avromatic 2.2.5 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bdd13d41971f1b38c3b1a9496ec698a14122b69ed5442b4cca7ac7e7d099c6b2
-  data.tar.gz: af4fbf880781abeffc7e0807491ca43a0fdabdff5714c60bfe46b365caa355a5
+  metadata.gz: d4938e400e426cf06497e5819b1f92c9c3f12920ada5ed999a1a826bd19c7efb
+  data.tar.gz: e37322f05ec5adaff55e28bc8e15a2e2164dc3d8575fb8ed0dad6e5b283fa440
 SHA512:
-  metadata.gz: 856111e8a1f7e5ec99cbbe20877095ff630182f27265617e7746437402e4146628c5ae2812f85a9f0cd5c234b748bd1b1c8abee8fddb92e21bc137537074a0d4
-  data.tar.gz: 275aa990b3a84aaa679141955a93800cb4764fc0bbf44a290cbaebd4d54e1cd443f2a3943431b2781bcc6165df06861c7a0d6f9c6bf4c754732737518935d896
+  metadata.gz: 258766a91f94e209f18e0f2060bb2590d606bb973b93bd702a2acc45535d2591e7688b5d14695c004621a5eddf8d328528518447ccf26521c10d2fb3821dfdb6
+  data.tar.gz: fd1aea43406300f106aba81a9be6212e50d4e6bab68b4a3a25bb5f7aafaa01400bb1712bfe7a9a4206a6dc8fa7bf31491988bd43a69755b2582f6c44d26603ba

data/.circleci/config.yml

@@ -0,0 +1,89 @@
+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_9_rails5_2.gemfile"
+              - "gemfiles/avro1_10_rails5_2.gemfile"
+              - "gemfiles/avro1_9_rails6_0.gemfile"
+              - "gemfiles/avro1_10_rails6_0.gemfile"
+              - "gemfiles/avro1_10_rails6_1.gemfile"
+              - "gemfiles/avro1_9_rails6_1.gemfile"
+              ruby-version:
+              - "2.5.8"
+              - "2.6.6"
+              - "2.7.2"
+      - test:
+          matrix:
+            parameters:
+              gemfile:
+                - "gemfiles/avro1_10_rails6_1.gemfile"
+                - "gemfiles/avro1_9_rails6_1.gemfile"
+              ruby-version:
+                - "3.0.0"

data/.gitignore

@@ -9,3 +9,6 @@
 /tmp/
 /gemfiles/*.lock
 /log/*
+
+*.iml
+.idea

data/.rubocop.yml

@@ -2,7 +2,10 @@ inherit_gem:
   salsify_rubocop: conf/rubocop.yml
 
 AllCops:
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.5
+  Exclude:
+    - 'vendor/**/*'
+    - 'gemfiles/vendor/**/*'
 
 Style/MultilineBlockChain:
   Enabled: false

data/Appraisals

@@ -1,11 +1,5 @@
 # frozen_string_literal: true
 
-appraise 'avro1_8-rails5_2' do
-  gem 'avro', '1.8.2'
-  gem 'activesupport', '~> 5.2.0'
-  gem 'activemodel', '~> 5.2.0'
-end
-
 appraise 'avro1_9-rails5_2' do
   gem 'avro', '1.9.2'
   gem 'activesupport', '~> 5.2.0'
@@ -30,14 +24,14 @@ appraise 'avro1_10-rails6_0' do
   gem 'activemodel', '~> 6.0.0'
 end
 
-appraise 'avro-patches-rails5_2' do
-  gem 'avro-patches', '>= 0.4.1', '< 1.0'
-  gem 'activesupport', '~> 5.2.0'
-  gem 'activemodel', '~> 5.2.0'
+appraise 'avro1_9-rails6_1' do
+  gem 'avro', '1.9.2'
+  gem 'activesupport', '~> 6.1.0'
+  gem 'activemodel', '~> 6.1.0'
 end
 
-appraise 'avro-patches-rails6_0' do
-  gem 'avro-patches', '>= 1.0.0'
-  gem 'activesupport', '~> 6.0.0'
-  gem 'activemodel', '~> 6.0.0'
+appraise 'avro1_10-rails6_1' do
+  gem 'avro', '~> 1.10.0'
+  gem 'activesupport', '~> 6.1.0'
+  gem 'activemodel', '~> 6.1.0'
 end

data/CHANGELOG.md

@@ -1,5 +1,30 @@
 # avromatic changelog
 
+## 3.0.1
+- Raise an error when registering a nested model that has already been auto-generated.
+  This avoids hard to troubleshoot coercion errors when instantiating models and fixes 
+  a regression introduced in Avromatic 2.2.2.
+
+## 3.0.0
+- Drop support for Ruby 2.4.
+- Add support for Ruby 3.0.
+- Drop support for Avro < 1.9.
+- Drop support for Rails < 5.2.
+- Fix decoding of unions containing false boolean values.
+
+## 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.
+
 ## v2.2.5
 - Optimize memory usage when serializing, deserializing and instantiating 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.
@@ -430,23 +430,6 @@ Validation of required fields is done automatically when serializing a model to
 explicitly by calling the `valid?` or `invalid?` methods from the 
 [ActiveModel::Validations](https://edgeapi.rubyonrails.org/classes/ActiveModel/Validations.html) interface.
 
-### Logical Types
-
-Currently the official Apache Avro Ruby library does not support logical types ([AVRO-1695](https://issues.apache.org/jira/browse/AVRO-1695)).
-That feature is in progress and will hopefully be merged soon.
-
-Avromatic supports logical types as implemented in the [pull request](https://github.com/apache/avro/pull/116) referenced in AVRO-1695.
-
-Until that change is included in the official library, you can
-use the [avro-patches gem](https://github.com/salsify/avro-patches) which includes
-the changes from the above pull request.
-
-To use this gem, reference it in your Gemfile instead of `avro`:
-
-```ruby
-gem 'avro-patches'
-````
-
 ### RSpec Support
 
 This gem also includes an `"avromatic/rspec"` file that can be required to support

data/avromatic.gemspec

@@ -20,21 +20,22 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.4'
+  spec.required_ruby_version = '>= 2.5'
 
-  spec.add_runtime_dependency 'activemodel', '>= 5.0', '< 6.1'
-  spec.add_runtime_dependency 'activesupport', '>= 5.0', '< 6.1'
-  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 'activemodel', '>= 5.2', '< 6.2'
+  spec.add_runtime_dependency 'activesupport', '>= 5.2', '< 6.2'
+  spec.add_runtime_dependency 'avro', '>= 1.9.0', '< 1.11'
+  spec.add_runtime_dependency 'avro_schema_registry-client', '>= 0.4.0'
   spec.add_runtime_dependency 'avro_turf'
   spec.add_runtime_dependency 'ice_nine'
 
   spec.add_development_dependency 'appraisal'
   spec.add_development_dependency 'avro-builder', '>= 0.12.0'
-  spec.add_development_dependency 'bundler', '>= 1.11'
+  spec.add_development_dependency 'bundler', '~> 2.0'
   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 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.8'
+  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_8_rails5_2.gemfile → avro1_9_rails6_1.gemfile}

@@ -2,8 +2,8 @@
 
 source "https://rubygems.org"
 
-gem "avro", "1.8.2"
-gem "activesupport", "~> 5.2.0"
-gem "activemodel", "~> 5.2.0"
+gem "avro", "1.9.2"
+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

@@ -5,41 +5,29 @@ module Avromatic
     # Subclass DatumWriter to use additional information about union member
     # index.
     class DatumWriter < Avro::IO::DatumWriter
-      class << self
-        attr_accessor :optimize
-      end
-
       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
-        elsif self.class.optimize && optional && datum.nil?
-          index_of_schema = 0
         else
           index_of_schema = writers_schema.schemas.find_index do |schema|
             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