draper 0.18.0 → 1.1.0

data/lib/draper/delegation.rb

@@ -0,0 +1,13 @@
+module Draper
+  module Delegation
+    # @overload delegate(*methods, options = {})
+    #   Overrides {http://api.rubyonrails.org/classes/Module.html#method-i-delegate Module.delegate}
+    #   to make `:source` the default delegation target.
+    #
+    #   @return [void]
+    def delegate(*methods)
+      options = methods.extract_options!
+      super *methods, options.reverse_merge(to: :source)
+    end
+  end
+end

data/lib/draper/finders.rb

@@ -0,0 +1,37 @@
+module Draper
+  # Provides automatically-decorated finder methods for your decorators. You
+  # do not have to extend this module directly; it is extended by
+  # {Decorator.decorates_finders}.
+  module Finders
+
+    def find(id, options = {})
+      decorate(source_class.find(id), options)
+    end
+
+    def all(options = {})
+      decorate_collection(source_class.all, options)
+    end
+
+    def first(options = {})
+      decorate(source_class.first, options)
+    end
+
+    def last(options = {})
+      decorate(source_class.last, options)
+    end
+
+    # Decorates dynamic finder methods (`find_all_by_` and friends).
+    def method_missing(method, *args, &block)
+      return super unless method =~ /^find_(all_|last_|or_(initialize_|create_))?by_/
+
+      result = source_class.send(method, *args, &block)
+      options = args.extract_options!
+
+      if method =~ /^find_all/
+        decorate_collection(result, options)
+      else
+        decorate(result, options)
+      end
+    end
+  end
+end

data/lib/draper/helper_proxy.rb

@@ -0,0 +1,36 @@
+module Draper
+  # Provides access to helper methods - both Rails built-in helpers, and those
+  # 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)
+      self.class.define_proxy method
+      send(method, *args, &block)
+    end
+
+    protected
+
+    attr_reader :view_context
+
+    private
+
+    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/lazy_helpers.rb

@@ -1,11 +1,15 @@
 module Draper
+  # Include this module in your decorators to get direct access to the helpers
+  # so that you can stop typing `h.` everywhere, at the cost of mixing in a
+  # bazillion methods.
   module LazyHelpers
-    def method_missing(method_name, *args, &block)
-      begin
-        helpers.send method_name, *args, &block
-      rescue NoMethodError
-        super
-      end
+
+    # Sends missing methods to the {HelperProxy}.
+    def method_missing(method, *args, &block)
+      helpers.send(method, *args, &block)
+    rescue NoMethodError
+      super
     end
+
   end
 end

data/lib/draper/railtie.rb

@@ -3,8 +3,10 @@ require 'rails/railtie'
 module ActiveModel
   class Railtie < Rails::Railtie
     generators do |app|
-      Rails::Generators.configure!(app.config.generators)
-      require "generators/resource_override"
+      app ||= Rails.application # Rails 3.0.x does not yield `app`
+
+      Rails::Generators.configure! app.config.generators
+      require 'generators/resource_override'
     end
   end
 end
@@ -12,40 +14,44 @@ end
 module Draper
   class Railtie < Rails::Railtie
 
-    ##
-    # The `app/decorators` path is eager loaded
-    #
-    # This is the standard "Rails Way" to add paths from which constants
-    # can be loaded.
-    #
     config.after_initialize do |app|
-      app.config.paths.add 'app/decorators', :eager_load => true
+      app.config.paths.add 'app/decorators', eager_load: true
+
+      unless Rails.env.production?
+        require 'draper/test_case'
+        require 'draper/test/rspec_integration' if defined?(RSpec) and RSpec.respond_to?(:configure)
+        require 'draper/test/minitest_integration' if defined?(MiniTest::Rails)
+      end
     end
 
-    initializer "draper.extend_action_controller_base" do |app|
-      ActiveSupport.on_load(:action_controller) do
-        Draper::System.setup_action_controller(self)
+    initializer "draper.setup_action_controller" do |app|
+      ActiveSupport.on_load :action_controller do
+        Draper.setup_action_controller self
       end
     end
 
-    initializer "draper.extend_action_mailer_base" do |app|
-      ActiveSupport.on_load(:action_mailer) do
-        Draper::System.setup_action_mailer(self)
+    initializer "draper.setup_action_mailer" do |app|
+      ActiveSupport.on_load :action_mailer do
+        Draper.setup_action_mailer self
       end
     end
 
-    initializer "draper.extend_active_record_base" do |app|
-      ActiveSupport.on_load(:active_record) do
-        self.send(:include, Draper::ModelSupport)
+    initializer "draper.setup_orm" do |app|
+      [:active_record, :mongoid].each do |orm|
+        ActiveSupport.on_load orm do
+          Draper.setup_orm self
+        end
       end
     end
 
     console do
       require 'action_controller/test_case'
       ApplicationController.new.view_context
-      Draper::ViewContext.current.controller.request ||= ActionController::TestRequest.new
-      Draper::ViewContext.current.request            ||= Draper::ViewContext.current.controller.request
-      Draper::ViewContext.current.params             ||= {}
+      Draper::ViewContext.build_view_context
+    end
+
+    rake_tasks do
+      Dir[File.join(File.dirname(__FILE__),'tasks/*.rake')].each { |f| load f }
     end
   end
 end

data/lib/draper/tasks/test.rake

@@ -0,0 +1,22 @@
+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
+
+namespace :test do
+  test_task.new(:decorators => "test:prepare") do |t|
+    t.libs << "test"
+    t.pattern = "test/decorators/**/*_test.rb"
+  end
+end
+
+if 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

@@ -0,0 +1,30 @@
+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
+
+      _stub_current_scope scope, resource || resource_or_scope
+    end
+
+    def sign_out(resource_or_scope)
+      scope = Devise::Mapping.find_scope!(resource_or_scope)
+      _stub_current_scope scope, nil
+    end
+
+    private
+
+    def _stub_current_scope(scope, resource)
+      Draper::ViewContext.current.controller.singleton_class.class_eval do
+        define_method "current_#{scope}" do
+          resource
+        end
+      end
+    end
+  end
+end

data/lib/draper/test/minitest_integration.rb

@@ -1,7 +1,6 @@
-class MiniTest::Rails::ActiveSupport::TestCase
-  # Use AS::TestCase for the base class when describing a decorator
+class Draper::TestCase
   register_spec_type(self) do |desc|
-    desc < Draper::Base if desc.is_a?(Class)
+    desc < Draper::Decorator || desc < Draper::CollectionDecorator if desc.is_a?(Class)
   end
   register_spec_type(/Decorator( ?Test)?\z/i, self)
 end

data/lib/draper/test/rspec_integration.rb

@@ -1,22 +1,16 @@
 module Draper
   module DecoratorExampleGroup
+    include Draper::TestCase::Behavior
     extend ActiveSupport::Concern
+
     included { metadata[:type] = :decorator }
   end
-end
-
-RSpec.configure do |config|
-  # Automatically tag specs in specs/decorators as type: :decorator
-  config.include Draper::DecoratorExampleGroup, :type => :decorator, :example_group => {
-    :file_path => /spec[\\\/]decorators/
-  }
-
-end
-
-if defined?(Capybara)
-  require 'capybara/rspec/matchers'
 
   RSpec.configure do |config|
-    config.include Capybara::RSpecMatchers, :type => :decorator
+    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

@@ -0,0 +1,53 @@
+module Draper
+  begin
+    require 'minitest/rails'
+  rescue LoadError
+  end
+
+  active_support_test_case = begin
+    require 'minitest/rails/active_support' # minitest-rails < 0.5
+    ::MiniTest::Rails::ActiveSupport::TestCase
+  rescue LoadError
+    require 'active_support/test_case'
+    ::ActiveSupport::TestCase
+  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'
+        include Draper::DeviseHelper
+      end
+
+      if defined?(::Capybara) && (defined?(::RSpec) || defined?(::MiniTest::Matchers))
+        require 'capybara/rspec/matchers'
+        include ::Capybara::RSpecMatchers
+      end
+
+      include Draper::ViewHelpers::ClassMethods
+      alias_method :helper, :helpers
+    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 = "0.18.0"
+  VERSION = "1.1.0"
 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_context.rb

@@ -1,42 +1,99 @@
+require 'draper/view_context/build_strategy'
+require 'request_store'
+
 module Draper
   module ViewContext
-    def self.current_controller
-      Thread.current[:current_controller] || ApplicationController.new
+    # 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=(controller)
-      Thread.current[:current_controller] = controller
+    # Returns the current controller.
+    def self.controller
+      RequestStore.store[:current_controller]
     end
 
+    # 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
-      Thread.current[:current_view_context] ||= build_view_context
+      RequestStore.store.fetch(:current_view_context) { build! }
     end
 
-    def self.current=(context)
-      Thread.current[: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
 
-    def view_context
-      super.tap do |context|
-        Draper::ViewContext.current = context
-      end
+    # Clears the saved controller and view context.
+    def self.clear!
+      RequestStore.store.delete :current_controller
+      RequestStore.store.delete :current_view_context
     end
 
-    private
+    # 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|
-        context.instance_eval do
-          def url_options
-            ActionMailer::Base.default_url_options
-          end
-        end unless context.request
-        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_helpers.rb

@@ -0,0 +1,37 @@
+module Draper
+  # Provides the {#helpers} method used in {Decorator} and {CollectionDecorator}
+  # to call the Rails helpers.
+  module ViewHelpers
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+
+      # Access the helpers proxy to call built-in and user-defined
+      # Rails helpers from a class context.
+      #
+      # @return [HelperProxy] the helpers proxy
+      def helpers
+        Draper::ViewContext.current
+      end
+      alias_method :h, :helpers
+
+    end
+
+    # Access the helpers proxy to call built-in and user-defined
+    # Rails helpers. Aliased to `h` for convenience.
+    #
+    # @return [HelperProxy] the helpers proxy
+    def helpers
+      Draper::ViewContext.current
+    end
+    alias_method :h, :helpers
+
+    # Alias for `helpers.localize`, since localize is something that's used
+    # quite often. Further aliased to `l` for convenience.
+    def localize(*args)
+      helpers.localize(*args)
+    end
+    alias_method :l, :localize
+
+  end
+end

data/lib/draper.rb

@@ -1,16 +1,58 @@
 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/system'
-require 'draper/active_model_support'
-require 'draper/base'
+require 'draper/view_helpers'
+require 'draper/delegation'
+require 'draper/automatic_delegation'
+require 'draper/finders'
+require 'draper/decorator'
+require 'draper/helper_proxy'
 require 'draper/lazy_helpers'
-require 'draper/model_support'
+require 'draper/decoratable'
+require 'draper/decorated_association'
 require 'draper/helper_support'
 require 'draper/view_context'
-require 'draper/decorated_enumerable_proxy'
+require 'draper/collection_decorator'
 require 'draper/railtie' if defined?(Rails)
 
-# Test Support
-require 'draper/test/rspec_integration'    if defined?(RSpec) and RSpec.respond_to?(:configure)
-require 'draper/test/minitest_integration' if defined?(MiniTest::Rails)
+module Draper
+  def self.setup_action_controller(base)
+    base.class_eval do
+      include Draper::ViewContext
+      extend  Draper::HelperSupport
+
+      before_filter do |controller|
+        Draper::ViewContext.clear!
+        Draper::ViewContext.controller = controller
+      end
+    end
+  end
+
+  def self.setup_action_mailer(base)
+    base.class_eval do
+      include Draper::ViewContext
+    end
+  end
+
+  def self.setup_orm(base)
+    base.class_eval do
+      include Draper::Decoratable
+    end
+  end
+
+  class UninferrableDecoratorError < NameError
+    def initialize(klass)
+      super("Could not infer a decorator for #{klass}.")
+    end
+  end
+
+  class UninferrableSourceError < NameError
+    def initialize(klass)
+      super("Could not infer a source for #{klass}.")
+    end
+  end
+end

data/lib/generators/decorator/decorator_generator.rb

@@ -20,9 +20,17 @@ module Rails
         elsif defined?(ApplicationDecorator)
           "ApplicationDecorator"
         else
-          "Draper::Base"
+          "Draper::Decorator"
         end
       end
-   end
+
+      	
+      # Rails 3.0.X compatibility, stolen from https://github.com/jnunemaker/mongomapper/pull/385/files#L1R32
+      unless methods.include?(:module_namespacing)
+        def module_namespacing(&block)
+          yield if block
+        end
+      end
+    end
   end
 end