rails_decorators 0.1.0

data/README.markdown

@@ -0,0 +1,56 @@
+Rails Decorators
+================
+
+This gem makes it easy to apply the decorator pattern to the models in a Rails application.
+
+## Why?
+
+Helpers, as they're commonly used, are a bit odd. In both Ruby and Rails we approach everything from an Object-Oriented perspective, then with helpers we get procedural.
+
+The job of a helper is to take in data or a data object and output presentation-ready results. We can do that job in an OO fashion with a decorator.
+
+In general, a decorator wraps an object with presentation-related accessor methods. For instance, if you had an `Article` object, then a decorator might add instance methods like `.formatted_published_at` or `.formatted_title` that output actual HTML.
+
+## How?
+
+Here are the steps to utilizing this pattern:
+
+Add the dependency to your `Gemfile`:
+
+```
+gem "rails_decorators"
+```
+
+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`)
+
+Add your new formatting methods inside the `instance_methods` module
+
+If you need access to the Rails helpers like `link_to` and `content_tag`, include the appropriate modules (commented out in the generated decorator)
+
+Use the new methods in your views like any other model method (ex: `@article.formatted_published_at`)
+
+## Uses
+
+Here are some ideas of what you might do in decorator methods:
+
+* Implement output formatting for `to_csv`, `to_json`, or `to_xml`
+* Format dates and times using `strftime`
+* Implement a commonly used representation of the data object like a `.name` method that combines `first_name` and `last_name` attributes

data/lib/generators/decorator/model/USAGE

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

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

@@ -0,0 +1,9 @@
+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"
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module <%= singular_name.camelize %>Decorator
+  extend ActiveSupport::Concern
+
+  # Uncomment this line to have access to the Rails view helpers like link_to and content_tag:
+  # include ActionView::Helpers
+  
+  module InstanceMethods
+    # Add your instance methods here
+    
+    # Example:
+    # def formatted_created_at
+    #   content_tag :span, created_at.strftime("%A")
+    # end
+  end  
+end

data/lib/generators/decorator/setup/USAGE

@@ -0,0 +1,12 @@
+Description:
+    The setup generator creates an /app/decorators folder and
+    a /config/initializers/load_decorators.rb initializer.
+
+    Any decorator module in /app/decorators that matches a model name
+    will be included into that model.
+
+Examples:
+    rails generate decorators:setup
+
+        Folder:      app/decorators
+        Initializer: config/initializers/load_decorators.rb

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

@@ -0,0 +1,15 @@
+module Decorator
+  class SetupGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+  
+    def create_directory
+      empty_directory "app/decorators"
+    end  
+  
+    def build_initializer
+      initializer("load_decorators.rb") do
+        "RailsDecorators::Loader.load"
+      end
+    end
+  end
+end

data/lib/rails_decorators.rb

@@ -0,0 +1 @@
+require 'rails_decorators/loader'

data/lib/rails_decorators/loader.rb

@@ -0,0 +1,22 @@
+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

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: rails_decorators
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jeff Casimir
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-28 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec-rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.0.1
+  type: :development
+  version_requirements: *id001
+description: Rails Decorators reimagines the role of helpers in the view layer of a Rails application, allowing an object-oriented approach rather than procedural.
+email: jeff@jumpstartlab.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/generators/decorator/model/model_generator.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.rb
+- README.markdown
+has_rdoc: true
+homepage: http://github.com/jcasimir/rails_decorators
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.3.4
+requirements: []
+
+rubyforge_project: rails_decorators
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Decorator pattern implmentation for Rails.
+test_files: []
+