avromatic 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3edc684e5b6a637fa71fa717b8ea30e6503cc0a5
-  data.tar.gz: 1e32d812904379da626158fbb27b486a3a3eb465
+  metadata.gz: ce7da1b2c3c2ec8741eba98e50a294aa8db18bb1
+  data.tar.gz: 688813aeb07b275550fda92b30cc97f339ddf142
 SHA512:
-  metadata.gz: 5c08d19c73780f6421126098c325852db05a828905ea2fb4f87c71fe4ffdf83460a373c67430ddf71a21d138f655f899d87dde3891adcc2e03d45ead4f1dde1a
-  data.tar.gz: bd398cea6c28603b3975c8f893d67f8362154c061ed8105c29bb2d625e71332ad51fda763f89b613ceb476ce2e8104d2c9f5331e32163187112c13c41a95abdb
+  metadata.gz: 18c3b5f0a4aa093e9ed2868722f103fcd780361c417ab1a72b5f7e5a6a5c94b658e4100bfd42bbcf14fd30a2d6c0d9a154ee9bb8de4e5823a6ea4d76487d072a
+  data.tar.gz: 0988f486a37745ddf3e46d027d3b9976665807804c3f0355d05e99ceefa73abdeab881e6bab109f65220c60ee698d944017f9b487931fe75c5e19d6e7a60a9d0

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # avromatic changelog
 
+## 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.

data/README.md

@@ -41,10 +41,11 @@ Or install it yourself as:
   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.
-* **on_initialize**: An optional Proc that runs at the end of
+* **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.
+  option is useful for defining models that will be extended when the load order
+  is important.
 
 #### Using a Schema Registry/Messaging API
  
@@ -173,18 +174,18 @@ 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.on_initialize` 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, this Proc will also be executed after
+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.on_initialize do
+  config.eager_load_models = [
     # reference any extended models that should be defined first
     MyNestedModel
-  end
+  ]
 end
 
 #### Custom Types

data/lib/avromatic/model/attributes.rb

@@ -21,6 +21,8 @@ module Avromatic
 
       module ClassMethods
         def add_avro_fields
+          # models are registered in Avromatic.nested_models at this point to
+          # ensure that they are available as fields for recursive models.
           register!
 
           if key_avro_schema

data/lib/avromatic/model_registry.rb

@@ -18,11 +18,11 @@ module Avromatic
     def [](fullname)
       @hash.fetch(fullname)
     end
+    alias_method :fetch, :[]
 
     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)
+      name = model_fullname(model)
       raise "'#{name}' has already been registered" if registered?(name)
       @hash[name] = model
     end
@@ -31,6 +31,22 @@ module Avromatic
       @hash.key?(fullname)
     end
 
+    def model_fullname(model)
+      name = model.avro_schema.fullname
+      remove_prefix(name)
+    end
+
+    def ensure_registered_model(model)
+      name = model_fullname(model)
+      if registered?(name)
+        unless fetch(name).equal?(model)
+          raise "attempted to replace existing model #{fetch(name)} with new model #{model} as '#{name}'"
+        end
+      else
+        register(model)
+      end
+    end
+
     def remove_prefix(name)
       return name if @prefix.nil?
 

data/lib/avromatic/version.rb

@@ -1,3 +1,3 @@
 module Avromatic
-  VERSION = '0.10.0'.freeze
+  VERSION = '0.11.0'.freeze
 end

data/lib/avromatic.rb

@@ -3,11 +3,12 @@ require 'avromatic/model'
 require 'avromatic/model_registry'
 require 'avro_turf'
 require 'avro_turf/messaging'
+require 'active_support/core_ext/string/inflections'
 
 module Avromatic
   class << self
     attr_accessor :schema_registry, :registry_url, :schema_store, :logger,
-                  :messaging, :type_registry, :nested_models, :on_initialize
+                  :messaging, :type_registry, :nested_models
 
     delegate :register_type, to: :type_registry
   end
@@ -18,7 +19,7 @@ module Avromatic
 
   def self.configure
     yield self
-    on_initialize.call if on_initialize
+    eager_load_models!
   end
 
   def self.build_schema_registry
@@ -41,10 +42,23 @@ module Avromatic
     self.messaging = build_messaging
   end
 
+  # This method is called as a Rails to_prepare block after the application
+  # first initializes and prior to each code reloading.
   def self.prepare!
     nested_models.clear
-    on_initialize.call if on_initialize
+    eager_load_models!
   end
+
+  def self.eager_load_models=(models)
+    @eager_load_model_names = Array(models).map { |model| model.is_a?(Class) ? model.name : model }
+  end
+
+  def self.eager_load_models!
+    (@eager_load_model_names || []).each do |model_name|
+      nested_models.ensure_registered_model(model_name.constantize)
+    end
+  end
+  private_class_method :eager_load_models!
 end
 
 require 'avromatic/railtie' if defined?(Rails)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: avromatic
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Salsify Engineering
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-05 00:00:00.000000000 Z
+date: 2016-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: avro