activesupport-decorators 0.0.2 → 0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3fb383abd0973a741056c00121c60e933b56807f
-  data.tar.gz: 906175dbe61580b85a60e64a7f5ebd502e638a59
+  metadata.gz: ec2236b08c2f672564e38201de862f16d36077b3
+  data.tar.gz: a0d82c89cd824d7699eafc8114d6ad5aa28b9483
 SHA512:
-  metadata.gz: 57d948191c62ccadd8d08e0bdd569e8426d2eacbf161bd0b8abb27136a39498c930e58bb39044a062dcfd676e786a32fece3e5f4742aa687cfe4afeb9a29760d
-  data.tar.gz: 02ebb658116b83151734bbdbdaa2a87afddb539fbd5220ed08871e6225393a1edfe3a7e31b0d62b26054aad95c4ea1ed66c2cbd07e204839c7496e9343f0ba37
+  metadata.gz: 0cf349af37ab49b04a3963a0e439dadbe008494ad8aad5f2b1d344959594153811d8c52d304e69cf2118675a73383d591517d342a86a7a939c49f93553090299
+  data.tar.gz: 19691a0734337d8c0ff8cebe4b027be8b2154e7c55dc6d36c11d285393e87fc3ca1d0aac48ceb950b5b0299a6635133f0a7fb42d829ba8fe8fd9a280cf0f82ae

data/README.md

@@ -6,7 +6,7 @@ the decorator pattern, you need to load the decorator after the original file ha
 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.
+This is a tiny gem that provides you with a simple way to specify load dependencies.
 
 Example
 =======
@@ -27,14 +27,14 @@ class Pet
 end
 ```
 
-You can tell ActiveSupportDecorators to load any matching file in my_engine/app/models when a file is loaded from
+Now 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|
+      initializer :decorator_dependencies do |app|
         ActiveSupportDecorators.add_dependency("#{app.root}/app/models", "#{config.root}/app/models")
       end
     end
@@ -42,4 +42,13 @@ module MyEngine
 end
 ```
 
-Note that you could specify the path as "/app" to decorate controllers, models, helpers, etc.
+Note that you could specify the path as "/app" to allow decorating controllers, models, helpers, etc.
+
+Debugging
+=========
+
+Need to know which decorator files are loaded?  Enable debug output:
+
+```Ruby
+ActiveSupportDecorators.debug = true
+```

data/lib/active_support_decorators/active_support_decorators.rb

@@ -1,3 +1,5 @@
+require 'active_support_decorators/graph'
+
 module ActiveSupportDecorators
   def self.dependencies
     @dependencies ||= {}
@@ -20,8 +22,10 @@ module ActiveSupportDecorators
   end
 
   def self.load_path_order(file_name)
-    file_name_order = [file_name]
+    graph = Graph.new
+    graph.add(file_name)
 
+    # If an attempt is made to load the original file, ensure the decorators are loaded afterwards.
     dependencies.each do |path, decorator_paths|
       if file_name.starts_with?(path)
         relative_name = file_name.gsub(path, '')
@@ -30,13 +34,24 @@ module ActiveSupportDecorators
           decorator_file = "#{decorator_path}#{relative_name}"
 
           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
+            graph.add_dependency(file_name, decorator_file)
+          end
+        end
+      end
+
+      # If an attempt is made to load a decorator file, ensure the original file is loaded first.
+      decorator_paths.each do |decorator_path|
+        if file_name.starts_with?(decorator_path)
+          relative_name = file_name.gsub(decorator_path, '')
+          decorated_file = "#{path}#{relative_name}"
+
+          if File.file?(decorated_file) || File.file?(decorated_file + '.rb')
+            graph.add_dependency(decorated_file, file_name)
           end
         end
       end
     end
 
-    file_name_order
+    graph.resolve_object_order
   end
 end

data/lib/active_support_decorators/dependencies_patch.rb

@@ -4,7 +4,13 @@ module ActiveSupport::Dependencies
   alias_method :require_or_load_without_multiple, :require_or_load
 
   def require_or_load(file_name, const_path = nil)
-    ActiveSupportDecorators.load_path_order(file_name).each do |path|
+    order = ActiveSupportDecorators.load_path_order(file_name)
+
+    if ActiveSupportDecorators.debug && order.size > 1
+      Rails.try(:logger).try(:debug, "ActiveSupportDecorators: Loading files in order #{order.join(', ')}.")
+    end
+
+    order.each do |path|
       require_or_load_without_multiple(path, const_path)
     end
   end

data/lib/active_support_decorators/graph.rb

@@ -0,0 +1,48 @@
+class Graph
+  Node = Struct.new(:object) do
+    def depends_on
+      @depends_on ||= []
+    end
+  end
+
+  def initialize
+    @nodes = []
+  end
+
+  def resolve_object_order
+    result = []
+
+    until @nodes.empty?
+      nodes_without_dependencies = @nodes.select { |n| n.depends_on.empty? }
+      result += nodes_without_dependencies.map { |n| n.object }.sort
+
+      nodes_without_dependencies.each do |to_delete|
+        @nodes.delete(to_delete)
+        @nodes.each { |n| n.depends_on.delete(to_delete) }
+      end
+    end
+
+    result
+  end
+
+  def add(object)
+    find_or_add_node(object)
+  end
+
+  def add_dependency(from_object, to_object)
+    raise 'Objects are identical' if from_object == to_object
+    from_node = find_or_add_node(from_object)
+    to_node = find_or_add_node(to_object)
+    to_node.depends_on << from_node
+    raise 'EMPTY' if from_node.nil?
+  end
+
+  def find_or_add_node(object)
+    node = @nodes.find { |n| n.object == object }
+    unless node
+      node = Node.new(object)
+      @nodes.push(node)
+    end
+    node
+  end
+end

data/lib/active_support_decorators/version.rb

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

data/lib/activesupport-decorators.rb

@@ -1,2 +1,2 @@
+require 'active_support_decorators/active_support_decorators'
 require 'active_support_decorators/dependencies_patch'
-require 'active_support_decorators/active_support_decorators'

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: activesupport-decorators
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: '0.9'
 platform: ruby
 authors:
 - Pierre Pretorius
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-18 00:00:00.000000000 Z
+date: 2014-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
 description: Useful when extending functionality with Rails engines.
@@ -31,12 +31,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
+- Rakefile
 - lib/active_support_decorators/active_support_decorators.rb
 - lib/active_support_decorators/dependencies_patch.rb
+- lib/active_support_decorators/graph.rb
 - lib/active_support_decorators/version.rb
 - lib/activesupport-decorators.rb
-- Rakefile
-- README.md
 homepage: https://github.com/pierre-pretorius/activesupport-decorators
 licenses:
 - MIT
@@ -47,19 +48,18 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.2
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: Adds the decorator pattern to activesupport class loading.
 test_files: []
-has_rdoc: