smacks-apricoteatsgorilla 0.2.2 → 0.2.3

data/README.rdoc

@@ -19,7 +19,7 @@ but it quickly evolved into a more general translation tool.
 
 Let's assume you receive the following SOAP response:
 
-  <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
+xml = '<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
     <soap:Body>
       <ns2:findCustomerByIdResponse xmlns:ns2="http://v1_0.ws.example.com/">
         <return>
@@ -34,7 +34,7 @@ Let's assume you receive the following SOAP response:
         </return>
       </ns2:findCustomerByIdResponse>
     </soap:Body>
-  </soap:Envelope>
+  </soap:Envelope>'
 
 Just pass in the raw XML string:
 
@@ -42,6 +42,10 @@ Just pass in the raw XML string:
   require "apricoteatsgorilla
   hash = ApricotEatsGorilla.xml_to_hash(xml, "//return")
 
+Or use the shortcut:
+
+  hash = ApricotEatsGorilla(xml, "//return")
+
 And it gets converted into a nice little Hash:
 
   "empty" => false,
@@ -56,8 +60,8 @@ And it gets converted into a nice little Hash:
 == The conclusion
 
 * 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.
+  By calling the method with an XPath expression as second parameter, we're
+  able to 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.
 * Node values of "true" or "false" will be converted to boolean objects.

data/lib/apricoteatsgorilla.rb

@@ -2,15 +2,15 @@
 require 'rubygems'
 require 'hpricot'
 
-# Apricot eats Gorilla translates between XML documents and Ruby hashes.
+# Apricot eats Gorilla translates between XML documents and Hashes.
 # It's based on CobraVsMongoose but uses Hpricot instead of REXML to parse
 # XML and it also doesn't follow the BadgerFish convention.
 # 
-# Its initial purpose was to convert SOAP response messages to Ruby hashes,
+# Its initial purpose was to convert SOAP response messages to Hashes,
 # but it quickly evolved into a more general translation tool.
 class ApricotEatsGorilla
 
-  # Converts XML into a Ruby Hash. Starts parsing at root node by default.
+  # Converts XML into a 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 will not be included in the Hash.
   # 
@@ -25,7 +25,7 @@ class ApricotEatsGorilla
     xml_node_to_hash(root)
   end
 
-  # Converts a Ruby Hash to XML.
+  # Converts a Hash to XML.
   # 
   # E.g.
   #  hash = { "dude" => { "likes" => "beer", "hates" => "appletini" } }
@@ -37,7 +37,7 @@ class ApricotEatsGorilla
 
 private
 
-  # Converts XML nodes into a Ruby Hash.
+  # Converts XML into a Hash.
   def self.xml_node_to_hash(node)
     this_node = {}
 
@@ -64,9 +64,8 @@ private
     this_node
   end
 
-  # Converts a Ruby Hash to XML.
+  # Converts a Hash to XML.
   def self.nested_data_to_xml(name, item)
-    children = {}
     case item
     when String
       make_tag(name) { item }
@@ -114,3 +113,18 @@ private
   end
 
 end
+
+# Shortcut method for translating between XML documents and Hashes.
+# Calls xml_to_hash in case the first parameter is of type String.
+# Calls hash_to_xml in case the first parameter is of type Hash.
+# Returns nil otherwise.
+def ApricotEatsGorilla(source, root_node = nil)
+  case source
+  when String
+    ApricotEatsGorilla.xml_to_hash(source, root_node)
+  when Hash
+    ApricotEatsGorilla.hash_to_xml(source)
+  else
+    nil
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: smacks-apricoteatsgorilla
 version: !ruby/object:Gem::Version 
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors: 
 - Daniel Harrington