absolutely 3.1.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23de4e0e0d12b6a0d1f432cb8bbe82e9a8edd0228e4b012492e128c3538a12da
-  data.tar.gz: 1d75fec77e7ae6a8410cfcce593dbe00182740d7878a1ea3cf846221b30cf01d
+  metadata.gz: 5371bb5e8e56ff6966a5b629cbb908693030acc7c6c2e091a5e378a42fe3c161
+  data.tar.gz: 06ddd29f3b17b975f6d6e5f0456a0d6b4f17e5aa6fe21ce24eaac19623007d00
 SHA512:
-  metadata.gz: 9346f4f872d8866dfe6e3dca84d253feb7e245ce5a402e2bc17a42c85be85ff981143a5ec9f72399e705f203876f54494a33f4dd81c1aafeff9a8f366edde9d2
-  data.tar.gz: eb494b638a2f0f1f4a4dd0de0346829a7ef2a65a8211dd564dba34b5b9789e202830b1c3dc703f6a1b9a83e3265d7a13a3da3c28941dfdf9f86528133ffe4d41
+  metadata.gz: 26db5cebaef7246e5390bafbe7006a125ad932dfe402a4cd24ee527625da111b34a4c012d412e31284c3c9ceeceacec32cc60056296c0fb5073e2e912f51425d
+  data.tar.gz: 5ab65c11499651640bd49d259082dc8307b2626c07b47271252d490e910113f5acab0de21067031d6eaea3cce0d938d38192fdea4a8f0e69bb2ee73adb656bb8

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,9 +2,8 @@ require:
   - rubocop-performance
   - rubocop-rspec
 
-Layout/HashAlignment:
-  EnforcedColonStyle: table
-  EnforcedHashRocketStyle: table
+AllCops:
+  NewCops: enable
 
 Layout/LineLength:
   Enabled: false
@@ -16,9 +15,6 @@ Metrics/BlockLength:
 Naming/RescuedExceptionsVariableName:
   PreferredName: exception
 
-Style/Alias:
-  EnforcedStyle: prefer_alias_method
-
 Style/Documentation:
   Enabled: false
 

data/.ruby-version

@@ -1 +1 @@
-2.4.9
+2.4.10

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/CHANGELOG.md

@@ -1,46 +1,53 @@
 # Changelog
 
+## 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](https://github.com/jgarber623/absolutely/commit/e0273b5)).
+- Expand supported Ruby versions to include 2.7 (e0273b5)
 
 ## 3.0.1 / 2019-08-31
 
-- Update Addressable gem ([b257f75](https://github.com/jgarber623/absolutely/commit/b257f75)).
-- Update project Ruby version to 2.4.9 ([a14d29b](https://github.com/jgarber623/absolutely/commit/a14d29b)).
-- Update development dependencies.
+- 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](https://github.com/jgarber623/absolutely/commit/81261e9)).
+- 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.9 and is additionally tested against Ruby 2.5, 2.6, and 2.7 using [Travis CI](https://travis-ci.com/jgarber623/absolutely).
+Absolutely is developed using Ruby 2.4.10 and is additionally tested against Ruby 2.5, 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.9. 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.9 using your method of choice, install the project's gems by running:
+Before making changes to Absolutely, you'll want to install Ruby 2.4.10. 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.10 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.83.0'
+gem 'rubocop-performance', '~> 1.5'
+gem 'rubocop-rspec', '~> 1.39'
+gem 'simplecov', '~> 0.18.5'
+gem 'simplecov-console', '~> 0.7.2'

data/README.md

@@ -18,7 +18,7 @@
 
 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).
 
-Absolutely is developed using Ruby 2.4.9 and is additionally tested against Ruby 2.5, 2.6, and 2.7 using [Travis CI](https://travis-ci.com/jgarber623/absolutely).
+Absolutely is developed using Ruby 2.4.10 and is additionally tested against Ruby 2.5, 2.6, and 2.7 using [Travis CI](https://travis-ci.com/jgarber623/absolutely).
 
 ## Installation
 

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.8']
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.4', '< 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', '~> 13.0'
-  spec.add_development_dependency 'reek', '~> 5.6'
-  spec.add_development_dependency 'rspec', '~> 3.9'
-  spec.add_development_dependency 'rubocop', '~> 0.79.0'
-  spec.add_development_dependency 'rubocop-performance', '~> 1.5'
-  spec.add_development_dependency 'rubocop-rspec', '~> 1.37'
-  spec.add_development_dependency 'simplecov', '~> 0.17.1'
-  spec.add_development_dependency 'simplecov-console', '~> 0.6.0'
+  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.7'
 end

data/lib/absolutely.rb

@@ -7,11 +7,28 @@ require 'absolutely/uri'
 
 module Absolutely
   class << self
+    # Convert a relative path to an absolute URI.
+    #
+    # @param base [String]
+    # @param relative [String]
+    # @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]
+    # @param relative [String]
+    # @return [Absolutely::URI]
+    #
+    #   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,20 +1,51 @@
 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]
+    # @param relative [String]
+    # @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.normalize.to_s if relative_uri.absolute?
 
@@ -22,18 +53,5 @@ module Absolutely
 
       (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 = '3.1.0'.freeze
+  VERSION = '4.0.0'.freeze
 end

metadata

@@ -1,127 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: absolutely
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Jason Garber
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-20 00:00:00.000000000 Z
+date: 2020-05-13 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: reek
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.6'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.9'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.79.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.79.0
-- !ruby/object:Gem::Dependency
-  name: rubocop-performance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.37'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.37'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.17.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.17.1
-- !ruby/object:Gem::Dependency
-  name: simplecov-console
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.6.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
@@ -168,7 +56,7 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/jgarber623/absolutely/issues
-  changelog_uri: https://github.com/jgarber623/absolutely/blob/v3.1.0/CHANGELOG.md
+  changelog_uri: https://github.com/jgarber623/absolutely/blob/v4.0.0/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -187,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.3
 signing_key: 
 specification_version: 4
 summary: Convert relative paths to absolute URIs.