iri 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 87b71f1b546b3b5c62641549af0c0a448dfee41109519f3a9987f9e67b916948
+  data.tar.gz: 7102176c5f82ff8a05f5295233d74fff0d0e81400bf47f561763ee16d9916e60
+SHA512:
+  metadata.gz: 4c931d32c782208e17e613dd27a98eea60a320dacfb279f35d6c24e73bdf809344e8fed4b7e24b8d5be8967662d34c2e9af7ccdd02b20139b56d7e8a6a021421
+  data.tar.gz: aed064a6106b224ce9cc063b36edbbc472e34050ce0207878c014fff0d793d42a9822a8488efba41dc769dabdcd71d1881f4eb19d5350c2d2bb86cd68b4c240d

data/.0pdd.yml

@@ -0,0 +1,9 @@
+errors:
+  - yegor256@gmail.com
+# alerts:
+#   github:
+#     - yegor256
+
+tags:
+  - pdd
+  - bug

data/.gitignore

@@ -0,0 +1,6 @@
+Gemfile.lock
+*.gem
+.bundle/
+.DS_Store
+rdoc/
+.idea/

data/.pdd

@@ -0,0 +1,5 @@
+--source=.
+--verbose
+--rule min-words:20
+--rule min-estimate:15
+--rule max-estimate:90

data/.rubocop.yml

@@ -0,0 +1,21 @@
+AllCops:
+  DisplayCopNames: true
+  TargetRubyVersion: 2.5
+
+Metrics/ClassLength:
+  Exclude:
+    - 'test/*.rb'
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false
+Layout/MultilineMethodCallIndentation:
+  Enabled: false
+Metrics/AbcSize:
+  Max: 30
+Metrics/MethodLength:
+  Max: 30
+Metrics/CyclomaticComplexity:
+  Max: 12
+Metrics/PerceivedComplexity:
+  Max: 12
+Layout/EndOfLine:
+  EnforcedStyle: lf

data/.rultor.yml

@@ -0,0 +1,26 @@
+assets:
+  rubygems.yml: zerocracy/home#assets/rubygems.yml
+install: |-
+  export GEM_HOME=~/.ruby
+  export GEM_PATH=$GEM_HOME:$GEM_PATH
+release:
+  script: |-
+    bundle install
+    bundle exec rake
+    rm -rf *.gem
+    sed -i "s/0\.0\.0/${tag}/g" iri.gemspec
+    git add iri.gemspec
+    git commit -m "Version set to ${tag}"
+    gem build iri.gemspec
+    chmod 0600 ../rubygems.yml
+    gem push *.gem --config-file ../rubygems.yml
+  commanders:
+  - yegor256
+architect:
+- yegor256
+merge:
+  commanders: []
+  script: |-
+    bundle install
+    bundle exec rake
+deploy: {}

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+  - 2.6.0
+branches:
+  only:
+    - master
+install:
+  - bundle install
+script:
+  - set -e
+  - rake
+

data/Gemfile

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2019 Yegor Bugayenko
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the 'Software'), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+source 'https://rubygems.org'
+ruby '~>2.3'
+gemspec

data/README.md

@@ -0,0 +1,62 @@
+[![EO principles respected here](http://www.elegantobjects.org/badge.svg)](http://www.elegantobjects.org)
+[![DevOps By Rultor.com](http://www.rultor.com/b/yegor256/iri)](http://www.rultor.com/p/yegor256/iri)
+[![We recommend RubyMine](http://www.elegantobjects.org/rubymine.svg)](https://www.jetbrains.com/ruby/)
+
+[![Build Status](https://travis-ci.org/yegor256/iri.svg)](https://travis-ci.org/yegor256/iri)
+[![Build status](https://ci.appveyor.com/api/projects/status/5hj65olpn2tds4al?svg=true)](https://ci.appveyor.com/project/yegor256/iri)
+[![Gem Version](https://badge.fury.io/rb/iri.svg)](http://badge.fury.io/rb/iri)
+[![Maintainability](https://api.codeclimate.com/v1/badges/7018d2fe438103828685/maintainability)](https://codeclimate.com/github/yegor256/iri/maintainability)
+[![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://rubydoc.info/github/yegor256/iri/master/frames)
+
+Class `Iri` helps you build a URI and then modify its
+parts via a simple fluent interface:
+
+```ruby
+url = Iri.new('http://google.com/')
+  .add(q: 'books about OOP', limit: 50)
+  .del(:q) # remove this query parameter
+  .del('limit') # remove this one too
+  .over(q: 'books about tennis', limit: 10) # replace these params
+  .scheme('https') # replace 'http' with 'https'
+  .host('localhost') # replace the host name
+  .port('443') # replace the port
+  .to_s # convert it to a string
+```
+
+Install it:
+
+```bash
+$ gem install iri
+```
+
+Or add this to your `Gemfile`:
+
+```bash
+gem 'iri'
+```
+
+Pay attention, it is not a parser. The only functionality this gem provides
+is _building_ URIs. It is very convenient to use inside
+[HAML](http://haml.info/tutorial.html), for example:
+
+```haml
+- iri = Iri.new(request.url)
+%a{href: iri.over(offset: offset + 10)} Next Page
+%a{href: iri.over(offset: offset - 10)} Previous Page
+```
+
+That's it.
+
+## How to contribute
+
+Read [these guidelines](https://www.yegor256.com/2014/04/15/github-guidelines.html).
+Make sure you build is green before you contribute
+your pull request. You will need to have [Ruby](https://www.ruby-lang.org/en/) 2.3+ and
+[Bundler](https://bundler.io/) installed. Then:
+
+```
+$ bundle update
+$ bundle exec rake
+```
+
+If it's clean and you don't see any error messages, submit your pull request.

data/Rakefile

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2019 Yegor Bugayenko
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the 'Software'), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+
+CLEAN = FileList['coverage']
+
+def name
+  @name ||= File.basename(Dir['*.gemspec'].first, '.*')
+end
+
+def version
+  Gem::Specification.load(Dir['*.gemspec'].first).version
+end
+
+task default: %i[clean test rubocop]
+
+require 'rake/testtask'
+Rake::TestTask.new do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = false
+end
+
+require 'rdoc/task'
+RDoc::Task.new do |rdoc|
+  rdoc.main = 'README.md'
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.rdoc_files.include('README.md', 'lib/**/*.rb')
+end
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new do |task|
+  task.fail_on_error = true
+  task.requires << 'rubocop-rspec'
+end

data/appveyor.yml

@@ -0,0 +1,36 @@
+version: '{build}'
+skip_tags: true
+clone_depth: 10
+branches:
+  only:
+    - master
+  except:
+    - gh-pages
+os: Windows Server 2012
+environment:
+  matrix:
+    - ruby_version: "25-x64"
+install:
+  - ps: |
+      $Env:PATH = "C:\Ruby${Env:ruby_version}\bin;${Env:PATH}"
+      if ($Env:ruby_version -match "^23" ) {
+        # RubyInstaller; download OpenSSL headers from OpenKnapsack Project
+        $Env:openssl_dir = "C:\Ruby${Env:ruby_version}"
+        appveyor DownloadFile http://dl.bintray.com/oneclick/OpenKnapsack/x64/openssl-1.0.2j-x64-windows.tar.lzma
+        7z e openssl-1.0.2j-x64-windows.tar.lzma
+        7z x -y -oC:\Ruby${Env:ruby_version} openssl-1.0.2j-x64-windows.tar
+      } else {
+        # RubyInstaller2; openssl package seems to be installed already
+        $Env:openssl_dir = "C:\msys64\mingw64"
+      }
+  - bundle config --local path vendor/bundle
+  - bundle config build.openssl --with-openssl-dir=%openssl_dir%
+  - ruby -v
+  - bundle -v
+build_script:
+  - bundle update
+  - bundle install
+test_script:
+  - bundle exec rake --quiet
+cache:
+  - vendor/bundle

data/iri.gemspec

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+# (The MIT License)
+#
+# Copyright (c) 2019 Yegor Bugayenko
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the 'Software'), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+require 'English'
+Gem::Specification.new do |s|
+  s.specification_version = 2 if s.respond_to? :specification_version=
+  if s.respond_to? :required_rubygems_version=
+    s.required_rubygems_version = Gem::Requirement.new('>= 0')
+  end
+  s.rubygems_version = '2.5'
+  s.required_ruby_version = '>=2.5'
+  s.name = 'iri'
+  s.version = '0.1.0'
+  s.license = 'MIT'
+  s.summary = 'Simple Immutable Ruby URI Builder'
+  s.description = 'Simple Immutable Ruby URI Builder'
+  s.authors = ['Yegor Bugayenko']
+  s.email = 'yegor256@gmail.com'
+  s.homepage = 'http://github.com/yegor256/iri'
+  s.files = `git ls-files`.split($RS)
+  s.test_files = s.files.grep(%r{^(test)/})
+  s.rdoc_options = ['--charset=UTF-8']
+  s.extra_rdoc_files = ['README.md']
+  s.add_development_dependency 'minitest', '5.11.3'
+  s.add_development_dependency 'rake', '12.3.1'
+  s.add_development_dependency 'rdoc', '4.3.0'
+  s.add_development_dependency 'rubocop', '0.62.0'
+  s.add_development_dependency 'rubocop-rspec', '1.31.0'
+end

data/lib/iri.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+# (The MIT License)
+#
+# Copyright (c) 2019 Yegor Bugayenko
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the 'Software'), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+require 'uri'
+require 'cgi'
+
+# It is a simple URI builder.
+#
+#  require 'iri'
+#  url = Iri.new('http://google.com/')
+#    .add(q: 'books about OOP', limit: 50)
+#    .del(:q) // remove this query parameter
+#    .del('limit') // remove this one too
+#    .over(q: 'books about tennis', limit: 10) // replace these params
+#    .scheme('https')
+#    .host('localhost')
+#    .port('443')
+#    .to_s
+#
+# For more information read
+# {README}[https://github.com/yegor256/iri/blob/master/README.md] file.
+#
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2019 Yegor Bugayenko
+# License:: MIT
+class Iri
+  # Makes a new object.
+  def initialize(uri)
+    @uri = URI(uri)
+  end
+
+  def to_s
+    @uri.to_s
+  end
+
+  def to_uri
+    @uri.clone
+  end
+
+  def add(hash)
+    modify_query do |params|
+      hash.each do |k, v|
+        params[k.to_s] = [] unless params[k.to_s]
+        params[k.to_s] << v
+      end
+    end
+  end
+
+  def del(*keys)
+    modify_query do |params|
+      keys.each do |k|
+        params.delete(k.to_s)
+      end
+    end
+  end
+
+  def over(hash)
+    modify_query do |params|
+      hash.each do |k, v|
+        params[k.to_s] = [] unless params[k]
+        params[k.to_s] = [v]
+      end
+    end
+  end
+
+  def scheme(val)
+    modify do |c|
+      c.scheme = val
+    end
+  end
+
+  def host(val)
+    modify do |c|
+      c.host = val
+    end
+  end
+
+  def port(val)
+    modify do |c|
+      c.port = val
+    end
+  end
+
+  private
+
+  def modify
+    c = @uri.clone
+    yield c
+    Iri.new(c)
+  end
+
+  def modify_query
+    modify do |c|
+      params = CGI.parse(@uri.query || '').map { |p, a| [p.to_s, a.clone] }.to_h
+      yield(params)
+      c.query = URI.encode_www_form(params)
+    end
+  end
+end

data/test/test_iri.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+# (The MIT License)
+#
+# Copyright (c) 2019 Yegor Bugayenko
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the 'Software'), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+require 'minitest/autorun'
+require_relative '../lib/iri'
+
+# Iri test.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2019 Yegor Bugayenko
+# License:: MIT
+class IriTest < Minitest::Test
+  def test_builds_uri
+    url = Iri.new('http://google.com/')
+      .add(q: 'books about OOP', limit: 50)
+      .del(:q)
+      .del('limit')
+      .over(q: 'books about tennis', limit: 10)
+      .scheme('https')
+      .host('localhost')
+      .port('443')
+      .to_s
+    assert_equal('https://localhost:443/?q=books+about+tennis&limit=10', url)
+  end
+
+  def test_replaces_scheme
+    assert_equal(
+      'https://google.com/',
+      Iri.new('http://google.com/').scheme('https').to_s
+    )
+  end
+
+  def test_replaces_host
+    assert_equal(
+      'http://localhost/',
+      Iri.new('http://google.com/').host('localhost').to_s
+    )
+  end
+
+  def test_replaces_port
+    assert_equal(
+      'http://localhost:443/',
+      Iri.new('http://localhost/').port(443).to_s
+    )
+  end
+
+  def test_adds_query_param
+    assert_equal(
+      'http://google/?a=1&a=3&b=2',
+      Iri.new('http://google/').add(a: 1, b: 2).add(a: 3).to_s
+    )
+    assert_equal(
+      'http://google/?%D0%BF%D1%80%D0%B8%D0%B2%D0%B5%D1%82+%D0%B4%D1%80%D1%83%D0%B3=%D0%BA%D0%B0%D0%BA+%D0%B4%D0%B5%D0%BB%D0%B0%3F',
+      Iri.new('http://google/').add('привет друг' => 'как дела?').to_s
+    )
+  end
+
+  def test_removes_query_param
+    assert_equal(
+      'http://google/?b=2&c=3',
+      Iri.new('http://google/?a=1&b=2&c=3&a=3').del('a').del('x').to_s
+    )
+  end
+
+  def test_replaces_query_param
+    assert_equal(
+      'http://google/?a=hey&b=2&c=3',
+      Iri.new('http://google/?a=1&b=2&c=3&a=33').over(a: 'hey').to_s
+    )
+  end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: iri
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yegor Bugayenko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.11.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.11.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 12.3.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 12.3.1
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.3.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.62.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.62.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.31.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.31.0
+description: Simple Immutable Ruby URI Builder
+email: yegor256@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- ".0pdd.yml"
+- ".gitignore"
+- ".pdd"
+- ".rubocop.yml"
+- ".rultor.yml"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- appveyor.yml
+- iri.gemspec
+- lib/iri.rb
+- test/test_iri.rb
+homepage: http://github.com/yegor256/iri
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--charset=UTF-8"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 2
+summary: Simple Immutable Ruby URI Builder
+test_files:
+- test/test_iri.rb