deimos-ruby 1.12.6 → 1.13.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 945958ca7b49192f533a47eac766f4ca463d7ed85702b2c85b41fc22d8aaeef1
-  data.tar.gz: 8e7a6bf75f733d1903810a85e6ccf0185a868d8dbc07a1544d210bb160135417
+  metadata.gz: f51b89a9bf8a619db4c9294092b5e7b4f78c075c35f4aa2bc39c547da99ec67c
+  data.tar.gz: e4da7d718fff36bb28ca249a788fbf78ad5f980e9fa32983ecf019cd53cd40b8
 SHA512:
-  metadata.gz: 220de8bc9a38b50affdc56e0f25c6a185ffc1646cf39de21478b6906fc1fcf3bf20c197d4105132ecc7cae004e75498299ebc104fcb8d46f530fe8a67ac92883
-  data.tar.gz: fd89136dea1f76acb4de3bda22ee06e1d5ef88dc827a2690b588d2e84284584041818bbb257b71db99212586005a4b6818f89e8f627dc727e2eb8ba1b144c94f
+  metadata.gz: 7ac325f814c79a29985cba298ef0cde7daa4b0c561ce155eee22dab15470b2c1a933f5baa0181fd9375500062fa89fc846dcb01504d10466645275fa3644ec53
+  data.tar.gz: 021dd749b7040b136f84fcc7142a207847a982e2ab889439486af4b5dc4267ed4eed25f4d71c9a6496c51d8e84f3bedc6220e3dbd1f0a0133bca8c8cc1fe24e5

data/CHANGELOG.md

@@ -7,6 +7,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## UNRELEASED
 
+# 1.13.2 - 2022-04-07
+
+- Fix an issue with generating schema classes for schemas containing an enum with default value 
+
+# 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
+- Fix an issue with nullable enums not being included in the auto-generated schema class
+
 # 1.12.6 - 2022-03-14
 
 - Fix NameError when using Datadog Metrics

data/lib/deimos/schema_backends/avro_schema_registry.rb

@@ -28,7 +28,8 @@ module Deimos
           schemas_path: Deimos.config.schema.path,
           user: Deimos.config.schema.user,
           password: Deimos.config.schema.password,
-          namespace: @namespace
+          namespace: @namespace,
+          logger: Deimos.config.logger
         )
       end
     end

data/lib/deimos/version.rb

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

data/lib/generators/deimos/schema_class_generator.rb

@@ -62,6 +62,8 @@ module Deimos
             [schema.values]
           elsif schema.respond_to?(:items)
             [schema.items]
+          elsif schema.respond_to?(:schemas)
+            schema.schemas.reject { |s| s.class == Avro::Schema::PrimitiveSchema }
           else
             []
           end
@@ -71,17 +73,22 @@ 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 }
+          sub_schemas = schemas.reject { |s| s.name == schema_base.schema }.sort_by(&:name)
           @sub_schema_templates = sub_schemas.map do |schema|
             _generate_class_template_from_schema(schema)
           end
@@ -199,8 +206,8 @@ module Deimos
         return ' nil' if default == :no_default || default.nil? || IGNORE_DEFAULTS.include?(field.name)
 
         case field.type.type_sym
-        when :string
-          " '#{default}'"
+        when :string, :enum
+          " \"#{default}\""
         when :record
           schema_name = Deimos::SchemaBackends::AvroBase.schema_classname(field.type)
           class_instance = Utils::SchemaClass.instance(field.default, schema_name)

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/my_schema_with_complex_types_spec.rb

@@ -57,7 +57,7 @@ RSpec.describe Schemas::MySchemaWithComplexTypes do
     end
 
     let(:schema_fields) do
-      %w(test_id test_float test_int_array test_optional_int test_string_array some_integer_map some_record some_optional_record some_record_array some_record_map some_enum_array)
+      %w(test_id test_float test_int_array test_optional_int test_string_array some_integer_map some_record some_optional_record some_record_array some_record_map some_enum_array some_optional_enum some_enum_with_default)
     end
 
     it 'should return the name of the schema and namespace' do
@@ -77,6 +77,7 @@ RSpec.describe Schemas::MySchemaWithComplexTypes do
         'test_float' => 1.2,
         'test_string_array' => %w(abc def),
         'test_int_array' => [123, 456],
+        'some_optional_enum' => nil,
         'test_optional_int' => 123,
         'some_integer_map' => { 'int_1' => 1, 'int_2' => 2 },
         'some_record' => { 'a_record_field' => 'field 1' },
@@ -89,14 +90,15 @@ RSpec.describe Schemas::MySchemaWithComplexTypes do
           'record_1' => { 'a_record_field' => 'field 5' },
           'record_2' => { 'a_record_field' => 'field 6' }
         },
-        'some_enum_array' => %w(sym1 sym2)
+        'some_enum_array' => %w(sym1 sym2),
+        'some_enum_with_default' => 'sym6'
       }
 
       expect(klass.as_json).to eq(payload_h)
     end
 
     it 'should return a JSON string of the payload' do
-      s = '{"test_id":"test id","test_float":1.2,"test_string_array":["abc","def"],"test_int_array":[123,456],"test_optional_int":123,"some_integer_map":{"int_1":1,"int_2":2},"some_record":{"a_record_field":"field 1"},"some_optional_record":{"a_record_field":"field 2"},"some_record_array":[{"a_record_field":"field 3"},{"a_record_field":"field 4"}],"some_record_map":{"record_1":{"a_record_field":"field 5"},"record_2":{"a_record_field":"field 6"}},"some_enum_array":["sym1","sym2"]}'
+      s = '{"test_id":"test id","test_float":1.2,"test_string_array":["abc","def"],"test_int_array":[123,456],"test_optional_int":123,"some_integer_map":{"int_1":1,"int_2":2},"some_record":{"a_record_field":"field 1"},"some_optional_record":{"a_record_field":"field 2"},"some_record_array":[{"a_record_field":"field 3"},{"a_record_field":"field 4"}],"some_record_map":{"record_1":{"a_record_field":"field 5"},"record_2":{"a_record_field":"field 6"}},"some_enum_array":["sym1","sym2"],"some_optional_enum":null,"some_enum_with_default":"sym6"}'
       expect(klass.to_json).to eq(s)
     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/generated.rb

@@ -3,28 +3,6 @@
 # This file is autogenerated by Deimos, Do NOT modify
 module Schemas
   ### Secondary Schema Classes ###
-  # Autogenerated Schema for Enum at com.my-namespace.AnEnum
-  class AnEnum < Deimos::SchemaClass::Enum
-    # @return ['sym1', 'sym2']
-    attr_accessor :an_enum
-
-    # :nodoc:
-    def initialize(an_enum)
-      super
-      self.an_enum = an_enum
-    end
-
-    # @override
-    def symbols
-      %w(sym1 sym2)
-    end
-
-    # @override
-    def to_h
-      @an_enum
-    end
-  end
-
   # Autogenerated Schema for Record at com.my-namespace.ARecord
   class ARecord < Deimos::SchemaClass::Record
     ### Attribute Accessors ###
@@ -55,6 +33,28 @@ module Schemas
     end
   end
 
+  # Autogenerated Schema for Enum at com.my-namespace.AnEnum
+  class AnEnum < Deimos::SchemaClass::Enum
+    # @return ['sym1', 'sym2']
+    attr_accessor :an_enum
+
+    # :nodoc:
+    def initialize(an_enum)
+      super
+      self.an_enum = an_enum
+    end
+
+    # @override
+    def symbols
+      %w(sym1 sym2)
+    end
+
+    # @override
+    def to_h
+      @an_enum
+    end
+  end
+
   ### Primary Schema Class ###
   # Autogenerated Schema for Record at com.my-namespace.Generated
   class Generated < Deimos::SchemaClass::Record

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/schema_classes/my_schema_with_complex_types.rb

@@ -55,6 +55,50 @@ module Schemas
     end
   end
 
+  # Autogenerated Schema for Enum at com.my-namespace.AnotherEnum
+  class AnotherEnum < Deimos::SchemaClass::Enum
+    # @return ['sym3', 'sym4']
+    attr_accessor :another_enum
+
+    # :nodoc:
+    def initialize(another_enum)
+      super
+      self.another_enum = another_enum
+    end
+
+    # @override
+    def symbols
+      %w(sym3 sym4)
+    end
+
+    # @override
+    def to_h
+      @another_enum
+    end
+  end
+
+  # Autogenerated Schema for Enum at com.my-namespace.YetAnotherEnum
+  class YetAnotherEnum < Deimos::SchemaClass::Enum
+    # @return ['sym5', 'sym6']
+    attr_accessor :yet_another_enum
+
+    # :nodoc:
+    def initialize(yet_another_enum)
+      super
+      self.yet_another_enum = yet_another_enum
+    end
+
+    # @override
+    def symbols
+      %w(sym5 sym6)
+    end
+
+    # @override
+    def to_h
+      @yet_another_enum
+    end
+  end
+
   ### Primary Schema Class ###
   # Autogenerated Schema for Record at com.my-namespace.MySchemaWithComplexTypes
   class MySchemaWithComplexTypes < Deimos::SchemaClass::Record
@@ -69,6 +113,10 @@ module Schemas
     attr_reader :some_record_map
     # @return [Array<AnEnum>]
     attr_reader :some_enum_array
+    # @return [nil, AnotherEnum]
+    attr_reader :some_optional_enum
+    # @return [YetAnotherEnum]
+    attr_reader :some_enum_with_default
 
     ### Attribute Accessors ###
     # @param value [String]
@@ -116,6 +164,16 @@ module Schemas
       end
     end
 
+    # @param value [nil, AnotherEnum]
+    def some_optional_enum=(value)
+      @some_optional_enum = AnotherEnum.initialize_from_value(value)
+    end
+
+    # @param value [YetAnotherEnum]
+    def some_enum_with_default=(value)
+      @some_enum_with_default = YetAnotherEnum.initialize_from_value(value)
+    end
+
     # @override
     def initialize(test_id: nil,
                    test_float: nil,
@@ -127,7 +185,9 @@ module Schemas
                    some_optional_record: nil,
                    some_record_array: nil,
                    some_record_map: nil,
-                   some_enum_array: nil)
+                   some_enum_array: nil,
+                   some_optional_enum: nil,
+                   some_enum_with_default: "sym6")
       super
       self.test_id = test_id
       self.test_float = test_float
@@ -140,6 +200,8 @@ module Schemas
       self.some_record_array = some_record_array
       self.some_record_map = some_record_map
       self.some_enum_array = some_enum_array
+      self.some_optional_enum = some_optional_enum
+      self.some_enum_with_default = some_enum_with_default
     end
 
     # @override
@@ -165,7 +227,9 @@ module Schemas
         'some_optional_record' => @some_optional_record&.to_h,
         'some_record_array' => @some_record_array.map { |v| v&.to_h },
         'some_record_map' => @some_record_map.transform_values { |v| v&.to_h },
-        'some_enum_array' => @some_enum_array.map { |v| v&.to_h }
+        'some_enum_array' => @some_enum_array.map { |v| v&.to_h },
+        'some_optional_enum' => @some_optional_enum&.to_h,
+        'some_enum_with_default' => @some_enum_with_default&.to_h
       }
     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"
+        }
+      }
+    }
+  ]
+}

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

@@ -90,6 +90,26 @@
           "symbols": ["sym1", "sym2"]
         }
       }
+    },
+    {
+      "name": "some_optional_enum",
+      "type": [
+        "null",
+        {
+          "type": "enum",
+          "name": "AnotherEnum",
+          "symbols": ["sym3", "sym4"]
+        }
+      ]
+    },
+    {
+      "name": "some_enum_with_default",
+      "default": "sym6",
+      "type": {
+        "type": "enum",
+        "name": "YetAnotherEnum",
+        "symbols": ["sym5", "sym6"]
+      }
     }
   ]
 }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deimos-ruby
 version: !ruby/object:Gem::Version
-  version: 1.12.6
+  version: 1.13.2
 platform: ruby
 authors:
 - Daniel Orner
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-14 00:00:00.000000000 Z
+date: 2022-04-07 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