viewtastic 0.1.0 → 0.1.1

data/README.md

@@ -0,0 +1,82 @@
+# Viewtastic #
+
+
+## Installation ##
+
+Install the gem
+
+    gem install viewtastic
+
+Load the gem in your `environment.rb` file
+
+    config.gem "viewtastic"
+
+## Usage ##
+
+My presenters go into the `app/presenters` directory of the application so this is added to the load_path in Rails by default by Viewtastic.
+
+### Presenters ###
+
+A Presenter inherits from `Viewtastic::Base` and should use the `presents` method to declare presented objects.
+    
+    class CommentPresenter < Viewtastic::Base
+      presents :comment
+    end
+
+This gives you several 'magic' methods:
+
+* All attributes of comment with the prefix 'comment'. For instance: `comment_body`, `comment_post`, `comment_created_at`.
+* `comment_dom_id` is the same as calling `dom_id(comment)` in a view.
+
+If you want to skip the prefix and just have the attribute name, you can declare:
+    
+    presents :comment => [:body, :created_at]
+
+and you get `presenter.body` and `presenter.created_at`.
+
+
+Assuming you have a `Comment` model and your controller has a helper method `current_user` that returns the user currently logged in, you could make the following presenter to help in presenting products.
+
+    class CommentPresenter < Viewtastic::Base
+      presents :comment
+      
+      def dom_id
+        comment_dom_id
+      end
+      
+      def owner?
+        controller.current_user.comments.include?(comment)
+      end
+      
+      def links
+        returning([]) do |links|
+          links << link_to("Edit", [:edit, comment]) if owner?
+          links << link_to("Reply", [:new, :comment]) if controller.current_user
+        end
+      end
+    end
+
+### Convenience ###
+
+`each_with_presenter` is available on any `Array`, and it is designed to reuse a single Presenter instance and pass every element in the array as the presented object.
+
+In your view (maybe `posts/show.html.erb`):
+    
+    <ul>
+    <% @post.comments.each_with_presenter(CommentPresenter, :comment) do |comment| %>
+      <li id="<%= comment.dom_id %>">
+        <%= comment.body %>
+        <%= comment.links %>
+      </li>
+    <% end %>
+    </ul>
+
+## Credits ##
+
+* [ActivePresenter](http://github.com/giraffesoft/active_presenter) was the inspiration for this project and some of the presenter code was used from ActivePresenter.
+* [Authlogic](http://github.com/binarylogic/authlogic) -- the Authlogic activation code is used to activate Viewtastic on each request.
+
+## License ##
+
+
+Copyright (c) 2009 Istvan Hoka, released under the MIT license

data/init.rb

@@ -0,0 +1 @@
+Rails.configuration.load_paths << "app/presenters"

data/lib/duck_punches/array/each_with_presenter.rb

@@ -1,4 +1,8 @@
 class Array
+  # Wrap each element in the Array with a presenter specified by @presenter_class@ and 
+  # assigned as the model for @object_name@.
+  # @presenter_options@ are set once on the initial presenter instance.
+  #
   def each_with_presenter(presenter_class, object_name, presenter_options={}, &block)
     presenter = presenter_class.new(presenter_options)
     each do |object|

data/lib/viewtastic.rb

@@ -1,3 +1,7 @@
 require File.dirname(__FILE__) + "/viewtastic/activation"
 require File.dirname(__FILE__) + "/viewtastic/base"
 require File.dirname(__FILE__) + "/duck_punches/array/each_with_presenter"
+
+module Viewtastic
+  VERSION = "0.1.1"
+end

data/lib/viewtastic/activation.rb

@@ -1,7 +1,7 @@
 module Viewtastic
   module Activation
     # Lets Viewtastic know about the controller object via a before filter, AKA "activates" viewtastic.
-    # Borrowed from Viewtastic.
+    # Borrowed from Authlogic.
     #
     def self.included(klass) # :nodoc:
       if defined?(::ApplicationController)

data/lib/viewtastic/base.rb

@@ -1,101 +1,127 @@
-class Viewtastic::Base
-  include ActionView::Helpers::UrlHelper
-  include ActionView::Helpers::TextHelper
-  include ActionView::Helpers::TagHelper
+module Viewtastic
+  # Base class for presenters. See README.md for usage.
+  #
+  class Base
+    include ActionView::Helpers::UrlHelper
+    include ActionView::Helpers::TextHelper
+    include ActionView::Helpers::TagHelper
+
+    class_inheritable_accessor :presented
+    self.presented = []
   
-  class_inheritable_accessor :presented
-  self.presented = []
+    delegate :protect_against_forgery?,
+             :request_forgery_protection_token,
+             :form_authenticity_token,
+             :dom_id,
+             :to => :controller
   
-  delegate :protect_against_forgery?,
-           :request_forgery_protection_token,
-           :form_authenticity_token,
-           :dom_id,
-           :to => :controller
-  
-  class << self    
-    def presents(*types)
-      types_and_attributes = types.extract_options!
+    class << self
+      # Indicates which models are to be presented.
+      #
+      #   class CommentPresenter < Viewtastic::Base
+      #     presents :comment, :post
+      #   end
+      #  
+      # If you want to delegate messages to models without prefixing them with the model name, specify them in an Array: 
+      #
+      #   class PresenterWithTwoAddresses < ActivePresenter::Base
+      #     presents :post, :comment => [:body, :created_at]
+      #   end
+      #
+      def presents(*types)
+        types_and_attributes = types.extract_options!
     
-      types_and_attributes.each do |name, delegates|
-        attr_accessor name
-        presented << name
-        delegates.each do |msg|
-          delegate msg, :to => name
+        types_and_attributes.each do |name, delegates|
+          attr_accessor name
+          presented << name
+          delegates.each do |msg|
+            delegate msg, :to => name
+          end
         end
-      end
     
-      attr_accessor *types
-      self.presented += types
+        attr_accessor *types
+        self.presented += types
       
-      presented.each do |name|
-        define_method("#{name}_dom_id") do |*args|
-          send(:dom_id, send(name), *args)
+        presented.each do |name|
+          define_method("#{name}_dom_id") do |*args|
+            send(:dom_id, send(name), *args)
+          end
         end
       end
-    end
     
-    def controller=(value)
-      Thread.current[:viewtastic_controller] = value
-    end
+      def controller=(value) #:nodoc:
+        Thread.current[:viewtastic_controller] = value
+      end
     
-    def controller
-      Thread.current[:viewtastic_controller]
-    end
+      def controller #:nodoc:
+        Thread.current[:viewtastic_controller]
+      end
     
-    def activated?
-      !controller.nil?
+      def activated? #:nodoc:
+        !controller.nil?
+      end
     end
-  end
   
-  def initialize(*values)
-    keys_and_values = values.extract_options!
+    # Accepts arguments in two forms. If you had a CommentPresenter that presented a Comment model and a Post model, you would write the follwoing:
+    # 
+    # 1. CommentPresenter.new(:comment => Comment.new, :post => @post)
+    # 2. CommentPresenter.new(Comment.new, @post) - it will introspect on the model's class; the order is not important.
+    # 
+    # You can even mix the two:
+    #   CommentPresenter.new(Comment.new, :post => @post)
+    #
+    def initialize(*values)
+      keys_and_values = values.extract_options!
     
-    keys_and_values.each do |name, instance|
-      send("#{name}=", instance)
-    end
+      keys_and_values.each do |name, instance|
+        send("#{name}=", instance)
+      end
     
-    values.each do |value|
-      send("#{value.class.name.underscore}=", value)
+      values.each do |value|
+        send("#{value.class.name.underscore}=", value)
+      end
     end
-  end
   
-  def method_missing(method_name, *args, &block)
-    if method_name.to_s =~ /_(path|url)$/
-      # Delegate all named routes to the controller
-      controller.send(method_name, *args)
-    elsif presented_attribute?(method_name)
-      delegate_message(method_name, *args, &block)
-    else
-      super
+    def method_missing(method_name, *args, &block) 
+      if method_name.to_s =~ /_(path|url)$/
+        # Delegate all named routes to the controller
+        controller.send(method_name, *args)
+      elsif presented_attribute?(method_name)
+        delegate_message(method_name, *args, &block)
+      else
+        super
+      end
     end
-  end
-  
-  def controller
-    self.class.controller
-  end
   
-  protected
-    def delegate_message(method_name, *args, &block)
-      presentable = presentable_for(method_name)
-      send(presentable).send(flatten_attribute_name(method_name, presentable), *args, &block)
+    # The current controller performing the request is accessible with this.
+    #
+    def controller
+      self.class.controller
     end
+  
+    protected
+      def delegate_message(method_name, *args, &block) #:nodoc:
+        presentable = presentable_for(method_name)
+        send(presentable).send(flatten_attribute_name(method_name, presentable), *args, &block)
+      end
     
-    def presentable_for(method_name)
-      presented.sort_by { |k| k.to_s.size }.reverse.detect do |type|
-        method_name.to_s.starts_with?(attribute_prefix(type))
+      def presentable_for(method_name) #:nodoc:
+        presented.sort_by { |k| k.to_s.size }.reverse.detect do |type|
+          method_name.to_s.starts_with?(attribute_prefix(type))
+        end
       end
-    end
   
-    def presented_attribute?(method_name)
-      p = presentable_for(method_name)
-      !p.nil? && send(p).respond_to?(flatten_attribute_name(method_name,p))
-    end
+      def presented_attribute?(method_name) #:nodoc:
+        p = presentable_for(method_name)
+        !p.nil? && send(p).respond_to?(flatten_attribute_name(method_name,p))
+      end
     
-    def flatten_attribute_name(name, type)
-      name.to_s.gsub(/^#{attribute_prefix(type)}/, '')
-    end
+      def flatten_attribute_name(name, type) #:nodoc:
+        name.to_s.gsub(/^#{attribute_prefix(type)}/, '')
+      end
     
-    def attribute_prefix(type)
-      "#{type}_"
-    end
+      def attribute_prefix(type) #:nodoc:
+        "#{type}_"
+      end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: viewtastic
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Istvan Hoka
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-30 00:00:00 +02:00
+date: 2009-12-01 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
@@ -21,15 +21,16 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README
+- README.md
 files: 
 - LICENSE
+- init.rb
 - lib/duck_punches/array/each_with_presenter.rb
 - lib/viewtastic.rb
 - lib/viewtastic/activation.rb
 - lib/viewtastic/base.rb
 - lib/viewtastic/test_case.rb
-- README
+- README.md
 has_rdoc: true
 homepage: http://github.com/ihoka/viewtastic
 licenses: []

data/README

@@ -1,13 +0,0 @@
-Viewtastic
-==========
-
-Introduction goes here.
-
-
-Example
-=======
-
-Example goes here.
-
-
-Copyright (c) 2009 [name of plugin creator], released under the MIT license