erector 0.7.2 → 0.8.0

data/lib/erector/widgets.rb

@@ -1,5 +1,6 @@
 require "erector/widgets/environment_badge"
 require "erector/widgets/field_table"
 require "erector/widgets/form"
+require "erector/widgets/external_renderer"
 require "erector/widgets/page"
 require "erector/widgets/table"

data/lib/erector/widgets/external_renderer.rb

@@ -0,0 +1,51 @@
+class ExternalRenderer < Erector::Widget
+  needs :classes
+  needs :included_stylesheets => true, :inline_styles => true, :included_scripts => true, :inline_scripts => true
+  
+  def content
+    included_stylesheets if @included_stylesheets
+    inline_styles if @inline_styles
+    included_scripts if @included_scripts
+    inline_scripts if @inline_scripts
+  end
+  
+  def rendered_externals(type)
+    @classes.map do |klass|
+      klass.dependencies(type)
+    end.flatten.uniq
+  end
+  
+  def included_scripts
+    rendered_externals(:js).each do |external|
+      script({:type => "text/javascript", :src => external.text}.merge(external.options))
+    end
+  end
+  
+  def included_stylesheets
+    rendered_externals(:css).each do |external|
+      link({:rel => "stylesheet", :href => external.text, :type => "text/css", :media => "all"}.merge(external.options))
+    end
+  end
+
+  def inline_styles
+    rendered_externals(:style).each do |external|
+      style({:type => "text/css", 'xml:space' => 'preserve'}.merge(external.options)) do
+        rawtext external.text
+      end
+    end
+  end
+  
+  def inline_scripts
+    rendered_externals(:script).each do |external|
+      javascript external.options do
+        rawtext external.text
+      end
+    end
+    # todo: allow :load or :ready per external script
+    rendered_externals(:jquery).each do |external|
+      jquery :load, external.text, external.options
+    end
+  end
+
+end
+

data/lib/erector/widgets/page.rb

@@ -1,18 +1,24 @@
 # Erector Page base class.
 #
-# Allows for accumulation of script and style tags (see example below) with either
-# external or inline content. External references are 'uniq'd, so it's a good idea to declare
-# a js script in all widgets that use it, so you don't accidentally lose the script if you remove 
-# the one widget that happened to declare it.
-#
-# The script and style declarations are accumulated at class load time, as 'externals'.
-# This technique allows all widgets to add their own requirements to the page header
-# without extra logic for declaring which pages include which nested widgets.
-# Unfortunately, this means that every page in the application will share the same headers,
-# which may lead to conflicts.
-#
-# If you want something to show up in the headers for just one page type (subclass),
-# then override #head_content, call super, and then emit it yourself.
+# Allows for accumulation of script and style tags (see example below) with
+# either external or inline content. External references are 'uniq'd, so it's
+# a good idea to declare a js script in all widgets that use it, so you don't
+# accidentally lose the script if you remove the one widget that happened to
+# declare it.
+#
+# The script and style declarations are accumulated at class load time, as
+# 'dependencies'. This technique allows all widgets to add their own requirements
+# to the page header without extra logic for declaring which pages include
+# which nested widgets. Fortunately, Page is now smart enough to figure out
+# which widgets were actually rendered during the body_content run, so it only
+# emits into its HEAD the dependencies that are relevant. If it misses some, or
+# if you want to add some extra dependencies -- for instance, styles that apply
+# to widgets that are rendered later via AJAX -- then return an array of those
+# widget classes in your subclass by overriding the #extra_widgets method.
+#
+# If you want something to show up in the headers for just one page type
+# (subclass), then override #head_content, call super, and then emit it
+# yourself.
 #
 # Body content can be supplied in several ways:
 #
@@ -40,19 +46,20 @@
 #        text "body content"
 #      end
 #
-# This last trick (passing a block to Page.new) works because Page is an InlineWidget 
-# so its block is evaluated in the context of the newly instantiated widget object, 
-# and not in the context of its caller. But this means you can't access instance variables
-# of the caller, e.g.
-# 
+# This last trick (passing a block to Page.new) works because Page is an
+# InlineWidget so its block is evaluated in the context of the newly
+# instantiated widget object, and not in the context of its caller. But this
+# means you can't access instance variables of the caller, e.g.
+#
 #      @name = "fred"
 #      Erector::Widgets::Page.new do
 #        text "my name is #{@name}"
 #      end
 #
-# will emit "my name is " because @name is nil inside the new Page. However, you *can* 
-# call methods in the parent class, thanks to some method_missing magic. Confused? You 
-# should be. See Erector::Inline#content for more documentation.
+# will emit "my name is " because @name is nil inside the new Page. However,
+# you *can* call methods in the parent class, thanks to some method_missing
+# magic. Confused? You should be. See Erector::Inline#content for more
+# documentation.
 #
 # Author::   Alex Chaffee, alex@stinky.com 
 #
@@ -63,21 +70,21 @@
 #     external :script, "$(document).ready(function(){...});"
 #     external :css, "stuff.css"
 #     external :style, "li.foo { color: red; }"
-#     
+#
 #     def page_title
 #       "my app"
 #     end
-#     
+#
 #     def body_content
 #       h1 "My App"
 #       p "welcome to my app"
 #       widget WidgetWithExternalStyle
 #     end
 #   end
-# 
+#
 #   class WidgetWithExternalStyle < Erector::Widget
 #     external :style, "div.custom { border: 2px solid green; }"
-#     
+#
 #     def content
 #       div :class => "custom" do
 #         text "green is good"
@@ -99,21 +106,24 @@ class Erector::Widgets::Page < Erector::InlineWidget
   end
 
   def content
+    extra_head_slot = nil
     rawtext doctype
     html(html_attributes) do
       head do
         head_content
+        extra_head_slot = output.placeholder
       end
       body(body_attributes) do
         if block_given?
           yield
-        elsif @block
-          super
         else
           body_content
         end
       end
     end
+    # after everything's been rendered, use the placeholder to
+    # insert all the head's dependencies
+    extra_head_slot << included_head_content
   end
 
   # override me to provide a page title (default = name of the Page subclass)
@@ -133,51 +143,23 @@ class Erector::Widgets::Page < Erector::InlineWidget
 
   # override me (or instantiate Page with a block)
   def body_content
+    call_block
   end
 
   # emit the contents of the head element. Override and call super if you want to put more stuff in there.
   def head_content
     meta 'http-equiv' => 'content-type', :content => 'text/html;charset=UTF-8'
     title page_title
-
-    included_stylesheets
-    inline_styles
-
-    included_scripts
-    inline_scripts
-  end
-  
-  def included_scripts
-    self.class.externals(:js).each do |external|
-      script({:type => "text/javascript", :src => external.text}.merge(external.options))
-    end
   end
   
-  def included_stylesheets
-    self.class.externals(:css).each do |external|
-      link({:rel => "stylesheet", :href => external.text, :type => "text/css", :media => "all"}.merge(external.options))
-    end
-  end
-
-  def inline_styles
-    self.class.externals(:style).each do |external|
-      style({:type => "text/css", 'xml:space' => 'preserve'}.merge(external.options)) do
-        rawtext external.text
-      end
-    end
+  def included_head_content
+    # now that we've rendered the whole page, it's the right time
+    # to ask what all widgets were rendered to the output stream
+    included_widgets = [self.class] + output.widgets.to_a + extra_widgets
+    ExternalRenderer.new(:classes => included_widgets).to_html
   end
   
-  def inline_scripts
-    self.class.externals(:script).each do |external|
-      javascript external.options do
-        rawtext external.text
-      end
-    end
-    self.class.externals(:jquery).each do |external|
-      javascript external.options do
-        jquery_ready external.text
-      end
-    end
+  def extra_widgets
+    []
   end
-
 end

data/lib/erector/widgets/table.rb

@@ -1,5 +1,10 @@
-module Erector
+begin
+ require "active_support/inflector"
+
+ module Erector
   module Widgets #:nodoc:
+
+
     # The Table widget provides the ability to render a table from a 
     # list of objects (one for each row).
     #
@@ -93,4 +98,7 @@ module Erector
       end
     end
   end
+ end
+rescue LoadError => e
+  $stderr.puts "Erector::Widgets::Table requires active_support"
 end

data/spec/erect/erect_rails_spec.rb

@@ -1,5 +1,6 @@
 require File.expand_path("#{File.dirname(__FILE__)}/../spec_helper")
 require "erector/rails"
+require "rails/version"
 
 # backport mktmpdir so this test will work on Ruby 1.8.6
 unless Dir.respond_to?(:mktmpdir)
@@ -49,7 +50,6 @@ end
 # user guide).
 #
 module Erector
-
   describe "the Rails version" do
     it "should be #{Erector::Rails::RAILS_VERSION}" do
       ::Rails::VERSION::STRING.should == Erector::Rails::RAILS_VERSION
@@ -57,9 +57,7 @@ module Erector
   end
 
   describe "Erect in a Rails app" do
-    
     def run(cmd)
-#      puts "Running #{cmd}"
       stderr_file = Dir.tmpdir + "/stderr.txt"
       stdout = IO.popen(cmd + " 2>#{stderr_file}") do |pipe|
         pipe.read
@@ -76,37 +74,41 @@ module Erector
     def indent(s)
       s.gsub(/^/, '  ')
     end
-    
-    def run_rails(app_dir)
-      # To ensure we're working with the right version of Rails we use "gem 'rails', 1.2.3"
-      # in a "ruby -e" command line invocation of the rails executable to generate an
-      # app called explode.
-      #
-#      puts "Generating fresh rails #{Erector::Rails::RAILS_VERSION} app in #{app_dir}"
-      run "ruby -e \"require 'rubygems'; gem 'rails', '#{Erector::Rails::RAILS_VERSION}'; load 'rails'\" #{app_dir}"
-    end
-      
+
     it "works like we say it does in the user guide" do
       erector_dir = File.expand_path("#{File.dirname(__FILE__)}/../..")
 
+      # We add the paths to our vendored copy of rails to the load paths, so
+      # that this spec can be run without having a version of Rails (which may
+      # not match the version we wish to test against) installed.
+      rails_libs_argument = "-I'#{RAILS_LOAD_PATHS.join("':'")}'"
+
       Dir.mktmpdir do |app_dir|
-        run_rails app_dir
+        run "ruby #{rails_libs_argument} '#{VENDOR_RAILS}/railties/bin/rails' '#{app_dir}'"
+
+        FileUtils.cp_r(VENDOR_RAILS, "#{app_dir}/vendor/rails")
 
         FileUtils.mkdir_p(app_dir + "/vendor/gems")
         FileUtils.cp_r(erector_dir, "#{app_dir}/vendor/gems/erector")
 
         FileUtils.cd(app_dir) do
           run "script/generate scaffold post title:string body:text published:boolean"
-          run "ruby -I#{erector_dir}/lib #{erector_dir}/bin/erector app/views/posts"
+
+          # The 'erector' binary would normally have been installed through rubygems,
+          # providing it with a wrapper script which requires rubygems. But here we
+          # run it directly, so we need to require rubygems explicitly before running
+          # the main script.
+          run "ruby #{rails_libs_argument} -I'#{erector_dir}/lib' " +
+            "-e \"require 'rubygems'; load '#{erector_dir}/bin/erector'\" app/views/posts"
+
           FileUtils.rm_f("app/views/posts/*.erb")
           run "rake --trace db:migrate"
+
           # run "script/server" # todo: launch in background; use mechanize or something to crawl it; then kill it
           # perhaps use open4?
           # open http://localhost:3000/posts
         end
       end
     end
-    
   end
-
 end

data/spec/erect/erect_spec.rb

@@ -1,6 +1,6 @@
 require File.expand_path("#{File.dirname(__FILE__)}/../spec_helper")
 
-require "erector/erect"
+require "erector/erect/erect"
 
 module Erector
   describe Erect do
@@ -23,6 +23,16 @@ module Erector
       Erect.new([]).verbose.should be_true
       Erect.new(["-q"]).verbose.should be_false
     end
+    
+    it "sets the superclass to what you tell it" do
+      Erect.new([]).superklass.should == 'Erector::Widget'
+      Erect.new(['--superclass', 'Foo::Bar']).superklass.should == 'Foo::Bar'
+    end
+    
+    it "sets the method name to what you tell it" do
+      Erect.new([]).method_name.should == 'content'
+      Erect.new(['--method', 'my_content']).method_name.should == 'my_content'
+    end
 
     it "parses a command line with several filenames and an option on it" do
       erect = Erect.new(["-q", "foo.html", "bar/baz.html"])

data/spec/erect/erected_spec.rb

@@ -1,6 +1,6 @@
 require File.expand_path("#{File.dirname(__FILE__)}/../spec_helper")
 
-require "erector/erect"
+require "erector/erect/erect"
 
 module Erector
   describe Erected do
@@ -37,7 +37,7 @@ module Erector
       Erected.new("views/stuff/foo_bar.html.erb").parent_class.should == "Erector::Widget"
     end
 
-    def convert(dir, input, output)
+    def convert(dir, input, output, superklass = nil, method_name = nil)
       dir = Dir.tmpdir + "/#{Time.now.to_i}" + "/#{dir}"
 
       FileUtils.mkdir_p(dir)
@@ -47,8 +47,9 @@ module Erector
       File.open(html, "w") do |f|
         f.puts(input)
       end
-
-      @e = Erected.new(html)
+      
+      args = [ html, superklass || 'Erector::Widget', method_name || 'content' ]
+      @e = Erected.new(*args)
       @e.convert
 
       File.read(rb).should == output
@@ -79,13 +80,83 @@ module Erector
           "end\n"
       )
     end
+    
+    it "converts a normal file with a different superclass" do
+      convert(".",
+        "<div>hello</div>",
+        "class Dummy < Foo::Bar\n" +
+          "  def content\n" +
+          "    div do\n" +
+          "      text 'hello'\n" +
+          "    end\n" +
+          "  end\n" +
+          "end\n",
+        "Foo::Bar"
+      )
+    end
+    
+    it "converts a normal file with a different superclass and method name" do
+      convert(".",
+        "<div>hello</div>",
+        "class Dummy < Foo::Bar\n" +
+          "  def my_content\n" +
+          "    div do\n" +
+          "      text 'hello'\n" +
+          "    end\n" +
+          "  end\n" +
+          "end\n",
+        "Foo::Bar",
+        'my_content'
+      )
+    end
+    
+    it "ignores ERb trim markers" do
+      convert(".",
+        %{<div>
+<%= 1 + 3 -%>
+</div>},
+%{class Dummy < Erector::Widget
+  def content
+    div do
+      rawtext 1 + 3
+    end
+  end
+end
+})
+    end
+
+    it "converts ERb escapes in attributes" do
+      convert(".",
+        "<div id=\"foo_<%= bar %>_baz_<%= quux %>_marph\">hello</div>",
+%{class Dummy < Erector::Widget
+  def content
+    div(:id => ('foo_' + bar + '_baz_' + quux + '_marph')) do
+      text 'hello'
+    end
+  end
+end
+})
+    end
+
+    it "only parenthesizes ERb escapes in attributes if necessary" do
+      convert(".",
+        "<div id=\'<%= bar %>\'>hello</div>",
+%{class Dummy < Erector::Widget
+  def content
+    div :id => bar do
+      text 'hello'
+    end
+  end
+end
+})
+    end
 
 # todo: figure out if there is any such thing as unparsable HTML anymore
 #    it "raises an exception if given unparsable HTML" do
 #      begin
 #        convert(".", "<", "")
 #      rescue => e
-#        e.to_s.should include("Could not parse")
+#        e.to_html.should include("Could not parse")
 #      end
 #    end