Easiest and fast way to decorate Ruby on Rails models.
Decorator pattern - What is it?
Add this line to your application's Gemfile:
gem 'light-decorator', '~> 0.5.2'
Create the ApplicationDecorator
# app/decorators/application_decorator.rb
class ApplicationDecorator < Light::Decorator::Decorate
end
Create decorator for your model. For example we will use the User
model.
# app/decorators/user_decorator.rb
class UserDecorator < Application
def full_name
"#{object.first_name} #{object.last_name}"
end
end
Decorate your model in controller or anywhere.
# Single record
User.find(params[:id]).decorate
User.find_and_decorate(params[:id])
User.decorate.find(params[:id])
# Collection
User.all.decorate
User.decorate
User.limit(10).decorate
User.decorate.limit(10)
# Options
User.find_and_decorate(params[:id], with: AnotherUserDecorator)
# Associations will be decorated automatically
user = User.find_and_decorate(params[:id])
user.decorated? # true
user.comments.decorated? # true
user.comments.first.decorated? # true
Example of Decorator
class UserDecorator < ApplicationDecorator
def full_name
"#{object.first_name} #{object.last_name}"
# or
"#{o.first_name} #{o.last_name}"
end
def full_name_link
helpers.link_to full_name, user_path(object)
# or
h.link_to full_name, user_path(object)
end
end
- Create rake task
light-decorator:install
- Create generators
- Create configuration file
Bug reports and pull requests are welcome on GitHub at https://github.com/light-ruby/light-decorator. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
The gem is available as open source under the terms of the MIT License.