draper 0.12.1 → 0.17.0

data/.gitignore

@@ -6,4 +6,8 @@ pkg/*
 coverage.data
 coverage/*
 .yardoc
-tmp
+tmp
+vendor/bundle
+*.swp
+*.swo
+*.DS_Store

data/.rspec

@@ -1 +1,2 @@
 --color
+--order rand

data/.travis.yml

@@ -1,6 +1,4 @@
 rvm:
-  - 1.8.7
-  - 1.9.2
-  - rbx
-  - ree
-  - jruby
+  - 1.9.3
+  - rbx-19mode
+  - jruby-19mode

data/CHANGELOG.markdown

@@ -0,0 +1,51 @@
+# Draper Changelog
+
+## 0.16.0
+
+* [Automatically prime `view_context`](https://github.com/jcasimir/draper/commit/057ab4e8)
+* [Fixed bug where rspec eq matchers didn't work]((https://github.com/jcasimir/draper/commit/57617b)
+* [Sequel ORM support](https://github.com/jcasimir/draper/commit/7d4942)
+* Fixed issues with newer minitest
+* [Changed the way the `view_context` gets set](https://github.com/jcasimir/draper/commit/0b03d9c)
+
+## 0.15.0
+
+* Proper minitest integration
+* [We can properly decorate scoped associations](https://github.com/jcasimir/draper/issues/223)
+* [Fixed awkward eager loading](https://github.com/jcasimir/draper/commit/7dc3510b)
+
+## 0.14.0
+
+* [Properly prime the view context in Rails Console](https://github.com/jcasimir/draper/commit/738074f)
+* Make more gems development requirements only
+
+## 0.13.0
+
+* Upgraded all dependencies
+* Dropped support for Rubies < 1.9.3
+* `#to_model` has been renamed to `#wrapped_object`
+* Allow proper overriding of special `ActiveModel` methods
+
+## 0.12.3
+
+* [Fix i18n issue](https://github.com/jcasimir/draper/issues/202)
+
+## 0.12.2
+
+* Fix bug with initializing ammeter
+* Some gems are now development only in the gemspec
+* Fix bug where generated models were still inheriting from `ApplicationDecorator`
+
+## 0.12.0
+
+* Added Changelog
+* [Prevented double decoration](https://github.com/jcasimir/draper/issues/173)
+* [`ActiveModel::Errors` support](https://github.com/jcasimir/draper/commit/19496f0c)
+* [Fixed autoloading issue](https://github.com/jcasimir/draper/issues/188)
+* [Re-did generators](https://github.com/jcasimir/draper/commit/9155e58f)
+* [Added capybara integration](https://github.com/jcasimir/draper/commit/57c8678e)
+* Fixed a few bugs with the `DecoratedEnumerableProxy`
+
+## 0.11.1
+
+* [Fixed regression, we don't want to introduce a hard dependency on Rails](https://github.com/jcasimir/draper/issues/107)

data/Readme.markdown

@@ -1,7 +1,6 @@
 # Draper: View Models for Rails
 
 [![TravisCI Build Status](https://secure.travis-ci.org/jcasimir/draper.png)](http://travis-ci.org/jcasimir/draper)
-[![Gemnasium Build Status](https://gemnasium.com/jcasimir/draper.png)](https://gemnasium.com/jcasimir/draper)
 
 ## Quick Start
 
@@ -39,7 +38,7 @@ Ryan Bates has put together an excellent RailsCast on Draper based on the 0.8.0
 
 ## What's New
 
-Check out the full commit history at https://github.com/jcasimir/draper/compare/ad94f54369deabd11315fc241c66b74a30adec0a...04bb00505b7832419fddba20e5068317610eb38d
+Check out the full commit history at http://github.com/jcasimir/draper/commits
 
 In summary, you can now:
 
@@ -66,8 +65,9 @@ Why hate normal helpers? In Ruby/Rails we approach everything from an Object-Ori
 A decorator wraps an object with presentation-related accessor methods. For instance, if you had an `Article` object, then the decorator could override `.published_at` to use formatted output like this:
 
 ```ruby
-class ArticleDecorator < ApplicationDecorator
+class ArticleDecorator < Draper::Base
   decorates :article
+
   def published_at
     date = h.content_tag(:span, article.published_at.strftime("%A, %B %e").squeeze(" "), :class => 'date')
     time = h.content_tag(:span, article.published_at.strftime("%l:%M%p"), :class => 'time').delete(" ")
@@ -89,6 +89,7 @@ When you use a decorator you have the power of a Ruby object but it's a part of
 ```ruby
 class ArticleDecorator < ApplicationDecorator
   decorates :article
+  
   ADMIN_VISIBLE_ATTRIBUTES = [:title, :body, :author, :status]
   PUBLIC_VISIBLE_ATTRIBUTES = [:title, :body]
 
@@ -232,7 +233,7 @@ ArticleDecorator.decorate(Article.all)   # Returns an enumeration proxy of Artic
 ```ruby
 ArticleDecorator.find(1)
 ```
-  
+
 ### In Your Views
 
 Use the new methods in your views like any other model method (ex: `@article.published_at`):
@@ -241,25 +242,15 @@ 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
-ActionMailer class.
-
-```ruby
-class ArticleMailer < ActionMailer::Base
-  default 'init-draper' => Proc.new { set_current_view_context }
-end
-```
 ### Integration with RSpec
 
 Using the provided generator, Draper will place specs for your new decorator in `spec/decorators/`. 
 
-By default, specs in `spec/decorators` will be tagged as `type => :decorator`. Any spec tagged as `decorator` will run `ApplicationController.new.set_current_view_context` which makes helpers available to the decorator.
+By default, specs in `spec/decorators` will be tagged as `type => :decorator`. Any spec tagged as `decorator` will make helpers available to the decorator.
 
 If your decorator specs live somewhere else, which they shouldn't, make sure to tag them with `type => :decorator`. If you don't tag them, Draper's helpers won't be available to your decorator while testing. 
 
-Note: If you're using Spork, you need to `require 'draper/rspec_integration'` in your Spork.prefork block.
+Note: If you're using Spork, you need to `require 'draper/test/rspec_integration'` in your Spork.prefork block.
 
 ## Possible Decoration Methods
 
@@ -289,7 +280,7 @@ First, follow the steps above to add the dependency and update your bundle.
 Since we're talking about the `Article` model we'll create an `ArticleDecorator` class. You could do it by hand, but use the provided generator:
 
 ```
-rails generate draper:decorator Article
+rails generate decorator Article
 ```
 
 Now open up the created `app/decorators/article_decorator.rb` and you'll find an `ArticleDecorator` class. Add this method:
@@ -357,6 +348,30 @@ Now when you call the association it will use a decorator.
 <%= @article.author.fancy_name %>
 ```
 
+### A note on Rails configuration
+
+Draper loads your application's decorators when Rails start. This may lead to an issue with configuring I18n, whereby the settings you provide in `./config/application.rb` are ignored. This happens when you use the `I18n` constant at the class-level in one of the models that have a decorator, as in the following example:
+
+```ruby
+# app/models/user.rb
+class User < ActiveRecord::Base
+  validates :email, presence: { message: I18n.t('invalid_email') }
+end
+
+# app/decorators/user_decorator.rb
+class UserDecorator < ApplicationDecorator
+  decorates :user
+end
+```
+
+Note how the `validates` line is executed when the `User` class is loaded, triggering the initialization of the I18n framework _before_ Rails had a chance to apply its configuration.
+
+Using `I18n` directly in your model definition **is an antipattern**. The preferred solution would be to not override the `message` option in your `validates` macro, but provide the `activerecord.errors.models.attributes.user.email.presence` key in your translation files.
+
+## Extension gems
+
+For automatic decoration, check out [decorates_before_rendering](https://github.com/ohwillie/decorates_before_rendering).
+
 ## Contributing
 
 1. Fork it.

data/draper.gemspec

@@ -16,15 +16,12 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_dependency 'activesupport', '>= 2.3.10'
-  s.add_dependency 'rake'
-  s.add_dependency 'rspec', '~> 2.0'
-  s.add_dependency 'activesupport', '~> 3.1.3'
-  s.add_dependency 'actionpack', "~> 3.1.3"
+  s.add_dependency 'activesupport', '~> 3.2'
+  s.add_dependency 'actionpack', '~> 3.2'
 
-  s.add_development_dependency 'ammeter', '~> 0.2.2'
-  s.add_development_dependency 'guard'
-  s.add_development_dependency 'guard-rspec'
-  s.add_development_dependency 'launchy'
+  s.add_development_dependency 'ammeter', '0.2.2'
+  s.add_development_dependency 'rake', '~> 0.9.2'
+  s.add_development_dependency 'rspec', '~> 2.10'
   s.add_development_dependency 'yard'
+  s.add_development_dependency 'minitest', '~> 3.0' if RUBY_PLATFORM == "java"
 end

data/lib/draper/active_model_support.rb

@@ -1,24 +1,27 @@
 module Draper::ActiveModelSupport
   module Proxies
-    def create_proxies
+    def self.extended(base)
       # These methods (as keys) will be created only if the correspondent
-      # model descends from a specific class (as value)
-      proxies = {}
-      proxies[:to_param] = ActiveModel::Conversion if defined?(ActiveModel::Conversion)
-      proxies[:errors]   = ActiveModel::Validations if defined?(ActiveModel::Validations)
-      proxies[:id]       = ActiveRecord::Base if defined?(ActiveRecord::Base)
+      # model responds to the method
+      proxies = [:to_param, :errors, :id]
 
-      proxies.each do |method_name, dependency|
-        if model.kind_of?(dependency) || dependency.nil?
-          class << self
-            self
-          end.class_eval do
-            self.send(:define_method, method_name) do |*args, &block|
-              model.send(method_name, *args, &block)
+      proxies.each do |method_name|
+        if base.model.respond_to?(method_name)
+          base.singleton_class.class_eval do
+            if !base.class.instance_methods.include?(method_name) || base.class.instance_method(method_name).owner === Draper::Base
+              define_method(method_name) do |*args, &block|
+                model.send(method_name, *args, &block)
+              end
             end
           end
         end
       end
+
+      base.class_eval do
+        def to_model
+          self
+        end
+      end
     end
   end
 end

data/lib/draper/base.rb

@@ -11,8 +11,6 @@ module Draper
     self.denied = DEFAULT_DENIED
     self.allowed = DEFAULT_ALLOWED
 
-    include Draper::ActiveModelSupport::Proxies
-
     # Initialize a new decorator instance by passing in
     # an instance of the source class. Pass in an optional
     # context inside the options hash is stored for later use.
@@ -24,7 +22,7 @@ module Draper
       self.class.model_class = input.class if model_class.nil?
       @model = input.kind_of?(Draper::Base) ? input.model : input
       self.options = options
-      create_proxies
+      self.extend Draper::ActiveModelSupport::Proxies
     end
 
     # Proxies to the class specified by `decorates` to automatically
@@ -59,12 +57,16 @@ module Draper
     # the assocation to be decorated when it is retrieved.
     #
     # @param [Symbol] name of association to decorate, like `:products`
-    # @option options [Class] :with The decorator to decorate the association with
+    # @option options [Hash] :with The decorator to decorate the association with
+    #                        :scope The scope to apply to the association
     def self.decorates_association(association_symbol, options = {})
       define_method(association_symbol) do
         orig_association = model.send(association_symbol)
 
         return orig_association if orig_association.nil?
+        return decorated_associations[association_symbol] if decorated_associations[association_symbol]
+
+        orig_association = orig_association.send(options[:scope]) if options[:scope]
 
         return options[:with].decorate(orig_association) if options[:with]
 
@@ -78,7 +80,7 @@ module Draper
                   orig_association.class
                 end
 
-        "#{klass}Decorator".constantize.decorate(orig_association, options)
+        decorated_associations[association_symbol] = "#{klass}Decorator".constantize.decorate(orig_association, options)
       end
     end
 
@@ -87,7 +89,8 @@ module Draper
     #
     # @param [Symbols*] name of associations to decorate
     def self.decorates_associations(*association_symbols)
-      association_symbols.each{ |sym| decorates_association(sym) }
+      options = association_symbols.extract_options!
+      association_symbols.each{ |sym| decorates_association(sym, options) }
     end
 
     # Specifies a black list of methods which may *not* be proxied to
@@ -103,6 +106,16 @@ module Draper
       self.denied += input_denied
     end
 
+    # Specifies that all methods may *not* be proxied to
+    # to the wrapped object.
+    #
+    # Do not use `.allows` and `.denies` in combination with '.denies_all'
+    def self.denies_all
+      raise ArgumentError, "Use either 'allows' or 'denies', but not both." unless ((self.allowed == DEFAULT_ALLOWED && self.denied == DEFAULT_DENIED) || (self.allowed != DEFAULT_ALLOWED && self.denied != DEFAULT_DENIED))
+      self.denied  += [nil]  # Add dummy value to denied to prevent calls to #allows.  Hacky???
+      self.allowed += [nil]  # Add dummy value to allowed to prevent calls to #denies
+    end
+
     # Specifies a white list of methods which *may* be proxied to
     # to the wrapped object. When `allows` is used, only the listed
     # methods and methods defined in the decorator itself will be
@@ -135,7 +148,7 @@ module Draper
       if input.instance_of?(self)
         input.options = options unless options.empty?
         return input
-      elsif input.respond_to?(:each)
+      elsif input.respond_to?(:each) && (!defined?(Sequel) || !input.is_a?(Sequel::Model))
         Draper::DecoratedEnumerableProxy.new(input, self, options)
       elsif options[:infer]
         input.decorator(options)
@@ -160,12 +173,30 @@ module Draper
       decorate(model_class.last, options)
     end
 
+    # 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
+    class HelpersWrapper
+      def initialize(helpers)
+        @helpers = helpers
+      end
+
+      def method_missing(method, *args, &block)
+        @helpers.send(method, *args, &block)
+      end
+
+      #needed for tests
+      def ==(other)
+        other.instance_variable_get(:@helpers) == @helpers
+      end
+    end
+
     # Access the helpers proxy to call built-in and user-defined
     # Rails helpers. Aliased to `.h` for convenience.
     #
     # @return [Object] proxy
     def helpers
-      self.class.helpers
+      HelpersWrapper.new self.class.helpers
     end
     alias :h :helpers
 
@@ -191,7 +222,7 @@ module Draper
     # Fetch the original wrapped model.
     #
     # @return [Object] original_model
-    def to_model
+    def wrapped_object
       @model
     end
 
@@ -211,12 +242,20 @@ module Draper
       super || (allow?(method) && model.respond_to?(method, include_private))
     end
 
+    # We always want to delegate present, in case we decorate a nil object.
+    #
+    # I don't like the idea of decorating a nil object, but we'll deal with
+    # that later.
+    def present?
+      model.present?
+    end
+
     def method_missing(method, *args, &block)
       super unless allow?(method)
 
       if model.respond_to?(method)
-        self.class.send :define_method, method do |*args, &block|
-          model.send method, *args, &block
+        self.class.send :define_method, method do |*args, &blokk|
+          model.send method, *args, &blokk
         end
 
         send method, *args, &block
@@ -265,5 +304,9 @@ module Draper
         model.class.reflect_on_association(association)
       end
     end
+
+    def decorated_associations
+      @decorated_associations ||= {}
+    end
   end
 end

data/lib/draper/decorated_enumerable_proxy.rb

@@ -1,3 +1,4 @@
+require 'active_support/core_ext/object/blank'
 module Draper
   class DecoratedEnumerableProxy
     include Enumerable
@@ -13,6 +14,16 @@ module Draper
     end
     alias_method :to_ary, :decorated_collection
 
+    def find(ifnone_or_id = nil, &blk)
+      if block_given?
+        source.find(ifnone_or_id, &blk)
+      else
+        obj = decorated_collection.first
+        return nil if obj.blank?
+        obj.class.find(ifnone_or_id)
+      end
+    end
+
     def method_missing (method, *args, &block)
       @wrapped_collection.send(method, *args, &block)
     end
@@ -27,17 +38,13 @@ module Draper
     alias :is_a? :kind_of?
 
     def ==(other)
-      @wrapped_collection == other
-    end
-
-    def [](index)
-      @klass.new(@wrapped_collection[index], @options)
+      @wrapped_collection == (other.respond_to?(:source) ? other.source : other)
     end
 
     def to_s
       "#<DecoratedEnumerableProxy of #{@klass} for #{@wrapped_collection.inspect}>"
     end
-    
+
     def context=(input)
       self.map { |member| member.context = input }
     end

data/lib/draper/railtie.rb

@@ -12,39 +12,40 @@ end
 module Draper
   class Railtie < Rails::Railtie
 
-    ##
-    # Decorators are loaded in
-    # => at app boot in non-development environments
-    # => after each request in the development environment
-    #
-    # This is necessary because we might never explicitly reference
-    # Decorator constants.
-    #
-    config.to_prepare do
-      ::Draper::System.load_app_local_decorators
-    end
-
     ##
     # The `app/decorators` path is eager loaded
     #
     # This is the standard "Rails Way" to add paths from which constants
     # can be loaded.
     #
-    config.before_initialize do |app|
+    config.after_initialize do |app|
       app.config.paths.add 'app/decorators', :eager_load => true
     end
 
     initializer "draper.extend_action_controller_base" do |app|
       ActiveSupport.on_load(:action_controller) do
-        Draper::System.setup(:action_controller)
+        Draper::System.setup(self)
       end
     end
 
     initializer "draper.extend_action_mailer_base" do |app|
       ActiveSupport.on_load(:action_mailer) do
-        Draper::System.setup(:action_mailer)
+        Draper::System.setup(self)
       end
     end
 
+    initializer "draper.extend_active_record_base" do |app|
+      ActiveSupport.on_load(:active_record) do
+        self.send(:include, Draper::ModelSupport)
+      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             ||= {}
+    end
   end
 end

data/lib/draper/rspec_integration.rb

@@ -1,33 +1,2 @@
-module Draper
-  module DecoratorExampleGroup
-    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/
-  }
-
-  # Specs tagged type: :decorator set the Draper view context
-  config.around do |example|
-    if :decorator == example.metadata[:type]
-      ApplicationController.new.set_current_view_context
-      Draper::ViewContext.current.controller.request ||= ActionController::TestRequest.new
-      Draper::ViewContext.current.request            ||= Draper::ViewContext.current.controller.request
-      Draper::ViewContext.current.params             ||= {}
-    end
-    example.call
-  end
-end
-
-if defined?(Capybara)
-  require 'capybara/rspec/matchers'
-
-  RSpec.configure do |config|
-    config.include Capybara::RSpecMatchers, :type => :decorator
-  end
-end
-
+warn 'DEPRECATION WARNING -- use `require "draper/test/rspec_integration"` instead of `require "draper/rspec_integration"`'
+require 'draper/test/rspec_integration'

data/lib/draper/system.rb

@@ -1,20 +1,9 @@
 module Draper
   class System
-    def self.app_local_decorator_glob
-      'app/decorators/**/*_decorator.rb'
-    end
-
-    def self.load_app_local_decorators
-      decorator_files = Dir[ "#{ Rails.root }/#{ app_local_decorator_glob }" ]
-      decorator_files.each { |d| require_dependency d }
-    end
-
     def self.setup(component)
-      if component == :action_controller
-        ActionController::Base.send(:include, Draper::ViewContextFilter)
-        ActionController::Base.extend(Draper::HelperSupport)
-      elsif component == :action_mailer
-        ActionMailer::Base.send(:include, Draper::ViewContextFilter)
+      component.class_eval do
+        include Draper::ViewContext
+        extend  Draper::HelperSupport unless defined?(::ActionMailer) && self.is_a?(::ActionMailer::Base)
       end
     end
   end

data/lib/draper/test/minitest_integration.rb

@@ -0,0 +1,26 @@
+require 'draper/test/view_context'
+
+module MiniTest
+  class Spec
+    class Decorator < Spec
+      before { Draper::ViewContext.infect!(self) }
+    end
+  end
+end
+
+class MiniTest::Unit::DecoratorTestCase < MiniTest::Unit::TestCase
+  if method_defined?(:before_setup)
+    # for minitext >= 2.11
+    def before_setup
+      super
+      Draper::ViewContext.infect!(self)
+    end
+  else
+    # for older minitest, like what ships w/Ruby 1.9
+    add_setup_hook { Draper::ViewContext.infect!(self) }
+  end
+end
+
+MiniTest::Spec.register_spec_type(MiniTest::Spec::Decorator) do |desc|
+  desc.superclass == Draper::Base
+end

data/lib/draper/test/rspec_integration.rb

@@ -0,0 +1,28 @@
+require 'draper/test/view_context'
+
+module Draper
+  module DecoratorExampleGroup
+    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/
+  }
+
+  # Specs tagged type: :decorator set the Draper view context
+  config.before :type => :decorator do
+    Draper::ViewContext.infect!(self)
+  end
+end
+
+if defined?(Capybara)
+  require 'capybara/rspec/matchers'
+
+  RSpec.configure do |config|
+    config.include Capybara::RSpecMatchers, :type => :decorator
+  end
+end

data/lib/draper/test/view_context.rb

@@ -0,0 +1,12 @@
+module Draper
+  module ViewContext
+    def self.infect!(context)
+      context.instance_eval do
+        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             ||= {}
+      end
+    end
+  end
+end

data/lib/draper/version.rb

@@ -1,3 +1,3 @@
 module Draper
-  VERSION = "0.12.1"
+  VERSION = "0.17.0"
 end

data/lib/draper/view_context.rb

@@ -1,21 +1,17 @@
 module Draper
   module ViewContext
     def self.current
-      Thread.current[:current_view_context]
+      Thread.current[:current_view_context] || ApplicationController.new.view_context
     end
 
     def self.current=(input)
       Thread.current[:current_view_context] = input
     end
-  end
-
-  module ViewContextFilter
-    def set_current_view_context
-      Draper::ViewContext.current = self.view_context
-    end
 
-    def self.included(source)
-      source.send(:before_filter, :set_current_view_context) if source.respond_to?(:before_filter)
+    def view_context
+      super.tap do |context|
+        Draper::ViewContext.current = context
+      end
     end
   end
 end

data/lib/draper.rb

@@ -9,6 +9,8 @@ require 'draper/model_support'
 require 'draper/helper_support'
 require 'draper/view_context'
 require 'draper/decorated_enumerable_proxy'
-require 'draper/rspec_integration' if defined?(RSpec) and RSpec.respond_to?(:configure)
 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::Spec)