avro-resolution_canonical_form 0.1.0.rc0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8b215d8dafd28cb843b8a64936d6293631ca83ea
-  data.tar.gz: 260398add04f7503f3fdb68b04b7b009db08bb92
+SHA256:
+  metadata.gz: 92db806c8c64c020593f72c0915c506a6f644f732025e1b1188a6312999a1b7c
+  data.tar.gz: 352466440aa35ee0743aca9880b974c2a60db65e9b0326e985c42cdda3c47a35
 SHA512:
-  metadata.gz: db330d565c3e1251ff07e976b9cd8f6199fb0ac9e54548513004edd83194d584dfeda71950583100106d27bf957f36f5712f67532676bb064ad92e9485ae19d7
-  data.tar.gz: aca2c3fcb923337b095adedf83ad181dae64463ea625d2e8cc18e7c01b1f62e392e70d92ce057b500d13f1cbc4a911261d76244dbdcfb94dbdc472209b4605da
+  metadata.gz: d33a9ce1bb91751e437c15c379afc95bd0d7249b32f3d88be6a2c24ed9e5bb64de38927a90cdaab06fca39391c608a07a066222bc41e9dd424ad6c84432d1af9
+  data.tar.gz: 3597d4ebb038f45750aeb926b099bdb0f7cd07c6e7458f4f398507200090392f66cf026df28098c4daa914f7726a0066df4525b836c74cee369a803408f77c95

data/.gitignore

@@ -7,3 +7,5 @@
 /pkg/
 /spec/reports/
 /tmp/
+/gemfiles/.bundle
+/gemfiles/*.gemfile.lock

data/.rubocop.yml

@@ -8,4 +8,3 @@ Style/FileName:
 RSpec/FilePath:
   Enabled: false
 
-

data/.travis.yml

@@ -1,7 +1,11 @@
 language: ruby
 rvm:
-  - 2.3.3
-before_install: gem install bundler -v 1.14.6
+  - 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
 script:
   - bundle exec rubocop
-  - bundle exec rspec
+  - bundle exec appraisal rspec

data/Appraisals

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

data/CHANGELOG.md

@@ -1,4 +1,16 @@
 # 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.
+
+## v0.2.0
+- Require `avro-patches` instead of `avro-salsify-fork`.
+
 ## v0.1.0
 - Initial version

data/Gemfile

@@ -1,7 +1,5 @@
-
 source 'https://rubygems.org'
 
-
 # override the :github shortcut to be secure by using HTTPS
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}.git" }
 

data/README.md

@@ -23,24 +23,25 @@ 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.
 
 ## Ruby Support
 
-This currently gem requires the [avro-salsify-fork](https://github.com/salsify/avro)
-gem due to a bug in the Avro Ruby gem support for defaults. The fix for this issue
-will be included in Avro v1.8.2.
+This currently gem requires the [avro-patches](https://github.com/salsify/avro-patches)
+gem.
 
 ### Aliases
 
-The Avro Ruby gem, including the avro-salsify-fork, does not yet include support
+The Avro Ruby gem, including the avro-patches, does not yet include support
 for aliases. Aliases are included in the specification of the Resolution Canonical
 Form above, but not yet supported by this gem.
 
@@ -68,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
@@ -78,7 +79,7 @@ the existing `#sha256_fingerprint` which is based on the Parsing Canonical Form.
 ```ruby
 schema.sha256_resolution_fingerprint
 
-#=> 80361294467930602613800428579400567035362599364974249578710466785512094641526
+#=> 71676413924523555041213790831440929350080614901361467355865523343334332562796
 ```
 
 ## Development

data/Rakefile

@@ -1,6 +1,5 @@
 require 'bundler/gem_tasks'
 
-
 require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)

data/avro-resolution_canonical_form.gemspec

@@ -1,11 +1,12 @@
 # coding: utf-8
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'avro/resolution_canonical_form/version'
+require 'avro-resolution_canonical_form/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'avro-resolution_canonical_form'
-  spec.version       = Avro::ResolutionCanonicalForm::VERSION
+  spec.version       = AvroResolutionCanonicalForm::VERSION
   spec.authors       = ['Salsify, Inc']
   spec.email         = ['engineering@salsify.com']
 
@@ -18,7 +19,6 @@ Gem::Specification.new do |spec|
   # Set 'allowed_push_post' to control where this gem can be published.
   if spec.respond_to?(:metadata)
     spec.metadata['allowed_push_host'] = 'https://rubygems.org'
-
   else
     raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
   end
@@ -28,11 +28,27 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'appraisal'
+  spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.4'
   spec.add_development_dependency 'salsify_rubocop', '~> 0.46.0'
   spec.add_development_dependency 'overcommit'
   spec.add_development_dependency 'simplecov'
-  spec.add_runtime_dependency 'avro-salsify-fork', '>= 1.9.0.5'
+
+  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/gemfiles/avro_patches_0.x.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "avro-patches", "< 1.0.0"
+
+gemspec path: "../"

data/gemfiles/avro_patches_1.x.gemfile

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

data/lib/avro-resolution_canonical_form.rb

@@ -1,3 +1,3 @@
-require 'avro/resolution_canonical_form/version'
+require 'avro-resolution_canonical_form/version'
 require 'avro/resolution_canonical_form'
 require 'avro/resolution_fingerprint'

data/lib/avro-resolution_canonical_form/version.rb

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

data/lib/avro/resolution_canonical_form.rb

@@ -1,7 +1,9 @@
-require 'avro'
+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,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: avro-resolution_canonical_form
 version: !ruby/object:Gem::Version
-  version: 0.1.0.rc0
+  version: 0.3.0
 platform: ruby
 authors:
 - Salsify, Inc
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-03-10 00:00:00.000000000 Z
+date: 2020-07-20 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  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: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -95,19 +109,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: avro-salsify-fork
+  name: avro
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.9.0.5
+        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
+    requirements:
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 1.9.0.5
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
 description: Unique identification of Avro schemas for schema resolution
 email:
 - engineering@salsify.com
@@ -122,6 +150,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- Appraisals
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -130,16 +159,29 @@ files:
 - avro-resolution_canonical_form.gemspec
 - bin/console
 - bin/setup
+- gemfiles/avro_patches_0.x.gemfile
+- gemfiles/avro_patches_1.x.gemfile
 - lib/avro-resolution_canonical_form.rb
+- lib/avro-resolution_canonical_form/version.rb
 - lib/avro/resolution_canonical_form.rb
-- lib/avro/resolution_canonical_form/version.rb
 - lib/avro/resolution_fingerprint.rb
 homepage: https://github.com/salsify/avro-resolution_canonical_form
 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
@@ -150,13 +192,13 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.10
-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: []

data/lib/avro/resolution_canonical_form/version.rb

@@ -1,7 +0,0 @@
-require 'avro'
-
-module Avro
-  class ResolutionCanonicalForm < SchemaNormalization
-    VERSION = '0.1.0.rc0'.freeze
-  end
-end