RubyGems - draper - Versions diffs - 0.7.3 → 0.7.4 - Mend

draper 0.7.3 → 0.7.4

Files changed (35) hide show

data/.gitignore +1 -0
data/.yardopts +1 -0
data/Gemfile +1 -0
data/Readme.markdown +32 -17
data/doc/ApplicationDecorator.html +147 -0
data/doc/Draper.html +123 -0
data/doc/Draper/AllHelpers.html +256 -0
data/doc/Draper/Base.html +1222 -0
data/doc/Draper/DecoratorGenerator.html +216 -0
data/doc/Draper/LazyHelpers.html +174 -0
data/doc/Draper/ModelSupport.html +164 -0
data/doc/Draper/System.html +179 -0
data/doc/_index.html +172 -0
data/doc/class_list.html +47 -0
data/doc/css/common.css +1 -0
data/doc/css/full_list.css +53 -0
data/doc/css/style.css +320 -0
data/doc/file_list.html +46 -0
data/doc/frames.html +13 -0
data/doc/index.html +172 -0
data/doc/js/app.js +205 -0
data/doc/js/full_list.js +150 -0
data/doc/js/jquery.js +16 -0
data/doc/method_list.html +174 -0
data/doc/top-level-namespace.html +103 -0
data/lib/draper/base.rb +100 -15
data/lib/draper/model_support.rb +1 -0
data/lib/draper/version.rb +1 -1
data/lib/generators/rails/decorator_generator.rb +15 -0
data/spec/base_spec.rb +16 -3
data/spec/draper/model_support_spec.rb +5 -0
data/spec/samples/active_record.rb +1 -4
data/spec/samples/decorator_with_allows.rb +1 -1
data/spec/samples/product_decorator.rb +4 -0
metadata +45 -40

@@ -0,0 +1,103 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+  Top Level Namespace
+    &mdash; Documentation by YARD 0.7.2
+</title>
+  <link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  relpath = '';
+  if (relpath != '') relpath += '/';
+</script>
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+  </head>
+  <body>
+    <script type="text/javascript" charset="utf-8">
+      if (window.top.frames.main) document.body.className = 'frames';
+    </script>
+    <div id="header">
+      <div id="menu">
+    <a href="_index.html">Index</a> &raquo;
+    <span class="title">Top Level Namespace</span>
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+      <div id="search">
+    <a id="class_list_link" href="#">Class List</a>
+    <a id="method_list_link" href="#">Method List</a>
+    <a id="file_list_link" href="#">File List</a>
+</div>
+      <div class="clear"></div>
+    </div>
+    <iframe id="search_frame"></iframe>
+    <div id="content"><h1>Top Level Namespace
+</h1>
+<dl class="box">
+</dl>
+<div class="clear"></div>
+<h2>Defined Under Namespace</h2>
+<p class="children">
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="Draper.html" title="Draper (module)">Draper</a></span>
+</p>
+</div>
+    <div id="footer">
+  Generated on Thu Sep  1 01:13:37 2011 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.7.2 (ruby-1.8.7).
+</div>
+  </body>
+</html>

data/lib/draper/base.rb CHANGED

@@ -6,72 +6,157 @@ module Draper
     DEFAULT_DENIED = Object.new.methods << :method_missing
     FORCED_PROXY = [:to_param]
+    FORCED_PROXY.each do |method|
+      define_method method do |*args, &block|
+        model.send method, *args, &block
+      end
+    end
     self.denied = DEFAULT_DENIED
-    def initialize(input, context = nil)
+    # Initialize a new decorator instance by passing in
+    # an instance of the source class. Pass in an optional
+    # context is stored for later use.
+    #
+    # @param [Object] instance to wrap
+    # @param [Object] context (optional)
+    def initialize(input, context = {})
+      input.inspect # forces evaluation of a lazy query from AR
       input.inspect
       self.class.model_class = input.class if model_class.nil?
       @model = input
       self.context = context
-      build_methods
     end
-    def self.find(input)
-      self.new(model_class.find(input))
+    # Proxies to the class specified by `decorates` to automatically
+    # lookup an object in the database and decorate it.
+    #
+    # @param [Symbol or String] id to lookup
+    # @return [Object] instance of this decorator class
+    def self.find(input, context = {})
+      self.new(model_class.find(input), context)
     end
+    # Typically called within a decorator definition, this method
+    # specifies the name of the wrapped object class.
+    #
+    # For instance, a `ProductDecorator` class might call `decorates :product`
+    #
+    # But they don't have to match in name, so a `EmployeeDecorator`
+    # class could call `decorates :person` to wrap instances of `Person`
+    #
+    # This is primarilly set so the `.find` method knows which class
+    # to query.
+    #
+    # @param [Symbol] class_name snakecase name of the decorated class, like `:product`
     def self.decorates(input)
       self.model_class = input.to_s.camelize.constantize
       model_class.send :include, Draper::ModelSupport
     end
+    # Specifies a black list of methods which may *not* be proxied to
+    # to the wrapped object.
+    #
+    # Do not use both `.allows` and `.denies` together, either write
+    # a whitelist with `.allows` or a blacklist with `.denies`
+    #
+    # @param [Symbols*] methods to deny like `:find, :find_by_name`
     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
+    # Specifies a white list of methods which *may* be proxied to
+    # to the wrapped object. When `allows` is used, only the listed
+    # methods and methods defined in the decorator itself will be
+    # available.
+    #
+    # Do not use both `.allows` and `.denies` together, either write
+    # a whitelist with `.allows` or a blacklist with `.denies`
+    #
+    # @param [Symbols*] methods to allow like `:find, :find_by_name`
     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.denied == DEFAULT_DENIED)
       self.allowed = input_allows
     end
-    def self.decorate(input, context = nil)
+    # Initialize a new decorator instance by passing in
+    # an instance of the source class. Pass in an optional
+    # context is stored for later use.
+    #
+    # When passing in a single object, using `.decorate` is
+    # identical to calling `.new`. However, `.decorate` can
+    # also accept a collection and return a collection of
+    # individually decorated objects.
+    #
+    # @param [Object] instance(s) to wrap
+    # @param [Object] context (optional)
+    def self.decorate(input, context = {})
       input.respond_to?(:each) ? input.map{|i| new(i, context)} : new(input, context)
     end
+    # Access the helpers proxy to call built-in and user-defined
+    # Rails helpers. Aliased to `.h` for convinience.
+    #
+    # @return [Object] proxy
     def helpers
       @helpers ||= ApplicationController::all_helpers
     end
     alias :h :helpers
+    # Calling `lazy_helpers` will make the built-in and
+    # user-defined Rails helpers accessible as class methods
+    # in the decorator without using the `h.` or `helpers.` proxy.
+    #
+    # The drawback is that you dump many methods into your decorator's
+    # namespace and collisions could create unexpected results.
     def self.lazy_helpers
       self.send(:include, Draper::LazyHelpers)
     end
+    # Use primarily by `form_for`, this returns an instance of
+    # `ActiveModel::Name` set to the wrapped model's class name
+    #
+    # @return [ActiveModel::Name] model_name
     def self.model_name
       ActiveModel::Name.new(model_class)
     end
+    # Fetch the original wrapped model.
+    #
+    # @return [Object] original_model
     def to_model
       @model
     end
+    # Delegates == to the decorated models
+    #
+    # @return [Boolean] true if other's model == self's model
+    def ==(other)
+      @model == other.model
+    end
+    def respond_to?(method)
+      if select_methods.include?(method)
+        model.respond_to?(method)
+      else
+        super
+      end
+    end
+    def method_missing(method, *args, &block)
+      if select_methods.include?(method)
+        model.send(method, *args, &block)
+      else
+        super
+      end
+    end
   private
     def select_methods
       specified = self.allowed || (model.public_methods.map{|s| s.to_sym} - denied.map{|s| s.to_sym})
       (specified - self.public_methods.map{|s| s.to_sym}) + FORCED_PROXY
     end
-    def build_methods
-      select_methods.each do |method|
-        (class << self; self; end).class_eval do
-          define_method method do |*args, &block|
-            model.send method, *args, &block
-          end
-        end
-      end
-    end
   end
 end

data/lib/draper/model_support.rb CHANGED

@@ -1,5 +1,6 @@
 module Draper::ModelSupport
   def decorator
     @decorator ||= "#{self.class.name}Decorator".constantize.decorate(self)
+    block_given? ? yield(@decorator) : @decorator
   end
 end

data/lib/draper/version.rb CHANGED

@@ -1,3 +1,3 @@
 module Draper
-  VERSION = "0.7.3"
+  VERSION = "0.7.4"
 end

data/lib/generators/rails/decorator_generator.rb ADDED

@@ -0,0 +1,15 @@
+require File.expand_path('../../draper/decorator/decorator_generator.rb', __FILE__)
+class Rails::DecoratorGenerator < Draper::DecoratorGenerator
+  source_root File.expand_path('../../draper/decorator/templates', __FILE__)
+  class_option :invoke_after_finished, :type => :string, :description => "Generator to invoke when finished"
+  def build_model_and_application_decorators
+    super
+    if self.options[:invoke_after_finished]
+      Rails::Generators.invoke(self.options[:invoke_after_finished], [@name, @_initializer.first[1..-1]])
+    end
+  end
+end

data/spec/base_spec.rb CHANGED

@@ -43,8 +43,9 @@ describe Draper::Base do
   context("selecting methods") do
     it "echos the methods of the wrapped class except default exclusions" do
+      pending "Fine on 1.9 but fails on 1.8 due to differences in implementation of respond_to and method_missing. Help?"
       source.methods.each do |method|
-        unless Draper::Base::DEFAULT_DENIED.include?(method)
+        unless Draper::Base::DEFAULT_DENIED.include?(method)
           subject.should respond_to(method)
         end
       end
@@ -88,6 +89,11 @@ describe Draper::Base do
       pd.should be_instance_of(ProductDecorator)
       pd.model.should be_instance_of(Product)
     end
+    it "should accept and store a context" do
+      pd = ProductDecorator.find(1, :admin)
+      pd.context.should == :admin
+    end
   end
   context ".decorate" do
@@ -132,6 +138,13 @@ describe Draper::Base do
     end
   end
+  context('.==') do
+    it "should compare the decorated models" do
+      other = Draper::Base.new(source)
+      subject.should == other
+    end
+  end
   describe "a sample usage with denies" do
     let(:subject_with_denies){ DecoratorWithDenies.new(source) }
@@ -156,11 +169,11 @@ describe Draper::Base do
     let(:subject_with_allows){ DecoratorWithAllows.new(source) }
     it "should echo the allowed method" do
-      subject_with_allows.should respond_to(:upcase)
+      subject_with_allows.should respond_to(:goodnight_moon)
     end
     it "should echo _only_ the allowed method" do
-      subject_with_allows.should_not respond_to(:downcase)
+      subject_with_allows.should_not respond_to(:hello_world)
     end
   end

data/spec/draper/model_support_spec.rb CHANGED

@@ -6,5 +6,10 @@ describe Draper::ModelSupport do
   describe '#decorator' do
     its(:decorator) { should be_kind_of(ProductDecorator) }
     its(:decorator) { should be(subject.decorator) }
+    it 'should have abillity to pass block' do
+      a = Product.new.decorator { |d| d.awesome_title }
+      a.should eql "Awesome Title"
+    end
   end
 end

data/spec/samples/active_record.rb CHANGED

@@ -1,7 +1,4 @@
 module ActiveRecord
   class Base
-    def method_missing(name, *args)
-      name
-    end
   end
-end
+end

data/spec/samples/decorator_with_allows.rb CHANGED

@@ -1,3 +1,3 @@
 class DecoratorWithAllows < Draper::Base
-  allows :upcase
+  allows :goodnight_moon
 end

data/spec/samples/product_decorator.rb CHANGED

@@ -1,3 +1,7 @@
 class ProductDecorator < Draper::Base
   decorates :product
+  def awesome_title
+    "Awesome Title"
+  end
 end

metadata CHANGED

@@ -1,39 +1,52 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification
 name: draper
-version: !ruby/object:Gem::Version
-  hash: 5
+version: !ruby/object:Gem::Version
+  version: 0.7.4
   prerelease:
-  segments:
-  - 0
-  - 7
-  - 3
-  version: 0.7.3
 platform: ruby
-authors:
+authors:
 - Jeff Casimir
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2011-08-29 00:00:00 Z
+date: 2011-10-03 00:00:00.000000000Z
 dependencies: []
-description: Draper reimagines the role of helpers in the view layer of a Rails application, allowing an object-oriented approach rather than procedural.
-email:
+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:
+files:
 - .gitignore
 - .travis.yml
+- .yardopts
 - Gemfile
 - Guardfile
 - Rakefile
 - Readme.markdown
+- doc/ApplicationDecorator.html
+- doc/Draper.html
+- doc/Draper/AllHelpers.html
+- doc/Draper/Base.html
+- doc/Draper/DecoratorGenerator.html
+- doc/Draper/LazyHelpers.html
+- doc/Draper/ModelSupport.html
+- doc/Draper/System.html
+- doc/_index.html
+- doc/class_list.html
+- doc/css/common.css
+- doc/css/full_list.css
+- doc/css/style.css
+- doc/file_list.html
+- doc/frames.html
+- doc/index.html
+- doc/js/app.js
+- doc/js/full_list.js
+- doc/js/jquery.js
+- doc/method_list.html
+- doc/top-level-namespace.html
 - draper.gemspec
 - lib/draper.rb
 - lib/draper/all_helpers.rb
@@ -46,6 +59,7 @@ files:
 - lib/generators/draper/decorator/decorator_generator.rb
 - lib/generators/draper/decorator/templates/application_decorator.rb
 - lib/generators/draper/decorator/templates/decorator.rb
+- lib/generators/rails/decorator_generator.rb
 - spec/base_spec.rb
 - spec/draper/model_support_spec.rb
 - spec/samples/active_record.rb
@@ -59,38 +73,29 @@ files:
 - spec/spec_helper.rb
 homepage: http://github.com/jcasimir/draper
 licenses: []
 post_install_message:
 rdoc_options: []
-require_paths:
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements:
-  - - ">="
-    - !ruby/object:Gem::Version
-      hash: 3
-      segments:
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements:
-  - - ">="
-    - !ruby/object:Gem::Version
-      hash: 3
-      segments:
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
 rubyforge_project: draper
-rubygems_version: 1.8.6
+rubygems_version: 1.8.10
 signing_key:
 specification_version: 3
 summary: Decorator pattern implmentation for Rails.
-test_files:
+test_files:
 - spec/base_spec.rb
 - spec/draper/model_support_spec.rb
 - spec/samples/active_record.rb