avromatic 4.0.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b0efb11db848986a5f33f4d499ac919bb1e217b8e1d0b06311f485a26f0c94a
-  data.tar.gz: 2aee989c64a77e875894146a98ebdcd8a15409ba556b86a1d4bce9c18ee977fa
+  metadata.gz: edd31aa475804bf20a1f5b4ddbe90e8c98460617daeaf2e1641316c08cce505b
+  data.tar.gz: b20ae31b2aeff034f9fa99e2a90d4bb78dfe894967ab8e0267b1df6ee954a15d
 SHA512:
-  metadata.gz: a84b530d3d65135ff5520e412cb8517062dfa964bc3cff4511f81d310429d6b804f93a392c5a6add8c9f7c278207ed38e19a0117b3e17b2dfec948ffb2a10748
-  data.tar.gz: 7a1e707977d52b68b2bcd78de6bf8db5db097c7afc32493db2d242c1733aa1b3610d53fd640e68db0d23f9192f9e6e7910793512a6001b36976e700d66ae36ee
+  metadata.gz: 6e4d441e7645b52840725041d361f699266a9e5dd974e8cd588c8f4750ba21eb4efd016b9c6c20e034a98ed79b673f9aa12a5f0b3a56312a57b344659b93606d
+  data.tar.gz: 5b8ba9cc0049f80a31f88399ca504796997038b969d728be5867d6fd5bc6868786e4ae9dffc0de8a7c1db99e129f9398e4f867794dbd449d54f74c69650735bb

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # avromatic changelog
 
+## 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:
 

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: avromatic
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.1.0
 platform: ruby
 authors:
 - Salsify Engineering
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-12 00:00:00.000000000 Z
+date: 2022-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel