Class: HTTY::CLI::Commands::QueryUnsetAll

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

Overview

Encapsulates the query-unset-all 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

.categoryObject

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



17
18
19
# File 'lib/htty/cli/commands/query_unset_all.rb', line 17

def self.category
  'Navigation'
end

.helpObject

Returns the help text for the query-unset-all command.



22
23
24
# File 'lib/htty/cli/commands/query_unset_all.rb', line 22

def self.help
  "Clears the query string of the request's address"
end

.help_extendedObject

Returns the extended help text for the query-unset-all command.



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

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

.see_also_commandsObject

Returns related command classes for the query-unset-all command.



35
36
37
38
39
# File 'lib/htty/cli/commands/query_unset_all.rb', line 35

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

Instance Method Details

#performObject

Performs the query-unset-all command.



42
43
44
45
46
47
48
# File 'lib/htty/cli/commands/query_unset_all.rb', line 42

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