Class: Jisota::Param

Inherits:
Object
  • Object
show all
Defined in:
lib/jisota/param.rb

Overview

A package param

Options:

default

Provide a default value for the param

required

If true, an error is raised unless the param has a value

splat

Will get remaining unnamed arguments

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, options = {}) ⇒ Param

Returns a new instance of Param.



13
14
15
16
# File 'lib/jisota/param.rb', line 13

def initialize(name, options = {})
  @name = name
  @options = options
end

Instance Attribute Details

#nameObject (readonly)

Returns the value of attribute name.



11
12
13
# File 'lib/jisota/param.rb', line 11

def name
  @name
end

#optionsObject (readonly)

Returns the value of attribute options.



11
12
13
# File 'lib/jisota/param.rb', line 11

def options
  @options
end

Instance Method Details

#defaultObject



22
23
24
# File 'lib/jisota/param.rb', line 22

def default
  options[:default]
end

#default?Boolean

Returns:

  • (Boolean)


18
19
20
# File 'lib/jisota/param.rb', line 18

def default?
  options.has_key?(:default)
end

#required?Boolean

Returns:

  • (Boolean)


26
27
28
# File 'lib/jisota/param.rb', line 26

def required?
  !!options[:required]
end

#splat?Boolean

Returns:

  • (Boolean)


30
31
32
# File 'lib/jisota/param.rb', line 30

def splat?
  !!options[:splat]
end