draper 2.1.0 → 3.0.0

data/lib/draper/compatibility/api_only.rb

@@ -0,0 +1,23 @@
+module Draper
+  module Compatibility
+    # Draper expects your `ApplicationController` to include `ActionView::Rendering`. The
+    # `ApplicationController` generated by Rails 5 API-only applications (created with
+    # `rails new --api`) don't by default. However, including `ActionView::Rendering` in
+    # `ApplicatonController` breaks `render :json` due to `render_to_body` being overridden.
+    #
+    # This compatibility patch fixes the issue by restoring the original `render_to_body`
+    # method after including `ActionView::Rendering`. Ultimately, including `ActionView::Rendering`
+    # in an ActionController::API may not be supported functionality by Rails (see Rails issue
+    # for more detail: https://github.com/rails/rails/issues/27211). This hack is meant to be a
+    # temporary solution until we can find a way to not rely on the controller layer.
+    module ApiOnly
+      extend ActiveSupport::Concern
+
+      included do
+        alias :previous_render_to_body :render_to_body
+        include ActionView::Rendering
+        alias :render_to_body :previous_render_to_body
+      end
+    end
+  end
+end

data/lib/draper/configuration.rb

@@ -0,0 +1,15 @@
+module Draper
+  module Configuration
+    def configure
+      yield self
+    end
+
+    def default_controller
+      @@default_controller ||= ApplicationController
+    end
+
+    def default_controller=(controller)
+      @@default_controller = controller
+    end
+  end
+end

data/lib/draper/decoratable.rb

@@ -56,8 +56,7 @@ module Draper
       # @param [Hash] options
       #   see {Decorator.decorate_collection}.
       def decorate(options = {})
-        collection = Rails::VERSION::MAJOR >= 4 ? all : scoped
-        decorator_class.decorate_collection(collection, options.reverse_merge(with: nil))
+        decorator_class.decorate_collection(all, options.reverse_merge(with: nil))
       end
 
       def decorator_class?
@@ -75,10 +74,10 @@ module Draper
         decorator_name = "#{prefix}Decorator"
         decorator_name.constantize
       rescue NameError => error
+        raise unless error.missing_name?(decorator_name)
         if superclass.respond_to?(:decorator_class)
           superclass.decorator_class
         else
-          raise unless error.missing_name?(decorator_name)
           raise Draper::UninferrableDecoratorError.new(self)
         end
       end
@@ -87,7 +86,7 @@ module Draper
       #
       # @return [Boolean]
       def ===(other)
-        super || (other.respond_to?(:object) && super(other.object))
+        super || (other.is_a?(Draper::Decorator) && super(other.object))
       end
 
     end

data/lib/draper/decorator.rb

@@ -10,8 +10,6 @@ module Draper
     # @return the object being decorated.
     attr_reader :object
     alias_method :model, :object
-    alias_method :source, :object # TODO: deprecate this
-    alias_method :to_source, :object # TODO: deprecate this
 
     # @return [Hash] extra data to be used in user-defined methods.
     attr_accessor :context
@@ -72,15 +70,10 @@ module Draper
     # Checks whether this decorator class has a corresponding {object_class}.
     def self.object_class?
       object_class
-    rescue Draper::UninferrableSourceError
+    rescue Draper::UninferrableObjectError
       false
     end
 
-    class << self # TODO deprecate this
-      alias_method :source_class, :object_class
-      alias_method :source_class?, :object_class?
-    end
-
     # Automatically decorates ActiveRecord finder methods, so that you can use
     # `ProductDecorator.find(id)` instead of
     # `ProductDecorator.decorate(Product.find(id))`.
@@ -182,7 +175,7 @@ module Draper
 
     # Returns a unique hash for a decorated object based on
     # the decorator class and the object being decorated.
-    # 
+    #
     # @return [Fixnum]
     def hash
       self.class.hash ^ object.hash
@@ -203,18 +196,6 @@ module Draper
       super || object.instance_of?(klass)
     end
 
-    if RUBY_VERSION < "2.0"
-      # nasty hack to stop 1.9.x using the delegated `to_s` in `inspect`
-      alias_method :_to_s, :to_s
-
-      def inspect
-        ivars = instance_variables.map do |name|
-          "#{name}=#{instance_variable_get(name).inspect}"
-        end
-        _to_s.insert(-2, " #{ivars.join(", ")}")
-      end
-    end
-
     delegate :to_s
 
     # In case object is nil
@@ -242,8 +223,7 @@ module Draper
     def self.collection_decorator_class
       name = collection_decorator_name
       name.constantize
-    rescue NameError => error
-      raise if name && !error.missing_name?(name)
+    rescue NameError
       Draper::CollectionDecorator
     end
 
@@ -268,7 +248,7 @@ module Draper
       name.constantize
     rescue NameError => error
       raise if name && !error.missing_name?(name)
-      raise Draper::UninferrableSourceError.new(self)
+      raise Draper::UninferrableObjectError.new(self)
     end
 
     def self.collection_decorator_name

data/lib/draper/helper_proxy.rb

@@ -4,9 +4,7 @@ module Draper
   class HelperProxy
 
     # @overload initialize(view_context)
-    def initialize(view_context = nil)
-      view_context ||= current_view_context # backwards compatibility
-
+    def initialize(view_context)
       @view_context = view_context
     end
 
@@ -35,10 +33,5 @@ module Draper
         view_context.send(name, *args, &block)
       end
     end
-
-    def current_view_context
-      ActiveSupport::Deprecation.warn("wrong number of arguments (0 for 1) passed to Draper::HelperProxy.new", caller[1..-1])
-      Draper::ViewContext.current.view_context
-    end
   end
 end

data/lib/draper/railtie.rb

@@ -3,8 +3,6 @@ require 'rails/railtie'
 module ActiveModel
   class Railtie < Rails::Railtie
     generators do |app|
-      app ||= Rails.application # Rails 3.0.x does not yield `app`
-
       Rails::Generators.configure! app.config.generators
       require_relative '../generators/controller_override'
     end
@@ -13,7 +11,6 @@ end
 
 module Draper
   class Railtie < Rails::Railtie
-
     config.after_initialize do |app|
       app.config.paths.add 'app/decorators', eager_load: true
 
@@ -23,19 +20,19 @@ module Draper
       end
     end
 
-    initializer "draper.setup_action_controller" do |app|
+    initializer 'draper.setup_action_controller' do
       ActiveSupport.on_load :action_controller do
         Draper.setup_action_controller self
       end
     end
 
-    initializer "draper.setup_action_mailer" do |app|
+    initializer 'draper.setup_action_mailer' do
       ActiveSupport.on_load :action_mailer do
         Draper.setup_action_mailer self
       end
     end
 
-    initializer "draper.setup_orm" do |app|
+    initializer 'draper.setup_orm' do
       [:active_record, :mongoid].each do |orm|
         ActiveSupport.on_load orm do
           Draper.setup_orm self
@@ -43,28 +40,22 @@ module Draper
       end
     end
 
-    initializer "draper.setup_active_model_serializers" do |app|
-      ActiveSupport.on_load :active_model_serializers do
-        if defined?(ActiveModel::ArraySerializerSupport)
-          Draper::CollectionDecorator.send :include, ActiveModel::ArraySerializerSupport
-        end
-      end
-    end
-
-    initializer "draper.minitest-rails_integration" do |app|
+    initializer 'draper.minitest-rails_integration' do
       ActiveSupport.on_load :minitest do
-        require "draper/test/minitest_integration"
+        require 'draper/test/minitest_integration'
       end
     end
 
-    console do
+    def initialize_view_context
       require 'action_controller/test_case'
-      ApplicationController.new.view_context
+      Draper.default_controller.new.view_context
       Draper::ViewContext.build
     end
 
-    rake_tasks do
-      Dir[File.join(File.dirname(__FILE__),'tasks/*.rake')].each { |f| load f }
-    end
+    console { initialize_view_context }
+
+    runner { initialize_view_context }
+
+    rake_tasks { Dir[File.join(File.dirname(__FILE__), 'tasks/*.rake')].each { |f| load f } }
   end
 end

data/lib/draper/tasks/test.rake

@@ -1,22 +1,9 @@
 require 'rake/testtask'
-
-test_task = if Rails.version.to_f < 3.2
-  require 'rails/test_unit/railtie'
-  Rake::TestTask
-else
-  require 'rails/test_unit/sub_test_task'
-  Rails::SubTestTask
-end
+require 'rails/test_unit/railtie'
 
 namespace :test do
-  test_task.new(:decorators => "test:prepare") do |t|
+  Rake::TestTask.new(decorators: "test:prepare") do |t|
     t.libs << "test"
     t.pattern = "test/decorators/**/*_test.rb"
   end
 end
-
-if Rails.version.to_f < 4.2 && Rake::Task.task_defined?('test:run')
-  Rake::Task['test:run'].enhance do
-    Rake::Task['test:decorators'].invoke
-  end
-end

data/lib/draper/test/devise_helper.rb

@@ -1,14 +1,7 @@
 module Draper
   module DeviseHelper
     def sign_in(resource_or_scope, resource = nil)
-      scope = begin
-        Devise::Mapping.find_scope!(resource_or_scope)
-      rescue RuntimeError => e
-        # Draper 1.0 didn't require the mapping to exist
-        ActiveSupport::Deprecation.warn("#{e.message}.\nUse `sign_in :user, mock_user` instead.", caller)
-        :user
-      end
-
+      scope = Devise::Mapping.find_scope!(resource_or_scope)
       _stub_current_scope scope, resource || resource_or_scope
     end
 

data/lib/draper/test/rspec_integration.rb

@@ -7,11 +7,7 @@ module Draper
   end
 
   RSpec.configure do |config|
-    if RSpec::Core::Version::STRING.starts_with?("3")
-      config.include DecoratorExampleGroup, file_path: %r{spec/decorators}, type: :decorator
-    else
-      config.include DecoratorExampleGroup, example_group: {file_path: %r{spec/decorators}}, type: :decorator
-    end
+    config.include DecoratorExampleGroup, file_path: %r{spec/decorators}, type: :decorator
 
     [:decorator, :controller, :mailer].each do |type|
       config.before(:each, type: type) { Draper::ViewContext.clear! }

data/lib/draper/test_case.rb

@@ -29,14 +29,10 @@ module Draper
   end
 end
 
-if defined?(ActionController::TestCase)
-  class ActionController::TestCase
-    include Draper::TestCase::ViewContextTeardown
-  end
+if defined? ActionController::TestCase
+  ActionController::TestCase.include Draper::TestCase::ViewContextTeardown
 end
 
-if defined?(ActionMailer::TestCase)
-  class ActionMailer::TestCase
-    include Draper::TestCase::ViewContextTeardown
-  end
+if defined? ActionMailer::TestCase
+  ActionMailer::TestCase.include Draper::TestCase::ViewContextTeardown
 end

data/lib/draper/undecorate.rb

@@ -6,4 +6,12 @@ module Draper
       object
     end
   end
+  
+  def self.undecorate_chain(object)
+    if object.respond_to?(:decorated?) && object.decorated?
+      undecorate_chain(object.object)
+    else
+      object
+    end
+  end
 end

data/lib/draper/version.rb

@@ -1,3 +1,3 @@
 module Draper
-  VERSION = "2.1.0"
+  VERSION = '3.0.0'
 end

data/lib/draper/view_context.rb

@@ -20,8 +20,10 @@ module Draper
       RequestStore.store[:current_controller]
     end
 
-    # Sets the current controller.
+    # Sets the current controller. Clears view context when we are setting
+    # different controller.
     def self.controller=(controller)
+      clear! if RequestStore.store[:current_controller] != controller
       RequestStore.store[:current_controller] = controller
     end
 
@@ -82,23 +84,5 @@ module Draper
     def self.build_strategy
       @build_strategy ||= Draper::ViewContext::BuildStrategy.new(:full)
     end
-
-    # @deprecated Use {controller} instead.
-    def self.current_controller
-      ActiveSupport::Deprecation.warn("Draper::ViewContext.current_controller is deprecated (use controller instead)", caller)
-      self.controller || ApplicationController.new
-    end
-
-    # @deprecated Use {controller=} instead.
-    def self.current_controller=(controller)
-      ActiveSupport::Deprecation.warn("Draper::ViewContext.current_controller= is deprecated (use controller instead)", caller)
-      self.controller = controller
-    end
-
-    # @deprecated Use {build} instead.
-    def self.build_view_context
-      ActiveSupport::Deprecation.warn("Draper::ViewContext.build_view_context is deprecated (use build instead)", caller)
-      build
-    end
   end
 end

data/lib/draper/view_context/build_strategy.rb

@@ -37,10 +37,19 @@ module Draper
         attr_reader :block
 
         def controller
-          (Draper::ViewContext.controller || ApplicationController.new).tap do |controller|
-            controller.request ||= ActionController::TestRequest.new if defined?(ActionController::TestRequest)
+          Draper::ViewContext.controller ||= Draper.default_controller.new
+          Draper::ViewContext.controller.tap do |controller|
+            controller.request ||= new_test_request controller if defined?(ActionController::TestRequest)
           end
         end
+
+        def new_test_request(controller)
+          is_above_rails_5_1 ? ActionController::TestRequest.create(controller) : ActionController::TestRequest.create
+        end
+
+        def is_above_rails_5_1
+          ActionController::TestRequest.method(:create).parameters.first == [:req, :controller_class]
+        end
       end
 
     end

data/lib/generators/controller_override.rb

@@ -5,13 +5,13 @@ require "rails/generators/rails/scaffold_controller/scaffold_controller_generato
 module Rails
   module Generators
     class ControllerGenerator
-      hook_for :decorator, default: true do |generator|
+      hook_for :decorator, type: :boolean, default: true do |generator|
         invoke generator, [name.singularize]
       end
     end
 
     class ScaffoldControllerGenerator
-      hook_for :decorator, default: true
+      hook_for :decorator, type: :boolean, default: true
     end
   end
 end

data/lib/generators/draper/install_generator.rb

@@ -0,0 +1,14 @@
+module Draper
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      desc 'Creates an ApplicationDecorator, if none exists.'
+
+      def create_application_decorator
+        file = 'application_decorator.rb'
+        copy_file file, "app/decorators/#{file}"
+      end
+    end
+  end
+end

data/lib/generators/draper/templates/application_decorator.rb

@@ -0,0 +1,8 @@
+class ApplicationDecorator < Draper::Decorator
+  # Define methods for all decorated objects.
+  # Helpers are accessed through `helpers` (aka `h`). For example:
+  #
+  #   def percent_amount
+  #     h.number_to_percentage object.amount, precision: 2
+  #   end
+end