draper 3.0.1 → 4.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: cc23ed0f81227aa958510ecb67676453d97b40cc
-  data.tar.gz: ed8a159772bafb7df87cc5c767757e8b697f55b3
+SHA256:
+  metadata.gz: 6b009279cf28737a6fcf4027fc26f3dc2a955741c7c5e5d2220c8dcb383490e3
+  data.tar.gz: 22455a3a7126650483af269d6a0e432a5a4465a59c762518ce78f40bcecb4286
 SHA512:
-  metadata.gz: 466c609e53461c1e1f260f9e2bf6a0eb522238e5bdae8a2f37a88c1cd22d22665bf18293ba497f9f64d27faa0e12f0dbb9e3d906bae569f324c6124c02ad6b7e
-  data.tar.gz: db229fe0cf5daf0acc2e52834c599a21e9ba85782458a8fd3a0520574e77f1857ec30c57c81dceb75561016170c941f8da3593d3a58fd395137c01ce57322cf0
+  metadata.gz: 2fd6c0b87227c23320e9ee211b4b2001c81cbf76d103a12e5076f427954febdb2d0366d5182f16b27f5155717ad878f08671098f8b1f9986c137ec053e1637bf
+  data.tar.gz: 260d4eccd57c623c966422cd256ab1485e1ce4bbaea05d2c6f615cdb644ab0147f00e8917b8165eba78651f279b66cde0a13da38b1c5cc9dc6a0e49822db2361

data/.github/workflows/ci.yml

@@ -0,0 +1,55 @@
+---
+name: CI
+
+on:
+  - push
+  - pull_request
+
+jobs:
+  rspec:
+    runs-on: ubuntu-20.04
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - '3.0'
+          - '2.7'
+          - '2.6'
+          - '2.5'
+          - '2.4'
+
+    services:
+      mongodb:
+        image: mongo
+        ports:
+          - 27017:27017
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - name: Setup Ruby cache
+        uses: actions/cache@v2
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-gems-${{ matrix.ruby }}-${{ hashFiles('**/Gemfile.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-gems-${{ matrix.ruby }}-
+
+      - name: Bundle
+        run: |
+          gem install bundler
+          bundle config path vendor/bundle
+          bundle install --jobs 4 --retry 3
+
+      - name: RSpec & publish code coverage
+        uses: paambaati/codeclimate-action@v2.7.5
+        env:
+          CC_TEST_REPORTER_ID: b7ba588af2a540fa96c267b3655a2afe31ea29976dc25905a668dd28d5e88915
+        with:
+          coverageCommand: bin/rake

data/CHANGELOG.md

@@ -1,5 +1,46 @@
 # Draper Changelog
 
+## 4.0.2 - 2021-05-27
+
+### Fixes
+* Fix kwargs usage for Ruby 3 compatibility [#885](https://github.com/drapergem/draper/pull/885)
+* Fix ruby warnings for "ambiguous first argument" [#881](https://github.com/drapergem/draper/pull/881)
+* Fix rake warnings in CI [#897](https://github.com/drapergem/draper/pull/897)
+* Fix decoration spec [#895](https://github.com/drapergem/draper/pull/895)
+
+### Other Changes
+* Migration from Travis CI to GitHub Actions [#893](https://github.com/drapergem/draper/pull/893), [#896](https://github.com/drapergem/draper/pull/896), [#903](https://github.com/drapergem/draper/pull/903)
+
+## 4.0.1 - 2020-03-25
+
+### Fixes
+* Check only object's private methods when preventing delegation [#875](https://github.com/drapergem/draper/pull/875)
+
+### Other Changes
+* Use `alias` over `alias_method` [#877](https://github.com/drapergem/draper/pull/877)
+
+## 4.0.0 - 2020-02-05
+
+### Breaking Changes
+* Drop support for Ruby < 2.4 [#852](https://github.com/drapergem/draper/pull/852), [#872](https://github.com/drapergem/draper/pull/872)
+* Don't delegate public methods overridden by a private method in the decorator [#849](https://github.com/drapergem/draper/pull/849)
+
+### Fixes
+* Add preservation of decorator options on QueryMethods [#868](https://github.com/drapergem/draper/pull/868)
+* Add `#respond_to_missing?` to `CollectionDecorator` so it correctly responds to ORM methods [#850](https://github.com/drapergem/draper/pull/850)
+* Fix deprecation warning with the new Rails 6 `ActionView::Base` constructor [#866](https://github.com/drapergem/draper/pull/866)
+* Fix deprecation warning with Ruby 2.7 [#870](https://github.com/drapergem/draper/pull/870)
+
+### Other Changes
+* Add SimpleCov for code coverage analysis [#851](https://github.com/drapergem/draper/pull/851)
+* Update RSpec syntax in the README [#855](https://github.com/drapergem/draper/pull/855)
+* Update continuous integration configuration [#861](https://github.com/drapergem/draper/pull/861), [#862](https://github.com/drapergem/draper/pull/862), [#863](https://github.com/drapergem/draper/pull/863), [#872](https://github.com/drapergem/draper/pull/872)
+
+## 3.1.0
+* Rails 6 support [#841](https://github.com/drapergem/draper/pull/841)
+* Include ORM query methods in `CollectionDecorator` (e.g. `includes`) [#845](https://github.com/drapergem/draper/pull/845)
+* Document the fix for view context leaking in specs [#847](https://github.com/drapergem/draper/pull/847)
+
 ## 3.0.1
 * Let `decorator_class` infer anonymous class decorator from superclass [#820](https://github.com/drapergem/draper/pull/820)
 * When inferring decorator fails, show original class instead of `ActiveRecord::Base` [#821](https://github.com/drapergem/draper/pull/821)

data/Gemfile

@@ -3,7 +3,11 @@ source "https://rubygems.org"
 gemspec
 
 platforms :ruby do
-  gem "sqlite3"
+  if RUBY_VERSION >= "2.5.0"
+    gem 'sqlite3'
+  else
+    gem 'sqlite3', '~> 1.3.6'
+  end
 end
 
 platforms :jruby do
@@ -11,5 +15,10 @@ platforms :jruby do
   gem "activerecord-jdbcsqlite3-adapter"
 end
 
-gem "rails", "~> 5.0"
+if RUBY_VERSION >= "2.5.0"
+  gem "rails", "~> 6.0"
+  gem 'webrick'
+else
+  gem "rails", "~> 5.0"
+end
 gem "mongoid", github: "mongodb/mongoid"

data/README.md

@@ -1,7 +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)
+[![Actions Status](https://github.com/drapergem/draper/workflows/CI/badge.svg?branch=master)](https://github.com/drapergem/draper/actions?query=workflow%3Aci+branch%3Amaster)
 [![Code Climate](https://codeclimate.com/github/drapergem/draper.svg)](https://codeclimate.com/github/drapergem/draper)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/0d40c43951d516bf6985/test_coverage)](https://codeclimate.com/github/drapergem/draper/test_coverage)
 [![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
@@ -107,7 +108,7 @@ Decorators are the ideal place to:
 
 ## Installation
 
-As of version 3.0.0, Draper is only compatible with Rails 5 / Ruby 2.2 and later. Add Draper to your Gemfile.
+As of version 4.0.0, Draper only officially supports Rails 5.2 / Ruby 2.4 and later. Add Draper to your Gemfile.
 
 ```ruby
   gem 'draper'
@@ -326,6 +327,17 @@ your `ArticleDecorator` and they'll return decorated objects:
 @article = ArticleDecorator.find(params[:id])
 ```
 
+### Decorated Query Methods
+By default, Draper will decorate all [QueryMethods](https://api.rubyonrails.org/classes/ActiveRecord/QueryMethods.html)
+of ActiveRecord.
+If you're using another ORM, in order to support it, you can tell Draper to use a custom strategy:
+
+```ruby
+Draper.configure do |config|
+  config.default_query_methods_strategy = :mongoid
+end
+```
+
 ### When to Decorate Objects
 
 Decorators are supposed to behave very much like the models they decorate, and
@@ -368,7 +380,7 @@ 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 
+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:
@@ -457,12 +469,29 @@ end
 ```
 
 Then you can stub the specific route helper functions you need using your
-preferred stubbing technique (this example uses RSpec's `stub` method):
+preferred stubbing technique. This examples uses Rspec currently recommended API
+available in RSpec 3.6+
 
 ```ruby
-helpers.stub(users_path: '/users')
+without_partial_double_verification do
+  allow(helpers).to receive(:users_path).and_return('/users')
+end
+```
+
+### View context leakage
+As mentioned before, Draper needs to build a view context to access helper methods. In MiniTest, the view context is
+cleared during `before_setup` preventing any view context leakage. In RSpec, the view context is cleared before each
+`decorator`, `controller`, and `mailer` spec. However, if you use decorators in other types of specs
+(e.g. `job`), you may still experience the view context leaking from the previous spec. To solve this, add the
+following to your `spec_helper` for each type of spec you are experiencing the leakage:
+
+```ruby
+config.before(:each, type: :type) { Draper::ViewContext.clear! }
 ```
 
+_Note_: The `:type` above is just a placeholder. Replace `:type` with the type of spec you are experiencing
+the leakage from.
+
 ## Advanced usage
 
 ### Shared Decorator Methods
@@ -620,7 +649,7 @@ you can include this module manually.
 
 ### Active Job Integration
 
-[Active Job](http://edgeguides.rubyonrails.org/active_job_basics.html) allows you to pass ActiveRecord 
+[Active Job](http://edgeguides.rubyonrails.org/active_job_basics.html) allows you to pass ActiveRecord
 objects to background tasks directly and performs the necessary serialization and deserialization. In
 order to do this, arguments to a background job must implement [Global ID](https://github.com/rails/globalid).
 Decorated objects implement Global ID by delegating to the object they are decorating. This means

data/bin/bundle

@@ -0,0 +1,114 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'bundle' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "rubygems"
+
+m = Module.new do
+  module_function
+
+  def invoked_as_script?
+    File.expand_path($0) == File.expand_path(__FILE__)
+  end
+
+  def env_var_version
+    ENV["BUNDLER_VERSION"]
+  end
+
+  def cli_arg_version
+    return unless invoked_as_script? # don't want to hijack other binstubs
+    return unless "update".start_with?(ARGV.first || " ") # must be running `bundle update`
+    bundler_version = nil
+    update_index = nil
+    ARGV.each_with_index do |a, i|
+      if update_index && update_index.succ == i && a =~ Gem::Version::ANCHORED_VERSION_PATTERN
+        bundler_version = a
+      end
+      next unless a =~ /\A--bundler(?:[= ](#{Gem::Version::VERSION_PATTERN}))?\z/
+      bundler_version = $1
+      update_index = i
+    end
+    bundler_version
+  end
+
+  def gemfile
+    gemfile = ENV["BUNDLE_GEMFILE"]
+    return gemfile if gemfile && !gemfile.empty?
+
+    File.expand_path("../../Gemfile", __FILE__)
+  end
+
+  def lockfile
+    lockfile =
+      case File.basename(gemfile)
+      when "gems.rb" then gemfile.sub(/\.rb$/, gemfile)
+      else "#{gemfile}.lock"
+      end
+    File.expand_path(lockfile)
+  end
+
+  def lockfile_version
+    return unless File.file?(lockfile)
+    lockfile_contents = File.read(lockfile)
+    return unless lockfile_contents =~ /\n\nBUNDLED WITH\n\s{2,}(#{Gem::Version::VERSION_PATTERN})\n/
+    Regexp.last_match(1)
+  end
+
+  def bundler_version
+    @bundler_version ||=
+      env_var_version || cli_arg_version ||
+        lockfile_version
+  end
+
+  def bundler_requirement
+    return "#{Gem::Requirement.default}.a" unless bundler_version
+
+    bundler_gem_version = Gem::Version.new(bundler_version)
+
+    requirement = bundler_gem_version.approximate_recommendation
+
+    return requirement unless Gem::Version.new(Gem::VERSION) < Gem::Version.new("2.7.0")
+
+    requirement += ".a" if bundler_gem_version.prerelease?
+
+    requirement
+  end
+
+  def load_bundler!
+    ENV["BUNDLE_GEMFILE"] ||= gemfile
+
+    activate_bundler
+  end
+
+  def activate_bundler
+    gem_error = activation_error_handling do
+      gem "bundler", bundler_requirement
+    end
+    return if gem_error.nil?
+    require_error = activation_error_handling do
+      require "bundler/version"
+    end
+    return if require_error.nil? && Gem::Requirement.new(bundler_requirement).satisfied_by?(Gem::Version.new(Bundler::VERSION))
+    warn "Activating bundler (#{bundler_requirement}) failed:\n#{gem_error.message}\n\nTo install the version of bundler this project requires, run `gem install bundler -v '#{bundler_requirement}'`"
+    exit 42
+  end
+
+  def activation_error_handling
+    yield
+    nil
+  rescue StandardError, LoadError => e
+    e
+  end
+end
+
+m.load_bundler!
+
+if m.invoked_as_script?
+  load Gem.bin_path("bundler", "bundle")
+end

data/bin/rake

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/draper.gemspec

@@ -1,4 +1,4 @@
-require File.join(__dir__, "lib", "draper", "version")
+require_relative 'lib/draper/version'
 
 Gem::Specification.new do |s|
   s.name        = "draper"
@@ -12,22 +12,23 @@ Gem::Specification.new do |s|
 
   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.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', '~> 5.0'
-  s.add_dependency 'activemodel-serializers-xml', '~> 1.0'
+  s.add_dependency 'activesupport', '>= 5.0'
+  s.add_dependency 'actionpack', '>= 5.0'
+  s.add_dependency 'request_store', '>= 1.0'
+  s.add_dependency 'activemodel', '>= 5.0'
+  s.add_dependency 'activemodel-serializers-xml', '>= 1.0'
+  s.add_dependency 'ruby2_keywords'
 
   s.add_development_dependency 'ammeter'
   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', '~> 0.10'
+  s.add_development_dependency 'active_model_serializers', '>= 0.10'
   s.add_development_dependency 'rubocop'
+  s.add_development_dependency 'simplecov', '0.17.1'
 end

data/lib/draper/automatic_delegation.rb

@@ -6,7 +6,7 @@ module Draper
     # 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)
+    ruby2_keywords def method_missing(method, *args, &block)
       return super unless delegatable?(method)
 
       object.send(method, *args, &block)
@@ -20,12 +20,14 @@ module Draper
 
     # @private
     def delegatable?(method)
+      return if private_methods(false).include?(method)
+
       object.respond_to?(method)
     end
 
     module ClassMethods
       # Proxies missing class methods to the source class.
-      def method_missing(method, *args, &block)
+      ruby2_keywords def method_missing(method, *args, &block)
         return super unless delegatable?(method)
 
         object_class.send(method, *args, &block)

data/lib/draper/collection_decorator.rb

@@ -2,6 +2,7 @@ module Draper
   class CollectionDecorator
     include Enumerable
     include Draper::ViewHelpers
+    include Draper::QueryMethods
     extend Draper::Delegation
 
     # @return the collection being decorated.
@@ -34,7 +35,7 @@ module Draper
     end
 
     class << self
-      alias_method :decorate, :new
+      alias :decorate :new
     end
 
     # @return [Array] the decorated items.
@@ -58,11 +59,12 @@ module Draper
       true
     end
 
-    alias_method :decorated_with?, :instance_of?
+    alias :decorated_with? :instance_of?
 
     def kind_of?(klass)
       decorated_collection.kind_of?(klass) || super
     end
+
     alias_method :is_a?, :kind_of?
 
     def replace(other)

data/lib/draper/configuration.rb

@@ -11,5 +11,13 @@ module Draper
     def default_controller=(controller)
       @@default_controller = controller
     end
+
+    def default_query_methods_strategy
+      @@default_query_methods_strategy ||= :active_record
+    end
+
+    def default_query_methods_strategy=(strategy)
+      @@default_query_methods_strategy = strategy
+    end
   end
 end

data/lib/draper/decoratable.rb

@@ -48,7 +48,6 @@ module Draper
     end
 
     module ClassMethods
-
       # Decorates a collection of objects. Used at the end of a scope chain.
       #
       # @example

data/lib/draper/decorated_association.rb

@@ -1,7 +1,6 @@
 module Draper
   # @private
   class DecoratedAssociation
-
     def initialize(owner, association, options)
       options.assert_valid_keys(:with, :scope, :context)
 
@@ -30,6 +29,5 @@ module Draper
 
       @decorated = factory.decorate(associated, context_args: owner.context)
     end
-
   end
 end

data/lib/draper/decorator.rb

@@ -12,7 +12,8 @@ module Draper
 
     # @return the object being decorated.
     attr_reader :object
-    alias_method :model, :object
+
+    alias :model :object
 
     # @return [Hash] extra data to be used in user-defined methods.
     attr_accessor :context
@@ -36,7 +37,7 @@ module Draper
     end
 
     class << self
-      alias_method :decorate, :new
+      alias :decorate :new
     end
 
     # Automatically delegates instance methods to the source object. Class
@@ -190,7 +191,8 @@ module Draper
     def kind_of?(klass)
       super || object.kind_of?(klass)
     end
-    alias_method :is_a?, :kind_of?
+
+    alias :is_a? :kind_of?
 
     # Checks if `self.instance_of?(klass)` or `object.instance_of?(klass)`
     #
@@ -225,7 +227,7 @@ module Draper
     # @return [Class] the class created by {decorate_collection}.
     def self.collection_decorator_class
       name = collection_decorator_name
-      name_constant = name && name.safe_constantize
+      name_constant = name&.safe_constantize
 
       name_constant || Draper::CollectionDecorator
     end
@@ -248,7 +250,7 @@ module Draper
 
     def self.inferred_object_class
       name = object_class_name
-      name_constant = name && name.safe_constantize
+      name_constant = name&.safe_constantize
       return name_constant unless name_constant.nil?
 
       raise Draper::UninferrableObjectError.new(self)
@@ -256,7 +258,7 @@ module Draper
 
     def self.collection_decorator_name
       singular = object_class_name
-      plural = singular && singular.pluralize
+      plural = singular&.pluralize
 
       "#{plural}Decorator" unless plural == singular
     end

data/lib/draper/delegation.rb

@@ -7,7 +7,7 @@ module Draper
     #   @return [void]
     def delegate(*methods)
       options = methods.extract_options!
-      super *methods, options.reverse_merge(to: :object)
+      super(*methods, **options.reverse_merge(to: :object))
     end
   end
 end

data/lib/draper/finders.rb

@@ -3,7 +3,6 @@ module Draper
   # do not have to extend this module directly; it is extended by
   # {Decorator.decorates_finders}.
   module Finders
-
     def find(id, options = {})
       decorate(object_class.find(id), options)
     end

data/lib/draper/helper_proxy.rb

@@ -2,14 +2,13 @@ module Draper
   # Provides access to helper methods - both Rails built-in helpers, and those
   # defined in your application.
   class HelperProxy
-
     # @overload initialize(view_context)
     def initialize(view_context)
       @view_context = view_context
     end
 
     # Sends helper methods to the view context.
-    def method_missing(method, *args, &block)
+    ruby2_keywords def method_missing(method, *args, &block)
       self.class.define_proxy method
       send(method, *args, &block)
     end
@@ -32,6 +31,7 @@ module Draper
       define_method name do |*args, &block|
         view_context.send(name, *args, &block)
       end
+      ruby2_keywords name
     end
   end
 end

data/lib/draper/lazy_helpers.rb

@@ -3,13 +3,11 @@ module Draper
   # so that you can stop typing `h.` everywhere, at the cost of mixing in a
   # bazillion methods.
   module LazyHelpers
-
     # Sends missing methods to the {HelperProxy}.
-    def method_missing(method, *args, &block)
+    ruby2_keywords def method_missing(method, *args, &block)
       helpers.send(method, *args, &block)
     rescue NoMethodError
       super
     end
-
   end
 end

data/lib/draper/query_methods/load_strategy.rb

@@ -0,0 +1,21 @@
+module Draper
+  module QueryMethods
+    module LoadStrategy
+      def self.new(name)
+        const_get(name.to_s.camelize).new
+      end
+
+      class ActiveRecord
+        def allowed?(method)
+          ::ActiveRecord::Relation::VALUE_METHODS.include? method
+        end
+      end
+
+      class Mongoid
+        def allowed?(method)
+          raise NotImplementedError
+        end
+      end
+    end
+  end
+end

data/lib/draper/query_methods.rb

@@ -0,0 +1,23 @@
+require_relative 'query_methods/load_strategy'
+
+module Draper
+  module QueryMethods
+    # Proxies missing query methods to the source class if the strategy allows.
+    ruby2_keywords def method_missing(method, *args, &block)
+      return super unless strategy.allowed? method
+
+      object.send(method, *args, &block).decorate(with: decorator_class, context: context)
+    end
+
+    def respond_to_missing?(method, include_private = false)
+      strategy.allowed?(method) || super
+    end
+
+    private
+
+    # Configures the strategy used to proxy the query methods, which defaults to `:active_record`.
+    def strategy
+      @strategy ||= LoadStrategy.new(Draper.default_query_methods_strategy)
+    end
+  end
+end