avro-builder 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2223e0a5e244cc9dc9e57be463e120b747fbaa9f3c9dc22bf8f7a7da43c2d4b9
-  data.tar.gz: 9e0129b8c9f1f0fd142beabe1dfda1f2fadc3de3e0105f4770995f4f15e323b7
+  metadata.gz: 9c3bfd2cd887dec4479df3b57f6749de1699c375a464fd8bcc0a53d70593db0b
+  data.tar.gz: cf9775f4d8cf8548b50bf860ceb8fbf896228cf7c5246f6668d8ea8f4a2c1ea8
 SHA512:
-  metadata.gz: 591e9422ed7a64adaf2969a9fd069f805398d8edefd64545900ef9e5bfb6cab4dcc1c41d1655886d83026bedc0bd56c914a31f495b732788d9f043d7f397fba0
-  data.tar.gz: 0d1da2ec6ae6a024a59035150f9423663a1550de37701ff204b5a8812ac221332d4ffa90d5ddb48a9ace7d16166d2e4bb9835e8d9941bda0934c4441ec82f835
+  metadata.gz: 1d8ef969008d124f6f7445d53397ec5e7c2fa8de4a8e9bbb9f6a9496640be6279439042abc01c210f2f4367e3dd35202b6aaa61453727ae4ad7a99d337e85720
+  data.tar.gz: 3d253d37019c40e9d4f9737748b312c58986e34cdc04f6e8a1fedd79a5ab091d418df1e85e2308192b2bd329ad2b0daac6e157372053a944489eea9f12fd2777

data/.circleci/config.yml

@@ -2,14 +2,14 @@ version: 2.1
 jobs:
   lint:
     docker:
-      - image: salsify/ruby_ci:2.6.6
+      - image: salsify/ruby_ci:2.6.8
     working_directory: ~/avro-builder
     steps:
       - checkout
       - restore_cache:
           keys:
-            - v2-gems-ruby-2.6.6-{{ checksum "avro-builder.gemspec" }}-{{ checksum "Gemfile" }}
-            - v2-gems-ruby-2.6.6-
+            - v2-gems-ruby-2.6.8-{{ checksum "avro-builder.gemspec" }}-{{ checksum "Gemfile" }}
+            - v2-gems-ruby-2.6.8-
       - run:
           name: Install Gems
           command: |
@@ -18,7 +18,7 @@ jobs:
               bundle clean
             fi
       - save_cache:
-          key: v2-gems-ruby-2.6.6-{{ checksum "avro-builder.gemspec" }}-{{ checksum "Gemfile" }}
+          key: v2-gems-ruby-2.6.8-{{ checksum "avro-builder.gemspec" }}-{{ checksum "Gemfile" }}
           paths:
             - "vendor/bundle"
             - "gemfiles/vendor/bundle"
@@ -71,7 +71,8 @@ workflows:
               gemfile:
                 - "gemfiles/avro_1.9.gemfile"
                 - "gemfiles/avro_1.10.gemfile"
+                - "gemfiles/avro_1.11.gemfile"
               ruby-version:
-              - "2.6.6"
-              - "2.7.2"
-              - "3.0.0"
+              - "2.6.8"
+              - "2.7.4"
+              - "3.0.2"

data/.github/CODEOWNERS

@@ -0,0 +1 @@
+* @jturkel @kphelps @tjwp

data/Appraisals

@@ -5,5 +5,9 @@ appraise 'avro-1.9' do
 end
 
 appraise 'avro-1.10' do
-  gem 'avro', '1.10.1'
+  gem 'avro', '1.10.2'
+end
+
+appraise 'avro-1.11' do
+  gem 'avro', '~> 1.11.0'
 end

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # avro-builder changelog
 
+## v1.1.0
+- Add support for Avro 1.11
+- Add support for decimal logical types.
+
 ## v1.0.1
 - Bug fix: Fix pretty formatting of schemas for Rails applications that don't 
   use oj or yajl by removing the dependency on multi_json.

data/README.md

@@ -279,9 +279,10 @@ end
 
 ### Logical Types
 
-The DSL supports setting a logical type on any type except a union. The logical
-types defined in the Avro [spec](https://avro.apache.org/docs/1.8.1/spec.html#Logical+Types)
-are more limited.
+The DSL supports setting a logical type on any type except a union. The Avro
+[spec](https://avro.apache.org/docs/current/spec.html#Logical+Types) lists the logical types
+that are currently defined. Note: `avro-builder` is more permissive and any logical type can
+be specified on a type.
 
 A logical type can be specified for a field using the `logical_type` attribute:
 
@@ -308,6 +309,13 @@ record :with_date_array
 end
 ```
 
+#### Decimal Logical Types
+
+The decimal logical type, for bytes and fixed types, is currently the only logical type that requires additional
+attributes. For decimals, precision must be specified and scale may optionally be specified. `avro-builder`
+supports both of these attributes for bytes and fixed decimals. See the Avro
+[spec](https://avro.apache.org/docs/current/spec.html#Decimal) for more details.
+
 ### Abstract Types
 
 Types can be declared as abstract in the DSL. Declaring a type as abstract

data/avro-builder.gemspec

@@ -15,6 +15,13 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/salsify/avro-builder.git'
   spec.license       = 'MIT'
 
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+    spec.metadata['rubygems_mfa_required'] = 'true'
+  else
+    raise 'RubyGems 2.0 or newer is required to set allowed_push_host.'
+  end
+
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
@@ -22,7 +29,7 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.6'
 
-  spec.add_runtime_dependency 'avro', '>= 1.9.0', '< 1.11'
+  spec.add_runtime_dependency 'avro', '>= 1.9.0', '< 1.12'
 
   spec.add_development_dependency 'appraisal'
   spec.add_development_dependency 'bundler', '~> 2.0'

data/gemfiles/avro_1.10.gemfile

@@ -2,6 +2,6 @@
 
 source "https://rubygems.org"
 
-gem "avro", "1.10.1"
+gem "avro", "1.10.2"
 
 gemspec path: "../"

data/gemfiles/avro_1.11.gemfile

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

data/lib/avro/builder/type_factory.rb

@@ -30,7 +30,9 @@ module Avro
       # Return a new Type instance
       def create_builtin_type(avro_type_name, field:, cache:)
         name = avro_type_name.to_s.downcase
-        if Avro::Schema::PRIMITIVE_TYPES.include?(name)
+        if name == 'bytes'
+          Avro::Builder::Types::BytesType.new(field: field, cache: cache)
+        elsif Avro::Schema::PRIMITIVE_TYPES.include?(name)
           Avro::Builder::Types::Type.new(name, field: field, cache: cache)
         elsif field.nil? && NAMED_TYPES.include?(name)
           Avro::Builder.const_get(name.capitalize).new(cache: cache)

data/lib/avro/builder/types/bytes_type.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Avro
+  module Builder
+    module Types
+      # Subclass for the primitive Bytes type because it supports the decimal logical type.
+      class BytesType < Type
+        dsl_attributes :precision, :scale
+
+        def initialize(cache:, field: nil)
+          super('bytes', field: field, cache: cache)
+        end
+
+        def serialize(reference_state)
+          super(reference_state, overrides: serialized_attributes)
+        end
+
+        def to_h(reference_state)
+          super(reference_state, overrides: serialized_attributes)
+        end
+
+        private
+
+        def serialized_attributes
+          { precision: precision, scale: scale }
+        end
+      end
+    end
+  end
+end

data/lib/avro/builder/types/fixed_type.rb

@@ -5,7 +5,7 @@ module Avro
     module Types
       class FixedType < NamedType
 
-        dsl_attribute :size
+        dsl_attributes :size, :precision, :scale
 
         def serialize(reference_state)
           super(reference_state, overrides: serialized_attributes)
@@ -23,7 +23,7 @@ module Avro
         private
 
         def serialized_attributes
-          { size: size }
+          { size: size, precision: precision, scale: scale }
         end
       end
     end

data/lib/avro/builder/types/type.rb

@@ -24,17 +24,16 @@ module Avro
           !!abstract
         end
 
-        def serialize(_reference_state)
+        def serialize(_reference_state, overrides: {})
           if logical_type
-            { type: avro_type_name, logicalType: logical_type }
+            serialized_attributes_hash(overrides)
           else
             avro_type_name
           end
         end
 
-        def to_h(_reference_state)
-          { type: avro_type_name, logicalType: logical_type }
-            .reject { |_, v| v.nil? }
+        def to_h(_reference_state, overrides: {})
+          serialized_attributes_hash(overrides)
         end
 
         def namespace
@@ -75,6 +74,12 @@ module Avro
 
         private
 
+        def serialized_attributes_hash(overrides)
+          { type: avro_type_name, logicalType: logical_type }
+            .merge(overrides)
+            .reject { |_, v| v.nil? }
+        end
+
         def required_attribute_error!(attribute_name)
           raise RequiredAttributeError.new(type: avro_type_name,
                                            attribute: attribute_name,

data/lib/avro/builder/types.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'avro/builder/types/type'
+require 'avro/builder/types/bytes_type'
 require 'avro/builder/types/complex_type'
 require 'avro/builder/types/type_referencer'
 require 'avro/builder/types/named_type'

data/lib/avro/builder/version.rb

@@ -2,6 +2,6 @@
 
 module Avro
   module Builder
-    VERSION = '1.0.1'
+    VERSION = '1.1.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: avro-builder
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Salsify Engineering
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-24 00:00:00.000000000 Z
+date: 2021-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: avro
@@ -19,7 +19,7 @@ dependencies:
         version: 1.9.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '1.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: 1.9.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '1.12'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -178,6 +178,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
+- ".github/CODEOWNERS"
 - ".gitignore"
 - ".overcommit.yml"
 - ".rspec"
@@ -193,6 +194,7 @@ files:
 - bin/console
 - bin/setup
 - gemfiles/avro_1.10.gemfile
+- gemfiles/avro_1.11.gemfile
 - gemfiles/avro_1.9.gemfile
 - lib/avro/builder.rb
 - lib/avro/builder/aliasable.rb
@@ -216,6 +218,7 @@ files:
 - lib/avro/builder/type_factory.rb
 - lib/avro/builder/types.rb
 - lib/avro/builder/types/array_type.rb
+- lib/avro/builder/types/bytes_type.rb
 - lib/avro/builder/types/complex_type.rb
 - lib/avro/builder/types/enum_type.rb
 - lib/avro/builder/types/fixed_type.rb
@@ -231,8 +234,10 @@ files:
 homepage: https://github.com/salsify/avro-builder.git
 licenses:
 - MIT
-metadata: {}
-post_install_message:
+metadata:
+  allowed_push_host: https://rubygems.org
+  rubygems_mfa_required: 'true'
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -247,8 +252,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
-signing_key:
+rubygems_version: 3.2.22
+signing_key: 
 specification_version: 4
 summary: Ruby DSL to create Avro schemas
 test_files: []