Thor

Ronin::UI::CommandLine::Command

Included Modules

Thor::Actions, Ronin::UI::Output::Helpers

Constructor Summary

public initialize(arguments = [], options = {}, config = {})

Creates a new Command object.

Meta Tags

Parameters:

[Array] arguments: Command-line arguments.
[Hash] options: Additional command-line options.
[Hash] config: Additional configuration.

[View source]

    
49
50
51
52
53
        
          # File 'lib/ronin/ui/command_line/command.rb', line 49

def initialize(arguments=[],options={},config={})
  @indent = 0

  super(arguments,options,config)
end

Public Visibility

Public Class Method Summary

start(arguments = ARGV, config = {})

Public Instance Method Summary

#default(*arguments)	Default method to call after the options have been parsed.
#help	Prints the help information for the command and exists.

Public Class Method Details

start

public start(arguments = ARGV, config = {})

[View source]

    
55
56
57
58
59
60
61
        
          # File 'lib/ronin/ui/command_line/command.rb', line 55

def self.start(arguments=ARGV,config={})
  unless map[arguments.first.to_s]
    arguments = [default_task] + arguments
  end

  super(arguments,config)
end

Public Instance Method Details

default

public default(*arguments)

Default method to call after the options have been parsed.

[View source]

    
87
88
        
          # File 'lib/ronin/ui/command_line/command.rb', line 87

def default(*arguments)
end

help

public help

Prints the help information for the command and exists.

[View source]

    
      
        
          

95
96
97
98
99
100
101
102
103
        
        
          # File 'lib/ronin/ui/command_line/command.rb', line 95

def help
  self.class.help(
    shell, 
    self.class.default_task,
    :short => false,
    :ident => 2,
    :namespace => false
  )
end

        
      

  

Protected Visibility

Protected Instance Method Summary

#indent(n = 2, &block)	Increases the indentation out output temporarily. Returns: `nil`
#name	Returns the name of the command.
#print_array(array, options = {})	Prints a given Array. Returns: `nil`
#print_hash(hash, options = {})	Prints a given Hash. Returns: `nil`
#print_title(title)	Prints a given title.
#puts(*messages)	Print the given messages with indentation.

Protected Instance Methods Included from Ronin::UI::Output::Helpers

print_debug, print_error, print_info, print_warning

Protected Instance Method Details

indent

protected nil indent(n = 2, &block)

Increases the indentation out output temporarily.

Meta Tags

Parameters:

[Integer] n: The number of spaces to increase the indentation by.

Yields:

[Object]

: The block will be called after the indentation has been increased. After the block has returned, the indentation will be returned to normal.

Returns:

[nil]

[View source]

    
127
128
129
130
131
132
133
134
        
          # File 'lib/ronin/ui/command_line/command.rb', line 127

def indent(n=2,&block)
  @indent += n

  block.call()

  @indent -= n
  return nil
end

name

protected name

Returns the name of the command.

[View source]

    
110
111
112
        
          # File 'lib/ronin/ui/command_line/command.rb', line 110

def name
  self.class.name.split('::').last.snake_case
end

print_array

protected nil print_array(array, options = {})

Prints a given Array.

Meta Tags

Parameters:

[Array] array

The Array to print.

Options Hash options

Key Name	Default Value	Accepted Types	Description
:title	N/A	[`String`]	The optional title to print before the contents of the Array.

Returns:

[nil]

[View source]

    
170
171
172
173
174
175
176
177
178
179
        
          # File 'lib/ronin/ui/command_line/command.rb', line 170

def print_array(array,options={})
  print_title(options[:title]) if options[:title]

  indent do
    array.each { |value| puts value }
  end

  puts "\n" if options[:title]
  return nil
end

print_hash

protected nil print_hash(hash, options = {})

Prints a given Hash.

Meta Tags

Parameters:

[Hash] hash

The Hash to print.

Options Hash options

Key Name	Default Value	Accepted Types	Description
:title	N/A	[`String`]	The optional title to print before the contents of the Hash.

Returns:

[nil]

[View source]

    
      
        
          

195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
        
        
          # File 'lib/ronin/ui/command_line/command.rb', line 195

def print_hash(hash,options={})
  align = hash.keys.map { |name|
    name.to_s.length
  }.max

  print_title(options[:title]) if options[:title]

  indent do
    hash.each do |name,value|
      name = "#{name}:".ljust(align)
      puts "#{name}\t#{value}"
    end
  end

  puts "\n" if options[:title]
  return nil
end

        
      

  

print_title

protected print_title(title)

Prints a given title.

Meta Tags

Parameters:

[String] title: The title to print.

[View source]

    
152
153
154
        
          # File 'lib/ronin/ui/command_line/command.rb', line 152

def print_title(title)
  puts "[ #{title} ]"
end

puts

protected puts(*messages)

Print the given messages with indentation.

Meta Tags

Parameters:

[Array] messages: The messages to print, one per-line.

[View source]

    
142
143
144
        
          # File 'lib/ronin/ui/command_line/command.rb', line 142

def puts(*messages)
  super(*(messages.map { |mesg| (' ' * @indent) + mesg.to_s }))
end

Class: Ronin::UI::CommandLine::Command

Included Modules

Constructor Summary

Meta Tags

Parameters:

Public Visibility

Public Class Method Summary

Public Instance Method Summary

Public Class Method Details

start

Public Instance Method Details

default

help

Protected Visibility

Protected Instance Method Summary

Protected Instance Methods Included from Ronin::UI::Output::Helpers

Protected Instance Method Details

indent

Meta Tags

Parameters:

Yields:

Returns:

name

print_array

Meta Tags

Parameters:

Returns:

print_hash

Meta Tags

Parameters:

Returns:

print_title

Meta Tags

Parameters:

puts

Meta Tags

Parameters: