avromatic 0.27.0 → 0.28.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5a60c2a9d61072d44905624ea8310ed0ca91d5c0
-  data.tar.gz: 40bd23b5fbf401cb46ce58970b687e2dd914404a
+  metadata.gz: 361781d979e68fb4b48f288153368b9d2f00d064
+  data.tar.gz: d761359438529abe3ca428582c68d47a73de7587
 SHA512:
-  metadata.gz: 1a7848c367f7bce862b342d6127438d8f9edc4b69c015700699fb0a8e3fbdacc86efe9f7df605225d336c6cc9930782183f4cf49ad2d337b9506226de7971b46
-  data.tar.gz: 8d345cf24135af8f4fc9712b6a6d48f9bb9aa7696b276945653cc528c93fc3e550bb984fdf788e5b8846741da015b7de443951a7851dfcf73af45d85599ccaab
+  metadata.gz: 15122e83c1a2f3301d25873f56a668b1bd545bb5e3763bc0d56d2c1135ed812961ef786da27ca16eaaef1d3864cea2f2f6d481fc36f5829f9347e692fac91f1e
+  data.tar.gz: 10e242e0cc4f755992d1b955ea9e5ab6746be6c30b60d79277f96e121e44b807a96bb1a79b1a22290fd1d525a73932b48dd64b54b348ad99a4d09ff3d866fbf1

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # avromatic changelog
 
+## v0.28.1
+- Fix a bug that raised an error when encoding a cached model containing optional
+  field(s). With this change, immutable model caching now enabled only when 
+  `avro-patches` is present.
+
+## v0.28.0
+- Add support for caching avro encodings for immutable models
+
 ## v0.27.0
 - Patches avromatic model classes to cache `Virtus::ValueObject::AllowedWriterMethods#allowed_writer_methods`
 - Support Rails 5.1

data/README.md

@@ -99,10 +99,11 @@ end
 
 #### Encoding
 * **use_custom_datum_writer**: `Avromatic` includes a modified subclass of
-  `Avro::IO::DatumWriter`. This subclass uses additional information about
-  the index of union members to optimize the encoding of Avro messages.
-  By default this information is included in the hash passed to the encoder
-  but can be omitted by setting this option to `false`.
+  `Avro::IO::DatumWriter`. This subclass supports caching avro encodings for 
+  immutable models and uses additional information about the index of union 
+  members to optimize the encoding of Avro messages. By default this 
+  information is included in the hash passed to the encoder but can be omitted
+  by setting this option to `false`.
 
 
 ### Models

data/lib/avromatic.rb

@@ -4,6 +4,7 @@ require 'avromatic/model'
 require 'avromatic/model_registry'
 require 'avromatic/messaging'
 require 'active_support/core_ext/string/inflections'
+require 'avromatic/patches'
 
 module Avromatic
   class << self
@@ -27,6 +28,10 @@ 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,6 +1,7 @@
 module Avromatic
   module IO
     UNION_MEMBER_INDEX = '__avromatic_member_index'.freeze
+    ENCODING_PROVIDER = '__avromatic_encoding_provider'.freeze
   end
 end
 

data/lib/avromatic/io/datum_writer.rb

@@ -20,6 +20,14 @@ module Avromatic
         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)
+          encoder.write(datum[Avromatic::IO::ENCODING_PROVIDER].avro_raw_value)
+        else
+          super
+        end
+      end
     end
   end
 end

data/lib/avromatic/model/raw_serialization.rb

@@ -29,6 +29,11 @@ module Avromatic
             if value.is_a?(Avromatic::Model::Attributes)
               hash = value.value_attributes_for_avro
               if Avromatic.use_custom_datum_writer
+                if Avromatic.use_encoding_providers? && !value.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...
+                  hash = { Avromatic::IO::ENCODING_PROVIDER => value }
+                end
                 member_index = member_types.index(value.class) if member_types.any?
                 hash[Avromatic::IO::UNION_MEMBER_INDEX] = member_index if member_index
               end
@@ -67,7 +72,11 @@ module Avromatic
         end
 
         def avro_raw_value
-          avro_raw_encode(value_attributes_for_avro, :value)
+          if self.class.config.mutable
+            avro_raw_encode(value_attributes_for_avro, :value)
+          else
+            @avro_raw_value ||= avro_raw_encode(value_attributes_for_avro, :value)
+          end
         end
 
         def avro_raw_key

data/lib/avromatic/patches.rb

@@ -0,0 +1,11 @@
+loaded_avro_patches = begin
+    require 'avro-patches'
+    true
+  rescue LoadError
+    false
+  end
+
+if loaded_avro_patches
+  require 'avromatic/patches/schema_validator_patch'
+  Avro::SchemaValidator.singleton_class.prepend(Avromatic::Patches::SchemaValidatorPatch)
+end

data/lib/avromatic/patches/schema_validator_patch.rb

@@ -0,0 +1,20 @@
+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
+  end
+end

data/lib/avromatic/version.rb

@@ -1,3 +1,3 @@
 module Avromatic
-  VERSION = '0.27.0'.freeze
+  VERSION = '0.28.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: avromatic
 version: !ruby/object:Gem::Version
-  version: 0.27.0
+  version: 0.28.1
 platform: ruby
 authors:
 - Salsify Engineering
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-02 00:00:00.000000000 Z
+date: 2017-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: avro
@@ -304,6 +304,8 @@ files:
 - lib/avromatic/model/validation.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