Class: HTTY::CLI::Commands::HostSet

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

Overview

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



15
16
17
# File 'lib/htty/cli/commands/host_set.rb', line 15

def self.category
  'Navigation'
end

.command_line_argumentsObject

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



20
21
22
# File 'lib/htty/cli/commands/host_set.rb', line 20

def self.command_line_arguments
  'HOST'
end

.helpObject

Returns the help text for the host-set command.



25
26
27
# File 'lib/htty/cli/commands/host_set.rb', line 25

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

.help_extendedObject

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



30
31
32
33
34
35
36
37
38
# File 'lib/htty/cli/commands/host_set.rb', line 30

def self.help_extended
  'Changes the host used for the request. Does not communicate with the '  +
  "host.\n"                                                                +
  "\n"                                                                     +
  "The host you supply can be either a hostname (e.g., 'github.com') or "  +
  "an IP address (e.g., '127.0.0.1').\n"                                   +
  "\n"                                                                     +
  'The console prompt shows the address for the current request.'
end

.see_also_commandsObject

Returns related command classes for the host-set command.



41
42
43
# File 'lib/htty/cli/commands/host_set.rb', line 41

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

Instance Method Details

#performObject

Performs the host-set command.



46
47
48
49
50
51
52
# File 'lib/htty/cli/commands/host_set.rb', line 46

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