xoxo 1.0.1 → 1.1.0

data/.ruby

@@ -0,0 +1,36 @@
+--- 
+spec_version: 1.0.0
+replaces: []
+
+loadpath: 
+- lib
+name: xoxo
+repositories: 
+  public: git://github.com/rubyworks/xoxo.git
+conflicts: []
+
+engine_check: []
+
+title: XOXO
+contact: Thomas Sawyer <transfire@gmail.com>
+resources: 
+  code: http://github.com/rubyworks/xoxo
+  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.
+summary: XOXO Parser and Generator
+created: 2006-01-01

data/{COPYING → COPYING.rdoc}

@@ -1,3 +1,7 @@
+= COPYRIGHT NOTICES
+
+== xoxo.rb
+
 Copyright (c) 2007, 2008 Christian Neukirchen <purl.org/net/chneukirchen>
  
 Permission is hereby granted, free of charge, to any person obtaining a copy

data/HISTORY.rdoc

@@ -0,0 +1,30 @@
+= RELEASE HISTORY
+
+
+== 1.1.0 | 2011-05-05
+
+This release improves how the library handles Struct objects and
+general Object instances. The previous release applied #to_s to these
+objects, which usually led to the turning a inspection string into
+an XOXO document, which is certainly not the desired effect. This 
+release extracts the member attributes into a hash and converts this
+hash to XOXO.
+
+Changes:
+
+* Convert Struct and general Object instances properly.
+* Add QED documentation.
+
+
+== 1.0.0 | 2009-07-06
+
+This is essentially the XOXO library written Christian Neukirchen.
+While the library has been distributed as part of Facets for some
+time, there is no separate gem avaialbe for it. So this then is
+that stand-alone release. It differs from the original only in
+that it provides #to_xoxo.
+
+Changes:
+
+* Happy Birthday!
+

data/Profile

@@ -0,0 +1,30 @@
+--- 
+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/{README → README.rdoc}

@@ -1,11 +1,6 @@
 = XOXO
 
-* http://rubyworks.github.com/xoxo
-* http://github.com/rubyworks/xoxo
-* http://chneukirchen.org/repos/xoxo-rb/
-
-
-== DESCRIPTION:
+== DESCRIPTION
 
 XOXO is a Ruby XOXO parser and generator. It provides
 a Ruby API similar to Marshal and YAML (though more
@@ -14,29 +9,43 @@ an simple, open outline format written in standard XHTML and
 suitable for embedding in (X)HTML, Atom, RSS, and arbitrary XML.
 
 
-== FEATURES/ISSUES:
+== FEATURES
 
 * Uses REXML's pull parser.
 * Serialize any object via to_xoxo.
 
 
-== RELEASE NOTES:
+== 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].
+
+The offical XOXO format site is here[http://microformats.org/wiki/xoxo].
+
+
+== RELEASE NOTES
 
 Please see HISTORY file.
 
 
-== SYNOPSIS:
+== SYNOPSIS
 
 Simple way to generate XOXO.
 
   obj.to_xoxo
 
+For more details see the QED and API documentation.
+
 
-== INSTALLATION:
+== INSTALLATION
 
 To install with RubyGems simply open a console and type:
 
-  gem install xoxo
+  $ gem install xoxo
 
 Local installation requires Setup.rb (gem install setup),
 then download the tarball package and type:
@@ -48,11 +57,11 @@ then download the tarball package and type:
 Windows users use 'ruby setup.rb all'.
 
 
-== COPYING:
+== COPYING
 
 Copyright (C) 2006 Christian Neukirchen
 
 This program is ditributed unser the terms of the Ruby license.
 
-See LICENSE or COPYING file for details.
+See COPYING file for details.
 

data/Redfile

@@ -0,0 +1,86 @@
+---
+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

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

data/lib/xoxo.rb

@@ -2,8 +2,6 @@
 #
 # 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.
 #
@@ -23,10 +21,9 @@ require 'rexml/parsers/pullparser'
 #
 module XOXO
   # xoxo.rb version number
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 
   # 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
@@ -51,7 +48,7 @@ module XOXO
   #                                 wrapped XOXO document.
   #
   def self.dump(struct, options={})
-    struct = [struct]  unless struct.kind_of? Array
+    struct = [struct] unless struct.kind_of? Array
 
     if options[:html_wrap]
       result = <<EOF.strip
@@ -73,6 +70,9 @@ EOF
 
   private
 
+  # Serialize an object in XOXO format.
+  #
+  # @return [String] an XOXO document
   def self.make_xoxo(struct, class_name=nil)
     s = ''
     case struct
@@ -113,19 +113,39 @@ EOF
     when String
       s << struct
 
+    when Numeric
+      s << struct.to_s
+
+    when Struct
+      h = {}
+      struct.each_pair do |k,v|
+        h[k] = v
+      end
+      s = make_xoxo(h, class_name)
+
     else
-      s << struct.to_s          # too gentle?
+      h = {}
+      struct.instance_variables.each do |iv|
+        key = iv.sub(/^@/, '')
+        h[key] = struct.instance_variable_get(iv)
+      end
+      s = make_xoxo(h, class_name)
     end
 
     s
   end
+
 end
 
-class XOXO::Parser              # :nodoc:
+class XOXO::Parser
+
+  #
   CONTAINER_TAGS = %w{dl ol ul}
 
+  # @return [Array]
   attr_reader :structs
 
+  # Initialize new XOXO Parser.
   def initialize(xoxo)
     @parser = REXML::Parsers::PullParser.new(xoxo)
 
@@ -135,6 +155,11 @@ class XOXO::Parser              # :nodoc:
     @tags = []
   end
 
+  # Parse XOXO document.
+  #
+  # The end result of parsing is stored in the +structs+ attribute.
+  #
+  # @return [Parser] the current parser object
   def parse
     while @parser.has_next?
       res = @parser.pull
@@ -207,6 +232,10 @@ class XOXO::Parser              # :nodoc:
 
   private
 
+  # Take a hash of attributes and make sure the keys are all lowercase.
+  #
+  # @param [Hash] the attributes hash
+  # @return [Hash] the normalized attributes hash
   def normalize_attrs(attrs)
     attrs.keys.find_all { |k, v| k != k.downcase }.each { |k, v|
       v = v.downcase  if k == "rel" || k == "type"
@@ -216,6 +245,7 @@ class XOXO::Parser              # :nodoc:
     attrs
   end
 
+  #
   def push(struct)
     if struct == {} && @structs.last.kind_of?(Hash) &&
         @structs.last.has_key?('url') &&
@@ -233,7 +263,6 @@ end
 class Object
 
   # Dump object as XOXO.
-
   def to_xoxo(*args)
     XOXO.dump(self,*args)
   end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: xoxo
 version: !ruby/object:Gem::Version 
+  hash: 19
   prerelease: false
   segments: 
   - 1
-  - 0
   - 1
-  version: 1.0.1
+  - 0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Christian Neukirchen <chneukirchen@gmail.com>
@@ -14,72 +15,77 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-23 00:00:00 -05:00
+date: 2011-05-05 00:00:00 -04:00
 default_executable: 
-dependencies: []
-
-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: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: redline
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        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
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
-- README
+- README.rdoc
 files: 
+- .ruby
 - lib/xoxo.rb
-- meta/authors
-- meta/collection
-- meta/created
-- meta/description
-- meta/homepage
-- meta/name
-- meta/released
-- meta/repository
-- meta/summary
-- meta/title
-- meta/version
 - test/test_xoxo.rb
-- README
-- HISTORY
-- COPYING
+- HISTORY.rdoc
+- Profile
+- README.rdoc
+- Version
+- COPYING.rdoc
+- Redfile
 has_rdoc: true
 homepage: http://rubyworks.github.com/xoxo
-licenses: []
-
+licenses: 
+- chneukirchen
 post_install_message: 
 rdoc_options: 
 - --title
 - XOXO API
 - --main
-- README
+- README.rdoc
 require_paths: 
 - lib
 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 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: xoxo
-rubygems_version: 1.3.6.pre.3
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: XOXO Parser and Generator
-test_files: 
-- test/test_xoxo.rb
+test_files: []
+

data/HISTORY

@@ -1,14 +0,0 @@
-= HISTORY
-
-== 1.0.0 // 2009-07-06
-
-This is essentially the XOXO library written Christian Neukirchen.
-While the library has been distributed as part of Facets for some
-time, there is no separate gem avaialbe for it. So this then is
-that stand-alone release. It differs from the original only in
-that it provides #to_xoxo.
-
-* 1 Major Enhancement
-
-    * Happy Birthday!
-

data/meta/authors

@@ -1 +0,0 @@
-Christian Neukirchen <chneukirchen@gmail.com>

data/meta/collection

@@ -1 +0,0 @@
-rubyworks

data/meta/created

@@ -1 +0,0 @@
-2006-01-01

data/meta/description

@@ -1,5 +0,0 @@
-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.

data/meta/homepage

@@ -1 +0,0 @@
-http://rubyworks.github.com/xoxo

data/meta/name

@@ -1 +0,0 @@
-xoxo

data/meta/released

@@ -1 +0,0 @@
-2010-02-23

data/meta/repository

@@ -1 +0,0 @@
-git://github.com/rubyworks/xoxo.git

data/meta/summary

@@ -1 +0,0 @@
-XOXO Parser and Generator

data/meta/title

@@ -1 +0,0 @@
-XOXO

data/meta/version

@@ -1 +0,0 @@
-1.0.1