Class: Argy::Parameter

Inherits:
Object
  • Object
show all
Defined in:
lib/argy/parameter.rb

Direct Known Subclasses

Argument, Option

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, desc: nil, type: :string, default: nil, required: false) ⇒ Parameter 



8
9
10
11
12
13
14
 
# File 'lib/argy/parameter.rb', line 8

def initialize(name, desc: nil, type: :string, default: nil, required: false)
  @name = name
  @type = type
  @desc = desc
  @default = default
  @required = required
end

Instance Attribute Details

#default ⇒ Object (readonly)

Returns the value of attribute default.



6
7
8
 
# File 'lib/argy/parameter.rb', line 6

def default
  @default
end

#desc ⇒ Object (readonly)

Returns the value of attribute desc.



6
7
8
 
# File 'lib/argy/parameter.rb', line 6

def desc
  @desc
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



6
7
8
 
# File 'lib/argy/parameter.rb', line 6

def name
  @name
end

#type ⇒ Object (readonly)

Returns the value of attribute type.



6
7
8
 
# File 'lib/argy/parameter.rb', line 6

def type
  @type
end

Instance Method Details

#coerce(value) ⇒ Object 



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/argy/parameter.rb', line 30

def coerce(value)
  case type
  when :string, :boolean
    value
  when :integer
    Integer(value)
  when :float
    Float(value)
  when :array
    value.split(",")
  when :pathname
    Pathname.new(value).expand_path(Dir.pwd)
  else
    raise "Invalid type: #{type.inspect}" unless type.respond_to?(:call)
    type.call(value)
  end
rescue ArgumentError
  raise CoersionError, "`#{label}` received an invalid value"
end

#label ⇒ Object

Raises:

  • (NotImplementedError) 


16
17
18
 
# File 'lib/argy/parameter.rb', line 16

def label
  raise NotImplementedError, __method__
end

#required? ⇒ Boolean 



20
21
22
 
# File 'lib/argy/parameter.rb', line 20

def required?
  @required
end

#validate(value) ⇒ Object 



24
25
26
27
28
 
# File 'lib/argy/parameter.rb', line 24

def validate(value)
  if required? && value.nil?
    raise ValidationError, "`#{label}` is a required parameter"
  end
end