garnish 0.0.3 → 0.0.4

data/CHANGELOG.rdoc

@@ -1,3 +1,8 @@
+0.0.4 (February 16, 2012)
+
+* Overhaul on how relationships are manager by a Collection class now.
+Addresses method chaining issues on relationships.
+
 0.0.3 (February 1, 2012)
 
 * Version bump so I can push new version to rubygems

data/Gemfile

@@ -1,5 +1,10 @@
 source "http://rubygems.org"
 
+gem 'rake'
+gem 'activesupport'
+gem 'actionpack'
+gem 'i18n' #Why doesn't activesupport require this?
+
 group :development do
   gem 'guard'
   gem 'guard-rspec'

data/Guardfile

@@ -18,7 +18,7 @@ guard 'spin' do
   watch('Guardfile')
 end
 
-guard 'rspec', :cli => "--drb --color --order random", :version => 2, :rvm => ['1.9.3'] do
+guard 'rspec', :cli => "--color --order random", :version => 2, :rvm => ['1.9.3'] do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
   watch('spec/spec_helper.rb')                        { "spec" }

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Brian Pearce
+
+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/README.rdoc

@@ -2,7 +2,7 @@
 
 RDocs[http://rdoc.info/projects/brianp/garnish]
 
-Garnish is a Presenter / Decorator pattern for models in Rails. It gives a home to presntation level view logic that normally litters helpers and view files. Using it can help you:
+Garnish is a Presenter / Decorator pattern for models in Rails. It gives a home to presentation level view logic that normally litters helpers and view files. Using it can help you:
 
 * Keep helper files and views clean of if/else statements and other logic
 * Better define an interface for views to interact with models
@@ -10,6 +10,13 @@ Garnish is a Presenter / Decorator pattern for models in Rails. It gives a home
 * Keep you controller code clean by never having to instantiate the presenters
 * Handle Decorating / Presenting standard Rails relationships
 
+== Requirements
+
+Garnish Has been tested with
+
+* Rails 3
+* Ruby 1.9.2, 1.9.3
+
 == Installation
 
 In <b>Rails 3</b>, add this to your Gemfile and run the +bundle+ command.
@@ -35,12 +42,11 @@ Define the user_presenter
 
   module UserPresenter
     include Garnish::Presenter
-
   end
 
 === 2. Add methods to your presenter
 
-Define method in your presenter as regular instance methods
+Define methods in your presenter as regular instance methods
 
   module UserPresenter
     include Garnish::Presenter
@@ -83,12 +89,59 @@ The only change you need to make to start using your presenters now is to use re
 
 Garnish will now find and load presenters for any instance variables you set inside your action. *NOT* just the ivar passed to the respond_with block.
 
-== 5. Start using your presenter methods
+=== 5. Start using your presenter methods
 
 <tt>app/views/users/show.html.erb</tt>
 
   <span><%= @user.greeting %></span>
 
+== View Helpers
+
+Garnish plays very nicely when adding view helper methods into your presenter. Just treat them like a regular method.
+
+  module UserPresenter
+    include Garnish::Presenter
+
+    def profile_pic
+      image_tag profile_pic unless profile_pic.nil?
+    end
+  end
+
+== Relationships
+
+The real reason I got down to business. If I'm using presenters in my views I probably have presenters for multiple objects.
+
+  class User < ActiveRecord::Base
+    has_many :items
+  end
+
+  class Item < ActiveRecord::Base
+    belongs_to :user
+  end
+
+Assuming I have presenters for both of these models
+
+  module UserPresenter
+    include Garnish::Presenter
+  end
+
+  module ItemPresenter
+    include Garnish::Presenter
+
+    def picture
+      image_tag profile_pic unless profile_pic.nil?
+    end
+  end
+
+
+In my view when I'm accessing a user's items via the association what I really want is an Item extended with presenter methods not just a regular item.
+
+Garnish handles this for us. Anytime a relationship is accessed on a garnished resource the returned resources will also be extended with their presenter methods.
+
+  <%= @user.items.first.picture %>
+
+Works with no effort what so ever.
+
 == Questions or Problems?
 
 If you have any issues with Garnish which you cannot find the solution to, please add an {issue on GitHub}[https://github.com/brianp/garnish/issues] or fork the project and send a pull request.
@@ -97,4 +150,8 @@ To get the specs running you should call +bundle+ and then +rake+. See the {spec
 
 == Special Thanks
 
+{Fraser Valley Ruby Brigade}[http://www.fvrb.org/]
+
+The Ruby Moguls
+
 Garnish was inspired by draper[https://github.com/jcasimir/draper/] and the RailsCast Pro episode #287 Presenters from Scratch. See the CHANGELOG[https://github.com/brianp/garnish/blob/master/CHANGELOG.rdoc] for the full list.

data/lib/garnish.rb

@@ -4,6 +4,7 @@ require 'garnish/responder'
 require 'garnish/controller'
 require 'garnish/presenter/relationships'
 require 'garnish/presenter'
+require 'garnish/collection'
 
 require 'garnish/model_adapters/abstract_adapter'
 require 'garnish/model_adapters/default_adapter'

data/lib/garnish/collection.rb

@@ -0,0 +1,51 @@
+module Garnish
+  class Collection
+    include Enumerable
+    include Garnish::Converter
+
+    attr_accessor :relation
+    attr_accessor :template
+
+    delegate :avg, :max, :min, :sum, :length, :size, :count, :to => :relation
+
+    def initialize(relation, template)
+      @relation = relation
+      @template = template
+    end
+
+    # Call the method on the relation object and then convert the results
+    #
+    # @example
+    #   blog.posts.each { |post| post.name }
+    #
+    # @return [Collection]
+    [:to_a, :each].map do |method|
+      define_method method do
+        records = @relation.send(method)
+        convert(records)
+        records
+      end
+    end
+
+    def respond_to?(method)
+      @relation.respond_to?(method)
+    end
+
+    protected
+
+    def method_missing(method, *args, &block)
+      resp = @relation.send(method, *args, &block)
+
+      if resp.equal? @relation
+        self
+      elsif resp.instance_of? @relation.class
+        Garnish::Collection.new(resp, @template)
+      elsif resp.respond_to? :each
+        Garnish::Collection.new(resp, @template)
+      else
+        convert(resp)
+        resp
+      end
+    end
+  end
+end

data/lib/garnish/controller.rb

@@ -3,6 +3,15 @@ module Garnish
     extend ActiveSupport::Concern
 
     module ClassMethods
+      # Set the responder and respond_to formats
+      #
+      # @example
+      #   class ApplicationController < ActionController::Base
+      #     protect_from_forgery
+      #     garnish
+      #   end
+      #
+      # @return [undefined]
       def garnish(options = {}, &block)
         self.responder = Garnish::Responder
         respond_to :html

data/lib/garnish/presenter/relationships.rb

@@ -11,8 +11,7 @@ module Garnish
             alias_method "#{key}_orig".to_sym, key.to_sym
             define_method "#{key}" do |opts = nil, *rest|
               records = self.send("#{key}_orig")
-              convert(records)
-              records
+              Garnish::Collection.new(records, template)
             end
           end
         end

data/lib/garnish/version.rb

@@ -1,3 +1,3 @@
 module Garnish
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/garnish/collection_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe Garnish::Collection do
+
+  let(:relation) { stub(:relation) }
+  let(:template) { stub(:template) }
+  let(:collection) { Garnish::Collection.new(relation, template) }
+
+  it "should init with a relation record" do
+    collection.relation.should eq(relation)
+  end
+
+  it "should pass the each method to the relation" do
+    relation.should_receive(:each)
+    collection.each
+  end
+
+  it "should pass the to_a method to the relation" do
+    relation.should_receive(:to_a)
+    collection.to_a
+  end
+
+  describe "method chains should return the existing collection" do
+    it "should be the same collection" do
+      relation.stub(:limit => collection)
+      collection.limit(1).should eq(collection)
+    end
+
+    it "should be the same collection" do
+      relation.stub(:limit => collection, :order => collection)
+      collection.limit(1).order(:desc).should eq(collection)
+    end
+  end
+end

data/spec/garnish/controller_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe "A Garnished Controller" do
+describe Garnish::Controller do
 
   subject { TestController }
 

data/spec/garnish/converter_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe "A Garnish Converter" do
+describe Garnish::Converter do
 
   context "instance" do
 

data/spec/garnish/presenter/relationships_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe "A Presenter Relationship" do
+describe Garnish::Presenter::Relationships do
 
   let(:test_class) { TestClass.new }
   before { test_class.extend Garnish::Presenter::Relationships }
@@ -11,7 +11,8 @@ describe "A Presenter Relationship" do
   end
 
   it "should call convert on the records of the relationship" do
-    test_class.should_receive(:convert)
+    test_class.stub(:template => stub)
+    Garnish::Collection.should_receive(:new)
     test_class.users
   end
 

data/spec/garnish/presenter_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe "A Garnish Presenter" do
+describe Garnish::Presenter do
 
   let(:test_class) { TestClass.new }
   before { TestClass.send :include, TestClassPresenter }

data/spec/garnish/responder_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe "The Garnished Responder" do
+describe Garnish::Responder do
 
   let(:responder) { Garnish::Responder.new(controller, resources) }
   let(:formats) { stub(:formats, :first => nil) }

metadata

@@ -1,71 +1,57 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: garnish
-version: !ruby/object:Gem::Version 
-  hash: 25
+version: !ruby/object:Gem::Version
+  version: 0.0.4
   prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 3
-  version: 0.0.3
 platform: ruby
-authors: 
+authors:
 - brianp
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-02-01 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-02-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: activesupport
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70340124404820 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 3
-        - 0
-        - 0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 3.0.0
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *70340124404820
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70340124404220 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
-description: Provides an easy to use and transparent system for implementing the Decorator Pattern
-email: 
+  prerelease: false
+  version_requirements: *70340124404220
+description: Provides an easy to use and transparent system for implementing the Decorator
+  Pattern
+email:
 - brian.o.pearce@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .travis.yml
 - CHANGELOG.rdoc
 - Gemfile
 - Guardfile
+- LICENSE
 - README.rdoc
 - Rakefile
 - garnish.gemspec
 - lib/garnish.rb
+- lib/garnish/collection.rb
 - lib/garnish/controller.rb
 - lib/garnish/converter.rb
 - lib/garnish/model_adapters/abstract_adapter.rb
@@ -77,47 +63,40 @@ files:
 - lib/garnish/responder.rb
 - lib/garnish/version.rb
 - spec/README.rdoc
+- spec/garnish/collection_spec.rb
 - spec/garnish/controller_spec.rb
 - spec/garnish/converter_spec.rb
 - spec/garnish/presenter/relationships_spec.rb
 - spec/garnish/presenter_spec.rb
 - spec/garnish/responder_spec.rb
 - spec/spec_helper.rb
-homepage: ""
+homepage: ''
 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: garnish
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Provides the decorator design pattern
-test_files: 
+test_files:
 - spec/README.rdoc
+- spec/garnish/collection_spec.rb
 - spec/garnish/controller_spec.rb
 - spec/garnish/converter_spec.rb
 - spec/garnish/presenter/relationships_spec.rb