added support for layouts

reinh · Sep 18, 2009 · 33f0df3 · 33f0df3
1 parent dac3e4a
commit 33f0df3
Show file tree

Hide file tree

Showing 8 changed files with 127 additions and 31 deletions.
diff --git a/README b/README
@@ -7,7 +7,27 @@ At no time in the dev process would the view be unviewable in a browser.  The vi
 
 Notes (use cases) for me to remember:
 
-##############################################################################
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+:: Basic Use ::
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+<h1 ruby="page_header">
+
+Method :page_header would know how to represent itself in the context of the h1 element.
+
+The ruby executed would replace the content of the element it was being called on.  
+
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+:: Replacing attribute values ::
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+<meta ruby="content: meta_description" content='This is a description template' id='metaDescription' name='description' />
+
+content: meta_description is telling the parser to replace attribute 'content' with results from meta_description method.
+
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+:: Don't use iterators in views ::
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 <ul id="aab" ruby="present_results">
  <li>Lorem ipsum dolor sit amet</li>
@@ -16,26 +36,36 @@ Notes (use cases) for me to remember:
 
 Method :present_results would know how to represent itself in the context of the ul element.  In other words, it would know how to produce <li> elements.
 
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+:: Using a Layout ::
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-##############################################################################
-
-<h1 ruby="page_header">
-
-Method :page_header would know how to represent itself in the context of the h1 element.
-
-The ruby executed would replace the content of the element it was being called on.  
+Layout:
+<html>
+  <head>
+    <title>This is a title template</title>
+  </head>
+  <body>
+    <div ruby="_render_"></div>
+  </body>
+</html>
 
+Fragment:
+<h1 ruby="generate_h1">I am a templated headline</h1>
+<p ruby="my_content">Lorem ipsum dolor sit amet</p>
 
-##############################################################################
+To use:
 
-<meta ruby="content: meta_description" content='This is a description template' id='metaDescription' name='description' />
+Ruhl::Engine.new(File.read(fragment), :layout => path_to_layout).render(self)
 
-content: meta_description is telling the parser to replace attribute 'content' with results from meta_description method.
+Returns the expected result of parsed Layout w/ parsed Fragment.  Note the use of the _render_ method.  This is a 'special' method that Ruhl uses to inject the results of the parsed fragment into the layout.
 
 
-##############################################################################
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+:: Notes ::
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Things to note:
+* No eval (I don't think eval is evil, it's just not the way this works)
 
 * The ruby attribute is always removed from the output.
 
@@ -46,7 +76,9 @@ Things to note:
     au BufNewFile,BufRead *.ruhl set filetype=html
 
 
-TODO: 
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+:: TODO ::
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 1) Work on supporting templates  (shouldn't be hard)
 2) Work on supporting partials (shouldn't be hard)

diff --git a/lib/ruhl.rb b/lib/ruhl.rb
@@ -5,28 +5,36 @@
 
 module Ruhl
   class Engine
-    attr_reader :doc, :scope
+    attr_reader :document, :scope, :layout
 
-    def initialize(html)
-      @doc = Nokogiri::HTML(html)
+    def initialize(html, options = {})
+      if @layout = options[:layout]
+        raise LayoutNotFoundError.new(@layout) unless File.exists?(@layout)
+
+        @document = Nokogiri::HTML.fragment(html)
+      else
+        @document = Nokogiri::HTML(html)
+      end
     end
 
     def render(current_scope)
       set_scope(current_scope)
 
-      doc.xpath('//*[@ruby]').each do |tag|
-        code = tag['ruby']
-
-        if code =~ /^\w+:/
-          process_attribute(tag,code)
-        else
-          tag.inner_html = execute_ruby(tag,code)
-        end
+      parse_doc(@document)
 
-        tag.remove_attribute('ruby')
+      if @layout
+        render_with_layout 
+      else
+        document.to_s
       end
+    end
 
-      doc.to_s
+    # The _render_ method is used within a layout to inject
+    # the results of the template render.
+    #
+    # Ruhl::Engine.new(html, :layout => path_to_layout).render(self)
+    def _render_
+      document.to_s
     end
 
     private
@@ -40,13 +48,41 @@ def process_attribute(tag,code)
       end
     end
 
+    def render_with_layout
+     doc = Nokogiri::HTML( File.read(@layout) ) 
+     parse_doc(doc)
+     doc.to_s
+    end
+
+    def parse_doc(doc)
+      if (nodes = doc.xpath('//*[@ruby]')).empty?
+        nodes = doc.xpath('*[@ruby]')
+      end
+
+      nodes.each do |tag|
+        code = tag['ruby']
+
+        if code =~ /^\w+:/
+          process_attribute(tag,code)
+        else
+          tag.inner_html = execute_ruby(tag,code)
+        end
+
+        tag.remove_attribute('ruby')
+      end
+    end
+
     def set_scope(current_scope)
       raise Ruhl::NoScopeError unless current_scope
       @scope = current_scope 
     end
 
     def execute_ruby(tag, code)
-      scope.send(code, tag)
+      unless code == '_render_'
+        scope.send(code, tag)
+      else
+        _render_
+      end
     end
   end
 end
diff --git a/lib/ruhl/errors.rb b/lib/ruhl/errors.rb
@@ -1,3 +1,4 @@
 module Ruhl
+  class LayoutNotFoundError < StandardError; end
   class NoScopeError < StandardError; end
 end
diff --git a/lib/ruhl/sinatra.rb b/lib/ruhl/sinatra.rb
@@ -9,7 +9,7 @@ def ruhl(template, options = {}, locals = {})
     private
 
     def render_ruhl(template, data, options, locals, &block)
-      ::Ruhl::Engine.new(data).render(self)
+      ::Ruhl::Engine.new(data, options).render(self)
     end
   end
 end
diff --git a/spec/html/fragment.html b/spec/html/fragment.html
@@ -0,0 +1,2 @@
+<h1 ruby="generate_h1">I am a templated headline</h1>
+<p ruby="my_content">Lorem ipsum dolor sit amet, consectetur adipiscing elit. Curabitur sit amet lacinia metus. Nam sed dui est. Sed pellentesque aliquet massa, vel cursus arcu faucibus tincidunt. Nunc aliquet ultricies tellus sit amet elementum. Integer porttitor lorem dolor. Proin leo nunc, sollicitudin sed ullamcorper non, tempus non erat. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Sed commodo sodales pharetra. Vivamus pharetra, augue a volutpat scelerisque, elit nisl auctor elit, quis mollis dolor urna in ligula. Aliquam nisi augue, adipiscing quis mollis ut, aliquam nec urna. Morbi faucibus semper ante ut dignissim. Maecenas et dui eros, eget tristique odio. Sed vehicula erat nec dui porttitor laoreet.</p>
diff --git a/spec/html/layout.html b/spec/html/layout.html
@@ -0,0 +1,8 @@
+<html>
+  <head>
+    <title>This is a title template</title>
+  </head>
+  <body>
+    <div ruby="_render_"></div>
+  </body>
+</html>
diff --git a/spec/ruhl_spec.rb b/spec/ruhl_spec.rb
@@ -20,6 +20,10 @@ def present_results(tag = nil)
   "<li>line item 1</li><li>line item 2</li>"
 end
 
+def my_content(tag = nil)
+  "hello from my content."
+end
+
 describe Ruhl do
 
   describe "basic.html" do
@@ -62,6 +66,18 @@ def present_results(tag = nil)
       ul.inner_html.should ==  "<li>line item 1</li>\n<li>line item 2</li>\n"
     end
   end
+
+  describe "fragment.html" do
+    before do
+      @html = File.read html(:fragment)
+    end
+
+    it "will be injected into layout.html" do
+      doc  = create_doc( html(:layout) )
+      puts '*'*40
+      puts doc.to_s
+    end
+  end
 end
 
 

diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb
@@ -8,8 +8,9 @@ def do_parse(html)
   Nokogiri::HTML(html)
 end
 
-def create_doc
-  html = Ruhl::Engine.new(@html).render(self)
+def create_doc(layout = nil)
+  options = {:layout => layout} 
+  html = Ruhl::Engine.new(@html, :layout => layout).render(self)
   do_parse(html)
 end