addressable 2.2.2 → 2.2.3

data/CHANGELOG

@@ -1,3 +1,6 @@
+=== Addressable 2.2.3
+- added :flat_array notation for query strings
+
 === Addressable 2.2.2
 - fixed issue with percent escaping of '+' character in query strings
 

data/lib/addressable/uri.rb

@@ -1379,7 +1379,7 @@ module Addressable
     #   <code>:subscript</code>. The <code>:dot</code> notation is not
     #   supported for assignment. Default value is <code>:subscript</code>.
     #
-    # @return [Hash] The query string parsed as a Hash object.
+    # @return [Hash, Array] The query string parsed as a Hash or Array object.
     #
     # @example
     #   Addressable::URI.parse("?one=1&two=2&three=3").query_values
@@ -1402,12 +1402,16 @@ module Addressable
     #     "?one[two][three][]=four&one[two][three][]=five"
     #   ).query_values
     #   #=> {"one" => {"two" => {"three" => ["four", "five"]}}}
+    #   Addressable::URI.parse(
+    #     "?one=two&one=three").query_values(:notation => :flat_array)
+    #   #=> [['one', 'two'], ['one', 'three']]
     def query_values(options={})
       defaults = {:notation => :subscript}
       options = defaults.merge(options)
-      if ![:flat, :dot, :subscript].include?(options[:notation])
+      if ![:flat, :dot, :subscript, :flat_array].include?(options[:notation])
         raise ArgumentError,
-          "Invalid notation. Must be one of: [:flat, :dot, :subscript]."
+          "Invalid notation. Must be one of: " +
+          "[:flat, :dot, :subscript, :flat_array]."
       end
       dehash = lambda do |hash|
         hash.each do |(key, value)|
@@ -1424,9 +1428,10 @@ module Addressable
         end
       end
       return nil if self.query == nil
+      empty_accumulator = :flat_array == options[:notation] ? [] : {}
       return ((self.query.split("&").map do |pair|
         pair.split("=", -1) if pair && pair != ""
-      end).compact.inject({}) do |accumulator, (key, value)|
+      end).compact.inject(empty_accumulator.dup) do |accumulator, (key, value)|
         value = true if value.nil?
         key = self.class.unencode_component(key)
         if value != true
@@ -1437,6 +1442,8 @@ module Addressable
             raise ArgumentError, "Key was repeated: #{key.inspect}"
           end
           accumulator[key] = value
+        elsif options[:notation] == :flat_array
+          accumulator << [key, value]
         else
           if options[:notation] == :dot
             array_value = false
@@ -1459,8 +1466,12 @@ module Addressable
           end
         end
         accumulator
-      end).inject({}) do |accumulator, (key, value)|
-        accumulator[key] = value.kind_of?(Hash) ? dehash.call(value) : value
+      end).inject(empty_accumulator.dup) do |accumulator, (key, value)|
+        if options[:notation] == :flat_array
+          accumulator << [key, value]
+        else
+          accumulator[key] = value.kind_of?(Hash) ? dehash.call(value) : value
+        end
         accumulator
       end
     end
@@ -1470,7 +1481,7 @@ module Addressable
     # This method produces a query string using the :subscript notation.
     # An empty Hash will result in a nil query.
     #
-    # @param [Hash, #to_hash] new_query_values The new query values.
+    # @param [Hash, #to_hash, Array] new_query_values The new query values.
     def query_values=(new_query_values)
       # Check for frozenness
       raise TypeError, "Can't modify frozen URI." if self.frozen?
@@ -1478,15 +1489,22 @@ module Addressable
         self.query = nil
         return nil
       end
-      if !new_query_values.respond_to?(:to_hash)
-        raise TypeError, "Can't convert #{new_query_values.class} into Hash."
-      end
-      new_query_values = new_query_values.to_hash
-      new_query_values = new_query_values.map do |key, value|
-        key = key.to_s if key.kind_of?(Symbol)
-        [key, value]
+
+      if !new_query_values.is_a?(Array)
+        if !new_query_values.respond_to?(:to_hash)
+          raise TypeError,
+            "Can't convert #{new_query_values.class} into Hash."
+        end
+        new_query_values = new_query_values.to_hash
+        new_query_values = new_query_values.map do |key, value|
+          key = key.to_s if key.kind_of?(Symbol)
+          [key, value]
+        end
+        # Useful default for OAuth and caching.
+        # Only to be used for non-Array inputs. Arrays should preserve order.
+        new_query_values.sort!
       end
-      new_query_values.sort! # Useful default for OAuth and caching
+      # new_query_values have form [['key1', 'value1'], ['key2', 'value2']]
 
       # Algorithm shamelessly stolen from Julien Genestoux, slightly modified
       buffer = ""

data/lib/addressable/version.rb

@@ -28,7 +28,7 @@ if !defined?(Addressable::VERSION)
     module VERSION #:nodoc:
       MAJOR = 2
       MINOR = 2
-      TINY  = 2
+      TINY  = 3
 
       STRING = [MAJOR, MINOR, TINY].join('.')
     end

data/spec/addressable/uri_spec.rb

@@ -3056,6 +3056,12 @@ describe Addressable::URI, "when parsed from '?one=1&two=2&three=3'" do
       @uri.query_values(:notation => :bogus)
     end).should raise_error(ArgumentError)
   end
+
+  it "should have the correct flat array notation query values" do
+    @uri.query_values(:notation => :flat_array).should == [
+      ["one", "1"], ["two", "2"], ["three", "3"]
+    ]
+  end
 end
 
 describe Addressable::URI, "when parsed from '?one[two][three]=four'" do
@@ -3072,6 +3078,12 @@ describe Addressable::URI, "when parsed from '?one[two][three]=four'" do
       "one[two][three]" => "four"
     }
   end
+
+  it "should have the correct flat array notation query values" do
+    @uri.query_values(:notation => :flat_array).should == [
+      ["one[two][three]", "four"]
+    ]
+  end
 end
 
 describe Addressable::URI, "when parsed from '?one.two.three=four'" do
@@ -3090,6 +3102,12 @@ describe Addressable::URI, "when parsed from '?one.two.three=four'" do
       "one.two.three" => "four"
     }
   end
+
+  it "should have the correct flat array notation query values" do
+    @uri.query_values(:notation => :flat_array).should == [
+      ["one.two.three", "four"]
+    ]
+  end
 end
 
 describe Addressable::URI, "when parsed from " +
@@ -3110,6 +3128,12 @@ describe Addressable::URI, "when parsed from " +
       "one[two][five]" => "six"
     }
   end
+
+  it "should have the correct flat array notation query values" do
+    @uri.query_values(:notation => :flat_array).should == [
+      ["one[two][three]", "four"], ["one[two][five]", "six"]
+    ]
+  end
 end
 
 describe Addressable::URI, "when parsed from " +
@@ -3130,6 +3154,26 @@ describe Addressable::URI, "when parsed from " +
       "one.two.five" => "six"
     }
   end
+
+  it "should have the correct flat array notation query values" do
+    @uri.query_values(:notation => :flat_array).should == [
+      ["one.two.three", "four"], ["one.two.five", "six"]
+    ]
+  end
+end
+
+describe Addressable::URI, "when parsed from " +
+    "'?one=two&one=three'" do
+  before do
+    @uri = Addressable::URI.parse(
+      "?one=two&one=three"
+    )
+  end
+
+  it "should have correct flat_array notation query values" do
+    @uri.query_values(:notation => :flat_array).should == 
+      [['one', 'two'], ['one', 'three']] 
+  end
 end
 
 describe Addressable::URI, "when parsed from " +
@@ -3151,6 +3195,13 @@ describe Addressable::URI, "when parsed from " +
       @uri.query_values(:notation => :flat)
     end).should raise_error(ArgumentError)
   end
+
+  it "should not raise an error if a key is " +
+      "repeated in the flat array notation" do
+    (lambda do
+      @uri.query_values(:notation => :flat_array)
+    end).should_not raise_error
+  end
 end
 
 describe Addressable::URI, "when parsed from " +
@@ -3168,6 +3219,36 @@ describe Addressable::URI, "when parsed from " +
   end
 end
 
+describe Addressable::URI, "when parsed from " +
+    "'?one[two][three][1]=four&one[two][three][0]=five'" do
+  before do
+    @uri = Addressable::URI.parse(
+      "?one[two][three][1]=four&one[two][three][0]=five"
+    )
+  end
+
+  it "should have the correct subscript notation query values" do
+    @uri.query_values(:notation => :subscript).should == {
+      "one" => {"two" => {"three" => ["five", "four"]}}
+    }
+  end
+end
+
+describe Addressable::URI, "when parsed from " +
+    "'?one[two][three][2]=four&one[two][three][1]=five'" do
+  before do
+    @uri = Addressable::URI.parse(
+      "?one[two][three][2]=four&one[two][three][1]=five"
+    )
+  end
+
+  it "should have the correct subscript notation query values" do
+    @uri.query_values(:notation => :subscript).should == {
+      "one" => {"two" => {"three" => ["five", "four"]}}
+    }
+  end
+end
+
 describe Addressable::URI, "when parsed from " +
     "'http://www.詹姆斯.com/'" do
   before do
@@ -4183,6 +4264,21 @@ describe Addressable::URI, "when assigning query values" do
     @uri.query_values = {'ab' => 'c', :ab => 'a', :a => 'x'}
     @uri.query.should == "a=x&ab=a&ab=c"
   end
+
+  it "should correctly assign " +
+      "[['b', 'c'], ['b', 'a'], ['a', 'a']]" do
+    # Order can be guaranteed in this format, so preserve it.
+    @uri.query_values = [['b', 'c'], ['b', 'a'], ['a', 'a']]
+    @uri.query.should == "b=c&b=a&a=a"
+  end
+
+  it "should preserve query string order" do
+    query_string = (('a'..'z').to_a.shuffle.map { |e| "#{e}=#{e}" }).join("&")
+    @uri.query = query_string
+    original_uri = @uri.to_s
+    @uri.query_values = @uri.query_values(:notation => :flat_array)
+    @uri.to_s.should == original_uri
+  end
 end
 
 describe Addressable::URI, "when assigning path values" do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: addressable
 version: !ruby/object:Gem::Version 
-  hash: 3
-  prerelease: false
+  hash: 1
+  prerelease: 
   segments: 
   - 2
   - 2
-  - 2
-  version: 2.2.2
+  - 3
+  version: 2.2.3
 platform: ruby
 authors: 
 - Bob Aman
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-12 00:00:00 -07:00
+date: 2011-01-20 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -146,7 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: addressable
-rubygems_version: 1.3.7
+rubygems_version: 1.4.1
 signing_key: 
 specification_version: 3
 summary: URI Implementation