draper 1.0.0.beta6 → 1.0.0

data/lib/draper/helper_proxy.rb

@@ -1,8 +1,9 @@
 module Draper
+  # Provides access to helper methods - both Rails built-in helpers, and those
+  # defined in your application.
   class HelperProxy
-    # Some helpers are private, for example html_escape... as a workaround
-    # we are wrapping the helpers in a delegator that passes the methods
-    # along through a send, which will ignore private/public distinctions
+
+    # Sends helper methods to the view context.
     def method_missing(method, *args, &block)
       view_context.send(method, *args, &block)
     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

@@ -17,10 +17,11 @@ module Draper
     config.after_initialize do |app|
       app.config.paths.add 'app/decorators', eager_load: true
 
-      # Test Support
-      require 'draper/test/rspec_integration' if defined?(RSpec) and RSpec.respond_to?(:configure)
-      require 'draper/test/minitest_integration'  if defined?(MiniTest::Rails)
-      require 'draper/test/test_unit_integration'
+      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.setup_action_controller" do |app|

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,34 @@
+module Draper
+  module DeviseHelper
+    def sign_in(user)
+      warden.stub :authenticate! => user
+      controller.stub :current_user => user
+      user
+    end
+
+    private
+
+    def request
+      @request ||= ::ActionDispatch::TestRequest.new
+    end
+
+    def controller
+      return @controller if @controller
+      @controller = ApplicationController.new
+      @controller.request = request
+      ::Draper::ViewContext.current = @controller.view_context
+      @controller
+    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
+        end
+        request.env['warden'] = Warden::Proxy.new(request.env, manager)
+      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::Decorator 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,67 +1,12 @@
 module Draper
   module DecoratorExampleGroup
+    include Draper::TestCase::Behavior
     extend ActiveSupport::Concern
-    included { metadata[:type] = :decorator }
-  end
-
-  module DeviseHelper
-    def sign_in(user)
-      warden.stub :authenticate! => user
-      controller.stub :current_user => user
-      user
-    end
-
-    private
 
-    def request
-      @request ||= ::ActionDispatch::TestRequest.new
-    end
-
-    def controller
-      return @controller if @controller
-      @controller = ApplicationController.new
-      @controller.request = request
-      ::Draper::ViewContext.current = @controller.view_context
-      @controller
-    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
-        end
-        request.env['warden'] = Warden::Proxy.new(request.env, manager)
-      end
-    end
-  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/
-  }
-
-  if defined?(Devise)
-    config.include Draper::DeviseHelper, :type => :decorator
+    included { metadata[:type] = :decorator }
   end
-end
 
-module Draper
-  module RSpec
-    class Railtie < Rails::Railtie
-      config.after_initialize do |app|
-        if defined?(Capybara)
-          require 'capybara/rspec/matchers'
-
-          ::RSpec.configure do |config|
-            config.include Capybara::RSpecMatchers, :type => :decorator
-          end
-        end
-      end
-    end
+  RSpec.configure do |config|
+    config.include DecoratorExampleGroup, example_group: {file_path: %r{spec/decorators}}, type: :decorator
   end
 end
-

data/lib/draper/test_case.rb

@@ -0,0 +1,33 @@
+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 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
+  end
+end

data/lib/draper/version.rb

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

data/lib/draper/view_helpers.rb

@@ -1,4 +1,6 @@
 module Draper
+  # Provides the {#helpers} method used in {Decorator} and {CollectionDecorator}
+  # to call the Rails helpers.
   module ViewHelpers
     extend ActiveSupport::Concern
 
@@ -24,9 +26,8 @@ module Draper
     end
     alias_method :h, :helpers
 
-    # Localize is something that's used quite often. Even though
-    # it's available through helpers, that's annoying. Aliased
-    # to `l` for convenience.
+    # 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

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

@@ -4,34 +4,16 @@ class <%= class_name %>Decorator < <%= parent_class_name %>
   <%- else -%>
 class <%= class_name %>
   <%- end -%>
+  delegate_all
 
-  # Accessing Helpers
-  #   You can access any helper via a proxy
-  #
-  #   Normal Usage: helpers.number_to_currency(2)
-  #   Abbreviated : h.number_to_currency(2)
-  #
-  #   Or, optionally enable "lazy helpers" by including this module:
-  #     include Draper::LazyHelpers
-  #   Then use the helpers with no proxy:
-  #     number_to_currency(2)
-
-  # Defining an Interface
-  #   Control access to the wrapped subject's methods using one of the following:
-  #
-  #   To allow only the listed methods (whitelist):
-  #     allows :method1, :method2
-  #
-  #   To allow everything except the listed methods (blacklist):
-  #     denies :method1, :method2
-
-  # Presentation Methods
-  #   Define your own instance methods, even overriding accessors
-  #   generated by ActiveRecord:
+  # Define presentation-specific methods here. Helpers are accessed through
+  # `helpers` (aka `h`). You can override attributes, for example:
   #
   #   def created_at
-  #     h.content_tag :span, attributes["created_at"].strftime("%a %m/%d/%y"),
-  #                   :class => 'timestamp'
+  #     helpers.content_tag :span, class: 'time' do
+  #       source.created_at.strftime("%a %m/%d/%y")
+  #     end
   #   end
+
 end
 <% end -%>

data/lib/generators/mini_test/decorator_generator.rb

@@ -0,0 +1,20 @@
+require 'generators/mini_test'
+
+module MiniTest
+  module Generators
+    class DecoratorGenerator < Base
+      def self.source_root
+        File.expand_path('../templates', __FILE__)
+      end
+
+      class_option :spec, :type => :boolean, :default => false, :desc => "Use MiniTest::Spec DSL"
+
+      check_class_collision suffix: "DecoratorTest"
+
+      def create_test_file
+        template_type = options[:spec] ? "spec" : "test"
+        template "decorator_#{template_type}.rb", File.join("test/decorators", class_path, "#{singular_name}_decorator_test.rb")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,4 @@
+require 'minitest_helper'
+
+describe <%= class_name %>Decorator do
+end

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

@@ -0,0 +1,4 @@
+require 'minitest_helper'
+
+class <%= class_name %>DecoratorTest < Draper::TestCase
+end

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

@@ -1,4 +1,4 @@
 require 'test_helper'
 
-class <%= class_name %>DecoratorTest < ActiveSupport::TestCase
+class <%= class_name %>DecoratorTest < Draper::TestCase
 end

data/spec/draper/collection_decorator_spec.rb

@@ -76,7 +76,7 @@ describe Draper::CollectionDecorator do
       end
 
       it "raises error on invalid options" do
-        expect { Draper::CollectionDecorator.new(source, valid_options.merge(foo: 'bar')) }.to raise_error(ArgumentError, 'Unknown key: foo')
+        expect { Draper::CollectionDecorator.new(source, valid_options.merge(foo: 'bar')) }.to raise_error(ArgumentError, /Unknown key/)
       end
     end
   end
@@ -127,6 +127,20 @@ describe Draper::CollectionDecorator do
     end
   end
 
+  describe ".delegate" do
+    subject { Class.new(Draper::CollectionDecorator) }
+
+    it "defaults the :to option to :source" do
+      Draper::CollectionDecorator.superclass.should_receive(:delegate).with(:foo, :bar, to: :source)
+      subject.delegate :foo, :bar
+    end
+
+    it "does not overwrite the :to option if supplied" do
+      Draper::CollectionDecorator.superclass.should_receive(:delegate).with(:foo, :bar, to: :baz)
+      subject.delegate :foo, :bar, to: :baz
+    end
+  end
+
   describe "#find" do
     context "with a block" do
       it "decorates Enumerable#find" do
@@ -248,7 +262,7 @@ describe Draper::CollectionDecorator do
       let(:options) { {with: ProductDecorator} }
 
       it "returns a string representation of the CollectionDecorator" do
-        subject.to_s.should == '#<CollectionDecorator of ProductDecorator for ["a", "b", "c"]>'
+        subject.to_s.should == '#<Draper::CollectionDecorator of ProductDecorator for ["a", "b", "c"]>'
       end
     end
 
@@ -256,7 +270,15 @@ describe Draper::CollectionDecorator do
       let(:options) { {} }
 
       it "returns a string representation of the CollectionDecorator" do
-        subject.to_s.should == '#<CollectionDecorator of inferred decorators for ["a", "b", "c"]>'
+        subject.to_s.should == '#<Draper::CollectionDecorator of inferred decorators for ["a", "b", "c"]>'
+      end
+    end
+
+    context "for a custom subclass" do
+      subject { ProductsDecorator.new(source) }
+
+      it "uses the custom class name" do
+        subject.to_s.should =~ /ProductsDecorator/
       end
     end
   end

data/spec/draper/decorated_association_spec.rb

@@ -15,7 +15,7 @@ describe Draper::DecoratedAssociation do
       end
 
       it "raises error on invalid options" do
-        expect { Draper::DecoratedAssociation.new(owner, :association, valid_options.merge(foo: 'bar')) }.to raise_error(ArgumentError, 'Unknown key: foo')
+        expect { Draper::DecoratedAssociation.new(owner, :association, valid_options.merge(foo: 'bar')) }.to raise_error(ArgumentError, /Unknown key/)
       end
     end
   end
@@ -31,10 +31,10 @@ describe Draper::DecoratedAssociation do
 
     context "for a singular association" do
       let(:associated) { Product.new }
+      let(:decorator) { SpecificProductDecorator }
 
       context "when :with option was given" do
         let(:options) { {with: decorator} }
-        let(:decorator) { SpecificProductDecorator }
 
         it "uses the specified decorator" do
           decorator.should_receive(:decorate).with(associated, expected_options).and_return(:decorated)
@@ -44,7 +44,8 @@ describe Draper::DecoratedAssociation do
 
       context "when :with option was not given" do
         it "infers the decorator" do
-          associated.should_receive(:decorate).with(expected_options).and_return(:decorated)
+          associated.stub(:decorator_class).and_return(decorator)
+          decorator.should_receive(:decorate).with(associated, expected_options).and_return(:decorated)
           decorated_association.call.should be :decorated
         end
       end
@@ -52,10 +53,10 @@ describe Draper::DecoratedAssociation do
 
     context "for a collection association" do
       let(:associated) { [Product.new, Widget.new] }
+      let(:collection_decorator) { ProductsDecorator }
 
       context "when :with option is a collection decorator" do
         let(:options) { {with: collection_decorator} }
-        let(:collection_decorator) { ProductsDecorator }
 
         it "uses the specified decorator" do
           collection_decorator.should_receive(:decorate).with(associated, expected_options).and_return(:decorated_collection)
@@ -74,9 +75,19 @@ describe Draper::DecoratedAssociation do
       end
 
       context "when :with option was not given" do
-        it "uses a CollectionDecorator of inferred decorators" do
-          Draper::CollectionDecorator.should_receive(:decorate).with(associated, expected_options).and_return(:decorated_collection)
-          decorated_association.call.should be :decorated_collection
+        context "when the collection is decoratable" do
+          it "infers the decorator" do
+            associated.stub(:decorator_class).and_return(collection_decorator)
+            collection_decorator.should_receive(:decorate).with(associated, expected_options).and_return(:decorated_collection)
+            decorated_association.call.should be :decorated_collection
+          end
+        end
+
+        context "when the collection is not decoratable" do
+          it "uses a CollectionDecorator of inferred decorators" do
+            Draper::CollectionDecorator.should_receive(:decorate).with(associated, expected_options).and_return(:decorated_collection)
+            decorated_association.call.should be :decorated_collection
+          end
         end
       end
     end