draper 3.0.0 → 4.0.2

data/lib/generators/test_unit/decorator_generator.rb

@@ -1,9 +1,12 @@
 module TestUnit
-  class DecoratorGenerator < ::Rails::Generators::NamedBase
-    source_root File.expand_path('../templates', __FILE__)
+  module Generators
+    class DecoratorGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path("templates", __dir__)
+      check_class_collision suffix: "DecoratorTest"
 
-    def create_test_file
-      template 'decorator_test.rb', File.join('test/decorators', class_path, "#{singular_name}_decorator_test.rb")
+      def create_test_file
+        template 'decorator_test.rb', File.join('test/decorators', class_path, "#{singular_name}_decorator_test.rb")
+      end
     end
   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
@@ -61,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
@@ -218,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
@@ -287,6 +287,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"}
@@ -73,6 +72,16 @@ module Draper
         expect(Product).to receive(:decorator_class).and_return(:some_decorator)
         expect(product.decorator_class).to be :some_decorator
       end
+
+      it "specifies the class that #decorator_class was first called on (superclass)" do
+        person = Person.new
+        expect { person.decorator_class }.to raise_error(Draper::UninferrableDecoratorError, 'Could not infer a decorator for Person.')
+      end
+
+      it "specifies the class that #decorator_class was first called on (subclass)" do
+        child = Child.new
+        expect { child.decorator_class }.to raise_error(Draper::UninferrableDecoratorError, 'Could not infer a decorator for Child.')
+      end
     end
 
     describe "#==" do
@@ -205,11 +214,22 @@ module Draper
 
       context "when an unrelated NameError is thrown" do
         it "re-raises that error" do
-          allow_any_instance_of(String).to receive(:constantize) { Draper::Base }
+          # Not related to safe_constantize behavior, we just want to raise a NameError inside the function
+          allow_any_instance_of(String).to receive(:safe_constantize) { Draper::Base }
           expect{Product.decorator_class}.to raise_error NameError, /Draper::Base/
         end
       end
-    end
 
+      context "when an anonymous class is given" do
+        it "infers the decorator from a superclass" do
+          anonymous_class = Class.new(Product) do
+            def self.name
+              to_s
+            end
+          end
+          expect(anonymous_class.decorator_class).to be ProductDecorator
+        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/decorator_spec.rb

@@ -202,7 +202,8 @@ module Draper
 
         context "when an unrelated NameError is thrown" do
           it "re-raises that error" do
-            allow_any_instance_of(String).to receive(:constantize) { SomethingThatDoesntExist }
+            # Not related to safe_constantize behavior, we just want to raise a NameError inside the function
+            allow_any_instance_of(String).to receive(:safe_constantize) { SomethingThatDoesntExist }
             expect{ProductDecorator.object_class}.to raise_error NameError, /SomethingThatDoesntExist/
           end
         end
@@ -225,7 +226,7 @@ module Draper
 
     describe '.collection_decorator_class' do
       it 'defaults to CollectionDecorator' do
-        allow_any_instance_of(String).to receive(:constantize) { SomethingThatDoesntExist }
+        allow_any_instance_of(String).to receive(:safe_constantize) { nil }
         expect(ProductDecorator.collection_decorator_class).to be Draper::CollectionDecorator
       end
 
@@ -438,7 +439,7 @@ module Draper
       it "returns a detailed description of the decorator" do
         decorator = ProductDecorator.new(double)
 
-        expect(decorator.inspect).to match /#<ProductDecorator:0x\h+ .+>/
+        expect(decorator.inspect).to match(/#<ProductDecorator:0x\h+ .+>/)
       end
 
       it "includes the object" do
@@ -663,6 +664,38 @@ module Draper
           expect{decorator.hello_world}.to raise_error NoMethodError
           expect(decorator.methods).not_to include :hello_world
         end
+
+        context 'when decorator overrides a public method defined on the object with a private' do
+          let(:decorator_class) do
+            Class.new(Decorator) do
+              private
+
+              def hello_world
+                'hello world'
+              end
+            end
+          end
+
+          let(:object) { Class.new { def hello_world; end }.new }
+
+          it 'does not delegate the public method defined on the object' do
+            decorator = decorator_class.new(object)
+
+            expect{ decorator.hello_world }.to raise_error NoMethodError
+          end
+        end
+
+        context 'when delegated method has the same name as private method defined on another object' do
+          let(:decorator_class) { Class.new(Decorator) }
+          let(:object) { Class.new { def print; end }.new }
+
+          it 'delegates the public method defined on the object' do
+            decorator = decorator_class.new(object)
+
+            # `print` private method is defined on `Object`
+            expect{ decorator.print }.not_to raise_error
+          end
+        end
       end
 
       context ".method_missing" do

data/spec/draper/draper_spec.rb

@@ -1,5 +1,6 @@
 require 'spec_helper'
 require 'support/shared_examples/view_helpers'
+SimpleCov.command_name 'test:unit'
 
 module Draper
   describe Draper do

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,70 @@
+require 'spec_helper'
+require_relative '../dummy/app/decorators/post_decorator'
+
+Post = Struct.new(:id) { }
+
+module Draper
+  describe QueryMethods do
+    let(:fake_strategy) { instance_double(QueryMethods::LoadStrategy::ActiveRecord) }
+
+    before { allow(QueryMethods::LoadStrategy).to receive(:new).and_return(fake_strategy) }
+
+    describe '#method_missing' do
+      let(:collection) { [ Post.new, Post.new ] }
+      let(:collection_context) { { user: 'foo' } }
+      let(:collection_decorator) { PostDecorator.decorate_collection(collection, context: collection_context) }
+
+      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
+
+        it 'calls the method on the collection and keeps the decoration options' do
+          collection_decorator.some_query_method
+
+          expect(results).to have_received(:decorate).with({ context: collection_context, with: PostDecorator })
+        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
+
+    describe "#respond_to?" do
+      let(:collection) { [ Post.new, Post.new ] }
+      let(:collection_decorator) { PostDecorator.decorate_collection(collection) }
+
+      subject { collection_decorator.respond_to?(:some_query_method) }
+
+      context 'when strategy allows collection to call the method' do
+        before do
+          allow(fake_strategy).to receive(:allowed?).with(:some_query_method).and_return(true)
+        end
+
+        it { is_expected.to eq(true) }
+      end
+
+      context 'when strategy does not allow collection to call the method' do
+        before do
+          allow(fake_strategy).to receive(:allowed?).with(:some_query_method).and_return(false)
+        end
+
+        it { is_expected.to eq(false) }
+      end
+    end
+  end
+end

data/spec/dummy/app/assets/config/manifest.js

@@ -0,0 +1,3 @@
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::Base
+end

data/spec/dummy/app/jobs/publish_post_job.rb

@@ -0,0 +1,7 @@
+class PublishPostJob < ActiveJob::Base
+  queue_as :default
+
+  def perform(post)
+    post.save!
+  end
+end

data/spec/dummy/app/models/application_record.rb

@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/spec/dummy/app/models/post.rb

@@ -1,3 +1,3 @@
-class Post < ActiveRecord::Base
+class Post < ApplicationRecord
   # attr_accessible :title, :body
 end

data/spec/dummy/config/application.rb

@@ -38,9 +38,6 @@ module Dummy
     # Configure the default encoding used in templates for Ruby 1.9.
     config.encoding = "utf-8"
 
-    # Configure sensitive parameters which will be filtered from the log file.
-    config.filter_parameters += [:password]
-
     # Enable escaping HTML in JSON.
     config.active_support.escape_html_entities_in_json = true
 

data/spec/dummy/config/environments/development.rb

@@ -30,4 +30,6 @@ Dummy::Application.configure do
 
   # Expands the lines which load the assets
   # config.assets.debug = true
+
+  config.active_storage.service = :local
 end

data/spec/dummy/config/environments/production.rb

@@ -54,4 +54,6 @@ Dummy::Application.configure do
   # Log the query plan for queries taking more than this (works
   # with SQLite, MySQL, and PostgreSQL)
   # config.active_record.auto_explain_threshold_in_seconds = 0.5
+
+  config.active_storage.service = :local
 end

data/spec/dummy/config/environments/test.rb

@@ -28,4 +28,8 @@ Dummy::Application.configure do
   config.active_support.deprecation = :stderr
 
   config.eager_load = false
+
+  config.active_job.queue_adapter = :test
+
+  config.active_storage.service = :test
 end