Class: Aid::Scripts::Help

Inherits:
Aid::Script show all
Defined in:
lib/aid/scripts/help.rb

Constant Summary

Constants included from Colorize

Colorize::COLOR_CODES

Instance Attribute Summary collapse

Attributes inherited from Aid::Script

#argv

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Aid::Script

#description, #exit_code, #exit_with_help!, #help, name, #project_root, run, #step, #system!, #within_dir

Methods included from Inheritable

included

Methods included from Colorize

colorize, included

Constructor Details

#initialize(*argv) ⇒ Help

Returns a new instance of Help.



8
9
10
11
12
13
 
# File 'lib/aid/scripts/help.rb', line 8

def initialize(*argv)
  super

  script_name = argv.first
  @script = Aid::Script.scripts[script_name]
end

Instance Attribute Details

#script ⇒ Object (readonly)

Returns the value of attribute script.



6
7
8
 
# File 'lib/aid/scripts/help.rb', line 6

def script
  @script
end

Class Method Details

.description ⇒ Object 



15
16
17
 
# File 'lib/aid/scripts/help.rb', line 15

def self.description
  'Displays help information'
end

.help ⇒ Object 



19
20
21
 
# File 'lib/aid/scripts/help.rb', line 19

def self.help
  ''
end

Instance Method Details

#run ⇒ Object 



23
24
25
26
27
28
29
30
31
32
 
# File 'lib/aid/scripts/help.rb', line 23

def run
  if script
    puts "Help for #{colorize(:light_blue, script.name)}:"

    puts script.help
    puts
  else
    basic_usage
  end
end