avromatic 4.1.1 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7bec6621c5d35e04596185542eaa4d96d00ef67f86f24b26378c68b22ecb3b3c
-  data.tar.gz: 1468ebd3138c5dc63a5d18d86dab5757df5c67109867628d1161b01ef70db1f3
+  metadata.gz: 5d9619909ed1f1301168536a2907146f30da67a08dd2bb4377d7cb0aa6cb4b6f
+  data.tar.gz: 3ff48eef3f8880fbd2f36eeda17008723be7bdc269a5546f432e1f5e6c09635d
 SHA512:
-  metadata.gz: da43c835a7f56011c1ed194bba7a02e5f98a190f65a8ce025b67f8a23d9a43093e2e64f83cdaf520d847c37ecf66cfd6ed276aee7f195a9f3f2b0c248967f5bf
-  data.tar.gz: 920048102d5947af69eca3d4e4c357adf9eefaebbd83e8d70190d29a6fb8d30c65072c97fda65613d9ebed32e127f98d9f4952e1e91e081963e61a480a002af3
+  metadata.gz: 61cc46b27e9544faea7b411f5f10676d206c0504fabb69f2ebf0ad00b7d6adc0610973c4c27a6716ca1e7676c6436f4be8eb1c8298978fe7b4ece5c8910fe6ae
+  data.tar.gz: 5ec19a93b881b723589b5f8afdaf1a0e41b15d601ca2ab840f8c627f74db3eeeab21b678c396840675caae75a3a92ccf97b872ea355cb94b2850e58d22179e12

data/lib/avromatic/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Avromatic
-  VERSION = '4.1.1'
+  VERSION = '4.2.0'
 end

data/lib/avromatic.rb

@@ -79,7 +79,11 @@ module Avromatic
   end
 
   def self.eager_load_models=(models)
-    @eager_load_model_names = Array(models).map { |model| model.is_a?(Class) ? model.name : model }
+    @eager_load_model_names = Array(models).map { |model| model.is_a?(Class) ? model.name : model }.freeze
+  end
+
+  def self.eager_load_models
+    @eager_load_model_names
   end
 
   def self.eager_load_models!

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: avromatic
 version: !ruby/object:Gem::Version
-  version: 4.1.1
+  version: 4.2.0
 platform: ruby
 authors:
 - Salsify Engineering
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-09-26 00:00:00.000000000 Z
+date: 2022-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -273,30 +273,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".circleci/config.yml"
-- ".github/CODEOWNERS"
-- ".gitignore"
-- ".overcommit.yml"
-- ".rspec"
-- ".rubocop.yml"
-- ".ruby-gemset"
-- ".ruby-version"
-- Appraisals
-- CHANGELOG.md
-- Gemfile
 - LICENSE.txt
-- README.md
-- Rakefile
-- avromatic.gemspec
 - bin/console
 - bin/setup
-- gemfiles/.bundle/config
-- gemfiles/avro1_10_rails5_2.gemfile
-- gemfiles/avro1_10_rails6_0.gemfile
-- gemfiles/avro1_10_rails6_1.gemfile
-- gemfiles/avro1_10_rails7_0.gemfile
-- gemfiles/avro1_11_rails6_1.gemfile
-- gemfiles/avro1_11_rails7_0.gemfile
 - lib/avromatic.rb
 - lib/avromatic/io.rb
 - lib/avromatic/io/datum_reader.rb
@@ -342,7 +321,6 @@ files:
 - lib/avromatic/railtie.rb
 - lib/avromatic/rspec.rb
 - lib/avromatic/version.rb
-- log/.gitkeep
 homepage: https://github.com/salsify/avromatic.git
 licenses:
 - MIT

data/.circleci/config.yml

@@ -1,88 +0,0 @@
-version: 2.1
-jobs:
-  lint:
-    docker:
-      - image: salsify/ruby_ci:2.7.4
-    working_directory: ~/avromatic
-    steps:
-      - checkout
-      - restore_cache:
-          keys:
-            - v2-gems-ruby-2.7.4-{{ checksum "avromatic.gemspec" }}-{{ checksum "Gemfile" }}
-            - v2-gems-ruby-2.7.4-
-      - 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.7.4-{{ checksum "avromatic.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: ~/avromatic
-    steps:
-      - checkout
-      - restore_cache:
-          keys:
-            - v2-gems-ruby-<< parameters.ruby-version >>-{{ checksum "avromatic.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 "avromatic.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/avro1_10_rails5_2.gemfile"
-              - "gemfiles/avro1_10_rails6_0.gemfile"
-              - "gemfiles/avro1_10_rails6_1.gemfile"
-              - "gemfiles/avro1_10_rails7_0.gemfile"
-              - "gemfiles/avro1_11_rails7_0.gemfile"
-              ruby-version:
-              - "2.7.4"
-      - test:
-          matrix:
-            parameters:
-              gemfile:
-                - "gemfiles/avro1_10_rails6_1.gemfile"
-                - "gemfiles/avro1_10_rails7_0.gemfile"
-                - "gemfiles/avro1_11_rails7_0.gemfile"
-              ruby-version:
-                - "3.0.3"
-                - "3.1.0"

data/.github/CODEOWNERS

@@ -1 +0,0 @@
-* @jturkel @tjwp @salsify/infrastructure-services

data/.gitignore

@@ -1,14 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-/gemfiles/*.lock
-/log/*
-
-*.iml
-.idea

data/.overcommit.yml

@@ -1,14 +0,0 @@
-PreCommit:
-  RuboCop:
-    enabled: true
-    required: false
-    on_warn: fail
-
-  HardTabs:
-    enabled: true
-    required: false
-
-CommitMsg:
-  TrailingPeriod:
-    enabled: false
-

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.rubocop.yml

@@ -1,17 +0,0 @@
-inherit_gem:
-  salsify_rubocop: conf/rubocop.yml
-
-AllCops:
-  TargetRubyVersion: 2.7
-  Exclude:
-    - 'vendor/**/*'
-    - 'gemfiles/**/*'
-
-Style/MultilineBlockChain:
-  Enabled: false
-
-Style/NumericPredicate:
-  Enabled: false
-
-Style/FrozenStringLiteralComment:
-  Enabled: true

data/.ruby-gemset

@@ -1 +0,0 @@
-avromatic

data/.ruby-version

@@ -1 +0,0 @@
-2.7.4

data/Appraisals

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-appraise 'avro1_10-rails5_2' do
-  gem 'avro', '~> 1.10.0'
-  gem 'activesupport', '~> 5.2.0'
-  gem 'activemodel', '~> 5.2.0'
-end
-
-appraise 'avro1_10-rails6_0' do
-  gem 'avro', '~> 1.10.0'
-  gem 'activesupport', '~> 6.0.0'
-  gem 'activemodel', '~> 6.0.0'
-end
-
-appraise 'avro1_10-rails6_1' do
-  gem 'avro', '~> 1.10.0'
-  gem 'activesupport', '~> 6.1.0'
-  gem 'activemodel', '~> 6.1.0'
-end
-
-appraise 'avro1_10-rails7_0' do
-  gem 'avro', '~> 1.10.0'
-  gem 'activesupport', '~> 7.0.0'
-  gem 'activemodel', '~> 7.0.0'
-end
-
-appraise 'avro1_11-rails6_1' do
-  gem 'avro', '~> 1.11.0'
-  gem 'activesupport', '~> 6.1.0'
-  gem 'activemodel', '~> 6.1.0'
-end
-
-appraise 'avro1_11-rails7_0' do
-  gem 'avro', '~> 1.11.0'
-  gem 'activesupport', '~> 7.0.0'
-  gem 'activemodel', '~> 7.0.0'
-end

data/CHANGELOG.md

@@ -1,275 +0,0 @@
-# avromatic changelog
-
-## 4.1.1
-- Fix eager loading of nested models when using the Zeitwerk classloader with Rails.
-
-## 4.1.0
-- Add support for specifying a subject for the avro schema when building an Avromatic model
-
-## 4.0.0
-- Drop support for Ruby 2.6.
-- Drop support for Avro 1.9.
-- Add support for Avro 1.11.
-- Add support for Rails 7.0.
-
-## 3.0.2
-- Reset the schema registry client between RSpec tests to ensure any cached values are
-  consistent with the fake schema registry.
-
-## 3.0.1
-- Raise an error when registering a nested model that has already been auto-generated.
-  This avoids hard to troubleshoot coercion errors when instantiating models and fixes 
-  a regression introduced in Avromatic 2.2.2.
-
-## 3.0.0
-- Drop support for Ruby 2.4.
-- Add support for Ruby 3.0.
-- Drop support for Avro < 1.9.
-- Drop support for Rails < 5.2.
-- Fix decoding of unions containing false boolean values.
-
-## v2.4.0
-- Ignore the `validate` argument and always validate during serialization. This
-  argument will be removed in Avromatic 3.0.
-- Optimize model validation during serialization.
-- Don't cache immutable model validation results or serialized Avro attributes if a model has mutable children.
-
-## v2.3.0
-- Add support for Rails 6.1.
-- Optimize nested model serialization.
-
-## v2.2.6
-- Optimize memory usage when serializing models.
-
-## v2.2.5
-- Optimize memory usage when serializing, deserializing and instantiating models.
-
-## v2.2.4
-- Compatibility with Avro v1.10.x.
-
-## v2.2.3
-- Fix bug where method `#referenced_model_classes` was declared as private instead of public.
-
-## v2.2.2
-- Fix missing models in the model registry when in development by loading the nested models of eager loaded models.
-- Fake schema registry support for stubbing URLs with usernames and passwords.
-
-## v2.2.1
-- Avoid allocating default empty hash in `Avromatic::IO::DatumReader.read_data`
-
-## v2.2.0
-- Add support for Rails 6.0.
-- Drop support for Ruby < 2.4.
-
-## v2.1.0
-- Add `key_schema_name` and `value_schema_name` attributes to `UnexpectedKeyError`.
-
-## v2.0.2
-- Optimize model initialization and decoding
-
-## v2.0.1
-- Allow generated model attribute accessors to be overridden. This was a regression in Avromatic 2.0.0.
-- Ensure that timestamp-millis are coerced when the number of microseconds is divisible by 1,000 but the
-  number of nanoseconds is not divisible by 1,000,000.
-
-## v2.0.0
-- Remove [virtus](https://github.com/solnic/virtus) dependency resulting in a 3x performance improvement in model instantation and 1.4x - 2.0x performance improvement in Avro serialization and Avromatic code simplification.
-- Raise `Avromatic::Model::CoercionError` when attribute values can't be coerced to the target type in model constructors and attribute setters. Previously coercion errors weren't detected until Avro serialization or an explicit call to `valid?`.
-- Prevent model instances from being constructed with unknown attributes. Previously unknown attributes were ignored. 
-  This can be disabled by setting `Avromatic.allow_unknown_attributes` to `true`.
-  WARNING: Setting `Avromatic.allow_unknown_attributes` to `true` will result in incorrect union member coercions 
-  if an earlier union member is satisfied by a subset of the latter union member's attributes.
-- Validate required attributes are present when serializing to Avro for better error messages. Explicit 
-  validation can still be done by calling the `valid?` or `invalid?` methods from the 
-  [ActiveModel::Validations](https://edgeapi.rubyonrails.org/classes/ActiveModel/Validations.html) interface
-  but errors will now appear under the `:base` key. Previously these errors were detected late in the Avro serialization process resulting in hard to understand error messages. 
-- Support for custom types in unions with more than one non-null type.
-- Drop support for Ruby < 2.3 and Rails < 5.0.
-- Call `super()` in model constructor making it easier to define class/module hierarchies for models.
-
-## v1.0.0
-- No changes.
-
-## v0.33.0
-- Fix compatibility with avro-patches v0.4.0.
-
-## v0.32.0
-- Improve partial assignment using a hash for records outside of unions.
-- Prevent invalid types from being assigned to primitives in unions.
-- Add validation that primitive attributes have the expected type.
-
-## v0.31.0
-- Add support for Rails 5.2.
-
-## v0.30.0
-- Add `Avromatic::Model::MessageDecoder#model` method to return the Avromatic
-  model class for a message.
-
-## v0.29.1
-- Add `Avromatic.build_messaging!` to `avromatic/rspec`.
-
-## v0.29.0
-- Add new public methods `#avro_key_datum` and `#avro_value_datum` on an
-  Avromatic model instance that return the attributes of the model suitable for
-  Avro encoding without any customizations.
-
-## v0.28.1
-- Fix a bug that raised an error when encoding a cached model containing optional
-  field(s). With this change, immutable model caching now enabled only when 
-  `avro-patches` is present.
-
-## v0.28.0
-- Add support for caching avro encodings for immutable models
-
-## v0.27.0
-- Patches avromatic model classes to cache `Virtus::ValueObject::AllowedWriterMethods#allowed_writer_methods`
-- Support Rails 5.1
-
-## v0.26.0
-- Caches result of Avromatic::Model::RawSerialization#value_attributes_for_avro for immutable models
-
-## v0.25.0
-- Disallow optional fields in schemas used for keys by default.
-
-## v0.24.0
-- Add `Avromatic::IO::DatumWriter` to optimize the encoding of Avro unions
-  from Avromatic models.
-- Expose the `#key_attributes_for_avro` method on models.
-
-## v0.23.0
-- Add mutable option when defining a model.
-
-## v0.22.0
-- Require `avro_schema_registry_client` v0.3.0 or later to avoid
-  using `avro-salsify-fork`.
-
-## v0.21.1
-- Fix a bug in the optimization of optional union decoding.
-
-## v0.21.0
-- Remove monkey-patches for `AvroTurf::ConfluentSchemaRegistry` and
-  `FakeConfluentSchemaRegistryServer` and depend on `avro_schema_registry-client`
-  instead.
-- Rename the configuration option `use_cacheable_schema_registration` to
-  `use_schema_fingerprint_lookup`.
-
-## v0.20.0
-- Support schema stores with a `#clear_schemas` method.
-
-## v0.19.0
-- Use a fingerprint based on `avro-resolution_canonical_form`.
-
-## v0.18.1
-- Replace another reference to `avromatic/test/fake_schema_registry_server`.
-
-## v0.18.0
-- Compatibility with `avro_turf` v0.8.0. `avromatic/test/fake_schema_registry_server`
-  is now deprecated and will be removed in a future release.
-  Use `avromatic/test/fake_confluent_schema_registry_server` instead.
-
-## v0.17.1
-- Correctly namespace Avro errors raised by `Avromatic::IO::DatumReader`.
-
-## v0.17.0
-- Add `.register_schemas!` method to generated models to register the associated
-  schemas in a schema registry.
-
-## v0.16.0
-- Add `#lookup_subject_schema` method to `AvroTurf::SchemaRegistry` patch to
-  directly support looking up existing schema ids by fingerprint.
-
-## v0.15.1
-- Add `Avromatic.use_cacheable_schema_registration` option to control the lookup
-  of existing schema ids by fingerprint.
-
-## v0.15.0
-- Add patch to `AvroTurf::SchemaRegistry` to lookup existing schema ids using
-  `GET /subjects/:subject/fingerprints/:fingerprint` from `#register`.
-  This endpoint is supported in the avro-schema-registry.
-- Add patch to the `FakeSchemaRegistryServer` from `AvroTurf` to support the
-  fingerprint endpoint.
-
-## v0.14.0
-- Add `Avromatic::Messaging` and `Avromatic::IO::DatumReader` classes to
-  optimize the decoding of Avro unions to Avromatic models.
-
-## v0.13.0
-- Add interfaces to deserialize as a hash of attributes instead of a model.
-
-## v0.12.0
-- Clear the schema store, if it supports it, prior to code reloading in Rails
-  applications. This allows schema changes to be picked up during code
-  reloading.
-
-## v0.11.2
-- Fix for models containing optional array and map fields.
-
-## v0.11.1
-- Another fix for Rails initialization and reloading. Do not clear the nested
-  models registry the first time that the `to_prepare` hook is called.
-
-## v0.11.0
-- Replace `Avromatic.on_initialize` proc with `Avromatic.eager_load_models`
-  array. The models listed by this configuration are added to the registry
-  at the end of `.configure` and prior to code reloading in Rails applications.
-  This is a compatibility breaking change.
-
-## v0.10.0
-- Add `Avromatic.on_initialize` proc that is called at the end of `.configure`
-  and on code reloading in Rails applications.
-
-## v0.9.0
-- Experimental: Add support for more than one non-null type in a union.
-- Allow nested models to be referenced and reused.
-- Fix the serialization of nested complex types.
-- Add support for recursive models.
-- Allow required array and map fields to be empty. Only nil values for required
-  array and map fields are now considered invalid.
-- Validate nested models. This includes models embedded within other complex
-  types (array, map, and union).
-- Truncate values for timestamps to the precision supported by the logical type.
-
-## v0.8.0
-- Add support for logical types. Currently this requires using the
-  `avro-salsify-fork` gem for logical types support with Ruby.
-
-## v0.7.1
-- Raise a more descriptive error when attempting to generate a model for a
-  non-record Avro type.
-
-## v0.7.0
-- Add RSpec `FakeSchemaRegistryServer` test helper.
-
-## v0.6.2
-- Remove dependency on `Hash#transform_values` from `ActiveSupport` v4.2.
-
-## v0.6.1
-- Fix serialization of array and map types that contain nested models.
-
-## v0.6.0
-- Require `avro_turf` v0.7.0 or later.
-
-## v0.5.0
-- Rename `Avromatic::Model::Decoder` to `MessageDecoder`.
-- Rename `.deserialize` on generated models to `.avro_message_decode`.
-- Add `#avro_raw_key`, `#avro_raw_value` and `.avro_raw_decode` methods to
-  generated models to support encoding and decoding without a schema registry.
-
-## v0.4.0
-- Allow the specification of a custom type, including conversion to/from Avro,
-  for named types.
-
-## v0.3.0
-- Remove dependency on the `private_attr` gem.
-
-## v0.2.0
-- Allow a module level schema registry to be configured.
-
-## v0.1.2
-- Do not build an `AvroTurf::Messaging` object for each model class.
-
-## v0.1.1
-- Fix Railtie.
-
-## v0.1.0
-- Initial release

data/Gemfile

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in avromatic.gemspec
-gemspec

data/README.md

@@ -1,477 +0,0 @@
-# Avromatic
-
-[![Build Status](https://circleci.com/gh/salsify/avromatic.svg?style=svg)][circleci]
-[![Gem Version](https://badge.fury.io/rb/avromatic.svg)](https://badge.fury.io/rb/avromatic)
-
-[circleci]: https://circleci.com/gh/salsify/avromatic
-
-`Avromatic` generates Ruby models from [Avro](http://avro.apache.org/) schemas
-and provides utilities to encode and decode them.
-
-**This README reflects Avromatic 2.0. Please see the 
-[1-0-stable](https://github.com/salsify/avromatic/blob/1-0-stable/README.md) branch for Avromatic 1.0.**
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'avromatic'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install avromatic
-
-See the [Logical Types](#logical-types) section below for details on using
-Avromatic with unreleased Avro features.
-
-## Usage
-
-### Configuration
-
-`Avromatic` supports the following configuration:
-
-#### Model Generation
-
-* **schema_store**: A schema store is required to load Avro schemas from the filesystem.
-  It should be an object that responds to `find(name, namespace = nil)` and
-  returns an `Avro::Schema` object. An `AvroTurf::SchemaStore` can be used.
-  The `schema_store` is unnecessary if models are generated directly from 
-  `Avro::Schema` objects. See [Models](#models).
-* **nested_models**: An optional [ModelRegistry](https://github.com/salsify/avromatic/blob/master/lib/avromatic/model_registry.rb)
-  that is used to store, by full schema name, the generated models that are
-  embedded within top-level models. By default a new `Avromatic::ModelRegistry`
-  is created.
-* **eager_load_models**: An optional array of models, or strings with class
-  names for models, that are added to `nested_models` at the end of
-  `Avromatic.configure` and during code reloading in Rails applications. This
-  option is useful for defining models that will be extended when the load order
-  is important.
-* **allow_unknown_attributes**: Optionally allow model constructors to silently
-  ignore unknown attributes. Defaults to `false`. WARNING: Setting this to `true` 
-  will result in incorrect union member coercions if an earlier union member is 
-  satisfied by a subset of the latter union member's attributes.
-
-#### Custom Types
-
-See the section below on configuring [Custom Types](#custom-type-configuration).
-
-#### Using a Schema Registry/Messaging API
- 
-The configuration options below are required when using a schema registry 
-(see [Confluent Schema Registry](http://docs.confluent.io/2.0.1/schema-registry/docs/intro.html))
-and the [Messaging API](#messaging-api).
-  
-* **schema_registry**: An `AvroSchemaRegistry::Client` or
-  `AvroTurf::ConfluentSchemaRegistry` object used to store Avro schemas
-  so that they can be referenced by id. Either `schema_registry` or
-  `registry_url` must be configured.
-* **registry_url**: URL for the schema registry. Either `schema_registry` or 
-  `registry_url` must be configured.  The `build_schema_registry!` method may 
-  be used to create a caching schema registry client instance based on other 
-  configuration values.
-* **use_schema_fingerprint_lookup**: Avromatic supports a Schema Registry
-  [extension](https://github.com/salsify/avro-schema-registry#extensions) that
-  provides an endpoint to lookup existing schema ids by fingerprint.
-  A successful response from this GET request can be cached indefinitely.
-  The use of this additional endpoint can be disabled by setting this option to
-  `false` and this is recommended if using a Schema Registry that does not support
-  the endpoint.
-* **messaging**: An `AvroTurf::Messaging` object to be shared by all generated models
-  The `build_messaging!` method may be used to create a `Avromatic::Messaging`
-  instance based on the other configuration values.
-* **logger**: The logger to use for the schema registry client.
-
-Example using a schema registry:
-
-```ruby
-Avromatic.configure do |config|
-  config.schema_store = AvroTurf::SchemaStore.new(path: 'avro/schemas')
-  config.registry_url = Rails.configuration.x.avro_schema_registry_url
-  config.build_schema_registry!
-  config.build_messaging!
-end
-```
-
-#### Decoding
-
-* **use_custom_datum_reader**: `Avromatic` includes a modified subclass of
-  `Avro::IO::DatumReader`. This subclass returns additional information about
-  the index of union members when decoding Avro messages. This information is
-  used to optimize model creation when decoding. By default this information
-  is included in the hash returned by the `DatumReader` but can be omitted by
-  setting this option to `false`.
-
-#### Encoding
-* **use_custom_datum_writer**: `Avromatic` includes a modified subclass of
-  `Avro::IO::DatumWriter`. This subclass supports caching avro encodings for 
-  immutable models and uses additional information about the index of union 
-  members to optimize the encoding of Avro messages. By default this 
-  information is included in the hash passed to the encoder but can be omitted
-  by setting this option to `false`.
-
-
-### Models
-
-Models are defined based on an Avro schema for a record.
-
-The Avro schema can be specified by name and loaded using the schema store:
-
-```ruby
-class MyModel
-  include Avromatic::Model.build(schema_name: :my_model)
-end
-
-# Construct instances by passing in a hash of attributes
-instance = MyModel.new(id: 123, name: 'Tesla Model 3', enabled: true)
-
-# Access attribute values with readers
-instance.name # => "Tesla Model 3"
-
-# Models are immutable by default
-instance.name = 'Tesla Model X' # => NoMethodError (private method `name=' called for #<MyModel:0x00007ff711e64e60>) 
-
-# Booleans can also be accessed by '?' readers that coerce nil to false
-instance.enabled? # => true
-
-# Models implement ===, eql? and hash
-instance == MyModel.new(id: 123, name: 'Tesla Model 3', enabled: true) # => true
-instance.eql?(MyModel.new(id: 123, name: 'Tesla Model 3', enabled: true)) # => true
-instance.hash # => -1279155042741869898
-
-# Retrieve a hash of the model's attributes via to_h, to_hash or attributes
-instance.to_h # => {:id=>123, :name=>"Tesla Model 3", :enabled=>true}
-```
-
-Or an `Avro::Schema` object can be specified directly:
-
-```ruby
-class MyModel
-  include Avromatic::Model.build(schema: schema_object)
-end
-```
-
-A specific subject name can be associated with the schema:
-```ruby
-class MyModel
-  include Avromatic::Model.build(schema_name: 'my_model',
-                                 schema_subject: 'my_model-value')
-end
-```
-
-Models are generated as immutable value
-objects by default, but can optionally be defined as mutable:
-
-```ruby
-class MyModel
-  include Avromatic::Model.build(schema_name: :my_model, mutable: true)
-end
-```
-
-Generated models include attributes for each field in the Avro schema
-including any default values defined in the schema.
-
-A model may be defined with both a key and a value schema:
-
-```ruby
-class MyTopic
-  include Avromatic::Model.build(value_schema_name: :topic_value,
-                                 key_schema_name: :topic_key)
-end
-```
-
-When key and value schemas are both specified, attributes are added to the model
-for the union of the fields in the two schemas.
-
-By default, optional fields are not allowed in key schemas since their values may
-be accidentally omitted leading to problems if data is partitioned based on the
-key values.
-
-This behavior can be overridden by specifying the `:allow_optional_key_fields`
-option for the model:
-
-```ruby
-class MyTopic
-  include Avromatic::Model.build(value_schema_name: :topic_value,
-                                 key_schema_name: :topic_key,
-                                 allow_optional_key_fields: true)
-end
-```
-
-A specific subject name can be associated with both the value and key schemas:
-```ruby
-class MyTopic
-  include Avromatic::Model.build(value_schema_name: :topic_value,
-                                 value_schema_subject: 'topic_value-value',
-                                 key_schema_name: :topic_key,
-                                 key_schema_subject: 'topic_key-value')
-end
-```
-
-A model can also be generated as an anonymous class that can be assigned to a
-constant:
-
-```ruby
-MyModel = Avromatic::Model.model(schema_name :my_model)
-```
-
-#### Experimental: Union Support
-
-Avromatic contains experimental support for unions containing more than one
-non-null member type. This feature is experimental because Avromatic
-may attempt to coerce between types too aggressively.
-
-For now, if a union contains [nested models](#nested-models) then it is
-recommended that you assign model instances.
-
-Some combination of the ordering of member types in the union and relying on
-model validation may be required so that the correct member is selected,
-especially when deserializing from Avro.
-
-In the future, the type coercion used in the gem will be enhanced to better
-support the union use case.
-
-#### Nested Models
-
-Nested models are models that are embedded within top-level models generated
-using Avromatic. Normally these nested models are automatically generated.
-
-By default, nested models are stored in `Avromatic.nested_models`. This is an
-`Avromatic::ModelRegistry` instance that provides access to previously generated
-nested models by the full name of their Avro schema.
-
-```ruby
-Avromatic.nested_models['com.my_company.test.example']
-#=> <model class>
-```
-
-The `ModelRegistry` can be customized to remove a namespace prefix:
-
-```ruby
-Avromatic.nested_models =
-  Avromatic::ModelRegistry.new(remove_namespace_prefix: 'com.my_company')
-```
-
-The `:remove_namespace_prefix` value can be a string or a regexp.
-
-By default, top-level generated models reuse `Avromatic.nested_models`. This
-allows nested models to be shared across different generated models.
-A `:nested_models` option can be specified when generating a model. This allows
-the reuse of nested models to be scoped:
-
-```ruby
-Avromatic::Model.model(schema_name, :my_model
-                       nested_models: ModelRegistry.new)
-```
-
-Only models without a key schema can be used as nested models. When a model is
-generated with just a value schema then it is automatically registered so that
-it can be used as a nested model.
-
-To extend a model that will be used as a nested model, you must ensure that it
-is defined, which will register it, prior it being referenced by another model.
-
-Using the `Avromatic.eager_load_models` option allows models that are extended
-and will be used as nested models to be defined at the end of the `.configure`
-block. In Rails applications, these models are also re-registered after
-`nested_models` is cleared when code reloads to ensure that classes load in the
-correct order:
-
-```ruby
-Avromatic.configure do |config|
-  config.eager_load_models = [
-    # reference any extended models that should be defined first
-    'MyNestedModel'
-  ]
-end
-```
-
-#### Custom Type Configuration
-
-Custom types can be configured for fields of named types (record, enum, fixed).
-These customizations are registered on the `Avromatic` module. Once a custom type
-is registered, it is used for all models with a schema that references that type.
-It is recommended to register types within a block passed to `Avromatic.configure`:
-
-```ruby
-Avromatic.configure do |config|
-  config.register_type('com.example.my_string', MyString)
-end
-```
-
-The full name of the type and an optional class may be specified. When a class is
-provided then values for attributes of that type are defined using the specified 
-class.
-
-If the provided class responds to the class methods `from_avro` and `to_avro`
-then those methods are used to convert values when assigning to the model and 
-before encoding using Avro respectively.
-
-`from_avro` and `to_avro` methods may be also be specified as Procs when 
-registering the type:
-
-```ruby
-Avromatic.configure do |config|
-  config.register_type('com.example.updown_string') do |type|
-    type.from_avro = ->(value) { value.upcase }
-    type.to_avro = ->(value) { value.downcase }
-  end
-end
-```
-
-Nil handling is not required as the conversion methods are not be called if the
-inbound or outbound value is nil.
-
-If a custom type is registered for a record-type field, then any `to_avro` 
-method/Proc should return a Hash with string keys for encoding using Avro.
-
-### Encoding and Decoding
-
-`Avromatic` provides two different interfaces for encoding the key (optional)
-and value associated with a model.
-
-#### Manually Managed Schemas
-
-The attributes for the value schema used to define a model can be encoded using:
-
-```ruby
-encoded_value = model.avro_raw_value
-```
-
-In order to decode this data, a copy of the value schema is required.
-
-If a model also has an Avro schema for a key, then the key attributes can be
-encoded using:
-
-```ruby
-encoded_key = model.avro_raw_key
-```
-
-If attributes were encoded using the same schema(s) used to define a model, then
-the data can be decoded to create a new model instance:
-
-```ruby
-MyModel.avro_raw_decode(key: encoded_key, value: encoded_value)
-```
-
-If the attributes where encoded using a different version of the model's schemas,
-then a new model instance can be created by also providing the schemas used to 
-encode the data:
-
-```ruby
-MyModel.avro_raw_decode(key: encoded_key,
-                        key_schema: writers_key_schema,
-                        value: encoded_value,
-                        value_schema: writers_value_schema)
-```
-
-#### Messaging API
-
-The other interface for encoding and decoding attributes uses the
-`AvroTurf::Messaging` API. This interface leverages a schema registry and
-prefixes the encoded data with an id to identify the schema. In this approach,
-a schema registry is used to ensure that the correct schemas are available during
-decoding.
-
-The attributes for the value schema can be encoded with a schema id prefix using:
-
-```ruby
-message_value = model.avro_message_value
-```
-
-If a model has an Avro schema for a key, then those attributes can also be encoded
-prefixed with a schema id:
-
-```ruby
-message_key = model.avro_message_key
-```
-
-A model instance can be created from a key and value encoded in this manner:
-
-```ruby
-MyTopic.avro_message_decode(message_key, message_value)
-```
-
-Or just a value if only one schema is used:
-
-```ruby
-MyValue.avro_message_decode(message_value)
-```
-
-The schemas associated with a model can also be added to a schema registry without
-encoding a message:
-
-```ruby
-MyTopic.register_schemas!
-```
-
-#### Avromatic::Model::MessageDecoder
-
-A stream of messages encoded from various models using the messaging approach
-can be decoded using `Avromatic::Model::MessageDecoder`. The decoder must be 
-initialized with the list of models to decode:
-
-```ruby
-decoder = Avromatic::Model::MessageDecoder.new(MyModel1, MyModel2)
-
-decoder.decode(model1_messge_key, model1_message_value)
-# => instance of MyModel1
-decoder.decode(model2_message_value)
-# => instance of MyModel2
-```
-
-### Validations and Coercions
-
-An exception will be thrown if an attribute value cannot be coerced to the corresponding Avro schema field's type.
-The following coercions are supported:
-
-| Ruby Type | Avro Type |
-| --------- | --------- |
-| String, Symbol | string |
-| Array | array |
-| Hash | map |
-| Integer, Float | int |
-| Integer | long |
-| Float | float |
-| Float | double |
-| String | bytes |
-| Date, Time, DateTime | date |
-| Time, DateTime | timestamp-millis |
-| Time, DateTime | timestamp-micros |
-| TrueClass, FalseClass | boolean |
-| NilClass | null |
-| Hash | record |
-
-Validation of required fields is done automatically when serializing a model to Avro. It can also be done
-explicitly by calling the `valid?` or `invalid?` methods from the 
-[ActiveModel::Validations](https://edgeapi.rubyonrails.org/classes/ActiveModel/Validations.html) interface.
-
-### RSpec Support
-
-This gem also includes an `"avromatic/rspec"` file that can be required to support
-using Avromatic with a fake schema registry during tests.
-
-Requiring this file configures a RSpec before hook that directs any schema
-registry requests to a fake, in-memory schema registry and rebuilds the
-`Avromatic::Messaging` object for each example.
-
-## 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.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/salsify/avromatic.
-
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/Rakefile

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-require 'appraisal/task'
-require 'avro/builder'
-
-RSpec::Core::RakeTask.new(:default_spec)
-
-Appraisal::Task.new
-
-if !ENV['APPRAISAL_INITIALIZED']
-  task default: :appraisal
-  task spec: :appraisal
-else
-  task default: :default_spec
-end
-
-namespace :avro do
-  desc 'Generate Avro schema files used by specs'
-  task :generate_spec do
-    root = 'spec/avro/dsl'
-    Avro::Builder.add_load_path(root)
-    Dir["#{root}/**/*.rb"].each do |dsl_file|
-      puts "Generating Avro schema from #{dsl_file}"
-      output_file = dsl_file.sub('/dsl/', '/schema/').sub(/\.rb$/, '.avsc')
-      schema = Avro::Builder.build(File.read(dsl_file))
-      FileUtils.mkdir_p(File.dirname(output_file))
-      File.write(output_file, schema.end_with?("\n") ? schema : schema << "\n")
-    end
-  end
-end

data/avromatic.gemspec

@@ -1,53 +0,0 @@
-# frozen_string_literal: true
-
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'avromatic/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'avromatic'
-  spec.version       = Avromatic::VERSION
-  spec.authors       = ['Salsify Engineering']
-  spec.email         = ['engineering@salsify.com']
-
-  spec.summary       = 'Generate Ruby models from Avro schemas'
-  spec.description   = spec.summary
-  spec.homepage      = 'https://github.com/salsify/avromatic.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.metadata['rubygems_mfa_required'] = 'true'
-
-  spec.required_ruby_version = '>= 2.7'
-
-  spec.add_runtime_dependency 'activemodel', '>= 5.2', '< 7.1'
-  spec.add_runtime_dependency 'activesupport', '>= 5.2', '< 7.1'
-  spec.add_runtime_dependency 'avro', '>= 1.10.0', '< 1.12'
-  spec.add_runtime_dependency 'avro_schema_registry-client', '>= 0.4.0'
-  spec.add_runtime_dependency 'avro_turf'
-  spec.add_runtime_dependency 'ice_nine'
-
-  spec.add_development_dependency 'appraisal'
-  spec.add_development_dependency 'avro-builder', '>= 0.12.0'
-  spec.add_development_dependency 'bundler', '~> 2.0'
-  spec.add_development_dependency 'overcommit', '0.35.0'
-  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.27.1'
-  spec.add_development_dependency 'simplecov'
-  spec.add_development_dependency 'webmock'
-  # For AvroSchemaRegistry::FakeServer
-  spec.add_development_dependency 'sinatra'
-end

data/gemfiles/.bundle/config

@@ -1,2 +0,0 @@
----
-BUNDLE_RETRY: "1"

data/gemfiles/avro1_10_rails5_2.gemfile

@@ -1,9 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "avro", "~> 1.10.0"
-gem "activesupport", "~> 5.2.0"
-gem "activemodel", "~> 5.2.0"
-
-gemspec path: "../"

data/gemfiles/avro1_10_rails6_0.gemfile

@@ -1,9 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "avro", "~> 1.10.0"
-gem "activesupport", "~> 6.0.0"
-gem "activemodel", "~> 6.0.0"
-
-gemspec path: "../"

data/gemfiles/avro1_10_rails6_1.gemfile

@@ -1,9 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "avro", "~> 1.10.0"
-gem "activesupport", "~> 6.1.0"
-gem "activemodel", "~> 6.1.0"
-
-gemspec path: "../"

data/gemfiles/avro1_10_rails7_0.gemfile

@@ -1,9 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "avro", "~> 1.10.0"
-gem "activesupport", "~> 7.0.0"
-gem "activemodel", "~> 7.0.0"
-
-gemspec path: "../"

data/gemfiles/avro1_11_rails6_1.gemfile

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

data/gemfiles/avro1_11_rails7_0.gemfile

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