dekorator 1.0.0.pre.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92168b3d181e861e0c2649e7f6a56165da132af21e251ddaa92d08e6f98381b8
-  data.tar.gz: ac455c756a54061271316b83e37025353a9371480b19f212aabdc37a72056f66
+  metadata.gz: e632f3f499971f15713b16354a960d3c0c2e42436694a040d5a77c8627baec7a
+  data.tar.gz: 1318630635b3406f2336d0d144d1651c0b66bb013e4f5e342c726314ba145b30
 SHA512:
-  metadata.gz: 75e15ec204e2ce9645209582b70009c21690857df2eca9098b3d45ffc725bd92cc673d65d7ae0f2f69515a26befcaedf85dd7a80fae520b6d4b22d17982f15f7
-  data.tar.gz: 6432e281aa9ff6dee4fb31b247f4ffa216b35fe3cc522f794e0d75040518c9cb3e318fcc3e053a9e9daa3ec346a6778b75dc906e580b66b21ae659d95e50dbe3
+  metadata.gz: c51f4aa3459a64007d77e6f33361e2fdacceb56893f05cfef773c2bd0401ea92cb021bd6fc8153ff8b679fcff52de642fe7338d8cefe448b59595edc36e1ed19
+  data.tar.gz: 453e6c9a109f4b0c791a211365284adac236496dd7e7f7280103066f074e867c103f9d1c298b5096f3228e9bc4627f73713da659c38e62e5e20af5b0eaa74909

data/.github/workflows/test.yml

@@ -0,0 +1,51 @@
+name: Tests
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    name: Ruby ${{ matrix.versions.ruby }}, Rails ${{ matrix.versions.rails }}
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        versions:
+          - { ruby: "2.4.x", rails: "5.0.x" }
+          - { ruby: "2.5.x", rails: "5.0.x" }
+          - { ruby: "2.6.x", rails: "5.0.x" }
+          - { ruby: "2.4.x", rails: "5.1.x" }
+          - { ruby: "2.5.x", rails: "5.1.x" }
+          - { ruby: "2.6.x", rails: "5.1.x" }
+          - { ruby: "2.4.x", rails: "5.2.x" }
+          - { ruby: "2.5.x", rails: "5.2.x" }
+          - { ruby: "2.6.x", rails: "5.2.x" }
+          - { ruby: "2.5.x", rails: "6.0.x" }
+          - { ruby: "2.6.x", rails: "6.0.x" }
+
+    steps:
+    - uses: actions/checkout@v1
+
+    - uses: actions/cache@v1
+      id: cache
+      with:
+        path: gemfiles/vendor/bundle
+        key: ruby-${{ matrix.versions.ruby }}-rails-${{ matrix.versions.rails }}
+
+    - name: Set up Ruby
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.versions.ruby }}
+
+    - name: Set up bundler
+      run: |
+        echo 'gem: --no-document' >> ~/.gemrc
+        gem install bundler
+        bundle config --global gemfile gemfiles/rails_${{ matrix.versions.rails }}.gemfile
+        bundle config --global path vendor/bundle
+
+    - name: Install gems
+      run: |
+        bundle install --jobs $(nproc) --retry 3
+
+    - name: Test with Rake
+      run: |
+        bundle exec rake test:all_with_coverage

data/CHANGELOG.md

@@ -1,4 +1,5 @@
 # Changelog
+
 All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
@@ -7,10 +8,25 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]
 Nothing yet
 
+## [1.0.0] - 2019-12-02
+### Added
+- Avoid deep decoration ([#25](https://github.com/komposable/dekorator/pull/25))
+- Make `decorate` accessible in ApplicationController ([#29](https://github.com/komposable/dekorator/pull/29))
+
+### Changed
+- Moved to Komposable organization ([#13](https://github.com/komposable/dekorator/pull/13))
+- Replace Travis CI by Github Actions and remove ruby 2.3 support ([#23](https://github.com/komposable/dekorator/pull/23))
+- Update railtie to prevent triggering initialization autoloaded constant deprecation warning ([#30](https://github.com/komposable/dekorator/pull/30))
+- Improve generators ([#31](https://github.com/komposable/dekorator/pull/31))
+
+### Fixes
+- Fix DecoratedEnumerableProxy for Rails 6 ([5a656333](https://github.com/komposable/dekorator/commit/5a656333e9ca6321d0474f0e54de4332219b88d0))
+
 ## 1.0.0.pre.1 - 2019-01-30
 ### Added
-- Create Dekorator::Base the base of decorators (a2a36d66)
-- Create `dekorator:install` generator (a2a36d66)
-- Create `decorator` generator (a2a36d66)
+- Create Dekorator::Base the base of decorators ([a2a36d66](https://github.com/komposable/dekorator/commit/a2a36d66c6de6cb0a00f783794cd29f899bc04b6))
+- Create `dekorator:install` generator ([a2a36d66](https://github.com/komposable/dekorator/commit/a2a36d66c6de6cb0a00f783794cd29f899bc04b6))
+- Create `decorator` generator ([a2a36d66](https://github.com/komposable/dekorator/commit/a2a36d66c6de6cb0a00f783794cd29f899bc04b6))
 
-[Unreleased]: https://github.com/pantographe/dekorator/compare/v1.0.0.pre.1...HEAD
+[Unreleased]: https://github.com/komposable/dekorator/compare/v1.0.0...master
+[1.0.0]: https://github.com/komposable/dekorator/compare/v1.0.0...1.0.0.pre.1

data/CODE_OF_CONDUCT.md

@@ -55,7 +55,7 @@ further defined and clarified by project maintainers.
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at nicolas@pantographe.studio. All
+reported by contacting the project team at oss@pantographe.studio. All
 complaints will be reviewed and investigated and will result in a response that
 is deemed necessary and appropriate to the circumstances. The project team is
 obligated to maintain confidentiality with regard to the reporter of an incident.

data/README.md

@@ -1,24 +1,24 @@
 # Dekorator
 
-[![Build Status](https://travis-ci.org/pantographe/dekorator.svg?branch=master)](https://travis-ci.org/pantographe/dekorator)
+[![Tests](https://github.com/komposable/dekorator/workflows/Tests/badge.svg)](https://github.com/komposable/dekorator/actions)
 [![Gem Version](https://badge.fury.io/rb/dekorator.svg)](https://rubygems.org/gems/dekorator)
-[![Coverage Status](https://coveralls.io/repos/github/pantographe/dekorator/badge.svg)](https://coveralls.io/github/pantographe/dekorator)
-[![Inch CI](https://inch-ci.org/github/pantographe/dekorator.svg?branch=master)](https://inch-ci.org/github/pantographe/dekorator)
-[![Yardoc](https://img.shields.io/badge/doc-yardoc-blue.svg)](https://www.rubydoc.info/github/pantographe/dekorator/master)
+[![Maintainability](https://api.codeclimate.com/v1/badges/f7ab08512ead00da34c0/maintainability)](https://codeclimate.com/github/komposable/dekorator/maintainability)
+[![Coverage Status](https://coveralls.io/repos/github/komposable/dekorator/badge.svg)](https://coveralls.io/github/komposable/dekorator)
+[![Inch CI](https://inch-ci.org/github/komposable/dekorator.svg?branch=master)](https://inch-ci.org/github/komposable/dekorator)
+[![Yardoc](https://img.shields.io/badge/doc-yardoc-blue.svg)](https://www.rubydoc.info/github/komposable/dekorator/master)
 
-**Dekorator** is an opinionated way of organizing model-view code in Ruby on Rails, based on _decorators_.
+**Dekorator** is a lightweight library to implement _presenters_ and/or _decorators_ in your Rails app. It has less features than [`draper`](https://github.com/drapergem/draper) and aims at having a lower memory footprint.
 
-**Not production ready**
+This gem has been inspired by our Rails development practices at [Pantographe](https://pantographe.studio), and the [Ruby memory, ActiveRecord and Draper](https://medium.com/appaloosa-store-engineering/ruby-memory-activerecord-and-draper-64f06abeeb34) talk by [Benoit Tigeot](https://github.com/benoittgt).
 
 ## Compatibility
 
-* Ruby 2.3+
+* Ruby 2.4+
 * Rails 5.0+
 
-
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this line to your application `Gemfile`:
 
 ```ruby
 gem "dekorator"
@@ -28,7 +28,6 @@ And then execute:
 
     $ bundle
 
-
 ## Getting started
 
 Run the following command to set up your project:
@@ -37,7 +36,6 @@ Run the following command to set up your project:
 
 This command will create an `ApplicationDecorator` file.
 
-
 ## Usage
 
 Generate a new decorator with the `decorator` generator:
@@ -48,23 +46,55 @@ This command will generate the following file:
 
 ```ruby
 class UserDecorator < ApplicationDecorator
-  # include ActionView::Helpers::TextHelper
-  #
-  # decorates_association :posts
-  #
-  # def full_name
-  #   [first_name, last_name].join(" ")
-  # end
-  #
-  # def biography_summary
-  #   truncate(biography, length: 170)
-  # end
+  include ActionView::Helpers::TextHelper
+  
+  decorates_association :posts
+  
+  def full_name
+    [first_name, last_name].join(" ")
+  end
+  
+  def biography_summary
+    truncate(biography, length: 170)
+  end
 end
 ```
 
+### Decorate from a controller
+
+```ruby
+class UsersController < ApplicationController
+  def index
+    @users = decorate User.all
+  end
+
+  def show
+    @user = decorate User.find(params[:id])
+  end
+end
+```
+
+### Decorate from a view
+
+```erb
+# app/views/users/index.html.erb
+
+<ul>
+  <% decorate(@users).each do |user| %>
+    <li><%= user.full_name %></li>
+  <% end %>
+</ul>
+```
+
+### Decorate outside a controller/view
+
+```ruby
+UserDecorate.decorate(User.first) # => UserDecorator
+```
+
 ### Associations
 
-If you want to automatically decorates association for a decorated object,
+If you want to automatically decorate an association for a decorated object,
 you have to use `#decorates_association` as following:
 
 ```ruby
@@ -82,29 +112,34 @@ end
 In this example, `UserDecorator#posts` will be decorated.
 
 ```ruby
-decorated_user = decorator(User.first)
+decorated_user = decorate(User.first)
 decorated_user # => UserDecorator
 decorated_user.posts.first # => PostDecorator
 ```
 
-### Specify decorator
+### Custom decorator
+
+By default, Dekorator searches for the decorator class by adding `Decorator` at the end.  
+For `User`, Dekorator looks for the `UserDecorator` class, and for `User::Profile`
+it looks for `User::ProfileDecorator`.
 
-If you want to create specific decorator or sub-decorator, you could simply 
-specify the decorator class that should be use.
+If you want to create a specific decorator or sub-decorator, you can simply
+specify the decorator class that should be used.
 
 ```ruby
 class AdminDecorator < ApplicationDecorator
+  ...
 end
 
-decorated_user = decorator(User.first, with: AdminDecorator)
+decorated_user = decorate(User.first, with: AdminDecorator)
 decorated_user # => AdminDecorator
 ```
 
-You also could specify the decorator for associations:
+You can also specify the decorator for associations:
 
 ```ruby
 class UserDecorator < ApplicationDecorator
-  decorates_association :posts, ArticleDecorator
+  decorates_association :posts, with: ArticleDecorator
 
   ...
 end
@@ -112,7 +147,7 @@ end
 class ArticleDecorator < ApplicationDecorator
 end
 
-decorated_user = decorator(User.first)
+decorated_user = decorate(User.first)
 decorated_user # => UserDecorator
 decorated_user.posts.first # => ArticleDecorator
 ```
@@ -140,10 +175,10 @@ end
 
 ### Devise
 
-If you use [`device`][devise] gem you may have an issue if you decorate your
+If you use the [`Devise`][devise] gem you may have an issue if you decorate your
 `User` model.
 
-You must define `#devise_scope` as following. Devise need to manage with
+You must define `#devise_scope` as following. Devise needs to manage with the
 `User` model (https://github.com/plataformatec/devise/blob/369ba267efaa10d01c8dba59b09c3b94dd9e5551/lib/devise/mapping.rb#L35).
 
 ```ruby
@@ -156,24 +191,55 @@ class UserDecorator < ApplicationDecorator
 end
 ```
 
+## Testing
+
+`rails generate decorator user` also generates a testing file based on your
+configuration.
+
+You can test a decorator the same way you do for helpers.
+
+### RSpec
+
+```ruby
+describe UserDecorator, type: :decorator do
+  let(:object) { User.new(first_name: "John", last_name: "Doe") }
+  let(:decorated_user) { described_class.new(object) }
+
+  describe "#full_name" do
+    it { expect(decorated_user.full_name).to eq("John Doe") }
+  end
+end
+```
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake spec` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.
+To release a new version, update the version number in `version.rb`, then
+run `bundle exec rake release`, which will create a git tag for the version,
+push git commits and tags, and push the `.gem` file to [rubygems.org].
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/pantographe/dekorator. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/komposable/dekorator. This project is intended to be a safe,
+welcoming space for collaboration, and contributors are expected to adhere to
+the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT License].
 
 ## Code of Conduct
 
-Everyone interacting in the Dekorator project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/pantographe/dekorator/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Dekorator project codebases, issue trackers,
+chat rooms and mailing lists is expected to follow the [code of conduct].
 
 [activeadmin]: https://activeadmin.info/11-decorators.html
 [devise]: https://github.com/plataformatec/devise/
+[rubygems.org]: https://rubygems.org
+[MIT License]: https://opensource.org/licenses/MIT
+[code of conduct]: https://github.com/komposable/dekorator/blob/master/CODE_OF_CONDUCT.md

data/benchmarks/README.md

@@ -0,0 +1,7 @@
+# Benchmarks
+
+## Run benchmarks
+
+```sh
+$ ruby benchmark.rb
+```

data/benchmarks/benchmark.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+require "bundler/inline"
+
+gemfile(true) do
+  source "https://rubygems.org"
+
+  git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+  gem "rails", "6.0.1"
+  gem "sqlite3"
+  gem "benchmark-ips"
+  gem "benchmark-memory"
+
+  gem "dekorator", path: "../", require: false
+  gem "draper", require: false
+end
+
+require "active_record"
+require "logger"
+
+ActiveRecord::Base.establish_connection(adapter: "sqlite3", database: ":memory:")
+ActiveRecord::Base.logger = nil # Logger.new(STDOUT)
+
+ActiveRecord::Schema.define do
+  create_table :posts, force: true do |t|
+    t.string :title
+    t.text :body
+  end
+
+  create_table :comments, force: true do |t|
+    t.integer :post_id
+    t.string :author
+    t.text :body
+  end
+end
+
+# Models
+class Post < ActiveRecord::Base
+  has_many :comments
+
+  def summary
+    @summary ||= body&.truncate(170)
+  end
+end
+
+class Comment < ActiveRecord::Base
+  belongs_to :post
+end
+
+# Data
+comments = 100.times.map { Comment.new(author: "John D.", body: "Great article") }
+10.times.each { Post.create!(title: "Our first article!", body: "", comments: comments) }
+
+# Decorators
+require "dekorator"
+
+class PostDecorator < Dekorator::Base
+  decorates_association :comments
+
+  def summary
+    @summary ||= body&.truncate(170)
+  end
+end
+
+class CommentDecorator < Dekorator::Base
+end
+
+require "draper"
+
+class CommentDraperDecorator < Draper::Decorator
+end
+
+class PostDraperDecorator < Draper::Decorator
+  decorates_association :comments, with: CommentDraperDecorator
+
+  def summary
+    @summary ||= object.body&.truncate(170)
+  end
+end
+
+require "delegate"
+
+class PostDelegator < SimpleDelegator
+  def summary
+    @summary ||= body&.truncate(170)
+  end
+
+  def comments
+    @comments = __getobj__.comments.map { |comment| CommentDelegator.new(CommentDelegator) }
+  end
+end
+
+class CommentDelegator < SimpleDelegator
+end
+
+# Benchmark
+SCENARIOS = {
+  "#summary"        => :summary,
+  "#comments"       => :comments,
+}
+
+SCENARIOS.each_pair do |name, method|
+  puts
+  puts " #{name} ".center(80, "=")
+  puts
+
+  model = Post.all
+
+  puts " ips ".center(80, "-")
+  puts
+
+  Benchmark.ips do |x|
+    x.report("In model")  { model.first.public_send(method) }
+    x.report("Dekorator") { PostDecorator.decorate(model).first.public_send(method) }
+    x.report("Dekorator.new") { PostDecorator.decorate(model).first.public_send(method) }
+    x.report("Draper") { PostDraperDecorator.decorate_collection(model).first.public_send(method) }
+    x.report("SimpleDelegator") { PostDelegator.new(model.first).public_send(method) }
+
+    x.compare!
+  end
+
+  puts " memory ".center(80, "-")
+  puts
+
+  Benchmark.memory do |x|
+    x.report("In model")  { model.first.public_send(method) }
+    x.report("Dekorator") { PostDecorator.decorate(model).first.public_send(method) }
+    x.report("Dekorator.new") { PostDecorator.decorate(model).first.public_send(method) }
+    x.report("Draper") { PostDraperDecorator.decorate_collection(model).first.public_send(method) }
+    x.report("SimpleDelegator") { PostDelegator.new(model.first).public_send(method) }
+
+    x.compare!
+  end
+end