Class | Gem::Command |
In: |
lib/rubygems/command.rb
|
Parent: | Object |
Base class for all Gem commands. When creating a new gem command, define new, execute, arguments, defaults_str, description and usage (as appropriate). See the above mentioned methods for details.
A very good example to look at is Gem::Commands::ContentsCommand
command | [R] | The name of the command. |
defaults | [RW] | The default options for the command. |
options | [R] | The options for the command. |
program_name | [RW] | The name of the command for command-line invocation. |
summary | [RW] | A short description of the command. |
Add a list of extra arguments for the given command. args may be an array or a string to be split on white space.
Initializes a generic gem command named command. summary is a short description displayed in `gem help commands`. defaults are the default options. Defaults should be mirrored in defaults_str, unless there are none.
When defining a new command subclass, use add_option to add command-line switches.
Unhandled arguments (gem names, files, etc.) are left in options[:args].
Add a command-line option and handler to the command.
See OptionParser#make_switch for an explanation of opts.
handler will be called with two values, the value of the argument and the options hash.
If the first argument of add_option is a Symbol, it‘s used to group options in output. See `gem help list` for an example.
Override to provide details of the arguments a command takes. It should return a left-justified string, one argument per line.
For example:
def usage "#{program_name} FILE [FILE ...]" end def arguments "FILE name of file to find" end
Override to display the default values of the command options. (similar to arguments, but displays the default values).
For example:
def defaults_str --no-gems-first --no-all end
Override to provide command handling.
options will be filled in with your parsed options, unparsed options will be left in options[:args].
See also: get_all_gem_names, get_one_gem_name, get_one_optional_argument
Get the single gem name from the command line. Fail if there is no gem name or if there is more than one gem name given.
Get a single optional argument from the command line. If more than one argument is given, return only the first. Return nil if none are given.
Merge a set of command options with the set of default options (without modifying the default option hash).
Call the given block when invoked.
Normal command invocations just executes the execute method of the command. Specifying an invocation block allows the test methods to override the normal action of a command to determine that it has been invoked correctly.