stonean-ruhl 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.DS_Store
+*.swp
+pkg/**
+coverage/**

data/README

@@ -0,0 +1,48 @@
+Ruhl (Ruby Hypertext Language)
+
+This project is here to flesh out an idea.  What I want is to have developers work with HTML and with the simple addition of a 'ruby' attribute, convert it to a dynamic page.
+
+At no time in the dev process would the view be unviewable in a browser.  The view could actually retain the original template data the designer used because this replaces the content.  I think this is a nice plus.
+
+
+Notes (use cases) for me to remember:
+
+##############################################################################
+
+<ul id="aab" ruby="present_results">
+ <li>Lorem ipsum dolor sit amet</li>
+ <li>consectetur adipiscing elit</li>
+</ul>
+
+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.
+
+
+##############################################################################
+
+<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.  
+
+
+##############################################################################
+
+<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.
+
+
+##############################################################################
+
+Things to note:
+
+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: 
+
+1) Work on supporting templates  (shouldn't be hard)
+2) Work on supporting partials (shouldn't be hard)
+

data/Rakefile

@@ -0,0 +1,30 @@
+require 'rubygems'
+require 'rake'
+require 'rcov'
+require 'spec/rake/spectask'
+
+task :default => 'rcov'
+
+desc "Run all specs and rcov in a non-sucky way"
+Spec::Rake::SpecTask.new(:rcov) do |t|
+  t.spec_opts = IO.readlines("spec/spec.opts").map {|l| l.chomp.split " "}.flatten
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.rcov = true
+  t.rcov_opts = IO.readlines("spec/rcov.opts").map {|l| l.chomp.split " "}.flatten
+end
+
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "ruhl"
+    gemspec.summary = "Ruby Hypertext Language"
+    gemspec.description = "Make your HTML dynamic with the addition of a ruby attribute."
+    gemspec.email = "andy@stonean.com"
+    gemspec.homepage = "http://github.com/stonean/ruhl"
+    gemspec.authors = ["Andrew Stone"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/ruhl.rb

@@ -0,0 +1,52 @@
+$:.unshift File.dirname(__FILE__)
+
+require 'nokogiri'
+require 'ruhl/errors'
+
+module Ruhl
+  class Engine
+    attr_reader :doc, :scope
+
+    def initialize(html)
+      @doc = Nokogiri::HTML(html)
+    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
+
+        tag.remove_attribute('ruby')
+      end
+
+      doc.to_s
+    end
+
+    private
+
+    def process_attribute(tag,code)
+      parts = code.split(';')
+      parts.each do |pair|
+        attribute, value = pair.split(':')
+
+        tag[attribute] = execute_ruby(tag, value.strip)
+      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)
+    end
+  end
+end

data/lib/ruhl/errors.rb

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

data/lib/ruhl/sinatra.rb

@@ -0,0 +1,15 @@
+module Sinatra
+  module Templates
+    def ruhl(template, options = {}, locals = {})
+      require_warn('Ruhl') unless defined?(::Ruhl::Engine)
+
+      render :ruhl, template, options, locals
+    end
+
+    private
+
+    def render_ruhl(template, data, options, locals, &block)
+      ::Ruhl::Engine.new(data).render(self)
+    end
+  end
+end

data/spec/html/basic.html

@@ -0,0 +1,9 @@
+<html>
+  <head>
+    <title>Hello World</title>
+  </head>
+  <body>
+    <h1 ruby="generate_h1">I am a templated headline</h1>
+    <p>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>
+  </body>
+</html>

data/spec/html/medium.html

@@ -0,0 +1,12 @@
+<html>
+  <head>
+    <title>This is a title template</title>
+  </head>
+  <body>
+    <h1>This is the header template</h1>
+    <ul ruby="present_results">
+      <li>Lorem ipsum dolor sit amet</li> 
+      <li>consectetur adipiscing elit.</li>
+    </ul>
+  </body>
+</html>

data/spec/html/seo.html

@@ -0,0 +1,11 @@
+<html>
+  <head>
+    <title>This is a title template</title>
+    <meta ruby="content: generate_description" content='This is a description template' id='metaDescription' name='description' />
+    <meta ruby="content: generate_keywords" content='these,are,template,keywords' id='metaKeywords' name='keywords' />
+  </head>
+  <body>
+    <h1 ruby="generate_h1">I am a templated headline</h1>
+    <p>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>
+  </body>
+</html>

data/spec/rcov.opts

@@ -0,0 +1,5 @@
+--text-summary
+--exclude
+  json,FakeWeb,rcov.rb,rspec,spec
+--sort
+  coverage

data/spec/ruhl_spec.rb

@@ -0,0 +1,68 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+def generate_h1(tag = nil)
+  "data from presenter"     
+end
+
+def data_from_method(tag = nil)
+  "I am data from a method"
+end
+
+def generate_description(tag = nil)
+  "I am a custom meta description"
+end
+
+def generate_keywords(tag = nil)
+  "I, am, custom, keywords"
+end
+
+def present_results(tag = nil)
+  "<li>line item 1</li><li>line item 2</li>"
+end
+
+describe Ruhl do
+
+  describe "basic.html" do
+    before do
+      @html = File.read html(:basic) 
+    end
+
+    it "content of p should be content from data_from_method" do
+       doc = create_doc
+       doc.xpath('//h1').first.content.should == generate_h1
+    end
+  end
+
+  describe "seo.html" do
+    before do
+      @html = File.read html(:seo)
+    end
+
+    it "meta keywords should be replaced" do
+      doc = create_doc
+      doc.xpath('//meta[@name="keywords"]').first['content'].
+        should == generate_keywords 
+    end
+
+    it "meta title should be replaced" do
+      doc = create_doc
+      doc.xpath('//meta[@name="description"]').first['content'].
+        should == generate_description
+    end
+  end
+
+  describe "medium.html" do
+    before do
+      @html = File.read html(:medium)
+    end
+
+    it "ul content should have new li's" do
+      doc = create_doc
+      ul = doc.xpath('//ul').first
+      ul.inner_html.should ==  "<li>line item 1</li>\n<li>line item 2</li>\n"
+    end
+  end
+end
+
+
+

data/spec/spec.opts

@@ -0,0 +1,3 @@
+--color
+--format
+  progress

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require File.expand_path(File.join(File.dirname(__FILE__), %w[.. lib ruhl]))
+
+def html(name)
+  File.join( File.dirname(__FILE__), 'html', "#{name}.html" )
+end
+
+def do_parse(html)
+  Nokogiri::HTML(html)
+end
+
+def create_doc
+  html = Ruhl::Engine.new(@html).render(self)
+  do_parse(html)
+end
+ 

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: stonean-ruhl
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Andrew Stone
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-16 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Make your HTML dynamic with the addition of a ruby attribute.
+email: andy@stonean.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- .gitignore
+- README
+- Rakefile
+- VERSION
+- lib/ruhl.rb
+- lib/ruhl/errors.rb
+- lib/ruhl/sinatra.rb
+- spec/html/basic.html
+- spec/html/medium.html
+- spec/html/seo.html
+- spec/rcov.opts
+- spec/ruhl_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: false
+homepage: http://github.com/stonean/ruhl
+licenses: 
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Ruby Hypertext Language
+test_files: 
+- spec/ruhl_spec.rb
+- spec/spec_helper.rb