be9-viewtastic 0.3.0

data/History.txt

@@ -0,0 +1,5 @@
+0.1.2 - Holy smokes!
+====================
+
+* FIX: properly add "app/presenters" to load_path
+* FIX: Include Viewtastic::Activation in ActionController::Base to activate Viewtastic

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2009 Istvan Hoka
+
+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.md

@@ -0,0 +1,86 @@
+# Viewtastic #
+
+## About this fork
+
+
+This is the viewtastic for Rails 3. Original one, intended for 2.x, can be found [here](http://github.com/ihoka/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/lib/duck_punches/array/each_with_presenter.rb

@@ -0,0 +1,13 @@
+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|
+      presenter.send("#{object_name}=", object)
+      yield presenter
+    end
+  end
+end

data/lib/viewtastic.rb

@@ -0,0 +1,19 @@
+require 'rails'
+require "viewtastic/activation"
+require "viewtastic/base"
+
+module Viewtastic
+  VERSION = "0.3.0"
+
+  class Railtie < Rails::Railtie
+    initializer "viewtastic.activate" do
+      ActiveSupport.on_load(:action_controller) do
+        ActionController::Base.send(:include, Viewtastic::Activation)
+      end
+    end
+
+    initializer "viewtastic.add_presenter_paths" do
+      require "duck_punches/array/each_with_presenter"
+    end
+  end
+end

data/lib/viewtastic/activation.rb

@@ -0,0 +1,15 @@
+module Viewtastic
+  module Activation
+    # Lets Viewtastic know about the controller object via a before filter, AKA "activates" viewtastic.
+    # Borrowed from Authlogic.
+    #
+    def self.included(klass) # :nodoc:
+      klass.prepend_before_filter :activate_viewtastic
+    end
+    
+    private
+      def activate_viewtastic
+        Viewtastic::Base.controller = self
+      end
+  end
+end

data/lib/viewtastic/base.rb

@@ -0,0 +1,129 @@
+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
+    include ActionView::Helpers::NumberHelper
+    include ActionView::Helpers::FormTagHelper
+
+    class_inheritable_accessor :presented
+    self.presented = []
+  
+    delegate :protect_against_forgery?,
+             :request_forgery_protection_token,
+             :form_authenticity_token,
+             :dom_id,
+             :to => :controller
+  
+    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
+          end
+        end
+    
+        attr_accessor *types
+        self.presented += types
+      
+        presented.each do |name|
+          define_method("#{name}_dom_id") do |*args|
+            controller.send(:dom_id, send(name), *args)
+          end
+        end
+      end
+    
+      def controller=(value) #:nodoc:
+        Thread.current[:viewtastic_controller] = value
+      end
+    
+      def controller #:nodoc:
+        Thread.current[:viewtastic_controller]
+      end
+    
+      def activated? #:nodoc:
+        !controller.nil?
+      end
+    end
+  
+    # 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
+    
+      values.each do |value|
+        send("#{value.class.name.underscore}=", value)
+      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
+      end
+    end
+  
+    # 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) #:nodoc:
+        presented.sort_by { |k| k.to_s.size }.reverse.detect do |type|
+          method_name.to_s.starts_with?(attribute_prefix(type))
+        end
+      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) #:nodoc:
+        name.to_s.gsub(/^#{attribute_prefix(type)}/, '')
+      end
+    
+      def attribute_prefix(type) #:nodoc:
+        "#{type}_"
+      end
+  end
+end

data/lib/viewtastic/test_case.rb

@@ -0,0 +1,15 @@
+module Viewtastic
+  module TestCase
+    include Authlogic::TestCase
+
+    def activate_viewtastic
+      if @request && ! @request.respond_to?(:params)
+        class <<@request
+          alias_method :params, :parameters
+        end
+      end
+
+      Viewtastic::Base.controller = (@request && Authlogic::TestCase::RailsRequestAdapter.new(@request)) || controller
+    end
+  end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: be9-viewtastic
+version: !ruby/object:Gem::Version 
+  hash: 19
+  prerelease: false
+  segments: 
+  - 0
+  - 3
+  - 0
+  version: 0.3.0
+platform: ruby
+authors: 
+- Istvan Hoka
+- Oleg Dashevskii
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-15 00:00:00 +06:00
+default_executable: 
+dependencies: []
+
+description: 
+email: olegdashevskii@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- History.txt
+- LICENSE
+- 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.md
+has_rdoc: true
+homepage: http://github.com/be9/viewtastic
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+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 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Presenter implementation for Ruby on Rails 3.x
+test_files: []
+