draper 3.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6f2c896cc71e7e4e654a5d65907dd0ec4cefed7f
-  data.tar.gz: ce50051cf161e9416483a40797d38ae2d2da3384
+  metadata.gz: cc23ed0f81227aa958510ecb67676453d97b40cc
+  data.tar.gz: ed8a159772bafb7df87cc5c767757e8b697f55b3
 SHA512:
-  metadata.gz: 527adb1c71ce28f23bb9be4186fe857c543a26edd8d20404f1e2a6db51e819143dd9c7973f7735746457c2a8a392e7a6d5b8a79232d26a1694035e09441a98f4
-  data.tar.gz: 0ed34d19d3b0300ea733392aab2c4cceaa1b284efc71e84452331fea4c9c11c68c7dc00baa7802a864d60f69bfb42beb8f5cecf959ed5ebf01b8a24c7e676f3f
+  metadata.gz: 466c609e53461c1e1f260f9e2bf6a0eb522238e5bdae8a2f37a88c1cd22d22665bf18293ba497f9f64d27faa0e12f0dbb9e3d906bae569f324c6124c02ad6b7e
+  data.tar.gz: db229fe0cf5daf0acc2e52834c599a21e9ba85782458a8fd3a0520574e77f1857ec30c57c81dceb75561016170c941f8da3593d3a58fd395137c01ce57322cf0

data/.travis.yml

@@ -1,9 +1,16 @@
 language: ruby
+sudo: false
+cache: bundler
 
 services:
   - mongodb
 
 rvm:
-  - 2.2.6
-  - 2.3.3
+  - 2.2.7
+  - 2.3.4
   - 2.4.1
+  - ruby-head
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Draper Changelog
 
+## 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)
+* ActiveJob compatibility and documentation [#817](https://github.com/drapergem/draper/pull/817)
+
 ## 3.0.0 - 2017
 
 ### Breaking Changes

data/README.md

@@ -618,6 +618,15 @@ is included in `ActiveRecord::Base` and `Mongoid::Document` by default. If
 you're using another ORM, or want to decorate plain old Ruby objects,
 you can include this module manually.
 
+### Active Job Integration
+
+[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
+you can pass decorated objects to background jobs, however, the object won't be decorated when it is
+deserialized.
+
 ## Contributors
 
 Draper was conceived by Jeff Casimir and heavily refined by Steve Klabnik and a

data/lib/draper/compatibility/global_id.rb

@@ -0,0 +1,22 @@
+module Draper
+  module Compatibility
+    # [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).
+    #
+    # This compatibility patch implements Global ID for decorated objects by delegating to the object
+    # that is decorated. This means you can pass decorated objects to background jobs, but 
+    # the object won't be decorated when it is deserialized. This patch is meant as an intermediate
+    # fix until we can find a way to deserialize the decorated object correctly.
+    module GlobalID
+      extend ActiveSupport::Concern
+
+      included do
+        include ::GlobalID::Identification
+
+        delegate :to_global_id, :to_signed_global_id, to: :object
+      end
+    end
+  end
+end

data/lib/draper/decoratable.rb

@@ -69,16 +69,16 @@ module Draper
       # `Product` maps to `ProductDecorator`).
       #
       # @return [Class] the inferred decorator class.
-      def decorator_class
+      def decorator_class(called_on = self)
         prefix = respond_to?(:model_name) ? model_name : name
         decorator_name = "#{prefix}Decorator"
-        decorator_name.constantize
-      rescue NameError => error
-        raise unless error.missing_name?(decorator_name)
+        decorator_name_constant = decorator_name.safe_constantize
+        return decorator_name_constant unless decorator_name_constant.nil?
+
         if superclass.respond_to?(:decorator_class)
-          superclass.decorator_class
+          superclass.decorator_class(called_on)
         else
-          raise Draper::UninferrableDecoratorError.new(self)
+          raise Draper::UninferrableDecoratorError.new(called_on)
         end
       end
 

data/lib/draper/decorator.rb

@@ -1,6 +1,9 @@
+require 'draper/compatibility/global_id'
+
 module Draper
   class Decorator
     include Draper::ViewHelpers
+    include Draper::Compatibility::GlobalID if defined?(GlobalID)
     extend Draper::Delegation
 
     include ActiveModel::Serialization
@@ -222,9 +225,9 @@ module Draper
     # @return [Class] the class created by {decorate_collection}.
     def self.collection_decorator_class
       name = collection_decorator_name
-      name.constantize
-    rescue NameError
-      Draper::CollectionDecorator
+      name_constant = name && name.safe_constantize
+
+      name_constant || Draper::CollectionDecorator
     end
 
     private
@@ -239,22 +242,23 @@ module Draper
     end
 
     def self.object_class_name
-      raise NameError if name.nil? || name.demodulize !~ /.+Decorator$/
+      return nil if name.nil? || name.demodulize !~ /.+Decorator$/
       name.chomp("Decorator")
     end
 
     def self.inferred_object_class
       name = object_class_name
-      name.constantize
-    rescue NameError => error
-      raise if name && !error.missing_name?(name)
+      name_constant = name && name.safe_constantize
+      return name_constant unless name_constant.nil?
+
       raise Draper::UninferrableObjectError.new(self)
     end
 
     def self.collection_decorator_name
-      plural = object_class_name.pluralize
-      raise NameError if plural == object_class_name
-      "#{plural}Decorator"
+      singular = object_class_name
+      plural = singular && singular.pluralize
+
+      "#{plural}Decorator" unless plural == singular
     end
 
     def handle_multiple_decoration(options)

data/lib/draper/version.rb

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

data/lib/generators/draper/install_generator.rb

@@ -1,7 +1,7 @@
 module Draper
   module Generators
     class InstallGenerator < Rails::Generators::Base
-      source_root File.expand_path('../templates', __FILE__)
+      source_root File.expand_path("templates", __dir__)
 
       desc 'Creates an ApplicationDecorator, if none exists.'
 

data/lib/generators/mini_test/decorator_generator.rb

@@ -4,7 +4,7 @@ module MiniTest
   module Generators
     class DecoratorGenerator < Base
       def self.source_root
-        File.expand_path('../templates', __FILE__)
+        File.expand_path("templates", __dir__)
       end
 
       class_option :spec, type: :boolean, default: false, desc: "Use MiniTest::Spec DSL"

data/lib/generators/rails/decorator_generator.rb

@@ -1,7 +1,7 @@
 module Rails
   module Generators
     class DecoratorGenerator < NamedBase
-      source_root File.expand_path("../templates", __FILE__)
+      source_root File.expand_path("templates", __dir__)
       check_class_collision suffix: "Decorator"
 
       class_option :parent, type: :string, desc: "The parent class for the generated decorator"

data/lib/generators/rspec/decorator_generator.rb

@@ -1,9 +1,11 @@
 module Rspec
-  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__)
 
-    def create_spec_file
-      template 'decorator_spec.rb', File.join('spec/decorators', class_path, "#{singular_name}_decorator_spec.rb")
+      def create_spec_file
+        template 'decorator_spec.rb', File.join('spec/decorators', class_path, "#{singular_name}_decorator_spec.rb")
+      end
     end
   end
 end

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

@@ -73,6 +73,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,10 +215,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
+
+      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

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
 

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

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

data/spec/dummy/config/initializers/filter_parameter_logging.rb

@@ -0,0 +1,4 @@
+# Be sure to restart your server when you modify this file.
+
+# Configure sensitive parameters which will be filtered from the log file.
+Rails.application.config.filter_parameters += [:password]

data/spec/dummy/db/migrate/20121019115657_create_posts.rb

@@ -1,4 +1,4 @@
-class CreatePosts < ActiveRecord::Migration
+class CreatePosts < ActiveRecord::Migration[4.2]
   def change
     create_table :posts do |t|
 

data/spec/dummy/spec/jobs/publish_post_job_spec.rb

@@ -0,0 +1,9 @@
+RSpec.describe PublishPostJob, type: :job do
+  let(:post) { Post.create.decorate }
+
+  subject(:job) { described_class.perform_later(post) }
+
+  it 'queues the job' do
+    expect { job }.to have_enqueued_job(described_class).with(post.object)
+  end
+end

data/spec/dummy/spec/models/application_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe ApplicationRecord do
+  it { expect(described_class.superclass).to eq ActiveRecord::Base }
+
+  it { expect(described_class.abstract_class).to be_truthy }
+end

data/spec/dummy/spec/models/post_spec.rb

@@ -1,6 +1,15 @@
 require 'spec_helper'
 require 'shared_examples/decoratable'
 
-describe Post do
-  it_behaves_like "a decoratable model"
+RSpec.describe Post do
+  it_behaves_like 'a decoratable model'
+
+  it { should be_a ApplicationRecord }
+
+  describe '#to_global_id' do
+    let(:post) { Post.create }
+    subject { post.to_global_id }
+
+    it { is_expected.to eq post.decorate.to_global_id }
+  end
 end

data/spec/spec_helper.rb

@@ -16,6 +16,8 @@ class Model; include Draper::Decoratable; end
 class Product < Model; end
 class SpecialProduct < Product; end
 class Other < Model; end
+class Person < Model; end
+class Child < Person; end
 class ProductDecorator < Draper::Decorator; end
 class ProductsDecorator < Draper::CollectionDecorator; end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: draper
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
 platform: ruby
 authors:
 - Jeff Casimir
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-08 00:00:00.000000000 Z
+date: 2017-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -207,6 +207,7 @@ files:
 - lib/draper/automatic_delegation.rb
 - lib/draper/collection_decorator.rb
 - lib/draper/compatibility/api_only.rb
+- lib/draper/compatibility/global_id.rb
 - lib/draper/configuration.rb
 - lib/draper/decoratable.rb
 - lib/draper/decoratable/equality.rb
@@ -267,9 +268,11 @@ files:
 - spec/dummy/app/decorators/mongoid_post_decorator.rb
 - spec/dummy/app/decorators/post_decorator.rb
 - spec/dummy/app/helpers/application_helper.rb
+- spec/dummy/app/jobs/publish_post_job.rb
 - spec/dummy/app/mailers/application_mailer.rb
 - spec/dummy/app/mailers/post_mailer.rb
 - spec/dummy/app/models/admin.rb
+- spec/dummy/app/models/application_record.rb
 - spec/dummy/app/models/mongoid_post.rb
 - spec/dummy/app/models/post.rb
 - spec/dummy/app/models/user.rb
@@ -288,6 +291,7 @@ files:
 - spec/dummy/config/environments/test.rb
 - spec/dummy/config/initializers/backtrace_silencers.rb
 - spec/dummy/config/initializers/draper.rb
+- spec/dummy/config/initializers/filter_parameter_logging.rb
 - spec/dummy/config/initializers/inflections.rb
 - spec/dummy/config/initializers/mime_types.rb
 - spec/dummy/config/initializers/secret_token.rb
@@ -312,7 +316,9 @@ files:
 - spec/dummy/spec/decorators/post_decorator_spec.rb
 - spec/dummy/spec/decorators/spec_type_spec.rb
 - spec/dummy/spec/decorators/view_context_spec.rb
+- spec/dummy/spec/jobs/publish_post_job_spec.rb
 - spec/dummy/spec/mailers/post_mailer_spec.rb
+- spec/dummy/spec/models/application_spec.rb
 - spec/dummy/spec/models/mongoid_post_spec.rb
 - spec/dummy/spec/models/post_spec.rb
 - spec/dummy/spec/shared_examples/decoratable.rb
@@ -389,9 +395,11 @@ test_files:
 - spec/dummy/app/decorators/mongoid_post_decorator.rb
 - spec/dummy/app/decorators/post_decorator.rb
 - spec/dummy/app/helpers/application_helper.rb
+- spec/dummy/app/jobs/publish_post_job.rb
 - spec/dummy/app/mailers/application_mailer.rb
 - spec/dummy/app/mailers/post_mailer.rb
 - spec/dummy/app/models/admin.rb
+- spec/dummy/app/models/application_record.rb
 - spec/dummy/app/models/mongoid_post.rb
 - spec/dummy/app/models/post.rb
 - spec/dummy/app/models/user.rb
@@ -410,6 +418,7 @@ test_files:
 - spec/dummy/config/environments/test.rb
 - spec/dummy/config/initializers/backtrace_silencers.rb
 - spec/dummy/config/initializers/draper.rb
+- spec/dummy/config/initializers/filter_parameter_logging.rb
 - spec/dummy/config/initializers/inflections.rb
 - spec/dummy/config/initializers/mime_types.rb
 - spec/dummy/config/initializers/secret_token.rb
@@ -434,7 +443,9 @@ test_files:
 - spec/dummy/spec/decorators/post_decorator_spec.rb
 - spec/dummy/spec/decorators/spec_type_spec.rb
 - spec/dummy/spec/decorators/view_context_spec.rb
+- spec/dummy/spec/jobs/publish_post_job_spec.rb
 - spec/dummy/spec/mailers/post_mailer_spec.rb
+- spec/dummy/spec/models/application_spec.rb
 - spec/dummy/spec/models/mongoid_post_spec.rb
 - spec/dummy/spec/models/post_spec.rb
 - spec/dummy/spec/shared_examples/decoratable.rb