activesupport-decorators 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a22f99e79b704ddf3d114c4e995ec75790a96a79
-  data.tar.gz: da8b53bd8f8ed6ce86d96e71cfb0ea06fcd81e36
+  metadata.gz: 3fb383abd0973a741056c00121c60e933b56807f
+  data.tar.gz: 906175dbe61580b85a60e64a7f5ebd502e638a59
 SHA512:
-  metadata.gz: ef3fbcc96854c5a9505edd6bcd3636765693450193d2a993fedfc9ac89f438b2f6d1d775d51fdcf1dbbdd3eb3f37ed37bbe68ac6df29cc6e41a9c72d8a574808
-  data.tar.gz: 1924715f6dd6bdfb13a69b146b38095fb62fef5f022c8e421b8005555414a110a1352dba79660c519698d87b634d1e365e2f75134b16c29c9b805627557339f0
+  metadata.gz: 57d948191c62ccadd8d08e0bdd569e8426d2eacbf161bd0b8abb27136a39498c930e58bb39044a062dcfd676e786a32fece3e5f4742aa687cfe4afeb9a29760d
+  data.tar.gz: 02ebb658116b83151734bbdbdaa2a87afddb539fbd5220ed08871e6225393a1edfe3a7e31b0d62b26054aad95c4ea1ed66c2cbd07e204839c7496e9343f0ba37

data/README.md

@@ -1,4 +1,45 @@
 ActiveSupportDecorators
 =======================
 
-Adds the decorator pattern to activesupport class loading.
+The decorator pattern is particularly useful when extending constants in rails engines or vica versa.  To implement
+the decorator pattern, you need to load the decorator after the original file has been loaded.  When you reference a
+class in a Rails application, ActiveSupport will only load the first file it finds that matches the class name.  This
+means that you will need to manually load the additional (decorator) file.  Usually you don't want to want to introduce
+hard dependencies such as require statements.  You also don't want to preload a bunch of classes in a Rails initializer.
+This gem allows you to specify load dependencies without loading any of them when the application starts up.
+
+Example
+=======
+
+Lets say your main rails application defines a model called Pet (in app/models/pet.rb):
+
+```Ruby
+class Pet < ActiveRecord::Base
+end
+```
+
+Your rails engine adds the concept of pet owners to the application.  You can extend the Pet model in the engine with
+the following model decorator (in my_engine/app/models/pet.rb).
+
+```Ruby
+class Pet
+  belongs_to :owner
+end
+```
+
+You can tell ActiveSupportDecorators to load any matching file in my_engine/app/models when a file is loaded from
+app/models.  A convenient place to do this is in a Rails initializer in the engine:
+
+```Ruby
+module MyEngine
+  module Rails
+    class Engine < ::Rails::Engine
+      initializer :append_auto_decorators do |app|
+        ActiveSupportDecorators.add_dependency("#{app.root}/app/models", "#{config.root}/app/models")
+      end
+    end
+  end
+end
+```
+
+Note that you could specify the path as "/app" to decorate controllers, models, helpers, etc.

data/lib/active_support_decorators/active_support_decorators.rb

@@ -1,30 +1,38 @@
 module ActiveSupportDecorators
-  def self.auto_decorate_paths=(path_array)
-    @auto_decorate_paths = path_array
+  def self.dependencies
+    @dependencies ||= {}
   end
 
-  def self.auto_decorate_paths
-    @auto_decorate_paths ||= []
+  def self.add_dependency(path, decorator_path)
+    if dependencies.include?(path)
+      dependencies[path] << decorator_path
+    else
+      dependencies[path] = [decorator_path]
+    end
   end
 
-  def self.auto_decorate_provider_paths=(path_array)
-    @auto_decorate_provider_paths = path_array
+  def self.debug
+    @debug ||= false
   end
 
-  def self.auto_decorate_provider_paths
-    @auto_decorate_provider_paths ||= []
+  def self.debug=(debugging_enabled)
+    @debug = debugging_enabled
   end
 
   def self.load_path_order(file_name)
     file_name_order = [file_name]
 
-    if auto_decorate_paths.any? { |path| file_name.starts_with?(path) }
-      relative_name = file_name.gsub(Rails.root.to_s, '')
+    dependencies.each do |path, decorator_paths|
+      if file_name.starts_with?(path)
+        relative_name = file_name.gsub(path, '')
+
+        decorator_paths.each do |decorator_path|
+          decorator_file = "#{decorator_path}#{relative_name}"
 
-      auto_decorate_provider_paths.each do |path|
-        decorator_file = "#{path}#{relative_name}"
-        if File.file?(decorator_file) || File.file?(decorator_file + '.rb')
-          file_name_order << decorator_file
+          if File.file?(decorator_file) || File.file?(decorator_file + '.rb')
+            Rails.logger.debug "ActiveSupportDecorators: Loading '#{decorator_file}' after '#{file_name}'." if debug
+            file_name_order << decorator_file
+          end
         end
       end
     end

data/lib/active_support_decorators/version.rb

@@ -1,3 +1,3 @@
 module ActiveSupportDecorators
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activesupport-decorators
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Pierre Pretorius