erector 0.7.0 → 0.7.1

data/lib/erector/widgets.rb

@@ -1,2 +1,4 @@
 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"

data/lib/erector/widgets/environment_badge.rb

@@ -0,0 +1,29 @@
+module Erector
+  module Widgets #:nodoc:
+
+    # Displays a colored badge in the upper-left corner 
+    # signifying the environment the app is running in. 
+    # Inspired by Assaf Arkin
+    #  <http://blog.labnotes.org/2009/10/08/using-a-badge-to-distinguish-development-and-production-environments/>
+    # Erectorized by Alex Chaffee
+    class EnvironmentBadge < Erector::Widget
+      def content
+        style <<-STYLE
+#environment_badge { position: fixed; left: 1em; font-weight: bold; padding: .2em 0.9em; text-transform: uppercase; display: none }
+#environment_badge.staging { color: #000; background: #ffff00; border: 2px solid #cccc20; }
+#environment_badge.development { color: #fff; background: #ff0000; border: 2px solid #cc2020; }
+#environment_badge.staging, #environment_badge.development { border-top: none; display: block; opacity: 0.6 }    
+        STYLE
+        unless environment =~ /production/
+          p environment, :class => environment, :id => "environment_badge"
+        end
+      end
+
+      def environment
+        RAILS_ENV
+      rescue NameError
+        ENV['RAILS_ENV'] || ENV['RACK_ENV']
+      end
+    end
+  end
+end

data/lib/erector/widgets/field_table.rb

@@ -0,0 +1,110 @@
+# A simple HTML table with three columns: label, contents, and (optionally) note.
+# Each row is called a field.
+# The last row can optionally contain "buttons" (actually any widget will do)
+# that are all shown in the 2nd column.
+# It's all surrounded with a fieldset element for a title.
+# 
+# In ASCII art, it looks something like this:
+#
+# /-Meals----------------------------------------\
+# | Breakfast | eggs              |              |
+# | Lunch     | sandwich          |              |
+# | Dinner    | lo mein           | with shrimp! | 
+# |           | [Save] [Cancel]   |              |
+# \----------------------------------------------/
+#
+# There are two ways to create a FieldTable.
+# 1. Pass a block in to the constructor.
+# 2. Make a subclass.
+# In both cases you'll want to call the "field" and "button" methods on the table. 
+# This sets up the contents which will be rendered later during FieldTable#content.
+# If you make a subclass (#2) you can do this either in the constructor or in
+# the content method *before* you call super.
+#
+# The FieldTable is surrounded by a fieldset element whose legend is the "title" instance variable.
+# Inside this fieldset is a table element.
+# Each field (row of the table) has a label (th), a content cell (td), and an optional note (td).
+#
+# If you call "button" you can pass in a block that'll get rendered inside the 2nd column of the last row. The idea here is that you might want to make an HTML form that has a bunch of buttons at the bottom (Save, Cancel, Clear) and these all go in the same cell, with no label for the row.
+#
+# TODO: error messages?
+# @author Alex Chaffee
+class FieldTable < Erector::Widget
+
+  include Erector::Inline
+  
+  class Field < Erector::Widget
+    needs :label, :note => nil
+    
+    def content
+      tr :class => "field_table_field" do
+        th do
+          text @label
+          text ":" unless @label.nil?
+        end
+        td do
+          super # calls the block
+        end
+        if @note
+          td do
+            text @note
+          end
+        end
+      end
+    end
+  end
+
+  # Define a field, containing a label, optional note, and block for the contents
+  #
+  # TODO: allow passing in a widget instead of a block
+  def field(label = nil, note = nil, &contents)
+    @fields << Field.new(:label => label, :note => note, &contents)
+  end
+  
+  # If you call "button" you can pass in a block that'll get rendered inside the 2nd column of the
+  # last row. The idea here is that you might want to make an HTML form that has a bunch of buttons at
+  # the bottom (Save, Cancel, Clear) and these all go in the same cell, with no label for the row.
+  #
+  # TODO: allow passing in a widget instead of a block
+  def button(&button_proc)
+    @buttons << button_proc
+  end
+
+  needs :title
+  
+  # Pass in a block and it'll get called with a pointer to this table, so you can call
+  # 'field' and 'button' to configure it
+  def initialize(*args)
+    super
+    @fields = []
+    @buttons = []
+    yield self if block_given? # invoke the configuration block
+  end
+  
+  def content
+    fieldset :class => "field_table" do
+      legend @title
+      table :width => '100%' do
+        @fields.each do |f|
+          widget f
+        end
+        unless @buttons.empty?
+          tr :class => "field_table_buttons" do
+            td :colspan => 2, :align => "right" do          
+              table :class => 'layout' do
+                tr do
+                  @buttons.each do |button|
+                    td :class => "field_table_button" do
+                      button.call
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+  
+end

data/lib/erector/widgets/page.rb

@@ -0,0 +1,158 @@
+# 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.
+#
+# 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. 
+#
+# 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.
+#
+# Author::   Alex Chaffee, alex@stinky.com 
+#
+# = Example Usage: 
+#
+#   class MyPage < Page
+#     external :js, "lib/jquery.js"
+#     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"
+#       end
+#     end
+#   end
+#
+# = Thoughts:
+#  * 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
+
+  # Emit the Transitional doctype.
+  # TODO: allow selection from among different standard doctypes
+  def doctype
+    '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+       "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
+  end
+
+  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
+      head do
+        head_content
+      end
+      body :class => body_class do
+        body_content
+      end
+    end
+  end
+
+  # override me to provide a page title (default = name of the Page subclass)
+  def page_title
+    self.class.name
+  end
+  
+  # override me to add a css class to the body
+  def body_class
+  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.
+  def head_content
+    meta 'http-equiv' => 'content-type', :content => 'text/html;charset=UTF-8'
+    title page_title
+
+    basic_styles if @basic_styles
+    included_stylesheets
+    inline_styles
+
+    included_scripts
+    inline_scripts
+  end
+  
+  def included_scripts
+    self.class.externals(:js).each do |file|
+      script :type => "text/javascript", :src => file
+    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"
+    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
+      end
+    end
+  end
+  
+  def inline_scripts
+    javascript do
+      self.class.externals(:script).each do |txt|
+        rawtext "\n"
+        rawtext txt
+      end
+      self.class.externals(:jquery).each do |txt|
+        jquery_ready txt
+      end
+    end
+  end
+
+end

data/spec/erector/external_spec.rb

@@ -0,0 +1,52 @@
+require File.expand_path("#{File.dirname(__FILE__)}/../spec_helper")
+require 'benchmark'
+
+describe "external declarations" do
+  class HotSauce < Erector::Widget
+    external :css, "/css/tapatio.css"
+    external :css, "/css/salsa_picante.css"
+    external :js, "/lib/jquery.js"
+    external :js, "/lib/picante.js"
+  end
+  
+  class SourCream < Erector::Widget
+    external :css, "/css/sourcream.css"
+    external :js, "/lib/jquery.js"
+    external :js, "/lib/dairy.js"
+  end
+  
+  it "can be fetched via the type" do
+    Erector::Widget.externals(:css).should == [
+      "/css/tapatio.css",
+      "/css/salsa_picante.css",
+      "/css/sourcream.css",
+      ]
+  end
+  
+  it "can be filtered via the class" do
+    Erector::Widget.externals(:css, HotSauce).should == [
+      "/css/tapatio.css",
+      "/css/salsa_picante.css",
+      ]
+    Erector::Widget.externals(:css, SourCream).should == [
+      "/css/sourcream.css",
+      ]
+  end
+  
+  it "removes duplicates" do
+    Erector::Widget.externals(:js).should == [
+      "/lib/jquery.js",
+      "/lib/picante.js",
+      "/lib/dairy.js",
+      ]
+  end
+  
+  it "works with strings or symbols" do
+    Erector::Widget.externals("js").should == [
+      "/lib/jquery.js",
+      "/lib/picante.js",
+      "/lib/dairy.js",
+      ]
+  end
+
+end

data/spec/erector/widget_spec.rb

@@ -212,7 +212,7 @@ module WidgetSpec
               :nil_attribute => nil
             )
           end.to_s
-          doc = Hpricot(html)
+          doc = Nokogiri::HTML(html)
           div = doc.at('div')
           div[:class].should == "foo bar"
           div[:style].should == "display: none; color: white; float: left;"
@@ -430,6 +430,40 @@ module WidgetSpec
         end
       end
     end
+    
+    def capturing_output
+      output = StringIO.new
+      $stdout = output
+      yield
+      output.string
+    ensure
+      $stdout = STDOUT
+    end
+
+    describe "#comment" do
+      it "emits an HTML comment" do
+        Erector.inline do
+          comment "foo"
+        end.to_s.should == "<!--foo-->"
+      end
+      
+      # see http://www.w3.org/TR/html4/intro/sgmltut.html#h-3.2.4
+      it "does not HTML-escape character references" do
+        Erector.inline do
+          comment "&nbsp;"
+        end.to_s.should == "<!--&nbsp;-->"
+      end
+      
+      # see http://www.w3.org/TR/html4/intro/sgmltut.html#h-3.2.4
+      # "Authors should avoid putting two or more adjacent hyphens inside comments."
+      it "warns if there's two hyphens in a row" do
+        capturing_output do
+          Erector.inline do
+            comment "he was -- awesome!"
+          end.to_s.should == "<!--he was -- awesome!-->"
+        end.should == "Warning: Authors should avoid putting two or more adjacent hyphens inside comments.\n"
+      end     
+    end  
 
     describe "#nbsp" do
       it "turns consecutive spaces into consecutive non-breaking spaces" do
@@ -594,8 +628,8 @@ module WidgetSpec
           html = Erector.inline do
             javascript(:src => "/my/js/file.js")
           end.to_s
-          doc = Hpricot(html)
-          doc.at('/')[:src].should == "/my/js/file.js"
+          doc = Nokogiri::HTML(html)
+          doc.at("script")[:src].should == "/my/js/file.js"
         end
       end
 
@@ -604,7 +638,7 @@ module WidgetSpec
           html = Erector.inline do
             javascript('alert("&<>\'hello");', :src => "/my/js/file.js")
           end.to_s
-          doc = Hpricot(html)
+          doc = Nokogiri::HTML(html)
           script_tag = doc.at('script')
           script_tag[:src].should == "/my/js/file.js"
           script_tag.inner_html.should include('alert("&<>\'hello");')
@@ -709,15 +743,25 @@ module WidgetSpec
 
     end
     
-    describe "assigning local variables" do
+    describe "assigning instance variables" do
       it "attempting to overwrite a reserved instance variable raises error" do
         lambda {
           Erector::Widget.new(:output => "foo")
         }.should raise_error(ArgumentError)
       end
+
+      it "handles instance variable names with and without '@' in the beginning" do
+        html = Erector.inline(:foo => "bar", '@baz' => 'quux') do
+          div do
+            p @foo
+            p @baz
+          end
+        end.to_s
+        doc = Nokogiri::HTML(html)
+        doc.css("p").map {|p| p.inner_html}.should == ["bar", "quux"]
+      end
     end
       
-    
     context "when declaring parameters with the 'needs' macro" do
       it "doesn't complain if there aren't any needs declared" do
         class Thing1 < Erector::Widget