active_decorator 0.8.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 14f002118bfbc2127bf674fc7488990d80a5152c
-  data.tar.gz: 6e40b90bb6ffc7ba584147a93041025456216f52
+SHA256:
+  metadata.gz: f803e15d40a85700faf6ceb443bea2fabc225c2d3503e32c99dcb4e54e7f75e3
+  data.tar.gz: 1c15042cec49c02013f05ff50c91335d00d6acff63b6ae51ccee2ea77c27ec88
 SHA512:
-  metadata.gz: 5bd8f1c1bdc0cfe4734755e9a56fd1d20cbea6205319ac20c308360b95b5c74303d3f16cda0002458c2b33795ad6690e2eb8401ed99d35db4c3068f5630e6936
-  data.tar.gz: cf5c094dedd2637ea7f23bdd3b0f131b2a33f0cc98e9ff2148433960e8305c2b1732d7cf6005bd82247d9cc8b8a71897c61e5bcd5f9d044a641d970f53c7fa58
+  metadata.gz: b48a0acdcdce16cd8f3fda7b56c95209af5e833502ea2ea5f9244e9e78bcf4255c376c21f50310631852a928279283d070bed45f618578867eb1edd45f6ddcaa
+  data.tar.gz: 8b959e33b9c70791a47ee759a6e9c3c877672cda9bb3ba5dc1de0ea4587be5d16bbccd0d0e980fc9ecfaae47adad0f616b35dda7f3c902b05cba064fda21fcc5

data/.gitignore

@@ -4,3 +4,5 @@ Gemfile.lock
 gemfiles/*.lock
 pkg/*
 log
+tmp
+.byebug_history

data/.travis.yml

@@ -1,33 +1,100 @@
 language: ruby
 
-script: bundle exec rake test
-
-rvm:
-  - 2.0.0
-  - 2.1.10
-  - 2.2.6
-  - 2.3.3
-  - ruby-head
-gemfile:
-  - gemfiles/Gemfile-rails.3.2.x
-  - gemfiles/Gemfile-rails.4.0.x
-  - gemfiles/Gemfile-rails.4.1.x
-  - gemfiles/Gemfile-rails.4.2.x
-  - gemfiles/Gemfile-rails.5.0.x
-
-sudo: false
+addons:
+  chrome: stable
+
+before_install:
+  - sudo apt update -qq
+  - sudo apt install -y chromium-chromedriver
+  - gem i bundler -v '<2'
+
+cache: bundler
+
+# rvm:
+#   - 2.6.7
+#   - 2.5.9
+#   - 2.4.10
+#   - 2.3.8
+#   - 2.2.10
+#   - 2.1.10
+#   - 2.0.0
+# gemfile:
+#   - gemfiles/Gemfile-rails.5.2.x
+#   - gemfiles/Gemfile-rails.5.1.x
+#   - gemfiles/Gemfile-rails.5.0.x
+#   - gemfiles/Gemfile-rails.4.2.x
 
 matrix:
-  exclude:
-    - rvm: ruby-head
-      gemfile: gemfiles/Gemfile-rails.3.2.x
-    - rvm: ruby-head
-      gemfile: gemfiles/Gemfile-rails.4.0.x
-    - rvm: ruby-head
-      gemfile: gemfiles/Gemfile-rails.4.1.x
-    - rvm: 2.0.0
+  include:
+    - rvm: 3.0.1
+      gemfile: gemfiles/Gemfile-rails.6.1.x
+    - rvm: 3.0.1
+      gemfile: gemfiles/Gemfile-rails.6.1.x
+      env: API=1
+
+    - rvm: 2.7.3
+      gemfile: gemfiles/Gemfile-rails.6.1.x
+    - rvm: 2.7.3
+      gemfile: gemfiles/Gemfile-rails.6.1.x
+      env: API=1
+    - rvm: 2.7.3
+      gemfile: gemfiles/Gemfile-rails.6.0.x
+    - rvm: 2.7.3
+      gemfile: gemfiles/Gemfile-rails.6.0.x
+      env: API=1
+
+    - rvm: 2.6.7
+      gemfile: gemfiles/Gemfile-rails.6.1.x
+    - rvm: 2.6.7
+      gemfile: gemfiles/Gemfile-rails.6.1.x
+      env: API=1
+    - rvm: 2.6.7
+      gemfile: gemfiles/Gemfile-rails.6.0.x
+    - rvm: 2.6.7
+      gemfile: gemfiles/Gemfile-rails.6.0.x
+      env: API=1
+    - rvm: 2.6.7
+      gemfile: gemfiles/Gemfile-rails.5.2.x
+    - rvm: 2.6.7
+      gemfile: gemfiles/Gemfile-rails.5.2.x
+      env: API=1
+    - rvm: 2.6.7
+      gemfile: gemfiles/Gemfile-rails.5.1.x
+    - rvm: 2.6.7
+      gemfile: gemfiles/Gemfile-rails.5.1.x
+      env: API=1
+    - rvm: 2.6.7
       gemfile: gemfiles/Gemfile-rails.5.0.x
-    - rvm: 2.1.10
+    - rvm: 2.6.7
       gemfile: gemfiles/Gemfile-rails.5.0.x
+      env: API=1
+
+    - rvm: 2.5.9
+      gemfile: gemfiles/Gemfile-rails.5.2.x
+
+    - rvm: 2.4.10
+      gemfile: gemfiles/Gemfile-rails.5.2.x
+
+    - rvm: 2.3.8
+      gemfile: gemfiles/Gemfile-rails.5.2.x
+    - rvm: 2.3.8
+      gemfile: gemfiles/Gemfile-rails.4.2.x
+
+    - rvm: 2.2.10
+      gemfile: gemfiles/Gemfile-rails.5.2.x
+
+    - rvm: 2.1.10
+      gemfile: gemfiles/Gemfile-rails.4.2.x
+
+    - rvm: 2.0.0
+      gemfile: gemfiles/Gemfile-rails.4.2.x
+
+    - rvm: ruby-head
+      gemfile: gemfiles/Gemfile-rails.edge
+    - rvm: ruby-head
+      gemfile: gemfiles/Gemfile-rails.edge
+      env: API=1
+
   allow_failures:
     - rvm: ruby-head
+    - gemfile: gemfiles/Gemfile-rails.edge

data/CHANGELOG.md

@@ -0,0 +1,52 @@
+## 1.4.0
+
+* Decorate non-nil objects where `nil?` returns true, namely, ActionText::RichText body [@jamesbrooks]
+
+## 1.3.4
+
+* Support Rails 6.1 [@y-yagi]
+
+## 1.3.3
+
+* Fixed Ruby 2.7 keyword arguments warning [@pocke]
+
+## 1.3.2
+
+* Fixed NameError on ActionController::API controllers without jbuilder enhancement [@kamillle]
+
+## 1.3.1
+
+* Switched back from Ruby's `const_get` to Active Support `constantize` for fetching decorator modules, due to inability to properly detect namespaced decorator [@sinsoku]
+
+## 1.3.0
+
+* Switched from Active Support `constantize` to Ruby's `const_get` when fetching decorator modules
+
+* Switched `config` from ActiveSupport::Configurable to a simple Struct
+
+* Association decoration now propagates from AssociationRelation to spawned Relations (e.g. `@post.comments.order(:id).each`)
+
+* Dropped support for Rails 3.2, 4.0, and 4.1
+
+
+## 1.2.0
+
+* Decorate values in Hash recursively [@FumiyaShibusawa]
+
+
+## 1.1.1
+
+* Improved ActionController::API support for Rails 5.0.x [@frodsan]
+
+* Fixed "NameError: undefined local variable or method `view_context'" with ActionController::API or when rendering in controllers
+
+
+## 1.1.0
+
+* ActionController::API support [@frodsan]
+
+* `ActiveDecorator::Decorator.instance.decorate` now returns the decorated object when the receiver was already a decorated object (it used to return `nil`) [@velonica1997]
+
+* Update decorator_spec.rb syntax to respect RSpec 3 style [@memoht]
+
+* Fixed namespace for TestUnit generator with some refactorings [@yhirano55]

data/Gemfile

@@ -1,10 +1,5 @@
 # frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec
-
-gem 'rails'
-gem 'test-unit-rails'
-gem 'capybara'
-gem 'sqlite3'
-gem 'jbuilder'

data/README.md

@@ -1,22 +1,23 @@
 # ActiveDecorator [![Build Status](https://travis-ci.org/amatsuda/active_decorator.svg?branch=master)](https://travis-ci.org/amatsuda/active_decorator) [![Code Climate](https://codeclimate.com/github/amatsuda/active_decorator/badges/gpa.svg)](https://codeclimate.com/github/amatsuda/active_decorator)
 
-A simple and Rubyish view helper for Rails 3, Rails 4 and Rails 5. Keep your helpers and views Object-Oriented!
+A simple and Rubyish view helper for Rails 4, Rails 5, and Rails 6. Keep your helpers and views Object-Oriented!
 
 
 ## Features ##
 
 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)
+   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, 2.5.x, 2.6.x, 2.7.x, 3.0.x, and 3.1 (trunk)
 
-* Rails 3.2.x, 4.0.x, 4.1.x, 4.2.x, 5.0, and 5.1 (edge)
+* Rails 4.2.x, 5.0, 5.1, 5.2, 6.0, 6.1, and 7.0 (edge)
 
 
 ## Supported ORMs ##
@@ -34,79 +35,97 @@ 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)  # powered by action_args
+    @author = 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)
+    @author = 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>
+<p><%= @author.name %></p>
+<ul>
+<% @author.books.order(:id).each do |book| %>
+  <%# `book` here is auto-decorated because @author is a decorated instance %>
+  <li><%= book.link %></li>
 <% end %>
+</ul>
+```
 
-# app/views/users/_blog_post.html.erb
-<% blog_posts.each do |blog_post| %>
-  <%= blog_post.published_date %>
-<% end %>
+### Using ActiveDecorator outside of Action View ###
+
+Sometimes you may want to use decorators outside of Action View, for example,
+for background tasks for ActiveJob.
+For such use case, ActiveDecorator module provides `run_with` method
+that takes some kind of Action View and a block.
+
+```ruby
+ActiveDecorator::ViewContext.run_with ApplicationController.new.view_context do
+  ## perform some heavy jobs here
+end
 ```
 
+
 ## Testing
 
 You can test a decorator using your favorite test framework by decorating the model instance with
@@ -115,7 +134,7 @@ You can test a decorator using your favorite test framework by decorating the mo
 ActiveDecorator::Decorator.instance.decorate(model_instance)
 ```
 
-Considering an `Organization` model and it's simple decorator:
+Considering an `Organization` model and its simple decorator:
 
 ```ruby
 module OrganizationDecorator

data/Rakefile

@@ -8,7 +8,11 @@ require 'rake/testtask'
 
 Rake::TestTask.new do |t|
   t.libs << "test"
-  t.pattern = 'test/**/*_test.rb'
+  if ENV['API']
+    t.pattern = 'test/**/*_api_test.rb'
+  else
+    t.test_files = Dir['test/**/*_test.rb'] - Dir['test/**/*_api_test.rb']
+  end
   t.warning = true
   t.verbose = true
 end

data/active_decorator.gemspec

@@ -1,5 +1,5 @@
-# -*- encoding: utf-8 -*-
 # frozen_string_literal: true
+
 $:.push File.expand_path("../lib", __FILE__)
 require "active_decorator/version"
 
@@ -9,11 +9,22 @@ Gem::Specification.new do |s|
   s.authors     = ["Akira Matsuda"]
   s.email       = ["ronnie@dio.jp"]
   s.homepage    = 'https://github.com/amatsuda/active_decorator'
+  s.license     = 'MIT'
   s.summary     = %q{A simple and Rubyish view helper for Rails}
   s.description = %q{A simple and Rubyish view helper for Rails}
 
-  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.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
   s.require_paths = ["lib"]
+
+  s.add_dependency 'activesupport'
+
+  s.add_development_dependency 'test-unit-rails'
+  s.add_development_dependency 'selenium-webdriver'
+  s.add_development_dependency 'puma'
+  s.add_development_dependency 'capybara'
+  s.add_development_dependency 'sqlite3'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'byebug'
 end

data/gemfiles/Gemfile-rails.4.2.x

@@ -1,9 +1,8 @@
 source 'https://rubygems.org'
 
-gem 'active_decorator', path: '..'
+gemspec path: '..'
 
 gem 'rails', '~> 4.2.0'
-gem 'test-unit-rails'
-gem 'capybara'
-gem 'sqlite3'
-gem 'jbuilder'
+gem 'sqlite3', '< 1.4'
+gem 'nokogiri', '~> 1.6.0'
+gem 'jbuilder' unless ENV['API']

data/gemfiles/Gemfile-rails.5.0.x

@@ -1,9 +1,7 @@
 source 'https://rubygems.org'
 
-gem 'active_decorator', path: '..'
+gemspec path: '..'
 
 gem 'rails', '~> 5.0.0'
-gem 'test-unit-rails'
-gem 'capybara'
-gem 'sqlite3'
-gem 'jbuilder'
+gem 'sqlite3', '< 1.4'
+gem 'jbuilder' unless ENV['API']

data/gemfiles/Gemfile-rails.5.1.x

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec path: '..'
+
+gem 'rails', '~> 5.1.0'
+gem 'jbuilder' unless ENV['API']

data/gemfiles/Gemfile-rails.5.2.x

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec path: '..'
+
+gem 'rails', git: 'https://github.com/rails/rails', branch: '5-2-stable'
+gem 'webdrivers', '< 4'
+gem 'jbuilder' unless ENV['API']

data/gemfiles/Gemfile-rails.6.0.x

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec path: '..'
+
+gem 'rails', '~> 6.0.0'
+gem 'webdrivers'
+gem 'jbuilder' unless ENV['API']

data/gemfiles/Gemfile-rails.6.1.x

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gemspec path: '..'
+
+gem 'rails', '~> 6.1.0'
+gem 'webdrivers'
+gem 'rexml'
+gem 'jbuilder' unless ENV['API']

data/gemfiles/Gemfile-rails.edge

@@ -0,0 +1,18 @@
+source 'https://rubygems.org'
+
+gemspec path: '..'
+
+git_source(:github) do |repo_name|
+  repo_name = "#{repo_name}/#{repo_name}" unless repo_name.include?("/")
+  "https://github.com/#{repo_name}.git"
+end
+
+github 'rails/rails' do
+  gem 'rails'
+end
+
+unless ENV['API']
+  github 'rails/jbuilder' do
+    gem 'jbuilder'
+  end
+end

data/lib/active_decorator/config.rb

@@ -1,6 +1,13 @@
 # frozen_string_literal: true
+
 module ActiveDecorator
-  include ActiveSupport::Configurable
+  def self.config
+    @_config ||= Struct.new(:decorator_suffix).new
+  end
+
+  def self.configure
+    yield config
+  end
 
   config.decorator_suffix = 'Decorator'
 end

data/lib/active_decorator/decorated.rb

@@ -0,0 +1,5 @@
+# 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,8 @@
 # frozen_string_literal: true
+
 require 'singleton'
 require 'active_decorator/helpers'
+require 'active_decorator/decorated'
 
 module ActiveDecorator
   class Decorator
@@ -10,31 +12,63 @@ module ActiveDecorator
       @@decorators = {}
     end
 
+    # Decorates the given object.
+    # Plus, performs special decoration for the classes below:
+    #   Array: decorates its each element
+    #   Hash: decorates its each value
+    #   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 obj.nil?
+      return obj if defined?(Jbuilder) && (Jbuilder === obj)
 
-      if obj.is_a?(Array)
+      case obj
+      when Array
         obj.each do |r|
           decorate r
         end
-      elsif defined?(ActiveRecord) && obj.is_a?(ActiveRecord::Relation)
-        # don't call each nor to_a immediately
-        if obj.respond_to?(:records)
-          # Rails 5.0
-          obj.extend ActiveDecorator::RelationDecorator unless obj.is_a? ActiveDecorator::RelationDecorator
-        else
-          # Rails 3.x and 4.x
-          obj.extend ActiveDecorator::RelationDecoratorLegacy unless obj.is_a? ActiveDecorator::RelationDecoratorLegacy
+      when Hash
+        obj.each_value do |v|
+          decorate v
         end
+      when nil, true, false
+        obj
       else
-        d = decorator_for obj.class
-        return obj unless d
-        obj.extend d unless obj.is_a? d
+        if defined?(ActiveRecord) && obj.is_a?(ActiveRecord::Relation)
+          # don't call each nor to_a immediately
+          if obj.respond_to?(:records)
+            # Rails 5.0
+            obj.extend ActiveDecorator::RelationDecorator unless obj.is_a? ActiveDecorator::RelationDecorator
+          else
+            # Rails 3.x and 4.x
+            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
+        end
       end
+
+      obj
+    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,19 +91,17 @@ module ActiveDecorator
     end
   end
 
+  # For AR 3 and 4
   module RelationDecoratorLegacy
     def to_a
-      super.tap do |arr|
-        ActiveDecorator::Decorator.instance.decorate arr
-      end
+      ActiveDecorator::Decorator.instance.decorate super
     end
   end
 
+  # For AR 5+
   module RelationDecorator
     def records
-      super.tap do |arr|
-        ActiveDecorator::Decorator.instance.decorate arr
-      end
+      ActiveDecorator::Decorator.instance.decorate super
     end
   end
 end