delegate_presenter 0.0.1

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in delegate_presenter.gemspec
+gemspec

data/README.markdown

@@ -0,0 +1,49 @@
+Introduction
+=================================
+
+This gem includes a base class, `DelegatePresenter::Base` which all your presenter classes should inherit from.
+
+So, creating a new presenter class:
+
+	class TodoPresenter < DelegatePresenter::Base
+	  def todo_name
+	    s("<br>", self.description)
+	  end
+	end
+
+Wait, *what* did you just do?
+=================================
+
+You mean that little s hack? That's a way to keep yourself from going sane having to `.html_escape` everything.
+
+[See my blog article on this subject](http://rwilcox.tumblr.com/post/10546160404/presenter-pattern-rails-3-and-html-safe)
+
+How do I get a presenter for this object I have?
+=================================
+
+Call `Present(object)`
+
+This will look up the name of `object`'s class, then look for a class named (that name) presenter.
+
+So, if object is a Todo instance, DelegatePresenter will look for `TodoPresenter`. It will then instantiate an object of that class (`TodoPresenter`), passing the parameter from the Present call into the constructor.
+
+As `DelegatePresenter::Base` subclasses are just `SimpleDelegator`s at heart, this means methods that `TodoPresenter` does not know about will be passed on to (delegated to) the `Todo` instance.
+
+So, what is DelegatePresenter, really?
+================================
+
+DelegatePresenter does two things:
+
+  1. Inherits from Ruby Standard Library's SimpleDelegator. This simple class solves many of the problems I've seen with decorators in the past. (calling object.method everywhere)
+
+  2. Makes Rails helpers available to you via the helpers method, gives you s (above) and h (your old Rails 2 friend)
+
+  3. Gives you a `record_id` method, which will return the ActiveRecord ID of the database object. Because I think it should have been this way in the first place :)
+
+
+Installation
+================================
+
+  1. Add me to your Gemfile
+  2. In your `config/application.rb`, add an autoload path for `app/presenters/`
+  3. Create presenters for your classes. For example: `app/presenters/todo_presenter.rb`. These classes should subclass `DelegatePresenter::Base`

data/Rakefile

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

data/delegate_presenter.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "delegate_presenter/version"
+
+Gem::Specification.new do |s|
+  s.name        = "delegate_presenter"
+  s.version     = DelegatePresenter::VERSION
+  s.authors     = ["Ryan Wilcox"]
+  s.email       = ["rwilcox@wilcoxd.com"]
+  s.homepage    = "http://github.com/rwilcox/delegate_presenter"
+  s.summary     = %q{A simple Superclass for your Presenters, using SimpleDelegator}
+  s.description = %q{Presenters are easier with delegators, and other friends}
+
+  s.rubyforge_project = "delegate_presenter"
+
+  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"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "rspec"
+  s.add_runtime_dependency "rails"
+  # s.add_runtime_dependency "rest-client"
+end

data/lib/delegate_presenter.rb

@@ -0,0 +1,35 @@
+require "delegate_presenter/version"
+require 'delegate_presenter/application_controller'
+require 'delegate_presenter/present'
+
+module DelegatePresenter
+  class Base < SimpleDelegator
+
+    def initialize( object_to_delegate_to )
+      super(object_to_delegate_to)
+    end
+
+
+    def record_id
+      self.__getobj__.id
+    end
+
+
+    def helpers
+      ApplicationController.all_helpers
+    end
+
+    def s(*args)
+      output = "".html_safe
+      args.each {|current_arg|
+        output << current_arg.html_safe
+      }
+      output
+    end
+
+    def h(str)
+      helpers.send(:h, str)
+    end
+
+  end
+end

data/lib/delegate_presenter/application_controller.rb

@@ -0,0 +1,33 @@
+module DelegatePresenter::ApplicationController
+  # Provide access to helper methods from outside controllers and views,
+  # such as in Presenter objects. Rails provides ActionController::Base.helpers,
+  # but this does not include any of our application helpers.
+  def all_helpers
+    @all_helpers_proxy ||= begin
+      # Start with just the rails helpers. This is the same method used
+      # by ActionController::Base.helpers
+      proxy = ActionView::Base.new.extend(_helpers)
+
+      # url_for depends on _routes method being defined
+      proxy.instance_eval do
+        def _routes
+          Rails.application.routes
+        end
+      end
+
+      # Import all named path methods
+      proxy.extend(Rails.application.routes.named_routes.module)
+
+      # Load all our application helpers to extend
+      modules_for_helpers([:all]).each do |mod|
+        proxy.extend(mod)
+      end
+
+      proxy
+    end
+  end
+end
+
+class ApplicationController
+  extend DelegatePresenter::ApplicationController
+end

data/lib/delegate_presenter/present.rb

@@ -0,0 +1,4 @@
+def Present(object)
+  presenter_class = Object.const_get("#{object.class.name}Presenter")
+  presenter_class.new(object)
+end

data/lib/delegate_presenter/version.rb

@@ -0,0 +1,3 @@
+module DelegatePresenter
+  VERSION = "0.0.1"
+end

data/spec/delegate_presenter_base_spec.rb

@@ -0,0 +1,21 @@
+#-*- tab-width: 2; indent-tabs-mode: nil; x-auto-expand-tabs: true; x-counterpart: ../../app/presenters/application_presenter.rb; x-typographers-quotes: false; -*-
+
+require 'spec_helper'
+
+describe "DelegatePresenter::Base" do
+
+  describe "HTML building helpers" do
+
+    before do
+      @ap = DelegatePresenter::Base.new(1)
+    end
+
+    it "handles HTML elements that should not be escaped" do
+    	@ap.s("<h1>Hi</h1>") == "<h1>Hi</h1>"
+    end
+
+    it "handles an h in the middle to indicate that a particular string actually should be escaped" do
+    	@ap.s("<blink>hello</blink>", " world ", @ap.h("<BAD TAG>")).should == "<blink>hello</blink> world &lt;BAD TAG&gt;"
+    end
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: delegate_presenter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Ryan Wilcox
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-10-20 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &82177300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *82177300
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &82177090 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *82177090
+description: Presenters are easier with delegators, and other friends
+email:
+- rwilcox@wilcoxd.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.markdown
+- Rakefile
+- delegate_presenter.gemspec
+- lib/delegate_presenter.rb
+- lib/delegate_presenter/application_controller.rb
+- lib/delegate_presenter/present.rb
+- lib/delegate_presenter/version.rb
+- spec/delegate_presenter_base_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/rwilcox/delegate_presenter
+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: '0'
+requirements: []
+rubyforge_project: delegate_presenter
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: A simple Superclass for your Presenters, using SimpleDelegator
+test_files: []