multi_xml 0.1.1 → 0.1.2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    multi_xml (0.1.1)
+    multi_xml (0.1.2)
 
 GEM
   remote: http://rubygems.org/

data/lib/multi_xml.rb

@@ -161,22 +161,12 @@ module MultiXml
       end
     end
 
-    def wrap(object)
-      if object.nil?
-        []
-      elsif object.respond_to?(:to_ary)
-        object.to_ary
-      else
-        [object]
-      end
-    end
-
     def typecast_xml_value(value)
       case value
       when Hash
         if value['type'] == 'array'
-          _, entries = wrap(value.detect{|key, value| key != 'type'})
-          if entries.blank? || (c = value[CONTENT_ROOT] && c.blank?)
+          _, entries = Array.wrap(value.detect{|key, value| key != 'type'})
+          if entries.blank? || (value.is_a?(Hash) && c = value[CONTENT_ROOT] && c.blank?)
             []
           else
             case entries

data/lib/multi_xml/core_extensions.rb

@@ -57,3 +57,52 @@ class String #:nodoc:
     strip.empty?
   end
 end
+
+class Array
+  # Wraps its argument in an array unless it is already an array (or array-like).
+  #
+  # Specifically:
+  #
+  # * If the argument is +nil+ an empty list is returned.
+  # * Otherwise, if the argument responds to +to_ary+ it is invoked, and its result returned.
+  # * Otherwise, returns an array with the argument as its single element.
+  #
+  #   Array.wrap(nil)       # => []
+  #   Array.wrap([1, 2, 3]) # => [1, 2, 3]
+  #   Array.wrap(0)         # => [0]
+  #
+  # This method is similar in purpose to <tt>Kernel#Array</tt>, but there are some differences:
+  #
+  # * If the argument responds to +to_ary+ the method is invoked. <tt>Kernel#Array</tt>
+  # moves on to try +to_a+ if the returned value is +nil+, but <tt>Arraw.wrap</tt> returns
+  # such a +nil+ right away.
+  # * If the returned value from +to_ary+ is neither +nil+ nor an +Array+ object, <tt>Kernel#Array</tt>
+  # raises an exception, while <tt>Array.wrap</tt> does not, it just returns the value.
+  # * It does not call +to_a+ on the argument, though special-cases +nil+ to return an empty array.
+  #
+  # The last point is particularly worth comparing for some enumerables:
+  #
+  #   Array(:foo => :bar)      # => [[:foo, :bar]]
+  #   Array.wrap(:foo => :bar) # => [{:foo => :bar}]
+  #
+  #   Array("foo\nbar")        # => ["foo\n", "bar"], in Ruby 1.8
+  #   Array.wrap("foo\nbar")   # => ["foo\nbar"]
+  #
+  # There's also a related idiom that uses the splat operator:
+  #
+  #   [*object]
+  #
+  # which returns <tt>[nil]</tt> for +nil+, and calls to <tt>Array(object)</tt> otherwise.
+  #
+  # Thus, in this case the behavior is different for +nil+, and the differences with
+  # <tt>Kernel#Array</tt> explained above apply to the rest of +object+s.
+  def self.wrap(object)
+    if object.nil?
+      []
+    elsif object.respond_to?(:to_ary)
+      object.to_ary
+    else
+      [object]
+    end
+  end
+end

data/lib/multi_xml/version.rb

@@ -1,3 +1,3 @@
 module MultiXml
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/spec/multi_xml_spec.rb

@@ -55,7 +55,7 @@ describe "MultiXml" do
           end
         end
 
-        context "a single-node document" do
+        context "an XML document" do
 
           before do
             @xml = '<user/>'
@@ -70,8 +70,8 @@ describe "MultiXml" do
               @xml = '<user><![CDATA[Erik Michaels-Ober]]></user>'
             end
 
-            it "should parse correctly" do
-              MultiXml.parse(@xml).should == {"user" => "Erik Michaels-Ober"}
+            it "should return the correct CDATA" do
+              MultiXml.parse(@xml)['user'].should == "Erik Michaels-Ober"
             end
           end
 
@@ -80,8 +80,8 @@ describe "MultiXml" do
               @xml = '<user>Erik Michaels-Ober</user>'
             end
 
-            it "should parse correctly" do
-              MultiXml.parse(@xml).should == {"user" => "Erik Michaels-Ober"}
+            it "should return the correct content" do
+              MultiXml.parse(@xml)['user'].should == "Erik Michaels-Ober"
             end
           end
 
@@ -90,8 +90,8 @@ describe "MultiXml" do
               @xml = '<user name="Erik Michaels-Ober"/>'
             end
 
-            it "should parse correctly" do
-              MultiXml.parse(@xml).should == {"user" => {"name" => "Erik Michaels-Ober"}}
+            it "should return the correct attribute" do
+              MultiXml.parse(@xml)['user']['name'].should == "Erik Michaels-Ober"
             end
           end
 
@@ -100,14 +100,15 @@ describe "MultiXml" do
               @xml = '<user name="Erik Michaels-Ober" screen_name="sferik"/>'
             end
 
-            it "should parse correctly" do
-              MultiXml.parse(@xml).should == {"user" => {"name" => "Erik Michaels-Ober", "screen_name" => "sferik"}}
+            it "should return the correct attributes" do
+              MultiXml.parse(@xml)['user']['name'].should == "Erik Michaels-Ober"
+              MultiXml.parse(@xml)['user']['screen_name'].should == "sferik"
             end
           end
 
           context "with :symbolize_keys => true" do
             before do
-              @xml = '<user name="Erik Michaels-Ober"/>'
+              @xml = '<user><name>Erik Michaels-Ober</name></user>'
             end
 
             it "should symbolize keys" do
@@ -118,7 +119,7 @@ describe "MultiXml" do
           context "with an attribute type=\"boolean\"" do
             %w(true false).each do |boolean|
               context "when #{boolean}" do
-                it "should be #{boolean}" do
+                it "should return #{boolean}" do
                   xml = "<tag type=\"boolean\">#{boolean}</tag>"
                   MultiXml.parse(xml)['tag'].should instance_eval("be_#{boolean}")
                 end
@@ -130,7 +131,7 @@ describe "MultiXml" do
                 @xml = '<tag type="boolean">1</tag>'
               end
 
-              it "should be true" do
+              it "should return true" do
                 MultiXml.parse(@xml)['tag'].should be_true
               end
             end
@@ -140,7 +141,7 @@ describe "MultiXml" do
                 @xml = '<tag type="boolean">0</tag>'
               end
 
-              it "should be false" do
+              it "should return false" do
                 MultiXml.parse(@xml)['tag'].should be_false
               end
             end
@@ -152,11 +153,15 @@ describe "MultiXml" do
                 @xml = '<tag type="integer">1</tag>'
               end
 
-              it "should be a Fixnum" do
+              it "should return a Fixnum" do
                 MultiXml.parse(@xml)['tag'].should be_a(Fixnum)
               end
 
-              it "should be the correct number" do
+              it "should return a positive number" do
+                MultiXml.parse(@xml)['tag'].should > 0
+              end
+
+              it "should return the correct number" do
                 MultiXml.parse(@xml)['tag'].should == 1
               end
             end
@@ -166,11 +171,15 @@ describe "MultiXml" do
                 @xml = '<tag type="integer">-1</tag>'
               end
 
-              it "should be a Fixnum" do
+              it "should return a Fixnum" do
                 MultiXml.parse(@xml)['tag'].should be_a(Fixnum)
               end
 
-              it "should be the correct number" do
+              it "should return a negative number" do
+                MultiXml.parse(@xml)['tag'].should < 0
+              end
+
+              it "should return the correct number" do
                 MultiXml.parse(@xml)['tag'].should == -1
               end
             end
@@ -181,11 +190,11 @@ describe "MultiXml" do
               @xml = '<tag type="string"></tag>'
             end
 
-            it "should be a String" do
+            it "should return a String" do
               MultiXml.parse(@xml)['tag'].should be_a(String)
             end
 
-            it "should be the correct string" do
+            it "should return the correct string" do
               MultiXml.parse(@xml)['tag'].should == ""
             end
           end
@@ -195,11 +204,11 @@ describe "MultiXml" do
               @xml = '<tag type="date">1970-01-01</tag>'
             end
 
-            it "should be a Date" do
+            it "should return a Date" do
               MultiXml.parse(@xml)['tag'].should be_a(Date)
             end
 
-            it "should be the correct date" do
+            it "should return the correct date" do
               MultiXml.parse(@xml)['tag'].should == Date.parse('1970-01-01')
             end
           end
@@ -209,11 +218,11 @@ describe "MultiXml" do
               @xml = '<tag type="datetime">1970-01-01 00:00</tag>'
             end
 
-            it "should be a Time" do
+            it "should return a Time" do
               MultiXml.parse(@xml)['tag'].should be_a(Time)
             end
 
-            it "should be the correct time" do
+            it "should return the correct time" do
               MultiXml.parse(@xml)['tag'].should == Time.parse('1970-01-01 00:00')
             end
           end
@@ -223,11 +232,11 @@ describe "MultiXml" do
               @xml = '<tag type="datetime">1970-01-01 00:00</tag>'
             end
 
-            it "should be a Time" do
+            it "should return a Time" do
               MultiXml.parse(@xml)['tag'].should be_a(Time)
             end
 
-            it "should be the correct time" do
+            it "should return the correct time" do
               MultiXml.parse(@xml)['tag'].should == Time.parse('1970-01-01 00:00')
             end
           end
@@ -237,11 +246,11 @@ describe "MultiXml" do
               @xml = '<tag type="double">3.14159265358979</tag>'
             end
 
-            it "should be a Float" do
+            it "should return a Float" do
               MultiXml.parse(@xml)['tag'].should be_a(Float)
             end
 
-            it "should be the correct number" do
+            it "should return the correct number" do
               MultiXml.parse(@xml)['tag'].should == 3.14159265358979
             end
           end
@@ -251,11 +260,11 @@ describe "MultiXml" do
               @xml = '<tag type="decimal">3.14159265358979323846264338327950288419716939937510</tag>'
             end
 
-            it "should be a BigDecimal" do
+            it "should return a BigDecimal" do
               MultiXml.parse(@xml)['tag'].should be_a(BigDecimal)
             end
 
-            it "should be the correct number" do
+            it "should return the correct number" do
               MultiXml.parse(@xml)['tag'].should == 3.14159265358979323846264338327950288419716939937510
             end
           end
@@ -265,22 +274,26 @@ describe "MultiXml" do
               @xml = '<tag type="base64Binary">aW1hZ2UucG5n</tag>'
             end
 
-            it "should be a String" do
+            it "should return a String" do
               MultiXml.parse(@xml)['tag'].should be_a(String)
             end
 
-            it "should be the correct string" do
+            it "should return the correct string" do
               MultiXml.parse(@xml)['tag'].should == "image.png"
             end
           end
 
           context "with an attribute type=\"yaml\"" do
             before do
-              @xml = "<tag type=\"yaml\">--- \n1: should be an integer\n:message: Have a nice day\narray: \n- should-have-dashes: true\n  should_have_underscores: true\n</tag>"
+              @xml = "<tag type=\"yaml\">--- \n1: should return an integer\n:message: Have a nice day\narray: \n- should-have-dashes: true\n  should_have_underscores: true\n</tag>"
             end
 
-            it "should parse correctly" do
-              MultiXml.parse(@xml)['tag'].should == {:message => "Have a nice day", 1 => "should be an integer", "array" => [{"should-have-dashes" => true, "should_have_underscores" => true}]}
+            it "should return a Hash" do
+              MultiXml.parse(@xml)['tag'].should be_a(Hash)
+            end
+
+            it "should return the correctly parsed YAML" do
+              MultiXml.parse(@xml)['tag'].should == {:message => "Have a nice day", 1 => "should return an integer", "array" => [{"should-have-dashes" => true, "should_have_underscores" => true}]}
             end
           end
 
@@ -289,7 +302,7 @@ describe "MultiXml" do
               @xml = '<tag type="file" name="data.txt" content_type="text/plain">ZGF0YQ==</tag>'
             end
 
-            it "should be a StringIO" do
+            it "should return a StringIO" do
               MultiXml.parse(@xml)['tag'].should be_a(StringIO)
             end
 
@@ -310,7 +323,7 @@ describe "MultiXml" do
                 @xml = '<tag type="file">ZGF0YQ==</tag>'
               end
 
-              it "should be a StringIO" do
+              it "should return a StringIO" do
                 MultiXml.parse(@xml)['tag'].should be_a(StringIO)
               end
 
@@ -328,13 +341,27 @@ describe "MultiXml" do
             end
           end
 
-          %w(integer boolean date datetime yaml).each do |type|
+          context "with an attribute type=\"array\"" do
+            before do
+              @xml = '<users type="array"><user>Erik Michaels-Ober</user><user>Wynn Netherland</user></users>'
+            end
+
+            it "should return an Array" do
+              MultiXml.parse(@xml)['users'].should be_a(Array)
+            end
+
+            it "should return the correct array" do
+              MultiXml.parse(@xml)['users'].should == ["Erik Michaels-Ober", "Wynn Netherland"]
+            end
+          end
+
+          %w(integer boolean date datetime yaml file).each do |type|
             context "with an empty attribute type=\"#{type}\"" do
               before do
                 @xml = "<tag type=\"#{type}\"/>"
               end
 
-              it "should be nil" do
+              it "should return nil" do
                 MultiXml.parse(@xml)['tag'].should be_nil
               end
             end
@@ -342,20 +369,20 @@ describe "MultiXml" do
 
           context "with an empty attribute type=\"array\"" do
             before do
-              @xml = '<users type="array"/>'
+              @xml = '<tag type="array"/>'
             end
 
-            it "should be an empty Array" do
-              MultiXml.parse(@xml)['users'].should == []
+            it "should return an empty Array" do
+              MultiXml.parse(@xml)['tag'].should == []
             end
 
             context "with whitespace" do
               before do
-                @xml = '<users type="array"> </users>'
+                @xml = '<tag type="array"> </tag>'
               end
 
-              it "should be an empty Array" do
-                MultiXml.parse(@xml)['users'].should == []
+              it "should return an empty Array" do
+                MultiXml.parse(@xml)['tag'].should == []
               end
             end
           end
@@ -372,7 +399,7 @@ describe "MultiXml" do
             end
 
             context "in content" do
-              it "should unescape XML entities" do
+              it "should return unescaped XML entities" do
                 @xml_entities.each do |key, value|
                   xml = "<tag>#{value}</tag>"
                   MultiXml.parse(xml)['tag'].should == key
@@ -381,7 +408,7 @@ describe "MultiXml" do
             end
 
             context "in attribute" do
-              it "should unescape XML entities" do
+              it "should return unescaped XML entities" do
                 @xml_entities.each do |key, value|
                   xml = "<tag attribute=\"#{value}\"/>"
                   MultiXml.parse(xml)['tag']['attribute'].should == key
@@ -395,7 +422,7 @@ describe "MultiXml" do
               @xml = '<tag-1/>'
             end
 
-            it "should undasherize tag" do
+            it "should return undasherize tag" do
               MultiXml.parse(@xml).keys.should include('tag_1')
             end
           end
@@ -405,30 +432,20 @@ describe "MultiXml" do
               @xml = '<tag attribute-1="1"></tag>'
             end
 
-            it "should undasherize attribute" do
+            it "should return undasherize attribute" do
               MultiXml.parse(@xml)['tag'].keys.should include('attribute_1')
             end
           end
-        end
-
-        context "a document" do
-          context "with :symbolize_keys => true" do
-            before do
-              @xml = '<user><name>Erik Michaels-Ober</name></user>'
-            end
-
-            it "should symbolize keys" do
-              MultiXml.parse(@xml, :symbolize_keys => true).should == {:user => {:name => "Erik Michaels-Ober"}}
-            end
-          end
 
           context "with children" do
-            before do
-              @xml = '<root><user name="Erik Michaels-Ober"/></root>'
-            end
+            context "with attributes" do
+              before do
+                @xml = '<users><user name="Erik Michaels-Ober"/></users>'
+              end
 
-            it "should parse correctly" do
-              MultiXml.parse(@xml).should == {"root" => {"user" => {"name"=>"Erik Michaels-Ober"}}}
+              it "should return the correct attributes" do
+                MultiXml.parse(@xml)['users']['user']['name'].should == "Erik Michaels-Ober"
+              end
             end
 
             context "with text" do
@@ -436,8 +453,8 @@ describe "MultiXml" do
                 @xml = '<user><name>Erik Michaels-Ober</name></user>'
               end
 
-              it "should parse correctly" do
-                MultiXml.parse(@xml).should == {"user" => {"name" => "Erik Michaels-Ober"}}
+              it "should return the correct text" do
+                MultiXml.parse(@xml)['user']['name'].should == "Erik Michaels-Ober"
               end
             end
 
@@ -461,35 +478,34 @@ describe "MultiXml" do
               end
 
               it "should parse correctly" do
-                MultiXml.parse(@xml).should == {"user"=>{"name"=>"Erik Michaels-Ober"}}
+                MultiXml.parse(@xml).should == {"user" => {"name" => "Erik Michaels-Ober"}}
               end
             end
 
             # Babies having babies
             context "with children" do
               before do
-                @xml = '<root><user name="Erik Michaels-Ober"><status text="Hello"/></user></root>'
+                @xml = '<users><user name="Erik Michaels-Ober"><status text="Hello"/></user></users>'
               end
 
               it "should parse correctly" do
-                MultiXml.parse(@xml).should == {"root" => {"user" => {"name" => "Erik Michaels-Ober", "status" => {"text" => "Hello"}}}}
+                MultiXml.parse(@xml).should == {"users" => {"user" => {"name" => "Erik Michaels-Ober", "status" => {"text" => "Hello"}}}}
               end
             end
           end
 
           context "with sibling children" do
             before do
-              @xml = '<root><users>Erik Michaels-Ober</users><users>Wynn Netherland</users></root>'
+              @xml = '<users><user>Erik Michaels-Ober</user><user>Wynn Netherland</user></users>'
             end
 
-            it "should parse correctly" do
-              MultiXml.parse(@xml).should == {"root" => {"users" => ["Erik Michaels-Ober", "Wynn Netherland"]}}
+            it "should return an Array" do
+              MultiXml.parse(@xml)['users']['user'].should be_a(Array)
             end
 
-            it "should be Array" do
-              MultiXml.parse(@xml)['root']['users'].should be_a(Array)
+            it "should parse correctly" do
+              MultiXml.parse(@xml).should == {"users" => {"user" => ["Erik Michaels-Ober", "Wynn Netherland"]}}
             end
-
           end
         end
       end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: multi_xml
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 31
   prerelease: false
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Erik Michaels-Ober