Module: Ridley::Mixin::ParamsValidate
- Included in:
- Chef::Cookbook::Metadata
- Defined in:
- lib/ridley/mixin/params_validate.rb
Overview
Borrowed and modified from: https://raw.github.com/opscode/chef/11.4.0/lib/chef/mixin/params_validate.rb
- Copyright
-
Copyright © 2008 Opscode, Inc.
Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Instance Method Summary collapse
- #set_or_return(symbol, arg, validation) ⇒ Object
-
#validate(opts, map) ⇒ Object
Takes a hash of options, along with a map to validate them.
Instance Method Details
#set_or_return(symbol, arg, validation) ⇒ Object
74 75 76 77 78 79 80 81 82 83 84 85 86 |
# File 'lib/ridley/mixin/params_validate.rb', line 74 def set_or_return(symbol, arg, validation) iv_symbol = "@#{symbol.to_s}".to_sym map = { symbol => validation } if arg == nil && self.instance_variable_defined?(iv_symbol) == true self.instance_variable_get(iv_symbol) else opts = validate({ symbol => arg }, { symbol => validation }) self.instance_variable_set(iv_symbol, opts[symbol]) end end |
#validate(opts, map) ⇒ Object
Takes a hash of options, along with a map to validate them. Returns the original options hash, plus any changes that might have been made (through things like setting default values in the validation map)
For example:
validate({ :one => "neat" }, { :one => { :kind_of => String }})
Would raise an exception if the value of :one above is not a kind_of? string. Valid map options are:
- :default
-
Sets the default value for this parameter.
- :callbacks
-
Takes a hash of Procs, which should return true if the argument is valid. The key will be inserted into the error message if the Proc does not return true:
"Option #{key}'s value #{value} #{}!"
- :kind_of
-
Ensure that the value is a kind_of?(Whatever). If passed an array, it will ensure that the value is one of those types.
- :respond_to
-
Ensure that the value has a given method. Takes one method name or an array of method names.
- :required
-
Raise an exception if this parameter is missing. Valid values are true or false, by default, options are not required.
- :regex
-
Match the value of the paramater against a regular expression.
- :equal_to
-
Match the value of the paramater with ==. An array means it can be equal to any of the values.
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 |
# File 'lib/ridley/mixin/params_validate.rb', line 42 def validate(opts, map) #-- # validate works by taking the keys in the validation map, assuming it's a hash, and # looking for _pv_:symbol as methods. Assuming it find them, it calls the right # one. #++ raise ArgumentError, "Options must be a hash" unless opts.kind_of?(Hash) raise ArgumentError, "Validation Map must be a hash" unless map.kind_of?(Hash) map.each do |key, validation| unless key.kind_of?(Symbol) || key.kind_of?(String) raise ArgumentError, "Validation map keys must be symbols or strings!" end case validation when true _pv_required(opts, key) when false true when Hash validation.each do |check, carg| check_method = "_pv_#{check.to_s}" if self.respond_to?(check_method, true) self.send(check_method, opts, key, carg) else raise ArgumentError, "Validation map has unknown check: #{check}" end end end end opts end |