smacks-apricoteatsgorilla 0.3.61 → 0.3.91

data/lib/apricoteatsgorilla.rb

@@ -47,6 +47,21 @@ class ApricotEatsGorilla
     # Flag to enable optional sorting of Hash keys.
     attr_accessor :sort_keys
 
+    # Flag to disable conversion of tag names to lowerCamelCase.
+    attr_accessor :disable_tag_names_to_lower_camel_case
+
+    # Flag to disable conversion of Hash keys to snake_case.
+    attr_accessor :disable_hash_keys_to_snake_case
+
+    # Flag to disable conversion of Hash keys to Symbols.
+    attr_accessor :disable_hash_keys_to_symbol
+
+    # Array of XML nodes to add a namespace to.
+    attr_accessor :nodes_to_namespace
+
+    # The namespace for nodes in :nodes_to_namespace.
+    attr_accessor :node_namespace
+
     # Shortcut method for translating between XML Strings and Ruby Hashes.
     # Delegates to xml_to_hash in case +source+ is of type String or delegates
     # to hash_to_xml in case +source+ is of type Hash. Returns nil otherwise.
@@ -66,6 +81,12 @@ class ApricotEatsGorilla
       end
     end
 
+    # Yields this class object in case a +block+ was given. Nice way for setting
+    # multiple options at once.
+    def setup
+      yield self if block_given?
+    end
+    
     # Converts a given +xml+ String into a Ruby Hash. Starts parsing at root
     # node by default. The optional +root_node+ parameter can be used to specify
     # a custom root node to start parsing at via XPath (Hpricot search).
@@ -151,6 +172,18 @@ class ApricotEatsGorilla
       end
     end
 
+    # Converts a given +string+ from CamelCase/lowerCamelCase to snake_case.
+    def to_snake_case(string)
+      string = string.gsub(/[A-Z]+/, '\1_\0').downcase
+      string = string[1, string.length-1] if string[0, 1] == "_"
+      string
+    end
+
+    # Converts a given +string+ from snake_case to lowerCamelCase.
+    def to_lower_camel_case(string)
+      string.to_s.gsub(/_(.)/) { $1.upcase }
+    end
+
   private
 
     # Actual implementation for xml_to_hash. Takes and iterates through a given
@@ -171,7 +204,9 @@ class ApricotEatsGorilla
           key, value = child.name, xml_node_to_hash(child)
         end
 
-        key = to_snake_case(remove_namespace(key)).intern
+        key = remove_namespace(key)
+        key = to_snake_case(key) unless disable_hash_keys_to_snake_case
+        key = key.intern unless disable_hash_keys_to_symbol
         current = this_node[key]
         case current
           when Array
@@ -194,16 +229,16 @@ class ApricotEatsGorilla
     # * +item+ - A Hash value to translate into an XML String.
     def nested_data_to_xml(name, item)
       case item
-      when String
-        tag(name) { item }
+      when String, Symbol
+        tag(name) { item.to_s }
       when Array
         item.map { |subitem| nested_data_to_xml(name, subitem) }.join
       when Hash
         tag(name) do
           opt_order(item).map { |tag, value|
             case value
-            when String
-              tag(tag) { value }
+            when String, Symbol
+              tag(tag) { value.to_s }
             when Array
               value.map { |subitem| nested_data_to_xml(tag, subitem) }.join
             when Hash
@@ -222,6 +257,10 @@ class ApricotEatsGorilla
     # * +name+ - The name of the XML tag.
     # * +attributes+ - Optional. Hash of attributes for the XML tag.
     def tag(name, attributes = {})
+      name = to_lower_camel_case(name) unless disable_tag_names_to_lower_camel_case
+      if nodes_to_namespace.kind_of? Array
+        name = "#{node_namespace}:#{name}" if node_namespace && nodes_to_namespace.include?(name)
+      end
       return "<#{name} />" unless block_given?
 
       attr = opt_order(attributes).map { |k, v| %Q( xmlns:#{k}="#{v}") }.to_s
@@ -231,20 +270,15 @@ class ApricotEatsGorilla
 
     # Removes line breaks and whitespace between tags from a given +xml+ String.
     def clean_xml(xml)
-      xml = xml.gsub(/\n+/, "")
-      xml.gsub(/(>)\s*(<)/, '\1\2')
+      xml.gsub!(/\n+/, "")
+      xml.gsub!(/(>)\s*(<)/, '\1\2')
+      xml
     end
 
     # Removes the namespace from a given XML +tag+.
     def remove_namespace(tag)
-      tag.sub(/.+:(.+)/, '\1')
-    end
-
-    # Converts a given +string+ from CamelCase/lowerCamelCase to snake_case.
-    def to_snake_case(string)
-      string = string.gsub(/[A-Z]+/, '\1_\0').downcase
-      string = string[1, string.length-1] if string[0, 1] == "_"
-      string
+      tag.sub!(/.+:(.+)/, '\1')
+      tag
     end
 
     # Checks to see if a given +string+ matches "true" or "false" and converts

data/test/apricoteatsgorilla/hash_to_xml_test.rb

@@ -3,10 +3,17 @@ require File.join(File.dirname(__FILE__), "..", "helper")
 class HashToXmlTest < Test::Unit::TestCase
 
   context "Calling hash_to_xml" do
-    setup { ApricotEatsGorilla.sort_keys = true }
+    setup do
+      ApricotEatsGorilla.setup do |s|
+        s.sort_keys = true
+        s.disable_tag_names_to_lower_camel_case = false
+        s.disable_hash_keys_to_snake_case = false
+        s.disable_hash_keys_to_symbol = false
+      end
+    end
 
     context "with a Hash consisting of a single key-value-pair" do
-      should "returns an XML String containing one node and a value" do
+      should "return an XML String containing one node and a value" do
         hash = { "apricot" => "eats gorilla" }
         expected = "<apricot>eats gorilla</apricot>"
 
@@ -16,7 +23,7 @@ class HashToXmlTest < Test::Unit::TestCase
     end
 
     context "with a Hash containing another Hash" do
-      should "returns an XML String representing the given structure" do
+      should "return an XML String representing the given structure" do
         hash = { "apricot" => { "eats" => "gorilla", "drinks" => "beer" } }
         expected = "<apricot><drinks>beer</drinks><eats>gorilla</eats></apricot>"
 
@@ -26,7 +33,7 @@ class HashToXmlTest < Test::Unit::TestCase
     end
 
     context "with a Hash containing a Hash containing an Array" do
-      should "returns an XML String representing the given structure" do
+      should "return an XML String representing the given structure" do
         hash = { "apricot" => { "eats" => [ "gorilla", "snake" ] } }
         expected = "<apricot><eats>gorilla</eats><eats>snake</eats></apricot>"
 
@@ -36,7 +43,7 @@ class HashToXmlTest < Test::Unit::TestCase
     end
 
     context "with a Hash containing a Hash containing an Array containing a Hash" do
-      should "returns an XML String representing the given structure" do
+      should "return an XML String representing the given structure" do
         hash = { "apricot" =>
           { "eats" => [ { "lotsOf" => "gorillas" }, { "justSome" => "snakes" } ]
         } }
@@ -47,6 +54,38 @@ class HashToXmlTest < Test::Unit::TestCase
         assert_equal expected, result
       end
     end
+
+    context "with a Hash containing Symbols" do
+      should "returns an XML String with Symbols converted into Strings" do
+        hash = { :apricot => { :eats => [ :gorilla, "snake" ] } }
+        expected = "<apricot><eats>gorilla</eats><eats>snake</eats></apricot>"
+
+        result = ApricotEatsGorilla.hash_to_xml(hash)
+        assert_equal expected, result
+      end
+    end
+
+    context "with a Hash containing snake_case keys" do
+      should "convert snake_case Hash keys to lowerCamelCase" do
+        hash = { :apricot => { :eats => { :lots_of => "gorillas" } } }
+        expected = "<apricot><eats><lotsOf>gorillas</lotsOf></eats></apricot>"
+
+        result = ApricotEatsGorilla.hash_to_xml(hash)
+        assert_equal expected, result
+      end
+
+      context "and converting snake_case tag names to lowerCamelCase turned off" do
+        setup { ApricotEatsGorilla.disable_tag_names_to_lower_camel_case = true }
+
+        should "not convert snake_case tag names to lowerCamelCase" do
+          hash = { :apricot => { :eats => { :lots_of => "gorillas" } } }
+          expected = "<apricot><eats><lots_of>gorillas</lots_of></eats></apricot>"
+
+          result = ApricotEatsGorilla.hash_to_xml(hash)
+          assert_equal expected, result
+        end
+      end
+    end
   end
 
 end

data/test/apricoteatsgorilla/shortcut_method_test.rb

@@ -3,7 +3,14 @@ require File.join(File.dirname(__FILE__), "..", "helper")
 class ShortcutMethodTest < Test::Unit::TestCase
 
   context "Calling []" do
-    setup { ApricotEatsGorilla.sort_keys = true }
+    setup do
+      ApricotEatsGorilla.setup do |s|
+        s.sort_keys = true
+        s.disable_tag_names_to_lower_camel_case = false
+        s.disable_hash_keys_to_snake_case = false
+        s.disable_hash_keys_to_symbol = false
+      end
+    end
 
     context "with an XML String" do
       should "return a Hash containing the XML content" do

data/test/apricoteatsgorilla/xml_to_hash_test.rb

@@ -3,7 +3,14 @@ require File.join(File.dirname(__FILE__), "..", "helper")
 class XmlToHashTest < Test::Unit::TestCase
 
   context "Calling xml_to_hash" do
-    setup { ApricotEatsGorilla.sort_keys = true }
+    setup do
+      ApricotEatsGorilla.setup do |s|
+        s.sort_keys = true
+        s.disable_tag_names_to_lower_camel_case = false
+        s.disable_hash_keys_to_snake_case = false
+        s.disable_hash_keys_to_symbol = false
+      end
+    end
 
     context "with a SOAP response example and a custom root node" do
       should "return a Hash containing the XML content" do
@@ -56,14 +63,48 @@ class XmlToHashTest < Test::Unit::TestCase
       end
     end
 
-    context "with XML containing nodes with the same name" do
-      should "group these nodes into an Array" do
-        xml = "<root><items>first</items><items>second</items></root>"
-        expected = { :items => [ "first", "second" ] }
+    context "with XML containing lowerCamelCase nodes" do
+      should "convert lowerCamelCase nodes to snake_case" do
+        xml = "<contact><firstName>Jungle</firstName><lastName>Julia</lastName></contact>"
+        expected = { :first_name => "Jungle", :last_name => "Julia" }
+
+        result = ApricotEatsGorilla.xml_to_hash(xml)
+        assert_equal expected, result
+      end
+
+      context "and converting lowerCamelCase Hash keys to snake_case turned off" do
+        setup { ApricotEatsGorilla.disable_hash_keys_to_snake_case = true }
+
+        should "not convert lowerCamelCase Hash keys to snake_case" do
+          xml = "<contact><firstName>Jungle</firstName><lastName>Julia</lastName></contact>"
+          expected = { :firstName => "Jungle", :lastName => "Julia" }
+
+          result = ApricotEatsGorilla.xml_to_hash(xml)
+          assert_equal expected, result
+        end
+      end
+    end
+
+    context "with some XML" do
+      should "convert Hash keys to Symbols" do
+        xml = "<contact><name>Jungle Julia</name><address/></contact>"
+        expected = { :name => "Jungle Julia", :address => nil }
 
         result = ApricotEatsGorilla.xml_to_hash(xml)
         assert_equal expected, result
       end
+
+      context "and converting Hash keys to Symbols turned off" do
+        setup { ApricotEatsGorilla.disable_hash_keys_to_symbol = true }
+
+        should "not convert Hash keys to Symbols" do
+          xml = "<contact><name>Jungle Julia</name><address/></contact>"
+          expected = { "name" => "Jungle Julia", "address" => nil }
+
+          result = ApricotEatsGorilla.xml_to_hash(xml)
+          assert_equal expected, result
+        end
+      end
     end
   end
 

metadata

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