avro-builder 0.16.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 200291b14e045c942db013af4e3288ff6f6fd58bd72dec71d07dcd5b3dd8feaa
-  data.tar.gz: 41ec29b767c1133feb64c91766681b58dd98696e27ee4be504a27a6201ee4950
+  metadata.gz: 9c3bfd2cd887dec4479df3b57f6749de1699c375a464fd8bcc0a53d70593db0b
+  data.tar.gz: cf9775f4d8cf8548b50bf860ceb8fbf896228cf7c5246f6668d8ea8f4a2c1ea8
 SHA512:
-  metadata.gz: affd413784160d10c371d1d70547d58332d388726d31a727b242c85823a068e5d9e97d12a999ee96bcdd6db2796cbd6ea2f70566ccdd707bd3e21995373aac3c
-  data.tar.gz: d94ffa43cd149edf03046b17368d56d2b3229cc46ad92e3f1dd7588f056078ec4e6679f3157968989e319db7d25f10d461f25cca3e651d8fcb07b66d0531a004
+  metadata.gz: 1d8ef969008d124f6f7445d53397ec5e7c2fa8de4a8e9bbb9f6a9496640be6279439042abc01c210f2f4367e3dd35202b6aaa61453727ae4ad7a99d337e85720
+  data.tar.gz: 3d253d37019c40e9d4f9737748b312c58986e34cdc04f6e8a1fedd79a5ab091d418df1e85e2308192b2bd329ad2b0daac6e157372053a944489eea9f12fd2777

data/.circleci/config.yml

@@ -0,0 +1,78 @@
+version: 2.1
+jobs:
+  lint:
+    docker:
+      - image: salsify/ruby_ci:2.6.8
+    working_directory: ~/avro-builder
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+            - v2-gems-ruby-2.6.8-{{ checksum "avro-builder.gemspec" }}-{{ checksum "Gemfile" }}
+            - v2-gems-ruby-2.6.8-
+      - 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.8-{{ checksum "avro-builder.gemspec" }}-{{ checksum "Gemfile" }}
+          paths:
+            - "vendor/bundle"
+            - "gemfiles/vendor/bundle"
+      - run:
+          name: Run Rubocop
+          command: bundle exec rubocop
+  test:
+    parameters:
+      gemfile:
+        type: string
+      ruby-version:
+        type: string
+    docker:
+      - image: salsify/ruby_ci:<< parameters.ruby-version >>
+    environment:
+      CIRCLE_TEST_REPORTS: "test-results"
+      BUNDLE_GEMFILE: << parameters.gemfile >>
+    working_directory: ~/avro-builder
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+            - v2-gems-ruby-<< parameters.ruby-version >>-{{ checksum "avro-builder.gemspec" }}-{{ checksum "<< parameters.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-builder.gemspec" }}-{{ checksum "<< parameters.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:
+              gemfile:
+                - "gemfiles/avro_1.9.gemfile"
+                - "gemfiles/avro_1.10.gemfile"
+                - "gemfiles/avro_1.11.gemfile"
+              ruby-version:
+              - "2.6.8"
+              - "2.7.4"
+              - "3.0.2"

data/.github/CODEOWNERS

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

data/.rubocop.yml

@@ -7,7 +7,7 @@ AllCops:
       - Exclude
   NewCops: disable
   Exclude:
-    - "gemfiles/*"
+    - "gemfiles/**/*"
 
 Style/RaiseArgs:
   EnforcedStyle: compact

data/.ruby-version

@@ -1 +1 @@
-2.5.8
+2.6.6

data/Appraisals

@@ -1,26 +1,13 @@
 # frozen_string_literal: true
 
-appraise 'avro-1.8.2' do
-  gem 'avro', '1.8.2'
+appraise 'avro-1.9' do
+  gem 'avro', '1.9.2'
 end
 
-appraise 'avro-1.9.0' do
-  gem 'avro', '1.9.0'
+appraise 'avro-1.10' do
+  gem 'avro', '1.10.2'
 end
 
-appraise 'avro-1.9.1' do
-  gem 'avro', '1.9.1'
-end
-
-appraise 'avro-1.10.0' do
-  gem 'avro', '1.10.0'
-end
-
-appraise 'avro-patches-0.x' do
-  gem 'avro', '1.8.2'
-  gem 'avro-patches', '< 1.0.0'
-end
-
-appraise 'avro-patches-1.x' do
-  gem 'avro-patches', '>= 1.0.0'
+appraise 'avro-1.11' do
+  gem 'avro', '~> 1.11.0'
 end

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # 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.
+
+## v1.0.0
+- Drop support for Avro < 1.9.
+- Drop support for Ruby < 2.6.
+- Add Ruby 3.0 support.
+- Bug fix: Use multi_json to encode schemas and ensure that a JSON encoder
+  is always present.
+
+## v0.17.0
+- Add support for enum defaults introduced in Avro v1.10.0.
+
 ## v0.16.2
 - Allow avro version up to v1.10.x. Support will be added for new
   functionality in Avro v1.10 in a later release.

data/README.md

@@ -1,9 +1,9 @@
 # Avro::Builder
 
-[![Build Status](https://travis-ci.org/salsify/avro-builder.svg?branch=master)][travis]
+[![Build Status](https://circleci.com/gh/salsify/avro-builder.svg?style=svg)][circleci]
 [![Gem Version](https://badge.fury.io/rb/avro-builder.svg)](https://badge.fury.io/rb/avro-builder)
 
-[travis]: http://travis-ci.org/salsify/avro-builder
+[circleci]: https://circleci.com/gh/salsify/avro-builder
 
 `Avro::Builder` provides a Ruby DSL to create [Apache Avro](https://avro.apache.org/docs/current/) Schemas.
 
@@ -165,6 +165,9 @@ fixed :g, size: 8
 enum :e, :X, :Y, :Z
 enum :d, symbols: [:A, :B]
 
+# defaults can be set for enums with Ruby Avro v1.10.0
+enum :c, symbols: [:A, :B], default: :A
+
 record :my_record_with_named do
   required :f_ref, :f
   required :fixed_inline, :fixed, size: 9
@@ -276,21 +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 official Ruby `avro` gem does not yet support logical types:
-[AVRO-1695](https://issues.apache.org/jira/browse/AVRO-1695).
-
-There is a [avro-patches](https://github.com/salsify/avro-patches) gem that patches
-the official Avro Ruby gem to support
-encoding and decoding logical types. To use this gem, reference it in your Gemfile
-instead of the official Avro gem:
-
-```ruby
-gem 'avro-patches'
-```
+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:
 
@@ -317,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,12 +15,21 @@ 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) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'avro', '>= 1.7.0', '< 1.11'
+  spec.required_ruby_version = '>= 2.6'
+
+  spec.add_runtime_dependency 'avro', '>= 1.9.0', '< 1.12'
 
   spec.add_development_dependency 'appraisal'
   spec.add_development_dependency 'bundler', '~> 2.0'
@@ -29,6 +38,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rspec-its'
-  spec.add_development_dependency 'salsify_rubocop', '~> 0.85.0'
+  spec.add_development_dependency 'rspec_junit_formatter'
+  spec.add_development_dependency 'salsify_rubocop', '~> 1.0.1'
   spec.add_development_dependency 'simplecov'
 end

data/gemfiles/{avro_1.10.0.gemfile → avro_1.10.gemfile}

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

data/gemfiles/{avro_1.8.2.gemfile → avro_1.11.gemfile}

@@ -2,6 +2,6 @@
 
 source "https://rubygems.org"
 
-gem "avro", "1.8.2"
+gem "avro", "~> 1.11.0"
 
 gemspec path: "../"

data/gemfiles/{avro_1.9.1.gemfile → avro_1.9.gemfile}

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

data/lib/avro/builder/dsl.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'avro'
+require 'json'
 require 'avro/builder/errors'
 require 'avro/builder/dsl_options'
 require 'avro/builder/dsl_attributes'

data/lib/avro/builder/rake/avro_generate_task.rb

@@ -12,6 +12,7 @@ module Avro
                       :load_paths, :dependencies, :filetype
 
         def initialize(name: :generate, dependencies: [])
+          super()
           @name = name
           @task_namespace = :avro
           @task_desc = 'Generate Avro schema files from Avro::Builder DSL'

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/enum_type.rb

@@ -5,7 +5,7 @@ module Avro
     module Types
       class EnumType < NamedType
 
-        dsl_attribute :doc
+        dsl_attributes :doc, :default
 
         dsl_attribute :symbols do |*values|
           # Define symbols explicitly to support values as a splat or single array
@@ -27,12 +27,19 @@ module Avro
         def validate!
           super
           validate_required_attribute!(:symbols)
+          validate_enum_default!
         end
 
         private
 
+        def validate_enum_default!
+          if !default.nil? && !symbols.map(&:to_sym).include?(default.to_sym)
+            raise AttributeError.new("enum default '#{default}' must be one of the enum symbols: #{symbols}")
+          end
+        end
+
         def serialized_attributes
-          { symbols: symbols, doc: doc }
+          { symbols: symbols, doc: doc, default: default }
         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/record_type.rb

@@ -13,7 +13,8 @@ module Avro
         dsl_attribute :doc
         dsl_attribute_alias :type_doc, :doc
 
-        def initialize(name = nil, options: {}, cache:, field: nil, &block)
+        def initialize(name = nil, cache:, options: {}, field: nil, &block) # rubocop:disable Lint/MissingSuper
+          # TODO: Fix missing call to super
           @avro_type_name = :record
           @name = name
           @cache = cache

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 = '0.16.2'
+    VERSION = '1.1.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: avro-builder
 version: !ruby/object:Gem::Version
-  version: 0.16.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Salsify Engineering
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-29 00:00:00.000000000 Z
+date: 2021-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: avro
@@ -16,20 +16,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: 1.9.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '1.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        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
@@ -128,20 +128,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  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: salsify_rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.85.0
+        version: 1.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.85.0
+        version: 1.0.1
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -163,12 +177,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
+- ".github/CODEOWNERS"
 - ".gitignore"
 - ".overcommit.yml"
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
-- ".travis.yml"
 - Appraisals
 - CHANGELOG.md
 - Gemfile
@@ -178,12 +193,9 @@ files:
 - avro-builder.gemspec
 - bin/console
 - bin/setup
-- gemfiles/avro_1.10.0.gemfile
-- gemfiles/avro_1.8.2.gemfile
-- gemfiles/avro_1.9.0.gemfile
-- gemfiles/avro_1.9.1.gemfile
-- gemfiles/avro_patches_0.x.gemfile
-- gemfiles/avro_patches_1.x.gemfile
+- gemfiles/avro_1.10.gemfile
+- gemfiles/avro_1.11.gemfile
+- gemfiles/avro_1.9.gemfile
 - lib/avro/builder.rb
 - lib/avro/builder/aliasable.rb
 - lib/avro/builder/anonymous_types.rb
@@ -206,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
@@ -221,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
@@ -230,16 +245,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.7.6.2
-signing_key:
+rubygems_version: 3.2.22
+signing_key: 
 specification_version: 4
 summary: Ruby DSL to create Avro schemas
 test_files: []

data/.travis.yml

@@ -1,16 +0,0 @@
-language: ruby
-rvm:
-  - 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 appraisal avro-1.8.2 rspec
-  - bundle exec appraisal avro-1.9.0 rspec
-  - bundle exec appraisal avro-1.9.1 rspec
-  - bundle exec appraisal avro-1.10.0 rspec
-  - bundle exec appraisal avro-patches-0.x rspec
-  - bundle exec appraisal avro-patches-1.x rspec

data/gemfiles/avro_1.9.0.gemfile

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

data/gemfiles/avro_patches_0.x.gemfile

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

data/gemfiles/avro_patches_1.x.gemfile

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