deimos-ruby 1.13.2 → 1.14.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f51b89a9bf8a619db4c9294092b5e7b4f78c075c35f4aa2bc39c547da99ec67c
-  data.tar.gz: e4da7d718fff36bb28ca249a788fbf78ad5f980e9fa32983ecf019cd53cd40b8
+  metadata.gz: 1d94fcbeb955de22fde06b29f63809cae7305d91f029ba8ec0b36e4dbbe037a2
+  data.tar.gz: 611e5cc68a5d9e661ff692f05692d7ba24e4804f5761479802a632cbdd2a0fd7
 SHA512:
-  metadata.gz: 7ac325f814c79a29985cba298ef0cde7daa4b0c561ce155eee22dab15470b2c1a933f5baa0181fd9375500062fa89fc846dcb01504d10466645275fa3644ec53
-  data.tar.gz: 021dd749b7040b136f84fcc7142a207847a982e2ab889439486af4b5dc4267ed4eed25f4d71c9a6496c51d8e84f3bedc6220e3dbd1f0a0133bca8c8cc1fe24e5
+  metadata.gz: 5100b19ede901f0b7a4e20f0aa6c15d487e9355d95ea46d984c8fcb587039be4be9529991197148e630ad3670c65d79ab0653ff57c28e224236a4d966bebe7e1
+  data.tar.gz: '082ad2e7be4d85fa3e8e242cdc7f192a35f99424675f5bddc3e11a3c19477ce5abf0df629117ca4f714ca107ea5be0a93a8aa5041a1f67cc628517f451005bb1'

data/CHANGELOG.md

@@ -7,6 +7,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## UNRELEASED
 
+# 1.14.1 - 2022-05-25
+
+- Fix: When using key schemas, ActiveRecordConsumers were not finding the record by default.
+
+# 1.14.0 - 2022-05-16
+
+- **Breaking Change**: Nest sub-schemas by default into their parent schemas when generating classes.
+- Add the `nest_child_schemas` option to essentially bring back the previous behavior in terms of code use (the actual classes will be separated out into different files).
+
+# 1.13.3 - 2022-05-10
+
+- Some cleanup on the active_record generator
+- Fix crash with `test_consume_message` when using schema classes
+- Add `[]=` and `merge` methods on the base schema class
+
 # 1.13.2 - 2022-04-07
 
 - Fix an issue with generating schema classes for schemas containing an enum with default value 

data/README.md

@@ -818,6 +818,12 @@ Add the following configurations to start using generated schema classes in your
 Additionally, you can enable or disable the usage of schema classes for a particular consumer or producer with the
 `use_schema_classes` config. See [Configuration](./docs/CONFIGURATION.md#defining-producers).
 
+Note that if you have a schema in your repo but have not configured a producer or consumer, the generator will **not** generate a schema class for it. This is because you need to supply the `key_config` for the generator to know how to handle the schema key. 
+
+One additional configuration option indicates whether nested records should be generated as top-level classes or would remain nested inside the generated class for its parent schema. The default is to nest them, as a flattened structure can have one sub-schema clobber another sub-schema defined in a different top-level schema.
+
+    config.schema.nest_child_schemas = false # Flatten all classes into one directory
+
 ### Consumer
 
 The consumer interface uses the `decode_message` method to turn JSON hash into the Schemas

data/deimos-ruby.gemspec

@@ -39,6 +39,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency('rspec', '~> 3')
   spec.add_development_dependency('rspec_junit_formatter', '~>0.3')
   spec.add_development_dependency('rspec-rails', '~> 4')
+  spec.add_development_dependency('rspec-snapshot', '~> 2.0')
   spec.add_development_dependency('rubocop', '0.89.0')
   spec.add_development_dependency('rubocop-rspec', '1.42.0')
   spec.add_development_dependency('sqlite3', '~> 1.3')

data/lib/deimos/active_record_consume/message_consumption.rb

@@ -13,7 +13,8 @@ module Deimos
       # @param key [Object]
       # @return [ActiveRecord::Base]
       def fetch_record(klass, _payload, key)
-        klass.unscoped.where(klass.primary_key => key).first
+        fetch_key = key.is_a?(Hash) && key.size == 1 ? key.values.first : key
+        klass.unscoped.where(klass.primary_key => fetch_key).first
       end
 
       # Assign a key to a new record.

data/lib/deimos/config/configuration.rb

@@ -343,6 +343,10 @@ module Deimos
       # Set to true to use the generated schema classes in your application
       # @return [Boolean]
       setting :use_schema_classes, false
+
+      # Set to false to generate child schemas as their own files.
+      # @return [Boolean]
+      setting :nest_child_schemas, true
     end
 
     # The configured metrics provider.

data/lib/deimos/schema_backends/avro_base.rb

@@ -96,7 +96,7 @@ module Deimos
       # @param schema [Avro::Schema::NamedSchema] A named schema
       # @return [String]
       def self.schema_classname(schema)
-        schema.name.underscore.camelize
+        schema.name.underscore.camelize.singularize
       end
 
       # Converts Avro::Schema::NamedSchema's to String form for generated YARD docs.

data/lib/deimos/schema_class/base.rb

@@ -29,6 +29,23 @@ module Deimos
         raise NotImplementedError
       end
 
+      # @param key [String|Symbol]
+      # @param val [Object]
+      def []=(key, val)
+        self.send("#{key}=", val)
+      end
+
+      # Merge a hash or an identical schema object with this one and return a new object.
+      # @param other_hash [Hash|SchemaClasses::Base]
+      # @return [SchemaClasses::Base]
+      def merge(other_hash)
+        obj = self.class.new(**self.to_h.symbolize_keys)
+        other_hash.to_h.each do |k, v|
+          obj.send("#{k}=", v)
+        end
+        obj
+      end
+
       # :nodoc:
       def ==(other)
         comparison = other

data/lib/deimos/test_helpers.rb

@@ -188,7 +188,7 @@ module Deimos
                              &block)
       raise 'Cannot have both call_original and be given a block!' if call_original && block_given?
 
-      payload&.stringify_keys!
+      payload.stringify_keys! if payload.respond_to?(:stringify_keys!)
       handler_class = if handler_class_or_topic.is_a?(String)
                         _get_handler_class_from_topic(handler_class_or_topic)
                       else

data/lib/deimos/version.rb

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

data/lib/generators/deimos/active_record/templates/migration.rb.tt

@@ -6,7 +6,7 @@ class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version
     end
     create_table :<%= table_name %> do |t|
       <%- fields.each do |key| -%>
-      <%- next if %w(id message_id timestamp).include?(key.name) -%>
+      <%- next if %w(id message_id timestamp updated_at created_at).include?(key.name) -%>
       <%- sql_type = schema_base.sql_type(key)
          if %w(record array map).include?(sql_type)
            conn = ActiveRecord::Base.connection
@@ -15,9 +15,11 @@ class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version
       -%>
       t.<%= sql_type %> :<%= key.name %>
       <%- end -%>
-    end
 
-    # TODO add indexes as necessary
+      t.timestamps
+
+      # TODO add indexes as necessary
+    end
   end
 
   def down

data/lib/generators/deimos/active_record_generator.rb

@@ -72,7 +72,7 @@ module Deimos
       # :nodoc:
       def generate
         migration_template('migration.rb', "db/migrate/create_#{table_name.underscore}.rb")
-        template('model.rb', "app/models/#{table_name.underscore}.rb")
+        template('model.rb', "app/models/#{table_name.underscore.singularize}.rb")
       end
     end
   end

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

@@ -2,13 +2,6 @@
 
 # This file is autogenerated by Deimos, Do NOT modify
 module Schemas
-<% if @sub_schema_templates.present? && @sub_schema_templates.any? -%>
-  ### Secondary Schema Classes ###
-<% end -%>
-<%- @sub_schema_templates.each do |schema_template| -%>
-  <%=- schema_template %>
-
-<%- end -%>
   ### Primary Schema Class ###
   <%=- @main_class_definition -%>
 

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

@@ -1,6 +1,15 @@
   # Autogenerated Schema for Record at <%= @current_schema.namespace %>.<%= @current_schema.name %>
   class <%= Deimos::SchemaBackends::AvroBase.schema_classname(@current_schema) %> < Deimos::SchemaClass::Record
-<%- if @field_assignments.select{ |h| h[:is_schema_class] }.any? -%>
+<% if @sub_schema_templates.present? -%>
+
+    ### Secondary Schema Classes ###
+  <%- @sub_schema_templates.each do |schema_template| -%>
+  <%=- schema_template.gsub(/^/, "  ") %>
+
+  <%- end -%>
+<% end -%>
+
+  <%- if @field_assignments.select{ |h| h[:is_schema_class] }.any? -%>
     ### Attribute Readers ###
   <%- @field_assignments.select{ |h| h[:is_schema_class] }.each do |method_definition| -%>
     # @return [<%= method_definition[:deimos_type] %>]

data/lib/generators/deimos/schema_class_generator.rb

@@ -86,20 +86,32 @@ module Deimos
         # @param key_schema_base[Avro::Schema::NamedSchema]
         def generate_class_from_schema_base(schema_base, key_schema_base: nil)
           @discovered_schemas = Set.new
+          @sub_schema_templates = []
           schemas = collect_all_schemas(schema_base.schema_store.schemas.values)
 
+          main_schema = schemas.find { |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)
+          if Deimos.config.schema.nest_child_schemas
+            @sub_schema_templates = sub_schemas.map do |schema|
+              _generate_class_template_from_schema(schema)
+            end
+            write_file(main_schema, key_schema_base)
+          else
+            write_file(main_schema, key_schema_base)
+            sub_schemas.each do |schema|
+              write_file(schema, nil)
+            end
           end
+        end
 
-          main_schema = schemas.find { |s| s.name == schema_base.schema }
-          class_template = _generate_class_template_from_schema(main_schema, key_schema_base)
+        # @param schema [Avro::Schema::NamedSchema]
+        # @param key_schema_base [Avro::Schema::NamedSchema, nil]
+        def write_file(schema, key_schema_base)
+          class_template = _generate_class_template_from_schema(schema, key_schema_base)
           @main_class_definition = class_template
 
-          file_prefix = main_schema.name.underscore
-          namespace_path = main_schema.namespace.tr('.', '/')
-          filename = "#{Deimos.config.schema.generated_class_path}/#{namespace_path}/#{file_prefix}.rb"
+          file_prefix = schema.name.underscore.singularize
+          filename = "#{Deimos.config.schema.generated_class_path}/#{file_prefix}.rb"
           template(SCHEMA_CLASS_FILE, filename, force: true)
         end
 

data/spec/active_record_consumer_spec.rb

@@ -39,6 +39,14 @@ module ActiveRecordConsumerTest
       end
       stub_const('MyConsumer', consumer_class)
 
+      consumer_class = Class.new(Deimos::ActiveRecordConsumer) do
+        schema 'MySchemaWithDateTimes'
+        namespace 'com.my-namespace'
+        key_config schema: 'MySchemaId_key'
+        record_class Widget
+      end
+      stub_const('MyConsumerWithKey', consumer_class)
+
       consumer_class = Class.new(Deimos::ActiveRecordConsumer) do
         schema 'MySchema'
         namespace 'com.my-namespace'
@@ -126,6 +134,19 @@ module ActiveRecordConsumerTest
             travel_back
           end
 
+          it 'should find widgets with a schema key' do
+            widget1 = Widget.create!(test_id: 'id1')
+            expect(widget1.some_int).to be_nil
+            test_consume_message(MyConsumerWithKey, {
+                                   test_id: 'id1',
+                                   some_int: 3
+                                 },
+                                 key: { id: widget1.id },
+                                 call_original: true)
+            expect(widget1.reload.some_int).to eq(3)
+            expect(Widget.count).to eq(1)
+          end
+
           it 'should find widgets by custom logic' do
             widget1 = Widget.create!(test_id: 'id1')
             expect(widget1.some_int).to be_nil

data/spec/generators/active_record_generator_spec.rb

@@ -33,9 +33,11 @@ RSpec.describe Deimos::Generators::ActiveRecordGenerator do
             t.json :an_array
             t.json :a_map
             t.json :a_record
+
+            t.timestamps
+
+            # TODO add indexes as necessary
           end
-      
-          # TODO add indexes as necessary
         end
       
         def down

data/spec/generators/schema_class/my_schema_with_complex_types_spec.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # For testing the generated class.
-RSpec.describe Schemas::MySchemaWithComplexTypes do
+RSpec.describe Schemas::MySchemaWithComplexType do
   let(:payload_hash) do
     {
       test_id: 'test id',
@@ -9,16 +9,16 @@ RSpec.describe Schemas::MySchemaWithComplexTypes do
       test_string_array: %w(abc def),
       test_int_array: [123, 456],
       some_integer_map: { 'int_1' => 1, 'int_2' => 2 },
-      some_record: Schemas::ARecord.new(a_record_field: 'field 1'),
-      some_optional_record: Schemas::ARecord.new(a_record_field: 'field 2'),
-      some_record_array: [Schemas::ARecord.new(a_record_field: 'field 3'),
-                          Schemas::ARecord.new(a_record_field: 'field 4')],
+      some_record: Schemas::MySchemaWithComplexType::ARecord.new(a_record_field: 'field 1'),
+      some_optional_record: Schemas::MySchemaWithComplexType::ARecord.new(a_record_field: 'field 2'),
+      some_record_array: [Schemas::MySchemaWithComplexType::ARecord.new(a_record_field: 'field 3'),
+                          Schemas::MySchemaWithComplexType::ARecord.new(a_record_field: 'field 4')],
       some_record_map: {
-        'record_1' => Schemas::ARecord.new(a_record_field: 'field 5'),
-        'record_2' => Schemas::ARecord.new(a_record_field: 'field 6')
+        'record_1' => Schemas::MySchemaWithComplexType::ARecord.new(a_record_field: 'field 5'),
+        'record_2' => Schemas::MySchemaWithComplexType::ARecord.new(a_record_field: 'field 6')
       },
-      some_enum_array: [Schemas::AnEnum.new('sym1'),
-                        Schemas::AnEnum.new('sym2')]
+      some_enum_array: [Schemas::MySchemaWithComplexType::AnEnum.new('sym1'),
+                        Schemas::MySchemaWithComplexType::AnEnum.new('sym2')]
     }
   end
 
@@ -57,7 +57,9 @@ 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 some_optional_enum some_enum_with_default)
+      %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
@@ -113,7 +115,8 @@ RSpec.describe Schemas::MySchemaWithComplexTypes do
     it 'should set some_record if it is not provided' do
       payload_hash.delete(:some_record)
       klass = described_class.new(**payload_hash)
-      expect(klass.some_record).to eq(Schemas::ARecord.new(a_record_field: 'Test String'))
+      expect(klass.some_record).
+        to eq(Schemas::MySchemaWithComplexType::ARecord.new(a_record_field: 'Test String'))
     end
 
     it 'should set some_record to nil' do
@@ -136,25 +139,26 @@ RSpec.describe Schemas::MySchemaWithComplexTypes do
 
       it 'should get the value of some_record_array' do
         some_record_array = klass.some_record_array
-        expect(some_record_array.first).to be_instance_of(Schemas::ARecord)
+        expect(some_record_array.first).to be_instance_of(Schemas::MySchemaWithComplexType::ARecord)
         expect(some_record_array.first.a_record_field).to eq('field 3')
       end
 
       it 'should get the value of some_record_map' do
         some_record_map = klass.some_record_map
-        expect(some_record_map['record_1']).to be_instance_of(Schemas::ARecord)
+        expect(some_record_map['record_1']).
+          to be_instance_of(Schemas::MySchemaWithComplexType::ARecord)
         expect(some_record_map['record_1'].a_record_field).to eq('field 5')
       end
 
       it 'should get the value of some_enum_array' do
         some_enum_array = klass.some_enum_array
-        expect(some_enum_array.first).to be_instance_of(Schemas::AnEnum)
+        expect(some_enum_array.first).to be_instance_of(Schemas::MySchemaWithComplexType::AnEnum)
         expect(some_enum_array.first.an_enum).to eq('sym1')
       end
 
       it 'should get the value of some_record' do
         record = klass.some_record
-        expect(record).to be_instance_of(Schemas::ARecord)
+        expect(record).to be_instance_of(Schemas::MySchemaWithComplexType::ARecord)
         expect(record.a_record_field).to eq('field 1')
         expect(record.to_h).to eq({ 'a_record_field' => 'field 1' })
       end
@@ -175,33 +179,42 @@ RSpec.describe Schemas::MySchemaWithComplexTypes do
       end
 
       it 'should modify the value of some_optional_record' do
-        expect(klass.some_optional_record).to eq(Schemas::ARecord.new(a_record_field: 'field 2'))
-        klass.some_optional_record = Schemas::ARecord.new(a_record_field: 'new field')
+        expect(klass.some_optional_record).
+          to eq(Schemas::MySchemaWithComplexType::ARecord.new(a_record_field: 'field 2'))
+        klass.some_optional_record = Schemas::MySchemaWithComplexType::ARecord.
+          new(a_record_field: 'new field')
 
-        expect(klass.some_optional_record).to eq(Schemas::ARecord.new(a_record_field: 'new field'))
+        expect(klass.some_optional_record).to eq(Schemas::MySchemaWithComplexType::ARecord.
+          new(a_record_field: 'new field'))
         expect(klass.some_optional_record.as_json).to eq({ 'a_record_field' => 'new field' })
       end
 
       it 'should accept a hash object inner records' do
         klass.some_optional_record = { a_record_field: 'new field' }
-        expect(klass.some_optional_record).to eq(Schemas::ARecord.new(a_record_field: 'new field'))
+        expect(klass.some_optional_record).to eq(Schemas::MySchemaWithComplexType::ARecord.
+          new(a_record_field: 'new field'))
         expect(klass.some_optional_record.as_json).to eq({ 'a_record_field' => 'new field' })
       end
 
       it 'should modify the value of some_enum_array' do
         klass.some_enum_array.first.an_enum = 'new_sym'
-        expect(klass.some_enum_array.first).to eq(Schemas::AnEnum.new('new_sym'))
+        expect(klass.some_enum_array.first).
+          to eq(Schemas::MySchemaWithComplexType::AnEnum.new('new_sym'))
 
-        klass.some_enum_array.second.an_enum = Schemas::AnEnum.new('other_sym')
+        klass.some_enum_array.second.an_enum = Schemas::MySchemaWithComplexType::AnEnum.
+          new('other_sym')
         expect(klass.some_enum_array.second.an_enum).to eq('other_sym')
       end
 
       it 'should modify the value of some_record_map' do
         klass.some_record_map['record_1'].a_record_field = 'new field'
-        expect(klass.some_record_map['record_1']).to eq(Schemas::ARecord.new(a_record_field: 'new field'))
+        expect(klass.some_record_map['record_1']).to eq(Schemas::MySchemaWithComplexType::ARecord.
+          new(a_record_field: 'new field'))
 
-        klass.some_record_map['record_2'] = Schemas::ARecord.new(a_record_field: 'other field')
-        expect(klass.some_record_map['record_2']).to eq(Schemas::ARecord.new(a_record_field: 'other field'))
+        klass.some_record_map['record_2'] = Schemas::MySchemaWithComplexType::ARecord.
+          new(a_record_field: 'other field')
+        expect(klass.some_record_map['record_2']).to eq(Schemas::MySchemaWithComplexType::ARecord.
+          new(a_record_field: 'other field'))
       end
     end
   end