Class: HTTY::CLI::Commands::FragmentSet

Inherits:

HTTY::CLI::Command

• Object
• HTTY::CLI::Command
• HTTY::CLI::Commands::FragmentSet

show all

Includes:

UrlEscaping

Defined in:

lib/htty/cli/commands/fragment_set.rb

Overview

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)

• + (Object) category

  Returns the name of a category under which help for the fragment-set command should appear.

• + (Object) command_line_arguments

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

• + (Object) help

  Returns the help text for the fragment-set command.

• + (Object) help_extended

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

• + (Object) see_also_commands

  Returns related command classes for the fragment-set command.

Instance Method Summary (collapse)

• - (Object) perform

  Performs the fragment-set command.

Methods included from UrlEscaping

#escape_or_warn_of_escape_sequences

Methods included from Display

#format, #indent, #logotype, #normal, #notice, #pluralize, #prompt, #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

19
20
21

# File 'lib/htty/cli/commands/fragment_set.rb', line 19

def self.category
  'Navigation'
end

24
25
26

# File 'lib/htty/cli/commands/fragment_set.rb', line 24

def self.command_line_arguments
  'FRAGMENT'
end

29
30
31

# File 'lib/htty/cli/commands/fragment_set.rb', line 29

def self.help
  "Sets the fragment of the request's address"
end

34
35
36
37
38
39
40
41

# File 'lib/htty/cli/commands/fragment_set.rb', line 34

def self.help_extended
  'Sets the page fragment used for the request. Does not communicate with ' +
  "the host.\n"                                                             +
  "\n"                                                                      +
  "The page fragment will be URL-encoded if necessary.\n"                   +
  "\n"                                                                      +
  'The console prompt shows the address for the current request.'
end

44
45
46
47

# File 'lib/htty/cli/commands/fragment_set.rb', line 44

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

50
51
52
53
54
55
56
57
58
59

# File 'lib/htty/cli/commands/fragment_set.rb', line 50

def perform
  add_request_if_new do |request|
    clean_arguments = arguments.collect do |a|
      a.gsub(/^#/, '')
    end
    self.class.notify_if_cookies_cleared request do
      request.fragment_set(*escape_or_warn_of_escape_sequences(clean_arguments))
    end
  end
end