draper 4.0.1 → 4.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a90d57e1df50336b735a6f16cc119a558ee8472b70bd9748c59f25b70afc319a
-  data.tar.gz: a4510f40a8afac7976e7afea4659d8e1c3eb981c005bc4046660b4d110874df7
+  metadata.gz: 78c5e444690de191d46a5be87ed46a3f9be6ec0ffd59fed6dcd1d63e5d527b85
+  data.tar.gz: f92be8ee42d8ce2e48c1743077f758eef779296593fcbcdef9a82fd5937a03ae
 SHA512:
-  metadata.gz: bee71715525fdc2de5336c399b1dfe4a774d9fd68071bb01468c8f31712504cf6af8beecf1f4facf4ea25ef5bcad7a14b2e2f12bec12f7b6f1e55c04318c4f7a
-  data.tar.gz: 8f013f4b36efa767ada401a979e5bf10e28f068997d24fd8035e4025254300709eb7c2e80c5f0498cc49c176b7561fbff48e2cc03f39b418f368c3266bf30359
+  metadata.gz: 2b2d10594f175019d7cbee9b7af7f811c8978349abae3cdce746abd94f24501d81b519c9da9ae350658265dd5aa0b33cdd9b3f18e26df922363227df8f57c4a4
+  data.tar.gz: 81565fd7b8034294a41c49b557f48619e6cee814056d2d4bff4c0e6f17c024877b250b421d4a185310f6b6fa3dee14b51d954b6ee3cef39100d3cfb4c9582af7

data/.github/workflows/ci.yml

@@ -0,0 +1,71 @@
+---
+name: CI
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  rspec:
+    name: >-
+      rspec (${{ matrix.ruby }})
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - 3.3
+          - 3.2
+          - 3.1
+        rails:
+          - 7.2
+        include:
+          # Edge
+          - { ruby: 'head', rails: 'edge', allow-fail: true }
+          # Outdated
+          - { ruby: '3.0',  rails: '7.1' }
+          - { ruby: '2.7',  rails: '6'   } # RSpec AR Expectations support Rails 7.1 since Ruby 3.0
+          - { ruby: '2.6',  rails: '6'   }
+          - { ruby: '2.5',  rails: '6'   }
+          - { ruby: '2.4',  rails: '5'   }
+
+    env:
+      RAILS_VERSION: "${{ matrix.rails }}"
+
+    services:
+      mongodb:
+        image: mongo
+        ports:
+          - 27017:27017
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          rubygems: latest
+          bundler-cache: true
+
+      - name: RSpec & publish code coverage
+        uses: paambaati/codeclimate-action@v8
+        env:
+          CC_TEST_REPORTER_ID: b7ba588af2a540fa96c267b3655a2afe31ea29976dc25905a668dd28d5e88915
+        with:
+          coverageCommand: bin/rake
+        continue-on-error: ${{ matrix.allow-fail }}
+        id: test
+
+      - name: >-
+          Test ${{ steps.test.outcome }}
+        run: |
+          echo Ruby  ${{ matrix.ruby  }}
+          echo Rails ${{ matrix.rails }}

data/.rspec

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

data/CHANGELOG.md

@@ -1,5 +1,34 @@
 # Draper Changelog
 
+## 4.0.4 - 2025-01-28
+
+### Fixes
+* Fix a `LoadError` caused by a cherry-pick issue in version 4.0.3
+
+## 4.0.3 - 2025-01-27
+
+Added support for latest Ruby (upto 3.4) and Rails (upto 8) versions.
+
+### Fixes
+* Fix `CollectionDecorator#respond_to?` for non-ORM collections [#920](https://github.com/drapergem/draper/pull/920)
+* Fix issues with using Draper outside of controller scope [#927](https://github.com/drapergem/draper/pull/927)
+* Fix decoration of AR associations [#932](https://github.com/drapergem/draper/pull/932)
+
+### Other Changes
+* Improve performance of delegation via `delegate_all` [#911](https://github.com/drapergem/draper/pull/911)
+* Improve README [#878](https://github.com/drapergem/draper/pull/878), [#922](https://github.com/drapergem/draper/pull/922), [#934](https://github.com/drapergem/draper/pull/934)
+
+## 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

data/Gemfile

@@ -2,6 +2,8 @@ source "https://rubygems.org"
 
 gemspec
 
+gem 'puma'
+
 platforms :ruby do
   if RUBY_VERSION >= "2.5.0"
     gem 'sqlite3'
@@ -15,9 +17,30 @@ platforms :jruby do
   gem "activerecord-jdbcsqlite3-adapter"
 end
 
-if RUBY_VERSION >= "2.5.0"
-  gem "rails", "~> 6.0"
+case rails_version = ENV['RAILS_VERSION']
+when nil
+  gem 'rails'
+when 'edge'
+  gem 'rails', github: 'rails/rails'
 else
-  gem "rails", "~> 5.0"
+  gem 'rails', "~> #{rails_version}.0"
+end
+
+gem 'mongoid' unless
+    rails_version == 'edge'
+gem 'active_model_serializers'
+
+case RUBY_VERSION
+when '2.6'...'3.0'
+  gem "turbo-rails", "<= 2.0.7"
+  gem "redis", "~> 4.0"
+when '3.0'...'4'
+  gem 'turbo-rails'
+  gem 'redis', '~> 4.0'
+end
+
+if RUBY_VERSION < "2.5.0"
+  gem 'rspec-activerecord-expectations', '~> 1.2.0'
+  gem 'simplecov', '0.17.1'
+  gem "loofah", "< 2.21.0" # Workaround for `uninitialized constant Nokogiri::HTML4`
 end
-gem "mongoid", github: "mongodb/mongoid"

data/README.md

@@ -1,6 +1,6 @@
 # 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)
@@ -131,6 +131,17 @@ class ArticleDecorator < Draper::Decorator
 end
 ```
 
+
+To decorate a model in a namespace e.g. `Admin::Catalogue` place the decorator under the
+directory `app/decorators/admin` in the same way you would with views and models.
+
+```ruby
+# app/decorators/admin/catalogue_decorator.rb
+class Admin::CatalogueDecorator < Draper::Decorator
+# ...
+end
+```
+
 ### Generators
 
 To create an `ApplicationDecorator` that all generated decorators inherit from, run...
@@ -155,6 +166,15 @@ rails generate decorator Article
 
 ...to create the `ArticleDecorator`.
 
+If you don't want Rails to generate decorator files when generating a new controller,
+you can add the following configuration to your `config/application.rb` file:
+
+```ruby
+config.generators do |g|
+  g.decorator false
+end
+```
+
 ### Accessing Helpers
 
 Normal Rails helpers are still useful for lots of tasks. Both Rails' provided
@@ -664,7 +684,8 @@ great community of open source
 
 ### Current maintainers
 
-* Cliff Braton (cliff.braton@gmail.com)
+* Alexander Senko (Alexander.Senko@gmail.com)
+* Yuji Yaginuma (yuuji.yaginuma@gmail.com)
 
 ### Historical maintainers
 
@@ -673,3 +694,4 @@ great community of open source
 * Vasiliy Ermolovich
 * Andrew Haines
 * Sean Linsley
+* Cliff Braton (cliff.braton@gmail.com)

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,18 +1,17 @@
-require File.join(__dir__, "lib", "draper", "version")
+require_relative 'lib/draper/version'
 
 Gem::Specification.new do |s|
   s.name        = "draper"
   s.version     = Draper::VERSION
   s.authors     = ["Jeff Casimir", "Steve Klabnik"]
   s.email       = ["jeff@casimircreative.com", "steve@steveklabnik.com"]
-  s.homepage    = "http://github.com/drapergem/draper"
+  s.homepage    = "https://github.com/drapergem/draper"
   s.summary     = "View Models for Rails"
   s.description = "Draper adds an object-oriented layer of presentation logic to your Rails apps."
   s.license     = "MIT"
 
   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'
@@ -22,13 +21,14 @@ Gem::Specification.new do |s|
   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 'rspec-activerecord-expectations'
   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'
   s.add_development_dependency 'simplecov'
 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)
@@ -18,16 +18,26 @@ module Draper
       super || delegatable?(method)
     end
 
-    # @private
-    def delegatable?(method)
-      return if private_methods(false).include?(method)
+    # The inherit argument for `private_method_defined?` is supported since Ruby 2.6.
+    if RUBY_VERSION >= "2.6"
+      # @private
+      def delegatable?(method)
+        return if self.class.private_method_defined?(method, false)
 
-      object.respond_to?(method)
+        object.respond_to?(method)
+      end
+    else
+      # @private
+      def delegatable?(method)
+        return if private_methods(false).include?(method)
+
+        object.respond_to?(method)
+      end
     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/decoratable/collection_proxy.rb

@@ -0,0 +1,15 @@
+module Draper
+  module Decoratable
+    module CollectionProxy
+      # Decorates a collection of objects. Used at the end of a scope chain.
+      #
+      # @example
+      #   company.products.popular.decorate
+      # @param [Hash] options
+      #   see {Decorator.decorate_collection}.
+      def decorate(options = {})
+        decorator_class.decorate_collection(load_target, options.reverse_merge(with: nil))
+      end
+    end
+  end
+end

data/lib/draper/decoratable.rb

@@ -11,6 +11,8 @@ module Draper
     extend ActiveSupport::Concern
     include Draper::Decoratable::Equality
 
+    autoload :CollectionProxy, 'draper/decoratable/collection_proxy'
+
     # Decorates the object using the inferred {#decorator_class}.
     # @param [Hash] options
     #   see {Decorator#initialize}
@@ -87,8 +89,6 @@ module Draper
       def ===(other)
         super || (other.is_a?(Draper::Decorator) && super(other.object))
       end
-
     end
-
   end
 end

data/lib/draper/helper_proxy.rb

@@ -8,7 +8,7 @@ module Draper
     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
@@ -31,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

@@ -4,7 +4,7 @@ module Draper
   # 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

data/lib/draper/query_methods.rb

@@ -3,14 +3,14 @@ require_relative 'query_methods/load_strategy'
 module Draper
   module QueryMethods
     # Proxies missing query methods to the source class if the strategy allows.
-    def method_missing(method, *args, &block)
+    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
+      object.respond_to?(method) && strategy.allowed?(method) || super
     end
 
     private

data/lib/draper/railtie.rb

@@ -33,10 +33,14 @@ module Draper
     end
 
     initializer 'draper.setup_orm' do
-      [:active_record, :mongoid].each do |orm|
-        ActiveSupport.on_load orm do
-          Draper.setup_orm self
-        end
+      ActiveSupport.on_load :active_record do
+        include Draper::Decoratable
+
+        ActiveRecord::Associations::CollectionProxy.include Draper::Decoratable::CollectionProxy
+      end
+
+      ActiveSupport.on_load :mongoid do
+        include Draper::Decoratable
       end
     end
 

data/lib/draper/version.rb

@@ -1,3 +1,3 @@
 module Draper
-  VERSION = '4.0.1'
+  VERSION = '4.0.4'
 end

data/lib/draper/view_context/build_strategy.rb

@@ -38,17 +38,9 @@ module Draper
         def controller
           Draper::ViewContext.controller ||= Draper.default_controller.new
           Draper::ViewContext.controller.tap do |controller|
-            controller.request ||= new_test_request controller if defined?(ActionController::TestRequest)
+            controller.request ||= ActionDispatch::TestRequest.create
           end
         end
-
-        def new_test_request(controller)
-          is_above_rails_5_1 ? ActionController::TestRequest.create(controller) : ActionController::TestRequest.create
-        end
-
-        def is_above_rails_5_1
-          ActionController::TestRequest.method(:create).parameters.first == [:req, :controller_class]
-        end
       end
     end
   end

data/lib/draper/view_helpers.rb

@@ -28,7 +28,7 @@ module Draper
 
     # Alias for `helpers.localize`, since localize is something that's used
     # quite often. Further aliased to `l` for convenience.
-    def localize(*args)
+    ruby2_keywords def localize(*args)
       helpers.localize(*args)
     end
 

data/lib/draper.rb

@@ -8,6 +8,8 @@ require 'active_support/core_ext/hash/keys'
 require 'active_support/core_ext/hash/reverse_merge'
 require 'active_support/core_ext/name_error'
 
+require 'ruby2_keywords'
+
 require 'draper/version'
 require 'draper/configuration'
 require 'draper/view_helpers'
@@ -49,12 +51,6 @@ module Draper
     end
   end
 
-  def self.setup_orm(base)
-    base.class_eval do
-      include Draper::Decoratable
-    end
-  end
-
   class UninferrableDecoratorError < NameError
     def initialize(klass)
       super("Could not infer a decorator for #{klass}.")

data/spec/draper/collection_decorator_spec.rb

@@ -60,10 +60,11 @@ module Draper
 
       context "when the collection has not yet been decorated" do
         it "does not trigger decoration" do
-          decorator = CollectionDecorator.new([])
+          decorated = CollectionDecorator.new([]).tap(&:to_a)
+          undecorated = CollectionDecorator.new([])
 
-          expect(decorator).not_to receive(:decorated_collection)
-          decorator.context = {other: "context"}
+          expect(decorated.instance_variable_defined?(:@decorated_collection)).to be_truthy
+          expect(undecorated.instance_variable_defined?(:@decorated_collection)).to be_falsy
         end
 
         it "sets context after decoration is triggered" do
@@ -217,7 +218,7 @@ module Draper
         it "uses the custom class name" do
           decorator = ProductsDecorator.new([])
 
-          expect(decorator.to_s).to match /ProductsDecorator/
+          expect(decorator.to_s).to match(/ProductsDecorator/)
         end
       end
     end

data/spec/draper/decoratable_spec.rb

@@ -147,7 +147,7 @@ module Draper
         scoped = [Product.new]
         allow(Product).to receive(:all).and_return(scoped)
 
-        expect(Product.decorator_class).to receive(:decorate_collection).with(scoped, with: nil).and_return(:decorated_collection)
+        expect(Product.decorator_class).to receive(:decorate_collection).with(scoped, {with: nil}).and_return(:decorated_collection)
         expect(Product.decorate).to be :decorated_collection
       end