draper 2.1.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b85cf531330b6947bd3bd6970e527ca62149975a
-  data.tar.gz: e063ca4cd9757a4bfc7ad5eb3970b852fa62f1f8
+  metadata.gz: 6f2c896cc71e7e4e654a5d65907dd0ec4cefed7f
+  data.tar.gz: ce50051cf161e9416483a40797d38ae2d2da3384
 SHA512:
-  metadata.gz: d51ffa67dbb810f7d093bf2bf7c7b0c216cc03231150dbec62b0915fc098ac7bd28b8975541ac99abe3fcdae541d98133d3e7fc176335f16615c6cd6169111bb
-  data.tar.gz: 0006c748a474980dcc613530ed51fa1b9b469e3bbf63eb5ed3eb72d06ab2d5c692c439d5cc43cc139c00ce0032329ac77518600efc351c10b0b1c5b6fa81af51
+  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/.gitignore

@@ -1,5 +1,7 @@
 *.gem
-*.rvmrc
+.rvmrc
+.ruby-version
+.ruby-gemset
 .bundle
 Gemfile.lock
 pkg/*

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,10 +4,6 @@ services:
   - mongodb
 
 rvm:
-  - 2.1.5
-  - 2.2.1
-
-env:
-  - "RAILS_VERSION=4.0"
-  - "RAILS_VERSION=4.1"
-  - "RAILS_VERSION=4.2"
+  - 2.2.6
+  - 2.3.3
+  - 2.4.1

data/CHANGELOG.md

@@ -1,5 +1,31 @@
 # 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
+  * Ruby >= 2.2 is required, matching Rails 5
+* Dropped support for ActiveModelSerializers 0.8
+
 ## 2.1.0 - 2015-03-26
 
 * Cleared most issues and merged a few PRs

data/Gemfile

@@ -7,10 +7,9 @@ platforms :ruby do
 end
 
 platforms :jruby do
-  gem "minitest", ">= 3.0"
-  gem "activerecord-jdbcsqlite3-adapter", ">= 1.3.0.beta2"
+  gem "minitest"
+  gem "activerecord-jdbcsqlite3-adapter"
 end
 
-version = ENV["RAILS_VERSION"] || "4.1"
-
-eval_gemfile File.expand_path("../gemfiles/#{version}.gemfile", __FILE__)
+gem "rails", "~> 5.0"
+gem "mongoid", github: "mongodb/mongoid"

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

@@ -1,8 +1,8 @@
 # Draper: View Models for Rails
 
 [![TravisCI Build Status](https://travis-ci.org/drapergem/draper.svg?branch=master)](http://travis-ci.org/drapergem/draper)
-[![Code Climate](https://codeclimate.com/github/drapergem/draper.png)](https://codeclimate.com/github/drapergem/draper)
-[![Inline docs](http://inch-ci.org/github/drapergem/draper.png?branch=master)](http://inch-ci.org/github/drapergem/draper)
+[![Code Climate](https://codeclimate.com/github/drapergem/draper.svg)](https://codeclimate.com/github/drapergem/draper)
+[![Inline docs](http://inch-ci.org/github/drapergem/draper.svg?branch=master)](http://inch-ci.org/github/drapergem/draper)
 
 Draper adds an object-oriented layer of presentation logic to your Rails
 application.
@@ -48,7 +48,7 @@ end
 But it makes you a little uncomfortable. `publication_status` lives in a
 nebulous namespace spread across all controllers and view. Down the road, you
 might want to display the publication status of a `Book`. And, of course, your
-design calls for a slighly different formatting to the date for a `Book`.
+design calls for a slightly different formatting to the date for a `Book`.
 
 Now your helper method can either switch based on the input class type (poor
 Ruby style), or you break it out into two methods, `book_publication_status` and
@@ -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', '~> 1.3'
+  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...
 
 ```
@@ -276,6 +282,19 @@ omitted.
 delegate :current_page, :per_page, :offset, :total_entries, :total_pages
 ```
 
+If needed, you can then set the collection_decorator_class of your CustomDecorator as follows:
+```ruby
+class ArticleDecorator < Draper::Decorator
+  def self.collection_decorator_class
+    PaginatingDecorator
+  end
+end
+
+ArticleDecorator.decorate_collection(@articles.paginate)
+# => Collection decorated by PaginatingDecorator
+# => Members decorated by ArticleDecorator
+```
+
 ### Decorating Associated Objects
 
 You can automatically decorate associated models when the primary model is
@@ -348,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
@@ -379,6 +410,15 @@ In your `Spork.prefork` block of `spec_helper.rb`, add this:
 require 'draper/test/rspec_integration'
 ```
 
+#### Custom Draper Controller ViewContext
+If running tests in an engine setting with a controller other than "ApplicationController," set a custom controller in `spec_helper.rb`
+
+```ruby
+config.before(:each, type: :decorator) do |example|
+  Draper::ViewContext.controller = ExampleEngine::CustomRootController.new
+end
+```
+
 ### Isolated Tests
 
 In tests, Draper needs to build a view context to access helper methods. By
@@ -455,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:
@@ -564,13 +607,15 @@ end
 
 This is only necessary when proxying class methods.
 
+Once this association between the decorator and the model is set up, you can call
+`SomeModel.decorator_class` to access class methods defined in the decorator.
+If necessary, you can check if your model is decorated with `SomeModel.decorator_class?`.
+
 ### Making Models Decoratable
 
 Models get their `decorate` method from the `Draper::Decoratable` module, which
 is included in `ActiveRecord::Base` and `Mongoid::Document` by default. If
-you're [using another
-ORM](https://github.com/drapergem/draper/wiki/Using-other-ORMs) (including
-versions of Mongoid prior to 3.0), or want to decorate plain old Ruby objects,
+you're using another ORM, or want to decorate plain old Ruby objects,
 you can include this module manually.
 
 ## Contributors
@@ -579,9 +624,14 @@ Draper was conceived by Jeff Casimir and heavily refined by Steve Klabnik and a
 great community of open source
 [contributors](https://github.com/drapergem/draper/contributors).
 
-### Core Team
+### Current maintainers
+
+* Cliff Braton (cliff.braton@gmail.com)
+
+### Historical maintainers
 
 * Jeff Casimir (jeff@jumpstartlab.com)
 * Steve Klabnik (steve@jumpstartlab.com)
 * Vasiliy Ermolovich
 * Andrew Haines
+* Sean Linsley

data/Rakefile

@@ -64,6 +64,6 @@ namespace "db" do
     run_in_dummy_app "rm -f db/*.sqlite3"
     run_in_dummy_app "RAILS_ENV=development rake db:schema:load db:seed"
     run_in_dummy_app "RAILS_ENV=production rake db:schema:load db:seed"
-    run_in_dummy_app "RAILS_ENV=test rake db:schema:load"
+    run_in_dummy_app "RAILS_ENV=test rake db:environment:set db:schema:load"
   end
 end

data/draper.gemspec

@@ -1,6 +1,4 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "draper/version"
+require File.join(__dir__, "lib", "draper", "version")
 
 Gem::Specification.new do |s|
   s.name        = "draper"
@@ -17,15 +15,19 @@ 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', '>= 3.0'
-  s.add_dependency 'actionpack', '>= 3.0'
+  s.required_ruby_version = '>= 2.2.2'
+
+  s.add_dependency 'activesupport', '~> 5.0'
+  s.add_dependency 'actionpack', '~> 5.0'
   s.add_dependency 'request_store', '~> 1.0'
-  s.add_dependency 'activemodel', '>= 3.0'
+  s.add_dependency 'activemodel', '~> 5.0'
+  s.add_dependency 'activemodel-serializers-xml', '~> 1.0'
 
   s.add_development_dependency 'ammeter'
-  s.add_development_dependency 'rake', '>= 0.9.2'
-  s.add_development_dependency 'rspec-rails', '~> 3.2'
-  s.add_development_dependency 'minitest-rails', '>= 1.0'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec-rails'
+  s.add_development_dependency 'minitest-rails'
   s.add_development_dependency 'capybara'
-  s.add_development_dependency 'active_model_serializers'
+  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,13 +29,16 @@ 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
 
-      before_filter :activate_draper
+      before_action :activate_draper
     end
   end
 
@@ -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.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}>"