Class: ParamsValidator::Parameter

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

Overview

Parameter definition

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, klass = Object, optional = false, rule = nil) ⇒ Parameter

Returns a new instance of Parameter.



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

def initialize(name, klass = Object, optional = false, rule = nil)
  @name = name.to_sym
  @optional = optional
  @klass = klass
  @rule = rule
end

Instance Attribute Details

#klass ⇒ Object

parameter type (Object by default)



19
20
21
 
# File 'lib/params_validator/parameter.rb', line 19

def klass
  @klass
end

#name ⇒ Object

parameter name



13
14
15
 
# File 'lib/params_validator/parameter.rb', line 13

def name
  @name
end

#optional ⇒ Object

set if parameter is mandatory or optional



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

def optional
  @optional
end

#rule ⇒ Object

specific ruleset (i.e. max or min length)



22
23
24
 
# File 'lib/params_validator/parameter.rb', line 22

def rule
  @rule
end

Instance Method Details

#mandatory? ⇒ Boolean

Returns:

  • (Boolean) 


35
36
37
 
# File 'lib/params_validator/parameter.rb', line 35

def mandatory?
  !@optional
end

#optional? ⇒ Boolean

Returns:

  • (Boolean) 


31
32
33
 
# File 'lib/params_validator/parameter.rb', line 31

def optional?
  @optional
end