Sha256: 84f85870f88e9d633dc84b2659dd6bb8afa14b7e6123966168e9684570b0fe10
Contents?: true
Size: 1.81 KB
Versions: 7
Compression:
Stored size: 1.81 KB
Contents
module MelissaData
# Entrypoint for the MelissaData CLI. This class should never be
# initialized directly (like a typical Thor class). Instead,
# use {Environment#cli} to invoke the CLI.
#
# # Defining Custom CLI Commands
#
# If you're looking to define custom CLI commands, then look at
# one of the two following classes:
#
# * {Command::Base} - Implementing a single command such as `melissadata up`, e.g.
# one without subcommands. Also take a look at {Command::NamedBase}.
# * {Command::GroupBase} - Implementing a command with subcommands, such as
# `melissadata box`, which has the `list`, `add`, etc. subcommands.
#
# The above linked classes contain the main documentation for each
# type of command.
class CLI < Thor
# Registers the given class with the CLI so it can be accessed.
# The class must be a subclass of {Command::Base}
# Don't call this method directly, instead call the {Command::Base.register}
#
# @param [Class] klass Command class
# @param [String] name Command name, accessed at `melissadata NAME`
# @param [String] usage Command usage, such as "melissadata NAME [--option]"
# @param [String] description Description of the command shown during the
# command listing.
# @param [Hash] opts Other options (not gone into detail here, look at
# the source instead).
def self.register(klass, name, usage, description, opts=nil)
opts ||= {}
# A subclass of Base is a single command, since it
# is invoked as a whole (as Thor::Group)
desc usage, description, opts
define_method(name) { |*args| invoke klass, args }
if opts[:alias]
# Alises are defined for this command, so properly alias the
# newly defined method/subcommand:
map opts[:alias] => name
end
end
end
end
Version data entries
7 entries across 7 versions & 1 rubygems