erector 0.7.1 → 0.7.2

data/lib/erector/widgets.rb

@@ -1,4 +1,5 @@
-require "#{File.dirname(__FILE__)}/widgets/table"
-require "#{File.dirname(__FILE__)}/widgets/field_table"
-require "#{File.dirname(__FILE__)}/widgets/page"
-require "#{File.dirname(__FILE__)}/widgets/environment_badge"
+require "erector/widgets/environment_badge"
+require "erector/widgets/field_table"
+require "erector/widgets/form"
+require "erector/widgets/page"
+require "erector/widgets/table"

data/lib/erector/widgets/form.rb

@@ -0,0 +1,30 @@
+# todo: make more like http://github.com/justinfrench/formtastic
+
+class Form < Erector::Widget
+  needs :action, :method => "post"
+  
+  def content
+    form :method => form_method, :action => @action do
+      unless rest_method == form_method
+        input :type => "hidden", :name => "_method", :value => rest_method
+      end
+      super
+    end
+  end
+  
+  def method
+    @method.to_s.downcase
+  end
+  
+  def form_method
+    if method == "get"
+      "get"
+    else
+      "post"
+    end
+  end
+  
+  def rest_method
+    method
+  end
+end

data/lib/erector/widgets/page.rb

@@ -5,18 +5,55 @@
 # 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.
 #
-# At minimum, child classes must override #body_content. You can also get a "quick and dirty"
-# page by passing a block to Page.new but that doesn't really buy you much.
-#
 # 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. 
+# which may lead to conflicts.
 #
-# If you want something to show up in the headers for just one page type (subclass), 
+# 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:
+#
+#   * In a Page subclass, by overriding the #body_content method:
+#
+#      class MyPage < Erector::Widgets::Page
+#        def body_content
+#          text "body content"
+#        end
+#      end
+#
+#   * Or by overriding #content and passing a block to super:
+#
+#      class MyPage < Erector::Widgets::Page
+#        def content
+#          super do
+#            text "body content"
+#          end
+#        end
+#      end
+#
+#   * Or by passing a block to Page.new:
+#
+#      Erector::Widgets::Page.new do
+#        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.
+# 
+#      @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.
+#
 # Author::   Alex Chaffee, alex@stinky.com 
 #
 # = Example Usage: 
@@ -52,9 +89,7 @@
 #  * It may be desirable to unify #js and #script, and #css and #style, and have the routine be
 #    smart enough to analyze its parameter to decide whether to make it a file or a script.
 #
-class Erector::Widgets::Page < Erector::Widget
-
-  needs :basic_styles => true
+class Erector::Widgets::Page < Erector::InlineWidget
 
   # Emit the Transitional doctype.
   # TODO: allow selection from among different standard doctypes
@@ -65,13 +100,18 @@ class Erector::Widgets::Page < Erector::Widget
 
   def content
     rawtext doctype
-    # todo: allow customization of xmlns and xml:lang
-    html :xmlns => 'http://www.w3.org/1999/xhtml', 'xml:lang' => 'en', :lang => 'en' do
+    html(html_attributes) do
       head do
         head_content
       end
-      body :class => body_class do
-        body_content
+      body(body_attributes) do
+        if block_given?
+          yield
+        elsif @block
+          super
+        else
+          body_content
+        end
       end
     end
   end
@@ -81,13 +121,18 @@ class Erector::Widgets::Page < Erector::Widget
     self.class.name
   end
   
-  # override me to add a css class to the body
-  def body_class
+  # override me to change the attributes of the HTML element
+  def html_attributes
+    {:xmlns => 'http://www.w3.org/1999/xhtml', 'xml:lang' => 'en', :lang => 'en'}
+  end
+  
+  # override me to add attributes (e.g. a css class) to the body
+  def body_attributes
+    {}
   end
 
   # override me (or instantiate Page with a block)
   def body_content
-    instance_eval(&@block) if @block
   end
 
   # emit the contents of the head element. Override and call super if you want to put more stuff in there.
@@ -95,7 +140,6 @@ class Erector::Widgets::Page < Erector::Widget
     meta 'http-equiv' => 'content-type', :content => 'text/html;charset=UTF-8'
     title page_title
 
-    basic_styles if @basic_styles
     included_stylesheets
     inline_styles
 
@@ -104,53 +148,34 @@ class Erector::Widgets::Page < Erector::Widget
   end
   
   def included_scripts
-    self.class.externals(:js).each do |file|
-      script :type => "text/javascript", :src => file
+    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 |file|
-      # todo: allow different media
-      link :rel => "stylesheet", :href => file, :type => "text/css", :media => "all"
+    self.class.externals(:css).each do |external|
+      link({:rel => "stylesheet", :href => external.text, :type => "text/css", :media => "all"}.merge(external.options))
     end
   end
-  
-  # Emit some *very* basic styles, hopefully not too controversial. Suppress
-  # them by setting :basic_styles => false when you construct your Page, or just 
-  # override the basic_styles method in your subclass and make it do nothing.
-  # You can also redefine them since they're defined above any other styles in the HEAD.
-  #
-  # Class "right" floats right, class "left" floats left, and class "clear" clears
-  # any floats on both sides while being as small as possible to minimize impact
-  # on your layout. And images have no border.
-  def basic_styles
-    style <<-STYLE
-      img {border: none}
-      .right {float: right;}
-      .left {float: left;}
-      .clear {background: none;border: 0;clear: both;display: block;float: none;font-size: 0;margin: 0;padding: 0;position: static;overflow: hidden;visibility: hidden;width: 0;height: 0;}
-    STYLE
-  end
 
   def inline_styles
-    style :type => "text/css", 'xml:space' => 'preserve' do
-      rawtext "\n"
-      self.class.externals(:style).each do |txt|
-        rawtext "\n"
-        rawtext txt
+    self.class.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
-    javascript do
-      self.class.externals(:script).each do |txt|
-        rawtext "\n"
-        rawtext txt
+    self.class.externals(:script).each do |external|
+      javascript external.options do
+        rawtext external.text
       end
-      self.class.externals(:jquery).each do |txt|
-        jquery_ready txt
+    end
+    self.class.externals(:jquery).each do |external|
+      javascript external.options do
+        jquery_ready external.text
       end
     end
   end

data/rails/init.rb

@@ -0,0 +1,4 @@
+require "erector"
+require "erector/rails"
+
+Erector.init_rails(binding)

data/spec/erect/erect_rails_spec.rb

@@ -1,6 +1,47 @@
 require File.expand_path("#{File.dirname(__FILE__)}/../spec_helper")
 require "erector/rails"
 
+# backport mktmpdir so this test will work on Ruby 1.8.6
+unless Dir.respond_to?(:mktmpdir)
+  def Dir.mktmpdir(prefix_suffix=nil, tmpdir=nil)
+    case prefix_suffix
+    when nil
+      prefix = "d"
+      suffix = ""
+    when String
+      prefix = prefix_suffix
+      suffix = ""
+    when Array
+      prefix = prefix_suffix[0]
+      suffix = prefix_suffix[1]
+    else
+      raise ArgumentError, "unexpected prefix_suffix: #{prefix_suffix.inspect}"
+    end
+    tmpdir ||= Dir.tmpdir
+    t = Time.now.strftime("%Y%m%d")
+    n = nil
+    begin
+      path = "#{tmpdir}/#{prefix}#{t}-#{$$}-#{rand(0x100000000).to_s(36)}"
+      path << "-#{n}" if n
+      path << suffix
+      Dir.mkdir(path, 0700)
+    rescue Errno::EEXIST
+      n ||= 0
+      n += 1
+      retry
+    end
+
+    if block_given?
+      begin
+        yield path
+      ensure
+        FileUtils.remove_entry_secure path
+      end
+    else
+      path
+    end
+  end
+end
 
 # Note: this is *not* inside the rails_root since we're not testing 
 # Erector inside a rails app. We're testing that we can use the command-line
@@ -9,19 +50,16 @@ require "erector/rails"
 #
 module Erector
 
-  describe "the user running this spec" do
-    it "should have the correct Rails gem (version #{Erector::Rails::RAILS_VERSION}) installed" do
-      target_version = Gem::Version.new(Erector::Rails::RAILS_VERSION)
-      dep = Gem::Dependency.new "rails", target_version
-      specs = Gem.source_index.search dep
-      specs.size.should == 1
+  describe "the Rails version" do
+    it "should be #{Erector::Rails::RAILS_VERSION}" do
+      ::Rails::VERSION::STRING.should == Erector::Rails::RAILS_VERSION
     end
   end
 
   describe "Erect in a Rails app" do
     
     def run(cmd)
-      puts "Running #{cmd}"
+#      puts "Running #{cmd}"
       stderr_file = Dir.tmpdir + "/stderr.txt"
       stdout = IO.popen(cmd + " 2>#{stderr_file}") do |pipe|
         pipe.read
@@ -44,29 +82,28 @@ module Erector
       # 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}"
+#      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
-      app_dir = Dir.tmpdir + "/#{Time.now.to_i}" + "/explode"
-      erector_bin = File.expand_path("#{File.dirname(__FILE__)}/../../bin")
-      
-      FileUtils.mkdir_p(app_dir)
-      run_rails app_dir
-      
-      FileUtils.mkdir_p(app_dir + "/vendor/gems")
-      FileUtils.cp_r("#{File.dirname __FILE__}/../..", "#{app_dir}/vendor/gems/erector")
-      
-      FileUtils.cd(app_dir) do
-        run "script/generate scaffold post title:string body:text published:boolean"
-        run "#{erector_bin}/erector app/views/posts"
-        FileUtils.rm_f("app/views/posts/*.erb")
-#        run "(echo ''; echo \"require 'erector'\") >> config/environment.rb"
-        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
+      erector_dir = File.expand_path("#{File.dirname(__FILE__)}/../..")
+
+      Dir.mktmpdir do |app_dir|
+        run_rails app_dir
+
+        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"
+          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
     

data/spec/erect/erected_spec.rb

@@ -32,9 +32,9 @@ module Erector
       Erected.new("stuff/foo_bar.html.erb").parent_class.should == "Erector::Widget"
     end
 
-    it "uses RailsWidget as the parent class if it's in a views dir" do
-      Erected.new("app/views/stuff/foo_bar.html.erb").parent_class.should == "Erector::RailsWidget"
-      Erected.new("views/stuff/foo_bar.html.erb").parent_class.should == "Erector::RailsWidget"
+    it "uses Widget as the parent class if it's in a views dir" do
+      Erected.new("app/views/stuff/foo_bar.html.erb").parent_class.should == "Erector::Widget"
+      Erected.new("views/stuff/foo_bar.html.erb").parent_class.should == "Erector::Widget"
     end
 
     def convert(dir, input, output)
@@ -70,7 +70,7 @@ module Erector
     it "converts a views file" do
       convert("app/views/foos",
         "<div>hello</div>",
-        "class Views::Foos::Dummy < Erector::RailsWidget\n" +
+        "class Views::Foos::Dummy < Erector::Widget\n" +
           "  def content\n" +
           "    div do\n" +
           "      text 'hello'\n" +

data/spec/erector/external_spec.rb

@@ -1,9 +1,50 @@
 require File.expand_path("#{File.dirname(__FILE__)}/../spec_helper")
 require 'benchmark'
+require 'active_support' # for Symbol#to_proc
+
+describe Erector::External do
+  it "can be constructed with type, klass, text" do
+    x = Erector::External.new(:foo, Object, "abc")
+    x.type.should == :foo
+    x.klass.should == Object
+    x.text.should == "abc"
+    x.options.should == {}
+  end
+
+  it "can be constructed with type, klass, text, and options" do
+    x = Erector::External.new(:foo, Object, "abc", {:bar => 7})
+    x.options.should == {:bar => 7}
+  end
+  
+  it "is equal to an identical external" do
+    x = Erector::External.new(:foo, Object, "abc", {:bar => 7})
+    y = Erector::External.new(:foo, Object, "abc", {:bar => 7})
+    x.should == y
+    [x].should include(y)
+  end
+  
+  it "is equal to an identical external with a different class" do
+    class_x = Class.new
+    class_y = Class.new
+    x = Erector::External.new(:foo, class_x, "abc", {:bar => 7})
+    y = Erector::External.new(:foo, class_y, "abc", {:bar => 7})
+    x.should == y
+    [x].should include(y)
+  end
+  
+  it "is not equal to an identical external with a different options" do
+    class_x = Class.new
+    x = Erector::External.new(:foo, class_x, "abc")
+    y = Erector::External.new(:foo, class_x, "abc", {:bar => 7})
+    x.should_not == y
+    [x].should_not include(y)
+  end
+  
+end
 
 describe "external declarations" do
   class HotSauce < Erector::Widget
-    external :css, "/css/tapatio.css"
+    external :css, "/css/tapatio.css", :media => "print"
     external :css, "/css/salsa_picante.css"
     external :js, "/lib/jquery.js"
     external :js, "/lib/picante.js"
@@ -16,7 +57,7 @@ describe "external declarations" do
   end
   
   it "can be fetched via the type" do
-    Erector::Widget.externals(:css).should == [
+    Erector::Widget.externals(:css).map(&:text).should == [
       "/css/tapatio.css",
       "/css/salsa_picante.css",
       "/css/sourcream.css",
@@ -24,25 +65,42 @@ describe "external declarations" do
   end
   
   it "can be filtered via the class" do
-    Erector::Widget.externals(:css, HotSauce).should == [
+    Erector::Widget.externals(:css, HotSauce).map(&:text).should == [
       "/css/tapatio.css",
       "/css/salsa_picante.css",
       ]
-    Erector::Widget.externals(:css, SourCream).should == [
+    Erector::Widget.externals(:css, SourCream).map(&:text).should == [
       "/css/sourcream.css",
       ]
   end
   
+  it "retains the options" do
+    Erector::Widget.externals(:css, HotSauce).map(&:options).should == [
+      {:media => "print"}, 
+      {}
+    ]
+  end
+  
   it "removes duplicates" do
-    Erector::Widget.externals(:js).should == [
+    Erector::Widget.externals(:js).map(&:text).should == [
       "/lib/jquery.js",
       "/lib/picante.js",
       "/lib/dairy.js",
       ]
   end
+
+
+  class Taco < Erector::Widget
+    external :filling, "beef"
+    external :filling, "beef", :media => "print"
+  end
+    
+  it "considers options when removing duplicates" do
+    Erector::Widget.externals(:filling).map(&:text).should == ["beef", "beef"]
+  end
   
   it "works with strings or symbols" do
-    Erector::Widget.externals("js").should == [
+    Erector::Widget.externals("js").map(&:text).should == [
       "/lib/jquery.js",
       "/lib/picante.js",
       "/lib/dairy.js",