qasa-url 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70e637380f87112da94c4baabe3f72d117175fcf151978501057034cddee03bd
-  data.tar.gz: e93986b23ed44518830a92af7ce6c7da5c7c096bf4a0f3de30b70dbf696e79d7
+  metadata.gz: da87a5058a88b4fd8f610e7950afb30f03453d7e9fe67d4c8682bad3699608a8
+  data.tar.gz: 5552a59d77879d045c20819031a2521df3eb5ab1c1a767b53b71a656116eaf82
 SHA512:
-  metadata.gz: edfaad59c0df751e0b3da3420322d5d9b7be56bb0cc68b095b58fd22ade71af2ce0edfe34c351412d2ccaf640535de5bcb2c0036413c05bb8979384f438cd876
-  data.tar.gz: b5b65f227aad9869a2c7430a90b52743b54c06ff9aeb73ad60aa2043ede1b9c4155655c8b6f6684802387fb16c919256cac4439b4f3666d3f0bc298413713190
+  metadata.gz: d96e2f786ca8ec0a93edf2d662e691ecf7e996d73519e5cdfea3fade2ae8bf339d56b35f7732fb8b9c90477aeb2ef00e2e53c7117a5fe6a353ab334b89978c78
+  data.tar.gz: 46fe970aefe8cd4d4f7e6d3c300c426e4db4ce6430b93b120f35ad70149a2aa114ca321b98b3155551278fe2aecd322e9a5da82858a5f80f281d55f5bfffdbf1

data/README.md

@@ -1,8 +1,9 @@
 # URL
-URL is a simple URL parser and construction tool for Ruby. It doesn't follow any RFC, instead, it behaves as you expect.
+**URL** is a simple URL parser and construction tool for Ruby. It doesn't strictly follow any RFCs — instead, **it behaves as you’d expect**.
 
 ## Background
-This gem was born out of frustration with the URL handling in Ruby's standard library and other gems. I wanted to be able to parse a URL, modify it and then get the modified URL back as a string. I also wanted to be able to join paths and query strings to URLs without having to worry about trailing slashes and question marks.
+This gem was born out of frustration with the URL handling in Ruby’s standard library and other gems.
+I wanted to parse a URL, modify it, and then convert it back to a string. I also wanted to join paths and query strings to URLs without worrying about trailing slashes or question marks.
 
 ## Installation
 ```ruby
@@ -11,7 +12,7 @@ gem "qasa-url"
 
 ## Usage
 ```ruby
-# Initialize a new URL object by parsing a URL string:
+# Initialize a new URL object from a string:
 url = URL.parse("http://www.example.com:404/path")
 url.to_s # => "http://www.example.com:404/path"
 
@@ -30,21 +31,22 @@ url.to_s # => "https://www.example.com/path/to/nowhere?foo=bar"
 url = URL["example.com"]
 url.join("/path", "to", "nowhere")
 
-# Note: If you don't provide a protocol, it'll default to "https":
+# Note: If no protocol is provided, it defaults to "https":
 url.to_s # => "https://example.com/path/to/nowhere"
 ```
 
-## Alternatives 
-If you're looking for something that parses URLs in Ruby and Ruby on Rails and closely conforms to RFC 3986, RFC 3987, and RFC 6570 (level 4),
-check out [addressable](https://github.com/sporkmonger/addressable).
-If you need to do domain name validation check out [public_suffix](https://github.com/weppos/publicsuffix-ruby).
+## Alternatives
+If you're looking for something that parses URLs in Ruby and Ruby on Rails and closely conforms to RFC 3986, RFC 3987, and RFC 6570 (level 4), check out [addressable](https://github.com/sporkmonger/addressable).
+For domain name validation, see [public_suffix](https://github.com/weppos/publicsuffix-ruby).
 
 ## Risks using this gem
-The risk should be considered low. The gem is very small, simple and well-tested. The only risk is that it doesn't follow any RFCs. This means that it might not behave as you expect. However, it's very unlikely that you'll run into any problems.
-The gem is maintained by [Qasa](https://www.qasa.se), we're a small team of dedicated Ruby developers.
+The risks of using this gem are very low. It’s small, simple, and well-tested.
+The main caveat is that it doesn’t follow any RFCs, so behavior may differ in edge cases. That said, it’s unlikely you’ll encounter issues in practice.
+
+This gem is actively maintained by [Qasa](https://www.qasa.se), a small team of dedicated Ruby developers.
 
 ## Contributing
-Bug reports and pull requests are always welcome!
+**Bug reports and pull requests are always welcome!**
 
 ## License
 See [LICENSE](LICENSE).

data/lib/qasa/url/version.rb

@@ -2,6 +2,6 @@
 
 module Qasa
   module Url
-    VERSION = "0.1.2"
+    VERSION = "0.2.0"
   end
 end

data/lib/url.rb

@@ -139,7 +139,7 @@ class URL
   #   @param path [String] a single string path
   # @overload join(*paths)
   #   @param paths [Array<String>] an array of string paths
-  # @return [URL] self
+  # @return [URL] duplicate of self
   # @example
   #   url = URL.parse("https://www.example.com")
   #   url.join("path").path("to", "nowhere")
@@ -149,6 +149,18 @@ class URL
   #  url.join("/path", "/to/", "nowhere/")
   #  url.to_s # => "https://www.example.com/path/to/nowhere/"
   def join(*paths)
+    dup = self.dup
+
+    dup.join!(*paths)
+  end
+
+  # Adds a path to the URL
+  # @overload join(path)
+  #   @param path [String] a single string path
+  # @overload join(*paths)
+  #   @param paths [Array<String>] an array of string paths
+  # @return [URL] self
+  def join!(*paths)
     parts = Array(path).concat(paths)
     size = parts.size
 
@@ -165,12 +177,25 @@ class URL
 
   # Append query parameters to the URL
   # @param [Hash]
-  # @return [URL] self
+  # @return [URL] duplicate of self
   # @example
   #   url = URL.parse("https://www.example.com")
   #   url.merge(query: "string")
   #   url.to_s # => "https://www.example.com?query=string"
   def merge(query)
+    dup = self.dup
+
+    dup.merge!(query)
+  end
+
+  # Append query parameters to the URL
+  # @param [Hash]
+  # @return [URL] self
+  # @example
+  #   url = URL.parse("https://www.example.com")
+  #   url.merge(query: "string")
+  #   url.to_s # => "https://www.example.com?query=string"
+  def merge!(query)
     self.query = self.query.merge(deep_transform_keys(query))
 
     self

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: qasa-url
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - ingemar