Class: HTTY::CLI::Commands::QuerySet

Inherits:
HTTY::CLI::Command show all
Includes:
Display, UrlEscaping
Defined in:
lib/htty/cli/commands/query_set.rb

Overview

Encapsulates the query-set command.

Constant Summary

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 included from UrlEscaping

#escape_or_warn_of_escape_sequences

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

Methods inherited from HTTY::CLI::Command

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

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-set command should appear.



23
24
25
# File 'lib/htty/cli/commands/query_set.rb', line 23

def self.category
  'Navigation'
end

.command_line_argumentsObject

Returns the arguments for the command-line usage of the query-set command.



28
29
30
# File 'lib/htty/cli/commands/query_set.rb', line 28

def self.command_line_arguments
  'NAME [VALUE [NAME [VALUE ...]]]'
end

.helpObject

Returns the help text for the query-set command.



33
34
35
# File 'lib/htty/cli/commands/query_set.rb', line 33

def self.help
  "Sets query-string parameters in the request's address"
end

.help_extendedObject

Returns the extended help text for the query-set command.



38
39
40
41
42
43
44
45
46
47
48
49
50
# File 'lib/htty/cli/commands/query_set.rb', line 38

def self.help_extended
  'Sets one or more query-string parameters used for the request. Does not ' +
  "communicate with the host.\n"                                             +
  "\n"                                                                       +
  'The difference between this command and '                                 +
  "#{strong HTTY::CLI::Commands::QueryAdd.command_line} is that this "       +
  "command replaces any duplicate parameters instead of adding more.\n"      +
  "\n"                                                                       +
  'The name(s) and value(s) of the query-string parameter(s) will be URL-'   +
  "encoded if necessary.\n"                                                  +
  "\n"                                                                       +
  'The console prompt shows the address for the current request.'
end

.see_also_commandsObject

Returns related command classes for the query-set command.



53
54
55
56
57
58
59
# File 'lib/htty/cli/commands/query_set.rb', line 53

def self.see_also_commands
  [HTTY::CLI::Commands::QueryUnset,
   HTTY::CLI::Commands::QueryUnsetAll,
   HTTY::CLI::Commands::QueryAdd,
   HTTY::CLI::Commands::QueryRemove,
   HTTY::CLI::Commands::Address]
end

Instance Method Details

#performObject

Performs the query-set command.



62
63
64
65
66
67
68
69
70
71
72
73
74
75
# File 'lib/htty/cli/commands/query_set.rb', line 62

def perform
  if arguments.empty?
    raise ArgumentError, 'wrong number of arguments (0 for N)'
  end
  add_request_if_new do |request|
    self.class.notify_if_cookies_cleared request do
      escaped_arguments = escape_or_warn_of_escape_sequences(arguments)
      escaped_arguments.each_slice 2 do |name, value|
        request = request.query_set(name, value)
      end
      request
    end
  end
end