uri-query_params 0.8.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da86f32384123e5240b11aae3767b48770696604afb3eee3c4a04351badaa585
-  data.tar.gz: c469674aa5d7f20e72f19dd6fb2eac80917182638706390fe1cc2e60d89ecb98
+  metadata.gz: cc67bd83bfc5a5da2b33ddb21f124663d45e54ce09498b541f223a6180851236
+  data.tar.gz: 692d674b03b6e0e165c4ee5cd78363b9e7288ac428d4972c69de8f90379668fc
 SHA512:
-  metadata.gz: 62031ef7a85c4e0d17205964f3d2b14c0596d42da4c04f583faedd83f8a7f3c861bddfefdae6e4c36055913e2a59738a93021d943bd0447d91cf360d3762b8b3
-  data.tar.gz: af4ad8d768e9114636279f4abe2d197b439f856474bab5dbb5269388e8f5ad7aaa0a780858e16c797d77f68874f696d3c2e58e486dfada640bcbe19b826b4e3e
+  metadata.gz: cb4d13c217fabbd2abe86abab5a4bdce9c7039430967c955cac58d9eb06584c29dfd7cbdfefe04250d6670936f28bae2d619ea4bb9a9c762ba5ac005bb83d1f4
+  data.tar.gz: 902d5196f48db8853c9f60110039ffc0fa41835c6877dac60798f69ea3a5e0f063c5cc321f5d8bae3635ddd41d00920edd3ee87cd24ab1eee46e32a78e285d29

data/.github/workflows/ruby.yml

@@ -9,8 +9,6 @@ jobs:
       fail-fast: false
       matrix:
         ruby:
-          - 2.6
-          - 2.7
           - '3.0'
           - 3.1
           - jruby

data/.gitignore

@@ -1,4 +1,5 @@
 /Gemfile.lock
+/coverage/
 /doc/
 /pkg/
 /vendor/bundle

data/ChangeLog.md

@@ -1,3 +1,9 @@
+### 0.8.1 / 2022-10-22
+
+* Updated {URI::Generic#to_s} to ruby-3.0.0.
+* Override {URI::HTTP#request_uri} to be aware of
+  {URI::QueryParams::Mixin#query_params}.
+
 ### 0.8.0 / 2022-01-14
 
 * Require [ruby] >= 2.0.0.

data/Gemfile

@@ -10,7 +10,8 @@ group :development do
   gem 'rake'
   gem 'rubygems-tasks', '~> 0.2'
 
-  gem 'rspec', '~> 3.0'
+  gem 'rspec',     '~> 3.0'
+  gem 'simplecov', '~> 0.20'
 
   gem 'kramdown'
   gem 'yard', '~> 0.9'

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'uri/query_params/mixin'
 
 require 'uri/generic'
@@ -11,44 +13,44 @@ module URI
     # Constructs String from URI
     #
     # @note
-    #   This is the `URI::Generic#to_s` method from Ruby 2.2.0, with the minor
+    #   This is the `URI::Generic#to_s` method from Ruby 3.0.0, with the minor
     #   modification of calling the `query` method overrode by
     #   {URI::QueryParams::Mixin}, instead of `@query`.
     #
-    # @see https://github.com/ruby/ruby/blob/v2_2_0/lib/uri/generic.rb#L1338-L1376
+    # @see https://github.com/ruby/ruby/blob/v3_0.0/lib/uri/generic.rb#L1330-L1368
     #
     def to_s
-      str = ''
+      str = ''.dup
       if @scheme
         str << @scheme
-        str << ':'.freeze
+        str << ':'
       end
 
       if @opaque
         str << @opaque
       else
-        if @host
-          str << '//'.freeze
+        if @host || %w[file postgres].include?(@scheme)
+          str << '//'
         end
         if self.userinfo
           str << self.userinfo
-          str << '@'.freeze
+          str << '@'
         end
         if @host
           str << @host
         end
         if @port && @port != self.default_port
-          str << ':'.freeze
+          str << ':'
           str << @port.to_s
         end
         str << @path
-        if query
-          str << '?'.freeze
+        if (query = self.query)
+          str << '?'
           str << query
         end
       end
       if @fragment
-        str << '#'.freeze
+        str << '#'
         str << @fragment
       end
       str

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'uri/query_params/core_ext/uri/generic'
+
+require 'uri/http'
+
+module URI
+  class HTTP < Generic
+
+    alias raw_request_uri request_uri
+
+    #
+    # Returns the full path for an HTTP request.
+    #
+    # @return [String, nil]
+    #   The request URI (path + query params) or `nil` if the URI has no
+    #   path.
+    #
+    # @example
+    #   uri.path = '/path'
+    #   uri.query_params['foo'] = '1'
+    #   uri.query_params['bar'] = '2'
+    #   uri.request_uri
+    #   # => "/path?foo=1&bar=2"
+    #
+    def request_uri
+      if defined?(@query_params) && @query_params
+        return unless @path
+
+        query = URI::QueryParams.dump(@query_params)
+
+        url = "#{@path}?#{query}"
+        url = "/#{url}" unless url.start_with?('/')
+        url
+      else
+        raw_request_uri
+      end
+    end
+
+  end
+end

data/lib/uri/query_params/core_ext/uri.rb

@@ -1 +1,2 @@
 require 'uri/query_params/core_ext/uri/generic'
+require 'uri/query_params/core_ext/uri/http'

data/lib/uri/query_params/version.rb

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

data/lib/uri/query_params.rb

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

data/spec/core_ext/addressable/uri_spec.rb

@@ -3,7 +3,7 @@ require 'query_params_mixin_examples'
 require 'uri/query_params/core_ext/addressable/uri'
 
 describe Addressable::URI do
-  let(:uri) { described_class.parse('http://www.example.com/page.php') }
+  subject { described_class.parse('http://www.example.com/page.php') }
 
   it_should_behave_like "URI::QueryParams::Mixin"
 end

data/spec/core_ext/uri/generic_spec.rb

@@ -3,7 +3,7 @@ require 'query_params_mixin_examples'
 require 'uri/query_params/core_ext/uri'
 
 describe URI::Generic do
-  let(:uri) { URI('/page.php') }
+  subject { URI.parse('/page.php') }
 
   it_should_behave_like "URI::QueryParams::Mixin"
 end

data/spec/core_ext/uri/http_spec.rb

@@ -1,9 +1,77 @@
 require 'spec_helper'
 require 'query_params_mixin_examples'
-require 'uri/query_params/core_ext/uri'
+require 'uri/query_params/core_ext/uri/http'
 
 describe URI::HTTP do
-  let(:uri) { URI('http://www.example.com/page.php') }
+  subject { URI.parse("http://www.example.com/page.php") }
 
   it_should_behave_like "URI::QueryParams::Mixin"
+
+  describe "#request_uri" do
+    context "when #query_params is set" do
+      let(:query_params) do
+        {'x' => '1', 'y' => '2'}
+      end
+
+      before { subject.query_params = query_params }
+
+      context "and when #path is set" do
+        it "must return the #path and #query_params" do
+          expect(subject.request_uri).to eq("#{subject.path}?x=#{query_params['x']}&y=#{query_params['y']}")
+        end
+
+        context "but #path does not start with a '/' character" do
+          subject { URI.parse("http://www.example.com") }
+
+          it "must prepend a '/' character" do
+            expect(subject.request_uri).to eq("/#{subject.path}?x=#{query_params['x']}&y=#{query_params['y']}")
+          end
+        end
+      end
+
+      context "but #path is not set" do
+        before { subject.path = nil }
+
+        it "must return nil" do
+          expect(subject.request_uri).to be(nil)
+        end
+      end
+    end
+
+    context "when #query_params is not set" do
+      context "and when #path is set" do
+        context "and when #query is set" do
+          let(:query) { 'x=1&y=2' }
+
+          subject { URI("http://www.example.com/page.php?#{query}") }
+
+          it "must return the #path and #query" do
+            expect(subject.request_uri).to eq("#{subject.path}?#{subject.query}")
+          end
+        end
+
+        context "but when #query is not set" do
+          it "must return #path" do
+            expect(subject.request_uri).to eq(subject.path)
+          end
+        end
+
+        context "but #path does not start with a '/' character" do
+          subject { URI.parse("http://www.example.com") }
+
+          it "must prepend a '/' character" do
+            expect(subject.request_uri).to eq("/#{subject.path}")
+          end
+        end
+      end
+
+      context "but #path is not set" do
+        before { subject.path = nil }
+
+        it "must return nil" do
+          expect(subject.request_uri).to be(nil)
+        end
+      end
+    end
+  end
 end

data/spec/query_params_mixin_examples.rb

@@ -6,9 +6,7 @@ require 'uri'
 shared_examples_for "URI::QueryParams::Mixin" do
   let(:query) { 'x=1&y=one%20two&z' }
 
-  subject { uri }
-
-  before(:each) { uri.query = query }
+  before { subject.query = query }
 
   context "when included" do
     it "should include QueryParams::Mixin" do
@@ -16,11 +14,11 @@ shared_examples_for "URI::QueryParams::Mixin" do
     end
 
     it "should still provide access to #query" do
-      expect(uri.query).to eq(query)
+      expect(subject.query).to eq(query)
     end
 
     it "should provide #query_params" do
-      is_expected.to respond_to(:query_params)
+      expect(subject).to respond_to(:query_params)
     end
   end
 
@@ -44,6 +42,7 @@ shared_examples_for "URI::QueryParams::Mixin" do
   describe "#query" do
     it "should dump out the #query_params when accessing #query" do
       subject.query_params = {'u' => '3'}
+
       expect(subject.query).to eq('u=3')
     end
 
@@ -61,26 +60,24 @@ shared_examples_for "URI::QueryParams::Mixin" do
   end
 
   describe "#query_params" do
-    subject { uri.query_params }
-
     it "should be a Hash" do
-      expect(subject.class).to eq(Hash)
+      expect(subject.query_params.class).to eq(Hash)
     end
 
     it "should contain params" do
-      is_expected.not_to be_empty
+      expect(subject.query_params).not_to be_empty
     end
 
     it "can contain single-word params" do
-      expect(subject['x']).to eq('1')
+      expect(subject.query_params['x']).to eq('1')
     end
 
     it "can contain multi-word params" do
-      expect(subject['y']).to eq('one two')
+      expect(subject.query_params['y']).to eq('one two')
     end
 
     it "can contain empty params" do
-      expect(subject['z']).to be_empty
+      expect(subject.query_params['z']).to be_empty
     end
   end
 end

data/spec/spec_helper.rb

@@ -1 +1,4 @@
 require 'rspec'
+require 'simplecov'
+
+SimpleCov.start

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: uri-query_params
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Postmodern
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-15 00:00:00.000000000 Z
+date: 2022-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -49,6 +49,7 @@ files:
 - lib/uri/query_params/core_ext/addressable/uri.rb
 - lib/uri/query_params/core_ext/uri.rb
 - lib/uri/query_params/core_ext/uri/generic.rb
+- lib/uri/query_params/core_ext/uri/http.rb
 - lib/uri/query_params/extensions.rb
 - lib/uri/query_params/extensions/addressable/uri.rb
 - lib/uri/query_params/extensions/uri.rb
@@ -91,7 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Access the query parameters of a URI, just like $_GET in PHP.