Project

decorators

0.04
No release in over 3 years
Low commit activity in last 3 years
Manages the process of loading decorators into your Rails application.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

>= 3.5.0, ~> 3.5

Runtime

>= 4.0.0, < 7
 Project Readme

Decorators Plugin Build Status

This is a very simple plugin that adds support for decorators to your Rails application. Effectively all that this does is allow you to register paths in which to search for decorators which are then loaded at the appropriate point in your application's initialisation process.

Decorators must follow this naming convention:

app/decorators/<at least one subdirectory>/something_decorator.rb

This is an example of a decorator that will be loaded:

app/decorators/controllers/pages_controller_decorator.rb

These are examples of decorators that won't be loaded:

app/decorators/pages_controller_decorator.rb
app/decorators/controllers/pages_controller.rb

The important parts are being inside a sub directory of app/decorators and having _decorator.rb at the end of the file's name.

How to install

In your Gemfile, add the gem:

gem 'decorators', '~> 2.0.3'

Now, run bundle install and the gem should install.

How to use

There really is just one method to call; Decorators#register!. Simply pass one path or many paths to the method to register paths to search inside for decorators to be loaded from.

require 'decorators'
Decorators.register! Rails.root

Or for many paths:

require 'decorators'
Decorators.register! Rails.root, Rails.root.join('vendor', 'extensions', 'extension_with_decorators')

Avoiding Rails development mode reloading issues (example)

If you are loading this from within a Rails engine definition make sure you require the decorators library in the standard way, from outside of any method definitions:

+require 'decorators'
+
 module Namespaced
   class Engine < Rails::Engine

   initializer 'load decorators' do
-    require 'decorators'
     Decorators.register! Rails.root, Rails.root.join('vendor', 'extensions', 'namespaced')
   end
 end

If this is happening in the main application you can avoid this in config/application.rb:

 require File.expand_path('../boot', __FILE__)

 require 'rails/all'
+require 'decorators'

 if defined?(Bundler)
   # etc

License

Decorators is released under the MIT license and is copyright (c) 2013 Philip Arndt