Clamp::Subcommand::Declaration

Public Instance Methods

default_subcommand(*args, &block) click to toggle source
# File lib/clamp/subcommand/declaration.rb, line 63
def default_subcommand(*args, &block)
  if args.empty?
    @default_subcommand
  else
    $stderr.puts "WARNING: Clamp default_subcommand syntax has changed; check the README."
    $stderr.puts "  (from #{caller.first})"
    self.default_subcommand = args.first
    subcommand(*args, &block)
  end
end
default_subcommand=(name) click to toggle source
# File lib/clamp/subcommand/declaration.rb, line 56
def default_subcommand=(name)
  if has_subcommands?
    raise Clamp::DeclarationError, "default_subcommand must be defined before subcommands"
  end
  @default_subcommand = name
end
find_subcommand(name) click to toggle source
# File lib/clamp/subcommand/declaration.rb, line 34
def find_subcommand(name)
  recognised_subcommands.find { |sc| sc.is_called?(name) }
end
find_subcommand_class(*names) click to toggle source
# File lib/clamp/subcommand/declaration.rb, line 38
def find_subcommand_class(*names)
  names.inject(self) do |command_class, name|
    if command_class
      if subcommand = command_class.find_subcommand(name)
        subcommand.subcommand_class
      end
    end
  end
end
has_subcommands?() click to toggle source
# File lib/clamp/subcommand/declaration.rb, line 30
def has_subcommands?
  !recognised_subcommands.empty?
end
inheritable_attributes() click to toggle source
# File lib/clamp/subcommand/declaration.rb, line 52
def inheritable_attributes
  recognised_options + parameters_before_subcommand
end
parameters_before_subcommand() click to toggle source
# File lib/clamp/subcommand/declaration.rb, line 48
def parameters_before_subcommand
  parameters.take_while { |p| p != @subcommand_parameter }
end
recognised_subcommands() click to toggle source
# File lib/clamp/subcommand/declaration.rb, line 9
def recognised_subcommands
  @recognised_subcommands ||= []
end
subcommand(name, description, subcommand_class = self, &block) click to toggle source
# File lib/clamp/subcommand/declaration.rb, line 13
def subcommand(name, description, subcommand_class = self, &block)
  unless has_subcommands?
    @subcommand_parameter = if @default_subcommand
      parameter "[SUBCOMMAND]", "subcommand", :attribute_name => :subcommand_name, :default => @default_subcommand
    else
      parameter "SUBCOMMAND", "subcommand", :attribute_name => :subcommand_name, :required => false
    end
    remove_method :default_subcommand_name
    parameter "[ARG] ...", "subcommand arguments", :attribute_name => :subcommand_arguments
  end
  if block
    # generate a anonymous sub-class
    subcommand_class = Class.new(subcommand_class, &block)
  end
  recognised_subcommands << Subcommand::Definition.new(name, description, subcommand_class)
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.