avro-resolution_canonical_form 0.1.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: dd4c9bcb8a8a9547bdf86e07f176653c6f652eef
-  data.tar.gz: e9cdf593af4a7d544730b7f0861af33380a19418
+SHA256:
+  metadata.gz: 5bc3f7c52afdd1298ab687f9d68d77c0c9aacf080c5087ed0c89a7f9066e55a7
+  data.tar.gz: a76c46c1a5b50efc70b634063de67f84d6dee38a3b91934a8263365622c5fc58
 SHA512:
-  metadata.gz: 82d0029b499e6094121baaefc687ed60d5dcdeb94aec258b625d38edbaa6ca44b86c9c8e194fb3af30b1f5af1b4105020118fc8d0978eef0e8dd505ac4a1cc18
-  data.tar.gz: def105ef3ab398094c5110a2505dd3f61f89296e74f00fbc6f500f85257cd327c362f337b946dcceeaea8c34310afc2e3a900f8eafe3918b823d9ea5cc1afb3e
+  metadata.gz: 510197a7bf31b4841e18664d02aaf29b96a215a3d914ac1615f21e7680bfb4b9edeab7218983fc340efaae0649dbd01d7be83d7329557602b9ffccb11dc046fc
+  data.tar.gz: c910f5a1de6cfed67a46f52ce5a746fcf7403a458ae29aa41d13170592afd29f02a1be72deedd11833fb26adc07790c038040200b5c87e3bf3e885cead5c3b84

data/.circleci/config.yml

@@ -0,0 +1,71 @@
+version: 2.1
+jobs:
+  lint:
+    docker:
+      - image: salsify/ruby_ci:2.6.6
+    working_directory: ~/avro-resolution_canonical_form
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+            - v2-gems-ruby-2.6.6-{{ checksum "avro-resolution_canonical_form.gemspec" }}-{{ checksum "Gemfile" }}
+            - v2-gems-ruby-2.6.6-
+      - 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.6.6-{{ checksum "avro-resolution_canonical_form.gemspec" }}-{{ checksum "Gemfile" }}
+          paths:
+            - "vendor/bundle"
+            - "gemfiles/vendor/bundle"
+      - run:
+          name: Run Rubocop
+          command: bundle exec rubocop
+  test:
+    parameters:
+      ruby-version:
+        type: string
+    docker:
+      - image: salsify/ruby_ci:<< parameters.ruby-version >>
+    environment:
+      CIRCLE_TEST_REPORTS: "test-results"
+    working_directory: ~/avro-resolution_canonical_form
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+            - v2-gems-ruby-<< parameters.ruby-version >>-{{ checksum "avro-resolution_canonical_form.gemspec" }}-{{ checksum "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 "avro-resolution_canonical_form.gemspec" }}-{{ checksum "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:
+              ruby-version:
+                - "2.6.6"
+                - "2.7.2"
+                - "3.0.0"

data/.gitignore

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

data/.rubocop.yml

@@ -1,10 +1,12 @@
 inherit_gem:
   salsify_rubocop: conf/rubocop.yml
 
-Style/FileName:
+AllCops:
+  TargetRubyVersion: 2.6
+
+Naming/FileName:
   Exclude:
     - 'lib/avro-resolution_canonical_form.rb'
 
 RSpec/FilePath:
   Enabled: false
-

data/CHANGELOG.md

@@ -1,4 +1,22 @@
 # avro-resolution_canonical_form
 
+## v0.4.0 (Unreleased)
+- Drop dependency on `avro-patches`.
+- Add support for Ruby 3.0.
+- Drop support for Ruby < 2.6.
+- Use frozen string literals.
+
+## 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,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # override the :github shortcut to be secure by using HTTPS

data/README.md

@@ -23,27 +23,17 @@ 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.
-
-### Aliases
-
-The Avro Ruby gem, including the avro-salsify-fork, 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.
-
 ## Usage
 
 `Avro::ResolutionCanonicalForm` subclasses `Avro::SchemaNormalization`
@@ -68,7 +58,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 +68,7 @@ the existing `#sha256_fingerprint` which is based on the Parsing Canonical Form.
 ```ruby
 schema.sha256_resolution_fingerprint
 
-#=> 80361294467930602613800428579400567035362599364974249578710466785512094641526
+#=> 71676413924523555041213790831440929350080614901361467355865523343334332562796
 ```
 
 ## Development

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 
 require 'rspec/core/rake_task'

data/avro-resolution_canonical_form.gemspec

@@ -1,5 +1,6 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'avro-resolution_canonical_form/version'
 
@@ -27,11 +28,28 @@ 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 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.4'
-  spec.add_development_dependency 'salsify_rubocop', '~> 0.46.0'
+  spec.required_ruby_version = '>= 2.6'
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'overcommit'
+  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', '~> 1.0.1'
   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.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.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+
+require 'avro'
 require 'avro-resolution_canonical_form/version'
 require 'avro/resolution_canonical_form'
 require 'avro/resolution_fingerprint'

data/lib/avro-resolution_canonical_form/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module AvroResolutionCanonicalForm
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.4.0'
 end

data/lib/avro/resolution_canonical_form.rb

@@ -1,7 +1,9 @@
-require 'avro'
+# frozen_string_literal: true
 
 module Avro
-  class ResolutionCanonicalForm < SchemaNormalization
+  class ResolutionCanonicalForm < Avro::SchemaNormalization
+    DECIMAL_LOGICAL_TYPE = 'decimal'
+
     def self.to_resolution_form(schema)
       new.to_resolution_form(schema)
     end
@@ -12,20 +14,44 @@ 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?
+      extensions[:aliases] = field.aliases.sort if field.aliases && !field.aliases.empty?
+
+      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) && !schema.default.nil?
+        # For enum defaults
+        extensions[:default] = schema.default
+      end
+
+      aliases = schema.fullname_aliases
+      extensions[:aliases] = aliases.sort unless aliases.empty?
+      extensions = add_logical_type(schema, extensions)
+      super.merge(extensions)
+    end
   end
 end

data/lib/avro/resolution_fingerprint.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Avro
   class Schema
     # Returns the SHA-256 fingerprint of the Resolution Canonical Form for the

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: avro-resolution_canonical_form
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Salsify, Inc
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-03-14 00:00:00.000000000 Z
+date: 2021-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,58 +16,58 @@ dependencies:
     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
+  name: overcommit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: salsify_rubocop
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.46.0
+        version: '3.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.46.0
+        version: '3.8'
 - !ruby/object:Gem::Dependency
-  name: overcommit
+  name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: salsify_rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -95,19 +109,19 @@ 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.9.0.5
+        version: 1.10.0
 description: Unique identification of Avro schemas for schema resolution
 email:
 - engineering@salsify.com
@@ -117,11 +131,11 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - ".overcommit.yml"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -139,7 +153,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
@@ -147,16 +172,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.10
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Unique identification of Avro schemas for schema resolution
 test_files: []

data/.travis.yml

@@ -1,7 +0,0 @@
-language: ruby
-rvm:
-  - 2.3.3
-before_install: gem install bundler -v 1.14.6
-script:
-  - bundle exec rubocop
-  - bundle exec rspec