draper 3.0.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: cc23ed0f81227aa958510ecb67676453d97b40cc
-  data.tar.gz: ed8a159772bafb7df87cc5c767757e8b697f55b3
+SHA256:
+  metadata.gz: c323d66ea5eafcb8aac1d70bdbf02335a7460939bf6dc24a801a37a7c75f6691
+  data.tar.gz: ebd93feddfba45e9c1596b320278bc3ae0886579dbfc6637f7025a6df6e3994c
 SHA512:
-  metadata.gz: 466c609e53461c1e1f260f9e2bf6a0eb522238e5bdae8a2f37a88c1cd22d22665bf18293ba497f9f64d27faa0e12f0dbb9e3d906bae569f324c6124c02ad6b7e
-  data.tar.gz: db229fe0cf5daf0acc2e52834c599a21e9ba85782458a8fd3a0520574e77f1857ec30c57c81dceb75561016170c941f8da3593d3a58fd395137c01ce57322cf0
+  metadata.gz: 5977d38ab1436a7dd00cb9e6e8854abdd78d2d21e2a15c00d1b40dade4490909a5d66c73fe64cbea610074096d7ece893fc70b16403fa9090b5de62a2eed2ff6
+  data.tar.gz: b1d4f7faf5afafc5b4820b30bb8f2650fe8c8f936fdde22aedc3198d6b6c21d3299f067da23d96f23a835081bdbef2d71263725f72dce843723f14be3e7216f8

data/.travis.yml

@@ -6,9 +6,10 @@ services:
   - mongodb
 
 rvm:
-  - 2.2.7
-  - 2.3.4
-  - 2.4.1
+  - 2.3.5
+  - 2.4.3
+  - 2.5.4
+  - 2.6.2
   - ruby-head
 
 matrix:

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Draper Changelog
 
+## 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,7 @@ source "https://rubygems.org"
 gemspec
 
 platforms :ruby do
-  gem "sqlite3"
+  gem 'sqlite3', '~> 1.3.6'
 end
 
 platforms :jruby do

data/README.md

@@ -326,6 +326,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
@@ -463,6 +474,20 @@ preferred stubbing technique (this example uses RSpec's `stub` method):
 helpers.stub(users_path: '/users')
 ```
 
+### 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

data/draper.gemspec

@@ -17,17 +17,17 @@ Gem::Specification.new do |s|
 
   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_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'
 end

data/lib/draper.rb

@@ -23,6 +23,7 @@ require 'draper/factory'
 require 'draper/decorated_association'
 require 'draper/helper_support'
 require 'draper/view_context'
+require 'draper/query_methods'
 require 'draper/collection_decorator'
 require 'draper/undecorate'
 require 'draper/decorates_assigned'

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.

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/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,7 +2,6 @@ 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

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)
       helpers.send(method, *args, &block)
     rescue NoMethodError
       super
     end
-
   end
 end

data/lib/draper/query_methods.rb

@@ -0,0 +1,19 @@
+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)
+      return super unless strategy.allowed? method
+
+      object.send(method, *args, &block).decorate
+    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

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/test_case.rb

@@ -3,9 +3,9 @@ module Draper
 
   class TestCase < ::ActiveSupport::TestCase
     module ViewContextTeardown
-      def teardown
-        super
+      def before_setup
         Draper::ViewContext.clear!
+        super
       end
     end
 

data/lib/draper/undecorate.rb

@@ -6,7 +6,7 @@ module Draper
       object
     end
   end
-  
+
   def self.undecorate_chain(object)
     if object.respond_to?(:decorated?) && object.decorated?
       undecorate_chain(object.object)

data/lib/draper/version.rb

@@ -1,3 +1,3 @@
 module Draper
-  VERSION = '3.0.1'
+  VERSION = '3.1.0'
 end

data/lib/draper/view_context/build_strategy.rb

@@ -2,7 +2,6 @@ module Draper
   module ViewContext
     # @private
     module BuildStrategy
-
       def self.new(name, &block)
         const_get(name.to_s.camelize).new(&block)
       end
@@ -51,7 +50,6 @@ module Draper
           ActionController::TestRequest.method(:create).parameters.first == [:req, :controller_class]
         end
       end
-
     end
   end
 end

data/lib/draper/view_helpers.rb

@@ -5,7 +5,6 @@ module Draper
     extend ActiveSupport::Concern
 
     module ClassMethods
-
       # Access the helpers proxy to call built-in and user-defined
       # Rails helpers from a class context.
       #
@@ -14,7 +13,6 @@ module Draper
         Draper::ViewContext.current
       end
       alias_method :h, :helpers
-
     end
 
     # Access the helpers proxy to call built-in and user-defined
@@ -32,6 +30,5 @@ module Draper
       helpers.localize(*args)
     end
     alias_method :l, :localize
-
   end
 end

data/spec/draper/collection_decorator_spec.rb

@@ -7,7 +7,6 @@ module Draper
 
     describe "#initialize" do
       describe "options validation" do
-
         it "does not raise error on valid options" do
           valid_options = {with: Decorator, context: {}}
           expect{CollectionDecorator.new([], valid_options)}.not_to raise_error
@@ -287,6 +286,5 @@ module Draper
         expect(decorator.replace([:foo, :bar])).to be decorator
       end
     end
-
   end
 end

data/spec/draper/configuration_spec.rb

@@ -6,20 +6,44 @@ module Draper
       Draper.configure { |config| expect(config).to be Draper }
     end
 
-    it 'defaults default_controller to ApplicationController' do
-      expect(Draper.default_controller).to be ApplicationController
+    describe '#default_controller' do
+      it 'defaults default_controller to ApplicationController' do
+        expect(Draper.default_controller).to be ApplicationController
+      end
+
+      it 'allows customizing default_controller through configure' do
+        default = Draper.default_controller
+
+        Draper.configure do |config|
+          config.default_controller = CustomController
+        end
+
+        expect(Draper.default_controller).to be CustomController
+
+        Draper.default_controller = default
+      end
     end
 
-    it 'allows customizing default_controller through configure' do
-      default = Draper.default_controller
+    describe '#default_query_methods_strategy' do
+      let!(:default) { Draper.default_query_methods_strategy }
+
+      subject { Draper.default_query_methods_strategy }
 
-      Draper.configure do |config|
-        config.default_controller = CustomController
+      context 'when there is no custom strategy' do
+        it { is_expected.to eq(:active_record) }
       end
 
-      expect(Draper.default_controller).to be CustomController
+      context 'when using a custom strategy' do
+        before do
+          Draper.configure do |config|
+            config.default_query_methods_strategy = :mongoid
+          end
+        end
 
-      Draper.default_controller = default
+        after { Draper.default_query_methods_strategy = default }
+
+        it { is_expected.to eq(:mongoid) }
+      end
     end
   end
 end

data/spec/draper/decoratable_spec.rb

@@ -3,7 +3,6 @@ require 'support/shared_examples/decoratable_equality'
 
 module Draper
   describe Decoratable do
-
     describe "#decorate" do
       it "returns a decorator for self" do
         product = Product.new
@@ -11,7 +10,7 @@ module Draper
 
         expect(decorator).to be_a ProductDecorator
         expect(decorator.object).to be product
-     end
+      end
 
       it "accepts context" do
         context = {some: "context"}
@@ -232,6 +231,5 @@ module Draper
         end
       end
     end
-
   end
 end

data/spec/draper/decorated_association_spec.rb

@@ -2,7 +2,6 @@ require 'spec_helper'
 
 module Draper
   describe DecoratedAssociation do
-
     describe "#initialize" do
       it "accepts valid options" do
         valid_options = {with: Decorator, scope: :foo, context: {}}
@@ -79,6 +78,5 @@ module Draper
         end
       end
     end
-
   end
 end

data/spec/draper/factory_spec.rb

@@ -2,7 +2,6 @@ require 'spec_helper'
 
 module Draper
   describe Factory do
-
     describe "#initialize" do
       it "accepts valid options" do
         valid_options = {with: Decorator, context: {foo: "bar"}}
@@ -88,11 +87,9 @@ module Draper
         end
       end
     end
-
   end
 
   describe Factory::Worker do
-
     describe "#call" do
       it "calls the decorator method" do
         object = double
@@ -246,6 +243,5 @@ module Draper
         end
       end
     end
-
   end
 end

data/spec/draper/query_methods/load_strategy_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+require 'active_record'
+
+module Draper
+  module QueryMethods
+    describe LoadStrategy do
+      describe '#new' do
+        subject { described_class.new(:active_record) }
+
+        it { is_expected.to be_an_instance_of(LoadStrategy::ActiveRecord) }
+      end
+    end
+
+    describe LoadStrategy::ActiveRecord do
+      describe '#allowed?' do
+        it 'checks whether or not ActiveRecord::Relation::VALUE_METHODS has the given method' do
+          allow(::ActiveRecord::Relation::VALUE_METHODS).to receive(:include?)
+
+          described_class.new.allowed? :foo
+
+          expect(::ActiveRecord::Relation::VALUE_METHODS).to have_received(:include?).with(:foo)
+        end
+      end
+    end
+  end
+end

data/spec/draper/query_methods_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+require_relative '../dummy/app/decorators/post_decorator'
+
+Post = Struct.new(:id) { }
+
+module Draper
+  describe QueryMethods do
+    describe '#method_missing' do
+      let(:collection) { [ Post.new, Post.new ] }
+      let(:collection_decorator) { PostDecorator.decorate_collection(collection) }
+      let(:fake_strategy) { instance_double(QueryMethods::LoadStrategy::ActiveRecord) }
+
+      before { allow(QueryMethods::LoadStrategy).to receive(:new).and_return(fake_strategy) }
+
+      context 'when strategy allows collection to call the method' do
+        let(:results) { spy(:results) }
+
+        before do
+          allow(fake_strategy).to receive(:allowed?).with(:some_query_method).and_return(true)
+          allow(collection).to receive(:send).with(:some_query_method).and_return(results)
+        end
+
+        it 'calls the method on the collection and decorate it results' do
+          collection_decorator.some_query_method
+
+          expect(results).to have_received(:decorate)
+        end
+      end
+
+      context 'when strategy does not allow collection to call the method' do
+        before { allow(fake_strategy).to receive(:allowed?).with(:some_query_method).and_return(false) }
+
+        it 'raises NoMethodError' do
+          expect { collection_decorator.some_query_method }.to raise_exception(NoMethodError)
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: draper
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.1.0
 platform: ruby
 authors:
 - Jeff Casimir
@@ -9,76 +9,76 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-12 00:00:00.000000000 Z
+date: 2019-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
   name: request_store
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
   name: activemodel-serializers-xml
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
@@ -155,14 +155,14 @@ dependencies:
   name: active_model_serializers
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.10'
 - !ruby/object:Gem::Dependency
@@ -220,6 +220,8 @@ files:
 - lib/draper/helper_proxy.rb
 - lib/draper/helper_support.rb
 - lib/draper/lazy_helpers.rb
+- lib/draper/query_methods.rb
+- lib/draper/query_methods/load_strategy.rb
 - lib/draper/railtie.rb
 - lib/draper/tasks/test.rake
 - lib/draper/test/devise_helper.rb
@@ -255,6 +257,8 @@ files:
 - spec/draper/finders_spec.rb
 - spec/draper/helper_proxy_spec.rb
 - spec/draper/lazy_helpers_spec.rb
+- spec/draper/query_methods/load_strategy_spec.rb
+- spec/draper/query_methods_spec.rb
 - spec/draper/undecorate_chain_spec.rb
 - spec/draper/undecorate_spec.rb
 - spec/draper/view_context/build_strategy_spec.rb
@@ -364,8 +368,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: View Models for Rails
@@ -382,6 +385,8 @@ test_files:
 - spec/draper/finders_spec.rb
 - spec/draper/helper_proxy_spec.rb
 - spec/draper/lazy_helpers_spec.rb
+- spec/draper/query_methods/load_strategy_spec.rb
+- spec/draper/query_methods_spec.rb
 - spec/draper/undecorate_chain_spec.rb
 - spec/draper/undecorate_spec.rb
 - spec/draper/view_context/build_strategy_spec.rb