Class: HTTY::CLI::Commands::FragmentUnset

Inherits:
HTTY::CLI::Command show all
Defined in:
lib/htty/cli/commands/fragment_unset.rb

Overview

Encapsulates the fragment-unset command.

Constant Summary

Constants included from Display

Display::FORMATS

Instance Attribute Summary

Attributes inherited from HTTY::CLI::Command

#arguments, #session

Class Method Summary (collapse)

Instance Method Summary (collapse)

Methods inherited from HTTY::CLI::Command

#add_request_if_new, alias_for, aliases, build_for, command_line, command_line_arguments, complete_for?, #initialize, notify_if_cookies_cleared, raw_name, sanitize_arguments

Methods included from Display

#break, #format, #formatted_prompt_for, #indent, #logotype, #normal, #notice, #pluralize, #rescuing_from, #say, #say_goodbye, #say_header, #say_hello, #show_headers, #show_request, #show_response, #strong, #word_wrap, #word_wrap_indented

Constructor Details

This class inherits a constructor from HTTY::CLI::Command

Class Method Details

+ (Object) category

Returns the name of a category under which help for the fragment-unset command should appear.



16
17
18
# File 'lib/htty/cli/commands/fragment_unset.rb', line 16

def self.category
  'Navigation'
end

+ (Object) help

Returns the help text for the fragment-unset command.



21
22
23
# File 'lib/htty/cli/commands/fragment_unset.rb', line 21

def self.help
  "Removes the fragment from the request's address"
end

+ (Object) help_extended

Returns the extended help text for the fragment-unset command.



26
27
28
29
30
31
# File 'lib/htty/cli/commands/fragment_unset.rb', line 26

def self.help_extended
  'Removes the page fragment used for the request. Does not communicate ' +
  "with the host.\n"                                                      +
  "\n"                                                                    +
  'The console prompt shows the address for the current request.'
end

+ (Object) see_also_commands

Returns related command classes for the fragment-unset command.



34
35
36
37
# File 'lib/htty/cli/commands/fragment_unset.rb', line 34

def self.see_also_commands
  [HTTY::CLI::Commands::FragmentSet,
   HTTY::CLI::Commands::Address]
end

Instance Method Details

- (Object) perform

Performs the fragment-unset command.



40
41
42
43
44
45
46
# File 'lib/htty/cli/commands/fragment_unset.rb', line 40

def perform
  add_request_if_new do |request|
    self.class.notify_if_cookies_cleared request do
      request.fragment_unset(*arguments)
    end
  end
end