uri-query_params 0.5.1 → 0.5.2

data/.yardopts

@@ -1 +1 @@
---quiet --markup markdown --title 'URI query_params Documentation' --protected --files ChangeLog.md,LICENSE.txt
+--markup markdown --title 'URI query_params Documentation' --protected --files ChangeLog.md,LICENSE.txt

data/ChangeLog.md

@@ -1,3 +1,20 @@
+### 0.5.2 / 2010-11-11
+
+* Added {URI::QueryParams::UNSAFE}:
+  * Contains RFC 3986 unsafe URI characters.
+  * Use {URI::QueryParams::UNSAFE} in {URI::QueryParams.dump} for safer
+    query strings.
+* Added {URI::QueryParams::Mixin#query}:
+  * If any query-params are set, dump them out using
+    {URI::QueryParams.dump}.
+* Renamed `parse_query_params` to
+  {URI::QueryParams::Mixin#parse_query_params!}.
+
+### 0.5.1 / 2010-11-11
+
+* Added {URI::QueryParams::Mixin#initialize_copy} to properly copy the
+  `query_params` when calling `clone` or `dup` on a URI.
+
 ### 0.5.0 / 2010-11-07
 
 * Added {URI::QueryParams.dump}.

data/README.md

@@ -1,7 +1,7 @@
 # URI query_params
 
-* [github.com/postmodern/uri-query_params](http://github.com/postmodern/uri-query_params/)
-* [github.com/postmodern/uri-query_params/issues](http://github.com/postmodern/uri-query_params/issues/)
+* [Source](http://github.com/postmodern/uri-query_params/)
+* [Issues](http://github.com/postmodern/uri-query_params/issues/)
 * Postmodern (postmodern.mod3 at gmail.com)
 
 ## Description

data/lib/uri/query_params/mixin.rb

@@ -1,7 +1,5 @@
 require 'uri/query_params/query_params'
 
-require 'cgi'
-
 module URI
   module QueryParams
     #
@@ -28,6 +26,24 @@ module URI
         super(url)
       end
 
+      #
+      # The raw query-string.
+      #
+      # @return [String, nil]
+      #   The raw query-string.
+      #
+      # @see QueryParams.dump
+      #
+      # @since 0.5.2
+      #
+      def query
+        if @query_params
+          QueryParams.dump(@query_params)
+        else
+          super
+        end
+      end
+
       #
       # Sets the query string and updates query_params.
       #
@@ -41,9 +57,12 @@ module URI
       #   url.query = 'a=1&b=2'
       #   # => "a=1&b=2"
       #
-      def query=(query_str)
-        new_query = super(query_str)
-        parse_query_params
+      # @see QueryParams.parse
+      #
+      def query=(raw_query)
+        new_query = super(raw_query)
+
+        parse_query_params! if @query_params
         return new_query
       end
 
@@ -53,8 +72,10 @@ module URI
       # @return [Hash{String => String}]
       #   The query params of the URI.
       #
+      # @see QueryParams.parse
+      #
       def query_params
-        parse_query_params unless @query_params
+        parse_query_params! unless @query_params
         return @query_params
       end
 
@@ -85,14 +106,18 @@ module URI
       # Parses the query parameters from the query data, populating
       # query_params with the parsed parameters.
       #
-      def parse_query_params
+      # @see QueryParams.parse
+      #
+      # @since 0.5.2
+      #
+      def parse_query_params!
         @query_params = QueryParams.parse(@query)
       end
 
       private
 
       def path_query
-        unless (@query_params.nil? || @query_params.empty?)
+        if @query_params
           str = @path
 
           unless @query_params.empty?

data/lib/uri/query_params/query_params.rb

@@ -2,6 +2,12 @@ require 'uri'
 
 module URI
   module QueryParams
+    # RFC 3986 unsafe characters (including ' ')
+    UNSAFE = [
+      ' ', '!', '*', "'", '(', ')', ';', ':', '@', '&', '=', '+', '$', ',',
+      '/', '?', '%', '#', '[', ']'
+    ].join
+
     #
     # Parses a URI query string.
     #
@@ -11,6 +17,14 @@ module URI
     # @return [Hash{String => String}]
     #   The parsed query parameters.
     #
+    # @example
+    #   QueryParams.parse("x=1&y=2")
+    #   # => {"x"=>"1", "y"=>"2"}
+    #
+    # @example
+    #   QueryParams.parse("x=a%20b%20c&y")
+    #   # => {"x"=>"a b c", "y"=>""}
+    #
     def QueryParams.parse(query_string)
       query_params = {}
 
@@ -19,7 +33,7 @@ module URI
           name, value = param.split('=',2)
 
           if value
-            query_params[name] = URI.decode(value)
+            query_params[name] = URI.unescape(value)
           else
             query_params[name] = ''
           end
@@ -38,24 +52,36 @@ module URI
     # @return [String]
     #   The dumped URI query string.
     #
+    # @example Dumping Strings
+    #   QueryParams.dump('x' => '1', 'y' => '2')
+    #   # => "x=1&x=2"
+    #
+    # @example Dumping non-Strings
+    #   QueryParams.dump(:x => 1, :y => true, :z => false)
+    #   # => "x=1&x=active&z="
+    #
+    # @example Dumping Arrays
+    #   QueryParams.dump(:x => ['a','b','c'])
+    #   # => "x=a%20b%20c"
+    #
     # @since 0.5.0
     #
     def QueryParams.dump(query_params)
       query = []
 
       query_params.each do |name,value|
-        param = case value
+        value = case value
                 when Array
-                  "#{name}=#{CGI.escape(value.join(' '))}"
+                  URI.escape(value.join(' '),UNSAFE)
                 when true
-                  "#{name}=active"
+                  'active'
                 when false, nil
-                  "#{name}="
+                  ''
                 else
-                  "#{name}=#{CGI.escape(value.to_s)}"
+                  URI.escape(value.to_s,UNSAFE)
                 end
 
-        query << param
+        query << "#{name}=#{value}"
       end
 
       return query.join('&')

data/lib/uri/query_params/version.rb

@@ -1,6 +1,6 @@
 module URI
   module QueryParams
     # uri-query_params version
-    VERSION = '0.5.1'
+    VERSION = '0.5.2'
   end
 end

data/spec/query_params_mixin_examples.rb

@@ -4,23 +4,32 @@ require 'uri/query_params'
 require 'uri'
 
 shared_examples_for "URI::QueryParams::Mixin" do
+  let(:query) { 'x=1&y=one%20two&z' }
+
   subject { uri }
 
-  before(:each) do
-    uri.query = 'x=1&y=one%20two&z'
-  end
+  before(:each) { uri.query = query }
 
   it "should include QueryParams" do
     subject.class.should include(URI::QueryParams::Mixin)
   end
 
+  it "should still provide access to #query" do
+    uri.query.should == query
+  end
+
   it "should provide #query_params" do
     should respond_to(:query_params)
   end
 
   it "should update #query_params after #query is set" do
-    subject.query = 'u=3'
-    subject.query_params['u'].should == '3'
+    subject.query = 'u=2'
+    subject.query_params['u'].should == '2'
+  end
+
+  it "should dump out the #query_params when accessing #query" do
+    subject.query_params = {'u' => '3'}
+    subject.query.should == 'u=3'
   end
 
   it "should properly escape query param values" do

data/spec/query_params_spec.rb

@@ -62,7 +62,7 @@ describe URI::QueryParams do
     end
 
     it "should dump query params with Array values" do
-      subject.dump({'x' => [1,2]}).should == 'x=1+2'
+      subject.dump({'x' => [1,2]}).should == 'x=1%202'
     end
 
     it "should dump multiple query params" do

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 5
-  - 1
-  version: 0.5.1
+  - 2
+  version: 0.5.2
 platform: ruby
 authors: 
 - Postmodern