erector 0.7.2 → 0.8.0

data/spec/erect/rhtml_parser_spec.rb

@@ -1,6 +1,6 @@
 require File.expand_path("#{File.dirname(__FILE__)}/../spec_helper")
 
-require "erector/erect"
+require "erector/erect/erect"
 
 module ParserTestHelper
   def assert_evals_to_self(input)
@@ -167,6 +167,11 @@ describe RhtmlParser do
     parse("<div id='foo'>bar</div>").convert.should == "div :id => 'foo' do\n  text 'bar'\nend\n"    
   end
   
+  it "processes ERb escapes in attributes, and adds parentheses when required" do
+    parse("<div id=\"<%= bar %>\" />").convert.should == "div :id => bar\n"
+    parse("<div id=\"foo_<%= bar %>_baz\" />").convert.should == "div(:id => ('foo_' + bar + '_baz'))\n"
+  end
+  
   it "escapes single quotes inside attribute values" do
     @parser.root = :attribute
     parse("a=\"don't worry\"").convert.should == ":a => 'don\\'t worry'"
@@ -228,6 +233,11 @@ describe RhtmlParser do
     parse("'foo'").value.should == "foo"
     parse("\"foo\"").value.should == "foo"
   end
+  
+  it "quotes empty strings" do
+    @parser.root = :quoted
+    parse("''").convert.should == "''"
+  end
 
   it "converts attributes in isolation" do
     @parser.root = :attribute

data/spec/erector/caching_spec.rb

@@ -0,0 +1,267 @@
+require File.expand_path("#{File.dirname(__FILE__)}/../spec_helper")
+
+  describe Erector::Cache do
+    before do
+      @cache = Erector::Cache.new
+    end
+
+    class Johnny < Erector::Widget
+    end
+
+    class June < Erector::Widget
+    end
+
+    it 'caches a class with no parameters' do
+      @cache[Johnny] = "ring of fire"
+      @cache[Johnny].should == "ring of fire"
+    end
+
+    it 'caches two classes with no parameters' do
+      @cache[Johnny] = "ring of fire"
+      @cache[June] = "wildwood flower"
+      @cache[Johnny].should == "ring of fire"
+      @cache[June].should == "wildwood flower"
+    end
+
+    it "stores different slots for the same class with different parameters" do
+      @cache[Johnny, {:flames => "higher"}] = "ring of fire"
+      @cache[Johnny, {:working => "in a coal mine"}] = "my daddy died young"
+
+      @cache[Johnny, {:flames => "higher"}].should == "ring of fire"
+      @cache[Johnny, {:working => "in a coal mine"}].should == "my daddy died young"
+    end
+
+    it "stores different slots for the same class with same parameters and different content methods" do
+      @cache[Johnny, {}, :foo] = "ring of fire"
+      @cache[Johnny, {}, :bar] = "my daddy died young"
+
+      @cache[Johnny, {}, :foo].should == "ring of fire"
+      @cache[Johnny, {}, :bar].should == "my daddy died young"
+    end
+
+    describe 'after storing a widget with one parameter' do
+      before do
+        @cache[Johnny, {:flames => "higher"}] = "ring of fire"
+      end
+
+      it 'doesn\'t get it when passed the class alone' do
+        @cache[Johnny].should be_nil
+      end
+
+      it 'doesn\'t get it when passed a different class' do
+        @cache[June].should be_nil
+      end
+
+      it 'gets it' do
+        @cache[Johnny, {:flames => "higher"}].should == "ring of fire"
+      end
+
+      it 'doesn\'t get it when passed a different parameter key' do
+        @cache[Johnny, {:working => "coal mine"}].should be_nil
+      end
+
+      it 'doesn\'t get it when passed a different parameter value' do
+        @cache[Johnny, {:flames => "lower"}].should be_nil
+      end
+
+      it 'doesn\'t get it when passed an extra parameter key' do
+        @cache[Johnny, {:flames => "higher", :working => "coal mine"}].should be_nil
+      end
+    end
+
+    describe 'after storing a widget with more than one parameter' do
+      before do
+        @cache[Johnny, {:flames => "higher", :working => "coal mine"}] = "ring of fire"
+      end
+
+      it "gets it" do
+        @cache[Johnny, {:flames => "higher", :working => "coal mine"}].should == "ring of fire"
+      end
+
+      it 'doesn\'t get it when passed the class alone' do
+        @cache[Johnny].should be_nil
+      end
+
+      it "doesn't get it when passed a partial parameter set" do
+        @cache[Johnny, {:flames => "higher"}].should be_nil
+      end
+
+      it 'doesn\'t get it when passed a different class' do
+        @cache[June].should be_nil
+      end
+
+      it 'doesn\'t get it when passed different a parameter value' do
+        @cache[Johnny, {:flames => "lower", :working => "coal mine"}].should be_nil
+      end
+
+      it 'doesn\'t get it when passed an extra parameter key' do
+        @cache[Johnny, {:flames => "higher", :working => "coal mine", :hear => "train a' comin'"}].should be_nil
+      end
+    end
+
+    describe "expires" do
+      it 'a class with no parameters' do
+        @cache[Johnny] = "ring of fire"
+        @cache.delete(Johnny)
+        @cache[Johnny].should be_nil
+      end
+
+      it 'all versions of a class' do
+        @cache[Johnny] = "i fell in"
+        @cache[Johnny, {:flames => "higher"}] = "ring of fire"
+        @cache[Johnny, {:working => "in a coal mine"}] = "my daddy died young"
+
+        @cache.delete_all(Johnny)
+
+        @cache[Johnny].should be_nil
+        @cache[Johnny, {:flames => "higher"}].should be_nil
+        @cache[Johnny, {:working => "in a coal mine"}].should be_nil
+      end
+
+      it '...but not other cached values' do
+        @cache[Johnny] = "ring of fire"
+        @cache[Johnny, {:flames => 'higher'}] = "higher fire"
+        @cache[June] = "wildwood flower"
+        @cache.delete(Johnny)
+        @cache[Johnny].should be_nil
+        @cache[Johnny, {:flames => 'higher'}].should == "higher fire"
+        @cache[June].should == "wildwood flower"
+      end
+    end
+  end
+
+  describe Erector::Caching do
+    include Erector::Mixin
+
+    class Cash < Erector::Widget
+      needs :name
+      cachable
+
+      def content
+        p do
+          text @name
+          text " Cash"
+        end
+      end
+    end
+
+    class Family < Erector::Widget
+      cacheable
+
+      def content
+        widget Cash, :name => "Johnny"
+        widget Cash, :name => "June"
+      end
+    end
+
+    class NotCachable < Erector::Widget
+      def content
+        text "CONTENT"
+      end
+    end
+
+    before do
+      @cache = Erector::Cache.new
+      Erector::Widget.cache = @cache
+    end
+
+    after do
+      Erector::Widget.cache = nil
+    end
+
+    it "has a global cache" do
+      Erector::Widget.cache.should == @cache
+    end
+
+    it '-- a widget is not cachable by default' do
+      Erector::Widget.cachable?.should be_false
+    end
+
+    it '-- a widget is cachable if you say so in the class definition' do
+      Cash.cachable?.should be_true
+    end
+
+    it '-- can be declared cachable using the alternate spelling "cacheable"' do
+      Family.cachable?.should be_true
+    end
+
+    describe '#to_html' do
+
+      it "caches a rendered widget" do
+        Cash.new(:name => "Johnny").to_html
+        @cache[Cash, {:name => "Johnny"}].to_s.should == "<p>Johnny Cash</p>"
+      end
+
+      it "uses the cached value" do
+        @cache[Cash, {:name => "Johnny"}] = "CACHED"
+        Cash.new(:name => "Johnny").to_html.should == "CACHED"
+      end
+
+      it "doesn't use the cached value for widgets not declared cachable" do
+        @cache[NotCachable] = "CACHED"
+        NotCachable.new.to_html.should == "CONTENT"
+      end
+
+      it "doesn't cache widgets not declared cachable" do
+        NotCachable.new.to_html
+        @cache[NotCachable].should be_nil
+      end
+
+      it "doesn't cache widgets initialized with a block (yet)" do
+        Cash.new(:name => "June") do
+          text "whatever"
+        end.to_html
+        @cache[Cash, {:name => "June"}].should be_nil
+      end
+
+      it "caches distinct values when using :content_method_name" do
+        widget = Class.new(Erector::Widget) do
+          cacheable
+
+          def foo
+            text "foo"
+          end
+
+          def bar
+            text "bar"
+          end
+        end
+
+        widget.new.to_html(:content_method_name => :foo).should == "foo"
+        widget.new.to_html(:content_method_name => :bar).should == "bar"
+      end
+
+      it "works when passing an existing output as a parameter to to_html"
+    end
+
+    describe '#widget' do
+
+      it "caches rendered widgets" do
+        Family.new.to_html
+        @cache[Cash, {:name => "Johnny"}].to_s.should == "<p>Johnny Cash</p>"
+        @cache[Cash, {:name => "June"}].to_s.should == "<p>June Cash</p>"
+      end
+
+      it "uses the cached value" do
+        @cache[Cash, {:name => "Johnny"}] = "JOHNNY CACHED"
+        Family.new.to_html.should == "JOHNNY CACHED<p>June Cash</p>"
+      end
+
+      class WidgetWithBlock < Erector::Widget
+        def content
+          call_block
+        end
+      end
+
+      it "doesn't cache widgets initialized with a block (yet)" do
+        erector {
+          w = WidgetWithBlock.new do
+            text "in block"
+          end
+          widget w
+        }.should == "in block"
+        @cache[WidgetWithBlock].should be_nil
+      end
+
+    end
+  end

data/spec/erector/convenience_spec.rb

@@ -0,0 +1,258 @@
+require File.expand_path("#{File.dirname(__FILE__)}/../spec_helper")
+
+describe Erector::Convenience do
+  include Erector::Mixin
+
+  describe "#to_pretty" do
+    it "calls to_html with :prettyprint => true" do
+      widget = Erector.inline do
+        div "foo"
+      end
+      mock(widget).to_html({:prettyprint => true})
+      widget.to_pretty
+    end
+
+    it "passes extra options through to to_html" do
+      widget = Erector.inline do
+        div "foo"
+      end
+      mock(widget).to_html({:prettyprint => true, :extra => "yay"})
+      widget.to_pretty(:extra => "yay")
+    end
+  end
+
+  describe "#to_s" do
+    it "returns html" do
+      capturing_stderr do
+        Erector.inline do
+          div "foo"
+        end.to_s.should == "<div>foo</div>"
+      end
+    end
+  end
+
+  describe "#to_html" do
+    it "returns html" do
+      Erector.inline do
+        div "foo"
+      end.to_html.should == "<div>foo</div>"
+    end
+  end
+
+  describe "#to_text" do
+    it "strips tags" do
+      Erector.inline do
+        div "foo"
+      end.to_text.should == "foo"
+    end
+
+    it "unescapes named entities" do
+      s = "my \"dog\" has fleas & <ticks>"
+      Erector.inline do
+        text s
+      end.to_text.should == s
+    end
+
+    it "ignores >s inside attribute strings" do
+      Erector.inline do
+        a "foo", :href => "http://example.com/x>y"
+      end.to_text.should == "foo"
+    end
+
+    def with_prettyprint_default(value = true)
+      old_default = Erector::Widget.new.prettyprint_default
+      begin
+        Erector::Widget.prettyprint_default = value
+        yield
+      ensure
+        Erector::Widget.prettyprint_default = old_default
+      end
+    end
+
+    it "doesn't inherit unwanted pretty-printed whitespace (i.e. it turns off prettyprinting)" do
+      with_prettyprint_default(true) do
+        Erector.inline do
+          div { div { div "foo" } }
+        end.to_text.should == "foo"
+      end
+    end
+
+    it "passes extra attributes through to to_s" do
+      class Funny < Erector::Widget
+        def content
+          div "foo"
+        end
+
+        def funny
+          div "haha"
+        end
+      end
+      Funny.new.to_text(:content_method_name => :funny).should == "haha"
+    end
+
+    it "doesn't turn a p into a newline if it's at the beginning of the string" do
+      Erector.inline do
+        p "hi"
+      end.to_text.should == "hi\n"
+    end
+
+    it "puts a blank line (two newlines) after a /p tag" do
+      Erector.inline do
+        p "first paragraph"
+        p "second paragraph"
+      end.to_text.should == "first paragraph\n\nsecond paragraph\n"
+    end
+
+    it "separates p tags with attributes" do
+      Erector.inline do
+        p "first paragraph", :class => "first"
+        p "second paragraph", :class => "second"
+      end.to_text.should == "first paragraph\n\nsecond paragraph\n"
+    end
+
+    it "puts a newline after a br tag" do
+      Erector.inline do
+        text "first line"
+        br
+        text "second line"
+      end.to_text.should == "first line\nsecond line"
+    end
+
+    it "formats a UL (unordered list) using asterisks for bullets" do
+      Erector.inline do
+        ul do
+          li "vanilla"
+          li "chocolate"
+          li "strawberry"
+        end
+      end.to_text.should == "\n* vanilla\n* chocolate\n* strawberry\n"
+    end
+
+    # it's too hard to keep track of numbers with a regexp munger, so just use asterisks for bullets
+    # todo: integrate text output into core rendering code
+    it "formats an OL (ordered list)" do
+      Erector.inline do
+        ol do
+          li "vanilla"
+          li "chocolate"
+          li "strawberry"
+        end
+      end.to_text.should == "\n* vanilla\n* chocolate\n* strawberry\n"
+    end
+  end
+
+  describe "#join" do
+    it "empty array means nothing to join" do
+      erector do
+        join [], Erector::Widget.new { text "x" }
+      end.should == ""
+    end
+
+    it "larger example with two tabs" do
+      erector do
+        tab1 =
+                Erector.inline do
+                  a "Upload document", :href => "/upload"
+                end
+        tab2 =
+                Erector.inline do
+                  a "Logout", :href => "/logout"
+                end
+        join [tab1, tab2],
+             Erector::Widget.new { text nbsp(" |"); text " " }
+      end.should ==
+              '<a href="/upload">Upload document</a>&#160;| <a href="/logout">Logout</a>'
+    end
+
+    it "plain string as join separator means pass it to text" do
+      erector do
+        join [
+                Erector::Widget.new { text "x" },
+                Erector::Widget.new { text "y" }
+        ], "<>"
+      end.should == "x&lt;&gt;y"
+    end
+
+    it "plain string as item to join means pass it to text" do
+      erector do
+        join [
+                "<",
+                "&"
+        ], Erector::Widget.new { text " + " }
+      end.should == "&lt; + &amp;"
+    end
+  end
+
+  describe "#css" do
+    it "makes a link when passed a string" do
+      erector do
+        css "erector.css"
+      end.should == "<link href=\"erector.css\" rel=\"stylesheet\" type=\"text/css\" />"
+    end
+
+    it "accepts a media attribute" do
+      erector do
+        css "print.css", :media => "print"
+      end.should == "<link href=\"print.css\" media=\"print\" rel=\"stylesheet\" type=\"text/css\" />"
+    end
+
+    it "passes extra attributes through" do
+      erector { css "foo.css", :title => 'Foo' }.should == "<link href=\"foo.css\" rel=\"stylesheet\" title=\"Foo\" type=\"text/css\" />"
+    end
+  end
+
+  describe "#url" do
+    it "renders an anchor tag with the same href and text" do
+      erector do
+        url "http://example.com"
+      end.should == "<a href=\"http://example.com\">http://example.com</a>"
+    end
+
+    it "accepts extra attributes" do
+      erector do
+        url "http://example.com", :onclick=>"alert('foo')"
+      end.should == "<a href=\"http://example.com\" onclick=\"alert('foo')\">http://example.com</a>"
+    end
+
+  end
+
+  describe "#dom_id" do
+    class DOMIDWidget < Erector::Widget
+      def content
+        div :id => dom_id
+      end
+    end
+
+    it "makes a unique id based on the widget's class name and object id" do
+      widget = DOMIDWidget.new
+      widget.dom_id.should include("#{widget.object_id}")
+      widget.dom_id.should include("DOMIDWidget")
+    end
+
+    it "can be used as an HTML id" do
+      widget = DOMIDWidget.new
+      widget.to_html.should == "<div id=\"#{widget.dom_id}\"></div>"
+    end
+
+    describe 'for a namespaced widget class' do
+
+      module ::ErectorConvenienceSpec
+        class NestedWidget < Erector::Widget
+        end
+      end
+
+      it 'is colon escaped' do
+        g = ErectorConvenienceSpec::NestedWidget.new
+        g.dom_id.should_not =~ /:/
+      end
+
+      it 'combines all parent namespaces' do
+        g = ErectorConvenienceSpec::NestedWidget.new
+        g.dom_id.should == "ErectorConvenienceSpec_NestedWidget_#{g.object_id}"
+      end
+
+    end
+
+  end
+end
+