erector 0.7.0 → 0.7.1

data/README.txt

@@ -13,6 +13,8 @@ modular decomposition, encapsulation) in views. See the rdoc for the
 Erector::Widget class to learn how to make your own widgets, and visit the
 project site at http://erector.rubyforge.org for more documentation.
 
+No, seriously, we've got hella docs at http://erector.rubyforge.org
+
 == SYNOPSIS
 
     require 'erector'
@@ -25,7 +27,7 @@ project site at http://erector.rubyforge.org for more documentation.
           end
           body do
             text "Hello, "
-            b target, :class => 'big'
+            b @target, :class => 'big'
             text "!"
           end
         end

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :major: 0
 :minor: 7
-:patch: 0
+:patch: 1

data/lib/erector.rb

@@ -6,6 +6,7 @@ require "active_support/inflector"
 require "active_support/inflections"
 require "#{dir}/erector/extensions/object"
 require "#{dir}/erector/raw_string"
+require "#{dir}/erector/externals"
 require "#{dir}/erector/widget"
 require "#{dir}/erector/inline"
 require "#{dir}/erector/unicode"

data/lib/erector/externals.rb

@@ -0,0 +1,29 @@
+module Erector
+  module Externals
+    def externals(type, klass = nil)
+      type = type.to_sym
+      assure_externals_declared(type, klass)
+      x = @@externals[type].dup
+      if klass
+        x.select{|value| @@externals[klass].include?(value)}
+      else
+        x
+      end
+    end
+
+    def assure_externals_declared(type, klass)
+      @@externals ||= {}
+      @@externals[type] ||= []
+      @@externals[klass] ||= [] if klass
+    end
+
+    def external(type, value)
+      type = type.to_sym
+      klass = self # since it's a class method, self should be the class itself
+      assure_externals_declared(type, klass)
+      @@externals[type] << value unless @@externals[type].include?(value)
+      @@externals[klass] << value unless @@externals[klass].include?(value)
+    end
+  end
+
+end

data/lib/erector/rails.rb

@@ -1,7 +1,10 @@
 dir = File.dirname(__FILE__)
 require "action_controller"
 require "#{dir}/rails/rails_version"
+require "#{dir}/rails/rails_form_builder"
 require "#{dir}/rails/extensions/rails_widget"
 require "#{dir}/rails/extensions/action_controller"
 require "#{dir}/rails/extensions/action_view"
-require "#{dir}/rails/template_handlers/action_view_template_handler"
+require "#{dir}/rails/extensions/rails_widget/rails_helpers"
+require "#{dir}/rails/template_handlers/rb_handler"
+require "#{dir}/rails/template_handlers/ert_handler"

data/lib/erector/rails/extensions/action_controller.rb

@@ -12,7 +12,7 @@ ActionController::Base.class_eval do
       end
     end
     response.template.send(:_evaluate_assigns_and_ivars)
-    render :inline => "<% @__widget_class.new(@__widget_assigns).to_s(:output => output_buffer, :helpers => self) %>"
+    render :inline => "<% @__widget_class.new(@__widget_assigns.merge(:parent => self)).to_s %>"
   end
 
   def render_with_erector_widget(*options, &block)

data/lib/erector/rails/extensions/rails_widget.rb

@@ -8,40 +8,37 @@ module Erector
       process_output_buffer || @output
     end
 
-    def capture_with_helpers(&block)
-      helpers ? helpers.capture(&block) : capture_without_helpers(&block)
+    def capture_with_parent(&block)
+      parent ? parent.capture(&block) : capture_without_parent(&block)
     end
 
-    alias_method_chain :capture, :helpers
+    alias_method_chain :capture, :parent
 
-    # This is here to force #helpers.capture to return the output
+    # This is here to force #parent.capture to return the output
     def __in_erb_template; end
 
     private
 
     def process_output_buffer
-      if helpers.respond_to?(:output_buffer)
-        buffer = helpers.output_buffer
-        buffer.is_a?(String) ? buffer : handle_rjs_buffer
+      if parent.respond_to?(:output_buffer)
+        parent.output_buffer.is_a?(String) ? parent.output_buffer : handle_rjs_buffer
       else
         nil
       end
     end
 
     def handle_rjs_buffer
-      returning buffer = helpers.output_buffer.dup.to_s do
-        helpers.output_buffer.clear
-        helpers.with_output_buffer(buffer) do
-          buffer << helpers.output_buffer.to_s
+      returning buffer = parent.output_buffer.dup.to_s do
+        parent.output_buffer.clear
+        parent.with_output_buffer(buffer) do
+          buffer << parent.output_buffer.to_s
         end
       end
     end
   end
-  
+
   class InlineRailsWidget < RailsWidget
     include Inline
   end
-  
-end
 
-require "#{File.dirname(__FILE__)}/rails_widget/helpers"
+end

data/lib/erector/rails/extensions/rails_widget/rails_helpers.rb

@@ -0,0 +1,136 @@
+module Erector
+  class RailsWidget < Widget
+    module RailsHelpers
+      include ActionController::UrlWriter
+
+      # parent returning raw text whose first parameter is HTML escaped
+      ESCAPED_HELPERS = [
+        :link_to,
+        :link_to_remote,
+        :mail_to,
+        :button_to,
+        :submit_tag,
+      ]
+      ESCAPED_HELPERS.each do |method_name|
+        start_line = __LINE__ + 2
+        method_def =<<-METHOD_DEF
+          def #{method_name}(link_text, *args, &block)
+            rawtext(parent.#{method_name}(h(link_text), *args, &block))
+          end
+        METHOD_DEF
+        eval(method_def, binding, __FILE__, start_line)
+      end
+
+      # return text, take block
+      RAW_HELPERS = [
+        :link_to_function,
+        :text_field_tag,
+        :password_field_tag,
+        :check_box_tag,
+        :error_messages_for,
+        :submit_tag,
+        :file_field,
+        :image_tag,
+        :javascript_include_tag,
+        :stylesheet_link_tag,
+        :sortable_element,
+        :sortable_element_js,
+        :text_field_with_auto_complete
+      ]
+      RAW_HELPERS.each do |method_name|
+        start_line = __LINE__ + 2
+        method_def =<<-METHOD_DEF
+          def #{method_name}(*args, &block)
+            rawtext parent.#{method_name}(*args, &block)
+          end
+        METHOD_DEF
+        eval(method_def, binding, __FILE__, start_line)
+      end
+
+      CAPTURED_HELPERS_WITHOUT_CONCAT = [
+        :render
+      ]
+      CAPTURED_HELPERS_WITHOUT_CONCAT.each do |method_name|
+        start_line = __LINE__ + 2
+        method_def =<<-METHOD_DEF
+          def #{method_name}(*args, &block)
+            captured = parent.capture do
+              parent.concat(parent.#{method_name}(*args, &block))
+              parent.output_buffer.to_s
+            end
+            rawtext(captured)
+          end
+        METHOD_DEF
+        eval(method_def, binding, __FILE__, start_line)
+      end
+
+      CAPTURED_HELPERS_WITH_CONCAT = [
+        :form_tag
+      ]
+      CAPTURED_HELPERS_WITH_CONCAT.each do |method_name|
+        start_line = __LINE__ + 2
+        method_def =<<-METHOD_DEF
+          def #{method_name}(*args, &block)
+            captured = parent.capture do
+              parent.#{method_name}(*args, &block)
+              parent.output_buffer.to_s
+            end
+            rawtext(captured)
+          end
+        METHOD_DEF
+        eval(method_def, binding, __FILE__, start_line)
+      end
+
+      def form_for(record_or_name_or_array, *args, &proc)
+        options = args.extract_options!
+        options[:builder] ||= ::Erector::RailsFormBuilder
+        args.push(options)
+        parent.form_for(record_or_name_or_array, *args, &proc)
+      end
+
+      def fields_for(record_or_name_or_array, *args, &proc)
+        options = args.extract_options!
+        options[:builder] ||= ::Erector::RailsFormBuilder
+        args.push(options)
+        parent.fields_for(record_or_name_or_array, *args, &proc)
+      end
+
+      def javascript_include_merged(key)
+        parent.javascript_include_merged(key)
+      end
+
+      def stylesheet_link_merged(key)
+        parent.stylesheet_link_merged(key)
+      end
+
+      def flash
+        parent.controller.send(:flash)
+      end
+
+      def session
+        parent.controller.session
+      end
+
+      def controller
+        parent.controller
+      end
+
+      def cycle(*args)
+        parent.cycle(*args)
+      end
+
+      def simple_format(string)
+        p raw(string.to_s.html_escape.gsub(/\r\n?/, "\n").gsub(/\n/, "<br/>\n"))
+      end
+
+      def time_ago_in_words(*args)
+        parent.time_ago_in_words(*args)
+      end
+
+      def pluralize(*args)
+        parent.pluralize(*args)
+      end
+    end
+    include RailsHelpers
+  end
+end

data/lib/erector/rails/rails_form_builder.rb

@@ -0,0 +1,20 @@
+module Erector
+  class RailsFormBuilder
+    attr_reader :parent, :template
+
+    def initialize(object_name, object, template, options, proc)
+      @template = template
+      @parent = ActionView::Helpers::FormBuilder.new(object_name, object, template, options, proc)
+    end
+
+    def method_missing(method_name, *args, &block)
+      if parent.respond_to?(method_name)
+        return_value = parent.send(method_name, *args, &block)
+        template.concat(return_value) if return_value.is_a?(String)
+        return_value
+      else
+        super
+      end
+    end
+  end
+end

data/lib/erector/rails/rails_version.rb

@@ -1,6 +1,6 @@
 module Erector
   module Rails
-    RAILS_VERSION = "2.3.2"
-    RAILS_VERSION_TAG = "v2.3.2"
+    RAILS_VERSION = "2.3.4"
+    RAILS_VERSION_TAG = "v2.3.4"
   end
 end

data/lib/erector/rails/template_handlers/ert_handler.rb

@@ -0,0 +1,32 @@
+module ActionView #:nodoc:
+  module TemplateHandlers #:nodoc:
+    class ErtTemplate < TemplateHandler
+      include Compilable
+      def self.line_offset
+        2
+      end
+
+      ActionView::Template.instance_eval do
+        register_template_handler :ert, ActionView::TemplateHandlers::ErtTemplate
+      end
+
+      def compile(template)
+        [
+          "extend ::Erector::Mixin",
+          "@output_buffer = ''",
+          "memoized_instance_variables = instance_variables.inject({}) do |all, instance_variable|",
+          "  all[instance_variable] = instance_variable_get(instance_variable)",
+          "  all",
+          "end",
+          "r =::Erector::RailsWidget.inline do",
+          "  memoized_instance_variables.each do |instance_variable, value|",
+          "    instance_variable_set(instance_variable, value)",
+          "  end",
+          template.source,
+          "end",
+          "r.to_s",
+        ].join("; ")
+      end
+    end
+  end
+end

data/lib/erector/rails/template_handlers/{action_view_template_handler.rb → rb_handler.rb}

@@ -1,13 +1,13 @@
 module ActionView #:nodoc:
   module TemplateHandlers #:nodoc:
-    class Erector < TemplateHandler
+    class RbHandler < TemplateHandler
       include Compilable
       def self.line_offset
         2
       end
 
       ActionView::Template.instance_eval do
-        register_template_handler :rb, ActionView::TemplateHandlers::Erector
+        register_template_handler :rb, ActionView::TemplateHandlers::RbHandler
       end
 
       def compile(template)

data/lib/erector/widget.rb

@@ -33,6 +33,8 @@ module Erector
   # like a normal method and leaves it up to the caller to emit that string if
   # it wants.
   class Widget
+    extend Erector::Externals # 'extend'ing since they're class methods, not instance methods
+    
     class << self
       def all_tags
         Erector::Widget.full_tags + Erector::Widget.empty_tags
@@ -84,6 +86,7 @@ module Erector
       def after_initialize_parts
         @after_initialize_parts ||= []
       end
+      
     end
 
     # Class method by which widget classes can declare that they need certain
@@ -153,21 +156,20 @@ module Erector
 
     SPACES_PER_INDENT = 2
 
-    RESERVED_INSTANCE_VARS = [:helpers, :assigns, :block, :parent, :output, :prettyprint, :indentation, :at_start_of_line]
+    RESERVED_INSTANCE_VARS = [:helpers, :assigns, :block, :output, :prettyprint, :indentation, :at_start_of_line]
 
     attr_reader *RESERVED_INSTANCE_VARS
+    attr_reader :parent
     
     def initialize(assigns={}, &block)
       unless assigns.is_a? Hash
         raise "Erector's API has changed. Now you should pass only an options hash into Widget.new; the rest come in via to_s, or by using #widget."
       end
-      if (respond_to? :render) &&
-        !self.method(:render).to_s.include?("(RailsWidget)")
-        raise "Erector's API has changed. You should rename #{self.class}#render to #content."
-      end
       @assigns = assigns
-      assign_locals(assigns)
-      @parent = block ? eval("self", block.binding) : nil
+      assign_instance_variables(assigns)
+      unless @parent
+        @parent = block ? eval("self", block.binding) : nil
+      end
       @block = block
       self.class.after_initialize self
     end
@@ -197,14 +199,14 @@ module Erector
     end
 
     public
-    def assign_locals(local_assigns)
+    def assign_instance_variables (instance_variables)
       needed = self.class.get_needs.map{|need| need.is_a?(Hash) ? need.keys : need}.flatten
       assigned = []
-      local_assigns.each do |name, value|
+      instance_variables.each do |name, value|
         unless needed.empty? || needed.include?(name)
           raise "Unknown parameter '#{name}'. #{self.class.name} only accepts #{needed.join(', ')}"
         end
-        assign_local(name, value)
+        assign_instance_variable(name, value)
         assigned << name
       end
 
@@ -212,7 +214,7 @@ module Erector
       self.class.get_needs.select{|var| var.is_a? Hash}.each do |hash|
         hash.each_pair do |name, value|
           unless assigned.include?(name)
-            assign_local(name, value)
+            assign_instance_variable(name, value)
             assigned << name
           end
         end
@@ -224,9 +226,11 @@ module Erector
       end
     end
     
-    def assign_local(name, value)
+    def assign_instance_variable (name, value)
       raise ArgumentError, "Sorry, #{name} is a reserved variable name for Erector. Please choose a different name." if RESERVED_INSTANCE_VARS.include?(name)
-      instance_variable_set("@#{name}", value)
+      name = name.to_s
+      ivar_name = (name[0..0] == '@' ? name : "@#{name}")
+      instance_variable_set(ivar_name, value)
     end
     
     # Render (like to_s) but adding newlines and indentation.
@@ -279,14 +283,12 @@ module Erector
       end
     end
     
-    alias_method :inspect, :to_s
-    
     # Template method which must be overridden by all widget subclasses.
     # Inside this method you call the magic #element methods which emit HTML
     # and text to the output string. If you call "super" (or don't override
     # +content+) then your widget will render any block that was passed into
     # its constructor. If you want this block to have access to Erector methods
-    # then see Erector::Inline#content.
+    # then see Erector::Inline#content or Erector#inline.
     def content
       if @block
         @block.call
@@ -465,6 +467,15 @@ module Erector
       output << "<?xml#{format_sorted(sort_for_xml_declaration(attributes))}?>"
     end
 
+    # Emits an HTML comment, which looks like this: &lt;!--foo--&gt;
+    # see http://www.w3.org/TR/html4/intro/sgmltut.html#h-3.2.4
+    # Since "Authors should avoid putting two or more adjacent hyphens inside comments,"
+    # we emit a warning if you do that.
+    def comment(text)
+      puts "Warning: Authors should avoid putting two or more adjacent hyphens inside comments." if text =~ /--/
+      output << "<!--#{text}-->"
+    end
+
     # Creates a whole new output string, executes the block, then converts the
     # output string to a string and emits it as raw text. If at all possible
     # you should avoid this method since it hurts performance, and use
@@ -562,6 +573,21 @@ module Erector
         false
       end
     end    
+
+    # emits a jQuery script that is to be run on document ready
+    def jquery(txt)
+      javascript do
+        jquery_ready txt
+      end
+    end
+
+    protected
+    def jquery_ready(txt)
+      rawtext "\n"
+      rawtext "$(document).ready(function(){\n"
+      rawtext txt
+      rawtext "\n});"
+    end
     
 ### internal utility methods