to create new validator, inherit from Apipie::Validator::Base and implement class method build and instance method validate
find the right validator for given options
# File lib/apipie/validator.rb, line 31 def self.find(param_description, argument, options, block) @validators.each do |validator_type| validator = validator_type.build(param_description, argument, options, block) return validator if validator end return nil end
# File lib/apipie/validator.rb, line 25 def self.inherited(subclass) @validators ||= [] @validators.insert 0, subclass end
# File lib/apipie/validator.rb, line 11 def initialize(param_description) @param_description = param_description end
# File lib/apipie/validator.rb, line 87 def ==(other) return false unless self.class == other.class if param_description == other.param_description true else false end end
validator description
# File lib/apipie/validator.rb, line 55 def description "TODO: validator description" end
# File lib/apipie/validator.rb, line 59 def error ParamInvalid.new(param_name, @error_value, description) end
what type is expected, mostly string this information is used in cli client thor supported types :string, :hash, :array, :numeric, or :boolean
# File lib/apipie/validator.rb, line 74 def expected_type 'string' end
# File lib/apipie/validator.rb, line 19 def inspect string = "#<#{self.class.name}:#{self.object_id} " fields = inspected_fields.map {|field| "#{field}: #{self.send(field)}"} string << fields.join(", ") << ">" end
# File lib/apipie/validator.rb, line 15 def inspected_fields [:param_description] end
# File lib/apipie/validator.rb, line 78 def merge_with(other_validator) return self if self == other_validator raise NotImplementedError, "Don't know how to merge #{self.inspect} with #{other_validator.inspect}" end
# File lib/apipie/validator.rb, line 50 def param_name @param_description.name end
# File lib/apipie/validator.rb, line 83 def params_ordered nil end
# File lib/apipie/validator.rb, line 67 def to_json self.description end
# File lib/apipie/validator.rb, line 63 def to_s self.description end
check if value is valid
# File lib/apipie/validator.rb, line 40 def valid?(value) if self.validate(value) @error_value = nil true else @error_value = value false end end