draper 3.0.0.pre1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 016c0c7b5f38f0560c5629e83abcc175401cdcb4
-  data.tar.gz: eb23dac2cdc58bf4a2eedccd0f468b25f2df49b8
+  metadata.gz: 6f2c896cc71e7e4e654a5d65907dd0ec4cefed7f
+  data.tar.gz: ce50051cf161e9416483a40797d38ae2d2da3384
 SHA512:
-  metadata.gz: 4fc57f67ed9b7f7779f93c7393c4a91a883ed5a5393dffa6be88da26171bfa6ae463db4d73c5d8831dc4c8f5f4fa3d6e61e3a38c8fec02e9d481c7c3e88ab85d
-  data.tar.gz: 972827d365bf4d02bc8bb9f817c6fab065a9de81bf9f80c3de67b2be8fc12b1216d5e459fa561997afe9debad1456d704da2d2f8d108aef8fdcccbc6139da317
+  metadata.gz: 527adb1c71ce28f23bb9be4186fe857c543a26edd8d20404f1e2a6db51e819143dd9c7973f7735746457c2a8a392e7a6d5b8a79232d26a1694035e09441a98f4
+  data.tar.gz: 0ed34d19d3b0300ea733392aab2c4cceaa1b284efc71e84452331fea4c9c11c68c7dc00baa7802a864d60f69bfb42beb8f5cecf959ed5ebf01b8a24c7e676f3f

data/.codeclimate.yml

@@ -0,0 +1,16 @@
+---
+engines:
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+ratings:
+  paths:
+  - "**.rb"
+exclude_paths:
+- spec/

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,24 @@
+## Description
+Detail your changes here.  
+A few sentences describing the overall goals of the pull request's commits will suffice.
+Some questions you might answer:
+
+* Why was this change required?
+* Did you have any tough decisions to make? Which one(s) did you go with and why?
+* Are there any deployment impacts to this change?
+* Is there something you aren't happy with or that needs extra attention?
+
+## Testing
+Outline steps to test your changes.
+
+1. Go here.
+1. Click this.
+1. See that.
+
+## To-Dos
+- [ ] tests
+- [ ] documentation
+
+## References
+* [GitHub Issue ####](https://github.com/drapergem/draper/issues/####)
+* [GitHub Pull Request ####](https://github.com/drapergem/draper/pull/####)

data/.rubocop.yml

@@ -0,0 +1,11 @@
+AllCops:
+  TargetRubyVersion: 2.4
+  DisplayCopNames: true
+  Exclude:
+    - 'spec/dummy/**/*'
+
+Style/StringLiterals:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 100

data/.travis.yml

@@ -4,5 +4,6 @@ services:
   - mongodb
 
 rvm:
-  - 2.2.5
-  - 2.3.1
+  - 2.2.6
+  - 2.3.3
+  - 2.4.1

data/CHANGELOG.md

@@ -1,5 +1,25 @@
 # Draper Changelog
 
+## 3.0.0 - 2017
+
+### Breaking Changes
+* Rename UninferrableSourceError to UninferrableObjectError [#768](https://github.com/drapergem/draper/pull/768)
+* Remove conflicting source aliases: `source`, `to_source`, `source_class` and `source_class?` [#786](https://github.com/drapergem/draper/pull/786)
+
+### New Features
+* Generator for creating `ApplicationDecorator` that other decorators inherit from [#796](https://github.com/drapergem/draper/pull/796)
+* Draper configuration with ability to customize the controller Draper uses [#788](https://github.com/drapergem/draper/pull/788)
+* Added support for Rails 5 API-only applications [#793](https://github.com/drapergem/draper/pull/793)
+* Added support for Rails runner [#739](https://github.com/drapergem/draper/pull/739)
+
+### Other Changes
+* Clear view context when the controller changes [#799](https://github.com/drapergem/draper/pull/799)
+* Removed previously deprecated functionality [#785](https://github.com/drapergem/draper/pull/785)
+* Only delegate === if other is an instance of a class that inherits from `Decorator` [#720](https://github.com/drapergem/draper/pull/720)
+* Always default to `CollectionDecorator` when `NameError` is raised [#795](https://github.com/drapergem/draper/pull/795)
+* Fixed issues in order to support Rails 5.1
+* Fixed a bug where helpers were used inside a decorator and this decorator was used outside of controller context
+
 ## 3.0.0.pre1 - 2016-07-10
 
 * Added support for Rails 5, dropped 4.0 - 4.2

data/Guardfile

@@ -1,25 +1,25 @@
 def rspec_guard(options = {}, &block)
   options = {
-    :version => 2,
-    :notification => false
+    version: 2,
+    notification: false
   }.merge(options)
 
   guard 'rspec', options, &block
 end
 
-rspec_guard :spec_paths => %w{spec/draper spec/generators} do
+rspec_guard spec_paths: %w{spec/draper spec/generators} do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
   watch('spec/spec_helper.rb')  { "spec" }
 end
 
-rspec_guard :spec_paths => 'spec/integration', :env => {'RAILS_ENV' => 'development'} do
+rspec_guard spec_paths: 'spec/integration', env: {'RAILS_ENV' => 'development'} do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
   watch('spec/spec_helper.rb')  { "spec" }
 end
 
-rspec_guard :spec_paths => 'spec/integration', :env => {'RAILS_ENV' => 'production'} do
+rspec_guard spec_paths: 'spec/integration', env: {'RAILS_ENV' => 'production'} do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
   watch('spec/spec_helper.rb')  { "spec" }

data/README.md

@@ -107,13 +107,13 @@ Decorators are the ideal place to:
 
 ## Installation
 
-Add Draper to your Gemfile:
+As of version 3.0.0, Draper is only compatible with Rails 5 / Ruby 2.2 and later. Add Draper to your Gemfile.
 
 ```ruby
-gem 'draper'
+  gem 'draper'
 ```
 
-And run `bundle install` within your app's directory.
+After that, run `bundle install` within your app's directory.
 
 If you're upgrading from a 0.x release, the major changes are outlined [in the
 wiki](https://github.com/drapergem/draper/wiki/Upgrading-to-1.0).
@@ -132,6 +132,12 @@ end
 
 ### Generators
 
+To create an `ApplicationDecorator` that all generated decorators inherit from, run...
+
+```
+rails generate draper:install
+```
+
 When you have Draper installed and generate a controller...
 
 ```
@@ -361,6 +367,18 @@ you'll have access to an ArticleDecorator object instead. In your controller you
 can continue to use the `@article` instance variable to manipulate the model -
 for example, `@article.comments.build` to add a new blank comment for a form.
 
+## Configuration
+Draper works out the box well, but also provides a hook for you to configure its 
+default functionality. For example, Draper assumes you have a base `ApplicationController`.
+If your base controller is named something different (e.g. `BaseController`),
+you can tell Draper to use it by adding the following to an initializer:
+
+```ruby
+Draper.configure do |config|
+  config.default_controller = BaseController
+end
+```
+
 ## Testing
 
 Draper supports RSpec, MiniTest::Rails, and Test::Unit, and will add the
@@ -477,7 +495,10 @@ end
 
 When your decorator calls `delegate_all`, any method called on the decorator not
 defined in the decorator itself will be delegated to the decorated object. This
-is a very permissive interface.
+includes calling `super` from within the decorator. A call to `super` from within
+the decorator will first try to call the method on the parent decorator class. If
+the method does not exist on the parent decorator class, it will then try to call
+the method on the decorated `object`. This is a very permissive interface.
 
 If you want to strictly control which methods are called within views, you can
 choose to only delegate certain methods from the decorator to the source model:
@@ -605,7 +626,7 @@ great community of open source
 
 ### Current maintainers
 
-* Sean Linsley
+* Cliff Braton (cliff.braton@gmail.com)
 
 ### Historical maintainers
 
@@ -613,3 +634,4 @@ great community of open source
 * Steve Klabnik (steve@jumpstartlab.com)
 * Vasiliy Ermolovich
 * Andrew Haines
+* Sean Linsley

data/Rakefile

@@ -16,8 +16,7 @@ desc "Run all specs"
 task "spec" => "spec:all"
 
 namespace "spec" do
-  # TODOD: add back "generators"
-  task "all" => ["draper", "integration"]
+  task "all" => ["draper", "generators", "integration"]
 
   def spec_task(name)
     desc "Run #{name} specs"

data/draper.gemspec

@@ -29,4 +29,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'minitest-rails'
   s.add_development_dependency 'capybara'
   s.add_development_dependency 'active_model_serializers', '~> 0.10'
+  s.add_development_dependency 'rubocop'
 end

data/lib/draper.rb

@@ -9,7 +9,9 @@ require 'active_support/core_ext/hash/reverse_merge'
 require 'active_support/core_ext/name_error'
 
 require 'draper/version'
+require 'draper/configuration'
 require 'draper/view_helpers'
+require 'draper/compatibility/api_only'
 require 'draper/delegation'
 require 'draper/automatic_delegation'
 require 'draper/finders'
@@ -27,8 +29,11 @@ require 'draper/decorates_assigned'
 require 'draper/railtie' if defined?(Rails)
 
 module Draper
+  extend Draper::Configuration
+
   def self.setup_action_controller(base)
     base.class_eval do
+      include Draper::Compatibility::ApiOnly if base == ActionController::API
       include Draper::ViewContext
       extend  Draper::HelperSupport
       extend  Draper::DecoratesAssigned
@@ -55,9 +60,9 @@ module Draper
     end
   end
 
-  class UninferrableSourceError < NameError
+  class UninferrableObjectError < NameError
     def initialize(klass)
-      super("Could not infer a source for #{klass}.")
+      super("Could not infer an object for #{klass}.")
     end
   end
 end

data/lib/draper/automatic_delegation.rb

@@ -2,12 +2,14 @@ module Draper
   module AutomaticDelegation
     extend ActiveSupport::Concern
 
-    # Delegates missing instance methods to the source object.
+    # Delegates missing instance methods to the source object. Note: This will delegate `super`
+    # method calls to `object` as well. Calling `super` will first try to call the method on
+    # the parent decorator class. If no method exists on the parent class, it will then try
+    # to call the method on the `object`.
     def method_missing(method, *args, &block)
       return super unless delegatable?(method)
 
-      self.singleton_class.delegate method
-      send(method, *args, &block)
+      object.send(method, *args, &block)
     end
 
     # Checks if the decorator responds to an instance method, or is able to

data/lib/draper/collection_decorator.rb

@@ -42,17 +42,7 @@ module Draper
       @decorated_collection ||= object.map{|item| decorate_item(item)}
     end
 
-    # Delegated to the decorated collection when using the block form
-    # (`Enumerable#find`) or to the decorator class if not
-    # (`ActiveRecord::FinderMethods#find`)
-    def find(*args, &block)
-      if block_given?
-        decorated_collection.find(*args, &block)
-      else
-        ActiveSupport::Deprecation.warn("Using ActiveRecord's `find` on a CollectionDecorator is deprecated. Call `find` on a model, and then decorate the result", caller)
-        decorate_item(object.find(*args))
-      end
-    end
+    delegate :find, to: :decorated_collection
 
     def to_s
       "#<#{self.class.name} of #{decorator_class || "inferred decorators"} for #{object.inspect}>"

data/lib/draper/compatibility/api_only.rb

@@ -0,0 +1,23 @@
+module Draper
+  module Compatibility
+    # Draper expects your `ApplicationController` to include `ActionView::Rendering`. The
+    # `ApplicationController` generated by Rails 5 API-only applications (created with
+    # `rails new --api`) don't by default. However, including `ActionView::Rendering` in
+    # `ApplicatonController` breaks `render :json` due to `render_to_body` being overridden.
+    #
+    # This compatibility patch fixes the issue by restoring the original `render_to_body`
+    # method after including `ActionView::Rendering`. Ultimately, including `ActionView::Rendering`
+    # in an ActionController::API may not be supported functionality by Rails (see Rails issue
+    # for more detail: https://github.com/rails/rails/issues/27211). This hack is meant to be a
+    # temporary solution until we can find a way to not rely on the controller layer.
+    module ApiOnly
+      extend ActiveSupport::Concern
+
+      included do
+        alias :previous_render_to_body :render_to_body
+        include ActionView::Rendering
+        alias :render_to_body :previous_render_to_body
+      end
+    end
+  end
+end

data/lib/draper/configuration.rb

@@ -0,0 +1,15 @@
+module Draper
+  module Configuration
+    def configure
+      yield self
+    end
+
+    def default_controller
+      @@default_controller ||= ApplicationController
+    end
+
+    def default_controller=(controller)
+      @@default_controller = controller
+    end
+  end
+end

data/lib/draper/decoratable.rb

@@ -74,10 +74,10 @@ module Draper
         decorator_name = "#{prefix}Decorator"
         decorator_name.constantize
       rescue NameError => error
+        raise unless error.missing_name?(decorator_name)
         if superclass.respond_to?(:decorator_class)
           superclass.decorator_class
         else
-          raise unless error.missing_name?(decorator_name)
           raise Draper::UninferrableDecoratorError.new(self)
         end
       end
@@ -86,7 +86,7 @@ module Draper
       #
       # @return [Boolean]
       def ===(other)
-        super || (other.respond_to?(:object) && super(other.object))
+        super || (other.is_a?(Draper::Decorator) && super(other.object))
       end
 
     end

data/lib/draper/decorator.rb

@@ -10,8 +10,6 @@ module Draper
     # @return the object being decorated.
     attr_reader :object
     alias_method :model, :object
-    alias_method :source, :object # TODO: deprecate this
-    alias_method :to_source, :object # TODO: deprecate this
 
     # @return [Hash] extra data to be used in user-defined methods.
     attr_accessor :context
@@ -72,15 +70,10 @@ module Draper
     # Checks whether this decorator class has a corresponding {object_class}.
     def self.object_class?
       object_class
-    rescue Draper::UninferrableSourceError
+    rescue Draper::UninferrableObjectError
       false
     end
 
-    class << self # TODO deprecate this
-      alias_method :source_class, :object_class
-      alias_method :source_class?, :object_class?
-    end
-
     # Automatically decorates ActiveRecord finder methods, so that you can use
     # `ProductDecorator.find(id)` instead of
     # `ProductDecorator.decorate(Product.find(id))`.
@@ -182,7 +175,7 @@ module Draper
 
     # Returns a unique hash for a decorated object based on
     # the decorator class and the object being decorated.
-    # 
+    #
     # @return [Fixnum]
     def hash
       self.class.hash ^ object.hash
@@ -230,8 +223,7 @@ module Draper
     def self.collection_decorator_class
       name = collection_decorator_name
       name.constantize
-    rescue NameError => error
-      raise if name && !error.missing_name?(name)
+    rescue NameError
       Draper::CollectionDecorator
     end
 
@@ -256,7 +248,7 @@ module Draper
       name.constantize
     rescue NameError => error
       raise if name && !error.missing_name?(name)
-      raise Draper::UninferrableSourceError.new(self)
+      raise Draper::UninferrableObjectError.new(self)
     end
 
     def self.collection_decorator_name

data/lib/draper/helper_proxy.rb

@@ -4,9 +4,7 @@ module Draper
   class HelperProxy
 
     # @overload initialize(view_context)
-    def initialize(view_context = nil)
-      view_context ||= current_view_context # backwards compatibility
-
+    def initialize(view_context)
       @view_context = view_context
     end
 
@@ -35,10 +33,5 @@ module Draper
         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/railtie.rb

@@ -3,8 +3,6 @@ require 'rails/railtie'
 module ActiveModel
   class Railtie < Rails::Railtie
     generators do |app|
-      app ||= Rails.application # Rails 3.0.x does not yield `app`
-
       Rails::Generators.configure! app.config.generators
       require_relative '../generators/controller_override'
     end
@@ -13,7 +11,6 @@ end
 
 module Draper
   class Railtie < Rails::Railtie
-
     config.after_initialize do |app|
       app.config.paths.add 'app/decorators', eager_load: true
 
@@ -23,19 +20,19 @@ module Draper
       end
     end
 
-    initializer "draper.setup_action_controller" do |app|
+    initializer 'draper.setup_action_controller' do
       ActiveSupport.on_load :action_controller do
         Draper.setup_action_controller self
       end
     end
 
-    initializer "draper.setup_action_mailer" do |app|
+    initializer 'draper.setup_action_mailer' do
       ActiveSupport.on_load :action_mailer do
         Draper.setup_action_mailer self
       end
     end
 
-    initializer "draper.setup_orm" do |app|
+    initializer 'draper.setup_orm' do
       [:active_record, :mongoid].each do |orm|
         ActiveSupport.on_load orm do
           Draper.setup_orm self
@@ -43,20 +40,22 @@ module Draper
       end
     end
 
-    initializer "draper.minitest-rails_integration" do |app|
+    initializer 'draper.minitest-rails_integration' do
       ActiveSupport.on_load :minitest do
-        require "draper/test/minitest_integration"
+        require 'draper/test/minitest_integration'
       end
     end
 
-    console do
+    def initialize_view_context
       require 'action_controller/test_case'
-      ApplicationController.new.view_context
+      Draper.default_controller.new.view_context
       Draper::ViewContext.build
     end
 
-    rake_tasks do
-      Dir[File.join(File.dirname(__FILE__),'tasks/*.rake')].each { |f| load f }
-    end
+    console { initialize_view_context }
+
+    runner { initialize_view_context }
+
+    rake_tasks { Dir[File.join(File.dirname(__FILE__), 'tasks/*.rake')].each { |f| load f } }
   end
 end