RubyGems - jam - Versions diffs - 0.2 - Mend

jam 0.2

Files changed (43) hide show

data/HISTORY +21 -0
data/MANIFEST +52 -0
data/README +39 -0
data/TODO +22 -0
data/bin/jam +0 -0
data/demo/array.rb +16 -0
data/demo/attribute.rb +24 -0
data/demo/demi/fixtures/ex1.html +10 -0
data/demo/demi/fixtures/samples.yaml +19 -0
data/demo/demi/integration/01_jam.rd +41 -0
data/demo/demi/integration/02_xpath.rd +41 -0
data/demo/demi/integration/samples.rd +28 -0
data/demo/demi/unit/hpricot.rd +150 -0
data/demo/demi/unit/libxml.rd +75 -0
data/demo/demi/unit/nokogiri.rd +148 -0
data/demo/demi/unit/rexml.rd +63 -0
data/demo/hash.rb +20 -0
data/demo/helloworld.rb +12 -0
data/demo/object.rb +19 -0
data/demo/table.rb +24 -0
data/js/jquery.jam.js +230 -0
data/lib/jam.rb +2 -0
data/lib/jam/cherry.rb +1 -0
data/lib/jam/css2xpath.rb +104 -0
data/lib/jam/css_to_xpath.rb +132 -0
data/lib/jam/engine.rb +169 -0
data/lib/jam/hpricot.rb +137 -0
data/lib/jam/libxml.rb +151 -0
data/lib/jam/nokogiri.rb +167 -0
data/lib/jam/rexml.rb +135 -0
data/lib/jam/template.rb +224 -0
data/meta/abstract +2 -0
data/meta/author +1 -0
data/meta/created +1 -0
data/meta/homepage +1 -0
data/meta/package +1 -0
data/meta/project +1 -0
data/meta/status +1 -0
data/meta/summary +1 -0
data/meta/timestamp +1 -0
data/meta/title +1 -0
data/meta/version +1 -0
metadata +103 -0

data/HISTORY ADDED

@@ -0,0 +1,21 @@
+= Jam Change History
+== 0.2 / 2009-06-15
+This release cleans up the code and adds support for
+extensions. Currently only Nokigiri is supported as
+a backend engine.
+Changes:
+* Rewrote the backend to support #jam extensions.
+== 0.1 / 2009-06-01
+This is the first version of Jam, as extracted from the
+Cherry project.
+Changes:
+* Happy Birthday!

data/MANIFEST ADDED

@@ -0,0 +1,52 @@
+#!mast bin demo js lib meta test [A-Z]*
+bin
+bin/jam
+demo
+demo/array.rb
+demo/attribute.rb
+demo/demi
+demo/demi/fixtures
+demo/demi/fixtures/ex1.html
+demo/demi/fixtures/samples.yaml
+demo/demi/integration
+demo/demi/integration/01_jam.rd
+demo/demi/integration/02_xpath.rd
+demo/demi/integration/samples.rd
+demo/demi/unit
+demo/demi/unit/hpricot.rd
+demo/demi/unit/libxml.rd
+demo/demi/unit/nokogiri.rd
+demo/demi/unit/rexml.rd
+demo/hash.rb
+demo/helloworld.rb
+demo/object.rb
+demo/table.rb
+js
+js/jquery.jam.js
+lib
+lib/jam
+lib/jam/cherry.rb
+lib/jam/css2xpath.rb
+lib/jam/css_to_xpath.rb
+lib/jam/engine.rb
+lib/jam/hpricot.rb
+lib/jam/libxml.rb
+lib/jam/nokogiri.rb
+lib/jam/rexml.rb
+lib/jam/template.rb
+lib/jam.rb
+meta
+meta/abstract
+meta/author
+meta/created
+meta/homepage
+meta/package
+meta/project
+meta/status
+meta/summary
+meta/timestamp
+meta/title
+meta/version
+TODO
+README
+HISTORY

data/README ADDED

@@ -0,0 +1,39 @@
+= Jam
+  http://jam.rubyforge.org
+Jam is a data-driven templater system. Jam provides 100% sepearation between
+logic and presentation.
+Jam can operate on the back-end via Ruby or on the front-end via Javascript/jQuery
+off-loading some of the back-end work load, while also providing 100% SOC
+(Seperation of Concern).
+== Examples
+Here is an example of usage in Javascript.
+   data = {
+     hello: "Hello, World!"
+   }
+   $.jam(data)
+Jam templates are especially useful when filled via AJAX with JSON data.
+For this reason a shortcut is provided.
+  $.jam_ajax('http://somewhere/data.json')
+== TODO
+Jam will likely witch from jQuery to Swizzle on the Javascript side in the future.
+= License
+Jam - Ruby/Javascript Templates
+Copyright (c) 2007,2008 Tiger Ops

data/TODO ADDED

@@ -0,0 +1,22 @@
+= TODO
+== Tag Erasing
+Add erase attribute, jam="erase" or erase="true" or other?
+This will be used to to remove the tag from the xml/xhtml.
+== Punt Adapter Support to Cherry?
+It would be much easier to create cherry, and then use that
+to provide different backend adapters.
+I may limit direct support to Nokogiri and let Cherry handle
+the others. Hpricot adapter works pretty well though (despite
+the unit test bombing). So maybe support Hpricot directly too.
+I'd like to support LibXML-Ruby directly since I helped with
+that project for so long, but it's API is not quite as easy
+to support. So... get Nokogiri working first at least.

data/bin/jam ADDED

File without changes

data/demo/array.rb ADDED

@@ -0,0 +1,16 @@
+require 'jam'
+t = <<-END
+  <example>
+    <ul><li id="list"></li></ul>
+  </example>
+END
+tmpl = Jam::Template.new t, "LibXML"
+data = { :list => %w{ A B C } }
+out = tmpl.expand(data)
+puts out

data/demo/attribute.rb ADDED

@@ -0,0 +1,24 @@
+require 'jam'
+tmpl = Jam::Template.new <<-END
+  <example id="a"></example>]
+END
+data = { 'a/@class' => "test" }
+out = tmpl.render(data)
+puts out
+# nested example
+tmpl = Jam::Template.new <<-END
+  <example id="a"></example>]
+END
+data = { :a => { '@class' => "test" } }
+out = tmpl.render(data)
+puts out

data/demo/demi/fixtures/ex1.html ADDED

@@ -0,0 +1,10 @@
+<html>
+<body>
+  <h1>Hello</h1>
+  <div id="a">
+  </div>
+</body>
+</html>

data/demo/demi/fixtures/samples.yaml ADDED

@@ -0,0 +1,19 @@
+---
+- data:
+    a: A
+    b: B
+  template:
+    <x><y><m id="a">dummy</m><n id="b">dummy</n></y></x>
+  result:
+    <x><y><m id="a">A</m><n id="b">B</n></y></x>
+- data:
+    a: [ A, B, C ]
+  template:
+    <x><y><m id="a">dummy</m></y></x>
+  result:
+    <x><y><m id="a">A</m><m id="a">B</m><m id="a">C</m></y></x>

data/demo/demi/integration/01_jam.rd ADDED

@@ -0,0 +1,41 @@
+= Jam Template Interpolation
+Load the template library.
+  require 'jam'
+== Hash
+Template rendering with a basic hash.
+  tmpl = Jam::Template.new <<-EOS
+    <x><y><m id="a">dummy</m><n id="b">dummy</n></y></x>
+  EOS
+  data = {
+    :a => "A",
+    :b => "B"
+  }
+  out = tmpl.expand(data).gsub(/\n\s*/,'')
+  out.should == %{<x><y><m id="a">A</m><n id="b">B</n></y></x>}
+== Lists
+Template rendering with an Array.
+  tmpl = Jam::Template.new <<-EOS
+    <x><y><m id="a">dummy</m></y></x>
+  EOS
+  data = {
+    :a => [ "A", "B", "C" ]
+  }
+  out = tmpl.expand(data).gsub(/\n\s*/,'')
+  out.should == %{<x><y><m id="a">A</m><m id="a">B</m><m id="a">C</m></y></x>}
+QED.

data/demo/demi/integration/02_xpath.rd ADDED

@@ -0,0 +1,41 @@
+= Jam Template Interpolation
+Load the template library.
+  require 'jam'
+== Hash
+Template rendering with a basic hash.
+  tmpl = Jam::Template.new <<-EOS
+    <x><y><m id="a">dummy</m><n id="b">dummy</n></y></x>
+  EOS
+  data = {
+    :a => "A",
+    :b => "B"
+  }
+  out = tmpl.expand(data).gsub(/\n\s*/,'')
+  out.should == %{<x><y><m id="a">A</m><n id="b">B</n></y></x>}
+== Lists
+Template rendering with an Array.
+  tmpl = Jam::Template.new <<-EOS
+    <x><y><m id="a">dummy</m></y></x>
+  EOS
+  data = {
+    :a => [ "A", "B", "C" ]
+  }
+  out = tmpl.expand(data).gsub(/\n\s*/,'')
+  out.should == %{<x><y><m id="a">A</m><m id="a">B</m><m id="a">C</m></y></x>}
+QED.

data/demo/demi/integration/samples.rd ADDED

@@ -0,0 +1,28 @@
+= Jam Template Interpolation
+Load the template library.
+  require 'jam'
+== Nokogiri
+Run samples through Nokogiri adapter.
+  table('samples.yaml') do |sample|
+    tmp = Jam::Template.new(sample['template'])
+    out = tmp.expand(sample['data']).gsub(/\n\s*/,'')
+    out.should == sample['result']
+  end
+== Hpricot
+Run samples through Hpricot adapter.
+  table('samples.yaml') do |sample|
+    tmp = Jam::Template.new(sample['template'])
+    out = tmp.expand(sample['data']).gsub(/\n\s*/,'')
+    out.should == sample['result']
+  end
+QED.

data/demo/demi/unit/hpricot.rd ADDED

@@ -0,0 +1,150 @@
+= Unit Tests for Jam Hpricot Adapter
+Require adapter.
+  require "jam/hpricot"
+This automatically requires 'hpricot' too.
+== Jam::Hpricot
+Support objects for following tests.
+  @xml = "<root><a>A</a><b>B</b><c>C</c></root>"
+  @eng = Jam::Hpricot.new
+BEFORE: We will resuse this XML document.
+  before {
+    @doc = @eng.document(@xml)
+  }
+=== #append
+Append should be able to append an XML node.
+  node  = @doc.search('root')
+  node2 = node.search('a').dup
+  @eng.append(node, node2)
+  out = node.to_s.gsub(/\n\s*/,'')
+  out.should == '<root><a>A</a><b>B</b><c>C</c><a>A</a></root>'
+Append should be able to append a set of nodes.
+  node       = @doc.search('root')
+  nodeset    = @doc.search('root/*')
+  @eng.append(node, nodeset)
+  out = node.to_s.gsub(/\n\s*/,'')
+  out.should == '<root><a>A</a><b>B</b><c>C</c><a>A</a><b>B</b><c>C</c></root>'
+Append should be able to append an XML text fragment.
+  node = @doc.search('root')
+  @eng.append(node, '<d>D</d>')
+  out = node.to_s.gsub(/\n\s*/,'')
+  out.should == '<root><a>A</a><b>B</b><c>C</c><d>D</d></root>'
+=== #replace_content_with_text
+It should replace node children with given text.
+  node = @doc.search('root')
+  @eng.replace_content_with_text(node, 'H')
+  out = node.to_s.gsub(/\n\s*/,'')
+  out.should == '<root>H</root>'
+It should be able to replace the children of each node of a NodeSet with text.
+  node    = @doc.root
+  nodeset = @doc.root.children
+  @eng.replace_content_with_text(nodeset, 'H')
+  out = node.to_s.gsub(/\n\s*/,'')
+  out.should == '<root><a>H</a><b>H</b><c>H</c></root>'
+=== #cleanup
+This will clean a document, or node, of any elements that request it.
+  doc = @eng.document('<root><a jam="erase">This is text.</a></root>')
+  @eng.cleanup(doc)
+  out = doc.root.to_s.gsub(/\n\s*/,'')
+  out.should == '<root>This is text.</root>'
+== Hpricot::Doc
+=== #jam
+Jam data into a Hpricot Document.
+  xml = Hpricot(%{
+    <root><x><m id="a">dummy</m><n id="b">dummy</n></x></root>
+  })
+  data = {
+    :a => "A",
+    :b => "B"
+  }
+  out = xml.jam(data)
+  out = out.root.to_s.gsub(/\n\s*/,'')
+  out.should == %{<root><x><m id="a">A</m><n id="b">B</n></x></root>}
+== Hpricot::Elem
+=== #jam
+Jam data into a Hpricot Node.
+  xml = Hpricot(%{
+    <root><x><m id="a">dummy</m><n id="b">dummy</n></x></root>
+  })
+  node = xml.root
+  data = {
+    :a => "A",
+    :b => "B"
+  }
+  out = node.jam(data)
+  out = out.to_s.gsub(/\n\s*/,'')
+  out.should == %{<root><x><m id="a">A</m><n id="b">B</n></x></root>}
+== Hpricot::Elements
+=== #jam
+Jam data into a Hpricot Elements.
+  xml = Hpricot(%{
+    <root><x><m id="a" class="q">dummy</m><n id="b" class="q">dummy</n></x></root>
+  })
+  nodeset = xml.search('.q')
+  p nodeset.search('#a')
+  data = { :a => "A", :b => "B" }
+  out = nodeset.jam(data)
+  out = out.to_s.gsub(/\n\s*/,'')
+  out.should == %{<m class="q" id="a">A</m><n class="q" id="b">B</n>}
+QED.