avromatic 2.2.6 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5038f6f83ba2ca87bc8cd16a96aae5528397ca5cf9ef01d955861459ae68391a
-  data.tar.gz: 83f5e8bb53086297882f77108480976292a2ca97b40dcb3da5a23c579a7c1edd
+  metadata.gz: a7401c0e72992925f02234f5d3d2ab8e762a36bc62aa25c631569d6f4d9918d2
+  data.tar.gz: f2121b2a62bf60893ea0eb143ed83a142ea069d07839fb8121d0618483b469d5
 SHA512:
-  metadata.gz: 5d5f8501fc5e050db26475ea1205a1c08f864d6fae8272e54c4a04df4fb22bf634868dadde7eade371a6b22f5438423f84a6405808286b1c687fb7acb26859c3
-  data.tar.gz: 7025885a25ab59923d8efc08e494a51f3c6bc57f0e72eedc84c00b9b46c1ef1df085d99ba9135d6997a8370f3fb1497690a714ca067896faad1a2e9a25f0e970
+  metadata.gz: 42be85747686fca4ec66d6e178f7e5aab6d9e9ab88cd4d107ed1c5de8a83017f083a510889ced33a2eb284f45865b3c32b3a9edad200011aed5b17c284f3a593
+  data.tar.gz: be13122bca8693d33e20d1317ae5cd88d8c1c975c08d94ed522d0330d70f202bc43d79d7f2941032bc7540ad83b2d647d3c7d29bb5b72c03a560dfedb85e62f7

data/.circleci/config.yml

@@ -0,0 +1,85 @@
+version: 2.1
+jobs:
+  lint:
+    docker:
+      - image: salsify/ruby_ci:2.5.8
+    working_directory: ~/avromatic
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+            - v2-gems-ruby-2.5.8-{{ checksum "avromatic.gemspec" }}-{{ checksum "Gemfile" }}
+            - v2-gems-ruby-2.5.8-
+      - run:
+          name: Install Gems
+          command: |
+            if ! bundle check --path=vendor/bundle; then
+              bundle install --path=vendor/bundle --jobs=4 --retry=3
+              bundle clean
+            fi
+      - save_cache:
+          key: v2-gems-ruby-2.5.8-{{ checksum "avromatic.gemspec" }}-{{ checksum "Gemfile" }}
+          paths:
+            - "vendor/bundle"
+            - "gemfiles/vendor/bundle"
+      - run:
+          name: Run Rubocop
+          command: bundle exec rubocop
+  test:
+    parameters:
+      gemfile:
+        type: string
+      ruby-version:
+        type: string
+    docker:
+      - image: salsify/ruby_ci:<< parameters.ruby-version >>
+    environment:
+      CIRCLE_TEST_REPORTS: "test-results"
+      BUNDLE_GEMFILE: << parameters.gemfile >>
+    working_directory: ~/avromatic
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+            - v2-gems-ruby-<< parameters.ruby-version >>-{{ checksum "avromatic.gemspec" }}-{{ checksum "<< parameters.gemfile >>" }}
+            - v2-gems-ruby-<< parameters.ruby-version >>-
+      - run:
+          name: Install Gems
+          command: |
+            if ! bundle check --path=vendor/bundle; then
+              bundle install --path=vendor/bundle --jobs=4 --retry=3
+              bundle clean
+            fi
+      - save_cache:
+          key: v2-gems-ruby-<< parameters.ruby-version >>-{{ checksum "avromatic.gemspec" }}-{{ checksum "<< parameters.gemfile >>" }}
+          paths:
+            - "vendor/bundle"
+            - "gemfiles/vendor/bundle"
+      - run:
+          name: Run Tests
+          command: |
+            bundle exec rspec --format RspecJunitFormatter --out $CIRCLE_TEST_REPORTS/rspec/junit.xml --format progress spec
+      - store_test_results:
+          path: "test-results"
+workflows:
+  build:
+    jobs:
+      - lint
+      - test:
+          matrix:
+            parameters:
+              gemfile:
+              - "gemfiles/avro1_8_rails5_2.gemfile"
+              - "gemfiles/avro1_9_rails5_2.gemfile"
+              - "gemfiles/avro1_10_rails5_2.gemfile"
+              - "gemfiles/avro1_9_rails6_0.gemfile"
+              - "gemfiles/avro1_10_rails6_0.gemfile"
+              - "gemfiles/avro_patches_rails5_2.gemfile"
+              - "gemfiles/avro_patches_rails6_0.gemfile"
+              - "gemfiles/avro1_10_rails6_1.gemfile"
+              - "gemfiles/avro1_9_rails6_1.gemfile"
+              - "gemfiles/avro_patches_rails6_1.gemfile"
+              ruby-version:
+              - "2.5.8"
+              - "2.6.6"
+              - "2.7.1"

data/.rubocop.yml

@@ -3,6 +3,9 @@ inherit_gem:
 
 AllCops:
   TargetRubyVersion: 2.4
+  Exclude:
+    - 'vendor/**/*'
+    - 'gemfiles/vendor/**/*'
 
 Style/MultilineBlockChain:
   Enabled: false

data/Appraisals

@@ -41,3 +41,21 @@ appraise 'avro-patches-rails6_0' do
   gem 'activesupport', '~> 6.0.0'
   gem 'activemodel', '~> 6.0.0'
 end
+
+appraise 'avro1_9-rails6_1' do
+  gem 'avro', '1.9.2'
+  gem 'activesupport', '~> 6.1.0'
+  gem 'activemodel', '~> 6.1.0'
+end
+
+appraise 'avro1_10-rails6_1' do
+  gem 'avro', '~> 1.10.0'
+  gem 'activesupport', '~> 6.1.0'
+  gem 'activemodel', '~> 6.1.0'
+end
+
+appraise 'avro-patches-rails6_1' do
+  gem 'avro-patches', '>= 1.0.0'
+  gem 'activesupport', '~> 6.1.0'
+  gem 'activemodel', '~> 6.1.0'
+end

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # avromatic changelog
 
+## v2.4.0
+- Ignore the `validate` argument and always validate during serialization. This
+  argument will be removed in Avromatic 3.0.
+- Optimize model validation during serialization.
+- Don't cache immutable model validation results or serialized Avro attributes if a model has mutable children.
+
+## v2.3.0
+- Add support for Rails 6.1.
+- Optimize nested model serialization.
+
 ## v2.2.6
 - Optimize memory usage when serializing models.
 

data/README.md

@@ -1,9 +1,9 @@
 # Avromatic
 
-[![Build Status](https://travis-ci.org/salsify/avromatic.svg?branch=master)][travis]
+[![Build Status](https://circleci.com/gh/salsify/avromatic.svg?style=svg)][circleci]
 [![Gem Version](https://badge.fury.io/rb/avromatic.svg)](https://badge.fury.io/rb/avromatic)
 
-[travis]: http://travis-ci.org/salsify/avromatic
+[circleci]: https://circleci.com/gh/salsify/avromatic
 
 `Avromatic` generates Ruby models from [Avro](http://avro.apache.org/) schemas
 and provides utilities to encode and decode them.

data/avromatic.gemspec

@@ -22,8 +22,8 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.4'
 
-  spec.add_runtime_dependency 'activemodel', '>= 5.0', '< 6.1'
-  spec.add_runtime_dependency 'activesupport', '>= 5.0', '< 6.1'
+  spec.add_runtime_dependency 'activemodel', '>= 5.0', '< 6.2'
+  spec.add_runtime_dependency 'activesupport', '>= 5.0', '< 6.2'
   spec.add_runtime_dependency 'avro', '>= 1.7.7', '< 1.11'
   spec.add_runtime_dependency 'avro_schema_registry-client', '>= 0.3.0'
   spec.add_runtime_dependency 'avro_turf'
@@ -35,6 +35,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'overcommit', '0.35.0'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rspec_junit_formatter'
   spec.add_development_dependency 'salsify_rubocop', '~> 0.52.1.1'
   spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'webmock'

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "avromatic"
+require 'bundler/setup'
+require 'avromatic'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +11,5 @@ require "avromatic"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/gemfiles/avro1_10_rails6_1.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "avro", "~> 1.10.0"
+gem "activesupport", "~> 6.1.0"
+gem "activemodel", "~> 6.1.0"
+
+gemspec path: "../"

data/gemfiles/avro1_9_rails6_1.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "avro", "1.9.2"
+gem "activesupport", "~> 6.1.0"
+gem "activemodel", "~> 6.1.0"
+
+gemspec path: "../"

data/gemfiles/avro_patches_rails6_1.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "avro-patches", ">= 1.0.0"
+gem "activesupport", "~> 6.1.0"
+gem "activemodel", "~> 6.1.0"
+
+gemspec path: "../"

data/lib/avromatic.rb

@@ -8,7 +8,6 @@ require 'avromatic/model'
 require 'avromatic/model_registry'
 require 'avromatic/messaging'
 require 'active_support/core_ext/string/inflections'
-require 'avromatic/patches'
 
 module Avromatic
   class << self
@@ -33,10 +32,6 @@ module Avromatic
     eager_load_models!
   end
 
-  def self.use_encoding_providers?
-    use_custom_datum_writer && defined?(Avromatic::Patches::SchemaValidatorPatch)
-  end
-
   def self.build_schema_registry
     raise 'Avromatic must be configured with a registry_url' unless registry_url
     if use_schema_fingerprint_lookup

data/lib/avromatic/io.rb

@@ -1,11 +1,5 @@
 # frozen_string_literal: true
 
-module Avromatic
-  module IO
-    UNION_MEMBER_INDEX = '__avromatic_member_index'
-    ENCODING_PROVIDER = '__avromatic_encoding_provider'
-  end
-end
-
 require 'avromatic/io/datum_reader'
 require 'avromatic/io/datum_writer'
+require 'avromatic/io/union_datum'

data/lib/avromatic/io/datum_reader.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-# rubocop:disable Style/WhenThen
 module Avromatic
   module IO
     # Subclass DatumReader to include additional information about the union
@@ -8,81 +7,32 @@ module Avromatic
     # branch 'salsify-master' with the tag 'v1.9.0.3'
     class DatumReader < Avro::IO::DatumReader
 
-      UNION_MEMBER_INDEX = Avromatic::IO::UNION_MEMBER_INDEX
-
-      def read_data(writers_schema, readers_schema, decoder, initial_record = nil)
-        # schema matching
-        unless self.class.match_schemas(writers_schema, readers_schema)
-          raise Avro::IO::SchemaMatchException.new(writers_schema, readers_schema)
-        end
-
+      def read_data(writers_schema, readers_schema, decoder)
         # schema resolution: reader's schema is a union, writer's schema is not
-        if writers_schema.type_sym != :union && readers_schema.type_sym == :union
-          rs_index = readers_schema.schemas.find_index do |s|
-            self.class.match_schemas(writers_schema, s)
-          end
+        return super unless writers_schema.type_sym != :union && readers_schema.type_sym == :union
 
-          optional = readers_schema.schemas.first.type_sym == :null
-          union_info = if readers_schema.schemas.size == 2 && optional
-                         # Avromatic does not treat the union of null and 1 other type as a union
-                         nil
-                       elsif optional
-                         # Avromatic does not treat the null of an optional field as part of the union
-                         { UNION_MEMBER_INDEX => rs_index - 1 }
-                       else
-                         { UNION_MEMBER_INDEX => rs_index }
-                       end
-
-          return read_data(writers_schema, readers_schema.schemas[rs_index], decoder, union_info) if rs_index
-          raise Avro::IO::SchemaMatchException.new(writers_schema, readers_schema)
+        rs_index = readers_schema.schemas.find_index do |s|
+          self.class.match_schemas(writers_schema, s)
         end
 
-        # function dispatch for reading data based on type of writer's schema
-        datum = case writers_schema.type_sym
-                when :null;    decoder.read_null
-                when :boolean; decoder.read_boolean
-                when :string;  decoder.read_string
-                when :int;     decoder.read_int
-                when :long;    decoder.read_long
-                when :float;   decoder.read_float
-                when :double;  decoder.read_double
-                when :bytes;   decoder.read_bytes
-                when :fixed;   read_fixed(writers_schema, readers_schema, decoder)
-                when :enum;    read_enum(writers_schema, readers_schema, decoder)
-                when :array;   read_array(writers_schema, readers_schema, decoder)
-                when :map;     read_map(writers_schema, readers_schema, decoder)
-                when :union;   read_union(writers_schema, readers_schema, decoder)
-                when :record, :error, :request; read_record(writers_schema, readers_schema, decoder, initial_record || {})
-                else
-                  raise Avro::AvroError.new("Cannot read unknown schema type: #{writers_schema.type}")
-                end
+        raise Avro::IO::SchemaMatchException.new(writers_schema, readers_schema) unless rs_index
 
-        # Allow this code to be used with an official Avro release or the
-        # avro-patches gem that includes logical_type support.
-        if readers_schema.respond_to?(:logical_type)
-          readers_schema.type_adapter.decode(datum)
-        else
-          datum
-        end
-      end
+        datum = read_data(writers_schema, readers_schema.schemas[rs_index], decoder)
+        optional = readers_schema.schemas.first.type_sym == :null
 
-      # Override to specify an initial record that may contain union index
-      def read_record(writers_schema, readers_schema, decoder, initial_record = {})
-        readers_fields_hash = readers_schema.fields_hash
-        read_record = Avromatic.use_custom_datum_reader ? initial_record : {}
-        writers_schema.fields.each do |field|
-          readers_field = readers_fields_hash[field.name]
-          if readers_field
-            field_val = read_data(field.type, readers_field.type, decoder)
-            read_record[field.name] = field_val
-          else
-            skip_data(field.type, decoder)
-          end
+        if readers_schema.schemas.size == 2 && optional
+          # Avromatic does not treat the union of null and 1 other type as a union
+          datum
+        elsif datum.nil?
+          # Avromatic does not treat the null of an optional field as part of the union
+          nil
+        else
+          # Avromatic does not treat the null of an optional field as part of the union so
+          # adjust the member index accordingly
+          member_index = optional ? rs_index - 1 : rs_index
+          Avromatic::IO::UnionDatum.new(member_index, datum)
         end
-
-        read_record
       end
     end
   end
 end
-# rubocop:enable Style/WhenThen

data/lib/avromatic/io/datum_writer.rb

@@ -7,10 +7,11 @@ module Avromatic
     class DatumWriter < Avro::IO::DatumWriter
       def write_union(writers_schema, datum, encoder)
         optional = writers_schema.schemas.first.type_sym == :null
-        if datum.is_a?(Hash) && datum.key?(Avromatic::IO::UNION_MEMBER_INDEX)
-          index_of_schema = datum[Avromatic::IO::UNION_MEMBER_INDEX]
+        if datum.is_a?(Avromatic::IO::UnionDatum)
+          index_of_schema = datum.member_index
           # Avromatic does not treat the null of an optional field as part of the union
           index_of_schema += 1 if optional
+          datum = datum.datum
         elsif optional && writers_schema.schemas.size == 2
           # Optimize for the common case of a union that's just an optional field
           index_of_schema = datum.nil? ? 0 : 1
@@ -19,21 +20,14 @@ module Avromatic
             Avro::Schema.validate(schema, datum)
           end
         end
+
         unless index_of_schema
           raise Avro::IO::AvroTypeError.new(writers_schema, datum)
         end
+
         encoder.write_long(index_of_schema)
         write_data(writers_schema.schemas[index_of_schema], datum, encoder)
       end
-
-      def write_record(writers_schema, datum, encoder)
-        if datum.is_a?(Hash) && datum.key?(Avromatic::IO::ENCODING_PROVIDER)
-          # This is only used for recursive serialization so validation has already been done
-          encoder.write(datum[Avromatic::IO::ENCODING_PROVIDER].avro_raw_value(validate: false))
-        else
-          super
-        end
-      end
     end
   end
 end

data/lib/avromatic/io/union_datum.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Avromatic
+  module IO
+    class UnionDatum
+      attr_reader :member_index, :datum
+
+      def initialize(member_index, datum)
+        @member_index = member_index
+        @datum = datum
+      end
+
+      def ==(other)
+        other.is_a?(Avromatic::IO::UnionDatum) &&
+          member_index == other.member_index &&
+          datum == other.datum
+      end
+      alias_method :eql?, :==
+
+      def hash
+        31 * datum.hash + member_index
+      end
+    end
+  end
+end

data/lib/avromatic/messaging.rb

@@ -29,7 +29,8 @@ module Avromatic
       end
 
       # The following line differs from the parent class to use a custom DatumReader
-      reader = Avromatic::IO::DatumReader.new(writers_schema, readers_schema)
+      reader_class = Avromatic.use_custom_datum_reader ? Avromatic::IO::DatumReader : Avro::IO::DatumReader
+      reader = reader_class.new(writers_schema, readers_schema)
       reader.read(decoder)
     end
 
@@ -50,7 +51,8 @@ module Avromatic
       encoder.write([schema_id].pack('N'))
 
       # The following line differs from the parent class to use a custom DatumWriter
-      writer = Avromatic::IO::DatumWriter.new(schema)
+      writer_class = Avromatic.use_custom_datum_writer ? Avromatic::IO::DatumWriter : Avro::IO::DatumWriter
+      writer = writer_class.new(schema)
 
       # The actual message comes last.
       writer.write(message, encoder)

data/lib/avromatic/model/attributes.rb

@@ -27,7 +27,10 @@ module Avromatic
         def initialize(owner:, field:, type:)
           @owner = owner
           @field = field
+          @required = FieldHelper.required?(field)
+          @nullable = FieldHelper.nullable?(field)
           @type = type
+          @values_immutable = type.referenced_model_classes.all?(&:recursively_immutable?)
           @name = field.name.to_sym
           @name_string = field.name.to_s.dup.freeze
           @setter_name = "#{field.name}=".to_sym
@@ -40,8 +43,16 @@ module Avromatic
                      end
         end
 
+        def nullable?
+          @nullable
+        end
+
         def required?
-          FieldHelper.required?(field)
+          @required
+        end
+
+        def values_immutable?
+          @values_immutable
         end
 
         def coerce(input)
@@ -69,6 +80,8 @@ module Avromatic
       included do
         class_attribute :attribute_definitions, instance_writer: false
         self.attribute_definitions = {}
+
+        delegate :recursively_immutable?, to: :class
       end
 
       def initialize(data = {})
@@ -130,6 +143,12 @@ module Avromatic
           define_avro_attributes(avro_schema, generated_methods_module)
         end
 
+        def recursively_immutable?
+          return @recursively_immutable if defined?(@recursively_immutable)
+
+          @recursively_immutable = immutable? && attribute_definitions.each_value.all?(&:values_immutable?)
+        end
+
         private
 
         def check_for_field_conflicts!
@@ -174,10 +193,10 @@ module Avromatic
             generated_methods_module.send(:define_method, "#{field.name}?") { !!_attributes[symbolized_field_name] } if FieldHelper.boolean?(field)
 
             generated_methods_module.send(:define_method, "#{field.name}=") do |value|
-              _attributes[symbolized_field_name] = attribute_definitions[symbolized_field_name].coerce(value)
+              _attributes[symbolized_field_name] = attribute_definition.coerce(value)
             end
 
-            unless config.mutable # rubocop:disable Style/Next
+            unless mutable? # rubocop:disable Style/Next
               generated_methods_module.send(:private, "#{field.name}=")
               generated_methods_module.send(:define_method, :clone) { self }
               generated_methods_module.send(:define_method, :dup) { self }

data/lib/avromatic/model/configurable.rb

@@ -19,9 +19,12 @@ module Avromatic
         end
       end
 
+      included do
+        class_attribute :config, instance_accessor: false, instance_predicate: false
+      end
+
       module ClassMethods
-        attr_accessor :config
-        delegate :avro_schema, :value_avro_schema, :key_avro_schema, to: :config
+        delegate :avro_schema, :value_avro_schema, :key_avro_schema, :mutable?, :immutable?, to: :config
 
         def value_avro_field_names
           @value_avro_field_names ||= value_avro_schema.fields.map(&:name).map(&:to_sym).freeze
@@ -67,6 +70,7 @@ module Avromatic
       delegate :avro_schema, :value_avro_schema, :key_avro_schema,
                :value_avro_field_names, :key_avro_field_names,
                :value_avro_field_references, :key_avro_field_references,
+               :mutable?, :immutable?,
                to: :class
     end
   end

data/lib/avromatic/model/configuration.rb

@@ -8,6 +8,7 @@ module Avromatic
 
       attr_reader :avro_schema, :key_avro_schema, :nested_models, :mutable,
                   :allow_optional_key_fields
+      alias_method :mutable?, :mutable
       delegate :schema_store, to: Avromatic
 
       # Either schema(_name) or value_schema(_name), but not both, must be
@@ -34,6 +35,10 @@ module Avromatic
 
       alias_method :value_avro_schema, :avro_schema
 
+      def immutable?
+        !mutable?
+      end
+
       private
 
       def find_avro_schema(**options)

data/lib/avromatic/model/field_helper.rb

@@ -16,9 +16,13 @@ module Avromatic
         !optional?(field)
       end
 
+      def nullable?(field)
+        optional?(field) || field.type.type_sym == :null
+      end
+
       def boolean?(field)
         field.type.type_sym == :boolean ||
-          (FieldHelper.optional?(field) && field.type.schemas.last.type_sym == :boolean)
+          (optional?(field) && field.type.schemas.last.type_sym == :boolean)
       end
     end
   end

data/lib/avromatic/model/messaging_serialization.rb

@@ -48,7 +48,8 @@ module Avromatic
           value_attributes = avro_messaging
             .decode(message_value, schema_name: avro_schema.fullname)
 
-          value_attributes.merge!(key_attributes || {})
+          value_attributes.merge!(key_attributes) if key_attributes
+          value_attributes
         end
       end
 

data/lib/avromatic/model/raw_serialization.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'active_support/deprecation'
+
 module Avromatic
   module Model
 
@@ -11,55 +13,93 @@ module Avromatic
       module Encode
         extend ActiveSupport::Concern
 
+        UNSPECIFIED = Object.new
+
         delegate :datum_writer, :datum_reader, to: :class
         private :datum_writer, :datum_reader
 
-        def avro_raw_value(validate: true)
-          if self.class.config.mutable
-            avro_raw_encode(value_attributes_for_avro(validate: validate), :value)
+        def avro_raw_value(validate: UNSPECIFIED)
+          unless validate == UNSPECIFIED
+            ActiveSupport::Deprecation.warn("The 'validate' argument to #{__method__} is deprecated.")
+          end
+
+          if self.class.recursively_immutable?
+            @avro_raw_value ||= avro_raw_encode(value_attributes_for_avro, :value)
           else
-            @avro_raw_value ||= avro_raw_encode(value_attributes_for_avro(validate: validate), :value)
+            avro_raw_encode(value_attributes_for_avro, :value)
           end
         end
 
-        def avro_raw_key(validate: true)
+        def avro_raw_key(validate: UNSPECIFIED)
+          unless validate == UNSPECIFIED
+            ActiveSupport::Deprecation.warn("The 'validate' argument to #{__method__} is deprecated.")
+          end
+
           raise 'Model has no key schema' unless key_avro_schema
-          avro_raw_encode(key_attributes_for_avro(validate: validate), :key)
+          avro_raw_encode(key_attributes_for_avro, :key)
         end
 
-        def value_attributes_for_avro(validate: true)
-          if self.class.config.mutable
-            avro_hash(value_avro_field_references, validate: validate)
+        def value_attributes_for_avro(validate: UNSPECIFIED)
+          unless validate == UNSPECIFIED
+            ActiveSupport::Deprecation.warn("The 'validate' argument to #{__method__} is deprecated.")
+          end
+
+          if self.class.recursively_immutable?
+            @value_attributes_for_avro ||= avro_hash(value_avro_field_references)
           else
-            @value_attributes_for_avro ||= avro_hash(value_avro_field_references, validate: validate)
+            avro_hash(value_avro_field_references)
           end
         end
 
-        def key_attributes_for_avro(validate: true)
-          avro_hash(key_avro_field_references, validate: validate)
+        def key_attributes_for_avro(validate: UNSPECIFIED)
+          unless validate == UNSPECIFIED
+            ActiveSupport::Deprecation.warn("The 'validate' argument to #{__method__} is deprecated.")
+          end
+
+          avro_hash(key_avro_field_references)
         end
 
-        def avro_value_datum(validate: true)
-          if self.class.config.mutable
-            avro_hash(value_avro_field_references, strict: true, validate: validate)
+        def avro_value_datum(validate: UNSPECIFIED)
+          unless validate == UNSPECIFIED
+            ActiveSupport::Deprecation.warn("The 'validate' argument to #{__method__} is deprecated.")
+          end
+
+          if self.class.recursively_immutable?
+            @avro_value_datum ||= avro_hash(value_avro_field_references, strict: true)
           else
-            @avro_datum ||= avro_hash(value_avro_field_references, strict: true, validate: validate)
+            avro_hash(value_avro_field_references, strict: true)
           end
         end
 
-        def avro_key_datum(validate: true)
-          avro_hash(key_avro_field_references, strict: true, validate: validate)
+        def avro_key_datum(validate: UNSPECIFIED)
+          unless validate == UNSPECIFIED
+            ActiveSupport::Deprecation.warn("The 'validate' argument to #{__method__} is deprecated.")
+          end
+
+          avro_hash(key_avro_field_references, strict: true)
         end
 
         private
 
-        def avro_hash(field_references, strict: false, validate:)
-          avro_validate! if validate
+        def avro_hash(field_references, strict: false)
           field_references.each_with_object(Hash.new) do |field_reference, result|
-            next unless _attributes.include?(field_reference.name_sym)
-
+            attribute_definition = self.class.attribute_definitions[field_reference.name_sym]
             value = _attributes[field_reference.name_sym]
-            result[field_reference.name] = attribute_definitions[field_reference.name_sym].serialize(value, strict)
+
+            if value.nil? && !attribute_definition.nullable?
+              # We're missing a required attribute so perform an explicit validation to generate
+              # a more complete error message
+              avro_validate!
+            elsif _attributes.include?(field_reference.name_sym)
+              begin
+                result[field_reference.name] = attribute_definition.serialize(value, strict)
+              rescue Avromatic::Model::ValidationError
+                # Perform an explicit validation to generate a more complete error message
+                avro_validate!
+                # We should never get here but just in case...
+                raise
+              end
+            end
           end
         end
 
@@ -81,8 +121,8 @@ module Avromatic
         def avro_raw_decode(key: nil, value:, key_schema: nil, value_schema: nil)
           key_attributes = key && decode_avro_datum(key, key_schema, :key)
           value_attributes = decode_avro_datum(value, value_schema, :value)
-
-          new(value_attributes.merge!(key_attributes || {}))
+          value_attributes.merge!(key_attributes) if key_attributes
+          new(value_attributes)
         end
 
         private

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

@@ -42,13 +42,10 @@ module Avromatic
         def serialize(value, strict)
           if value.nil?
             value
-          elsif !strict && Avromatic.use_custom_datum_writer && Avromatic.use_encoding_providers? && !record_class.config.mutable
-            # n.b. Ideally we'd just return value here instead of wrapping it in a
-            # hash but then we'd have no place to stash the union member index...
-            { Avromatic::IO::ENCODING_PROVIDER => value }
+          elsif strict
+            value.avro_value_datum
           else
-            # This is only used for recursive serialization so validation has already been done
-            strict ? value.avro_value_datum(validate: false) : value.value_attributes_for_avro(validate: false)
+            value.value_attributes_for_avro
           end
         end
 

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

@@ -7,7 +7,6 @@ module Avromatic
   module Model
     module Types
       class UnionType < AbstractType
-        MEMBER_INDEX = ::Avromatic::IO::DatumReader::UNION_MEMBER_INDEX
         attr_reader :member_types, :value_classes, :input_classes
 
         def initialize(member_types:)
@@ -24,8 +23,8 @@ module Avromatic
           return input if coerced?(input)
 
           result = nil
-          if input.is_a?(Hash) && input.key?(MEMBER_INDEX)
-            result = member_types[input.delete(MEMBER_INDEX)].coerce(input)
+          if input.is_a?(Avromatic::IO::UnionDatum)
+            result = member_types[input.member_index].coerce(input.datum)
           else
             member_types.find do |member_type|
               result = safe_coerce(member_type, input)
@@ -40,12 +39,16 @@ module Avromatic
         end
 
         def coerced?(value)
+          return false if value.is_a?(Avromatic::IO::UnionDatum)
+
           value.nil? || member_types.any? do |member_type|
             member_type.coerced?(value)
           end
         end
 
         def coercible?(input)
+          return true if value.is_a?(Avromatic::IO::UnionDatum)
+
           coerced?(input) || member_types.any? do |member_type|
             member_type.coercible?(input)
           end
@@ -60,11 +63,11 @@ module Avromatic
             raise ArgumentError.new("Expected #{value.inspect} to be one of #{value_classes.map(&:name)}")
           end
 
-          hash = member_types[member_index].serialize(value, strict)
-          if !strict && Avromatic.use_custom_datum_writer && value.is_a?(Avromatic::Model::Attributes)
-            hash[Avromatic::IO::UNION_MEMBER_INDEX] = member_index
+          serialized_value = member_types[member_index].serialize(value, strict)
+          if !strict && Avromatic.use_custom_datum_writer
+            serialized_value = Avromatic::IO::UnionDatum.new(member_index, serialized_value)
           end
-          hash
+          serialized_value
         end
 
         def referenced_model_classes

data/lib/avromatic/model/validation.rb

@@ -64,8 +64,8 @@ module Avromatic
           end
         end
 
-        unless self.class.config.mutable
-          @missing_attributes = missing_attributes.deep_freeze
+        if recursively_immutable?
+          @missing_attributes = missing_attributes.freeze
         end
 
         missing_attributes

data/lib/avromatic/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: avromatic
 version: !ruby/object:Gem::Version
-  version: 2.2.6
+  version: 2.4.0
 platform: ruby
 authors:
 - Salsify Engineering
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-07 00:00:00.000000000 Z
+date: 2021-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -19,7 +19,7 @@ dependencies:
         version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '6.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '6.2'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -39,7 +39,7 @@ dependencies:
         version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '6.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -49,7 +49,7 @@ dependencies:
         version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '6.2'
 - !ruby/object:Gem::Dependency
   name: avro
   requirement: !ruby/object:Gem::Requirement
@@ -196,6 +196,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: salsify_rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -259,13 +273,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - ".overcommit.yml"
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-gemset"
 - ".ruby-version"
-- ".travis.yml"
 - Appraisals
 - CHANGELOG.md
 - Gemfile
@@ -278,15 +292,19 @@ files:
 - gemfiles/.bundle/config
 - gemfiles/avro1_10_rails5_2.gemfile
 - gemfiles/avro1_10_rails6_0.gemfile
+- gemfiles/avro1_10_rails6_1.gemfile
 - gemfiles/avro1_8_rails5_2.gemfile
 - gemfiles/avro1_9_rails5_2.gemfile
 - gemfiles/avro1_9_rails6_0.gemfile
+- gemfiles/avro1_9_rails6_1.gemfile
 - gemfiles/avro_patches_rails5_2.gemfile
 - gemfiles/avro_patches_rails6_0.gemfile
+- gemfiles/avro_patches_rails6_1.gemfile
 - lib/avromatic.rb
 - lib/avromatic/io.rb
 - lib/avromatic/io/datum_reader.rb
 - lib/avromatic/io/datum_writer.rb
+- lib/avromatic/io/union_datum.rb
 - lib/avromatic/messaging.rb
 - lib/avromatic/model.rb
 - lib/avromatic/model/attributes.rb
@@ -324,8 +342,6 @@ files:
 - lib/avromatic/model/validation_error.rb
 - lib/avromatic/model/value_object.rb
 - lib/avromatic/model_registry.rb
-- lib/avromatic/patches.rb
-- lib/avromatic/patches/schema_validator_patch.rb
 - lib/avromatic/railtie.rb
 - lib/avromatic/rspec.rb
 - lib/avromatic/version.rb

data/.travis.yml

@@ -1,16 +0,0 @@
-language: ruby
-rvm:
-  - 2.5.8
-  - 2.6.6
-  - 2.7.1
-before_script:
-  - bundle exec rubocop
-gemfile:
-  - gemfiles/avro1_8_rails5_2.gemfile
-  - gemfiles/avro1_9_rails5_2.gemfile
-  - gemfiles/avro1_10_rails5_2.gemfile
-  - gemfiles/avro1_9_rails6_0.gemfile
-  - gemfiles/avro1_10_rails6_0.gemfile
-  - gemfiles/avro_patches_rails5_2.gemfile
-  - gemfiles/avro_patches_rails6_0.gemfile
-script: bundle exec rspec

data/lib/avromatic/patches.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-loaded_avro_patches = begin
-    require 'avro-patches'
-    true
-  rescue LoadError
-    false
-  end
-
-if loaded_avro_patches
-  require 'avromatic/patches/schema_validator_patch'
-  avro_patches_version = Gem::Version.new(AvroPatches::VERSION)
-  if avro_patches_version < Gem::Version.new('0.4.0')
-    Avro::SchemaValidator.singleton_class.prepend(Avromatic::Patches::SchemaValidatorPatch)
-  else
-    Avro::SchemaValidator.singleton_class.prepend(Avromatic::Patches::SchemaValidatorPatchV040)
-  end
-end

data/lib/avromatic/patches/schema_validator_patch.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-module Avromatic
-  module Patches
-    module SchemaValidatorPatch
-      # This method replaces validate_recursive in AvroPatches::LogicalTypes::SchemaValidatorPatch
-      # to enable validating datums that contain an encoding provider.
-      def validate_recursive(expected_schema, logical_datum, path, result, encoded = false)
-        datum = resolve_datum(expected_schema, logical_datum, encoded)
-        case expected_schema.type_sym
-        when :record, :error, :request
-          if datum.is_a?(Hash) && datum.key?(Avromatic::IO::ENCODING_PROVIDER)
-            return if expected_schema.sha256_resolution_fingerprint ==
-              datum[Avromatic::IO::ENCODING_PROVIDER].value_avro_schema.sha256_resolution_fingerprint
-            raise Avro::SchemaValidator::ValidationError
-          end
-        end
-        super(expected_schema, logical_datum, path, result, encoded)
-      end
-    end
-
-    module SchemaValidatorPatchV040
-      # This method replaces validate_recursive in AvroPatches::LogicalTypes::SchemaValidatorPatch
-      # to enable validating datums that contain an encoding provider.
-      def validate_recursive(expected_schema, logical_datum, path, result, options = {})
-        datum = resolve_datum(expected_schema, logical_datum, options[:encoded])
-        case expected_schema.type_sym
-        when :record, :error, :request
-          if datum.is_a?(Hash) && datum.key?(Avromatic::IO::ENCODING_PROVIDER)
-            return if expected_schema.sha256_resolution_fingerprint ==
-              datum[Avromatic::IO::ENCODING_PROVIDER].value_avro_schema.sha256_resolution_fingerprint
-            raise Avro::SchemaValidator::ValidationError
-          end
-        end
-        super(expected_schema, logical_datum, path, result, options)
-      end
-    end
-  end
-end