avro-builder 2.1.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f59fdd8a081eaaffd44838edb7a38ccdb9910c608376c736f24c65877c86afb5
-  data.tar.gz: 5747a1fc177ee16557a4b8d4cf82b3e3c98be8dd5840c3c8be4bac0cf20d5940
+  metadata.gz: b69b72980ff9b8694f57b85ccf9167b46a939dbd3e19465dfee1de70f1cf82f9
+  data.tar.gz: a6856ad6135354d02549ec405c5b46a1d60616285c4f5b7d17980c59150a615b
 SHA512:
-  metadata.gz: e27dd35585d480e3ab97164d0d133f0a84ac617539cb9f8a56aa51c82cd0c56041e0d384f8337f870a40339dd3fecb5b4451132dac0859605c8b7b02fd417cc4
-  data.tar.gz: a42ae650e5fad0647da8e7d3174af55ee88fe73bafd98bf68ecc121301fcca9965ef686f893e7632c88b8087b07a1426ed58e83853a07c2c21664830dc9d6a7f
+  metadata.gz: d56eaaf1a0d4286fa09c2a8680cca7b97a0f9033211222d11436bf4444257b13225100ea2af1aa2226f3c3cb1dca305a7178e07cac8011cd3b389cc34d5d2a0d
+  data.tar.gz: 2b9f623c68965f2f557d2bd246a8835347382158cdeab816273985413adb4d36594415c39c29ba4a24666039fc2b35cd2a8b5d17080f48b1e756763550ad0006

data/.circleci/config.yml

@@ -2,23 +2,24 @@ version: 2.1
 jobs:
   lint:
     docker:
-      - image: cimg/ruby:2.7.7
+      - image: cimg/ruby:3.3.10
     working_directory: ~/avro-builder
     steps:
       - checkout
       - restore_cache:
           keys:
-            - v2-gems-ruby-2.7.7-{{ checksum "avro-builder.gemspec" }}-{{ checksum "Gemfile" }}
-            - v2-gems-ruby-2.7.7-
+            - v2-gems-ruby-3.3.10-{{ checksum "avro-builder.gemspec" }}-{{ checksum "Gemfile" }}
+            - v2-gems-ruby-3.3.10-
       - run:
           name: Install Gems
           command: |
-            if ! bundle check --path=vendor/bundle; then
-              bundle install --path=vendor/bundle --jobs=4 --retry=3
+            bundle config set path 'vendor/bundle'
+            if ! bundle check; then
+              bundle install --jobs=4 --retry=3
               bundle clean
             fi
       - save_cache:
-          key: v2-gems-ruby-2.7.7-{{ checksum "avro-builder.gemspec" }}-{{ checksum "Gemfile" }}
+          key: v2-gems-ruby-3.3.10-{{ checksum "avro-builder.gemspec" }}-{{ checksum "Gemfile" }}
           paths:
             - "vendor/bundle"
             - "gemfiles/vendor/bundle"
@@ -46,8 +47,9 @@ jobs:
       - run:
           name: Install Gems
           command: |
-            if ! bundle check --path=vendor/bundle; then
-              bundle install --path=vendor/bundle --jobs=4 --retry=3
+            bundle config set path 'vendor/bundle'
+            if ! bundle check; then
+              bundle install --jobs=4 --retry=3
               bundle clean
             fi
       - save_cache:
@@ -69,13 +71,9 @@ workflows:
           matrix:
             parameters:
               gemfile:
-                - gemfiles/avro_1.9.gemfile
-                - gemfiles/avro_1.10.gemfile
                 - gemfiles/avro_1.11.gemfile
                 - gemfiles/avro_1.12.gemfile
               ruby-version:
-                - 2.7.7
-                - 3.0.5
-                - 3.1.3
-                - 3.2.0
-                - 3.3.0
+                - 3.3.10
+                - 3.4.8
+                - 4.0.1

data/.github/CODEOWNERS

@@ -1 +1 @@
-* @salsify/pim-core-backend
+* @salsify/pim-core-backend @jturkel

data/.rubocop.yml

@@ -1,13 +1,12 @@
 inherit_gem:
   salsify_rubocop: conf/rubocop.yml
 
+inherit_mode:
+  merge:
+    - Exclude
+
+require: rubocop-rspec
+
 AllCops:
-  inherit_mode:
-    merge:
-      - Exclude
-  NewCops: disable
   Exclude:
     - "gemfiles/**/*"
-
-Style/RaiseArgs:
-  EnforcedStyle: compact

data/.ruby-version

@@ -1 +1 @@
-2.7.7
+3.3.10

data/Appraisals

@@ -1,13 +1,5 @@
 # frozen_string_literal: true
 
-appraise 'avro-1.9' do
-  gem 'avro', '1.9.2'
-end
-
-appraise 'avro-1.10' do
-  gem 'avro', '1.10.2'
-end
-
 appraise 'avro-1.11' do
   gem 'avro', '~> 1.11.0'
 end

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # avro-builder changelog
 
+## v3.0.0
+- Add support for configurable metadata on fields, records, enums, fixed types, and
+  primitives via `Avro::Builder.extra_metadata_attributes`.
+- Add support for field `order` attribute in serialized output.
+- Raise an error when invalid options are passed to a type instead of silently ignoring them.
+- Add support for Ruby 3.4, and 4.0.
+- Drop support for Avro < 1.11.
+- Drop support for Ruby < 3.3.
+
 ## v2.1.0
 - Add support for Avro 1.12.
 

data/README.md

@@ -458,6 +458,22 @@ Avro::Builder::Rake::AvroGenerateTask.new(name: :custom_gen,
 end
 ```
 
+### Extra metadata attributes
+
+The [Avro specification](https://avro.apache.org/docs/1.12.0/specification/) allows metadata attribute to be added to any type or field as long as it does not clash with Avro specification attributes.
+
+```ruby
+# Configure the metadata attributes an initializer
+Avro::Builder.extra_metadata_attributes(:deprecated_by, :documentation_url)
+
+# Use metadata attributes in your schema definition like any other DSL attributes
+record :my_record do
+  documentation_url 'https://example.com/docs'
+  required :my_boolean, :boolean, deprecated_by: 'com.example.my_boolean2'
+  required :my_boolean2, :boolean
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/Rakefile

@@ -8,9 +8,13 @@ RSpec::Core::RakeTask.new(:default_spec)
 
 Appraisal::Task.new
 
+# rubocop:disable Rake/DuplicateTask
+# rubocop:disable Rake/Desc
 if !ENV['APPRAISAL_INITIALIZED']
   task default: :appraisal
   task spec: :appraisal
 else
   task default: :default_spec
 end
+# rubocop:enable Rake/DuplicateTask
+# rubocop:enable Rake/Desc

data/avro-builder.gemspec

@@ -27,18 +27,17 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.7'
+  spec.required_ruby_version = '>= 3.3'
 
-  spec.add_runtime_dependency 'avro', '>= 1.9.0', '< 1.13'
+  spec.add_runtime_dependency 'avro', '>= 1.11.0', '< 1.13'
 
   spec.add_development_dependency 'appraisal'
-  spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'json_spec'
   spec.add_development_dependency 'overcommit'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.13'
   spec.add_development_dependency 'rspec-its'
   spec.add_development_dependency 'rspec_junit_formatter'
-  spec.add_development_dependency 'salsify_rubocop', '~> 1.0.1'
+  spec.add_development_dependency 'salsify_rubocop', '~> 1.85.1'
   spec.add_development_dependency 'simplecov'
 end

data/lib/avro/builder/dsl_attributes.rb

@@ -17,6 +17,29 @@ module Avro
     # When a DSL attribute is defined, the class also keeps track of the
     # attribute names.
     module DslAttributes
+      ATTRIBUTE_NAMES = [
+        :abstract,
+        :aliases,
+        :default,
+        :doc,
+        :items,
+        :logicalType,
+        :logical_type,
+        :namespace,
+        :order,
+        :precision,
+        :scale,
+        :size,
+        :symbols,
+        :type,
+        :type_aliases,
+        :type_doc,
+        :type_name,
+        :type_namespace,
+        :types,
+        :values
+      ].freeze
+
       def self.included(base)
         base.extend ClassMethods
       end
@@ -59,6 +82,10 @@ module Avro
         end
 
         def add_attribute_name(name)
+          unless ATTRIBUTE_NAMES.include?(name)
+            raise "DSL attribute #{name.inspect} must be added to Avro::Builder::DslAttributes::RESERVED_NAMES"
+          end
+
           dsl_attribute_names << name
           add_option_name(name)
         end

data/lib/avro/builder/field.rb

@@ -2,6 +2,7 @@
 
 require 'avro/builder/type_factory'
 require 'avro/builder/aliasable'
+require 'avro/builder/metadata'
 
 module Avro
   module Builder
@@ -13,33 +14,30 @@ module Avro
       include Avro::Builder::DslAttributes
       include Avro::Builder::Aliasable
       include Avro::Builder::AnonymousTypes
-
-      INTERNAL_ATTRIBUTES = [:optional_field].to_set.freeze
+      include Avro::Builder::Metadata
 
       # These attributes may be set as options or via a block in the DSL
       dsl_attributes :doc, :default, :order
 
-      def initialize(name:, avro_type_or_name:, record:, cache:, internal: {}, options: {}, &block)
+      def initialize(name:, avro_type_or_name:, record:, cache:, optional:, options: {}, &block)
         @cache = cache
         @record = record
         @name = name.to_s
-
-        internal.each do |key, value|
-          send("#{key}=", value) if INTERNAL_ATTRIBUTES.include?(key)
-        end
+        @optional_field = optional
 
         type_options = options.dup
         options.keys.each do |key|
-          send(key, type_options.delete(key)) if dsl_attribute?(key)
+          send(key, type_options.delete(key)) if dsl_attribute?(key) || extra_metadata_attribute?(key)
         end
 
         # Find existing Type or build a new instance of a builtin Type using
         # the supplied block
         @field_type = type_lookup(avro_type_or_name, namespace) do |avro_type_name|
+          type_internal = NAMED_TYPES.include?(avro_type_name.to_s) ? { type_namespace: namespace } : {}
           create_and_configure_builtin_type(avro_type_name,
                                             field: self,
                                             cache: cache,
-                                            internal: internal,
+                                            internal: type_internal,
                                             validate_type: false,
                                             options: type_options)
         end
@@ -56,7 +54,15 @@ module Avro
       end
 
       def method_missing(id, *args, &block)
-        field_type.dsl_respond_to?(id) ? field_type.send(id, *args, &block) : super
+        # We can't just rely on Metadata#method_missing because we want to give precedence to defining
+        # metadata on the field rather than the type
+        if extra_metadata_accessor?(id)
+          extra_metadata_access(id, args)
+        elsif field_type.dsl_respond_to?(id)
+          field_type.send(id, *args, &block)
+        else
+          super
+        end
       end
 
       def name_fragment
@@ -84,15 +90,15 @@ module Avro
       end
 
       def serialize(reference_state)
-        # TODO: order is not included here
         {
           name: name,
           type: serialized_type(reference_state),
           doc: doc,
           default: default,
-          aliases: aliases
-        }.reject { |_, v| v.nil? }.tap do |result|
-          result.merge!(default: nil) if optional_field
+          aliases: aliases,
+          order: order
+        }.merge(extra_metadata).compact.tap do |result|
+          result[:default] = nil if optional_field
         end
       end
 

data/lib/avro/builder/metadata.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Avro
+  module Builder
+    module Metadata
+      @attribute_names = Set.new
+
+      class << self
+        def register(*attrs)
+          attrs = attrs.flatten.map(&:to_sym) - attribute_names.to_a
+
+          reserved = attrs & Avro::Builder::DslAttributes::ATTRIBUTE_NAMES
+          if reserved.any?
+            raise ArgumentError.new(
+              "Extra metadata attribute(s) use reserved name(s): #{reserved.join(', ')}"
+            )
+          end
+
+          attribute_names.merge(attrs)
+        end
+
+        def reset!
+          attribute_names.clear
+        end
+
+        def attribute?(name)
+          attribute_names.include?(name.to_sym)
+        end
+
+        private
+
+        attr_reader :attribute_names
+      end
+
+      def respond_to_missing?(id, include_all)
+        extra_metadata_accessor?(id) || super
+      end
+
+      def method_missing(id, *args, &block)
+        if extra_metadata_accessor?(id)
+          extra_metadata_access(id, args)
+        else
+          super
+        end
+      end
+
+      private
+
+      def extra_metadata_attribute?(name)
+        Metadata.attribute?(name)
+      end
+
+      def extra_metadata
+        @extra_metadata ||= {}
+      end
+
+      def extra_metadata_accessor?(name)
+        name = name.to_s.delete_suffix('=').to_sym
+        extra_metadata_attribute?(name)
+      end
+
+      def extra_metadata_access(name, args)
+        name = name.to_s.delete_suffix('=').to_sym
+
+        if !extra_metadata_attribute?(name)
+          raise ArgumentError.new("Unknown metadata attribute: #{name}")
+        elsif args.size > 1
+          raise ArgumentError.new("Expected 0 or 1 arguments. Got #{args.size}")
+        elsif args.empty? || args.first.nil?
+          extra_metadata[name]
+        else
+          extra_metadata[name] = args.first
+        end
+      end
+    end
+  end
+end

data/lib/avro/builder/schema_serializer_reference_state.rb

@@ -24,6 +24,15 @@ module Avro
           yield
         end
       end
+
+      def definition(fullname)
+        if references.include?(fullname)
+          raise ArgumentError.new("Type '#{fullname}' has already been defined")
+        else
+          references << fullname
+          yield
+        end
+      end
     end
   end
 end

data/lib/avro/builder/type_factory.rb

@@ -6,8 +6,8 @@ module Avro
     # This concern is used by classes that create new Type instances.
     module TypeFactory
 
-      NAMED_TYPES = ['enum', 'fixed', 'record'].map(&:freeze).to_set.freeze
-      COMPLEX_TYPES = ['array', 'enum', 'fixed', 'map', 'record', 'union'].map(&:freeze).to_set.freeze
+      NAMED_TYPES = ['enum', 'fixed', 'record'].to_set.freeze
+      COMPLEX_TYPES = ['array', 'enum', 'fixed', 'map', 'record', 'union'].to_set.freeze
       BUILTIN_TYPES = Avro::Schema::PRIMITIVE_TYPES.union(COMPLEX_TYPES).freeze
 
       private
@@ -33,7 +33,7 @@ module Avro
         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)
+          Avro::Builder::Types::PrimitiveType.new(name, field: field, cache: cache)
         elsif field.nil? && NAMED_TYPES.include?(name)
           Avro::Builder.const_get(name.capitalize).new(cache: cache)
         elsif COMPLEX_TYPES.include?(name)

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

@@ -3,8 +3,7 @@
 module Avro
   module Builder
     module Types
-      class ArrayType < Type
-        include Avro::Builder::Types::ComplexType
+      class ArrayType < ComplexType
         include Avro::Builder::Types::TypeReferencer
 
         dsl_attribute :items do |items_type = nil|
@@ -19,9 +18,10 @@ module Avro
           validate_required_attribute!(:items)
         end
 
-        def serialize(referenced_state)
-          super(referenced_state,
-                overrides: { items: items.serialize(referenced_state) })
+        private
+
+        def serialized_attribute_hash(reference_state)
+          super.merge(items: items.serialize(reference_state))
         end
       end
     end

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

@@ -4,25 +4,17 @@ module Avro
   module Builder
     module Types
       # Subclass for the primitive Bytes type because it supports the decimal logical type.
-      class BytesType < Type
+      class BytesType < PrimitiveType
         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 }
+        def serialized_attribute_hash(reference_state)
+          super.merge(precision: precision, scale: scale)
         end
       end
     end

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

@@ -4,12 +4,13 @@ module Avro
   module Builder
     module Types
 
-      # This module provides common functionality for non-primitive types
-      # that do not require a name to be created.
-      module ComplexType
+      # This is an abstract class that provides common functionality for
+      # non-primitive types that do not require a name to be created.
+      class ComplexType < Type
 
-        def self.included(base)
-          base.extend ClassMethods
+        # Infer avro_type_name based on class
+        def self.avro_type_name
+          @avro_type_name ||= name.split('::').last.sub('Type', '').downcase.to_sym
         end
 
         # Override initialize so that type name is not required
@@ -20,25 +21,6 @@ module Avro
         def namespace
           field.namespace
         end
-
-        def serialize(_reference_state, overrides: {})
-          {
-            type: avro_type_name,
-            logicalType: logical_type
-          }.merge(overrides).reject { |_, v| v.nil? }
-        end
-
-        def to_h(reference_state)
-          serialize(reference_state)
-        end
-
-        module ClassMethods
-
-          # Infer avro_type_name based on class
-          def avro_type_name
-            @avro_type_name ||= name.split('::').last.sub('Type', '').downcase.to_sym
-          end
-        end
       end
     end
   end

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

@@ -16,14 +16,6 @@ module Avro
           end
         end
 
-        def serialize(reference_state)
-          super(reference_state, overrides: serialized_attributes)
-        end
-
-        def to_h(reference_state)
-          super(reference_state, overrides: serialized_attributes)
-        end
-
         def validate!
           super
           validate_required_attribute!(:symbols)
@@ -38,8 +30,8 @@ module Avro
           end
         end
 
-        def serialized_attributes
-          { symbols: symbols, doc: doc, default: default }
+        def serialized_attribute_hash(_reference_state)
+          super.merge(symbols: symbols, doc: doc, default: default)
         end
       end
     end

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

@@ -7,14 +7,6 @@ module Avro
 
         dsl_attributes :size, :precision, :scale
 
-        def serialize(reference_state)
-          super(reference_state, overrides: serialized_attributes)
-        end
-
-        def to_h(reference_state)
-          super(reference_state, overrides: serialized_attributes)
-        end
-
         def validate!
           super
           validate_required_attribute!(:size)
@@ -22,8 +14,8 @@ module Avro
 
         private
 
-        def serialized_attributes
-          { size: size, precision: precision, scale: scale }
+        def serialized_attribute_hash(_reference_state)
+          super.merge(size: size, precision: precision, scale: scale)
         end
       end
     end

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

@@ -3,8 +3,7 @@
 module Avro
   module Builder
     module Types
-      class MapType < Type
-        include Avro::Builder::Types::ComplexType
+      class MapType < ComplexType
         include Avro::Builder::Types::TypeReferencer
 
         dsl_attribute :values do |value_type = nil|
@@ -15,14 +14,15 @@ module Avro
           end
         end
 
-        def serialize(referenced_state)
-          super(referenced_state,
-                overrides: { values: values.serialize(referenced_state) })
-        end
-
         def validate!
           validate_required_attribute!(:values)
         end
+
+        private
+
+        def serialized_attribute_hash(reference_state)
+          super.merge(values: values.serialize(reference_state))
+        end
       end
     end
   end

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

@@ -10,8 +10,7 @@ module Avro
 
       # This is an abstract class that represents a type that can be defined
       # with a name, outside a record.
-      class NamedType < Type
-        include Avro::Builder::Types::ComplexType
+      class NamedType < ComplexType
         include Avro::Builder::Namespaceable
         include Avro::Builder::Aliasable
 
@@ -55,33 +54,30 @@ module Avro
         end
 
         # As a type for a field
-        # Subclasses may call super with additional overrides to be added
-        # to the serialized value.
-        def serialize(reference_state, overrides: {})
+        def serialize(reference_state)
+          # Return the full type definition if it hasn't been seen yet.
+          # Otherwise, just return its name.
           reference_state.definition_or_reference(fullname) do
-            serialized_attribute_hash.merge(overrides).reject { |_, v| v.nil? }
+            super
           end
         end
 
         # As a top-level, named type
-        # Subclasses may call super with additional overrides to be added
-        # to the hash representation.
-        def to_h(_reference_state, overrides: {})
-          serialized_attribute_hash
-            .merge(aliases: aliases)
-            .merge(overrides)
-            .reject { |_, v| v.nil? }
+        def to_h(reference_state)
+          # Always return the type definition. It's an error if the type has already been seen.
+          reference_state.definition(fullname) do
+            super
+          end
         end
 
         private
 
-        def serialized_attribute_hash
-          {
+        def serialized_attribute_hash(_reference_state)
+          super.merge(
             name: name,
-            type: avro_type_name,
             namespace: namespace,
-            logicalType: logical_type
-          }
+            aliases: aliases
+          )
         end
       end
     end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Avro
+  module Builder
+    module Types
+      # Subclass of Type for primitive Avro types (null, boolean, int, long,
+      # float, double, bytes, string).
+      class PrimitiveType < Type
+        def serialize(reference_state)
+          if logical_type
+            super
+          else
+            avro_type_name
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -13,14 +13,9 @@ module Avro
         dsl_attribute :doc
         dsl_attribute_alias :type_doc, :doc
 
-        def initialize(name = nil, cache:, options: {}, field: nil, &block) # rubocop:disable Lint/MissingSuper
-          # TODO: Fix missing call to super
-          @avro_type_name = :record
+        def initialize(name = nil, cache:, field: nil, &block)
+          super(cache: cache, field: field)
           @name = name
-          @cache = cache
-          @field = field
-
-          configure_options(options)
           instance_eval(&block) if block_given?
         end
 
@@ -34,7 +29,7 @@ module Avro
                                                avro_type_or_name: avro_type_or_name,
                                                record: self,
                                                cache: cache,
-                                               internal: { type_namespace: namespace },
+                                               optional: false,
                                                options: options,
                                                &block)
           add_field(new_field)
@@ -47,8 +42,7 @@ module Avro
                                                avro_type_or_name: avro_type_or_name,
                                                record: self,
                                                cache: cache,
-                                               internal: { type_namespace: namespace,
-                                                           optional_field: true },
+                                               optional: true,
                                                options: options,
                                                &block)
           add_field(new_field)
@@ -60,21 +54,6 @@ module Avro
           fields.merge!(cache.lookup_named_type(name, options.delete(:namespace) || namespace).duplicated_fields)
         end
 
-        def to_h(reference_state = SchemaSerializerReferenceState.new)
-          reference_state.definition_or_reference(fullname) do
-            {
-              type: :record,
-              name: name,
-              namespace: namespace,
-              doc: doc,
-              aliases: aliases,
-              logicalType: logical_type,
-              fields: fields.values.map { |field| field.serialize(reference_state) }
-            }.reject { |_, v| v.nil? }
-          end
-        end
-        alias_method :serialize, :to_h
-
         protected
 
         def duplicated_fields
@@ -86,6 +65,13 @@ module Avro
 
         private
 
+        def serialized_attribute_hash(reference_state)
+          super.merge(
+            doc: doc,
+            fields: fields.values.map { |field| field.serialize(reference_state) }
+          )
+        end
+
         # Add field, replacing any existing field with the same name.
         def add_field(field)
           fields[field.name] = field

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

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
+require 'avro/builder/metadata'
+
 module Avro
   module Builder
     module Types
-      # Base class for simple types. The type name is specified when the
-      # type is constructed. The type has no additional attributes, and
-      # the type is serialized as just the type name.
       class Type
         include Avro::Builder::DslOptions
         include Avro::Builder::DslAttributes
+        include Avro::Builder::Metadata
 
         dsl_attributes :logical_type, :abstract
 
@@ -24,16 +24,12 @@ module Avro
           !!abstract
         end
 
-        def serialize(_reference_state, overrides: {})
-          if logical_type
-            serialized_attributes_hash(overrides)
-          else
-            avro_type_name
-          end
+        def serialize(reference_state)
+          serialized_attribute_hash(reference_state).compact
         end
 
-        def to_h(_reference_state, overrides: {})
-          serialized_attributes_hash(overrides)
+        def to_h(reference_state)
+          serialized_attribute_hash(reference_state).compact
         end
 
         def namespace
@@ -42,7 +38,7 @@ module Avro
 
         def configure_options(options = {})
           options.each do |key, value|
-            send("#{key}=", value) if dsl_option?(key)
+            send("#{key}=", value)
           end
         end
 
@@ -74,10 +70,8 @@ module Avro
 
         private
 
-        def serialized_attributes_hash(overrides)
-          { type: avro_type_name, logicalType: logical_type }
-            .merge(overrides)
-            .reject { |_, v| v.nil? }
+        def serialized_attribute_hash(_reference_state)
+          extra_metadata.merge(type: avro_type_name, logicalType: logical_type)
         end
 
         def required_attribute_error!(attribute_name)

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

@@ -3,8 +3,7 @@
 module Avro
   module Builder
     module Types
-      class UnionType < Type
-        include Avro::Builder::Types::ComplexType
+      class UnionType < ComplexType
         include Avro::Builder::Types::TypeReferencer
 
         NULL_TYPE = 'null'
@@ -18,8 +17,12 @@ module Avro
         end
 
         # Unions are serialized as an array of types
-        def serialize(referenced_state)
-          types.map { |type| type.serialize(referenced_state) }
+        def serialize(reference_state)
+          types.map { |type| type.serialize(reference_state) }
+        end
+
+        def to_h(reference_state)
+          serialize(reference_state)
         end
 
         # serialized will be an array of types. If the array includes

data/lib/avro/builder/types.rb

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

data/lib/avro/builder/version.rb

@@ -2,6 +2,6 @@
 
 module Avro
   module Builder
-    VERSION = '2.1.0'
+    VERSION = '3.0.0'
   end
 end

data/lib/avro/builder.rb

@@ -26,6 +26,16 @@ module Avro
     def self.add_load_path(*paths)
       Avro::Builder::DSL.load_paths.merge(paths)
     end
+
+    # Define extra allowable metadata attributes for fields and types
+    def self.extra_metadata_attributes(*attrs)
+      Avro::Builder::Metadata.register(*attrs)
+    end
+
+    # Reset extra metadata attributes, removing all registered attributes
+    def self.reset_extra_metadata_attributes!
+      Avro::Builder::Metadata.reset!
+    end
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: avro-builder
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Salsify Engineering
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-08-05 00:00:00.000000000 Z
+date: 2026-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: avro
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.9.0
+        version: 1.11.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '1.13'
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.9.0
+        version: 1.11.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '1.13'
@@ -44,20 +44,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: json_spec
   requirement: !ruby/object:Gem::Requirement
@@ -92,28 +78,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.13'
 - !ruby/object:Gem::Dependency
   name: rspec-its
   requirement: !ruby/object:Gem::Requirement
@@ -148,14 +134,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.85.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.85.1
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -193,10 +179,8 @@ files:
 - avro-builder.gemspec
 - bin/console
 - bin/setup
-- gemfiles/avro_1.10.gemfile
 - gemfiles/avro_1.11.gemfile
 - gemfiles/avro_1.12.gemfile
-- gemfiles/avro_1.9.gemfile
 - lib/avro/builder.rb
 - lib/avro/builder/aliasable.rb
 - lib/avro/builder/anonymous_types.rb
@@ -209,6 +193,7 @@ files:
 - lib/avro/builder/field.rb
 - lib/avro/builder/file_handler.rb
 - lib/avro/builder/fixed.rb
+- lib/avro/builder/metadata.rb
 - lib/avro/builder/namespaceable.rb
 - lib/avro/builder/railtie.rb
 - lib/avro/builder/rake/avro_generate_task.rb
@@ -226,6 +211,7 @@ files:
 - lib/avro/builder/types/map_type.rb
 - lib/avro/builder/types/named_error_handling.rb
 - lib/avro/builder/types/named_type.rb
+- lib/avro/builder/types/primitive_type.rb
 - lib/avro/builder/types/record_type.rb
 - lib/avro/builder/types/top_level.rb
 - lib/avro/builder/types/type.rb
@@ -246,14 +232,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.5.22
 signing_key: 
 specification_version: 4
 summary: Ruby DSL to create Avro schemas

data/gemfiles/avro_1.10.gemfile

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

data/gemfiles/avro_1.9.gemfile

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