Class: HTTY::CLI::Commands::PortSet

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

Overview

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



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

def self.category
  'Navigation'
end

.command_line_argumentsObject

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



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

def self.command_line_arguments
  'PORT'
end

.helpObject

Returns the help text for the port-set command.



26
27
28
# File 'lib/htty/cli/commands/port_set.rb', line 26

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

.help_extendedObject

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



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

def self.help_extended
  'Changes the TCP port used for the request. Does not communicate with '  +
  "the host.\n"                                                            +
  "\n"                                                                     +
  "The port you supply must be an integer between 0 and 65,535. Changing " +
  "the port has no effect on the scheme, and vice versa.\n"                +
  "\n"                                                                     +
  'The console prompt shows the address for the current request.'
end

.see_also_commandsObject

Returns related command classes for the port-set command.



42
43
44
# File 'lib/htty/cli/commands/port_set.rb', line 42

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

Instance Method Details

#performObject

Performs the port-set command.



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

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