RubyGems - stonean-ruhl - Versions diffs - 0.1.0 → 0.2.0 - Mend

stonean-ruhl 0.1.0 → 0.2.0

Files changed (11) hide show

data/README CHANGED Viewed

@@ -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,32 +36,49 @@ 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 ::
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-##############################################################################
+Layout:
+<html>
+  <head>
+    <title>This is a title template</title>
+  </head>
+  <body>
+    <div ruby="_render_"></div>
+  </body>
+</html>
-<h1 ruby="page_header">
+Fragment:
+<h1 ruby="generate_h1">I am a templated headline</h1>
+<p ruby="my_content">Lorem ipsum dolor sit amet</p>
-Method :page_header would know how to represent itself in the context of the h1 element.
+To use:
-The ruby executed would replace the content of the element it was being called on.
+Ruhl::Engine.new(File.read(fragment), :layout => path_to_layout).render(self)
+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.
-##############################################################################
-<meta ruby="content: meta_description" content='This is a description template' id='metaDescription' name='description' />
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+:: Notes ::
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-content: meta_description is telling the parser to replace attribute 'content' with results from meta_description method.
+* 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.
-##############################################################################
+* Each method called must accept a tag parameter.
+    e.g def page_header(tag)
-Things to note:
+* Since it's just HTML, syntax highlighting is built-in.  For vim, just add this to your ~/.vimrc:
+    au BufNewFile,BufRead *.ruhl set filetype=html
-1) The ruby attribute is always removed from the output.
-2) Each method called must accept a tag parameter.
-  e.g def page_header(tag)
-TODO:
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+:: TODO ::
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 1) Work on supporting templates  (shouldn't be hard)
 2) Work on supporting partials (shouldn't be hard)

data/VERSION CHANGED Viewed

	@@ -1 +1 @@
1	- 0.1.0
1	+ 0.2.0

data/lib/ruhl.rb CHANGED Viewed

@@ -5,28 +5,36 @@ require 'ruhl/errors'
 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 @@ module Ruhl
       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

data/lib/ruhl/errors.rb CHANGED Viewed

@@ -1,3 +1,4 @@
 module Ruhl
+  class LayoutNotFoundError < StandardError; end
   class NoScopeError < StandardError; end
 end

data/lib/ruhl/sinatra.rb CHANGED Viewed

@@ -9,7 +9,7 @@ module Sinatra
     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

data/ruhl.gemspec ADDED Viewed

@@ -0,0 +1,56 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+Gem::Specification.new do |s|
+  s.name = %q{ruhl}
+  s.version = "0.2.0"
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Andrew Stone"]
+  s.date = %q{2009-09-17}
+  s.description = %q{Make your HTML dynamic with the addition of a ruby attribute.}
+  s.email = %q{andy@stonean.com}
+  s.extra_rdoc_files = [
+    "README"
+  ]
+  s.files = [
+    ".gitignore",
+     "README",
+     "Rakefile",
+     "VERSION",
+     "lib/ruhl.rb",
+     "lib/ruhl/errors.rb",
+     "lib/ruhl/sinatra.rb",
+     "ruhl.gemspec",
+     "spec/html/basic.html",
+     "spec/html/fragment.html",
+     "spec/html/layout.html",
+     "spec/html/medium.html",
+     "spec/html/seo.html",
+     "spec/rcov.opts",
+     "spec/ruhl_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/stonean/ruhl}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Ruby Hypertext Language}
+  s.test_files = [
+    "spec/ruhl_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/spec/html/fragment.html ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ <h1 ruby="generate_h1">I am a templated headline</h1>
2	+ <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>

data/spec/html/layout.html ADDED Viewed

@@ -0,0 +1,8 @@
+<html>
+  <head>
+    <title>This is a title template</title>
+  </head>
+  <body>
+    <div ruby="_render_"></div>
+  </body>
+</html>

data/spec/ruhl_spec.rb CHANGED Viewed

@@ -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 @@ describe Ruhl do
       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

data/spec/spec_helper.rb CHANGED Viewed

@@ -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

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stonean-ruhl
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Andrew Stone
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
-date: 2009-09-16 00:00:00 -07:00
+date: 2009-09-17 00:00:00 -07:00
 default_executable:
 dependencies: []
@@ -29,7 +29,10 @@ files:
 - lib/ruhl.rb
 - lib/ruhl/errors.rb
 - lib/ruhl/sinatra.rb
+- ruhl.gemspec
 - spec/html/basic.html
+- spec/html/fragment.html
+- spec/html/layout.html
 - spec/html/medium.html
 - spec/html/seo.html
 - spec/rcov.opts