uri-query_params 0.6.2 → 0.7.0

data/ChangeLog.md

@@ -1,3 +1,10 @@
+### 0.7.0 / 2012-03-27
+
+* Inject {URI::QueryParams::Mixin} into {URI::Generic}, so all URIs have
+  `query_params`.
+* Inject {URI::QueryParams::Mixin} into `Addressable::URI`, if `addressable/uri`
+  is loaded.
+
 ### 0.6.2 / 2012-03-15
 
 * Fixed a query parameter ordering issue in {URI::QueryParams.dump},
@@ -26,7 +33,7 @@
   * Contains RFC 3986 unsafe URI characters.
   * Use {URI::QueryParams::UNSAFE} in {URI::QueryParams.dump} for safer
     query strings.
-* Added {URI::QueryParams::Mixin#query}:
+* Added `URI::QueryParams::Mixin#query`:
   * If any query-params are set, dump them out using
     {URI::QueryParams.dump}.
 * Renamed `parse_query_params` to

data/README.md

@@ -8,7 +8,7 @@
 ## Description
 
 Allows access to the query component of the URI as a Hash. This is similar
-to `$_GET` from PHP, except available on any {URI::HTTP} object.
+to `$_GET` from PHP, except available on any Ruby URI object.
 
 ## Examples
 
@@ -29,6 +29,12 @@ Setting the URI query_params:
     url.to_s
     # => "http://www.google.com/search?btnG=Search&hs=1HY&rls=org.mozilla:en-US:official&client=firefox-a&hl=en&q=Upright%20Citizens%20Brigade"
 
+Parsing URI query_params embedded within the Fragment Identifier:
+
+    url = URI('https://twitter.com/#!/download?lang=en&logged_out=1')
+    URI(url.fragment).query_params
+    # => {"logged_out"=>"1", "lang"=>"en"}
+
 ## Install
 
     $ gem install uri-query_params

data/Rakefile

@@ -1,16 +1,6 @@
 require 'rubygems'
 require 'rake'
 
-begin
-  gem 'ore-tasks', '~> 0.4'
-  require 'ore/tasks'
-
-  Ore::Tasks.new
-rescue LoadError => e
-  warn e.message
-  warn "Run `gem install ore-tasks` to install 'ore/tasks'."
-end
-
 begin
   gem 'rspec', '~> 2.4'
   require 'rspec/core/rake_task'

data/gemspec.yml

@@ -8,6 +8,5 @@ email: postmodern.mod3@gmail.com
 has_yard: true
 
 development_dependencies:
-  ore-tasks: ~> 0.4
   rspec: ~> 2.4
   yard: ~> 0.6

data/lib/uri/query_params/extensions.rb

@@ -1,2 +1,2 @@
-require 'uri/query_params/extensions/http'
-require 'uri/query_params/extensions/https'
+require 'uri/query_params/extensions/uri'
+require 'uri/query_params/extensions/addressable/uri' if defined?(Addressable)

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

@@ -0,0 +1,11 @@
+require 'uri/query_params/mixin'
+
+require 'addressable/uri'
+
+module Addressable
+  class URI
+
+    include ::URI::QueryParams::Mixin
+
+  end
+end

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

@@ -0,0 +1 @@
+require 'uri/query_params/extensions/uri/generic'

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

@@ -0,0 +1,39 @@
+require 'uri/query_params/mixin'
+
+require 'uri/generic'
+
+module URI
+  class Generic
+
+    include URI::QueryParams::Mixin
+
+    private
+
+    alias raw_path_query path_query
+
+    #
+    # Parses the query parameters from the query data, populating
+    # query_params with the parsed parameters.
+    #
+    # @see QueryParams.parse
+    #
+    # @since 0.5.2
+    #
+    def path_query
+      if @query_params
+        str = @path
+
+        unless @query_params.empty?
+          str += '?' + URI::QueryParams.dump(@query_params)
+        end
+
+        str
+      else
+        # do not rebuild the path-query, if the query_params have not
+        # been parsed yet
+        raw_path_query
+      end
+    end
+
+  end
+end

data/lib/uri/query_params/mixin.rb

@@ -10,6 +10,58 @@ module URI
       # Allows setting the query_params.
       attr_writer :query_params
 
+      #
+      # Called when {Mixin} is included into a URI Class. Overrides the `query`
+      # and `query=` methods to transparently update the {#query_params}.
+      #
+      def self.included(base)
+        base.module_eval do
+          alias raw_query query
+
+          #
+          # The raw query-string.
+          #
+          # @return [String, nil]
+          #   The raw query-string.
+          #
+          # @see QueryParams.dump
+          #
+          # @since 0.5.2
+          #
+          def query
+            if @query_params
+              URI::QueryParams.dump(@query_params)
+            else
+              raw_query
+            end
+          end
+
+          alias raw_query= query=
+
+          #
+          # Sets the query string and updates query_params.
+          #
+          # @param [String] query_str
+          #   The new URI query string to use.
+          #
+          # @return [String]
+          #   The new URI query string.
+          #
+          # @example
+          #   url.query = 'a=1&b=2'
+          #   # => "a=1&b=2"
+          #
+          # @see QueryParams.parse
+          #
+          def query=(new_query)
+            new_query = (self.raw_query = new_query)
+
+            parse_query_params! if @query_params
+            return new_query
+          end
+        end
+      end
+
       #
       # Deep-copies the {#query_params} from another URL.
       #
@@ -26,46 +78,6 @@ 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.
-      #
-      # @param [String] query_str
-      #   The new URI query string to use.
-      #
-      # @return [String]
-      #   The new URI query string.
-      #
-      # @example
-      #   url.query = 'a=1&b=2'
-      #   # => "a=1&b=2"
-      #
-      # @see QueryParams.parse
-      #
-      def query=(raw_query)
-        new_query = super(raw_query)
-
-        parse_query_params! if @query_params
-        return new_query
-      end
-
       #
       # The query params of the URI.
       #
@@ -111,26 +123,9 @@ module URI
       # @since 0.5.2
       #
       def parse_query_params!
-        @query_params = QueryParams.parse(@query)
+        @query_params = URI::QueryParams.parse(@query)
       end
 
-      private
-
-      def path_query
-        if @query_params
-          str = @path
-
-          unless @query_params.empty?
-            str += '?' + QueryParams.dump(@query_params)
-          end
-
-          str
-        else
-          # do not rebuild the path-query, if the query_params have not
-          # been parsed yet
-          super
-        end
-      end
     end
   end
 end

data/lib/uri/query_params/version.rb

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

data/spec/extensions/addressable/uri_spec.rb

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

data/spec/extensions/uri/generic_spec.rb

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

data/spec/extensions/{http_spec.rb → uri/http_spec.rb}

@@ -1,6 +1,6 @@
 require 'spec_helper'
 require 'query_params_mixin_examples'
-require 'uri/query_params/extensions/http'
+require 'uri/query_params/extensions/uri'
 
 describe URI::HTTP do
   let(:uri) { URI('http://www.example.com/page.php') }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: uri-query_params
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.7.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,22 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-16 00:00:00.000000000 Z
+date: 2012-03-28 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: ore-tasks
-  requirement: &19935200 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.4'
-  type: :development
-  prerelease: false
-  version_requirements: *19935200
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &19934680 !ruby/object:Gem::Requirement
+  requirement: &13944620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +21,10 @@ dependencies:
         version: '2.4'
   type: :development
   prerelease: false
-  version_requirements: *19934680
+  version_requirements: *13944620
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &19934200 !ruby/object:Gem::Requirement
+  requirement: &13944020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,7 +32,7 @@ dependencies:
         version: '0.6'
   type: :development
   prerelease: false
-  version_requirements: *19934200
+  version_requirements: *13944020
 description: Allows access to the query component of the URI as a Hash.
 email: postmodern.mod3@gmail.com
 executables: []
@@ -62,13 +51,15 @@ files:
 - 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/extensions/addressable/uri.rb
+- lib/uri/query_params/extensions/uri.rb
+- lib/uri/query_params/extensions/uri/generic.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/extensions/addressable/uri_spec.rb
+- spec/extensions/uri/generic_spec.rb
+- spec/extensions/uri/http_spec.rb
 - spec/query_params_mixin_examples.rb
 - spec/query_params_spec.rb
 - spec/spec_helper.rb
@@ -99,7 +90,8 @@ 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/extensions/addressable/uri_spec.rb
+- spec/extensions/uri/generic_spec.rb
+- spec/extensions/uri/http_spec.rb
 - spec/query_params_spec.rb
 has_rdoc: 

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

@@ -1,11 +0,0 @@
-require 'uri/query_params/mixin'
-
-require 'uri/http'
-
-module URI
-  class HTTP < Generic
-
-    include QueryParams::Mixin
-
-  end
-end

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

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

data/spec/extensions/https_spec.rb

@@ -1,9 +0,0 @@
-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