Parent

Class/Module Index [+]

Quicksearch

HammerCLI::Options::OptionDefinition

Attributes

context_target[RW]
value_formatter[RW]

Public Class Methods

new(switches, type, description, options = {}) click to toggle source
# File lib/hammer_cli/options/option_definition.rb, line 24
def initialize(switches, type, description, options = {})
  self.value_formatter = options.delete(:format)
  self.context_target = options.delete(:context_target)
  super
end

Public Instance Methods

complete(value) click to toggle source
# File lib/hammer_cli/options/option_definition.rb, line 30
def complete(value)
  if value_formatter.nil?
    []
  else
    value_formatter.complete(value)
  end
end
default_conversion_block() click to toggle source
# File lib/hammer_cli/options/option_definition.rb, line 73
def default_conversion_block
  if !value_formatter.nil?
    value_formatter.method(:format)
  elsif flag?
    Clamp.method(:truthy?)
  end
end
default_value() click to toggle source
# File lib/hammer_cli/options/option_definition.rb, line 81
def default_value
  if defined?(@default_value)
    if value_formatter
      value_formatter.format(@default_value)
    else
      @default_value
    end
  elsif multivalued?
    []
  end
end
format_description() click to toggle source
# File lib/hammer_cli/options/option_definition.rb, line 53
def format_description
  if value_formatter.nil?
    ""
  else
    value_formatter.description
  end
end
help_lhs() click to toggle source
# File lib/hammer_cli/options/option_definition.rb, line 38
def help_lhs
  super
end
help_rhs() click to toggle source
# File lib/hammer_cli/options/option_definition.rb, line 42
def help_rhs
  lines = [
    description.strip,
    format_description.strip,
    value_description.strip
  ]

  rhs = lines.reject(&:empty?).join("\n")
  rhs.empty? ? " " : rhs
end
value_description() click to toggle source
# File lib/hammer_cli/options/option_definition.rb, line 61
def value_description
  default_sources = [
    ("$#{@environment_variable}" if defined?(@environment_variable)),
    (@default_value.inspect if defined?(@default_value))
  ].compact

  str = ""
  str += _("Can be specified multiple times. ") if multivalued?
  str += _("Default: ") + default_sources.join(_(", or ")) unless default_sources.empty?
  str
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.