blumquist 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 389e1b2f8a0295f3c975f7b3877da1877c32d150
-  data.tar.gz: d144ddd0daf59b3ce2719bfe60b7787d0b263417
+  metadata.gz: 3ee6152ea1367e4b7e55b943b64f0e299a29eb8a
+  data.tar.gz: 3aa49823ff6acee7a49542e0029c88969d9c5ecc
 SHA512:
-  metadata.gz: 7b0d8b821d05fe847fc2670a86498849fb50f3b0ccfffb9c220c97876ca6d846eac7aadc93ac0692b7e1055d428552f8c4679bea7a57551b070ebb76371b6544
-  data.tar.gz: 335da3462e4abb87f212a5c63c83ab6fc6ae3196faeaec8293612a78f824bd98171b663e7e63562fd02fa804baf8502f49883b6d28f7b2785a814eb4150f3822
+  metadata.gz: 438a17212917a8dd877ad8d0ad3ca0657f2c0a0e929a3c6104578dee237720bdb734603b99b6aeaf4dbd24ae7c7cb04e325a2a0fc5d38e71ba07f2cf2c55984f
+  data.tar.gz: f0524889add5b31f04db920b48ffc378a264e538211282fa1da0872df4f60eee49751e796b2eefe6a3cd3966c302d79d4222496c34c96b4295df93144044988f

data/CHANGELOG.md

@@ -1,15 +1,19 @@
+# 0.4.0
+- Support properties with multiple types
+  (e.g. an object, but also null)
+
 # 0.3.2
-- fix #2 (arrays of primitives)
+- Fix #2 (arrays of primitives)
 
 # 0.3.1
-- support array type definitions that are expressed as an object
+- Support array type definitions that are expressed as an object
   or as an array of objects
 
 # 0.3.0
-- important whitespace changes
-- proper exceptions
-- disallow arrays with undefined item types
+- Important whitespace changes
+- Proper exceptions
+- Disallow arrays with undefined item types
 
 # 0.2.0 (Oct-30-15)
-- validate objects (if desired)
-- use keyword arguments (in <2.0 compat mode)
+- Validate objects (if desired)
+- Use keyword arguments (in <2.0 compat mode)

data/README.md

@@ -103,7 +103,7 @@ Or install it yourself as:
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub in the [issues section](https://github.com/moviepilot/blumquist/issues). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub in the [issues section](https://github.com/moviepilot/blumquist/issues). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 
 ## License

data/blumquist.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
   spec.add_development_dependency "coveralls"
   spec.add_development_dependency "simplecov"
   spec.add_development_dependency "guard-rspec"

data/lib/blumquist.rb

@@ -1,4 +1,4 @@
-require "blumquist/version"
+require 'blumquist/version'
 require 'active_support/core_ext/hash/indifferent_access'
 require 'json'
 require 'json-schema'
@@ -27,7 +27,7 @@ class Blumquist
 
   def validate_schema
     return if @schema[:type] == 'object'
-    raise(Errors::UnsupportedType, @schema[:type])
+    raise(Errors::UnsupportedSchema, type: @schema[:type])
   end
 
   def resolve_json_pointers
@@ -54,21 +54,28 @@ class Blumquist
 
   def define_getters
     @schema[:properties].each do |property, type_def|
+      types = [type_def[:type]].flatten - ["null"]
+      type = types.first
+
+      # The type_def can contain one or more types.
+      # We only support single types, or one
+      # normal type and the null type.
+      raise(Errors::UnsupportedType, type_def[:type]) if types.length > 1
 
       # Wrap objects recursively
-      if type_def[:type] == 'object'
+      if type == 'object' || type_def[:oneOf]
         blumquistify_object(property)
 
       # Turn array elements into Blumquists
-      elsif type_def[:type] == 'array'
+      elsif type == 'array'
         blumquistify_array(property)
 
       # Nothing to do for primitive values
-      elsif primitive_type?(type_def[:type])
+      elsif primitive_type?(type)
 
       # We don't know what to do, so let's panic
       else
-        raise(Errors::UnsupportedType, type_def[:type])
+        raise(Errors::UnsupportedType, type)
       end
 
       # And define the getter
@@ -88,7 +95,66 @@ class Blumquist
     sub_schema = @schema[:properties][property].merge(
       definitions: @schema[:definitions]
     )
-    @data[property] = Blumquist.new(schema: sub_schema, data: @data[property], validate: @validate)
+
+    # If properties are defined directly, like this:
+    #
+    #     { "type": "object", "properties": { ... } }
+    #
+    if sub_schema[:properties]
+      sub_blumquist = Blumquist.new(schema: sub_schema, data: @data[property], validate: @validate)
+      @data[property] = sub_blumquist
+      return
+    end
+
+    # Properties not defined directly, object must be 'oneOf',
+    # like this:
+    #
+    #    { "type": "object", "oneOf": [{...}] }
+    #
+    # The json schema v4 draft specifies, that:
+    #
+    #    "the oneOf keyword is new in draft v4; its value is an array of schemas, and an instance is valid if and only if it is valid against exactly one of these schemas"
+    #
+    # *See: http://json-schema.org/example2.html
+    #
+    # That means we can just go through the oneOfs and return
+    # the first that matches:
+    if sub_schema[:oneOf]
+      primitive_allowed = false
+      sub_schema[:oneOf].each do |one|
+        begin
+          if primitive_type?(one[:type])
+            primitive_allowed = true
+          else
+            if one[:type]
+              schema = one.merge(definitions: @schema[:definitions])
+            else
+              schema = resolve_json_pointer!(one).merge(
+                definitions: @schema[:definitions]
+              )
+            end
+            @data[property] = Blumquist.new(data: @data[property], schema: schema)
+            return
+          end
+        rescue
+          # On to the next oneOf
+        end
+      end
+
+      # We found no matching object definition.
+      # If a primitve is part of the `oneOfs,
+      # that's no problem though.
+      return if primitive_allowed
+
+      # We didn't find a schema in oneOf that matches our data
+      raise(Errors::NoCompatibleOneOf, one_ofs: sub_schema[:oneOf], data: @data[property])
+
+      return
+    end
+
+    # If there's neither `properties` nor `oneOf`, we don't
+    # know what to do and shall panic:
+    raise(Errors::MissingProperties, sub_schema)
   end
 
   def blumquistify_array(property)
@@ -112,7 +178,6 @@ class Blumquist
     # The items of this array are defined by a pointer
     if type_def[:$ref]
       item_schema = resolve_json_pointer!(type_def)
-      raise(Errors::MissingArrayItemsType, @schema[:properties][property]) unless item_schema
 
       sub_schema = item_schema.merge(
         definitions: @schema[:definitions]

data/lib/blumquist/error.rb

@@ -0,0 +1,4 @@
+class Blumquist
+  class Error < RuntimeError
+  end
+end

data/lib/blumquist/errors.rb

@@ -1 +1,7 @@
+require 'blumquist/error'
+require 'blumquist/errors/unsupported_schema'
 require 'blumquist/errors/unsupported_type'
+require 'blumquist/errors/invalid_pointer'
+require 'blumquist/errors/missing_array_items_type'
+require 'blumquist/errors/missing_properties'
+require 'blumquist/errors/no_compatible_one_of'

data/lib/blumquist/errors/invalid_pointer.rb

@@ -1,6 +1,6 @@
 class Blumquist
   module Errors
-    class InvalidPointer < RuntimeError
+    class InvalidPointer < Blumquist::Error
       def initialize(pointer)
         super("Could not find pointer #{pointer.to_s.to_json}")
       end

data/lib/blumquist/errors/missing_array_items_type.rb

@@ -1,6 +1,6 @@
 class Blumquist
   module Errors
-    class MissingArrayItemstype < RuntimeError
+    class MissingArrayItemstype < Blumquist::Error
       def initialize(property)
         super("Array items' type missing in #{property.to_json}")
       end

data/lib/blumquist/errors/missing_properties.rb

@@ -0,0 +1,9 @@
+class Blumquist
+  module Errors
+    class MissingProperties < Blumquist::Error
+      def initialize(type)
+        super("Neither 'properties' nor 'oneOf' defined in #{type.to_s.to_json}")
+      end
+    end
+  end
+end

data/lib/blumquist/errors/no_compatible_one_of.rb

@@ -0,0 +1,11 @@
+class Blumquist
+  module Errors
+    class NoCompatibleOneOf < Blumquist::Error
+      def initialize(options)
+        data = options[:data]
+        one_ofs = options[:one_ofs]
+        super("Could not find a matching schema for #{data.to_json} in the oneOfs: #{one_ofs.to_json}")
+      end
+    end
+  end
+end

data/lib/blumquist/errors/unsupported_schema.rb

@@ -0,0 +1,9 @@
+class Blumquist
+  module Errors
+    class UnsupportedSchema < Blumquist::Error
+      def initialize(type)
+        super("The top level object of the schema must be \"object\" (it is #{type.to_json})")
+      end
+    end
+  end
+end

data/lib/blumquist/errors/unsupported_type.rb

@@ -1,8 +1,8 @@
 class Blumquist
   module Errors
-    class UnsupportedType < RuntimeError
+    class UnsupportedType < Blumquist::Error
       def initialize(type)
-        super("Only null, boolean, number, string, array and object types are supported. Unsupported type #{type.to_s.to_json}")
+        super("Unsupported type '#{type.to_s}' (#{%w{null, boolean, number, string, array object}.to_json} are supported)")
       end
     end
   end

data/lib/blumquist/version.rb

@@ -1,3 +1,3 @@
 class Blumquist
-  VERSION = "0.3.2"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blumquist
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Jannis Hermanns
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-09 00:00:00.000000000 Z
+date: 2016-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -168,9 +182,13 @@ files:
 - Rakefile
 - blumquist.gemspec
 - lib/blumquist.rb
+- lib/blumquist/error.rb
 - lib/blumquist/errors.rb
 - lib/blumquist/errors/invalid_pointer.rb
 - lib/blumquist/errors/missing_array_items_type.rb
+- lib/blumquist/errors/missing_properties.rb
+- lib/blumquist/errors/no_compatible_one_of.rb
+- lib/blumquist/errors/unsupported_schema.rb
 - lib/blumquist/errors/unsupported_type.rb
 - lib/blumquist/version.rb
 homepage: https://github.com/moviepilot/blumquist
@@ -199,3 +217,4 @@ specification_version: 4
 summary: Turn some data and a json schema into an immutable object with getters from
   the schema
 test_files: []
+has_rdoc: