Class: Slop::Option

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

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.



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
 
# File 'lib/slop/option.rb', line 34

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| v.to_s.to_i },
    :float   => proc { |v| v.to_f },
    :array   => proc { |v| v.split(@config[:delimiter], @config[:limit]) },
    :range   => proc { |v| value_to_range(v) }
  }

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

  @config.each_key do |key|
    self.class.send(:define_method, "#{key}?") { !!@config[key] }
  end
end

Instance Attribute Details

#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

#value ⇒ Object

Fetch the argument value for this option.

Returns the Object once any type conversions have taken place.



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/slop/option.rb', line 87

def value
  value = @value || config[:default]
  return if value.nil?

  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

Instance Method Details

#accepts_optional_argument? ⇒ Boolean

Returns true if this option accepts an optional argument.

Returns:

  • (Boolean) 


68
69
70
 
# File 'lib/slop/option.rb', line 68

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.



80
81
82
 
# File 'lib/slop/option.rb', line 80

def call(*objects)
  @callback.call(*objects) if @callback.respond_to?(:call)
end

#expects_argument? ⇒ Boolean

Returns true if this option expects an argument.

Returns:

  • (Boolean) 


63
64
65
 
# File 'lib/slop/option.rb', line 63

def expects_argument?
  config[:argument] && config[:argument] != :optional
end

#inspect ⇒ Object

Returns the String inspection text.



124
125
126
127
128
 
# File 'lib/slop/option.rb', line 124

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.



73
74
75
 
# File 'lib/slop/option.rb', line 73

def key
  long || short
end

#to_s ⇒ Object Also known as: help

Returns the help String for this option.



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/slop/option.rb', line 104

def to_s
  return config[:help] if config[:help].respond_to?(:to_str)

  out = "    "
  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