avromatic 4.0.0 → 4.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b0efb11db848986a5f33f4d499ac919bb1e217b8e1d0b06311f485a26f0c94a
-  data.tar.gz: 2aee989c64a77e875894146a98ebdcd8a15409ba556b86a1d4bce9c18ee977fa
+  metadata.gz: 7bec6621c5d35e04596185542eaa4d96d00ef67f86f24b26378c68b22ecb3b3c
+  data.tar.gz: 1468ebd3138c5dc63a5d18d86dab5757df5c67109867628d1161b01ef70db1f3
 SHA512:
-  metadata.gz: a84b530d3d65135ff5520e412cb8517062dfa964bc3cff4511f81d310429d6b804f93a392c5a6add8c9f7c278207ed38e19a0117b3e17b2dfec948ffb2a10748
-  data.tar.gz: 7a1e707977d52b68b2bcd78de6bf8db5db097c7afc32493db2d242c1733aa1b3610d53fd640e68db0d23f9192f9e6e7910793512a6001b36976e700d66ae36ee
+  metadata.gz: da43c835a7f56011c1ed194bba7a02e5f98a190f65a8ce025b67f8a23d9a43093e2e64f83cdaf520d847c37ecf66cfd6ed276aee7f195a9f3f2b0c248967f5bf
+  data.tar.gz: 920048102d5947af69eca3d4e4c357adf9eefaebbd83e8d70190d29a6fb8d30c65072c97fda65613d9ebed32e127f98d9f4952e1e91e081963e61a480a002af3

data/.github/CODEOWNERS

@@ -1 +1 @@
-* @jturkel @kphelps @tjwp
+* @jturkel @tjwp @salsify/infrastructure-services

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # avromatic changelog
 
+## 4.1.1
+- Fix eager loading of nested models when using the Zeitwerk classloader with Rails.
+
+## 4.1.0
+- Add support for specifying a subject for the avro schema when building an Avromatic model
+
 ## 4.0.0
 - Drop support for Ruby 2.6.
 - Drop support for Avro 1.9.

data/README.md

@@ -124,7 +124,7 @@ The Avro schema can be specified by name and loaded using the schema store:
 
 ```ruby
 class MyModel
-  include Avromatic::Model.build(schema_name :my_model)
+  include Avromatic::Model.build(schema_name: :my_model)
 end
 
 # Construct instances by passing in a hash of attributes
@@ -156,12 +156,20 @@ class MyModel
 end
 ```
 
+A specific subject name can be associated with the schema:
+```ruby
+class MyModel
+  include Avromatic::Model.build(schema_name: 'my_model',
+                                 schema_subject: 'my_model-value')
+end
+```
+
 Models are generated as immutable value
 objects by default, but can optionally be defined as mutable:
 
 ```ruby
 class MyModel
-  include Avromatic::Model.build(schema_name :my_model, mutable: true)
+  include Avromatic::Model.build(schema_name: :my_model, mutable: true)
 end
 ```
 
@@ -195,6 +203,16 @@ class MyTopic
 end
 ```
 
+A specific subject name can be associated with both the value and key schemas:
+```ruby
+class MyTopic
+  include Avromatic::Model.build(value_schema_name: :topic_value,
+                                 value_schema_subject: 'topic_value-value',
+                                 key_schema_name: :topic_key,
+                                 key_schema_subject: 'topic_key-value')
+end
+```
+
 A model can also be generated as an anonymous class that can be assigned to a
 constant:
 
@@ -268,7 +286,7 @@ correct order:
 Avromatic.configure do |config|
   config.eager_load_models = [
     # reference any extended models that should be defined first
-    MyNestedModel
+    'MyNestedModel'
   ]
 end
 ```

data/avromatic.gemspec

@@ -45,7 +45,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.8'
   spec.add_development_dependency 'rspec_junit_formatter'
-  spec.add_development_dependency 'salsify_rubocop', '~> 1.1.0'
+  spec.add_development_dependency 'salsify_rubocop', '~> 1.27.1'
   spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'webmock'
   # For AvroSchemaRegistry::FakeServer

data/lib/avromatic/model/configurable.rb

@@ -24,7 +24,8 @@ module Avromatic
       end
 
       module ClassMethods
-        delegate :avro_schema, :value_avro_schema, :key_avro_schema, :mutable?, :immutable?, to: :config
+        delegate :avro_schema, :value_avro_schema, :key_avro_schema, :mutable?, :immutable?,
+                 :avro_schema_subject, :value_avro_schema_subject, :key_avro_schema_subject, to: :config
 
         def value_avro_field_names
           @value_avro_field_names ||= value_avro_schema.fields.map(&:name).map(&:to_sym).freeze
@@ -68,6 +69,7 @@ module Avromatic
       end
 
       delegate :avro_schema, :value_avro_schema, :key_avro_schema,
+               :avro_schema_subject, :value_avro_schema_subject, :key_avro_schema_subject,
                :value_avro_field_names, :key_avro_field_names,
                :value_avro_field_references, :key_avro_field_references,
                :mutable?, :immutable?,

data/lib/avromatic/model/configuration.rb

@@ -7,7 +7,7 @@ module Avromatic
     class Configuration
 
       attr_reader :avro_schema, :key_avro_schema, :nested_models, :mutable,
-                  :allow_optional_key_fields
+                  :allow_optional_key_fields, :avro_schema_subject, :key_avro_schema_subject
       alias_method :mutable?, :mutable
       delegate :schema_store, to: Avromatic
 
@@ -17,24 +17,30 @@ module Avromatic
       # @param options [Hash]
       # @option options [Avro::Schema] :schema
       # @option options [String, Symbol] :schema_name
+      # @option options [String, Symbol] :schema_subject
       # @option options [Avro::Schema] :value_schema
       # @option options [String, Symbol] :value_schema_name
+      # @option options [String, Symbol] :value_schema_subject
       # @option options [Avro::Schema] :key_schema
       # @option options [String, Symbol] :key_schema_name
+      # @option options [String, Symbol] :key_schema_subject
       # @option options [Avromatic::ModelRegistry] :nested_models
       # @option options [Boolean] :mutable, default false
       # @option options [Boolean] :allow_optional_key_fields, default false
       def initialize(**options)
         @avro_schema = find_avro_schema(**options)
+        @avro_schema_subject = options[:schema_subject] || options[:value_schema_subject]
         raise ArgumentError.new('value_schema(_name) or schema(_name) must be specified') unless avro_schema
 
         @key_avro_schema = find_schema_by_option(:key_schema, **options)
+        @key_avro_schema_subject = options[:key_schema_subject]
         @nested_models = options[:nested_models]
         @mutable = options.fetch(:mutable, false)
         @allow_optional_key_fields = options.fetch(:allow_optional_key_fields, false)
       end
 
       alias_method :value_avro_schema, :avro_schema
+      alias_method :value_avro_schema_subject, :avro_schema_subject
 
       def immutable?
         !mutable?

data/lib/avromatic/model/messaging_serialization.rb

@@ -16,7 +16,8 @@ module Avromatic
         def avro_message_value
           avro_messaging.encode(
             value_attributes_for_avro,
-            schema_name: value_avro_schema.fullname
+            schema_name: value_avro_schema.fullname,
+            subject: value_avro_schema_subject
           )
         end
 
@@ -25,7 +26,8 @@ module Avromatic
 
           avro_messaging.encode(
             key_attributes_for_avro,
-            schema_name: key_avro_schema.fullname
+            schema_name: key_avro_schema.fullname,
+            subject: key_avro_schema_subject
           )
         end
       end
@@ -56,15 +58,15 @@ module Avromatic
 
       module Registration
         def register_schemas!
-          register_schema(key_avro_schema) if key_avro_schema
-          register_schema(value_avro_schema)
+          register_schema(key_avro_schema, subject: key_avro_schema_subject) if key_avro_schema
+          register_schema(value_avro_schema, subject: value_avro_schema_subject)
           nil
         end
 
         private
 
-        def register_schema(schema)
-          avro_messaging.registry.register(schema.fullname, schema)
+        def register_schema(schema, subject: nil)
+          avro_messaging.registry.register(subject || schema.fullname, schema)
         end
       end
 

data/lib/avromatic/model/types/type_factory.rb

@@ -60,11 +60,11 @@ module Avromatic
               Avromatic::Model::Types::EnumType.new(schema.symbols)
             when :array
               value_type = create(schema: schema.items, nested_models: nested_models,
-use_custom_types: use_custom_types)
+                                  use_custom_types: use_custom_types)
               Avromatic::Model::Types::ArrayType.new(value_type: value_type)
             when :map
               value_type = create(schema: schema.values, nested_models: nested_models,
-use_custom_types: use_custom_types)
+                                  use_custom_types: use_custom_types)
               Avromatic::Model::Types::MapType.new(
                 key_type: Avromatic::Model::Types::StringType.new,
                 value_type: value_type

data/lib/avromatic/railtie.rb

@@ -7,19 +7,8 @@ module Avromatic
         config.logger = Rails.logger
       end
 
-      # Rails calls the to_prepare hook once during boot-up, after running
-      # initializers. After the to_prepare call during boot-up, no code will
-      # we reloaded, so we need to retain the contents of the nested_models
-      # registry.
-      #
-      # For subsequent calls to to_prepare (in development), the nested_models
-      # registry is cleared and repopulated by explicitly referencing the
-      # eager_loaded_models.
-      first_prepare = true
-
       Rails.configuration.to_prepare do
-        Avromatic.prepare!(skip_clear: first_prepare)
-        first_prepare = false
+        Avromatic.prepare!
       end
     end
   end

data/lib/avromatic/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Avromatic
-  VERSION = '4.0.0'
+  VERSION = '4.1.1'
 end

data/lib/avromatic.rb

@@ -29,7 +29,6 @@ module Avromatic
 
   def self.configure
     yield self
-    eager_load_models!
   end
 
   def self.build_schema_registry
@@ -66,18 +65,16 @@ module Avromatic
 
   # This method is called as a Rails to_prepare hook after the application
   # first initializes during boot-up and prior to each code reloading.
-  # For the first call during boot-up we do not want to clear the nested_models.
-  def self.prepare!(skip_clear: false)
-    unless skip_clear
-      nested_models.clear
-      if schema_store
-        if schema_store.respond_to?(:clear_schemas)
-          schema_store.clear_schemas
-        elsif schema_store.respond_to?(:clear)
-          schema_store.clear
-        end
+  def self.prepare!
+    nested_models.clear
+    if schema_store
+      if schema_store.respond_to?(:clear_schemas)
+        schema_store.clear_schemas
+      elsif schema_store.respond_to?(:clear)
+        schema_store.clear
       end
     end
+
     eager_load_models!
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: avromatic
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.1.1
 platform: ruby
 authors:
 - Salsify Engineering
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-12 00:00:00.000000000 Z
+date: 2022-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -216,14 +216,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.27.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.27.1
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -364,7 +364,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Generate Ruby models from Avro schemas