avro-resolution_canonical_form 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e533fe17ac1e1efd5276ab07eb8f26830f0b93bee15e78465a275f297510f76e
-  data.tar.gz: 943b99539ce570a2dd7999d60aa2ec364d5e43f4e04581acde19735b694c7bcd
+  metadata.gz: 92db806c8c64c020593f72c0915c506a6f644f732025e1b1188a6312999a1b7c
+  data.tar.gz: 352466440aa35ee0743aca9880b974c2a60db65e9b0326e985c42cdda3c47a35
 SHA512:
-  metadata.gz: 993c1ba85a0c80e1498d0f8a90fdcac6aec0d22dd3a72bdf37ed5756eeeb5df29b5a02766363efc6fdfa5b364b654c685eb81edcd88ecd25d3d4c4fe5a1ab5b1
-  data.tar.gz: 9577dc0b1e02ae7f87a162ee86273d26146daa9fa322e95bec31e0b0ab1c89bc9ced1c1ff64dc183427f390283b2574eae0ab5cb761fd47b54abc0b16ab4ff9d
+  metadata.gz: d33a9ce1bb91751e437c15c379afc95bd0d7249b32f3d88be6a2c24ed9e5bb64de38927a90cdaab06fca39391c608a07a066222bc41e9dd424ad6c84432d1af9
+  data.tar.gz: 3597d4ebb038f45750aeb926b099bdb0f7cd07c6e7458f4f398507200090392f66cf026df28098c4daa914f7726a0066df4525b836c74cee369a803408f77c95

data/.travis.yml

@@ -1,8 +1,8 @@
 language: ruby
 rvm:
-  - 2.4.6
-  - 2.5.5
-  - 2.6.3
+  - 2.5.8
+  - 2.6.6
+  - 2.7.1
 before_install: gem install bundler -v 2.0.1 --no-document
 before_script:
   - bundle exec appraisal install --jobs=3

data/Appraisals

@@ -1,7 +1,3 @@
-appraise 'avro-patches-0.x' do
-  gem 'avro-patches', '< 1.0.0'
-end
-
 appraise 'avro-patches-1.x' do
   gem 'avro-patches', '>= 1.0.0'
 end

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # avro-resolution_canonical_form
 
+## v0.3.0
+- Require Avro v1.10.
+- Include aliases, enum defaults, and decimal logical types in the resolution
+  canonical form. Schemas that use any of these parts of the Avro spec will
+  get a different fingerprint with this version.
+
 ## v0.2.1
 - Restrict to `avro-patches` versions < 2.0.0.
 

data/README.md

@@ -23,12 +23,14 @@ Or install it yourself as:
 
 ## Resolution Canonical Form
 
-The Resolution Canonical Form extends the [Parsing Canonical Form](http://avro.apache.org/docs/1.8.1/spec.html#Parsing+Canonical+Form+for+Schemas)
-to include `default` and `aliases` attributes:
+The Resolution Canonical Form extends the [Parsing Canonical Form](http://avro.apache.org/docs/1.10.0/spec.html#Parsing+Canonical+Form+for+Schemas)
+to include `default` and `aliases` attributes and logical type for decimals:
 
+* [STRIP] Keep only attributes that are relevant to resolution, which are:
+  `name, type, fields, symbols, items, values, size, default, aliases, logical_type(=decimal), precision, scale`
 * [ORDER] Order the appearance of fields in JSON objects as follows:
   `name, type, fields, symbols, items, values, size, default, aliases`
-* [ALIASES] [Aliases](http://avro.apache.org/docs/1.8.1/spec.html#Aliases) for
+* [ALIASES] [Aliases](http://avro.apache.org/docs/1.10.0/spec.html#Aliases) for
   named types and fields are converted to their fullname, using applicable
   namespace, and sorted.
 
@@ -67,7 +69,7 @@ schema = Avro::Schema.parse(<<-JSON)
 JSON
 
 Avro::ResolutionCanonicalForm.to_resolution_form(schema)
-#=> {"name":"example.dimensions","type":"record","fields":[{"name":"height","type":"int","default":1},{"name":"width","type":"int"}]}
+#=> => "{\"name\":\"example.dimensions\",\"type\":\"record\",\"fields\":[{\"name\":\"height\",\"type\":\"int\",\"default\":1},{\"name\":\"width\",\"type\":\"int\",\"aliases\":[\"across\"]}],\"aliases\":[\"eg.sizing\",\"example.dims\"]}"
 ```
 
 A new method, `#sha256_resolution_fingerprint`, is added to `Avro::Schema` to
@@ -77,7 +79,7 @@ the existing `#sha256_fingerprint` which is based on the Parsing Canonical Form.
 ```ruby
 schema.sha256_resolution_fingerprint
 
-#=> 80361294467930602613800428579400567035362599364974249578710466785512094641526
+#=> 71676413924523555041213790831440929350080614901361467355865523343334332562796
 ```
 
 ## Development

data/avro-resolution_canonical_form.gemspec

@@ -35,5 +35,20 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'salsify_rubocop', '~> 0.46.0'
   spec.add_development_dependency 'overcommit'
   spec.add_development_dependency 'simplecov'
+
+  spec.add_runtime_dependency 'avro', '~> 1.10.0'
   spec.add_runtime_dependency 'avro-patches', '< 2.0.0'
+
+  spec.post_install_message = %(
+avro-resolution_canonical_form now requires Avro v1.10.
+
+New features in Avro Ruby v1.10 are now included in the canonical form:
+  - aliases
+  - enum defaults
+  - decimal logical types
+
+Schemas that use any of these features will get a different fingerprint with
+this version. For projects that only use Ruby, use of these features is unlikely
+as they were previously unsupported.
+)
 end

data/lib/avro-resolution_canonical_form/version.rb

@@ -1,3 +1,3 @@
 module AvroResolutionCanonicalForm
-  VERSION = '0.2.1'.freeze
+  VERSION = '0.3.0'.freeze
 end

data/lib/avro/resolution_canonical_form.rb

@@ -2,6 +2,8 @@ require 'avro-patches'
 
 module Avro
   class ResolutionCanonicalForm < SchemaNormalization
+    DECIMAL_LOGICAL_TYPE = 'decimal'.freeze
+
     def self.to_resolution_form(schema)
       new.to_resolution_form(schema)
     end
@@ -12,20 +14,46 @@ module Avro
 
     private
 
-    # TODO: include aliases once the avro Ruby gem supports them
-    # Note: permitted values for defaults are not enforced here.
-    # That should be done at the schema level, and is not done currently
-    # in the Avro Ruby gem
+    def normalize_schema(schema)
+      if schema.type_sym == :bytes && schema.logical_type == DECIMAL_LOGICAL_TYPE
+        add_logical_type(schema, type: schema.type)
+      else
+        super
+      end
+    end
+
     def normalize_field(field)
-      default_value = if field.default?
-                        { default: field.default }
-                      else
-                        {}
-                      end
-      super.merge(default_value)
+      extensions = {}
+      extensions[:default] = field.default if field.default?
+      if field.aliases && !field.aliases.empty?
+        extensions[:aliases] = field.aliases.sort
+      end
+
+      super.merge(extensions)
     end
 
-    # TODO: Override normalize_named_type once the Avro Ruby gem supports aliases
-    # def normalized_named_type(schema, attributes = {})
+    def add_logical_type(schema, serialized)
+      if schema.logical_type == DECIMAL_LOGICAL_TYPE
+        extensions = { logicalType: DECIMAL_LOGICAL_TYPE }
+        extensions[:precision] = schema.precision if schema.respond_to?(:precision) && schema.precision
+        extensions[:scale] = schema.scale if schema.respond_to?(:scale) && schema.scale
+        serialized.merge(extensions)
+      else
+        serialized
+      end
+    end
+
+    def normalize_named_type(schema, attributes = {})
+      extensions = {}
+      if schema.respond_to?(:default)
+        # For enum defaults
+        extensions[:default] = schema.default unless schema.default.nil?
+      end
+
+      aliases = schema.fullname_aliases
+      extensions[:aliases] = aliases.sort unless aliases.empty?
+      extensions = add_logical_type(schema, extensions)
+      super.merge(extensions)
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: avro-resolution_canonical_form
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Salsify, Inc
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-05-22 00:00:00.000000000 Z
+date: 2020-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appraisal
@@ -108,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: avro
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.10.0
 - !ruby/object:Gem::Dependency
   name: avro-patches
   requirement: !ruby/object:Gem::Requirement
@@ -156,7 +170,18 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message: |2
+
+  avro-resolution_canonical_form now requires Avro v1.10.
+
+  New features in Avro Ruby v1.10 are now included in the canonical form:
+    - aliases
+    - enum defaults
+    - decimal logical types
+
+  Schemas that use any of these features will get a different fingerprint with
+  this version. For projects that only use Ruby, use of these features is unlikely
+  as they were previously unsupported.
 rdoc_options: []
 require_paths:
 - lib
@@ -171,9 +196,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.9
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.7.6.2
+signing_key:
 specification_version: 4
 summary: Unique identification of Avro schemas for schema resolution
 test_files: []