iri 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 12449f264a53cb485147418a1dac3bf592d6739bc9907a9150c742d67f0cea67
-  data.tar.gz: 47b3d56c0cf5f9b613fdb4902c98bd385cce90450271e9256ec5cab8ce2cfdfc
+  metadata.gz: 8673c781f1957a3ae681e9b324fb65331b0d2fd3790256f02b7ca63ca97e543e
+  data.tar.gz: c32ca8b48268204469d8a8aa870aa73c7cbae81e74f767863e34f6547dab60ec
 SHA512:
-  metadata.gz: f4aa33c7601a7f6ea0f06e14a091d644efd48ee821198fedecf78bedbb34adba049d203cd2466f7f2562ed3344ea8d6a7e5462732c56c36872ac343611a25f29
-  data.tar.gz: 372918b261d96aa75a6c8f813ee315e7dc9a1a32e31343b5bbd2d54b325726771f5650bd86a7a87d76204300a19a20b31523fdc79a557b9bdb319d2a9cab2ce4
+  metadata.gz: 74d0e96a473993791365dbd5e35239effab3d13cb8b0d51ed395a5475d040c1a5fc980ae1900e4c8f8218fc3fd4b712d6f7e8b38fa67af1590d713f0db061e98
+  data.tar.gz: 8d761157337ea934988ca0ceca6478381c6d3c57c475c73940809a9def8ce0be7210fb2af049d9ded1e6977db846856be52747573ecb782d1519afcbe9c6ef82

data/README.md

@@ -24,6 +24,8 @@ url = Iri.new('http://google.com/')
   .to_s # convert it to a string
 ```
 
+The full list of methods is [here](https://www.rubydoc.info/github/yegor256/iri/master/Iri).
+
 Install it:
 
 ```bash

data/iri.gemspec

@@ -31,10 +31,11 @@ Gem::Specification.new do |s|
   s.rubygems_version = '2.5'
   s.required_ruby_version = '>=2.5'
   s.name = 'iri'
-  s.version = '0.2.0'
+  s.version = '0.3.0'
   s.license = 'MIT'
   s.summary = 'Simple Immutable Ruby URI Builder'
-  s.description = 'Simple Immutable Ruby URI Builder'
+  s.description = 'Class Iri helps you build a URI and then modify its \
+parts via a simple fluent interface.'
   s.authors = ['Yegor Bugayenko']
   s.email = 'yegor256@gmail.com'
   s.homepage = 'http://github.com/yegor256/iri'

data/lib/iri.rb

@@ -46,18 +46,32 @@ require 'cgi'
 # License:: MIT
 class Iri
   # Makes a new object.
-  def initialize(uri)
+  #
+  # You can even ignore the argument, which will produce an empty URI.
+  def initialize(uri = '')
     @uri = URI(uri)
   end
 
+  # Convert it to a string.
   def to_s
     @uri.to_s
   end
 
+  # Convert it to an object of class +URI+.
   def to_uri
     @uri.clone
   end
 
+  # Add a few query arguments. For example:
+  #
+  #  Iri.new('https://google.com').add(q: 'test', limit: 10)
+  #
+  # You can add many of them and they will all be present in the resulting
+  # URI, even if their names are the same. In order to make sure you have
+  # only one instance of a query argument, use +del+ first:
+  #
+  #  Iri.new('https://google.com').del(:q).add(q: 'test')
+  #
   def add(hash)
     modify_query do |params|
       hash.each do |k, v|
@@ -67,6 +81,10 @@ class Iri
     end
   end
 
+  # Delete a few query arguments. For example:
+  #
+  #  Iri.new('https://google.com?q=test').del(:q)
+  #
   def del(*keys)
     modify_query do |params|
       keys.each do |k|
@@ -75,7 +93,10 @@ class Iri
     end
   end
 
-  # Replace the query argument(s).
+  # Replace query argument(s).
+  #
+  #  Iri.new('https://google.com?q=test').over(q: 'hey you!')
+  #
   def over(hash)
     modify_query do |params|
       hash.each do |k, v|
@@ -113,6 +134,13 @@ class Iri
     end
   end
 
+  # Replace the fragment part of the URI.
+  def fragment(val)
+    modify do |c|
+      c.fragment = val
+    end
+  end
+
   # Replace the query part of the URI.
   def query(val)
     modify do |c|
@@ -120,7 +148,11 @@ class Iri
     end
   end
 
-  # Remove the entire path+query+fragment part.
+  # Remove the entire path+query+fragment part. For example:
+  #
+  #  Iri.new('https://google.com/a/b?q=test').cut('/hello')
+  #
+  # The result will contain "https://google.com/hello".
   def cut(path = '/')
     modify do |c|
       c.query = nil

data/test/test_iri.rb

@@ -43,6 +43,13 @@ class IriTest < Minitest::Test
     assert_equal('https://localhost:443/?q=books+about+tennis&limit=10', url)
   end
 
+  def test_starts_with_empty_uri
+    assert_equal(
+      'https:',
+      Iri.new.scheme('https').to_s
+    )
+  end
+
   def test_replaces_scheme
     assert_equal(
       'https://google.com/',
@@ -64,6 +71,13 @@ class IriTest < Minitest::Test
     )
   end
 
+  def test_replaces_fragment
+    assert_equal(
+      'http://localhost/a/b#test',
+      Iri.new('http://localhost/a/b#before').fragment('test').to_s
+    )
+  end
+
   def test_sets_path
     assert_equal(
       'http://localhost/hey/you?i=8#test',

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iri
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-17 00:00:00.000000000 Z
+date: 2019-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -80,7 +80,9 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.31.0
-description: Simple Immutable Ruby URI Builder
+description: |-
+  Class Iri helps you build a URI and then modify its \
+  parts via a simple fluent interface.
 email: yegor256@gmail.com
 executables: []
 extensions: []