actionpack 0.9.0

data/lib/action_view/helpers/tag_helper.rb

@@ -0,0 +1,59 @@
+require 'cgi'
+
+module ActionView
+  module Helpers
+    # This is poor man's Builder for the rare cases where you need to programmatically make tags but can't use Builder.
+    module TagHelper
+      include ERB::Util
+
+      # Examples: 
+      # * tag("br") => <br />
+      # * tag("input", { "type" => "text"}) => <input type="text" />
+      def tag(name, options = {}, open = false)
+        "<#{name + tag_options(options)}" + (open ? ">" : " />")
+      end
+      
+      # Examples: 
+      # * content_tag("p", "Hello world!") => <p>Hello world!</p>
+      # * content_tag("div", content_tag("p", "Hello world!"), "class" => "strong") => 
+      #   <div class="strong"><p>Hello world!</p></div>
+      def content_tag(name, content, options = {})
+        "<#{name + tag_options(options)}>#{content}</#{name}>"
+      end
+
+      # Starts a form tag that points the action to an url configured with <tt>url_for_options</tt> just like 
+      # ActionController::Base#url_for.
+      def form_tag(url_for_options, options = {}, *parameters_for_url)
+        html_options = { "method" => "POST" }.merge(options)
+        
+        if html_options[:multipart]
+          html_options["enctype"] = "multipart/form-data"
+          html_options.delete(:multipart)
+        end
+        
+        html_options["action"] = url_for(url_for_options, *parameters_for_url)
+        
+        tag("form", html_options, true)
+      end
+      
+      alias_method :start_form_tag, :form_tag
+
+      # Outputs "</form>"
+      def end_form_tag
+        "</form>"
+      end
+
+
+      private
+        def tag_options(options)
+          if options.empty?
+            ""
+          else
+            " " + options.collect { |pair| 
+              "#{pair.first}=\"#{html_escape(pair.last)}\"" 
+            }.sort.join(" ") 
+          end
+        end
+    end
+  end
+end

data/lib/action_view/helpers/text_helper.rb

@@ -0,0 +1,129 @@
+module ActionView
+  # The template helpers serves to relieve the templates from including the same inline code again and again. It's a
+  # set of standardized methods for working with forms (FormHelper), dates (DateHelper), texts (TextHelper), and 
+  # Active Records (ActiveRecordHelper) that's available to all templates by default.
+  #
+  # It's also really easy to make your own helpers and it's much encouraged to keep the template files free
+  # from complicated logic. It's even encouraged to bundle common compositions of methods from other helpers 
+  # (often the common helpers) as they're used by the specific application.
+  # 
+  # Defining a helper requires you to include a specialized +append_features+ method that makes them capable 
+  # of configuring their integration upon inclusion in a controller, like this:
+  # 
+  #   module MyHelper
+  #     def self.append_features(controller)
+  #       controller.ancestors.include?(ActionController::Base) ?
+  #         controller.add_template_helper(self) : super
+  #     end
+  #   
+  #     def hello_world() "hello world" end
+  #   end
+  # 
+  # MyHelper can now be included in a controller, like this:
+  # 
+  #   require 'my_helper'
+  #   class MyController < ActionController::Base
+  #     include MyHelper
+  #   end
+  # 
+  # ...and, same as above, used in any template rendered from MyController, like this:
+  # 
+  # Let's hear what the helper has to say: <tt><%= hello_world %></tt>
+  module Helpers
+    # Provides a set of methods for working with text strings that can help unburden the level of inline Ruby code in the
+    # templates. In the example below we iterate over a collection of posts provided to the template and prints each title 
+    # after making sure it doesn't run longer than 20 characters:
+    #   <% for post in @posts %>
+    #     Title: <%= truncate(post.title, 20) %>
+    #   <% end %>
+    module TextHelper
+      # The regular puts and print are outlawed in eRuby. It's recommended to use the <%= "hello" %> form instead of print "hello".
+      # If you absolutely must use a method-based output, you can use concat. It's use like this <% concat "hello", binding %>. Notice that
+      # it doesn't have an equal sign in front. Using <%= concat "hello" %> would result in a double hello.
+      def concat(string, binding)
+        eval("_erbout", binding).concat(string)
+      end
+
+      # Truncates +text+ to the length of +length+ and replaces the last three characters with the +truncate_string+
+      # if the +text+ is longer than +length+.
+      def truncate(text, length = 30, truncate_string = "...")
+        if text.nil? then return end
+        if text.length > length then text[0..(length - 3)] + truncate_string else text end
+      end
+
+      # Highlights the +phrase+ where it is found in the +text+ by surrounding it like
+      # <strong class="highlight">I'm a highlight phrase</strong>. The highlighter can be specialized by
+      # passing +highlighter+ as single-quoted string with \1 where the phrase is supposed to be inserted.
+      # N.B.: The +phrase+ is sanitized to include only letters, digits, and spaces before use.
+      def highlight(text, phrase, highlighter = '<strong class="highlight">\1</strong>')
+        if text.nil? || phrase.nil? then return end
+        text.gsub(/(#{escape_regexp(phrase)})/i, highlighter) unless text.nil?
+      end
+      
+      # Extracts an excerpt from the +text+ surrounding the +phrase+ with a number of characters on each side determined
+      # by +radius+. If the phrase isn't found, nil is returned. Ex: 
+      #   excerpt("hello my world", "my", 3) => "...lo my wo..."
+      def excerpt(text, phrase, radius = 100, excerpt_string = "...")
+        if text.nil? || phrase.nil? then return end
+        phrase = escape_regexp(phrase)
+        
+        if found_pos = text =~ /(#{phrase})/i
+          start_pos = [ found_pos - radius, 0 ].max
+          end_pos   = [ found_pos + phrase.length + radius, text.length ].min
+
+          prefix  = start_pos > 0 ? excerpt_string : ""
+          postfix = end_pos < text.length ? excerpt_string : ""
+
+          prefix + text[start_pos..end_pos].strip + postfix
+        else
+          nil
+        end
+      end
+
+      # Attempts to pluralize the +singular+ word unless +count+ is 1. See source for pluralization rules.
+      def pluralize(count, singular, plural = nil)
+         "#{count} " + if count == 1
+          singular
+        elsif plural
+          plural
+        elsif Object.const_defined?("Inflector")
+          Inflector.pluralize(singular)
+        else 
+          singular + "s"
+        end
+      end
+
+      begin
+        require "redcloth"
+
+        # Returns the text with all the Textile codes turned into HTML-tags. 
+        # <i>This method is only available if RedCloth can be required</i>.
+        def textilize(text)
+          RedCloth.new(text).to_html
+        end
+
+        # Returns the text with all the Textile codes turned into HTML-tags, but without the regular bounding <p> tag. 
+        # <i>This method is only available if RedCloth can be required</i>.
+        def textilize_without_paragraph(text)
+          textiled = textilize(text)
+          if textiled[0..2] == "<p>" then textiled = textiled[3..-1] end
+          if textiled[-4..-1] == "</p>" then textiled = textiled[0..-5] end
+          return textiled
+        end
+      rescue LoadError
+        # We can't really help what's not there
+      end
+
+      # Turns all links into words, like "<a href="something">else</a>" to "else".
+      def strip_links(text)
+        text.gsub(/<a.*>(.*)<\/a>/m, '\1')
+      end
+      
+      private
+        # Returns a version of the text that's safe to use in a regular expression without triggering engine features.
+        def escape_regexp(text)
+          text.gsub(/([\\|?+*\/\)\(])/) { |m| "\\#{$1}" }
+        end
+    end
+  end
+end

data/lib/action_view/helpers/url_helper.rb

@@ -0,0 +1,72 @@
+module ActionView
+  module Helpers
+    # Provides a set of methods for making easy links and getting urls that depend on the controller and action. This means that
+    # you can use the same format for links in the views that you do in the controller. The different methods are even named
+    # synchronously, so link_to uses that same url as is generated by url_for, which again is the same url used for
+    # redirection in redirect_to.
+    module UrlHelper
+      # Returns the URL for the set of +options+ provided. See the valid options in link:classes/ActionController/Base.html#M000021
+      def url_for(options = {}, *parameters_for_method_reference)
+        if Hash === options then options = { :only_path => true }.merge(options) end
+        @controller.send(:url_for, options, *parameters_for_method_reference).gsub("&", "&")
+      end
+
+      # Creates a link tag of the given +name+ using an URL created by the set of +options+. See the valid options in
+      # link:classes/ActionController/Base.html#M000021. It's also possible to pass a string instead of an options hash to
+      # get a link tag that just points without consideration. The html_options have a special feature for creating javascript
+      # confirm alerts where if you pass :confirm => 'Are you sure?', the link will be guarded with a JS popup asking that question.
+      # If the user accepts, the link is processed, otherwise not.
+      def link_to(name, options = {}, html_options = {}, *parameters_for_method_reference)
+        if options.is_a?(String)
+          content_tag "a", name, "href" => options
+        else
+          convert_confirm_option_to_javascript!(html_options)
+          content_tag("a", name, html_options.merge({ "href" => url_for(options, *parameters_for_method_reference) }))
+        end
+      end
+
+      # Creates a link tag of the given +name+ using an URL created by the set of +options+, unless the current 
+      # controller, action, and id are the same as the link's, in which case only the name is returned (or the
+      # given block is yielded, if one exists). This is useful for creating link bars where you don't want to link 
+      # to the page currently being viewed.
+      def link_to_unless_current(name, options = {}, html_options = {}, *parameters_for_method_reference)
+        assume_current_url_options!(options)
+
+        if destination_equal_to_current(options)
+          block_given? ?
+            yield(name, options, html_options, *parameters_for_method_reference) :
+            html_escape(name)
+        else
+          link_to name, options, html_options, *parameters_for_method_reference
+        end
+      end
+
+      private
+        def destination_equal_to_current(options)
+          params_without_location = @params.reject { |key, value| %w( controller action id ).include?(key) }
+
+          options[:action] == @params['action'] &&
+            options[:id] == @params['id'] &&
+            options[:controller] == @params['controller'] &&
+            (options.has_key?(:params) ? params_without_location == options[:params] : true) 
+        end
+        
+        def assume_current_url_options!(options)
+          if options[:controller].nil?
+            options[:controller] = @params['controller']
+            if options[:action].nil?
+              options[:action] = @params['action']
+              if options[:id].nil? then options[:id] ||= @params['id'] end
+            end
+          end
+        end
+        
+        def convert_confirm_option_to_javascript!(html_options)
+          if html_options.include?(:confirm)
+            html_options["onClick"] = "return confirm('#{html_options[:confirm]}');"
+            html_options.delete(:confirm)
+          end
+        end
+    end
+  end
+end

data/lib/action_view/partials.rb

@@ -0,0 +1,61 @@
+module ActionView
+  # There's also a convenience method for rendering sub templates within the current controller that depends on a single object 
+  # (we call this kind of sub templates for partials). It relies on the fact that partials should follow the naming convention of being 
+  # prefixed with an underscore -- as to separate them from regular templates that could be rendered on their own. In the template for 
+  # Advertiser#buy, we could have:
+  #
+  #   <% for ad in @advertisements %>
+  #     <%= render_partial "ad", ad %>
+  #   <% end %>
+  #
+  # This would render "advertiser/_ad.rhtml" and pass the local variable +ad+ to the template for display.
+  #
+  # == Rendering a collection of partials
+  #
+  # The example of partial use describes a familar pattern where a template needs to iterate over an array and render a sub
+  # template for each of the elements. This pattern has been implemented as a single method that accepts an array and renders
+  # a partial by the same name as the elements contained within. So the three-lined example in "Using partials" can be rewritten
+  # with a single line:
+  #
+  #   <%= render_collection_of_partials "ad", @advertisements %>
+  #
+  # This will render "advertiser/_ad.rhtml" and pass the local variable +ad+ to the template for display. An iteration counter
+  # will automatically be made available to the template with a name of the form +partial_name_counter+. In the case of the 
+  # example above, the template would be fed +ad_counter+.
+  # 
+  # == Rendering shared partials
+  #
+  # Two controllers can share a set of partials and render them like this:
+  #
+  #   <%= render_partial "advertisement/ad", ad %>
+  #
+  # This will render the partial "advertisement/_ad.rhtml" regardless of which controller this is being called from.
+  module Partials
+    def render_partial(partial_path, object = nil, local_assigns = {})
+      path, partial_name = partial_pieces(partial_path)
+      object ||= controller.instance_variable_get("@#{partial_name}")
+      render("#{path}/_#{partial_name}", { partial_name => object }.merge(local_assigns))
+    end
+
+    def render_collection_of_partials(partial_name, collection, partial_spacer_template = nil)
+      collection_of_partials = Array.new
+      collection.each_with_index do |element, counter|
+        collection_of_partials.push(render_partial(partial_name, element, "#{partial_name.split("/").last}_counter" => counter))
+      end
+
+      return nil if collection_of_partials.empty?
+      partial_spacer_template ? 
+        collection_of_partials.join(render("#{controller.send(:controller_name)}/_#{partial_spacer_template}")) : 
+        collection_of_partials
+    end
+    
+    private
+      def partial_pieces(partial_path)
+        if partial_path.include?('/')
+          return File.dirname(partial_path), File.basename(partial_path)
+        else
+          return controller.send(:controller_name), partial_path
+        end
+      end
+  end
+end

data/lib/action_view/template_error.rb

@@ -0,0 +1,84 @@
+module ActionView
+  # The TemplateError exception is raised when the compilation of the template fails. This exception then gathers a
+  # bunch of intimate details and uses it to report a very precise exception message.
+  class TemplateError < ActionViewError #:nodoc:
+    SOURCE_CODE_RADIUS = 3
+
+    attr_reader :original_exception
+
+    def initialize(base_path, file_name, assigns, source, original_exception)
+      @base_path, @file_name, @assigns, @source, @original_exception = 
+        base_path, file_name, assigns, source, original_exception
+    end
+  
+    def message
+      if original_exception.message.include?("(eval):")
+        original_exception.message.scan(/\(eval\):(?:[0-9]*):in `.*'(.*)/).first.first
+      else
+        original_exception.message
+      end
+    end
+  
+    def sub_template_message
+      if @sub_templates
+        "Trace of template inclusion: " +
+        @sub_templates.collect { |template| strip_base_path(template) }.join(", ")
+      else
+        ""
+      end
+    end
+  
+    def source_extract
+      source_code = IO.readlines(@file_name)
+      
+      start_on_line = [ line_number - SOURCE_CODE_RADIUS - 1, 0 ].max
+      end_on_line   = [ line_number + SOURCE_CODE_RADIUS - 1, source_code.length].min
+
+      line_counter = start_on_line
+      extract = source_code[start_on_line..end_on_line].collect do |line| 
+        line_counter += 1
+        "#{line_counter}: " + line
+      end
+    
+      extract.join
+    end
+  
+    def sub_template_of(file_name)
+      @sub_templates ||= []
+      @sub_templates << file_name
+    end
+  
+    def line_number
+      begin
+        @original_exception.backtrace.join.scan(/\((?:erb)\):([0-9]*)/).first.first.to_i
+      rescue
+        begin
+          original_exception.message.scan(/\((?:eval)\):([0-9]*)/).first.first.to_i
+        rescue
+          1
+        end
+      end
+    end
+  
+    def file_name
+      strip_base_path(@file_name)
+    end
+    
+    def to_s
+      "\n\n#{self.class} (#{message}) on line ##{line_number} of #{file_name}:\n" + 
+      source_extract + "\n    " +
+      clean_backtrace(original_exception).join("\n    ") +
+      "\n\n"
+    end
+
+    private
+      def strip_base_path(file_name)
+        file_name.gsub(@base_path, "")
+      end
+
+      def clean_backtrace(exception)
+        base_dir = File.expand_path(File.dirname(__FILE__) + "/../../../../")
+        exception.backtrace.collect { |line| line.gsub(base_dir, "").gsub("/public/../config/environments/../../", "").gsub("/public/../", "") }
+      end
+  end
+end

data/lib/action_view/vendor/builder.rb

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+#--
+# Copyright 2004 by Jim Weirich (jim@weirichhouse.org).
+# All rights reserved.
+
+# Permission is granted for use, copying, modification, distribution,
+# and distribution of modified versions of this work as long as the
+# above copyright notice is included.
+#++
+
+require 'builder/xmlmarkup'
+require 'builder/xmlevents'

data/lib/action_view/vendor/builder/blankslate.rb

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+#--
+# Copyright 2004 by Jim Weirich (jim@weirichhouse.org).
+# All rights reserved.
+
+# Permission is granted for use, copying, modification, distribution,
+# and distribution of modified versions of this work as long as the
+# above copyright notice is included.
+#++
+
+module Builder #:nodoc:
+
+  # BlankSlate provides an abstract base class with no predefined
+  # methods (except for <tt>\_\_send__</tt> and <tt>\_\_id__</tt>).
+  # BlankSlate is useful as a base class when writing classes that
+  # depend upon <tt>method_missing</tt> (e.g. dynamic proxies).
+  class BlankSlate #:nodoc:
+    instance_methods.each { |m| undef_method m unless m =~ /^(__|instance_eval)/ }
+  end
+
+end

data/lib/action_view/vendor/builder/xmlbase.rb

@@ -0,0 +1,143 @@
+#!/usr/bin/env ruby
+
+require 'builder/blankslate'
+
+module Builder #:nodoc:
+
+  # Generic error for builder
+  class IllegalBlockError < RuntimeError #:nodoc:
+  end
+
+  # XmlBase is a base class for building XML builders.  See
+  # Builder::XmlMarkup and Builder::XmlEvents for examples.
+  class XmlBase < BlankSlate #:nodoc:
+
+    # Create an XML markup builder.
+    #
+    # out::     Object receiving the markup.1  +out+ must respond to
+    #           <tt><<</tt>.
+    # indent::  Number of spaces used for indentation (0 implies no
+    #           indentation and no line breaks).
+    # initial:: Level of initial indentation.
+    #
+    def initialize(indent=0, initial=0)
+      @indent = indent
+      @level  = initial
+    end
+    
+    # Create a tag named +sym+.  Other than the first argument which
+    # is the tag name, the arguements are the same as the tags
+    # implemented via <tt>method_missing</tt>.
+    def tag!(sym, *args, &block)
+      self.__send__(sym, *args, &block)
+    end
+
+    # Create XML markup based on the name of the method.  This method
+    # is never invoked directly, but is called for each markup method
+    # in the markup block.
+    def method_missing(sym, *args, &block)
+      text = nil
+      attrs = nil
+      sym = "#{sym}:#{args.shift}" if args.first.kind_of?(Symbol)
+      args.each do |arg|
+	case arg
+	when Hash
+	  attrs ||= {}
+	  attrs.merge!(arg)
+	else
+	  text ||= ''
+	  text << arg.to_s
+	end
+      end
+      if block
+	unless text.nil?
+	  raise ArgumentError, "XmlMarkup cannot mix a text argument with a block"
+	end
+	_capture_outer_self(block) if @self.nil?
+	_indent
+	_start_tag(sym, attrs)
+	_newline
+	_nested_structures(block)
+	_indent
+	_end_tag(sym)
+	_newline
+      elsif text.nil?
+	_indent
+	_start_tag(sym, attrs, true)
+	_newline
+      else
+	_indent
+	_start_tag(sym, attrs)
+	text! text
+	_end_tag(sym)
+	_newline
+      end
+      @target
+    end
+
+    # Append text to the output target.  Escape any markup.  May be
+    # used within the markup brakets as:
+    #
+    #   builder.p { br; text! "HI" }   #=>  <p><br/>HI</p>
+    def text!(text)
+      _text(_escape(text))
+    end
+    
+    # Append text to the output target without escaping any markup.
+    # May be used within the markup brakets as:
+    #
+    #   builder.p { |x| x << "<br/>HI" }   #=>  <p><br/>HI</p>
+    #
+    # This is useful when using non-builder enabled software that
+    # generates strings.  Just insert the string directly into the
+    # builder without changing the inserted markup.
+    #
+    # It is also useful for stacking builder objects.  Builders only
+    # use <tt><<</tt> to append to the target, so by supporting this
+    # method/operation builders can use oother builders as their
+    # targets.
+    def <<(text)
+      _text(text)
+    end
+    
+    # For some reason, nil? is sent to the XmlMarkup object.  If nil?
+    # is not defined and method_missing is invoked, some strange kind
+    # of recursion happens.  Since nil? won't ever be an XML tag, it
+    # is pretty safe to define it here. (Note: this is an example of
+    # cargo cult programming,
+    # cf. http://fishbowl.pastiche.org/2004/10/13/cargo_cult_programming).
+    def nil?
+      false
+    end
+
+    private
+    
+    def _escape(text)
+      text.
+	gsub(%r{&}, '&amp;').
+	gsub(%r{<}, '&lt;').
+	gsub(%r{>}, '&gt;')
+    end
+
+    def _capture_outer_self(block)
+      @self = eval("self", block)
+    end
+    
+    def _newline
+      return if @indent == 0
+      text! "\n"
+    end
+    
+    def _indent
+      return if @indent == 0 || @level == 0
+      text!(" " * (@level * @indent))
+    end
+    
+    def _nested_structures(block)
+      @level += 1
+      block.call(self)
+    ensure
+      @level -= 1
+    end
+  end
+end