honkster-erector 0.8.1

data/spec/erect/rhtml_parser_spec.rb

@@ -0,0 +1,361 @@
+require File.expand_path("#{File.dirname(__FILE__)}/../spec_helper")
+
+require "erector/erect/erect"
+
+module ParserTestHelper
+  def assert_evals_to_self(input)
+    assert_evals_to(input, input)
+  end
+
+  def parse(input)
+    result = @parser.parse(input)
+    if result
+      result.set_indent(0) if result.respond_to? :set_indent
+    else
+      puts @parser.failure_reason
+      puts @parser.terminal_failures.join("\n")
+      result.should_not be_nil
+    end
+    result
+  end
+end
+
+describe RhtmlParser do
+  include ParserTestHelper
+  
+  before :each do
+    @parser = RhtmlParser.new
+  end
+  
+  it "converts text" do
+    parse("hello").convert.should == "text 'hello'\n"
+    parse("hello maude!").convert.should == "text 'hello maude!'\n"
+    parse(" hello ").convert.should == "text 'hello'\n"
+  end
+  
+  it "unescapes HTML entities in text" do
+      parse("&lt;").convert.should == "text '<'\n"
+      parse("5 &gt; 2").convert.should == "text '5 > 2'\n"
+  end
+
+  it "converts self-closing tags" do
+    parse("<br/>").convert.should == "br\n"
+    parse("<br />").convert.should == "br\n"
+  end
+
+  it "converts open tag" do
+    parse("<div>").convert.should == "div do\n"
+    parse("<h1>").convert.should == "h1 do\n"
+  end
+
+  it "converts close tag" do
+    parse("</div>").convert.should == "end\n"
+    parse("</h1>").convert.should == "end\n"
+  end
+
+  it "converts two nested divs" do
+    parse("<div><div></div></div>").convert.should ==
+      "div do\n" +
+      "  div do\n" +
+      "  end\n" +
+      "end\n"
+  end
+
+  it "converts two nested divs with whitespace" do
+    parse("<div> <div> </div> </div>").convert.should ==
+      "div do\n" +
+      "  div do\n" +
+      "  end\n" +
+      "end\n"
+  end
+
+  it "converts no open, text, and no close tag" do
+    parse("hello</div>").convert.should == "text 'hello'\nend\n"
+  end
+
+  it "converts open, text, and no close tag" do
+    parse("<div>hello").convert.should == "div do\n  text 'hello'\n"
+  end
+
+  it "converts open, text, close" do
+    parse("<div>hello</div>").convert.should == "div do\n  text 'hello'\nend\n"
+  end
+  
+  it "autocloses an img tag" do
+    parse("<img src='foo'>").convert.should == "img :src => 'foo'\n"
+  end
+
+  it "converts a scriptlet" do
+    parse("<% foo %>").convert.should == "foo\n"
+  end
+
+  it "converts open, text, scriptlet, text, close" do
+    parse("<div>hello <% 5.times do %> very <% end %> much</div>").convert.should ==
+      "div do\n" +
+      "  text 'hello'\n" +
+      "  5.times do\n" +
+      "    text 'very'\n" +
+      "  end\n" +
+      "  text 'much'\n" +
+      "end\n"
+  end
+
+  it "converts open, scriptlet, text, close" do
+    parse("<div><% 5.times do %> very <% end %> much</div>").convert.should ==
+      "div do\n" +
+      "  5.times do\n" +
+      "    text 'very'\n" +
+      "  end\n" +
+      "  text 'much'\n" +
+      "end\n"
+  end
+
+  it "converts open, text, scriptlet, close" do
+    parse("<div>hello <% 5.times do %> very <% end %></div>").convert.should ==
+      "div do\n" +
+      "  text 'hello'\n" +
+      "  5.times do\n" +
+      "    text 'very'\n" +
+      "  end\n" +
+      "end\n"
+  end
+
+  it "converts printlets into rawtext statements" do
+    parse("<%= 1+1 %>").convert.should == "rawtext 1+1\n"
+    parse("<%= link_to \"mom\" %>").convert.should == "rawtext link_to(\"mom\")\n"
+  end
+
+  it "converts h-printlets into text statements" do
+    parse("<%=h foo %>").convert.should == "text foo\n"
+    parse("<%= h \"mom\" %>").convert.should == "text \"mom\"\n"
+  end
+
+  it "allows naked percent signs inside scriptlets" do
+      parse("<% x = 10 % 5 %>").convert.should == "x = 10 % 5\n"
+  end
+
+  it "indents" do
+    i = Erector::Indenting.new(nil, nil)
+    i.line("foo").should ==     "foo\n"
+    i.line_in("bar").should ==  "bar\n"
+    i.line_in("baz").should ==  "  baz\n"
+    i.line("baf").should ==     "    baf\n"
+    i.line_out("end").should == "  end\n"
+    i.line_out("end").should == "end\n"
+  end
+
+  it "indents extra when told to" do
+    parse("<div>hello</div>").set_indent(2).convert.should ==
+      "    div do\n" +
+      "      text 'hello'\n" +
+      "    end\n"
+  end
+
+  it "indents scriptlets ending with do and end" do
+    parse("<% form_for :foo do |x,y| %><% 5.times do %>hello<% end %><% end %>bye").convert.should ==
+      "form_for :foo do |x,y|\n" +
+      "  5.times do\n" +
+      "    text 'hello'\n" +
+      "  end\n" +
+      "end\n" +
+      "text 'bye'\n"
+  end
+
+  it "converts HTML attributes" do
+    parse("<div id='foo'/>").convert.should == "div :id => 'foo'\n"
+    parse("<div id='foo' class='bar'/>").convert.should == "div :id => 'foo', :class => 'bar'\n"
+    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'"
+  end
+
+  it "escapes single quotes inside text strings" do
+    parse("isn't she lovely").convert.should == "text 'isn" + "\\" + "'t she lovely'\n"
+  end
+
+  it "allows newlines where whitespace is allowed" do
+    parse("<img src='foo' \nalt='bar' />").convert.should == "img :src => 'foo', :alt => 'bar'\n"
+  end
+  
+  it "treats tab characters the same as spaces" do
+    parse("<div \t />").convert.should == "div\n"
+  end
+  
+  it "deals with HTML entities in text" do
+    parse("&lt;").convert.should == "text '<'\n"
+  end
+
+  it "deals with a naked less-than or greater-than sign inside text" do
+    parse("if x > 2 or x< 5 then").convert.should == "text 'if x > 2 or x< 5 then'\n"
+  end
+
+  it "wraps printlets in parens if necessary, to avoid warning: parenthesize argument(s) for future version" do
+    parse("<%= h \"mom\" %>").convert.should == "text \"mom\"\n"
+    parse("<%= h hi \"mom\" %>").convert.should == "text hi(\"mom\")\n"
+
+    parse("<%= \"mom\" %>").convert.should == "rawtext \"mom\"\n"
+    parse("<%= \"hi mom\" %>").convert.should == "rawtext \"hi mom\"\n"
+    parse("<%= hi \"mom\" %>").convert.should == "rawtext hi(\"mom\")\n"
+
+    parse("<%= link_to blah %>").convert.should == "rawtext link_to(blah)\n"
+    parse("<%= link_to blah blah %>").convert.should == "rawtext link_to(blah blah)\n"
+    parse("<%= link_to blah(blah) %>").convert.should == "rawtext link_to(blah(blah))\n"
+
+    parse("<%= link_to(blah) %>").convert.should == "rawtext link_to(blah)\n"
+  end
+  
+  it "won't parenthesize expressions" do
+    parse("<%= h foo / bar %>").convert.should == "text foo / bar\n"
+  end
+
+  it "understands a varname" do
+    @parser.root = :varname
+    parse("head").text_value.should == "head"
+  end
+  
+  it "converts yield printlet into a use of @content_for_layout, commented for your edification" do
+    parse("<%= yield  %>").convert.should == "rawtext @content_for_layout # Note: you must define @content_for_layout elsewhere\n"
+    parse("<%=  yield :head   %>").convert.should == "rawtext @content_for_head # Note: you must define @content_for_head elsewhere\n"
+    parse("<%= \"yield\" %>").convert.should == "rawtext \"yield\"\n"
+    parse("<%= \"the yield is good\" %>").convert.should == "rawtext \"the yield is good\"\n"
+  end
+  
+  it "parses quoted strings" do
+    @parser.root = :quoted
+    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
+    parse("a='foo'").convert.should == ":a => 'foo'"
+    parse("a=\"foo\"").convert.should == ":a => 'foo'"
+  end
+  
+  it "parses a set of attributes" do
+    @parser.root = :attributes
+    parse("a='foo' b='bar'").convert.should == " :a => 'foo', :b => 'bar'"
+  end
+  
+  it "works with namespaced attributes" do
+    @parser.root = :attribute
+    parse('xml:lang="en"').convert.should == "'xml:lang' => 'en'"
+  end
+  
+  it "deals with HTML entities in attribute values" do
+    @parser.root = :attribute
+    parse("foo='b<r'").convert.should == ":foo => 'b<r'"
+    parse("foo='b&lt;r'").convert.should == ":foo => 'b<r'"
+  end
+
+  it "converts DOCTYPEs" do
+    html = '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+           "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
+    parse(html).convert.should == "rawtext '#{html}'\n"
+  end
+  
+  ["<!--[if IE]>", "<![endif]-->", "<![if !IE]>", "<![endif]>", "<!--[if IE 5.5000]>", "<!--[if IE 6]>"].each do |html|
+    it "converts IE directive '#{html}'" do
+      parse(html).convert.should == "rawtext '#{html}'\n"
+    end
+  end
+
+  ## More functional-type specs below here
+
+  it "ignores spaces, tabs and newlines" do
+    parse("  <div>\t\n" + "\thello !" + "\n\t</div>").convert.should ==
+      "div do\n" +
+      "  text 'hello !'\n" +
+      "end\n"
+  end
+
+  it "parses some scaffolding" do
+    parse("<p>
+  <b>Name:</b>
+  <%=h @foo.name %>
+</p>").convert.should ==
+      "p do\n" +
+      "  b do\n" +
+      "    text 'Name:'\n" +
+      "  end\n" +
+      "  text @foo.name\n" +
+      "end\n"
+  end
+
+  it "parses edit.erb.html" do
+    parse("<h1>Editing foo</h1>
+
+<%= error_messages_for :foo %>
+
+<% form_for(@foo) do |f| %>
+  <p>
+    <b>Name</b><br />
+    <%= f.text_field :name %>
+  </p>
+
+  <p>
+    <b>Age</b><br />
+    <%= f.text_field :age %>
+  </p>
+
+  <p>
+    <%= f.submit \"Update\" %>
+  </p>
+<% end %>
+
+<%= link_to 'Show', @foo %> |
+<%= link_to 'Back', foos_path %>
+")
+  end
+
+  it "parses show.html.erb" do
+    parse("<p>
+  <b>Name:</b>
+  <%=h @foo.name %>
+</p>
+
+<p>
+  <b>Age:</b>
+  <%=h @foo.age %>
+</p>
+
+
+<%= link_to 'Edit', edit_foo_path(@foo) %> |
+<%= link_to 'Back', foos_path %>
+")
+  end
+
+  it "does meta" do
+    parse('<meta http-equiv="content-type" content="text/html;charset=UTF-8" />').convert.should ==
+    "meta 'http-equiv' => 'content-type', :content => 'text/html;charset=UTF-8'\n"
+  end
+  
+  it "parses JayTee's IE and DOCTYPE test file" do
+    parse <<-HTML
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<!--[if IE]><link href="custom.css" rel="stylesheet" type="text/css" /><![endif]-->
+<!--[if IE]><link href="custom.css" rel="stylesheet" type="text/css" /><![endif]-->
+<script language="javascript" type="text/javascript"> /* <![CDATA[ */
+var myJavascriptCode = 1; /*]]>*/ </script>
+</head>
+<body>
+</body>
+</html>
+    HTML
+  end
+end

data/spec/erector/caching_spec.rb

@@ -0,0 +1,269 @@
+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" do
+        pending
+      end
+    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