absolutely 2.1.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7795781f33ec7faa95aaf0613898d77b0b154bd32afd497a98e35bd2911557ac
-  data.tar.gz: aeccbc8532f4eb04ecc9ca3cf55f00a674de774bc6d4a19c00cf278f5d79d973
+  metadata.gz: e85663b997a813d8f8680809466945d0c729870a2b0a9bd4b75fc99e95967a36
+  data.tar.gz: 38a549966120f07d4e8b94662e63d299de7239b7c64050f6a37b37f92a465da2
 SHA512:
-  metadata.gz: 560912d16ae79115377345d95351304f019c501da26891e327fa7472e681aedd57441129865b9e851c25c2a1337bb6746b573fa035109437746e2bb4d6fdb00a
-  data.tar.gz: c65f10379621cc39973d34b39d58b76fc036d07fbc3aac346ac1d5b3d64732d2fe93c41e8b8a976e962d1f26d52b49d1e4569319cd47cafad45850b3f50e8836
+  metadata.gz: 44829bf2dd3b9cf289188fbf7e01a5ae97375289fc3cf62d148846af424fe18947f1e715039464483cc4f6100affc29f418ce70a3232ace3c7faf8f5260eb398
+  data.tar.gz: 76a06f5464f50388af6ed65290f124da3c6c13aa2c8f07d39a11d460753751c719e82ca22afddf08bd077bf03d1b9190bb6c9c533d1c0bfbc1d2b470d900218b

data/.reek.yml

@@ -1,9 +1,6 @@
 detectors:
   IrresponsibleModule:
     enabled: false
-  TooManyStatements:
-    exclude:
-      - Absolutely::URI#set_instance_vars
 
 exclude_paths:
   - vendor/

data/.rubocop.yml

@@ -2,23 +2,19 @@ require:
   - rubocop-performance
   - rubocop-rspec
 
-Layout/AlignHash:
-  EnforcedColonStyle: table
-  EnforcedHashRocketStyle: table
+AllCops:
+  NewCops: enable
+
+Layout/LineLength:
+  Enabled: false
 
 Metrics/BlockLength:
   Exclude:
     - spec/**/*.rb
 
-Metrics/LineLength:
-  Enabled: false
-
 Naming/RescuedExceptionsVariableName:
   PreferredName: exception
 
-Style/Alias:
-  EnforcedStyle: prefer_alias_method
-
 Style/Documentation:
   Enabled: false
 

data/.ruby-version

@@ -1 +1 @@
-2.4.6
+2.5.8

data/.simplecov

@@ -2,9 +2,11 @@ require 'simplecov-console'
 
 formatters = [SimpleCov::Formatter::HTMLFormatter]
 
+# rubocop:disable Style/IfUnlessModifier
 if RSpec.configuration.files_to_run.length > 1
   formatters << SimpleCov::Formatter::Console
 end
+# rubocop:enable Style/IfUnlessModifier
 
 SimpleCov.start do
   formatter SimpleCov::Formatter::MultiFormatter.new(formatters)

data/.travis.yml

@@ -1,13 +1,10 @@
+dist: bionic
 language: ruby
 rvm:
-  - 2.4.6
-  - 2.5.5
-  - 2.6.3
-cache:
-  - bundler
-before_install:
-  - gem update --system
-  - gem install bundler
+  - 2.5
+  - 2.6
+  - 2.7
+cache: bundler
 before_script:
   - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
   - chmod +x ./cc-test-reporter

data/CHANGELOG.md

@@ -1,32 +1,58 @@
 # Changelog
 
+## 5.0.0 / 2020-08-23
+
+- **Breaking change:** Update minimum supported Ruby version to 2.5 (866cec3)
+- Update project Ruby version to 2.5.8 (231653b)
+
+## 4.0.0 / 2020-05-13
+
+- **Breaking Change:** Remove alias from `to_absolute_uri` to `to_abs` (b4df234)
+- Improve inline documentation and refactor gem code (bb0456e)
+- Move development dependencies to Gemfile per current Bundler convention (3c2f579)
+- Update development Ruby version to 2.4.10 (6c79003)
+
+## 3.1.0 / 2020-01-20
+
+- Expand supported Ruby versions to include 2.7 (e0273b5)
+
+## 3.0.1 / 2019-08-31
+
+- Update Addressable gem (b257f75)
+- Update project Ruby version to 2.4.9 (a14d29b)
+- Update development dependencies
+
+## 3.0.0 / 2019-05-28
+
+- Return normalized `relative_uri` in `to_abs` when `relative_uri` is an absolute URL (81261e9)
+
 ## 2.1.0 / 2019-05-01
 
-- Rename `to_absolute_uri` method to `to_abs` ([d14e33f](https://github.com/jgarber623/absolutely/commit/d14e33f)).
-- Add `inspect` instance method to `Absolutely::URI` ([e4e7e5a](https://github.com/jgarber623/absolutely/commit/e4e7e5a)).
+- Rename `to_absolute_uri` method to `to_abs` (d14e33f)
+- Add `inspect` instance method to `Absolutely::URI` (e4e7e5a)
 
 ## 2.0.0 / 2019-04-25
 
-- The `URI` class' `base` and `relative` methods are now read-only ([7879f78](https://github.com/jgarber623/absolutely/commit/7879f78)).
-- Add Reek and configuration ([fb60f9c](https://github.com/jgarber623/absolutely/commit/fb60f9c)).
+- The `URI` class' `base` and `relative` methods are now read-only (7879f78)
+- Add Reek and configuration (fb60f9c)
 
 ## 1.1.2 / 2019-01-03
 
-- Expand supported Ruby versions to include 2.6 ([866d58a](https://github.com/jgarber623/absolutely/commit/866d58a)).
+- Expand supported Ruby versions to include 2.6 (866d58a)
 
 ## 1.1.1 / 2018-11-11
 
-- Liberalizes dependency constraints ([e0bc056](https://github.com/jgarber623/absolutely/commit/e0bc056)).
+- Liberalizes dependency constraints (e0bc056)
 
 ## 1.1.0 / 2018-07-05
 
-- Sets `base` URI's path to `/` if empty to conform with browser behavior ([b0f657a](https://github.com/jgarber623/absolutely/commit/b0f657a)).
-- Adds new tests from the [indieweb/php-mf2 URL test suite](https://github.com/indieweb/php-mf2/blob/master/tests/Mf2/URLTest.php) ([0b6417b](https://github.com/jgarber623/absolutely/commit/0b6417b)).
+- Sets `base` URI's path to `/` if empty to conform with browser behavior (b0f657a)
+- Adds new tests from the [indieweb/php-mf2 URL test suite](https://github.com/indieweb/php-mf2/blob/master/tests/Mf2/URLTest.php) (0b6417b)
 
 ## 1.0.0 / 2018-07-05
 
-- **Breaking Change:** Return value passed as `relative` if `relative` is to determined to be an absolute URI, regardless of the value passed as `base` ([e3996eb](https://github.com/jgarber623/absolutely/commit/e3996eb)).
-- Updates documentation to demonstrate new `relative` parameter behavior.
+- **Breaking Change:** Return value passed as `relative` if `relative` is to determined to be an absolute URI, regardless of the value passed as `base` (e3996eb)
+- Updates documentation to demonstrate new `relative` parameter behavior
 
 ## 0.1.0 / 2018-07-04
 

data/CONTRIBUTING.md

@@ -8,9 +8,9 @@ There are a couple ways you can help improve Absolutely:
 
 ## Getting Started
 
-Absolutely is developed using Ruby 2.4.6 and is additionally tested against Ruby 2.5.5 and 2.6.3 using [Travis CI](https://travis-ci.com/jgarber623/absolutely).
+Absolutely is developed using Ruby 2.5.8 and is additionally tested against Ruby 2.6 and 2.7 using [Travis CI](https://travis-ci.com/jgarber623/absolutely).
 
-Before making changes to Absolutely, you'll want to install Ruby 2.4.6. It's recommended that you use a Ruby version managment tool like [rbenv](https://github.com/rbenv/rbenv), [chruby](https://github.com/postmodern/chruby), or [rvm](https://github.com/rvm/rvm). Once you've installed Ruby 2.4.6 using your method of choice, install the project's gems by running:
+Before making changes to Absolutely, you'll want to install Ruby 2.5.8. It's recommended that you use a Ruby version managment tool like [rbenv](https://github.com/rbenv/rbenv), [chruby](https://github.com/postmodern/chruby), or [rvm](https://github.com/rvm/rvm). Once you've installed Ruby 2.5.8 using your method of choice, install the project's gems by running:
 
 ```sh
 bundle install

data/Gemfile

@@ -2,3 +2,13 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in absolutely.gemspec
 gemspec
+
+gem 'pry-byebug', '~> 3.9'
+gem 'rake', '~> 13.0'
+gem 'reek', '~> 6.0'
+gem 'rspec', '~> 3.9'
+gem 'rubocop', '~> 0.89.1'
+gem 'rubocop-performance', '~> 1.7'
+gem 'rubocop-rspec', '~> 1.43'
+gem 'simplecov', '~> 0.19.0'
+gem 'simplecov-console', '~> 0.7.2'

data/README.md

@@ -4,7 +4,7 @@
 
 [![Gem](https://img.shields.io/gem/v/absolutely.svg?style=for-the-badge)](https://rubygems.org/gems/absolutely)
 [![Downloads](https://img.shields.io/gem/dt/absolutely.svg?style=for-the-badge)](https://rubygems.org/gems/absolutely)
-[![Build](https://img.shields.io/travis/com/jgarber623/absolutely/master.svg?style=for-the-badge)](https://travis-ci.com/jgarber623/absolutely)
+[![Build](https://img.shields.io/travis/com/jgarber623/absolutely/main.svg?style=for-the-badge)](https://travis-ci.com/jgarber623/absolutely)
 [![Dependencies](https://img.shields.io/depfu/jgarber623/absolutely.svg?style=for-the-badge)](https://depfu.com/github/jgarber623/absolutely)
 [![Maintainability](https://img.shields.io/codeclimate/maintainability/jgarber623/absolutely.svg?style=for-the-badge)](https://codeclimate.com/github/jgarber623/absolutely)
 [![Coverage](https://img.shields.io/codeclimate/c/jgarber623/absolutely.svg?style=for-the-badge)](https://codeclimate.com/github/jgarber623/absolutely/code)
@@ -12,13 +12,13 @@
 ## Key Features
 
 - Uses the [Addressable](https://github.com/sporkmonger/addressable) Ruby gem for improved URI parsing.
-- Supports Ruby 2.4 and newer.
+- Supports Ruby 2.5 and newer.
 
 ## Getting Started
 
-Before installing and using Absolutely, you'll want to have [Ruby](https://www.ruby-lang.org) 2.4 (or newer) installed. It's recommended that you use a Ruby version managment tool like [rbenv](https://github.com/rbenv/rbenv), [chruby](https://github.com/postmodern/chruby), or [rvm](https://github.com/rvm/rvm).
+Before installing and using Absolutely, you'll want to have [Ruby](https://www.ruby-lang.org) 2.5 (or newer) installed. It's recommended that you use a Ruby version managment tool like [rbenv](https://github.com/rbenv/rbenv), [chruby](https://github.com/postmodern/chruby), or [rvm](https://github.com/rvm/rvm).
 
-Absolutely is developed using Ruby 2.4.6 and is additionally tested against Ruby 2.5.5 and 2.6.3 using [Travis CI](https://travis-ci.com/jgarber623/absolutely).
+Absolutely is developed using Ruby 2.5.8 and is additionally tested against Ruby 2.6 and 2.7 using [Travis CI](https://travis-ci.com/jgarber623/absolutely).
 
 ## Installation
 
@@ -67,7 +67,7 @@ Note that if the value passed as `relative` is determined to be an absolute URI,
 ```ruby
 require 'absolutely'
 
-uri = Absolute.to_abs(base: 'https://example.com', relative: 'https://example.com/foo')
+uri = Absolutely.to_abs(base: 'https://example.com', relative: 'https://example.com/foo')
 
 puts uri # => 'https://example.com/foo'
 ```
@@ -96,7 +96,7 @@ For convenience, the `base_uri` and `relative_uri` methods return instances of t
 
 ## Contributing
 
-Interested in helping improve Absolutely? Awesome! Your help is greatly appreciated. See [CONTRIBUTING.md](https://github.com/jgarber623/absolutely/blob/master/CONTRIBUTING.md) for details.
+Interested in helping improve Absolutely? Awesome! Your help is greatly appreciated. See [CONTRIBUTING.md](https://github.com/jgarber623/absolutely/blob/main/CONTRIBUTING.md) for details.
 
 ## Acknowledgments
 

data/Rakefile

@@ -6,6 +6,7 @@ require 'rubocop/rake_task'
 
 Reek::Rake::Task.new do |task|
   task.fail_on_error = false
+  task.source_files  = FileList['**/*.rb'].exclude('vendor/**/*.rb')
 end
 
 RSpec::Core::RakeTask.new

data/absolutely.gemspec

@@ -1,10 +1,7 @@
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-
-require 'absolutely/version'
+require_relative 'lib/absolutely/version'
 
 Gem::Specification.new do |spec|
-  spec.required_ruby_version = ['>= 2.4', '< 2.7']
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5', '< 2.8')
 
   spec.name          = 'absolutely'
   spec.version       = Absolutely::VERSION
@@ -16,23 +13,14 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/jgarber623/absolutely'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(bin|spec)/}) }
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(bin|spec)/}) }
+  end
 
   spec.require_paths = ['lib']
 
-  spec.metadata = {
-    'bug_tracker_uri' => "#{spec.homepage}/issues",
-    'changelog_uri'   => "#{spec.homepage}/blob/v#{spec.version}/CHANGELOG.md"
-  }
-
-  spec.add_development_dependency 'rake', '~> 12.3'
-  spec.add_development_dependency 'reek', '~> 5.4'
-  spec.add_development_dependency 'rspec', '~> 3.8'
-  spec.add_development_dependency 'rubocop', '~> 0.68.1'
-  spec.add_development_dependency 'rubocop-performance', '~> 1.1'
-  spec.add_development_dependency 'rubocop-rspec', '~> 1.32'
-  spec.add_development_dependency 'simplecov', '~> 0.16.1'
-  spec.add_development_dependency 'simplecov-console', '~> 0.4.2'
+  spec.metadata['bug_tracker_uri'] = "#{spec.homepage}/issues"
+  spec.metadata['changelog_uri']   = "#{spec.homepage}/blob/v#{spec.version}/CHANGELOG.md"
 
-  spec.add_runtime_dependency 'addressable', '~> 2.6'
+  spec.add_runtime_dependency 'addressable', '~> 2.7'
 end

data/lib/absolutely.rb

@@ -7,11 +7,29 @@ require 'absolutely/uri'
 
 module Absolutely
   class << self
+    # Convert a relative path to an absolute URI.
+    #
+    # @param base [String] an absolute URI used to resolve relative path
+    # @param relative [String] a relative path
+    # @return [String]
+    #
+    # @example
+    #   Absolutely.to_abs(base: 'https://example.com', relative: '/foo')
+    #   #=> "https://example.com/foo"
     def to_abs(base:, relative:)
       uri(base: base, relative: relative).to_abs
     end
-    alias_method :to_absolute_uri, :to_abs
 
+    # Create an Absolutely::URI from a base URI and a relative path.
+    #
+    # @param base [String] an absolute URI used to resolve relative path
+    # @param relative [String] a relative path
+    # @return [Absolutely::URI]
+    #
+    # @example
+    #   uri = Absolutely.uri(base: 'https://example.com', relative: '/foo')
+    #   puts uri.to_abs
+    #   #=> "https://example.com/foo"
     def uri(base:, relative:)
       URI.new(base: base, relative: relative)
     end

data/lib/absolutely/uri.rb

@@ -1,39 +1,57 @@
 module Absolutely
   class URI
-    attr_reader :base, :base_uri, :relative, :relative_uri
-
+    attr_reader :base, :relative
+
+    # Create an Absolutely::URI from a base URI and a relative path.
+    #
+    # @param base [String] an absolute URI used to resolve relative path
+    # @param relative [String] a relative path
+    # @raise [Absolutely::ArgumentError]
+    # @raise [Absolutely::InvalidURIError]
+    #
+    # @example
+    #   uri = Absolutely::URI.new(base: 'https://example.com', relative: '/foo')
+    #   puts uri.to_abs
+    #   #=> "https://example.com/foo"
     def initialize(base:, relative:)
       raise ArgumentError, "base must be a String (given #{base.class.name})" unless base.is_a?(String)
       raise ArgumentError, "relative must be a String (given #{relative.class.name})" unless relative.is_a?(String)
 
-      set_instance_vars(base, relative)
+      @base = base
+      @relative = relative
+
+      base_uri
+      relative_uri
 
       raise ArgumentError, 'base must be an absolute URL (e.g. https://example.com)' unless base_uri.absolute?
+    rescue Addressable::URI::InvalidURIError => exception
+      raise InvalidURIError, exception
+    end
+
+    # @return [Addressable::URI]
+    def base_uri
+      @base_uri ||= Addressable::URI.parse(base)
     end
 
+    # @return [String]
     def inspect
-      format("#<#{self.class.name}:%#0x>", object_id)
+      format("#<#{self.class.name}:%#0x base: #{base.inspect}, relative: #{relative.inspect}>", object_id)
+    end
+
+    # @return [Addressable::URI]
+    def relative_uri
+      @relative_uri ||= Addressable::URI.parse(relative)
     end
 
+    # Convert a relative path to an absolute URI.
+    #
+    # @return [String]
     def to_abs
-      return relative_uri.to_s if relative_uri.absolute?
+      return relative_uri.normalize.to_s if relative_uri.absolute?
 
       base_uri.path = base_uri.normalized_path
 
       (base_uri + relative_uri).to_s
     end
-    alias_method :to_absolute_uri, :to_abs
-
-    private
-
-    def set_instance_vars(base, relative)
-      @base = base
-      @relative = relative
-
-      @base_uri = Addressable::URI.parse(base)
-      @relative_uri = Addressable::URI.parse(relative)
-    rescue Addressable::URI::InvalidURIError => exception
-      raise InvalidURIError, exception
-    end
   end
 end

data/lib/absolutely/version.rb

@@ -1,3 +1,3 @@
 module Absolutely
-  VERSION = '2.1.0'.freeze
+  VERSION = '5.0.0'.freeze
 end

metadata

@@ -1,141 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: absolutely
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 5.0.0
 platform: ruby
 authors:
 - Jason Garber
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-02 00:00:00.000000000 Z
+date: 2020-08-24 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.3'
-- !ruby/object:Gem::Dependency
-  name: reek
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.4'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.8'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.8'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.68.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.68.1
-- !ruby/object:Gem::Dependency
-  name: rubocop-performance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.32'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.32'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.16.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.16.1
-- !ruby/object:Gem::Dependency
-  name: simplecov-console
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.4.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.4.2
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '2.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '2.7'
 description: Convert relative paths to absolute URIs.
 email:
 - jason@sixtwothree.org
@@ -168,7 +56,7 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/jgarber623/absolutely/issues
-  changelog_uri: https://github.com/jgarber623/absolutely/blob/v2.1.0/CHANGELOG.md
+  changelog_uri: https://github.com/jgarber623/absolutely/blob/v5.0.0/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -177,17 +65,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.5'
   - - "<"
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '2.8'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Convert relative paths to absolute URIs.