deimos-ruby 1.13.0 → 1.13.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c57c2700b01b998f358cb4e96ee6e6b2c1c8c32936d741b2371182a6017f7adc
-  data.tar.gz: 440bf25b629ba34da51cd1c0a1b443858bcd4ca270fed800b6e277c050b0741f
+  metadata.gz: 2fe5f643562c8cebecd6991d31222c3809115cee282b2f8fcef0e36b1b19f972
+  data.tar.gz: a9de46de1265d73a7d94e94f24c43a0c210687b93f4862a7a2fefee73c40fb89
 SHA512:
-  metadata.gz: 05df77f7f8890959ea91817a7497c11348d3b68f349462275a1ffb133a1c8194d9ee2282ac3dbe14a389bd09f16f059c88b467c05fb959c1a334b7c3789ade92
-  data.tar.gz: bc8b8c832a7399a6c60a4a0ac71582aff4ff324d5a2c9bb2a73241bb64de3a958d09208e1c127d36e8b3c47077857224ec853aaea769ef00aaef88dc6e6cf0e9
+  metadata.gz: 0365bcefe9cd82d91bf9f5eb587f6f72725f0ef981336722571465e8308d615b69fabc7516755761ebdad473ba1b8e0027e1546a81076d1bdf5c9c8cfe5e9d0f
+  data.tar.gz: 5e4f15b372217ac878b9c82ab606c90e16a0a370947956bef2b6aae5ffa4ac8c4739ff74e10d7bf442c29968ee0bba0135624d7be2966d51b85d8c777f2e2573

data/CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## UNRELEASED
 
+# 1.13.1 - 2022-04-06
+
+- Fix circular reference schema generation
+
 # 1.13.0 - 2022-03-30
 
 - Pass the Deimos logger to `AvroTurf::Messaging` for consistent logging

data/lib/deimos/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Deimos
-  VERSION = '1.13.0'
+  VERSION = '1.13.1'
 end

data/lib/generators/deimos/schema_class_generator.rb

@@ -63,7 +63,7 @@ module Deimos
           elsif schema.respond_to?(:items)
             [schema.items]
           elsif schema.respond_to?(:schemas)
-            schema.schemas
+            schema.schemas.reject { |s| s.class == Avro::Schema::PrimitiveSchema }
           else
             []
           end
@@ -73,14 +73,19 @@ module Deimos
         # @return [Array<Avro::Schema::NamedSchema>]
         def collect_all_schemas(schemas)
           schemas.dup.each do |schema|
+            next if @discovered_schemas.include?(schema)
+
+            @discovered_schemas << schema
             schemas.concat(collect_all_schemas(child_schemas(schema)))
           end
+
           schemas.select { |s| s.respond_to?(:name) }.uniq
         end
 
         # @param schema_base [Deimos::SchemaBackends::Base]
         # @param key_schema_base[Avro::Schema::NamedSchema]
         def generate_class_from_schema_base(schema_base, key_schema_base: nil)
+          @discovered_schemas = Set.new
           schemas = collect_all_schemas(schema_base.schema_store.schemas.values)
 
           sub_schemas = schemas.reject { |s| s.name == schema_base.schema }

data/spec/generators/schema_class/my_schema_with_circular_reference_spec.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+# For testing the generated class.
+RSpec.describe Schemas::MySchemaWithCircularReference do
+  let(:payload_hash) do
+    {
+      properties: {
+        a_boolean: {
+          property: true
+        },
+        an_integer: {
+          property: 1
+        },
+        a_float: {
+          property: 4.5
+        },
+        a_string: {
+          property: 'string'
+        },
+        an_array: {
+          property: [1, 2, 3]
+        },
+        an_hash: {
+          property: {
+            a_key: 'a_value'
+          }
+        }
+      }
+    }
+  end
+
+  describe 'class initialization' do
+    it 'should initialize the class from keyword arguments' do
+      klass = described_class.new(properties: payload_hash[:properties])
+      expect(klass).to be_instance_of(described_class)
+    end
+
+    it 'should initialize the class from a hash with symbols as keys' do
+      klass = described_class.new(**payload_hash)
+      expect(klass).to be_instance_of(described_class)
+    end
+
+    it 'should initialize the class when missing attributes' do
+      payload_hash.delete(:properties)
+      klass = described_class.new(**payload_hash)
+      expect(klass).to be_instance_of(described_class)
+    end
+
+  end
+
+  describe 'base class methods' do
+    let(:klass) do
+      described_class.new(**payload_hash)
+    end
+
+    it 'should return the name of the schema and namespace' do
+      expect(klass.schema).to eq('MySchemaWithCircularReference')
+      expect(klass.namespace).to eq('com.my-namespace')
+      expect(klass.full_schema).to eq('com.my-namespace.MySchemaWithCircularReference')
+    end
+
+    it 'should return a json version of the payload' do
+      described_class.new(**payload_hash)
+      payload_h = {
+        'properties' => {
+          'a_boolean' => {
+            'property' => true
+          },
+          'an_integer' => {
+            'property' => 1
+          },
+          'a_float' => {
+            'property' => 4.5
+          },
+          'a_string' => {
+            'property' => 'string'
+          },
+          'an_array' => {
+            'property' => [1, 2, 3]
+          },
+          'an_hash' => {
+            'property' => {
+              'a_key' => 'a_value'
+            }
+          }
+        }
+      }
+
+      expect(klass.as_json).to eq(payload_h)
+    end
+
+    it 'should return a JSON string of the payload' do
+      s = '{"properties":{"a_boolean":{"property":true},"an_integer":{"property":1},"a_float":{"property":4.5},"a_string":{"property":"string"},"an_array":{"property":[1,2,3]},"an_hash":{"property":{"a_key":"a_value"}}}}'
+      expect(klass.to_json).to eq(s)
+    end
+  end
+end

data/spec/generators/schema_class_generator_spec.rb

@@ -73,6 +73,32 @@ RSpec.describe Deimos::Generators::SchemaClassGenerator do
     end
   end
 
+  context 'with a Consumers Schema with a circular reference' do
+    before(:each) do
+      Deimos.configure do
+        consumer do
+          class_name 'ConsumerTest::MyConsumer'
+          topic 'MyTopic'
+          schema 'MySchemaWithCircularReference'
+          namespace 'com.my-namespace'
+          key_config field: :a_string
+        end
+      end
+      described_class.start
+    end
+
+    it 'should generate the correct number of classes' do
+      expect(files.length).to eq(1)
+    end
+
+    it 'should generate a schema class for my_schema_with_circular_reference' do
+      generated_path = files.select { |f| f =~ /my_schema_with_circular_reference/ }.first
+      expected_path = expected_files.select { |f| f =~ /my_schema_with_circular_reference/ }.first
+
+      expect(File.read(generated_path)).to eq(File.read(expected_path))
+    end
+  end
+
   context 'with a Producers Schema and a Key' do
     before(:each) do
       Deimos.configure do

data/spec/schema_classes/my_schema_with_circular_reference.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+# This file is autogenerated by Deimos, Do NOT modify
+module Schemas
+  ### Secondary Schema Classes ###
+  # Autogenerated Schema for Record at com.my-namespace.Property
+  class Property < Deimos::SchemaClass::Record
+    ### Attribute Accessors ###
+    # @param value [Boolean, Integer, Integer, Float, Float, String, Array<Property>, Hash<String, Property>]
+    attr_accessor :property
+
+    # @override
+    def initialize(property: nil)
+      super
+      self.property = property
+    end
+
+    # @override
+    def schema
+      'Property'
+    end
+
+    # @override
+    def namespace
+      'com.my-namespace'
+    end
+
+    # @override
+    def to_h
+      {
+        'property' => @property
+      }
+    end
+  end
+
+  ### Primary Schema Class ###
+  # Autogenerated Schema for Record at com.my-namespace.MySchemaWithCircularReference
+  class MySchemaWithCircularReference < Deimos::SchemaClass::Record
+    ### Attribute Readers ###
+    # @return [Hash<String, Property>]
+    attr_reader :properties
+
+    ### Attribute Writers ###
+    # @param values [Hash<String, Property>]
+    def properties=(values)
+      @properties = values.transform_values do |value|
+        Property.initialize_from_value(value)
+      end
+    end
+
+    # @override
+    def initialize(properties: {})
+      super
+      self.properties = properties
+    end
+
+    # @override
+    def schema
+      'MySchemaWithCircularReference'
+    end
+
+    # @override
+    def namespace
+      'com.my-namespace'
+    end
+
+    # @override
+    def to_h
+      {
+        'properties' => @properties.transform_values { |v| v&.to_h }
+      }
+    end
+  end
+end

data/spec/schemas/com/my-namespace/MySchemaWithCircularReference.avsc

@@ -0,0 +1,39 @@
+{
+  "namespace": "com.my-namespace",
+  "name": "MySchemaWithCircularReference",
+  "type": "record",
+  "fields": [
+    {
+      "default": {},
+      "name": "properties",
+      "type": {
+        "type": "map",
+        "values": {
+          "fields": [
+            {
+              "name": "property",
+              "type": [
+                "boolean",
+                "int",
+                "long",
+                "float",
+                "double",
+                "string",
+                {
+                  "items": "Property",
+                  "type": "array"
+                },
+                {
+                  "type": "map",
+                  "values": "Property"
+                }
+              ]
+            }
+          ],
+          "name": "Property",
+          "type": "record"
+        }
+      }
+    }
+  ]
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deimos-ruby
 version: !ruby/object:Gem::Version
-  version: 1.13.0
+  version: 1.13.1
 platform: ruby
 authors:
 - Daniel Orner
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-30 00:00:00.000000000 Z
+date: 2022-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: avro_turf
@@ -463,6 +463,7 @@ files:
 - spec/consumer_spec.rb
 - spec/deimos_spec.rb
 - spec/generators/active_record_generator_spec.rb
+- spec/generators/schema_class/my_schema_with_circular_reference_spec.rb
 - spec/generators/schema_class/my_schema_with_complex_types_spec.rb
 - spec/generators/schema_class_generator_spec.rb
 - spec/handlers/my_batch_consumer.rb
@@ -484,12 +485,14 @@ files:
 - spec/schema_classes/my_nested_schema.rb
 - spec/schema_classes/my_schema.rb
 - spec/schema_classes/my_schema_key.rb
+- spec/schema_classes/my_schema_with_circular_reference.rb
 - spec/schema_classes/my_schema_with_complex_types.rb
 - spec/schemas/com/my-namespace/Generated.avsc
 - spec/schemas/com/my-namespace/MyNestedSchema.avsc
 - spec/schemas/com/my-namespace/MySchema.avsc
 - spec/schemas/com/my-namespace/MySchemaCompound_key.avsc
 - spec/schemas/com/my-namespace/MySchemaWithBooleans.avsc
+- spec/schemas/com/my-namespace/MySchemaWithCircularReference.avsc
 - spec/schemas/com/my-namespace/MySchemaWithComplexTypes.avsc
 - spec/schemas/com/my-namespace/MySchemaWithDateTimes.avsc
 - spec/schemas/com/my-namespace/MySchemaWithId.avsc
@@ -554,6 +557,7 @@ test_files:
 - spec/consumer_spec.rb
 - spec/deimos_spec.rb
 - spec/generators/active_record_generator_spec.rb
+- spec/generators/schema_class/my_schema_with_circular_reference_spec.rb
 - spec/generators/schema_class/my_schema_with_complex_types_spec.rb
 - spec/generators/schema_class_generator_spec.rb
 - spec/handlers/my_batch_consumer.rb
@@ -575,12 +579,14 @@ test_files:
 - spec/schema_classes/my_nested_schema.rb
 - spec/schema_classes/my_schema.rb
 - spec/schema_classes/my_schema_key.rb
+- spec/schema_classes/my_schema_with_circular_reference.rb
 - spec/schema_classes/my_schema_with_complex_types.rb
 - spec/schemas/com/my-namespace/Generated.avsc
 - spec/schemas/com/my-namespace/MyNestedSchema.avsc
 - spec/schemas/com/my-namespace/MySchema.avsc
 - spec/schemas/com/my-namespace/MySchemaCompound_key.avsc
 - spec/schemas/com/my-namespace/MySchemaWithBooleans.avsc
+- spec/schemas/com/my-namespace/MySchemaWithCircularReference.avsc
 - spec/schemas/com/my-namespace/MySchemaWithComplexTypes.avsc
 - spec/schemas/com/my-namespace/MySchemaWithDateTimes.avsc
 - spec/schemas/com/my-namespace/MySchemaWithId.avsc