Class: Parametron::ParamsValidator

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

Defined Under Namespace

Classes: GenericParameter, OptionalParameter, RequiredParameter

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(opts) ⇒ ParamsValidator

Returns a new instance of ParamsValidator.



5
6
7
8
9
10
 
# File 'lib/parametron/params_validator.rb', line 5

def initialize(opts)
  @reject_unexpected = opts.fetch(:reject, true)
  @raise_on_excess   = opts.fetch(:strict, false)
  self.required_vals = []
  self.optional_vals = []
end

Instance Attribute Details

#optional_vals ⇒ Object

Returns the value of attribute optional_vals.



3
4
5
 
# File 'lib/parametron/params_validator.rb', line 3

def optional_vals
  @optional_vals
end

#required_vals ⇒ Object

Returns the value of attribute required_vals.



3
4
5
 
# File 'lib/parametron/params_validator.rb', line 3

def required_vals
  @required_vals
end

Instance Method Details

#optional(name, opts = {}) ⇒ Object

Raises:

  • (Parametron::ErrorMethodParams) 


12
13
14
15
16
17
18
 
# File 'lib/parametron/params_validator.rb', line 12

def optional(name, opts={})
  default   = opts.delete(:default)
  validator = opts.delete(:validator)
  as        = opts.delete(:as)
  raise Parametron::ErrorMethodParams.new("Not available param: #{opts.inspect}") unless opts.empty?
  self.optional_vals << OptionalParameter.new(name.to_s, default, validator, as)
end

#required(name, opts = {}) ⇒ Object

Raises:

  • (Parametron::ErrorMethodParams) 


20
21
22
23
24
25
26
 
# File 'lib/parametron/params_validator.rb', line 20

def required(name, opts={})
  default   = opts.delete(:default)
  validator = opts.delete(:validator)
  as        = opts.delete(:as)
  raise Parametron::ErrorMethodParams.new("Not available param: #{opts.inspect}") unless opts.empty?
  self.required_vals << RequiredParameter.new(name.to_s, default, validator, as)
end

#validate!(obj, params) ⇒ Object 



28
29
30
31
32
33
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/parametron/params_validator.rb', line 28

def validate!(obj, params)
  obj.validation_error_cause = []
  normalized_param_keys = params.keys.map(&:to_s).sort
  exceed_params = normalized_param_keys - valid_keys
  if exceed_params.any?
    exceed_params.each do |par|
      obj.validation_error_cause << [par, params[par.to_sym]]
    end
    raise Parametron::ExcessParameter.new(exceed_params.to_s)  if @raise_on_excess
  end

  key_common = normalized_param_keys & required_keys
  if key_common != required_keys
    missing = required_keys - key_common
    obj.validation_error_cause << missing
    raise Parametron::RequiredParamError.new(missing)
  end

  params.each do |k, v|
    key = k.to_s
    unless valid_keys.include?(key)
      params.delete(key) if @reject_unexpected
      next
    end
    validators.find{|val| val.name == key}.tap do |curr_val|
      unless curr_val.valid?(v)
        obj.validation_error_cause << [key, v]
        raise Parametron::MalformedParams.new(key)
      end
    end
  end

end