active_decorator 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 14f002118bfbc2127bf674fc7488990d80a5152c
-  data.tar.gz: 6e40b90bb6ffc7ba584147a93041025456216f52
+  metadata.gz: 4a64ac56dc2cc2bf285935260b3dd24f83df0b82
+  data.tar.gz: ec20d7d2ea5a11c8dff62b1b4bf648e73294da95
 SHA512:
-  metadata.gz: 5bd8f1c1bdc0cfe4734755e9a56fd1d20cbea6205319ac20c308360b95b5c74303d3f16cda0002458c2b33795ad6690e2eb8401ed99d35db4c3068f5630e6936
-  data.tar.gz: cf5c094dedd2637ea7f23bdd3b0f131b2a33f0cc98e9ff2148433960e8305c2b1732d7cf6005bd82247d9cc8b8a71897c61e5bcd5f9d044a641d970f53c7fa58
+  metadata.gz: 113084bbe2c85cfe885ba8c99bac86b7a09650647630fe4c5c71c93ef2c316039552055a5200d49fc1d2f87a0573686d8c6865f22e38761c46751fbdd23ea58b
+  data.tar.gz: a8dd5c74158c52d2dbda7116a3289ac30287b639606271f14f4ddcd924f6a2ee3dac79294fec6c9d3e41f6d55aea20f027530358589bf17f42e1a51a4fd7bb0a

data/.travis.yml

@@ -1,12 +1,14 @@
 language: ruby
 
+before_install: gem update bundler --no-document
 script: bundle exec rake test
 
 rvm:
   - 2.0.0
   - 2.1.10
-  - 2.2.6
+  - 2.2.7
   - 2.3.3
+  - 2.4.1
   - ruby-head
 gemfile:
   - gemfiles/Gemfile-rails.3.2.x
@@ -14,6 +16,7 @@ gemfile:
   - gemfiles/Gemfile-rails.4.1.x
   - gemfiles/Gemfile-rails.4.2.x
   - gemfiles/Gemfile-rails.5.0.x
+  - gemfiles/Gemfile-rails.5.1.x
 
 sudo: false
 
@@ -25,9 +28,22 @@ matrix:
       gemfile: gemfiles/Gemfile-rails.4.0.x
     - rvm: ruby-head
       gemfile: gemfiles/Gemfile-rails.4.1.x
+    - rvm: 2.4.1
+      gemfile: gemfiles/Gemfile-rails.3.2.x
+    - rvm: 2.4.1
+      gemfile: gemfiles/Gemfile-rails.4.0.x
+    - rvm: 2.4.1
+      gemfile: gemfiles/Gemfile-rails.4.1.x
+    - rvm: 2.4.1
+      gemfile: gemfiles/Gemfile-rails.4.2.x
     - rvm: 2.0.0
       gemfile: gemfiles/Gemfile-rails.5.0.x
     - rvm: 2.1.10
       gemfile: gemfiles/Gemfile-rails.5.0.x
+    - rvm: 2.0.0
+      gemfile: gemfiles/Gemfile-rails.5.1.x
+    - rvm: 2.1.10
+      gemfile: gemfiles/Gemfile-rails.5.1.x
   allow_failures:
     - rvm: ruby-head
+    - gemfile: gemfiles/Gemfile-rails.5.1.x

data/README.md

@@ -8,13 +8,14 @@ A simple and Rubyish view helper for Rails 3, Rails 4 and Rails 5. Keep your hel
 1. automatically mixes decorator module into corresponding model only when:
   1. passing a model or collection of models or an instance of ActiveRecord::Relation from controllers to views
   2. rendering partials with models (using `:collection` or `:object` or `:locals` explicitly or implicitly)
+  3. fetching already decorated Active Record model object's association
 2. the decorator module runs in the model's context. So, you can directly call any attributes or methods in the decorator module
 3. since decorators are considered as sort of helpers, you can also call any ActionView's helper methods such as `content_tag` or `link_to`
 
 
 ## Supported versions ##
 
-* Ruby 2.0.0, 2.1.x, 2.2.x, 2.3.x, and 2.4 (trunk)
+* Ruby 2.0.0, 2.1.x, 2.2.x, 2.3.x, 2.4.x, and 2.5 (trunk)
 
 * Rails 3.2.x, 4.0.x, 4.1.x, 4.2.x, 5.0, and 5.1 (edge)
 
@@ -34,77 +35,81 @@ You can use the generator for doing this ( `% rails g decorator user` )
 
 ## Examples ##
 
+### Auto-decorating via `render` ###
+
+* Model
 ```ruby
-# app/models/user.rb
-class User < ActiveRecord::Base
-  # first_name:string last_name:string website:string
+class Author < ActiveRecord::Base
+  # first_name:string last_name:string
 end
+```
 
-# app/decorators/user_decorator.rb
-module UserDecorator
-  def full_name
-    "#{first_name} #{last_name}"
-  end
-
-  def link
-    link_to full_name, website
+* Controller
+```ruby
+class AuthorsController < ApplicationController
+  def show(id)
+    @user = Author.find id
   end
 end
+```
 
-# app/controllers/users_controller.rb
-class UsersController < ApplicationController
-  def index
-    @users = User.all
+* Decorator
+```ruby
+module AuthorDecorator
+  def full_name
+    "#{first_name} #{last_name}"
   end
 end
 ```
+
+* View
 ```erb
-# app/views/users/index.html.erb
-<% @users.each do |user| %>
-  <%= user.link %><br>
-<% end %>
+<%# @author here is auto-decorated in between the controller and the view %>
+<p><%= @author.full_name %></p>
 ```
 
-## Decorating associated objects ##
-
-ActiveDecorator *does not* automatically decorate associated objects. We recommend that you pass associated objects to `render` when decorated associated objects are needed.
+### Auto-decorating via AR model's associated objects ###
 
+* Models
 ```ruby
-# app/models/blog_post.rb
-class BlogPost < ActiveRecord::Base
-  # published_at:datetime
+class Author < ActiveRecord::Base
+  # name:string
+  has_many :books
 end
 
-# app/models/user.rb
-class User < ActiveRecord::Base
-  has_many :blog_posts
+class Book < ActiveRecord::Base
+  # title:string url:string
+  belongs_to :author
 end
+```
 
-# app/decorators/blog_post_decorator.rb
-module BlogPostDecorator
-  def published_date
-    published_at.strftime("%Y.%m.%d")
+* Controller
+```ruby
+class AuthorsController < ApplicationController
+  def show(id)
+    @user = Author.find id
   end
 end
+```
 
-# app/controllers/users_controller.rb
-class UsersController < ApplicationController
-  def index
-    @users = User.all
+* Decorator
+```ruby
+module BookDecorator
+  def link
+    link_to title, url
   end
 end
 ```
 
+* View
 ```erb
-# app/views/users/index.html.erb
-<% @users.each do |user| %>
-  <%= render partial: "blog_post", locals: { blog_posts: user.blog_posts } %><br>
-<% end %>
-
-# app/views/users/_blog_post.html.erb
-<% blog_posts.each do |blog_post| %>
-  <%= blog_post.published_date %>
+<p><%= @author.name %></p>
+<ul>
+<% @author.books.each do |book| %>
+  <%# `book` here is auto-decorated because @author is a decorated instance %>
+  <li><%= book.link %></li>
 <% end %>
+</ul>
 ```
 
 ## Testing

data/gemfiles/Gemfile-rails.5.1.x

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gem 'active_decorator', path: '..'
+
+gem 'rails', '5.1.0.rc1'
+gem 'test-unit-rails'
+gem 'capybara'
+gem 'sqlite3'
+gem 'jbuilder'

data/lib/active_decorator/decorated.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+# A no-op module to mark an AR model instance as a "decorated" object.
+module ActiveDecorator::Decorated
+end

data/lib/active_decorator/decorator.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 require 'singleton'
 require 'active_decorator/helpers'
+require 'active_decorator/decorated'
 
 module ActiveDecorator
   class Decorator
@@ -10,8 +11,17 @@ module ActiveDecorator
       @@decorators = {}
     end
 
+    # Decorates the given object.
+    # Plus, performs special decoration for the classes below:
+    #   Array: decorates its each element
+    #   AR::Relation: decorates its each record lazily
+    #   AR model: decorates its associations on the fly
+    #
+    # Always returns the object, regardless of whether decorated or not decorated.
+    #
+    # This method can be publicly called from anywhere by `ActiveDecorator::Decorator.instance.decorate(obj)`.
     def decorate(obj)
-      return if defined?(Jbuilder) && Jbuilder === obj
+      return if defined?(Jbuilder) && (Jbuilder === obj)
       return if obj.nil?
 
       if obj.is_a?(Array)
@@ -28,13 +38,26 @@ module ActiveDecorator
           obj.extend ActiveDecorator::RelationDecoratorLegacy unless obj.is_a? ActiveDecorator::RelationDecoratorLegacy
         end
       else
+        if defined?(ActiveRecord) && obj.is_a?(ActiveRecord::Base) && !obj.is_a?(ActiveDecorator::Decorated)
+          obj.extend ActiveDecorator::Decorated
+        end
+
         d = decorator_for obj.class
         return obj unless d
         obj.extend d unless obj.is_a? d
+        obj
       end
     end
 
+    # Decorates AR model object's association only when the object was decorated.
+    # Returns the association instance.
+    def decorate_association(owner, target)
+      owner.is_a?(ActiveDecorator::Decorated) ? decorate(target) : target
+    end
+
     private
+    # Returns a decorator module for the given class.
+    # Returns `nil` if no decorator module was found.
     def decorator_for(model_class)
       return @@decorators[model_class] if @@decorators.key? model_class
 
@@ -57,6 +80,7 @@ module ActiveDecorator
     end
   end
 
+  # For AR 3 and 4
   module RelationDecoratorLegacy
     def to_a
       super.tap do |arr|
@@ -65,6 +89,7 @@ module ActiveDecorator
     end
   end
 
+  # For AR 5+
   module RelationDecorator
     def records
       super.tap do |arr|

data/lib/active_decorator/helpers.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# On the fly delegation from the decorator to the decorated object and the helpers.
 module ActiveDecorator
   module Helpers
     def method_missing(method, *args, &block)

data/lib/active_decorator/monkey/abstract_controller/rendering.rb

@@ -1,4 +1,6 @@
 # frozen_string_literal: true
+# A monkey-patch for Rails controllers/mailers that auto-decorates ivars
+# that are passed to views.
 module ActiveDecorator
   module Monkey
     module AbstractController

data/lib/active_decorator/monkey/action_controller/base/rescue_from.rb

@@ -1,4 +1,6 @@
 # frozen_string_literal: true
+# A monkey-patch for Action Controller to pass the controller view_context over
+# to `render` invocation in `rescue_from` block.
 module ActiveDecorator
   module Monkey
     module ActionController

data/lib/active_decorator/monkey/action_view/partial_renderer.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# A monkey-patch for Action View `render :partial` that auto-decorates `locals` values.
 module ActiveDecorator
   module Monkey
     module ActionView

data/lib/active_decorator/monkey/active_record/associations.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+# A monkey-patch for Active Record that enables association auto-decoration.
+module ActiveDecorator
+  module Monkey
+    module ActiveRecord
+      module Associations
+        module Association
+          def target
+            ActiveDecorator::Decorator.instance.decorate_association(owner, super)
+          end
+        end
+
+        # @see https://github.com/rails/rails/commit/03855e790de2224519f55382e3c32118be31eeff
+        if Rails.version.to_f < 4.1
+          module CollectionAssociation
+            private
+            def first_or_last(*)
+              ActiveDecorator::Decorator.instance.decorate_association(owner, super)
+            end
+          end
+        elsif Rails.version.to_f < 5.1
+          module CollectionAssociation
+            private
+            def first_nth_or_last(*)
+              ActiveDecorator::Decorator.instance.decorate_association(owner, super)
+            end
+          end
+        end
+
+        if Rails.version.to_f >= 4.0
+          module CollectionProxy
+            def take(limit = nil)
+              ActiveDecorator::Decorator.instance.decorate_association(@association.owner, super)
+            end
+
+            if Rails.version.to_f >= 5.1
+              def last(limit = nil)
+                ActiveDecorator::Decorator.instance.decorate_association(@association.owner, super)
+              end
+
+              private
+
+              def find_nth_with_limit(index, limit)
+                ActiveDecorator::Decorator.instance.decorate_association(@association.owner, super)
+              end
+
+              def find_nth_from_last(index)
+                ActiveDecorator::Decorator.instance.decorate_association(@association.owner, super)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/active_decorator/railtie.rb

@@ -28,6 +28,17 @@ module ActiveDecorator
           ActionMailer::Base.send :include, ActiveDecorator::ViewContext::Filter
         end
       end
+
+      ActiveSupport.on_load :active_record do
+        require 'active_decorator/monkey/active_record/associations'
+        ActiveRecord::Associations::Association.send :prepend, ActiveDecorator::Monkey::ActiveRecord::Associations::Association
+        if Rails.version.to_f < 5.1
+          ActiveRecord::Associations::CollectionAssociation.send :prepend, ActiveDecorator::Monkey::ActiveRecord::Associations::CollectionAssociation
+        end
+        if Rails.version.to_f >= 4.0
+          ActiveRecord::Associations::CollectionProxy.send :prepend, ActiveDecorator::Monkey::ActiveRecord::Associations::CollectionProxy
+        end
+      end
     end
   end
 end

data/lib/active_decorator/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module ActiveDecorator
-  VERSION = '0.8.0'
+  VERSION = '0.9.0'
 end

data/lib/active_decorator/view_context.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# A module that carries the controllers' view_context to decorators.
 module ActiveDecorator
   module ViewContext
     class << self

data/spec/lib/decorator_spec.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+require 'spec_helper'
+
+describe ActiveDecorator::Decorator do
+  subject { ActiveDecorator::Decorator.instance }
+  let(:book) { Book.new(title: 'Boek') }
+
+  it 'returns the object on decoration' do
+    subject.decorate(book).should == book
+  end
+
+  it "returns the object when it already is decorated on decorate" do
+    subject.decorate(subject.decorate(book)).should == book
+  end
+end

data/test/controllers/fake_detection_test.rb

@@ -4,6 +4,10 @@ require 'test_helper'
 class MoviesControllerTest < ActionController::TestCase
   test 'reveals fakes' do
     movie = Movie.create
-    assert_nothing_raised { get :show, id: movie.id }
+    if Rails::VERSION::MAJOR >= 5
+      assert_nothing_raised { get :show, params: {id: movie.id} }
+    else
+      assert_nothing_raised { get :show, id: movie.id }
+    end
   end
 end

data/test/fake_app/app/views/authors/show.html.erb

@@ -1,2 +1,10 @@
 <%= @author.name %>
 <%= @author.capitalized_name %>
+<%= @author.books.first.upcased_title %>
+<%= @author.books.last.upcased_title %>
+<% if Rails.version.to_f >= 4.0 && p = @author.publishers.take %><%= p.upcased_name %><% end %>
+<% if Rails.version.to_f >= 5.1 && p = @author.publishers.second_to_last %><%= p.reversed_name %><% end %>
+<% if p = @author.profile %><%= p.address %><% end %>
+<% if h = @author.profile_history %><%= h.update_date %><% end %>
+<% if m = @author.magazines.first %><%= m.upcased_title %><% end %>
+<% if c = @author.company %><%= c.reverse_name %><% end %>

data/test/fake_app/app/views/movies/show.html.erb

@@ -1 +1,2 @@
 <%= @movie.name %>
+<% if a = @movie.author %><%= a.reverse_name %><% end %>

data/test/fake_app/fake_app.rb

@@ -46,13 +46,39 @@ end
 # models
 class Author < ActiveRecord::Base
   has_many :books
+  has_many :publishers, through: :books
+  has_many :movies
+  has_one :profile
+  has_one :profile_history, through: :profile
+  has_and_belongs_to_many :magazines
+  belongs_to :company
 end
 class Book < ActiveRecord::Base
   belongs_to :author
+  belongs_to :publisher
+  accepts_nested_attributes_for :publisher
 end
 class Novel < Book
 end
 class Movie < ActiveRecord::Base
+  belongs_to :author
+end
+class Publisher < ActiveRecord::Base
+  has_many :books
+end
+class Profile < ActiveRecord::Base
+  belongs_to :author
+  has_one :profile_history
+  accepts_nested_attributes_for :profile_history
+end
+class ProfileHistory < ActiveRecord::Base
+  belongs_to :profile
+end
+class Magazine < ActiveRecord::Base
+  has_and_belongs_to_many :authors
+end
+class Company < ActiveRecord::Base
+  has_many :authors
 end
 
 # helpers
@@ -93,6 +119,35 @@ module BookDecorator
     "ERROR"
   end
 end
+module PublisherDecorator
+  def upcased_name
+    name.upcase
+  end
+
+  def reversed_name
+    name.reverse
+  end
+end
+module ProfileDecorator
+  def address
+    "secret"
+  end
+end
+module ProfileHistoryDecorator
+  def update_date
+    updated_on.strftime('%Y/%m/%d')
+  end
+end
+module MagazineDecorator
+  def upcased_title
+    title.upcase
+  end
+end
+module CompanyDecorator
+  def reverse_name
+    name.reverse
+  end
+end
 
 # decorator fake
 class MovieDecorator; end
@@ -176,11 +231,17 @@ class BookMailer < ActionMailer::Base
 end
 
 # migrations
-class CreateAllTables < ActiveRecord::Migration
+class CreateAllTables < ActiveRecord::VERSION::MAJOR >= 5 ? ActiveRecord::Migration[5.0] : ActiveRecord::Migration
   def self.up
-    create_table(:authors) {|t| t.string :name}
-    create_table(:books) {|t| t.string :title; t.references :author; t.string :type }
-    create_table(:movies) {|t| t.string :name}
+    create_table(:authors) {|t| t.string :name; t.references :company}
+    create_table(:books) {|t| t.string :title; t.string :type; t.references :author; t.references :publisher }
+    create_table(:profiles) {|t| t.string :address; t.references :author}
+    create_table(:profile_histories) {|t| t.date :updated_on; t.references :profile}
+    create_table(:publishers) {|t| t.string :name}
+    create_table(:movies) {|t| t.string :name; t.references :author}
+    create_table(:magazines) {|t| t.string :title}
+    create_table(:authors_magazines) {|t| t.references :author; t.references :magazine}
+    create_table(:companies) {|t| t.string :name}
   end
 end
 

data/test/features/association_test.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+require 'test_helper'
+
+class AssociationTest < ActionDispatch::IntegrationTest
+  setup do
+    company = Company.create! name: 'NaCl'
+    @matz = company.authors.create! name: 'matz'
+    @matz.books.create!(
+      title: 'the world of code',
+      publisher_attributes: { name: 'nikkei linux' }
+    )
+    @matz.books.create!(
+      title: 'the ruby programming language',
+      publisher_attributes: { name: "o'reilly" }
+    )
+    @matz.create_profile! address: 'Matsue city, Shimane'
+    @matz.profile.create_profile_history! updated_on: Date.new(2017, 2, 7)
+    @matz.magazines.create! title: 'rubima'
+  end
+
+  test 'decorating associated objects' do
+    visit "/authors/#{@matz.id}"
+    assert page.has_content? 'the world of code'.upcase
+    assert page.has_content? 'the ruby programming language'.upcase
+    if Rails.version.to_f >= 4.0
+      assert page.has_content? 'nikkei linux'.upcase
+    end
+    if Rails.version.to_f >= 5.1
+      assert page.has_content? 'nikkei linux'.reverse
+    end
+    assert page.has_content? 'secret'
+    assert page.has_content? '2017/02/07'
+    assert page.has_content? 'rubima'.upcase
+    assert page.has_content? 'NaCl'.reverse
+  end
+
+  test "decorating associated objects that owner doesn't have decorator" do
+    movie = Movie.create! author: @matz
+    visit "/movies/#{movie.id}"
+    assert page.has_content? 'matz'.reverse
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_decorator
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Akira Matsuda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-13 00:00:00.000000000 Z
+date: 2017-04-05 00:00:00.000000000 Z
 dependencies: []
 description: A simple and Rubyish view helper for Rails
 email:
@@ -29,13 +29,16 @@ files:
 - gemfiles/Gemfile-rails.4.1.x
 - gemfiles/Gemfile-rails.4.2.x
 - gemfiles/Gemfile-rails.5.0.x
+- gemfiles/Gemfile-rails.5.1.x
 - lib/active_decorator.rb
 - lib/active_decorator/config.rb
+- lib/active_decorator/decorated.rb
 - lib/active_decorator/decorator.rb
 - lib/active_decorator/helpers.rb
 - lib/active_decorator/monkey/abstract_controller/rendering.rb
 - lib/active_decorator/monkey/action_controller/base/rescue_from.rb
 - lib/active_decorator/monkey/action_view/partial_renderer.rb
+- lib/active_decorator/monkey/active_record/associations.rb
 - lib/active_decorator/railtie.rb
 - lib/active_decorator/version.rb
 - lib/active_decorator/view_context.rb
@@ -45,6 +48,7 @@ files:
 - lib/generators/rspec/templates/decorator_spec.rb
 - lib/generators/test_unit/decorator_generator.rb
 - lib/generators/test_unit/templates/decorator_test.rb
+- spec/lib/decorator_spec.rb
 - test/configuration_test.rb
 - test/controllers/fake_detection_test.rb
 - test/fake_app/app/views/authors/index.html.erb
@@ -62,6 +66,7 @@ files:
 - test/fake_app/app/views/movies/show.html.erb
 - test/fake_app/fake_app.rb
 - test/features/action_view_helpers_test.rb
+- test/features/association_test.rb
 - test/features/controller_ivar_test.rb
 - test/features/jbuilder_test.rb
 - test/features/name_error_handling_test.rb
@@ -86,11 +91,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: A simple and Rubyish view helper for Rails
 test_files:
+- spec/lib/decorator_spec.rb
 - test/configuration_test.rb
 - test/controllers/fake_detection_test.rb
 - test/fake_app/app/views/authors/index.html.erb
@@ -108,6 +114,7 @@ test_files:
 - test/fake_app/app/views/movies/show.html.erb
 - test/fake_app/fake_app.rb
 - test/features/action_view_helpers_test.rb
+- test/features/association_test.rb
 - test/features/controller_ivar_test.rb
 - test/features/jbuilder_test.rb
 - test/features/name_error_handling_test.rb