class Argy::Parameter

@abstract Subclasses must implement {#label}

Attributes

default[R]

The default value for the parameter @return [Object]

desc[R]

The description for the parameter @return [String]

name[R]

The name of the parameter @return [String]

type[R]

The type of the parameter @return [String]

Public Class Methods

new(name, desc: nil, type: :string, default: nil, required: false) click to toggle source

Create a new Parameter @param name [Symbol] name of the parameter @param desc [String,nil] description for the parameter @param type [Symbol,#call] type of parameter @param default [Object] default value for the parameter @param required [TrueClass,FalseClass] whether or not the field is required

# File lib/argy/parameter.rb, line 29
def initialize(name, desc: nil, type: :string, default: nil, required: false)
  @name = name
  @type = type
  @desc = desc
  @default = default
  @required = required
end

Public Instance Methods

coerce(value) click to toggle source

Coerces a value to the correct type. @param value [Object] the value to coerce @raise [CoersionError] if the value cannot be coerced

# File lib/argy/parameter.rb, line 64
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() click to toggle source

The display label for the paramter @abstract @return [String]

# File lib/argy/parameter.rb, line 40
def label
  raise NotImplementedError, __method__
end
required?() click to toggle source

Check if the parameter is required @return [TrueClass,FalseClass]

# File lib/argy/parameter.rb, line 46
def required?
  @required
end
validate(value) click to toggle source

Validates a value. @return [Object] the value @raise [ValidationError] if the valid is invalid

# File lib/argy/parameter.rb, line 53
def validate(value)
  if required? && value.nil?
    raise ValidationError, "`#{label}` is a required parameter"
  end

  value
end