actionpack 0.9.0

data/lib/action_view.rb

@@ -0,0 +1,40 @@
+#--
+# Copyright (c) 2004 David Heinemeier Hansson
+#
+# 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.
+#++
+
+begin
+  require 'rubygems'	
+  require 'builder'
+rescue LoadError
+  # RubyGems is not available, use included Builder
+  $:.unshift(File.dirname(__FILE__) + "/action_view/vendor")
+  require 'action_view/vendor/builder'
+end
+
+require 'action_view/base'
+require 'action_view/partials'
+
+ActionView::Base.class_eval do
+  include ActionView::Partials
+end
+
+ActionView::Base.load_helpers(File.dirname(__FILE__) + "/action_view/helpers/")

data/lib/action_view/base.rb

@@ -0,0 +1,253 @@
+require 'erb'
+
+module ActionView #:nodoc:
+  class ActionViewError < StandardError #:nodoc:
+  end
+
+  # Action View templates can be written in two ways. If the template file has a +.rhtml+ extension then it uses a mixture of ERb 
+  # (included in Ruby) and HTML. If the template file has a +.rxml+ extension then Jim Weirich's Builder::XmlMarkup library is used.  
+  # 
+  # = ERb
+  # 
+  # You trigger ERb by using embeddings such as <% %> and <%= %>. The difference is whether you want output or not. Consider the 
+  # following loop for names:
+  #
+  #   <b>Names of all the people</b>
+  #   <% for person in @people %>
+  #     Name: <%= person.name %><br/>
+  #   <% end %>
+  #
+  # The loop is setup in regular embedding tags (<% %>) and the name is written using the output embedding tag (<%= %>). Note that this
+  # is not just a usage suggestion. Regular output functions like print or puts won't work with ERb templates. So this would be wrong:
+  #
+  #   Hi, Mr. <% puts "Frodo" %>
+  #
+  # (If you absolutely must write from within a function, you can use the TextHelper#concat)
+  #
+  # == Using sub templates
+  #
+  # Using sub templates allows you to sidestep tedious replication and extract common display structures in shared templates. The
+  # classic example is the use of a header and footer (even though the Action Pack-way would be to use Layouts):
+  #
+  #   <%= render "shared/header" %>
+  #   Something really specific and terrific
+  #   <%= render "shared/footer" %>
+  #
+  # As you see, we use the output embeddings for the render methods. The render call itself will just return a string holding the
+  # result of the rendering. The output embedding writes it to the current template.
+  #
+  # But you don't have to restrict yourself to static includes. Templates can share variables amongst themselves by using instance
+  # variables defined in using the regular embedding tags. Like this:
+  #
+  #   <% @page_title = "A Wonderful Hello" %>
+  #   <%= render "shared/header" %>
+  #
+  # Now the header can pick up on the @page_title variable and use it for outputting a title tag:
+  #
+  #   <title><%= @page_title %></title>
+  #
+  # == Passing local variables to sub templates
+  # 
+  # You can pass local variables to sub templates by using a hash with the variable names as keys and the objects as values:
+  #
+  #   <%= render "shared/header", { "headline" => "Welcome", "person" => person } %>
+  #
+  # These can now be accessed in shared/header with:
+  #
+  #   Headline: <%= headline %>
+  #   First name: <%= person.first_name %>
+  #
+  # == Template caching
+  #
+  # The parsing of ERb templates are cached by default, but the reading of them are not. This means that the application by default
+  # will reflect changes to the templates immediatly. If you'd like to sacrifice that immediacy for the speed gain given by also
+  # caching the loading of templates (reading from the file systen), you can turn that on with 
+  # <tt>ActionView::Base.cache_template_loading = true</tt>.
+  #
+  # == Builder
+  #
+  # Builder templates are a more programatic alternative to ERb. They are especially useful for generating XML content. An +XmlMarkup+ object 
+  # named +xml+ is automatically made available to templates with a +.rxml+ extension. 
+  #
+  # Here are some basic examples:
+  #
+  #   xml.em("emphasized")                              # => <em>emphasized</em>
+  #   xml.em { xml.b("emp & bold") }                    # => <em><b>emph &amp; bold</b></em>
+  #   xml.a("A Link", "href"=>"http://onestepback.org") # => <a href="http://onestepback.org">A Link</a>
+  #   xm.target("name"=>"compile", "option"=>"fast")    # => <target option="fast" name="compile"\>
+  #                                                     # NOTE: order of attributes is not specified.
+  # 
+  # Any method with a block will be treated as an XML markup tag with nested markup in the block. For example, the following:
+  #
+  #   xml.div {
+  #     xml.h1(@person.name)
+  #     xml.p(@person.bio)
+  #   }
+  #
+  # would produce something like:
+  #
+  #   <div>
+  #     <h1>David Heinemeier Hansson</h1>
+  #     <p>A product of Danish Design during the Winter of '79...</p>
+  #   </div>
+  #
+  # A full-length RSS example actually used on Basecamp:
+  #
+  #   xml.rss("version" => "2.0", "xmlns:dc" => "http://purl.org/dc/elements/1.1/") do
+  #     xml.channel do
+  #       xml.title(@feed_title)
+  #       xml.link(@url)
+  #       xml.description "Basecamp: Recent items"
+  #       xml.language "en-us"
+  #       xml.ttl "40"
+  # 
+  #       for item in @recent_items
+  #         xml.item do
+  #           xml.title(item_title(item))
+  #           xml.description(item_description(item)) if item_description(item)
+  #           xml.pubDate(item_pubDate(item))
+  #           xml.guid(@person.firm.account.url + @recent_items.url(item))
+  #           xml.link(@person.firm.account.url + @recent_items.url(item))
+  #       
+  #           xml.tag!("dc:creator", item.author_name) if item_has_creator?(item)
+  #         end
+  #       end
+  #     end
+  #   end
+  #
+  # More builder documentation can be found at http://builder.rubyforge.org.
+  class Base
+    include ERB::Util
+    
+    attr_reader :first_render
+    attr_accessor :base_path, :assigns, :template_extension
+    attr_accessor :controller
+
+    # Turn on to cache the reading of templates from the file system. Doing so means that you have to restart the server
+    # when changing templates, but that rendering will be faster.
+    @@cache_template_loading = false
+    cattr_accessor :cache_template_loading
+
+    @@compiled_erb_templates = {}
+    @@loaded_templates = {}
+
+    def self.load_helpers(helper_dir)#:nodoc:
+      Dir.foreach(helper_dir) do |helper_file| 
+        next unless helper_file =~ /_helper.rb$/
+        require helper_dir + helper_file
+        helper_module_name = helper_file.capitalize.gsub(/_([a-z])/) { |m| $1.capitalize }[0..-4]
+
+        class_eval("include ActionView::Helpers::#{helper_module_name}") if Helpers.const_defined?(helper_module_name)
+      end
+    end
+
+    def initialize(base_path = nil, assigns_for_first_render = {}, controller = nil)#:nodoc:
+      @base_path, @assigns = base_path, assigns_for_first_render
+      @controller = controller
+    end
+
+    # Renders the template present at <tt>template_path</tt>. If <tt>use_full_path</tt> is set to true, 
+    # it's relative to the template_root, otherwise it's absolute. The hash in <tt>local_assigns</tt> 
+    # is made available as local variables.
+    def render_file(template_path, use_full_path = true, local_assigns = {})
+      @first_render      = template_path if @first_render.nil?
+      
+      if use_full_path
+        template_extension = pick_template_extension(template_path)
+        template_file_name = full_template_path(template_path, template_extension)
+      else
+        template_file_name = template_path
+        template_extension = template_path.split(".").last
+      end
+      
+      template_source = read_template_file(template_file_name)
+
+      begin
+        render_template(template_extension, template_source, local_assigns)
+      rescue Exception => e
+        if TemplateError === e
+          e.sub_template_of(template_file_name)
+          raise e
+        else
+          raise TemplateError.new(@base_path, template_file_name, @assigns, template_source, e)
+        end
+      end
+    end
+    
+    # Renders the template present at <tt>template_path</tt> (relative to the template_root). 
+    # The hash in <tt>local_assigns</tt> is made available as local variables.
+    def render(template_path, local_assigns = {})
+      render_file(template_path, true, local_assigns)
+    end
+    
+    # Renders the +template+ which is given as a string as either rhtml or rxml depending on <tt>template_extension</tt>.
+    # The hash in <tt>local_assigns</tt> is made available as local variables.
+    def render_template(template_extension, template, local_assigns = {})
+      b = binding
+      local_assigns.each { |key, value| eval "#{key} = local_assigns[\"#{key}\"]", b }
+      @assigns.each { |key, value| instance_variable_set "@#{key}", value }
+      xml = Builder::XmlMarkup.new(:indent => 2)
+      
+      send(pick_rendering_method(template_extension), template, binding)
+    end
+
+    def pick_template_extension(template_path)#:nodoc:
+      if erb_template_exists?(template_path)
+        "rhtml"
+      elsif builder_template_exists?(template_path)
+        "rxml"
+      else
+        raise ActionViewError, "No rhtml or rxml template found for #{template_path}"
+      end
+    end
+    
+    def pick_rendering_method(template_extension)#:nodoc:
+      (template_extension == "rxml" ? "rxml" : "rhtml") + "_render"
+    end
+
+    def erb_template_exists?(template_path)#:nodoc:
+      template_exists?(template_path, "rhtml")
+    end
+
+    def builder_template_exists?(template_path)#:nodoc:
+      template_exists?(template_path, "rxml")
+    end
+
+    def file_exists?(template_path)#:nodoc:
+      erb_template_exists?(template_path) || builder_template_exists?(template_path)
+    end
+
+    # Returns true is the file may be rendered implicitly.
+    def file_public?(template_path)#:nodoc:
+      template_path.split("/").last[0,1] != "_"
+    end
+
+    private
+      def full_template_path(template_path, extension)
+        "#{@base_path}/#{template_path}.#{extension}"
+      end
+
+      def template_exists?(template_path, extension)
+        FileTest.exists?(full_template_path(template_path, extension))
+      end
+
+      def read_template_file(template_path)
+        unless cache_template_loading && @@loaded_templates[template_path]
+          @@loaded_templates[template_path] = File.read(template_path)
+        end
+
+        @@loaded_templates[template_path]
+      end
+
+      def rhtml_render(template, binding)
+        @@compiled_erb_templates[template] ||= ERB.new(template)
+        @@compiled_erb_templates[template].result(binding)
+      end
+
+      def rxml_render(template, binding)
+        eval(template, binding)
+      end
+  end
+end
+
+require 'action_view/template_error'

data/lib/action_view/helpers/active_record_helper.rb

@@ -0,0 +1,171 @@
+require 'cgi'
+require File.dirname(__FILE__) + '/form_helper'
+
+module ActionView
+  class Base
+    @@field_error_proc = Proc.new{ |html_tag, instance| "<div class=\"fieldWithErrors\">#{html_tag}</div>" }
+    cattr_accessor :field_error_proc
+  end
+
+  module Helpers
+    # The Active Record Helper makes it easier to create forms for records kept in instance variables. The most far-reaching is the form
+    # method that creates a complete form for all the basic content types of the record (not associations or aggregations, though). This
+    # is a great of making the record quickly available for editing, but likely to prove lacklusters for a complicated real-world form.
+    # In that case, it's better to use the input method and the specialized form methods in link:classes/ActionView/Helpers/FormHelper.html
+    module ActiveRecordHelper
+      # Returns a default input tag for the type of object returned by the method. Example
+      # (title is a VARCHAR column and holds "Hello World"):
+      #   input("post", "title") => 
+      #     <input id="post_title" name="post[title]" size="30" type="text" value="Hello World" />
+      def input(record_name, method)
+        InstanceTag.new(record_name, method, self).to_tag
+      end
+
+      # Returns an entire form with input tags and everything for a specified Active Record object. Example
+      # (post is a new record that has a title using VARCHAR and a body using TEXT):
+      #   form("post") =>
+      #     <form action='create' method='POST'>
+      #       <p>
+      #         <b>Title</b><br />
+      #         <input id="post_title" name="post[title]" size="30" type="text" value="Hello World" />
+      #       </p>
+      #       <p>
+      #         <b>Body</b><br />
+      #         <textarea cols="40" id="post_body" name="post[body]" rows="20" wrap="virtual">
+      #           Back to the hill and over it again!
+      #         </textarea>
+      #       </p>
+      #       <input type='submit' value='Create' />
+      #     </form>
+      #
+      # It's possible to specialize the form builder by using a different action name and by supplying another
+      # block renderer. Example (entry is a new record that has a message attribute using VARCHAR):
+      #
+      #   form("entry", :action => "sign", :input_block => 
+      #        Proc.new { |record, column| "#{column.human_name}: #{input(record, column.name)}<br />" }) =>
+      #
+      #     <form action='sign' method='POST'>
+      #       Message:
+      #       <input id="post_title" name="post[title]" size="30" type="text" value="Hello World" /><br />
+      #       <input type='submit' value='Sign' />
+      #     </form>
+      def form(record_name, options = {})
+        record   = instance_eval("@#{record_name}")
+        action   = options[:action] || (record.new_record? ? "create" : "update")
+        id_field = record.new_record? ? "" : InstanceTag.new(record_name, "id", self).to_input_field_tag("hidden")
+
+        "<form action='#{action}' method='POST'>" +
+        id_field + all_input_tags(record, record_name, options) +
+        "<input type='submit' value='#{action.gsub(/[^A-Za-z]/, "").capitalize}' />" +
+        "</form>"
+      end
+
+      # Returns a string containing the error message attached to the +method+ on the +object+, if one exists.
+      # This error message is wrapped in a DIV tag, which can be specialized to include both a +prepend_text+ and +append_text+
+      # to properly introduce the error and a +css_class+ to style it accordingly. Examples (post has an error message 
+      # "can't be empty" on the title attribute):
+      #
+      #   <%= error_message_on "post", "title" %> =>
+      #     <div class="formError">can't be empty</div>
+      #
+      #   <%= error_message_on "post", "title", "Title simply ", " (or it won't work)", "inputError" %> =>
+      #     <div class="inputError">Title simply can't be empty (or it won't work)</div>
+      def error_message_on(object, method, prepend_text = "", append_text = "", css_class = "formError")
+        if instance_eval("@#{object}").errors.on(method)
+          "<div class=\"#{css_class}\">#{prepend_text + instance_eval("@#{object}").errors.on(method) + append_text}</div>"
+        end
+      end
+      
+      def error_messages_for(object_name)
+        object = instance_eval("@#{object_name}")
+        unless object.errors.empty?
+          "<div id=\"errorExplanation\">" +
+          "<h2>#{object.errors.count} error#{"s" unless object.errors.count == 1} prohibited this #{object_name.gsub("_", " ")} from being saved</h2>" +
+          "<p>There were problems with the following fields (marked in red below):</p>" +
+          "<ul>#{object.errors.full_messages.collect { |msg| "<li>#{msg}</li>"}}</ul>" +
+          "</div>"
+        end
+      end
+      
+      private
+        def all_input_tags(record, record_name, options)
+          input_block = options[:input_block] || default_input_block
+          record.class.content_columns.collect{ |column| input_block.call(record_name, column) }.join("\n")
+        end
+
+        def default_input_block
+          Proc.new { |record, column| "<p><b>#{column.human_name}</b><br />#{input(record, column.name)}</p>" }
+        end        
+    end
+
+    class InstanceTag #:nodoc:
+      def to_tag(options = {})
+        case column_type
+          when :string
+            field_type = @method_name.include?("password") ? "password" : "text"
+            to_input_field_tag(field_type, options)
+          when :text
+            to_text_area_tag(options)
+          when :integer, :float
+            to_input_field_tag("text", options)
+          when :date
+            to_date_select_tag(options)
+          when :datetime
+            to_datetime_select_tag(options)
+          when :boolean
+            to_boolean_select_tag(options)
+        end
+      end
+
+      alias_method :tag_without_error_wrapping, :tag
+
+      def tag(name, options)
+        if object.respond_to?("errors") && object.errors.respond_to?("on")
+          error_wrapping(tag_without_error_wrapping(name, options), object.errors.on(@method_name))
+        else
+          tag_without_error_wrapping(name, options)
+        end
+      end
+
+      alias_method :content_tag_without_error_wrapping, :content_tag
+
+      def content_tag(name, value, options)
+        if object.respond_to?("errors") && object.errors.respond_to?("on")
+          error_wrapping(content_tag_without_error_wrapping(name, value, options), object.errors.on(@method_name))
+        else
+          content_tag_without_error_wrapping(name, value, options)
+        end
+      end
+
+      alias_method :to_date_select_tag_without_error_wrapping, :to_date_select_tag
+      def to_date_select_tag(options = {})
+        if object.respond_to?("errors") && object.errors.respond_to?("on")
+          error_wrapping(to_date_select_tag_without_error_wrapping(options), object.errors.on(@method_name))
+        else
+          to_date_select_tag_without_error_wrapping(options)
+        end
+      end
+
+      alias_method :to_datetime_select_tag_without_error_wrapping, :to_datetime_select_tag
+      def to_datetime_select_tag(options = {})
+        if object.respond_to?("errors") && object.errors.respond_to?("on")
+            error_wrapping(to_datetime_select_tag_without_error_wrapping(options), object.errors.on(@method_name))
+          else
+            to_datetime_select_tag_without_error_wrapping(options)
+        end
+      end
+
+      def error_wrapping(html_tag, has_error)
+        has_error ? Base.field_error_proc.call(html_tag, self) : html_tag
+      end
+
+      def error_message
+        object.errors.on(@method_name)
+      end
+
+      def column_type
+        object.send("column_for_attribute", @method_name).type
+      end
+    end
+  end
+end