RubyGems - erector - Versions diffs - 0.2.83 → 0.3.105 - Mend

erector 0.2.83 → 0.3.105

Files changed (22) hide show

data/README.txt +17 -219
data/lib/erector.rb +2 -1
data/lib/erector/erect.rb +3 -1
data/lib/erector/extensions/action_controller.rb +21 -19
data/lib/erector/extensions/action_view_template_handler.rb +37 -12
data/lib/erector/extensions/object.rb +14 -1
data/lib/erector/helpers.rb +57 -14
data/lib/erector/html_parts.rb +2 -0
data/lib/erector/indenting.rb +1 -1
data/lib/erector/raw_string.rb +8 -0
data/lib/erector/widget.rb +225 -109
data/lib/erector/widgets/table.rb +1 -1
data/spec/erect/erect_spec.rb +4 -1
data/spec/erect/rhtml_parser_spec.rb +6 -6
data/spec/erector/extensions/template_handler_spec.rb +29 -0
data/spec/erector/rails_helpers_spec.rb +147 -0
data/spec/erector/widget_spec.rb +71 -0
data/spec/rails/standard_helpers_spec.rb +105 -0
data/spec/rails/view_spec.rb +33 -0
data/spec/spec_helper.rb +8 -0
data/test/rails_root/app/views/template_handler_spec/test_page.rb +8 -0
metadata +11 -5

data/README.txt CHANGED Viewed

@@ -3,19 +3,14 @@
 * http://erector.rubyforge.org
 * mailto:alex@pivotallabs.com
 == DESCRIPTION
 Erector is a Builder-like view framework, inspired by Markaby but overcoming
 some of its flaws. In Erector all views are objects, not template files,
 which allows the full power of object-oriented programming (inheritance,
-modular decomposition, encapsulation) in views.
-== FEATURES/PROBLEMS:
-While Erector is in use on several projects, it is still at a relatively
-early stage.  In particular, not all features are documented (although
-the most important ones are).
+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.
 == SYNOPSIS
@@ -23,16 +18,26 @@ the most important ones are).
     class Hello < Erector::Widget
       def render
-        div do
-          text "Hello!"
+        html do
+          head do
+            title "Hello"
+          end
+          body do
+            text "Hello, "
+            b "world!", :class => 'big'
+          end
         end
       end
     end
+    Hello.new.to_s
+    => "<html><head><title>Hello</title></head><body>Hello, <b class=\"big\">world!</b></body></html>"
 == REQUIREMENTS
-The gem depends on hoe and rake, although this is just for building
-erector (those who just use erector won't need these).
+The gem depends on rake and treetop, although this is just for using the "erect" tool,
+so deployed applications won't need these. Currently it also requires rails, although
+we plan to separate the rails-dependent code so you can use Erector cleanly in a non-Rails app.
 == INSTALL
@@ -73,210 +78,3 @@ 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.
-== MOTIVATION
-Why use Erector? This section will soon become a real essay or blog post,
-but briefly:
-* Markaby-style DOM Domain language
-* Your views are real classes, written in a real language, allowing
-  * Functional decomposition
-  * Inheritance
-  * Composition, not partials
-  * Well-defined semantics for variables, loops, blocks
-  * Dependency injection via constructor params
-* As little magic as possible (e.g. no automagic copying of "assigns" variable from your controller)
-* yield works again (Markaby broke it)
-* Very testable
-* form_for ERB code is craaaaazy (not to mention the quagmire of options vs. htmloptions)
-* Output is streamed, improving performance over string copy
-== USER DOCUMENTATION
-The basic way to construct some HTML/XML with erector is to
-subclass Erector::Widget and implement a render method:
-  class Hello < Erector::Widget
-    def render
-      html do
-        head do
-          title "Hello"
-        end
-        body do
-          text "Hello, "
-          b "world!"
-        end
-      end
-    end
-  end
-  Hello.new.to_s
-  #=> <html><head><title>Hello</title></head><body>Hello, <b>world!</b></body></html>
-Here are the basics:
-  element('foo')           # <foo></foo>
-  empty_element('foo')     # <foo />
-  html                     # <html></html> (likewise for other common html tags)
-  b "foo"                  # <b>foo</b>
-  text 'foo'               # foo
-  text '&<>'               # &amp;&lt;&gt; (what you generally want, especially
-                           # if the text came from the user or a database)
-  text raw('&<>')          # &<> (back door for raw html)
-  rawtext('&<>')           # &<> (alias for text(raw()))
-  html { text foo }        # <html>foo</html>
-  html "foo"               # <html>foo</html>
-  html foo                 # <html>bar</html> (if the method foo returns the string "bar")
-  a(:href => 'foo.html')   # <a href="foo.html"></a>
-  a(:href => 'q?a&b')      # <a href="q?a&amp;b"></a>  (quotes as for text)
-  a(:href => raw('&amp;')) # <a href="&amp;"></a>
-  text nbsp("Save Doc")    # Save&#160;Doc (turns spaces into non-breaking spaces)
-  instruct                 # <?xml version="1.0" encoding="UTF-8"?>
-TODO: document more obscure features like capture, Table, :class => ['one', 'two']
-=== Using Erector from Ruby on Rails
-Your views are just ruby classes.  Your controller instantiates the relevant view and calls render.
-For example:
-app/controllers/welcome_controller.rb:
-  class WelcomeController < ApplicationController
-    def index
-      render :template => 'welcome/show'
-    end
-  end
-app/views/welcome/show.rb:
-  class Views::Welcome::Show < Erector::Widget
-    def render
-      html do
-        head do
-          title "Welcome page"
-        end
-        body do
-          p "Hello, world"
-        end
-      end
-    end
-  end
-For Rails to find these .rb files during render, you must first either copy the erector source to
-vendor/plugins/erector, or add `require 'erector'` to config/environment.rb. You also should delete (or rename)
-any other view files with the same base name that might be getting in the way.
-=== Erect
-To make Rails integration as smooth as possible, we've written a little tool that will help you
-erect your existing Rails app. The "erect" tool will convert HTML or HTML/ERB into an Erector class.
-It ships as part of the Erector gem, so to try it out, install the gem, then run
-    erect app/views/foos/*.html.erb
-or just
-    erect app/views
-and then delete the original files when you're satisfied.
-Here's a little command-line howto for erecting a scaffold Rails app:
-    rails foo
-    cd foo
-    script/generate scaffold post title:string body:text published:boolean
-    erect app/views/posts/*.erb
-    mate app/views/posts
-    sleep 30 # this should be enough time for you to stop drooling
-    rm app/views/posts/*.erb
-    (echo ""; echo "require 'erector'") >> config/environment.rb
-    rake db:migrate
-    script/server
-    open http://localhost:3000/posts
-=== Layout Inheritance
-Erector replaces the typical Rails layout mechanism with a more natural construct, the use of inheritance. Want a common
-layout? Just implement a layout superclass and inherit from it. Implement render in the superclass and implement template
-methods in its subclasses. There's one trick you'll need to use this layout for non-erector templates. Here's an example.
-`application.rb` - The Erector layout superclass
-    class Views::Layouts::Application < Erector::Widget
-      attr_accessor :content
-      def render
-        html do
-          head { } # head content here
-          # body content here
-          body do
-            text content
-          end
-        end
-      end
-    end
-`application.mab` - The markaby template (adjust for other appropriately templating technologies)
-    widget = Views::Layouts::Application.new(self)
-    widget.content = content_for_layout
-    self << widget.to_s
-Here the abstract layout widget is used in a concrete fashion by the template-based layout. Normally, the `content` method
-would be implemented by subclassing widgets, but the layout template sets it directly and then calls to_s on the layout widget.
-This allows the same layout to be shared in a backward compatible way.
-=== Other ways to call erector
-Instead of subclassing Erector::Widget and implementing a render
-method, you can pass a block to Erector::Widget.new.  For example:
-  html = Erector::Widget.new do
-    p "Hello, world!"
-  end
-  html.to_s          #=> <p>Hello, world!</p>
-This lets you define mini-widgets on the fly.
-== DEVELOPER NOTES
-* Check out project from rubyforge:
-  svn co svn+ssh://developername@rubyforge.org/var/svn/erector/trunk erector
-* Install gems:
-  sudo gem install rake rails rspec rubyforge hpricot treetop
-* Run specs:
-  rake
-* Check out the available rake tasks:
-  rake -T
-=== VERSIONING POLICY
-* Versions are of the form major.minor.tiny
-* Tiny revisions fix bugs or documentation
-* Tiny revisions are roughly equal to the svn revision number when they were made
-* Minor revisions add API calls, or change behavior
-* Minor revisions may also remove API calls, but these must be clearly announced in History.txt, with instructions on how to migrate
-* Major revisions are about marketing more than technical needs. We will stay in major version 0 until we're happy taking the "alpha" label off it. And if we ever do a major overhaul of the API, especially one that breaks backwards compatibility, we will probably want to increment the major version.
-* We will not be shy about incrementing version numbers -- if we end up going to version 0.943.67454 then so be it.
-* Developers should attempt to add lines in History.txt to reflect their checkins. These should reflect feature-level changes, not just one line per checkin. The top section of History.txt is used as the Release Notes by the "rake publish" task and will appear on the RubyForge file page.
-* Someone making a release must fill in the version number in History.txt as well as in Rakefile. Note that "rake release" requires a "VERSION=1.2.3" parameter to confirm you're releasing the version you intend.
-* As soon as a release is made and published, the publisher should go into History.txt and make a new section. Since we won't yet know what the next version will be called, the new section will be noted by a single "===" at the top of the file.

data/lib/erector.rb CHANGED Viewed

@@ -5,11 +5,12 @@ require "erector/extensions/action_view_template_handler"
 require "erector/extensions/object"
 require "erector/helpers"
 require "erector/html_parts"
+require "erector/raw_string"
 require "erector/widget"
 require "erector/widgets"
 ##
 # Erector view framework
 module Erector
-  VERSION = "0.2.83"
+  VERSION = "0.3.105"
 end

data/lib/erector/erect.rb CHANGED Viewed

@@ -90,6 +90,7 @@ module Erector
           say " --> #{e.filename}\n"
         rescue => e
           puts e
+          puts e.backtrace.join("\n\t")
           puts
         end
       end
@@ -109,6 +110,7 @@ module Erector
           if widget_class < Erector::Widget
             widget = widget_class.new
+            #todo: skip if it's missing a no-arg constructor
             dir = output_dir || File.dirname(file)
             FileUtils.mkdir_p(dir)
             output_file = "#{dir}/#{filename}.html"
@@ -121,7 +123,7 @@ module Erector
           end
         rescue => e
           puts e
-          puts
+          puts e.backtrace.join("\n\t")
         end
       end
     end

data/lib/erector/extensions/action_controller.rb CHANGED Viewed

@@ -1,22 +1,24 @@
-class ActionController::Base
-  def render_widget(widget_class, assigns=@assigns)
-    render :text => render_widget_to_string(widget_class, assigns)
-  end
+module ActionController #:nodoc:
+  class Base
+    def render_widget(widget_class, assigns=@assigns)
+      render :text => render_widget_to_string(widget_class, assigns)
+    end
-  def render_widget_to_string(widget_class, assigns = @assigns)
-    add_variables_to_assigns
-    @rendered_widget = widget_class.new(@template, assigns.merge(:params => params))
-    @rendered_widget.to_s
-  end
-  def render_with_erector_widget(*options, &block)
-    if options.first.is_a?(Hash) && widget = options.first.delete(:widget)
-      render_widget widget, *options, &block
-    else
-      render_without_erector_widget *options, &block
+    def render_widget_to_string(widget_class, assigns = @assigns)
+      add_variables_to_assigns
+      @rendered_widget = widget_class.new(@template, assigns.merge(:params => params))
+      @rendered_widget.to_s
     end
-  end
-  alias_method_chain :render, :erector_widget
-  attr_reader :rendered_widget
-end
+    def render_with_erector_widget(*options, &block)
+      if options.first.is_a?(Hash) && widget = options.first.delete(:widget)
+        render_widget widget, *options, &block
+      else
+        render_without_erector_widget *options, &block
+      end
+    end
+    alias_method_chain :render, :erector_widget
+    attr_reader :rendered_widget
+  end
+end

data/lib/erector/extensions/action_view_template_handler.rb CHANGED Viewed

@@ -1,32 +1,57 @@
-module ActionView
-  module TemplateHandlers
+module ActionView #:nodoc:
+  module TemplateHandlers #:nodoc:
     class Erector
       def initialize(view)
         @view = view
       end
       def render(template, local_assigns)
-        banana = @view.first_render
-        paths = banana.split('/')
-        dot_rb = /\.rb$/
-        file_path = "#{RAILS_ROOT}/app/views/#{banana}.rb"
-        if File.exists?(file_path)
-          require_dependency file_path
+        if template =~ /class ([\w:_]+)/
+          classname_from_template = $1
+          template_path = Inflector::underscore(classname_from_template)
         else
-          partial_file_path = file_path.gsub(/\/([^\/]*)$/, '/_\1')
-          if File.exists?(partial_file_path)
-            require_dependency partial_file_path
+          template_path = @view.first_render
+        end
+        paths = template_path.split('/')
+        if paths.first == 'views'
+          paths.shift
+          template_path = paths.join('/')
+        end
+        found = false
+        @view.view_paths.each_with_index do |view_path, i|
+          full_path = "#{view_path}/#{template_path}.rb"
+          if File.exists?(full_path)
+            require_dependency full_path
           else
-            return
+            partial_file_path = full_path.gsub(/\/([^\/]*)$/, '/_\1')
+            if File.exists?(partial_file_path)
+              require_dependency partial_file_path
+              found = true
+              break
+            end
           end
         end
+        return unless found
+        dot_rb = /\.rb$/
         widget_class = paths.inject(Views) do |current_module, node|
           current_module.const_get(node.gsub(dot_rb, '').camelize)
         end
         rendered_widget = widget_class.new(@view, @view.assigns)
+        assign_locals(rendered_widget, local_assigns)
         rendered_widget.to_s
       end
+    private
+      # TODO: move into widget
+      def assign_locals(widget, local_assigns)
+        widget.assign_locals(local_assigns)
+      end
     end
   end
 end

data/lib/erector/extensions/object.rb CHANGED Viewed

@@ -2,4 +2,17 @@ class Object
   def metaclass
     class << self; self; end
   end
-end
+  def html_escape
+    return CGI.escapeHTML(to_s)
+  end
+  def html_unescape
+    CGI.unescapeHTML(to_s)
+  end
+  # OMGWTF :-)
+  def escape_single_quotes
+    self.gsub(/[']/, '\\\\\'')
+  end
+end

data/lib/erector/helpers.rb CHANGED Viewed

@@ -1,41 +1,80 @@
 module Erector
+  # Wrappers or replacements for the Rails helpers that are available from Rails views
   module Helpers
+    # helpers returning raw text
     [
         :image_tag,
         :javascript_include_tag,
+        :define_javascript_functions,
         :stylesheet_link_tag,
         :sortable_element,
-        :sortable_element_js
+        :sortable_element_js,
+        :text_field_with_auto_complete,
     ].each do |helper_name|
       define_method helper_name do |*args|
-        text raw(helpers.send(helper_name, *args))
+        begin
+          text raw(helpers.send(helper_name, *args))
+        rescue => e
+          puts e.backtrace.join("\n\t")
+          raise e
+        end
       end
     end
+    # helpers returning raw text whose first parameter is HTML escaped
     [
-        :link_to_function,
         :link_to,
         :link_to_remote,
-        :mail_to
-    ].each do |link_helper|
-      define_method link_helper do |link_text, *args|
-        text raw(helpers.send(link_helper, h(link_text), *args))
+        :mail_to,
+        :button_to,
+        :submit_tag,
+    ].each do |helper_name|
+      method_def =<<-METHOD_DEF
+      def #{helper_name}(link_text, *args, &block)
+        text raw(helpers.#{helper_name}(h(link_text), *args, &block))
       end
+      METHOD_DEF
+      eval(method_def)
     end
     def error_messages_for(*args)
-      fake_erbout do
-        helpers.error_messages_for(*args)
-      end
+      text raw(helpers.error_messages_for(*args))
     end
-    def form_for(*args, &block)
-      fake_erbout do
-        helpers.form_for(*args, &block)
+    # return text, take block
+    [
+      :link_to_function,
+      :form_for,
+      :form_tag,
+      :text_field_tag,
+      :password_field_tag,
+      :check_box_tag
+    ].each do |method_to_proxy_with_block|
+      method_def =<<-METHOD_DEF
+      def #{method_to_proxy_with_block}(*args, &block)
+        text raw(helpers.#{method_to_proxy_with_block}(*args, &block))
       end
+      METHOD_DEF
+      eval(method_def)
     end
+    # render text, take block
+    [
+      :error_messages_for,
+    ].each do |method_to_proxy_with_block|
+      method_def =<<-METHOD_DEF
+      def #{method_to_proxy_with_block}(*args, &block)
+        fake_erbout do
+          helpers.#{method_to_proxy_with_block}(*args, &block)
+        end
+      end
+      METHOD_DEF
+      eval(method_def)
+    end
     def javascript_include_merged(key)
       helpers.javascript_include_merged(key)
     end
@@ -51,6 +90,10 @@ module Erector
     def session
       helpers.controller.session
     end
+    def controller
+      helpers.controller
+    end
     def cycle(*args)
       helpers.cycle(*args)
@@ -68,4 +111,4 @@ module Erector
       helpers.pluralize(*args)
     end
   end
-end
+end