json_model_rb 0.1.12 → 0.1.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 452a7c1ae9d8d3c1df881d768520e439d92dce607b3e4fa609b8cafdce702b70
-  data.tar.gz: eba5d91dfd64620a0d64fd82e610837644d8e019fb3d7e4978eed050ea009487
+  metadata.gz: 55a34992353fa6800b488fba56a9516d78c0b1c256c987ea7f22cb61782477dc
+  data.tar.gz: c3d0b4289612c86e3e7ba805b26209534099503947df12885591decb2942a647
 SHA512:
-  metadata.gz: e9f23593b4a6d8647d0854be6c50e2e62ea5929571273bbe5229cf1f67f069d38638bd8cd2acc066fb69c513e48da929eed72782ba195bfd3d39f592391e9471
-  data.tar.gz: 777dd3fe984c380aabddd1d199e69bbaeafc94a5ebca9e6bf6a889138095133c8bb0ae002efcc944b733123a103b6adf06ab9e82b06d1654c86c9b23d137f2e6
+  metadata.gz: 128cceae1c36a9b9f130013417d2e0131a8b3b673b6cedde600297bb1d1d327fa7cfb91ebecf974af72f05e6efe96849ee2477f3e734b2b5e90ee6b0f2655c09
+  data.tar.gz: bb21f9d7ff5ccedcd7448f148d69ce78502b7f7200d0e6cb90edf5b54d77afae0284a3729c9d4dcba9fbac82253b3a95d957bd1aef56bc8a641453f0971a5283

data/README.md

@@ -623,7 +623,7 @@ class PaymentMethod
   title "Payment Method"
   description "Must specify exactly one payment method"
 
-  property :payment, type: T::OneOf[CreditCardPayment, PayPalPayment, BankTransferPayment]
+  property :payment, type: T::OneOf[CreditCardPayment, PayPalPayment, BankTransferPayment], discriminator: :payment_type
 end
 
 # Generate the JSON Schema

data/lib/json_model/properties.rb

@@ -25,6 +25,14 @@ module JsonModel
         @aliased_properties ||= {}
       end
 
+      # @param [Symbol] name
+      # @return [Symbol, nil]
+      def invert_alias(name)
+        aliased_properties[name]&.name || superclass&.invert_alias(name)
+      rescue NoMethodError
+        nil
+      end
+
       # @param [Symbol] name
       # @param [Object, Class] type
       # @param [Hash] options

data/lib/json_model/schema.rb

@@ -38,7 +38,7 @@ module JsonModel
       # @param [::Object] json
       # @return [::Object, nil]
       def from_json(json)
-        attributes = json.transform_keys { |key| aliased_properties[key]&.name || raise_unknown_attribute_error(key) }
+        attributes = json.transform_keys { |key| invert_alias(key) || raise_unknown_attribute_error(key) }
         new(attributes)
       end
 

data/lib/json_model/type_spec/composition/all_of.rb

@@ -17,7 +17,7 @@ module JsonModel
             return nil
           end
 
-          @types.map do |type|
+          types_for(json).map do |type|
             type.cast(json)
           rescue StandardError
             raise(Errors::TypeError, "Value #{json.inspect} cannot be cast to allOf type #{self}")

data/lib/json_model/type_spec/composition/any_of.rb

@@ -17,7 +17,7 @@ module JsonModel
             return nil
           end
 
-          type = @types.detect do |type|
+          type = types_for(json).detect do |type|
             type.cast(json)
           rescue StandardError
             false

data/lib/json_model/type_spec/composition/one_of.rb

@@ -17,7 +17,7 @@ module JsonModel
             return nil
           end
 
-          types = @types.select do |type|
+          types = types_for(json).select do |type|
             type.cast(json)
           rescue StandardError
             false

data/lib/json_model/type_spec/composition.rb

@@ -3,25 +3,28 @@
 module JsonModel
   class TypeSpec
     class Composition < TypeSpec
+      attr_reader(:types, :modifier, :discriminator)
+
       # @param [Symbol] modifier
-      # @param [TypeSpec] types
-      def initialize(modifier, *types)
+      # @param [::Array<TypeSpec>] types
+      def initialize(modifier, *types, discriminator: nil)
         super()
         @types = types
         @modifier = modifier
+        @discriminator = discriminator
       end
 
       # @param [Hash] options
       # @return [Hash]
       def as_schema(**options)
         {
-          @modifier => @types.map { |type| type.as_schema(**options) },
+          modifier => types.map { |type| type.as_schema(**options) },
         }
       end
 
       # @return [Array<TypeSpec>]
       def referenced_schemas
-        @types.flat_map(&:referenced_schemas)
+        types.flat_map(&:referenced_schemas)
       end
 
       # @param [::Object] json
@@ -29,6 +32,44 @@ module JsonModel
       def cast(json)
         raise(NotImplementedError)
       end
+
+      protected
+
+      # @return [Hash, nil]
+      def type_map
+        if discriminator.nil?
+          return nil
+        end
+
+        @type_map ||= types.each_with_object({}) do |type, hash|
+          if !type.is_a?(Object)
+            raise('Discriminator property can only be used with Object types')
+          end
+
+          discriminator_property = type.type.properties[discriminator]
+          discriminator_values = if discriminator_property&.type.is_a?(Const)
+                                   [discriminator_property.type.value]
+                                 elsif discriminator_property&.type.is_a?(Enum)
+                                   discriminator_property.type.values
+                                 else
+                                   raise('Discriminator property must be of type Const or Enum')
+                                 end
+          discriminator_values.each do |value|
+            hash[value] ||= []
+            hash[value] << type
+          end
+        end
+      end
+
+      # @param [::Object] json
+      # @return [::Array<TypeSpec>]
+      def types_for(json)
+        if type_map.nil?
+          types
+        else
+          type_map[json[discriminator]]
+        end
+      end
     end
   end
 end

data/lib/json_model/type_spec/const.rb

@@ -3,6 +3,8 @@
 module JsonModel
   class TypeSpec
     class Const < TypeSpec
+      attr_reader(:value)
+
       # @param [String] value
       def initialize(value)
         super()
@@ -17,7 +19,7 @@ module JsonModel
       # @return [Hash]
       def as_schema(**_options)
         {
-          const: @value,
+          const: value,
         }.compact
       end
 
@@ -26,7 +28,7 @@ module JsonModel
       def register_validations(name, klass)
         super
 
-        klass.validates(name, inclusion: { in: @value }, allow_nil: true)
+        klass.validates(name, inclusion: { in: value }, allow_nil: true)
       end
     end
   end

data/lib/json_model/type_spec/enum.rb

@@ -3,6 +3,8 @@
 module JsonModel
   class TypeSpec
     class Enum < TypeSpec
+      attr_reader(:values)
+
       # @param [Array<Object, nil>] values
       def initialize(*values)
         super()
@@ -17,7 +19,7 @@ module JsonModel
       # @return [Hash]
       def as_schema(**_options)
         {
-          enum: @values,
+          enum: values,
         }.compact
       end
 
@@ -26,7 +28,7 @@ module JsonModel
       def register_validations(name, klass)
         super
 
-        klass.validates(name, inclusion: { in: @values }, allow_nil: true)
+        klass.validates(name, inclusion: { in: values }, allow_nil: true)
       end
     end
   end

data/lib/json_model/type_spec/object.rb

@@ -3,6 +3,8 @@
 module JsonModel
   class TypeSpec
     class Object < TypeSpec
+      attr_reader(:type)
+
       # @param [Schema] type
       def initialize(type)
         super()
@@ -12,18 +14,18 @@ module JsonModel
       # @param [Hash] options
       # @return [Hash]
       def as_schema(**options)
-        @type.as_schema(**options)
+        type.as_schema(**options)
       end
 
       # @return [Array<TypeSpec>]
       def referenced_schemas
-        [@type]
+        [type]
       end
 
       # @param [::Object] json
       # @return [::Object, nil]
       def cast(json)
-        @type.from_json(**json)
+        type.from_json(**json)
       end
     end
   end

data/lib/json_model/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JsonModel
-  VERSION = '0.1.12'
+  VERSION = '0.1.14'
 end

data/spec/examples/file_system_spec.rb

@@ -9,7 +9,7 @@ RSpec.describe('File system schema') do
       Class.new do
         include(JsonModel::Schema)
 
-        property(:type, type: T::Enum['disk'])
+        property(:type, type: T::Const['disk'])
         property(:device, type: String, pattern: %r{\A/dev/[^/]+(/[^/]+)*\z})
       end,
     )
@@ -19,7 +19,7 @@ RSpec.describe('File system schema') do
       Class.new do
         include(JsonModel::Schema)
 
-        property(:type, type: T::Enum['disk'])
+        property(:type, type: T::Enum['diskUUID', 'diskuuid'])
         property(
           :label,
           type: String,
@@ -33,7 +33,7 @@ RSpec.describe('File system schema') do
       Class.new do
         include(JsonModel::Schema)
 
-        property(:type, type: T::Enum['nfs'])
+        property(:type, type: T::Const['nfs'])
         property(:remote_path, type: String, pattern: %r{\A(/[^/]+)+\z}, as: :remotePath)
         property(:server, type: String, format: :ipv4)
       end,
@@ -44,7 +44,7 @@ RSpec.describe('File system schema') do
       Class.new do
         include(JsonModel::Schema)
 
-        property(:type, type: T::Enum['tmpfs'])
+        property(:type, type: T::Const['tmpfs'])
         property(:size_in_mb, type: Integer, minimum: 16, maximum: 512, as: :sizeInMB)
       end,
     )
@@ -55,7 +55,12 @@ RSpec.describe('File system schema') do
         include(JsonModel::Schema)
 
         description('JSON Schema for an fstab entry')
-        property(:storage, type: T::OneOf[DiskDevice, DiskUuid, Nfs, Tmpfs], ref_mode: JsonModel::RefMode::LOCAL)
+        property(
+          :storage,
+          type: T::OneOf[DiskDevice, DiskUuid, Nfs, Tmpfs],
+          ref_mode: JsonModel::RefMode::LOCAL,
+          discriminator: :type,
+        )
         property(:fstype, type: T::Enum['ext3', 'ext4', 'btrfs'], optional: true)
         property(:options, type: T::Array[String], min_items: 1, unique_items: true, optional: true)
         property(:readonly, type: T::Boolean, optional: true)
@@ -100,7 +105,7 @@ RSpec.describe('File system schema') do
               DiskDevice: {
                 properties: {
                   type: {
-                    enum: ['disk'],
+                    const: 'disk',
                   },
                   device: {
                     type: 'string',
@@ -113,7 +118,7 @@ RSpec.describe('File system schema') do
               },
               DiskUuid: {
                 properties: {
-                  type: { enum: ['disk'] },
+                  type: { enum: %w(diskUUID diskuuid) },
                   label: {
                     type: 'string',
                     pattern: '\\A[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\\z',
@@ -125,7 +130,7 @@ RSpec.describe('File system schema') do
               },
               Nfs: {
                 properties: {
-                  type: { enum: ['nfs'] },
+                  type: { const: 'nfs' },
                   remotePath: {
                     type: 'string',
                     pattern: '\\A(/[^/]+)+\\z',
@@ -141,7 +146,7 @@ RSpec.describe('File system schema') do
               },
               Tmpfs: {
                 properties: {
-                  type: { enum: ['tmpfs'] },
+                  type: { const: 'tmpfs' },
                   sizeInMB: { type: 'integer', minimum: 16, maximum: 512 },
                 },
                 required: %i(sizeInMB type),

data/spec/schema_spec.rb

@@ -64,16 +64,29 @@ RSpec.describe(JsonModel::Schema) do
   end
 
   describe('.from_json') do
-    let(:klass) do
-      Class.new do
-        include(JsonModel::Schema)
+    before do
+      stub_const(
+        'Foo',
+        Class.new do
+          include(JsonModel::Schema)
 
-        property(:foo_bar, type: String, as: :fooBar)
-      end
+          property(:foo_bar, type: String, as: :fooBar)
+        end,
+      )
+
+      stub_const(
+        'Bar',
+        Class.new(Foo),
+      )
+    end
+
+    it('parent can be instantiated from json') do
+      instance = Foo.from_json({ fooBar: 'baz' })
+      expect(instance.foo_bar).to(eq('baz'))
     end
 
-    it('can be instantiated from json') do
-      instance = klass.from_json({ fooBar: 'baz' })
+    it('child can be instantiated from json') do
+      instance = Bar.from_json({ fooBar: 'baz' })
       expect(instance.foo_bar).to(eq('baz'))
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: json_model_rb
 version: !ruby/object:Gem::Version
-  version: 0.1.12
+  version: 0.1.14
 platform: ruby
 authors:
 - Paul Gillesberger