smacks-apricoteatsgorilla 0.1.2 → 0.2.0

data/README.rdoc

@@ -1,14 +1,15 @@
 = Apricot eats Gorilla
 
-Apricot eats Gorilla converts SOAP response messages to Ruby hashes.
-It's based on CobraVsMongoose but uses Hpricot instead of REXML and it
-also doesn't follow the BadgerFish convention.
+Apricot eats Gorilla translates between XML documents and Ruby hashes.
+It's based on CobraVsMongoose but uses Hpricot instead of REXML to parse
+XML and it also doesn't follow the BadgerFish convention.
+
+It's initial purpose was to convert SOAP response messages to Ruby hashes,
+but it quickly evolved into a more general translation tool.
 
 == Install
 
-  $ sudo gem sources -a http://gems.github.com
-  $ sudo gem install smacks-apricoteatsgorilla
-  $ sudo gem install hpricot
+  $ sudo gem install smacks-apricoteatsgorilla --source http://gems.github.com
 
 == Dependencies
 
@@ -16,7 +17,7 @@ also doesn't follow the BadgerFish convention.
 
 == An example
 
-Let's assume you receive the following SOAP response message:
+Let's assume you receive the following SOAP response:
 
   <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
     <soap:Body>
@@ -37,9 +38,9 @@ Let's assume you receive the following SOAP response message:
 
 Just pass in the raw XML string like this:
 
-  require 'rubygems'
-  require 'apricoteatsgorilla'
-  hash = ApricotEatsGorilla.soap_response_to_hash(xml)
+  require "rubygems"
+  require "apricoteatsgorilla
+  hash = ApricotEatsGorilla.xml_to_hash(xml, "//return")
 
 And it gets converted into a nice little hash:
 
@@ -54,12 +55,13 @@ And it gets converted into a nice little hash:
 
 == The conclusion
 
-* It assumes a root node named "return", but you can pass in an XPath
-  expession as the second parameter, to define a different root node.
-* All attributes are ignored and won't be included in the hash.
+* The xml_to_hash method starts parsing the XML at the root node by default.
+  By calling the method with an XPath expression as second parameter, we define
+  a custom root node.
+* Node attributes are ignored and won't be included in the hash.
 * The value of empty element nodes will be nil.
-* Values of "true" or "false" will be converted to boolean objects.
+* Node values of "true" or "false" will be converted to boolean objects.
 
 == For more information
 
-Take a look at the tests to see some more examples.
+Take a look at the tests for some more examples.

data/lib/apricoteatsgorilla.rb

@@ -2,23 +2,42 @@
 require 'rubygems'
 require 'hpricot'
 
-# Apricot eats Gorilla converts SOAP response messages to Ruby hashes.
-# It's based on CobraVsMongoose but uses Hpricot instead of REXML and it
-# also doesn't follow the BadgerFish convention.
+# Apricot eats Gorilla translates between XML documents and Ruby hashes.
+# It's based on CobraVsMongoose but uses Hpricot instead of REXML to parse
+# XML and it also doesn't follow the BadgerFish convention.
+# 
+# It's initial purpose was to convert SOAP response messages to Ruby hashes,
+# but it quickly evolved into a more general translation tool.
 class ApricotEatsGorilla
 
-  # Converts a given SOAP response message into a Ruby Hash.
-  def self.soap_response_to_hash(xml, root_node = nil)
-    xml = prepare_xml(xml)
-    root_node ||= "//return"
+  # Converts XML into a Ruby Hash. Starts parsing at root node by default.
+  # Call with XPath expession (Hpricot search) as second parameter to define
+  # a custom root node. The root node itself is not included in the Hash.
+  # 
+  # E.g.
+  #  xml = "<dude><likes>beer</likes><hates>appletini</hates></dude>"
+  #  ApricotEatsGorilla.xml_to_hash(xml)
+  #  # => { "hates" => "appletini", "likes" => "beer" }
+  def self.xml_to_hash(xml, root_node = nil)
+    xml = clean_xml(xml)
     doc = Hpricot.XML(xml)
-    xml_node_to_hash doc.at(root_node)
+    root = root_node ? doc.at(root_node) : doc.root
+    xml_node_to_hash(root)
+  end
+
+  # Converts a Ruby Hash to XML.
+  # 
+  # E.g.
+  #  hash = { "dude" => { "likes" => "beer", "hates" => "appletini" } }
+  #  ApricotEatsGorilla.hash_to_xml(hash)
+  #  # => "<dude><hates>appletini</hates><likes>beer</likes></dude>"
+  def self.hash_to_xml(hash)
+    nested_data_to_xml(hash.keys.first, hash.values.first)
   end
 
 private
 
-  # Converts XML nodes into a Ruby Hash. Recursively calls itself to grab
-  # nested XML nodes and values.
+  # Converts XML nodes into a Ruby Hash.
   def self.xml_node_to_hash(node)
     this_node = {}
 
@@ -45,8 +64,43 @@ private
     this_node
   end
 
+  # Converts a Ruby Hash to XML.
+  def self.nested_data_to_xml(name, item)
+    children = {}
+    case item
+    when String
+      make_tag(name) { item }
+    when Array
+      item.map { |subitem| nested_data_to_xml(name, subitem) }.join
+    when Hash
+      make_tag(name) do
+        item.map { |tag, value|
+          case value
+          when String
+            make_tag(tag) { value }
+          when Array
+            value.map { |subitem| nested_data_to_xml(tag, subitem) }.join
+          when Hash
+            nested_data_to_xml(tag, value)
+          end
+        }.join
+      end
+    end
+  end
+
+  # Helper to create an XML tag. Expects a block for tag content.
+  # Defaults to an empty element tag in case no block was supplied.
+  def self.make_tag(name)
+    body = yield
+    if body && !body.empty?
+      "<#{name}>" << body << "</#{name}>"
+    else
+      "<#{name} />"
+    end
+  end
+  
   # Helper to remove line breaks and whitespace between XML nodes.
-  def self.prepare_xml(xml)
+  def self.clean_xml(xml)
     xml = xml.gsub(/\n+/, "")
     xml = xml.gsub(/(>)\s*(<)/, '\1\2')
   end

data/tests/hash_to_xml_test.rb

@@ -0,0 +1,39 @@
+# -*- coding: utf-8 -*-
+require 'test/unit'
+require File.join(File.dirname(__FILE__), "..", "lib", "apricoteatsgorilla")
+
+class HashToXmlTest < Test::Unit::TestCase
+
+  def test_dead_simple
+    hash = { "dude" => "likes beer" }
+    expected = "<dude>likes beer</dude>"
+
+    result = ApricotEatsGorilla.hash_to_xml(hash)
+    assert_equal expected, result
+  end
+
+  def test_nested_hash
+    hash = { "dude" => { "likes" => "beer", "hates" => "appletini" } }
+    expected = "<dude><hates>appletini</hates><likes>beer</likes></dude>"
+
+    result = ApricotEatsGorilla.hash_to_xml(hash)
+    assert_equal expected, result
+  end
+
+  def test_nested_hash_with_array
+    hash = { "dude" => { "likes" => [ "beer", "helicopters" ] } }
+    expected = "<dude><likes>beer</likes><likes>helicopters</likes></dude>"
+
+    result = ApricotEatsGorilla.hash_to_xml(hash)
+    assert_equal expected, result
+  end
+
+  def test_nested_hash_with_array_containing_a_hash
+    hash = { "dude" => { "likes" => [ { "beer" => "a lot" }, { "helicopters" => "a little more" } ] } }
+    expected = "<dude><likes><beer>a lot</beer></likes><likes><helicopters>a little more</helicopters></likes></dude>"
+
+    result = ApricotEatsGorilla.hash_to_xml(hash)
+    assert_equal expected, result
+  end
+
+end

data/tests/{apricoteatsgorilla_test.rb → xml_to_hash_test.rb}

@@ -1,9 +1,8 @@
 # -*- coding: utf-8 -*-
-require 'rubygems'
 require 'test/unit'
 require File.join(File.dirname(__FILE__), "..", "lib", "apricoteatsgorilla")
 
-class ApricotEatsGorillaTest < Test::Unit::TestCase
+class XmlToHashTest < Test::Unit::TestCase
 
   def test_soap_response_example
     xml = '<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
@@ -18,49 +17,49 @@ class ApricotEatsGorillaTest < Test::Unit::TestCase
         </ns2:authenticateResponse>
       </soap:Body>
     </soap:Envelope>'
-    expected = {'authValue' => {'token' => 'secret', 'client' => 'example'}}
+    expected = { 'authValue' => { 'token' => 'secret', 'client' => 'example' } }
 
-    result = ApricotEatsGorilla.soap_response_to_hash(xml)
+    result = ApricotEatsGorilla.xml_to_hash(xml, '//return')
     assert_equal expected, result
   end
 
   def test_that_boolean_string_values_are_converted_to_actual_boolean_objects
     xml = '<root><yes>true</yes><no>false</no><txt>something</txt></root>'
-    expected = {'yes' => true, 'no' => false, 'txt' => 'something'}
+    expected = { 'yes' => true, 'no' => false, 'txt' => 'something' }
 
-    result = ApricotEatsGorilla.soap_response_to_hash(xml, '//root')
+    result = ApricotEatsGorilla.xml_to_hash(xml)
     assert_equal expected, result
   end
 
   def test_that_empty_element_tags_are_converted_to_nil
     xml = '<contact><name>Jungle Julia</name><email /><phone/></contact>'
-    expected = {'name' => 'Jungle Julia', 'email' => nil, 'phone' => nil}
+    expected = { 'name' => 'Jungle Julia', 'email' => nil, 'phone' => nil }
 
-    result = ApricotEatsGorilla.soap_response_to_hash(xml, '//contact')
+    result = ApricotEatsGorilla.xml_to_hash(xml)
     assert_equal expected, result
   end
 
   def test_that_attributes_get_removed
     xml = '<todo><paint subject="chair" color="#000000">black</paint></todo>'
-    expected = {'paint' => 'black'}
+    expected = { 'paint' => 'black' }
 
-    result = ApricotEatsGorilla.soap_response_to_hash(xml, '//todo')
+    result = ApricotEatsGorilla.xml_to_hash(xml)
     assert_equal expected, result
   end
 
   def test_that_node_groups_with_text_values_get_converted_to_arrays
     xml = '<root><items>first</items><items>second</items></root>'
-    expected = {'items' => ['first', 'second']}
+    expected = { 'items' => [ 'first', 'second' ] }
 
-    result = ApricotEatsGorilla.soap_response_to_hash(xml, '//root')
+    result = ApricotEatsGorilla.xml_to_hash(xml)
     assert_equal expected, result
   end
 
   def test_that_node_groups_with_nesting_get_converted_to_arrays_with_hashes
     xml = '<root><items><name>first</name></items><items><name>second</name></items></root>'
-    expected = {'items' => [{'name' => 'first'}, {'name' => 'second'}]}
+    expected = { 'items' => [ { 'name' => 'first' }, { 'name' => 'second' } ] }
 
-    result = ApricotEatsGorilla.soap_response_to_hash(xml, '//root')
+    result = ApricotEatsGorilla.xml_to_hash(xml)
     assert_equal expected, result
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: smacks-apricoteatsgorilla
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors: 
 - Daniel Harrington
@@ -22,7 +22,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 0.6.164
     version: 
-description: Apricot eats Gorilla converts SOAP response messages to Ruby hashes
+description: Apricot eats Gorilla translates between XML documents and Ruby hashes.
 email: 
 executables: []
 
@@ -59,6 +59,7 @@ rubyforge_project:
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
-summary: Apricot eats Gorilla converts SOAP response messages to Ruby hashes
+summary: Apricot eats Gorilla translates between XML documents and Ruby hashes.
 test_files: 
-- tests/apricoteatsgorilla_test.rb
+- tests/hash_to_xml_test.rb
+- tests/xml_to_hash_test.rb