active_decorator 0.8.0 → 1.4.0

data/lib/active_decorator/helpers.rb

@@ -1,16 +1,30 @@
 # frozen_string_literal: true
+
+# On the fly delegation from the decorator to the decorated object and the helpers.
 module ActiveDecorator
   module Helpers
     def method_missing(method, *args, &block)
       super
-    rescue NoMethodError, NameError
-      begin
-        (view_context = ActiveDecorator::ViewContext.current).send method, *args, &block
-      rescue NoMethodError
-        raise NoMethodError, "undefined method `#{method}` for either #{self} or #{view_context}"
-      rescue NameError
-        raise NameError, "undefined local variable `#{method}` for either #{self} or #{view_context}"
+    rescue NoMethodError, NameError => e1
+      # the error is not mine, so just releases it as is.
+      raise e1 if e1.name != method
+
+      if (view_context = ActiveDecorator::ViewContext.current)
+        begin
+          view_context.send method, *args, &block
+        rescue NoMethodError => e2
+          raise e2 if e2.name != method
+
+          raise NoMethodError.new("undefined method `#{method}' for either #{self} or #{view_context}", method)
+        rescue NameError => e2
+          raise e2 if e2.name != method
+
+          raise NameError.new("undefined local variable `#{method}' for either #{self} or #{view_context}", method)
+        end
+      else  # AC::API would have not view_context
+        raise e1
       end
     end
+    ruby2_keywords :method_missing if respond_to?(:ruby2_keywords, true)
   end
 end

data/lib/active_decorator/monkey/abstract_controller/rendering.rb

@@ -1,4 +1,7 @@
 # frozen_string_literal: true
+
+# A monkey-patch for Rails controllers/mailers that auto-decorates ivars
+# that are passed to views.
 module ActiveDecorator
   module Monkey
     module AbstractController

data/lib/active_decorator/monkey/action_controller/base/rescue_from.rb

@@ -1,13 +1,16 @@
 # frozen_string_literal: true
+
+# A monkey-patch for Action Controller to pass the controller view_context over
+# to `render` invocation in `rescue_from` block.
 module ActiveDecorator
   module Monkey
     module ActionController
       module Base
         def rescue_with_handler(*)
-          ActiveDecorator::ViewContext.push(view_context)
+          ActiveDecorator::ViewContext.push(view_context) if defined?(view_context)
           super
         ensure
-          ActiveDecorator::ViewContext.pop
+          ActiveDecorator::ViewContext.pop if defined?(view_context)
         end
       end
     end

data/lib/active_decorator/monkey/action_view/collection_renderer.rb

@@ -0,0 +1,12 @@
+module ActiveDecorator
+  module Monkey
+    module ActionView
+      module CollectionRenderer
+        def render_collection_with_partial(collection, *)
+          ActiveDecorator::Decorator.instance.decorate collection
+          super
+        end
+      end
+    end
+  end
+end

data/lib/active_decorator/monkey/action_view/object_renderer.rb

@@ -0,0 +1,12 @@
+module ActiveDecorator
+  module Monkey
+    module ActionView
+      module ObjectRenderer
+        def render_object_with_partial(object, *)
+          ActiveDecorator::Decorator.instance.decorate object
+          super
+        end
+      end
+    end
+  end
+end

data/lib/active_decorator/monkey/action_view/partial_renderer.rb

@@ -1,20 +1,34 @@
 # frozen_string_literal: true
+
+# A monkey-patch for Action View `render :partial` that auto-decorates `locals` values.
 module ActiveDecorator
   module Monkey
     module ActionView
       module PartialRenderer
+        if Rails.version.to_f >= 6.1
+          def initialize(*)
+            super
+
+            @locals.each_value do |v|
+              ActiveDecorator::Decorator.instance.decorate v
+            end
+          end
+        end
+
         private
 
-        def setup(*)
-          super
+        if Rails.version.to_f < 6.1
+          def setup(*)
+            super
 
-          @locals.values.each do |v|
-            ActiveDecorator::Decorator.instance.decorate v
-          end if @locals
-          ActiveDecorator::Decorator.instance.decorate @object if @object && (@object != nil)
-          ActiveDecorator::Decorator.instance.decorate @collection unless @collection.blank?
+            @locals.each_value do |v|
+              ActiveDecorator::Decorator.instance.decorate v
+            end if @locals
+            ActiveDecorator::Decorator.instance.decorate @object if @object
+            ActiveDecorator::Decorator.instance.decorate @collection unless @collection.blank?
 
-          self
+            self
+          end
         end
       end
     end

data/lib/active_decorator/monkey/active_record/associations.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+# A monkey-patch for Active Record that enables association auto-decoration.
+module ActiveDecorator
+  module Monkey
+    module ActiveRecord
+      module Associations
+        module Association
+          def target
+            ActiveDecorator::Decorator.instance.decorate_association(owner, super)
+          end
+        end
+
+        if Rails.version.to_f < 5.1
+          module CollectionAssociation
+            private
+            def first_nth_or_last(*)
+              ActiveDecorator::Decorator.instance.decorate_association(owner, super)
+            end
+          end
+        end
+
+        module CollectionProxy
+          def take(*)
+            ActiveDecorator::Decorator.instance.decorate_association(@association.owner, super)
+          end
+
+          if Rails.version.to_f >= 5.1
+            def last(*)
+              ActiveDecorator::Decorator.instance.decorate_association(@association.owner, super)
+            end
+
+            private
+
+            def find_nth_with_limit(*)
+              ActiveDecorator::Decorator.instance.decorate_association(@association.owner, super)
+            end
+
+            def find_nth_from_last(*)
+              ActiveDecorator::Decorator.instance.decorate_association(@association.owner, super)
+            end
+          end
+        end
+
+        module CollectionAssociation
+          private
+
+          def build_record(*)
+            ActiveDecorator::Decorator.instance.decorate_association(@owner, super)
+          end
+        end
+      end
+
+      module AssociationRelation
+        def spawn(*)
+          ActiveDecorator::Decorator.instance.decorate_association(@association.owner, super)
+        end
+      end
+    end
+  end
+end

data/lib/active_decorator/railtie.rb

@@ -1,6 +1,4 @@
 # frozen_string_literal: true
-require 'active_decorator/view_context'
-require 'rails'
 
 module ActiveDecorator
   class Railtie < ::Rails::Railtie
@@ -8,6 +6,14 @@ module ActiveDecorator
       ActiveSupport.on_load :action_view do
         require 'active_decorator/monkey/action_view/partial_renderer'
         ActionView::PartialRenderer.send :prepend, ActiveDecorator::Monkey::ActionView::PartialRenderer
+
+        if Rails.version.to_f >= 6.1
+          require 'active_decorator/monkey/action_view/collection_renderer'
+          ActionView::CollectionRenderer.send :prepend, ActiveDecorator::Monkey::ActionView::CollectionRenderer
+
+          require 'active_decorator/monkey/action_view/object_renderer'
+          ActionView::ObjectRenderer.send :prepend, ActiveDecorator::Monkey::ActionView::ObjectRenderer
+        end
       end
 
       ActiveSupport.on_load :action_controller do
@@ -17,17 +23,45 @@ module ActiveDecorator
         require 'active_decorator/monkey/action_controller/base/rescue_from'
         ActionController::Base.send :prepend, ActiveDecorator::Monkey::ActionController::Base
 
+        require 'active_decorator/view_context'
         ActionController::Base.send :include, ActiveDecorator::ViewContext::Filter
       end
 
+      if Rails::VERSION::MAJOR >= 5
+        ActiveSupport.on_load :action_controller do
+          if self == ActionController::API
+            require 'active_decorator/monkey/abstract_controller/rendering'
+            ::ActionController::API.send :prepend, ActiveDecorator::Monkey::AbstractController::Rendering
+
+            require 'active_decorator/monkey/action_controller/base/rescue_from'
+            ::ActionController::API.send :prepend, ActiveDecorator::Monkey::ActionController::Base
+          end
+        end
+      end
+
       ActiveSupport.on_load :action_mailer do
         require 'active_decorator/monkey/abstract_controller/rendering'
         ActionMailer::Base.send :prepend, ActiveDecorator::Monkey::AbstractController::Rendering
 
         if ActionMailer::Base.respond_to? :before_action
+          require 'active_decorator/view_context'
           ActionMailer::Base.send :include, ActiveDecorator::ViewContext::Filter
         end
       end
+
+      ActiveSupport.on_load :active_record do
+        require 'active_decorator/monkey/active_record/associations'
+        ActiveRecord::Associations::Association.send :prepend, ActiveDecorator::Monkey::ActiveRecord::Associations::Association
+
+        if Rails.version.to_f < 5.1
+          ActiveRecord::Associations::CollectionAssociation.send :prepend, ActiveDecorator::Monkey::ActiveRecord::Associations::CollectionAssociation
+        end
+
+        ActiveRecord::AssociationRelation.send :prepend, ActiveDecorator::Monkey::ActiveRecord::AssociationRelation
+
+        ActiveRecord::Associations::CollectionProxy.send :prepend, ActiveDecorator::Monkey::ActiveRecord::Associations::CollectionProxy
+        ActiveRecord::Associations::CollectionAssociation.send :prepend, ActiveDecorator::Monkey::ActiveRecord::Associations::CollectionAssociation
+      end
     end
   end
 end

data/lib/active_decorator/version.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module ActiveDecorator
-  VERSION = '0.8.0'
+  VERSION = '1.4.0'
 end

data/lib/active_decorator/view_context.rb

@@ -1,18 +1,30 @@
 # frozen_string_literal: true
+
+# A module that carries the controllers' view_context to decorators.
 module ActiveDecorator
   module ViewContext
     class << self
       def current
-        Thread.current[:active_decorator_view_contexts].last
+        view_context_stack.last
       end
 
       def push(view_context)
-        Thread.current[:active_decorator_view_contexts] ||= []
-        Thread.current[:active_decorator_view_contexts] << view_context
+        view_context_stack.push view_context
       end
 
       def pop
-        Thread.current[:active_decorator_view_contexts].pop if Thread.current[:active_decorator_view_contexts]
+        view_context_stack.pop
+      end
+
+      def view_context_stack
+        Thread.current[:active_decorator_view_contexts] ||= []
+      end
+
+      def run_with(view_context)
+        push view_context
+        yield
+      ensure
+        pop
       end
     end
 
@@ -20,23 +32,9 @@ module ActiveDecorator
       extend ActiveSupport::Concern
 
       included do
-        if Rails::VERSION::MAJOR >= 4
-          around_action do |controller, blk|
-            begin
-              ActiveDecorator::ViewContext.push controller.view_context
-              blk.call
-            ensure
-              ActiveDecorator::ViewContext.pop
-            end
-          end
-        else
-          around_filter do |controller, blk|
-            begin
-              ActiveDecorator::ViewContext.push controller.view_context
-              blk.call
-            ensure
-              ActiveDecorator::ViewContext.pop
-            end
+        around_action do |controller, blk|
+          ActiveDecorator::ViewContext.run_with(controller.view_context) do
+            blk.call
           end
         end
       end

data/lib/active_decorator.rb

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
+
 require 'active_decorator/version'
 require 'active_decorator/decorator'
-require 'active_decorator/railtie'
+begin
+  require 'rails'
+  require 'active_decorator/railtie'
+rescue LoadError
+end
 require 'active_decorator/config'

data/lib/generators/rails/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Stubs out a decorator module in app/decorators directory.
+
+Examples:
+    `rails g decorator book`
+
+    This creates:
+        app/decorators/book_decorator.rb

data/lib/generators/rails/decorator_generator.rb

@@ -1,19 +1,10 @@
 # frozen_string_literal: true
+
 module Rails
   module Generators
-    class DecoratorGenerator < Rails::Generators::NamedBase
-      source_root File.expand_path('../templates', __FILE__)
-
-      desc <<DESC
-Description:
-    Stubs out a decorator module in app/decorators directory.
-
-Examples:
-    `rails g decorator book`
-
-    This creates:
-        app/decorators/book_decorator.rb
-DESC
+    class DecoratorGenerator < NamedBase
+      source_root File.expand_path("templates", __dir__)
+      check_class_collision suffix: "Decorator"
 
       def create_decorator_file
         template 'decorator.rb', File.join('app/decorators', class_path, "#{file_name}_decorator.rb")

data/lib/generators/rails/templates/decorator.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 module <%= class_name %>Decorator
 end

data/lib/generators/rspec/decorator_generator.rb

@@ -1,10 +1,13 @@
 # frozen_string_literal: true
+
 module Rspec
-  class DecoratorGenerator < ::Rails::Generators::NamedBase
-    source_root File.expand_path('../templates', __FILE__)
+  module Generators
+    class DecoratorGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path("templates", __dir__)
 
-    def create_spec_file
-      template 'decorator_spec.rb', File.join('spec/decorators', class_path, "#{file_name}_decorator_spec.rb")
+      def create_spec_file
+        template 'decorator_spec.rb', File.join('spec/decorators', class_path, "#{file_name}_decorator_spec.rb")
+      end
     end
   end
 end

data/lib/generators/rspec/templates/decorator_spec.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 require '<%= File.exists?('spec/rails_helper.rb') ? 'rails_helper' : 'spec_helper' %>'
 
-describe <%= singular_name.camelize %>Decorator do
-  let(:<%= singular_name %>) { <%= class_name %>.new.extend <%= singular_name.camelize %>Decorator }
+RSpec.describe <%= class_name %>Decorator do
+  let(:<%= singular_name %>) { <%= class_name %>.new.extend <%= class_name %>Decorator }
   subject { <%= singular_name %> }
   it { should be_a <%= class_name %> }
 end

data/lib/generators/test_unit/decorator_generator.rb

@@ -1,10 +1,14 @@
 # frozen_string_literal: true
+
 module TestUnit
-  class DecoratorGenerator < ::Rails::Generators::NamedBase
-    source_root File.expand_path('../templates', __FILE__)
+  module Generators
+    class DecoratorGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path("templates", __dir__)
+      check_class_collision suffix: "DecoratorTest"
 
-    def create_test_file
-      template 'decorator_test.rb', File.join('test/decorators', class_path, "#{file_name}_decorator_test.rb")
+      def create_test_file
+        template 'decorator_test.rb', File.join('test/decorators', class_path, "#{file_name}_decorator_test.rb")
+      end
     end
   end
 end

data/lib/generators/test_unit/templates/decorator_test.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
-class <%= singular_name.camelize %>DecoratorTest < ActiveSupport::TestCase
+class <%= class_name %>DecoratorTest < ActiveSupport::TestCase
   def setup
-    @<%= singular_name %> = <%= class_name %>.new.extend <%= singular_name.camelize %>Decorator
+    @<%= singular_name %> = <%= class_name %>.new.extend <%= class_name %>Decorator
   end
 
   # test "the truth" do