draper 0.9.3 → 0.9.5

data/.rspec

@@ -0,0 +1 @@
+--color

data/Readme.markdown

@@ -20,17 +20,28 @@
 6. Output the instance methods in your view templates
   ex: `@article_decorator.created_at`
 
-## What's New
+## Watch the RailsCast
+
+Ryan Bates has put together an excellent RailsCast on Draper based on the 0.8.0 release:
+
+[![RailsCast #286](https://img.skitch.com/20111021-dgxmqntq22d37fthky6pttk59n.jpg "RailsCast #286 - Draper")](http://railscasts.com/episodes/286-draper)
 
-### Version 0.9.3
+## What's New
 
-* Helpers are available from the decorator class level, so you could call `ArticleDecorator.new_article_link`
-* Automatically generate a named accessor for the wrapped object, so now inside of `ArticleDecorator` you can use `article` instead of just `model`
-* Removed the `lazy_helpers` method to favor using `include Draper::LazyHelpers`
-* Refactored how methods are selected for delegation to the wrapped model
-* Fixed how the view context is stored in the `Thread.current` to resolve cross-request issues
-* Decorated collections now return a collection proxy instead of an array, which fixes many compatibility issues
-* Automatically generate RSpec/Test::Unit stub for decorator class
+### Version 0.9.X
+
+* `.5`: Render the `decorate` helper, passing a source object and a block in a view template to auto-decorate and render the block (ISSUE: see https://github.com/jcasimir/draper/issues/32)
+* `.5`: `ArticleDecorator.first` and `ArticleDecorator.last` will return decorated instances as you'd expect
+* `.5`: Calling `ArticleDecorator.all` will now return a `DecoratedEnumerableProxy` of the objects from `Article.all`
+* `.5`: More love for `DecoratedEnumerableProxy` including better use of `respond_to`, `include?`, and overriding `.all` to return a 
+* `.4`: Improved the collection proxy's `respond_to` and `to_ary` to play nicely with Rails' `render`
+* `.3`: Helpers are available from the decorator class level, so you could write a `ArticleDecorator.new_article_link` that uses `h.link_to`
+* `.2`: Automatically generate a named accessor for the wrapped object, so now inside of `ArticleDecorator` you can use `article` instead of just `model`
+* `.2`: Automatically generate RSpec/Test::Unit stub for decorator class
+* `.1`: Removed the `lazy_helpers` method to favor using `include Draper::LazyHelpers`
+* `.1`: Refactored how methods are selected for delegation to the wrapped model
+* `.0`: Fixed how the view context is stored to resolve cross-request issues
+* `.0`: Decorated collections now return a collection proxy instead of an array, which fixes many compatibility issues
 
 ## Goals
 
@@ -222,6 +233,21 @@ Use the new methods in your views like any other model method (ex: `@article.pub
 <h1><%= @article.title %> <%= @article.published_at %></h1>
 ```
 
+### Using in Mailers
+
+To use decorators in mailers that use helpers, you have to call `set_current_view_context` in your
+mailer method:
+
+```ruby
+class ActicleMailer < ActionMailer::Base
+  def new_article(article)
+    set_current_view_context
+    @article_decorator = ArticleDecorator.decorate(article)
+    mail(:to => 'come@me.bro', :subject => "New Article: #{@article_decorator.title}")
+  end
+end
+```
+
 ## Possible Decoration Methods
 
 Here are some ideas of what you might do in decorator methods:

data/draper.gemspec

@@ -8,13 +8,12 @@ Gem::Specification.new do |s|
   s.authors     = ["Jeff Casimir"]
   s.email       = ["jeff@casimircreative.com"]
   s.homepage    = "http://github.com/jcasimir/draper"
-  s.summary     = "Decorator pattern implmentation for Rails."
-  s.description = "Draper reimagines the role of helpers in the view layer of a Rails application, allowing an object-oriented approach rather than procedural."
-
+  s.summary     = "Decorator pattern implementation for Rails."
+  s.description = "Draper implements a decorator or presenter pattern for Rails applications."
   s.rubyforge_project = "draper"
-
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
+  s.add_dependency('activesupport', '>= 2.3.10')
 end

data/lib/draper.rb

@@ -3,6 +3,7 @@ require 'draper/system'
 require 'draper/base'
 require 'draper/lazy_helpers'
 require 'draper/model_support'
+require 'draper/helper_support'
 require 'draper/view_context'
 require 'draper/decorated_enumerable_proxy'
 

data/lib/draper/base.rb

@@ -95,6 +95,22 @@ module Draper
     def self.decorate(input, context = {})
       input.respond_to?(:each) ? Draper::DecoratedEnumerableProxy.new(input, self, context) : new(input, context)
     end
+    
+    # Fetch all instances of the decorated class and decorate them.
+    #
+    # @param [Object] context (optional)
+    # @return [Draper::DecoratedEnumerableProxy]
+    def self.all(context = {})
+      Draper::DecoratedEnumerableProxy.new(model_class.all, self, context)
+    end
+    
+    def self.first(context = {})
+      decorate(model_class.first, context)
+    end
+
+    def self.last(context = {})
+      decorate(model_class.last, context)
+    end
 
     # Access the helpers proxy to call built-in and user-defined
     # Rails helpers. Aliased to `.h` for convinience.
@@ -111,7 +127,7 @@ module Draper
     # @return [Object] proxy   
     class << self
       def helpers
-        Thread.current[:current_view_context]
+        Draper::ViewContext.current
       end
       alias :h :helpers
     end    
@@ -127,7 +143,7 @@ module Draper
     #
     # @return [Boolean] true if other's model == self's model 
     def ==(other)
-      @model == other.model
+      @model == (other.respond_to?(:model) ? other.model : other)
     end
 
     def respond_to?(method, include_private = false)

data/lib/draper/decorated_enumerable_proxy.rb

@@ -6,22 +6,28 @@ module Draper
       @wrapped_collection, @klass, @context = collection, klass, context
     end
 
-    # Implementation of Enumerable#each that proxyes to the wrapped collection
     def each(&block)
       @wrapped_collection.each { |member| block.call(@klass.new(member, @context)) }
     end
 
-    # Implement to_arry so that render @decorated_collection is happy
     def to_ary
-      @wrapped_collection.to_ary
+      @wrapped_collection.map { |member| @klass.new(member, @context) }
     end
 
-    def method_missing (meth, *args, &block)
-      @wrapped_collection.send(meth, *args, &block)
+    def method_missing (method, *args, &block)
+      @wrapped_collection.send(method, *args, &block)
+    end
+
+    def respond_to?(method)
+      super || @wrapped_collection.respond_to?(method)
+    end
+
+    def ==(other)
+      @wrapped_collection == other
     end
 
     def to_s
       "#<DecoratedEnumerableProxy of #{@klass} for #{@wrapped_collection.inspect}>"
     end
   end
-end
+end

data/lib/draper/helper_support.rb

@@ -0,0 +1,5 @@
+module Draper::HelperSupport
+  def decorate(input, &block)
+    capture { block.call(input.decorate) }
+  end
+end

data/lib/draper/model_support.rb

@@ -3,4 +3,17 @@ module Draper::ModelSupport
     @decorator ||= "#{self.class.name}Decorator".constantize.decorate(self)
     block_given? ? yield(@decorator) : @decorator
   end
+  
+  alias :decorate :decorator
+
+  module ClassMethods
+    def decorate(context = {})
+      @decorator_proxy ||= "#{model_name}Decorator".constantize.decorate(self.scoped)
+      block_given? ? yield(@decorator_proxy) : @decorator_proxy
+    end
+  end
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
 end

data/lib/draper/system.rb

@@ -1,7 +1,9 @@
 module Draper
-  class System    
+  class System
     def self.setup
-      ActionController::Base.send(:include, Draper::ViewContext) if defined?(ActionController::Base)
+      ActionController::Base.send(:include, Draper::ViewContextFilter) if defined?(ActionController::Base)
+      ActionMailer::Base.send(:include, Draper::ViewContextFilter) if defined?(ActionMailer::Base)
+      ActionController::Base.send(:helper, Draper::HelperSupport) if defined?(ActionController::Base)
     end
   end
-end
+end

data/lib/draper/version.rb

@@ -1,3 +1,3 @@
 module Draper
-  VERSION = "0.9.3"
+  VERSION = "0.9.5"
 end

data/lib/draper/view_context.rb

@@ -1,11 +1,21 @@
 module Draper
   module ViewContext
+    def self.current
+      Thread.current[:current_view_context]
+    end
+
+    def self.current=(input)
+      Thread.current[:current_view_context] = input
+    end
+  end
+
+  module ViewContextFilter
     def set_current_view_context
-      Thread.current[:current_view_context] = self.view_context
+      Draper::ViewContext.current = self.view_context
     end
-    
+
     def self.included(source)
-      source.send(:before_filter, :set_current_view_context)
+      source.send(:before_filter, :set_current_view_context) if source.respond_to?(:before_filter)
     end
   end
-end
+end

data/spec/{base_spec.rb → draper/base_spec.rb}

@@ -1,5 +1,4 @@
 require 'spec_helper'
-require 'draper'
 
 describe Draper::Base do
   before(:each){ ApplicationController.new.set_current_view_context }
@@ -10,11 +9,11 @@ describe Draper::Base do
     it "should pass missing class method calls on to the wrapped class" do
       subject.class.sample_class_method.should == "sample class method"
     end
-    
+
     it "should respond_to a wrapped class method" do
       subject.class.should respond_to(:sample_class_method)
     end
-    
+
     it "should still respond_to it's own class methods" do
       subject.class.should respond_to(:own_class_method)
     end
@@ -24,17 +23,17 @@ describe Draper::Base do
     it "should have a valid view_context" do
       subject.helpers.should be
     end
-    
+
     it "should be aliased to .h" do
       subject.h.should == subject.helpers
-    end    
+    end
   end
-  
+
   context("#helpers") do
     it "should have a valid view_context" do
       Decorator.helpers.should be
     end
-    
+
     it "should be aliased to #h" do
       Decorator.h.should == Decorator.helpers
     end
@@ -44,7 +43,7 @@ describe Draper::Base do
     it "sets the model class for the decorator" do
       ProductDecorator.new(source).model_class.should == Product
     end
-    
+
     it "should handle plural-like words properly'" do
       class Business; end
       expect do
@@ -54,7 +53,7 @@ describe Draper::Base do
         BusinessDecorator.model_class.should == Business
       end.should_not raise_error
     end
-    
+
     it "creates a named accessor for the wrapped model" do
       pd = ProductDecorator.new(source)
       pd.send(:product).should == source
@@ -71,7 +70,7 @@ describe Draper::Base do
   context("selecting methods") do
     it "echos the methods of the wrapped class except default exclusions" do
       source.methods.each do |method|
-        unless Draper::Base::DEFAULT_DENIED.include?(method)        
+        unless Draper::Base::DEFAULT_DENIED.include?(method)
           subject.should respond_to(method.to_sym)
         end
       end
@@ -120,7 +119,7 @@ describe Draper::Base do
       pd.should be_instance_of(ProductDecorator)
       pd.model.should be_instance_of(Product)
     end
-    
+
     it "should accept and store a context" do
       pd = ProductDecorator.find(1, :admin)
       pd.context.should == :admin
@@ -176,18 +175,37 @@ describe Draper::Base do
       subject.should == other
     end
   end
+  
+  context 'position accessors' do
+    [:first, :last].each do |method|
+      context "##{method}" do
+        it "should return a decorated instance" do
+          ProductDecorator.send(method).should be_instance_of ProductDecorator
+        end
+
+        it "should return the #{method} instance of the wrapped class" do
+          ProductDecorator.send(method).model.should == Product.send(method)
+        end
+
+        it "should accept an optional context" do
+          ProductDecorator.send(method, :admin).context.should == :admin
+        end
+      end      
+    end
+  end
 
   describe "collection decoration" do
-    
+
     # Implementation of #decorate that returns an array
-    # of decorated objects is insufficient to deal with 
-    # situations where the original collection has been 
+    # of decorated objects is insufficient to deal with
+    # situations where the original collection has been
     # expanded with the use of modules (as often the case
-    # with paginator gems) or is just more complex then 
-    # an array. 
+    # with paginator gems) or is just more complex then
+    # an array.
     module Paginator; def page_number; "magic_value"; end; end
     Array.send(:include, Paginator)
     let(:paged_array) { [Product.new, Product.new] }
+    let(:empty_collection) { [] }
     subject { ProductDecorator.decorate(paged_array) }
 
     it "should proxy all calls to decorated collection" do
@@ -196,10 +214,56 @@ describe Draper::Base do
     end
 
     it "should support Rails partial lookup for a collection" do
-      # to support Rails render @collection the returned collection 
-      # (or its proxy) should implement #to_ary. 
+      # to support Rails render @collection the returned collection
+      # (or its proxy) should implement #to_ary.
       subject.respond_to?(:to_ary).should be true
-      subject.to_a.first.should == ProductDecorator.decorate(paged_array.first)
+      subject.to_ary.first.should == ProductDecorator.decorate(paged_array.first)
+    end
+
+    it "should delegate respond_to? to the wrapped collection" do
+      decorator = ProductDecorator.decorate(paged_array)
+      paged_array.should_receive(:respond_to?).with(:whatever)
+      decorator.respond_to?(:whatever)
+    end
+
+    it "should return blank for a decorated empty collection" do
+      # This tests that respond_to? is defined for the DecoratedEnumerableProxy
+      # since activesupport calls respond_to?(:empty) in #blank
+      decorator = ProductDecorator.decorate(empty_collection)
+      decorator.should be_blank
+    end
+
+    it "should return whether the member is in the array for a decorated wrapped collection" do
+      # This tests that include? is defined for the DecoratedEnumerableProxy
+      member = paged_array.first
+      subject.respond_to?(:include?)
+      subject.include?(member).should == true
+      subject.include?(subject.first).should == true
+      subject.include?(Product.new).should == false
+    end
+
+    it "should equal each other when decorating the same collection" do
+      subject_one = ProductDecorator.decorate(paged_array)
+      subject_two = ProductDecorator.decorate(paged_array)
+      subject_one.should == subject_two
+    end
+
+    it "should not equal each other when decorating different collections" do
+      subject_one = ProductDecorator.decorate(paged_array)
+      new_paged_array = paged_array + [Product.new]
+      subject_two = ProductDecorator.decorate(new_paged_array)
+      subject_one.should_not == subject_two
+    end
+
+    context '#all' do
+      it "should return a decorated collection" do
+        ProductDecorator.all.first.should be_instance_of ProductDecorator
+      end
+      
+      it "should accept a context" do
+        collection = ProductDecorator.all(:admin)
+        collection.first.context.should == :admin
+      end
     end
   end
 

data/spec/draper/helper_support_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe Draper::HelperSupport do
+  before(:each){ @product = Product.new}
+
+  context '#decorate' do
+    it 'renders a block' do
+      output = ApplicationController.decorate(@product){|p| p.model.object_id }
+      output.should == @product.object_id
+    end
+    
+    it 'uses #capture so Rails only renders the content once' do
+      ApplicationController.decorate(@product){|p| p.model.object_id }
+      ApplicationController.capture_triggered.should be
+    end
+  end
+
+end

data/spec/draper/model_support_spec.rb

@@ -11,5 +11,19 @@ describe Draper::ModelSupport do
       a = Product.new.decorator { |d| d.awesome_title }
       a.should eql "Awesome Title"
     end
+    
+    it 'should be aliased to .decorate' do
+      subject.decorator.model.should == subject.decorate.model
+    end
+  end
+
+  describe '#decorate - decorate collections of AR objects' do
+    subject { Product.limit }
+    its(:decorate) { should be_kind_of(Draper::DecoratedEnumerableProxy) }
+
+    it "should decorate the collection" do
+      subject.decorate.size.should == 1
+      subject.decorate.to_ary[0].model.should be_a(Product)
+    end
   end
 end

data/spec/{view_context_spec.rb → draper/view_context_spec.rb}

@@ -1,5 +1,4 @@
 require 'spec_helper'
-require 'draper'
 
 describe Draper::ViewContext do
   let (:app_controller) do
@@ -19,17 +18,7 @@ describe Draper::ViewContext do
   end
   
   it "raises an exception if the view_context is fetched without being set" do
-    Thread.current[:current_view_context] = nil
+    Draper::ViewContext.current = nil
     expect {app_controller.current_view_context}.should raise_exception(Exception)
   end
-  
-  it "sets view_context every time" do
-    app_controller_instance.stub(:view_context) { 'first' }
-    app_controller_instance.set_current_view_context
-    Thread.current[:current_view_context].should == 'first'
-    
-    app_controller_instance.stub(:view_context) { 'second' }
-    app_controller_instance.set_current_view_context
-    Thread.current[:current_view_context].should == 'second'
-  end
-end
+end

data/spec/spec_helper.rb

@@ -1,7 +1,5 @@
 require 'rubygems'
 require 'bundler/setup'
 Bundler.require
-require './spec/samples/application_helper.rb'
-Dir.glob(['./spec/samples/*.rb', './spec/support/*.rb']) do |file| 
-  require file
-end
+
+Dir['./spec/support/**/*.rb'].each {|file| require file }

data/spec/{samples → support/samples}/active_record.rb

@@ -1,4 +1,9 @@
 module ActiveRecord
   class Base
+
+    def self.limit
+      self
+    end
+
   end
 end

data/spec/{samples → support/samples}/application_controller.rb

@@ -1,3 +1,5 @@
+require './spec/support/samples/application_helper'
+
 module ActionController
   class Base
     @@before_filters = []
@@ -7,6 +9,9 @@ module ActionController
     def self.before_filter(name)
       @@before_filters << name
     end
+    def self.helper(mod)
+      extend mod
+    end
   end
 end
 
@@ -27,6 +32,15 @@ class ApplicationController < ActionController::Base
   def self.hello
     "Hello!"
   end
+  
+  def self.capture(&block)
+    @@capture = true
+    block.call
+  end
+  
+  def self.capture_triggered
+    @@capture ||= false
+  end
 end
 
-Draper::System.setup
+Draper::System.setup

data/spec/{samples → support/samples}/product.rb

@@ -1,4 +1,26 @@
 class Product < ActiveRecord::Base
+  include Draper::ModelSupport
+
+  def self.first
+    @@first ||= Product.new
+  end
+
+  def self.last
+    @@last ||= Product.new
+  end
+  
+  def self.all
+    [Product.new, Product.new]
+  end
+
+  def self.scoped
+    [Product.new]
+  end
+
+  def self.model_name
+    "Product"
+  end
+
   def self.find(id)
     return Product.new
   end
@@ -22,4 +44,4 @@ class Product < ActiveRecord::Base
   def block
     yield
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: draper
 version: !ruby/object:Gem::Version
-  version: 0.9.3
+  version: 0.9.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,10 +9,20 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-20 00:00:00.000000000Z
-dependencies: []
-description: Draper reimagines the role of helpers in the view layer of a Rails application,
-  allowing an object-oriented approach rather than procedural.
+date: 2011-10-29 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70218782393040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.3.10
+  type: :runtime
+  prerelease: false
+  version_requirements: *70218782393040
+description: Draper implements a decorator or presenter pattern for Rails applications.
 email:
 - jeff@casimircreative.com
 executables: []
@@ -20,6 +30,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - .travis.yml
 - .yardopts
 - Gemfile
@@ -51,6 +62,7 @@ files:
 - lib/draper.rb
 - lib/draper/base.rb
 - lib/draper/decorated_enumerable_proxy.rb
+- lib/draper/helper_support.rb
 - lib/draper/lazy_helpers.rb
 - lib/draper/model_support.rb
 - lib/draper/system.rb
@@ -67,22 +79,23 @@ files:
 - lib/generators/test_unit/decorator_generator.rb
 - lib/generators/test_unit/templates/application_decorator_test.rb
 - lib/generators/test_unit/templates/decorator_test.rb
-- spec/base_spec.rb
+- spec/draper/base_spec.rb
+- spec/draper/helper_support_spec.rb
 - spec/draper/model_support_spec.rb
+- spec/draper/view_context_spec.rb
 - spec/generators/draper/decorator/decorator_generator_spec.rb
 - spec/generators/rspec/decorator_generator_spec.rb
 - spec/generators/test_unit/decorator_generator_spec.rb
-- spec/samples/active_record.rb
-- spec/samples/application_controller.rb
-- spec/samples/application_helper.rb
-- spec/samples/decorator.rb
-- spec/samples/decorator_with_allows.rb
-- spec/samples/decorator_with_application_helper.rb
-- spec/samples/decorator_with_denies.rb
-- spec/samples/product.rb
-- spec/samples/product_decorator.rb
 - spec/spec_helper.rb
-- spec/view_context_spec.rb
+- spec/support/samples/active_record.rb
+- spec/support/samples/application_controller.rb
+- spec/support/samples/application_helper.rb
+- spec/support/samples/decorator.rb
+- spec/support/samples/decorator_with_allows.rb
+- spec/support/samples/decorator_with_application_helper.rb
+- spec/support/samples/decorator_with_denies.rb
+- spec/support/samples/product.rb
+- spec/support/samples/product_decorator.rb
 homepage: http://github.com/jcasimir/draper
 licenses: []
 post_install_message: 
@@ -106,21 +119,22 @@ rubyforge_project: draper
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: Decorator pattern implmentation for Rails.
+summary: Decorator pattern implementation for Rails.
 test_files:
-- spec/base_spec.rb
+- spec/draper/base_spec.rb
+- spec/draper/helper_support_spec.rb
 - spec/draper/model_support_spec.rb
+- spec/draper/view_context_spec.rb
 - spec/generators/draper/decorator/decorator_generator_spec.rb
 - spec/generators/rspec/decorator_generator_spec.rb
 - spec/generators/test_unit/decorator_generator_spec.rb
-- spec/samples/active_record.rb
-- spec/samples/application_controller.rb
-- spec/samples/application_helper.rb
-- spec/samples/decorator.rb
-- spec/samples/decorator_with_allows.rb
-- spec/samples/decorator_with_application_helper.rb
-- spec/samples/decorator_with_denies.rb
-- spec/samples/product.rb
-- spec/samples/product_decorator.rb
 - spec/spec_helper.rb
-- spec/view_context_spec.rb
+- spec/support/samples/active_record.rb
+- spec/support/samples/application_controller.rb
+- spec/support/samples/application_helper.rb
+- spec/support/samples/decorator.rb
+- spec/support/samples/decorator_with_allows.rb
+- spec/support/samples/decorator_with_application_helper.rb
+- spec/support/samples/decorator_with_denies.rb
+- spec/support/samples/product.rb
+- spec/support/samples/product_decorator.rb