draper 0.3.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+gem 'actionpack', "~> 3.0.9", :require => 'action_view'
+gemspec

data/Guardfile

@@ -0,0 +1,5 @@
+guard 'rspec', :version => 2, :notification => false do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/Readme.markdown

@@ -0,0 +1,169 @@
+Draper
+================
+
+This gem makes it easy to apply the decorator pattern to the models in a Rails application.
+
+## Why use decorators?
+
+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 is it implemented?
+
+To implement the pattern in Rails we can:
+
+1. Write a wrapper class with the decoration methods
+2. Wrap the data object
+3. Utilize those methods within our view layer
+
+## How do you utilize this gem in your application?
+
+Here are the steps to utilizing this gem:
+
+Add the dependency to your `Gemfile`:
+
+```
+gem "draper"
+```
+
+Run bundle:
+
+```
+bundle
+```
+
+Create a decorator for your model (ex: `Article`)
+
+```
+rails generate draper:model Article
+```
+
+Open the decorator model (ex: `app/decorators/article_decorator.rb`)
+
+Add your new formatting methods as normal instance or class methods. You have access to the Rails helpers from the following classes:
+
+```
+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`)
+
+## An Interface with Allows/Denies
+
+A proper interface defines a contract between two objects. One purpose of the decorator pattern is to define an interface between your data model and the view template.
+
+You are provided class methods `allows` and `denies` to control exactly which of the subject's methods are available. By default, *all* of the subject's methods can be accessed.
+
+For example, say you want to prevent access to the `:title` method. You'd use `denies` like this:
+
+```ruby
+  class ArticleDecorator < Draper::Base
+    denies :title
+  end
+```
+
+`denies` uses a blacklist approach. Note that, as of the current version, denying `:title` does not affect related methods like `:title=`, `:title?`, etc.
+
+A better idea is a whitelist approach using `allows`:
+
+```ruby
+  class ArticleDecorator < Draper::Base
+    allows :title, :body, :author
+  end
+```
+
+Now only those methods and any defined in the decorator class itself can be accessed directly.
+
+## Possible Decoration Methods
+
+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
+
+## Example Using a Decorator
+
+Say I have a publishing system with `Article` resources. My designer decides that whenever we print the `published_at` timestamp, it should be constructed like this:
+
+```html
+<span class='published_at'>
+  <span class='date'>Monday, May 6</span>
+  <span class='time'>8:52AM</span>
+</span>
+```
+
+Could we build that using a partial? Yes. A helper? Uh-huh. But the point of the decorator is to encapsulate logic just like we would a method in our models. Here's how to implement it.
+
+First, follow the steps above to add the dependency, update your bundle, then run the `rails generate decorator:setup` to prepare your app.
+
+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 draper:model Article
+```
+
+Now open up the created `app/decorators/article_decorator.rb` and you'll find an `ArticleDecorator` class. Add this method:
+
+```ruby
+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
+```
+
+*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.
+
+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
+class ArticleDecorator < Draper::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
+```
+
+## Issues / Pending
+
+* Test coverage for generators
+* Ability to decorate multiple objects at once, ex: `ArticleDecorator.decorate(Article.all)`
+* Revise readme to better explain interface pattern
+* Build sample Rails application
+* Consider: `ArticleDecorator.new(1)` does the equivalent of `ArticleDecorator.new(Article.find(1))`
+
+## License
+
+(The MIT License)
+
+Copyright © 2011 Jeff Casimir
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the ‘Software’), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED ‘AS IS’, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/draper.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "draper/version"
+
+Gem::Specification.new do |s|
+  s.name        = "draper"
+  s.version     = Draper::VERSION
+  s.authors     = ["Jeff Casimir"]
+  s.email       = ["jeff@casimircreative.com"]
+  s.homepage    = "http://github.com/jcasimir/draper"
+  s.summary     = "Decorator pattern implmentation for Rails."
+  s.description = "Draper reimagines the role of helpers in the view layer of a Rails application, allowing an object-oriented approach rather than procedural."
+
+  s.rubyforge_project = "draper"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  s.add_development_dependency "rake", "0.8.7"
+  s.add_development_dependency "rspec", "~> 2.0.1"
+  s.add_development_dependency "activesupport", "~> 3.0.9"
+  s.add_development_dependency "actionpack", "~> 3.0.9"
+  s.add_development_dependency "ruby-debug19"
+  s.add_development_dependency "guard"
+  s.add_development_dependency "guard-rspec"
+  s.add_development_dependency "rb-fsevent"
+end

data/lib/draper.rb

@@ -0,0 +1,2 @@
+require "draper/version"
+require 'draper/base'

data/lib/draper/base.rb

@@ -0,0 +1,46 @@
+module Draper
+  class Base  
+    include ActionView::Helpers::TagHelper
+    include ActionView::Helpers::UrlHelper
+    include ActionView::Helpers::TextHelper
+
+    require 'active_support/core_ext/class/attribute'
+    class_attribute :denied, :allowed
+    attr_accessor   :source
+    
+    DEFAULT_DENIED = Object.new.methods << :method_missing
+    self.denied = DEFAULT_DENIED
+    
+    def self.denies(*input_denied)
+      raise ArgumentError, "Specify at least one method (as a symbol) to exclude when using denies" if input_denied.empty?
+      raise ArgumentError, "Use either 'allows' or 'denies', but not both." if self.allowed?
+      self.denied += input_denied
+    end
+    
+    def self.allows(*input_allows)
+      raise ArgumentError, "Specify at least one method (as a symbol) to allow when using allows" if input_allows.empty?
+      #raise ArgumentError, "Use either 'allows' or 'denies', but not both." unless (self.denies == DEFAULT_EXCLUSIONS)
+      self.allowed = input_allows
+    end
+    
+    def initialize(subject)
+      self.source = subject      
+      build_methods
+    end   
+    
+  private
+    def select_methods
+      self.allowed || (source.public_methods - denied)
+    end
+
+    def build_methods
+      select_methods.each do |method|
+        (class << self; self; end).class_eval do
+          define_method method do |*args|
+            source.send method, *args
+          end
+        end
+      end  
+    end    
+  end
+end

data/lib/draper/version.rb

@@ -0,0 +1,3 @@
+module Draper
+  VERSION = "0.3.1"
+end

data/lib/generators/draper/model/USAGE

@@ -0,0 +1,7 @@
+Description:
+    The draper:model generator creates a decorator model in /app/decorators.
+
+Examples:
+    rails generate draper:model Article
+
+        file: app/decorators/article_decorator.rb

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

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

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

@@ -0,0 +1,25 @@
+class <%= singular_name.camelize %>Decorator < Draper::Base
+
+  # Rails Helpers
+  #   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
+
+  # Wrapper Methods
+  #   Control access to the wrapped subject's methods using one of the following:
+  #
+  #   To allow _only_ the listed methods:
+  #     allows :method1, :method2
+  #
+  #   To allow everything _except_ the listed methods:
+  #     denies :method1, :method2
+
+  # Presentation Methods
+  #   Define presentation-related instance methods. Ex:
+  #     def formatted_created_at
+  #       content_tag :span, created_at.strftime("%A")
+  #     end
+end

data/spec/base_spec.rb

@@ -0,0 +1,132 @@
+require 'spec_helper'
+require 'draper'
+
+describe Draper::Base do
+  subject{ Draper::Base.new(source) }
+  let(:source){ "Sample String" }
+    
+  it "should return the wrapped object when asked for source" do
+    subject.source.should == source
+  end
+  
+  it "echos the methods of the wrapped class" do
+    source.methods.each do |method|
+      subject.should respond_to(method)
+    end
+  end
+  
+  it "should not copy the .class, .inspect, or other existing methods" do
+    source.class.should_not == subject.class
+    source.inspect.should_not == subject.inspect
+    source.to_s.should_not == subject.to_s
+  end
+  
+  describe "a sample usage with denies" do
+    before(:all) do
+      class DecoratorWithDenies < Draper::Base  
+        denies :upcase
+        
+        def sample_content
+          content_tag :span, "Hello, World!"
+        end
+        
+        def sample_link
+          link_to "Hello", "/World"
+        end
+        
+        def sample_truncate
+          ActionView::Helpers::TextHelper.truncate("Once upon a time", :length => 7)
+        end
+      end
+    end
+    
+    let(:subject_with_denies){ DecoratorWithDenies.new(source) }
+    
+    it "should not echo methods specified with denies" do
+      subject_with_denies.should_not respond_to(:upcase)
+    end
+
+    it "should not clobber other decorators' methods" do
+      subject.should respond_to(:upcase)
+    end    
+    
+    it "should be able to use the content_tag helper" do
+      subject_with_denies.sample_content.to_s.should == "<span>Hello, World!</span>"
+    end
+    
+    it "should be able to use the link_to helper" do
+      subject_with_denies.sample_link.should == "<a href=\"/World\">Hello</a>"
+    end
+    
+    it "should be able to use the pluralize helper" do
+      pending("Figure out odd interaction when the wrapped source object already has the text_helper methods (ie: a String)")
+      subject_with_denies.sample_truncate.should == "Once..."
+    end
+    
+    it "should nullify method_missing to prevent AR from being cute" do
+      pending("How to test this without AR? Ugh.")
+    end
+  end
+  
+  describe "a sample usage with allows" do
+    before(:all) do
+      class DecoratorWithAllows < Draper::Base  
+        allows :upcase
+      end
+    end
+    
+    let(:subject_with_allows){ DecoratorWithAllows.new(source) }
+    
+    it "should echo the allowed method" do
+      subject_with_allows.should respond_to(:upcase)
+    end
+    
+    it "should echo _only_ the allowed method" do
+      subject_with_allows.should_not respond_to(:downcase)
+    end
+  end
+  
+  describe "invalid usages of allows and denies" do
+    let(:blank_allows){
+      class DecoratorWithInvalidAllows < Draper::Base  
+        allows
+      end
+    }
+    
+    let(:blank_denies){
+      class DecoratorWithInvalidDenies < Draper::Base  
+        denies
+      end
+    }
+    
+    let(:using_allows_then_denies){
+      class DecoratorWithInvalidMixing < Draper::Base  
+        allows :upcase
+        denies :downcase
+      end
+    }    
+    
+    let(:using_denies_then_allows){
+      class DecoratorWithInvalidMixing < Draper::Base  
+        denies :downcase
+        allows :upcase        
+      end
+    }
+
+    it "should raise an exception for a blank allows" do
+      expect {blank_allows}.should raise_error(ArgumentError)
+    end
+    
+    it "should raise an exception for a blank denies" do
+      expect {blank_denies}.should raise_error(ArgumentError)
+    end
+    
+    it "should raise an exception for calling allows then denies" do
+      expect {using_allows_then_denies}.should raise_error(ArgumentError)
+    end
+    
+    it "should raise an exception for calling denies then allows" do
+      expect {using_denies_then_allows}.should raise_error(ArgumentError)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'bundler'
+Bundler.require
+require 'active_support'
+require 'action_view'
+require 'bundler/setup'
+require 'draper'
+
+Dir["spec/support/**/*.rb"].each do |file|
+  require "./" + file
+end
+
+RSpec.configure do |config|
+
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: draper
+version: !ruby/object:Gem::Version
+  version: 0.3.1
+  prerelease: 
+platform: ruby
+authors:
+- Jeff Casimir
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-06-30 00:00:00.000000000 -04:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2154360120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :development
+  prerelease: false
+  version_requirements: *2154360120
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2154359620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: *2154359620
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &2154359160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.9
+  type: :development
+  prerelease: false
+  version_requirements: *2154359160
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: &2154358700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.9
+  type: :development
+  prerelease: false
+  version_requirements: *2154358700
+- !ruby/object:Gem::Dependency
+  name: ruby-debug19
+  requirement: &2154358320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2154358320
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: &2154357860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2154357860
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &2154381220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2154381220
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: &2154380800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2154380800
+description: Draper reimagines the role of helpers in the view layer of a Rails application,
+  allowing an object-oriented approach rather than procedural.
+email:
+- jeff@casimircreative.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- Rakefile
+- Readme.markdown
+- draper.gemspec
+- lib/draper.rb
+- lib/draper/base.rb
+- lib/draper/version.rb
+- lib/generators/draper/model/USAGE
+- lib/generators/draper/model/model_generator.rb
+- lib/generators/draper/model/templates/model.rb
+- spec/base_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/jcasimir/draper
+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'
+      segments:
+      - 0
+      hash: 50059517492085377
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 50059517492085377
+requirements: []
+rubyforge_project: draper
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Decorator pattern implmentation for Rails.
+test_files:
+- spec/base_spec.rb
+- spec/spec_helper.rb