jam 0.2

data/demo/demi/unit/libxml.rd

@@ -0,0 +1,75 @@
+= Unit Tests for Jam LibXML Adapter
+
+Require adapter.
+
+  require "jam/libxml"
+
+This automatically requires 'libxml' too.
+
+== LibXML::XML::Document
+
+=== #jam
+
+Jam data into a LibXML Document.
+
+  xml = LibXML::XML::Document.string <<-EOS
+    <root><x><m id="a">dummy</m><n id="b">dummy</n></x></root>
+  EOS
+
+  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>}
+
+== LibXML::XML::Node
+
+=== #jam
+
+Jam data into a LibXML Node.
+
+  xml = LibXML::XML::Document.string <<-EOS
+    <root><x><m id="a">dummy</m><n id="b">dummy</n></x></root>
+  EOS
+
+  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>}
+
+== LibXML::XML::XPath::Object
+
+=== #jam
+
+Jam data into the Nodes of a LibXML::XPath::Object.
+
+  xml = LibXML::XML::Document.string <<-EOS
+    <root><x><m id="a" class="q">dummy</m><n id="b" class="q">dummy</n></x></root>
+  EOS
+
+  nodes = xml.find(".//*[@class='q']") #('.q')
+
+  data = { :a => "A", :b => "B" }
+
+  out = nodes.jam(data)
+
+  # can't get string?
+  out = out.inject(""){ |m, n| m += n.to_s }
+
+  out = out.gsub(/\n\s*/,'')
+
+  out.should == %{<m id="a" class="q">A</m><n id="b" class="q">B</n>}
+
+QED.
+

data/demo/demi/unit/nokogiri.rd

@@ -0,0 +1,148 @@
+= Unit Tests for Jam Nokogiri Adapter
+
+Require adapter.
+
+  require "jam/nokogiri"
+
+This automatically requires 'nokogiri' too.
+
+== Jam::Nokogiri
+
+Support objects for following tests.
+
+  @xml = "<root><a>A</a><b>B</b><c>C</c></root>"
+  @eng = Jam::Nokogiri.new
+
+BEFORE: We will resuse this XML document.
+
+  @doc = @eng.document(@xml)
+
+=== #append
+
+Append should be able to append an XML node.
+
+  node  = @doc.root
+  node2 = node.children[0].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 NodeSet.
+
+  node    = @doc.root
+  nodeset = @doc.root.children.dup
+
+  @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.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.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>'
+
+
+== ::Nokogiri::Document
+
+=== #jam
+
+Jam data into a Nokogiri Document.
+
+  xml = Nokogiri::XML <<-EOS
+    <root><x><m id="a">dummy</m><n id="b">dummy</n></x></root>
+  EOS
+
+  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>}
+
+== ::Nokogiri::Node
+
+=== #jam
+
+Jam data into a Nokogiri Node.
+
+  xml = Nokogiri::XML <<-EOS
+    <root><x><m id="a">dummy</m><n id="b">dummy</n></x></root>
+  EOS
+
+  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>}
+
+== ::Nokogiri::NodeSet
+
+=== #jam
+
+Jam data into a Nokogiri Node.
+
+  xml = Nokogiri::XML <<-EOS
+    <root><x><m id="a" class="q">dummy</m><n id="b" class="q">dummy</n></x></root>
+  EOS
+
+  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 id="a" class="q">A</m><n id="b" class="q">B</n>}
+
+QED.
+

data/demo/demi/unit/rexml.rd

@@ -0,0 +1,63 @@
+= Unit Tests for Jam REXML Adapter
+
+Require adapter.
+
+  require "jam/rexml"
+
+This automatically requires 'rexml/document' too.
+
+== REXML::Document
+
+=== #jam
+
+Jam data into a REXML Document.
+
+  xml = REXML::Document.new <<-EOS
+    <root><x><m id="a">dummy</m><n id="b">dummy</n></x></root>
+  EOS
+
+  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>}
+
+== REXML::Node
+
+=== #jam
+
+Jam data into a REXML Node.
+
+  xml = REXML::Document.new <<-EOS
+    <root><x><m id="a">dummy</m><n id="b">dummy</n></x></root>
+  EOS
+
+  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>}
+
+== REXML::XPath
+
+=== #jam_each
+
+Jam data into the nodes of a REXML::XPath object.
+
+  xml = REXML::Document.new <<-EOS
+    <root><x><m id="a" class="q">dummy</m><n id="b" class="q">dummy</n></x></root>
+  EOS
+
+  data = { :a => "A", :b => "B" }
+
+  out = REXML::XPath.jam(xml, data)
+  out = out.to_s.gsub(/\n\s*/,'')
+
+  out.should == %{<m id="a" class="q">A</m><n id="b" class="q">B</n>}
+
+QED.
+

data/demo/hash.rb

@@ -0,0 +1,20 @@
+require 'jam'
+
+tmpl = Jam::Template.new <<-END
+<html>
+  <body>
+    <h1 id="title">title will be inserted here</h1>
+    <p id="body">body text will be inserted here</p>
+  </body>
+</html>
+END
+
+data = {
+  :title => "hello world",
+  :body => "Amrita is a html template libraly for Ruby"
+}
+
+out = tmpl.expand(data)
+
+puts out
+

data/demo/helloworld.rb

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

data/demo/object.rb

@@ -0,0 +1,19 @@
+require 'jam'
+
+class A
+  attr :a
+  def initialize
+    @a = "A"
+  end
+end
+
+tmpl = Jam::Template.new <<-END
+  <example id="a"></example>]
+END
+
+data = A.new
+
+out = tmpl.render(data)
+
+puts out
+

data/demo/table.rb

@@ -0,0 +1,24 @@
+require 'jam'
+
+tmpl = Jam::Template.new <<-END
+<table border="1">
+  <tr><th>name</th><th>author</th></tr>
+  <tr id="table1">
+    <td id="name"></td>
+    <td id="author"></td>
+  </tr>
+</table>
+END
+
+data = {
+  :table1=>[ 
+    { :name=>"Ruby",   :author=>"Matz" },
+    { :name=>"Perl",   :author=>"Larry Wall" },
+    { :name=>"Python", :author=>"Guido van Rossum" }
+  ]
+}
+
+out = tmpl.expand(data)
+
+puts out
+

data/js/jquery.jam.js

@@ -0,0 +1,230 @@
+// Jam Templates -- a jQuery Plugin
+// Copyright (c) 2007,2008 Tiger Ops 
+// http://tigerops.psytower.info
+//
+// Jam is a "weaving" template system that
+// operate fully on the front-end, thus off-loading
+// some of the back-end work load while also
+// providing 100% SOC (Seperation of Concern).
+//
+// Example:
+//
+//   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')
+//
+
+// FOR DEBUGGING
+/*
+function inspect(obj) {
+  var txt = "";
+  for(var prop in obj) {
+    txt += prop + ": " + obj[prop] + "\n";
+  }
+  alert(txt);
+};
+*/
+
+//
+//
+//
+jQuery.jam_ajax = function(url) {
+  result = url.match(/[.]xml$/);
+  if (result != null) {
+    jQuery.getXML(url, jQuery.cherry_xml);
+  } else {
+    jQuery.getJSON(url, jQuery.cherry);
+  }
+};
+
+//
+//
+//
+jQuery.getXML = function(url, callback) {
+  jQuery.ajax({
+    dataType: "xml",
+    url: url,
+    success: callback
+  });
+};
+
+//
+// Interpolate XML by converting to JSON.
+// This only work is xml2json.js is loaded.
+//
+jQuery.jam_xml = function(xml) {
+  var json = xml2json(xml,'  ');
+  //var data = json.parseJSON();
+  var data = eval('(' + json + ')');  // SECURE ME!
+  jQuery.jam(data);
+};
+
+//
+// Interpolate JSON data.
+//
+// TODO: how to do whole document instead of body?
+jQuery.jam = function(data) {
+  // jQuery('body').interpolate(data);
+  // jQuery('body').jam_cleanup();
+  jQuery.interpolate(data);
+  jQuery.jam_cleanup();
+};
+
+//
+// Remove any unwanted jam tags.
+//
+// TODO: remove jam attributes too.
+jQuery.jam_cleanup = function() {
+  jQuery("[@jam='erase']").unwrap();
+};
+
+//
+// Interpolate data into template nodes.
+//
+jQuery.fn.interpolate = function(data) {
+  if(!data) {
+    this.remove();
+  }
+  else if (data instanceof Array) {
+    this.interpolate_sequence(data);
+  }
+  else if(data instanceof Object) {
+    this.interpolate_object(data);
+  }
+  else {
+    this.interpolate_scalar(data);
+  };
+  return this;
+};
+
+//
+// Interpolate object mapping.
+//
+jQuery.fn.interpolate_object = function(data) {
+  var qry;
+  var attr;
+  var tag;
+  var result;
+  var match;
+
+  for (var id in data) {
+    attr = false;
+    tag  = false;
+    qry  = id;
+
+    result = qry.match(/^<(.*?)>$/);
+    if (result != null) {
+      tag = true;
+      qry = result[1];
+    };
+
+    result = qry.match(/^((.*?)\/)?([@](.*?))$/);
+    if (result != null) {
+      if (result[2] == undefined) { result[2] = null };
+      attr = result[4];
+      qry  = result[2] //+ '[@' + attr + ']';
+    }
+    else {
+      attr = false;
+    };
+
+    if (attr == false) {
+      if (tag == false) { qry = '#' + qry; }
+      // probably change to use 'ref' attribute instead of 'id'
+      match = this.find(qry)
+      if (match.size() > 0) {
+        match.interpolate(data[id]);
+      }
+    }
+    else {
+      //qry = qry + '[@' + attr + ']';
+      //this.find(qry).attr(attr,data[id]);
+      if (qry != null) {
+        if (tag == false) { qry = '#' + qry; }
+        this.find(qry).attr(attr,data[id]);
+      } else {
+        this.attr(attr,data[id]);
+      }
+    };
+  };
+};
+
+//
+// Interpolate attribute.
+//
+// TODO
+
+//
+// Interpolate array sequence.
+//
+jQuery.fn.interpolate_sequence = function(data) {
+  var temp = this.clone();
+  this.empty();
+  for (var i in data) {
+    var newNode = temp.clone();
+    newNode.interpolate(data[i]);
+    this.append(newNode); //.children());
+  };
+};
+
+//
+// Interpolate scalar value.
+//
+// TODO: Should this has some special HTML features?
+//
+// TODO: Should we have two modes --one with and one
+// without the extra HTML features?
+//
+jQuery.fn.interpolate_scalar = function(data) {
+  //var all_special = new Array;
+
+  // text inputs
+  //var special = this.find('input[@type=text]');
+  //special.val(data.toString());
+  //all_special.concat(special);
+  // textarea
+  // TODO
+
+  //this.not(special).empty();
+  //this.not(special).append(data.toString());
+//alert(data);
+  this.empty();
+  this.append(data.toString());
+};
+
+//
+// Unwrap a node, such that the outer tag is
+// removed, leaving only it's own children.
+//
+jQuery.fn.unwrap = function(expr) {
+  return this.each(function(){
+     $(this).parents(expr).eq(0).after(this).remove();
+  });
+};
+
+
+
+/*
+// Interpolate list.
+
+function interpolate_list(node, data) {
+  temp = node.copy(true)
+  node.empty!
+  for (var d in data) {
+    nc = temp.copy(true);
+    interpolate_children( nc, d )
+    for (var c in nc.children) {
+      node.add(c);
+    };
+  };
+};
+*/
+