link-header-parser 2.2.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: edd4ff4c4ffec2f5a5610c32c6814cd82fc1b6f33308648bac07e3444f5f007b
-  data.tar.gz: 2f533a163609ef49b0e8f44d3ddfe85c2450aedffd6da2ae971cee4b54a22d18
+  metadata.gz: 6b2127eef719541b0ed02c6cb37c7271ed1c1bac8358f5808fb50c08d5ccada3
+  data.tar.gz: 999fdc8ea6ad395fe72e88094ed4e924063844600b25df4df5822b2e85b6c2aa
 SHA512:
-  metadata.gz: 6bca6797af5591f2114b141a11aa7f1d1c80c61279fc79dedce4fcba6fa557777c3c2ae635e87012b4a3ce13e43d4ba42c506b274f8ddf6b6631b18e1c71b19d
-  data.tar.gz: db2871789cb01fdcd8b8e8e848320d0ff4c8444381f39a02fdbc24071caf2dce3fed31dc0106c53649c21f57a725348a5c4e1943e759c7be5d21e918a819f4da
+  metadata.gz: 90a5edd9b4ea7802818d84d858a365f365c6aee0cdcb9ec453feb5620ef7c6b2957da0063a8eaa2847318b69be5e668874a1bf4dc5b01cb36ff75cfd6190a33d
+  data.tar.gz: 676c81a374430b522d62d2cc569e149e4c18d5eead47db851cadc1fe509ff787d02b3ecdb823a1e70f8244a6f4d3fb8b122a18ca2dd4ea697eff6faa8c9e22a5

data/CHANGELOG.md

@@ -1,6 +1,14 @@
 # Changelog
 
-## 2.2.0 / 20201-04-02
+## 3.0.0 / 2021-05-22
+
+- Add implicit type conversion methods, alias explicit methods, and update specs (d132535)
+- Remove exceptions module (249d77c)
+- Use implicit conversions instead of type checking in methods (628c01b)
+- Replace Absolutely dependency with Addressable (beb5188)
+- Update project Ruby version to 2.5.9 (4a3941f)
+
+## 2.2.0 / 2021-04-02
 
 - Expand supported Ruby versions to include 3.0 (7187878)
 

data/CONTRIBUTING.md

@@ -8,9 +8,9 @@ There are a couple ways you can help improve link-header-parser-ruby:
 
 ## Getting Started
 
-link-header-parser-ruby is developed using Ruby 2.5.8 and is additionally tested against Ruby 2.6, 2.7, and 3.0 using [CircleCI](https://app.circleci.com/pipelines/github/jgarber623/link-header-parser-ruby).
+link-header-parser-ruby is developed using Ruby 2.5.9 and is additionally tested against Ruby 2.6, 2.7, and 3.0 using [CircleCI](https://app.circleci.com/pipelines/github/jgarber623/link-header-parser-ruby).
 
-Before making changes to link-header-parser-ruby, 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:
+Before making changes to link-header-parser-ruby, you'll want to install Ruby 2.5.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.5.9 using your method of choice, install the project's gems by running:
 
 ```sh
 bundle install

data/README.md

@@ -12,7 +12,7 @@
 
 Before installing and using link-header-parser-ruby, 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).
 
-link-header-parser-ruby is developed using Ruby 2.5.8 and is additionally tested against Ruby 2.6, 2.7, and 3.0 using [CircleCI](https://app.circleci.com/pipelines/github/jgarber623/link-header-parser-ruby).
+link-header-parser-ruby is developed using Ruby 2.5.9 and is additionally tested against Ruby 2.6, 2.7, and 3.0 using [CircleCI](https://app.circleci.com/pipelines/github/jgarber623/link-header-parser-ruby).
 
 ## Installation
 
@@ -42,13 +42,13 @@ response = HTTP.get('https://sixtwothree.org')
 
 link_headers = response.headers.get('link')
 
-collection = LinkHeaderParser.parse(link_headers, base: response.uri.to_s)
+collection = LinkHeaderParser.parse(link_headers, base: response.uri)
 ```
 
 The `parse` method accepts two arguments:
 
 1. an `Array` of strings representing HTTP Link headers (e.g. `['</>; rel="home"', '</chapters/1>; anchor="#copyright"; rel="license"']`)
-1. a `String` representing the absolute URL of the resource providing the HTTP Link headers
+1. a `String` (or any `String`-like object) representing the absolute URL of the resource providing the HTTP Link headers
 
 In the example above, `collection` is an instance of `LinkHeadersCollection` which includes Ruby's [`Enumerable`](https://ruby-doc.org/core/Enumerable.html) mixin. This mixin allows for use of common methods like `each`, `first`/`last`, and `map`.
 
@@ -137,7 +137,7 @@ link_header.relation_types
 link_header = LinkHeaderParser.parse('</posts.rss>; rel="alternate"; hreflang="en-US"; title="sixtwothree.org: Posts"; type="application/rss+xml"', base: 'https://sixtwothree.org').first
 
 link_header.link_parameters
-#=> [#<LinkHeaderParser::LinkHeaderParameter:0x3fdea54716ac name: "rel", value: "alternate">, #<LinkHeaderParser::LinkHeaderParameter:0x3fdea5471684 name: "hreflang", value: "en-US">, #<LinkHeaderParser::LinkHeaderParameter:0x3fdea5471670 name: "title", value: "sixtwothree.org: Posts">, #<LinkHeaderParser::LinkHeaderParameter:0x3fdea547165c name: "type", value: "application/rss+xml">]
+#=> [#<LinkHeaderParser::LinkHeaderParameter name: "rel", value: "alternate">, #<LinkHeaderParser::LinkHeaderParameter name: "hreflang", value: "en-US">, #<LinkHeaderParser::LinkHeaderParameter name: "title", value: "sixtwothree.org: Posts">, #<LinkHeaderParser::LinkHeaderParameter name: "type", value: "application/rss+xml">]
 ```
 
 Note that the `Array` returned by the `link_parameters` method may include multiple `LinkHeaderParameter`s with the same name depending on the provided Link header. Certain methods on `LinkHeader` will return values from the first occurrence of a parameter name (e.g. `link_header.relations_string`) in accordance with [RFC-8288](https://tools.ietf.org/html/rfc8288).

data/lib/link-header-parser.rb

@@ -1,9 +1,8 @@
 require 'forwardable'
 
-require 'absolutely'
+require 'addressable/uri'
 
 require 'link_header_parser/version'
-require 'link_header_parser/exceptions'
 
 require 'link_header_parser/link_header'
 require 'link_header_parser/link_header_parameter'

data/lib/link_header_parser/link_header.rb

@@ -11,11 +11,8 @@ module LinkHeaderParser
     # @param field_value [String]
     # @param base [String]
     def initialize(field_value, base:)
-      raise ArgumentError, "field_value must be a String (given #{field_value.class})" unless field_value.is_a?(String)
-      raise ArgumentError, "base must be a String (given #{base.class})" unless base.is_a?(String)
-
-      @field_value = field_value
-      @base = base
+      @field_value = field_value.to_str
+      @base = base.to_str
     end
 
     # The context URL for this Link header extracted from field_value (or target URL if no context URL is present)
@@ -31,7 +28,7 @@ module LinkHeaderParser
     #
     # @return [String]
     def context_uri
-      @context_uri ||= Absolutely.to_abs(base: target_uri, relative: context_string)
+      @context_uri ||= Addressable::URI.join(target_uri, context_string).normalize.to_s
     end
 
     def inspect
@@ -59,7 +56,7 @@ module LinkHeaderParser
     #
     # @return [String]
     def relations_string
-      @relations_string ||= grouped_link_parameters[:rel]&.first || ''
+      @relations_string ||= grouped_link_parameters[:rel]&.first.to_s
     end
 
     # The target URL for this Link header extracted from field_value
@@ -75,11 +72,11 @@ module LinkHeaderParser
     #
     # @return [String]
     def target_uri
-      @target_uri ||= Absolutely.to_abs(base: base, relative: target_string)
+      @target_uri ||= Addressable::URI.join(base, target_string).normalize.to_s
     end
 
     # @return [Hash{Symbol => String, Array, Hash{Symbol => Array}}]
-    def to_h
+    def to_hash
       {
         target_string: target_string,
         target_uri: target_uri,
@@ -91,6 +88,8 @@ module LinkHeaderParser
       }
     end
 
+    alias to_h to_hash
+
     private
 
     attr_reader :base

data/lib/link_header_parser/link_header_parameter.rb

@@ -6,7 +6,7 @@ module LinkHeaderParser
 
     # @param parameter [String]
     def initialize(parameter)
-      @parameter = parameter
+      @parameter = parameter.to_str
     end
 
     def inspect
@@ -22,16 +22,18 @@ module LinkHeaderParser
 
     # @see https://tools.ietf.org/html/rfc8288#appendix-B.3 (Appendix B.3.2.8)
     #
-    # @return [String, nil]
+    # @return [String]
     def value
-      @value ||= parameter_match_data[:value] || ''
+      @value ||= parameter_match_data[:value].to_s
     end
 
     # @return [Array<String>]
-    def to_a
+    def to_ary
       [name, value]
     end
 
+    alias to_a to_ary
+
     private
 
     def parameter_match_data

data/lib/link_header_parser/link_headers_collection.rb

@@ -11,10 +11,10 @@ module LinkHeaderParser
     # @param headers [Array<String>]
     # @param base [String]
     def initialize(*headers, base:)
-      @headers = headers.flatten
-      @base = base
+      @headers = headers.to_ary.flatten.map(&:to_str)
+      @base = base.to_str
 
-      discrete_headers.each { |header| push(LinkHeader.new(header, base: base)) }
+      distinct_headers.each { |header| push(LinkHeader.new(header, base: base)) }
     end
 
     # @return [Hash{Symbol => Array<LinkHeaderParser::LinkHeader>}]
@@ -37,8 +37,8 @@ module LinkHeaderParser
 
     attr_reader :base
 
-    def discrete_headers
-      @discrete_headers ||= headers.flat_map { |header| header.split(/,(?=[\s|<])/) }.map(&:strip)
+    def distinct_headers
+      @distinct_headers ||= headers.flat_map { |header| header.split(/,(?=[\s|<])/) }.map(&:strip)
     end
 
     def members

data/lib/link_header_parser/version.rb

@@ -1,3 +1,3 @@
 module LinkHeaderParser
-  VERSION = '2.2.0'.freeze
+  VERSION = '3.0.0'.freeze
 end

data/link-header-parser.gemspec

@@ -22,5 +22,5 @@ Gem::Specification.new do |spec|
   spec.metadata['bug_tracker_uri'] = "#{spec.homepage}/issues"
   spec.metadata['changelog_uri']   = "#{spec.homepage}/blob/v#{spec.version}/CHANGELOG.md"
 
-  spec.add_runtime_dependency 'absolutely', '~> 5.1'
+  spec.add_runtime_dependency 'addressable', '~> 2.7'
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: link-header-parser
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Jason Garber
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-02 00:00:00.000000000 Z
+date: 2021-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: absolutely
+  name: addressable
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '2.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '2.7'
 description: Parse HTTP Link headers.
 email:
 - jason@sixtwothree.org
@@ -36,7 +36,6 @@ files:
 - LICENSE
 - README.md
 - lib/link-header-parser.rb
-- lib/link_header_parser/exceptions.rb
 - lib/link_header_parser/link_header.rb
 - lib/link_header_parser/link_header_parameter.rb
 - lib/link_header_parser/link_headers_collection.rb
@@ -47,7 +46,7 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/jgarber623/link-header-parser-ruby/issues
-  changelog_uri: https://github.com/jgarber623/link-header-parser-ruby/blob/v2.2.0/CHANGELOG.md
+  changelog_uri: https://github.com/jgarber623/link-header-parser-ruby/blob/v3.0.0/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -66,7 +65,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.16
 signing_key:
 specification_version: 4
 summary: Parse HTTP Link headers.

data/lib/link_header_parser/exceptions.rb

@@ -1,5 +0,0 @@
-module LinkHeaderParser
-  class LinkHeaderParserError < StandardError; end
-
-  class ArgumentError < LinkHeaderParserError; end
-end