Class: JSON::Schema::TypeAttribute

Inherits:
Attribute
  • Object
show all
Defined in:
lib/json-schema/attributes/type.rb

Constant Summary collapse

TYPE_CLASS_MAPPINGS =
{
  "string" => String,
  "number" => Numeric,
  "integer" => Integer,
  "boolean" => [TrueClass, FalseClass],
  "object" => Hash,
  "array" => Array,
  "null" => NilClass,
  "any" => Object
}

Class Method Summary collapse

Methods inherited from Attribute

build_fragment, validation_error, validation_errors

Class Method Details

.data_valid_for_type?(data, type) ⇒ Boolean

Returns:

  • (Boolean)


84
85
86
87
# File 'lib/json-schema/attributes/type.rb', line 84

def self.data_valid_for_type?(data, type)
  valid_classes = TYPE_CLASS_MAPPINGS.fetch(type) { return true }
  Array(valid_classes).any? { |c| data.is_a?(c) }
end

.type_of_data(data) ⇒ Object

Lookup Schema type of given class instance



90
91
92
93
94
95
96
97
98
99
# File 'lib/json-schema/attributes/type.rb', line 90

def self.type_of_data(data)
  type, klass = TYPE_CLASS_MAPPINGS.map { |k,v| [k,v] }.sort_by { |i|
    k,v = i
    -Array(v).map { |klass| klass.ancestors.size }.max
  }.find { |i|
    k,v = i
    Array(v).any? { |klass| data.kind_of?(klass) }
  }
  type
end

.validate(current_schema, data, fragments, processor, validator, options = {}) ⇒ Object



4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
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
61
62
63
64
65
66
67
68
69
70
71
# File 'lib/json-schema/attributes/type.rb', line 4

def self.validate(current_schema, data, fragments, processor, validator, options = {})
  union = true
  if options[:disallow]
    types = current_schema.schema['disallow']
  else
    types = current_schema.schema['type']
  end

  if !types.is_a?(Array)
    types = [types]
    union = false
  end
  valid = false

  # Create an array to hold errors that are generated during union validation
  union_errors = []

  types.each do |type|
    if type.is_a?(String)
      valid = data_valid_for_type?(data, type)
    elsif type.is_a?(Hash) && union
      # Validate as a schema
      schema = JSON::Schema.new(type,current_schema.uri,validator)

      # We're going to add a little cruft here to try and maintain any validation errors that occur in this union type
      # We'll handle this by keeping an error count before and after validation, extracting those errors and pushing them onto a union error
      pre_validation_error_count = validation_errors(processor).count

      begin
        schema.validate(data,fragments,processor,options)
        valid = true
      rescue ValidationError
        # We don't care that these schemas don't validate - we only care that one validated
      end

      diff = validation_errors(processor).count - pre_validation_error_count
      valid = false if diff > 0
      while diff > 0
        diff = diff - 1
        union_errors.push(validation_errors(processor).pop)
      end
    end

    break if valid
  end

  if (options[:disallow])
    if valid
      message = "The property '#{build_fragment(fragments)}' matched one or more of the following types:"
      types.each {|type| message += type.is_a?(String) ? " #{type}," : " (schema)," }
      message.chop!
      validation_error(processor, message, fragments, current_schema, self, options[:record_errors])
    end
  elsif !valid
    if union
      message = "The property '#{build_fragment(fragments)}' of type #{type_of_data(data)} did not match one or more of the following types:"
      types.each {|type| message += type.is_a?(String) ? " #{type}," : " (schema)," }
      message.chop!
      validation_error(processor, message, fragments, current_schema, self, options[:record_errors])
      validation_errors(processor).last.sub_errors = union_errors
    else
      message = "The property '#{build_fragment(fragments)}' of type #{type_of_data(data)} did not match the following type:"
      types.each {|type| message += type.is_a?(String) ? " #{type}," : " (schema)," }
      message.chop!
      validation_error(processor, message, fragments, current_schema, self, options[:record_errors])
    end
  end
end