absolutely 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f16f86035665614b32d4fa91b9f87095c567bf62c4905bf08281f9dc06f9b00
-  data.tar.gz: affcb6d3a59693727e4354cea0d52ff7813332ddd006d1370ab15c8253cfebca
+  metadata.gz: 7795781f33ec7faa95aaf0613898d77b0b154bd32afd497a98e35bd2911557ac
+  data.tar.gz: aeccbc8532f4eb04ecc9ca3cf55f00a674de774bc6d4a19c00cf278f5d79d973
 SHA512:
-  metadata.gz: 43f2451ce53d29070180c5889fdfce3f31c542db7508c0a50d7f4e195deab3a58b14f6bb9b08fca8e6b7e739ff453849561deaded3b543b6b78ae83692a0f397
-  data.tar.gz: 14411e64c9ca529968c2333b90db9f306a119af0049e3e96ec3c7aee45a25633e57b37c1fd0a4bc3673dbf643f0655bfd62b81025518e010e997150adecb9a2d
+  metadata.gz: 560912d16ae79115377345d95351304f019c501da26891e327fa7472e681aedd57441129865b9e851c25c2a1337bb6746b573fa035109437746e2bb4d6fdb00a
+  data.tar.gz: c65f10379621cc39973d34b39d58b76fc036d07fbc3aac346ac1d5b3d64732d2fe93c41e8b8a976e962d1f26d52b49d1e4569319cd47cafad45850b3f50e8836

data/.reek.yml

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

data/.rubocop.yml

@@ -2,6 +2,10 @@ require:
   - rubocop-performance
   - rubocop-rspec
 
+Layout/AlignHash:
+  EnforcedColonStyle: table
+  EnforcedHashRocketStyle: table
+
 Metrics/BlockLength:
   Exclude:
     - spec/**/*.rb
@@ -12,6 +16,9 @@ Metrics/LineLength:
 Naming/RescuedExceptionsVariableName:
   PreferredName: exception
 
+Style/Alias:
+  EnforcedStyle: prefer_alias_method
+
 Style/Documentation:
   Enabled: false
 

data/.travis.yml

@@ -2,7 +2,7 @@ language: ruby
 rvm:
   - 2.4.6
   - 2.5.5
-  - 2.6.2
+  - 2.6.3
 cache:
   - bundler
 before_install:

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 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)).
+
 ## 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)).

data/CONTRIBUTING.md

@@ -8,7 +8,7 @@ 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.2 using [Travis CI](https://travis-ci.com/jgarber623/absolutely).
+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).
 
 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:
 

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.6 and is additionally tested against Ruby 2.5.5 and 2.6.2 using [Travis CI](https://travis-ci.com/jgarber623/absolutely).
+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).
 
 ## Installation
 
@@ -45,9 +45,9 @@ With Absolutely added to your project's `Gemfile` and installed, you may convert
 ```ruby
 require 'absolutely'
 
-uri = Absolutely.uri(base: 'https://example.com', relative: '/foo').to_absolute_uri
+uri = Absolutely.uri(base: 'https://example.com', relative: '/foo').to_abs
 
-puts uri # returns String: 'https://example.com/foo'
+puts uri # => String: 'https://example.com/foo'
 ```
 
 This example combines the supplied `base` value (`https://example.com`) and combines it with the supplied `relative` value (`/foo`), returning the string `https://example.com/foo`.
@@ -57,9 +57,9 @@ You may obtain the same results using this slightly shorter version:
 ```ruby
 require 'absolutely'
 
-uri = Absolutely.to_absolute_uri(base: 'https://example.com', relative: '/foo')
+uri = Absolutely.to_abs(base: 'https://example.com', relative: '/foo')
 
-puts uri # returns String: 'https://example.com/foo'
+puts uri # => 'https://example.com/foo'
 ```
 
 Note that if the value passed as `relative` is determined to be an absolute URI, Absolutely will return the value of `relative` regardless of the value passed as `base`:
@@ -67,9 +67,9 @@ Note that if the value passed as `relative` is determined to be an absolute URI,
 ```ruby
 require 'absolutely'
 
-uri = Absolute.to_absolute_uri(base: 'https://example.com', relative: 'https://example.com/foo')
+uri = Absolute.to_abs(base: 'https://example.com', relative: 'https://example.com/foo')
 
-puts uri # returns String: 'https://example.com/foo'
+puts uri # => 'https://example.com/foo'
 ```
 
 ### Advanced Usage
@@ -81,18 +81,18 @@ require 'absolutely'
 
 uri = Absolutely::URI.new(base: 'https://example.com', relative: '/foo')
 
-puts uri                 # returns Absolutely::URI
+puts uri              # => #<Absolutely::URI>
 
-puts uri.base            # returns String: 'https://example.com'
-puts uri.relative        # returns String: '/foo'
+puts uri.base         # => 'https://example.com'
+puts uri.relative     # => '/foo'
 
-puts uri.base_uri        # returns Addressable::URI
-puts uri.relative_uri    # returns Addressable::URI
+puts uri.base_uri     # => #<Addressable::URI URI:https://example.com>
+puts uri.relative_uri # => #<Addressable::URI URI:/foo>
 
-puts uri.to_absolute_uri # returns String: 'https://example.com/foo'
+puts uri.to_abs       # => 'https://example.com/foo'
 ```
 
-The `base_uri` and `relative_uri` methods return instances of `Addressable::URI` for convenience. For more on this class' available methods, see [the Addressable Ruby gem's source code](https://github.com/sporkmonger/addressable).
+For convenience, the `base_uri` and `relative_uri` methods return instances of the `Addressable::URI` class. For more on this class' available methods, see [the Addressable Ruby gem's source code](https://github.com/sporkmonger/addressable).
 
 ## Contributing
 

data/Rakefile

@@ -4,8 +4,14 @@ require 'reek/rake/task'
 require 'rspec/core/rake_task'
 require 'rubocop/rake_task'
 
-Reek::Rake::Task.new
+Reek::Rake::Task.new do |task|
+  task.fail_on_error = false
+end
+
 RSpec::Core::RakeTask.new
-RuboCop::RakeTask.new
+
+RuboCop::RakeTask.new do |task|
+  task.fail_on_error = false
+end
 
 task default: [:rubocop, :reek, :spec]

data/absolutely.gemspec

@@ -20,10 +20,15 @@ Gem::Specification.new do |spec|
 
   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.67.2'
+  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'

data/lib/absolutely.rb

@@ -7,9 +7,10 @@ require 'absolutely/uri'
 
 module Absolutely
   class << self
-    def to_absolute_uri(base:, relative:)
-      uri(base: base, relative: relative).to_absolute_uri
+    def to_abs(base:, relative:)
+      uri(base: base, relative: relative).to_abs
     end
+    alias_method :to_absolute_uri, :to_abs
 
     def uri(base:, relative:)
       URI.new(base: base, relative: relative)

data/lib/absolutely/exceptions.rb

@@ -1,7 +1,7 @@
 module Absolutely
-  class Error < StandardError; end
+  class AbsolutelyError < StandardError; end
 
-  class ArgumentError < Error; end
+  class ArgumentError < AbsolutelyError; end
 
-  class InvalidURIError < Error; end
+  class InvalidURIError < AbsolutelyError; end
 end

data/lib/absolutely/uri.rb

@@ -1,36 +1,39 @@
 module Absolutely
   class URI
-    attr_reader :base, :relative
+    attr_reader :base, :base_uri, :relative, :relative_uri
 
     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)
 
-      @base = base
-      @relative = relative
-
-      base_uri
-      relative_uri
-
-      raise ArgumentError, 'base must be an absolute URI (e.g. https://example.com)' unless base_uri.absolute?
-    rescue Addressable::URI::InvalidURIError => exception
-      raise InvalidURIError, exception
-    end
+      set_instance_vars(base, relative)
 
-    def base_uri
-      @base_uri ||= Addressable::URI.parse(base)
+      raise ArgumentError, 'base must be an absolute URL (e.g. https://example.com)' unless base_uri.absolute?
     end
 
-    def relative_uri
-      @relative_uri ||= Addressable::URI.parse(relative)
+    def inspect
+      format("#<#{self.class.name}:%#0x>", object_id)
     end
 
-    def to_absolute_uri
+    def to_abs
       return relative_uri.to_s if relative_uri.absolute?
 
-      base_uri.path = '/' if base_uri.path.empty?
+      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.0.0'.freeze
+  VERSION = '2.1.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: absolutely
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Jason Garber
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-26 00:00:00.000000000 Z
+date: 2019-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.67.2
+        version: 0.68.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.67.2
+        version: 0.68.1
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -166,7 +166,9 @@ files:
 homepage: https://github.com/jgarber623/absolutely
 licenses:
 - MIT
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/jgarber623/absolutely/issues
+  changelog_uri: https://github.com/jgarber623/absolutely/blob/v2.1.0/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths: