xoxo 1.1.0 → 1.2.0

data/.ruby

@@ -1,36 +1,48 @@
---- 
-spec_version: 1.0.0
-replaces: []
-
-loadpath: 
-- lib
-name: xoxo
-repositories: 
-  public: git://github.com/rubyworks/xoxo.git
+---
+source:
+- meta
+authors:
+- name: Thomas Sawyer
+  email: transfire@gmail.com
+- name: Christian Neukirchen
+  email: chneukirchen@gmail.com
+copyrights:
+- holder: Christian Neukirchen
+  year: '2006'
+  license: MIT
+replacements: []
+alternatives: []
+requirements:
+- name: detroit
+  groups:
+  - build
+  development: true
+- name: qed
+  groups:
+  - test
+  development: true
+dependencies: []
 conflicts: []
-
-engine_check: []
-
-title: XOXO
-contact: Thomas Sawyer <transfire@gmail.com>
-resources: 
-  code: http://github.com/rubyworks/xoxo
+repositories:
+- uri: git://github.com/rubyworks/xoxo.git
+  scm: git
+  name: upstream
+resources:
   home: http://rubyworks.github.com/xoxo
-maintainers: []
-
-requires: 
-- group: 
-  - build
-  name: redline
-  version: 0+
-suite: rubyworks
-manifest: MANIFEST.txt
-version: 1.1.0
-licenses: 
-- chneukirchen
-copyright: Copyright (c) 2006 Christian Neukirchen
-authors: 
-- Christian Neukirchen <chneukirchen@gmail.com>
-description: 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.
+  code: http://github.com/rubyworks/xoxo
+  mail: http://groups.google.com/rubyworks-mailinglist
+extra: {}
+load_path:
+- lib
+revision: 0
+created: '2006-01-01'
 summary: XOXO Parser and Generator
-created: 2006-01-01
+title: XOXO
+version: 1.2.0
+name: xoxo
+description: ! "XOXO is a Ruby XOXO parser and generator. It provides a Ruby API \nsimilar
+  to Marshal and YAML (though more specific) to load and dump\nXOXO[http://microformats.org/wiki/xoxo],
+  an simple, open outline\nformat written in standard XHTML and suitable for embedding
+  in\n(X)HTML, Atom, RSS, and arbitrary XML."
+organization: rubyworks
+date: '2011-10-26'

data/.yardopts

@@ -0,0 +1,8 @@
+--title "XOXO"
+--readme README.rdoc
+--protected
+--private
+lib/**/*.rb
+-
+[A-Z]*.*
+

data/COPYING.rdoc

@@ -1,22 +1,27 @@
 = COPYRIGHT NOTICES
 
-== xoxo.rb
+== XOXO
+
+Copyright:: (c) 2007 Christian Neukirchen
+License:: MIT
+Website:: http://rubyworks.github.com/xoxo
+
+    Copyright (c) 2007 Christian Neukirchen <purl.org/net/chneukirchen>
+     
+    Permission is hereby granted, free of charge, to any person obtaining a copy
+    of this software and associated documentation files (the "Software"), to
+    deal in the Software without restriction, including without limitation the
+    rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+    sell copies of the Software, and to permit persons to whom the Software is
+    furnished to do so, subject to the following conditions:
+     
+    The above copyright notice and this permission notice shall be included in
+    all copies or substantial portions of the Software.
+     
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+    THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+    IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+    CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
-Copyright (c) 2007, 2008 Christian Neukirchen <purl.org/net/chneukirchen>
- 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to
-deal in the Software without restriction, including without limitation the
-rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
-sell copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
- 
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
- 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
-THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
-IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
-CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/HISTORY.rdoc

@@ -1,5 +1,17 @@
 = RELEASE HISTORY
 
+== 1.2.0 | 2011-10-26
+
+Converting Hashes with 'url' for a key are treated completely as `a` tags.
+Before they were converted into `a` tags and `dl` tags for any "left over" 
+keys. This release also modernizes the build configuraiton.
+
+Changes:
+
+* Hashes with 'url' keys are ONLY `a` tags.
+* Use XOXO::Assoc to keep definition lists in order if possible.
+* Modernize build configuration.
+
 
 == 1.1.0 | 2011-05-05
 

data/README.rdoc

@@ -1,5 +1,12 @@
 = XOXO
 
+{Homepage}[http://rubyworks.github.com/xoxo] |
+{Source Code}[http://github.com/rubyworks/xoxo] |
+{Issue Tracker}[http://github.com/rubyworks/xoxo/issues]
+
+{<img src="http://travis-ci.org/rubyworks/xoxo.png" />}[http://travis-ci.org/rubyworks/xoxo]
+
+
 == DESCRIPTION
 
 XOXO is a Ruby XOXO parser and generator. It provides
@@ -12,14 +19,11 @@ suitable for embedding in (X)HTML, Atom, RSS, and arbitrary XML.
 == FEATURES
 
 * Uses REXML's pull parser.
-* Serialize any object via to_xoxo.
+* Serialize any object via `to_xoxo`.
 
 
 == RESOURCES
 
-* home: http://rubyworks.github.com/xoxo
-* code: http://github.com/rubyworks/xoxo
-
 The original version of this code was written by Christian Neukirchen,
 and can be found here[http://chneukirchen.org/repos/xoxo-rb/] and a
 blog post on it here[http://chneukirchen.org/blog/archive/2006/01/xoxo-rb-0-1-released.html].
@@ -29,7 +33,7 @@ The offical XOXO format site is here[http://microformats.org/wiki/xoxo].
 
 == RELEASE NOTES
 
-Please see HISTORY file.
+Please see HISTORY.rdoc file.
 
 
 == SYNOPSIS
@@ -57,11 +61,11 @@ then download the tarball package and type:
 Windows users use 'ruby setup.rb all'.
 
 
-== COPYING
+== COPYRIGHTS
 
-Copyright (C) 2006 Christian Neukirchen
+Copyright (c) 2006 Christian Neukirchen, Rubyworks
 
-This program is ditributed unser the terms of the Ruby license.
+This program is ditributable under the terms of the *MIT* license.
 
-See COPYING file for details.
+See COPYING.rdoc file for details.
 

data/lib/xoxo.rb

@@ -21,7 +21,7 @@ require 'rexml/parsers/pullparser'
 #
 module XOXO
   # xoxo.rb version number
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"  # :erb: VERSION = "<%= version %>"
 
   # Load and return a XOXO structure from the String, IO or StringIO or _xoxo_.
   def self.load(xoxo)
@@ -72,10 +72,25 @@ EOF
 
   # Serialize an object in XOXO format.
   #
+  # Note that Hash's with a 'url' key are converted to `<a>` tags instead
+  # of `<dl>` tags. If you need to work around this you can convert the key
+  # to a Symbol instead of a String. 
+  #
+  # TODO: Should it be the other way around, Symbol instead of String key?
+  # 
   # @return [String] an XOXO document
   def self.make_xoxo(struct, class_name=nil)
     s = ''
     case struct
+    when Assoc
+      unless struct.empty?
+        s << "<dl>"
+        struct.each do |(key, value)|
+          s << "<dt>" << key.to_s << "</dt><dd>" << make_xoxo(value) << "</dd>"
+        end
+        s << "</dl>"
+      end
+
     when Array
       if class_name
         s << %Q[<ol class="#{class_name}">]
@@ -88,26 +103,23 @@ EOF
       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)) << '" '
+      if struct.has_key? 'url'
+        d = struct.dup
+        u = d.delete('url')       
+        t = d.delete('text') { d.delete('title', u) }
+        s << '<a href="' << u.to_s << '" '
+        d.each do |tag, value|
+          s << tag.to_s << '="' << make_xoxo(d.delete(tag)) << '" '
+        end
+        s << '>' << make_xoxo(t) << '</a>'
+      else
+        unless struct.empty?
+          s << "<dl>"
+          struct.each do |key, value|
+            s << "<dt>" << key.to_s << "</dt><dd>" << make_xoxo(value) << "</dd>"
           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>"
+          s << "</dl>"
+        end
       end
 
     when String
@@ -117,24 +129,28 @@ EOF
       s << struct.to_s
 
     when Struct
-      h = {}
+      a = Assoc.new
       struct.each_pair do |k,v|
-        h[k] = v
+        a << [k,v]
       end
-      s = make_xoxo(h, class_name)
+      s = make_xoxo(a, class_name)
 
     else
-      h = {}
+      a = Assoc.new
       struct.instance_variables.each do |iv|
-        key = iv.sub(/^@/, '')
-        h[key] = struct.instance_variable_get(iv)
+        key = iv.to_s.sub(/^@/, '')
+        a << [key, struct.instance_variable_get(iv)]
       end
-      s = make_xoxo(h, class_name)
+      s = make_xoxo(a, class_name)
     end
 
     s
   end
 
+  # Used to distinguish arrays from assoc arrays.
+  class Assoc < Array
+  end
+
 end
 
 class XOXO::Parser

data/qed/applique/xoxo.rb

@@ -0,0 +1,7 @@
+require 'xoxo'
+
+When "serializes to" do |text|
+  text = text.gsub(/^\s+/, '').gsub(/\n/, '')
+  @_.assert == text 
+end
+

data/qed/to_xoxo.rdoc

@@ -0,0 +1,96 @@
+= to_xoxo
+
+Any object can be serialized as an XOXO document easily with the #to_xoxo
+method.
+
+== String
+
+  "This is an example".to_xoxo
+
+serializes to:
+
+  <ol class="xoxo">
+    <li>This is an example</li>
+  </ol>
+
+== Array
+
+  ["one", "two", "three"].to_xoxo
+
+serializes to:
+
+  <ol class="xoxo">
+    <li>one</li>
+    <li>two</li>
+    <li>three</li>
+  </ol>
+
+== Hash
+
+  {"one"=>1, "two"=>2, "three"=>3}.to_xoxo
+
+With some implementations of Ruby Hash order is not preserved. So,
+
+  @_.assert.include?('<ol class="xoxo">')
+  @_.assert.include?('<dt>one</dt><dd>1</dd>')
+  @_.assert.include?('<dt>two</dt><dd>2</dd>')
+  @_.assert.include?('<dt>three</dt><dd>3</dd>')
+
+It would otherwise look like this:
+
+  <ol class="xoxo">
+  <li>
+    <dl>
+    <dt>a</dt><dd>1</dd>
+    <dt>b</dt><dd>2</dd>
+    <dt>c</dt><dd>3</dd>
+    </dl>
+  </li>
+  </ol>
+
+== Struct
+
+  c = Struct.new(:a, :b, :c)
+  s = c.new(1,2,3)
+
+  s.to_xoxo
+
+With some implementations of Ruby Stuct order is not preserved. So,
+
+  @_.assert.include?('<ol class="xoxo">')
+  @_.assert.include?('<dt>a</dt><dd>1</dd>')
+  @_.assert.include?('<dt>b</dt><dd>2</dd>')
+  @_.assert.include?('<dt>c</dt><dd>3</dd>')
+
+It would otherwise look like this:
+
+  <ol class="xoxo">
+  <li>
+    <dl>
+    <dt>a</dt><dd>1</dd>
+    <dt>b</dt><dd>2</dd>
+    <dt>c</dt><dd>3</dd>
+    </dl>
+  </li>
+  </ol>
+
+== Object
+
+  class C
+    def initialize(a,b,c)
+      @a, @b, @c = a, b, c
+    end
+  end
+
+  c = C.new(1,2,3)
+
+  c.to_xoxo
+
+Instance attributes are not stored in order. So
+
+  @_.assert.include?('<ol class="xoxo">')
+  @_.assert.include?('<dt>a</dt><dd>1</dd>')
+  @_.assert.include?('<dt>b</dt><dd>2</dd>')
+  @_.assert.include?('<dt>c</dt><dd>3</dd>')
+
+

metadata

@@ -1,91 +1,85 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: xoxo
-version: !ruby/object:Gem::Version 
-  hash: 19
-  prerelease: false
-  segments: 
-  - 1
-  - 1
-  - 0
-  version: 1.1.0
+version: !ruby/object:Gem::Version
+  version: 1.2.0
+  prerelease: 
 platform: ruby
-authors: 
-- Christian Neukirchen <chneukirchen@gmail.com>
+authors:
+- Thomas Sawyer
+- Christian Neukirchen
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-05-05 00:00:00 -04:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: redline
+date: 2011-10-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: detroit
+  requirement: &10737640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: *10737640
+- !ruby/object:Gem::Dependency
+  name: qed
+  requirement: &10726380 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id001
-description: 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.
-email: transfire@gmail.com
+  prerelease: false
+  version_requirements: *10726380
+description: ! "XOXO is a Ruby XOXO parser and generator. It provides a Ruby API \nsimilar
+  to Marshal and YAML (though more specific) to load and dump\nXOXO[http://microformats.org/wiki/xoxo],
+  an simple, open outline\nformat written in standard XHTML and suitable for embedding
+  in\n(X)HTML, Atom, RSS, and arbitrary XML."
+email:
+- transfire@gmail.com
+- chneukirchen@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
+- HISTORY.rdoc
 - README.rdoc
-files: 
+- COPYING.rdoc
+files:
 - .ruby
+- .yardopts
 - lib/xoxo.rb
+- qed/applique/xoxo.rb
+- qed/to_xoxo.rdoc
 - test/test_xoxo.rb
 - HISTORY.rdoc
-- Profile
 - README.rdoc
-- Version
 - COPYING.rdoc
-- Redfile
-has_rdoc: true
 homepage: http://rubyworks.github.com/xoxo
-licenses: 
-- chneukirchen
+licenses:
+- MIT
 post_install_message: 
-rdoc_options: 
-- --title
-- XOXO API
-- --main
-- README.rdoc
-require_paths: 
+rdoc_options: []
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: xoxo
-rubygems_version: 1.3.7
+rubyforge_project: 
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: XOXO Parser and Generator
 test_files: []
-

data/Profile

@@ -1,30 +0,0 @@
---- 
-title     : XOXO
-summary   : XOXO Parser and Generator
-contact   : Thomas Sawyer <transfire@gmail.com>
-suite     : rubyworks
-created   : 2006-01-01
-license   : chneukirchen
-copyright : Copyright (c) 2006 Christian Neukirchen
-
-requires:
-  - redline (build)
-
-authors: 
-  - Christian Neukirchen <chneukirchen@gmail.com>
-
-description:
-  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.
-
-resources:
-  home: http://rubyworks.github.com/xoxo
-  code: http://github.com/rubyworks/xoxo
-
-repositories:
-  public: git://github.com/rubyworks/xoxo.git
-
-

data/Redfile

@@ -1,86 +0,0 @@
----
-email:
-  service : Email
-  file    : ~
-  subject : ~
-  mailto  : ruby-talk@ruby-lang.org
-  active  : true
-
-gem:
-  service: Gem
-  active : true
-
-testrb:
-  service  : testrb
-  tests    : ~
-  exclude  : ~
-  loadpath : ~
-  requires : ~
-  live     : false   
-  active   : false
-
-syntax:
-  service  : Syntax
-  loadpath : ~
-  exclude  : ~
-  active   : false
-
-rdoc:
-  service  : RDoc
-  format   : newfish
-  include  : [README.rdoc, HISTORY.rdoc, COPYING.rdoc, lib]
-  exclude  : ~
-  main     : ~
-  extra    : ~
-  output   : site/docs/api
-  active   : true
-
-ri:
-  service: RI
-  include: ~
-  exclude: ~
-  output : ri
-  active : true
-
-qedoc:
-  service: Custom
-  document: |
-    system "qedoc -t XOXO -o site/docs/qed qed/"
-
-dnote:
-  service  : DNote
-  loadpath : ~
-  labels   : ~
-  output   : ~
-  format   : ~
-  active   : false
-
-stats:
-  service  : Stats
-  title    : ~
-  loadpath : ~
-  exclude  : ~
-  output   : ~
-  active   : true
-
-#vclog:
-#  service  : VClog
-#  format   : html   # xml, txt
-#  layout   : rel    # gnu
-#  typed    : false
-#  output   : ~
-#  active   : false
-
-#rubyforge:
-#  service : Forge
-#  unixname: <%= collection %>
-#  groupid : ~
-#  package : <%= name %>
-#  sitemap:
-#    doc/rdoc: <%= name %>
-#  active  : false
-
-grancher:
-  service: Grancher
-  active: true
-

data/Version

@@ -1 +0,0 @@
-1.1.0