uri-query_params 0.4.0 → 0.5.0

data/.document

@@ -0,0 +1,4 @@
+lib/**/*.rb
+- 
+ChangeLog.*
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--colour --format documentation

data/ChangeLog.md

@@ -1,3 +1,10 @@
+### 0.5.0 / 2010-11-07
+
+* Added {URI::QueryParams.dump}.
+* Added `uri/query_params/extensions/https.rb`.
+* Fixed a bug in {URI::QueryParams.parse}, where query param values
+  containing `=` characters were not properly parsed.
+
 ### 0.4.0 / 2010-08-28
 
 * Initial release.

data/README.md

@@ -13,11 +13,12 @@ to `$_GET` from PHP, except available on any {URI::HTTP} object.
 
 Inspecting the URI query_params:
 
+    require 'uri/query_params'
+    
     url = URI('http://www.google.com/search?hl=en&client=firefox-a&rls=org.mozilla%3Aen-US%3Aofficial&hs=1HY&q=bob+ross&btnG=Search')
     url.query_params
     # => {"btnG"=>"Search", "hs"=>"1HY", "rls"=>"org.mozilla:en-US:official", "client"=>"firefox-a", "hl"=>"en", "q"=>"bob+ross"}
 
-
     url.query_params['q']
     # => "bob+ross"
 

data/Rakefile

@@ -2,45 +2,34 @@ require 'rubygems'
 require 'rake'
 
 begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = 'uri-query_params'
-    gem.license = 'MIT'
-    gem.summary = %Q{Access the query parameters of a URI, just like $_GET in PHP.}
-    gem.description = %Q{Allows access to the query component of the URI as a Hash.}
-    gem.email = 'postmodern.mod3@gmail.com'
-    gem.homepage = 'http://github.com/postmodern/uri-query_params'
-    gem.authors = ['Postmodern']
-    gem.add_development_dependency 'rspec', '>= 1.3.0'
-    gem.add_development_dependency 'yard', '>= 0.5.3'
-    gem.has_rdoc = 'yard'
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+  gem 'ore-tasks', '~> 0.2.0'
+  require 'ore/tasks'
+
+  Ore::Tasks.new
+rescue LoadError => e
+  STDERR.puts e.message
+  STDERR.puts "Run `gem install ore-tasks` to install 'ore/tasks'."
 end
 
 begin
-  require 'spec/rake/spectask'
-  Spec::Rake::SpecTask.new(:spec) do |spec|
-    spec.libs += ['lib', 'spec']
-    spec.spec_files = FileList['spec/**/*_spec.rb']
-    spec.spec_opts = ['--options', '.specopts']
-  end
+  gem 'rspec', '~> 2.0.0'
+  require 'rspec/core/rake_task'
 
-  task :spec => :check_dependencies
-  task :default => :spec
-rescue LoadError
+  RSpec::Core::RakeTask.new
+rescue LoadError => e
   task :spec do
-    abort "RSpec is not available. In order to run `rake spec`, you must: gem install rspec"
+    abort "Please run `gem install rspec` to install RSpec."
   end
 end
+task :default => :spec
 
 begin
+  gem 'yard', '~> 0.6.0'
   require 'yard'
-  YARD::Rake::YardocTask.new
-rescue LoadError
+
+  YARD::Rake::YardocTask.new  
+rescue LoadError => e
   task :yard do
-    abort "YARD is not available. In order to run yard, you must: gem install yard"
+    abort "Please run `gem install yard` to install YARD."
   end
 end

data/gemspec.yml

@@ -0,0 +1,13 @@
+name: uri-query_params
+summary: Access the query parameters of a URI, just like $_GET in PHP.
+description: Allows access to the query component of the URI as a Hash.
+license: MIT
+homepage: http://github.com/postmodern/uri-query_params
+authors: Postmodern
+email: postmodern.mod3@gmail.com
+has_yard: true
+
+development_dependencies:
+  ore-tasks: ~> 0.2.0
+  rspec: ~> 2.0.0
+  yard: ~> 0.6.0

data/lib/uri/query_params/extensions/https.rb

@@ -0,0 +1,3 @@
+require 'uri/query_params/extensions/http'
+
+require 'uri/https'

data/lib/uri/query_params/extensions.rb

@@ -1 +1,2 @@
 require 'uri/query_params/extensions/http'
+require 'uri/query_params/extensions/https'

data/lib/uri/query_params/mixin.rb

@@ -76,23 +76,11 @@ module URI
       private
 
       def path_query
-        if @query_params
+        unless (@query_params.nil? || @query_params.empty?)
           str = @path
 
           unless @query_params.empty?
-            str += '?' + @query_params.to_a.map { |name,value|
-              if value==true
-                "#{name}=active"
-              elsif value
-                if value.kind_of?(Array)
-                  "#{name}=#{CGI.escape(value.join(' '))}"
-                else
-                  "#{name}=#{CGI.escape(value.to_s)}"
-                end
-              else
-                "#{name}="
-              end
-            }.join('&')
+            str += '?' + QueryParams.dump(@query_params)
           end
 
           str

data/lib/uri/query_params/query_params.rb

@@ -16,7 +16,7 @@ module URI
 
       if query_string
         query_string.split('&').each do |param|
-          name, value = param.split('=')
+          name, value = param.split('=',2)
 
           if value
             query_params[name] = URI.decode(value)
@@ -29,5 +29,37 @@ module URI
       return query_params
     end
 
+    #
+    # Dumps the URI query params.
+    #
+    # @param [Hash{String => String}] query_params
+    #   The query params.
+    #
+    # @return [String]
+    #   The dumped URI query string.
+    #
+    # @since 0.5.0
+    #
+    def QueryParams.dump(query_params)
+      query = []
+
+      query_params.each do |name,value|
+        param = case value
+                when Array
+                  "#{name}=#{CGI.escape(value.join(' '))}"
+                when true
+                  "#{name}=active"
+                when false, nil
+                  "#{name}="
+                else
+                  "#{name}=#{CGI.escape(value.to_s)}"
+                end
+
+        query << param
+      end
+
+      return query.join('&')
+    end
+
   end
 end

data/lib/uri/query_params/version.rb

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

data/spec/extensions/http_spec.rb

@@ -1,8 +1,9 @@
 require 'spec_helper'
+require 'query_params_mixin_examples'
 require 'uri/query_params/extensions/http'
 
 describe URI::HTTP do
-  it "should include QueryParams" do
-    URI::HTTP.should include(URI::QueryParams::Mixin)
-  end
+  let(:uri) { URI('http://www.example.com/page.php') }
+
+  it_should_behave_like "URI::QueryParams::Mixin"
 end

data/spec/extensions/https_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+require 'query_params_mixin_examples'
+require 'uri/query_params/extensions/http'
+
+describe URI::HTTPS do
+  let(:uri) { URI('https://www.example.com/page.php') }
+
+  it_should_behave_like "URI::QueryParams::Mixin"
+end

data/spec/query_params_mixin_examples.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+require 'uri/query_params'
+
+require 'uri'
+
+shared_examples_for "URI::QueryParams::Mixin" do
+  subject { uri }
+
+  before(:each) do
+    uri.query = 'x=1&y=one%20two&z'
+  end
+
+  it "should include QueryParams" do
+    subject.class.should include(URI::QueryParams::Mixin)
+  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'
+  end
+
+  it "should properly escape query param values" do
+    subject.query_params = {'x' => '1&2', 'y' => 'one=two', 'z' => '?'}
+
+    subject.to_s.match(/\?(.+)$/)[1].should == "x=1%262&y=one%3Dtwo&z=%3F"
+  end
+
+  describe "#query_params" do
+    subject { uri.query_params }
+
+    it "should be a Hash" do
+      subject.class.should == Hash
+    end
+
+    it "should contain params" do
+      should_not be_empty
+    end
+
+    it "can contain single-word params" do
+      subject['x'].should == '1'
+    end
+
+    it "can contain multi-word params" do
+      subject['y'].should == 'one two'
+    end
+
+    it "can contain empty params" do
+      subject['z'].should be_empty
+    end
+  end
+end

data/spec/query_params_spec.rb

@@ -4,45 +4,69 @@ require 'uri/query_params'
 require 'uri'
 
 describe URI::QueryParams do
-  let(:uri) { URI('http://www.example.com/page.php?x=1&y=one%20two&z') }
-  subject { uri }
+  describe "parse" do
+    it "should not parse an empty String" do
+      subject.parse('').should be_empty
+    end
 
-  it "should provide #query_params" do
-    should respond_to(:query_params)
-  end
+    it "should parse a single query param name" do
+      subject.parse('x').should have_key('x')
+    end
 
-  it "should update #query_params after #query is set" do
-    subject.query = 'u=3'
-    subject.query_params['u'].should == '3'
-  end
+    it "should parse a query param with an empty value" do
+      query_params = subject.parse('x=')
+
+      query_params.should have_key('x')
+      query_params['x'].should be_empty
+    end
+
+    it "should URI decode query param values" do
+      query_params = subject.parse('x=1%202')
+
+      query_params['x'].should == '1 2'
+    end
+
+    it "should ignore multiple '=' characters in query param values" do
+      query_params = subject.parse('x=1=2')
+
+      query_params['x'].should == '1=2'
+    end
 
-  it "should properly escape query param values" do
-    subject.query_params = {'x' => '1&2', 'y' => 'one=two', 'z' => '?'}
+    it "should parse multiple query params" do
+      query_params = subject.parse('x=1&y=2')
 
-    subject.to_s.should == "http://www.example.com/page.php?x=1%262&y=one%3Dtwo&z=%3F"
+      query_params['x'].should == '1'
+      query_params['y'].should == '2'
+    end
   end
 
-  describe "#query_params" do
-    subject { uri.query_params }
+  describe "dump" do
+    it "should not dump an empty Hash" do
+      subject.dump({}).should be_empty
+    end
+
+    it "should dump query params with no values" do
+      subject.dump({'x' => nil}).should == 'x='
+    end
 
-    it "should be a Hash" do
-      subject.class.should == Hash
+    it "should dump query params with empty values" do
+      subject.dump({'x' => ''}).should == 'x='
     end
 
-    it "should contain params" do
-      should_not be_empty
+    it "should dump query params with true values" do
+      subject.dump({'x' => true}).should == 'x=active'
     end
 
-    it "can contain single-word params" do
-      subject['x'].should == '1'
+    it "should dump query params with non String values" do
+      subject.dump({'x' => 1}).should == 'x=1'
     end
 
-    it "can contain multi-word params" do
-      subject['y'].should == 'one two'
+    it "should dump query params with Array values" do
+      subject.dump({'x' => [1,2]}).should == 'x=1+2'
     end
 
-    it "can contain empty params" do
-      subject['z'].should be_empty
+    it "should dump multiple query params" do
+      subject.dump({'x' => '1', 'y' => '2'}).should == 'x=1&y=2'
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,4 +1,4 @@
 require 'rubygems'
 
-gem 'rspec', '>= 1.3.0'
-require 'spec'
+gem 'rspec', '~> 2.0.0'
+require 'rspec'

data/uri-query_params.gemspec

@@ -1,68 +1,10 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
 
-Gem::Specification.new do |s|
-  s.name = %q{uri-query_params}
-  s.version = "0.4.0"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Postmodern"]
-  s.date = %q{2010-08-28}
-  s.description = %q{Allows access to the query component of the URI as a Hash.}
-  s.email = %q{postmodern.mod3@gmail.com}
-  s.extra_rdoc_files = [
-    "ChangeLog.md",
-     "LICENSE.txt",
-     "README.md"
-  ]
-  s.files = [
-    ".gitignore",
-     ".specopts",
-     ".yardopts",
-     "ChangeLog.md",
-     "LICENSE.txt",
-     "README.md",
-     "Rakefile",
-     "VERSION",
-     "lib/uri/query_params.rb",
-     "lib/uri/query_params/extensions.rb",
-     "lib/uri/query_params/extensions/http.rb",
-     "lib/uri/query_params/mixin.rb",
-     "lib/uri/query_params/query_params.rb",
-     "spec/extensions/http_spec.rb",
-     "spec/query_params_spec.rb",
-     "spec/spec_helper.rb",
-     "uri-query_params.gemspec"
-  ]
-  s.has_rdoc = %q{yard}
-  s.homepage = %q{http://github.com/postmodern/uri-query_params}
-  s.licenses = ["MIT"]
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
-  s.summary = %q{Access the query parameters of a URI, just like $_GET in PHP.}
-  s.test_files = [
-    "spec/extensions/http_spec.rb",
-     "spec/query_params_spec.rb",
-     "spec/spec_helper.rb"
-  ]
-
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<rspec>, [">= 1.3.0"])
-      s.add_development_dependency(%q<yard>, [">= 0.5.3"])
-    else
-      s.add_dependency(%q<rspec>, [">= 1.3.0"])
-      s.add_dependency(%q<yard>, [">= 0.5.3"])
-    end
-  else
-    s.add_dependency(%q<rspec>, [">= 1.3.0"])
-    s.add_dependency(%q<yard>, [">= 0.5.3"])
+begin
+  Ore::Specification.new do |gemspec|
+    # custom logic here
   end
+rescue NameError
+  STDERR.puts "The 'uri-query_params.gemspec' file requires Ore."
+  STDERR.puts "Run `gem install ore-core` to install Ore."
 end
-

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 4
+  - 5
   - 0
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Postmodern
@@ -14,39 +14,54 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-28 00:00:00 -07:00
+date: 2010-11-07 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: ore-tasks
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
         segments: 
-        - 1
-        - 3
         - 0
-        version: 1.3.0
+        - 2
+        - 0
+        version: 0.2.0
   type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: yard
+  name: rspec
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
         segments: 
+        - 2
+        - 0
         - 0
-        - 5
-        - 3
-        version: 0.5.3
+        version: 2.0.0
   type: :development
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 6
+        - 0
+        version: 0.6.0
+  type: :development
+  version_requirements: *id003
 description: Allows access to the query component of the URI as a Hash.
 email: postmodern.mod3@gmail.com
 executables: []
@@ -54,24 +69,28 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
+- README.md
 - ChangeLog.md
 - LICENSE.txt
-- README.md
 files: 
-- .gitignore
-- .specopts
+- .document
+- .rspec
 - .yardopts
 - ChangeLog.md
 - LICENSE.txt
 - README.md
 - Rakefile
-- VERSION
+- gemspec.yml
 - lib/uri/query_params.rb
 - lib/uri/query_params/extensions.rb
 - lib/uri/query_params/extensions/http.rb
+- lib/uri/query_params/extensions/https.rb
 - lib/uri/query_params/mixin.rb
 - lib/uri/query_params/query_params.rb
+- lib/uri/query_params/version.rb
 - spec/extensions/http_spec.rb
+- spec/extensions/https_spec.rb
+- spec/query_params_mixin_examples.rb
 - spec/query_params_spec.rb
 - spec/spec_helper.rb
 - uri-query_params.gemspec
@@ -80,8 +99,8 @@ homepage: http://github.com/postmodern/uri-query_params
 licenses: 
 - MIT
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -102,12 +121,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: "0"
 requirements: []
 
-rubyforge_project: 
+rubyforge_project: uri-query_params
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Access the query parameters of a URI, just like $_GET in PHP.
 test_files: 
 - spec/extensions/http_spec.rb
+- spec/extensions/https_spec.rb
 - spec/query_params_spec.rb
-- spec/spec_helper.rb

data/.gitignore

@@ -1,10 +0,0 @@
-doc
-pkg
-tmp/*
-.DS_Store
-.bundle
-.yardoc
-*.db
-*.log
-*.swp
-*~

data/.specopts

@@ -1 +0,0 @@
---colour --format specdoc

data/VERSION

@@ -1 +0,0 @@
-0.4.0