avro_turf 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db17e2aed8677c0288cd1c817b2e4ecae50da47255663c2b0a75d64a43e91152
-  data.tar.gz: e88f6481337b05b80db9710283daf20818fcad9621c09ca9ebd75e533ca5135c
+  metadata.gz: 3eea429db02f7f6eba5f13f46b2bf3e82602371ef9306e374c1102561f508675
+  data.tar.gz: d798ef10b0e674f48ffdcc6bd3b87e59d9447c985d539f2ba01164e689fe4f8a
 SHA512:
-  metadata.gz: 3c226b186752b4feed4519d329e7789dc02ad29793d3573ca2832a182074010652c16746308f785320018bed528d00b241c9b6354b2a3271a72278812d552d56
-  data.tar.gz: c07515285fbd182752764d43c350d529f9a60bce1ad7d7aa6992cb1cda9fb958c189092d78a432a6e141eca380c8e9459857b29e2b038f03e32b645f5b4f0461
+  metadata.gz: e7cacb60d4e7890a700ebaba9a0cf1d46606fb01157e0746a0d6a6c900895e9ca1268f0a04dd4d03f5d1a9cec9bf6795d9c5d70acb6884965353c72bb1de4095
+  data.tar.gz: c4dbd604b66916355a6cba44ec4e7225eb439c2d9bb0682e62414b6ffa3018bb1d2a84b78d943983c99d7af3897a67658db9cb2205f7d92d6c13661ae44ba602

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## Unreleased
 
+## v1.7.0
+
+- Added extra params for the validation message schem before encode (#169)
+- Fix infinite retry when loading schema with nested primary type in separate file (#165)
+
 ## v1.6.0
 
 - Schema registry path prefix (#162)

data/lib/avro_turf/schema_store.rb

@@ -88,7 +88,7 @@ class AvroTurf::SchemaStore
       local_schemas_cache.each do |schema_name, schema|
         local_schemas_cache.delete(schema_name) unless File.exist?(build_schema_path(schema_name))
       end
-      load_schema!(fullname, local_schemas_cache)
+      load_schema!(fullname, @schemas.dup)
     else
       raise
     end

data/lib/avro_turf/version.rb

@@ -1,3 +1,3 @@
 class AvroTurf
-  VERSION = "1.6.0"
+  VERSION = "1.7.0"
 end

data/lib/avro_turf.rb

@@ -16,7 +16,9 @@ end
 
 class AvroTurf
   class Error < StandardError; end
+
   class SchemaError < Error; end
+
   class SchemaNotFoundError < Error; end
 
   DEFAULT_SCHEMAS_PATH = "./schemas"
@@ -31,7 +33,7 @@ class AvroTurf
   # Currently, the only valid codec name is `deflate`.
   def initialize(schemas_path: nil, schema_store: nil, namespace: nil, codec: nil)
     @namespace = namespace
-    @schema_store = schema_store || 
+    @schema_store = schema_store ||
       SchemaStore.new(path: schemas_path || DEFAULT_SCHEMAS_PATH)
     @codec = codec
   end
@@ -62,14 +64,20 @@ class AvroTurf
   # validate    - The boolean for performing complete data validation before
   #               encoding it, Avro::SchemaValidator::ValidationError with
   #               a descriptive message will be raised in case of invalid message.
+  # validate_options - Hash for the Avro::SchemaValidator, default
+  #               {recursive: true, encoded: false, fail_on_extra_fields: true}
   #
   # Returns nothing.
-  def encode_to_stream(data, schema_name: nil, stream: nil, namespace: @namespace, validate: false)
+  def encode_to_stream(data, schema_name: nil, stream: nil, namespace: @namespace,
+                       validate: false,
+                       validate_options: { recursive: true,
+                                           encoded: false,
+                                           fail_on_extra_fields: true })
     schema = @schema_store.find(schema_name, namespace)
     writer = Avro::IO::DatumWriter.new(schema)
 
     if validate
-      Avro::SchemaValidator.validate!(schema, data, recursive: true, encoded: false, fail_on_extra_fields: true)
+      Avro::SchemaValidator.validate!(schema, data, **validate_options)
     end
 
     dw = Avro::DataFile::Writer.new(stream, writer, schema, @codec)

data/spec/avro_turf_spec.rb

@@ -251,6 +251,31 @@ describe AvroTurf do
           expect { encode_to_stream }.to raise_error(Avro::SchemaValidator::ValidationError, /extra field 'fulll_name'/)
         end
       end
+
+      context "when the `fail_on_extra_fields` validation option is disabled" do
+        let(:message) { { "full_name" => "John Doe", "first_name" => "John", "last_name" => "Doe" } }
+        subject(:encode_to_stream) do
+          stream = StringIO.new
+          avro.encode_to_stream(message, stream: stream, schema_name: "message",
+                                validate: true,
+                                validate_options: { recursive: true, encoded: false, fail_on_extra_fields: false }
+          )
+        end
+
+        it "should not raise Avro::SchemaValidator::ValidationError with a message about extra field" do
+          define_schema "message.avsc", <<-AVSC
+            {
+              "name": "message",
+              "type": "record",
+              "fields": [
+                { "name": "full_name", "type": "string" }
+              ]
+            }
+          AVSC
+
+          expect { encode_to_stream }.not_to raise_error
+        end
+      end
     end
   end
 

data/spec/schema_store_spec.rb

@@ -26,6 +26,33 @@ describe AvroTurf::SchemaStore do
       expect(schema.fullname).to eq "message"
     end
 
+    it "resolves missing references when nested schema is not a named type" do
+      define_schema "root.avsc", <<-AVSC
+        {
+          "type": "record",
+          "name": "root",
+          "fields": [
+            {
+              "type": "nested",
+              "name": "nested_value"
+            }
+          ]
+        }
+      AVSC
+
+      define_schema "nested.avsc", <<-AVSC
+        {
+          "name": "nested",
+          "type": "string",
+          "logicalType": "uuid"
+        }
+      AVSC
+
+      schema = store.find("root")
+
+      expect(schema.fullname).to eq "root"
+    end
+
     it "resolves missing references" do
       define_schema "person.avsc", <<-AVSC
         {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: avro_turf
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Daniel Schierbeck
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-24 00:00:00.000000000 Z
+date: 2022-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: avro
@@ -156,7 +156,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - dasch@zendesk.com
 executables: []
@@ -251,8 +251,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
 summary: A library that makes it easier to use the Avro serialization format from
   Ruby