RubyGems - microfiche - Versions diffs - 1.0.0 - Mend

microfiche 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (9) hide show

data/ProjectInfo +31 -0
data/README +24 -0
data/Rakefile +2 -0
data/VERSION +1 -0
data/lib/facets/json.rb +917 -0
data/lib/facets/xoxo.rb +541 -0
data/test/lib/facets/test_json.rb +232 -0
data/test/lib/facets/test_xoxo.rb +288 -0
metadata +61 -0

data/lib/facets/xoxo.rb ADDED Viewed

@@ -0,0 +1,541 @@
+# = xoxo.rb
+#
+# == Copyright (C) 2006 Christian Neukirchen
+#
+#   Ruby License
+#
+#   This module is free software. You may use, modify, and/or redistribute this
+#   software under the same terms as Ruby.
+#
+#   This program is distributed in the hope that it will be useful, but WITHOUT
+#   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+#   FOR A PARTICULAR PURPOSE.
+#
+# == Special Thanks
+#
+# Special thanks go to Christian Neukirchen for xoxo.rb.
+# * http://chneukirchen.org/repos/xoxo-rb/.
+#
+# == Author(s)
+#
+# * Christian Neukirchen
+# Author::    Christian Neukirchen
+# Copyright:: Copyright (c) 2006 Christian Neukirchen
+# License::   Ruby License
+require 'rexml/parsers/pullparser'
+# = XOXO
+#
+# XOXO is a Ruby XOXO parser and generator. It provides
+# a Ruby API similar to Marshal and YAML (though more
+# specific) to load and dump XOXO[http://microformats.org/wiki/xoxo],
+# an simple, open outline format written in standard XHTML and
+# suitable for embedding in (X)HTML, Atom, RSS, and arbitrary XML.
+module XOXO
+  # xoxo.rb version number
+  #VERSION = "0.1"
+  # Load and return a XOXO structure from the String, IO or StringIO or _xoxo_.
+  #
+  def self.load(xoxo)
+    structs = Parser.new(xoxo).parse.structs
+    while structs.kind_of?(Array) && structs.size == 1
+      structs = structs.first
+    end
+    structs
+  end
+  # Return a XOXO string corresponding to the Ruby object +struct+,
+  # translated to the following rules:
+  #
+  # * Arrays become ordered lists <tt><ol></tt>.
+  # * Hashes become definition lists <tt><dl></tt>, keys are
+  #   stringified with +to_s+.
+  # * Everything else becomes stringified with +to_s+ and wrapped in
+  #   appropriate list elements (<tt><li></tt> or <tt><dt></tt>/<tt><dd></tt>).
+  #
+  # Additionally, you can pass these options on the _options_ hash:
+  # <tt>:html_wrap</tt> => +true+:: Wrap the XOXO with a basic XHTML 1.0
+  #                                 Transitional header.
+  # <tt>:css</tt> => _css_::        Reference _css_ as stylesheet for the
+  #                                 wrapped XOXO document.
+  #
+  def self.dump(struct, options={})
+    struct = [struct]  unless struct.kind_of? Array
+    if options[:html_wrap]
+      result = <<EOF.strip
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN
+http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml"><head profile=""><meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+EOF
+      if options[:css]
+        result << %Q[<style type="text/css" >@import "#{options[:css]}";</style>]
+      end
+      result << "</head><body>" << make_xoxo(struct, 'xoxo') << "</body></html>"
+    else
+      result = make_xoxo(struct, 'xoxo')
+    end
+    result
+  end
+  private
+  def self.make_xoxo(struct, class_name=nil)
+    s = ''
+    case struct
+    when Array
+      if class_name
+        s << %Q[<ol class="#{class_name}">]
+      else
+        s << "<ol>"
+      end
+      struct.each { |item|
+        s << "<li>" << make_xoxo(item) << "</li>"
+      }
+      s << "</ol>"
+    when Hash
+      d = struct.dup
+      if d.has_key? 'url'
+        s << '<a href="' << d['url'].to_s << '" '
+        text = d.fetch('text') { d.fetch('title', d['url']) }
+        %w[title rel type].each { |tag|
+          if d.has_key? tag
+            s << tag.to_s << '="' << make_xoxo(d.delete(tag)) << '" '
+          end
+        }
+        s << '>' << make_xoxo(text) << '</a>'
+        d.delete 'text'
+        d.delete 'url'
+      end
+      unless d.empty?
+        s << "<dl>"
+        d.each { |key, value|
+          s << "<dt>" << key.to_s << "</dt><dd>" << make_xoxo(value) << "</dd>"
+        }
+        s << "</dl>"
+      end
+    when String
+      s << struct
+    else
+      s << struct.to_s          # too gentle?
+    end
+    s
+  end
+end
+class XOXO::Parser              # :nodoc:
+  CONTAINER_TAGS = %w{dl ol ul}
+  attr_reader :structs
+  def initialize(xoxo)
+    @parser = REXML::Parsers::PullParser.new(xoxo)
+    @textstack = ['']
+    @xostack = []
+    @structs = []
+    @tags = []
+  end
+  def parse
+    while @parser.has_next?
+      res = @parser.pull
+      if res.start_element?
+        @tags << res[0]
+        case res[0]
+        when "a"
+          attrs = normalize_attrs res[1]
+          attrs['url'] = attrs['href']
+          attrs.delete 'href'
+          push attrs
+          @textstack << ''
+        when "dl"
+          push({})
+        when "ol", "ul"
+          push []
+        when "li", "dt", "dd"
+          @textstack << ''
+        end
+      elsif res.end_element?
+        @tags.pop
+        case res[0]
+        when "a"
+          val = @textstack.pop
+          unless val.empty?
+            val = ''  if @xostack.last['title'] == val
+            val = ''  if @xostack.last['url'] == val
+            @xostack.last['text'] = val  unless val.empty?
+          end
+          @xostack.pop
+        when "dl", "ol", "ul"
+          @xostack.pop
+        when "li"
+          val = @textstack.pop
+          while @structs.last != @xostack.last
+            val = @structs.pop
+            @xostack.last << val
+          end
+          @xostack.last << val  if val.kind_of? String
+        when "dt"
+          # skip
+        when "dd"
+          val = @textstack.pop
+          key = @textstack.pop
+          val = @structs.pop  if @structs.last != @xostack.last
+          @xostack.last[key] = val
+        end
+      elsif res.text?
+        unless @tags.empty? || CONTAINER_TAGS.include?(@tags.last)
+          @textstack.last << res[0]
+        end
+      end
+    end
+    self
+  end
+  private
+  def normalize_attrs(attrs)
+    attrs.keys.find_all { |k, v| k != k.downcase }.each { |k, v|
+      v = v.downcase  if k == "rel" || k == "type"
+      attrs.delete k
+      attrs[k.downcase] = v
+    }
+    attrs
+  end
+  def push(struct)
+    if struct == {} && @structs.last.kind_of?(Hash) &&
+        @structs.last.has_key?('url') &&
+        @structs.last != @xostack.last
+      # put back the <a>-made one for extra def's
+      @xostack << @structs.last
+    else
+      @structs << struct
+      @xostack << @structs.last
+    end
+  end
+end
+class Object
+  # Dump object as XOXO.
+  def to_xoxo(*args)
+    XOXO.dump(self,*args)
+  end
+end
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin test
+  require 'test/unit'
+  class TCXOXO < Test::Unit::TestCase
+    def test_simple_list
+      l = ['1', '2', '3']
+      html = XOXO.dump(l)
+      assert_equal '<ol class="xoxo"><li>1</li><li>2</li><li>3</li></ol>', html
+    end
+    def test_nested_list
+      l = ['1', ['2', '3']]
+      assert_equal '<ol class="xoxo"><li>1</li><li><ol><li>2</li><li>3</li></ol></li></ol>', XOXO.dump(l)
+    end
+    def test_hash
+      h = {'test' => '1', 'name' => 'Kevin'}
+      # Changed since Ruby sorts the hash differently.
+      assert_equal '<ol class="xoxo"><li><dl><dt>name</dt><dd>Kevin</dd><dt>test</dt><dd>1</dd></dl></li></ol>', XOXO.dump(h)
+    end
+    def test_single_item
+      l = 'test'
+      assert_equal '<ol class="xoxo"><li>test</li></ol>', XOXO.dump(l)
+    end
+    def test_wrap_differs
+      l = 'test'
+      html = XOXO.dump(l)
+      html_wrap = XOXO.dump(l, :html_wrap => true)
+      assert_not_equal html, html_wrap
+    end
+    def test_wrap_single_item
+      l = 'test'
+      html = XOXO.dump(l, :html_wrap => true)
+      assert_equal <<EOF.strip, html
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN
+http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml"><head profile=""><meta http-equiv="Content-Type" content="text/html; charset=utf-8" /></head><body><ol class="xoxo"><li>test</li></ol></body></html>
+EOF
+    end
+    def test_wrap_item_with_css
+      l = 'test'
+      html = XOXO.dump(l, :html_wrap => true, :css => 'reaptest.css')
+      assert_equal <<EOF.strip, html
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN
+http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml"><head profile=""><meta http-equiv="Content-Type" content="text/html; charset=utf-8" /><style type="text/css" >@import "reaptest.css";</style></head><body><ol class="xoxo"><li>test</li></ol></body></html>
+EOF
+    end
+    def test_hash_roundtrip
+      h = {'test' => '1', 'name' => 'Kevin'}
+      assert_equal h, XOXO.load(XOXO.dump(h))
+    end
+    def test_hash_with_url_roundtrip
+      h = {'url' => 'http://example.com', 'name' => 'Kevin'}
+      assert_equal h, XOXO.load(XOXO.dump(h))
+    end
+    def test_nested_hash_roundtrip
+      h = {'test' => '1', 'inner' => {'name' => 'Kevin'}}
+      assert_equal h, XOXO.load(XOXO.dump(h))
+    end
+    def test_nested_hash_with_url_roundtrip
+      h = {'url' => 'http://example.com', 'inner' => {
+            'url' => 'http://slashdot.org', 'name' => 'Kevin'}}
+      assert_equal h, XOXO.load(XOXO.dump(h))
+    end
+    def test_list_round_trip
+      l = ['3', '2', '1']
+      assert_equal l, XOXO.load(XOXO.dump(l))
+    end
+    def test_list_of_hashes_round_trip
+      l = ['3', {'a' => '2'}, {'b' => '1', 'c' => '4'}]
+      assert_equal l, XOXO.load(XOXO.dump(l))
+    end
+    def test_list_of_lists_round_trip
+      l = ['3', ['a', '2'], ['b', ['1', ['c', '4']]]]
+      assert_equal l, XOXO.load(XOXO.dump(l))
+    end
+    def test_hashes_of_lists_roundtrip
+      h = {
+        'test' => ['1', '2'],
+        'name' => 'Kevin',
+        'nestlist' => ['a', ['b', 'c']],
+        'nestdict' => {'e' => '6', 'f' => '7'}
+      }
+      assert_equal h, XOXO.load(XOXO.dump(h))
+    end
+    def test_xoxo_junk_in_containers
+      h = XOXO.load '<ol>bad<li><dl>worse<dt>good</dt><dd>buy</dd> now</dl></li></ol>'
+      assert_equal({'good' => 'buy'}, h)
+    end
+    def test_xoxo_junk_in_elements
+      l = XOXO.load '<ol><li>bad<dl><dt>good</dt><dd>buy</dd></dl>worse</li><li>bag<ol><li>OK</li></ol>fish</li></ol>'
+      assert_equal([{'good' => 'buy'}, ['OK']], l)
+    end
+    def test_xoxo_with_spaces_and_newlines
+      xoxo_sample = <<EOF.strip
+<ol class='xoxo'>
+  <li>
+    <dl>
+        <dt>text</dt>
+        <dd>item 1</dd>
+        <dt>description</dt>
+        <dd> This item represents the main point we're trying to make.</dd>
+        <dt>url</dt>
+        <dd>http://example.com/more.xoxo</dd>
+        <dt>title</dt>
+        <dd>title of item 1</dd>
+        <dt>type</dt>
+        <dd>text/xml</dd>
+        <dt>rel</dt>
+        <dd>help</dd>
+    </dl>
+  </li>
+</ol>
+EOF
+      h = XOXO.load xoxo_sample
+      h2 = {
+        'text' => 'item 1',
+        'description' => " This item represents the main point we're trying to make.",
+        'url' => 'http://example.com/more.xoxo',
+        'title' => 'title of item 1',
+        'type' => 'text/xml',
+        'rel' => 'help'
+      }
+      assert_equal h2, XOXO.load(xoxo_sample)
+    end
+    def test_special_attribute_decoding
+      xoxo_sample = <<EOF.strip
+<ol class='xoxo'>
+  <li>
+    <dl>
+        <dt>text</dt>
+        <dd>item 1</dd>
+        <dt>url</dt>
+        <dd>http://example.com/more.xoxo</dd>
+        <dt>title</dt>
+        <dd>title of item 1</dd>
+        <dt>type</dt>
+        <dd>text/xml</dd>
+        <dt>rel</dt>
+        <dd>help</dd>
+    </dl>
+  </li>
+</ol>
+EOF
+      smart_xoxo_sample = <<EOF.strip
+<ol class='xoxo'>
+  <li><a href="http://example.com/more.xoxo"
+         title="title of item 1"
+         type="text/xml"
+         rel="help">item 1</a>
+<!-- note how the "text" property is simply the contents of the <a> element -->
+  </li>
+</ol>
+EOF
+      assert_equal XOXO.load(xoxo_sample), XOXO.load(smart_xoxo_sample)
+    end
+    def test_special_attribute_and_dl_decoding
+      xoxo_sample = <<EOF.strip
+<ol class="xoxo">
+  <li>
+    <dl>
+        <dt>text</dt>
+        <dd>item 1</dd>
+        <dt>description</dt>
+        <dd> This item represents the main point we're trying to make.</dd>
+        <dt>url</dt>
+        <dd>http://example.com/more.xoxo</dd>
+        <dt>title</dt>
+        <dd>title of item 1</dd>
+        <dt>type</dt>
+        <dd>text/xml</dd>
+        <dt>rel</dt>
+        <dd>help</dd>
+    </dl>
+  </li>
+</ol>
+EOF
+      smart_xoxo_sample = <<EOF.strip
+<ol class="xoxo">
+  <li><a href="http://example.com/more.xoxo"
+         title="title of item 1"
+         type="text/xml"
+         rel="help">item 1</a>
+<!-- note how the "text" property is simply the contents of the <a> element -->
+      <dl>
+        <dt>description</dt>
+          <dd> This item represents the main point we're trying to make.</dd>
+      </dl>
+  </li>
+</ol>
+EOF
+      assert_equal XOXO.load(xoxo_sample), XOXO.load(smart_xoxo_sample)
+    end
+    def test_special_attribute_encode
+      h = {
+        'url' => 'http://example.com/more.xoxo',
+        'title' => 'sample url',
+        'type' => "text/xml",
+        'rel' => 'help',
+        'text' => 'an example'
+      }
+      assert_equal '<ol class="xoxo"><li><a href="http://example.com/more.xoxo" title="sample url" rel="help" type="text/xml" >an example</a></li></ol>', XOXO.dump(h)
+    end
+    def test_special_attribute_roundtrip_full
+      h = {
+        'url' => 'http://example.com/more.xoxo',
+        'title' => 'sample url',
+        'type' => "text/xml",
+        'rel' => 'help',
+        'text' => 'an example'
+      }
+      assert_equal h, XOXO.load(XOXO.dump(h))
+    end
+    def test_special_attribute_roundtrip_no_text
+      h = {
+        'url' => 'http://example.com/more.xoxo',
+        'title' => 'sample url',
+        'type' => "text/xml",
+        'rel' => 'help'
+      }
+      assert_equal h, XOXO.load(XOXO.dump(h))
+    end
+    def test_special_attribute_roundtrip_no_text_or_title
+      h = {'url' => 'http://example.com/more.xoxo'}
+      assert_equal h, XOXO.load(XOXO.dump(h))
+    end
+    def test_attention_roundtrip
+      kmattn = <<EOF.strip
+<ol class="xoxo"><li><a href="http://www.boingboing.net/" title="Boing Boing Blog" >Boing Boing Blog</a><dl><dt>alturls</dt><dd><ol><li><a href="http://boingboing.net/rss.xml" >xmlurl</a></li></ol></dd><dt>description</dt><dd>Boing Boing Blog</dd></dl></li><li><a href="http://www.financialcryptography.com/" title="Financial Cryptography" >Financial Cryptography</a><dl><dt>alturls</dt><dd><ol><li><a href="http://www.financialcryptography.com/mt/index.rdf" >xmlurl</a></li></ol></dd><dt>description</dt><dd>Financial Cryptography</dd></dl></li><li><a href="http://hublog.hubmed.org/" title="HubLog" >HubLog</a><dl><dt>alturls</dt><dd><ol><li><a href="http://hublog.hubmed.org/index.xml" >xmlurl</a></li><li><a href="http://hublog.hubmed.org/foaf.rdf" >foafurl</a></li></ol></dd><dt>description</dt><dd>HubLog</dd></dl></li></ol>
+EOF
+      assert_equal kmattn, XOXO.dump(XOXO.load(kmattn))
+      assert_equal XOXO.load(kmattn), XOXO.load(XOXO.dump(XOXO.load(kmattn)))
+      assert_equal XOXO.dump(XOXO.load(kmattn)),
+                  XOXO.dump(XOXO.load(XOXO.dump(XOXO.load(kmattn))))
+    end
+    def test_unicode_roundtrip
+      unicode = "Tantek \xc3\x87elik and a snowman \xe2\x98\x83"
+      assert_equal unicode, XOXO.load(XOXO.dump(unicode))
+    end
+  # TBD:  Implement proper encodings.
+  #
+  #  def test_utf8_roundtrip
+  #  end
+  #  def test_windows1252_roundtrip
+  #  end
+  end
+=end