File: instance.rb

package info (click to toggle)
ruby-autoparse 0.3.3-3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, forky, sid, trixie
  • size: 364 kB
  • sloc: ruby: 2,250; makefile: 5
file content (483 lines) | stat: -rw-r--r-- 15,248 bytes parent folder | download
1
2
3
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
88
89
90
91
92
93
94
95
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
150
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
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
# Copyright 2010 Google 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.


require 'multi_json'
require 'time'
require 'autoparse/inflection'
require 'addressable/uri'

module AutoParse
  class Instance
    def self.uri
      return (@uri ||=
        (@schema_data ? Addressable::URI.parse(@schema_data['id']) : nil)
      )
    end

    def self.dereference
      if @schema_data['$ref']
        # Dereference the schema if necessary.
        ref_uri = Addressable::URI.parse(@schema_data['$ref'])
        if self.uri
          schema_uri =
            self.uri + Addressable::URI.parse(@schema_data['$ref'])
        else
          if ref_uri.relative?
            warn("Schema URI is relative, could not resolve against parent.")
          else
            warn("Could not resolve URI against parent.")
          end
          schema_uri = ref_uri
        end
        schema_class = AutoParse.schemas[schema_uri]
        warn("Schema URI mismatch.") if schema_class.uri != schema_uri
        if schema_class == nil
          raise ArgumentError,
            "Could not find schema: #{@schema_data['$ref']}. " +
            "Referenced schema must be parsed first."
        else
          return schema_class
        end
      else
        return self
      end
    end

    def self.properties
      return @properties ||= (
        if self.superclass.ancestors.include?(::AutoParse::Instance)
          self.superclass.properties.dup
        else
          {}
        end
      )
    end

    def self.property(property_name)
      property_key = self.keys[property_name] || property_name
      schema_class = self.properties[property_key]
      if !schema_class
        if self.data[property_name]
          schema_class = AutoParse.generate(self.data[property_name], :parent => self)
        else
          schema_class = self.additional_properties_schema
        end
      end
      if schema_class.data['$ref']
        # Dereference the schema if necessary.
        schema_class = schema_class.dereference
        # Avoid this dereference in the future.
        self.properties[property_key] = schema_class
      end
      return schema_class
    end
    
    def self.keys
      return @keys ||= (
        if self.superclass.ancestors.include?(::AutoParse::Instance)
          self.superclass.keys.dup
        else
          {}
        end
      )
    end

    def self.additional_properties_schema
      return EMPTY_SCHEMA
    end

    def self.property_dependencies
      return @property_dependencies ||= {}
    end

    def self.data
      return @schema_data ||= {}
    end

    def self.description
      return self.data['description']
    end

    def self.validate_string_property(property_value, schema_data)
      property_value = property_value.to_str rescue property_value
      if !property_value.kind_of?(String)
        return false
      else
        # TODO: implement more than type-checking
        return true
      end
    end

    def self.validate_boolean_property(property_value, schema_data)
      return false if property_value != true && property_value != false
      # TODO: implement more than type-checking
      return true
    end

    def self.validate_integer_property(property_value, schema_data)
      return false if !property_value.kind_of?(Integer)
      if schema_data['minimum'] && schema_data['exclusiveMinimum']
        return false if property_value <= schema_data['minimum']
      elsif schema_data['minimum']
        return false if property_value < schema_data['minimum']
      end
      if schema_data['maximum'] && schema_data['exclusiveMaximum']
        return false if property_value >= schema_data['maximum']
      elsif schema_data['maximum']
        return false if property_value > schema_data['maximum']
      end
      return true
    end

    def self.validate_number_property(property_value, schema_data)
      return false if !property_value.kind_of?(Numeric)
      # TODO: implement more than type-checking
      return true
    end

    def self.validate_array_property(property_value, schema_data)
      if property_value.respond_to?(:to_ary)
        property_value = property_value.to_ary
      else
        return false
      end
      property_value.each do |item_value|
        unless self.validate_property_value(item_value, schema_data['items'])
          return false
        end
      end
      return true
    end

    def self.validate_object_property(property_value, schema_data)
      if property_value.kind_of?(Instance)
        return property_value.valid?
      else
        # This is highly ineffecient, but currently hard to avoid given the
        # schema is anonymous, making lookups very difficult.
        schema = AutoParse.generate(schema_data, :parent => self)
        begin
          return schema.new(property_value).valid?
        rescue TypeError, ArgumentError, ::JSON::ParserError
          return false
        end
      end
    end

    def self.validate_union_property(property_value, schema_data)
      union = schema_data['type']
      possible_types = [union].flatten.compact
      for type in possible_types
        case type
        when 'string'
          return true if self.validate_string_property(
            property_value, schema_data
          )
        when 'boolean'
          return true if self.validate_boolean_property(
            property_value, schema_data
          )
        when 'integer'
          return true if self.validate_integer_property(
            property_value, schema_data
          )
        when 'number'
          return true if self.validate_number_property(
            property_value, schema_data
          )
        when 'array'
          return true if self.validate_array_property(
            property_value, schema_data
          )
        when 'object'
          return true if self.validate_object_property(
            property_value, schema_data
          )
        when 'null'
          return true if property_value.nil?
        when 'any'
          return true
        end
      end
      # None of the union types validated.
      # An empty union will fail to validate anything.
      return false
    end

    ##
    # @api private
    def self.validate_property_value(property_value, schema_data)
      if property_value == nil && schema_data['required'] == true
        return false
      elsif property_value == nil
        # Value was omitted, but not required. Still valid.
        return true
      end

      # Verify property values
      if schema_data['$ref']
        if self.uri
          schema_uri = self.uri + Addressable::URI.parse(schema_data['$ref'])
        else
          schema_uri = Addressable::URI.parse(schema_data['$ref'])
        end
        schema = AutoParse.schemas[schema_uri]
        if schema == nil
          raise ArgumentError,
            "Could not find schema: #{schema_data['$ref']}. " +
            "Referenced schema must be parsed first."
        end
        schema_data = schema.data
      end
      case schema_data['type']
      when 'string'
        return false unless self.validate_string_property(
          property_value, schema_data
        )
      when 'boolean'
        return false unless self.validate_boolean_property(
          property_value, schema_data
        )
      when 'integer'
        return false unless self.validate_integer_property(
          property_value, schema_data
        )
      when 'number'
        return false unless self.validate_number_property(
          property_value, schema_data
        )
      when 'array'
        return false unless self.validate_array_property(
          property_value, schema_data
        )
      when 'object'
        return false unless self.validate_object_property(
          property_value, schema_data
        )
      when 'null'
        return false unless property_value.nil?
      when Array
        return false unless self.validate_union_property(
          property_value, schema_data
        )
      else
        # Either type 'any' or we don't know what this is,
        # default to anything goes. Validation of an 'any' property always
        # succeeds.
      end
      return true
    end

    def initialize(data={})
      if (self.class.data || {})['type'] == nil
        # Type is omitted, default value is any.
      else
        type_set = [(self.class.data || {})['type']].flatten.compact
        if !type_set.include?('object')
          raise TypeError,
            "Only schemas of type 'object' are instantiable:\n" +
            "#{self.class.data.inspect}"
        end
      end
      if data.respond_to?(:to_hash)
        data = data.to_hash
      elsif data.respond_to?(:to_json)
        data = JSON.parse(data.to_json)
      else
        raise TypeError,
          'Unable to parse. ' +
          'Expected data to respond to either :to_hash or :to_json.'
      end
      unless data.is_a?(Hash)
        raise TypeError,
          "Fallback. Data expected to be a hash. :to_json might have processed it anyway."
      end
      if data['$ref']
        raise TypeError,
          "Cannot instantiate a reference schema. Must be dereferenced first."
      end
      @data = data
    end

    def method_missing(method, *params, &block)
      schema_data = self.class.data
      unless schema_data['additionalProperties']
        # Do nothing special if additionalProperties is not set.
        super
      else
        # We can't modify the method in-place because this affects the call
        # to super.
        property_name = method.to_s
        assignment = false
        # Property names simply identify the property and thus don't
        # include the assignment operator.
        if property_name[-1..-1] == '='
          assignment = true
          property_name[-1..-1] = ''
        end
        property_key = self.class.keys[property_name]
        property_schema = self.class.properties[property_key]
        # TODO: Properly support additionalProperties.
        if property_key == nil || property_schema == nil
          # Method not found.
          return super
        end
        # If additionalProperties is simply set to true, no parsing takes
        # place and all values are treated as 'any'.
        if assignment
          new_value = params[0]
          __set__(property_name, new_value)
        else
          __get__(property_name)
        end
      end
    end

    def __get__(property_name)
      property_key = self.class.keys[property_name] || property_name
      schema_class = self.class.property(property_name)
      if !schema_class
        @data[property_key]
      else
        if @data.has_key?(property_key)
          value = @data[property_key]
        else
          value = schema_class.data['default']
        end
        AutoParse.import(value, schema_class)
      end    end
    protected :__get__

    def __set__(property_name, value)
      property_key = self.class.keys[property_name] || property_name
      schema_class = self.class.property(property_name)
      if !schema_class
        @data[property_key] = value
      else
        @data[property_key] = AutoParse.export(value, schema_class)
      end
    end
    protected :__set__

    def [](key, raw=false)
      if raw == true
        return @data[key]
      else
        return self.__get__(key)
      end
    end

    def []=(key, raw=false, value=:undefined)
      if value == :undefined
        # Due to the way Ruby handles default values in assignment methods,
        # we have to swap some values around here.
        raw, value = false, raw
      end
      if raw == true
        return @data[key] = value
      else
        return self.__set__(key, value)
      end
    end

    ##
    # Validates the parsed data against the schema.
    def valid?
      unvalidated_fields = @data.keys.dup
      for property_key, schema_class in self.class.properties
        property_value = @data[property_key]
        if !self.class.validate_property_value(
            property_value, schema_class.data)
          return false
        end
        if property_value == nil && schema_class.data['required'] != true
          # Value was omitted, but not required. Still valid. Skip dependency
          # checks.
          next
        end

        # Verify property dependencies
        property_dependencies = self.class.property_dependencies[property_key]
        case property_dependencies
        when String, Array
          property_dependencies = [property_dependencies].flatten
          for dependency_key in property_dependencies
            dependency_value = @data[dependency_key]
            return false if dependency_value == nil
          end
        when Class
          if property_dependencies.ancestors.include?(Instance)
            dependency_instance = property_dependencies.new(property_value)
            return false unless dependency_instance.valid?
          else
            raise TypeError,
              "Expected schema Class, got #{property_dependencies.class}."
          end
        end
      end
      if self.class.additional_properties_schema == nil
        # No additional properties allowed
        return false unless unvalidated_fields.empty?
      elsif self.class.additional_properties_schema != EMPTY_SCHEMA
        # Validate all remaining fields against this schema
        for property_key in unvalidated_fields
          property_value = @data[property_key]
          if !self.class.additional_properties_schema.validate_property_value(
              property_value, self.class.additional_properties_schema.data)
            return false
          end
        end
      end
      if self.class.superclass && self.class.superclass != Instance &&
          self.class.ancestors.first != Instance
        # The spec actually only defined the 'extends' semantics as children
        # must also validate aainst the parent.
        return false unless self.class.superclass.new(@data).valid?
      end
      return true
    end

    def to_hash
      return @data
    end

    ##
    # Converts the instance value to JSON.
    #
    # @return [String] The instance value converted to JSON.
    #
    # @note
    #   Ignores extra arguments to avoid throwing errors w/ certain JSON
    #   libraries.
    def to_json(*args)
      return MultiJson.dump(self.to_hash)
    end

    ##
    # Returns a <code>String</code> representation of the schema instance.
    #
    # @return [String] The instance's state, as a <code>String</code>.
    def inspect
      sprintf(
        "#<%s:%#0x DATA:%s>",
        self.class.to_s, self.object_id, self.to_hash.inspect
      )
    end
  end

  ##
  # The empty schema accepts all JSON.
  EMPTY_SCHEMA = Instance
end