rails_decorators 0.1.1 → 0.2.5

data/README.markdown

@@ -15,12 +15,10 @@ In general, a decorator wraps an object with presentation-related accessor metho
 
 To implement the pattern in Rails we can:
 
-1. Write a module with the decoration methods
-2. Inject that module into the model
+1. Write a wrapper class with the decoration methods
+2. Wrap the data object
 3. Utilize those methods within our view layer
 
-We're not polluting the model layer because it's code stays purely persistence and business logic. The decorator is a part of the view layer, and that's the only place we'd utilize the decoration methods.
-
 ## How do you utilize this gem in your application?
 
 Here are the steps to utilizing this gem:
@@ -37,23 +35,21 @@ Run bundle:
 bundle
 ```
 
-Run the setup generator to create a decorators folder and an initializer to connect your decorators with your models:
-
-```
-rails generate decorator:setup
-```
-
 Create a decorator for your model (ex: `Article`)
 
 ```
 rails generate decorator:model Article
 ```
 
-Open the decorator module (ex: `app/decorators/article_decorator.rb`)
+Open the decorator model (ex: `app/decorators/article_decorator.rb`)
 
-Add your new formatting methods inside the `instance_methods` module
+Add your new formatting methods as normal instance or class methods. You have access to the Rails helpers from the following classes:
 
-If you need access to the Rails helpers like `link_to` and `content_tag`, include the appropriate modules (commented out in the generated decorator)
+```
+ActionView::Helpers::TagHelper
+ActionView::Helpers::UrlHelper
+ActionView::Helpers::TextHelper
+```
 
 Use the new methods in your views like any other model method (ex: `@article.formatted_published_at`)
 
@@ -80,21 +76,13 @@ Could we build that using a partial? Yes. A helper? Uh-huh. But the point of the
 
 First, follow the steps above to add the dependency, update your bundle, then run the `rails generate decorator:setup` to prepare your app.
 
-Each decorator is dedicated to a single model. Since we're talking about the `Article` model we'll create an `ArticleDecorator` module. You could do it by hand, but use the provided generator:
+Since we're talking about the `Article` model we'll create an `ArticleDecorator` class. You could do it by hand, but use the provided generator:
 
 ```
 rails generate decorator:model Article
 ```
 
-Now open up the created `app/decorators/article_decorator.rb` and you'll find an `ArticleDecorator` module. 
-
-Why is this a `module`? A traditional decorator implementation uses a second class to completely encapsulate the subject. But because Ruby has such a flexible object model, this isn't necessary. We instead build the decorator as a module and inject that module into the original class. This allows the model's source code to remain purely persistence and business logic while the module contains all the decorations. Neither the model nor the controller layers need to know about the existence of the decorator methods, they can live up at the view layer.
-
-Within the module, notice that we `extend ActiveSupport::Concern`. This library allows us to mask some of the ugliness of Ruby modules and utilize a simplified syntax. (Here's a great tutorial: http://www.fakingfantastic.com/2010/09/20/concerning-yourself-with-active-support-concern/)
-
-Next you'll see commented-out samples for how to utilize Rails' view helper methods. In this example we could make use of the `content_tag` helper, so uncomment the `TagHelper` line. (API Reference: http://api.rubyonrails.org/classes/ActionView/Helpers/TagHelper.html)
-
-Move below those comments and you'll find a nested module named `InstanceMethods`. Any methods you add inside here will be available as instance methods on your object. Within the module, we would add this method:
+Now open up the created `app/decorators/article_decorator.rb` and you'll find an `ArticleDecorator` class. You'll see commented-out samples for how to utilize Rails' view helper methods. Move below those comments and add this method:
 
 ```ruby
 def formatted_published_at
@@ -106,25 +94,30 @@ end
 
 *ASIDE*: Unfortunately, due to the current implementation of `content_tag`, you can't use the style of sending the content is as a block or you'll get an error about `undefined method 'output_buffer='`. Passing in the content as the second argument, as above, works fine.
 
-Save the decorator file and it'll be auto-loaded on the next request just like the rest of your application. From the view, you can access it like any model method presuming you have an instance of `Article` in the variable `@article`:
+Then you need to perform the wrapping in your controller. Here's the simplest method:
 
+```ruby
+class ArticlesController < ApplicationController
+  def show
+    @article = ArticleDecorator.new( Article.find params[:id] )
+  end
+end
 ```
+
+Then within your views you can utilize both the normal data methods and your new presentation methods:
+
+```ruby
 <%= @article.formatted_published_at %>
 ```
 
 Ta-da! Object-oriented data formatting for your view layer. Below is the complete decorator with extra comments removed:
 
 ```ruby
-module ArticleDecorator
-  extend ActiveSupport::Concern
-  include ActionView::Helpers::TagHelper
-  
-  module InstanceMethods
-    def formatted_published_at
-      date = content_tag(:span, published_at.strftime("%A, %B %e").squeeze(" "), :class => 'date')
-      time = content_tag(:span, published_at.strftime("%l:%M%p").delete(" "), :class => 'time')
-      content_tag :span, date + time, :class => 'published_at'
-    end
+class ArticleDecorator < RailsDecorators::Base
+  def formatted_published_at
+    date = content_tag(:span, published_at.strftime("%A, %B %e").squeeze(" "), :class => 'date')
+    time = content_tag(:span, published_at.strftime("%l:%M%p"), :class => 'time').delete(" ")
+    content_tag :span, date + time, :class => 'created_at'
   end
 end
 ```

data/lib/generators/decorator/model/USAGE

@@ -1,6 +1,5 @@
 Description:
-    The decorator:model generator creates a decorator module in /app/decorators
-    setup to interact with the named model.
+    The decorator:model generator creates a decorator model in /app/decorators.
 
 Examples:
     rails generate decorator:model Article

data/lib/generators/decorator/model/model_generator.rb

@@ -2,8 +2,8 @@ module Decorator
   class ModelGenerator < Rails::Generators::NamedBase
     source_root File.expand_path('../templates', __FILE__)
 
-    def build_module
-      template 'module.rb', "app/decorators/#{singular_name}_decorator.rb"
+    def build_model
+      template 'model.rb', "app/decorators/#{singular_name}_decorator.rb"
     end
   end
 end

data/lib/generators/decorator/model/templates/model.rb

@@ -0,0 +1,13 @@
+class <%= singular_name.camelize %>Decorator < RailsDecorators::Base
+  # Rails helpers like content_tag, link_to, and pluralize are already
+  # available to you. If you need access to other helpers, include them
+  # like this:
+  #   include ActionView::Helpers::TextHelper
+  # Or pull in the whole kitchen sink:
+  #   include ActionView::Helpers
+
+  # Then define presentation-related instance methods. Ex:
+  #   def formatted_created_at
+  #     content_tag :span, created_at.strftime("%A")
+  #   end
+end

data/lib/generators/decorator/setup/setup_generator.rb

@@ -6,10 +6,10 @@ module Decorator
       empty_directory "app/decorators"
     end  
   
-    def build_initializer
-      initializer("load_decorators.rb") do
-        "RailsDecorators::Loader.load"
-      end
-    end
+    # def build_initializer
+    #   initializer("load_decorators.rb") do
+    #     "RailsDecorators::Loader.load"
+    #   end
+    # end
   end
 end

data/lib/rails_decorators.rb

@@ -1 +1 @@
-require 'rails_decorators/loader'
+require 'rails_decorators/base'

data/lib/rails_decorators/base.rb

@@ -0,0 +1,17 @@
+module RailsDecorators
+  class Base  
+    include ActionView::Helpers::TagHelper
+    include ActionView::Helpers::UrlHelper
+    include ActionView::Helpers::TextHelper
+    
+    def initialize(subject)
+      subject.public_methods.each do |method|
+        (class << self; self; end).class_eval do
+          define_method method do |*args|
+            subject.send method, *args
+          end
+        end
+      end  
+    end 
+  end
+end

metadata

@@ -2,7 +2,7 @@
 name: rails_decorators
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.1
+  version: 0.2.5
 platform: ruby
 authors: 
 - Jeff Casimir
@@ -10,8 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-28 00:00:00 -07:00
-default_executable: 
+date: 2011-06-01 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec-rails
@@ -34,14 +33,14 @@ extra_rdoc_files: []
 
 files: 
 - lib/generators/decorator/model/model_generator.rb
+- lib/generators/decorator/model/templates/model.rb
 - lib/generators/decorator/model/templates/module.rb
 - lib/generators/decorator/model/USAGE
 - lib/generators/decorator/setup/setup_generator.rb
 - lib/generators/decorator/setup/USAGE
-- lib/rails_decorators/loader.rb
+- lib/rails_decorators/base.rb
 - lib/rails_decorators.rb
 - README.markdown
-has_rdoc: true
 homepage: http://github.com/jcasimir/rails_decorators
 licenses: []
 
@@ -65,7 +64,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: rails_decorators
-rubygems_version: 1.6.2
+rubygems_version: 1.7.2
 signing_key: 
 specification_version: 3
 summary: Decorator pattern implmentation for Rails.

data/lib/rails_decorators/loader.rb

@@ -1,22 +0,0 @@
-module RailsDecorators
-  class Loader
-    def self.load
-      ActionController::Dispatcher.to_prepare do
-        models = Dir.glob(File.join(Rails.root, '/app/models/*.rb')).map do |file|
-          file.match(/(\w*).rb/)[1].split('_').map do |class_part|
-            class_part.capitalize
-          end.join('')
-        end
-
-        models.each do |model|
-          begin
-            decorator = (model + "Decorator").constantize
-            model.constantize.send :include, decorator
-          rescue NameError
-            # No Decorator Exists
-          end
-        end
-      end
-    end
-  end
-end