avromatic 0.9.0.rc1 → 0.9.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8850a5d6dce59c5dd91c2476b3b541ca6d258b94
-  data.tar.gz: eb4d4df178cf748408d7346251c7b0989eab7d8d
+  metadata.gz: 349bd4de9cfdaffd91c737ef6330d9b9d20ff8ed
+  data.tar.gz: cc1b8f6f5275cea982902ce4ae5d055e504a69a5
 SHA512:
-  metadata.gz: 7feeb97078619ec38b8092fde8f01d5f9f7e209f7040b9dd6252cc7766f7ac700da35681c9a95ca4ce1d88e6477f68e1bf41c09414fff3cd854e97c9cdb3707b
-  data.tar.gz: 3d2f3e5b0da52a97fcb5c555cda2eeda65767b4840e2ade715449e7a48df57c42a770d1ac8a56aadb45be8924e50aa060534e1c342f0bbc44c04c077573a3b29
+  metadata.gz: a1d4474e40c761995be5512600d9e84f6f743501b9f496901900686058cd4e5190c78712723125bf66d3e7a571cc786ea579fcc91021bcf35506a88f7ef69be7
+  data.tar.gz: 72e71deb56ff37c1f85a4c11b04d37f2672cc0d3b406ee574180257f690a6f7d057fe53250cfbd513610740120fe7e191d7d73970f7140be4c6b7b16d711c122

data/.rspec

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

data/.rubocop.yml

@@ -4,3 +4,6 @@ inherit_gem:
 AllCops:
   TargetRubyVersion: 2.2
 
+Style/MultilineBlockChain:
+  Enabled: false
+

data/CHANGELOG.md

@@ -1,7 +1,8 @@
 # avromatic changelog
 
 ## v0.9.0 (unreleased)
-- Add support for more than one non-null type in a union.
+- 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.
 
 ## v0.8.0

data/README.md

@@ -37,7 +37,11 @@ Or install it yourself as:
   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.
+
 #### Using a Schema Registry/Messaging API
  
 The configuration options below are required when using a schema registry 
@@ -109,6 +113,72 @@ constant:
 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 Virtus attributes
+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 replaced 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)
+```
+
+It is also possible to explicitly generate a nested model that should be reused
+and add it to the registry. This is useful when the nested model is extended:
+
+```ruby
+class UsefulSubrecord
+  include Avromatic::Model.build(schema_name: 'useful_subrecord')
+
+  def do_something_custom
+    ...
+  end
+end
+Avromatic.nested_models.register(UsefulSubrecord)
+```
+
+With Rails, it may be necessary to perform this explicit registration in an
+initializer so that lazy class loading works correctly in development.
+
 #### Custom Types
 
 Custom types can be configured for fields of named types (record, enum, fixed).

data/lib/avromatic.rb

@@ -1,16 +1,18 @@
 require 'avromatic/version'
 require 'avromatic/model'
+require 'avromatic/model_registry'
 require 'avro_turf'
 require 'avro_turf/messaging'
 
 module Avromatic
   class << self
     attr_accessor :schema_registry, :registry_url, :schema_store, :logger,
-                  :messaging, :type_registry
+                  :messaging, :type_registry, :nested_models
 
     delegate :register_type, to: :type_registry
   end
 
+  self.nested_models = ModelRegistry.new
   self.logger = Logger.new($stdout)
   self.type_registry = Avromatic::Model::TypeRegistry.new
 

data/lib/avromatic/model/attributes.rb

@@ -126,14 +126,7 @@ module Avromatic
           when :union
             union_field_class(field_type)
           when :record
-            # TODO: This should add the generated model to a module.
-            # A hash of generated models should be kept by name for reuse.
-            Avromatic::Model.model(schema: field_type).tap do |record_class|
-              # Register the generated model with Axiom to prevent it being
-              # treated as a BasicObject.
-              # See https://github.com/solnic/virtus/issues/284#issuecomment-56405137
-              Axiom::Types::Object.new { primitive(record_class) }
-            end
+            build_nested_model(field_type)
           else
             raise "Unsupported type #{field_type}"
           end

data/lib/avromatic/model/builder.rb

@@ -4,6 +4,7 @@ require 'active_model'
 require 'avromatic/model/configuration'
 require 'avromatic/model/value_object'
 require 'avromatic/model/configurable'
+require 'avromatic/model/nested_models'
 require 'avromatic/model/attribute/union'
 require 'avromatic/model/attributes'
 require 'avromatic/model/attribute/record'
@@ -42,6 +43,7 @@ module Avromatic
           ActiveModel::Validations,
           Virtus.value_object,
           Avromatic::Model::Configurable,
+          Avromatic::Model::NestedModels,
           Avromatic::Model::Attributes,
           Avromatic::Model::ValueObject,
           Avromatic::Model::RawSerialization,

data/lib/avromatic/model/configurable.rb

@@ -26,6 +26,10 @@ module Avromatic
           @key_avro_fields_by_name ||= mapped_by_name(key_avro_schema)
         end
 
+        def nested_models
+          config.nested_models || Avromatic.nested_models
+        end
+
         private
 
         def mapped_by_name(schema)

data/lib/avromatic/model/configuration.rb

@@ -4,7 +4,7 @@ module Avromatic
     # This class holds configuration for a model built from Avro schema(s).
     class Configuration
 
-      attr_reader :avro_schema, :key_avro_schema
+      attr_reader :avro_schema, :key_avro_schema, :nested_models
       delegate :schema_store, to: Avromatic
 
       # Either schema(_name) or value_schema(_name), but not both, must be
@@ -17,10 +17,12 @@ module Avromatic
       # @option options [String, Symbol] :value_schema_name
       # @option options [Avro::Schema] :key_schema
       # @option options [String, Symbol] :key_schema_name
+      # @option options [Avromatic::ModelRegistry] :nested_models
       def initialize(**options)
         @avro_schema = find_avro_schema(**options)
         raise ArgumentError.new('value_schema(_name) or schema(_name) must be specified') unless avro_schema
         @key_avro_schema = find_schema_by_option(:key_schema, **options)
+        @nested_models = options[:nested_models]
       end
 
       alias_method :value_avro_schema, :avro_schema
@@ -39,7 +41,6 @@ module Avromatic
         schema_name_option = :"#{option_name}_name"
         options[option_name] ||
           (options[schema_name_option] && schema_store.find(options[schema_name_option]))
-
       end
     end
   end

data/lib/avromatic/model/nested_models.rb

@@ -0,0 +1,29 @@
+require 'active_support/inflector/methods'
+
+module Avromatic
+  module Model
+    # This module handles integration with the ModelRegistry and support
+    # for nested model reuse.
+    module NestedModels
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        def build_nested_model(schema)
+          fullname = schema.fullname
+
+          if nested_models.registered?(fullname)
+            nested_models[fullname]
+          else
+            nested_model = Avromatic::Model.model(schema: schema,
+                                                  nested_models: nested_models)
+            # Register the generated model with Axiom to prevent it being
+            # treated as a BasicObject.
+            # See https://github.com/solnic/virtus/issues/284#issuecomment-56405137
+            Axiom::Types::Object.new { primitive(nested_model) }
+            nested_models.register(nested_model)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/avromatic/model/value_object.rb

@@ -1,6 +1,5 @@
 module Avromatic
   module Model
-
     # This module is used to override the comparisons defined by
     # Virtus::Equalizer which is pulled in by Virtus::ValueObject.
     module ValueObject

data/lib/avromatic/model_registry.rb

@@ -0,0 +1,45 @@
+require 'active_support/core_ext/string/access'
+
+module Avromatic
+  # The ModelRegistry class is used to store and fetch nested models by
+  # their fullname. An optional namespace prefix can be removed from the full
+  # name that is used to store and fetch models.
+  class ModelRegistry
+
+    def initialize(remove_namespace_prefix: nil)
+      @prefix = remove_namespace_prefix
+      @hash = Hash.new
+    end
+
+    def [](fullname)
+      @hash.fetch(fullname)
+    end
+
+    def register(model)
+      raise 'models with a key schema are not supported' if model.key_avro_schema
+      name = model.avro_schema.fullname
+      name = remove_prefix(name) if @prefix
+      @hash[name] = model
+    end
+
+    def registered?(fullname)
+      @hash.key?(fullname)
+    end
+
+    private
+
+    def remove_prefix(name)
+      value =
+        case @prefix
+        when String
+          name.from(@prefix.length) if name.start_with?(@prefix)
+        when Regexp
+          name.sub(@prefix, '')
+        else
+          raise "unsupported `remove_namespace_prefix` value: #{@prefix}"
+        end
+
+      value.start_with?('.') ? value.from(1) : value
+    end
+  end
+end

data/lib/avromatic/version.rb

@@ -1,3 +1,3 @@
 module Avromatic
-  VERSION = '0.9.0.rc1'.freeze
+  VERSION = '0.9.0.rc2'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: avromatic
 version: !ruby/object:Gem::Version
-  version: 0.9.0.rc1
+  version: 0.9.0.rc2
 platform: ruby
 authors:
 - Salsify Engineering
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-03 00:00:00.000000000 Z
+date: 2016-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: avro
@@ -257,11 +257,13 @@ files:
 - lib/avromatic/model/logical_types.rb
 - lib/avromatic/model/message_decoder.rb
 - lib/avromatic/model/messaging_serialization.rb
+- lib/avromatic/model/nested_models.rb
 - lib/avromatic/model/null_custom_type.rb
 - lib/avromatic/model/passthrough_serializer.rb
 - lib/avromatic/model/raw_serialization.rb
 - lib/avromatic/model/type_registry.rb
 - lib/avromatic/model/value_object.rb
+- lib/avromatic/model_registry.rb
 - lib/avromatic/railtie.rb
 - lib/avromatic/rspec.rb
 - lib/avromatic/version.rb