Class: LibGems::Commands::HelpCommand

Inherits:
LibGems::Command show all
Defined in:
lib/libgems/commands/help_command.rb

Constant Summary collapse

EXAMPLES =

:stopdoc:

"Some examples of 'gem' usage.\n\n* Install 'rake', either from local directory or remote server:\n\n  gem install rake\n\n* Install 'rake', only from remote server:\n\n  gem install rake --remote\n\n* Install 'rake' from remote server, and run unit tests,\nand generate RDocs:\n\n  gem install --remote rake --test --rdoc --ri\n\n* Install 'rake', but only version 0.3.1, even if dependencies\nare not met, and into a user-specific directory:\n\n  gem install rake --version 0.3.1 --force --user-install\n\n* List local gems whose name begins with 'D':\n\n  gem list D\n\n* List local and remote gems whose name contains 'log':\n\n  gem search log --both\n\n* List only remote gems whose name contains 'log':\n\n  gem search log --remote\n\n* Uninstall 'rake':\n\n  gem uninstall rake\n\n* Create a gem:\n\n  See http://rubygems.rubyforge.org/wiki/wiki.pl?CreateAGemInTenMinutes\n\n* See information about \#{LibGems::NAME}:\n\n  gem environment\n\n* Update all gems on your system:\n\n  gem update\n"
PLATFORMS = 
"\#{LibGems::NAME} platforms are composed of three parts, a CPU, an OS, and a\nversion.  These values are taken from values in rbconfig.rb.  You can view\nyour current platform by running `gem environment`.\n\n\#{LibGems::NAME} matches platforms as follows:\n\n* The CPU must match exactly, unless one of the platforms has\n  \"universal\" as the CPU.\n* The OS must match exactly.\n* The versions must match exactly unless one of the versions is nil.\n\nFor commands that install, uninstall and list gems, you can override what\n\#{LibGems::NAME} thinks your platform is with the --platform option.  The platform\nyou pass must match \"\#{cpu}-\#{os}\" or \"\#{cpu}-\#{os}-\#{version}\".  On mswin\nplatforms, the version is the compiler version, not the OS version.  (Ruby\ncompiled with VC6 uses \"60\" as the compiler version, VC8 uses \"80\".)\n\nExample platforms:\n\nx86-freebsd        # Any FreeBSD version on an x86 CPU\nuniversal-darwin-8 # Darwin 8 only gems that run on any CPU\nx86-mswin32-80     # Windows gems compiled with VC8\n\nWhen building platform gems, set the platform in the gem specification to\nLibGems::Platform::CURRENT.  This will correctly mark the gem with your ruby's\nplatform.\n"

Instance Attribute Summary

Attributes inherited from LibGems::Command

#command, #defaults, #options, #program_name, #summary

Instance Method Summary collapse

Methods inherited from LibGems::Command

add_common_option, #add_extra_args, #add_option, add_specific_extra_args, #begins?, build_args, build_args=, common_options, #defaults_str, #description, extra_args, extra_args=, #get_all_gem_names, #get_one_gem_name, #get_one_optional_argument, #handle_options, #handles?, #invoke, #merge_options, #remove_option, #show_help, #show_lookup_failure, specific_extra_args, specific_extra_args_hash, #when_invoked

Methods included from UserInteraction

#methname

Methods included from DefaultUserInteraction

ui, #ui, ui=, #ui=, use_ui, #use_ui

Constructor Details

#initialize ⇒ HelpCommand

:startdoc:



86
87
88
 
# File 'lib/libgems/commands/help_command.rb', line 86

def initialize
  super 'help', "Provide help on the 'gem' command"
end

Instance Method Details

#arguments ⇒ Object

:nodoc:



90
91
92
93
94
95
96
97
 
# File 'lib/libgems/commands/help_command.rb', line 90

def arguments # :nodoc:
  args = "    commands      List all 'gem' commands\n    examples      Show examples of 'gem' usage\n    <command>     Show specific help for <command>\n  EOF\n  return args.gsub(/^\\s+/, '')\nend\n"

#execute ⇒ Object 



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/libgems/commands/help_command.rb', line 103

def execute
  command_manager = LibGems::CommandManager.instance
  arg = options[:args][0]

  if begins? "commands", arg then
    out = []
    out << "GEM commands are:"
    out << nil

    margin_width = 4

    desc_width = command_manager.command_names.map { |n| n.size }.max + 4

    summary_width = 80 - margin_width - desc_width
    wrap_indent = ' ' * (margin_width + desc_width)
    format = "#{' ' * margin_width}%-#{desc_width}s%s"

    command_manager.command_names.each do |cmd_name|
      summary = command_manager[cmd_name].summary
      summary = wrap(summary, summary_width).split "\n"
      out << sprintf(format, cmd_name, summary.shift)
      until summary.empty? do
        out << "#{wrap_indent}#{summary.shift}"
      end
    end

    out << nil
    out << "For help on a particular command, use 'gem help COMMAND'."
    out << nil
    out << "Commands may be abbreviated, so long as they are unambiguous."
    out << "e.g. 'gem i rake' is short for 'gem install rake'."

    say out.join("\n")

  elsif begins? "options", arg then
    say LibGems::Command::HELP

  elsif begins? "examples", arg then
    say EXAMPLES

  elsif begins? "platforms", arg then
    say PLATFORMS

  elsif options[:help] then
    command = command_manager[options[:help]]
    if command
      # help with provided command
      command.invoke("--help")
    else
      alert_error "Unknown command #{options[:help]}.  Try 'gem help commands'"
    end

  elsif arg then
    possibilities = command_manager.find_command_possibilities(arg.downcase)
    if possibilities.size == 1
      command = command_manager[possibilities.first]
      command.invoke("--help")
    elsif possibilities.size > 1
      alert_warning "Ambiguous command #{arg} (#{possibilities.join(', ')})"
    else
      alert_warning "Unknown command #{arg}. Try gem help commands"
    end

  else
    say LibGems::Command::HELP
  end
end

#usage ⇒ Object

:nodoc:



99
100
101
 
# File 'lib/libgems/commands/help_command.rb', line 99

def usage # :nodoc:
  "#{program_name} ARGUMENT"
end