Module: Nakischema

Defined in:
lib/nakischema.rb

Constant Summary collapse

Error = 
Class.new RuntimeError

Class Method Summary collapse

Class Method Details

.fixture(_, no_shuffle = false) ⇒ Object 



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/nakischema.rb', line 151

def self.fixture _, no_shuffle = false
  require "regexp-examples"
  require "addressable"
  case _
  when NilClass ; nil
  when Hash
    case _.keys
    when %i{ hash     } ;   _[:hash    ].map{ |k,v| [k,fixture(v,no_shuffle)] }                .then{ |_| no_shuffle ? _ : _.shuffle }.to_h
    when %i{ hash_req } ; [*_[:hash_req].map{ |k,v| [k,fixture(v,no_shuffle)] }, ["foo","bar"]].then{ |_| no_shuffle ? _ : _.shuffle }.to_h   # TODO: assert no collision
    when %i{ size each } ; Array.new(_[:size].max){ fixture _[:each], no_shuffle }
    else ; fail _.keys.inspect
    end
  when Array ; [Array] == _.map(&:class) ? _[0].map{ |_| fixture _, no_shuffle } : fixture(_.sample, no_shuffle)
  when Regexp
    begin
      URI(t = _.random_example)
    rescue URI::InvalidURIError
      begin
        URI Addressable::URI.escape t
      rescue Addressable::URI::InvalidURIError
        t
      end
    end.to_s
  when Range ; rand _
  when String ; _
  when TrueClass ; true
  when Class
    case _.name
    when "Integer" ; -rand(1000000)
    when "String" ; SecureRandom.random_bytes(1000).force_encoding("utf-8").scrub
    when "Hash" ; {}
    else ; fail "bad fixture node class name: #{_.name}"
    end
  else ; fail "bad fixture node class: #{_.class.inspect}"
  end
end

.valid?(object, schema) ⇒ Boolean

Returns:

  • (Boolean) 


89
90
91
92
93
94
 
# File 'lib/nakischema.rb', line 89

def self.valid? object, schema
  validate object, schema
  true
rescue Error
  false
end

.validate(object, schema, message = nil, path: []) ⇒ 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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/nakischema.rb', line 4

def self.validate object, schema, message = nil, path: []
  raise_with_path = lambda do |msg, _path = path|
    raise Error.new "#{msg}#{" (at #{_path})" unless _path.empty?}#{" #{message.respond_to?(:call) ? message[object] : message}" if message}"  # TODO: lambda message?
  end
  # TODO: maybe move '(at ...)' to the beginning
  case schema
  when NilClass, TrueClass, FalseClass, String, Symbol ; raise_with_path.call "expected #{schema.inspect} != #{object.inspect}" unless schema === object
  # TODO: maybe deprecate the NilClass, TrueClass, FalseClass since they can be asserted via the next case branch
  when Class                                           ; raise_with_path.call "expected #{schema        } != #{object.class  }" unless schema === object
  when Regexp                                          ; raise_with_path.call "expected #{schema        } != #{object.inspect}" unless schema === object
  when Range                                           ; raise_with_path.call "expected #{schema        } != #{object.inspect}" unless schema.include? object
  when Hash
    raise_with_path.call "expected Hash != #{object.class}" unless object.is_a? Hash unless (schema.keys & %i{ keys each_key each_value }).empty?
    raise_with_path.call "expected Array != #{object.class}" unless object.is_a? Array unless (schema.keys & %i{ size }).empty?   # TODO: maybe allow Hash object?
    schema.each do |k, v|
      case k
      when :size ; raise_with_path.call "expected Range != #{v.class}" unless v.is_a? Range
                   raise_with_path.call "expected explicit size #{v} != #{object.size}" unless v.include? object.size
      # when Fixnum
      #   raise_with_path.call "expected Array != #{object.class}" unless object.is_a? Array
      #   validate object[k], v, path: [*path, :"##{k}"]
      when :keys ; validate object.keys, v, message, path: [*path, :keys]
      when :values ; validate object.values, v, message, path: [*path, :values]
      when :keys_sorted ; validate object.keys.sort, v, message, path: [*path, :keys_sorted]   # TODO: maybe copypaste the Array validation to reduce [] nesting
      when :hash_opt ; raise_with_path.call "expected Hash != #{object.class}" unless object.is_a? Hash
                       v.each{ |k, v| validate object.fetch(k), v, message, path: [*path, k] if object.key? k }
      when :hash_req ; raise_with_path.call "expected Hash != #{object.class}" unless object.is_a? Hash
                       raise_with_path.call "expected required keys #{v.keys.sort} ∉ #{object.keys.sort}" unless (v.keys - object.keys).empty?
                       v.each{ |k, v| validate object.fetch(k), v, message, path: [*path, k] }
      when :hash     ; raise_with_path.call "expected Hash != #{object.class}" unless object.is_a? Hash
                       hash_wo_opt = object.keys.sort - schema.fetch(:hash_opt, {}).keys
                       raise_with_path.call "expected implicit keys #{v.keys.sort} != #{hash_wo_opt}" unless v.keys.sort == hash_wo_opt
                       v.each{ |k, v| validate object.fetch(k), v, message, path: [*path, k] }
      when :each_key ; object.keys.each_with_index{ |k, i| validate k, v, message, path: [*path, :"key##{i}"] }
      when :each_value ; object.values.each_with_index{ |v_, i| validate v_, v, message, path: [*path, :"value##{i}"] }
      when :method ; v.each{ |m, e| validate object.public_method(m).call, e, message, path: [*path, :"method##{m}"] }
      when :each
        raise_with_path.call "expected iterable != #{object.class}" unless object.respond_to? :each_with_index
        object.each_with_index{ |e, i| validate e, v, message, path: [*path, :"##{i}"] }
      # when :case
      #   raise_with_path.call "expected at least one of #{v.size} cases to match the #{object.inspect}" if v.map.with_index do |(k, v), i|
      #     next if begin
      #       validate object, k
      #       nil
      #     rescue Error => e
      #       e
      #     end
      #     validate object, v, path: [*path, :"case##{i}"]
      #     true
      #   end.none?
      when :assertions
        v.each_with_index do |assertion, i|
          begin
            raise Error.new "custom assertion failed" unless assertion.call object, [*path, :"assertion##{i}"]
          rescue Error => e
            raise_with_path.call e, [*path, :"assertion##{i}"]
          end
        end
      else
        raise_with_path.call "unsupported rule #{k.inspect}"
      end
    end
  when Array
    if schema.map(&:class) == [Array]
      raise_with_path.call "expected Array != #{object.class}" unless object.is_a? Array
      raise_with_path.call "expected implicit size #{schema[0].size} != #{object.size} for #{object.inspect}" unless schema[0].size == object.size
      object.zip(schema[0]).each_with_index{ |(o, v), i| validate o, v, message, path: [*path, :"##{i}"] }
    else
      results = schema.lazy.with_index.map do |v, i|
        # raise_with_path.call "unsupported nested Array" if v.is_a? Array
        begin
          validate object, v, message, path: [*path, :"variant##{i}"]
          nil
        rescue Error => e
          e
        end
      end
      raise Error.new "expected at least one of #{schema.size} rules to match the #{object.inspect}, errors:\n" +
        results.force.compact.map{ |_| _.to_s.gsub(/^/, "  ") }.join("\n") if results.all?
    end
  else
    raise_with_path.call "unsupported rule class #{schema.class}"
  end
end

.validate_oga_xml(object, schema, path = []) ⇒ Object 



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/nakischema.rb', line 96

def self.validate_oga_xml object, schema, path = []
  raise_with_path = lambda do |msg, _path = path|
    raise Error.new "#{msg}#{" (at #{_path})" unless _path.empty?}"
  end
  case schema
  when String, Regexp ; raise_with_path.call "expected #{schema.inspect} != #{object.inspect}" unless schema === object
  when Hash
    schema.each do |k, v|
      case k
      when :size ; raise_with_path.call "expected explicit size #{v} != #{object.size}" unless v.include? object.size
      when :text ; raise_with_path.call "expected text #{v.inspect} != #{object.text.inspect}" unless v == object.text
      when :each ; raise_with_path.call "expected iterable != #{object.class}" unless object.respond_to? :each_with_index
                   object.each_with_index{ |e, i| validate_oga_xml e, v, [*path, :"##{i}"] }
      when :exact ; children = object.xpath "./*"
                    names = children.map(&:name).uniq
                    raise_with_path.call "expected implicit children #{v.keys} != #{names}" unless v.keys == names
                    v.each{ |k, v| validate_oga_xml children.select{ |_| _.name == k }, v, [*path, k] }
      when :children   ; v.each{ |k, v| validate_oga_xml object.xpath(k.start_with?("./") ? k : "./#{k}"), v, [*path, k] }
      when :attr_exact ; names = object.attributes.map &:name
                         raise_with_path.call "expected implicit attributes #{v.keys} != #{names}" unless v.keys == names
                         v.each{ |k, v| validate_oga_xml object[k], v, [*path, k] }
      when :attr_req   ; v.each{ |k, v| validate_oga_xml object[k], v, [*path, k] }
      when :assertions
        v.each_with_index do |assertion, i|
          begin
            raise Error.new "custom assertion failed" unless assertion.call object, [*path, :"assertion##{i}"]
          rescue Error => e
            raise_with_path.call e, [*path, :"assertion##{i}"]
          end
        end
      else
        raise_with_path.call "unsupported rule #{k.inspect}"
      end
    end
  when Array
    if schema.map(&:class) == [Array]
      raise_with_path.call "expected implicit size #{schema[0].size} != #{object.size} for #{object.inspect}" unless schema[0].size == object.size
      object.zip(schema[0]).each_with_index{ |(o, v), i| validate_oga_xml o, v, [*path, :"##{i}"] }
    else
      results = schema.lazy.with_index.map do |v, i|
        begin
          validate_oga_xml object, v, [*path, :"variant##{i}"]
          nil
        rescue Error => e
          e
        end
      end
      raise Error.new "expected at least one of #{schema.size} rules to match the #{object.inspect}, errors:\n" +
        results.force.compact.map{ |_| _.to_s.gsub(/^/, "  ") }.join("\n") if results.all?
    end
  else
    raise_with_path.call "unsupported rule class #{schema.class}"
  end
end