class Pry::Slop::Option

Constants

DEFAULT_OPTIONS

The default Hash of configuration options this class uses.

Attributes

argument_in_value[RW]
config[R]
count[RW]
description[R]
long[R]
short[R]
types[R]

Public Class Methods

new(slop, short, long, description, config = {}, &block) click to toggle source

Incapsulate internal option information, mainly used to store option specific configuration data, most of the meat of this class is found in the value method.

slop - The instance of Slop tied to this Option. short - The String or Symbol short flag. long - The String or Symbol long flag. description - The String description text. config - A Hash of configuration options. block - An optional block used as a callback.

# File lib/pry/slop/option.rb, line 35
def initialize(slop, short, long, description, config = {}, &block)
  @slop = slop
  @short = short
  @long = long
  @description = description
  @config = DEFAULT_OPTIONS.merge(config)
  @count = 0
  @callback = block_given? ? block : config[:callback]
  @value = nil

  @types = {
    string: proc { |v| v.to_s },
    symbol: proc { |v| v.to_sym },
    integer: proc { |v| value_to_integer(v) },
    float: proc { |v| value_to_float(v) },
    range: proc { |v| value_to_range(v) },
    count: proc { @count }
  }

  if long && long.size > @slop.config[:longest_flag]
    @slop.config[:longest_flag] = long.size
  end

  @config.each_key do |key|
    predicate = :"#{key}?"
    unless self.class.method_defined?(predicate)
      self.class.__send__(:define_method, predicate) { !@config.key?(key) }
    end
  end
end

Public Instance Methods

accepts_optional_argument?() click to toggle source

Returns true if this option accepts an optional argument.

# File lib/pry/slop/option.rb, line 72
def accepts_optional_argument?
  config[:optional_argument] || config[:argument] == :optional
end
call(*objects) click to toggle source

Call this options callback if one exists, and it responds to call().

Returns nothing.

# File lib/pry/slop/option.rb, line 84
def call(*objects)
  @callback.call(*objects) if @callback.respond_to?(:call)
end
expects_argument?() click to toggle source

Returns true if this option expects an argument.

# File lib/pry/slop/option.rb, line 67
def expects_argument?
  config[:argument] && config[:argument] != :optional
end
help()
Alias for: to_s
inspect() click to toggle source

Returns the String inspection text.

# File lib/pry/slop/option.rb, line 143
def inspect
  "#<Slop::Option [-#{short} | --#{long}" \
  "#{'=' if expects_argument?}#{'=?' if accepts_optional_argument?}]" \
  " (#{description}) #{config.inspect}"
end
key() click to toggle source

Returns the String flag of this option. Preferring the long flag.

# File lib/pry/slop/option.rb, line 77
def key
  long || short
end
to_s() click to toggle source

Returns the help String for this option.

# File lib/pry/slop/option.rb, line 124
def to_s
  return config[:help] if config[:help].respond_to?(:to_str)

  out = "    #{short ? "-#{short}, " : ' ' * 4}"

  if long
    out += "--#{long}"
    size = long.size
    diff = @slop.config[:longest_flag] - size
    out += (' ' * (diff + 6))
  else
    out += (' ' * (@slop.config[:longest_flag] + 8))
  end

  "#{out}#{description}"
end
Also aliased as: help
value() click to toggle source

Fetch the argument value for this option.

Returns the Object once any type conversions have taken place.

# File lib/pry/slop/option.rb, line 108
def value
  value = @value.nil? ? config[:default] : @value

  return value if [true, false, nil].include?(value) && config[:as].to_s != 'count'

  type = config[:as]
  if type.respond_to?(:call)
    type.call(value)
  elsif (callable = types[type.to_s.downcase.to_sym])
    callable.call(value)
  else
    value
  end
end
value=(new_value) click to toggle source

Set the new argument value for this option.

We use this setter method to handle concatenating lists. That is, when an array type is specified and used more than once, values from both options will be grouped together and flattened into a single array.

# File lib/pry/slop/option.rb, line 93
def value=(new_value)
  if config[:as].to_s.casecmp('array') == 0
    @value ||= []

    if new_value.respond_to?(:split)
      @value.concat new_value.split(config[:delimiter], config[:limit])
    end
  else
    @value = new_value
  end
end

Private Instance Methods

value_to_float(value) click to toggle source

Convert an object to a Float if possible.

value - The Object we want to convert to a float.

Returns the Float value if possible to convert, else a zero.

# File lib/pry/slop/option.rb, line 173
def value_to_float(value)
  if @slop.strict?
    begin
      Float(value.to_s)
    rescue ArgumentError
      raise InvalidArgumentError, "#{value} could not be coerced into Float"
    end
  else
    value.to_s.to_f
  end
end
value_to_integer(value) click to toggle source

Convert an object to an Integer if possible.

value - The Object we want to convert to an integer.

Returns the Integer value if possible to convert, else a zero.

# File lib/pry/slop/option.rb, line 156
def value_to_integer(value)
  if @slop.strict?
    begin
      Integer(value.to_s, 10)
    rescue ArgumentError
      raise InvalidArgumentError, "#{value} could not be coerced into Integer"
    end
  else
    value.to_s.to_i
  end
end
value_to_range(value) click to toggle source

Convert an object to a Range if possible.

value - The Object we want to convert to a range.

Returns the Range value if one could be found, else the original object.

# File lib/pry/slop/option.rb, line 190
def value_to_range(value)
  case value.to_s
  when /\A(\-?\d+)\z/
    Range.new(Regexp.last_match(1).to_i, Regexp.last_match(1).to_i)
  when /\A(-?\d+?)(\.\.\.?|-|,)(-?\d+)\z/
    Range.new(
      Regexp.last_match(1).to_i,
      Regexp.last_match(3).to_i,
      Regexp.last_match(2) == '...'
    )
  else
    if @slop.strict?
      raise InvalidArgumentError, "#{value} could not be coerced into Range"
    end

    value
  end
end