xoxo 1.2.0 → 1.2.1

data/.ruby

@@ -38,11 +38,11 @@ revision: 0
 created: '2006-01-01'
 summary: XOXO Parser and Generator
 title: XOXO
-version: 1.2.0
+version: 1.2.1
 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
+  a 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/HISTORY.rdoc

@@ -1,5 +1,14 @@
 = RELEASE HISTORY
 
+== 1.2.1 | 2011-10-27
+
+Add missing QED.rdoc file, so it will show up in YARD docs.
+
+Changes:
+
+* Add QED.rdoc to gem.
+
+
 == 1.2.0 | 2011-10-26
 
 Converting Hashes with 'url' for a key are treated completely as `a` tags.

data/QED.rdoc

@@ -0,0 +1,97 @@
+= 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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xoxo
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -14,7 +14,7 @@ date: 2011-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: detroit
-  requirement: &10737640 !ruby/object:Gem::Requirement
+  requirement: &22110100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *10737640
+  version_requirements: *22110100
 - !ruby/object:Gem::Dependency
   name: qed
-  requirement: &10726380 !ruby/object:Gem::Requirement
+  requirement: &22103800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *10726380
+  version_requirements: *22103800
 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
+  a 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
@@ -46,6 +46,7 @@ extensions: []
 extra_rdoc_files:
 - HISTORY.rdoc
 - README.rdoc
+- QED.rdoc
 - COPYING.rdoc
 files:
 - .ruby
@@ -56,6 +57,7 @@ files:
 - test/test_xoxo.rb
 - HISTORY.rdoc
 - README.rdoc
+- QED.rdoc
 - COPYING.rdoc
 homepage: http://rubyworks.github.com/xoxo
 licenses: