cobravsmongoose 0.0.1 → 0.0.2

data/CHANGES

@@ -1,2 +1,6 @@
+== 0.0.2 (2006-06-28)
+* Added direct XML <-> JSON conversion
+* Can accept REXML::Document or anything that responds to to_s for XML
+
 == 0.0.1 (2006-04-16)
 * Initial release.

data/lib/cobravsmongoose.rb

@@ -4,6 +4,7 @@ require 'cgi'
 #
 # CobraVsMongoose translates between XML documents and Ruby hashes according to the 
 # rules of the BadgerFish convention (see http://badgerfish.ning.com/).
+# It can also convert directly between XML and JSON using the JSON library.
 #
 class CobraVsMongoose
 
@@ -13,7 +14,9 @@ class CobraVsMongoose
   class << self
 
     #
-    # Returns a Hash corresponding to the data structure of the given XML string.
+    # Returns a Hash corresponding to the data structure of the given XML,
+    # which should be a REXML::Document or anything that responds to to_s
+    # with a string of valid XML.
     #
     # E.g.
     #  xml = '<alice><bob>charlie</bob><bob>david</bob></alice>'
@@ -21,7 +24,11 @@ class CobraVsMongoose
     #  # => { "alice" => { "bob" => [{ "$" => "charlie" }, { "$" => "david" }] } }
     #
     def xml_to_hash(xml)
-      doc = REXML::Document.new(xml)
+      if xml.respond_to?(:root_node)
+        doc = xml
+      else
+        doc = REXML::Document.new(xml.to_s)
+      end     
       return xml_node_to_hash(doc.root_node)
     end
   
@@ -41,6 +48,23 @@ class CobraVsMongoose
       return nested_data_to_xml(hash.keys.first, hash.values.first)
     end
     
+    #
+    # Returns a JSON string corresponding to the given XML, the constraints
+    # for which are as for xml_to_hash.
+    #
+    def xml_to_json(xml)
+      require 'json'
+      return xml_to_hash(xml).to_json
+    end
+    
+    #
+    # Returns an XML string corresponding to the given JSON string.
+    #
+    def json_to_xml(json)
+      require 'json'
+      return hash_to_xml(JSON.parse(json))
+    end
+    
     #
     # The sort_keys class attribute is useful for testing, when a predictable order 
     # is required in the generated XML. By setting CobraVsMongoose.sort_keys to true,

data/test/hash_to_xml_test.rb

@@ -3,8 +3,8 @@ require 'cobravsmongoose'
 require 'test/unit'
 begin
   require 'test/unit/xml' 
-rescue 
-  puts 'You need to install Test::Unit::XML (http://testunitxml.rubyforge.org/) for this test.'
+rescue LoadError
+  $stderr.puts 'You need to install Test::Unit::XML (http://testunitxml.rubyforge.org/) for this test.'
 end
 require File.dirname(__FILE__) + '/test_data'
 

data/test/json_test.rb

@@ -0,0 +1,29 @@
+$: << File.dirname(__FILE__) + '/../lib/'
+require 'cobravsmongoose'
+require 'test/unit'
+begin
+  require 'json' 
+rescue LoadError
+  $stderr.puts 'You need to install the JSON library for Ruby (http://json.rubyforge.org/)'
+  $stderr.puts 'to use and test the XML<->JSON features of Cobra vs Mongoose.'
+end
+
+class HashToXMLTest < Test::Unit::TestCase
+  
+  def test_xml_to_json
+    xml = '<alice><bob>charlie</bob><bob>david</bob></alice>'
+    assert_equal(
+      '{"alice":{"bob":[{"$":"charlie"},{"$":"david"}]}}',
+      CobraVsMongoose.xml_to_json(xml)
+    )
+  end
+  
+  def test_json_to_xml    
+    json = '{"alice":{"$":"bob","@charlie":"david"}}'
+    assert_equal(
+      "<alice charlie='david'>bob</alice>",
+      CobraVsMongoose.json_to_xml(json)
+    )
+  end
+  
+end

data/test/xml_to_hash_test.rb

@@ -16,6 +16,12 @@ class XMLToHashTest < Test::Unit::TestCase
     assert !COBRA_VS_MONGOOSE_TEST_DATA.empty?
     assert methods.grep(/^test_/).length > COBRA_VS_MONGOOSE_TEST_DATA.keys.length
   end
+  
+  def test_should_accept_a_rexml_document_source
+    expected, source = COBRA_VS_MONGOOSE_TEST_DATA[:nested_elements]
+    rexml_doc = REXML::Document.new(source)
+    assert_equal(expected, CobraVsMongoose.xml_to_hash(rexml_doc))
+  end
     
   def assert_xml_to_hash(name)
     expected, source = COBRA_VS_MONGOOSE_TEST_DATA[name]

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: cobravsmongoose
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
-date: 2006-04-16 00:00:00 +01:00
+  version: 0.0.2
+date: 2006-06-28 00:00:00 +01:00
 summary: Translates XML to and from Ruby Hash objects, following the BadgerFish convention.
 require_paths: 
 - lib
@@ -31,6 +31,7 @@ files:
 - lib/cobravsmongoose.rb
 - test/all.rb
 - test/hash_to_xml_test.rb
+- test/json_test.rb
 - test/test_data.rb
 - test/xml_to_hash_test.rb
 - README