Class: HTTY::CLI::Commands::PathSet

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

Overview

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



18
19
20
# File 'lib/htty/cli/commands/path_set.rb', line 18

def self.category
  'Navigation'
end

.command_line_argumentsObject

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



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

def self.command_line_arguments
  'PATH'
end

.helpObject

Returns the help text for the path-set command.



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

def self.help
  "Changes the path of the request's address"
end

.help_extendedObject

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



33
34
35
36
37
38
39
40
# File 'lib/htty/cli/commands/path_set.rb', line 33

def self.help_extended
  'Changes the path used for the request. Does not communicate with the ' +
  "host.\n"                                                               +
  "\n"                                                                    +
  "The path 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 path-set command.



43
44
45
# File 'lib/htty/cli/commands/path_set.rb', line 43

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

Instance Method Details

#performObject

Performs the path-set command.



48
49
50
51
52
53
54
# File 'lib/htty/cli/commands/path_set.rb', line 48

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