Class: Slop::Option
- Inherits:
-
Object
- Object
- Slop::Option
- Defined in:
- lib/slop/option.rb
Constant Summary collapse
- DEFAULT_OPTIONS =
The default Hash of configuration options this class uses.
{ :argument => false, :optional_argument => false, :tail => false, :default => nil, :callback => nil, :delimiter => ',', :limit => 0, :match => nil, :optional => true, :required => false, :as => String, :autocreated => false }
Instance Attribute Summary collapse
-
#argument_in_value ⇒ Object
Returns the value of attribute argument_in_value.
-
#config ⇒ Object
readonly
Returns the value of attribute config.
-
#count ⇒ Object
Returns the value of attribute count.
-
#description ⇒ Object
readonly
Returns the value of attribute description.
-
#long ⇒ Object
readonly
Returns the value of attribute long.
-
#short ⇒ Object
readonly
Returns the value of attribute short.
-
#types ⇒ Object
readonly
Returns the value of attribute types.
Instance Method Summary collapse
-
#accepts_optional_argument? ⇒ Boolean
Returns true if this option accepts an optional argument.
-
#call(*objects) ⇒ Object
Call this options callback if one exists, and it responds to call().
-
#expects_argument? ⇒ Boolean
Returns true if this option expects an argument.
-
#initialize(slop, short, long, description, config = {}, &block) ⇒ Option
constructor
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.
-
#inspect ⇒ Object
Returns the String inspection text.
-
#key ⇒ Object
Returns the String flag of this option.
-
#to_s ⇒ Object
(also: #help)
Returns the help String for this option.
-
#value ⇒ Object
Fetch the argument value for this option.
-
#value=(new_value) ⇒ Object
Set the new argument value for this option.
Constructor Details
#initialize(slop, short, long, description, config = {}, &block) ⇒ Option
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.
33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 |
# 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 |
Instance Attribute Details
#argument_in_value ⇒ Object
Returns the value of attribute argument_in_value.
21 22 23 |
# File 'lib/slop/option.rb', line 21 def argument_in_value @argument_in_value end |
#config ⇒ Object (readonly)
Returns the value of attribute config.
20 21 22 |
# File 'lib/slop/option.rb', line 20 def config @config end |
#count ⇒ Object
Returns the value of attribute count.
21 22 23 |
# File 'lib/slop/option.rb', line 21 def count @count end |
#description ⇒ Object (readonly)
Returns the value of attribute description.
20 21 22 |
# File 'lib/slop/option.rb', line 20 def description @description end |
#long ⇒ Object (readonly)
Returns the value of attribute long.
20 21 22 |
# File 'lib/slop/option.rb', line 20 def long @long end |
#short ⇒ Object (readonly)
Returns the value of attribute short.
20 21 22 |
# File 'lib/slop/option.rb', line 20 def short @short end |
#types ⇒ Object (readonly)
Returns the value of attribute types.
20 21 22 |
# File 'lib/slop/option.rb', line 20 def types @types end |
Instance Method Details
#accepts_optional_argument? ⇒ Boolean
Returns true if this option accepts an optional argument.
71 72 73 |
# File 'lib/slop/option.rb', line 71 def accepts_optional_argument? config[:optional_argument] || config[:argument] == :optional end |
#call(*objects) ⇒ Object
Call this options callback if one exists, and it responds to call().
Returns nothing.
83 84 85 |
# File 'lib/slop/option.rb', line 83 def call(*objects) @callback.call(*objects) if @callback.respond_to?(:call) end |
#expects_argument? ⇒ Boolean
Returns true if this option expects an argument.
66 67 68 |
# File 'lib/slop/option.rb', line 66 def expects_argument? config[:argument] && config[:argument] != :optional end |
#inspect ⇒ Object
Returns the String inspection text.
151 152 153 154 155 |
# File 'lib/slop/option.rb', line 151 def inspect "#<Slop::Option [-#{short} | --#{long}" + "#{'=' if expects_argument?}#{'=?' if accepts_optional_argument?}]" + " (#{description}) #{config.inspect}" end |
#key ⇒ Object
Returns the String flag of this option. Preferring the long flag.
76 77 78 |
# File 'lib/slop/option.rb', line 76 def key long || short end |
#to_s ⇒ Object Also known as: help
Returns the help String for this option.
127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 |
# 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 if config[:default] default = config[:default] "#{out}#{description} (default: #{default})" else "#{out}#{description}" end end |
#value ⇒ Object
Fetch the argument value for this option.
Returns the Object once any type conversions have taken place.
107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 |
# 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 |
#value=(new_value) ⇒ Object
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.
92 93 94 95 96 97 98 99 100 101 102 |
# 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 |