view_context.rb in draper-1.1.0

- old
+ new
@@ -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
 
-    def self.current=(context)
-      RequestStore.store[:current_view_context] = context
+    # 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
+
+    # 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