deimos-ruby 2.1.2 → 2.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60b8a371a3669c29d7f59694bc49af057412313aeb08eebab2b88d4dbc5b6da4
-  data.tar.gz: 9c7231954c6db7ee55ffd4d3e18351bc7470acd443555f270c589da37e054631
+  metadata.gz: 3b6f32c7658a4b3cc134cc544bb0d4291b90e6424df288f4b4fcfd7fa93c630f
+  data.tar.gz: 2f3ebc77c9c622f5256d77448fec7c7303134519acaa1611f985002838f0278e
 SHA512:
-  metadata.gz: 294627ab365d88be5f0617422a88bbd15fe81b46eae81dc663aff66174377145ccbbac218c205b5fbaf2d0dbdef31f0586e43607381423e0cd13cbb673f6913a
-  data.tar.gz: 216b9300910d20feb4786f4798542fc32a6a1f957dc19dc50209877853424a5d13e208f08f42c38fe420c86ec73e6b620e95a8f20d8700c1a7b3713f8f54472b
+  metadata.gz: 4654cbbe510338b52186bf6eb507c930cb932293c0018f4ca5cda83acb1b901ecc646af7adbed3ca167ea1d756b1c3a19857cc727ac7de902028718fad13b9cd
+  data.tar.gz: b4cc6c4f30a5c6e5d94b2c56f194ee3fc1b04467f577928f89e6550fca1d0aee2b078c6b616a68db820c132d67a985fbe444302143eed7c218cae50f91d920fd

data/CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## UNRELEASED
 
+# 2.1.4 - 2025-07-22
+
+- Feature: Add interrogation methods (e.g. `approved?`) for schema class enums.
+- Fix: Schema class generation was missing payload_key for a number of cases.
+- Fix: Possible crashes when using schema classes with Avro messages.
+
 ## 2.1.2 - 2025-07-21
 
 - Fix: Backwards-compatible fix wasn't working correctly.

data/karafka.rb

@@ -1 +1,71 @@
-# blank load file, used in regenerate_test_schema_classes.rb
+# Used in regenerate_test_schema_classes.rb
+
+class MyConsumer < Deimos::Consumer
+  def consume(payload, metadata); end
+end
+
+require_relative "./lib/generators/deimos/schema_class_generator"
+
+Deimos.configure do |deimos_config|
+  deimos_config.schema.nest_child_schemas = true
+  deimos_config.schema.path = "spec/schemas"
+  deimos_config.schema.backend = :avro_validation
+  deimos_config.schema.generated_class_path = './spec/schemas'
+  deimos_config.schema.use_full_namespace = true
+  deimos_config.schema.schema_namespace_map = {
+    'com' => 'Schemas',
+    'com.my-namespace.my-suborg' => %w(Schemas MyNamespace)
+  }
+end
+
+class KarafkaApp < Karafka::App
+  setup do
+    config.kafka = {
+      "bootstrap.servers": '127.0.0.1:9092'
+    }
+  end
+  routes.draw do
+    topic 'MyTopic' do
+      consumer MyConsumer
+      schema 'Generated'
+      namespace 'com.my-namespace'
+      key_config({ field: :a_string })
+    end
+
+    topic 'MyTopic2' do
+      consumer MyConsumer
+      schema 'MySchemaWithComplexTypes'
+      namespace 'com.my-namespace'
+      key_config({ field: :test_id })
+    end
+
+    topic 'MyTopic3' do
+      consumer MyConsumer
+      schema 'MySchemaWithCircularReference'
+      namespace 'com.my-namespace'
+      key_config({ none: true })
+    end
+
+    topic 'MyTopic4' do
+      consumer MyConsumer
+      schema 'MyNestedSchema'
+      namespace 'com.my-namespace'
+      key_config({ field: :test_id })
+    end
+
+    topic 'MyTopic5' do
+      consumer MyConsumer
+      schema 'MyLongNamespaceSchema'
+      namespace 'com.my-namespace.my-suborg'
+      key_config({ field: :test_id })
+    end
+
+    topic 'MyTopic6' do
+      producer_class MyConsumer
+      schema 'MySchema'
+      namespace 'com.my-namespace'
+      key_config({ schema: 'MySchema_key' })
+    end
+
+  end
+end

data/lib/deimos/schema_backends/avro_schema_coercer.rb

@@ -65,6 +65,8 @@ module Deimos
     # @param val [Object]
     # @return [Object]
     def coerce_record(type, val)
+      return nil if val.nil?
+
       record = val.map do |name, value|
         field = type.fields.find { |f| f.name == name }
         coerce_type(field.type, value)

data/lib/deimos/schema_class/record.rb

@@ -90,9 +90,9 @@ module Deimos
 
         return value if value.is_a?(self)
         if from_message
-          self.new_from_message(**value.symbolize_keys)
+          self.new_from_message(**value&.symbolize_keys || {})
         else
-          self.new(**value.symbolize_keys)
+          self.new(**value&.symbolize_keys || {})
         end
       end
     end

data/lib/deimos/version.rb

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

data/lib/generators/deimos/schema_class/templates/schema_enum.rb.tt

@@ -1,10 +1,13 @@
   # Autogenerated Schema for Enum at <%= @current_schema.namespace %>.<%= @current_schema.name %>
   class <%= Deimos::SchemaBackends::AvroBase.schema_classname(@current_schema) %> < Deimos::SchemaClass::Enum
-    # @return ['<%= @current_schema.symbols.join("', '") %>']
-    attr_accessor :<%= @current_schema.name.underscore %>
-
     # @override
     def symbols
       %w(<%= @current_schema.symbols.join(' ') %>)
     end
+
+    <% @current_schema.symbols.each do |symbol| %>
+    def <%= symbol.underscore %>?
+      @value == '<%= symbol %>'
+    end
+    <% end %>
   end

data/lib/generators/deimos/schema_class_generator.rb

@@ -162,26 +162,22 @@ module Deimos
       def generate
         _validate
         Rails.logger.info("Generating schemas from Deimos.config to #{Deimos.config.schema.generated_class_path}")
-        found_schemas = Set.new
-        Deimos.config.producer_objects.each do |config|
+        found_schemas = {}
+        Deimos.karafka_configs.each do |config|
           schema_name = config.schema
+          next if schema_name.nil?
           namespace = config.namespace || Deimos.config.producers.schema_namespace
           key_schema_name = config.key_config[:schema]
-          found_schemas.add("#{namespace}.#{schema_name}")
-          found_schemas.add("#{namespace}.#{key_schema_name}") if key_schema_name
-          generate_classes(schema_name, namespace, config.key_config)
-        end
 
-        Deimos.config.consumer_objects.each do |config|
-          schema_name = config.schema
-          namespace = config.namespace
-          key_schema_name = config.key_config[:schema]
-          found_schemas.add("#{namespace}.#{schema_name}")
-          found_schemas.add("#{namespace}.#{key_schema_name}") if key_schema_name
+          # don't regenerate if the schema was already found and had a payload key
+          next if found_schemas["#{namespace}.#{schema_name}"].present?
+
+          found_schemas["#{namespace}.#{schema_name}"] = key_schema_name
+          found_schemas["#{namespace}.#{key_schema_name}"] = nil
           generate_classes(schema_name, namespace, config.key_config)
         end
 
-        generate_from_schema_files(found_schemas)
+        generate_from_schema_files(found_schemas.keys)
 
       end
 
@@ -245,7 +241,7 @@ module Deimos
           "record.tombstone_key = key\n      record.#{key_config[:field]} = key"
         elsif key_schema
           field_base_type = _field_type(key_schema)
-          "record.tombstone_key = #{field_base_type}.initialize_from_value(key, from_message: self._from_message)\n      record.payload_key = key"
+          "record.tombstone_key = #{field_base_type}.initialize_from_value(key)\n      record.payload_key = key"
         else
           ''
         end

data/regenerate_test_schema_classes.rb

@@ -10,70 +10,4 @@ class DeimosApp < Rails::Application
 end
 DeimosApp.initialize!
 
-class MyConsumer < Deimos::Consumer
-  def consume(payload, metadata); end
-end
-
-require_relative "./lib/generators/deimos/schema_class_generator"
-
-Deimos.configure do |deimos_config|
-  deimos_config.schema.nest_child_schemas = true
-  deimos_config.schema.path = "spec/schemas"
-  deimos_config.schema.backend = :avro_validation
-  deimos_config.schema.generated_class_path = './spec/schemas'
-  deimos_config.schema.use_full_namespace = true
-  deimos_config.schema.schema_namespace_map = {
-    'com' => 'Schemas',
-    'com.my-namespace.my-suborg' => %w(Schemas MyNamespace)
-  }
-
-  consumer do
-    class_name 'MyConsumer'
-    topic 'MyTopic'
-    schema 'Generated'
-    namespace 'com.my-namespace'
-    key_config field: :a_string
-  end
-
-  consumer do
-    class_name 'MyConsumer'
-    topic 'MyTopic'
-    schema 'MySchemaWithComplexTypes'
-    namespace 'com.my-namespace'
-    key_config field: :test_id
-  end
-
-  consumer do
-    class_name 'MyConsumer'
-    topic 'MyTopic'
-    schema 'MySchemaWithCircularReference'
-    namespace 'com.my-namespace'
-    key_config none: true
-  end
-
-  consumer do
-    class_name 'MyConsumer'
-    topic 'MyTopic'
-    schema 'MyNestedSchema'
-    namespace 'com.my-namespace'
-    key_config field: :test_id
-  end
-
-  consumer do
-    class_name 'MyConsumer'
-    topic 'MyTopic'
-    schema 'MyLongNamespaceSchema'
-    namespace 'com.my-namespace.my-suborg'
-    key_config field: :test_id
-  end
-
-  producer do
-    class_name 'MyConsumer'
-    topic 'MyTopic'
-    schema 'MySchema'
-    namespace 'com.my-namespace'
-    key_config schema: 'MySchema_key'
-  end
-end
-
 Deimos::Generators::SchemaClassGenerator.new.generate

data/spec/schemas/my_namespace/my_schema.rb

@@ -45,7 +45,7 @@ module Schemas; module MyNamespace
 
     def self.tombstone(key)
       record = self.allocate
-      record.tombstone_key = MySchemaKey.initialize_from_value(key, from_message: self._from_message)
+      record.tombstone_key = MySchemaKey.initialize_from_value(key)
       record.payload_key = key
       record
     end

data/spec/schemas/my_namespace/my_updated_schema.rb

@@ -8,7 +8,8 @@ module Schemas; module Com; module MyNamespace
 
     attr_accessor :super_int
 
-    def initialize(test_id: nil,
+    def initialize(_from_message: false,
+                   test_id: nil,
                    some_int: nil)
       super
       self.super_int = some_int.nil? ? 10 : some_int * 9000