draper 0.11.1 → 0.12.0

data/CHANGELOG.txt

@@ -0,0 +1,23 @@
+= Draper Changelog
+
+= Master
+
+== 0.12.1
+
+* Added Changelog
+
+* Prevented double decoration, see #173
+
+* ActiveModel::Errors support, 19496f0c
+
+* Fixed autoloading issue, see #188
+
+* Re-did generators, see 9155e58f
+
+* Added capybara integration, see 57c8678e
+
+* Fixed a few bugs with the DecoratedEnumerableProxy
+
+== 0.11.1
+
+* Fixed regression, we don't want to introduce a hard dependency on Rails. #107

data/Gemfile

@@ -10,4 +10,8 @@ gem 'guard-rspec'
 gem 'launchy'
 gem 'yard'
 
+group :development do
+  gem 'redcarpet'
+end
+
 gemspec

data/Readme.markdown

@@ -6,22 +6,31 @@
 ## Quick Start
 
 1. Add `gem 'draper'` to your `Gemfile` and `bundle`
-2. Run `rails g draper:install` to create the directory and `ApplicationDecorator`
-3. Run `rails g draper:decorator YourModel`
+2. When you generate a resource with `rails g resource YourModel`, you get a decorator automatically!
+3. If YourModel exists, run `rails g decorator YourModel`
 4. Edit `app/decorators/[your_model]_decorator.rb` using:
   1. `h` to proxy to Rails/application helpers like `h.current_user`
   2. `[your_model]` to access the wrapped object like `article.created_at`
-5. Put common decorations in `app/decorators/application.rb`  
-6. Wrap models in your controller with the decorator using:
+5. Wrap models in your controller with the decorator using:
   1. `.find` automatic lookup & wrap
     ex: `ArticleDecorator.find(1)`
   2. `.decorate` method with single object or collection, 
     ex: `ArticleDecorator.decorate(Article.all)`
   3. `.new` method with single object
     ex: `ArticleDecorator.new(Article.first)`
-7. Output the instance methods in your view templates
+6. Output the instance methods in your view templates
   ex: `@article_decorator.created_at`
 
+If you need common methods in your decorators, create an `app/decorators/application_decorator.rb`:
+
+``` ruby
+class ApplicationDecorator < Draper::Base
+  # your methods go here
+end
+```
+
+and make your decorators inherit from it. Newly generated decorators will respect this choice and inherit from `ApplicationDecorator`.
+
 ## Watch the RailsCast
 
 Ryan Bates has put together an excellent RailsCast on Draper based on the 0.8.0 release:
@@ -146,12 +155,20 @@ gem "draper"
 
 Then run `bundle` from the project directory.
 
+### Run the draper:install command
+
+This will create the `app/decorators` directory and the `ApplicationDecorator` inside it.
+
+```
+rails generate draper:install
+```
+
 ### Generate the Decorator
 
 To decorate a model named `Article`:
 
 ```
-rails generate draper:decorator Article
+rails generate draper:decorator article
 ```
 
 ### Writing Methods
@@ -239,7 +256,7 @@ ActionMailer class.
 
 ```ruby
 class ArticleMailer < ActionMailer::Base
-  defaults 'init-draper' => Proc.new { set_current_view_context }
+  default 'init-draper' => Proc.new { set_current_view_context }
 end
 ```
 ### Integration with RSpec
@@ -348,6 +365,14 @@ Now when you call the association it will use a decorator.
 <%= @article.author.fancy_name %>
 ```
 
+## Contributing
+
+1. Fork it.
+2. Create a branch (`git checkout -b my_awesome_branch`)
+3. Commit your changes (`git commit -am "Added some magic"`)
+4. Push to the branch (`git push origin my_awesome_branch`)
+5. Send pull request
+
 ## Issues / Pending
 
 * Documentation
@@ -355,7 +380,6 @@ Now when you call the association it will use a decorator.
   * Add information about the `.decorator` method
   * Make clear the pattern of overriding accessor methods of the wrapped model  
   * Build sample Rails application(s)
-  * Add a section about contributing
 * Generators
   * Implement hook so generating a controller/scaffold generates a decorator  
   * Add generators for...

data/draper.gemspec

@@ -16,4 +16,5 @@ 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_development_dependency('redcarpet')
 end

data/lib/draper.rb

@@ -1,5 +1,6 @@
 require "draper/version"
 require 'draper/system'
+require 'draper/active_model_support'
 require 'draper/base'
 require 'draper/lazy_helpers'
 require 'draper/model_support'

data/lib/draper/active_model_support.rb

@@ -0,0 +1,24 @@
+module Draper::ActiveModelSupport
+  module Proxies
+    def create_proxies
+      # 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)
+
+      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)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/draper/base.rb

@@ -1,20 +1,18 @@
 module Draper
   class Base
     require 'active_support/core_ext/class/attribute'
+    require 'active_support/core_ext/array/extract_options'
+
     class_attribute :denied, :allowed, :model_class
     attr_accessor :model, :options
 
-    DEFAULT_DENIED = Object.new.methods << :method_missing
+    DEFAULT_DENIED = Object.instance_methods << :method_missing
     DEFAULT_ALLOWED = []
-    FORCED_PROXY = [:to_param, :id]
-    FORCED_PROXY.each do |method|
-      define_method method do |*args, &block|
-        model.send method, *args, &block
-      end
-    end
     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,8 +22,9 @@ module Draper
     def initialize(input, options = {})
       input.inspect # forces evaluation of a lazy query from AR
       self.class.model_class = input.class if model_class.nil?
-      @model = input
+      @model = input.kind_of?(Draper::Base) ? input.model : input
       self.options = options
+      create_proxies
     end
 
     # Proxies to the class specified by `decorates` to automatically
@@ -60,7 +59,7 @@ module Draper
     # the assocation to be decorated when it is retrieved.
     #
     # @param [Symbol] name of association to decorate, like `:products`
-    # @option opts [Class] :with The decorator to decorate the association with
+    # @option options [Class] :with The decorator to decorate the association with
     def self.decorates_association(association_symbol, options = {})
       define_method(association_symbol) do
         orig_association = model.send(association_symbol)
@@ -69,15 +68,16 @@ module Draper
 
         return options[:with].decorate(orig_association) if options[:with]
 
-        if options[:polymorphic]
-          klass = orig_association.class
-        elsif model.class.respond_to?(:reflect_on_association) && model.class.reflect_on_association(association_symbol)
-          klass = model.class.reflect_on_association(association_symbol).klass
-        elsif orig_association.respond_to?(:first)
-          klass = orig_association.first.class
-        else
-          klass = orig_association.class
-        end
+        klass = if options[:polymorphic]
+                  orig_association.class
+                elsif association_reflection = find_association_reflection(association_symbol)
+                  association_reflection.klass
+                elsif orig_association.respond_to?(:first)
+                  orig_association.first.class
+                else
+                  orig_association.class
+                end
+
         "#{klass}Decorator".constantize.decorate(orig_association, options)
       end
     end
@@ -129,6 +129,8 @@ module Draper
     #
     # @param [Object] instance(s) to wrap
     # @param [Hash] options (optional)
+    # @option options [Boolean] :infer If true, each model will be
+    #   wrapped by its inferred decorator.
     def self.decorate(input, options = {})
       if input.instance_of?(self)
         input.options = options unless options.empty?
@@ -206,7 +208,7 @@ module Draper
     alias :is_a? :kind_of?
 
     def respond_to?(method, include_private = false)
-      super || (allow?(method) && model.respond_to?(method))
+      super || (allow?(method) && model.respond_to?(method, include_private))
     end
 
     def method_missing(method, *args, &block)
@@ -228,8 +230,8 @@ module Draper
     end
 
     def self.method_missing(method, *args, &block)
-      if method.to_s.match(/^find_by.*/)
-        self.decorate(model_class.send(method, *args, &block))
+      if method.to_s.match(/^find_((all_|last_)?by_|or_(initialize|create)_by_).*/)
+        self.decorate(model_class.send(method, *args, &block), :context => args.dup.extract_options!)
       else
         model_class.send(method, *args, &block)
       end
@@ -255,7 +257,13 @@ module Draper
   private
 
     def allow?(method)
-      (allowed.empty? || allowed.include?(method) || FORCED_PROXY.include?(method)) && !denied.include?(method)
+      (allowed.empty? || allowed.include?(method)) && !denied.include?(method)
+    end
+
+    def find_association_reflection(association)
+      if model.class.respond_to?(:reflect_on_association)
+        model.class.reflect_on_association(association)
+      end
     end
   end
 end

data/lib/draper/decorated_enumerable_proxy.rb

@@ -2,28 +2,27 @@ module Draper
   class DecoratedEnumerableProxy
     include Enumerable
 
+    delegate :as_json, :collect, :map, :each, :[], :all?, :include?, :first, :last, :shift, :to => :decorated_collection
+
     def initialize(collection, klass, options = {})
       @wrapped_collection, @klass, @options = collection, klass, options
     end
 
-    def each(&block)
-      @wrapped_collection.each { |member| block.call(@klass.decorate(member, @options)) }
-    end
-
-    def to_ary
-      @wrapped_collection.map { |member| @klass.decorate(member, @options) }
+    def decorated_collection
+      @decorated_collection ||= @wrapped_collection.collect { |member| @klass.decorate(member, @options) }
     end
+    alias_method :to_ary, :decorated_collection
 
     def method_missing (method, *args, &block)
       @wrapped_collection.send(method, *args, &block)
     end
 
-    def respond_to?(method)
-      super || @wrapped_collection.respond_to?(method)
+    def respond_to?(method, include_private = false)
+      super || @wrapped_collection.respond_to?(method, include_private)
     end
 
     def kind_of?(klass)
-      super || @wrapped_collection.kind_of?(klass)
+      @wrapped_collection.kind_of?(klass) || super
     end
     alias :is_a? :kind_of?
 
@@ -38,6 +37,10 @@ module Draper
     def to_s
       "#<DecoratedEnumerableProxy of #{@klass} for #{@wrapped_collection.inspect}>"
     end
+    
+    def context=(input)
+      self.map { |member| member.context = input }
+    end
 
     def source
       @wrapped_collection

data/lib/draper/helper_support.rb

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

data/lib/draper/lazy_helpers.rb

@@ -8,4 +8,4 @@ module Draper
       end
     end
   end
-end
+end

data/lib/draper/model_support.rb

@@ -1,4 +1,6 @@
 module Draper::ModelSupport
+  extend ActiveSupport::Concern
+
   def decorator(options = {})
     @decorator ||= "#{self.class.name}Decorator".constantize.decorate(self, options.merge(:infer => false))
     block_given? ? yield(@decorator) : @decorator
@@ -12,8 +14,4 @@ module Draper::ModelSupport
       block_given? ? yield(decorator_proxy) : decorator_proxy
     end
   end
-
-  def self.included(base)
-    base.extend(ClassMethods)
-  end
 end

data/lib/draper/railtie.rb

@@ -1,8 +1,39 @@
 require 'rails/railtie'
 
+module ActiveModel
+  class Railtie < Rails::Railtie
+    generators do |app|
+      Rails::Generators.configure!(app.config.generators)
+      require "generators/resource_override"
+    end
+  end
+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|
+      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)

data/lib/draper/rspec_integration.rb

@@ -3,20 +3,31 @@ module Draper
     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/
-    }
+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
-      end
-      example.call
+  # 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
 

data/lib/draper/system.rb

@@ -1,5 +1,14 @@
 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)