Module: RHC::Commands

Defined in:

lib/rhc/commands.rb,
lib/rhc/commands/app.rb,
lib/rhc/commands/env.rb,
lib/rhc/commands/ssh.rb,
lib/rhc/commands/apps.rb,
lib/rhc/commands/tail.rb,
lib/rhc/commands/alias.rb,
lib/rhc/commands/setup.rb,
lib/rhc/commands/domain.rb,
lib/rhc/commands/logout.rb,
lib/rhc/commands/member.rb,
lib/rhc/commands/server.rb,
lib/rhc/commands/sshkey.rb,
lib/rhc/commands/account.rb,
lib/rhc/commands/snapshot.rb,
lib/rhc/commands/cartridge.rb,
lib/rhc/commands/git_clone.rb,
lib/rhc/commands/deployment.rb,
lib/rhc/commands/threaddump.rb,
lib/rhc/commands/port_forward.rb,
lib/rhc/commands/authorization.rb

Defined Under Namespace

Classes: Account, Alias, App, Apps, Authorization, Base, Cartridge, Deployment, Domain, Env, ForwardingSpec, GitClone, Logout, Member, PortForward, Server, Setup, Snapshot, Ssh, Sshkey, Tail, Threaddump

Class Method Summary

• .add(opts) ⇒ Object
• .deprecated! ⇒ Object
• .global_option(*args, &block) ⇒ Object
• .load ⇒ Object
• .needs_configuration!(cmd, options, config) ⇒ Object
• .to_commander(instance = Commander::Runner.instance) ⇒ Object

Class Method Details

.add(opts) ⇒ Object

# File 'lib/rhc/commands.rb', line 184

def self.add(opts)
  commands[opts[:name]] = opts
end

.deprecated! ⇒ Object

# File 'lib/rhc/commands.rb', line 191

def self.deprecated!
  instance = Commander::Runner.instance
  command_name = instance.command_name_from_args
  command = instance.active_command

  if new_cmd = command.deprecated(command_name)
    new_cmd = "pbox #{command.name}" if new_cmd == true
    RHC::Helpers.deprecated_command new_cmd
  end
end

.global_option(*args, &block) ⇒ Object

# File 'lib/rhc/commands.rb', line 187

def self.global_option(*args, &block)
  global_options << [args.freeze, block]
end

.load ⇒ Object

# File 'lib/rhc/commands.rb', line 178

def self.load
  Dir[File.join(File.dirname(__FILE__), "commands", "*.rb")].each do |file|
    require file
  end
  self
end

.needs_configuration!(cmd, options, config) ⇒ Object

# File 'lib/rhc/commands.rb', line 202

def self.needs_configuration!(cmd, options, config)
  if not (cmd.class.suppress_wizard? or
          options.noprompt or
          options.help or
          config.has_local_config? or
          config.has_opts_config?)

    $stderr.puts RHC::Helpers.color("You have not yet configured the ProtonBox client tools. Please run 'pbox setup'.", :yellow)
  end
end

.to_commander(instance = Commander::Runner.instance) ⇒ Object

# File 'lib/rhc/commands.rb', line 213

def self.to_commander(instance=Commander::Runner.instance)
  global_options.each do |args, block|
    args = args.dup
    opts = (args.pop if Hash === args.last) || {}
    option = instance.global_option(*args, &block).last
    option.merge!(opts)
  end
  commands.each_pair do |name, opts|
    name = Array(name)
    names = [name.reverse.join('-'), name.join(' ')] if name.length > 1
    name = name.join('-')

    instance.command name do |c|
      c.description = opts[:description]
      c.summary = opts[:summary]
      c.syntax = opts[:syntax]
      c.default_action = opts[:default]

      c.info = opts

      (options_metadata = Array(opts[:options])).each do |o|
        option_data = [o[:switches], o[:type], o[:description], o.slice(:optional, :default, :hide, :covered_by)].compact.flatten(1)
        c.option *option_data
        o[:arg] = Commander::Runner.switch_to_sym(Array(o[:switches]).last)
      end

      (args_metadata = Array(opts[:args])).each do |meta|
        switches = meta[:switches]
        unless switches.blank?
          switches = switches.dup
          switches << meta[:description]
          switches << meta.slice(:optional, :default, :hide, :covered_by, :allow_nil)
          c.option *switches
        end
      end

      Array(opts[:aliases]).each do |a|
        action = Array(a[:action])
        [' ', '-'].each do |s|
          cmd = action.join(s)
          instance.alias_command cmd, name
        end
      end

      if names
        names.each{ |alt| instance.alias_command alt, name }
      else
        c.root = true
      end

      c.when_called do |args, options|
        deprecated!

        config = c.instance_variable_get(:@config)

        cmd = opts[:class].new
        cmd.options = options
        cmd.config = config

        args = fill_arguments(cmd, options, args_metadata, options_metadata, args)
        needs_configuration!(cmd, options, config)

        return execute(cmd, :help, args) unless opts[:method]
        execute(cmd, opts[:method], args)
      end
    end
  end
  self
end