http://microformats.org/wiki/api.php?action=feedcontributions&feedformat=atom&user=RobertSayre
Microformats Wiki - User contributions [en]
2026-04-15T08:32:25Z
User contributions
MediaWiki 1.38.4
http://microformats.org/wiki/index.php?title=xoxo-sample-code&diff=4471
xoxo-sample-code
2005-10-30T20:00:36Z
<p>RobertSayre: /* XOXOParser.java */</p>
<hr />
<div>= XOXO Sample Code =<br />
<br />
A whole bunch of open source ([http://creativecommons.org/licenses/by/2.0/ CC-by-2.0], [http://www.apache.org/licenses/LICENSE-2.0 Apache 2.0]) sample code to read and write [[xoxo]] files in Python and Java (with Perl, PHP, ... to follow).<br />
= Python =<br />
== xoxo.py ==<br />
<pre><nowiki><br />
# -*- coding: utf-8 -*-<br />
"""xoxo.py - a utility module for transforming to and from the XHTMLOutlines format XOXO<br />
toXOXO takes a Python datastructure (tuples, lists or dictionaries, arbitrarily nested) and returns a XOXO representation of it.<br />
fromXOXO parses an XHTML file for a xoxo list and returns the structure<br />
"""<br />
__version__ = "0.8"<br />
__date__ = "2004-10-05"<br />
__author__ = "Kevin Marks <kmarks@technorati.com>"<br />
__copyright__ = "Copyright 2004, Kevin marks & Technorati"<br />
__license__ = "http://creativecommons.org/licenses/by/2.0/ CC-by-2.0], [http://www.apache.org/licenses/LICENSE-2.0 Apache 2.0"<br />
__credits__ = """Tantek Çelik and Mark Pilgrim for data structure"""<br />
__history__ = """<br />
TODO: add <title> tag<br />
TODO: add a proper profile link<br />
0.8 work in unicode then render to utf-8<br />
0.7 initial encoding support - just utf-8 for now<br />
0.6 support the special behaviour for url properties to/from <a><br />
0.5 fix some awkward side effects of whitespace and text outside our expected tags; simplify writing code<br />
0.4 add correct XHTML headers so it validates<br />
0.3 read/write version; fixed invlaid nested list generation;<br />
0.1 first write-only version<br />
"""<br />
<br />
try:<br />
True, False<br />
except NameError:<br />
True, False = not not 1, not 1<br />
containerTags={'ol':False,'ul':False,'dl':False}<br />
import sgmllib, urllib, urlparse, re<br />
def makeXOXO(struct,className=None,depth=0):<br />
s=u''<br />
if isinstance(struct,list) or isinstance(struct,tuple):<br />
if className:<br />
s += u'<ol class="%s">' % className<br />
else:<br />
s+= u"<ol>"<br />
if isinstance(struct,dict):<br />
d=struct.copy()<br />
if d.has_key('url'):<br />
s+=u'<a href="%s" ' % d['url']<br />
text = d.get('text',d.get('title',d['url']))<br />
for attr in ('title','rel','type'):<br />
if d.has_key(attr):<br />
xVal = makeXOXO(d[attr],None,depth+1)<br />
s +=u'%s="%s" ' % (attr,xVal)<br />
del d[attr]<br />
s +=u'>%s</a>' % makeXOXO(text,None,depth+1)<br />
if d.has_key('text'):<br />
del d['text']<br />
del d['url']<br />
if len(d):<br />
s +=u"<dl>"<br />
for key,value in d.items():<br />
xVal = makeXOXO(value,None,depth+1)<br />
s+= u'<dt>%s</dt><dd>%s</dd>' % (key, xVal)<br />
s +=u"</dl>"<br />
elif type(struct) ==type((1,))or type(struct) ==type([1,]):<br />
for item in struct:<br />
s+=u"<li>" + makeXOXO(item,None,depth+1)+"</li>"<br />
s +=u"</ol>"<br />
elif type(struct) == type(u'unicode'):<br />
s+=struct<br />
else:<br />
if not type(struct)==type(' '):<br />
struct=str(struct)<br />
try:<br />
s+=unicode(struct,'utf-8')<br />
except:<br />
s+=unicode(struct,'windows_1252')<br />
return s<br />
class xoxoParser(sgmllib.SGMLParser):<br />
def __init__(self):<br />
sgmllib.SGMLParser.__init__(self)<br />
self.structs=[]<br />
self.xostack=[]<br />
self.textstack=['']<br />
def normalize_attrs(self, attrs):<br />
attrs = [(k.lower(), sgmllib.charref.sub(lambda m: chr(int(m.groups()[0])), v).strip()) for k, v in attrs]<br />
attrs = [(k, k in ('rel','type') and v.lower() or v) for k, v in attrs]<br />
return attrs<br />
def pushStruct(self,struct):<br />
if type(struct) == type({}) and len(struct)==0 and len(self.structs) and type(self.structs[-1]) == type({}) and self.structs[-1].has_key('url'):<br />
self.xostack.append(self.structs[-1]) # put back the <a>-made one for extra def's<br />
else:<br />
self.structs.append(struct)<br />
self.xostack.append(self.structs[-1])<br />
def start_a(self,attrs):<br />
attrsD = dict(self.normalize_attrs(attrs))<br />
attrsD['url']= attrsD.get('href','')<br />
del attrsD['href']<br />
self.pushStruct(attrsD)<br />
self.textstack.append('')<br />
def end_a(self):<br />
val = self.textstack.pop()<br />
if val: <br />
if self.xostack[-1].get('title','') == val:<br />
val=''<br />
if self.xostack[-1]['url'] == val:<br />
val=''<br />
if val:<br />
self.xostack[-1]['text']=val<br />
self.xostack.pop()<br />
def start_dl(self,attrs):<br />
self.pushStruct({})<br />
def end_dl(self):<br />
self.xostack.pop()<br />
def start_ol(self,attrs):<br />
self.pushStruct([])<br />
def end_ol(self):<br />
self.xostack.pop()<br />
def start_ul(self,attrs):<br />
self.pushStruct([])<br />
def end_ul(self):<br />
self.xostack.pop()<br />
def start_li(self,attrs):<br />
self.textstack.append('')<br />
def end_li(self):<br />
val = self.textstack.pop()<br />
if self.structs[-1] != self.xostack[-1]:<br />
val = self.structs.pop()<br />
self.xostack[-1].append(val)<br />
def start_dt(self,attrs):<br />
self.textstack.append('')<br />
def end_dt(self):<br />
pass<br />
def start_dd(self,attrs):<br />
self.textstack.append('')<br />
def end_dd(self):<br />
val = self.textstack.pop()<br />
key = self.textstack.pop()<br />
if self.structs[-1] != self.xostack[-1]:<br />
val = self.structs.pop()<br />
self.xostack[-1][key]=val<br />
def handle_data(self, text):<br />
if len(self.stack) and containerTags.get(self.stack[-1],True): #skip text not within an element<br />
self.textstack[-1] += text<br />
def toXOXO(struct,addHTMLWrapper=False,cssUrl=''):<br />
if type(struct) ==type((1,))or type(struct) ==type([1,]):<br />
inStruct = struct<br />
else:<br />
inStruct = [struct]<br />
if addHTMLWrapper:<br />
s= '''<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN<br />
http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><br />
<html xmlns="http://www.w3.org/1999/xhtml"><head profile=""><meta http-equiv="Content-Type" content="text/html; charset=utf-8" />'''<br />
if cssUrl:<br />
s+='<style type="text/css" >@import "%s";</style>' % cssUrl<br />
s+="</head><body>%s</body></html>" % makeXOXO(inStruct,'xoxo')<br />
return s.encode('utf-8')<br />
else:<br />
return makeXOXO(inStruct,'xoxo').encode('utf-8')<br />
<br />
import sys<br />
<br />
def fromXOXO(html):<br />
parser = xoxoParser()<br />
parser.feed(unicode(html,'utf-8'))<br />
#print >>sys.stderr, parser.structs<br />
structs=[struct for struct in parser.structs if struct]<br />
#print >>sys.stderr, structs<br />
while (len(structs) ==1 and type(structs)==type([1,])):<br />
structs=structs[0]<br />
return structs<br />
<br />
# Allow direct invocation<br />
# Read HTML from URL, parse into data structures, then re-output<br />
<br />
if __name__ == "__main__":<br />
if len(sys.argv) < 2: raise SystemExit("Usage: "+sys.argv[0]+" url\n"+__doc__)<br />
url=sys.argv[1]<br />
file = urllib.urlopen(url)<br />
html=file.read(-1)<br />
file.close<br />
s=fromXOXO(html)<br />
p=toXOXO(s,True)<br />
print p<br />
<br />
</nowiki></pre><br />
<br />
== testxoxo.py ==<br />
<pre><nowiki><br />
# -*- coding: utf-8 -*-<br />
"""testxoxo.py <br />
Unit tests for xoxo.py<br />
This file tests the functions in xoxo.py <br />
The underlying model here is http://diveintopython.org/unit_testing/index.html <br />
<br />
run from command line with<br />
python testxoxo.py -v<br />
"""<br />
import xoxo<br />
reload(xoxo)<br />
import unittest<br />
<br />
class xoxoTestCases(unittest.TestCase):<br />
<br />
def testSimpleList(self):<br />
'''make a xoxo file from a list'''<br />
l = ['1','2','3']<br />
html = xoxo.toXOXO(l)<br />
self.assertEqual(html,'<ol class="xoxo"><li>1</li><li>2</li><li>3</li></ol>')<br />
def testNestedList(self):<br />
'''make a xoxo file from a list with a list in'''<br />
l = ['1',['2','3']]<br />
html = xoxo.toXOXO(l)<br />
self.assertEqual(html,'<ol class="xoxo"><li>1</li><li><ol><li>2</li><li>3</li></ol></li></ol>')<br />
<br />
def testDictionary(self):<br />
'''make a xoxo file from a dictionary'''<br />
d = {'test':'1','name':'Kevin'}<br />
html = xoxo.toXOXO(d)<br />
self.assertEqual(html,'<ol class="xoxo"><li><dl><dt>test</dt><dd>1</dd><dt>name</dt><dd>Kevin</dd></dl></li></ol>')<br />
<br />
def testSingleItem(self):<br />
'''make a xoxo file from a string'''<br />
l = "test"<br />
html = xoxo.toXOXO(l)<br />
self.assertEqual(html,'<ol class="xoxo"><li>test</li></ol>')<br />
<br />
def testWrapDiffers(self):<br />
'''make a xoxo file from a string with and without html wrapper and check they are different'''<br />
l = "test"<br />
html = xoxo.toXOXO(l)<br />
htmlwrap = xoxo.toXOXO(l,addHTMLWrapper=True)<br />
self.failIfEqual(html,htmlwrap)<br />
<br />
def testWrapSingleItem(self):<br />
'''make a wrapped xoxo file from a string'''<br />
l = "test"<br />
html = xoxo.toXOXO(l,addHTMLWrapper=True)<br />
self.assertEqual(html,'''<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN<br />
http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><br />
<html xmlns="http://www.w3.org/1999/xhtml"><head profile=""></head><body><ol class="xoxo"><li>test</li></ol></body></html>''')<br />
<br />
def testDictionaryRoundTrip(self):<br />
''' make a dictionary into a xoxo file and back again; check it is the same'''<br />
d = {'test':'1','name':'Kevin'}<br />
html = xoxo.toXOXO(d)<br />
newd = xoxo.fromXOXO(html)<br />
self.assertEqual(d,newd)<br />
<br />
def testListRoundTrip(self):<br />
''' make a list into a xoxo file and back again; check it is the same'''<br />
l = ['3','2','1']<br />
html = xoxo.toXOXO(l)<br />
newdl= xoxo.fromXOXO(html)<br />
self.assertEqual(l,newdl)<br />
def testListofDictsRoundTrip(self):<br />
''' make a list of Dicts into a xoxo file and back again; check it is the same'''<br />
l = ['3',{'a':'2'},{'b':'1','c':'4'}]<br />
html = xoxo.toXOXO(l)<br />
newdl= xoxo.fromXOXO(html)<br />
self.assertEqual(l,newdl)<br />
def testListofListsRoundTrip(self):<br />
''' make a list of Lists into a xoxo file and back again; check it is the same'''<br />
l = ['3',['a','2'],['b',['1',['c','4']]]]<br />
html = xoxo.toXOXO(l)<br />
newdl= xoxo.fromXOXO(html)<br />
self.assertEqual(l,newdl)<br />
def testDictofListsRoundTrip(self):<br />
''' make a dict with lists in into a xoxo file and back again; check it is the same'''<br />
d = {'test':['1','2'],<br />
'name':'Kevin',<br />
'nestlist':['a',['b','c']],<br />
'nestdict':{'e':'6','f':'7'}}<br />
html = xoxo.toXOXO(d)<br />
newd = xoxo.fromXOXO(html)<br />
self.assertEqual(d,newd)<br />
<br />
def testXOXOjunkInContainers(self):<br />
'''make sure text outside <li> etc is ignored'''<br />
d=xoxo.fromXOXO('<ol>bad<li><dl>worse<dt>good</dt><dd>buy</dd> now</dl></li></ol>')<br />
self.assertEqual(d,{'good': 'buy'})<br />
def testXOXOjunkInElements(self):<br />
'''make sure text within <li> but outside a subcontainer is ignored'''<br />
l=xoxo.fromXOXO('<ol><li>bad<dl><dt>good</dt><dd>buy</dd></dl>worse</li><li>bag<ol><li>OK</li></ol>fish</li></ol>')<br />
self.assertEqual(l,[{'good': 'buy'},['OK']])<br />
def testXOXOWithSpacesAndNewlines(self):<br />
'''unmung some xoxo with spaces in and check result is right'''<br />
xoxoSample= '''<ol class='xoxo'> <br />
<li><br />
<dl><br />
<dt>text</dt><br />
<dd>item 1</dd><br />
<dt>description</dt><br />
<dd> This item represents the main point we're trying to make.</dd><br />
<dt>url</dt><br />
<dd>http://example.com/more.xoxo</dd><br />
<dt>title</dt><br />
<dd>title of item 1</dd><br />
<dt>type</dt><br />
<dd>text/xml</dd><br />
<dt>rel</dt><br />
<dd>help</dd><br />
</dl><br />
</li><br />
</ol>'''<br />
d = xoxo.fromXOXO(xoxoSample)<br />
d2={'text':'item 1',<br />
'description':" This item represents the main point we're trying to make.",<br />
'url':'http://example.com/more.xoxo',<br />
'title':'title of item 1',<br />
'type':'text/xml',<br />
'rel':'help'<br />
}<br />
xoxoAgain = xoxo.toXOXO(d)<br />
self.assertEqual(d,d2)<br />
#this needs a smarter whitespace-sensitive comparison<br />
#self.assertEqual(xoxoSample,xoxoAgain)<br />
<br />
def testSpecialAttributeDecoding(self):<br />
'''unmung some xoxo with <a href=' rel= etc in and check result is right'''<br />
xoxoSample= '''<ol class='xoxo'> <br />
<li><br />
<dl><br />
<dt>text</dt><br />
<dd>item 1</dd><br />
<dt>url</dt><br />
<dd>http://example.com/more.xoxo</dd><br />
<dt>title</dt><br />
<dd>title of item 1</dd><br />
<dt>type</dt><br />
<dd>text/xml</dd><br />
<dt>rel</dt><br />
<dd>help</dd><br />
</dl><br />
</li><br />
</ol>'''<br />
d = xoxo.fromXOXO(xoxoSample)<br />
smartxoxoSample= '''<ol class='xoxo'> <br />
<li><a href="http://example.com/more.xoxo"<br />
title="title of item 1"<br />
type="text/xml"<br />
rel="help">item 1</a> <br />
<!-- note how the "text" property is simply the contents of the <a> element --><br />
</li><br />
</ol>'''<br />
d2 = xoxo.fromXOXO(smartxoxoSample)<br />
self.assertEqual(d,d2)<br />
def testSpecialAttributeAndDLDecoding(self):<br />
'''unmung some xoxo with <a href=' rel= etc in plus a <dl> in the same item and check result is right'''<br />
xoxoSample= '''<ol class="xoxo"> <br />
<li><br />
<dl><br />
<dt>text</dt><br />
<dd>item 1</dd><br />
<dt>description</dt><br />
<dd> This item represents the main point we're trying to make.</dd><br />
<dt>url</dt><br />
<dd>http://example.com/more.xoxo</dd><br />
<dt>title</dt><br />
<dd>title of item 1</dd><br />
<dt>type</dt><br />
<dd>text/xml</dd><br />
<dt>rel</dt><br />
<dd>help</dd><br />
</dl><br />
</li><br />
</ol>'''<br />
d = xoxo.fromXOXO(xoxoSample)<br />
smartxoxoSample= '''<ol class="xoxo"> <br />
<li><a href="http://example.com/more.xoxo"<br />
title="title of item 1"<br />
type="text/xml"<br />
rel="help">item 1</a> <br />
<!-- note how the "text" property is simply the contents of the <a> element --><br />
<dl><br />
<dt>description</dt><br />
<dd> This item represents the main point we're trying to make.</dd><br />
</dl><br />
</li><br />
</ol>'''<br />
d2 = xoxo.fromXOXO(smartxoxoSample)<br />
self.assertEqual(d,d2)<br />
def testSpecialAttributeEncode(self):<br />
'''check it makes an <a href with a url parameter'''<br />
d={'url':'http://example.com/more.xoxo','title':'sample url','type':"text/xml",'rel':'help','text':'an example'}<br />
html=xoxo.toXOXO(d)<br />
expectedHTML= '<ol class="xoxo"><li><a href="http://example.com/more.xoxo" title="sample url" rel="help" type="text/xml" >an example</a></li></ol>' <br />
self.assertEqual(html,expectedHTML)<br />
<br />
def testSpecialAttributeRoundTripFull(self):<br />
'''check it makes an <a href with a url parameter'''<br />
d={'url':'http://example.com/more.xoxo','title':'sample url','type':"text/xml",'rel':'help','text':'an example'}<br />
html=xoxo.toXOXO(d)<br />
self.assertEqual(d,xoxo.fromXOXO(html))<br />
def testSpecialAttributeRoundTripNoText(self):<br />
'''check it makes an <a href with a url parameter and no text attribute'''<br />
d={'url':'http://example.com/more.xoxo','title':'sample url','type':"text/xml",'rel':'help'}<br />
html=xoxo.toXOXO(d)<br />
self.assertEqual(d,xoxo.fromXOXO(html))<br />
def testSpecialAttributeRoundTripNoTextOrTitle(self):<br />
'''check it makes an <a href with a url parameter and no text or title attribute'''<br />
d={'url':'http://example.com/more.xoxo'}<br />
html=xoxo.toXOXO(d)<br />
self.assertEqual(d,xoxo.fromXOXO(html))<br />
def testUnicodeRoundtrip(self):<br />
'''check unicode characters can go to xoxo and back'''<br />
src=unicode('Tantek Çelik and a snowman ?','utf-8')<br />
html = html=xoxo.toXOXO(src)<br />
self.assertEqual(src,xoxo.fromXOXO(html))<br />
if __name__ == "__main__":<br />
unittest.main()<br />
else:<br />
runner = unittest.TextTestRunner()<br />
suite = unittest.makeSuite(xoxoTestCases,'test')<br />
runner.run(suite)<br />
<br />
</nowiki></pre><br />
<br />
= Java =<br />
== XOXOWriter.java ==<br />
<pre><nowiki><br />
/*<br />
* Copyright 2005 Robert Sayre<br />
*<br />
* Licensed under the Apache License, Version 2.0 (the "License");<br />
* you may not use this file except in compliance with the License.<br />
* You may obtain a copy of the License at<br />
* <br />
* http://www.apache.org/licenses/LICENSE-2.0<br />
* <br />
* Unless required by applicable law or agreed to in writing, software<br />
* distributed under the License is distributed on an "AS IS" BASIS,<br />
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<br />
* See the License for the specific language governing permissions and<br />
* limitations under the License.<br />
*<br />
* Portions of this code are derived from the Apache-licensed Python XOXO<br />
* module by Kevin Marks. <http://microformats.org/wiki/xoxo-sample-code><br />
*/<br />
<br />
package org.atompub.draft.xoxo;<br />
<br />
import java.util.*;<br />
<br />
public class XOXOWriter {<br />
<br />
public String[] attrs = {"title","rel","type"};<br />
<br />
public String makeXOXO(List struct, String className){<br />
return makeXOXO(struct, className, 0, true);<br />
}<br />
<br />
public String makeXOXO(List struct, String className,<br />
boolean doNSDeclaration){<br />
return makeXOXO(struct, className, 0, doNSDeclaration);<br />
}<br />
<br />
public String makeXOXO(List struct){<br />
return makeXOXO(struct, "xoxo", 0, true);<br />
}<br />
<br />
public String makeXOXO(Object struct, int depth){<br />
return makeXOXO(struct, null, 0, false);<br />
}<br />
<br />
public String makeXOXO(Object struct, String className,<br />
int depth, boolean doNSDeclaration){<br />
if(struct == null) return "";<br />
StringBuffer sb = new StringBuffer();<br />
if(struct instanceof Object[]){<br />
struct = Arrays.asList((Object[]) struct);<br />
}<br />
if(struct instanceof List){<br />
sb.append("<ol");<br />
if(doNSDeclaration)<br />
sb.append(" xmlns=\"http://www.w3.org/1999/xhtml\"");<br />
if(className != null){<br />
sb.append(" class=\"");<br />
sb.append(className);<br />
sb.append("\"");<br />
}<br />
sb.append(">");<br />
}<br />
if(struct instanceof Map){<br />
Map d = new LinkedHashMap((Map) struct);<br />
if(d.containsKey("url")){<br />
sb.append("<a href=\"" + d.get("url") + "\" ");<br />
Object text;<br />
if(d.containsKey("text")){<br />
text = d.get("text");<br />
}else if(d.containsKey("title")){<br />
text = d.get("title");<br />
}else{<br />
text = d.get("url");<br />
}<br />
for(int i=0; i<attrs.length; i++){<br />
String xVal = makeXOXO(d.get(attrs[i]),depth+1);<br />
if(xVal != null && !xVal.equals("")){<br />
sb.append(attrs[i] + "=\"" + xVal + "\" ");<br />
}<br />
d.remove(attrs[i]);<br />
}<br />
sb.append(">" + makeXOXO(text, depth+1) + "</a>");<br />
d.remove("text");<br />
d.remove("url");<br />
}<br />
if(d.size() > 0){<br />
sb.append("<dl>");<br />
for(Iterator i = d.keySet().iterator(); i.hasNext();){<br />
Object k = i.next();<br />
String ddVal = makeXOXO(d.get(k),depth+1);<br />
sb.append("<dt>" + k + "</dt>");<br />
sb.append("<dd>" + ddVal + "</dd>");<br />
}<br />
sb.append("</dl>");<br />
}<br />
}else if(struct instanceof List){<br />
List l = (List) struct;<br />
for(Iterator i = l.iterator(); i.hasNext();){<br />
Object item = i.next();<br />
sb.append("<li>" + makeXOXO(item,depth+1) + "</li>");<br />
}<br />
sb.append("</ol>");<br />
}else{<br />
sb.append(struct);<br />
}<br />
return sb.toString();<br />
}<br />
<br />
public String toXOXO(List struct){<br />
return toXOXO(struct, false, null);<br />
}<br />
<br />
public String toXOXO(Object struct){<br />
List alist = new ArrayList();<br />
alist.add(struct);<br />
return toXOXO(alist);<br />
}<br />
<br />
public String toXOXO(Object struct,<br />
boolean addHTMLWrapper,<br />
String cssUrl){<br />
List alist = new ArrayList();<br />
alist.add(struct);<br />
return toXOXO(alist, addHTMLWrapper, cssUrl);<br />
}<br />
<br />
public String toXOXO(List struct,<br />
boolean addHTMLWrapper,<br />
String cssUrl){<br />
String startHTML = "<!DOCTYPE html PUBLIC \"-//W3C//DTD"<br />
+ "XHTML 1.0 Transitional//EN\n"<br />
+ "http://www.w3.org/TR/xhtml1/DTD/"<br />
+ "xhtml1-transitional.dtd\">"<br />
+ "<html xmlns=\"http://www.w3.org/1999/xhtml\">"<br />
+ "<head>";<br />
if(addHTMLWrapper){<br />
String s = startHTML;<br />
if(cssUrl != null){<br />
s += "<style type=\"text/css\">@import \""<br />
+ cssUrl + "\";</style>";<br />
}<br />
s += "</head><body>" + makeXOXO(struct, "xoxo", false)<br />
+ "</body></html>";<br />
return s;<br />
}else{<br />
return makeXOXO(struct, "xoxo");<br />
}<br />
}<br />
}<br />
</nowiki></pre><br />
<br />
== XOXOParser.java ==<br />
This needs some small additions to handle the XHTML DTD and named character entities.<br />
<br />
<pre><nowiki><br />
/*<br />
* Copyright 2005 Robert Sayre<br />
*<br />
* Licensed under the Apache License, Version 2.0 (the "License");<br />
* you may not use this file except in compliance with the License.<br />
* You may obtain a copy of the License at<br />
* <br />
* http://www.apache.org/licenses/LICENSE-2.0<br />
* <br />
* Unless required by applicable law or agreed to in writing, software<br />
* distributed under the License is distributed on an "AS IS" BASIS,<br />
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<br />
* See the License for the specific language governing permissions and<br />
* limitations under the License.<br />
*<br />
* Portions of this code are derived from the Apache-licensed Python XOXO<br />
* module by Kevin Marks. <http://microformats.org/wiki/xoxo-sample-code><br />
*/<br />
<br />
package org.atompub.draft.xoxo;<br />
<br />
import org.xml.sax.InputSource;<br />
import org.xml.sax.SAXException;<br />
import org.xml.sax.XMLReader;<br />
import org.xml.sax.Attributes;<br />
import org.xml.sax.helpers.XMLReaderFactory;<br />
import org.xml.sax.helpers.DefaultHandler;<br />
<br />
import java.util.*;<br />
import java.io.InputStream;<br />
import java.io.StringReader;<br />
import java.io.IOException;<br />
<br />
public class XOXOParser extends DefaultHandler {<br />
<br />
protected String XHTML_NS = "http://www.w3.org/1999/xhtml";<br />
protected List elStack;<br />
protected Map listEls;<br />
public List structs;<br />
public List xoStack;<br />
public List textStack;<br />
<br />
public XOXOParser() {<br />
reset();<br />
}<br />
<br />
protected void pushStruct(Object struct){<br />
if((struct instanceof Map) && (((Map) struct).size() > 0)<br />
&& (structs.get(structs.size()-1) instanceof Map)<br />
&& (((Map) struct).containsKey("url"))){<br />
// put back the <a>-made one for extra defs<br />
xoStack.add(structs.get(structs.size()-1));<br />
}else{<br />
structs.add(struct);<br />
xoStack.add(struct);<br />
}<br />
}<br />
<br />
public void startElement(String nsUri, String localName,<br />
String qName, Attributes atts){<br />
// bounce non-XHTML elements<br />
if(nsUri.equals(XHTML_NS)){<br />
elStack.add(localName);<br />
}else{<br />
elStack.add("foo");<br />
return;<br />
}<br />
<br />
if(localName.equals("a")){<br />
Map attmap = new LinkedHashMap();<br />
int len = atts.getLength();<br />
for(int i=0; i<len; i++){<br />
attmap.put(atts.getQName(i),atts.getValue(i));<br />
}<br />
if(attmap.containsKey("href")){<br />
attmap.put("url",attmap.get("href"));<br />
attmap.remove("href");<br />
}<br />
pushStruct(attmap);<br />
textStack.add("");<br />
}else if(localName.equals("dl")){<br />
pushStruct(new LinkedHashMap());<br />
}else if(localName.equals("ol")){<br />
pushStruct(new ArrayList());<br />
}else if(localName.equals("ul")){<br />
pushStruct(new ArrayList());<br />
}else if(localName.equals("li")){<br />
textStack.add("");<br />
}else if(localName.equals("dt")){<br />
textStack.add("");<br />
}else if(localName.equals("dd")){<br />
textStack.add("");<br />
}<br />
}<br />
<br />
public void endElement(String nsUri, String localName,<br />
String qName){<br />
elStack.remove(elStack.size()-1);<br />
// bounce non-XHTML elements<br />
if(nsUri != XHTML_NS){<br />
return;<br />
}<br />
<br />
if(localName.equals("a")){<br />
String val = (String) textStack.remove(textStack.size()-1);<br />
if (val.length() > 0){<br />
Map defs = (Map) xoStack.get(xoStack.size()-1);<br />
String defVal = (String) defs.get("title");<br />
if((defVal != null) && (val.equals(defVal))){<br />
val = "";<br />
}<br />
defVal = (String) defs.get("url");<br />
if((defVal != null) && (val.equals(defVal))){<br />
val = "";<br />
}<br />
if(val.length() > 0){<br />
defs.put("text",val);<br />
}<br />
}<br />
xoStack.remove(xoStack.size()-1);<br />
}else if(localName.equals("dl")){<br />
xoStack.remove(xoStack.size()-1);<br />
}else if(localName.equals("ol")){<br />
xoStack.remove(xoStack.size()-1);<br />
}else if(localName.equals("ul")){<br />
xoStack.remove(xoStack.size()-1);<br />
}else if(localName.equals("li")){<br />
Object val = textStack.remove(textStack.size()-1);<br />
List last = (List) xoStack.get(xoStack.size()-1);<br />
if(structs.get(structs.size()-1) != last){<br />
val = structs.remove(structs.size()-1);<br />
}<br />
last.add(val);<br />
}else if(localName.equals("dd")){<br />
Object val = textStack.remove(textStack.size()-1);<br />
Object key = textStack.remove(textStack.size()-1);<br />
Map last = (Map) xoStack.get(xoStack.size()-1);<br />
if(structs.get(structs.size()-1) != last){<br />
val = structs.remove(structs.size()-1);<br />
}<br />
last.put(key,val);<br />
}<br />
}<br />
<br />
public void characters(char[] ch, int start, int length){<br />
if((xoStack.size() > 0)<br />
&& (!listEls.containsKey(elStack.get(elStack.size()-1)))){<br />
String text = (String) textStack.get(textStack.size()-1);<br />
String test = new String(ch,start,length);<br />
textStack.set(textStack.size()-1,text+test);<br />
}<br />
}<br />
<br />
public Object parse(String s) throws SAXException, IOException{<br />
return parse(new InputSource(new StringReader(s)));<br />
}<br />
<br />
public Object parse(InputStream is) throws SAXException, IOException {<br />
return parse(new InputSource(is));<br />
}<br />
<br />
public Object parse(InputSource in) throws SAXException, IOException {<br />
XMLReader parser = XMLReaderFactory.createXMLReader();<br />
parser.setContentHandler(this);<br />
parser.parse(in);<br />
List returnList = new ArrayList();<br />
for(Iterator i = this.structs.iterator(); i.hasNext();){<br />
Object thing = i.next();<br />
if(thing != null){<br />
returnList.add(thing);<br />
}<br />
}<br />
while((returnList.size()==1)){<br />
if(returnList.get(0) instanceof List){<br />
returnList = (List) returnList.get(0);<br />
}else{<br />
reset();<br />
return returnList.get(0);<br />
}<br />
}<br />
reset();<br />
return returnList;<br />
}<br />
<br />
protected void reset(){<br />
elStack = new ArrayList();<br />
listEls = new HashMap();<br />
structs = new ArrayList();<br />
xoStack = new ArrayList();<br />
textStack = new ArrayList();<br />
listEls.put("ol","ol");<br />
listEls.put("ul","ul");<br />
listEls.put("dl","dl");<br />
}<br />
}<br />
<br />
</nowiki></pre><br />
<br />
== XOXOTest.java ==<br />
<pre><nowiki><br />
/*<br />
* Copyright 2005 Robert Sayre<br />
*<br />
* Licensed under the Apache License, Version 2.0 (the "License");<br />
* you may not use this file except in compliance with the License.<br />
* You may obtain a copy of the License at<br />
* <br />
* http://www.apache.org/licenses/LICENSE-2.0<br />
* <br />
* Unless required by applicable law or agreed to in writing, software<br />
* distributed under the License is distributed on an "AS IS" BASIS,<br />
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<br />
* See the License for the specific language governing permissions and<br />
* limitations under the License.<br />
*<br />
* Portions of this code are derived from the Apache-licensed Python XOXO<br />
* module by Kevin Marks. <http://microformats.org/wiki/xoxo-sample-code><br />
*/<br />
<br />
package org.atompub.draft.xoxo.tests;<br />
<br />
import junit.framework.TestSuite;<br />
import junit.framework.TestCase;<br />
import junit.textui.TestRunner;<br />
import org.atompub.draft.xoxo.XOXOWriter;<br />
import org.atompub.draft.xoxo.XOXOParser;<br />
<br />
import java.util.*;<br />
<br />
public class XOXOTest extends TestCase {<br />
<br />
public static void main(String[] args) {<br />
new TestRunner().doRun(new TestSuite(XOXOTest.class));<br />
}<br />
String XHTML_DEC = "xmlns=\"http://www.w3.org/1999/xhtml\" ";<br />
public String simpleListHTML = "<ol "<br />
+ XHTML_DEC<br />
+ "class=\"xoxo\">"<br />
+ "<li>1</li><li>2</li><li>3</li></ol>";<br />
<br />
public void testSimpleList(){<br />
String [] numbers = {"1","2","3"};<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(simpleListHTML,<br />
xoxo.toXOXO(Arrays.asList(numbers)));<br />
}<br />
<br />
public void testStringIntegerList(){<br />
Object[] numbers = {new Integer(1),"2","3"};<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(simpleListHTML,<br />
xoxo.toXOXO(Arrays.asList(numbers)));<br />
}<br />
<br />
public String nestedListHTML = "<ol "<br />
+ XHTML_DEC<br />
+ "class=\"xoxo\"><li>1</li><li>"<br />
+ "<ol><li>2</li><li>3</li></ol></li></ol>";<br />
<br />
public void testNestedList(){<br />
Object[] arr = {"2","3"};<br />
Object[] nested = {"1",Arrays.asList(arr)};<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(nestedListHTML,<br />
xoxo.toXOXO(Arrays.asList(nested)));<br />
}<br />
<br />
public void testNestedArray(){<br />
Object[] arr = {"2","3"};<br />
Object[] nested = {"1",arr};<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(nestedListHTML,<br />
xoxo.toXOXO(Arrays.asList(nested)));<br />
}<br />
<br />
public String dictHTML = "<ol "<br />
+ XHTML_DEC<br />
+ "class=\"xoxo\">"<br />
+ "<li><dl><dt>test</dt><dd>1</dd><dt>name</dt>"<br />
+ "<dd>Kevin</dd></dl></li></ol>";<br />
<br />
public void testDictionary(){<br />
Map dict = new LinkedHashMap();<br />
dict.put("test", new Integer(1));<br />
dict.put("name", "Kevin");<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(dictHTML,<br />
xoxo.toXOXO(dict));<br />
}<br />
<br />
public String singleHTML = "<ol "<br />
+ XHTML_DEC<br />
+ "class=\"xoxo\">"<br />
+ "<li>test</li></ol>";<br />
<br />
public void testSingleItem(){<br />
String item = "test";<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(singleHTML,<br />
xoxo.toXOXO(item));<br />
}<br />
<br />
public void testWrapDiffers(){<br />
String item = "test";<br />
XOXOWriter xoxo = new XOXOWriter();<br />
String nowrap = xoxo.toXOXO(item);<br />
Object[] itemArr = {item};<br />
String wrap = xoxo.toXOXO(Arrays.asList(itemArr),true,null);<br />
assertFalse(wrap.equals(nowrap));<br />
}<br />
<br />
String startHTML = "<!DOCTYPE html PUBLIC \"-//W3C//DTD"<br />
+ "XHTML 1.0 Transitional//EN\n"<br />
+ "http://www.w3.org/TR/xhtml1/DTD/"<br />
+ "xhtml1-transitional.dtd\">"<br />
+ "<html xmlns=\"http://www.w3.org/1999/xhtml\">"<br />
+ "<head></head><body>";<br />
public String singleWrapHTML = "<ol "<br />
+ "class=\"xoxo\">"<br />
+ "<li>test</li></ol>";<br />
public String endHTML = "</body></html>";<br />
<br />
public void testWrapSingleItem(){<br />
String item = "test";<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(startHTML + singleWrapHTML + endHTML,<br />
xoxo.toXOXO(item,true,null));<br />
}<br />
<br />
public void testXOXOParser(){<br />
XOXOParser parser = new XOXOParser();<br />
try{<br />
parser.parse(dictHTML);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testDictRoundTrip(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("test", "1");<br />
dict.put("name", "Kevin");<br />
String html = xoxo.toXOXO(dict);<br />
try{<br />
Object newDict = parser.parse(html);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testListRoundTrip(){<br />
Object[] obj = {"1","2","3"};<br />
List testList = Arrays.asList(obj);<br />
XOXOWriter xoxo = new XOXOWriter();<br />
String html = xoxo.toXOXO(testList);<br />
XOXOParser parser = new XOXOParser();<br />
try{<br />
Object newList = parser.parse(html);<br />
assertEquals(testList,newList);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testListOfDictsRoundTrip(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("test", "1");<br />
dict.put("name", "Kevin");<br />
Map dict2 = new LinkedHashMap();<br />
dict2.put("one", "two");<br />
dict2.put("three", "four");<br />
dict2.put("five", "six");<br />
Object[] obj = {"1",dict,dict2};<br />
List testList = Arrays.asList(obj);<br />
String html = xoxo.toXOXO(testList);<br />
try{<br />
Object newList = parser.parse(html);<br />
assertEquals(testList,newList);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testListOfListsRoundTrip(){<br />
Object[] list1 = {"1","2","3"};<br />
Object[] list2 = {"4","5","6", Arrays.asList(list1)};<br />
Object[] list3 = {"7", Arrays.asList(list2)};<br />
Object[] list4 = {"8", Arrays.asList(list3)};<br />
List testList = Arrays.asList(list4);<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
String html = xoxo.toXOXO(testList);<br />
try{<br />
Object newList = parser.parse(html);<br />
assertEquals(testList,newList);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testDictOfListsRoundTrip(){<br />
Object[] list1 = {"1","2","3"};<br />
Object[] list2 = {"4","5","6"};<br />
Object[] list3 = {"7"};<br />
Object[] list4 = {"8", "9"};<br />
Map dict = new LinkedHashMap();<br />
dict.put("foo", Arrays.asList(list1));<br />
dict.put("bar", Arrays.asList(list2));<br />
dict.put("baz", Arrays.asList(list3));<br />
dict.put("qux", Arrays.asList(list4));<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
String html = xoxo.toXOXO(dict);<br />
try{<br />
Object newDict = parser.parse(html);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public String junkXOXO = "<ol "<br />
+ XHTML_DEC<br />
+ "class=\"xoxo\">"<br />
+ "bad<li><dl>worse<dt>good</dt><dd>buy</dd> now</dl></li></ol>";<br />
<br />
public void testXOXOJunkInContainers(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("good","buy");<br />
try{<br />
Object newDict = parser.parse(junkXOXO);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public String junkElementXOXO = "<ol "<br />
+ XHTML_DEC<br />
+ "><li>bad<dl><dt>good</dt><dd>buy</dd></dl>"<br />
+ "worse</li><li>bag<ol><li>OK</li></ol>fish</li></ol>";<br />
<br />
public void testXOXOjunkInElements(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("good","buy");<br />
Object[] ok = {"OK"};<br />
Object[] obj ={dict, Arrays.asList(ok)};<br />
List testList = Arrays.asList(obj);<br />
try{<br />
Object newList = parser.parse(junkElementXOXO);<br />
assertEquals(testList,newList);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public String xoxoSpacesNewlines = "<ol " + XHTML_DEC +<br />
" class='xoxo'> \n" +<br />
" <li>\n" +<br />
" <dl>\n" +<br />
" <dt>text</dt>\n" +<br />
" <dd>item 1</dd>\n" +<br />
" <dt>description</dt>\n" +<br />
" <dd> This item represents the main" +<br />
" point we're trying to make.</dd>\n" +<br />
" <dt>url</dt>\n" +<br />
" <dd>http://example.com/more.xoxo</dd>\n" +<br />
" <dt>title</dt>\n" +<br />
" <dd>title of item 1</dd>\n" +<br />
" <dt>type</dt>\n" +<br />
" <dd>text/xml</dd>\n" +<br />
" <dt>rel</dt>\n" +<br />
" <dd>help</dd>\n" +<br />
" </dl>\n" +<br />
" </li>\n" +<br />
"</ol>";<br />
<br />
public void testXOXOWithSpacesAndNewlines(){<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("text","item 1");<br />
dict.put("description"," This item represents the main" +<br />
" point we're trying to make.");<br />
dict.put("url","http://example.com/more.xoxo");<br />
dict.put("title","title of item 1");<br />
dict.put("type","text/xml");<br />
dict.put("rel","help");<br />
try{<br />
Object newDict = parser.parse(xoxoSpacesNewlines);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public String xoxoSample = "<ol " + XHTML_DEC +<br />
" class='xoxo'> \n" +<br />
" <li>\n" +<br />
" <dl>\n" +<br />
" <dt>text</dt>\n" +<br />
" <dd>item 1</dd>\n" +<br />
" <dt>url</dt>\n" +<br />
" <dd>http://example.com/more.xoxo</dd>\n" +<br />
" <dt>title</dt>\n" +<br />
" <dd>title of item 1</dd>\n" +<br />
" <dt>type</dt>\n" +<br />
" <dd>text/xml</dd>\n" +<br />
" <dt>rel</dt>\n" +<br />
" <dd>help</dd>\n" +<br />
" </dl>\n" +<br />
" </li>\n" +<br />
"</ol>";<br />
<br />
public String smartXOXOSample = "<ol " + XHTML_DEC +<br />
"class=\"xoxo\"> \n" +<br />
" <li><a href=\"http://example.com/more.xoxo\"\n" +<br />
" title=\"title of item 1\"\n" +<br />
" type=\"text/xml\"\n" +<br />
" rel=\"help\">item 1</a> \n" +<br />
"<!-- note how the \"text\" property is simply" +<br />
" the contents of the <a> element -->\n" +<br />
" </li>\n" +<br />
"</ol>";<br />
<br />
public void testSpecialAttributeDecoding(){<br />
XOXOParser parser = new XOXOParser();<br />
try{<br />
Object xoxoDict = parser.parse(xoxoSample);<br />
Object xoxoDict2 = parser.parse(smartXOXOSample);<br />
assertEquals(xoxoDict,xoxoDict2);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public String specialAttrHTML = "<ol " + XHTML_DEC +<br />
"class=\"xoxo\">" +<br />
"<li><a href=\"http://example.com/more.xoxo\" title=\"sample url\" " +<br />
"rel=\"help\" type=\"text/xml\" >an example</a></li></ol>";<br />
<br />
public void testSpecialAttributeEncode(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
Map dict = new LinkedHashMap();<br />
dict.put("url","http://example.com/more.xoxo");<br />
dict.put("title","sample url");<br />
dict.put("type","text/xml");<br />
dict.put("rel","help");<br />
dict.put("text","an example");<br />
String html = xoxo.toXOXO(dict);<br />
assertEquals(specialAttrHTML,html);<br />
}<br />
<br />
public void testSpecialAttributeRoundTripFull(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("url","http://example.com/more.xoxo");<br />
dict.put("title","sample url");<br />
dict.put("type","text/xml");<br />
dict.put("rel","help");<br />
dict.put("text","an example");<br />
String html = xoxo.toXOXO(dict);<br />
try{<br />
Object newDict = parser.parse(html);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testSpecialAttributeRoundTripNoText(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("url","http://example.com/more.xoxo");<br />
dict.put("title","sample url");<br />
dict.put("type","text/xml");<br />
dict.put("rel","help");<br />
String html = xoxo.toXOXO(dict);<br />
try{<br />
Object newDict = parser.parse(html);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testSpecialAttributeRoundTripNoTextOrTitle(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("url","http://example.com/more.xoxo");<br />
dict.put("type","text/xml");<br />
dict.put("rel","help");<br />
String html = xoxo.toXOXO(dict);<br />
try{<br />
Object newDict = parser.parse(html);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testUnicodeRoundTrip(){<br />
String s = "Tantek Çelik and a snowman ?";<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
String html = xoxo.toXOXO(s);<br />
try{<br />
Object newString = parser.parse(html);<br />
assertEquals(s,newString);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
}<br />
<br />
</nowiki></pre></div>
RobertSayre
http://microformats.org/wiki/index.php?title=xoxo-sample-code&diff=2506
xoxo-sample-code
2005-10-30T19:33:39Z
<p>RobertSayre: /* XOXOParser.java */</p>
<hr />
<div>= XOXO Sample Code =<br />
<br />
A whole bunch of open source ([http://creativecommons.org/licenses/by/2.0/ CC-by-2.0], [http://www.apache.org/licenses/LICENSE-2.0 Apache 2.0]) sample code to read and write [[xoxo]] files in Python and Java (with Perl, PHP, ... to follow).<br />
= Python =<br />
== xoxo.py ==<br />
<pre><nowiki><br />
# -*- coding: utf-8 -*-<br />
"""xoxo.py - a utility module for transforming to and from the XHTMLOutlines format XOXO<br />
toXOXO takes a Python datastructure (tuples, lists or dictionaries, arbitrarily nested) and returns a XOXO representation of it.<br />
fromXOXO parses an XHTML file for a xoxo list and returns the structure<br />
"""<br />
__version__ = "0.8"<br />
__date__ = "2004-10-05"<br />
__author__ = "Kevin Marks <kmarks@technorati.com>"<br />
__copyright__ = "Copyright 2004, Kevin marks & Technorati"<br />
__license__ = "http://creativecommons.org/licenses/by/2.0/ CC-by-2.0], [http://www.apache.org/licenses/LICENSE-2.0 Apache 2.0"<br />
__credits__ = """Tantek Çelik and Mark Pilgrim for data structure"""<br />
__history__ = """<br />
TODO: add <title> tag<br />
TODO: add a proper profile link<br />
0.8 work in unicode then render to utf-8<br />
0.7 initial encoding support - just utf-8 for now<br />
0.6 support the special behaviour for url properties to/from <a><br />
0.5 fix some awkward side effects of whitespace and text outside our expected tags; simplify writing code<br />
0.4 add correct XHTML headers so it validates<br />
0.3 read/write version; fixed invlaid nested list generation;<br />
0.1 first write-only version<br />
"""<br />
<br />
try:<br />
True, False<br />
except NameError:<br />
True, False = not not 1, not 1<br />
containerTags={'ol':False,'ul':False,'dl':False}<br />
import sgmllib, urllib, urlparse, re<br />
def makeXOXO(struct,className=None,depth=0):<br />
s=u''<br />
if isinstance(struct,list) or isinstance(struct,tuple):<br />
if className:<br />
s += u'<ol class="%s">' % className<br />
else:<br />
s+= u"<ol>"<br />
if isinstance(struct,dict):<br />
d=struct.copy()<br />
if d.has_key('url'):<br />
s+=u'<a href="%s" ' % d['url']<br />
text = d.get('text',d.get('title',d['url']))<br />
for attr in ('title','rel','type'):<br />
if d.has_key(attr):<br />
xVal = makeXOXO(d[attr],None,depth+1)<br />
s +=u'%s="%s" ' % (attr,xVal)<br />
del d[attr]<br />
s +=u'>%s</a>' % makeXOXO(text,None,depth+1)<br />
if d.has_key('text'):<br />
del d['text']<br />
del d['url']<br />
if len(d):<br />
s +=u"<dl>"<br />
for key,value in d.items():<br />
xVal = makeXOXO(value,None,depth+1)<br />
s+= u'<dt>%s</dt><dd>%s</dd>' % (key, xVal)<br />
s +=u"</dl>"<br />
elif type(struct) ==type((1,))or type(struct) ==type([1,]):<br />
for item in struct:<br />
s+=u"<li>" + makeXOXO(item,None,depth+1)+"</li>"<br />
s +=u"</ol>"<br />
elif type(struct) == type(u'unicode'):<br />
s+=struct<br />
else:<br />
if not type(struct)==type(' '):<br />
struct=str(struct)<br />
try:<br />
s+=unicode(struct,'utf-8')<br />
except:<br />
s+=unicode(struct,'windows_1252')<br />
return s<br />
class xoxoParser(sgmllib.SGMLParser):<br />
def __init__(self):<br />
sgmllib.SGMLParser.__init__(self)<br />
self.structs=[]<br />
self.xostack=[]<br />
self.textstack=['']<br />
def normalize_attrs(self, attrs):<br />
attrs = [(k.lower(), sgmllib.charref.sub(lambda m: chr(int(m.groups()[0])), v).strip()) for k, v in attrs]<br />
attrs = [(k, k in ('rel','type') and v.lower() or v) for k, v in attrs]<br />
return attrs<br />
def pushStruct(self,struct):<br />
if type(struct) == type({}) and len(struct)==0 and len(self.structs) and type(self.structs[-1]) == type({}) and self.structs[-1].has_key('url'):<br />
self.xostack.append(self.structs[-1]) # put back the <a>-made one for extra def's<br />
else:<br />
self.structs.append(struct)<br />
self.xostack.append(self.structs[-1])<br />
def start_a(self,attrs):<br />
attrsD = dict(self.normalize_attrs(attrs))<br />
attrsD['url']= attrsD.get('href','')<br />
del attrsD['href']<br />
self.pushStruct(attrsD)<br />
self.textstack.append('')<br />
def end_a(self):<br />
val = self.textstack.pop()<br />
if val: <br />
if self.xostack[-1].get('title','') == val:<br />
val=''<br />
if self.xostack[-1]['url'] == val:<br />
val=''<br />
if val:<br />
self.xostack[-1]['text']=val<br />
self.xostack.pop()<br />
def start_dl(self,attrs):<br />
self.pushStruct({})<br />
def end_dl(self):<br />
self.xostack.pop()<br />
def start_ol(self,attrs):<br />
self.pushStruct([])<br />
def end_ol(self):<br />
self.xostack.pop()<br />
def start_ul(self,attrs):<br />
self.pushStruct([])<br />
def end_ul(self):<br />
self.xostack.pop()<br />
def start_li(self,attrs):<br />
self.textstack.append('')<br />
def end_li(self):<br />
val = self.textstack.pop()<br />
if self.structs[-1] != self.xostack[-1]:<br />
val = self.structs.pop()<br />
self.xostack[-1].append(val)<br />
def start_dt(self,attrs):<br />
self.textstack.append('')<br />
def end_dt(self):<br />
pass<br />
def start_dd(self,attrs):<br />
self.textstack.append('')<br />
def end_dd(self):<br />
val = self.textstack.pop()<br />
key = self.textstack.pop()<br />
if self.structs[-1] != self.xostack[-1]:<br />
val = self.structs.pop()<br />
self.xostack[-1][key]=val<br />
def handle_data(self, text):<br />
if len(self.stack) and containerTags.get(self.stack[-1],True): #skip text not within an element<br />
self.textstack[-1] += text<br />
def toXOXO(struct,addHTMLWrapper=False,cssUrl=''):<br />
if type(struct) ==type((1,))or type(struct) ==type([1,]):<br />
inStruct = struct<br />
else:<br />
inStruct = [struct]<br />
if addHTMLWrapper:<br />
s= '''<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN<br />
http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><br />
<html xmlns="http://www.w3.org/1999/xhtml"><head profile=""><meta http-equiv="Content-Type" content="text/html; charset=utf-8" />'''<br />
if cssUrl:<br />
s+='<style type="text/css" >@import "%s";</style>' % cssUrl<br />
s+="</head><body>%s</body></html>" % makeXOXO(inStruct,'xoxo')<br />
return s.encode('utf-8')<br />
else:<br />
return makeXOXO(inStruct,'xoxo').encode('utf-8')<br />
<br />
import sys<br />
<br />
def fromXOXO(html):<br />
parser = xoxoParser()<br />
parser.feed(unicode(html,'utf-8'))<br />
#print >>sys.stderr, parser.structs<br />
structs=[struct for struct in parser.structs if struct]<br />
#print >>sys.stderr, structs<br />
while (len(structs) ==1 and type(structs)==type([1,])):<br />
structs=structs[0]<br />
return structs<br />
<br />
# Allow direct invocation<br />
# Read HTML from URL, parse into data structures, then re-output<br />
<br />
if __name__ == "__main__":<br />
if len(sys.argv) < 2: raise SystemExit("Usage: "+sys.argv[0]+" url\n"+__doc__)<br />
url=sys.argv[1]<br />
file = urllib.urlopen(url)<br />
html=file.read(-1)<br />
file.close<br />
s=fromXOXO(html)<br />
p=toXOXO(s,True)<br />
print p<br />
<br />
</nowiki></pre><br />
<br />
== testxoxo.py ==<br />
<pre><nowiki><br />
# -*- coding: utf-8 -*-<br />
"""testxoxo.py <br />
Unit tests for xoxo.py<br />
This file tests the functions in xoxo.py <br />
The underlying model here is http://diveintopython.org/unit_testing/index.html <br />
<br />
run from command line with<br />
python testxoxo.py -v<br />
"""<br />
import xoxo<br />
reload(xoxo)<br />
import unittest<br />
<br />
class xoxoTestCases(unittest.TestCase):<br />
<br />
def testSimpleList(self):<br />
'''make a xoxo file from a list'''<br />
l = ['1','2','3']<br />
html = xoxo.toXOXO(l)<br />
self.assertEqual(html,'<ol class="xoxo"><li>1</li><li>2</li><li>3</li></ol>')<br />
def testNestedList(self):<br />
'''make a xoxo file from a list with a list in'''<br />
l = ['1',['2','3']]<br />
html = xoxo.toXOXO(l)<br />
self.assertEqual(html,'<ol class="xoxo"><li>1</li><li><ol><li>2</li><li>3</li></ol></li></ol>')<br />
<br />
def testDictionary(self):<br />
'''make a xoxo file from a dictionary'''<br />
d = {'test':'1','name':'Kevin'}<br />
html = xoxo.toXOXO(d)<br />
self.assertEqual(html,'<ol class="xoxo"><li><dl><dt>test</dt><dd>1</dd><dt>name</dt><dd>Kevin</dd></dl></li></ol>')<br />
<br />
def testSingleItem(self):<br />
'''make a xoxo file from a string'''<br />
l = "test"<br />
html = xoxo.toXOXO(l)<br />
self.assertEqual(html,'<ol class="xoxo"><li>test</li></ol>')<br />
<br />
def testWrapDiffers(self):<br />
'''make a xoxo file from a string with and without html wrapper and check they are different'''<br />
l = "test"<br />
html = xoxo.toXOXO(l)<br />
htmlwrap = xoxo.toXOXO(l,addHTMLWrapper=True)<br />
self.failIfEqual(html,htmlwrap)<br />
<br />
def testWrapSingleItem(self):<br />
'''make a wrapped xoxo file from a string'''<br />
l = "test"<br />
html = xoxo.toXOXO(l,addHTMLWrapper=True)<br />
self.assertEqual(html,'''<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN<br />
http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><br />
<html xmlns="http://www.w3.org/1999/xhtml"><head profile=""></head><body><ol class="xoxo"><li>test</li></ol></body></html>''')<br />
<br />
def testDictionaryRoundTrip(self):<br />
''' make a dictionary into a xoxo file and back again; check it is the same'''<br />
d = {'test':'1','name':'Kevin'}<br />
html = xoxo.toXOXO(d)<br />
newd = xoxo.fromXOXO(html)<br />
self.assertEqual(d,newd)<br />
<br />
def testListRoundTrip(self):<br />
''' make a list into a xoxo file and back again; check it is the same'''<br />
l = ['3','2','1']<br />
html = xoxo.toXOXO(l)<br />
newdl= xoxo.fromXOXO(html)<br />
self.assertEqual(l,newdl)<br />
def testListofDictsRoundTrip(self):<br />
''' make a list of Dicts into a xoxo file and back again; check it is the same'''<br />
l = ['3',{'a':'2'},{'b':'1','c':'4'}]<br />
html = xoxo.toXOXO(l)<br />
newdl= xoxo.fromXOXO(html)<br />
self.assertEqual(l,newdl)<br />
def testListofListsRoundTrip(self):<br />
''' make a list of Lists into a xoxo file and back again; check it is the same'''<br />
l = ['3',['a','2'],['b',['1',['c','4']]]]<br />
html = xoxo.toXOXO(l)<br />
newdl= xoxo.fromXOXO(html)<br />
self.assertEqual(l,newdl)<br />
def testDictofListsRoundTrip(self):<br />
''' make a dict with lists in into a xoxo file and back again; check it is the same'''<br />
d = {'test':['1','2'],<br />
'name':'Kevin',<br />
'nestlist':['a',['b','c']],<br />
'nestdict':{'e':'6','f':'7'}}<br />
html = xoxo.toXOXO(d)<br />
newd = xoxo.fromXOXO(html)<br />
self.assertEqual(d,newd)<br />
<br />
def testXOXOjunkInContainers(self):<br />
'''make sure text outside <li> etc is ignored'''<br />
d=xoxo.fromXOXO('<ol>bad<li><dl>worse<dt>good</dt><dd>buy</dd> now</dl></li></ol>')<br />
self.assertEqual(d,{'good': 'buy'})<br />
def testXOXOjunkInElements(self):<br />
'''make sure text within <li> but outside a subcontainer is ignored'''<br />
l=xoxo.fromXOXO('<ol><li>bad<dl><dt>good</dt><dd>buy</dd></dl>worse</li><li>bag<ol><li>OK</li></ol>fish</li></ol>')<br />
self.assertEqual(l,[{'good': 'buy'},['OK']])<br />
def testXOXOWithSpacesAndNewlines(self):<br />
'''unmung some xoxo with spaces in and check result is right'''<br />
xoxoSample= '''<ol class='xoxo'> <br />
<li><br />
<dl><br />
<dt>text</dt><br />
<dd>item 1</dd><br />
<dt>description</dt><br />
<dd> This item represents the main point we're trying to make.</dd><br />
<dt>url</dt><br />
<dd>http://example.com/more.xoxo</dd><br />
<dt>title</dt><br />
<dd>title of item 1</dd><br />
<dt>type</dt><br />
<dd>text/xml</dd><br />
<dt>rel</dt><br />
<dd>help</dd><br />
</dl><br />
</li><br />
</ol>'''<br />
d = xoxo.fromXOXO(xoxoSample)<br />
d2={'text':'item 1',<br />
'description':" This item represents the main point we're trying to make.",<br />
'url':'http://example.com/more.xoxo',<br />
'title':'title of item 1',<br />
'type':'text/xml',<br />
'rel':'help'<br />
}<br />
xoxoAgain = xoxo.toXOXO(d)<br />
self.assertEqual(d,d2)<br />
#this needs a smarter whitespace-sensitive comparison<br />
#self.assertEqual(xoxoSample,xoxoAgain)<br />
<br />
def testSpecialAttributeDecoding(self):<br />
'''unmung some xoxo with <a href=' rel= etc in and check result is right'''<br />
xoxoSample= '''<ol class='xoxo'> <br />
<li><br />
<dl><br />
<dt>text</dt><br />
<dd>item 1</dd><br />
<dt>url</dt><br />
<dd>http://example.com/more.xoxo</dd><br />
<dt>title</dt><br />
<dd>title of item 1</dd><br />
<dt>type</dt><br />
<dd>text/xml</dd><br />
<dt>rel</dt><br />
<dd>help</dd><br />
</dl><br />
</li><br />
</ol>'''<br />
d = xoxo.fromXOXO(xoxoSample)<br />
smartxoxoSample= '''<ol class='xoxo'> <br />
<li><a href="http://example.com/more.xoxo"<br />
title="title of item 1"<br />
type="text/xml"<br />
rel="help">item 1</a> <br />
<!-- note how the "text" property is simply the contents of the <a> element --><br />
</li><br />
</ol>'''<br />
d2 = xoxo.fromXOXO(smartxoxoSample)<br />
self.assertEqual(d,d2)<br />
def testSpecialAttributeAndDLDecoding(self):<br />
'''unmung some xoxo with <a href=' rel= etc in plus a <dl> in the same item and check result is right'''<br />
xoxoSample= '''<ol class="xoxo"> <br />
<li><br />
<dl><br />
<dt>text</dt><br />
<dd>item 1</dd><br />
<dt>description</dt><br />
<dd> This item represents the main point we're trying to make.</dd><br />
<dt>url</dt><br />
<dd>http://example.com/more.xoxo</dd><br />
<dt>title</dt><br />
<dd>title of item 1</dd><br />
<dt>type</dt><br />
<dd>text/xml</dd><br />
<dt>rel</dt><br />
<dd>help</dd><br />
</dl><br />
</li><br />
</ol>'''<br />
d = xoxo.fromXOXO(xoxoSample)<br />
smartxoxoSample= '''<ol class="xoxo"> <br />
<li><a href="http://example.com/more.xoxo"<br />
title="title of item 1"<br />
type="text/xml"<br />
rel="help">item 1</a> <br />
<!-- note how the "text" property is simply the contents of the <a> element --><br />
<dl><br />
<dt>description</dt><br />
<dd> This item represents the main point we're trying to make.</dd><br />
</dl><br />
</li><br />
</ol>'''<br />
d2 = xoxo.fromXOXO(smartxoxoSample)<br />
self.assertEqual(d,d2)<br />
def testSpecialAttributeEncode(self):<br />
'''check it makes an <a href with a url parameter'''<br />
d={'url':'http://example.com/more.xoxo','title':'sample url','type':"text/xml",'rel':'help','text':'an example'}<br />
html=xoxo.toXOXO(d)<br />
expectedHTML= '<ol class="xoxo"><li><a href="http://example.com/more.xoxo" title="sample url" rel="help" type="text/xml" >an example</a></li></ol>' <br />
self.assertEqual(html,expectedHTML)<br />
<br />
def testSpecialAttributeRoundTripFull(self):<br />
'''check it makes an <a href with a url parameter'''<br />
d={'url':'http://example.com/more.xoxo','title':'sample url','type':"text/xml",'rel':'help','text':'an example'}<br />
html=xoxo.toXOXO(d)<br />
self.assertEqual(d,xoxo.fromXOXO(html))<br />
def testSpecialAttributeRoundTripNoText(self):<br />
'''check it makes an <a href with a url parameter and no text attribute'''<br />
d={'url':'http://example.com/more.xoxo','title':'sample url','type':"text/xml",'rel':'help'}<br />
html=xoxo.toXOXO(d)<br />
self.assertEqual(d,xoxo.fromXOXO(html))<br />
def testSpecialAttributeRoundTripNoTextOrTitle(self):<br />
'''check it makes an <a href with a url parameter and no text or title attribute'''<br />
d={'url':'http://example.com/more.xoxo'}<br />
html=xoxo.toXOXO(d)<br />
self.assertEqual(d,xoxo.fromXOXO(html))<br />
def testUnicodeRoundtrip(self):<br />
'''check unicode characters can go to xoxo and back'''<br />
src=unicode('Tantek Çelik and a snowman ?','utf-8')<br />
html = html=xoxo.toXOXO(src)<br />
self.assertEqual(src,xoxo.fromXOXO(html))<br />
if __name__ == "__main__":<br />
unittest.main()<br />
else:<br />
runner = unittest.TextTestRunner()<br />
suite = unittest.makeSuite(xoxoTestCases,'test')<br />
runner.run(suite)<br />
<br />
</nowiki></pre><br />
<br />
= Java =<br />
== XOXOWriter.java ==<br />
<pre><nowiki><br />
/*<br />
* Copyright 2005 Robert Sayre<br />
*<br />
* Licensed under the Apache License, Version 2.0 (the "License");<br />
* you may not use this file except in compliance with the License.<br />
* You may obtain a copy of the License at<br />
* <br />
* http://www.apache.org/licenses/LICENSE-2.0<br />
* <br />
* Unless required by applicable law or agreed to in writing, software<br />
* distributed under the License is distributed on an "AS IS" BASIS,<br />
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<br />
* See the License for the specific language governing permissions and<br />
* limitations under the License.<br />
*<br />
* Portions of this code are derived from the Apache-licensed Python XOXO<br />
* module by Kevin Marks. <http://microformats.org/wiki/xoxo-sample-code><br />
*/<br />
<br />
package org.atompub.draft.xoxo;<br />
<br />
import java.util.*;<br />
<br />
public class XOXOWriter {<br />
<br />
public String[] attrs = {"title","rel","type"};<br />
<br />
public String makeXOXO(List struct, String className){<br />
return makeXOXO(struct, className, 0, true);<br />
}<br />
<br />
public String makeXOXO(List struct, String className,<br />
boolean doNSDeclaration){<br />
return makeXOXO(struct, className, 0, doNSDeclaration);<br />
}<br />
<br />
public String makeXOXO(List struct){<br />
return makeXOXO(struct, "xoxo", 0, true);<br />
}<br />
<br />
public String makeXOXO(Object struct, int depth){<br />
return makeXOXO(struct, null, 0, false);<br />
}<br />
<br />
public String makeXOXO(Object struct, String className,<br />
int depth, boolean doNSDeclaration){<br />
if(struct == null) return "";<br />
StringBuffer sb = new StringBuffer();<br />
if(struct instanceof Object[]){<br />
struct = Arrays.asList((Object[]) struct);<br />
}<br />
if(struct instanceof List){<br />
sb.append("<ol");<br />
if(doNSDeclaration)<br />
sb.append(" xmlns=\"http://www.w3.org/1999/xhtml\"");<br />
if(className != null){<br />
sb.append(" class=\"");<br />
sb.append(className);<br />
sb.append("\"");<br />
}<br />
sb.append(">");<br />
}<br />
if(struct instanceof Map){<br />
Map d = new LinkedHashMap((Map) struct);<br />
if(d.containsKey("url")){<br />
sb.append("<a href=\"" + d.get("url") + "\" ");<br />
Object text;<br />
if(d.containsKey("text")){<br />
text = d.get("text");<br />
}else if(d.containsKey("title")){<br />
text = d.get("title");<br />
}else{<br />
text = d.get("url");<br />
}<br />
for(int i=0; i<attrs.length; i++){<br />
String xVal = makeXOXO(d.get(attrs[i]),depth+1);<br />
if(xVal != null && !xVal.equals("")){<br />
sb.append(attrs[i] + "=\"" + xVal + "\" ");<br />
}<br />
d.remove(attrs[i]);<br />
}<br />
sb.append(">" + makeXOXO(text, depth+1) + "</a>");<br />
d.remove("text");<br />
d.remove("url");<br />
}<br />
if(d.size() > 0){<br />
sb.append("<dl>");<br />
for(Iterator i = d.keySet().iterator(); i.hasNext();){<br />
Object k = i.next();<br />
String ddVal = makeXOXO(d.get(k),depth+1);<br />
sb.append("<dt>" + k + "</dt>");<br />
sb.append("<dd>" + ddVal + "</dd>");<br />
}<br />
sb.append("</dl>");<br />
}<br />
}else if(struct instanceof List){<br />
List l = (List) struct;<br />
for(Iterator i = l.iterator(); i.hasNext();){<br />
Object item = i.next();<br />
sb.append("<li>" + makeXOXO(item,depth+1) + "</li>");<br />
}<br />
sb.append("</ol>");<br />
}else{<br />
sb.append(struct);<br />
}<br />
return sb.toString();<br />
}<br />
<br />
public String toXOXO(List struct){<br />
return toXOXO(struct, false, null);<br />
}<br />
<br />
public String toXOXO(Object struct){<br />
List alist = new ArrayList();<br />
alist.add(struct);<br />
return toXOXO(alist);<br />
}<br />
<br />
public String toXOXO(Object struct,<br />
boolean addHTMLWrapper,<br />
String cssUrl){<br />
List alist = new ArrayList();<br />
alist.add(struct);<br />
return toXOXO(alist, addHTMLWrapper, cssUrl);<br />
}<br />
<br />
public String toXOXO(List struct,<br />
boolean addHTMLWrapper,<br />
String cssUrl){<br />
String startHTML = "<!DOCTYPE html PUBLIC \"-//W3C//DTD"<br />
+ "XHTML 1.0 Transitional//EN\n"<br />
+ "http://www.w3.org/TR/xhtml1/DTD/"<br />
+ "xhtml1-transitional.dtd\">"<br />
+ "<html xmlns=\"http://www.w3.org/1999/xhtml\">"<br />
+ "<head>";<br />
if(addHTMLWrapper){<br />
String s = startHTML;<br />
if(cssUrl != null){<br />
s += "<style type=\"text/css\">@import \""<br />
+ cssUrl + "\";</style>";<br />
}<br />
s += "</head><body>" + makeXOXO(struct, "xoxo", false)<br />
+ "</body></html>";<br />
return s;<br />
}else{<br />
return makeXOXO(struct, "xoxo");<br />
}<br />
}<br />
}<br />
</nowiki></pre><br />
<br />
== XOXOParser.java ==<br />
This needs some small additions to handle the XHTML DTD and entities.<br />
<br />
<pre><nowiki><br />
/*<br />
* Copyright 2005 Robert Sayre<br />
*<br />
* Licensed under the Apache License, Version 2.0 (the "License");<br />
* you may not use this file except in compliance with the License.<br />
* You may obtain a copy of the License at<br />
* <br />
* http://www.apache.org/licenses/LICENSE-2.0<br />
* <br />
* Unless required by applicable law or agreed to in writing, software<br />
* distributed under the License is distributed on an "AS IS" BASIS,<br />
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<br />
* See the License for the specific language governing permissions and<br />
* limitations under the License.<br />
*<br />
* Portions of this code are derived from the Apache-licensed Python XOXO<br />
* module by Kevin Marks. <http://microformats.org/wiki/xoxo-sample-code><br />
*/<br />
<br />
package org.atompub.draft.xoxo;<br />
<br />
import org.xml.sax.InputSource;<br />
import org.xml.sax.SAXException;<br />
import org.xml.sax.XMLReader;<br />
import org.xml.sax.Attributes;<br />
import org.xml.sax.helpers.XMLReaderFactory;<br />
import org.xml.sax.helpers.DefaultHandler;<br />
<br />
import java.util.*;<br />
import java.io.InputStream;<br />
import java.io.StringReader;<br />
import java.io.IOException;<br />
<br />
public class XOXOParser extends DefaultHandler {<br />
<br />
protected String XHTML_NS = "http://www.w3.org/1999/xhtml";<br />
protected List elStack;<br />
protected Map listEls;<br />
public List structs;<br />
public List xoStack;<br />
public List textStack;<br />
<br />
public XOXOParser() {<br />
reset();<br />
}<br />
<br />
protected void pushStruct(Object struct){<br />
if((struct instanceof Map) && (((Map) struct).size() > 0)<br />
&& (structs.get(structs.size()-1) instanceof Map)<br />
&& (((Map) struct).containsKey("url"))){<br />
// put back the <a>-made one for extra defs<br />
xoStack.add(structs.get(structs.size()-1));<br />
}else{<br />
structs.add(struct);<br />
xoStack.add(struct);<br />
}<br />
}<br />
<br />
public void startElement(String nsUri, String localName,<br />
String qName, Attributes atts){<br />
// bounce non-XHTML elements<br />
if(nsUri.equals(XHTML_NS)){<br />
elStack.add(localName);<br />
}else{<br />
elStack.add("foo");<br />
return;<br />
}<br />
<br />
if(localName.equals("a")){<br />
Map attmap = new LinkedHashMap();<br />
int len = atts.getLength();<br />
for(int i=0; i<len; i++){<br />
attmap.put(atts.getQName(i),atts.getValue(i));<br />
}<br />
if(attmap.containsKey("href")){<br />
attmap.put("url",attmap.get("href"));<br />
attmap.remove("href");<br />
}<br />
pushStruct(attmap);<br />
textStack.add("");<br />
}else if(localName.equals("dl")){<br />
pushStruct(new LinkedHashMap());<br />
}else if(localName.equals("ol")){<br />
pushStruct(new ArrayList());<br />
}else if(localName.equals("ul")){<br />
pushStruct(new ArrayList());<br />
}else if(localName.equals("li")){<br />
textStack.add("");<br />
}else if(localName.equals("dt")){<br />
textStack.add("");<br />
}else if(localName.equals("dd")){<br />
textStack.add("");<br />
}<br />
}<br />
<br />
public void endElement(String nsUri, String localName,<br />
String qName){<br />
elStack.remove(elStack.size()-1);<br />
// bounce non-XHTML elements<br />
if(nsUri != XHTML_NS){<br />
return;<br />
}<br />
<br />
if(localName.equals("a")){<br />
String val = (String) textStack.remove(textStack.size()-1);<br />
if (val.length() > 0){<br />
Map defs = (Map) xoStack.get(xoStack.size()-1);<br />
String defVal = (String) defs.get("title");<br />
if((defVal != null) && (val.equals(defVal))){<br />
val = "";<br />
}<br />
defVal = (String) defs.get("url");<br />
if((defVal != null) && (val.equals(defVal))){<br />
val = "";<br />
}<br />
if(val.length() > 0){<br />
defs.put("text",val);<br />
}<br />
}<br />
xoStack.remove(xoStack.size()-1);<br />
}else if(localName.equals("dl")){<br />
xoStack.remove(xoStack.size()-1);<br />
}else if(localName.equals("ol")){<br />
xoStack.remove(xoStack.size()-1);<br />
}else if(localName.equals("ul")){<br />
xoStack.remove(xoStack.size()-1);<br />
}else if(localName.equals("li")){<br />
Object val = textStack.remove(textStack.size()-1);<br />
List last = (List) xoStack.get(xoStack.size()-1);<br />
if(structs.get(structs.size()-1) != last){<br />
val = structs.remove(structs.size()-1);<br />
}<br />
last.add(val);<br />
}else if(localName.equals("dd")){<br />
Object val = textStack.remove(textStack.size()-1);<br />
Object key = textStack.remove(textStack.size()-1);<br />
Map last = (Map) xoStack.get(xoStack.size()-1);<br />
if(structs.get(structs.size()-1) != last){<br />
val = structs.remove(structs.size()-1);<br />
}<br />
last.put(key,val);<br />
}<br />
}<br />
<br />
public void characters(char[] ch, int start, int length){<br />
if((xoStack.size() > 0)<br />
&& (!listEls.containsKey(elStack.get(elStack.size()-1)))){<br />
String text = (String) textStack.get(textStack.size()-1);<br />
String test = new String(ch,start,length);<br />
textStack.set(textStack.size()-1,text+test);<br />
}<br />
}<br />
<br />
public Object parse(String s) throws SAXException, IOException{<br />
return parse(new InputSource(new StringReader(s)));<br />
}<br />
<br />
public Object parse(InputStream is) throws SAXException, IOException {<br />
return parse(new InputSource(is));<br />
}<br />
<br />
public Object parse(InputSource in) throws SAXException, IOException {<br />
XMLReader parser = XMLReaderFactory.createXMLReader();<br />
parser.setContentHandler(this);<br />
parser.parse(in);<br />
List returnList = new ArrayList();<br />
for(Iterator i = this.structs.iterator(); i.hasNext();){<br />
Object thing = i.next();<br />
if(thing != null){<br />
returnList.add(thing);<br />
}<br />
}<br />
while((returnList.size()==1)){<br />
if(returnList.get(0) instanceof List){<br />
returnList = (List) returnList.get(0);<br />
}else{<br />
reset();<br />
return returnList.get(0);<br />
}<br />
}<br />
reset();<br />
return returnList;<br />
}<br />
<br />
protected void reset(){<br />
elStack = new ArrayList();<br />
listEls = new HashMap();<br />
structs = new ArrayList();<br />
xoStack = new ArrayList();<br />
textStack = new ArrayList();<br />
listEls.put("ol","ol");<br />
listEls.put("ul","ul");<br />
listEls.put("dl","dl");<br />
}<br />
}<br />
<br />
</nowiki></pre><br />
<br />
== XOXOTest.java ==<br />
<pre><nowiki><br />
/*<br />
* Copyright 2005 Robert Sayre<br />
*<br />
* Licensed under the Apache License, Version 2.0 (the "License");<br />
* you may not use this file except in compliance with the License.<br />
* You may obtain a copy of the License at<br />
* <br />
* http://www.apache.org/licenses/LICENSE-2.0<br />
* <br />
* Unless required by applicable law or agreed to in writing, software<br />
* distributed under the License is distributed on an "AS IS" BASIS,<br />
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<br />
* See the License for the specific language governing permissions and<br />
* limitations under the License.<br />
*<br />
* Portions of this code are derived from the Apache-licensed Python XOXO<br />
* module by Kevin Marks. <http://microformats.org/wiki/xoxo-sample-code><br />
*/<br />
<br />
package org.atompub.draft.xoxo.tests;<br />
<br />
import junit.framework.TestSuite;<br />
import junit.framework.TestCase;<br />
import junit.textui.TestRunner;<br />
import org.atompub.draft.xoxo.XOXOWriter;<br />
import org.atompub.draft.xoxo.XOXOParser;<br />
<br />
import java.util.*;<br />
<br />
public class XOXOTest extends TestCase {<br />
<br />
public static void main(String[] args) {<br />
new TestRunner().doRun(new TestSuite(XOXOTest.class));<br />
}<br />
String XHTML_DEC = "xmlns=\"http://www.w3.org/1999/xhtml\" ";<br />
public String simpleListHTML = "<ol "<br />
+ XHTML_DEC<br />
+ "class=\"xoxo\">"<br />
+ "<li>1</li><li>2</li><li>3</li></ol>";<br />
<br />
public void testSimpleList(){<br />
String [] numbers = {"1","2","3"};<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(simpleListHTML,<br />
xoxo.toXOXO(Arrays.asList(numbers)));<br />
}<br />
<br />
public void testStringIntegerList(){<br />
Object[] numbers = {new Integer(1),"2","3"};<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(simpleListHTML,<br />
xoxo.toXOXO(Arrays.asList(numbers)));<br />
}<br />
<br />
public String nestedListHTML = "<ol "<br />
+ XHTML_DEC<br />
+ "class=\"xoxo\"><li>1</li><li>"<br />
+ "<ol><li>2</li><li>3</li></ol></li></ol>";<br />
<br />
public void testNestedList(){<br />
Object[] arr = {"2","3"};<br />
Object[] nested = {"1",Arrays.asList(arr)};<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(nestedListHTML,<br />
xoxo.toXOXO(Arrays.asList(nested)));<br />
}<br />
<br />
public void testNestedArray(){<br />
Object[] arr = {"2","3"};<br />
Object[] nested = {"1",arr};<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(nestedListHTML,<br />
xoxo.toXOXO(Arrays.asList(nested)));<br />
}<br />
<br />
public String dictHTML = "<ol "<br />
+ XHTML_DEC<br />
+ "class=\"xoxo\">"<br />
+ "<li><dl><dt>test</dt><dd>1</dd><dt>name</dt>"<br />
+ "<dd>Kevin</dd></dl></li></ol>";<br />
<br />
public void testDictionary(){<br />
Map dict = new LinkedHashMap();<br />
dict.put("test", new Integer(1));<br />
dict.put("name", "Kevin");<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(dictHTML,<br />
xoxo.toXOXO(dict));<br />
}<br />
<br />
public String singleHTML = "<ol "<br />
+ XHTML_DEC<br />
+ "class=\"xoxo\">"<br />
+ "<li>test</li></ol>";<br />
<br />
public void testSingleItem(){<br />
String item = "test";<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(singleHTML,<br />
xoxo.toXOXO(item));<br />
}<br />
<br />
public void testWrapDiffers(){<br />
String item = "test";<br />
XOXOWriter xoxo = new XOXOWriter();<br />
String nowrap = xoxo.toXOXO(item);<br />
Object[] itemArr = {item};<br />
String wrap = xoxo.toXOXO(Arrays.asList(itemArr),true,null);<br />
assertFalse(wrap.equals(nowrap));<br />
}<br />
<br />
String startHTML = "<!DOCTYPE html PUBLIC \"-//W3C//DTD"<br />
+ "XHTML 1.0 Transitional//EN\n"<br />
+ "http://www.w3.org/TR/xhtml1/DTD/"<br />
+ "xhtml1-transitional.dtd\">"<br />
+ "<html xmlns=\"http://www.w3.org/1999/xhtml\">"<br />
+ "<head></head><body>";<br />
public String singleWrapHTML = "<ol "<br />
+ "class=\"xoxo\">"<br />
+ "<li>test</li></ol>";<br />
public String endHTML = "</body></html>";<br />
<br />
public void testWrapSingleItem(){<br />
String item = "test";<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(startHTML + singleWrapHTML + endHTML,<br />
xoxo.toXOXO(item,true,null));<br />
}<br />
<br />
public void testXOXOParser(){<br />
XOXOParser parser = new XOXOParser();<br />
try{<br />
parser.parse(dictHTML);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testDictRoundTrip(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("test", "1");<br />
dict.put("name", "Kevin");<br />
String html = xoxo.toXOXO(dict);<br />
try{<br />
Object newDict = parser.parse(html);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testListRoundTrip(){<br />
Object[] obj = {"1","2","3"};<br />
List testList = Arrays.asList(obj);<br />
XOXOWriter xoxo = new XOXOWriter();<br />
String html = xoxo.toXOXO(testList);<br />
XOXOParser parser = new XOXOParser();<br />
try{<br />
Object newList = parser.parse(html);<br />
assertEquals(testList,newList);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testListOfDictsRoundTrip(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("test", "1");<br />
dict.put("name", "Kevin");<br />
Map dict2 = new LinkedHashMap();<br />
dict2.put("one", "two");<br />
dict2.put("three", "four");<br />
dict2.put("five", "six");<br />
Object[] obj = {"1",dict,dict2};<br />
List testList = Arrays.asList(obj);<br />
String html = xoxo.toXOXO(testList);<br />
try{<br />
Object newList = parser.parse(html);<br />
assertEquals(testList,newList);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testListOfListsRoundTrip(){<br />
Object[] list1 = {"1","2","3"};<br />
Object[] list2 = {"4","5","6", Arrays.asList(list1)};<br />
Object[] list3 = {"7", Arrays.asList(list2)};<br />
Object[] list4 = {"8", Arrays.asList(list3)};<br />
List testList = Arrays.asList(list4);<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
String html = xoxo.toXOXO(testList);<br />
try{<br />
Object newList = parser.parse(html);<br />
assertEquals(testList,newList);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testDictOfListsRoundTrip(){<br />
Object[] list1 = {"1","2","3"};<br />
Object[] list2 = {"4","5","6"};<br />
Object[] list3 = {"7"};<br />
Object[] list4 = {"8", "9"};<br />
Map dict = new LinkedHashMap();<br />
dict.put("foo", Arrays.asList(list1));<br />
dict.put("bar", Arrays.asList(list2));<br />
dict.put("baz", Arrays.asList(list3));<br />
dict.put("qux", Arrays.asList(list4));<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
String html = xoxo.toXOXO(dict);<br />
try{<br />
Object newDict = parser.parse(html);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public String junkXOXO = "<ol "<br />
+ XHTML_DEC<br />
+ "class=\"xoxo\">"<br />
+ "bad<li><dl>worse<dt>good</dt><dd>buy</dd> now</dl></li></ol>";<br />
<br />
public void testXOXOJunkInContainers(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("good","buy");<br />
try{<br />
Object newDict = parser.parse(junkXOXO);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public String junkElementXOXO = "<ol "<br />
+ XHTML_DEC<br />
+ "><li>bad<dl><dt>good</dt><dd>buy</dd></dl>"<br />
+ "worse</li><li>bag<ol><li>OK</li></ol>fish</li></ol>";<br />
<br />
public void testXOXOjunkInElements(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("good","buy");<br />
Object[] ok = {"OK"};<br />
Object[] obj ={dict, Arrays.asList(ok)};<br />
List testList = Arrays.asList(obj);<br />
try{<br />
Object newList = parser.parse(junkElementXOXO);<br />
assertEquals(testList,newList);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public String xoxoSpacesNewlines = "<ol " + XHTML_DEC +<br />
" class='xoxo'> \n" +<br />
" <li>\n" +<br />
" <dl>\n" +<br />
" <dt>text</dt>\n" +<br />
" <dd>item 1</dd>\n" +<br />
" <dt>description</dt>\n" +<br />
" <dd> This item represents the main" +<br />
" point we're trying to make.</dd>\n" +<br />
" <dt>url</dt>\n" +<br />
" <dd>http://example.com/more.xoxo</dd>\n" +<br />
" <dt>title</dt>\n" +<br />
" <dd>title of item 1</dd>\n" +<br />
" <dt>type</dt>\n" +<br />
" <dd>text/xml</dd>\n" +<br />
" <dt>rel</dt>\n" +<br />
" <dd>help</dd>\n" +<br />
" </dl>\n" +<br />
" </li>\n" +<br />
"</ol>";<br />
<br />
public void testXOXOWithSpacesAndNewlines(){<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("text","item 1");<br />
dict.put("description"," This item represents the main" +<br />
" point we're trying to make.");<br />
dict.put("url","http://example.com/more.xoxo");<br />
dict.put("title","title of item 1");<br />
dict.put("type","text/xml");<br />
dict.put("rel","help");<br />
try{<br />
Object newDict = parser.parse(xoxoSpacesNewlines);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public String xoxoSample = "<ol " + XHTML_DEC +<br />
" class='xoxo'> \n" +<br />
" <li>\n" +<br />
" <dl>\n" +<br />
" <dt>text</dt>\n" +<br />
" <dd>item 1</dd>\n" +<br />
" <dt>url</dt>\n" +<br />
" <dd>http://example.com/more.xoxo</dd>\n" +<br />
" <dt>title</dt>\n" +<br />
" <dd>title of item 1</dd>\n" +<br />
" <dt>type</dt>\n" +<br />
" <dd>text/xml</dd>\n" +<br />
" <dt>rel</dt>\n" +<br />
" <dd>help</dd>\n" +<br />
" </dl>\n" +<br />
" </li>\n" +<br />
"</ol>";<br />
<br />
public String smartXOXOSample = "<ol " + XHTML_DEC +<br />
"class=\"xoxo\"> \n" +<br />
" <li><a href=\"http://example.com/more.xoxo\"\n" +<br />
" title=\"title of item 1\"\n" +<br />
" type=\"text/xml\"\n" +<br />
" rel=\"help\">item 1</a> \n" +<br />
"<!-- note how the \"text\" property is simply" +<br />
" the contents of the <a> element -->\n" +<br />
" </li>\n" +<br />
"</ol>";<br />
<br />
public void testSpecialAttributeDecoding(){<br />
XOXOParser parser = new XOXOParser();<br />
try{<br />
Object xoxoDict = parser.parse(xoxoSample);<br />
Object xoxoDict2 = parser.parse(smartXOXOSample);<br />
assertEquals(xoxoDict,xoxoDict2);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public String specialAttrHTML = "<ol " + XHTML_DEC +<br />
"class=\"xoxo\">" +<br />
"<li><a href=\"http://example.com/more.xoxo\" title=\"sample url\" " +<br />
"rel=\"help\" type=\"text/xml\" >an example</a></li></ol>";<br />
<br />
public void testSpecialAttributeEncode(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
Map dict = new LinkedHashMap();<br />
dict.put("url","http://example.com/more.xoxo");<br />
dict.put("title","sample url");<br />
dict.put("type","text/xml");<br />
dict.put("rel","help");<br />
dict.put("text","an example");<br />
String html = xoxo.toXOXO(dict);<br />
assertEquals(specialAttrHTML,html);<br />
}<br />
<br />
public void testSpecialAttributeRoundTripFull(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("url","http://example.com/more.xoxo");<br />
dict.put("title","sample url");<br />
dict.put("type","text/xml");<br />
dict.put("rel","help");<br />
dict.put("text","an example");<br />
String html = xoxo.toXOXO(dict);<br />
try{<br />
Object newDict = parser.parse(html);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testSpecialAttributeRoundTripNoText(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("url","http://example.com/more.xoxo");<br />
dict.put("title","sample url");<br />
dict.put("type","text/xml");<br />
dict.put("rel","help");<br />
String html = xoxo.toXOXO(dict);<br />
try{<br />
Object newDict = parser.parse(html);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testSpecialAttributeRoundTripNoTextOrTitle(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("url","http://example.com/more.xoxo");<br />
dict.put("type","text/xml");<br />
dict.put("rel","help");<br />
String html = xoxo.toXOXO(dict);<br />
try{<br />
Object newDict = parser.parse(html);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testUnicodeRoundTrip(){<br />
String s = "Tantek Çelik and a snowman ?";<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
String html = xoxo.toXOXO(s);<br />
try{<br />
Object newString = parser.parse(html);<br />
assertEquals(s,newString);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
}<br />
<br />
</nowiki></pre></div>
RobertSayre
http://microformats.org/wiki/index.php?title=xoxo-sample-code&diff=2505
xoxo-sample-code
2005-10-30T19:32:54Z
<p>RobertSayre: /* XOXOTest.java */</p>
<hr />
<div>= XOXO Sample Code =<br />
<br />
A whole bunch of open source ([http://creativecommons.org/licenses/by/2.0/ CC-by-2.0], [http://www.apache.org/licenses/LICENSE-2.0 Apache 2.0]) sample code to read and write [[xoxo]] files in Python and Java (with Perl, PHP, ... to follow).<br />
= Python =<br />
== xoxo.py ==<br />
<pre><nowiki><br />
# -*- coding: utf-8 -*-<br />
"""xoxo.py - a utility module for transforming to and from the XHTMLOutlines format XOXO<br />
toXOXO takes a Python datastructure (tuples, lists or dictionaries, arbitrarily nested) and returns a XOXO representation of it.<br />
fromXOXO parses an XHTML file for a xoxo list and returns the structure<br />
"""<br />
__version__ = "0.8"<br />
__date__ = "2004-10-05"<br />
__author__ = "Kevin Marks <kmarks@technorati.com>"<br />
__copyright__ = "Copyright 2004, Kevin marks & Technorati"<br />
__license__ = "http://creativecommons.org/licenses/by/2.0/ CC-by-2.0], [http://www.apache.org/licenses/LICENSE-2.0 Apache 2.0"<br />
__credits__ = """Tantek Çelik and Mark Pilgrim for data structure"""<br />
__history__ = """<br />
TODO: add <title> tag<br />
TODO: add a proper profile link<br />
0.8 work in unicode then render to utf-8<br />
0.7 initial encoding support - just utf-8 for now<br />
0.6 support the special behaviour for url properties to/from <a><br />
0.5 fix some awkward side effects of whitespace and text outside our expected tags; simplify writing code<br />
0.4 add correct XHTML headers so it validates<br />
0.3 read/write version; fixed invlaid nested list generation;<br />
0.1 first write-only version<br />
"""<br />
<br />
try:<br />
True, False<br />
except NameError:<br />
True, False = not not 1, not 1<br />
containerTags={'ol':False,'ul':False,'dl':False}<br />
import sgmllib, urllib, urlparse, re<br />
def makeXOXO(struct,className=None,depth=0):<br />
s=u''<br />
if isinstance(struct,list) or isinstance(struct,tuple):<br />
if className:<br />
s += u'<ol class="%s">' % className<br />
else:<br />
s+= u"<ol>"<br />
if isinstance(struct,dict):<br />
d=struct.copy()<br />
if d.has_key('url'):<br />
s+=u'<a href="%s" ' % d['url']<br />
text = d.get('text',d.get('title',d['url']))<br />
for attr in ('title','rel','type'):<br />
if d.has_key(attr):<br />
xVal = makeXOXO(d[attr],None,depth+1)<br />
s +=u'%s="%s" ' % (attr,xVal)<br />
del d[attr]<br />
s +=u'>%s</a>' % makeXOXO(text,None,depth+1)<br />
if d.has_key('text'):<br />
del d['text']<br />
del d['url']<br />
if len(d):<br />
s +=u"<dl>"<br />
for key,value in d.items():<br />
xVal = makeXOXO(value,None,depth+1)<br />
s+= u'<dt>%s</dt><dd>%s</dd>' % (key, xVal)<br />
s +=u"</dl>"<br />
elif type(struct) ==type((1,))or type(struct) ==type([1,]):<br />
for item in struct:<br />
s+=u"<li>" + makeXOXO(item,None,depth+1)+"</li>"<br />
s +=u"</ol>"<br />
elif type(struct) == type(u'unicode'):<br />
s+=struct<br />
else:<br />
if not type(struct)==type(' '):<br />
struct=str(struct)<br />
try:<br />
s+=unicode(struct,'utf-8')<br />
except:<br />
s+=unicode(struct,'windows_1252')<br />
return s<br />
class xoxoParser(sgmllib.SGMLParser):<br />
def __init__(self):<br />
sgmllib.SGMLParser.__init__(self)<br />
self.structs=[]<br />
self.xostack=[]<br />
self.textstack=['']<br />
def normalize_attrs(self, attrs):<br />
attrs = [(k.lower(), sgmllib.charref.sub(lambda m: chr(int(m.groups()[0])), v).strip()) for k, v in attrs]<br />
attrs = [(k, k in ('rel','type') and v.lower() or v) for k, v in attrs]<br />
return attrs<br />
def pushStruct(self,struct):<br />
if type(struct) == type({}) and len(struct)==0 and len(self.structs) and type(self.structs[-1]) == type({}) and self.structs[-1].has_key('url'):<br />
self.xostack.append(self.structs[-1]) # put back the <a>-made one for extra def's<br />
else:<br />
self.structs.append(struct)<br />
self.xostack.append(self.structs[-1])<br />
def start_a(self,attrs):<br />
attrsD = dict(self.normalize_attrs(attrs))<br />
attrsD['url']= attrsD.get('href','')<br />
del attrsD['href']<br />
self.pushStruct(attrsD)<br />
self.textstack.append('')<br />
def end_a(self):<br />
val = self.textstack.pop()<br />
if val: <br />
if self.xostack[-1].get('title','') == val:<br />
val=''<br />
if self.xostack[-1]['url'] == val:<br />
val=''<br />
if val:<br />
self.xostack[-1]['text']=val<br />
self.xostack.pop()<br />
def start_dl(self,attrs):<br />
self.pushStruct({})<br />
def end_dl(self):<br />
self.xostack.pop()<br />
def start_ol(self,attrs):<br />
self.pushStruct([])<br />
def end_ol(self):<br />
self.xostack.pop()<br />
def start_ul(self,attrs):<br />
self.pushStruct([])<br />
def end_ul(self):<br />
self.xostack.pop()<br />
def start_li(self,attrs):<br />
self.textstack.append('')<br />
def end_li(self):<br />
val = self.textstack.pop()<br />
if self.structs[-1] != self.xostack[-1]:<br />
val = self.structs.pop()<br />
self.xostack[-1].append(val)<br />
def start_dt(self,attrs):<br />
self.textstack.append('')<br />
def end_dt(self):<br />
pass<br />
def start_dd(self,attrs):<br />
self.textstack.append('')<br />
def end_dd(self):<br />
val = self.textstack.pop()<br />
key = self.textstack.pop()<br />
if self.structs[-1] != self.xostack[-1]:<br />
val = self.structs.pop()<br />
self.xostack[-1][key]=val<br />
def handle_data(self, text):<br />
if len(self.stack) and containerTags.get(self.stack[-1],True): #skip text not within an element<br />
self.textstack[-1] += text<br />
def toXOXO(struct,addHTMLWrapper=False,cssUrl=''):<br />
if type(struct) ==type((1,))or type(struct) ==type([1,]):<br />
inStruct = struct<br />
else:<br />
inStruct = [struct]<br />
if addHTMLWrapper:<br />
s= '''<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN<br />
http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><br />
<html xmlns="http://www.w3.org/1999/xhtml"><head profile=""><meta http-equiv="Content-Type" content="text/html; charset=utf-8" />'''<br />
if cssUrl:<br />
s+='<style type="text/css" >@import "%s";</style>' % cssUrl<br />
s+="</head><body>%s</body></html>" % makeXOXO(inStruct,'xoxo')<br />
return s.encode('utf-8')<br />
else:<br />
return makeXOXO(inStruct,'xoxo').encode('utf-8')<br />
<br />
import sys<br />
<br />
def fromXOXO(html):<br />
parser = xoxoParser()<br />
parser.feed(unicode(html,'utf-8'))<br />
#print >>sys.stderr, parser.structs<br />
structs=[struct for struct in parser.structs if struct]<br />
#print >>sys.stderr, structs<br />
while (len(structs) ==1 and type(structs)==type([1,])):<br />
structs=structs[0]<br />
return structs<br />
<br />
# Allow direct invocation<br />
# Read HTML from URL, parse into data structures, then re-output<br />
<br />
if __name__ == "__main__":<br />
if len(sys.argv) < 2: raise SystemExit("Usage: "+sys.argv[0]+" url\n"+__doc__)<br />
url=sys.argv[1]<br />
file = urllib.urlopen(url)<br />
html=file.read(-1)<br />
file.close<br />
s=fromXOXO(html)<br />
p=toXOXO(s,True)<br />
print p<br />
<br />
</nowiki></pre><br />
<br />
== testxoxo.py ==<br />
<pre><nowiki><br />
# -*- coding: utf-8 -*-<br />
"""testxoxo.py <br />
Unit tests for xoxo.py<br />
This file tests the functions in xoxo.py <br />
The underlying model here is http://diveintopython.org/unit_testing/index.html <br />
<br />
run from command line with<br />
python testxoxo.py -v<br />
"""<br />
import xoxo<br />
reload(xoxo)<br />
import unittest<br />
<br />
class xoxoTestCases(unittest.TestCase):<br />
<br />
def testSimpleList(self):<br />
'''make a xoxo file from a list'''<br />
l = ['1','2','3']<br />
html = xoxo.toXOXO(l)<br />
self.assertEqual(html,'<ol class="xoxo"><li>1</li><li>2</li><li>3</li></ol>')<br />
def testNestedList(self):<br />
'''make a xoxo file from a list with a list in'''<br />
l = ['1',['2','3']]<br />
html = xoxo.toXOXO(l)<br />
self.assertEqual(html,'<ol class="xoxo"><li>1</li><li><ol><li>2</li><li>3</li></ol></li></ol>')<br />
<br />
def testDictionary(self):<br />
'''make a xoxo file from a dictionary'''<br />
d = {'test':'1','name':'Kevin'}<br />
html = xoxo.toXOXO(d)<br />
self.assertEqual(html,'<ol class="xoxo"><li><dl><dt>test</dt><dd>1</dd><dt>name</dt><dd>Kevin</dd></dl></li></ol>')<br />
<br />
def testSingleItem(self):<br />
'''make a xoxo file from a string'''<br />
l = "test"<br />
html = xoxo.toXOXO(l)<br />
self.assertEqual(html,'<ol class="xoxo"><li>test</li></ol>')<br />
<br />
def testWrapDiffers(self):<br />
'''make a xoxo file from a string with and without html wrapper and check they are different'''<br />
l = "test"<br />
html = xoxo.toXOXO(l)<br />
htmlwrap = xoxo.toXOXO(l,addHTMLWrapper=True)<br />
self.failIfEqual(html,htmlwrap)<br />
<br />
def testWrapSingleItem(self):<br />
'''make a wrapped xoxo file from a string'''<br />
l = "test"<br />
html = xoxo.toXOXO(l,addHTMLWrapper=True)<br />
self.assertEqual(html,'''<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN<br />
http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><br />
<html xmlns="http://www.w3.org/1999/xhtml"><head profile=""></head><body><ol class="xoxo"><li>test</li></ol></body></html>''')<br />
<br />
def testDictionaryRoundTrip(self):<br />
''' make a dictionary into a xoxo file and back again; check it is the same'''<br />
d = {'test':'1','name':'Kevin'}<br />
html = xoxo.toXOXO(d)<br />
newd = xoxo.fromXOXO(html)<br />
self.assertEqual(d,newd)<br />
<br />
def testListRoundTrip(self):<br />
''' make a list into a xoxo file and back again; check it is the same'''<br />
l = ['3','2','1']<br />
html = xoxo.toXOXO(l)<br />
newdl= xoxo.fromXOXO(html)<br />
self.assertEqual(l,newdl)<br />
def testListofDictsRoundTrip(self):<br />
''' make a list of Dicts into a xoxo file and back again; check it is the same'''<br />
l = ['3',{'a':'2'},{'b':'1','c':'4'}]<br />
html = xoxo.toXOXO(l)<br />
newdl= xoxo.fromXOXO(html)<br />
self.assertEqual(l,newdl)<br />
def testListofListsRoundTrip(self):<br />
''' make a list of Lists into a xoxo file and back again; check it is the same'''<br />
l = ['3',['a','2'],['b',['1',['c','4']]]]<br />
html = xoxo.toXOXO(l)<br />
newdl= xoxo.fromXOXO(html)<br />
self.assertEqual(l,newdl)<br />
def testDictofListsRoundTrip(self):<br />
''' make a dict with lists in into a xoxo file and back again; check it is the same'''<br />
d = {'test':['1','2'],<br />
'name':'Kevin',<br />
'nestlist':['a',['b','c']],<br />
'nestdict':{'e':'6','f':'7'}}<br />
html = xoxo.toXOXO(d)<br />
newd = xoxo.fromXOXO(html)<br />
self.assertEqual(d,newd)<br />
<br />
def testXOXOjunkInContainers(self):<br />
'''make sure text outside <li> etc is ignored'''<br />
d=xoxo.fromXOXO('<ol>bad<li><dl>worse<dt>good</dt><dd>buy</dd> now</dl></li></ol>')<br />
self.assertEqual(d,{'good': 'buy'})<br />
def testXOXOjunkInElements(self):<br />
'''make sure text within <li> but outside a subcontainer is ignored'''<br />
l=xoxo.fromXOXO('<ol><li>bad<dl><dt>good</dt><dd>buy</dd></dl>worse</li><li>bag<ol><li>OK</li></ol>fish</li></ol>')<br />
self.assertEqual(l,[{'good': 'buy'},['OK']])<br />
def testXOXOWithSpacesAndNewlines(self):<br />
'''unmung some xoxo with spaces in and check result is right'''<br />
xoxoSample= '''<ol class='xoxo'> <br />
<li><br />
<dl><br />
<dt>text</dt><br />
<dd>item 1</dd><br />
<dt>description</dt><br />
<dd> This item represents the main point we're trying to make.</dd><br />
<dt>url</dt><br />
<dd>http://example.com/more.xoxo</dd><br />
<dt>title</dt><br />
<dd>title of item 1</dd><br />
<dt>type</dt><br />
<dd>text/xml</dd><br />
<dt>rel</dt><br />
<dd>help</dd><br />
</dl><br />
</li><br />
</ol>'''<br />
d = xoxo.fromXOXO(xoxoSample)<br />
d2={'text':'item 1',<br />
'description':" This item represents the main point we're trying to make.",<br />
'url':'http://example.com/more.xoxo',<br />
'title':'title of item 1',<br />
'type':'text/xml',<br />
'rel':'help'<br />
}<br />
xoxoAgain = xoxo.toXOXO(d)<br />
self.assertEqual(d,d2)<br />
#this needs a smarter whitespace-sensitive comparison<br />
#self.assertEqual(xoxoSample,xoxoAgain)<br />
<br />
def testSpecialAttributeDecoding(self):<br />
'''unmung some xoxo with <a href=' rel= etc in and check result is right'''<br />
xoxoSample= '''<ol class='xoxo'> <br />
<li><br />
<dl><br />
<dt>text</dt><br />
<dd>item 1</dd><br />
<dt>url</dt><br />
<dd>http://example.com/more.xoxo</dd><br />
<dt>title</dt><br />
<dd>title of item 1</dd><br />
<dt>type</dt><br />
<dd>text/xml</dd><br />
<dt>rel</dt><br />
<dd>help</dd><br />
</dl><br />
</li><br />
</ol>'''<br />
d = xoxo.fromXOXO(xoxoSample)<br />
smartxoxoSample= '''<ol class='xoxo'> <br />
<li><a href="http://example.com/more.xoxo"<br />
title="title of item 1"<br />
type="text/xml"<br />
rel="help">item 1</a> <br />
<!-- note how the "text" property is simply the contents of the <a> element --><br />
</li><br />
</ol>'''<br />
d2 = xoxo.fromXOXO(smartxoxoSample)<br />
self.assertEqual(d,d2)<br />
def testSpecialAttributeAndDLDecoding(self):<br />
'''unmung some xoxo with <a href=' rel= etc in plus a <dl> in the same item and check result is right'''<br />
xoxoSample= '''<ol class="xoxo"> <br />
<li><br />
<dl><br />
<dt>text</dt><br />
<dd>item 1</dd><br />
<dt>description</dt><br />
<dd> This item represents the main point we're trying to make.</dd><br />
<dt>url</dt><br />
<dd>http://example.com/more.xoxo</dd><br />
<dt>title</dt><br />
<dd>title of item 1</dd><br />
<dt>type</dt><br />
<dd>text/xml</dd><br />
<dt>rel</dt><br />
<dd>help</dd><br />
</dl><br />
</li><br />
</ol>'''<br />
d = xoxo.fromXOXO(xoxoSample)<br />
smartxoxoSample= '''<ol class="xoxo"> <br />
<li><a href="http://example.com/more.xoxo"<br />
title="title of item 1"<br />
type="text/xml"<br />
rel="help">item 1</a> <br />
<!-- note how the "text" property is simply the contents of the <a> element --><br />
<dl><br />
<dt>description</dt><br />
<dd> This item represents the main point we're trying to make.</dd><br />
</dl><br />
</li><br />
</ol>'''<br />
d2 = xoxo.fromXOXO(smartxoxoSample)<br />
self.assertEqual(d,d2)<br />
def testSpecialAttributeEncode(self):<br />
'''check it makes an <a href with a url parameter'''<br />
d={'url':'http://example.com/more.xoxo','title':'sample url','type':"text/xml",'rel':'help','text':'an example'}<br />
html=xoxo.toXOXO(d)<br />
expectedHTML= '<ol class="xoxo"><li><a href="http://example.com/more.xoxo" title="sample url" rel="help" type="text/xml" >an example</a></li></ol>' <br />
self.assertEqual(html,expectedHTML)<br />
<br />
def testSpecialAttributeRoundTripFull(self):<br />
'''check it makes an <a href with a url parameter'''<br />
d={'url':'http://example.com/more.xoxo','title':'sample url','type':"text/xml",'rel':'help','text':'an example'}<br />
html=xoxo.toXOXO(d)<br />
self.assertEqual(d,xoxo.fromXOXO(html))<br />
def testSpecialAttributeRoundTripNoText(self):<br />
'''check it makes an <a href with a url parameter and no text attribute'''<br />
d={'url':'http://example.com/more.xoxo','title':'sample url','type':"text/xml",'rel':'help'}<br />
html=xoxo.toXOXO(d)<br />
self.assertEqual(d,xoxo.fromXOXO(html))<br />
def testSpecialAttributeRoundTripNoTextOrTitle(self):<br />
'''check it makes an <a href with a url parameter and no text or title attribute'''<br />
d={'url':'http://example.com/more.xoxo'}<br />
html=xoxo.toXOXO(d)<br />
self.assertEqual(d,xoxo.fromXOXO(html))<br />
def testUnicodeRoundtrip(self):<br />
'''check unicode characters can go to xoxo and back'''<br />
src=unicode('Tantek Çelik and a snowman ?','utf-8')<br />
html = html=xoxo.toXOXO(src)<br />
self.assertEqual(src,xoxo.fromXOXO(html))<br />
if __name__ == "__main__":<br />
unittest.main()<br />
else:<br />
runner = unittest.TextTestRunner()<br />
suite = unittest.makeSuite(xoxoTestCases,'test')<br />
runner.run(suite)<br />
<br />
</nowiki></pre><br />
<br />
= Java =<br />
== XOXOWriter.java ==<br />
<pre><nowiki><br />
/*<br />
* Copyright 2005 Robert Sayre<br />
*<br />
* Licensed under the Apache License, Version 2.0 (the "License");<br />
* you may not use this file except in compliance with the License.<br />
* You may obtain a copy of the License at<br />
* <br />
* http://www.apache.org/licenses/LICENSE-2.0<br />
* <br />
* Unless required by applicable law or agreed to in writing, software<br />
* distributed under the License is distributed on an "AS IS" BASIS,<br />
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<br />
* See the License for the specific language governing permissions and<br />
* limitations under the License.<br />
*<br />
* Portions of this code are derived from the Apache-licensed Python XOXO<br />
* module by Kevin Marks. <http://microformats.org/wiki/xoxo-sample-code><br />
*/<br />
<br />
package org.atompub.draft.xoxo;<br />
<br />
import java.util.*;<br />
<br />
public class XOXOWriter {<br />
<br />
public String[] attrs = {"title","rel","type"};<br />
<br />
public String makeXOXO(List struct, String className){<br />
return makeXOXO(struct, className, 0, true);<br />
}<br />
<br />
public String makeXOXO(List struct, String className,<br />
boolean doNSDeclaration){<br />
return makeXOXO(struct, className, 0, doNSDeclaration);<br />
}<br />
<br />
public String makeXOXO(List struct){<br />
return makeXOXO(struct, "xoxo", 0, true);<br />
}<br />
<br />
public String makeXOXO(Object struct, int depth){<br />
return makeXOXO(struct, null, 0, false);<br />
}<br />
<br />
public String makeXOXO(Object struct, String className,<br />
int depth, boolean doNSDeclaration){<br />
if(struct == null) return "";<br />
StringBuffer sb = new StringBuffer();<br />
if(struct instanceof Object[]){<br />
struct = Arrays.asList((Object[]) struct);<br />
}<br />
if(struct instanceof List){<br />
sb.append("<ol");<br />
if(doNSDeclaration)<br />
sb.append(" xmlns=\"http://www.w3.org/1999/xhtml\"");<br />
if(className != null){<br />
sb.append(" class=\"");<br />
sb.append(className);<br />
sb.append("\"");<br />
}<br />
sb.append(">");<br />
}<br />
if(struct instanceof Map){<br />
Map d = new LinkedHashMap((Map) struct);<br />
if(d.containsKey("url")){<br />
sb.append("<a href=\"" + d.get("url") + "\" ");<br />
Object text;<br />
if(d.containsKey("text")){<br />
text = d.get("text");<br />
}else if(d.containsKey("title")){<br />
text = d.get("title");<br />
}else{<br />
text = d.get("url");<br />
}<br />
for(int i=0; i<attrs.length; i++){<br />
String xVal = makeXOXO(d.get(attrs[i]),depth+1);<br />
if(xVal != null && !xVal.equals("")){<br />
sb.append(attrs[i] + "=\"" + xVal + "\" ");<br />
}<br />
d.remove(attrs[i]);<br />
}<br />
sb.append(">" + makeXOXO(text, depth+1) + "</a>");<br />
d.remove("text");<br />
d.remove("url");<br />
}<br />
if(d.size() > 0){<br />
sb.append("<dl>");<br />
for(Iterator i = d.keySet().iterator(); i.hasNext();){<br />
Object k = i.next();<br />
String ddVal = makeXOXO(d.get(k),depth+1);<br />
sb.append("<dt>" + k + "</dt>");<br />
sb.append("<dd>" + ddVal + "</dd>");<br />
}<br />
sb.append("</dl>");<br />
}<br />
}else if(struct instanceof List){<br />
List l = (List) struct;<br />
for(Iterator i = l.iterator(); i.hasNext();){<br />
Object item = i.next();<br />
sb.append("<li>" + makeXOXO(item,depth+1) + "</li>");<br />
}<br />
sb.append("</ol>");<br />
}else{<br />
sb.append(struct);<br />
}<br />
return sb.toString();<br />
}<br />
<br />
public String toXOXO(List struct){<br />
return toXOXO(struct, false, null);<br />
}<br />
<br />
public String toXOXO(Object struct){<br />
List alist = new ArrayList();<br />
alist.add(struct);<br />
return toXOXO(alist);<br />
}<br />
<br />
public String toXOXO(Object struct,<br />
boolean addHTMLWrapper,<br />
String cssUrl){<br />
List alist = new ArrayList();<br />
alist.add(struct);<br />
return toXOXO(alist, addHTMLWrapper, cssUrl);<br />
}<br />
<br />
public String toXOXO(List struct,<br />
boolean addHTMLWrapper,<br />
String cssUrl){<br />
String startHTML = "<!DOCTYPE html PUBLIC \"-//W3C//DTD"<br />
+ "XHTML 1.0 Transitional//EN\n"<br />
+ "http://www.w3.org/TR/xhtml1/DTD/"<br />
+ "xhtml1-transitional.dtd\">"<br />
+ "<html xmlns=\"http://www.w3.org/1999/xhtml\">"<br />
+ "<head>";<br />
if(addHTMLWrapper){<br />
String s = startHTML;<br />
if(cssUrl != null){<br />
s += "<style type=\"text/css\">@import \""<br />
+ cssUrl + "\";</style>";<br />
}<br />
s += "</head><body>" + makeXOXO(struct, "xoxo", false)<br />
+ "</body></html>";<br />
return s;<br />
}else{<br />
return makeXOXO(struct, "xoxo");<br />
}<br />
}<br />
}<br />
</nowiki></pre><br />
<br />
== XOXOParser.java ==<br />
<pre><nowiki><br />
/*<br />
* Copyright 2005 Robert Sayre<br />
*<br />
* Licensed under the Apache License, Version 2.0 (the "License");<br />
* you may not use this file except in compliance with the License.<br />
* You may obtain a copy of the License at<br />
* <br />
* http://www.apache.org/licenses/LICENSE-2.0<br />
* <br />
* Unless required by applicable law or agreed to in writing, software<br />
* distributed under the License is distributed on an "AS IS" BASIS,<br />
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<br />
* See the License for the specific language governing permissions and<br />
* limitations under the License.<br />
*<br />
* Portions of this code are derived from the Apache-licensed Python XOXO<br />
* module by Kevin Marks. <http://microformats.org/wiki/xoxo-sample-code><br />
*/<br />
<br />
package org.atompub.draft.xoxo;<br />
<br />
import org.xml.sax.InputSource;<br />
import org.xml.sax.SAXException;<br />
import org.xml.sax.XMLReader;<br />
import org.xml.sax.Attributes;<br />
import org.xml.sax.helpers.XMLReaderFactory;<br />
import org.xml.sax.helpers.DefaultHandler;<br />
<br />
import java.util.*;<br />
import java.io.InputStream;<br />
import java.io.StringReader;<br />
import java.io.IOException;<br />
<br />
public class XOXOParser extends DefaultHandler {<br />
<br />
protected String XHTML_NS = "http://www.w3.org/1999/xhtml";<br />
protected List elStack;<br />
protected Map listEls;<br />
public List structs;<br />
public List xoStack;<br />
public List textStack;<br />
<br />
public XOXOParser() {<br />
reset();<br />
}<br />
<br />
protected void pushStruct(Object struct){<br />
if((struct instanceof Map) && (((Map) struct).size() > 0)<br />
&& (structs.get(structs.size()-1) instanceof Map)<br />
&& (((Map) struct).containsKey("url"))){<br />
// put back the <a>-made one for extra defs<br />
xoStack.add(structs.get(structs.size()-1));<br />
}else{<br />
structs.add(struct);<br />
xoStack.add(struct);<br />
}<br />
}<br />
<br />
public void startElement(String nsUri, String localName,<br />
String qName, Attributes atts){<br />
// bounce non-XHTML elements<br />
if(nsUri.equals(XHTML_NS)){<br />
elStack.add(localName);<br />
}else{<br />
elStack.add("foo");<br />
return;<br />
}<br />
<br />
if(localName.equals("a")){<br />
Map attmap = new LinkedHashMap();<br />
int len = atts.getLength();<br />
for(int i=0; i<len; i++){<br />
attmap.put(atts.getQName(i),atts.getValue(i));<br />
}<br />
if(attmap.containsKey("href")){<br />
attmap.put("url",attmap.get("href"));<br />
attmap.remove("href");<br />
}<br />
pushStruct(attmap);<br />
textStack.add("");<br />
}else if(localName.equals("dl")){<br />
pushStruct(new LinkedHashMap());<br />
}else if(localName.equals("ol")){<br />
pushStruct(new ArrayList());<br />
}else if(localName.equals("ul")){<br />
pushStruct(new ArrayList());<br />
}else if(localName.equals("li")){<br />
textStack.add("");<br />
}else if(localName.equals("dt")){<br />
textStack.add("");<br />
}else if(localName.equals("dd")){<br />
textStack.add("");<br />
}<br />
}<br />
<br />
public void endElement(String nsUri, String localName,<br />
String qName){<br />
elStack.remove(elStack.size()-1);<br />
// bounce non-XHTML elements<br />
if(nsUri != XHTML_NS){<br />
return;<br />
}<br />
<br />
if(localName.equals("a")){<br />
String val = (String) textStack.remove(textStack.size()-1);<br />
if (val.length() > 0){<br />
Map defs = (Map) xoStack.get(xoStack.size()-1);<br />
String defVal = (String) defs.get("title");<br />
if((defVal != null) && (val.equals(defVal))){<br />
val = "";<br />
}<br />
defVal = (String) defs.get("url");<br />
if((defVal != null) && (val.equals(defVal))){<br />
val = "";<br />
}<br />
if(val.length() > 0){<br />
defs.put("text",val);<br />
}<br />
}<br />
xoStack.remove(xoStack.size()-1);<br />
}else if(localName.equals("dl")){<br />
xoStack.remove(xoStack.size()-1);<br />
}else if(localName.equals("ol")){<br />
xoStack.remove(xoStack.size()-1);<br />
}else if(localName.equals("ul")){<br />
xoStack.remove(xoStack.size()-1);<br />
}else if(localName.equals("li")){<br />
Object val = textStack.remove(textStack.size()-1);<br />
List last = (List) xoStack.get(xoStack.size()-1);<br />
if(structs.get(structs.size()-1) != last){<br />
val = structs.remove(structs.size()-1);<br />
}<br />
last.add(val);<br />
}else if(localName.equals("dd")){<br />
Object val = textStack.remove(textStack.size()-1);<br />
Object key = textStack.remove(textStack.size()-1);<br />
Map last = (Map) xoStack.get(xoStack.size()-1);<br />
if(structs.get(structs.size()-1) != last){<br />
val = structs.remove(structs.size()-1);<br />
}<br />
last.put(key,val);<br />
}<br />
}<br />
<br />
public void characters(char[] ch, int start, int length){<br />
if((xoStack.size() > 0)<br />
&& (!listEls.containsKey(elStack.get(elStack.size()-1)))){<br />
String text = (String) textStack.get(textStack.size()-1);<br />
String test = new String(ch,start,length);<br />
textStack.set(textStack.size()-1,text+test);<br />
}<br />
}<br />
<br />
public Object parse(String s) throws SAXException, IOException{<br />
return parse(new InputSource(new StringReader(s)));<br />
}<br />
<br />
public Object parse(InputStream is) throws SAXException, IOException {<br />
return parse(new InputSource(is));<br />
}<br />
<br />
public Object parse(InputSource in) throws SAXException, IOException {<br />
XMLReader parser = XMLReaderFactory.createXMLReader();<br />
parser.setContentHandler(this);<br />
parser.parse(in);<br />
List returnList = new ArrayList();<br />
for(Iterator i = this.structs.iterator(); i.hasNext();){<br />
Object thing = i.next();<br />
if(thing != null){<br />
returnList.add(thing);<br />
}<br />
}<br />
while((returnList.size()==1)){<br />
if(returnList.get(0) instanceof List){<br />
returnList = (List) returnList.get(0);<br />
}else{<br />
reset();<br />
return returnList.get(0);<br />
}<br />
}<br />
reset();<br />
return returnList;<br />
}<br />
<br />
protected void reset(){<br />
elStack = new ArrayList();<br />
listEls = new HashMap();<br />
structs = new ArrayList();<br />
xoStack = new ArrayList();<br />
textStack = new ArrayList();<br />
listEls.put("ol","ol");<br />
listEls.put("ul","ul");<br />
listEls.put("dl","dl");<br />
}<br />
}<br />
<br />
</nowiki></pre><br />
<br />
== XOXOTest.java ==<br />
<pre><nowiki><br />
/*<br />
* Copyright 2005 Robert Sayre<br />
*<br />
* Licensed under the Apache License, Version 2.0 (the "License");<br />
* you may not use this file except in compliance with the License.<br />
* You may obtain a copy of the License at<br />
* <br />
* http://www.apache.org/licenses/LICENSE-2.0<br />
* <br />
* Unless required by applicable law or agreed to in writing, software<br />
* distributed under the License is distributed on an "AS IS" BASIS,<br />
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<br />
* See the License for the specific language governing permissions and<br />
* limitations under the License.<br />
*<br />
* Portions of this code are derived from the Apache-licensed Python XOXO<br />
* module by Kevin Marks. <http://microformats.org/wiki/xoxo-sample-code><br />
*/<br />
<br />
package org.atompub.draft.xoxo.tests;<br />
<br />
import junit.framework.TestSuite;<br />
import junit.framework.TestCase;<br />
import junit.textui.TestRunner;<br />
import org.atompub.draft.xoxo.XOXOWriter;<br />
import org.atompub.draft.xoxo.XOXOParser;<br />
<br />
import java.util.*;<br />
<br />
public class XOXOTest extends TestCase {<br />
<br />
public static void main(String[] args) {<br />
new TestRunner().doRun(new TestSuite(XOXOTest.class));<br />
}<br />
String XHTML_DEC = "xmlns=\"http://www.w3.org/1999/xhtml\" ";<br />
public String simpleListHTML = "<ol "<br />
+ XHTML_DEC<br />
+ "class=\"xoxo\">"<br />
+ "<li>1</li><li>2</li><li>3</li></ol>";<br />
<br />
public void testSimpleList(){<br />
String [] numbers = {"1","2","3"};<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(simpleListHTML,<br />
xoxo.toXOXO(Arrays.asList(numbers)));<br />
}<br />
<br />
public void testStringIntegerList(){<br />
Object[] numbers = {new Integer(1),"2","3"};<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(simpleListHTML,<br />
xoxo.toXOXO(Arrays.asList(numbers)));<br />
}<br />
<br />
public String nestedListHTML = "<ol "<br />
+ XHTML_DEC<br />
+ "class=\"xoxo\"><li>1</li><li>"<br />
+ "<ol><li>2</li><li>3</li></ol></li></ol>";<br />
<br />
public void testNestedList(){<br />
Object[] arr = {"2","3"};<br />
Object[] nested = {"1",Arrays.asList(arr)};<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(nestedListHTML,<br />
xoxo.toXOXO(Arrays.asList(nested)));<br />
}<br />
<br />
public void testNestedArray(){<br />
Object[] arr = {"2","3"};<br />
Object[] nested = {"1",arr};<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(nestedListHTML,<br />
xoxo.toXOXO(Arrays.asList(nested)));<br />
}<br />
<br />
public String dictHTML = "<ol "<br />
+ XHTML_DEC<br />
+ "class=\"xoxo\">"<br />
+ "<li><dl><dt>test</dt><dd>1</dd><dt>name</dt>"<br />
+ "<dd>Kevin</dd></dl></li></ol>";<br />
<br />
public void testDictionary(){<br />
Map dict = new LinkedHashMap();<br />
dict.put("test", new Integer(1));<br />
dict.put("name", "Kevin");<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(dictHTML,<br />
xoxo.toXOXO(dict));<br />
}<br />
<br />
public String singleHTML = "<ol "<br />
+ XHTML_DEC<br />
+ "class=\"xoxo\">"<br />
+ "<li>test</li></ol>";<br />
<br />
public void testSingleItem(){<br />
String item = "test";<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(singleHTML,<br />
xoxo.toXOXO(item));<br />
}<br />
<br />
public void testWrapDiffers(){<br />
String item = "test";<br />
XOXOWriter xoxo = new XOXOWriter();<br />
String nowrap = xoxo.toXOXO(item);<br />
Object[] itemArr = {item};<br />
String wrap = xoxo.toXOXO(Arrays.asList(itemArr),true,null);<br />
assertFalse(wrap.equals(nowrap));<br />
}<br />
<br />
String startHTML = "<!DOCTYPE html PUBLIC \"-//W3C//DTD"<br />
+ "XHTML 1.0 Transitional//EN\n"<br />
+ "http://www.w3.org/TR/xhtml1/DTD/"<br />
+ "xhtml1-transitional.dtd\">"<br />
+ "<html xmlns=\"http://www.w3.org/1999/xhtml\">"<br />
+ "<head></head><body>";<br />
public String singleWrapHTML = "<ol "<br />
+ "class=\"xoxo\">"<br />
+ "<li>test</li></ol>";<br />
public String endHTML = "</body></html>";<br />
<br />
public void testWrapSingleItem(){<br />
String item = "test";<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(startHTML + singleWrapHTML + endHTML,<br />
xoxo.toXOXO(item,true,null));<br />
}<br />
<br />
public void testXOXOParser(){<br />
XOXOParser parser = new XOXOParser();<br />
try{<br />
parser.parse(dictHTML);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testDictRoundTrip(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("test", "1");<br />
dict.put("name", "Kevin");<br />
String html = xoxo.toXOXO(dict);<br />
try{<br />
Object newDict = parser.parse(html);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testListRoundTrip(){<br />
Object[] obj = {"1","2","3"};<br />
List testList = Arrays.asList(obj);<br />
XOXOWriter xoxo = new XOXOWriter();<br />
String html = xoxo.toXOXO(testList);<br />
XOXOParser parser = new XOXOParser();<br />
try{<br />
Object newList = parser.parse(html);<br />
assertEquals(testList,newList);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testListOfDictsRoundTrip(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("test", "1");<br />
dict.put("name", "Kevin");<br />
Map dict2 = new LinkedHashMap();<br />
dict2.put("one", "two");<br />
dict2.put("three", "four");<br />
dict2.put("five", "six");<br />
Object[] obj = {"1",dict,dict2};<br />
List testList = Arrays.asList(obj);<br />
String html = xoxo.toXOXO(testList);<br />
try{<br />
Object newList = parser.parse(html);<br />
assertEquals(testList,newList);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testListOfListsRoundTrip(){<br />
Object[] list1 = {"1","2","3"};<br />
Object[] list2 = {"4","5","6", Arrays.asList(list1)};<br />
Object[] list3 = {"7", Arrays.asList(list2)};<br />
Object[] list4 = {"8", Arrays.asList(list3)};<br />
List testList = Arrays.asList(list4);<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
String html = xoxo.toXOXO(testList);<br />
try{<br />
Object newList = parser.parse(html);<br />
assertEquals(testList,newList);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testDictOfListsRoundTrip(){<br />
Object[] list1 = {"1","2","3"};<br />
Object[] list2 = {"4","5","6"};<br />
Object[] list3 = {"7"};<br />
Object[] list4 = {"8", "9"};<br />
Map dict = new LinkedHashMap();<br />
dict.put("foo", Arrays.asList(list1));<br />
dict.put("bar", Arrays.asList(list2));<br />
dict.put("baz", Arrays.asList(list3));<br />
dict.put("qux", Arrays.asList(list4));<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
String html = xoxo.toXOXO(dict);<br />
try{<br />
Object newDict = parser.parse(html);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public String junkXOXO = "<ol "<br />
+ XHTML_DEC<br />
+ "class=\"xoxo\">"<br />
+ "bad<li><dl>worse<dt>good</dt><dd>buy</dd> now</dl></li></ol>";<br />
<br />
public void testXOXOJunkInContainers(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("good","buy");<br />
try{<br />
Object newDict = parser.parse(junkXOXO);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public String junkElementXOXO = "<ol "<br />
+ XHTML_DEC<br />
+ "><li>bad<dl><dt>good</dt><dd>buy</dd></dl>"<br />
+ "worse</li><li>bag<ol><li>OK</li></ol>fish</li></ol>";<br />
<br />
public void testXOXOjunkInElements(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("good","buy");<br />
Object[] ok = {"OK"};<br />
Object[] obj ={dict, Arrays.asList(ok)};<br />
List testList = Arrays.asList(obj);<br />
try{<br />
Object newList = parser.parse(junkElementXOXO);<br />
assertEquals(testList,newList);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public String xoxoSpacesNewlines = "<ol " + XHTML_DEC +<br />
" class='xoxo'> \n" +<br />
" <li>\n" +<br />
" <dl>\n" +<br />
" <dt>text</dt>\n" +<br />
" <dd>item 1</dd>\n" +<br />
" <dt>description</dt>\n" +<br />
" <dd> This item represents the main" +<br />
" point we're trying to make.</dd>\n" +<br />
" <dt>url</dt>\n" +<br />
" <dd>http://example.com/more.xoxo</dd>\n" +<br />
" <dt>title</dt>\n" +<br />
" <dd>title of item 1</dd>\n" +<br />
" <dt>type</dt>\n" +<br />
" <dd>text/xml</dd>\n" +<br />
" <dt>rel</dt>\n" +<br />
" <dd>help</dd>\n" +<br />
" </dl>\n" +<br />
" </li>\n" +<br />
"</ol>";<br />
<br />
public void testXOXOWithSpacesAndNewlines(){<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("text","item 1");<br />
dict.put("description"," This item represents the main" +<br />
" point we're trying to make.");<br />
dict.put("url","http://example.com/more.xoxo");<br />
dict.put("title","title of item 1");<br />
dict.put("type","text/xml");<br />
dict.put("rel","help");<br />
try{<br />
Object newDict = parser.parse(xoxoSpacesNewlines);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public String xoxoSample = "<ol " + XHTML_DEC +<br />
" class='xoxo'> \n" +<br />
" <li>\n" +<br />
" <dl>\n" +<br />
" <dt>text</dt>\n" +<br />
" <dd>item 1</dd>\n" +<br />
" <dt>url</dt>\n" +<br />
" <dd>http://example.com/more.xoxo</dd>\n" +<br />
" <dt>title</dt>\n" +<br />
" <dd>title of item 1</dd>\n" +<br />
" <dt>type</dt>\n" +<br />
" <dd>text/xml</dd>\n" +<br />
" <dt>rel</dt>\n" +<br />
" <dd>help</dd>\n" +<br />
" </dl>\n" +<br />
" </li>\n" +<br />
"</ol>";<br />
<br />
public String smartXOXOSample = "<ol " + XHTML_DEC +<br />
"class=\"xoxo\"> \n" +<br />
" <li><a href=\"http://example.com/more.xoxo\"\n" +<br />
" title=\"title of item 1\"\n" +<br />
" type=\"text/xml\"\n" +<br />
" rel=\"help\">item 1</a> \n" +<br />
"<!-- note how the \"text\" property is simply" +<br />
" the contents of the <a> element -->\n" +<br />
" </li>\n" +<br />
"</ol>";<br />
<br />
public void testSpecialAttributeDecoding(){<br />
XOXOParser parser = new XOXOParser();<br />
try{<br />
Object xoxoDict = parser.parse(xoxoSample);<br />
Object xoxoDict2 = parser.parse(smartXOXOSample);<br />
assertEquals(xoxoDict,xoxoDict2);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public String specialAttrHTML = "<ol " + XHTML_DEC +<br />
"class=\"xoxo\">" +<br />
"<li><a href=\"http://example.com/more.xoxo\" title=\"sample url\" " +<br />
"rel=\"help\" type=\"text/xml\" >an example</a></li></ol>";<br />
<br />
public void testSpecialAttributeEncode(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
Map dict = new LinkedHashMap();<br />
dict.put("url","http://example.com/more.xoxo");<br />
dict.put("title","sample url");<br />
dict.put("type","text/xml");<br />
dict.put("rel","help");<br />
dict.put("text","an example");<br />
String html = xoxo.toXOXO(dict);<br />
assertEquals(specialAttrHTML,html);<br />
}<br />
<br />
public void testSpecialAttributeRoundTripFull(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("url","http://example.com/more.xoxo");<br />
dict.put("title","sample url");<br />
dict.put("type","text/xml");<br />
dict.put("rel","help");<br />
dict.put("text","an example");<br />
String html = xoxo.toXOXO(dict);<br />
try{<br />
Object newDict = parser.parse(html);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testSpecialAttributeRoundTripNoText(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("url","http://example.com/more.xoxo");<br />
dict.put("title","sample url");<br />
dict.put("type","text/xml");<br />
dict.put("rel","help");<br />
String html = xoxo.toXOXO(dict);<br />
try{<br />
Object newDict = parser.parse(html);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testSpecialAttributeRoundTripNoTextOrTitle(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("url","http://example.com/more.xoxo");<br />
dict.put("type","text/xml");<br />
dict.put("rel","help");<br />
String html = xoxo.toXOXO(dict);<br />
try{<br />
Object newDict = parser.parse(html);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testUnicodeRoundTrip(){<br />
String s = "Tantek Çelik and a snowman ?";<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
String html = xoxo.toXOXO(s);<br />
try{<br />
Object newString = parser.parse(html);<br />
assertEquals(s,newString);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
}<br />
<br />
</nowiki></pre></div>
RobertSayre
http://microformats.org/wiki/index.php?title=xoxo-sample-code&diff=2504
xoxo-sample-code
2005-10-30T19:32:31Z
<p>RobertSayre: /* XOXOParser.java */</p>
<hr />
<div>= XOXO Sample Code =<br />
<br />
A whole bunch of open source ([http://creativecommons.org/licenses/by/2.0/ CC-by-2.0], [http://www.apache.org/licenses/LICENSE-2.0 Apache 2.0]) sample code to read and write [[xoxo]] files in Python and Java (with Perl, PHP, ... to follow).<br />
= Python =<br />
== xoxo.py ==<br />
<pre><nowiki><br />
# -*- coding: utf-8 -*-<br />
"""xoxo.py - a utility module for transforming to and from the XHTMLOutlines format XOXO<br />
toXOXO takes a Python datastructure (tuples, lists or dictionaries, arbitrarily nested) and returns a XOXO representation of it.<br />
fromXOXO parses an XHTML file for a xoxo list and returns the structure<br />
"""<br />
__version__ = "0.8"<br />
__date__ = "2004-10-05"<br />
__author__ = "Kevin Marks <kmarks@technorati.com>"<br />
__copyright__ = "Copyright 2004, Kevin marks & Technorati"<br />
__license__ = "http://creativecommons.org/licenses/by/2.0/ CC-by-2.0], [http://www.apache.org/licenses/LICENSE-2.0 Apache 2.0"<br />
__credits__ = """Tantek Çelik and Mark Pilgrim for data structure"""<br />
__history__ = """<br />
TODO: add <title> tag<br />
TODO: add a proper profile link<br />
0.8 work in unicode then render to utf-8<br />
0.7 initial encoding support - just utf-8 for now<br />
0.6 support the special behaviour for url properties to/from <a><br />
0.5 fix some awkward side effects of whitespace and text outside our expected tags; simplify writing code<br />
0.4 add correct XHTML headers so it validates<br />
0.3 read/write version; fixed invlaid nested list generation;<br />
0.1 first write-only version<br />
"""<br />
<br />
try:<br />
True, False<br />
except NameError:<br />
True, False = not not 1, not 1<br />
containerTags={'ol':False,'ul':False,'dl':False}<br />
import sgmllib, urllib, urlparse, re<br />
def makeXOXO(struct,className=None,depth=0):<br />
s=u''<br />
if isinstance(struct,list) or isinstance(struct,tuple):<br />
if className:<br />
s += u'<ol class="%s">' % className<br />
else:<br />
s+= u"<ol>"<br />
if isinstance(struct,dict):<br />
d=struct.copy()<br />
if d.has_key('url'):<br />
s+=u'<a href="%s" ' % d['url']<br />
text = d.get('text',d.get('title',d['url']))<br />
for attr in ('title','rel','type'):<br />
if d.has_key(attr):<br />
xVal = makeXOXO(d[attr],None,depth+1)<br />
s +=u'%s="%s" ' % (attr,xVal)<br />
del d[attr]<br />
s +=u'>%s</a>' % makeXOXO(text,None,depth+1)<br />
if d.has_key('text'):<br />
del d['text']<br />
del d['url']<br />
if len(d):<br />
s +=u"<dl>"<br />
for key,value in d.items():<br />
xVal = makeXOXO(value,None,depth+1)<br />
s+= u'<dt>%s</dt><dd>%s</dd>' % (key, xVal)<br />
s +=u"</dl>"<br />
elif type(struct) ==type((1,))or type(struct) ==type([1,]):<br />
for item in struct:<br />
s+=u"<li>" + makeXOXO(item,None,depth+1)+"</li>"<br />
s +=u"</ol>"<br />
elif type(struct) == type(u'unicode'):<br />
s+=struct<br />
else:<br />
if not type(struct)==type(' '):<br />
struct=str(struct)<br />
try:<br />
s+=unicode(struct,'utf-8')<br />
except:<br />
s+=unicode(struct,'windows_1252')<br />
return s<br />
class xoxoParser(sgmllib.SGMLParser):<br />
def __init__(self):<br />
sgmllib.SGMLParser.__init__(self)<br />
self.structs=[]<br />
self.xostack=[]<br />
self.textstack=['']<br />
def normalize_attrs(self, attrs):<br />
attrs = [(k.lower(), sgmllib.charref.sub(lambda m: chr(int(m.groups()[0])), v).strip()) for k, v in attrs]<br />
attrs = [(k, k in ('rel','type') and v.lower() or v) for k, v in attrs]<br />
return attrs<br />
def pushStruct(self,struct):<br />
if type(struct) == type({}) and len(struct)==0 and len(self.structs) and type(self.structs[-1]) == type({}) and self.structs[-1].has_key('url'):<br />
self.xostack.append(self.structs[-1]) # put back the <a>-made one for extra def's<br />
else:<br />
self.structs.append(struct)<br />
self.xostack.append(self.structs[-1])<br />
def start_a(self,attrs):<br />
attrsD = dict(self.normalize_attrs(attrs))<br />
attrsD['url']= attrsD.get('href','')<br />
del attrsD['href']<br />
self.pushStruct(attrsD)<br />
self.textstack.append('')<br />
def end_a(self):<br />
val = self.textstack.pop()<br />
if val: <br />
if self.xostack[-1].get('title','') == val:<br />
val=''<br />
if self.xostack[-1]['url'] == val:<br />
val=''<br />
if val:<br />
self.xostack[-1]['text']=val<br />
self.xostack.pop()<br />
def start_dl(self,attrs):<br />
self.pushStruct({})<br />
def end_dl(self):<br />
self.xostack.pop()<br />
def start_ol(self,attrs):<br />
self.pushStruct([])<br />
def end_ol(self):<br />
self.xostack.pop()<br />
def start_ul(self,attrs):<br />
self.pushStruct([])<br />
def end_ul(self):<br />
self.xostack.pop()<br />
def start_li(self,attrs):<br />
self.textstack.append('')<br />
def end_li(self):<br />
val = self.textstack.pop()<br />
if self.structs[-1] != self.xostack[-1]:<br />
val = self.structs.pop()<br />
self.xostack[-1].append(val)<br />
def start_dt(self,attrs):<br />
self.textstack.append('')<br />
def end_dt(self):<br />
pass<br />
def start_dd(self,attrs):<br />
self.textstack.append('')<br />
def end_dd(self):<br />
val = self.textstack.pop()<br />
key = self.textstack.pop()<br />
if self.structs[-1] != self.xostack[-1]:<br />
val = self.structs.pop()<br />
self.xostack[-1][key]=val<br />
def handle_data(self, text):<br />
if len(self.stack) and containerTags.get(self.stack[-1],True): #skip text not within an element<br />
self.textstack[-1] += text<br />
def toXOXO(struct,addHTMLWrapper=False,cssUrl=''):<br />
if type(struct) ==type((1,))or type(struct) ==type([1,]):<br />
inStruct = struct<br />
else:<br />
inStruct = [struct]<br />
if addHTMLWrapper:<br />
s= '''<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN<br />
http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><br />
<html xmlns="http://www.w3.org/1999/xhtml"><head profile=""><meta http-equiv="Content-Type" content="text/html; charset=utf-8" />'''<br />
if cssUrl:<br />
s+='<style type="text/css" >@import "%s";</style>' % cssUrl<br />
s+="</head><body>%s</body></html>" % makeXOXO(inStruct,'xoxo')<br />
return s.encode('utf-8')<br />
else:<br />
return makeXOXO(inStruct,'xoxo').encode('utf-8')<br />
<br />
import sys<br />
<br />
def fromXOXO(html):<br />
parser = xoxoParser()<br />
parser.feed(unicode(html,'utf-8'))<br />
#print >>sys.stderr, parser.structs<br />
structs=[struct for struct in parser.structs if struct]<br />
#print >>sys.stderr, structs<br />
while (len(structs) ==1 and type(structs)==type([1,])):<br />
structs=structs[0]<br />
return structs<br />
<br />
# Allow direct invocation<br />
# Read HTML from URL, parse into data structures, then re-output<br />
<br />
if __name__ == "__main__":<br />
if len(sys.argv) < 2: raise SystemExit("Usage: "+sys.argv[0]+" url\n"+__doc__)<br />
url=sys.argv[1]<br />
file = urllib.urlopen(url)<br />
html=file.read(-1)<br />
file.close<br />
s=fromXOXO(html)<br />
p=toXOXO(s,True)<br />
print p<br />
<br />
</nowiki></pre><br />
<br />
== testxoxo.py ==<br />
<pre><nowiki><br />
# -*- coding: utf-8 -*-<br />
"""testxoxo.py <br />
Unit tests for xoxo.py<br />
This file tests the functions in xoxo.py <br />
The underlying model here is http://diveintopython.org/unit_testing/index.html <br />
<br />
run from command line with<br />
python testxoxo.py -v<br />
"""<br />
import xoxo<br />
reload(xoxo)<br />
import unittest<br />
<br />
class xoxoTestCases(unittest.TestCase):<br />
<br />
def testSimpleList(self):<br />
'''make a xoxo file from a list'''<br />
l = ['1','2','3']<br />
html = xoxo.toXOXO(l)<br />
self.assertEqual(html,'<ol class="xoxo"><li>1</li><li>2</li><li>3</li></ol>')<br />
def testNestedList(self):<br />
'''make a xoxo file from a list with a list in'''<br />
l = ['1',['2','3']]<br />
html = xoxo.toXOXO(l)<br />
self.assertEqual(html,'<ol class="xoxo"><li>1</li><li><ol><li>2</li><li>3</li></ol></li></ol>')<br />
<br />
def testDictionary(self):<br />
'''make a xoxo file from a dictionary'''<br />
d = {'test':'1','name':'Kevin'}<br />
html = xoxo.toXOXO(d)<br />
self.assertEqual(html,'<ol class="xoxo"><li><dl><dt>test</dt><dd>1</dd><dt>name</dt><dd>Kevin</dd></dl></li></ol>')<br />
<br />
def testSingleItem(self):<br />
'''make a xoxo file from a string'''<br />
l = "test"<br />
html = xoxo.toXOXO(l)<br />
self.assertEqual(html,'<ol class="xoxo"><li>test</li></ol>')<br />
<br />
def testWrapDiffers(self):<br />
'''make a xoxo file from a string with and without html wrapper and check they are different'''<br />
l = "test"<br />
html = xoxo.toXOXO(l)<br />
htmlwrap = xoxo.toXOXO(l,addHTMLWrapper=True)<br />
self.failIfEqual(html,htmlwrap)<br />
<br />
def testWrapSingleItem(self):<br />
'''make a wrapped xoxo file from a string'''<br />
l = "test"<br />
html = xoxo.toXOXO(l,addHTMLWrapper=True)<br />
self.assertEqual(html,'''<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN<br />
http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><br />
<html xmlns="http://www.w3.org/1999/xhtml"><head profile=""></head><body><ol class="xoxo"><li>test</li></ol></body></html>''')<br />
<br />
def testDictionaryRoundTrip(self):<br />
''' make a dictionary into a xoxo file and back again; check it is the same'''<br />
d = {'test':'1','name':'Kevin'}<br />
html = xoxo.toXOXO(d)<br />
newd = xoxo.fromXOXO(html)<br />
self.assertEqual(d,newd)<br />
<br />
def testListRoundTrip(self):<br />
''' make a list into a xoxo file and back again; check it is the same'''<br />
l = ['3','2','1']<br />
html = xoxo.toXOXO(l)<br />
newdl= xoxo.fromXOXO(html)<br />
self.assertEqual(l,newdl)<br />
def testListofDictsRoundTrip(self):<br />
''' make a list of Dicts into a xoxo file and back again; check it is the same'''<br />
l = ['3',{'a':'2'},{'b':'1','c':'4'}]<br />
html = xoxo.toXOXO(l)<br />
newdl= xoxo.fromXOXO(html)<br />
self.assertEqual(l,newdl)<br />
def testListofListsRoundTrip(self):<br />
''' make a list of Lists into a xoxo file and back again; check it is the same'''<br />
l = ['3',['a','2'],['b',['1',['c','4']]]]<br />
html = xoxo.toXOXO(l)<br />
newdl= xoxo.fromXOXO(html)<br />
self.assertEqual(l,newdl)<br />
def testDictofListsRoundTrip(self):<br />
''' make a dict with lists in into a xoxo file and back again; check it is the same'''<br />
d = {'test':['1','2'],<br />
'name':'Kevin',<br />
'nestlist':['a',['b','c']],<br />
'nestdict':{'e':'6','f':'7'}}<br />
html = xoxo.toXOXO(d)<br />
newd = xoxo.fromXOXO(html)<br />
self.assertEqual(d,newd)<br />
<br />
def testXOXOjunkInContainers(self):<br />
'''make sure text outside <li> etc is ignored'''<br />
d=xoxo.fromXOXO('<ol>bad<li><dl>worse<dt>good</dt><dd>buy</dd> now</dl></li></ol>')<br />
self.assertEqual(d,{'good': 'buy'})<br />
def testXOXOjunkInElements(self):<br />
'''make sure text within <li> but outside a subcontainer is ignored'''<br />
l=xoxo.fromXOXO('<ol><li>bad<dl><dt>good</dt><dd>buy</dd></dl>worse</li><li>bag<ol><li>OK</li></ol>fish</li></ol>')<br />
self.assertEqual(l,[{'good': 'buy'},['OK']])<br />
def testXOXOWithSpacesAndNewlines(self):<br />
'''unmung some xoxo with spaces in and check result is right'''<br />
xoxoSample= '''<ol class='xoxo'> <br />
<li><br />
<dl><br />
<dt>text</dt><br />
<dd>item 1</dd><br />
<dt>description</dt><br />
<dd> This item represents the main point we're trying to make.</dd><br />
<dt>url</dt><br />
<dd>http://example.com/more.xoxo</dd><br />
<dt>title</dt><br />
<dd>title of item 1</dd><br />
<dt>type</dt><br />
<dd>text/xml</dd><br />
<dt>rel</dt><br />
<dd>help</dd><br />
</dl><br />
</li><br />
</ol>'''<br />
d = xoxo.fromXOXO(xoxoSample)<br />
d2={'text':'item 1',<br />
'description':" This item represents the main point we're trying to make.",<br />
'url':'http://example.com/more.xoxo',<br />
'title':'title of item 1',<br />
'type':'text/xml',<br />
'rel':'help'<br />
}<br />
xoxoAgain = xoxo.toXOXO(d)<br />
self.assertEqual(d,d2)<br />
#this needs a smarter whitespace-sensitive comparison<br />
#self.assertEqual(xoxoSample,xoxoAgain)<br />
<br />
def testSpecialAttributeDecoding(self):<br />
'''unmung some xoxo with <a href=' rel= etc in and check result is right'''<br />
xoxoSample= '''<ol class='xoxo'> <br />
<li><br />
<dl><br />
<dt>text</dt><br />
<dd>item 1</dd><br />
<dt>url</dt><br />
<dd>http://example.com/more.xoxo</dd><br />
<dt>title</dt><br />
<dd>title of item 1</dd><br />
<dt>type</dt><br />
<dd>text/xml</dd><br />
<dt>rel</dt><br />
<dd>help</dd><br />
</dl><br />
</li><br />
</ol>'''<br />
d = xoxo.fromXOXO(xoxoSample)<br />
smartxoxoSample= '''<ol class='xoxo'> <br />
<li><a href="http://example.com/more.xoxo"<br />
title="title of item 1"<br />
type="text/xml"<br />
rel="help">item 1</a> <br />
<!-- note how the "text" property is simply the contents of the <a> element --><br />
</li><br />
</ol>'''<br />
d2 = xoxo.fromXOXO(smartxoxoSample)<br />
self.assertEqual(d,d2)<br />
def testSpecialAttributeAndDLDecoding(self):<br />
'''unmung some xoxo with <a href=' rel= etc in plus a <dl> in the same item and check result is right'''<br />
xoxoSample= '''<ol class="xoxo"> <br />
<li><br />
<dl><br />
<dt>text</dt><br />
<dd>item 1</dd><br />
<dt>description</dt><br />
<dd> This item represents the main point we're trying to make.</dd><br />
<dt>url</dt><br />
<dd>http://example.com/more.xoxo</dd><br />
<dt>title</dt><br />
<dd>title of item 1</dd><br />
<dt>type</dt><br />
<dd>text/xml</dd><br />
<dt>rel</dt><br />
<dd>help</dd><br />
</dl><br />
</li><br />
</ol>'''<br />
d = xoxo.fromXOXO(xoxoSample)<br />
smartxoxoSample= '''<ol class="xoxo"> <br />
<li><a href="http://example.com/more.xoxo"<br />
title="title of item 1"<br />
type="text/xml"<br />
rel="help">item 1</a> <br />
<!-- note how the "text" property is simply the contents of the <a> element --><br />
<dl><br />
<dt>description</dt><br />
<dd> This item represents the main point we're trying to make.</dd><br />
</dl><br />
</li><br />
</ol>'''<br />
d2 = xoxo.fromXOXO(smartxoxoSample)<br />
self.assertEqual(d,d2)<br />
def testSpecialAttributeEncode(self):<br />
'''check it makes an <a href with a url parameter'''<br />
d={'url':'http://example.com/more.xoxo','title':'sample url','type':"text/xml",'rel':'help','text':'an example'}<br />
html=xoxo.toXOXO(d)<br />
expectedHTML= '<ol class="xoxo"><li><a href="http://example.com/more.xoxo" title="sample url" rel="help" type="text/xml" >an example</a></li></ol>' <br />
self.assertEqual(html,expectedHTML)<br />
<br />
def testSpecialAttributeRoundTripFull(self):<br />
'''check it makes an <a href with a url parameter'''<br />
d={'url':'http://example.com/more.xoxo','title':'sample url','type':"text/xml",'rel':'help','text':'an example'}<br />
html=xoxo.toXOXO(d)<br />
self.assertEqual(d,xoxo.fromXOXO(html))<br />
def testSpecialAttributeRoundTripNoText(self):<br />
'''check it makes an <a href with a url parameter and no text attribute'''<br />
d={'url':'http://example.com/more.xoxo','title':'sample url','type':"text/xml",'rel':'help'}<br />
html=xoxo.toXOXO(d)<br />
self.assertEqual(d,xoxo.fromXOXO(html))<br />
def testSpecialAttributeRoundTripNoTextOrTitle(self):<br />
'''check it makes an <a href with a url parameter and no text or title attribute'''<br />
d={'url':'http://example.com/more.xoxo'}<br />
html=xoxo.toXOXO(d)<br />
self.assertEqual(d,xoxo.fromXOXO(html))<br />
def testUnicodeRoundtrip(self):<br />
'''check unicode characters can go to xoxo and back'''<br />
src=unicode('Tantek Çelik and a snowman ?','utf-8')<br />
html = html=xoxo.toXOXO(src)<br />
self.assertEqual(src,xoxo.fromXOXO(html))<br />
if __name__ == "__main__":<br />
unittest.main()<br />
else:<br />
runner = unittest.TextTestRunner()<br />
suite = unittest.makeSuite(xoxoTestCases,'test')<br />
runner.run(suite)<br />
<br />
</nowiki></pre><br />
<br />
= Java =<br />
== XOXOWriter.java ==<br />
<pre><nowiki><br />
/*<br />
* Copyright 2005 Robert Sayre<br />
*<br />
* Licensed under the Apache License, Version 2.0 (the "License");<br />
* you may not use this file except in compliance with the License.<br />
* You may obtain a copy of the License at<br />
* <br />
* http://www.apache.org/licenses/LICENSE-2.0<br />
* <br />
* Unless required by applicable law or agreed to in writing, software<br />
* distributed under the License is distributed on an "AS IS" BASIS,<br />
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<br />
* See the License for the specific language governing permissions and<br />
* limitations under the License.<br />
*<br />
* Portions of this code are derived from the Apache-licensed Python XOXO<br />
* module by Kevin Marks. <http://microformats.org/wiki/xoxo-sample-code><br />
*/<br />
<br />
package org.atompub.draft.xoxo;<br />
<br />
import java.util.*;<br />
<br />
public class XOXOWriter {<br />
<br />
public String[] attrs = {"title","rel","type"};<br />
<br />
public String makeXOXO(List struct, String className){<br />
return makeXOXO(struct, className, 0, true);<br />
}<br />
<br />
public String makeXOXO(List struct, String className,<br />
boolean doNSDeclaration){<br />
return makeXOXO(struct, className, 0, doNSDeclaration);<br />
}<br />
<br />
public String makeXOXO(List struct){<br />
return makeXOXO(struct, "xoxo", 0, true);<br />
}<br />
<br />
public String makeXOXO(Object struct, int depth){<br />
return makeXOXO(struct, null, 0, false);<br />
}<br />
<br />
public String makeXOXO(Object struct, String className,<br />
int depth, boolean doNSDeclaration){<br />
if(struct == null) return "";<br />
StringBuffer sb = new StringBuffer();<br />
if(struct instanceof Object[]){<br />
struct = Arrays.asList((Object[]) struct);<br />
}<br />
if(struct instanceof List){<br />
sb.append("<ol");<br />
if(doNSDeclaration)<br />
sb.append(" xmlns=\"http://www.w3.org/1999/xhtml\"");<br />
if(className != null){<br />
sb.append(" class=\"");<br />
sb.append(className);<br />
sb.append("\"");<br />
}<br />
sb.append(">");<br />
}<br />
if(struct instanceof Map){<br />
Map d = new LinkedHashMap((Map) struct);<br />
if(d.containsKey("url")){<br />
sb.append("<a href=\"" + d.get("url") + "\" ");<br />
Object text;<br />
if(d.containsKey("text")){<br />
text = d.get("text");<br />
}else if(d.containsKey("title")){<br />
text = d.get("title");<br />
}else{<br />
text = d.get("url");<br />
}<br />
for(int i=0; i<attrs.length; i++){<br />
String xVal = makeXOXO(d.get(attrs[i]),depth+1);<br />
if(xVal != null && !xVal.equals("")){<br />
sb.append(attrs[i] + "=\"" + xVal + "\" ");<br />
}<br />
d.remove(attrs[i]);<br />
}<br />
sb.append(">" + makeXOXO(text, depth+1) + "</a>");<br />
d.remove("text");<br />
d.remove("url");<br />
}<br />
if(d.size() > 0){<br />
sb.append("<dl>");<br />
for(Iterator i = d.keySet().iterator(); i.hasNext();){<br />
Object k = i.next();<br />
String ddVal = makeXOXO(d.get(k),depth+1);<br />
sb.append("<dt>" + k + "</dt>");<br />
sb.append("<dd>" + ddVal + "</dd>");<br />
}<br />
sb.append("</dl>");<br />
}<br />
}else if(struct instanceof List){<br />
List l = (List) struct;<br />
for(Iterator i = l.iterator(); i.hasNext();){<br />
Object item = i.next();<br />
sb.append("<li>" + makeXOXO(item,depth+1) + "</li>");<br />
}<br />
sb.append("</ol>");<br />
}else{<br />
sb.append(struct);<br />
}<br />
return sb.toString();<br />
}<br />
<br />
public String toXOXO(List struct){<br />
return toXOXO(struct, false, null);<br />
}<br />
<br />
public String toXOXO(Object struct){<br />
List alist = new ArrayList();<br />
alist.add(struct);<br />
return toXOXO(alist);<br />
}<br />
<br />
public String toXOXO(Object struct,<br />
boolean addHTMLWrapper,<br />
String cssUrl){<br />
List alist = new ArrayList();<br />
alist.add(struct);<br />
return toXOXO(alist, addHTMLWrapper, cssUrl);<br />
}<br />
<br />
public String toXOXO(List struct,<br />
boolean addHTMLWrapper,<br />
String cssUrl){<br />
String startHTML = "<!DOCTYPE html PUBLIC \"-//W3C//DTD"<br />
+ "XHTML 1.0 Transitional//EN\n"<br />
+ "http://www.w3.org/TR/xhtml1/DTD/"<br />
+ "xhtml1-transitional.dtd\">"<br />
+ "<html xmlns=\"http://www.w3.org/1999/xhtml\">"<br />
+ "<head>";<br />
if(addHTMLWrapper){<br />
String s = startHTML;<br />
if(cssUrl != null){<br />
s += "<style type=\"text/css\">@import \""<br />
+ cssUrl + "\";</style>";<br />
}<br />
s += "</head><body>" + makeXOXO(struct, "xoxo", false)<br />
+ "</body></html>";<br />
return s;<br />
}else{<br />
return makeXOXO(struct, "xoxo");<br />
}<br />
}<br />
}<br />
</nowiki></pre><br />
<br />
== XOXOParser.java ==<br />
<pre><nowiki><br />
/*<br />
* Copyright 2005 Robert Sayre<br />
*<br />
* Licensed under the Apache License, Version 2.0 (the "License");<br />
* you may not use this file except in compliance with the License.<br />
* You may obtain a copy of the License at<br />
* <br />
* http://www.apache.org/licenses/LICENSE-2.0<br />
* <br />
* Unless required by applicable law or agreed to in writing, software<br />
* distributed under the License is distributed on an "AS IS" BASIS,<br />
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<br />
* See the License for the specific language governing permissions and<br />
* limitations under the License.<br />
*<br />
* Portions of this code are derived from the Apache-licensed Python XOXO<br />
* module by Kevin Marks. <http://microformats.org/wiki/xoxo-sample-code><br />
*/<br />
<br />
package org.atompub.draft.xoxo;<br />
<br />
import org.xml.sax.InputSource;<br />
import org.xml.sax.SAXException;<br />
import org.xml.sax.XMLReader;<br />
import org.xml.sax.Attributes;<br />
import org.xml.sax.helpers.XMLReaderFactory;<br />
import org.xml.sax.helpers.DefaultHandler;<br />
<br />
import java.util.*;<br />
import java.io.InputStream;<br />
import java.io.StringReader;<br />
import java.io.IOException;<br />
<br />
public class XOXOParser extends DefaultHandler {<br />
<br />
protected String XHTML_NS = "http://www.w3.org/1999/xhtml";<br />
protected List elStack;<br />
protected Map listEls;<br />
public List structs;<br />
public List xoStack;<br />
public List textStack;<br />
<br />
public XOXOParser() {<br />
reset();<br />
}<br />
<br />
protected void pushStruct(Object struct){<br />
if((struct instanceof Map) && (((Map) struct).size() > 0)<br />
&& (structs.get(structs.size()-1) instanceof Map)<br />
&& (((Map) struct).containsKey("url"))){<br />
// put back the <a>-made one for extra defs<br />
xoStack.add(structs.get(structs.size()-1));<br />
}else{<br />
structs.add(struct);<br />
xoStack.add(struct);<br />
}<br />
}<br />
<br />
public void startElement(String nsUri, String localName,<br />
String qName, Attributes atts){<br />
// bounce non-XHTML elements<br />
if(nsUri.equals(XHTML_NS)){<br />
elStack.add(localName);<br />
}else{<br />
elStack.add("foo");<br />
return;<br />
}<br />
<br />
if(localName.equals("a")){<br />
Map attmap = new LinkedHashMap();<br />
int len = atts.getLength();<br />
for(int i=0; i<len; i++){<br />
attmap.put(atts.getQName(i),atts.getValue(i));<br />
}<br />
if(attmap.containsKey("href")){<br />
attmap.put("url",attmap.get("href"));<br />
attmap.remove("href");<br />
}<br />
pushStruct(attmap);<br />
textStack.add("");<br />
}else if(localName.equals("dl")){<br />
pushStruct(new LinkedHashMap());<br />
}else if(localName.equals("ol")){<br />
pushStruct(new ArrayList());<br />
}else if(localName.equals("ul")){<br />
pushStruct(new ArrayList());<br />
}else if(localName.equals("li")){<br />
textStack.add("");<br />
}else if(localName.equals("dt")){<br />
textStack.add("");<br />
}else if(localName.equals("dd")){<br />
textStack.add("");<br />
}<br />
}<br />
<br />
public void endElement(String nsUri, String localName,<br />
String qName){<br />
elStack.remove(elStack.size()-1);<br />
// bounce non-XHTML elements<br />
if(nsUri != XHTML_NS){<br />
return;<br />
}<br />
<br />
if(localName.equals("a")){<br />
String val = (String) textStack.remove(textStack.size()-1);<br />
if (val.length() > 0){<br />
Map defs = (Map) xoStack.get(xoStack.size()-1);<br />
String defVal = (String) defs.get("title");<br />
if((defVal != null) && (val.equals(defVal))){<br />
val = "";<br />
}<br />
defVal = (String) defs.get("url");<br />
if((defVal != null) && (val.equals(defVal))){<br />
val = "";<br />
}<br />
if(val.length() > 0){<br />
defs.put("text",val);<br />
}<br />
}<br />
xoStack.remove(xoStack.size()-1);<br />
}else if(localName.equals("dl")){<br />
xoStack.remove(xoStack.size()-1);<br />
}else if(localName.equals("ol")){<br />
xoStack.remove(xoStack.size()-1);<br />
}else if(localName.equals("ul")){<br />
xoStack.remove(xoStack.size()-1);<br />
}else if(localName.equals("li")){<br />
Object val = textStack.remove(textStack.size()-1);<br />
List last = (List) xoStack.get(xoStack.size()-1);<br />
if(structs.get(structs.size()-1) != last){<br />
val = structs.remove(structs.size()-1);<br />
}<br />
last.add(val);<br />
}else if(localName.equals("dd")){<br />
Object val = textStack.remove(textStack.size()-1);<br />
Object key = textStack.remove(textStack.size()-1);<br />
Map last = (Map) xoStack.get(xoStack.size()-1);<br />
if(structs.get(structs.size()-1) != last){<br />
val = structs.remove(structs.size()-1);<br />
}<br />
last.put(key,val);<br />
}<br />
}<br />
<br />
public void characters(char[] ch, int start, int length){<br />
if((xoStack.size() > 0)<br />
&& (!listEls.containsKey(elStack.get(elStack.size()-1)))){<br />
String text = (String) textStack.get(textStack.size()-1);<br />
String test = new String(ch,start,length);<br />
textStack.set(textStack.size()-1,text+test);<br />
}<br />
}<br />
<br />
public Object parse(String s) throws SAXException, IOException{<br />
return parse(new InputSource(new StringReader(s)));<br />
}<br />
<br />
public Object parse(InputStream is) throws SAXException, IOException {<br />
return parse(new InputSource(is));<br />
}<br />
<br />
public Object parse(InputSource in) throws SAXException, IOException {<br />
XMLReader parser = XMLReaderFactory.createXMLReader();<br />
parser.setContentHandler(this);<br />
parser.parse(in);<br />
List returnList = new ArrayList();<br />
for(Iterator i = this.structs.iterator(); i.hasNext();){<br />
Object thing = i.next();<br />
if(thing != null){<br />
returnList.add(thing);<br />
}<br />
}<br />
while((returnList.size()==1)){<br />
if(returnList.get(0) instanceof List){<br />
returnList = (List) returnList.get(0);<br />
}else{<br />
reset();<br />
return returnList.get(0);<br />
}<br />
}<br />
reset();<br />
return returnList;<br />
}<br />
<br />
protected void reset(){<br />
elStack = new ArrayList();<br />
listEls = new HashMap();<br />
structs = new ArrayList();<br />
xoStack = new ArrayList();<br />
textStack = new ArrayList();<br />
listEls.put("ol","ol");<br />
listEls.put("ul","ul");<br />
listEls.put("dl","dl");<br />
}<br />
}<br />
<br />
</nowiki></pre><br />
<br />
== XOXOTest.java ==<br />
<pre><nowiki><br />
package org.atompub.draft.xoxo.tests;<br />
<br />
import junit.framework.TestSuite;<br />
import junit.framework.TestCase;<br />
import junit.textui.TestRunner;<br />
import org.atompub.draft.xoxo.XOXOWriter;<br />
import org.atompub.draft.xoxo.XOXOParser;<br />
<br />
import java.util.*;<br />
<br />
public class XOXOTest extends TestCase {<br />
<br />
public static void main(String[] args) {<br />
new TestRunner().doRun(new TestSuite(XOXOTest.class));<br />
}<br />
String XHTML_DEC = "xmlns=\"http://www.w3.org/1999/xhtml\" ";<br />
public String simpleListHTML = "<ol "<br />
+ XHTML_DEC<br />
+ "class=\"xoxo\">"<br />
+ "<li>1</li><li>2</li><li>3</li></ol>";<br />
<br />
public void testSimpleList(){<br />
String [] numbers = {"1","2","3"};<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(simpleListHTML,<br />
xoxo.toXOXO(Arrays.asList(numbers)));<br />
}<br />
<br />
public void testStringIntegerList(){<br />
Object[] numbers = {new Integer(1),"2","3"};<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(simpleListHTML,<br />
xoxo.toXOXO(Arrays.asList(numbers)));<br />
}<br />
<br />
public String nestedListHTML = "<ol "<br />
+ XHTML_DEC<br />
+ "class=\"xoxo\"><li>1</li><li>"<br />
+ "<ol><li>2</li><li>3</li></ol></li></ol>";<br />
<br />
public void testNestedList(){<br />
Object[] arr = {"2","3"};<br />
Object[] nested = {"1",Arrays.asList(arr)};<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(nestedListHTML,<br />
xoxo.toXOXO(Arrays.asList(nested)));<br />
}<br />
<br />
public void testNestedArray(){<br />
Object[] arr = {"2","3"};<br />
Object[] nested = {"1",arr};<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(nestedListHTML,<br />
xoxo.toXOXO(Arrays.asList(nested)));<br />
}<br />
<br />
public String dictHTML = "<ol "<br />
+ XHTML_DEC<br />
+ "class=\"xoxo\">"<br />
+ "<li><dl><dt>test</dt><dd>1</dd><dt>name</dt>"<br />
+ "<dd>Kevin</dd></dl></li></ol>";<br />
<br />
public void testDictionary(){<br />
Map dict = new LinkedHashMap();<br />
dict.put("test", new Integer(1));<br />
dict.put("name", "Kevin");<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(dictHTML,<br />
xoxo.toXOXO(dict));<br />
}<br />
<br />
public String singleHTML = "<ol "<br />
+ XHTML_DEC<br />
+ "class=\"xoxo\">"<br />
+ "<li>test</li></ol>";<br />
<br />
public void testSingleItem(){<br />
String item = "test";<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(singleHTML,<br />
xoxo.toXOXO(item));<br />
}<br />
<br />
public void testWrapDiffers(){<br />
String item = "test";<br />
XOXOWriter xoxo = new XOXOWriter();<br />
String nowrap = xoxo.toXOXO(item);<br />
Object[] itemArr = {item};<br />
String wrap = xoxo.toXOXO(Arrays.asList(itemArr),true,null);<br />
assertFalse(wrap.equals(nowrap));<br />
}<br />
<br />
String startHTML = "<!DOCTYPE html PUBLIC \"-//W3C//DTD"<br />
+ "XHTML 1.0 Transitional//EN\n"<br />
+ "http://www.w3.org/TR/xhtml1/DTD/"<br />
+ "xhtml1-transitional.dtd\">"<br />
+ "<html xmlns=\"http://www.w3.org/1999/xhtml\">"<br />
+ "<head></head><body>";<br />
public String singleWrapHTML = "<ol "<br />
+ "class=\"xoxo\">"<br />
+ "<li>test</li></ol>";<br />
public String endHTML = "</body></html>";<br />
<br />
public void testWrapSingleItem(){<br />
String item = "test";<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(startHTML + singleWrapHTML + endHTML,<br />
xoxo.toXOXO(item,true,null));<br />
}<br />
<br />
public void testXOXOParser(){<br />
XOXOParser parser = new XOXOParser();<br />
try{<br />
parser.parse(dictHTML);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testDictRoundTrip(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("test", "1");<br />
dict.put("name", "Kevin");<br />
String html = xoxo.toXOXO(dict);<br />
try{<br />
Object newDict = parser.parse(html);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testListRoundTrip(){<br />
Object[] obj = {"1","2","3"};<br />
List testList = Arrays.asList(obj);<br />
XOXOWriter xoxo = new XOXOWriter();<br />
String html = xoxo.toXOXO(testList);<br />
XOXOParser parser = new XOXOParser();<br />
try{<br />
Object newList = parser.parse(html);<br />
assertEquals(testList,newList);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testListOfDictsRoundTrip(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("test", "1");<br />
dict.put("name", "Kevin");<br />
Map dict2 = new LinkedHashMap();<br />
dict2.put("one", "two");<br />
dict2.put("three", "four");<br />
dict2.put("five", "six");<br />
Object[] obj = {"1",dict,dict2};<br />
List testList = Arrays.asList(obj);<br />
String html = xoxo.toXOXO(testList);<br />
try{<br />
Object newList = parser.parse(html);<br />
assertEquals(testList,newList);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testListOfListsRoundTrip(){<br />
Object[] list1 = {"1","2","3"};<br />
Object[] list2 = {"4","5","6", Arrays.asList(list1)};<br />
Object[] list3 = {"7", Arrays.asList(list2)};<br />
Object[] list4 = {"8", Arrays.asList(list3)};<br />
List testList = Arrays.asList(list4);<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
String html = xoxo.toXOXO(testList);<br />
try{<br />
Object newList = parser.parse(html);<br />
assertEquals(testList,newList);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testDictOfListsRoundTrip(){<br />
Object[] list1 = {"1","2","3"};<br />
Object[] list2 = {"4","5","6"};<br />
Object[] list3 = {"7"};<br />
Object[] list4 = {"8", "9"};<br />
Map dict = new LinkedHashMap();<br />
dict.put("foo", Arrays.asList(list1));<br />
dict.put("bar", Arrays.asList(list2));<br />
dict.put("baz", Arrays.asList(list3));<br />
dict.put("qux", Arrays.asList(list4));<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
String html = xoxo.toXOXO(dict);<br />
try{<br />
Object newDict = parser.parse(html);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public String junkXOXO = "<ol "<br />
+ XHTML_DEC<br />
+ "class=\"xoxo\">"<br />
+ "bad<li><dl>worse<dt>good</dt><dd>buy</dd> now</dl></li></ol>";<br />
<br />
public void testXOXOJunkInContainers(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("good","buy");<br />
try{<br />
Object newDict = parser.parse(junkXOXO);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public String junkElementXOXO = "<ol "<br />
+ XHTML_DEC<br />
+ "><li>bad<dl><dt>good</dt><dd>buy</dd></dl>"<br />
+ "worse</li><li>bag<ol><li>OK</li></ol>fish</li></ol>";<br />
<br />
public void testXOXOjunkInElements(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("good","buy");<br />
Object[] ok = {"OK"};<br />
Object[] obj ={dict, Arrays.asList(ok)};<br />
List testList = Arrays.asList(obj);<br />
try{<br />
Object newList = parser.parse(junkElementXOXO);<br />
assertEquals(testList,newList);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public String xoxoSpacesNewlines = "<ol " + XHTML_DEC +<br />
" class='xoxo'> \n" +<br />
" <li>\n" +<br />
" <dl>\n" +<br />
" <dt>text</dt>\n" +<br />
" <dd>item 1</dd>\n" +<br />
" <dt>description</dt>\n" +<br />
" <dd> This item represents the main" +<br />
" point we're trying to make.</dd>\n" +<br />
" <dt>url</dt>\n" +<br />
" <dd>http://example.com/more.xoxo</dd>\n" +<br />
" <dt>title</dt>\n" +<br />
" <dd>title of item 1</dd>\n" +<br />
" <dt>type</dt>\n" +<br />
" <dd>text/xml</dd>\n" +<br />
" <dt>rel</dt>\n" +<br />
" <dd>help</dd>\n" +<br />
" </dl>\n" +<br />
" </li>\n" +<br />
"</ol>";<br />
<br />
public void testXOXOWithSpacesAndNewlines(){<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("text","item 1");<br />
dict.put("description"," This item represents the main" +<br />
" point we're trying to make.");<br />
dict.put("url","http://example.com/more.xoxo");<br />
dict.put("title","title of item 1");<br />
dict.put("type","text/xml");<br />
dict.put("rel","help");<br />
try{<br />
Object newDict = parser.parse(xoxoSpacesNewlines);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public String xoxoSample = "<ol " + XHTML_DEC +<br />
" class='xoxo'> \n" +<br />
" <li>\n" +<br />
" <dl>\n" +<br />
" <dt>text</dt>\n" +<br />
" <dd>item 1</dd>\n" +<br />
" <dt>url</dt>\n" +<br />
" <dd>http://example.com/more.xoxo</dd>\n" +<br />
" <dt>title</dt>\n" +<br />
" <dd>title of item 1</dd>\n" +<br />
" <dt>type</dt>\n" +<br />
" <dd>text/xml</dd>\n" +<br />
" <dt>rel</dt>\n" +<br />
" <dd>help</dd>\n" +<br />
" </dl>\n" +<br />
" </li>\n" +<br />
"</ol>";<br />
<br />
public String smartXOXOSample = "<ol " + XHTML_DEC +<br />
"class=\"xoxo\"> \n" +<br />
" <li><a href=\"http://example.com/more.xoxo\"\n" +<br />
" title=\"title of item 1\"\n" +<br />
" type=\"text/xml\"\n" +<br />
" rel=\"help\">item 1</a> \n" +<br />
"<!-- note how the \"text\" property is simply" +<br />
" the contents of the <a> element -->\n" +<br />
" </li>\n" +<br />
"</ol>";<br />
<br />
public void testSpecialAttributeDecoding(){<br />
XOXOParser parser = new XOXOParser();<br />
try{<br />
Object xoxoDict = parser.parse(xoxoSample);<br />
Object xoxoDict2 = parser.parse(smartXOXOSample);<br />
assertEquals(xoxoDict,xoxoDict2);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public String specialAttrHTML = "<ol " + XHTML_DEC +<br />
"class=\"xoxo\">" +<br />
"<li><a href=\"http://example.com/more.xoxo\" title=\"sample url\" " +<br />
"rel=\"help\" type=\"text/xml\" >an example</a></li></ol>";<br />
<br />
public void testSpecialAttributeEncode(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
Map dict = new LinkedHashMap();<br />
dict.put("url","http://example.com/more.xoxo");<br />
dict.put("title","sample url");<br />
dict.put("type","text/xml");<br />
dict.put("rel","help");<br />
dict.put("text","an example");<br />
String html = xoxo.toXOXO(dict);<br />
assertEquals(specialAttrHTML,html);<br />
}<br />
<br />
public void testSpecialAttributeRoundTripFull(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("url","http://example.com/more.xoxo");<br />
dict.put("title","sample url");<br />
dict.put("type","text/xml");<br />
dict.put("rel","help");<br />
dict.put("text","an example");<br />
String html = xoxo.toXOXO(dict);<br />
try{<br />
Object newDict = parser.parse(html);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testSpecialAttributeRoundTripNoText(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("url","http://example.com/more.xoxo");<br />
dict.put("title","sample url");<br />
dict.put("type","text/xml");<br />
dict.put("rel","help");<br />
String html = xoxo.toXOXO(dict);<br />
try{<br />
Object newDict = parser.parse(html);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testSpecialAttributeRoundTripNoTextOrTitle(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("url","http://example.com/more.xoxo");<br />
dict.put("type","text/xml");<br />
dict.put("rel","help");<br />
String html = xoxo.toXOXO(dict);<br />
try{<br />
Object newDict = parser.parse(html);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testUnicodeRoundTrip(){<br />
String s = "Tantek Çelik and a snowman ?";<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
String html = xoxo.toXOXO(s);<br />
try{<br />
Object newString = parser.parse(html);<br />
assertEquals(s,newString);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
}<br />
<br />
</nowiki></pre></div>
RobertSayre
http://microformats.org/wiki/index.php?title=xoxo-sample-code&diff=2503
xoxo-sample-code
2005-10-30T19:32:19Z
<p>RobertSayre: /* XOXOParser.java */</p>
<hr />
<div>= XOXO Sample Code =<br />
<br />
A whole bunch of open source ([http://creativecommons.org/licenses/by/2.0/ CC-by-2.0], [http://www.apache.org/licenses/LICENSE-2.0 Apache 2.0]) sample code to read and write [[xoxo]] files in Python and Java (with Perl, PHP, ... to follow).<br />
= Python =<br />
== xoxo.py ==<br />
<pre><nowiki><br />
# -*- coding: utf-8 -*-<br />
"""xoxo.py - a utility module for transforming to and from the XHTMLOutlines format XOXO<br />
toXOXO takes a Python datastructure (tuples, lists or dictionaries, arbitrarily nested) and returns a XOXO representation of it.<br />
fromXOXO parses an XHTML file for a xoxo list and returns the structure<br />
"""<br />
__version__ = "0.8"<br />
__date__ = "2004-10-05"<br />
__author__ = "Kevin Marks <kmarks@technorati.com>"<br />
__copyright__ = "Copyright 2004, Kevin marks & Technorati"<br />
__license__ = "http://creativecommons.org/licenses/by/2.0/ CC-by-2.0], [http://www.apache.org/licenses/LICENSE-2.0 Apache 2.0"<br />
__credits__ = """Tantek Çelik and Mark Pilgrim for data structure"""<br />
__history__ = """<br />
TODO: add <title> tag<br />
TODO: add a proper profile link<br />
0.8 work in unicode then render to utf-8<br />
0.7 initial encoding support - just utf-8 for now<br />
0.6 support the special behaviour for url properties to/from <a><br />
0.5 fix some awkward side effects of whitespace and text outside our expected tags; simplify writing code<br />
0.4 add correct XHTML headers so it validates<br />
0.3 read/write version; fixed invlaid nested list generation;<br />
0.1 first write-only version<br />
"""<br />
<br />
try:<br />
True, False<br />
except NameError:<br />
True, False = not not 1, not 1<br />
containerTags={'ol':False,'ul':False,'dl':False}<br />
import sgmllib, urllib, urlparse, re<br />
def makeXOXO(struct,className=None,depth=0):<br />
s=u''<br />
if isinstance(struct,list) or isinstance(struct,tuple):<br />
if className:<br />
s += u'<ol class="%s">' % className<br />
else:<br />
s+= u"<ol>"<br />
if isinstance(struct,dict):<br />
d=struct.copy()<br />
if d.has_key('url'):<br />
s+=u'<a href="%s" ' % d['url']<br />
text = d.get('text',d.get('title',d['url']))<br />
for attr in ('title','rel','type'):<br />
if d.has_key(attr):<br />
xVal = makeXOXO(d[attr],None,depth+1)<br />
s +=u'%s="%s" ' % (attr,xVal)<br />
del d[attr]<br />
s +=u'>%s</a>' % makeXOXO(text,None,depth+1)<br />
if d.has_key('text'):<br />
del d['text']<br />
del d['url']<br />
if len(d):<br />
s +=u"<dl>"<br />
for key,value in d.items():<br />
xVal = makeXOXO(value,None,depth+1)<br />
s+= u'<dt>%s</dt><dd>%s</dd>' % (key, xVal)<br />
s +=u"</dl>"<br />
elif type(struct) ==type((1,))or type(struct) ==type([1,]):<br />
for item in struct:<br />
s+=u"<li>" + makeXOXO(item,None,depth+1)+"</li>"<br />
s +=u"</ol>"<br />
elif type(struct) == type(u'unicode'):<br />
s+=struct<br />
else:<br />
if not type(struct)==type(' '):<br />
struct=str(struct)<br />
try:<br />
s+=unicode(struct,'utf-8')<br />
except:<br />
s+=unicode(struct,'windows_1252')<br />
return s<br />
class xoxoParser(sgmllib.SGMLParser):<br />
def __init__(self):<br />
sgmllib.SGMLParser.__init__(self)<br />
self.structs=[]<br />
self.xostack=[]<br />
self.textstack=['']<br />
def normalize_attrs(self, attrs):<br />
attrs = [(k.lower(), sgmllib.charref.sub(lambda m: chr(int(m.groups()[0])), v).strip()) for k, v in attrs]<br />
attrs = [(k, k in ('rel','type') and v.lower() or v) for k, v in attrs]<br />
return attrs<br />
def pushStruct(self,struct):<br />
if type(struct) == type({}) and len(struct)==0 and len(self.structs) and type(self.structs[-1]) == type({}) and self.structs[-1].has_key('url'):<br />
self.xostack.append(self.structs[-1]) # put back the <a>-made one for extra def's<br />
else:<br />
self.structs.append(struct)<br />
self.xostack.append(self.structs[-1])<br />
def start_a(self,attrs):<br />
attrsD = dict(self.normalize_attrs(attrs))<br />
attrsD['url']= attrsD.get('href','')<br />
del attrsD['href']<br />
self.pushStruct(attrsD)<br />
self.textstack.append('')<br />
def end_a(self):<br />
val = self.textstack.pop()<br />
if val: <br />
if self.xostack[-1].get('title','') == val:<br />
val=''<br />
if self.xostack[-1]['url'] == val:<br />
val=''<br />
if val:<br />
self.xostack[-1]['text']=val<br />
self.xostack.pop()<br />
def start_dl(self,attrs):<br />
self.pushStruct({})<br />
def end_dl(self):<br />
self.xostack.pop()<br />
def start_ol(self,attrs):<br />
self.pushStruct([])<br />
def end_ol(self):<br />
self.xostack.pop()<br />
def start_ul(self,attrs):<br />
self.pushStruct([])<br />
def end_ul(self):<br />
self.xostack.pop()<br />
def start_li(self,attrs):<br />
self.textstack.append('')<br />
def end_li(self):<br />
val = self.textstack.pop()<br />
if self.structs[-1] != self.xostack[-1]:<br />
val = self.structs.pop()<br />
self.xostack[-1].append(val)<br />
def start_dt(self,attrs):<br />
self.textstack.append('')<br />
def end_dt(self):<br />
pass<br />
def start_dd(self,attrs):<br />
self.textstack.append('')<br />
def end_dd(self):<br />
val = self.textstack.pop()<br />
key = self.textstack.pop()<br />
if self.structs[-1] != self.xostack[-1]:<br />
val = self.structs.pop()<br />
self.xostack[-1][key]=val<br />
def handle_data(self, text):<br />
if len(self.stack) and containerTags.get(self.stack[-1],True): #skip text not within an element<br />
self.textstack[-1] += text<br />
def toXOXO(struct,addHTMLWrapper=False,cssUrl=''):<br />
if type(struct) ==type((1,))or type(struct) ==type([1,]):<br />
inStruct = struct<br />
else:<br />
inStruct = [struct]<br />
if addHTMLWrapper:<br />
s= '''<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN<br />
http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><br />
<html xmlns="http://www.w3.org/1999/xhtml"><head profile=""><meta http-equiv="Content-Type" content="text/html; charset=utf-8" />'''<br />
if cssUrl:<br />
s+='<style type="text/css" >@import "%s";</style>' % cssUrl<br />
s+="</head><body>%s</body></html>" % makeXOXO(inStruct,'xoxo')<br />
return s.encode('utf-8')<br />
else:<br />
return makeXOXO(inStruct,'xoxo').encode('utf-8')<br />
<br />
import sys<br />
<br />
def fromXOXO(html):<br />
parser = xoxoParser()<br />
parser.feed(unicode(html,'utf-8'))<br />
#print >>sys.stderr, parser.structs<br />
structs=[struct for struct in parser.structs if struct]<br />
#print >>sys.stderr, structs<br />
while (len(structs) ==1 and type(structs)==type([1,])):<br />
structs=structs[0]<br />
return structs<br />
<br />
# Allow direct invocation<br />
# Read HTML from URL, parse into data structures, then re-output<br />
<br />
if __name__ == "__main__":<br />
if len(sys.argv) < 2: raise SystemExit("Usage: "+sys.argv[0]+" url\n"+__doc__)<br />
url=sys.argv[1]<br />
file = urllib.urlopen(url)<br />
html=file.read(-1)<br />
file.close<br />
s=fromXOXO(html)<br />
p=toXOXO(s,True)<br />
print p<br />
<br />
</nowiki></pre><br />
<br />
== testxoxo.py ==<br />
<pre><nowiki><br />
# -*- coding: utf-8 -*-<br />
"""testxoxo.py <br />
Unit tests for xoxo.py<br />
This file tests the functions in xoxo.py <br />
The underlying model here is http://diveintopython.org/unit_testing/index.html <br />
<br />
run from command line with<br />
python testxoxo.py -v<br />
"""<br />
import xoxo<br />
reload(xoxo)<br />
import unittest<br />
<br />
class xoxoTestCases(unittest.TestCase):<br />
<br />
def testSimpleList(self):<br />
'''make a xoxo file from a list'''<br />
l = ['1','2','3']<br />
html = xoxo.toXOXO(l)<br />
self.assertEqual(html,'<ol class="xoxo"><li>1</li><li>2</li><li>3</li></ol>')<br />
def testNestedList(self):<br />
'''make a xoxo file from a list with a list in'''<br />
l = ['1',['2','3']]<br />
html = xoxo.toXOXO(l)<br />
self.assertEqual(html,'<ol class="xoxo"><li>1</li><li><ol><li>2</li><li>3</li></ol></li></ol>')<br />
<br />
def testDictionary(self):<br />
'''make a xoxo file from a dictionary'''<br />
d = {'test':'1','name':'Kevin'}<br />
html = xoxo.toXOXO(d)<br />
self.assertEqual(html,'<ol class="xoxo"><li><dl><dt>test</dt><dd>1</dd><dt>name</dt><dd>Kevin</dd></dl></li></ol>')<br />
<br />
def testSingleItem(self):<br />
'''make a xoxo file from a string'''<br />
l = "test"<br />
html = xoxo.toXOXO(l)<br />
self.assertEqual(html,'<ol class="xoxo"><li>test</li></ol>')<br />
<br />
def testWrapDiffers(self):<br />
'''make a xoxo file from a string with and without html wrapper and check they are different'''<br />
l = "test"<br />
html = xoxo.toXOXO(l)<br />
htmlwrap = xoxo.toXOXO(l,addHTMLWrapper=True)<br />
self.failIfEqual(html,htmlwrap)<br />
<br />
def testWrapSingleItem(self):<br />
'''make a wrapped xoxo file from a string'''<br />
l = "test"<br />
html = xoxo.toXOXO(l,addHTMLWrapper=True)<br />
self.assertEqual(html,'''<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN<br />
http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><br />
<html xmlns="http://www.w3.org/1999/xhtml"><head profile=""></head><body><ol class="xoxo"><li>test</li></ol></body></html>''')<br />
<br />
def testDictionaryRoundTrip(self):<br />
''' make a dictionary into a xoxo file and back again; check it is the same'''<br />
d = {'test':'1','name':'Kevin'}<br />
html = xoxo.toXOXO(d)<br />
newd = xoxo.fromXOXO(html)<br />
self.assertEqual(d,newd)<br />
<br />
def testListRoundTrip(self):<br />
''' make a list into a xoxo file and back again; check it is the same'''<br />
l = ['3','2','1']<br />
html = xoxo.toXOXO(l)<br />
newdl= xoxo.fromXOXO(html)<br />
self.assertEqual(l,newdl)<br />
def testListofDictsRoundTrip(self):<br />
''' make a list of Dicts into a xoxo file and back again; check it is the same'''<br />
l = ['3',{'a':'2'},{'b':'1','c':'4'}]<br />
html = xoxo.toXOXO(l)<br />
newdl= xoxo.fromXOXO(html)<br />
self.assertEqual(l,newdl)<br />
def testListofListsRoundTrip(self):<br />
''' make a list of Lists into a xoxo file and back again; check it is the same'''<br />
l = ['3',['a','2'],['b',['1',['c','4']]]]<br />
html = xoxo.toXOXO(l)<br />
newdl= xoxo.fromXOXO(html)<br />
self.assertEqual(l,newdl)<br />
def testDictofListsRoundTrip(self):<br />
''' make a dict with lists in into a xoxo file and back again; check it is the same'''<br />
d = {'test':['1','2'],<br />
'name':'Kevin',<br />
'nestlist':['a',['b','c']],<br />
'nestdict':{'e':'6','f':'7'}}<br />
html = xoxo.toXOXO(d)<br />
newd = xoxo.fromXOXO(html)<br />
self.assertEqual(d,newd)<br />
<br />
def testXOXOjunkInContainers(self):<br />
'''make sure text outside <li> etc is ignored'''<br />
d=xoxo.fromXOXO('<ol>bad<li><dl>worse<dt>good</dt><dd>buy</dd> now</dl></li></ol>')<br />
self.assertEqual(d,{'good': 'buy'})<br />
def testXOXOjunkInElements(self):<br />
'''make sure text within <li> but outside a subcontainer is ignored'''<br />
l=xoxo.fromXOXO('<ol><li>bad<dl><dt>good</dt><dd>buy</dd></dl>worse</li><li>bag<ol><li>OK</li></ol>fish</li></ol>')<br />
self.assertEqual(l,[{'good': 'buy'},['OK']])<br />
def testXOXOWithSpacesAndNewlines(self):<br />
'''unmung some xoxo with spaces in and check result is right'''<br />
xoxoSample= '''<ol class='xoxo'> <br />
<li><br />
<dl><br />
<dt>text</dt><br />
<dd>item 1</dd><br />
<dt>description</dt><br />
<dd> This item represents the main point we're trying to make.</dd><br />
<dt>url</dt><br />
<dd>http://example.com/more.xoxo</dd><br />
<dt>title</dt><br />
<dd>title of item 1</dd><br />
<dt>type</dt><br />
<dd>text/xml</dd><br />
<dt>rel</dt><br />
<dd>help</dd><br />
</dl><br />
</li><br />
</ol>'''<br />
d = xoxo.fromXOXO(xoxoSample)<br />
d2={'text':'item 1',<br />
'description':" This item represents the main point we're trying to make.",<br />
'url':'http://example.com/more.xoxo',<br />
'title':'title of item 1',<br />
'type':'text/xml',<br />
'rel':'help'<br />
}<br />
xoxoAgain = xoxo.toXOXO(d)<br />
self.assertEqual(d,d2)<br />
#this needs a smarter whitespace-sensitive comparison<br />
#self.assertEqual(xoxoSample,xoxoAgain)<br />
<br />
def testSpecialAttributeDecoding(self):<br />
'''unmung some xoxo with <a href=' rel= etc in and check result is right'''<br />
xoxoSample= '''<ol class='xoxo'> <br />
<li><br />
<dl><br />
<dt>text</dt><br />
<dd>item 1</dd><br />
<dt>url</dt><br />
<dd>http://example.com/more.xoxo</dd><br />
<dt>title</dt><br />
<dd>title of item 1</dd><br />
<dt>type</dt><br />
<dd>text/xml</dd><br />
<dt>rel</dt><br />
<dd>help</dd><br />
</dl><br />
</li><br />
</ol>'''<br />
d = xoxo.fromXOXO(xoxoSample)<br />
smartxoxoSample= '''<ol class='xoxo'> <br />
<li><a href="http://example.com/more.xoxo"<br />
title="title of item 1"<br />
type="text/xml"<br />
rel="help">item 1</a> <br />
<!-- note how the "text" property is simply the contents of the <a> element --><br />
</li><br />
</ol>'''<br />
d2 = xoxo.fromXOXO(smartxoxoSample)<br />
self.assertEqual(d,d2)<br />
def testSpecialAttributeAndDLDecoding(self):<br />
'''unmung some xoxo with <a href=' rel= etc in plus a <dl> in the same item and check result is right'''<br />
xoxoSample= '''<ol class="xoxo"> <br />
<li><br />
<dl><br />
<dt>text</dt><br />
<dd>item 1</dd><br />
<dt>description</dt><br />
<dd> This item represents the main point we're trying to make.</dd><br />
<dt>url</dt><br />
<dd>http://example.com/more.xoxo</dd><br />
<dt>title</dt><br />
<dd>title of item 1</dd><br />
<dt>type</dt><br />
<dd>text/xml</dd><br />
<dt>rel</dt><br />
<dd>help</dd><br />
</dl><br />
</li><br />
</ol>'''<br />
d = xoxo.fromXOXO(xoxoSample)<br />
smartxoxoSample= '''<ol class="xoxo"> <br />
<li><a href="http://example.com/more.xoxo"<br />
title="title of item 1"<br />
type="text/xml"<br />
rel="help">item 1</a> <br />
<!-- note how the "text" property is simply the contents of the <a> element --><br />
<dl><br />
<dt>description</dt><br />
<dd> This item represents the main point we're trying to make.</dd><br />
</dl><br />
</li><br />
</ol>'''<br />
d2 = xoxo.fromXOXO(smartxoxoSample)<br />
self.assertEqual(d,d2)<br />
def testSpecialAttributeEncode(self):<br />
'''check it makes an <a href with a url parameter'''<br />
d={'url':'http://example.com/more.xoxo','title':'sample url','type':"text/xml",'rel':'help','text':'an example'}<br />
html=xoxo.toXOXO(d)<br />
expectedHTML= '<ol class="xoxo"><li><a href="http://example.com/more.xoxo" title="sample url" rel="help" type="text/xml" >an example</a></li></ol>' <br />
self.assertEqual(html,expectedHTML)<br />
<br />
def testSpecialAttributeRoundTripFull(self):<br />
'''check it makes an <a href with a url parameter'''<br />
d={'url':'http://example.com/more.xoxo','title':'sample url','type':"text/xml",'rel':'help','text':'an example'}<br />
html=xoxo.toXOXO(d)<br />
self.assertEqual(d,xoxo.fromXOXO(html))<br />
def testSpecialAttributeRoundTripNoText(self):<br />
'''check it makes an <a href with a url parameter and no text attribute'''<br />
d={'url':'http://example.com/more.xoxo','title':'sample url','type':"text/xml",'rel':'help'}<br />
html=xoxo.toXOXO(d)<br />
self.assertEqual(d,xoxo.fromXOXO(html))<br />
def testSpecialAttributeRoundTripNoTextOrTitle(self):<br />
'''check it makes an <a href with a url parameter and no text or title attribute'''<br />
d={'url':'http://example.com/more.xoxo'}<br />
html=xoxo.toXOXO(d)<br />
self.assertEqual(d,xoxo.fromXOXO(html))<br />
def testUnicodeRoundtrip(self):<br />
'''check unicode characters can go to xoxo and back'''<br />
src=unicode('Tantek Çelik and a snowman ?','utf-8')<br />
html = html=xoxo.toXOXO(src)<br />
self.assertEqual(src,xoxo.fromXOXO(html))<br />
if __name__ == "__main__":<br />
unittest.main()<br />
else:<br />
runner = unittest.TextTestRunner()<br />
suite = unittest.makeSuite(xoxoTestCases,'test')<br />
runner.run(suite)<br />
<br />
</nowiki></pre><br />
<br />
= Java =<br />
== XOXOWriter.java ==<br />
<pre><nowiki><br />
/*<br />
* Copyright 2005 Robert Sayre<br />
*<br />
* Licensed under the Apache License, Version 2.0 (the "License");<br />
* you may not use this file except in compliance with the License.<br />
* You may obtain a copy of the License at<br />
* <br />
* http://www.apache.org/licenses/LICENSE-2.0<br />
* <br />
* Unless required by applicable law or agreed to in writing, software<br />
* distributed under the License is distributed on an "AS IS" BASIS,<br />
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<br />
* See the License for the specific language governing permissions and<br />
* limitations under the License.<br />
*<br />
* Portions of this code are derived from the Apache-licensed Python XOXO<br />
* module by Kevin Marks. <http://microformats.org/wiki/xoxo-sample-code><br />
*/<br />
<br />
package org.atompub.draft.xoxo;<br />
<br />
import java.util.*;<br />
<br />
public class XOXOWriter {<br />
<br />
public String[] attrs = {"title","rel","type"};<br />
<br />
public String makeXOXO(List struct, String className){<br />
return makeXOXO(struct, className, 0, true);<br />
}<br />
<br />
public String makeXOXO(List struct, String className,<br />
boolean doNSDeclaration){<br />
return makeXOXO(struct, className, 0, doNSDeclaration);<br />
}<br />
<br />
public String makeXOXO(List struct){<br />
return makeXOXO(struct, "xoxo", 0, true);<br />
}<br />
<br />
public String makeXOXO(Object struct, int depth){<br />
return makeXOXO(struct, null, 0, false);<br />
}<br />
<br />
public String makeXOXO(Object struct, String className,<br />
int depth, boolean doNSDeclaration){<br />
if(struct == null) return "";<br />
StringBuffer sb = new StringBuffer();<br />
if(struct instanceof Object[]){<br />
struct = Arrays.asList((Object[]) struct);<br />
}<br />
if(struct instanceof List){<br />
sb.append("<ol");<br />
if(doNSDeclaration)<br />
sb.append(" xmlns=\"http://www.w3.org/1999/xhtml\"");<br />
if(className != null){<br />
sb.append(" class=\"");<br />
sb.append(className);<br />
sb.append("\"");<br />
}<br />
sb.append(">");<br />
}<br />
if(struct instanceof Map){<br />
Map d = new LinkedHashMap((Map) struct);<br />
if(d.containsKey("url")){<br />
sb.append("<a href=\"" + d.get("url") + "\" ");<br />
Object text;<br />
if(d.containsKey("text")){<br />
text = d.get("text");<br />
}else if(d.containsKey("title")){<br />
text = d.get("title");<br />
}else{<br />
text = d.get("url");<br />
}<br />
for(int i=0; i<attrs.length; i++){<br />
String xVal = makeXOXO(d.get(attrs[i]),depth+1);<br />
if(xVal != null && !xVal.equals("")){<br />
sb.append(attrs[i] + "=\"" + xVal + "\" ");<br />
}<br />
d.remove(attrs[i]);<br />
}<br />
sb.append(">" + makeXOXO(text, depth+1) + "</a>");<br />
d.remove("text");<br />
d.remove("url");<br />
}<br />
if(d.size() > 0){<br />
sb.append("<dl>");<br />
for(Iterator i = d.keySet().iterator(); i.hasNext();){<br />
Object k = i.next();<br />
String ddVal = makeXOXO(d.get(k),depth+1);<br />
sb.append("<dt>" + k + "</dt>");<br />
sb.append("<dd>" + ddVal + "</dd>");<br />
}<br />
sb.append("</dl>");<br />
}<br />
}else if(struct instanceof List){<br />
List l = (List) struct;<br />
for(Iterator i = l.iterator(); i.hasNext();){<br />
Object item = i.next();<br />
sb.append("<li>" + makeXOXO(item,depth+1) + "</li>");<br />
}<br />
sb.append("</ol>");<br />
}else{<br />
sb.append(struct);<br />
}<br />
return sb.toString();<br />
}<br />
<br />
public String toXOXO(List struct){<br />
return toXOXO(struct, false, null);<br />
}<br />
<br />
public String toXOXO(Object struct){<br />
List alist = new ArrayList();<br />
alist.add(struct);<br />
return toXOXO(alist);<br />
}<br />
<br />
public String toXOXO(Object struct,<br />
boolean addHTMLWrapper,<br />
String cssUrl){<br />
List alist = new ArrayList();<br />
alist.add(struct);<br />
return toXOXO(alist, addHTMLWrapper, cssUrl);<br />
}<br />
<br />
public String toXOXO(List struct,<br />
boolean addHTMLWrapper,<br />
String cssUrl){<br />
String startHTML = "<!DOCTYPE html PUBLIC \"-//W3C//DTD"<br />
+ "XHTML 1.0 Transitional//EN\n"<br />
+ "http://www.w3.org/TR/xhtml1/DTD/"<br />
+ "xhtml1-transitional.dtd\">"<br />
+ "<html xmlns=\"http://www.w3.org/1999/xhtml\">"<br />
+ "<head>";<br />
if(addHTMLWrapper){<br />
String s = startHTML;<br />
if(cssUrl != null){<br />
s += "<style type=\"text/css\">@import \""<br />
+ cssUrl + "\";</style>";<br />
}<br />
s += "</head><body>" + makeXOXO(struct, "xoxo", false)<br />
+ "</body></html>";<br />
return s;<br />
}else{<br />
return makeXOXO(struct, "xoxo");<br />
}<br />
}<br />
}<br />
</nowiki></pre><br />
<br />
== XOXOParser.java ==<br />
<pre><nowiki><br />
/*<br />
* Copyright 2005 Robert Sayre<br />
*<br />
* Licensed under the Apache License, Version 2.0 (the "License");<br />
* you may not use this file except in compliance with the License.<br />
* You may obtain a copy of the License at<br />
* <br />
* http://www.apache.org/licenses/LICENSE-2.0<br />
* <br />
* Unless required by applicable law or agreed to in writing, software<br />
* distributed under the License is distributed on an "AS IS" BASIS,<br />
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<br />
* See the License for the specific language governing permissions and<br />
* limitations under the License.<br />
*<br />
* Portions of this code are derived from the Apache-licensed Python XOXO<br />
* module by Kevin Marks. <http://microformats.org/wiki/xoxo-sample-code><br />
*/<br />
package org.atompub.draft.xoxo;<br />
<br />
import org.xml.sax.InputSource;<br />
import org.xml.sax.SAXException;<br />
import org.xml.sax.XMLReader;<br />
import org.xml.sax.Attributes;<br />
import org.xml.sax.helpers.XMLReaderFactory;<br />
import org.xml.sax.helpers.DefaultHandler;<br />
<br />
import java.util.*;<br />
import java.io.InputStream;<br />
import java.io.StringReader;<br />
import java.io.IOException;<br />
<br />
public class XOXOParser extends DefaultHandler {<br />
<br />
protected String XHTML_NS = "http://www.w3.org/1999/xhtml";<br />
protected List elStack;<br />
protected Map listEls;<br />
public List structs;<br />
public List xoStack;<br />
public List textStack;<br />
<br />
public XOXOParser() {<br />
reset();<br />
}<br />
<br />
protected void pushStruct(Object struct){<br />
if((struct instanceof Map) && (((Map) struct).size() > 0)<br />
&& (structs.get(structs.size()-1) instanceof Map)<br />
&& (((Map) struct).containsKey("url"))){<br />
// put back the <a>-made one for extra defs<br />
xoStack.add(structs.get(structs.size()-1));<br />
}else{<br />
structs.add(struct);<br />
xoStack.add(struct);<br />
}<br />
}<br />
<br />
public void startElement(String nsUri, String localName,<br />
String qName, Attributes atts){<br />
// bounce non-XHTML elements<br />
if(nsUri.equals(XHTML_NS)){<br />
elStack.add(localName);<br />
}else{<br />
elStack.add("foo");<br />
return;<br />
}<br />
<br />
if(localName.equals("a")){<br />
Map attmap = new LinkedHashMap();<br />
int len = atts.getLength();<br />
for(int i=0; i<len; i++){<br />
attmap.put(atts.getQName(i),atts.getValue(i));<br />
}<br />
if(attmap.containsKey("href")){<br />
attmap.put("url",attmap.get("href"));<br />
attmap.remove("href");<br />
}<br />
pushStruct(attmap);<br />
textStack.add("");<br />
}else if(localName.equals("dl")){<br />
pushStruct(new LinkedHashMap());<br />
}else if(localName.equals("ol")){<br />
pushStruct(new ArrayList());<br />
}else if(localName.equals("ul")){<br />
pushStruct(new ArrayList());<br />
}else if(localName.equals("li")){<br />
textStack.add("");<br />
}else if(localName.equals("dt")){<br />
textStack.add("");<br />
}else if(localName.equals("dd")){<br />
textStack.add("");<br />
}<br />
}<br />
<br />
public void endElement(String nsUri, String localName,<br />
String qName){<br />
elStack.remove(elStack.size()-1);<br />
// bounce non-XHTML elements<br />
if(nsUri != XHTML_NS){<br />
return;<br />
}<br />
<br />
if(localName.equals("a")){<br />
String val = (String) textStack.remove(textStack.size()-1);<br />
if (val.length() > 0){<br />
Map defs = (Map) xoStack.get(xoStack.size()-1);<br />
String defVal = (String) defs.get("title");<br />
if((defVal != null) && (val.equals(defVal))){<br />
val = "";<br />
}<br />
defVal = (String) defs.get("url");<br />
if((defVal != null) && (val.equals(defVal))){<br />
val = "";<br />
}<br />
if(val.length() > 0){<br />
defs.put("text",val);<br />
}<br />
}<br />
xoStack.remove(xoStack.size()-1);<br />
}else if(localName.equals("dl")){<br />
xoStack.remove(xoStack.size()-1);<br />
}else if(localName.equals("ol")){<br />
xoStack.remove(xoStack.size()-1);<br />
}else if(localName.equals("ul")){<br />
xoStack.remove(xoStack.size()-1);<br />
}else if(localName.equals("li")){<br />
Object val = textStack.remove(textStack.size()-1);<br />
List last = (List) xoStack.get(xoStack.size()-1);<br />
if(structs.get(structs.size()-1) != last){<br />
val = structs.remove(structs.size()-1);<br />
}<br />
last.add(val);<br />
}else if(localName.equals("dd")){<br />
Object val = textStack.remove(textStack.size()-1);<br />
Object key = textStack.remove(textStack.size()-1);<br />
Map last = (Map) xoStack.get(xoStack.size()-1);<br />
if(structs.get(structs.size()-1) != last){<br />
val = structs.remove(structs.size()-1);<br />
}<br />
last.put(key,val);<br />
}<br />
}<br />
<br />
public void characters(char[] ch, int start, int length){<br />
if((xoStack.size() > 0)<br />
&& (!listEls.containsKey(elStack.get(elStack.size()-1)))){<br />
String text = (String) textStack.get(textStack.size()-1);<br />
String test = new String(ch,start,length);<br />
textStack.set(textStack.size()-1,text+test);<br />
}<br />
}<br />
<br />
public Object parse(String s) throws SAXException, IOException{<br />
return parse(new InputSource(new StringReader(s)));<br />
}<br />
<br />
public Object parse(InputStream is) throws SAXException, IOException {<br />
return parse(new InputSource(is));<br />
}<br />
<br />
public Object parse(InputSource in) throws SAXException, IOException {<br />
XMLReader parser = XMLReaderFactory.createXMLReader();<br />
parser.setContentHandler(this);<br />
parser.parse(in);<br />
List returnList = new ArrayList();<br />
for(Iterator i = this.structs.iterator(); i.hasNext();){<br />
Object thing = i.next();<br />
if(thing != null){<br />
returnList.add(thing);<br />
}<br />
}<br />
while((returnList.size()==1)){<br />
if(returnList.get(0) instanceof List){<br />
returnList = (List) returnList.get(0);<br />
}else{<br />
reset();<br />
return returnList.get(0);<br />
}<br />
}<br />
reset();<br />
return returnList;<br />
}<br />
<br />
protected void reset(){<br />
elStack = new ArrayList();<br />
listEls = new HashMap();<br />
structs = new ArrayList();<br />
xoStack = new ArrayList();<br />
textStack = new ArrayList();<br />
listEls.put("ol","ol");<br />
listEls.put("ul","ul");<br />
listEls.put("dl","dl");<br />
}<br />
}<br />
<br />
</nowiki></pre><br />
<br />
== XOXOTest.java ==<br />
<pre><nowiki><br />
package org.atompub.draft.xoxo.tests;<br />
<br />
import junit.framework.TestSuite;<br />
import junit.framework.TestCase;<br />
import junit.textui.TestRunner;<br />
import org.atompub.draft.xoxo.XOXOWriter;<br />
import org.atompub.draft.xoxo.XOXOParser;<br />
<br />
import java.util.*;<br />
<br />
public class XOXOTest extends TestCase {<br />
<br />
public static void main(String[] args) {<br />
new TestRunner().doRun(new TestSuite(XOXOTest.class));<br />
}<br />
String XHTML_DEC = "xmlns=\"http://www.w3.org/1999/xhtml\" ";<br />
public String simpleListHTML = "<ol "<br />
+ XHTML_DEC<br />
+ "class=\"xoxo\">"<br />
+ "<li>1</li><li>2</li><li>3</li></ol>";<br />
<br />
public void testSimpleList(){<br />
String [] numbers = {"1","2","3"};<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(simpleListHTML,<br />
xoxo.toXOXO(Arrays.asList(numbers)));<br />
}<br />
<br />
public void testStringIntegerList(){<br />
Object[] numbers = {new Integer(1),"2","3"};<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(simpleListHTML,<br />
xoxo.toXOXO(Arrays.asList(numbers)));<br />
}<br />
<br />
public String nestedListHTML = "<ol "<br />
+ XHTML_DEC<br />
+ "class=\"xoxo\"><li>1</li><li>"<br />
+ "<ol><li>2</li><li>3</li></ol></li></ol>";<br />
<br />
public void testNestedList(){<br />
Object[] arr = {"2","3"};<br />
Object[] nested = {"1",Arrays.asList(arr)};<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(nestedListHTML,<br />
xoxo.toXOXO(Arrays.asList(nested)));<br />
}<br />
<br />
public void testNestedArray(){<br />
Object[] arr = {"2","3"};<br />
Object[] nested = {"1",arr};<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(nestedListHTML,<br />
xoxo.toXOXO(Arrays.asList(nested)));<br />
}<br />
<br />
public String dictHTML = "<ol "<br />
+ XHTML_DEC<br />
+ "class=\"xoxo\">"<br />
+ "<li><dl><dt>test</dt><dd>1</dd><dt>name</dt>"<br />
+ "<dd>Kevin</dd></dl></li></ol>";<br />
<br />
public void testDictionary(){<br />
Map dict = new LinkedHashMap();<br />
dict.put("test", new Integer(1));<br />
dict.put("name", "Kevin");<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(dictHTML,<br />
xoxo.toXOXO(dict));<br />
}<br />
<br />
public String singleHTML = "<ol "<br />
+ XHTML_DEC<br />
+ "class=\"xoxo\">"<br />
+ "<li>test</li></ol>";<br />
<br />
public void testSingleItem(){<br />
String item = "test";<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(singleHTML,<br />
xoxo.toXOXO(item));<br />
}<br />
<br />
public void testWrapDiffers(){<br />
String item = "test";<br />
XOXOWriter xoxo = new XOXOWriter();<br />
String nowrap = xoxo.toXOXO(item);<br />
Object[] itemArr = {item};<br />
String wrap = xoxo.toXOXO(Arrays.asList(itemArr),true,null);<br />
assertFalse(wrap.equals(nowrap));<br />
}<br />
<br />
String startHTML = "<!DOCTYPE html PUBLIC \"-//W3C//DTD"<br />
+ "XHTML 1.0 Transitional//EN\n"<br />
+ "http://www.w3.org/TR/xhtml1/DTD/"<br />
+ "xhtml1-transitional.dtd\">"<br />
+ "<html xmlns=\"http://www.w3.org/1999/xhtml\">"<br />
+ "<head></head><body>";<br />
public String singleWrapHTML = "<ol "<br />
+ "class=\"xoxo\">"<br />
+ "<li>test</li></ol>";<br />
public String endHTML = "</body></html>";<br />
<br />
public void testWrapSingleItem(){<br />
String item = "test";<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(startHTML + singleWrapHTML + endHTML,<br />
xoxo.toXOXO(item,true,null));<br />
}<br />
<br />
public void testXOXOParser(){<br />
XOXOParser parser = new XOXOParser();<br />
try{<br />
parser.parse(dictHTML);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testDictRoundTrip(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("test", "1");<br />
dict.put("name", "Kevin");<br />
String html = xoxo.toXOXO(dict);<br />
try{<br />
Object newDict = parser.parse(html);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testListRoundTrip(){<br />
Object[] obj = {"1","2","3"};<br />
List testList = Arrays.asList(obj);<br />
XOXOWriter xoxo = new XOXOWriter();<br />
String html = xoxo.toXOXO(testList);<br />
XOXOParser parser = new XOXOParser();<br />
try{<br />
Object newList = parser.parse(html);<br />
assertEquals(testList,newList);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testListOfDictsRoundTrip(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("test", "1");<br />
dict.put("name", "Kevin");<br />
Map dict2 = new LinkedHashMap();<br />
dict2.put("one", "two");<br />
dict2.put("three", "four");<br />
dict2.put("five", "six");<br />
Object[] obj = {"1",dict,dict2};<br />
List testList = Arrays.asList(obj);<br />
String html = xoxo.toXOXO(testList);<br />
try{<br />
Object newList = parser.parse(html);<br />
assertEquals(testList,newList);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testListOfListsRoundTrip(){<br />
Object[] list1 = {"1","2","3"};<br />
Object[] list2 = {"4","5","6", Arrays.asList(list1)};<br />
Object[] list3 = {"7", Arrays.asList(list2)};<br />
Object[] list4 = {"8", Arrays.asList(list3)};<br />
List testList = Arrays.asList(list4);<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
String html = xoxo.toXOXO(testList);<br />
try{<br />
Object newList = parser.parse(html);<br />
assertEquals(testList,newList);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testDictOfListsRoundTrip(){<br />
Object[] list1 = {"1","2","3"};<br />
Object[] list2 = {"4","5","6"};<br />
Object[] list3 = {"7"};<br />
Object[] list4 = {"8", "9"};<br />
Map dict = new LinkedHashMap();<br />
dict.put("foo", Arrays.asList(list1));<br />
dict.put("bar", Arrays.asList(list2));<br />
dict.put("baz", Arrays.asList(list3));<br />
dict.put("qux", Arrays.asList(list4));<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
String html = xoxo.toXOXO(dict);<br />
try{<br />
Object newDict = parser.parse(html);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public String junkXOXO = "<ol "<br />
+ XHTML_DEC<br />
+ "class=\"xoxo\">"<br />
+ "bad<li><dl>worse<dt>good</dt><dd>buy</dd> now</dl></li></ol>";<br />
<br />
public void testXOXOJunkInContainers(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("good","buy");<br />
try{<br />
Object newDict = parser.parse(junkXOXO);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public String junkElementXOXO = "<ol "<br />
+ XHTML_DEC<br />
+ "><li>bad<dl><dt>good</dt><dd>buy</dd></dl>"<br />
+ "worse</li><li>bag<ol><li>OK</li></ol>fish</li></ol>";<br />
<br />
public void testXOXOjunkInElements(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("good","buy");<br />
Object[] ok = {"OK"};<br />
Object[] obj ={dict, Arrays.asList(ok)};<br />
List testList = Arrays.asList(obj);<br />
try{<br />
Object newList = parser.parse(junkElementXOXO);<br />
assertEquals(testList,newList);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public String xoxoSpacesNewlines = "<ol " + XHTML_DEC +<br />
" class='xoxo'> \n" +<br />
" <li>\n" +<br />
" <dl>\n" +<br />
" <dt>text</dt>\n" +<br />
" <dd>item 1</dd>\n" +<br />
" <dt>description</dt>\n" +<br />
" <dd> This item represents the main" +<br />
" point we're trying to make.</dd>\n" +<br />
" <dt>url</dt>\n" +<br />
" <dd>http://example.com/more.xoxo</dd>\n" +<br />
" <dt>title</dt>\n" +<br />
" <dd>title of item 1</dd>\n" +<br />
" <dt>type</dt>\n" +<br />
" <dd>text/xml</dd>\n" +<br />
" <dt>rel</dt>\n" +<br />
" <dd>help</dd>\n" +<br />
" </dl>\n" +<br />
" </li>\n" +<br />
"</ol>";<br />
<br />
public void testXOXOWithSpacesAndNewlines(){<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("text","item 1");<br />
dict.put("description"," This item represents the main" +<br />
" point we're trying to make.");<br />
dict.put("url","http://example.com/more.xoxo");<br />
dict.put("title","title of item 1");<br />
dict.put("type","text/xml");<br />
dict.put("rel","help");<br />
try{<br />
Object newDict = parser.parse(xoxoSpacesNewlines);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public String xoxoSample = "<ol " + XHTML_DEC +<br />
" class='xoxo'> \n" +<br />
" <li>\n" +<br />
" <dl>\n" +<br />
" <dt>text</dt>\n" +<br />
" <dd>item 1</dd>\n" +<br />
" <dt>url</dt>\n" +<br />
" <dd>http://example.com/more.xoxo</dd>\n" +<br />
" <dt>title</dt>\n" +<br />
" <dd>title of item 1</dd>\n" +<br />
" <dt>type</dt>\n" +<br />
" <dd>text/xml</dd>\n" +<br />
" <dt>rel</dt>\n" +<br />
" <dd>help</dd>\n" +<br />
" </dl>\n" +<br />
" </li>\n" +<br />
"</ol>";<br />
<br />
public String smartXOXOSample = "<ol " + XHTML_DEC +<br />
"class=\"xoxo\"> \n" +<br />
" <li><a href=\"http://example.com/more.xoxo\"\n" +<br />
" title=\"title of item 1\"\n" +<br />
" type=\"text/xml\"\n" +<br />
" rel=\"help\">item 1</a> \n" +<br />
"<!-- note how the \"text\" property is simply" +<br />
" the contents of the <a> element -->\n" +<br />
" </li>\n" +<br />
"</ol>";<br />
<br />
public void testSpecialAttributeDecoding(){<br />
XOXOParser parser = new XOXOParser();<br />
try{<br />
Object xoxoDict = parser.parse(xoxoSample);<br />
Object xoxoDict2 = parser.parse(smartXOXOSample);<br />
assertEquals(xoxoDict,xoxoDict2);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public String specialAttrHTML = "<ol " + XHTML_DEC +<br />
"class=\"xoxo\">" +<br />
"<li><a href=\"http://example.com/more.xoxo\" title=\"sample url\" " +<br />
"rel=\"help\" type=\"text/xml\" >an example</a></li></ol>";<br />
<br />
public void testSpecialAttributeEncode(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
Map dict = new LinkedHashMap();<br />
dict.put("url","http://example.com/more.xoxo");<br />
dict.put("title","sample url");<br />
dict.put("type","text/xml");<br />
dict.put("rel","help");<br />
dict.put("text","an example");<br />
String html = xoxo.toXOXO(dict);<br />
assertEquals(specialAttrHTML,html);<br />
}<br />
<br />
public void testSpecialAttributeRoundTripFull(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("url","http://example.com/more.xoxo");<br />
dict.put("title","sample url");<br />
dict.put("type","text/xml");<br />
dict.put("rel","help");<br />
dict.put("text","an example");<br />
String html = xoxo.toXOXO(dict);<br />
try{<br />
Object newDict = parser.parse(html);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testSpecialAttributeRoundTripNoText(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("url","http://example.com/more.xoxo");<br />
dict.put("title","sample url");<br />
dict.put("type","text/xml");<br />
dict.put("rel","help");<br />
String html = xoxo.toXOXO(dict);<br />
try{<br />
Object newDict = parser.parse(html);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testSpecialAttributeRoundTripNoTextOrTitle(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("url","http://example.com/more.xoxo");<br />
dict.put("type","text/xml");<br />
dict.put("rel","help");<br />
String html = xoxo.toXOXO(dict);<br />
try{<br />
Object newDict = parser.parse(html);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testUnicodeRoundTrip(){<br />
String s = "Tantek Çelik and a snowman ?";<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
String html = xoxo.toXOXO(s);<br />
try{<br />
Object newString = parser.parse(html);<br />
assertEquals(s,newString);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
}<br />
<br />
</nowiki></pre></div>
RobertSayre
http://microformats.org/wiki/index.php?title=xoxo-sample-code&diff=2502
xoxo-sample-code
2005-10-30T19:32:00Z
<p>RobertSayre: /* XOXOWriter.java */</p>
<hr />
<div>= XOXO Sample Code =<br />
<br />
A whole bunch of open source ([http://creativecommons.org/licenses/by/2.0/ CC-by-2.0], [http://www.apache.org/licenses/LICENSE-2.0 Apache 2.0]) sample code to read and write [[xoxo]] files in Python and Java (with Perl, PHP, ... to follow).<br />
= Python =<br />
== xoxo.py ==<br />
<pre><nowiki><br />
# -*- coding: utf-8 -*-<br />
"""xoxo.py - a utility module for transforming to and from the XHTMLOutlines format XOXO<br />
toXOXO takes a Python datastructure (tuples, lists or dictionaries, arbitrarily nested) and returns a XOXO representation of it.<br />
fromXOXO parses an XHTML file for a xoxo list and returns the structure<br />
"""<br />
__version__ = "0.8"<br />
__date__ = "2004-10-05"<br />
__author__ = "Kevin Marks <kmarks@technorati.com>"<br />
__copyright__ = "Copyright 2004, Kevin marks & Technorati"<br />
__license__ = "http://creativecommons.org/licenses/by/2.0/ CC-by-2.0], [http://www.apache.org/licenses/LICENSE-2.0 Apache 2.0"<br />
__credits__ = """Tantek Çelik and Mark Pilgrim for data structure"""<br />
__history__ = """<br />
TODO: add <title> tag<br />
TODO: add a proper profile link<br />
0.8 work in unicode then render to utf-8<br />
0.7 initial encoding support - just utf-8 for now<br />
0.6 support the special behaviour for url properties to/from <a><br />
0.5 fix some awkward side effects of whitespace and text outside our expected tags; simplify writing code<br />
0.4 add correct XHTML headers so it validates<br />
0.3 read/write version; fixed invlaid nested list generation;<br />
0.1 first write-only version<br />
"""<br />
<br />
try:<br />
True, False<br />
except NameError:<br />
True, False = not not 1, not 1<br />
containerTags={'ol':False,'ul':False,'dl':False}<br />
import sgmllib, urllib, urlparse, re<br />
def makeXOXO(struct,className=None,depth=0):<br />
s=u''<br />
if isinstance(struct,list) or isinstance(struct,tuple):<br />
if className:<br />
s += u'<ol class="%s">' % className<br />
else:<br />
s+= u"<ol>"<br />
if isinstance(struct,dict):<br />
d=struct.copy()<br />
if d.has_key('url'):<br />
s+=u'<a href="%s" ' % d['url']<br />
text = d.get('text',d.get('title',d['url']))<br />
for attr in ('title','rel','type'):<br />
if d.has_key(attr):<br />
xVal = makeXOXO(d[attr],None,depth+1)<br />
s +=u'%s="%s" ' % (attr,xVal)<br />
del d[attr]<br />
s +=u'>%s</a>' % makeXOXO(text,None,depth+1)<br />
if d.has_key('text'):<br />
del d['text']<br />
del d['url']<br />
if len(d):<br />
s +=u"<dl>"<br />
for key,value in d.items():<br />
xVal = makeXOXO(value,None,depth+1)<br />
s+= u'<dt>%s</dt><dd>%s</dd>' % (key, xVal)<br />
s +=u"</dl>"<br />
elif type(struct) ==type((1,))or type(struct) ==type([1,]):<br />
for item in struct:<br />
s+=u"<li>" + makeXOXO(item,None,depth+1)+"</li>"<br />
s +=u"</ol>"<br />
elif type(struct) == type(u'unicode'):<br />
s+=struct<br />
else:<br />
if not type(struct)==type(' '):<br />
struct=str(struct)<br />
try:<br />
s+=unicode(struct,'utf-8')<br />
except:<br />
s+=unicode(struct,'windows_1252')<br />
return s<br />
class xoxoParser(sgmllib.SGMLParser):<br />
def __init__(self):<br />
sgmllib.SGMLParser.__init__(self)<br />
self.structs=[]<br />
self.xostack=[]<br />
self.textstack=['']<br />
def normalize_attrs(self, attrs):<br />
attrs = [(k.lower(), sgmllib.charref.sub(lambda m: chr(int(m.groups()[0])), v).strip()) for k, v in attrs]<br />
attrs = [(k, k in ('rel','type') and v.lower() or v) for k, v in attrs]<br />
return attrs<br />
def pushStruct(self,struct):<br />
if type(struct) == type({}) and len(struct)==0 and len(self.structs) and type(self.structs[-1]) == type({}) and self.structs[-1].has_key('url'):<br />
self.xostack.append(self.structs[-1]) # put back the <a>-made one for extra def's<br />
else:<br />
self.structs.append(struct)<br />
self.xostack.append(self.structs[-1])<br />
def start_a(self,attrs):<br />
attrsD = dict(self.normalize_attrs(attrs))<br />
attrsD['url']= attrsD.get('href','')<br />
del attrsD['href']<br />
self.pushStruct(attrsD)<br />
self.textstack.append('')<br />
def end_a(self):<br />
val = self.textstack.pop()<br />
if val: <br />
if self.xostack[-1].get('title','') == val:<br />
val=''<br />
if self.xostack[-1]['url'] == val:<br />
val=''<br />
if val:<br />
self.xostack[-1]['text']=val<br />
self.xostack.pop()<br />
def start_dl(self,attrs):<br />
self.pushStruct({})<br />
def end_dl(self):<br />
self.xostack.pop()<br />
def start_ol(self,attrs):<br />
self.pushStruct([])<br />
def end_ol(self):<br />
self.xostack.pop()<br />
def start_ul(self,attrs):<br />
self.pushStruct([])<br />
def end_ul(self):<br />
self.xostack.pop()<br />
def start_li(self,attrs):<br />
self.textstack.append('')<br />
def end_li(self):<br />
val = self.textstack.pop()<br />
if self.structs[-1] != self.xostack[-1]:<br />
val = self.structs.pop()<br />
self.xostack[-1].append(val)<br />
def start_dt(self,attrs):<br />
self.textstack.append('')<br />
def end_dt(self):<br />
pass<br />
def start_dd(self,attrs):<br />
self.textstack.append('')<br />
def end_dd(self):<br />
val = self.textstack.pop()<br />
key = self.textstack.pop()<br />
if self.structs[-1] != self.xostack[-1]:<br />
val = self.structs.pop()<br />
self.xostack[-1][key]=val<br />
def handle_data(self, text):<br />
if len(self.stack) and containerTags.get(self.stack[-1],True): #skip text not within an element<br />
self.textstack[-1] += text<br />
def toXOXO(struct,addHTMLWrapper=False,cssUrl=''):<br />
if type(struct) ==type((1,))or type(struct) ==type([1,]):<br />
inStruct = struct<br />
else:<br />
inStruct = [struct]<br />
if addHTMLWrapper:<br />
s= '''<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN<br />
http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><br />
<html xmlns="http://www.w3.org/1999/xhtml"><head profile=""><meta http-equiv="Content-Type" content="text/html; charset=utf-8" />'''<br />
if cssUrl:<br />
s+='<style type="text/css" >@import "%s";</style>' % cssUrl<br />
s+="</head><body>%s</body></html>" % makeXOXO(inStruct,'xoxo')<br />
return s.encode('utf-8')<br />
else:<br />
return makeXOXO(inStruct,'xoxo').encode('utf-8')<br />
<br />
import sys<br />
<br />
def fromXOXO(html):<br />
parser = xoxoParser()<br />
parser.feed(unicode(html,'utf-8'))<br />
#print >>sys.stderr, parser.structs<br />
structs=[struct for struct in parser.structs if struct]<br />
#print >>sys.stderr, structs<br />
while (len(structs) ==1 and type(structs)==type([1,])):<br />
structs=structs[0]<br />
return structs<br />
<br />
# Allow direct invocation<br />
# Read HTML from URL, parse into data structures, then re-output<br />
<br />
if __name__ == "__main__":<br />
if len(sys.argv) < 2: raise SystemExit("Usage: "+sys.argv[0]+" url\n"+__doc__)<br />
url=sys.argv[1]<br />
file = urllib.urlopen(url)<br />
html=file.read(-1)<br />
file.close<br />
s=fromXOXO(html)<br />
p=toXOXO(s,True)<br />
print p<br />
<br />
</nowiki></pre><br />
<br />
== testxoxo.py ==<br />
<pre><nowiki><br />
# -*- coding: utf-8 -*-<br />
"""testxoxo.py <br />
Unit tests for xoxo.py<br />
This file tests the functions in xoxo.py <br />
The underlying model here is http://diveintopython.org/unit_testing/index.html <br />
<br />
run from command line with<br />
python testxoxo.py -v<br />
"""<br />
import xoxo<br />
reload(xoxo)<br />
import unittest<br />
<br />
class xoxoTestCases(unittest.TestCase):<br />
<br />
def testSimpleList(self):<br />
'''make a xoxo file from a list'''<br />
l = ['1','2','3']<br />
html = xoxo.toXOXO(l)<br />
self.assertEqual(html,'<ol class="xoxo"><li>1</li><li>2</li><li>3</li></ol>')<br />
def testNestedList(self):<br />
'''make a xoxo file from a list with a list in'''<br />
l = ['1',['2','3']]<br />
html = xoxo.toXOXO(l)<br />
self.assertEqual(html,'<ol class="xoxo"><li>1</li><li><ol><li>2</li><li>3</li></ol></li></ol>')<br />
<br />
def testDictionary(self):<br />
'''make a xoxo file from a dictionary'''<br />
d = {'test':'1','name':'Kevin'}<br />
html = xoxo.toXOXO(d)<br />
self.assertEqual(html,'<ol class="xoxo"><li><dl><dt>test</dt><dd>1</dd><dt>name</dt><dd>Kevin</dd></dl></li></ol>')<br />
<br />
def testSingleItem(self):<br />
'''make a xoxo file from a string'''<br />
l = "test"<br />
html = xoxo.toXOXO(l)<br />
self.assertEqual(html,'<ol class="xoxo"><li>test</li></ol>')<br />
<br />
def testWrapDiffers(self):<br />
'''make a xoxo file from a string with and without html wrapper and check they are different'''<br />
l = "test"<br />
html = xoxo.toXOXO(l)<br />
htmlwrap = xoxo.toXOXO(l,addHTMLWrapper=True)<br />
self.failIfEqual(html,htmlwrap)<br />
<br />
def testWrapSingleItem(self):<br />
'''make a wrapped xoxo file from a string'''<br />
l = "test"<br />
html = xoxo.toXOXO(l,addHTMLWrapper=True)<br />
self.assertEqual(html,'''<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN<br />
http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><br />
<html xmlns="http://www.w3.org/1999/xhtml"><head profile=""></head><body><ol class="xoxo"><li>test</li></ol></body></html>''')<br />
<br />
def testDictionaryRoundTrip(self):<br />
''' make a dictionary into a xoxo file and back again; check it is the same'''<br />
d = {'test':'1','name':'Kevin'}<br />
html = xoxo.toXOXO(d)<br />
newd = xoxo.fromXOXO(html)<br />
self.assertEqual(d,newd)<br />
<br />
def testListRoundTrip(self):<br />
''' make a list into a xoxo file and back again; check it is the same'''<br />
l = ['3','2','1']<br />
html = xoxo.toXOXO(l)<br />
newdl= xoxo.fromXOXO(html)<br />
self.assertEqual(l,newdl)<br />
def testListofDictsRoundTrip(self):<br />
''' make a list of Dicts into a xoxo file and back again; check it is the same'''<br />
l = ['3',{'a':'2'},{'b':'1','c':'4'}]<br />
html = xoxo.toXOXO(l)<br />
newdl= xoxo.fromXOXO(html)<br />
self.assertEqual(l,newdl)<br />
def testListofListsRoundTrip(self):<br />
''' make a list of Lists into a xoxo file and back again; check it is the same'''<br />
l = ['3',['a','2'],['b',['1',['c','4']]]]<br />
html = xoxo.toXOXO(l)<br />
newdl= xoxo.fromXOXO(html)<br />
self.assertEqual(l,newdl)<br />
def testDictofListsRoundTrip(self):<br />
''' make a dict with lists in into a xoxo file and back again; check it is the same'''<br />
d = {'test':['1','2'],<br />
'name':'Kevin',<br />
'nestlist':['a',['b','c']],<br />
'nestdict':{'e':'6','f':'7'}}<br />
html = xoxo.toXOXO(d)<br />
newd = xoxo.fromXOXO(html)<br />
self.assertEqual(d,newd)<br />
<br />
def testXOXOjunkInContainers(self):<br />
'''make sure text outside <li> etc is ignored'''<br />
d=xoxo.fromXOXO('<ol>bad<li><dl>worse<dt>good</dt><dd>buy</dd> now</dl></li></ol>')<br />
self.assertEqual(d,{'good': 'buy'})<br />
def testXOXOjunkInElements(self):<br />
'''make sure text within <li> but outside a subcontainer is ignored'''<br />
l=xoxo.fromXOXO('<ol><li>bad<dl><dt>good</dt><dd>buy</dd></dl>worse</li><li>bag<ol><li>OK</li></ol>fish</li></ol>')<br />
self.assertEqual(l,[{'good': 'buy'},['OK']])<br />
def testXOXOWithSpacesAndNewlines(self):<br />
'''unmung some xoxo with spaces in and check result is right'''<br />
xoxoSample= '''<ol class='xoxo'> <br />
<li><br />
<dl><br />
<dt>text</dt><br />
<dd>item 1</dd><br />
<dt>description</dt><br />
<dd> This item represents the main point we're trying to make.</dd><br />
<dt>url</dt><br />
<dd>http://example.com/more.xoxo</dd><br />
<dt>title</dt><br />
<dd>title of item 1</dd><br />
<dt>type</dt><br />
<dd>text/xml</dd><br />
<dt>rel</dt><br />
<dd>help</dd><br />
</dl><br />
</li><br />
</ol>'''<br />
d = xoxo.fromXOXO(xoxoSample)<br />
d2={'text':'item 1',<br />
'description':" This item represents the main point we're trying to make.",<br />
'url':'http://example.com/more.xoxo',<br />
'title':'title of item 1',<br />
'type':'text/xml',<br />
'rel':'help'<br />
}<br />
xoxoAgain = xoxo.toXOXO(d)<br />
self.assertEqual(d,d2)<br />
#this needs a smarter whitespace-sensitive comparison<br />
#self.assertEqual(xoxoSample,xoxoAgain)<br />
<br />
def testSpecialAttributeDecoding(self):<br />
'''unmung some xoxo with <a href=' rel= etc in and check result is right'''<br />
xoxoSample= '''<ol class='xoxo'> <br />
<li><br />
<dl><br />
<dt>text</dt><br />
<dd>item 1</dd><br />
<dt>url</dt><br />
<dd>http://example.com/more.xoxo</dd><br />
<dt>title</dt><br />
<dd>title of item 1</dd><br />
<dt>type</dt><br />
<dd>text/xml</dd><br />
<dt>rel</dt><br />
<dd>help</dd><br />
</dl><br />
</li><br />
</ol>'''<br />
d = xoxo.fromXOXO(xoxoSample)<br />
smartxoxoSample= '''<ol class='xoxo'> <br />
<li><a href="http://example.com/more.xoxo"<br />
title="title of item 1"<br />
type="text/xml"<br />
rel="help">item 1</a> <br />
<!-- note how the "text" property is simply the contents of the <a> element --><br />
</li><br />
</ol>'''<br />
d2 = xoxo.fromXOXO(smartxoxoSample)<br />
self.assertEqual(d,d2)<br />
def testSpecialAttributeAndDLDecoding(self):<br />
'''unmung some xoxo with <a href=' rel= etc in plus a <dl> in the same item and check result is right'''<br />
xoxoSample= '''<ol class="xoxo"> <br />
<li><br />
<dl><br />
<dt>text</dt><br />
<dd>item 1</dd><br />
<dt>description</dt><br />
<dd> This item represents the main point we're trying to make.</dd><br />
<dt>url</dt><br />
<dd>http://example.com/more.xoxo</dd><br />
<dt>title</dt><br />
<dd>title of item 1</dd><br />
<dt>type</dt><br />
<dd>text/xml</dd><br />
<dt>rel</dt><br />
<dd>help</dd><br />
</dl><br />
</li><br />
</ol>'''<br />
d = xoxo.fromXOXO(xoxoSample)<br />
smartxoxoSample= '''<ol class="xoxo"> <br />
<li><a href="http://example.com/more.xoxo"<br />
title="title of item 1"<br />
type="text/xml"<br />
rel="help">item 1</a> <br />
<!-- note how the "text" property is simply the contents of the <a> element --><br />
<dl><br />
<dt>description</dt><br />
<dd> This item represents the main point we're trying to make.</dd><br />
</dl><br />
</li><br />
</ol>'''<br />
d2 = xoxo.fromXOXO(smartxoxoSample)<br />
self.assertEqual(d,d2)<br />
def testSpecialAttributeEncode(self):<br />
'''check it makes an <a href with a url parameter'''<br />
d={'url':'http://example.com/more.xoxo','title':'sample url','type':"text/xml",'rel':'help','text':'an example'}<br />
html=xoxo.toXOXO(d)<br />
expectedHTML= '<ol class="xoxo"><li><a href="http://example.com/more.xoxo" title="sample url" rel="help" type="text/xml" >an example</a></li></ol>' <br />
self.assertEqual(html,expectedHTML)<br />
<br />
def testSpecialAttributeRoundTripFull(self):<br />
'''check it makes an <a href with a url parameter'''<br />
d={'url':'http://example.com/more.xoxo','title':'sample url','type':"text/xml",'rel':'help','text':'an example'}<br />
html=xoxo.toXOXO(d)<br />
self.assertEqual(d,xoxo.fromXOXO(html))<br />
def testSpecialAttributeRoundTripNoText(self):<br />
'''check it makes an <a href with a url parameter and no text attribute'''<br />
d={'url':'http://example.com/more.xoxo','title':'sample url','type':"text/xml",'rel':'help'}<br />
html=xoxo.toXOXO(d)<br />
self.assertEqual(d,xoxo.fromXOXO(html))<br />
def testSpecialAttributeRoundTripNoTextOrTitle(self):<br />
'''check it makes an <a href with a url parameter and no text or title attribute'''<br />
d={'url':'http://example.com/more.xoxo'}<br />
html=xoxo.toXOXO(d)<br />
self.assertEqual(d,xoxo.fromXOXO(html))<br />
def testUnicodeRoundtrip(self):<br />
'''check unicode characters can go to xoxo and back'''<br />
src=unicode('Tantek Çelik and a snowman ?','utf-8')<br />
html = html=xoxo.toXOXO(src)<br />
self.assertEqual(src,xoxo.fromXOXO(html))<br />
if __name__ == "__main__":<br />
unittest.main()<br />
else:<br />
runner = unittest.TextTestRunner()<br />
suite = unittest.makeSuite(xoxoTestCases,'test')<br />
runner.run(suite)<br />
<br />
</nowiki></pre><br />
<br />
= Java =<br />
== XOXOWriter.java ==<br />
<pre><nowiki><br />
/*<br />
* Copyright 2005 Robert Sayre<br />
*<br />
* Licensed under the Apache License, Version 2.0 (the "License");<br />
* you may not use this file except in compliance with the License.<br />
* You may obtain a copy of the License at<br />
* <br />
* http://www.apache.org/licenses/LICENSE-2.0<br />
* <br />
* Unless required by applicable law or agreed to in writing, software<br />
* distributed under the License is distributed on an "AS IS" BASIS,<br />
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<br />
* See the License for the specific language governing permissions and<br />
* limitations under the License.<br />
*<br />
* Portions of this code are derived from the Apache-licensed Python XOXO<br />
* module by Kevin Marks. <http://microformats.org/wiki/xoxo-sample-code><br />
*/<br />
<br />
package org.atompub.draft.xoxo;<br />
<br />
import java.util.*;<br />
<br />
public class XOXOWriter {<br />
<br />
public String[] attrs = {"title","rel","type"};<br />
<br />
public String makeXOXO(List struct, String className){<br />
return makeXOXO(struct, className, 0, true);<br />
}<br />
<br />
public String makeXOXO(List struct, String className,<br />
boolean doNSDeclaration){<br />
return makeXOXO(struct, className, 0, doNSDeclaration);<br />
}<br />
<br />
public String makeXOXO(List struct){<br />
return makeXOXO(struct, "xoxo", 0, true);<br />
}<br />
<br />
public String makeXOXO(Object struct, int depth){<br />
return makeXOXO(struct, null, 0, false);<br />
}<br />
<br />
public String makeXOXO(Object struct, String className,<br />
int depth, boolean doNSDeclaration){<br />
if(struct == null) return "";<br />
StringBuffer sb = new StringBuffer();<br />
if(struct instanceof Object[]){<br />
struct = Arrays.asList((Object[]) struct);<br />
}<br />
if(struct instanceof List){<br />
sb.append("<ol");<br />
if(doNSDeclaration)<br />
sb.append(" xmlns=\"http://www.w3.org/1999/xhtml\"");<br />
if(className != null){<br />
sb.append(" class=\"");<br />
sb.append(className);<br />
sb.append("\"");<br />
}<br />
sb.append(">");<br />
}<br />
if(struct instanceof Map){<br />
Map d = new LinkedHashMap((Map) struct);<br />
if(d.containsKey("url")){<br />
sb.append("<a href=\"" + d.get("url") + "\" ");<br />
Object text;<br />
if(d.containsKey("text")){<br />
text = d.get("text");<br />
}else if(d.containsKey("title")){<br />
text = d.get("title");<br />
}else{<br />
text = d.get("url");<br />
}<br />
for(int i=0; i<attrs.length; i++){<br />
String xVal = makeXOXO(d.get(attrs[i]),depth+1);<br />
if(xVal != null && !xVal.equals("")){<br />
sb.append(attrs[i] + "=\"" + xVal + "\" ");<br />
}<br />
d.remove(attrs[i]);<br />
}<br />
sb.append(">" + makeXOXO(text, depth+1) + "</a>");<br />
d.remove("text");<br />
d.remove("url");<br />
}<br />
if(d.size() > 0){<br />
sb.append("<dl>");<br />
for(Iterator i = d.keySet().iterator(); i.hasNext();){<br />
Object k = i.next();<br />
String ddVal = makeXOXO(d.get(k),depth+1);<br />
sb.append("<dt>" + k + "</dt>");<br />
sb.append("<dd>" + ddVal + "</dd>");<br />
}<br />
sb.append("</dl>");<br />
}<br />
}else if(struct instanceof List){<br />
List l = (List) struct;<br />
for(Iterator i = l.iterator(); i.hasNext();){<br />
Object item = i.next();<br />
sb.append("<li>" + makeXOXO(item,depth+1) + "</li>");<br />
}<br />
sb.append("</ol>");<br />
}else{<br />
sb.append(struct);<br />
}<br />
return sb.toString();<br />
}<br />
<br />
public String toXOXO(List struct){<br />
return toXOXO(struct, false, null);<br />
}<br />
<br />
public String toXOXO(Object struct){<br />
List alist = new ArrayList();<br />
alist.add(struct);<br />
return toXOXO(alist);<br />
}<br />
<br />
public String toXOXO(Object struct,<br />
boolean addHTMLWrapper,<br />
String cssUrl){<br />
List alist = new ArrayList();<br />
alist.add(struct);<br />
return toXOXO(alist, addHTMLWrapper, cssUrl);<br />
}<br />
<br />
public String toXOXO(List struct,<br />
boolean addHTMLWrapper,<br />
String cssUrl){<br />
String startHTML = "<!DOCTYPE html PUBLIC \"-//W3C//DTD"<br />
+ "XHTML 1.0 Transitional//EN\n"<br />
+ "http://www.w3.org/TR/xhtml1/DTD/"<br />
+ "xhtml1-transitional.dtd\">"<br />
+ "<html xmlns=\"http://www.w3.org/1999/xhtml\">"<br />
+ "<head>";<br />
if(addHTMLWrapper){<br />
String s = startHTML;<br />
if(cssUrl != null){<br />
s += "<style type=\"text/css\">@import \""<br />
+ cssUrl + "\";</style>";<br />
}<br />
s += "</head><body>" + makeXOXO(struct, "xoxo", false)<br />
+ "</body></html>";<br />
return s;<br />
}else{<br />
return makeXOXO(struct, "xoxo");<br />
}<br />
}<br />
}<br />
</nowiki></pre><br />
<br />
== XOXOParser.java ==<br />
<pre><nowiki><br />
package org.atompub.draft.xoxo;<br />
<br />
import org.xml.sax.InputSource;<br />
import org.xml.sax.SAXException;<br />
import org.xml.sax.XMLReader;<br />
import org.xml.sax.Attributes;<br />
import org.xml.sax.helpers.XMLReaderFactory;<br />
import org.xml.sax.helpers.DefaultHandler;<br />
<br />
import java.util.*;<br />
import java.io.InputStream;<br />
import java.io.StringReader;<br />
import java.io.IOException;<br />
<br />
public class XOXOParser extends DefaultHandler {<br />
<br />
protected String XHTML_NS = "http://www.w3.org/1999/xhtml";<br />
protected List elStack;<br />
protected Map listEls;<br />
public List structs;<br />
public List xoStack;<br />
public List textStack;<br />
<br />
public XOXOParser() {<br />
reset();<br />
}<br />
<br />
protected void pushStruct(Object struct){<br />
if((struct instanceof Map) && (((Map) struct).size() > 0)<br />
&& (structs.get(structs.size()-1) instanceof Map)<br />
&& (((Map) struct).containsKey("url"))){<br />
// put back the <a>-made one for extra defs<br />
xoStack.add(structs.get(structs.size()-1));<br />
}else{<br />
structs.add(struct);<br />
xoStack.add(struct);<br />
}<br />
}<br />
<br />
public void startElement(String nsUri, String localName,<br />
String qName, Attributes atts){<br />
// bounce non-XHTML elements<br />
if(nsUri.equals(XHTML_NS)){<br />
elStack.add(localName);<br />
}else{<br />
elStack.add("foo");<br />
return;<br />
}<br />
<br />
if(localName.equals("a")){<br />
Map attmap = new LinkedHashMap();<br />
int len = atts.getLength();<br />
for(int i=0; i<len; i++){<br />
attmap.put(atts.getQName(i),atts.getValue(i));<br />
}<br />
if(attmap.containsKey("href")){<br />
attmap.put("url",attmap.get("href"));<br />
attmap.remove("href");<br />
}<br />
pushStruct(attmap);<br />
textStack.add("");<br />
}else if(localName.equals("dl")){<br />
pushStruct(new LinkedHashMap());<br />
}else if(localName.equals("ol")){<br />
pushStruct(new ArrayList());<br />
}else if(localName.equals("ul")){<br />
pushStruct(new ArrayList());<br />
}else if(localName.equals("li")){<br />
textStack.add("");<br />
}else if(localName.equals("dt")){<br />
textStack.add("");<br />
}else if(localName.equals("dd")){<br />
textStack.add("");<br />
}<br />
}<br />
<br />
public void endElement(String nsUri, String localName,<br />
String qName){<br />
elStack.remove(elStack.size()-1);<br />
// bounce non-XHTML elements<br />
if(nsUri != XHTML_NS){<br />
return;<br />
}<br />
<br />
if(localName.equals("a")){<br />
String val = (String) textStack.remove(textStack.size()-1);<br />
if (val.length() > 0){<br />
Map defs = (Map) xoStack.get(xoStack.size()-1);<br />
String defVal = (String) defs.get("title");<br />
if((defVal != null) && (val.equals(defVal))){<br />
val = "";<br />
}<br />
defVal = (String) defs.get("url");<br />
if((defVal != null) && (val.equals(defVal))){<br />
val = "";<br />
}<br />
if(val.length() > 0){<br />
defs.put("text",val);<br />
}<br />
}<br />
xoStack.remove(xoStack.size()-1);<br />
}else if(localName.equals("dl")){<br />
xoStack.remove(xoStack.size()-1);<br />
}else if(localName.equals("ol")){<br />
xoStack.remove(xoStack.size()-1);<br />
}else if(localName.equals("ul")){<br />
xoStack.remove(xoStack.size()-1);<br />
}else if(localName.equals("li")){<br />
Object val = textStack.remove(textStack.size()-1);<br />
List last = (List) xoStack.get(xoStack.size()-1);<br />
if(structs.get(structs.size()-1) != last){<br />
val = structs.remove(structs.size()-1);<br />
}<br />
last.add(val);<br />
}else if(localName.equals("dd")){<br />
Object val = textStack.remove(textStack.size()-1);<br />
Object key = textStack.remove(textStack.size()-1);<br />
Map last = (Map) xoStack.get(xoStack.size()-1);<br />
if(structs.get(structs.size()-1) != last){<br />
val = structs.remove(structs.size()-1);<br />
}<br />
last.put(key,val);<br />
}<br />
}<br />
<br />
public void characters(char[] ch, int start, int length){<br />
if((xoStack.size() > 0)<br />
&& (!listEls.containsKey(elStack.get(elStack.size()-1)))){<br />
String text = (String) textStack.get(textStack.size()-1);<br />
String test = new String(ch,start,length);<br />
textStack.set(textStack.size()-1,text+test);<br />
}<br />
}<br />
<br />
public Object parse(String s) throws SAXException, IOException{<br />
return parse(new InputSource(new StringReader(s)));<br />
}<br />
<br />
public Object parse(InputStream is) throws SAXException, IOException {<br />
return parse(new InputSource(is));<br />
}<br />
<br />
public Object parse(InputSource in) throws SAXException, IOException {<br />
XMLReader parser = XMLReaderFactory.createXMLReader();<br />
parser.setContentHandler(this);<br />
parser.parse(in);<br />
List returnList = new ArrayList();<br />
for(Iterator i = this.structs.iterator(); i.hasNext();){<br />
Object thing = i.next();<br />
if(thing != null){<br />
returnList.add(thing);<br />
}<br />
}<br />
while((returnList.size()==1)){<br />
if(returnList.get(0) instanceof List){<br />
returnList = (List) returnList.get(0);<br />
}else{<br />
reset();<br />
return returnList.get(0);<br />
}<br />
}<br />
reset();<br />
return returnList;<br />
}<br />
<br />
protected void reset(){<br />
elStack = new ArrayList();<br />
listEls = new HashMap();<br />
structs = new ArrayList();<br />
xoStack = new ArrayList();<br />
textStack = new ArrayList();<br />
listEls.put("ol","ol");<br />
listEls.put("ul","ul");<br />
listEls.put("dl","dl");<br />
}<br />
}<br />
<br />
</nowiki></pre><br />
<br />
== XOXOTest.java ==<br />
<pre><nowiki><br />
package org.atompub.draft.xoxo.tests;<br />
<br />
import junit.framework.TestSuite;<br />
import junit.framework.TestCase;<br />
import junit.textui.TestRunner;<br />
import org.atompub.draft.xoxo.XOXOWriter;<br />
import org.atompub.draft.xoxo.XOXOParser;<br />
<br />
import java.util.*;<br />
<br />
public class XOXOTest extends TestCase {<br />
<br />
public static void main(String[] args) {<br />
new TestRunner().doRun(new TestSuite(XOXOTest.class));<br />
}<br />
String XHTML_DEC = "xmlns=\"http://www.w3.org/1999/xhtml\" ";<br />
public String simpleListHTML = "<ol "<br />
+ XHTML_DEC<br />
+ "class=\"xoxo\">"<br />
+ "<li>1</li><li>2</li><li>3</li></ol>";<br />
<br />
public void testSimpleList(){<br />
String [] numbers = {"1","2","3"};<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(simpleListHTML,<br />
xoxo.toXOXO(Arrays.asList(numbers)));<br />
}<br />
<br />
public void testStringIntegerList(){<br />
Object[] numbers = {new Integer(1),"2","3"};<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(simpleListHTML,<br />
xoxo.toXOXO(Arrays.asList(numbers)));<br />
}<br />
<br />
public String nestedListHTML = "<ol "<br />
+ XHTML_DEC<br />
+ "class=\"xoxo\"><li>1</li><li>"<br />
+ "<ol><li>2</li><li>3</li></ol></li></ol>";<br />
<br />
public void testNestedList(){<br />
Object[] arr = {"2","3"};<br />
Object[] nested = {"1",Arrays.asList(arr)};<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(nestedListHTML,<br />
xoxo.toXOXO(Arrays.asList(nested)));<br />
}<br />
<br />
public void testNestedArray(){<br />
Object[] arr = {"2","3"};<br />
Object[] nested = {"1",arr};<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(nestedListHTML,<br />
xoxo.toXOXO(Arrays.asList(nested)));<br />
}<br />
<br />
public String dictHTML = "<ol "<br />
+ XHTML_DEC<br />
+ "class=\"xoxo\">"<br />
+ "<li><dl><dt>test</dt><dd>1</dd><dt>name</dt>"<br />
+ "<dd>Kevin</dd></dl></li></ol>";<br />
<br />
public void testDictionary(){<br />
Map dict = new LinkedHashMap();<br />
dict.put("test", new Integer(1));<br />
dict.put("name", "Kevin");<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(dictHTML,<br />
xoxo.toXOXO(dict));<br />
}<br />
<br />
public String singleHTML = "<ol "<br />
+ XHTML_DEC<br />
+ "class=\"xoxo\">"<br />
+ "<li>test</li></ol>";<br />
<br />
public void testSingleItem(){<br />
String item = "test";<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(singleHTML,<br />
xoxo.toXOXO(item));<br />
}<br />
<br />
public void testWrapDiffers(){<br />
String item = "test";<br />
XOXOWriter xoxo = new XOXOWriter();<br />
String nowrap = xoxo.toXOXO(item);<br />
Object[] itemArr = {item};<br />
String wrap = xoxo.toXOXO(Arrays.asList(itemArr),true,null);<br />
assertFalse(wrap.equals(nowrap));<br />
}<br />
<br />
String startHTML = "<!DOCTYPE html PUBLIC \"-//W3C//DTD"<br />
+ "XHTML 1.0 Transitional//EN\n"<br />
+ "http://www.w3.org/TR/xhtml1/DTD/"<br />
+ "xhtml1-transitional.dtd\">"<br />
+ "<html xmlns=\"http://www.w3.org/1999/xhtml\">"<br />
+ "<head></head><body>";<br />
public String singleWrapHTML = "<ol "<br />
+ "class=\"xoxo\">"<br />
+ "<li>test</li></ol>";<br />
public String endHTML = "</body></html>";<br />
<br />
public void testWrapSingleItem(){<br />
String item = "test";<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(startHTML + singleWrapHTML + endHTML,<br />
xoxo.toXOXO(item,true,null));<br />
}<br />
<br />
public void testXOXOParser(){<br />
XOXOParser parser = new XOXOParser();<br />
try{<br />
parser.parse(dictHTML);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testDictRoundTrip(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("test", "1");<br />
dict.put("name", "Kevin");<br />
String html = xoxo.toXOXO(dict);<br />
try{<br />
Object newDict = parser.parse(html);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testListRoundTrip(){<br />
Object[] obj = {"1","2","3"};<br />
List testList = Arrays.asList(obj);<br />
XOXOWriter xoxo = new XOXOWriter();<br />
String html = xoxo.toXOXO(testList);<br />
XOXOParser parser = new XOXOParser();<br />
try{<br />
Object newList = parser.parse(html);<br />
assertEquals(testList,newList);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testListOfDictsRoundTrip(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("test", "1");<br />
dict.put("name", "Kevin");<br />
Map dict2 = new LinkedHashMap();<br />
dict2.put("one", "two");<br />
dict2.put("three", "four");<br />
dict2.put("five", "six");<br />
Object[] obj = {"1",dict,dict2};<br />
List testList = Arrays.asList(obj);<br />
String html = xoxo.toXOXO(testList);<br />
try{<br />
Object newList = parser.parse(html);<br />
assertEquals(testList,newList);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testListOfListsRoundTrip(){<br />
Object[] list1 = {"1","2","3"};<br />
Object[] list2 = {"4","5","6", Arrays.asList(list1)};<br />
Object[] list3 = {"7", Arrays.asList(list2)};<br />
Object[] list4 = {"8", Arrays.asList(list3)};<br />
List testList = Arrays.asList(list4);<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
String html = xoxo.toXOXO(testList);<br />
try{<br />
Object newList = parser.parse(html);<br />
assertEquals(testList,newList);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testDictOfListsRoundTrip(){<br />
Object[] list1 = {"1","2","3"};<br />
Object[] list2 = {"4","5","6"};<br />
Object[] list3 = {"7"};<br />
Object[] list4 = {"8", "9"};<br />
Map dict = new LinkedHashMap();<br />
dict.put("foo", Arrays.asList(list1));<br />
dict.put("bar", Arrays.asList(list2));<br />
dict.put("baz", Arrays.asList(list3));<br />
dict.put("qux", Arrays.asList(list4));<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
String html = xoxo.toXOXO(dict);<br />
try{<br />
Object newDict = parser.parse(html);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public String junkXOXO = "<ol "<br />
+ XHTML_DEC<br />
+ "class=\"xoxo\">"<br />
+ "bad<li><dl>worse<dt>good</dt><dd>buy</dd> now</dl></li></ol>";<br />
<br />
public void testXOXOJunkInContainers(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("good","buy");<br />
try{<br />
Object newDict = parser.parse(junkXOXO);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public String junkElementXOXO = "<ol "<br />
+ XHTML_DEC<br />
+ "><li>bad<dl><dt>good</dt><dd>buy</dd></dl>"<br />
+ "worse</li><li>bag<ol><li>OK</li></ol>fish</li></ol>";<br />
<br />
public void testXOXOjunkInElements(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("good","buy");<br />
Object[] ok = {"OK"};<br />
Object[] obj ={dict, Arrays.asList(ok)};<br />
List testList = Arrays.asList(obj);<br />
try{<br />
Object newList = parser.parse(junkElementXOXO);<br />
assertEquals(testList,newList);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public String xoxoSpacesNewlines = "<ol " + XHTML_DEC +<br />
" class='xoxo'> \n" +<br />
" <li>\n" +<br />
" <dl>\n" +<br />
" <dt>text</dt>\n" +<br />
" <dd>item 1</dd>\n" +<br />
" <dt>description</dt>\n" +<br />
" <dd> This item represents the main" +<br />
" point we're trying to make.</dd>\n" +<br />
" <dt>url</dt>\n" +<br />
" <dd>http://example.com/more.xoxo</dd>\n" +<br />
" <dt>title</dt>\n" +<br />
" <dd>title of item 1</dd>\n" +<br />
" <dt>type</dt>\n" +<br />
" <dd>text/xml</dd>\n" +<br />
" <dt>rel</dt>\n" +<br />
" <dd>help</dd>\n" +<br />
" </dl>\n" +<br />
" </li>\n" +<br />
"</ol>";<br />
<br />
public void testXOXOWithSpacesAndNewlines(){<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("text","item 1");<br />
dict.put("description"," This item represents the main" +<br />
" point we're trying to make.");<br />
dict.put("url","http://example.com/more.xoxo");<br />
dict.put("title","title of item 1");<br />
dict.put("type","text/xml");<br />
dict.put("rel","help");<br />
try{<br />
Object newDict = parser.parse(xoxoSpacesNewlines);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public String xoxoSample = "<ol " + XHTML_DEC +<br />
" class='xoxo'> \n" +<br />
" <li>\n" +<br />
" <dl>\n" +<br />
" <dt>text</dt>\n" +<br />
" <dd>item 1</dd>\n" +<br />
" <dt>url</dt>\n" +<br />
" <dd>http://example.com/more.xoxo</dd>\n" +<br />
" <dt>title</dt>\n" +<br />
" <dd>title of item 1</dd>\n" +<br />
" <dt>type</dt>\n" +<br />
" <dd>text/xml</dd>\n" +<br />
" <dt>rel</dt>\n" +<br />
" <dd>help</dd>\n" +<br />
" </dl>\n" +<br />
" </li>\n" +<br />
"</ol>";<br />
<br />
public String smartXOXOSample = "<ol " + XHTML_DEC +<br />
"class=\"xoxo\"> \n" +<br />
" <li><a href=\"http://example.com/more.xoxo\"\n" +<br />
" title=\"title of item 1\"\n" +<br />
" type=\"text/xml\"\n" +<br />
" rel=\"help\">item 1</a> \n" +<br />
"<!-- note how the \"text\" property is simply" +<br />
" the contents of the <a> element -->\n" +<br />
" </li>\n" +<br />
"</ol>";<br />
<br />
public void testSpecialAttributeDecoding(){<br />
XOXOParser parser = new XOXOParser();<br />
try{<br />
Object xoxoDict = parser.parse(xoxoSample);<br />
Object xoxoDict2 = parser.parse(smartXOXOSample);<br />
assertEquals(xoxoDict,xoxoDict2);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public String specialAttrHTML = "<ol " + XHTML_DEC +<br />
"class=\"xoxo\">" +<br />
"<li><a href=\"http://example.com/more.xoxo\" title=\"sample url\" " +<br />
"rel=\"help\" type=\"text/xml\" >an example</a></li></ol>";<br />
<br />
public void testSpecialAttributeEncode(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
Map dict = new LinkedHashMap();<br />
dict.put("url","http://example.com/more.xoxo");<br />
dict.put("title","sample url");<br />
dict.put("type","text/xml");<br />
dict.put("rel","help");<br />
dict.put("text","an example");<br />
String html = xoxo.toXOXO(dict);<br />
assertEquals(specialAttrHTML,html);<br />
}<br />
<br />
public void testSpecialAttributeRoundTripFull(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("url","http://example.com/more.xoxo");<br />
dict.put("title","sample url");<br />
dict.put("type","text/xml");<br />
dict.put("rel","help");<br />
dict.put("text","an example");<br />
String html = xoxo.toXOXO(dict);<br />
try{<br />
Object newDict = parser.parse(html);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testSpecialAttributeRoundTripNoText(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("url","http://example.com/more.xoxo");<br />
dict.put("title","sample url");<br />
dict.put("type","text/xml");<br />
dict.put("rel","help");<br />
String html = xoxo.toXOXO(dict);<br />
try{<br />
Object newDict = parser.parse(html);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testSpecialAttributeRoundTripNoTextOrTitle(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("url","http://example.com/more.xoxo");<br />
dict.put("type","text/xml");<br />
dict.put("rel","help");<br />
String html = xoxo.toXOXO(dict);<br />
try{<br />
Object newDict = parser.parse(html);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testUnicodeRoundTrip(){<br />
String s = "Tantek Çelik and a snowman ?";<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
String html = xoxo.toXOXO(s);<br />
try{<br />
Object newString = parser.parse(html);<br />
assertEquals(s,newString);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
}<br />
<br />
</nowiki></pre></div>
RobertSayre
http://microformats.org/wiki/index.php?title=xoxo-sample-code&diff=2501
xoxo-sample-code
2005-10-30T19:28:56Z
<p>RobertSayre: </p>
<hr />
<div>= XOXO Sample Code =<br />
<br />
A whole bunch of open source ([http://creativecommons.org/licenses/by/2.0/ CC-by-2.0], [http://www.apache.org/licenses/LICENSE-2.0 Apache 2.0]) sample code to read and write [[xoxo]] files in Python and Java (with Perl, PHP, ... to follow).<br />
= Python =<br />
== xoxo.py ==<br />
<pre><nowiki><br />
# -*- coding: utf-8 -*-<br />
"""xoxo.py - a utility module for transforming to and from the XHTMLOutlines format XOXO<br />
toXOXO takes a Python datastructure (tuples, lists or dictionaries, arbitrarily nested) and returns a XOXO representation of it.<br />
fromXOXO parses an XHTML file for a xoxo list and returns the structure<br />
"""<br />
__version__ = "0.8"<br />
__date__ = "2004-10-05"<br />
__author__ = "Kevin Marks <kmarks@technorati.com>"<br />
__copyright__ = "Copyright 2004, Kevin marks & Technorati"<br />
__license__ = "http://creativecommons.org/licenses/by/2.0/ CC-by-2.0], [http://www.apache.org/licenses/LICENSE-2.0 Apache 2.0"<br />
__credits__ = """Tantek Çelik and Mark Pilgrim for data structure"""<br />
__history__ = """<br />
TODO: add <title> tag<br />
TODO: add a proper profile link<br />
0.8 work in unicode then render to utf-8<br />
0.7 initial encoding support - just utf-8 for now<br />
0.6 support the special behaviour for url properties to/from <a><br />
0.5 fix some awkward side effects of whitespace and text outside our expected tags; simplify writing code<br />
0.4 add correct XHTML headers so it validates<br />
0.3 read/write version; fixed invlaid nested list generation;<br />
0.1 first write-only version<br />
"""<br />
<br />
try:<br />
True, False<br />
except NameError:<br />
True, False = not not 1, not 1<br />
containerTags={'ol':False,'ul':False,'dl':False}<br />
import sgmllib, urllib, urlparse, re<br />
def makeXOXO(struct,className=None,depth=0):<br />
s=u''<br />
if isinstance(struct,list) or isinstance(struct,tuple):<br />
if className:<br />
s += u'<ol class="%s">' % className<br />
else:<br />
s+= u"<ol>"<br />
if isinstance(struct,dict):<br />
d=struct.copy()<br />
if d.has_key('url'):<br />
s+=u'<a href="%s" ' % d['url']<br />
text = d.get('text',d.get('title',d['url']))<br />
for attr in ('title','rel','type'):<br />
if d.has_key(attr):<br />
xVal = makeXOXO(d[attr],None,depth+1)<br />
s +=u'%s="%s" ' % (attr,xVal)<br />
del d[attr]<br />
s +=u'>%s</a>' % makeXOXO(text,None,depth+1)<br />
if d.has_key('text'):<br />
del d['text']<br />
del d['url']<br />
if len(d):<br />
s +=u"<dl>"<br />
for key,value in d.items():<br />
xVal = makeXOXO(value,None,depth+1)<br />
s+= u'<dt>%s</dt><dd>%s</dd>' % (key, xVal)<br />
s +=u"</dl>"<br />
elif type(struct) ==type((1,))or type(struct) ==type([1,]):<br />
for item in struct:<br />
s+=u"<li>" + makeXOXO(item,None,depth+1)+"</li>"<br />
s +=u"</ol>"<br />
elif type(struct) == type(u'unicode'):<br />
s+=struct<br />
else:<br />
if not type(struct)==type(' '):<br />
struct=str(struct)<br />
try:<br />
s+=unicode(struct,'utf-8')<br />
except:<br />
s+=unicode(struct,'windows_1252')<br />
return s<br />
class xoxoParser(sgmllib.SGMLParser):<br />
def __init__(self):<br />
sgmllib.SGMLParser.__init__(self)<br />
self.structs=[]<br />
self.xostack=[]<br />
self.textstack=['']<br />
def normalize_attrs(self, attrs):<br />
attrs = [(k.lower(), sgmllib.charref.sub(lambda m: chr(int(m.groups()[0])), v).strip()) for k, v in attrs]<br />
attrs = [(k, k in ('rel','type') and v.lower() or v) for k, v in attrs]<br />
return attrs<br />
def pushStruct(self,struct):<br />
if type(struct) == type({}) and len(struct)==0 and len(self.structs) and type(self.structs[-1]) == type({}) and self.structs[-1].has_key('url'):<br />
self.xostack.append(self.structs[-1]) # put back the <a>-made one for extra def's<br />
else:<br />
self.structs.append(struct)<br />
self.xostack.append(self.structs[-1])<br />
def start_a(self,attrs):<br />
attrsD = dict(self.normalize_attrs(attrs))<br />
attrsD['url']= attrsD.get('href','')<br />
del attrsD['href']<br />
self.pushStruct(attrsD)<br />
self.textstack.append('')<br />
def end_a(self):<br />
val = self.textstack.pop()<br />
if val: <br />
if self.xostack[-1].get('title','') == val:<br />
val=''<br />
if self.xostack[-1]['url'] == val:<br />
val=''<br />
if val:<br />
self.xostack[-1]['text']=val<br />
self.xostack.pop()<br />
def start_dl(self,attrs):<br />
self.pushStruct({})<br />
def end_dl(self):<br />
self.xostack.pop()<br />
def start_ol(self,attrs):<br />
self.pushStruct([])<br />
def end_ol(self):<br />
self.xostack.pop()<br />
def start_ul(self,attrs):<br />
self.pushStruct([])<br />
def end_ul(self):<br />
self.xostack.pop()<br />
def start_li(self,attrs):<br />
self.textstack.append('')<br />
def end_li(self):<br />
val = self.textstack.pop()<br />
if self.structs[-1] != self.xostack[-1]:<br />
val = self.structs.pop()<br />
self.xostack[-1].append(val)<br />
def start_dt(self,attrs):<br />
self.textstack.append('')<br />
def end_dt(self):<br />
pass<br />
def start_dd(self,attrs):<br />
self.textstack.append('')<br />
def end_dd(self):<br />
val = self.textstack.pop()<br />
key = self.textstack.pop()<br />
if self.structs[-1] != self.xostack[-1]:<br />
val = self.structs.pop()<br />
self.xostack[-1][key]=val<br />
def handle_data(self, text):<br />
if len(self.stack) and containerTags.get(self.stack[-1],True): #skip text not within an element<br />
self.textstack[-1] += text<br />
def toXOXO(struct,addHTMLWrapper=False,cssUrl=''):<br />
if type(struct) ==type((1,))or type(struct) ==type([1,]):<br />
inStruct = struct<br />
else:<br />
inStruct = [struct]<br />
if addHTMLWrapper:<br />
s= '''<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN<br />
http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><br />
<html xmlns="http://www.w3.org/1999/xhtml"><head profile=""><meta http-equiv="Content-Type" content="text/html; charset=utf-8" />'''<br />
if cssUrl:<br />
s+='<style type="text/css" >@import "%s";</style>' % cssUrl<br />
s+="</head><body>%s</body></html>" % makeXOXO(inStruct,'xoxo')<br />
return s.encode('utf-8')<br />
else:<br />
return makeXOXO(inStruct,'xoxo').encode('utf-8')<br />
<br />
import sys<br />
<br />
def fromXOXO(html):<br />
parser = xoxoParser()<br />
parser.feed(unicode(html,'utf-8'))<br />
#print >>sys.stderr, parser.structs<br />
structs=[struct for struct in parser.structs if struct]<br />
#print >>sys.stderr, structs<br />
while (len(structs) ==1 and type(structs)==type([1,])):<br />
structs=structs[0]<br />
return structs<br />
<br />
# Allow direct invocation<br />
# Read HTML from URL, parse into data structures, then re-output<br />
<br />
if __name__ == "__main__":<br />
if len(sys.argv) < 2: raise SystemExit("Usage: "+sys.argv[0]+" url\n"+__doc__)<br />
url=sys.argv[1]<br />
file = urllib.urlopen(url)<br />
html=file.read(-1)<br />
file.close<br />
s=fromXOXO(html)<br />
p=toXOXO(s,True)<br />
print p<br />
<br />
</nowiki></pre><br />
<br />
== testxoxo.py ==<br />
<pre><nowiki><br />
# -*- coding: utf-8 -*-<br />
"""testxoxo.py <br />
Unit tests for xoxo.py<br />
This file tests the functions in xoxo.py <br />
The underlying model here is http://diveintopython.org/unit_testing/index.html <br />
<br />
run from command line with<br />
python testxoxo.py -v<br />
"""<br />
import xoxo<br />
reload(xoxo)<br />
import unittest<br />
<br />
class xoxoTestCases(unittest.TestCase):<br />
<br />
def testSimpleList(self):<br />
'''make a xoxo file from a list'''<br />
l = ['1','2','3']<br />
html = xoxo.toXOXO(l)<br />
self.assertEqual(html,'<ol class="xoxo"><li>1</li><li>2</li><li>3</li></ol>')<br />
def testNestedList(self):<br />
'''make a xoxo file from a list with a list in'''<br />
l = ['1',['2','3']]<br />
html = xoxo.toXOXO(l)<br />
self.assertEqual(html,'<ol class="xoxo"><li>1</li><li><ol><li>2</li><li>3</li></ol></li></ol>')<br />
<br />
def testDictionary(self):<br />
'''make a xoxo file from a dictionary'''<br />
d = {'test':'1','name':'Kevin'}<br />
html = xoxo.toXOXO(d)<br />
self.assertEqual(html,'<ol class="xoxo"><li><dl><dt>test</dt><dd>1</dd><dt>name</dt><dd>Kevin</dd></dl></li></ol>')<br />
<br />
def testSingleItem(self):<br />
'''make a xoxo file from a string'''<br />
l = "test"<br />
html = xoxo.toXOXO(l)<br />
self.assertEqual(html,'<ol class="xoxo"><li>test</li></ol>')<br />
<br />
def testWrapDiffers(self):<br />
'''make a xoxo file from a string with and without html wrapper and check they are different'''<br />
l = "test"<br />
html = xoxo.toXOXO(l)<br />
htmlwrap = xoxo.toXOXO(l,addHTMLWrapper=True)<br />
self.failIfEqual(html,htmlwrap)<br />
<br />
def testWrapSingleItem(self):<br />
'''make a wrapped xoxo file from a string'''<br />
l = "test"<br />
html = xoxo.toXOXO(l,addHTMLWrapper=True)<br />
self.assertEqual(html,'''<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN<br />
http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><br />
<html xmlns="http://www.w3.org/1999/xhtml"><head profile=""></head><body><ol class="xoxo"><li>test</li></ol></body></html>''')<br />
<br />
def testDictionaryRoundTrip(self):<br />
''' make a dictionary into a xoxo file and back again; check it is the same'''<br />
d = {'test':'1','name':'Kevin'}<br />
html = xoxo.toXOXO(d)<br />
newd = xoxo.fromXOXO(html)<br />
self.assertEqual(d,newd)<br />
<br />
def testListRoundTrip(self):<br />
''' make a list into a xoxo file and back again; check it is the same'''<br />
l = ['3','2','1']<br />
html = xoxo.toXOXO(l)<br />
newdl= xoxo.fromXOXO(html)<br />
self.assertEqual(l,newdl)<br />
def testListofDictsRoundTrip(self):<br />
''' make a list of Dicts into a xoxo file and back again; check it is the same'''<br />
l = ['3',{'a':'2'},{'b':'1','c':'4'}]<br />
html = xoxo.toXOXO(l)<br />
newdl= xoxo.fromXOXO(html)<br />
self.assertEqual(l,newdl)<br />
def testListofListsRoundTrip(self):<br />
''' make a list of Lists into a xoxo file and back again; check it is the same'''<br />
l = ['3',['a','2'],['b',['1',['c','4']]]]<br />
html = xoxo.toXOXO(l)<br />
newdl= xoxo.fromXOXO(html)<br />
self.assertEqual(l,newdl)<br />
def testDictofListsRoundTrip(self):<br />
''' make a dict with lists in into a xoxo file and back again; check it is the same'''<br />
d = {'test':['1','2'],<br />
'name':'Kevin',<br />
'nestlist':['a',['b','c']],<br />
'nestdict':{'e':'6','f':'7'}}<br />
html = xoxo.toXOXO(d)<br />
newd = xoxo.fromXOXO(html)<br />
self.assertEqual(d,newd)<br />
<br />
def testXOXOjunkInContainers(self):<br />
'''make sure text outside <li> etc is ignored'''<br />
d=xoxo.fromXOXO('<ol>bad<li><dl>worse<dt>good</dt><dd>buy</dd> now</dl></li></ol>')<br />
self.assertEqual(d,{'good': 'buy'})<br />
def testXOXOjunkInElements(self):<br />
'''make sure text within <li> but outside a subcontainer is ignored'''<br />
l=xoxo.fromXOXO('<ol><li>bad<dl><dt>good</dt><dd>buy</dd></dl>worse</li><li>bag<ol><li>OK</li></ol>fish</li></ol>')<br />
self.assertEqual(l,[{'good': 'buy'},['OK']])<br />
def testXOXOWithSpacesAndNewlines(self):<br />
'''unmung some xoxo with spaces in and check result is right'''<br />
xoxoSample= '''<ol class='xoxo'> <br />
<li><br />
<dl><br />
<dt>text</dt><br />
<dd>item 1</dd><br />
<dt>description</dt><br />
<dd> This item represents the main point we're trying to make.</dd><br />
<dt>url</dt><br />
<dd>http://example.com/more.xoxo</dd><br />
<dt>title</dt><br />
<dd>title of item 1</dd><br />
<dt>type</dt><br />
<dd>text/xml</dd><br />
<dt>rel</dt><br />
<dd>help</dd><br />
</dl><br />
</li><br />
</ol>'''<br />
d = xoxo.fromXOXO(xoxoSample)<br />
d2={'text':'item 1',<br />
'description':" This item represents the main point we're trying to make.",<br />
'url':'http://example.com/more.xoxo',<br />
'title':'title of item 1',<br />
'type':'text/xml',<br />
'rel':'help'<br />
}<br />
xoxoAgain = xoxo.toXOXO(d)<br />
self.assertEqual(d,d2)<br />
#this needs a smarter whitespace-sensitive comparison<br />
#self.assertEqual(xoxoSample,xoxoAgain)<br />
<br />
def testSpecialAttributeDecoding(self):<br />
'''unmung some xoxo with <a href=' rel= etc in and check result is right'''<br />
xoxoSample= '''<ol class='xoxo'> <br />
<li><br />
<dl><br />
<dt>text</dt><br />
<dd>item 1</dd><br />
<dt>url</dt><br />
<dd>http://example.com/more.xoxo</dd><br />
<dt>title</dt><br />
<dd>title of item 1</dd><br />
<dt>type</dt><br />
<dd>text/xml</dd><br />
<dt>rel</dt><br />
<dd>help</dd><br />
</dl><br />
</li><br />
</ol>'''<br />
d = xoxo.fromXOXO(xoxoSample)<br />
smartxoxoSample= '''<ol class='xoxo'> <br />
<li><a href="http://example.com/more.xoxo"<br />
title="title of item 1"<br />
type="text/xml"<br />
rel="help">item 1</a> <br />
<!-- note how the "text" property is simply the contents of the <a> element --><br />
</li><br />
</ol>'''<br />
d2 = xoxo.fromXOXO(smartxoxoSample)<br />
self.assertEqual(d,d2)<br />
def testSpecialAttributeAndDLDecoding(self):<br />
'''unmung some xoxo with <a href=' rel= etc in plus a <dl> in the same item and check result is right'''<br />
xoxoSample= '''<ol class="xoxo"> <br />
<li><br />
<dl><br />
<dt>text</dt><br />
<dd>item 1</dd><br />
<dt>description</dt><br />
<dd> This item represents the main point we're trying to make.</dd><br />
<dt>url</dt><br />
<dd>http://example.com/more.xoxo</dd><br />
<dt>title</dt><br />
<dd>title of item 1</dd><br />
<dt>type</dt><br />
<dd>text/xml</dd><br />
<dt>rel</dt><br />
<dd>help</dd><br />
</dl><br />
</li><br />
</ol>'''<br />
d = xoxo.fromXOXO(xoxoSample)<br />
smartxoxoSample= '''<ol class="xoxo"> <br />
<li><a href="http://example.com/more.xoxo"<br />
title="title of item 1"<br />
type="text/xml"<br />
rel="help">item 1</a> <br />
<!-- note how the "text" property is simply the contents of the <a> element --><br />
<dl><br />
<dt>description</dt><br />
<dd> This item represents the main point we're trying to make.</dd><br />
</dl><br />
</li><br />
</ol>'''<br />
d2 = xoxo.fromXOXO(smartxoxoSample)<br />
self.assertEqual(d,d2)<br />
def testSpecialAttributeEncode(self):<br />
'''check it makes an <a href with a url parameter'''<br />
d={'url':'http://example.com/more.xoxo','title':'sample url','type':"text/xml",'rel':'help','text':'an example'}<br />
html=xoxo.toXOXO(d)<br />
expectedHTML= '<ol class="xoxo"><li><a href="http://example.com/more.xoxo" title="sample url" rel="help" type="text/xml" >an example</a></li></ol>' <br />
self.assertEqual(html,expectedHTML)<br />
<br />
def testSpecialAttributeRoundTripFull(self):<br />
'''check it makes an <a href with a url parameter'''<br />
d={'url':'http://example.com/more.xoxo','title':'sample url','type':"text/xml",'rel':'help','text':'an example'}<br />
html=xoxo.toXOXO(d)<br />
self.assertEqual(d,xoxo.fromXOXO(html))<br />
def testSpecialAttributeRoundTripNoText(self):<br />
'''check it makes an <a href with a url parameter and no text attribute'''<br />
d={'url':'http://example.com/more.xoxo','title':'sample url','type':"text/xml",'rel':'help'}<br />
html=xoxo.toXOXO(d)<br />
self.assertEqual(d,xoxo.fromXOXO(html))<br />
def testSpecialAttributeRoundTripNoTextOrTitle(self):<br />
'''check it makes an <a href with a url parameter and no text or title attribute'''<br />
d={'url':'http://example.com/more.xoxo'}<br />
html=xoxo.toXOXO(d)<br />
self.assertEqual(d,xoxo.fromXOXO(html))<br />
def testUnicodeRoundtrip(self):<br />
'''check unicode characters can go to xoxo and back'''<br />
src=unicode('Tantek Çelik and a snowman ?','utf-8')<br />
html = html=xoxo.toXOXO(src)<br />
self.assertEqual(src,xoxo.fromXOXO(html))<br />
if __name__ == "__main__":<br />
unittest.main()<br />
else:<br />
runner = unittest.TextTestRunner()<br />
suite = unittest.makeSuite(xoxoTestCases,'test')<br />
runner.run(suite)<br />
<br />
</nowiki></pre><br />
<br />
= Java =<br />
== XOXOWriter.java ==<br />
<pre><nowiki><br />
package org.atompub.draft.xoxo;<br />
<br />
import java.util.*;<br />
<br />
public class XOXOWriter {<br />
<br />
public String[] attrs = {"title","rel","type"};<br />
<br />
public String makeXOXO(List struct, String className){<br />
return makeXOXO(struct, className, 0, true);<br />
}<br />
<br />
public String makeXOXO(List struct, String className,<br />
boolean doNSDeclaration){<br />
return makeXOXO(struct, className, 0, doNSDeclaration);<br />
}<br />
<br />
public String makeXOXO(List struct){<br />
return makeXOXO(struct, "xoxo", 0, true);<br />
}<br />
<br />
public String makeXOXO(Object struct, int depth){<br />
return makeXOXO(struct, null, 0, false);<br />
}<br />
<br />
public String makeXOXO(Object struct, String className,<br />
int depth, boolean doNSDeclaration){<br />
if(struct == null) return "";<br />
StringBuffer sb = new StringBuffer();<br />
if(struct instanceof Object[]){<br />
struct = Arrays.asList((Object[]) struct);<br />
}<br />
if(struct instanceof List){<br />
sb.append("<ol");<br />
if(doNSDeclaration)<br />
sb.append(" xmlns=\"http://www.w3.org/1999/xhtml\"");<br />
if(className != null){<br />
sb.append(" class=\"");<br />
sb.append(className);<br />
sb.append("\"");<br />
}<br />
sb.append(">");<br />
}<br />
if(struct instanceof Map){<br />
Map d = new LinkedHashMap((Map) struct);<br />
if(d.containsKey("url")){<br />
sb.append("<a href=\"" + d.get("url") + "\" ");<br />
Object text;<br />
if(d.containsKey("text")){<br />
text = d.get("text");<br />
}else if(d.containsKey("title")){<br />
text = d.get("title");<br />
}else{<br />
text = d.get("url");<br />
}<br />
for(int i=0; i<attrs.length; i++){<br />
String xVal = makeXOXO(d.get(attrs[i]),depth+1);<br />
if(xVal != null && !xVal.equals("")){<br />
sb.append(attrs[i] + "=\"" + xVal + "\" ");<br />
}<br />
d.remove(attrs[i]);<br />
}<br />
sb.append(">" + makeXOXO(text, depth+1) + "</a>");<br />
d.remove("text");<br />
d.remove("url");<br />
}<br />
if(d.size() > 0){<br />
sb.append("<dl>");<br />
for(Iterator i = d.keySet().iterator(); i.hasNext();){<br />
Object k = i.next();<br />
String ddVal = makeXOXO(d.get(k),depth+1);<br />
sb.append("<dt>" + k + "</dt>");<br />
sb.append("<dd>" + ddVal + "</dd>");<br />
}<br />
sb.append("</dl>");<br />
}<br />
}else if(struct instanceof List){<br />
List l = (List) struct;<br />
for(Iterator i = l.iterator(); i.hasNext();){<br />
Object item = i.next();<br />
sb.append("<li>" + makeXOXO(item,depth+1) + "</li>");<br />
}<br />
sb.append("</ol>");<br />
}else{<br />
sb.append(struct);<br />
}<br />
return sb.toString();<br />
}<br />
<br />
public String toXOXO(List struct){<br />
return toXOXO(struct, false, null);<br />
}<br />
<br />
public String toXOXO(Object struct){<br />
List alist = new ArrayList();<br />
alist.add(struct);<br />
return toXOXO(alist);<br />
}<br />
<br />
public String toXOXO(Object struct,<br />
boolean addHTMLWrapper,<br />
String cssUrl){<br />
List alist = new ArrayList();<br />
alist.add(struct);<br />
return toXOXO(alist, addHTMLWrapper, cssUrl);<br />
}<br />
<br />
public String toXOXO(List struct,<br />
boolean addHTMLWrapper,<br />
String cssUrl){<br />
String startHTML = "<!DOCTYPE html PUBLIC \"-//W3C//DTD"<br />
+ "XHTML 1.0 Transitional//EN\n"<br />
+ "http://www.w3.org/TR/xhtml1/DTD/"<br />
+ "xhtml1-transitional.dtd\">"<br />
+ "<html xmlns=\"http://www.w3.org/1999/xhtml\">"<br />
+ "<head>";<br />
if(addHTMLWrapper){<br />
String s = startHTML;<br />
if(cssUrl != null){<br />
s += "<style type=\"text/css\">@import \""<br />
+ cssUrl + "\";</style>";<br />
}<br />
s += "</head><body>" + makeXOXO(struct, "xoxo", false)<br />
+ "</body></html>";<br />
return s;<br />
}else{<br />
return makeXOXO(struct, "xoxo");<br />
}<br />
}<br />
}<br />
</nowiki></pre><br />
<br />
== XOXOParser.java ==<br />
<pre><nowiki><br />
package org.atompub.draft.xoxo;<br />
<br />
import org.xml.sax.InputSource;<br />
import org.xml.sax.SAXException;<br />
import org.xml.sax.XMLReader;<br />
import org.xml.sax.Attributes;<br />
import org.xml.sax.helpers.XMLReaderFactory;<br />
import org.xml.sax.helpers.DefaultHandler;<br />
<br />
import java.util.*;<br />
import java.io.InputStream;<br />
import java.io.StringReader;<br />
import java.io.IOException;<br />
<br />
public class XOXOParser extends DefaultHandler {<br />
<br />
protected String XHTML_NS = "http://www.w3.org/1999/xhtml";<br />
protected List elStack;<br />
protected Map listEls;<br />
public List structs;<br />
public List xoStack;<br />
public List textStack;<br />
<br />
public XOXOParser() {<br />
reset();<br />
}<br />
<br />
protected void pushStruct(Object struct){<br />
if((struct instanceof Map) && (((Map) struct).size() > 0)<br />
&& (structs.get(structs.size()-1) instanceof Map)<br />
&& (((Map) struct).containsKey("url"))){<br />
// put back the <a>-made one for extra defs<br />
xoStack.add(structs.get(structs.size()-1));<br />
}else{<br />
structs.add(struct);<br />
xoStack.add(struct);<br />
}<br />
}<br />
<br />
public void startElement(String nsUri, String localName,<br />
String qName, Attributes atts){<br />
// bounce non-XHTML elements<br />
if(nsUri.equals(XHTML_NS)){<br />
elStack.add(localName);<br />
}else{<br />
elStack.add("foo");<br />
return;<br />
}<br />
<br />
if(localName.equals("a")){<br />
Map attmap = new LinkedHashMap();<br />
int len = atts.getLength();<br />
for(int i=0; i<len; i++){<br />
attmap.put(atts.getQName(i),atts.getValue(i));<br />
}<br />
if(attmap.containsKey("href")){<br />
attmap.put("url",attmap.get("href"));<br />
attmap.remove("href");<br />
}<br />
pushStruct(attmap);<br />
textStack.add("");<br />
}else if(localName.equals("dl")){<br />
pushStruct(new LinkedHashMap());<br />
}else if(localName.equals("ol")){<br />
pushStruct(new ArrayList());<br />
}else if(localName.equals("ul")){<br />
pushStruct(new ArrayList());<br />
}else if(localName.equals("li")){<br />
textStack.add("");<br />
}else if(localName.equals("dt")){<br />
textStack.add("");<br />
}else if(localName.equals("dd")){<br />
textStack.add("");<br />
}<br />
}<br />
<br />
public void endElement(String nsUri, String localName,<br />
String qName){<br />
elStack.remove(elStack.size()-1);<br />
// bounce non-XHTML elements<br />
if(nsUri != XHTML_NS){<br />
return;<br />
}<br />
<br />
if(localName.equals("a")){<br />
String val = (String) textStack.remove(textStack.size()-1);<br />
if (val.length() > 0){<br />
Map defs = (Map) xoStack.get(xoStack.size()-1);<br />
String defVal = (String) defs.get("title");<br />
if((defVal != null) && (val.equals(defVal))){<br />
val = "";<br />
}<br />
defVal = (String) defs.get("url");<br />
if((defVal != null) && (val.equals(defVal))){<br />
val = "";<br />
}<br />
if(val.length() > 0){<br />
defs.put("text",val);<br />
}<br />
}<br />
xoStack.remove(xoStack.size()-1);<br />
}else if(localName.equals("dl")){<br />
xoStack.remove(xoStack.size()-1);<br />
}else if(localName.equals("ol")){<br />
xoStack.remove(xoStack.size()-1);<br />
}else if(localName.equals("ul")){<br />
xoStack.remove(xoStack.size()-1);<br />
}else if(localName.equals("li")){<br />
Object val = textStack.remove(textStack.size()-1);<br />
List last = (List) xoStack.get(xoStack.size()-1);<br />
if(structs.get(structs.size()-1) != last){<br />
val = structs.remove(structs.size()-1);<br />
}<br />
last.add(val);<br />
}else if(localName.equals("dd")){<br />
Object val = textStack.remove(textStack.size()-1);<br />
Object key = textStack.remove(textStack.size()-1);<br />
Map last = (Map) xoStack.get(xoStack.size()-1);<br />
if(structs.get(structs.size()-1) != last){<br />
val = structs.remove(structs.size()-1);<br />
}<br />
last.put(key,val);<br />
}<br />
}<br />
<br />
public void characters(char[] ch, int start, int length){<br />
if((xoStack.size() > 0)<br />
&& (!listEls.containsKey(elStack.get(elStack.size()-1)))){<br />
String text = (String) textStack.get(textStack.size()-1);<br />
String test = new String(ch,start,length);<br />
textStack.set(textStack.size()-1,text+test);<br />
}<br />
}<br />
<br />
public Object parse(String s) throws SAXException, IOException{<br />
return parse(new InputSource(new StringReader(s)));<br />
}<br />
<br />
public Object parse(InputStream is) throws SAXException, IOException {<br />
return parse(new InputSource(is));<br />
}<br />
<br />
public Object parse(InputSource in) throws SAXException, IOException {<br />
XMLReader parser = XMLReaderFactory.createXMLReader();<br />
parser.setContentHandler(this);<br />
parser.parse(in);<br />
List returnList = new ArrayList();<br />
for(Iterator i = this.structs.iterator(); i.hasNext();){<br />
Object thing = i.next();<br />
if(thing != null){<br />
returnList.add(thing);<br />
}<br />
}<br />
while((returnList.size()==1)){<br />
if(returnList.get(0) instanceof List){<br />
returnList = (List) returnList.get(0);<br />
}else{<br />
reset();<br />
return returnList.get(0);<br />
}<br />
}<br />
reset();<br />
return returnList;<br />
}<br />
<br />
protected void reset(){<br />
elStack = new ArrayList();<br />
listEls = new HashMap();<br />
structs = new ArrayList();<br />
xoStack = new ArrayList();<br />
textStack = new ArrayList();<br />
listEls.put("ol","ol");<br />
listEls.put("ul","ul");<br />
listEls.put("dl","dl");<br />
}<br />
}<br />
<br />
</nowiki></pre><br />
<br />
== XOXOTest.java ==<br />
<pre><nowiki><br />
package org.atompub.draft.xoxo.tests;<br />
<br />
import junit.framework.TestSuite;<br />
import junit.framework.TestCase;<br />
import junit.textui.TestRunner;<br />
import org.atompub.draft.xoxo.XOXOWriter;<br />
import org.atompub.draft.xoxo.XOXOParser;<br />
<br />
import java.util.*;<br />
<br />
public class XOXOTest extends TestCase {<br />
<br />
public static void main(String[] args) {<br />
new TestRunner().doRun(new TestSuite(XOXOTest.class));<br />
}<br />
String XHTML_DEC = "xmlns=\"http://www.w3.org/1999/xhtml\" ";<br />
public String simpleListHTML = "<ol "<br />
+ XHTML_DEC<br />
+ "class=\"xoxo\">"<br />
+ "<li>1</li><li>2</li><li>3</li></ol>";<br />
<br />
public void testSimpleList(){<br />
String [] numbers = {"1","2","3"};<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(simpleListHTML,<br />
xoxo.toXOXO(Arrays.asList(numbers)));<br />
}<br />
<br />
public void testStringIntegerList(){<br />
Object[] numbers = {new Integer(1),"2","3"};<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(simpleListHTML,<br />
xoxo.toXOXO(Arrays.asList(numbers)));<br />
}<br />
<br />
public String nestedListHTML = "<ol "<br />
+ XHTML_DEC<br />
+ "class=\"xoxo\"><li>1</li><li>"<br />
+ "<ol><li>2</li><li>3</li></ol></li></ol>";<br />
<br />
public void testNestedList(){<br />
Object[] arr = {"2","3"};<br />
Object[] nested = {"1",Arrays.asList(arr)};<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(nestedListHTML,<br />
xoxo.toXOXO(Arrays.asList(nested)));<br />
}<br />
<br />
public void testNestedArray(){<br />
Object[] arr = {"2","3"};<br />
Object[] nested = {"1",arr};<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(nestedListHTML,<br />
xoxo.toXOXO(Arrays.asList(nested)));<br />
}<br />
<br />
public String dictHTML = "<ol "<br />
+ XHTML_DEC<br />
+ "class=\"xoxo\">"<br />
+ "<li><dl><dt>test</dt><dd>1</dd><dt>name</dt>"<br />
+ "<dd>Kevin</dd></dl></li></ol>";<br />
<br />
public void testDictionary(){<br />
Map dict = new LinkedHashMap();<br />
dict.put("test", new Integer(1));<br />
dict.put("name", "Kevin");<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(dictHTML,<br />
xoxo.toXOXO(dict));<br />
}<br />
<br />
public String singleHTML = "<ol "<br />
+ XHTML_DEC<br />
+ "class=\"xoxo\">"<br />
+ "<li>test</li></ol>";<br />
<br />
public void testSingleItem(){<br />
String item = "test";<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(singleHTML,<br />
xoxo.toXOXO(item));<br />
}<br />
<br />
public void testWrapDiffers(){<br />
String item = "test";<br />
XOXOWriter xoxo = new XOXOWriter();<br />
String nowrap = xoxo.toXOXO(item);<br />
Object[] itemArr = {item};<br />
String wrap = xoxo.toXOXO(Arrays.asList(itemArr),true,null);<br />
assertFalse(wrap.equals(nowrap));<br />
}<br />
<br />
String startHTML = "<!DOCTYPE html PUBLIC \"-//W3C//DTD"<br />
+ "XHTML 1.0 Transitional//EN\n"<br />
+ "http://www.w3.org/TR/xhtml1/DTD/"<br />
+ "xhtml1-transitional.dtd\">"<br />
+ "<html xmlns=\"http://www.w3.org/1999/xhtml\">"<br />
+ "<head></head><body>";<br />
public String singleWrapHTML = "<ol "<br />
+ "class=\"xoxo\">"<br />
+ "<li>test</li></ol>";<br />
public String endHTML = "</body></html>";<br />
<br />
public void testWrapSingleItem(){<br />
String item = "test";<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(startHTML + singleWrapHTML + endHTML,<br />
xoxo.toXOXO(item,true,null));<br />
}<br />
<br />
public void testXOXOParser(){<br />
XOXOParser parser = new XOXOParser();<br />
try{<br />
parser.parse(dictHTML);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testDictRoundTrip(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("test", "1");<br />
dict.put("name", "Kevin");<br />
String html = xoxo.toXOXO(dict);<br />
try{<br />
Object newDict = parser.parse(html);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testListRoundTrip(){<br />
Object[] obj = {"1","2","3"};<br />
List testList = Arrays.asList(obj);<br />
XOXOWriter xoxo = new XOXOWriter();<br />
String html = xoxo.toXOXO(testList);<br />
XOXOParser parser = new XOXOParser();<br />
try{<br />
Object newList = parser.parse(html);<br />
assertEquals(testList,newList);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testListOfDictsRoundTrip(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("test", "1");<br />
dict.put("name", "Kevin");<br />
Map dict2 = new LinkedHashMap();<br />
dict2.put("one", "two");<br />
dict2.put("three", "four");<br />
dict2.put("five", "six");<br />
Object[] obj = {"1",dict,dict2};<br />
List testList = Arrays.asList(obj);<br />
String html = xoxo.toXOXO(testList);<br />
try{<br />
Object newList = parser.parse(html);<br />
assertEquals(testList,newList);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testListOfListsRoundTrip(){<br />
Object[] list1 = {"1","2","3"};<br />
Object[] list2 = {"4","5","6", Arrays.asList(list1)};<br />
Object[] list3 = {"7", Arrays.asList(list2)};<br />
Object[] list4 = {"8", Arrays.asList(list3)};<br />
List testList = Arrays.asList(list4);<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
String html = xoxo.toXOXO(testList);<br />
try{<br />
Object newList = parser.parse(html);<br />
assertEquals(testList,newList);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testDictOfListsRoundTrip(){<br />
Object[] list1 = {"1","2","3"};<br />
Object[] list2 = {"4","5","6"};<br />
Object[] list3 = {"7"};<br />
Object[] list4 = {"8", "9"};<br />
Map dict = new LinkedHashMap();<br />
dict.put("foo", Arrays.asList(list1));<br />
dict.put("bar", Arrays.asList(list2));<br />
dict.put("baz", Arrays.asList(list3));<br />
dict.put("qux", Arrays.asList(list4));<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
String html = xoxo.toXOXO(dict);<br />
try{<br />
Object newDict = parser.parse(html);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public String junkXOXO = "<ol "<br />
+ XHTML_DEC<br />
+ "class=\"xoxo\">"<br />
+ "bad<li><dl>worse<dt>good</dt><dd>buy</dd> now</dl></li></ol>";<br />
<br />
public void testXOXOJunkInContainers(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("good","buy");<br />
try{<br />
Object newDict = parser.parse(junkXOXO);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public String junkElementXOXO = "<ol "<br />
+ XHTML_DEC<br />
+ "><li>bad<dl><dt>good</dt><dd>buy</dd></dl>"<br />
+ "worse</li><li>bag<ol><li>OK</li></ol>fish</li></ol>";<br />
<br />
public void testXOXOjunkInElements(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("good","buy");<br />
Object[] ok = {"OK"};<br />
Object[] obj ={dict, Arrays.asList(ok)};<br />
List testList = Arrays.asList(obj);<br />
try{<br />
Object newList = parser.parse(junkElementXOXO);<br />
assertEquals(testList,newList);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public String xoxoSpacesNewlines = "<ol " + XHTML_DEC +<br />
" class='xoxo'> \n" +<br />
" <li>\n" +<br />
" <dl>\n" +<br />
" <dt>text</dt>\n" +<br />
" <dd>item 1</dd>\n" +<br />
" <dt>description</dt>\n" +<br />
" <dd> This item represents the main" +<br />
" point we're trying to make.</dd>\n" +<br />
" <dt>url</dt>\n" +<br />
" <dd>http://example.com/more.xoxo</dd>\n" +<br />
" <dt>title</dt>\n" +<br />
" <dd>title of item 1</dd>\n" +<br />
" <dt>type</dt>\n" +<br />
" <dd>text/xml</dd>\n" +<br />
" <dt>rel</dt>\n" +<br />
" <dd>help</dd>\n" +<br />
" </dl>\n" +<br />
" </li>\n" +<br />
"</ol>";<br />
<br />
public void testXOXOWithSpacesAndNewlines(){<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("text","item 1");<br />
dict.put("description"," This item represents the main" +<br />
" point we're trying to make.");<br />
dict.put("url","http://example.com/more.xoxo");<br />
dict.put("title","title of item 1");<br />
dict.put("type","text/xml");<br />
dict.put("rel","help");<br />
try{<br />
Object newDict = parser.parse(xoxoSpacesNewlines);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public String xoxoSample = "<ol " + XHTML_DEC +<br />
" class='xoxo'> \n" +<br />
" <li>\n" +<br />
" <dl>\n" +<br />
" <dt>text</dt>\n" +<br />
" <dd>item 1</dd>\n" +<br />
" <dt>url</dt>\n" +<br />
" <dd>http://example.com/more.xoxo</dd>\n" +<br />
" <dt>title</dt>\n" +<br />
" <dd>title of item 1</dd>\n" +<br />
" <dt>type</dt>\n" +<br />
" <dd>text/xml</dd>\n" +<br />
" <dt>rel</dt>\n" +<br />
" <dd>help</dd>\n" +<br />
" </dl>\n" +<br />
" </li>\n" +<br />
"</ol>";<br />
<br />
public String smartXOXOSample = "<ol " + XHTML_DEC +<br />
"class=\"xoxo\"> \n" +<br />
" <li><a href=\"http://example.com/more.xoxo\"\n" +<br />
" title=\"title of item 1\"\n" +<br />
" type=\"text/xml\"\n" +<br />
" rel=\"help\">item 1</a> \n" +<br />
"<!-- note how the \"text\" property is simply" +<br />
" the contents of the <a> element -->\n" +<br />
" </li>\n" +<br />
"</ol>";<br />
<br />
public void testSpecialAttributeDecoding(){<br />
XOXOParser parser = new XOXOParser();<br />
try{<br />
Object xoxoDict = parser.parse(xoxoSample);<br />
Object xoxoDict2 = parser.parse(smartXOXOSample);<br />
assertEquals(xoxoDict,xoxoDict2);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public String specialAttrHTML = "<ol " + XHTML_DEC +<br />
"class=\"xoxo\">" +<br />
"<li><a href=\"http://example.com/more.xoxo\" title=\"sample url\" " +<br />
"rel=\"help\" type=\"text/xml\" >an example</a></li></ol>";<br />
<br />
public void testSpecialAttributeEncode(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
Map dict = new LinkedHashMap();<br />
dict.put("url","http://example.com/more.xoxo");<br />
dict.put("title","sample url");<br />
dict.put("type","text/xml");<br />
dict.put("rel","help");<br />
dict.put("text","an example");<br />
String html = xoxo.toXOXO(dict);<br />
assertEquals(specialAttrHTML,html);<br />
}<br />
<br />
public void testSpecialAttributeRoundTripFull(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("url","http://example.com/more.xoxo");<br />
dict.put("title","sample url");<br />
dict.put("type","text/xml");<br />
dict.put("rel","help");<br />
dict.put("text","an example");<br />
String html = xoxo.toXOXO(dict);<br />
try{<br />
Object newDict = parser.parse(html);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testSpecialAttributeRoundTripNoText(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("url","http://example.com/more.xoxo");<br />
dict.put("title","sample url");<br />
dict.put("type","text/xml");<br />
dict.put("rel","help");<br />
String html = xoxo.toXOXO(dict);<br />
try{<br />
Object newDict = parser.parse(html);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testSpecialAttributeRoundTripNoTextOrTitle(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("url","http://example.com/more.xoxo");<br />
dict.put("type","text/xml");<br />
dict.put("rel","help");<br />
String html = xoxo.toXOXO(dict);<br />
try{<br />
Object newDict = parser.parse(html);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testUnicodeRoundTrip(){<br />
String s = "Tantek Çelik and a snowman ?";<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
String html = xoxo.toXOXO(s);<br />
try{<br />
Object newString = parser.parse(html);<br />
assertEquals(s,newString);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
}<br />
<br />
</nowiki></pre></div>
RobertSayre
http://microformats.org/wiki/index.php?title=xoxo-sample-code&diff=2500
xoxo-sample-code
2005-10-30T19:28:27Z
<p>RobertSayre: </p>
<hr />
<div>= XOXO Sample Code =<br />
<br />
A whole bunch of open source ([http://creativecommons.org/licenses/by/2.0/ CC-by-2.0], [http://www.apache.org/licenses/LICENSE-2.0 Apache 2.0]) sample code to read and write [[xoxo]] files in Python (with Perl, PHP, ... to follow).<br />
== xoxo.py ==<br />
<pre><nowiki><br />
# -*- coding: utf-8 -*-<br />
"""xoxo.py - a utility module for transforming to and from the XHTMLOutlines format XOXO<br />
toXOXO takes a Python datastructure (tuples, lists or dictionaries, arbitrarily nested) and returns a XOXO representation of it.<br />
fromXOXO parses an XHTML file for a xoxo list and returns the structure<br />
"""<br />
__version__ = "0.8"<br />
__date__ = "2004-10-05"<br />
__author__ = "Kevin Marks <kmarks@technorati.com>"<br />
__copyright__ = "Copyright 2004, Kevin marks & Technorati"<br />
__license__ = "http://creativecommons.org/licenses/by/2.0/ CC-by-2.0], [http://www.apache.org/licenses/LICENSE-2.0 Apache 2.0"<br />
__credits__ = """Tantek Çelik and Mark Pilgrim for data structure"""<br />
__history__ = """<br />
TODO: add <title> tag<br />
TODO: add a proper profile link<br />
0.8 work in unicode then render to utf-8<br />
0.7 initial encoding support - just utf-8 for now<br />
0.6 support the special behaviour for url properties to/from <a><br />
0.5 fix some awkward side effects of whitespace and text outside our expected tags; simplify writing code<br />
0.4 add correct XHTML headers so it validates<br />
0.3 read/write version; fixed invlaid nested list generation;<br />
0.1 first write-only version<br />
"""<br />
<br />
try:<br />
True, False<br />
except NameError:<br />
True, False = not not 1, not 1<br />
containerTags={'ol':False,'ul':False,'dl':False}<br />
import sgmllib, urllib, urlparse, re<br />
def makeXOXO(struct,className=None,depth=0):<br />
s=u''<br />
if isinstance(struct,list) or isinstance(struct,tuple):<br />
if className:<br />
s += u'<ol class="%s">' % className<br />
else:<br />
s+= u"<ol>"<br />
if isinstance(struct,dict):<br />
d=struct.copy()<br />
if d.has_key('url'):<br />
s+=u'<a href="%s" ' % d['url']<br />
text = d.get('text',d.get('title',d['url']))<br />
for attr in ('title','rel','type'):<br />
if d.has_key(attr):<br />
xVal = makeXOXO(d[attr],None,depth+1)<br />
s +=u'%s="%s" ' % (attr,xVal)<br />
del d[attr]<br />
s +=u'>%s</a>' % makeXOXO(text,None,depth+1)<br />
if d.has_key('text'):<br />
del d['text']<br />
del d['url']<br />
if len(d):<br />
s +=u"<dl>"<br />
for key,value in d.items():<br />
xVal = makeXOXO(value,None,depth+1)<br />
s+= u'<dt>%s</dt><dd>%s</dd>' % (key, xVal)<br />
s +=u"</dl>"<br />
elif type(struct) ==type((1,))or type(struct) ==type([1,]):<br />
for item in struct:<br />
s+=u"<li>" + makeXOXO(item,None,depth+1)+"</li>"<br />
s +=u"</ol>"<br />
elif type(struct) == type(u'unicode'):<br />
s+=struct<br />
else:<br />
if not type(struct)==type(' '):<br />
struct=str(struct)<br />
try:<br />
s+=unicode(struct,'utf-8')<br />
except:<br />
s+=unicode(struct,'windows_1252')<br />
return s<br />
class xoxoParser(sgmllib.SGMLParser):<br />
def __init__(self):<br />
sgmllib.SGMLParser.__init__(self)<br />
self.structs=[]<br />
self.xostack=[]<br />
self.textstack=['']<br />
def normalize_attrs(self, attrs):<br />
attrs = [(k.lower(), sgmllib.charref.sub(lambda m: chr(int(m.groups()[0])), v).strip()) for k, v in attrs]<br />
attrs = [(k, k in ('rel','type') and v.lower() or v) for k, v in attrs]<br />
return attrs<br />
def pushStruct(self,struct):<br />
if type(struct) == type({}) and len(struct)==0 and len(self.structs) and type(self.structs[-1]) == type({}) and self.structs[-1].has_key('url'):<br />
self.xostack.append(self.structs[-1]) # put back the <a>-made one for extra def's<br />
else:<br />
self.structs.append(struct)<br />
self.xostack.append(self.structs[-1])<br />
def start_a(self,attrs):<br />
attrsD = dict(self.normalize_attrs(attrs))<br />
attrsD['url']= attrsD.get('href','')<br />
del attrsD['href']<br />
self.pushStruct(attrsD)<br />
self.textstack.append('')<br />
def end_a(self):<br />
val = self.textstack.pop()<br />
if val: <br />
if self.xostack[-1].get('title','') == val:<br />
val=''<br />
if self.xostack[-1]['url'] == val:<br />
val=''<br />
if val:<br />
self.xostack[-1]['text']=val<br />
self.xostack.pop()<br />
def start_dl(self,attrs):<br />
self.pushStruct({})<br />
def end_dl(self):<br />
self.xostack.pop()<br />
def start_ol(self,attrs):<br />
self.pushStruct([])<br />
def end_ol(self):<br />
self.xostack.pop()<br />
def start_ul(self,attrs):<br />
self.pushStruct([])<br />
def end_ul(self):<br />
self.xostack.pop()<br />
def start_li(self,attrs):<br />
self.textstack.append('')<br />
def end_li(self):<br />
val = self.textstack.pop()<br />
if self.structs[-1] != self.xostack[-1]:<br />
val = self.structs.pop()<br />
self.xostack[-1].append(val)<br />
def start_dt(self,attrs):<br />
self.textstack.append('')<br />
def end_dt(self):<br />
pass<br />
def start_dd(self,attrs):<br />
self.textstack.append('')<br />
def end_dd(self):<br />
val = self.textstack.pop()<br />
key = self.textstack.pop()<br />
if self.structs[-1] != self.xostack[-1]:<br />
val = self.structs.pop()<br />
self.xostack[-1][key]=val<br />
def handle_data(self, text):<br />
if len(self.stack) and containerTags.get(self.stack[-1],True): #skip text not within an element<br />
self.textstack[-1] += text<br />
def toXOXO(struct,addHTMLWrapper=False,cssUrl=''):<br />
if type(struct) ==type((1,))or type(struct) ==type([1,]):<br />
inStruct = struct<br />
else:<br />
inStruct = [struct]<br />
if addHTMLWrapper:<br />
s= '''<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN<br />
http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><br />
<html xmlns="http://www.w3.org/1999/xhtml"><head profile=""><meta http-equiv="Content-Type" content="text/html; charset=utf-8" />'''<br />
if cssUrl:<br />
s+='<style type="text/css" >@import "%s";</style>' % cssUrl<br />
s+="</head><body>%s</body></html>" % makeXOXO(inStruct,'xoxo')<br />
return s.encode('utf-8')<br />
else:<br />
return makeXOXO(inStruct,'xoxo').encode('utf-8')<br />
<br />
import sys<br />
<br />
def fromXOXO(html):<br />
parser = xoxoParser()<br />
parser.feed(unicode(html,'utf-8'))<br />
#print >>sys.stderr, parser.structs<br />
structs=[struct for struct in parser.structs if struct]<br />
#print >>sys.stderr, structs<br />
while (len(structs) ==1 and type(structs)==type([1,])):<br />
structs=structs[0]<br />
return structs<br />
<br />
# Allow direct invocation<br />
# Read HTML from URL, parse into data structures, then re-output<br />
<br />
if __name__ == "__main__":<br />
if len(sys.argv) < 2: raise SystemExit("Usage: "+sys.argv[0]+" url\n"+__doc__)<br />
url=sys.argv[1]<br />
file = urllib.urlopen(url)<br />
html=file.read(-1)<br />
file.close<br />
s=fromXOXO(html)<br />
p=toXOXO(s,True)<br />
print p<br />
<br />
</nowiki></pre><br />
<br />
== testxoxo.py ==<br />
<pre><nowiki><br />
# -*- coding: utf-8 -*-<br />
"""testxoxo.py <br />
Unit tests for xoxo.py<br />
This file tests the functions in xoxo.py <br />
The underlying model here is http://diveintopython.org/unit_testing/index.html <br />
<br />
run from command line with<br />
python testxoxo.py -v<br />
"""<br />
import xoxo<br />
reload(xoxo)<br />
import unittest<br />
<br />
class xoxoTestCases(unittest.TestCase):<br />
<br />
def testSimpleList(self):<br />
'''make a xoxo file from a list'''<br />
l = ['1','2','3']<br />
html = xoxo.toXOXO(l)<br />
self.assertEqual(html,'<ol class="xoxo"><li>1</li><li>2</li><li>3</li></ol>')<br />
def testNestedList(self):<br />
'''make a xoxo file from a list with a list in'''<br />
l = ['1',['2','3']]<br />
html = xoxo.toXOXO(l)<br />
self.assertEqual(html,'<ol class="xoxo"><li>1</li><li><ol><li>2</li><li>3</li></ol></li></ol>')<br />
<br />
def testDictionary(self):<br />
'''make a xoxo file from a dictionary'''<br />
d = {'test':'1','name':'Kevin'}<br />
html = xoxo.toXOXO(d)<br />
self.assertEqual(html,'<ol class="xoxo"><li><dl><dt>test</dt><dd>1</dd><dt>name</dt><dd>Kevin</dd></dl></li></ol>')<br />
<br />
def testSingleItem(self):<br />
'''make a xoxo file from a string'''<br />
l = "test"<br />
html = xoxo.toXOXO(l)<br />
self.assertEqual(html,'<ol class="xoxo"><li>test</li></ol>')<br />
<br />
def testWrapDiffers(self):<br />
'''make a xoxo file from a string with and without html wrapper and check they are different'''<br />
l = "test"<br />
html = xoxo.toXOXO(l)<br />
htmlwrap = xoxo.toXOXO(l,addHTMLWrapper=True)<br />
self.failIfEqual(html,htmlwrap)<br />
<br />
def testWrapSingleItem(self):<br />
'''make a wrapped xoxo file from a string'''<br />
l = "test"<br />
html = xoxo.toXOXO(l,addHTMLWrapper=True)<br />
self.assertEqual(html,'''<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN<br />
http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><br />
<html xmlns="http://www.w3.org/1999/xhtml"><head profile=""></head><body><ol class="xoxo"><li>test</li></ol></body></html>''')<br />
<br />
def testDictionaryRoundTrip(self):<br />
''' make a dictionary into a xoxo file and back again; check it is the same'''<br />
d = {'test':'1','name':'Kevin'}<br />
html = xoxo.toXOXO(d)<br />
newd = xoxo.fromXOXO(html)<br />
self.assertEqual(d,newd)<br />
<br />
def testListRoundTrip(self):<br />
''' make a list into a xoxo file and back again; check it is the same'''<br />
l = ['3','2','1']<br />
html = xoxo.toXOXO(l)<br />
newdl= xoxo.fromXOXO(html)<br />
self.assertEqual(l,newdl)<br />
def testListofDictsRoundTrip(self):<br />
''' make a list of Dicts into a xoxo file and back again; check it is the same'''<br />
l = ['3',{'a':'2'},{'b':'1','c':'4'}]<br />
html = xoxo.toXOXO(l)<br />
newdl= xoxo.fromXOXO(html)<br />
self.assertEqual(l,newdl)<br />
def testListofListsRoundTrip(self):<br />
''' make a list of Lists into a xoxo file and back again; check it is the same'''<br />
l = ['3',['a','2'],['b',['1',['c','4']]]]<br />
html = xoxo.toXOXO(l)<br />
newdl= xoxo.fromXOXO(html)<br />
self.assertEqual(l,newdl)<br />
def testDictofListsRoundTrip(self):<br />
''' make a dict with lists in into a xoxo file and back again; check it is the same'''<br />
d = {'test':['1','2'],<br />
'name':'Kevin',<br />
'nestlist':['a',['b','c']],<br />
'nestdict':{'e':'6','f':'7'}}<br />
html = xoxo.toXOXO(d)<br />
newd = xoxo.fromXOXO(html)<br />
self.assertEqual(d,newd)<br />
<br />
def testXOXOjunkInContainers(self):<br />
'''make sure text outside <li> etc is ignored'''<br />
d=xoxo.fromXOXO('<ol>bad<li><dl>worse<dt>good</dt><dd>buy</dd> now</dl></li></ol>')<br />
self.assertEqual(d,{'good': 'buy'})<br />
def testXOXOjunkInElements(self):<br />
'''make sure text within <li> but outside a subcontainer is ignored'''<br />
l=xoxo.fromXOXO('<ol><li>bad<dl><dt>good</dt><dd>buy</dd></dl>worse</li><li>bag<ol><li>OK</li></ol>fish</li></ol>')<br />
self.assertEqual(l,[{'good': 'buy'},['OK']])<br />
def testXOXOWithSpacesAndNewlines(self):<br />
'''unmung some xoxo with spaces in and check result is right'''<br />
xoxoSample= '''<ol class='xoxo'> <br />
<li><br />
<dl><br />
<dt>text</dt><br />
<dd>item 1</dd><br />
<dt>description</dt><br />
<dd> This item represents the main point we're trying to make.</dd><br />
<dt>url</dt><br />
<dd>http://example.com/more.xoxo</dd><br />
<dt>title</dt><br />
<dd>title of item 1</dd><br />
<dt>type</dt><br />
<dd>text/xml</dd><br />
<dt>rel</dt><br />
<dd>help</dd><br />
</dl><br />
</li><br />
</ol>'''<br />
d = xoxo.fromXOXO(xoxoSample)<br />
d2={'text':'item 1',<br />
'description':" This item represents the main point we're trying to make.",<br />
'url':'http://example.com/more.xoxo',<br />
'title':'title of item 1',<br />
'type':'text/xml',<br />
'rel':'help'<br />
}<br />
xoxoAgain = xoxo.toXOXO(d)<br />
self.assertEqual(d,d2)<br />
#this needs a smarter whitespace-sensitive comparison<br />
#self.assertEqual(xoxoSample,xoxoAgain)<br />
<br />
def testSpecialAttributeDecoding(self):<br />
'''unmung some xoxo with <a href=' rel= etc in and check result is right'''<br />
xoxoSample= '''<ol class='xoxo'> <br />
<li><br />
<dl><br />
<dt>text</dt><br />
<dd>item 1</dd><br />
<dt>url</dt><br />
<dd>http://example.com/more.xoxo</dd><br />
<dt>title</dt><br />
<dd>title of item 1</dd><br />
<dt>type</dt><br />
<dd>text/xml</dd><br />
<dt>rel</dt><br />
<dd>help</dd><br />
</dl><br />
</li><br />
</ol>'''<br />
d = xoxo.fromXOXO(xoxoSample)<br />
smartxoxoSample= '''<ol class='xoxo'> <br />
<li><a href="http://example.com/more.xoxo"<br />
title="title of item 1"<br />
type="text/xml"<br />
rel="help">item 1</a> <br />
<!-- note how the "text" property is simply the contents of the <a> element --><br />
</li><br />
</ol>'''<br />
d2 = xoxo.fromXOXO(smartxoxoSample)<br />
self.assertEqual(d,d2)<br />
def testSpecialAttributeAndDLDecoding(self):<br />
'''unmung some xoxo with <a href=' rel= etc in plus a <dl> in the same item and check result is right'''<br />
xoxoSample= '''<ol class="xoxo"> <br />
<li><br />
<dl><br />
<dt>text</dt><br />
<dd>item 1</dd><br />
<dt>description</dt><br />
<dd> This item represents the main point we're trying to make.</dd><br />
<dt>url</dt><br />
<dd>http://example.com/more.xoxo</dd><br />
<dt>title</dt><br />
<dd>title of item 1</dd><br />
<dt>type</dt><br />
<dd>text/xml</dd><br />
<dt>rel</dt><br />
<dd>help</dd><br />
</dl><br />
</li><br />
</ol>'''<br />
d = xoxo.fromXOXO(xoxoSample)<br />
smartxoxoSample= '''<ol class="xoxo"> <br />
<li><a href="http://example.com/more.xoxo"<br />
title="title of item 1"<br />
type="text/xml"<br />
rel="help">item 1</a> <br />
<!-- note how the "text" property is simply the contents of the <a> element --><br />
<dl><br />
<dt>description</dt><br />
<dd> This item represents the main point we're trying to make.</dd><br />
</dl><br />
</li><br />
</ol>'''<br />
d2 = xoxo.fromXOXO(smartxoxoSample)<br />
self.assertEqual(d,d2)<br />
def testSpecialAttributeEncode(self):<br />
'''check it makes an <a href with a url parameter'''<br />
d={'url':'http://example.com/more.xoxo','title':'sample url','type':"text/xml",'rel':'help','text':'an example'}<br />
html=xoxo.toXOXO(d)<br />
expectedHTML= '<ol class="xoxo"><li><a href="http://example.com/more.xoxo" title="sample url" rel="help" type="text/xml" >an example</a></li></ol>' <br />
self.assertEqual(html,expectedHTML)<br />
<br />
def testSpecialAttributeRoundTripFull(self):<br />
'''check it makes an <a href with a url parameter'''<br />
d={'url':'http://example.com/more.xoxo','title':'sample url','type':"text/xml",'rel':'help','text':'an example'}<br />
html=xoxo.toXOXO(d)<br />
self.assertEqual(d,xoxo.fromXOXO(html))<br />
def testSpecialAttributeRoundTripNoText(self):<br />
'''check it makes an <a href with a url parameter and no text attribute'''<br />
d={'url':'http://example.com/more.xoxo','title':'sample url','type':"text/xml",'rel':'help'}<br />
html=xoxo.toXOXO(d)<br />
self.assertEqual(d,xoxo.fromXOXO(html))<br />
def testSpecialAttributeRoundTripNoTextOrTitle(self):<br />
'''check it makes an <a href with a url parameter and no text or title attribute'''<br />
d={'url':'http://example.com/more.xoxo'}<br />
html=xoxo.toXOXO(d)<br />
self.assertEqual(d,xoxo.fromXOXO(html))<br />
def testUnicodeRoundtrip(self):<br />
'''check unicode characters can go to xoxo and back'''<br />
src=unicode('Tantek Çelik and a snowman ?','utf-8')<br />
html = html=xoxo.toXOXO(src)<br />
self.assertEqual(src,xoxo.fromXOXO(html))<br />
if __name__ == "__main__":<br />
unittest.main()<br />
else:<br />
runner = unittest.TextTestRunner()<br />
suite = unittest.makeSuite(xoxoTestCases,'test')<br />
runner.run(suite)<br />
<br />
</nowiki></pre><br />
<br />
= Java =<br />
== XOXOWriter.java ==<br />
<pre><nowiki><br />
package org.atompub.draft.xoxo;<br />
<br />
import java.util.*;<br />
<br />
public class XOXOWriter {<br />
<br />
public String[] attrs = {"title","rel","type"};<br />
<br />
public String makeXOXO(List struct, String className){<br />
return makeXOXO(struct, className, 0, true);<br />
}<br />
<br />
public String makeXOXO(List struct, String className,<br />
boolean doNSDeclaration){<br />
return makeXOXO(struct, className, 0, doNSDeclaration);<br />
}<br />
<br />
public String makeXOXO(List struct){<br />
return makeXOXO(struct, "xoxo", 0, true);<br />
}<br />
<br />
public String makeXOXO(Object struct, int depth){<br />
return makeXOXO(struct, null, 0, false);<br />
}<br />
<br />
public String makeXOXO(Object struct, String className,<br />
int depth, boolean doNSDeclaration){<br />
if(struct == null) return "";<br />
StringBuffer sb = new StringBuffer();<br />
if(struct instanceof Object[]){<br />
struct = Arrays.asList((Object[]) struct);<br />
}<br />
if(struct instanceof List){<br />
sb.append("<ol");<br />
if(doNSDeclaration)<br />
sb.append(" xmlns=\"http://www.w3.org/1999/xhtml\"");<br />
if(className != null){<br />
sb.append(" class=\"");<br />
sb.append(className);<br />
sb.append("\"");<br />
}<br />
sb.append(">");<br />
}<br />
if(struct instanceof Map){<br />
Map d = new LinkedHashMap((Map) struct);<br />
if(d.containsKey("url")){<br />
sb.append("<a href=\"" + d.get("url") + "\" ");<br />
Object text;<br />
if(d.containsKey("text")){<br />
text = d.get("text");<br />
}else if(d.containsKey("title")){<br />
text = d.get("title");<br />
}else{<br />
text = d.get("url");<br />
}<br />
for(int i=0; i<attrs.length; i++){<br />
String xVal = makeXOXO(d.get(attrs[i]),depth+1);<br />
if(xVal != null && !xVal.equals("")){<br />
sb.append(attrs[i] + "=\"" + xVal + "\" ");<br />
}<br />
d.remove(attrs[i]);<br />
}<br />
sb.append(">" + makeXOXO(text, depth+1) + "</a>");<br />
d.remove("text");<br />
d.remove("url");<br />
}<br />
if(d.size() > 0){<br />
sb.append("<dl>");<br />
for(Iterator i = d.keySet().iterator(); i.hasNext();){<br />
Object k = i.next();<br />
String ddVal = makeXOXO(d.get(k),depth+1);<br />
sb.append("<dt>" + k + "</dt>");<br />
sb.append("<dd>" + ddVal + "</dd>");<br />
}<br />
sb.append("</dl>");<br />
}<br />
}else if(struct instanceof List){<br />
List l = (List) struct;<br />
for(Iterator i = l.iterator(); i.hasNext();){<br />
Object item = i.next();<br />
sb.append("<li>" + makeXOXO(item,depth+1) + "</li>");<br />
}<br />
sb.append("</ol>");<br />
}else{<br />
sb.append(struct);<br />
}<br />
return sb.toString();<br />
}<br />
<br />
public String toXOXO(List struct){<br />
return toXOXO(struct, false, null);<br />
}<br />
<br />
public String toXOXO(Object struct){<br />
List alist = new ArrayList();<br />
alist.add(struct);<br />
return toXOXO(alist);<br />
}<br />
<br />
public String toXOXO(Object struct,<br />
boolean addHTMLWrapper,<br />
String cssUrl){<br />
List alist = new ArrayList();<br />
alist.add(struct);<br />
return toXOXO(alist, addHTMLWrapper, cssUrl);<br />
}<br />
<br />
public String toXOXO(List struct,<br />
boolean addHTMLWrapper,<br />
String cssUrl){<br />
String startHTML = "<!DOCTYPE html PUBLIC \"-//W3C//DTD"<br />
+ "XHTML 1.0 Transitional//EN\n"<br />
+ "http://www.w3.org/TR/xhtml1/DTD/"<br />
+ "xhtml1-transitional.dtd\">"<br />
+ "<html xmlns=\"http://www.w3.org/1999/xhtml\">"<br />
+ "<head>";<br />
if(addHTMLWrapper){<br />
String s = startHTML;<br />
if(cssUrl != null){<br />
s += "<style type=\"text/css\">@import \""<br />
+ cssUrl + "\";</style>";<br />
}<br />
s += "</head><body>" + makeXOXO(struct, "xoxo", false)<br />
+ "</body></html>";<br />
return s;<br />
}else{<br />
return makeXOXO(struct, "xoxo");<br />
}<br />
}<br />
}<br />
</nowiki></pre><br />
<br />
== XOXOParser.java ==<br />
<pre><nowiki><br />
package org.atompub.draft.xoxo;<br />
<br />
import org.xml.sax.InputSource;<br />
import org.xml.sax.SAXException;<br />
import org.xml.sax.XMLReader;<br />
import org.xml.sax.Attributes;<br />
import org.xml.sax.helpers.XMLReaderFactory;<br />
import org.xml.sax.helpers.DefaultHandler;<br />
<br />
import java.util.*;<br />
import java.io.InputStream;<br />
import java.io.StringReader;<br />
import java.io.IOException;<br />
<br />
public class XOXOParser extends DefaultHandler {<br />
<br />
protected String XHTML_NS = "http://www.w3.org/1999/xhtml";<br />
protected List elStack;<br />
protected Map listEls;<br />
public List structs;<br />
public List xoStack;<br />
public List textStack;<br />
<br />
public XOXOParser() {<br />
reset();<br />
}<br />
<br />
protected void pushStruct(Object struct){<br />
if((struct instanceof Map) && (((Map) struct).size() > 0)<br />
&& (structs.get(structs.size()-1) instanceof Map)<br />
&& (((Map) struct).containsKey("url"))){<br />
// put back the <a>-made one for extra defs<br />
xoStack.add(structs.get(structs.size()-1));<br />
}else{<br />
structs.add(struct);<br />
xoStack.add(struct);<br />
}<br />
}<br />
<br />
public void startElement(String nsUri, String localName,<br />
String qName, Attributes atts){<br />
// bounce non-XHTML elements<br />
if(nsUri.equals(XHTML_NS)){<br />
elStack.add(localName);<br />
}else{<br />
elStack.add("foo");<br />
return;<br />
}<br />
<br />
if(localName.equals("a")){<br />
Map attmap = new LinkedHashMap();<br />
int len = atts.getLength();<br />
for(int i=0; i<len; i++){<br />
attmap.put(atts.getQName(i),atts.getValue(i));<br />
}<br />
if(attmap.containsKey("href")){<br />
attmap.put("url",attmap.get("href"));<br />
attmap.remove("href");<br />
}<br />
pushStruct(attmap);<br />
textStack.add("");<br />
}else if(localName.equals("dl")){<br />
pushStruct(new LinkedHashMap());<br />
}else if(localName.equals("ol")){<br />
pushStruct(new ArrayList());<br />
}else if(localName.equals("ul")){<br />
pushStruct(new ArrayList());<br />
}else if(localName.equals("li")){<br />
textStack.add("");<br />
}else if(localName.equals("dt")){<br />
textStack.add("");<br />
}else if(localName.equals("dd")){<br />
textStack.add("");<br />
}<br />
}<br />
<br />
public void endElement(String nsUri, String localName,<br />
String qName){<br />
elStack.remove(elStack.size()-1);<br />
// bounce non-XHTML elements<br />
if(nsUri != XHTML_NS){<br />
return;<br />
}<br />
<br />
if(localName.equals("a")){<br />
String val = (String) textStack.remove(textStack.size()-1);<br />
if (val.length() > 0){<br />
Map defs = (Map) xoStack.get(xoStack.size()-1);<br />
String defVal = (String) defs.get("title");<br />
if((defVal != null) && (val.equals(defVal))){<br />
val = "";<br />
}<br />
defVal = (String) defs.get("url");<br />
if((defVal != null) && (val.equals(defVal))){<br />
val = "";<br />
}<br />
if(val.length() > 0){<br />
defs.put("text",val);<br />
}<br />
}<br />
xoStack.remove(xoStack.size()-1);<br />
}else if(localName.equals("dl")){<br />
xoStack.remove(xoStack.size()-1);<br />
}else if(localName.equals("ol")){<br />
xoStack.remove(xoStack.size()-1);<br />
}else if(localName.equals("ul")){<br />
xoStack.remove(xoStack.size()-1);<br />
}else if(localName.equals("li")){<br />
Object val = textStack.remove(textStack.size()-1);<br />
List last = (List) xoStack.get(xoStack.size()-1);<br />
if(structs.get(structs.size()-1) != last){<br />
val = structs.remove(structs.size()-1);<br />
}<br />
last.add(val);<br />
}else if(localName.equals("dd")){<br />
Object val = textStack.remove(textStack.size()-1);<br />
Object key = textStack.remove(textStack.size()-1);<br />
Map last = (Map) xoStack.get(xoStack.size()-1);<br />
if(structs.get(structs.size()-1) != last){<br />
val = structs.remove(structs.size()-1);<br />
}<br />
last.put(key,val);<br />
}<br />
}<br />
<br />
public void characters(char[] ch, int start, int length){<br />
if((xoStack.size() > 0)<br />
&& (!listEls.containsKey(elStack.get(elStack.size()-1)))){<br />
String text = (String) textStack.get(textStack.size()-1);<br />
String test = new String(ch,start,length);<br />
textStack.set(textStack.size()-1,text+test);<br />
}<br />
}<br />
<br />
public Object parse(String s) throws SAXException, IOException{<br />
return parse(new InputSource(new StringReader(s)));<br />
}<br />
<br />
public Object parse(InputStream is) throws SAXException, IOException {<br />
return parse(new InputSource(is));<br />
}<br />
<br />
public Object parse(InputSource in) throws SAXException, IOException {<br />
XMLReader parser = XMLReaderFactory.createXMLReader();<br />
parser.setContentHandler(this);<br />
parser.parse(in);<br />
List returnList = new ArrayList();<br />
for(Iterator i = this.structs.iterator(); i.hasNext();){<br />
Object thing = i.next();<br />
if(thing != null){<br />
returnList.add(thing);<br />
}<br />
}<br />
while((returnList.size()==1)){<br />
if(returnList.get(0) instanceof List){<br />
returnList = (List) returnList.get(0);<br />
}else{<br />
reset();<br />
return returnList.get(0);<br />
}<br />
}<br />
reset();<br />
return returnList;<br />
}<br />
<br />
protected void reset(){<br />
elStack = new ArrayList();<br />
listEls = new HashMap();<br />
structs = new ArrayList();<br />
xoStack = new ArrayList();<br />
textStack = new ArrayList();<br />
listEls.put("ol","ol");<br />
listEls.put("ul","ul");<br />
listEls.put("dl","dl");<br />
}<br />
}<br />
<br />
</nowiki></pre><br />
<br />
== XOXOTest.java ==<br />
<pre><nowiki><br />
package org.atompub.draft.xoxo.tests;<br />
<br />
import junit.framework.TestSuite;<br />
import junit.framework.TestCase;<br />
import junit.textui.TestRunner;<br />
import org.atompub.draft.xoxo.XOXOWriter;<br />
import org.atompub.draft.xoxo.XOXOParser;<br />
<br />
import java.util.*;<br />
<br />
public class XOXOTest extends TestCase {<br />
<br />
public static void main(String[] args) {<br />
new TestRunner().doRun(new TestSuite(XOXOTest.class));<br />
}<br />
String XHTML_DEC = "xmlns=\"http://www.w3.org/1999/xhtml\" ";<br />
public String simpleListHTML = "<ol "<br />
+ XHTML_DEC<br />
+ "class=\"xoxo\">"<br />
+ "<li>1</li><li>2</li><li>3</li></ol>";<br />
<br />
public void testSimpleList(){<br />
String [] numbers = {"1","2","3"};<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(simpleListHTML,<br />
xoxo.toXOXO(Arrays.asList(numbers)));<br />
}<br />
<br />
public void testStringIntegerList(){<br />
Object[] numbers = {new Integer(1),"2","3"};<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(simpleListHTML,<br />
xoxo.toXOXO(Arrays.asList(numbers)));<br />
}<br />
<br />
public String nestedListHTML = "<ol "<br />
+ XHTML_DEC<br />
+ "class=\"xoxo\"><li>1</li><li>"<br />
+ "<ol><li>2</li><li>3</li></ol></li></ol>";<br />
<br />
public void testNestedList(){<br />
Object[] arr = {"2","3"};<br />
Object[] nested = {"1",Arrays.asList(arr)};<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(nestedListHTML,<br />
xoxo.toXOXO(Arrays.asList(nested)));<br />
}<br />
<br />
public void testNestedArray(){<br />
Object[] arr = {"2","3"};<br />
Object[] nested = {"1",arr};<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(nestedListHTML,<br />
xoxo.toXOXO(Arrays.asList(nested)));<br />
}<br />
<br />
public String dictHTML = "<ol "<br />
+ XHTML_DEC<br />
+ "class=\"xoxo\">"<br />
+ "<li><dl><dt>test</dt><dd>1</dd><dt>name</dt>"<br />
+ "<dd>Kevin</dd></dl></li></ol>";<br />
<br />
public void testDictionary(){<br />
Map dict = new LinkedHashMap();<br />
dict.put("test", new Integer(1));<br />
dict.put("name", "Kevin");<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(dictHTML,<br />
xoxo.toXOXO(dict));<br />
}<br />
<br />
public String singleHTML = "<ol "<br />
+ XHTML_DEC<br />
+ "class=\"xoxo\">"<br />
+ "<li>test</li></ol>";<br />
<br />
public void testSingleItem(){<br />
String item = "test";<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(singleHTML,<br />
xoxo.toXOXO(item));<br />
}<br />
<br />
public void testWrapDiffers(){<br />
String item = "test";<br />
XOXOWriter xoxo = new XOXOWriter();<br />
String nowrap = xoxo.toXOXO(item);<br />
Object[] itemArr = {item};<br />
String wrap = xoxo.toXOXO(Arrays.asList(itemArr),true,null);<br />
assertFalse(wrap.equals(nowrap));<br />
}<br />
<br />
String startHTML = "<!DOCTYPE html PUBLIC \"-//W3C//DTD"<br />
+ "XHTML 1.0 Transitional//EN\n"<br />
+ "http://www.w3.org/TR/xhtml1/DTD/"<br />
+ "xhtml1-transitional.dtd\">"<br />
+ "<html xmlns=\"http://www.w3.org/1999/xhtml\">"<br />
+ "<head></head><body>";<br />
public String singleWrapHTML = "<ol "<br />
+ "class=\"xoxo\">"<br />
+ "<li>test</li></ol>";<br />
public String endHTML = "</body></html>";<br />
<br />
public void testWrapSingleItem(){<br />
String item = "test";<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(startHTML + singleWrapHTML + endHTML,<br />
xoxo.toXOXO(item,true,null));<br />
}<br />
<br />
public void testXOXOParser(){<br />
XOXOParser parser = new XOXOParser();<br />
try{<br />
parser.parse(dictHTML);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testDictRoundTrip(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("test", "1");<br />
dict.put("name", "Kevin");<br />
String html = xoxo.toXOXO(dict);<br />
try{<br />
Object newDict = parser.parse(html);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testListRoundTrip(){<br />
Object[] obj = {"1","2","3"};<br />
List testList = Arrays.asList(obj);<br />
XOXOWriter xoxo = new XOXOWriter();<br />
String html = xoxo.toXOXO(testList);<br />
XOXOParser parser = new XOXOParser();<br />
try{<br />
Object newList = parser.parse(html);<br />
assertEquals(testList,newList);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testListOfDictsRoundTrip(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("test", "1");<br />
dict.put("name", "Kevin");<br />
Map dict2 = new LinkedHashMap();<br />
dict2.put("one", "two");<br />
dict2.put("three", "four");<br />
dict2.put("five", "six");<br />
Object[] obj = {"1",dict,dict2};<br />
List testList = Arrays.asList(obj);<br />
String html = xoxo.toXOXO(testList);<br />
try{<br />
Object newList = parser.parse(html);<br />
assertEquals(testList,newList);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testListOfListsRoundTrip(){<br />
Object[] list1 = {"1","2","3"};<br />
Object[] list2 = {"4","5","6", Arrays.asList(list1)};<br />
Object[] list3 = {"7", Arrays.asList(list2)};<br />
Object[] list4 = {"8", Arrays.asList(list3)};<br />
List testList = Arrays.asList(list4);<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
String html = xoxo.toXOXO(testList);<br />
try{<br />
Object newList = parser.parse(html);<br />
assertEquals(testList,newList);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testDictOfListsRoundTrip(){<br />
Object[] list1 = {"1","2","3"};<br />
Object[] list2 = {"4","5","6"};<br />
Object[] list3 = {"7"};<br />
Object[] list4 = {"8", "9"};<br />
Map dict = new LinkedHashMap();<br />
dict.put("foo", Arrays.asList(list1));<br />
dict.put("bar", Arrays.asList(list2));<br />
dict.put("baz", Arrays.asList(list3));<br />
dict.put("qux", Arrays.asList(list4));<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
String html = xoxo.toXOXO(dict);<br />
try{<br />
Object newDict = parser.parse(html);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public String junkXOXO = "<ol "<br />
+ XHTML_DEC<br />
+ "class=\"xoxo\">"<br />
+ "bad<li><dl>worse<dt>good</dt><dd>buy</dd> now</dl></li></ol>";<br />
<br />
public void testXOXOJunkInContainers(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("good","buy");<br />
try{<br />
Object newDict = parser.parse(junkXOXO);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public String junkElementXOXO = "<ol "<br />
+ XHTML_DEC<br />
+ "><li>bad<dl><dt>good</dt><dd>buy</dd></dl>"<br />
+ "worse</li><li>bag<ol><li>OK</li></ol>fish</li></ol>";<br />
<br />
public void testXOXOjunkInElements(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("good","buy");<br />
Object[] ok = {"OK"};<br />
Object[] obj ={dict, Arrays.asList(ok)};<br />
List testList = Arrays.asList(obj);<br />
try{<br />
Object newList = parser.parse(junkElementXOXO);<br />
assertEquals(testList,newList);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public String xoxoSpacesNewlines = "<ol " + XHTML_DEC +<br />
" class='xoxo'> \n" +<br />
" <li>\n" +<br />
" <dl>\n" +<br />
" <dt>text</dt>\n" +<br />
" <dd>item 1</dd>\n" +<br />
" <dt>description</dt>\n" +<br />
" <dd> This item represents the main" +<br />
" point we're trying to make.</dd>\n" +<br />
" <dt>url</dt>\n" +<br />
" <dd>http://example.com/more.xoxo</dd>\n" +<br />
" <dt>title</dt>\n" +<br />
" <dd>title of item 1</dd>\n" +<br />
" <dt>type</dt>\n" +<br />
" <dd>text/xml</dd>\n" +<br />
" <dt>rel</dt>\n" +<br />
" <dd>help</dd>\n" +<br />
" </dl>\n" +<br />
" </li>\n" +<br />
"</ol>";<br />
<br />
public void testXOXOWithSpacesAndNewlines(){<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("text","item 1");<br />
dict.put("description"," This item represents the main" +<br />
" point we're trying to make.");<br />
dict.put("url","http://example.com/more.xoxo");<br />
dict.put("title","title of item 1");<br />
dict.put("type","text/xml");<br />
dict.put("rel","help");<br />
try{<br />
Object newDict = parser.parse(xoxoSpacesNewlines);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public String xoxoSample = "<ol " + XHTML_DEC +<br />
" class='xoxo'> \n" +<br />
" <li>\n" +<br />
" <dl>\n" +<br />
" <dt>text</dt>\n" +<br />
" <dd>item 1</dd>\n" +<br />
" <dt>url</dt>\n" +<br />
" <dd>http://example.com/more.xoxo</dd>\n" +<br />
" <dt>title</dt>\n" +<br />
" <dd>title of item 1</dd>\n" +<br />
" <dt>type</dt>\n" +<br />
" <dd>text/xml</dd>\n" +<br />
" <dt>rel</dt>\n" +<br />
" <dd>help</dd>\n" +<br />
" </dl>\n" +<br />
" </li>\n" +<br />
"</ol>";<br />
<br />
public String smartXOXOSample = "<ol " + XHTML_DEC +<br />
"class=\"xoxo\"> \n" +<br />
" <li><a href=\"http://example.com/more.xoxo\"\n" +<br />
" title=\"title of item 1\"\n" +<br />
" type=\"text/xml\"\n" +<br />
" rel=\"help\">item 1</a> \n" +<br />
"<!-- note how the \"text\" property is simply" +<br />
" the contents of the <a> element -->\n" +<br />
" </li>\n" +<br />
"</ol>";<br />
<br />
public void testSpecialAttributeDecoding(){<br />
XOXOParser parser = new XOXOParser();<br />
try{<br />
Object xoxoDict = parser.parse(xoxoSample);<br />
Object xoxoDict2 = parser.parse(smartXOXOSample);<br />
assertEquals(xoxoDict,xoxoDict2);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public String specialAttrHTML = "<ol " + XHTML_DEC +<br />
"class=\"xoxo\">" +<br />
"<li><a href=\"http://example.com/more.xoxo\" title=\"sample url\" " +<br />
"rel=\"help\" type=\"text/xml\" >an example</a></li></ol>";<br />
<br />
public void testSpecialAttributeEncode(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
Map dict = new LinkedHashMap();<br />
dict.put("url","http://example.com/more.xoxo");<br />
dict.put("title","sample url");<br />
dict.put("type","text/xml");<br />
dict.put("rel","help");<br />
dict.put("text","an example");<br />
String html = xoxo.toXOXO(dict);<br />
assertEquals(specialAttrHTML,html);<br />
}<br />
<br />
public void testSpecialAttributeRoundTripFull(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("url","http://example.com/more.xoxo");<br />
dict.put("title","sample url");<br />
dict.put("type","text/xml");<br />
dict.put("rel","help");<br />
dict.put("text","an example");<br />
String html = xoxo.toXOXO(dict);<br />
try{<br />
Object newDict = parser.parse(html);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testSpecialAttributeRoundTripNoText(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("url","http://example.com/more.xoxo");<br />
dict.put("title","sample url");<br />
dict.put("type","text/xml");<br />
dict.put("rel","help");<br />
String html = xoxo.toXOXO(dict);<br />
try{<br />
Object newDict = parser.parse(html);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testSpecialAttributeRoundTripNoTextOrTitle(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("url","http://example.com/more.xoxo");<br />
dict.put("type","text/xml");<br />
dict.put("rel","help");<br />
String html = xoxo.toXOXO(dict);<br />
try{<br />
Object newDict = parser.parse(html);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testUnicodeRoundTrip(){<br />
String s = "Tantek Çelik and a snowman ?";<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
String html = xoxo.toXOXO(s);<br />
try{<br />
Object newString = parser.parse(html);<br />
assertEquals(s,newString);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
}<br />
<br />
</nowiki></pre></div>
RobertSayre
http://microformats.org/wiki/index.php?title=xoxo-sample-code&diff=2499
xoxo-sample-code
2005-10-30T19:26:06Z
<p>RobertSayre: </p>
<hr />
<div>= XOXO Sample Code =<br />
<br />
A whole bunch of open source ([http://creativecommons.org/licenses/by/2.0/ CC-by-2.0], [http://www.apache.org/licenses/LICENSE-2.0 Apache 2.0]) sample code to read and write [[xoxo]] files in Python (with Perl, PHP, ... to follow).<br />
== xoxo.py ==<br />
<pre><nowiki><br />
# -*- coding: utf-8 -*-<br />
"""xoxo.py - a utility module for transforming to and from the XHTMLOutlines format XOXO<br />
toXOXO takes a Python datastructure (tuples, lists or dictionaries, arbitrarily nested) and returns a XOXO representation of it.<br />
fromXOXO parses an XHTML file for a xoxo list and returns the structure<br />
"""<br />
__version__ = "0.8"<br />
__date__ = "2004-10-05"<br />
__author__ = "Kevin Marks <kmarks@technorati.com>"<br />
__copyright__ = "Copyright 2004, Kevin marks & Technorati"<br />
__license__ = "http://creativecommons.org/licenses/by/2.0/ CC-by-2.0], [http://www.apache.org/licenses/LICENSE-2.0 Apache 2.0"<br />
__credits__ = """Tantek Çelik and Mark Pilgrim for data structure"""<br />
__history__ = """<br />
TODO: add <title> tag<br />
TODO: add a proper profile link<br />
0.8 work in unicode then render to utf-8<br />
0.7 initial encoding support - just utf-8 for now<br />
0.6 support the special behaviour for url properties to/from <a><br />
0.5 fix some awkward side effects of whitespace and text outside our expected tags; simplify writing code<br />
0.4 add correct XHTML headers so it validates<br />
0.3 read/write version; fixed invlaid nested list generation;<br />
0.1 first write-only version<br />
"""<br />
<br />
try:<br />
True, False<br />
except NameError:<br />
True, False = not not 1, not 1<br />
containerTags={'ol':False,'ul':False,'dl':False}<br />
import sgmllib, urllib, urlparse, re<br />
def makeXOXO(struct,className=None,depth=0):<br />
s=u''<br />
if isinstance(struct,list) or isinstance(struct,tuple):<br />
if className:<br />
s += u'<ol class="%s">' % className<br />
else:<br />
s+= u"<ol>"<br />
if isinstance(struct,dict):<br />
d=struct.copy()<br />
if d.has_key('url'):<br />
s+=u'<a href="%s" ' % d['url']<br />
text = d.get('text',d.get('title',d['url']))<br />
for attr in ('title','rel','type'):<br />
if d.has_key(attr):<br />
xVal = makeXOXO(d[attr],None,depth+1)<br />
s +=u'%s="%s" ' % (attr,xVal)<br />
del d[attr]<br />
s +=u'>%s</a>' % makeXOXO(text,None,depth+1)<br />
if d.has_key('text'):<br />
del d['text']<br />
del d['url']<br />
if len(d):<br />
s +=u"<dl>"<br />
for key,value in d.items():<br />
xVal = makeXOXO(value,None,depth+1)<br />
s+= u'<dt>%s</dt><dd>%s</dd>' % (key, xVal)<br />
s +=u"</dl>"<br />
elif type(struct) ==type((1,))or type(struct) ==type([1,]):<br />
for item in struct:<br />
s+=u"<li>" + makeXOXO(item,None,depth+1)+"</li>"<br />
s +=u"</ol>"<br />
elif type(struct) == type(u'unicode'):<br />
s+=struct<br />
else:<br />
if not type(struct)==type(' '):<br />
struct=str(struct)<br />
try:<br />
s+=unicode(struct,'utf-8')<br />
except:<br />
s+=unicode(struct,'windows_1252')<br />
return s<br />
class xoxoParser(sgmllib.SGMLParser):<br />
def __init__(self):<br />
sgmllib.SGMLParser.__init__(self)<br />
self.structs=[]<br />
self.xostack=[]<br />
self.textstack=['']<br />
def normalize_attrs(self, attrs):<br />
attrs = [(k.lower(), sgmllib.charref.sub(lambda m: chr(int(m.groups()[0])), v).strip()) for k, v in attrs]<br />
attrs = [(k, k in ('rel','type') and v.lower() or v) for k, v in attrs]<br />
return attrs<br />
def pushStruct(self,struct):<br />
if type(struct) == type({}) and len(struct)==0 and len(self.structs) and type(self.structs[-1]) == type({}) and self.structs[-1].has_key('url'):<br />
self.xostack.append(self.structs[-1]) # put back the <a>-made one for extra def's<br />
else:<br />
self.structs.append(struct)<br />
self.xostack.append(self.structs[-1])<br />
def start_a(self,attrs):<br />
attrsD = dict(self.normalize_attrs(attrs))<br />
attrsD['url']= attrsD.get('href','')<br />
del attrsD['href']<br />
self.pushStruct(attrsD)<br />
self.textstack.append('')<br />
def end_a(self):<br />
val = self.textstack.pop()<br />
if val: <br />
if self.xostack[-1].get('title','') == val:<br />
val=''<br />
if self.xostack[-1]['url'] == val:<br />
val=''<br />
if val:<br />
self.xostack[-1]['text']=val<br />
self.xostack.pop()<br />
def start_dl(self,attrs):<br />
self.pushStruct({})<br />
def end_dl(self):<br />
self.xostack.pop()<br />
def start_ol(self,attrs):<br />
self.pushStruct([])<br />
def end_ol(self):<br />
self.xostack.pop()<br />
def start_ul(self,attrs):<br />
self.pushStruct([])<br />
def end_ul(self):<br />
self.xostack.pop()<br />
def start_li(self,attrs):<br />
self.textstack.append('')<br />
def end_li(self):<br />
val = self.textstack.pop()<br />
if self.structs[-1] != self.xostack[-1]:<br />
val = self.structs.pop()<br />
self.xostack[-1].append(val)<br />
def start_dt(self,attrs):<br />
self.textstack.append('')<br />
def end_dt(self):<br />
pass<br />
def start_dd(self,attrs):<br />
self.textstack.append('')<br />
def end_dd(self):<br />
val = self.textstack.pop()<br />
key = self.textstack.pop()<br />
if self.structs[-1] != self.xostack[-1]:<br />
val = self.structs.pop()<br />
self.xostack[-1][key]=val<br />
def handle_data(self, text):<br />
if len(self.stack) and containerTags.get(self.stack[-1],True): #skip text not within an element<br />
self.textstack[-1] += text<br />
def toXOXO(struct,addHTMLWrapper=False,cssUrl=''):<br />
if type(struct) ==type((1,))or type(struct) ==type([1,]):<br />
inStruct = struct<br />
else:<br />
inStruct = [struct]<br />
if addHTMLWrapper:<br />
s= '''<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN<br />
http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><br />
<html xmlns="http://www.w3.org/1999/xhtml"><head profile=""><meta http-equiv="Content-Type" content="text/html; charset=utf-8" />'''<br />
if cssUrl:<br />
s+='<style type="text/css" >@import "%s";</style>' % cssUrl<br />
s+="</head><body>%s</body></html>" % makeXOXO(inStruct,'xoxo')<br />
return s.encode('utf-8')<br />
else:<br />
return makeXOXO(inStruct,'xoxo').encode('utf-8')<br />
<br />
import sys<br />
<br />
def fromXOXO(html):<br />
parser = xoxoParser()<br />
parser.feed(unicode(html,'utf-8'))<br />
#print >>sys.stderr, parser.structs<br />
structs=[struct for struct in parser.structs if struct]<br />
#print >>sys.stderr, structs<br />
while (len(structs) ==1 and type(structs)==type([1,])):<br />
structs=structs[0]<br />
return structs<br />
<br />
# Allow direct invocation<br />
# Read HTML from URL, parse into data structures, then re-output<br />
<br />
if __name__ == "__main__":<br />
if len(sys.argv) < 2: raise SystemExit("Usage: "+sys.argv[0]+" url\n"+__doc__)<br />
url=sys.argv[1]<br />
file = urllib.urlopen(url)<br />
html=file.read(-1)<br />
file.close<br />
s=fromXOXO(html)<br />
p=toXOXO(s,True)<br />
print p<br />
<br />
</nowiki></pre><br />
<br />
== testxoxo.py ==<br />
<pre><nowiki><br />
# -*- coding: utf-8 -*-<br />
"""testxoxo.py <br />
Unit tests for xoxo.py<br />
This file tests the functions in xoxo.py <br />
The underlying model here is http://diveintopython.org/unit_testing/index.html <br />
<br />
run from command line with<br />
python testxoxo.py -v<br />
"""<br />
import xoxo<br />
reload(xoxo)<br />
import unittest<br />
<br />
class xoxoTestCases(unittest.TestCase):<br />
<br />
def testSimpleList(self):<br />
'''make a xoxo file from a list'''<br />
l = ['1','2','3']<br />
html = xoxo.toXOXO(l)<br />
self.assertEqual(html,'<ol class="xoxo"><li>1</li><li>2</li><li>3</li></ol>')<br />
def testNestedList(self):<br />
'''make a xoxo file from a list with a list in'''<br />
l = ['1',['2','3']]<br />
html = xoxo.toXOXO(l)<br />
self.assertEqual(html,'<ol class="xoxo"><li>1</li><li><ol><li>2</li><li>3</li></ol></li></ol>')<br />
<br />
def testDictionary(self):<br />
'''make a xoxo file from a dictionary'''<br />
d = {'test':'1','name':'Kevin'}<br />
html = xoxo.toXOXO(d)<br />
self.assertEqual(html,'<ol class="xoxo"><li><dl><dt>test</dt><dd>1</dd><dt>name</dt><dd>Kevin</dd></dl></li></ol>')<br />
<br />
def testSingleItem(self):<br />
'''make a xoxo file from a string'''<br />
l = "test"<br />
html = xoxo.toXOXO(l)<br />
self.assertEqual(html,'<ol class="xoxo"><li>test</li></ol>')<br />
<br />
def testWrapDiffers(self):<br />
'''make a xoxo file from a string with and without html wrapper and check they are different'''<br />
l = "test"<br />
html = xoxo.toXOXO(l)<br />
htmlwrap = xoxo.toXOXO(l,addHTMLWrapper=True)<br />
self.failIfEqual(html,htmlwrap)<br />
<br />
def testWrapSingleItem(self):<br />
'''make a wrapped xoxo file from a string'''<br />
l = "test"<br />
html = xoxo.toXOXO(l,addHTMLWrapper=True)<br />
self.assertEqual(html,'''<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN<br />
http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><br />
<html xmlns="http://www.w3.org/1999/xhtml"><head profile=""></head><body><ol class="xoxo"><li>test</li></ol></body></html>''')<br />
<br />
def testDictionaryRoundTrip(self):<br />
''' make a dictionary into a xoxo file and back again; check it is the same'''<br />
d = {'test':'1','name':'Kevin'}<br />
html = xoxo.toXOXO(d)<br />
newd = xoxo.fromXOXO(html)<br />
self.assertEqual(d,newd)<br />
<br />
def testListRoundTrip(self):<br />
''' make a list into a xoxo file and back again; check it is the same'''<br />
l = ['3','2','1']<br />
html = xoxo.toXOXO(l)<br />
newdl= xoxo.fromXOXO(html)<br />
self.assertEqual(l,newdl)<br />
def testListofDictsRoundTrip(self):<br />
''' make a list of Dicts into a xoxo file and back again; check it is the same'''<br />
l = ['3',{'a':'2'},{'b':'1','c':'4'}]<br />
html = xoxo.toXOXO(l)<br />
newdl= xoxo.fromXOXO(html)<br />
self.assertEqual(l,newdl)<br />
def testListofListsRoundTrip(self):<br />
''' make a list of Lists into a xoxo file and back again; check it is the same'''<br />
l = ['3',['a','2'],['b',['1',['c','4']]]]<br />
html = xoxo.toXOXO(l)<br />
newdl= xoxo.fromXOXO(html)<br />
self.assertEqual(l,newdl)<br />
def testDictofListsRoundTrip(self):<br />
''' make a dict with lists in into a xoxo file and back again; check it is the same'''<br />
d = {'test':['1','2'],<br />
'name':'Kevin',<br />
'nestlist':['a',['b','c']],<br />
'nestdict':{'e':'6','f':'7'}}<br />
html = xoxo.toXOXO(d)<br />
newd = xoxo.fromXOXO(html)<br />
self.assertEqual(d,newd)<br />
<br />
def testXOXOjunkInContainers(self):<br />
'''make sure text outside <li> etc is ignored'''<br />
d=xoxo.fromXOXO('<ol>bad<li><dl>worse<dt>good</dt><dd>buy</dd> now</dl></li></ol>')<br />
self.assertEqual(d,{'good': 'buy'})<br />
def testXOXOjunkInElements(self):<br />
'''make sure text within <li> but outside a subcontainer is ignored'''<br />
l=xoxo.fromXOXO('<ol><li>bad<dl><dt>good</dt><dd>buy</dd></dl>worse</li><li>bag<ol><li>OK</li></ol>fish</li></ol>')<br />
self.assertEqual(l,[{'good': 'buy'},['OK']])<br />
def testXOXOWithSpacesAndNewlines(self):<br />
'''unmung some xoxo with spaces in and check result is right'''<br />
xoxoSample= '''<ol class='xoxo'> <br />
<li><br />
<dl><br />
<dt>text</dt><br />
<dd>item 1</dd><br />
<dt>description</dt><br />
<dd> This item represents the main point we're trying to make.</dd><br />
<dt>url</dt><br />
<dd>http://example.com/more.xoxo</dd><br />
<dt>title</dt><br />
<dd>title of item 1</dd><br />
<dt>type</dt><br />
<dd>text/xml</dd><br />
<dt>rel</dt><br />
<dd>help</dd><br />
</dl><br />
</li><br />
</ol>'''<br />
d = xoxo.fromXOXO(xoxoSample)<br />
d2={'text':'item 1',<br />
'description':" This item represents the main point we're trying to make.",<br />
'url':'http://example.com/more.xoxo',<br />
'title':'title of item 1',<br />
'type':'text/xml',<br />
'rel':'help'<br />
}<br />
xoxoAgain = xoxo.toXOXO(d)<br />
self.assertEqual(d,d2)<br />
#this needs a smarter whitespace-sensitive comparison<br />
#self.assertEqual(xoxoSample,xoxoAgain)<br />
<br />
def testSpecialAttributeDecoding(self):<br />
'''unmung some xoxo with <a href=' rel= etc in and check result is right'''<br />
xoxoSample= '''<ol class='xoxo'> <br />
<li><br />
<dl><br />
<dt>text</dt><br />
<dd>item 1</dd><br />
<dt>url</dt><br />
<dd>http://example.com/more.xoxo</dd><br />
<dt>title</dt><br />
<dd>title of item 1</dd><br />
<dt>type</dt><br />
<dd>text/xml</dd><br />
<dt>rel</dt><br />
<dd>help</dd><br />
</dl><br />
</li><br />
</ol>'''<br />
d = xoxo.fromXOXO(xoxoSample)<br />
smartxoxoSample= '''<ol class='xoxo'> <br />
<li><a href="http://example.com/more.xoxo"<br />
title="title of item 1"<br />
type="text/xml"<br />
rel="help">item 1</a> <br />
<!-- note how the "text" property is simply the contents of the <a> element --><br />
</li><br />
</ol>'''<br />
d2 = xoxo.fromXOXO(smartxoxoSample)<br />
self.assertEqual(d,d2)<br />
def testSpecialAttributeAndDLDecoding(self):<br />
'''unmung some xoxo with <a href=' rel= etc in plus a <dl> in the same item and check result is right'''<br />
xoxoSample= '''<ol class="xoxo"> <br />
<li><br />
<dl><br />
<dt>text</dt><br />
<dd>item 1</dd><br />
<dt>description</dt><br />
<dd> This item represents the main point we're trying to make.</dd><br />
<dt>url</dt><br />
<dd>http://example.com/more.xoxo</dd><br />
<dt>title</dt><br />
<dd>title of item 1</dd><br />
<dt>type</dt><br />
<dd>text/xml</dd><br />
<dt>rel</dt><br />
<dd>help</dd><br />
</dl><br />
</li><br />
</ol>'''<br />
d = xoxo.fromXOXO(xoxoSample)<br />
smartxoxoSample= '''<ol class="xoxo"> <br />
<li><a href="http://example.com/more.xoxo"<br />
title="title of item 1"<br />
type="text/xml"<br />
rel="help">item 1</a> <br />
<!-- note how the "text" property is simply the contents of the <a> element --><br />
<dl><br />
<dt>description</dt><br />
<dd> This item represents the main point we're trying to make.</dd><br />
</dl><br />
</li><br />
</ol>'''<br />
d2 = xoxo.fromXOXO(smartxoxoSample)<br />
self.assertEqual(d,d2)<br />
def testSpecialAttributeEncode(self):<br />
'''check it makes an <a href with a url parameter'''<br />
d={'url':'http://example.com/more.xoxo','title':'sample url','type':"text/xml",'rel':'help','text':'an example'}<br />
html=xoxo.toXOXO(d)<br />
expectedHTML= '<ol class="xoxo"><li><a href="http://example.com/more.xoxo" title="sample url" rel="help" type="text/xml" >an example</a></li></ol>' <br />
self.assertEqual(html,expectedHTML)<br />
<br />
def testSpecialAttributeRoundTripFull(self):<br />
'''check it makes an <a href with a url parameter'''<br />
d={'url':'http://example.com/more.xoxo','title':'sample url','type':"text/xml",'rel':'help','text':'an example'}<br />
html=xoxo.toXOXO(d)<br />
self.assertEqual(d,xoxo.fromXOXO(html))<br />
def testSpecialAttributeRoundTripNoText(self):<br />
'''check it makes an <a href with a url parameter and no text attribute'''<br />
d={'url':'http://example.com/more.xoxo','title':'sample url','type':"text/xml",'rel':'help'}<br />
html=xoxo.toXOXO(d)<br />
self.assertEqual(d,xoxo.fromXOXO(html))<br />
def testSpecialAttributeRoundTripNoTextOrTitle(self):<br />
'''check it makes an <a href with a url parameter and no text or title attribute'''<br />
d={'url':'http://example.com/more.xoxo'}<br />
html=xoxo.toXOXO(d)<br />
self.assertEqual(d,xoxo.fromXOXO(html))<br />
def testUnicodeRoundtrip(self):<br />
'''check unicode characters can go to xoxo and back'''<br />
src=unicode('Tantek Çelik and a snowman ?','utf-8')<br />
html = html=xoxo.toXOXO(src)<br />
self.assertEqual(src,xoxo.fromXOXO(html))<br />
if __name__ == "__main__":<br />
unittest.main()<br />
else:<br />
runner = unittest.TextTestRunner()<br />
suite = unittest.makeSuite(xoxoTestCases,'test')<br />
runner.run(suite)<br />
<br />
</nowiki></pre><br />
<br />
<pre><nowiki><br />
package org.atompub.draft.xoxo;<br />
<br />
import java.util.*;<br />
<br />
public class XOXOWriter {<br />
<br />
public String[] attrs = {"title","rel","type"};<br />
<br />
public String makeXOXO(List struct, String className){<br />
return makeXOXO(struct, className, 0, true);<br />
}<br />
<br />
public String makeXOXO(List struct, String className,<br />
boolean doNSDeclaration){<br />
return makeXOXO(struct, className, 0, doNSDeclaration);<br />
}<br />
<br />
public String makeXOXO(List struct){<br />
return makeXOXO(struct, "xoxo", 0, true);<br />
}<br />
<br />
public String makeXOXO(Object struct, int depth){<br />
return makeXOXO(struct, null, 0, false);<br />
}<br />
<br />
public String makeXOXO(Object struct, String className,<br />
int depth, boolean doNSDeclaration){<br />
if(struct == null) return "";<br />
StringBuffer sb = new StringBuffer();<br />
if(struct instanceof Object[]){<br />
struct = Arrays.asList((Object[]) struct);<br />
}<br />
if(struct instanceof List){<br />
sb.append("<ol");<br />
if(doNSDeclaration)<br />
sb.append(" xmlns=\"http://www.w3.org/1999/xhtml\"");<br />
if(className != null){<br />
sb.append(" class=\"");<br />
sb.append(className);<br />
sb.append("\"");<br />
}<br />
sb.append(">");<br />
}<br />
if(struct instanceof Map){<br />
Map d = new LinkedHashMap((Map) struct);<br />
if(d.containsKey("url")){<br />
sb.append("<a href=\"" + d.get("url") + "\" ");<br />
Object text;<br />
if(d.containsKey("text")){<br />
text = d.get("text");<br />
}else if(d.containsKey("title")){<br />
text = d.get("title");<br />
}else{<br />
text = d.get("url");<br />
}<br />
for(int i=0; i<attrs.length; i++){<br />
String xVal = makeXOXO(d.get(attrs[i]),depth+1);<br />
if(xVal != null && !xVal.equals("")){<br />
sb.append(attrs[i] + "=\"" + xVal + "\" ");<br />
}<br />
d.remove(attrs[i]);<br />
}<br />
sb.append(">" + makeXOXO(text, depth+1) + "</a>");<br />
d.remove("text");<br />
d.remove("url");<br />
}<br />
if(d.size() > 0){<br />
sb.append("<dl>");<br />
for(Iterator i = d.keySet().iterator(); i.hasNext();){<br />
Object k = i.next();<br />
String ddVal = makeXOXO(d.get(k),depth+1);<br />
sb.append("<dt>" + k + "</dt>");<br />
sb.append("<dd>" + ddVal + "</dd>");<br />
}<br />
sb.append("</dl>");<br />
}<br />
}else if(struct instanceof List){<br />
List l = (List) struct;<br />
for(Iterator i = l.iterator(); i.hasNext();){<br />
Object item = i.next();<br />
sb.append("<li>" + makeXOXO(item,depth+1) + "</li>");<br />
}<br />
sb.append("</ol>");<br />
}else{<br />
sb.append(struct);<br />
}<br />
return sb.toString();<br />
}<br />
<br />
public String toXOXO(List struct){<br />
return toXOXO(struct, false, null);<br />
}<br />
<br />
public String toXOXO(Object struct){<br />
List alist = new ArrayList();<br />
alist.add(struct);<br />
return toXOXO(alist);<br />
}<br />
<br />
public String toXOXO(Object struct,<br />
boolean addHTMLWrapper,<br />
String cssUrl){<br />
List alist = new ArrayList();<br />
alist.add(struct);<br />
return toXOXO(alist, addHTMLWrapper, cssUrl);<br />
}<br />
<br />
public String toXOXO(List struct,<br />
boolean addHTMLWrapper,<br />
String cssUrl){<br />
String startHTML = "<!DOCTYPE html PUBLIC \"-//W3C//DTD"<br />
+ "XHTML 1.0 Transitional//EN\n"<br />
+ "http://www.w3.org/TR/xhtml1/DTD/"<br />
+ "xhtml1-transitional.dtd\">"<br />
+ "<html xmlns=\"http://www.w3.org/1999/xhtml\">"<br />
+ "<head>";<br />
if(addHTMLWrapper){<br />
String s = startHTML;<br />
if(cssUrl != null){<br />
s += "<style type=\"text/css\">@import \""<br />
+ cssUrl + "\";</style>";<br />
}<br />
s += "</head><body>" + makeXOXO(struct, "xoxo", false)<br />
+ "</body></html>";<br />
return s;<br />
}else{<br />
return makeXOXO(struct, "xoxo");<br />
}<br />
}<br />
}<br />
</nowiki></pre><br />
<br />
<pre><nowiki><br />
package org.atompub.draft.xoxo.tests;<br />
<br />
import junit.framework.TestSuite;<br />
import junit.framework.TestCase;<br />
import junit.textui.TestRunner;<br />
import org.atompub.draft.xoxo.XOXOWriter;<br />
import org.atompub.draft.xoxo.XOXOParser;<br />
<br />
import java.util.*;<br />
<br />
public class XOXOTest extends TestCase {<br />
<br />
public static void main(String[] args) {<br />
new TestRunner().doRun(new TestSuite(XOXOTest.class));<br />
}<br />
String XHTML_DEC = "xmlns=\"http://www.w3.org/1999/xhtml\" ";<br />
public String simpleListHTML = "<ol "<br />
+ XHTML_DEC<br />
+ "class=\"xoxo\">"<br />
+ "<li>1</li><li>2</li><li>3</li></ol>";<br />
<br />
public void testSimpleList(){<br />
String [] numbers = {"1","2","3"};<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(simpleListHTML,<br />
xoxo.toXOXO(Arrays.asList(numbers)));<br />
}<br />
<br />
public void testStringIntegerList(){<br />
Object[] numbers = {new Integer(1),"2","3"};<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(simpleListHTML,<br />
xoxo.toXOXO(Arrays.asList(numbers)));<br />
}<br />
<br />
public String nestedListHTML = "<ol "<br />
+ XHTML_DEC<br />
+ "class=\"xoxo\"><li>1</li><li>"<br />
+ "<ol><li>2</li><li>3</li></ol></li></ol>";<br />
<br />
public void testNestedList(){<br />
Object[] arr = {"2","3"};<br />
Object[] nested = {"1",Arrays.asList(arr)};<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(nestedListHTML,<br />
xoxo.toXOXO(Arrays.asList(nested)));<br />
}<br />
<br />
public void testNestedArray(){<br />
Object[] arr = {"2","3"};<br />
Object[] nested = {"1",arr};<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(nestedListHTML,<br />
xoxo.toXOXO(Arrays.asList(nested)));<br />
}<br />
<br />
public String dictHTML = "<ol "<br />
+ XHTML_DEC<br />
+ "class=\"xoxo\">"<br />
+ "<li><dl><dt>test</dt><dd>1</dd><dt>name</dt>"<br />
+ "<dd>Kevin</dd></dl></li></ol>";<br />
<br />
public void testDictionary(){<br />
Map dict = new LinkedHashMap();<br />
dict.put("test", new Integer(1));<br />
dict.put("name", "Kevin");<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(dictHTML,<br />
xoxo.toXOXO(dict));<br />
}<br />
<br />
public String singleHTML = "<ol "<br />
+ XHTML_DEC<br />
+ "class=\"xoxo\">"<br />
+ "<li>test</li></ol>";<br />
<br />
public void testSingleItem(){<br />
String item = "test";<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(singleHTML,<br />
xoxo.toXOXO(item));<br />
}<br />
<br />
public void testWrapDiffers(){<br />
String item = "test";<br />
XOXOWriter xoxo = new XOXOWriter();<br />
String nowrap = xoxo.toXOXO(item);<br />
Object[] itemArr = {item};<br />
String wrap = xoxo.toXOXO(Arrays.asList(itemArr),true,null);<br />
assertFalse(wrap.equals(nowrap));<br />
}<br />
<br />
String startHTML = "<!DOCTYPE html PUBLIC \"-//W3C//DTD"<br />
+ "XHTML 1.0 Transitional//EN\n"<br />
+ "http://www.w3.org/TR/xhtml1/DTD/"<br />
+ "xhtml1-transitional.dtd\">"<br />
+ "<html xmlns=\"http://www.w3.org/1999/xhtml\">"<br />
+ "<head></head><body>";<br />
public String singleWrapHTML = "<ol "<br />
+ "class=\"xoxo\">"<br />
+ "<li>test</li></ol>";<br />
public String endHTML = "</body></html>";<br />
<br />
public void testWrapSingleItem(){<br />
String item = "test";<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(startHTML + singleWrapHTML + endHTML,<br />
xoxo.toXOXO(item,true,null));<br />
}<br />
<br />
public void testXOXOParser(){<br />
XOXOParser parser = new XOXOParser();<br />
try{<br />
parser.parse(dictHTML);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testDictRoundTrip(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("test", "1");<br />
dict.put("name", "Kevin");<br />
String html = xoxo.toXOXO(dict);<br />
try{<br />
Object newDict = parser.parse(html);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testListRoundTrip(){<br />
Object[] obj = {"1","2","3"};<br />
List testList = Arrays.asList(obj);<br />
XOXOWriter xoxo = new XOXOWriter();<br />
String html = xoxo.toXOXO(testList);<br />
XOXOParser parser = new XOXOParser();<br />
try{<br />
Object newList = parser.parse(html);<br />
assertEquals(testList,newList);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testListOfDictsRoundTrip(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("test", "1");<br />
dict.put("name", "Kevin");<br />
Map dict2 = new LinkedHashMap();<br />
dict2.put("one", "two");<br />
dict2.put("three", "four");<br />
dict2.put("five", "six");<br />
Object[] obj = {"1",dict,dict2};<br />
List testList = Arrays.asList(obj);<br />
String html = xoxo.toXOXO(testList);<br />
try{<br />
Object newList = parser.parse(html);<br />
assertEquals(testList,newList);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testListOfListsRoundTrip(){<br />
Object[] list1 = {"1","2","3"};<br />
Object[] list2 = {"4","5","6", Arrays.asList(list1)};<br />
Object[] list3 = {"7", Arrays.asList(list2)};<br />
Object[] list4 = {"8", Arrays.asList(list3)};<br />
List testList = Arrays.asList(list4);<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
String html = xoxo.toXOXO(testList);<br />
try{<br />
Object newList = parser.parse(html);<br />
assertEquals(testList,newList);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testDictOfListsRoundTrip(){<br />
Object[] list1 = {"1","2","3"};<br />
Object[] list2 = {"4","5","6"};<br />
Object[] list3 = {"7"};<br />
Object[] list4 = {"8", "9"};<br />
Map dict = new LinkedHashMap();<br />
dict.put("foo", Arrays.asList(list1));<br />
dict.put("bar", Arrays.asList(list2));<br />
dict.put("baz", Arrays.asList(list3));<br />
dict.put("qux", Arrays.asList(list4));<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
String html = xoxo.toXOXO(dict);<br />
try{<br />
Object newDict = parser.parse(html);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public String junkXOXO = "<ol "<br />
+ XHTML_DEC<br />
+ "class=\"xoxo\">"<br />
+ "bad<li><dl>worse<dt>good</dt><dd>buy</dd> now</dl></li></ol>";<br />
<br />
public void testXOXOJunkInContainers(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("good","buy");<br />
try{<br />
Object newDict = parser.parse(junkXOXO);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public String junkElementXOXO = "<ol "<br />
+ XHTML_DEC<br />
+ "><li>bad<dl><dt>good</dt><dd>buy</dd></dl>"<br />
+ "worse</li><li>bag<ol><li>OK</li></ol>fish</li></ol>";<br />
<br />
public void testXOXOjunkInElements(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("good","buy");<br />
Object[] ok = {"OK"};<br />
Object[] obj ={dict, Arrays.asList(ok)};<br />
List testList = Arrays.asList(obj);<br />
try{<br />
Object newList = parser.parse(junkElementXOXO);<br />
assertEquals(testList,newList);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public String xoxoSpacesNewlines = "<ol " + XHTML_DEC +<br />
" class='xoxo'> \n" +<br />
" <li>\n" +<br />
" <dl>\n" +<br />
" <dt>text</dt>\n" +<br />
" <dd>item 1</dd>\n" +<br />
" <dt>description</dt>\n" +<br />
" <dd> This item represents the main" +<br />
" point we're trying to make.</dd>\n" +<br />
" <dt>url</dt>\n" +<br />
" <dd>http://example.com/more.xoxo</dd>\n" +<br />
" <dt>title</dt>\n" +<br />
" <dd>title of item 1</dd>\n" +<br />
" <dt>type</dt>\n" +<br />
" <dd>text/xml</dd>\n" +<br />
" <dt>rel</dt>\n" +<br />
" <dd>help</dd>\n" +<br />
" </dl>\n" +<br />
" </li>\n" +<br />
"</ol>";<br />
<br />
public void testXOXOWithSpacesAndNewlines(){<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("text","item 1");<br />
dict.put("description"," This item represents the main" +<br />
" point we're trying to make.");<br />
dict.put("url","http://example.com/more.xoxo");<br />
dict.put("title","title of item 1");<br />
dict.put("type","text/xml");<br />
dict.put("rel","help");<br />
try{<br />
Object newDict = parser.parse(xoxoSpacesNewlines);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public String xoxoSample = "<ol " + XHTML_DEC +<br />
" class='xoxo'> \n" +<br />
" <li>\n" +<br />
" <dl>\n" +<br />
" <dt>text</dt>\n" +<br />
" <dd>item 1</dd>\n" +<br />
" <dt>url</dt>\n" +<br />
" <dd>http://example.com/more.xoxo</dd>\n" +<br />
" <dt>title</dt>\n" +<br />
" <dd>title of item 1</dd>\n" +<br />
" <dt>type</dt>\n" +<br />
" <dd>text/xml</dd>\n" +<br />
" <dt>rel</dt>\n" +<br />
" <dd>help</dd>\n" +<br />
" </dl>\n" +<br />
" </li>\n" +<br />
"</ol>";<br />
<br />
public String smartXOXOSample = "<ol " + XHTML_DEC +<br />
"class=\"xoxo\"> \n" +<br />
" <li><a href=\"http://example.com/more.xoxo\"\n" +<br />
" title=\"title of item 1\"\n" +<br />
" type=\"text/xml\"\n" +<br />
" rel=\"help\">item 1</a> \n" +<br />
"<!-- note how the \"text\" property is simply" +<br />
" the contents of the <a> element -->\n" +<br />
" </li>\n" +<br />
"</ol>";<br />
<br />
public void testSpecialAttributeDecoding(){<br />
XOXOParser parser = new XOXOParser();<br />
try{<br />
Object xoxoDict = parser.parse(xoxoSample);<br />
Object xoxoDict2 = parser.parse(smartXOXOSample);<br />
assertEquals(xoxoDict,xoxoDict2);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public String specialAttrHTML = "<ol " + XHTML_DEC +<br />
"class=\"xoxo\">" +<br />
"<li><a href=\"http://example.com/more.xoxo\" title=\"sample url\" " +<br />
"rel=\"help\" type=\"text/xml\" >an example</a></li></ol>";<br />
<br />
public void testSpecialAttributeEncode(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
Map dict = new LinkedHashMap();<br />
dict.put("url","http://example.com/more.xoxo");<br />
dict.put("title","sample url");<br />
dict.put("type","text/xml");<br />
dict.put("rel","help");<br />
dict.put("text","an example");<br />
String html = xoxo.toXOXO(dict);<br />
assertEquals(specialAttrHTML,html);<br />
}<br />
<br />
public void testSpecialAttributeRoundTripFull(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("url","http://example.com/more.xoxo");<br />
dict.put("title","sample url");<br />
dict.put("type","text/xml");<br />
dict.put("rel","help");<br />
dict.put("text","an example");<br />
String html = xoxo.toXOXO(dict);<br />
try{<br />
Object newDict = parser.parse(html);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testSpecialAttributeRoundTripNoText(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("url","http://example.com/more.xoxo");<br />
dict.put("title","sample url");<br />
dict.put("type","text/xml");<br />
dict.put("rel","help");<br />
String html = xoxo.toXOXO(dict);<br />
try{<br />
Object newDict = parser.parse(html);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testSpecialAttributeRoundTripNoTextOrTitle(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("url","http://example.com/more.xoxo");<br />
dict.put("type","text/xml");<br />
dict.put("rel","help");<br />
String html = xoxo.toXOXO(dict);<br />
try{<br />
Object newDict = parser.parse(html);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testUnicodeRoundTrip(){<br />
String s = "Tantek Çelik and a snowman ?";<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
String html = xoxo.toXOXO(s);<br />
try{<br />
Object newString = parser.parse(html);<br />
assertEquals(s,newString);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
}<br />
<br />
</nowiki></pre></div>
RobertSayre
http://microformats.org/wiki/index.php?title=xoxo-sample-code&diff=2498
xoxo-sample-code
2005-10-30T19:25:07Z
<p>RobertSayre: </p>
<hr />
<div>= XOXO Sample Code =<br />
<br />
A whole bunch of open source ([http://creativecommons.org/licenses/by/2.0/ CC-by-2.0], [http://www.apache.org/licenses/LICENSE-2.0 Apache 2.0]) sample code to read and write [[xoxo]] files in Python (with Perl, PHP, ... to follow).<br />
== xoxo.py ==<br />
<pre><nowiki><br />
# -*- coding: utf-8 -*-<br />
"""xoxo.py - a utility module for transforming to and from the XHTMLOutlines format XOXO<br />
toXOXO takes a Python datastructure (tuples, lists or dictionaries, arbitrarily nested) and returns a XOXO representation of it.<br />
fromXOXO parses an XHTML file for a xoxo list and returns the structure<br />
"""<br />
__version__ = "0.8"<br />
__date__ = "2004-10-05"<br />
__author__ = "Kevin Marks <kmarks@technorati.com>"<br />
__copyright__ = "Copyright 2004, Kevin marks & Technorati"<br />
__license__ = "http://creativecommons.org/licenses/by/2.0/ CC-by-2.0], [http://www.apache.org/licenses/LICENSE-2.0 Apache 2.0"<br />
__credits__ = """Tantek Çelik and Mark Pilgrim for data structure"""<br />
__history__ = """<br />
TODO: add <title> tag<br />
TODO: add a proper profile link<br />
0.8 work in unicode then render to utf-8<br />
0.7 initial encoding support - just utf-8 for now<br />
0.6 support the special behaviour for url properties to/from <a><br />
0.5 fix some awkward side effects of whitespace and text outside our expected tags; simplify writing code<br />
0.4 add correct XHTML headers so it validates<br />
0.3 read/write version; fixed invlaid nested list generation;<br />
0.1 first write-only version<br />
"""<br />
<br />
try:<br />
True, False<br />
except NameError:<br />
True, False = not not 1, not 1<br />
containerTags={'ol':False,'ul':False,'dl':False}<br />
import sgmllib, urllib, urlparse, re<br />
def makeXOXO(struct,className=None,depth=0):<br />
s=u''<br />
if isinstance(struct,list) or isinstance(struct,tuple):<br />
if className:<br />
s += u'<ol class="%s">' % className<br />
else:<br />
s+= u"<ol>"<br />
if isinstance(struct,dict):<br />
d=struct.copy()<br />
if d.has_key('url'):<br />
s+=u'<a href="%s" ' % d['url']<br />
text = d.get('text',d.get('title',d['url']))<br />
for attr in ('title','rel','type'):<br />
if d.has_key(attr):<br />
xVal = makeXOXO(d[attr],None,depth+1)<br />
s +=u'%s="%s" ' % (attr,xVal)<br />
del d[attr]<br />
s +=u'>%s</a>' % makeXOXO(text,None,depth+1)<br />
if d.has_key('text'):<br />
del d['text']<br />
del d['url']<br />
if len(d):<br />
s +=u"<dl>"<br />
for key,value in d.items():<br />
xVal = makeXOXO(value,None,depth+1)<br />
s+= u'<dt>%s</dt><dd>%s</dd>' % (key, xVal)<br />
s +=u"</dl>"<br />
elif type(struct) ==type((1,))or type(struct) ==type([1,]):<br />
for item in struct:<br />
s+=u"<li>" + makeXOXO(item,None,depth+1)+"</li>"<br />
s +=u"</ol>"<br />
elif type(struct) == type(u'unicode'):<br />
s+=struct<br />
else:<br />
if not type(struct)==type(' '):<br />
struct=str(struct)<br />
try:<br />
s+=unicode(struct,'utf-8')<br />
except:<br />
s+=unicode(struct,'windows_1252')<br />
return s<br />
class xoxoParser(sgmllib.SGMLParser):<br />
def __init__(self):<br />
sgmllib.SGMLParser.__init__(self)<br />
self.structs=[]<br />
self.xostack=[]<br />
self.textstack=['']<br />
def normalize_attrs(self, attrs):<br />
attrs = [(k.lower(), sgmllib.charref.sub(lambda m: chr(int(m.groups()[0])), v).strip()) for k, v in attrs]<br />
attrs = [(k, k in ('rel','type') and v.lower() or v) for k, v in attrs]<br />
return attrs<br />
def pushStruct(self,struct):<br />
if type(struct) == type({}) and len(struct)==0 and len(self.structs) and type(self.structs[-1]) == type({}) and self.structs[-1].has_key('url'):<br />
self.xostack.append(self.structs[-1]) # put back the <a>-made one for extra def's<br />
else:<br />
self.structs.append(struct)<br />
self.xostack.append(self.structs[-1])<br />
def start_a(self,attrs):<br />
attrsD = dict(self.normalize_attrs(attrs))<br />
attrsD['url']= attrsD.get('href','')<br />
del attrsD['href']<br />
self.pushStruct(attrsD)<br />
self.textstack.append('')<br />
def end_a(self):<br />
val = self.textstack.pop()<br />
if val: <br />
if self.xostack[-1].get('title','') == val:<br />
val=''<br />
if self.xostack[-1]['url'] == val:<br />
val=''<br />
if val:<br />
self.xostack[-1]['text']=val<br />
self.xostack.pop()<br />
def start_dl(self,attrs):<br />
self.pushStruct({})<br />
def end_dl(self):<br />
self.xostack.pop()<br />
def start_ol(self,attrs):<br />
self.pushStruct([])<br />
def end_ol(self):<br />
self.xostack.pop()<br />
def start_ul(self,attrs):<br />
self.pushStruct([])<br />
def end_ul(self):<br />
self.xostack.pop()<br />
def start_li(self,attrs):<br />
self.textstack.append('')<br />
def end_li(self):<br />
val = self.textstack.pop()<br />
if self.structs[-1] != self.xostack[-1]:<br />
val = self.structs.pop()<br />
self.xostack[-1].append(val)<br />
def start_dt(self,attrs):<br />
self.textstack.append('')<br />
def end_dt(self):<br />
pass<br />
def start_dd(self,attrs):<br />
self.textstack.append('')<br />
def end_dd(self):<br />
val = self.textstack.pop()<br />
key = self.textstack.pop()<br />
if self.structs[-1] != self.xostack[-1]:<br />
val = self.structs.pop()<br />
self.xostack[-1][key]=val<br />
def handle_data(self, text):<br />
if len(self.stack) and containerTags.get(self.stack[-1],True): #skip text not within an element<br />
self.textstack[-1] += text<br />
def toXOXO(struct,addHTMLWrapper=False,cssUrl=''):<br />
if type(struct) ==type((1,))or type(struct) ==type([1,]):<br />
inStruct = struct<br />
else:<br />
inStruct = [struct]<br />
if addHTMLWrapper:<br />
s= '''<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN<br />
http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><br />
<html xmlns="http://www.w3.org/1999/xhtml"><head profile=""><meta http-equiv="Content-Type" content="text/html; charset=utf-8" />'''<br />
if cssUrl:<br />
s+='<style type="text/css" >@import "%s";</style>' % cssUrl<br />
s+="</head><body>%s</body></html>" % makeXOXO(inStruct,'xoxo')<br />
return s.encode('utf-8')<br />
else:<br />
return makeXOXO(inStruct,'xoxo').encode('utf-8')<br />
<br />
import sys<br />
<br />
def fromXOXO(html):<br />
parser = xoxoParser()<br />
parser.feed(unicode(html,'utf-8'))<br />
#print >>sys.stderr, parser.structs<br />
structs=[struct for struct in parser.structs if struct]<br />
#print >>sys.stderr, structs<br />
while (len(structs) ==1 and type(structs)==type([1,])):<br />
structs=structs[0]<br />
return structs<br />
<br />
# Allow direct invocation<br />
# Read HTML from URL, parse into data structures, then re-output<br />
<br />
if __name__ == "__main__":<br />
if len(sys.argv) < 2: raise SystemExit("Usage: "+sys.argv[0]+" url\n"+__doc__)<br />
url=sys.argv[1]<br />
file = urllib.urlopen(url)<br />
html=file.read(-1)<br />
file.close<br />
s=fromXOXO(html)<br />
p=toXOXO(s,True)<br />
print p<br />
<br />
</nowiki></pre><br />
<br />
== testxoxo.py ==<br />
<pre><nowiki><br />
# -*- coding: utf-8 -*-<br />
"""testxoxo.py <br />
Unit tests for xoxo.py<br />
This file tests the functions in xoxo.py <br />
The underlying model here is http://diveintopython.org/unit_testing/index.html <br />
<br />
run from command line with<br />
python testxoxo.py -v<br />
"""<br />
import xoxo<br />
reload(xoxo)<br />
import unittest<br />
<br />
class xoxoTestCases(unittest.TestCase):<br />
<br />
def testSimpleList(self):<br />
'''make a xoxo file from a list'''<br />
l = ['1','2','3']<br />
html = xoxo.toXOXO(l)<br />
self.assertEqual(html,'<ol class="xoxo"><li>1</li><li>2</li><li>3</li></ol>')<br />
def testNestedList(self):<br />
'''make a xoxo file from a list with a list in'''<br />
l = ['1',['2','3']]<br />
html = xoxo.toXOXO(l)<br />
self.assertEqual(html,'<ol class="xoxo"><li>1</li><li><ol><li>2</li><li>3</li></ol></li></ol>')<br />
<br />
def testDictionary(self):<br />
'''make a xoxo file from a dictionary'''<br />
d = {'test':'1','name':'Kevin'}<br />
html = xoxo.toXOXO(d)<br />
self.assertEqual(html,'<ol class="xoxo"><li><dl><dt>test</dt><dd>1</dd><dt>name</dt><dd>Kevin</dd></dl></li></ol>')<br />
<br />
def testSingleItem(self):<br />
'''make a xoxo file from a string'''<br />
l = "test"<br />
html = xoxo.toXOXO(l)<br />
self.assertEqual(html,'<ol class="xoxo"><li>test</li></ol>')<br />
<br />
def testWrapDiffers(self):<br />
'''make a xoxo file from a string with and without html wrapper and check they are different'''<br />
l = "test"<br />
html = xoxo.toXOXO(l)<br />
htmlwrap = xoxo.toXOXO(l,addHTMLWrapper=True)<br />
self.failIfEqual(html,htmlwrap)<br />
<br />
def testWrapSingleItem(self):<br />
'''make a wrapped xoxo file from a string'''<br />
l = "test"<br />
html = xoxo.toXOXO(l,addHTMLWrapper=True)<br />
self.assertEqual(html,'''<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN<br />
http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><br />
<html xmlns="http://www.w3.org/1999/xhtml"><head profile=""></head><body><ol class="xoxo"><li>test</li></ol></body></html>''')<br />
<br />
def testDictionaryRoundTrip(self):<br />
''' make a dictionary into a xoxo file and back again; check it is the same'''<br />
d = {'test':'1','name':'Kevin'}<br />
html = xoxo.toXOXO(d)<br />
newd = xoxo.fromXOXO(html)<br />
self.assertEqual(d,newd)<br />
<br />
def testListRoundTrip(self):<br />
''' make a list into a xoxo file and back again; check it is the same'''<br />
l = ['3','2','1']<br />
html = xoxo.toXOXO(l)<br />
newdl= xoxo.fromXOXO(html)<br />
self.assertEqual(l,newdl)<br />
def testListofDictsRoundTrip(self):<br />
''' make a list of Dicts into a xoxo file and back again; check it is the same'''<br />
l = ['3',{'a':'2'},{'b':'1','c':'4'}]<br />
html = xoxo.toXOXO(l)<br />
newdl= xoxo.fromXOXO(html)<br />
self.assertEqual(l,newdl)<br />
def testListofListsRoundTrip(self):<br />
''' make a list of Lists into a xoxo file and back again; check it is the same'''<br />
l = ['3',['a','2'],['b',['1',['c','4']]]]<br />
html = xoxo.toXOXO(l)<br />
newdl= xoxo.fromXOXO(html)<br />
self.assertEqual(l,newdl)<br />
def testDictofListsRoundTrip(self):<br />
''' make a dict with lists in into a xoxo file and back again; check it is the same'''<br />
d = {'test':['1','2'],<br />
'name':'Kevin',<br />
'nestlist':['a',['b','c']],<br />
'nestdict':{'e':'6','f':'7'}}<br />
html = xoxo.toXOXO(d)<br />
newd = xoxo.fromXOXO(html)<br />
self.assertEqual(d,newd)<br />
<br />
def testXOXOjunkInContainers(self):<br />
'''make sure text outside <li> etc is ignored'''<br />
d=xoxo.fromXOXO('<ol>bad<li><dl>worse<dt>good</dt><dd>buy</dd> now</dl></li></ol>')<br />
self.assertEqual(d,{'good': 'buy'})<br />
def testXOXOjunkInElements(self):<br />
'''make sure text within <li> but outside a subcontainer is ignored'''<br />
l=xoxo.fromXOXO('<ol><li>bad<dl><dt>good</dt><dd>buy</dd></dl>worse</li><li>bag<ol><li>OK</li></ol>fish</li></ol>')<br />
self.assertEqual(l,[{'good': 'buy'},['OK']])<br />
def testXOXOWithSpacesAndNewlines(self):<br />
'''unmung some xoxo with spaces in and check result is right'''<br />
xoxoSample= '''<ol class='xoxo'> <br />
<li><br />
<dl><br />
<dt>text</dt><br />
<dd>item 1</dd><br />
<dt>description</dt><br />
<dd> This item represents the main point we're trying to make.</dd><br />
<dt>url</dt><br />
<dd>http://example.com/more.xoxo</dd><br />
<dt>title</dt><br />
<dd>title of item 1</dd><br />
<dt>type</dt><br />
<dd>text/xml</dd><br />
<dt>rel</dt><br />
<dd>help</dd><br />
</dl><br />
</li><br />
</ol>'''<br />
d = xoxo.fromXOXO(xoxoSample)<br />
d2={'text':'item 1',<br />
'description':" This item represents the main point we're trying to make.",<br />
'url':'http://example.com/more.xoxo',<br />
'title':'title of item 1',<br />
'type':'text/xml',<br />
'rel':'help'<br />
}<br />
xoxoAgain = xoxo.toXOXO(d)<br />
self.assertEqual(d,d2)<br />
#this needs a smarter whitespace-sensitive comparison<br />
#self.assertEqual(xoxoSample,xoxoAgain)<br />
<br />
def testSpecialAttributeDecoding(self):<br />
'''unmung some xoxo with <a href=' rel= etc in and check result is right'''<br />
xoxoSample= '''<ol class='xoxo'> <br />
<li><br />
<dl><br />
<dt>text</dt><br />
<dd>item 1</dd><br />
<dt>url</dt><br />
<dd>http://example.com/more.xoxo</dd><br />
<dt>title</dt><br />
<dd>title of item 1</dd><br />
<dt>type</dt><br />
<dd>text/xml</dd><br />
<dt>rel</dt><br />
<dd>help</dd><br />
</dl><br />
</li><br />
</ol>'''<br />
d = xoxo.fromXOXO(xoxoSample)<br />
smartxoxoSample= '''<ol class='xoxo'> <br />
<li><a href="http://example.com/more.xoxo"<br />
title="title of item 1"<br />
type="text/xml"<br />
rel="help">item 1</a> <br />
<!-- note how the "text" property is simply the contents of the <a> element --><br />
</li><br />
</ol>'''<br />
d2 = xoxo.fromXOXO(smartxoxoSample)<br />
self.assertEqual(d,d2)<br />
def testSpecialAttributeAndDLDecoding(self):<br />
'''unmung some xoxo with <a href=' rel= etc in plus a <dl> in the same item and check result is right'''<br />
xoxoSample= '''<ol class="xoxo"> <br />
<li><br />
<dl><br />
<dt>text</dt><br />
<dd>item 1</dd><br />
<dt>description</dt><br />
<dd> This item represents the main point we're trying to make.</dd><br />
<dt>url</dt><br />
<dd>http://example.com/more.xoxo</dd><br />
<dt>title</dt><br />
<dd>title of item 1</dd><br />
<dt>type</dt><br />
<dd>text/xml</dd><br />
<dt>rel</dt><br />
<dd>help</dd><br />
</dl><br />
</li><br />
</ol>'''<br />
d = xoxo.fromXOXO(xoxoSample)<br />
smartxoxoSample= '''<ol class="xoxo"> <br />
<li><a href="http://example.com/more.xoxo"<br />
title="title of item 1"<br />
type="text/xml"<br />
rel="help">item 1</a> <br />
<!-- note how the "text" property is simply the contents of the <a> element --><br />
<dl><br />
<dt>description</dt><br />
<dd> This item represents the main point we're trying to make.</dd><br />
</dl><br />
</li><br />
</ol>'''<br />
d2 = xoxo.fromXOXO(smartxoxoSample)<br />
self.assertEqual(d,d2)<br />
def testSpecialAttributeEncode(self):<br />
'''check it makes an <a href with a url parameter'''<br />
d={'url':'http://example.com/more.xoxo','title':'sample url','type':"text/xml",'rel':'help','text':'an example'}<br />
html=xoxo.toXOXO(d)<br />
expectedHTML= '<ol class="xoxo"><li><a href="http://example.com/more.xoxo" title="sample url" rel="help" type="text/xml" >an example</a></li></ol>' <br />
self.assertEqual(html,expectedHTML)<br />
<br />
def testSpecialAttributeRoundTripFull(self):<br />
'''check it makes an <a href with a url parameter'''<br />
d={'url':'http://example.com/more.xoxo','title':'sample url','type':"text/xml",'rel':'help','text':'an example'}<br />
html=xoxo.toXOXO(d)<br />
self.assertEqual(d,xoxo.fromXOXO(html))<br />
def testSpecialAttributeRoundTripNoText(self):<br />
'''check it makes an <a href with a url parameter and no text attribute'''<br />
d={'url':'http://example.com/more.xoxo','title':'sample url','type':"text/xml",'rel':'help'}<br />
html=xoxo.toXOXO(d)<br />
self.assertEqual(d,xoxo.fromXOXO(html))<br />
def testSpecialAttributeRoundTripNoTextOrTitle(self):<br />
'''check it makes an <a href with a url parameter and no text or title attribute'''<br />
d={'url':'http://example.com/more.xoxo'}<br />
html=xoxo.toXOXO(d)<br />
self.assertEqual(d,xoxo.fromXOXO(html))<br />
def testUnicodeRoundtrip(self):<br />
'''check unicode characters can go to xoxo and back'''<br />
src=unicode('Tantek Çelik and a snowman ?','utf-8')<br />
html = html=xoxo.toXOXO(src)<br />
self.assertEqual(src,xoxo.fromXOXO(html))<br />
if __name__ == "__main__":<br />
unittest.main()<br />
else:<br />
runner = unittest.TextTestRunner()<br />
suite = unittest.makeSuite(xoxoTestCases,'test')<br />
runner.run(suite)<br />
<br />
</nowiki></pre><br />
<br />
<pre><nowiki><br />
package org.atompub.draft.xoxo.tests;<br />
<br />
import junit.framework.TestSuite;<br />
import junit.framework.TestCase;<br />
import junit.textui.TestRunner;<br />
import org.atompub.draft.xoxo.XOXOWriter;<br />
import org.atompub.draft.xoxo.XOXOParser;<br />
<br />
import java.util.*;<br />
<br />
public class XOXOTest extends TestCase {<br />
<br />
public static void main(String[] args) {<br />
new TestRunner().doRun(new TestSuite(XOXOTest.class));<br />
}<br />
String XHTML_DEC = "xmlns=\"http://www.w3.org/1999/xhtml\" ";<br />
public String simpleListHTML = "<ol "<br />
+ XHTML_DEC<br />
+ "class=\"xoxo\">"<br />
+ "<li>1</li><li>2</li><li>3</li></ol>";<br />
<br />
public void testSimpleList(){<br />
String [] numbers = {"1","2","3"};<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(simpleListHTML,<br />
xoxo.toXOXO(Arrays.asList(numbers)));<br />
}<br />
<br />
public void testStringIntegerList(){<br />
Object[] numbers = {new Integer(1),"2","3"};<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(simpleListHTML,<br />
xoxo.toXOXO(Arrays.asList(numbers)));<br />
}<br />
<br />
public String nestedListHTML = "<ol "<br />
+ XHTML_DEC<br />
+ "class=\"xoxo\"><li>1</li><li>"<br />
+ "<ol><li>2</li><li>3</li></ol></li></ol>";<br />
<br />
public void testNestedList(){<br />
Object[] arr = {"2","3"};<br />
Object[] nested = {"1",Arrays.asList(arr)};<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(nestedListHTML,<br />
xoxo.toXOXO(Arrays.asList(nested)));<br />
}<br />
<br />
public void testNestedArray(){<br />
Object[] arr = {"2","3"};<br />
Object[] nested = {"1",arr};<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(nestedListHTML,<br />
xoxo.toXOXO(Arrays.asList(nested)));<br />
}<br />
<br />
public String dictHTML = "<ol "<br />
+ XHTML_DEC<br />
+ "class=\"xoxo\">"<br />
+ "<li><dl><dt>test</dt><dd>1</dd><dt>name</dt>"<br />
+ "<dd>Kevin</dd></dl></li></ol>";<br />
<br />
public void testDictionary(){<br />
Map dict = new LinkedHashMap();<br />
dict.put("test", new Integer(1));<br />
dict.put("name", "Kevin");<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(dictHTML,<br />
xoxo.toXOXO(dict));<br />
}<br />
<br />
public String singleHTML = "<ol "<br />
+ XHTML_DEC<br />
+ "class=\"xoxo\">"<br />
+ "<li>test</li></ol>";<br />
<br />
public void testSingleItem(){<br />
String item = "test";<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(singleHTML,<br />
xoxo.toXOXO(item));<br />
}<br />
<br />
public void testWrapDiffers(){<br />
String item = "test";<br />
XOXOWriter xoxo = new XOXOWriter();<br />
String nowrap = xoxo.toXOXO(item);<br />
Object[] itemArr = {item};<br />
String wrap = xoxo.toXOXO(Arrays.asList(itemArr),true,null);<br />
assertFalse(wrap.equals(nowrap));<br />
}<br />
<br />
String startHTML = "<!DOCTYPE html PUBLIC \"-//W3C//DTD"<br />
+ "XHTML 1.0 Transitional//EN\n"<br />
+ "http://www.w3.org/TR/xhtml1/DTD/"<br />
+ "xhtml1-transitional.dtd\">"<br />
+ "<html xmlns=\"http://www.w3.org/1999/xhtml\">"<br />
+ "<head></head><body>";<br />
public String singleWrapHTML = "<ol "<br />
+ "class=\"xoxo\">"<br />
+ "<li>test</li></ol>";<br />
public String endHTML = "</body></html>";<br />
<br />
public void testWrapSingleItem(){<br />
String item = "test";<br />
XOXOWriter xoxo = new XOXOWriter();<br />
assertEquals(startHTML + singleWrapHTML + endHTML,<br />
xoxo.toXOXO(item,true,null));<br />
}<br />
<br />
public void testXOXOParser(){<br />
XOXOParser parser = new XOXOParser();<br />
try{<br />
parser.parse(dictHTML);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testDictRoundTrip(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("test", "1");<br />
dict.put("name", "Kevin");<br />
String html = xoxo.toXOXO(dict);<br />
try{<br />
Object newDict = parser.parse(html);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testListRoundTrip(){<br />
Object[] obj = {"1","2","3"};<br />
List testList = Arrays.asList(obj);<br />
XOXOWriter xoxo = new XOXOWriter();<br />
String html = xoxo.toXOXO(testList);<br />
XOXOParser parser = new XOXOParser();<br />
try{<br />
Object newList = parser.parse(html);<br />
assertEquals(testList,newList);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testListOfDictsRoundTrip(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("test", "1");<br />
dict.put("name", "Kevin");<br />
Map dict2 = new LinkedHashMap();<br />
dict2.put("one", "two");<br />
dict2.put("three", "four");<br />
dict2.put("five", "six");<br />
Object[] obj = {"1",dict,dict2};<br />
List testList = Arrays.asList(obj);<br />
String html = xoxo.toXOXO(testList);<br />
try{<br />
Object newList = parser.parse(html);<br />
assertEquals(testList,newList);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testListOfListsRoundTrip(){<br />
Object[] list1 = {"1","2","3"};<br />
Object[] list2 = {"4","5","6", Arrays.asList(list1)};<br />
Object[] list3 = {"7", Arrays.asList(list2)};<br />
Object[] list4 = {"8", Arrays.asList(list3)};<br />
List testList = Arrays.asList(list4);<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
String html = xoxo.toXOXO(testList);<br />
try{<br />
Object newList = parser.parse(html);<br />
assertEquals(testList,newList);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testDictOfListsRoundTrip(){<br />
Object[] list1 = {"1","2","3"};<br />
Object[] list2 = {"4","5","6"};<br />
Object[] list3 = {"7"};<br />
Object[] list4 = {"8", "9"};<br />
Map dict = new LinkedHashMap();<br />
dict.put("foo", Arrays.asList(list1));<br />
dict.put("bar", Arrays.asList(list2));<br />
dict.put("baz", Arrays.asList(list3));<br />
dict.put("qux", Arrays.asList(list4));<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
String html = xoxo.toXOXO(dict);<br />
try{<br />
Object newDict = parser.parse(html);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public String junkXOXO = "<ol "<br />
+ XHTML_DEC<br />
+ "class=\"xoxo\">"<br />
+ "bad<li><dl>worse<dt>good</dt><dd>buy</dd> now</dl></li></ol>";<br />
<br />
public void testXOXOJunkInContainers(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("good","buy");<br />
try{<br />
Object newDict = parser.parse(junkXOXO);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public String junkElementXOXO = "<ol "<br />
+ XHTML_DEC<br />
+ "><li>bad<dl><dt>good</dt><dd>buy</dd></dl>"<br />
+ "worse</li><li>bag<ol><li>OK</li></ol>fish</li></ol>";<br />
<br />
public void testXOXOjunkInElements(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("good","buy");<br />
Object[] ok = {"OK"};<br />
Object[] obj ={dict, Arrays.asList(ok)};<br />
List testList = Arrays.asList(obj);<br />
try{<br />
Object newList = parser.parse(junkElementXOXO);<br />
assertEquals(testList,newList);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public String xoxoSpacesNewlines = "<ol " + XHTML_DEC +<br />
" class='xoxo'> \n" +<br />
" <li>\n" +<br />
" <dl>\n" +<br />
" <dt>text</dt>\n" +<br />
" <dd>item 1</dd>\n" +<br />
" <dt>description</dt>\n" +<br />
" <dd> This item represents the main" +<br />
" point we're trying to make.</dd>\n" +<br />
" <dt>url</dt>\n" +<br />
" <dd>http://example.com/more.xoxo</dd>\n" +<br />
" <dt>title</dt>\n" +<br />
" <dd>title of item 1</dd>\n" +<br />
" <dt>type</dt>\n" +<br />
" <dd>text/xml</dd>\n" +<br />
" <dt>rel</dt>\n" +<br />
" <dd>help</dd>\n" +<br />
" </dl>\n" +<br />
" </li>\n" +<br />
"</ol>";<br />
<br />
public void testXOXOWithSpacesAndNewlines(){<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("text","item 1");<br />
dict.put("description"," This item represents the main" +<br />
" point we're trying to make.");<br />
dict.put("url","http://example.com/more.xoxo");<br />
dict.put("title","title of item 1");<br />
dict.put("type","text/xml");<br />
dict.put("rel","help");<br />
try{<br />
Object newDict = parser.parse(xoxoSpacesNewlines);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public String xoxoSample = "<ol " + XHTML_DEC +<br />
" class='xoxo'> \n" +<br />
" <li>\n" +<br />
" <dl>\n" +<br />
" <dt>text</dt>\n" +<br />
" <dd>item 1</dd>\n" +<br />
" <dt>url</dt>\n" +<br />
" <dd>http://example.com/more.xoxo</dd>\n" +<br />
" <dt>title</dt>\n" +<br />
" <dd>title of item 1</dd>\n" +<br />
" <dt>type</dt>\n" +<br />
" <dd>text/xml</dd>\n" +<br />
" <dt>rel</dt>\n" +<br />
" <dd>help</dd>\n" +<br />
" </dl>\n" +<br />
" </li>\n" +<br />
"</ol>";<br />
<br />
public String smartXOXOSample = "<ol " + XHTML_DEC +<br />
"class=\"xoxo\"> \n" +<br />
" <li><a href=\"http://example.com/more.xoxo\"\n" +<br />
" title=\"title of item 1\"\n" +<br />
" type=\"text/xml\"\n" +<br />
" rel=\"help\">item 1</a> \n" +<br />
"<!-- note how the \"text\" property is simply" +<br />
" the contents of the <a> element -->\n" +<br />
" </li>\n" +<br />
"</ol>";<br />
<br />
public void testSpecialAttributeDecoding(){<br />
XOXOParser parser = new XOXOParser();<br />
try{<br />
Object xoxoDict = parser.parse(xoxoSample);<br />
Object xoxoDict2 = parser.parse(smartXOXOSample);<br />
assertEquals(xoxoDict,xoxoDict2);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public String specialAttrHTML = "<ol " + XHTML_DEC +<br />
"class=\"xoxo\">" +<br />
"<li><a href=\"http://example.com/more.xoxo\" title=\"sample url\" " +<br />
"rel=\"help\" type=\"text/xml\" >an example</a></li></ol>";<br />
<br />
public void testSpecialAttributeEncode(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
Map dict = new LinkedHashMap();<br />
dict.put("url","http://example.com/more.xoxo");<br />
dict.put("title","sample url");<br />
dict.put("type","text/xml");<br />
dict.put("rel","help");<br />
dict.put("text","an example");<br />
String html = xoxo.toXOXO(dict);<br />
assertEquals(specialAttrHTML,html);<br />
}<br />
<br />
public void testSpecialAttributeRoundTripFull(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("url","http://example.com/more.xoxo");<br />
dict.put("title","sample url");<br />
dict.put("type","text/xml");<br />
dict.put("rel","help");<br />
dict.put("text","an example");<br />
String html = xoxo.toXOXO(dict);<br />
try{<br />
Object newDict = parser.parse(html);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testSpecialAttributeRoundTripNoText(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("url","http://example.com/more.xoxo");<br />
dict.put("title","sample url");<br />
dict.put("type","text/xml");<br />
dict.put("rel","help");<br />
String html = xoxo.toXOXO(dict);<br />
try{<br />
Object newDict = parser.parse(html);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testSpecialAttributeRoundTripNoTextOrTitle(){<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
Map dict = new LinkedHashMap();<br />
dict.put("url","http://example.com/more.xoxo");<br />
dict.put("type","text/xml");<br />
dict.put("rel","help");<br />
String html = xoxo.toXOXO(dict);<br />
try{<br />
Object newDict = parser.parse(html);<br />
assertEquals(dict,newDict);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
public void testUnicodeRoundTrip(){<br />
String s = "Tantek Çelik and a snowman ?";<br />
XOXOWriter xoxo = new XOXOWriter();<br />
XOXOParser parser = new XOXOParser();<br />
String html = xoxo.toXOXO(s);<br />
try{<br />
Object newString = parser.parse(html);<br />
assertEquals(s,newString);<br />
}catch (Exception e){<br />
fail(e.getMessage());<br />
e.printStackTrace();<br />
}<br />
}<br />
<br />
}<br />
<br />
</nowiki></pre></div>
RobertSayre
http://microformats.org/wiki/index.php?title=datetime-design-pattern&diff=2166
datetime-design-pattern
2005-09-05T17:44:02Z
<p>RobertSayre: </p>
<hr />
<div>'''This page is a draft.'''<br />
<br />
This is a page for exploring a datetime design pattern.<br />
<br />
The pattern which is now used in [[hcalendar|hCalendar]] and [[hreview|hReview]] is something like this:<br />
<br />
<pre>&lt;abbr class="foo" title="YYYYMMDDTHH:MM:SS+ZZZZ"&gt;Date Time&lt;/abbr&gt;</pre><br />
<br />
where foo is the semantic classname which is being applied to this date/time, the title of the &lt;abbr&gt; is an ISO 8601 date/time and "Date Time" is a human-friendly representation of the same date/time.<br />
<br />
This pattern is likely to be highly resuable.<br />
<br />
--[[RyanKing]]<br />
<br />
Can this not be viewed as a microformat in itself?<br />
<br />
--[[DimitriGlazkov]]<br />
<br />
It could, but inventing a microformat for the sake of inventing a microformat is against the microformat principles.<br />
If there is a specific real world problem (and uses cases) that such an elemental microformat would solve, then it would be worth considering.<br />
<br />
Until then it is best to keep the &lt;abbr&gt; datetime concept merely as a microformat design pattern, to be used in _actual_ microformats that have a demonstrated practical need.<br />
<br />
-- [http://tantek.com/log/ Tantek]<br />
<br />
Excerpt from #microformats Aug 18th. Please edit!<br />
<br />
<pre><br />
Aug 18 15:16:14 <Tantek> DanC, what do you think of RFC3339?<br />
Aug 18 15:17:14 <Tantek> ISO8601 subset<br />
Aug 18 15:17:19 <DanC> Date and Time on the Internet: Timestamps http://www.ietf.org/rfc/rfc3339.txt<br />
Aug 18 15:17:30 <DanC> Klyne is a good guy. I wonder if I talked with him about this.<br />
Aug 18 15:17:32 <Tantek> compat with W3C-NOTE-DATETIME<br />
Aug 18 15:17:50 <Tantek> compat with xsd:dateTime<br />
Aug 18 15:17:57 <Tantek> it's a strict intersection subset<br />
Aug 18 15:17:59 <DanC> I consider W3C-NOTE-DATETIME obsoleted by XML Schema datatype-- yeah.. xsd:dateTime<br />
Aug 18 15:18:32 <Tantek> compare/contrast normatively using xsd:dateTime vs. RFC3339<br />
Aug 18 15:18:41 <Tantek> note: Atom 1.0 chose RFC3339<br />
Aug 18 15:18:50 <Tantek> i would like input from the microformats community on this<br />
Aug 18 15:19:27 <DanC> in what context are you evaluating RFC 3339?<br />
Aug 18 15:19:28 <jcgregorio> http://bitworking.org/news/Date_Constructs_in_the_Atom_Syndication_Format<br />
Aug 18 15:21:24 <DanC> which microformat is the question coming from, Tantek ?<br />
Aug 18 15:23:31 <DanC> " The grammar element time-second may have the value "60" at the end of<br />
Aug 18 15:23:31 <DanC> months in which a leap second occurs" The XML Schema WG is in the 27th level of leap-second-hell for the past few months, I gather.<br />
Aug 18 15:24:21 <DanC> yeah... here's the scary bit: " Leap seconds cannot be predicted far into the future. The<br />
Aug 18 15:24:21 <DanC> International Earth Rotation Service publishes bulletins [IERS] that<br />
Aug 18 15:24:21 <DanC> announce leap seconds with a few weeks' warning."<br />
Aug 18 15:26:03 <Tantek> DanC, which microformats? any/all that use datetime fields.<br />
Aug 18 15:26:36 <DanC> hard to give useful advice, then.<br />
Aug 18 15:26:58 <DanC> I expect they'll use datetime fields for different things that have different cost/benefit trade-offs<br />
Aug 18 15:27:26 <DanC> do you know of any particular differences that matter to anybody?<br />
Aug 18 15:56:43 <KragenSitaker> RFC3339 suggests -07:00, which seems like an improvement over -0700 anyway<br />
Aug 18 15:56:49 <Tantek> Kragen, agreed<br />
Aug 18 15:57:01 <Tantek> RFC3339 is certainly preferable to the ISO8601 subset in iCalendar<br />
Aug 18 16:05:57 <DanC> Tantek's right, Kragen; iCalendar looks like it solves the local timezone problem but doesn't.<br />
Aug 18 16:06:14 <DanC> and it's true that there's no standard solution to the local timezone problem<br />
Aug 18 16:06:39 <Tantek> so instead of appearing to solve the problem but not solving it, we chose to provide the ability to *approximate* the local timezone using e.g. "-07:00"<br />
Aug 18 16:06:49 <DanC> the simplest thing is to have people use Z time in hCalendar. But I gather that's unacceptably unusable?<br />
Aug 18 16:07:35 <Tantek> DanC, yes, the simplest thing is to have everyone use UTC Z<br />
Aug 18 16:07:38 <Tantek> However<br />
Aug 18 16:07:50 <Tantek> it is not *nearly* as usuable/verifiable<br />
Aug 18 16:07:55 <Tantek> as -07:00 etc.<br />
Aug 18 16:08:02 <Tantek> hence the decision to go with the latter<br />
Aug 18 16:08:12 <Tantek> some degree of human verifiability is important here<br />
Aug 18 16:14:21 <Tantek> DanC, my perception is that RFC3339 is a subset<br />
Aug 18 16:17:00 <DanC> time-numoffset = ("+" / "-") time-hour ":" time-minute<br />
Aug 18 16:17:34 <DanC> ok, then I can't see any differences. (modulo recent leap seconds issues that may affect xsd:dateTime )<br />
Aug 18 16:18:07 <Tantek> would be interesting to know why Atom 1.0 chose RFC3339 over xsd:dateTime<br />
Aug 18 16:18:21 <Tantek> if there was a "real" reason or if it was arbitrary / coin-flip.<br />
</pre><br />
<br />
Here's an exhaustive [http://www.imc.org/atom-syntax/mail-archive/msg13103.html comparison] from ndw. I think xsd:dateTime also allows unqualified local times, while RFC3339 allows only UTC with no known timezone (-00:00). In the end, Atompub followed the advice of [http://www.imc.org/atom-syntax/mail-archive/msg13244.html Sam Ruby] and [http://www.imc.org/atom-syntax/mail-archive/msg13248.html Scott Hollenbeck], our area director. Atom dates make some additional restrictions on RFC3339, such as uppercase T and Z characters for compatibility with xsd:dateTime, RFC3339, W3C-DTF, and ISO8601. --[http://franklinmint.fm Robert Sayre]<br />
<br />
<pre><br />
Aug 18 16:18:43 <KragenSitaker> rfc3339 is pretty short.<br />
Aug 18 16:19:36 <Tantek> DanC, BTW, which came first? REC for xsd:dateTime or RFC3339?<br />
Aug 18 16:19:50 <DanC> RFC3339 is dated July 2002 ...<br />
Aug 18 16:19:54 <KragenSitaker> Right --- and you might be able to understand xsd:dateTime without reading all of xml schema, you wouldn't be confident of it<br />
Aug 18 16:20:25 <DanC> W3C Recommendation 28 October 2004 ... but that's 2nd ed...<br />
Aug 18 16:20:47 <DanC> W3C Recommendation 02 May 2001<br />
Aug 18 16:22:10 <DanC> I don't see a BNF in http://www.w3.org/TR/2001/REC-xmlschema-2-20010502/#dateTime ...<br />
Aug 18 16:22:43 <KragenSitaker> yeah, appendix D of the current xml schema datatypes document seems a little scanty, actually<br />
Aug 18 16:23:28 <DanC> ah... 2nd ed of http://www.w3.org/TR/xmlschema-2/#date is much more explicit about syntax.<br />
Aug 18 16:23:30 <KragenSitaker> it's 1100 words but still doesn't give any examples<br />
Aug 18 16:23:35 <DanC> still, it's given in prose and not BNF<br />
Aug 18 16:24:17 <KragenSitaker> sections 3.2.9 through 3.2.14 seem to be the relevant ones around #date<br />
Aug 18 16:24:29 <KragenSitaker> which is another 2200 words<br />
Aug 18 16:24:42 <DanC> wow... they changed the canonical form of date from always-Z to timezone-allowed between 1st edition and 2nd edition<br />
Aug 18 16:25:01 <Tantek> Kragen, DanC, these are very good analyses<br />
Aug 18 16:25:21 <Tantek> could I ask you to summarize the pros/cons for each in a new section at end of http://microformats.org/wiki/datetime-design-pattern<br />
Aug 18 16:25:22 <Tantek> ?<br />
Aug 18 16:25:58 <KragenSitaker> rfc 3339 is 4000 words, excluding the last two pages of boilerplate.<br />
Aug 18 16:26:31 <KragenSitaker> so it's actually longer than the datetime-relevant parts of XSD but it seems much more rigorous and clear<br />
Aug 18 16:28:37 <DanC> my advice is: normatively cite both, and claim they specify the same syntax, and let anybody who discovers otherwise send you a bug report with a test case<br />
Aug 18 16:29:12 <KragenSitaker> danc: nice hack<br />
</pre><br />
<br />
<br />
The RFC3339 has a mandatory TIME portion of the DATE-TIME. Some vCard/iCalendar DATE-TIME stamps can omit the TIME. For instance, DTSTART, if that is a full day event, then you can omit the time. BDAY in vCard can be respresented by only a DATE. I like the idea of restricting the possible date formats, but i think that TIME should be optional, which it isn't in RFC3339. - [http://suda.co.uk/ brian suda]<br />
<br />
RFC 3339 allows lowercase 't' and 'z' while XSD doesn't. Specifying RFC 3339 plus 'T' and 'Z' MUST be caps will make them the same. - [http://bitworking.org Joe Gregorio]</div>
RobertSayre
http://microformats.org/wiki/index.php?title=datetime-design-pattern&diff=1587
datetime-design-pattern
2005-09-05T17:43:27Z
<p>RobertSayre: </p>
<hr />
<div>'''This page is a draft.'''<br />
<br />
This is a page for exploring a datetime design pattern.<br />
<br />
The pattern which is now used in [[hcalendar|hCalendar]] and [[hreview|hReview]] is something like this:<br />
<br />
<pre>&lt;abbr class="foo" title="YYYYMMDDTHH:MM:SS+ZZZZ"&gt;Date Time&lt;/abbr&gt;</pre><br />
<br />
where foo is the semantic classname which is being applied to this date/time, the title of the &lt;abbr&gt; is an ISO 8601 date/time and "Date Time" is a human-friendly representation of the same date/time.<br />
<br />
This pattern is likely to be highly resuable.<br />
<br />
--[[RyanKing]]<br />
<br />
Can this not be viewed as a microformat in itself?<br />
<br />
--[[DimitriGlazkov]]<br />
<br />
It could, but inventing a microformat for the sake of inventing a microformat is against the microformat principles.<br />
If there is a specific real world problem (and uses cases) that such an elemental microformat would solve, then it would be worth considering.<br />
<br />
Until then it is best to keep the &lt;abbr&gt; datetime concept merely as a microformat design pattern, to be used in _actual_ microformats that have a demonstrated practical need.<br />
<br />
-- [http://tantek.com/log/ Tantek]<br />
<br />
Excerpt from #microformats Aug 18th. Please edit!<br />
<br />
<pre><br />
Aug 18 15:16:14 <Tantek> DanC, what do you think of RFC3339?<br />
Aug 18 15:17:14 <Tantek> ISO8601 subset<br />
Aug 18 15:17:19 <DanC> Date and Time on the Internet: Timestamps http://www.ietf.org/rfc/rfc3339.txt<br />
Aug 18 15:17:30 <DanC> Klyne is a good guy. I wonder if I talked with him about this.<br />
Aug 18 15:17:32 <Tantek> compat with W3C-NOTE-DATETIME<br />
Aug 18 15:17:50 <Tantek> compat with xsd:dateTime<br />
Aug 18 15:17:57 <Tantek> it's a strict intersection subset<br />
Aug 18 15:17:59 <DanC> I consider W3C-NOTE-DATETIME obsoleted by XML Schema datatype-- yeah.. xsd:dateTime<br />
Aug 18 15:18:32 <Tantek> compare/contrast normatively using xsd:dateTime vs. RFC3339<br />
Aug 18 15:18:41 <Tantek> note: Atom 1.0 chose RFC3339<br />
Aug 18 15:18:50 <Tantek> i would like input from the microformats community on this<br />
Aug 18 15:19:27 <DanC> in what context are you evaluating RFC 3339?<br />
Aug 18 15:19:28 <jcgregorio> http://bitworking.org/news/Date_Constructs_in_the_Atom_Syndication_Format<br />
Aug 18 15:21:24 <DanC> which microformat is the question coming from, Tantek ?<br />
Aug 18 15:23:31 <DanC> " The grammar element time-second may have the value "60" at the end of<br />
Aug 18 15:23:31 <DanC> months in which a leap second occurs" The XML Schema WG is in the 27th level of leap-second-hell for the past few months, I gather.<br />
Aug 18 15:24:21 <DanC> yeah... here's the scary bit: " Leap seconds cannot be predicted far into the future. The<br />
Aug 18 15:24:21 <DanC> International Earth Rotation Service publishes bulletins [IERS] that<br />
Aug 18 15:24:21 <DanC> announce leap seconds with a few weeks' warning."<br />
Aug 18 15:26:03 <Tantek> DanC, which microformats? any/all that use datetime fields.<br />
Aug 18 15:26:36 <DanC> hard to give useful advice, then.<br />
Aug 18 15:26:58 <DanC> I expect they'll use datetime fields for different things that have different cost/benefit trade-offs<br />
Aug 18 15:27:26 <DanC> do you know of any particular differences that matter to anybody?<br />
Aug 18 15:56:43 <KragenSitaker> RFC3339 suggests -07:00, which seems like an improvement over -0700 anyway<br />
Aug 18 15:56:49 <Tantek> Kragen, agreed<br />
Aug 18 15:57:01 <Tantek> RFC3339 is certainly preferable to the ISO8601 subset in iCalendar<br />
Aug 18 16:05:57 <DanC> Tantek's right, Kragen; iCalendar looks like it solves the local timezone problem but doesn't.<br />
Aug 18 16:06:14 <DanC> and it's true that there's no standard solution to the local timezone problem<br />
Aug 18 16:06:39 <Tantek> so instead of appearing to solve the problem but not solving it, we chose to provide the ability to *approximate* the local timezone using e.g. "-07:00"<br />
Aug 18 16:06:49 <DanC> the simplest thing is to have people use Z time in hCalendar. But I gather that's unacceptably unusable?<br />
Aug 18 16:07:35 <Tantek> DanC, yes, the simplest thing is to have everyone use UTC Z<br />
Aug 18 16:07:38 <Tantek> However<br />
Aug 18 16:07:50 <Tantek> it is not *nearly* as usuable/verifiable<br />
Aug 18 16:07:55 <Tantek> as -07:00 etc.<br />
Aug 18 16:08:02 <Tantek> hence the decision to go with the latter<br />
Aug 18 16:08:12 <Tantek> some degree of human verifiability is important here<br />
Aug 18 16:14:21 <Tantek> DanC, my perception is that RFC3339 is a subset<br />
Aug 18 16:17:00 <DanC> time-numoffset = ("+" / "-") time-hour ":" time-minute<br />
Aug 18 16:17:34 <DanC> ok, then I can't see any differences. (modulo recent leap seconds issues that may affect xsd:dateTime )<br />
Aug 18 16:18:07 <Tantek> would be interesting to know why Atom 1.0 chose RFC3339 over xsd:dateTime<br />
Aug 18 16:18:21 <Tantek> if there was a "real" reason or if it was arbitrary / coin-flip.<br />
</pre><br />
<br />
Here's an exhaustive [http://www.imc.org/atom-syntax/mail-archive/msg13103.html comparison] from ndw. I think xsd:dateTime also allows unqualified local times, while RFC3339 allows only UTC with no known timezone (-00:00). In the end, Atompub followed the advice of [http://www.imc.org/atom-syntax/mail-archive/msg13244.html Sam Ruby] and [http://www.imc.org/atom-syntax/mail-archive/msg13248.html Scott Hollenbeck] our area director. Atom dates make some additional restrictions on RFC3339, such as uppercase T and Z characters for compatibility with xsd:dateTime, RFC3339, W3C-DTF, and ISO8601. --[http://franklinmint.fm Robert Sayre]<br />
<br />
<pre><br />
Aug 18 16:18:43 <KragenSitaker> rfc3339 is pretty short.<br />
Aug 18 16:19:36 <Tantek> DanC, BTW, which came first? REC for xsd:dateTime or RFC3339?<br />
Aug 18 16:19:50 <DanC> RFC3339 is dated July 2002 ...<br />
Aug 18 16:19:54 <KragenSitaker> Right --- and you might be able to understand xsd:dateTime without reading all of xml schema, you wouldn't be confident of it<br />
Aug 18 16:20:25 <DanC> W3C Recommendation 28 October 2004 ... but that's 2nd ed...<br />
Aug 18 16:20:47 <DanC> W3C Recommendation 02 May 2001<br />
Aug 18 16:22:10 <DanC> I don't see a BNF in http://www.w3.org/TR/2001/REC-xmlschema-2-20010502/#dateTime ...<br />
Aug 18 16:22:43 <KragenSitaker> yeah, appendix D of the current xml schema datatypes document seems a little scanty, actually<br />
Aug 18 16:23:28 <DanC> ah... 2nd ed of http://www.w3.org/TR/xmlschema-2/#date is much more explicit about syntax.<br />
Aug 18 16:23:30 <KragenSitaker> it's 1100 words but still doesn't give any examples<br />
Aug 18 16:23:35 <DanC> still, it's given in prose and not BNF<br />
Aug 18 16:24:17 <KragenSitaker> sections 3.2.9 through 3.2.14 seem to be the relevant ones around #date<br />
Aug 18 16:24:29 <KragenSitaker> which is another 2200 words<br />
Aug 18 16:24:42 <DanC> wow... they changed the canonical form of date from always-Z to timezone-allowed between 1st edition and 2nd edition<br />
Aug 18 16:25:01 <Tantek> Kragen, DanC, these are very good analyses<br />
Aug 18 16:25:21 <Tantek> could I ask you to summarize the pros/cons for each in a new section at end of http://microformats.org/wiki/datetime-design-pattern<br />
Aug 18 16:25:22 <Tantek> ?<br />
Aug 18 16:25:58 <KragenSitaker> rfc 3339 is 4000 words, excluding the last two pages of boilerplate.<br />
Aug 18 16:26:31 <KragenSitaker> so it's actually longer than the datetime-relevant parts of XSD but it seems much more rigorous and clear<br />
Aug 18 16:28:37 <DanC> my advice is: normatively cite both, and claim they specify the same syntax, and let anybody who discovers otherwise send you a bug report with a test case<br />
Aug 18 16:29:12 <KragenSitaker> danc: nice hack<br />
</pre><br />
<br />
<br />
The RFC3339 has a mandatory TIME portion of the DATE-TIME. Some vCard/iCalendar DATE-TIME stamps can omit the TIME. For instance, DTSTART, if that is a full day event, then you can omit the time. BDAY in vCard can be respresented by only a DATE. I like the idea of restricting the possible date formats, but i think that TIME should be optional, which it isn't in RFC3339. - [http://suda.co.uk/ brian suda]<br />
<br />
RFC 3339 allows lowercase 't' and 'z' while XSD doesn't. Specifying RFC 3339 plus 'T' and 'Z' MUST be caps will make them the same. - [http://bitworking.org Joe Gregorio]</div>
RobertSayre
http://microformats.org/wiki/index.php?title=datetime-design-pattern&diff=1586
datetime-design-pattern
2005-09-05T17:43:11Z
<p>RobertSayre: </p>
<hr />
<div>'''This page is a draft.'''<br />
<br />
This is a page for exploring a datetime design pattern.<br />
<br />
The pattern which is now used in [[hcalendar|hCalendar]] and [[hreview|hReview]] is something like this:<br />
<br />
<pre>&lt;abbr class="foo" title="YYYYMMDDTHH:MM:SS+ZZZZ"&gt;Date Time&lt;/abbr&gt;</pre><br />
<br />
where foo is the semantic classname which is being applied to this date/time, the title of the &lt;abbr&gt; is an ISO 8601 date/time and "Date Time" is a human-friendly representation of the same date/time.<br />
<br />
This pattern is likely to be highly resuable.<br />
<br />
--[[RyanKing]]<br />
<br />
Can this not be viewed as a microformat in itself?<br />
<br />
--[[DimitriGlazkov]]<br />
<br />
It could, but inventing a microformat for the sake of inventing a microformat is against the microformat principles.<br />
If there is a specific real world problem (and uses cases) that such an elemental microformat would solve, then it would be worth considering.<br />
<br />
Until then it is best to keep the &lt;abbr&gt; datetime concept merely as a microformat design pattern, to be used in _actual_ microformats that have a demonstrated practical need.<br />
<br />
-- [http://tantek.com/log/ Tantek]<br />
<br />
Excerpt from #microformats Aug 18th. Please edit!<br />
<br />
<pre><br />
Aug 18 15:16:14 <Tantek> DanC, what do you think of RFC3339?<br />
Aug 18 15:17:14 <Tantek> ISO8601 subset<br />
Aug 18 15:17:19 <DanC> Date and Time on the Internet: Timestamps http://www.ietf.org/rfc/rfc3339.txt<br />
Aug 18 15:17:30 <DanC> Klyne is a good guy. I wonder if I talked with him about this.<br />
Aug 18 15:17:32 <Tantek> compat with W3C-NOTE-DATETIME<br />
Aug 18 15:17:50 <Tantek> compat with xsd:dateTime<br />
Aug 18 15:17:57 <Tantek> it's a strict intersection subset<br />
Aug 18 15:17:59 <DanC> I consider W3C-NOTE-DATETIME obsoleted by XML Schema datatype-- yeah.. xsd:dateTime<br />
Aug 18 15:18:32 <Tantek> compare/contrast normatively using xsd:dateTime vs. RFC3339<br />
Aug 18 15:18:41 <Tantek> note: Atom 1.0 chose RFC3339<br />
Aug 18 15:18:50 <Tantek> i would like input from the microformats community on this<br />
Aug 18 15:19:27 <DanC> in what context are you evaluating RFC 3339?<br />
Aug 18 15:19:28 <jcgregorio> http://bitworking.org/news/Date_Constructs_in_the_Atom_Syndication_Format<br />
Aug 18 15:21:24 <DanC> which microformat is the question coming from, Tantek ?<br />
Aug 18 15:23:31 <DanC> " The grammar element time-second may have the value "60" at the end of<br />
Aug 18 15:23:31 <DanC> months in which a leap second occurs" The XML Schema WG is in the 27th level of leap-second-hell for the past few months, I gather.<br />
Aug 18 15:24:21 <DanC> yeah... here's the scary bit: " Leap seconds cannot be predicted far into the future. The<br />
Aug 18 15:24:21 <DanC> International Earth Rotation Service publishes bulletins [IERS] that<br />
Aug 18 15:24:21 <DanC> announce leap seconds with a few weeks' warning."<br />
Aug 18 15:26:03 <Tantek> DanC, which microformats? any/all that use datetime fields.<br />
Aug 18 15:26:36 <DanC> hard to give useful advice, then.<br />
Aug 18 15:26:58 <DanC> I expect they'll use datetime fields for different things that have different cost/benefit trade-offs<br />
Aug 18 15:27:26 <DanC> do you know of any particular differences that matter to anybody?<br />
Aug 18 15:56:43 <KragenSitaker> RFC3339 suggests -07:00, which seems like an improvement over -0700 anyway<br />
Aug 18 15:56:49 <Tantek> Kragen, agreed<br />
Aug 18 15:57:01 <Tantek> RFC3339 is certainly preferable to the ISO8601 subset in iCalendar<br />
Aug 18 16:05:57 <DanC> Tantek's right, Kragen; iCalendar looks like it solves the local timezone problem but doesn't.<br />
Aug 18 16:06:14 <DanC> and it's true that there's no standard solution to the local timezone problem<br />
Aug 18 16:06:39 <Tantek> so instead of appearing to solve the problem but not solving it, we chose to provide the ability to *approximate* the local timezone using e.g. "-07:00"<br />
Aug 18 16:06:49 <DanC> the simplest thing is to have people use Z time in hCalendar. But I gather that's unacceptably unusable?<br />
Aug 18 16:07:35 <Tantek> DanC, yes, the simplest thing is to have everyone use UTC Z<br />
Aug 18 16:07:38 <Tantek> However<br />
Aug 18 16:07:50 <Tantek> it is not *nearly* as usuable/verifiable<br />
Aug 18 16:07:55 <Tantek> as -07:00 etc.<br />
Aug 18 16:08:02 <Tantek> hence the decision to go with the latter<br />
Aug 18 16:08:12 <Tantek> some degree of human verifiability is important here<br />
Aug 18 16:14:21 <Tantek> DanC, my perception is that RFC3339 is a subset<br />
Aug 18 16:17:00 <DanC> time-numoffset = ("+" / "-") time-hour ":" time-minute<br />
Aug 18 16:17:34 <DanC> ok, then I can't see any differences. (modulo recent leap seconds issues that may affect xsd:dateTime )<br />
Aug 18 16:18:07 <Tantek> would be interesting to know why Atom 1.0 chose RFC3339 over xsd:dateTime<br />
Aug 18 16:18:21 <Tantek> if there was a "real" reason or if it was arbitrary / coin-flip.<br />
</pre><br />
<br />
Here's an exhaustive [http://www.imc.org/atom-syntax/mail-archive/msg13103.html comparison] from ndw. I think xsd:dateTime also allows unqualified local times, while RFC3339 allows only UTC with no known timezone (-00:00). In the end, Atompub followed the advice of [http://www.imc.org/atom-syntax/mail-archive/msg13244.html Sam Ruby] and [http://www.imc.org/atom-syntax/mail-archive/msg13248.html Scott Hollenbeck] our area director. Atom dates make some additional restrictions on RFC3339, such as uppercase T and Z characters for compatibility with xsd:dateTime, RFC3339, W3C-DTF, and ISO8601. [http://franklinmint.fm Robert Sayre]<br />
<br />
<pre><br />
Aug 18 16:18:43 <KragenSitaker> rfc3339 is pretty short.<br />
Aug 18 16:19:36 <Tantek> DanC, BTW, which came first? REC for xsd:dateTime or RFC3339?<br />
Aug 18 16:19:50 <DanC> RFC3339 is dated July 2002 ...<br />
Aug 18 16:19:54 <KragenSitaker> Right --- and you might be able to understand xsd:dateTime without reading all of xml schema, you wouldn't be confident of it<br />
Aug 18 16:20:25 <DanC> W3C Recommendation 28 October 2004 ... but that's 2nd ed...<br />
Aug 18 16:20:47 <DanC> W3C Recommendation 02 May 2001<br />
Aug 18 16:22:10 <DanC> I don't see a BNF in http://www.w3.org/TR/2001/REC-xmlschema-2-20010502/#dateTime ...<br />
Aug 18 16:22:43 <KragenSitaker> yeah, appendix D of the current xml schema datatypes document seems a little scanty, actually<br />
Aug 18 16:23:28 <DanC> ah... 2nd ed of http://www.w3.org/TR/xmlschema-2/#date is much more explicit about syntax.<br />
Aug 18 16:23:30 <KragenSitaker> it's 1100 words but still doesn't give any examples<br />
Aug 18 16:23:35 <DanC> still, it's given in prose and not BNF<br />
Aug 18 16:24:17 <KragenSitaker> sections 3.2.9 through 3.2.14 seem to be the relevant ones around #date<br />
Aug 18 16:24:29 <KragenSitaker> which is another 2200 words<br />
Aug 18 16:24:42 <DanC> wow... they changed the canonical form of date from always-Z to timezone-allowed between 1st edition and 2nd edition<br />
Aug 18 16:25:01 <Tantek> Kragen, DanC, these are very good analyses<br />
Aug 18 16:25:21 <Tantek> could I ask you to summarize the pros/cons for each in a new section at end of http://microformats.org/wiki/datetime-design-pattern<br />
Aug 18 16:25:22 <Tantek> ?<br />
Aug 18 16:25:58 <KragenSitaker> rfc 3339 is 4000 words, excluding the last two pages of boilerplate.<br />
Aug 18 16:26:31 <KragenSitaker> so it's actually longer than the datetime-relevant parts of XSD but it seems much more rigorous and clear<br />
Aug 18 16:28:37 <DanC> my advice is: normatively cite both, and claim they specify the same syntax, and let anybody who discovers otherwise send you a bug report with a test case<br />
Aug 18 16:29:12 <KragenSitaker> danc: nice hack<br />
</pre><br />
<br />
<br />
The RFC3339 has a mandatory TIME portion of the DATE-TIME. Some vCard/iCalendar DATE-TIME stamps can omit the TIME. For instance, DTSTART, if that is a full day event, then you can omit the time. BDAY in vCard can be respresented by only a DATE. I like the idea of restricting the possible date formats, but i think that TIME should be optional, which it isn't in RFC3339. - [http://suda.co.uk/ brian suda]<br />
<br />
RFC 3339 allows lowercase 't' and 'z' while XSD doesn't. Specifying RFC 3339 plus 'T' and 'Z' MUST be caps will make them the same. - [http://bitworking.org Joe Gregorio]</div>
RobertSayre
http://microformats.org/wiki/index.php?title=datetime-design-pattern&diff=1585
datetime-design-pattern
2005-09-05T17:42:19Z
<p>RobertSayre: </p>
<hr />
<div>'''This page is a draft.'''<br />
<br />
This is a page for exploring a datetime design pattern.<br />
<br />
The pattern which is now used in [[hcalendar|hCalendar]] and [[hreview|hReview]] is something like this:<br />
<br />
<pre>&lt;abbr class="foo" title="YYYYMMDDTHH:MM:SS+ZZZZ"&gt;Date Time&lt;/abbr&gt;</pre><br />
<br />
where foo is the semantic classname which is being applied to this date/time, the title of the &lt;abbr&gt; is an ISO 8601 date/time and "Date Time" is a human-friendly representation of the same date/time.<br />
<br />
This pattern is likely to be highly resuable.<br />
<br />
--[[RyanKing]]<br />
<br />
Can this not be viewed as a microformat in itself?<br />
<br />
--[[DimitriGlazkov]]<br />
<br />
It could, but inventing a microformat for the sake of inventing a microformat is against the microformat principles.<br />
If there is a specific real world problem (and uses cases) that such an elemental microformat would solve, then it would be worth considering.<br />
<br />
Until then it is best to keep the &lt;abbr&gt; datetime concept merely as a microformat design pattern, to be used in _actual_ microformats that have a demonstrated practical need.<br />
<br />
-- [http://tantek.com/log/ Tantek]<br />
<br />
Excerpt from #microformats Aug 18th. Please edit!<br />
<br />
<pre><br />
Aug 18 15:16:14 <Tantek> DanC, what do you think of RFC3339?<br />
Aug 18 15:17:14 <Tantek> ISO8601 subset<br />
Aug 18 15:17:19 <DanC> Date and Time on the Internet: Timestamps http://www.ietf.org/rfc/rfc3339.txt<br />
Aug 18 15:17:30 <DanC> Klyne is a good guy. I wonder if I talked with him about this.<br />
Aug 18 15:17:32 <Tantek> compat with W3C-NOTE-DATETIME<br />
Aug 18 15:17:50 <Tantek> compat with xsd:dateTime<br />
Aug 18 15:17:57 <Tantek> it's a strict intersection subset<br />
Aug 18 15:17:59 <DanC> I consider W3C-NOTE-DATETIME obsoleted by XML Schema datatype-- yeah.. xsd:dateTime<br />
Aug 18 15:18:32 <Tantek> compare/contrast normatively using xsd:dateTime vs. RFC3339<br />
Aug 18 15:18:41 <Tantek> note: Atom 1.0 chose RFC3339<br />
Aug 18 15:18:50 <Tantek> i would like input from the microformats community on this<br />
Aug 18 15:19:27 <DanC> in what context are you evaluating RFC 3339?<br />
Aug 18 15:19:28 <jcgregorio> http://bitworking.org/news/Date_Constructs_in_the_Atom_Syndication_Format<br />
Aug 18 15:21:24 <DanC> which microformat is the question coming from, Tantek ?<br />
Aug 18 15:23:31 <DanC> " The grammar element time-second may have the value "60" at the end of<br />
Aug 18 15:23:31 <DanC> months in which a leap second occurs" The XML Schema WG is in the 27th level of leap-second-hell for the past few months, I gather.<br />
Aug 18 15:24:21 <DanC> yeah... here's the scary bit: " Leap seconds cannot be predicted far into the future. The<br />
Aug 18 15:24:21 <DanC> International Earth Rotation Service publishes bulletins [IERS] that<br />
Aug 18 15:24:21 <DanC> announce leap seconds with a few weeks' warning."<br />
Aug 18 15:26:03 <Tantek> DanC, which microformats? any/all that use datetime fields.<br />
Aug 18 15:26:36 <DanC> hard to give useful advice, then.<br />
Aug 18 15:26:58 <DanC> I expect they'll use datetime fields for different things that have different cost/benefit trade-offs<br />
Aug 18 15:27:26 <DanC> do you know of any particular differences that matter to anybody?<br />
Aug 18 15:56:43 <KragenSitaker> RFC3339 suggests -07:00, which seems like an improvement over -0700 anyway<br />
Aug 18 15:56:49 <Tantek> Kragen, agreed<br />
Aug 18 15:57:01 <Tantek> RFC3339 is certainly preferable to the ISO8601 subset in iCalendar<br />
Aug 18 16:05:57 <DanC> Tantek's right, Kragen; iCalendar looks like it solves the local timezone problem but doesn't.<br />
Aug 18 16:06:14 <DanC> and it's true that there's no standard solution to the local timezone problem<br />
Aug 18 16:06:39 <Tantek> so instead of appearing to solve the problem but not solving it, we chose to provide the ability to *approximate* the local timezone using e.g. "-07:00"<br />
Aug 18 16:06:49 <DanC> the simplest thing is to have people use Z time in hCalendar. But I gather that's unacceptably unusable?<br />
Aug 18 16:07:35 <Tantek> DanC, yes, the simplest thing is to have everyone use UTC Z<br />
Aug 18 16:07:38 <Tantek> However<br />
Aug 18 16:07:50 <Tantek> it is not *nearly* as usuable/verifiable<br />
Aug 18 16:07:55 <Tantek> as -07:00 etc.<br />
Aug 18 16:08:02 <Tantek> hence the decision to go with the latter<br />
Aug 18 16:08:12 <Tantek> some degree of human verifiability is important here<br />
Aug 18 16:14:21 <Tantek> DanC, my perception is that RFC3339 is a subset<br />
Aug 18 16:17:00 <DanC> time-numoffset = ("+" / "-") time-hour ":" time-minute<br />
Aug 18 16:17:34 <DanC> ok, then I can't see any differences. (modulo recent leap seconds issues that may affect xsd:dateTime )<br />
Aug 18 16:18:07 <Tantek> would be interesting to know why Atom 1.0 chose RFC3339 over xsd:dateTime<br />
Aug 18 16:18:21 <Tantek> if there was a "real" reason or if it was arbitrary / coin-flip.<br />
</pre><br />
<br />
Here's an exhaustive [http://www.imc.org/atom-syntax/mail-archive/msg13103.html comparison] from ndw. I think xsd:dateTime also allows unqualified local times, while RFC3339 allows only UTC with no known timezone (-00:00). In the end, Atompub followed the advice of [http://www.imc.org/atom-syntax/mail-archive/msg13244.html Sam Ruby] and [http://www.imc.org/atom-syntax/mail-archive/msg13248.html Scott Hollenbeck] our area director. Atom dates make some additional restrictions on RFC3339, such as uppercase T and Z characters for compatibility with xsd:dateTime, RFC3339, W3C-DTF, and ISO8601.<br />
<br />
<pre><br />
Aug 18 16:18:43 <KragenSitaker> rfc3339 is pretty short.<br />
Aug 18 16:19:36 <Tantek> DanC, BTW, which came first? REC for xsd:dateTime or RFC3339?<br />
Aug 18 16:19:50 <DanC> RFC3339 is dated July 2002 ...<br />
Aug 18 16:19:54 <KragenSitaker> Right --- and you might be able to understand xsd:dateTime without reading all of xml schema, you wouldn't be confident of it<br />
Aug 18 16:20:25 <DanC> W3C Recommendation 28 October 2004 ... but that's 2nd ed...<br />
Aug 18 16:20:47 <DanC> W3C Recommendation 02 May 2001<br />
Aug 18 16:22:10 <DanC> I don't see a BNF in http://www.w3.org/TR/2001/REC-xmlschema-2-20010502/#dateTime ...<br />
Aug 18 16:22:43 <KragenSitaker> yeah, appendix D of the current xml schema datatypes document seems a little scanty, actually<br />
Aug 18 16:23:28 <DanC> ah... 2nd ed of http://www.w3.org/TR/xmlschema-2/#date is much more explicit about syntax.<br />
Aug 18 16:23:30 <KragenSitaker> it's 1100 words but still doesn't give any examples<br />
Aug 18 16:23:35 <DanC> still, it's given in prose and not BNF<br />
Aug 18 16:24:17 <KragenSitaker> sections 3.2.9 through 3.2.14 seem to be the relevant ones around #date<br />
Aug 18 16:24:29 <KragenSitaker> which is another 2200 words<br />
Aug 18 16:24:42 <DanC> wow... they changed the canonical form of date from always-Z to timezone-allowed between 1st edition and 2nd edition<br />
Aug 18 16:25:01 <Tantek> Kragen, DanC, these are very good analyses<br />
Aug 18 16:25:21 <Tantek> could I ask you to summarize the pros/cons for each in a new section at end of http://microformats.org/wiki/datetime-design-pattern<br />
Aug 18 16:25:22 <Tantek> ?<br />
Aug 18 16:25:58 <KragenSitaker> rfc 3339 is 4000 words, excluding the last two pages of boilerplate.<br />
Aug 18 16:26:31 <KragenSitaker> so it's actually longer than the datetime-relevant parts of XSD but it seems much more rigorous and clear<br />
Aug 18 16:28:37 <DanC> my advice is: normatively cite both, and claim they specify the same syntax, and let anybody who discovers otherwise send you a bug report with a test case<br />
Aug 18 16:29:12 <KragenSitaker> danc: nice hack<br />
</pre><br />
<br />
<br />
The RFC3339 has a mandatory TIME portion of the DATE-TIME. Some vCard/iCalendar DATE-TIME stamps can omit the TIME. For instance, DTSTART, if that is a full day event, then you can omit the time. BDAY in vCard can be respresented by only a DATE. I like the idea of restricting the possible date formats, but i think that TIME should be optional, which it isn't in RFC3339. - [http://suda.co.uk/ brian suda]<br />
<br />
RFC 3339 allows lowercase 't' and 'z' while XSD doesn't. Specifying RFC 3339 plus 'T' and 'Z' MUST be caps will make them the same. - [http://bitworking.org Joe Gregorio]</div>
RobertSayre