draper 1.0.0 → 1.1.0

data/Rakefile

@@ -60,6 +60,7 @@ end
 namespace "db" do
   desc "Set up databases for integration testing"
   task "setup" do
+    puts "Setting up databases"
     run_in_dummy_app "rm -f db/*.sqlite3"
     run_in_dummy_app "RAILS_ENV=development rake db:schema:load db:seed"
     run_in_dummy_app "RAILS_ENV=production rake db:schema:load db:seed"

data/draper.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.email       = ["jeff@casimircreative.com", "steve@steveklabnik.com"]
   s.homepage    = "http://github.com/drapergem/draper"
   s.summary     = "View Models for Rails"
-  s.description = "Draper adds a nicely-separated object-oriented layer of presentation logic to your Rails apps."
+  s.description = "Draper adds an object-oriented layer of presentation logic to your Rails apps."
   s.rubyforge_project = "draper"
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/draper.rb

@@ -1,4 +1,8 @@
 require 'action_view'
+require 'active_model/serialization'
+require 'active_support/inflector'
+require 'active_support/core_ext/hash/keys'
+require 'active_support/core_ext/hash/reverse_merge'
 
 require 'draper/version'
 require 'draper/view_helpers'
@@ -15,17 +19,16 @@ require 'draper/view_context'
 require 'draper/collection_decorator'
 require 'draper/railtie' if defined?(Rails)
 
-require 'active_support/core_ext/hash/keys'
-
 module Draper
   def self.setup_action_controller(base)
     base.class_eval do
       include Draper::ViewContext
       extend  Draper::HelperSupport
-      before_filter ->(controller) {
-        Draper::ViewContext.current = nil
-        Draper::ViewContext.current_controller = controller
-      }
+
+      before_filter do |controller|
+        Draper::ViewContext.clear!
+        Draper::ViewContext.controller = controller
+      end
     end
   end
 

data/lib/draper/decoratable.rb

@@ -1,3 +1,5 @@
+require 'draper/decoratable/equality'
+
 module Draper
   # Provides shortcuts to decorate objects directly, so you can do
   # `@product.decorate` instead of `ProductDecorator.new(@product)`.
@@ -7,6 +9,7 @@ module Draper
   # plain old Ruby objects, you can include it manually.
   module Decoratable
     extend ActiveSupport::Concern
+    include Draper::Decoratable::Equality
 
     # Decorates the object using the inferred {#decorator_class}.
     # @param [Hash] options
@@ -40,13 +43,6 @@ module Draper
       false
     end
 
-    # Compares with possibly-decorated objects.
-    #
-    # @return [Boolean]
-    def ==(other)
-      super || (other.respond_to?(:source) && self == other.source)
-    end
-
     module ClassMethods
 
       # Decorates a collection of objects. Used at the end of a scope chain.

data/lib/draper/decoratable/equality.rb

@@ -0,0 +1,14 @@
+module Draper
+  module Decoratable
+    module Equality
+      # Compares self with a possibly-decorated object.
+      #
+      # @return [Boolean]
+      def ==(other)
+        super ||
+          other.respond_to?(:decorated?) && other.decorated? &&
+          other.respond_to?(:source) && self == other.source
+      end
+    end
+  end
+end

data/lib/draper/decorator.rb

@@ -1,10 +1,8 @@
-require 'active_support/core_ext/array/extract_options'
-
 module Draper
   class Decorator
     include Draper::ViewHelpers
     extend Draper::Delegation
-    include ActiveModel::Serialization if defined?(ActiveModel::Serialization)
+    include ActiveModel::Serialization
 
     # @return the object being decorated.
     attr_reader :source
@@ -27,7 +25,6 @@ module Draper
     #   methods.
     def initialize(source, options = {})
       options.assert_valid_keys(:context)
-      source.to_a if source.respond_to?(:to_a) # forces evaluation of a lazy query from AR
       @source = source
       @context = options.fetch(:context, {})
       handle_multiple_decoration(options) if source.instance_of?(self.class)
@@ -159,11 +156,11 @@ module Draper
       true
     end
 
-    # Delegated to the source object.
+    # Compares the source with a possibly-decorated object.
     #
     # @return [Boolean]
     def ==(other)
-      source == (other.respond_to?(:source) ? other.source : other)
+      source.extend(Draper::Decoratable::Equality) == other
     end
 
     # Checks if `self.kind_of?(klass)` or `source.kind_of?(klass)`
@@ -191,7 +188,7 @@ module Draper
     end
 
     # ActiveModel compatibility
-    delegate :to_param, :to_partial_path
+    delegate :attributes, :to_param, :to_partial_path
 
     # ActiveModel compatibility
     singleton_class.delegate :model_name, to: :source_class

data/lib/draper/helper_proxy.rb

@@ -3,15 +3,34 @@ module Draper
   # defined in your application.
   class HelperProxy
 
+    # @overload initialize(view_context)
+    def initialize(view_context = nil)
+      view_context ||= current_view_context # backwards compatibility
+
+      @view_context = view_context
+    end
+
     # Sends helper methods to the view context.
     def method_missing(method, *args, &block)
-      view_context.send(method, *args, &block)
+      self.class.define_proxy method
+      send(method, *args, &block)
     end
 
+    protected
+
+    attr_reader :view_context
+
     private
 
-    def view_context
-      Draper::ViewContext.current
+    def self.define_proxy(name)
+      define_method name do |*args, &block|
+        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/test/devise_helper.rb

@@ -1,33 +1,29 @@
 module Draper
   module DeviseHelper
-    def sign_in(user)
-      warden.stub :authenticate! => user
-      controller.stub :current_user => user
-      user
-    end
-
-    private
+    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
 
-    def request
-      @request ||= ::ActionDispatch::TestRequest.new
+      _stub_current_scope scope, resource || resource_or_scope
     end
 
-    def controller
-      return @controller if @controller
-      @controller = ApplicationController.new
-      @controller.request = request
-      ::Draper::ViewContext.current = @controller.view_context
-      @controller
+    def sign_out(resource_or_scope)
+      scope = Devise::Mapping.find_scope!(resource_or_scope)
+      _stub_current_scope scope, nil
     end
 
-    # taken from Devise's helper but uses the request method instead of @request
-    #   and we don't really need the rest of their helper
-    def warden
-      @warden ||= begin
-        manager = Warden::Manager.new(nil) do |config|
-          config.merge! Devise.warden_config
+    private
+
+    def _stub_current_scope(scope, resource)
+      Draper::ViewContext.current.controller.singleton_class.class_eval do
+        define_method "current_#{scope}" do
+          resource
         end
-        request.env['warden'] = Warden::Proxy.new(request.env, manager)
       end
     end
   end

data/lib/draper/test/rspec_integration.rb

@@ -8,5 +8,9 @@ module Draper
 
   RSpec.configure do |config|
     config.include DecoratorExampleGroup, example_group: {file_path: %r{spec/decorators}}, type: :decorator
+
+    [:decorator, :controller, :mailer].each do |type|
+      config.after(:each, type: type) { Draper::ViewContext.clear! }
+    end
   end
 end

data/lib/draper/test_case.rb

@@ -13,6 +13,13 @@ module Draper
   end
 
   class TestCase < active_support_test_case
+    module ViewContextTeardown
+      def teardown
+        super
+        Draper::ViewContext.clear!
+      end
+    end
+
     module Behavior
       if defined?(::Devise)
         require 'draper/test/devise_helper'
@@ -29,5 +36,18 @@ module Draper
     end
 
     include Behavior
+    include ViewContextTeardown
+  end
+end
+
+if defined?(ActionController::TestCase)
+  class ActionController::TestCase
+    include Draper::TestCase::ViewContextTeardown
+  end
+end
+
+if defined?(ActionMailer::TestCase)
+  class ActionMailer::TestCase
+    include Draper::TestCase::ViewContextTeardown
   end
 end

data/lib/draper/version.rb

@@ -1,3 +1,3 @@
 module Draper
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/lib/draper/view_context.rb

@@ -1,37 +1,99 @@
+require 'draper/view_context/build_strategy'
 require 'request_store'
 
 module Draper
   module ViewContext
+    # Hooks into a controller or mailer to save the view context in {current}.
     def view_context
       super.tap do |context|
         Draper::ViewContext.current = context
       end
     end
 
-    def self.current_controller
-      RequestStore.store[:current_controller] || ApplicationController.new
+    # Returns the current controller.
+    def self.controller
+      RequestStore.store[:current_controller]
     end
 
-    def self.current_controller=(controller)
+    # Sets the current controller.
+    def self.controller=(controller)
       RequestStore.store[:current_controller] = controller
     end
 
+    # Returns the current view context, or builds one if none is saved.
+    #
+    # @return [HelperProxy]
     def self.current
-      RequestStore.store[:current_view_context] ||= build_view_context
+      RequestStore.store.fetch(:current_view_context) { build! }
+    end
+
+    # Sets the current view context.
+    def self.current=(view_context)
+      RequestStore.store[:current_view_context] = Draper::HelperProxy.new(view_context)
+    end
+
+    # Clears the saved controller and view context.
+    def self.clear!
+      RequestStore.store.delete :current_controller
+      RequestStore.store.delete :current_view_context
+    end
+
+    # Builds a new view context for usage in tests. See {test_strategy} for
+    # details of how the view context is built.
+    def self.build
+      build_strategy.call
+    end
+
+    # Builds a new view context and sets it as the current view context.
+    #
+    # @return [HelperProxy]
+    def self.build!
+      # send because we want to return the HelperProxy returned from #current=
+      send :current=, build
     end
 
-    def self.current=(context)
-      RequestStore.store[:current_view_context] = context
+    # Configures the strategy used to build view contexts in tests, which
+    # defaults to `:full` if `test_strategy` has not been called. Evaluates
+    # the block, if given, in the context of the view context's class.
+    #
+    # @example Pass a block to add helper methods to the view context:
+    #   Draper::ViewContext.test_strategy :fast do
+    #     include ApplicationHelper
+    #   end
+    #
+    # @param [:full, :fast] name
+    #   the strategy to use:
+    #
+    #   `:full` - build a fully-working view context. Your Rails environment
+    #   must be loaded, including your `ApplicationController`.
+    #
+    #   `:fast` - build a minimal view context in tests, with no dependencies
+    #   on other components of your application.
+    def self.test_strategy(name, &block)
+      @build_strategy = Draper::ViewContext::BuildStrategy.new(name, &block)
     end
 
+    # @private
+    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
-      current_controller.view_context.tap do |context|
-        if defined?(ActionController::TestRequest)
-          context.controller.request ||= ActionController::TestRequest.new
-          context.request            ||= context.controller.request
-          context.params             ||= {}
-        end
-      end
+      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

@@ -0,0 +1,48 @@
+module Draper
+  module ViewContext
+    # @private
+    module BuildStrategy
+
+      def self.new(name, &block)
+        const_get(name.to_s.camelize).new(&block)
+      end
+
+      class Fast
+        def initialize(&block)
+          @view_context_class = Class.new(ActionView::Base, &block)
+        end
+
+        def call
+          view_context_class.new
+        end
+
+        private
+
+        attr_reader :view_context_class
+      end
+
+      class Full
+        def initialize(&block)
+          @block = block
+        end
+
+        def call
+          controller.view_context.tap do |context|
+            context.singleton_class.class_eval(&block) if block
+          end
+        end
+
+        private
+
+        attr_reader :block
+
+        def controller
+          (Draper::ViewContext.controller || ApplicationController.new).tap do |controller|
+            controller.request ||= ActionController::TestRequest.new if defined?(ActionController::TestRequest)
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/draper/view_helpers.rb

@@ -11,7 +11,7 @@ module Draper
       #
       # @return [HelperProxy] the helpers proxy
       def helpers
-        @helpers ||= Draper::HelperProxy.new
+        Draper::ViewContext.current
       end
       alias_method :h, :helpers
 
@@ -22,7 +22,7 @@ module Draper
     #
     # @return [HelperProxy] the helpers proxy
     def helpers
-      self.class.helpers
+      Draper::ViewContext.current
     end
     alias_method :h, :helpers