class Slop::Option
Constants
- DEFAULT_OPTIONS
The default Hash of configuration options this class uses.
Attributes
Public Class Methods
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/slop/option.rb, line 33 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) }, :regexp => proc { |v| Regexp.new(v) }, :count => proc { |v| @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] } end end end
Public Instance Methods
Returns true if this option accepts an optional argument.
# File lib/slop/option.rb, line 71 def accepts_optional_argument? config[:optional_argument] || config[:argument] == :optional end
Call this options callback if one exists, and it responds to call().
Returns nothing.
# File lib/slop/option.rb, line 83 def call(*objects) @callback.call(*objects) if @callback.respond_to?(:call) end
Returns true if this option expects an argument.
# File lib/slop/option.rb, line 66 def expects_argument? config[:argument] && config[:argument] != :optional end
Returns the String inspection text.
# File lib/slop/option.rb, line 146 def inspect "#<Slop::Option [-#{short} | --#{long}" + "#{'=' if expects_argument?}#{'=?' if accepts_optional_argument?}]" + " (#{description}) #{config.inspect}" end
Returns the String flag of this option. Preferring the long flag.
# File lib/slop/option.rb, line 76 def key long || short end
Returns the help String for this option.
# File lib/slop/option.rb, line 127 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
Fetch the argument value for this option.
Returns the Object once any type conversions have taken place.
# File lib/slop/option.rb, line 107 def value value = @value.nil? ? config[:default] : @value if [true, false, nil].include?(value) && config[:as].to_s != 'count' return value end type = config[:as] if type.respond_to?(:call) type.call(value) else if callable = types[type.to_s.downcase.to_sym] callable.call(value) else value end end end
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/slop/option.rb, line 92 def value=(new_value) if config[:as].to_s.downcase == 'array' @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
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/slop/option.rb, line 176 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
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/slop/option.rb, line 159 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
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/slop/option.rb, line 193 def value_to_range(value) case value.to_s when /\A(\-?\d+)\z/ Range.new($1.to_i, $1.to_i) when /\A(-?\d+?)(\.\.\.?|-|,)(-?\d+)\z/ Range.new($1.to_i, $3.to_i, $2 == '...') else if @slop.strict? raise InvalidArgumentError, "#{value} could not be coerced into Range" else value end end end