link-header-parser 0.3.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 187d1cdf4fa37bf3e55485c6a11d47d9404365f2feee404b620fad075705797e
-  data.tar.gz: 2ddf7984a6a38a812db8b1919fb584cba18a7a05a6838158e3ddc7720af898d2
+  metadata.gz: 6b2127eef719541b0ed02c6cb37c7271ed1c1bac8358f5808fb50c08d5ccada3
+  data.tar.gz: 999fdc8ea6ad395fe72e88094ed4e924063844600b25df4df5822b2e85b6c2aa
 SHA512:
-  metadata.gz: fc4f9ba8a55df2e8bc85e442fcb68f6867bec872bef9db167ee4bb9c319a98de5bc5070d5f2fb1c3a2e7ea70d16c399fb70302655a62bc1e7d121bd812c5ce66
-  data.tar.gz: 154ec370bd83b135bd42c3c0925863300057308b4338b219697035d784b025f07f1654a43f89452491efc6c840dcc7165dc457a3882381c4e4159875801640be
+  metadata.gz: 90a5edd9b4ea7802818d84d858a365f365c6aee0cdcb9ec453feb5620ef7c6b2957da0063a8eaa2847318b69be5e668874a1bf4dc5b01cb36ff75cfd6190a33d
+  data.tar.gz: 676c81a374430b522d62d2cc569e149e4c18d5eead47db851cadc1fe509ff787d02b3ecdb823a1e70f8244a6f4d3fb8b122a18ca2dd4ea697eff6faa8c9e22a5

data/CHANGELOG.md

@@ -1,12 +1,43 @@
 # Changelog
 
+## 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)
+
+## 2.1.0 / 2020-10-07
+
+- Update Absolutely dependency to 5.0 (62988c0)
+
+## 2.0.0 / 2020-05-21
+
+- **Breaking changes:** Rewrite gem code (5351010)
+	- `LinkHeaderParser.parse` returns `LinkHeadersCollection`
+	- New classes: `LinkHeadersCollection`, `LinkHeader`, and `LinkHeaderParameter`
+	- Renamed collection's `by_relation_type` method to `group_by_relation_type`
+- **Breaking change:** Update project Ruby version to 2.5.8 and minimum Ruby version to 2.5 (05b2e82)
+- Update inline documentation and refactor `ParsedHeader` and `ParsedHeaderCollection` classes (31ec43e)
+
+## 1.0.0 / 2020-05-14
+
+- Update Absolutely dependency to 4.0 (4b78347)
+- Update development Ruby version to 2.4.10 (8d26096)
+- Move development dependencies to `Gemfile` (3f6b5dd)
+
 ## 0.3.0 / 2020-01-20
 
-- Expand supported Ruby versions to include 2.7 ([c55624a](https://github.com/jgarber623/link-header-parser-ruby/commit/c55624a)).
+- Expand supported Ruby versions to include 2.7 (c55624a)
 
 ## 0.2.0 / 2019-07-02
 
-- Add support for the `anchor` parameter to `ParsedHeader` exposed via `context` and `context_uri` methods ([d2dff52](https://github.com/jgarber623/link-header-parser-ruby/commit/d2dff52)).
+- Add support for the `anchor` parameter to `ParsedHeader` exposed via `context` and `context_uri` methods (d2dff52)
 
 ## 0.1.0 / 2019-06-06
 

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.4.9 and is additionally tested against Ruby 2.5, 2.6, and 2.7 using [Travis CI](https://travis-ci.com/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.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 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
@@ -22,7 +22,7 @@ bundle install
 1. Install development dependencies as outlined above.
 1. Create a feature branch for the code changes you're looking to make: `git checkout -b my-new-feature`.
 1. _Write some code!_
-1. If your changes would benefit from testing, add the necessary tests and verify everything passes by running `bundle exec rspec`.
+1. If your changes would benefit from testing, add the necessary tests and verify everything passes by running `bin/ci`.
 1. Commit your changes: `git commit -am 'Add some new feature or fix some issue'`. _(See [this excellent article](https://chris.beams.io/posts/git-commit/) for tips on writing useful Git commit messages.)_
 1. Push the branch to your fork: `git push -u origin my-new-feature`.
 1. Create a new [pull request][pulls] and we'll review your changes.

data/README.md

@@ -2,18 +2,17 @@
 
 **A Ruby gem for parsing HTTP Link headers.**
 
-[![Gem](https://img.shields.io/gem/v/link-header-parser.svg?style=for-the-badge)](https://rubygems.org/gems/link-header-parser)
-[![Downloads](https://img.shields.io/gem/dt/link-header-parser.svg?style=for-the-badge)](https://rubygems.org/gems/link-header-parser)
-[![Build](https://img.shields.io/travis/com/jgarber623/link-header-parser-ruby/master.svg?style=for-the-badge)](https://travis-ci.com/jgarber623/link-header-parser-ruby)
-[![Dependencies](https://img.shields.io/depfu/jgarber623/link-header-parser-ruby.svg?style=for-the-badge)](https://depfu.com/github/jgarber623/link-header-parser-ruby)
-[![Maintainability](https://img.shields.io/codeclimate/maintainability/jgarber623/link-header-parser-ruby.svg?style=for-the-badge)](https://codeclimate.com/github/jgarber623/link-header-parser-ruby)
-[![Coverage](https://img.shields.io/codeclimate/c/jgarber623/link-header-parser-ruby.svg?style=for-the-badge)](https://codeclimate.com/github/jgarber623/link-header-parser-ruby/code)
+[![Gem](https://img.shields.io/gem/v/link-header-parser.svg?logo=rubygems&style=for-the-badge)](https://rubygems.org/gems/link-header-parser)
+[![Downloads](https://img.shields.io/gem/dt/link-header-parser.svg?logo=rubygems&style=for-the-badge)](https://rubygems.org/gems/link-header-parser)
+[![Build](https://img.shields.io/circleci/build/github/jgarber623/link-header-parser-ruby?logo=circleci&style=for-the-badge)](https://app.circleci.com/pipelines/github/jgarber623/link-header-parser-ruby)
+[![Maintainability](https://img.shields.io/codeclimate/maintainability/jgarber623/link-header-parser-ruby.svg?logo=code-climate&style=for-the-badge)](https://codeclimate.com/github/jgarber623/link-header-parser-ruby)
+[![Coverage](https://img.shields.io/codeclimate/c/jgarber623/link-header-parser-ruby.svg?logo=code-climate&style=for-the-badge)](https://codeclimate.com/github/jgarber623/link-header-parser-ruby/code)
 
 ## Getting Started
 
-Before installing and using link-header-parser-ruby, 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 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.4.9 and is additionally tested against Ruby 2.5, 2.6, and 2.7 using [Travis CI](https://travis-ci.com/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
 
@@ -43,90 +42,109 @@ 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 `ParsedHeaderCollection` 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`.
+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`.
 
 For example, you could retrieve an array of `target_uri`s:
 
 ```ruby
-puts collection.map(&:target_uri) # => ["https://assets.sixtwothree.org/", "https://fonts.googleapis.com/", "https://fonts.gstatic.com/", "https://sixtwothree.org/webmentions"]
+puts collection.map(&:target_uri)
+#=> ["https://assets.sixtwothree.org/", "https://fonts.googleapis.com/", "https://fonts.gstatic.com/", "https://sixtwothree.org/webmentions"]
 ```
 
-### Working with a `ParsedHeaderCollection`
+### Working with a `LinkHeadersCollection`
 
-In addition to the included `Enumerable` methods, the following methods may be used to interact with a `ParsedHeaderCollection`:
+In addition to the included `Enumerable` methods, the following methods may be used to interact with a `LinkHeadersCollection`:
 
 #### The `relation_types` Method
 
 ```ruby
-puts collection.relation_types # => ["preconnect", "webmention"]
+puts collection.relation_types
+#=> ["preconnect", "webmention"]
 ```
 
-#### The `by_relation_type` Method
+#### The `group_by_relation_type` Method
 
-Using the `collection` from above, the `by_relation_type` method returns an `OpenStruct` with the following attributes:
+Using the `collection` from above, the `group_by_relation_type` method returns a `Hash`:
 
 ```ruby
 {
   preconnect: [
-    #<LinkHeaderParser::ParsedHeader @header="<https://assets.sixtwothree.org/>; rel=\"preconnect\"">,
-    #<LinkHeaderParser::ParsedHeader @header="<https://fonts.googleapis.com/>; rel=\"preconnect\"">,
-    #<LinkHeaderParser::ParsedHeader @header="<https://fonts.gstatic.com/>; rel=\"preconnect\"">
+    #<LinkHeaderParser::LinkHeader target_uri: "https://assets.sixtwothree.org/", relation_types: ["preconnect"]>,
+    #<LinkHeaderParser::LinkHeader target_uri: "https://fonts.googleapis.com/", relation_types: ["preconnect"]>,
+    #<LinkHeaderParser::LinkHeader target_uri: "https://fonts.gstatic.com/", relation_types: ["preconnect"]>
   ],
   webmention: [
-    #<LinkHeaderParser::ParsedHeader @header="<https://sixtwothree.org/webmentions>; rel=\"webmention\"">
+    #<LinkHeaderParser::LinkHeader target_uri: "https://sixtwothree.org/webmentions", relation_types: ["webmention"]>
   ]
 }
 ```
 
-### Working with a `ParsedHeader`
+### Working with a `LinkHeader`
 
-You may interact with one or more `ParsedHeader`s in a `ParsedHeaderCollection` using the methods outlined below. The naming conventions for these methods draws heavily on the terminology established in [RFC-5988](https://tools.ietf.org/html/rfc5988) and [RFC-8288](https://tools.ietf.org/html/rfc8288).
+You may interact with one or more `LinkHeader`s in a `LinkHeadersCollection` using the methods outlined below. The naming conventions for these methods draws heavily on the terminology established in [RFC-5988](https://tools.ietf.org/html/rfc5988) and [RFC-8288](https://tools.ietf.org/html/rfc8288).
 
 #### Link Target ([§ 3.1](https://tools.ietf.org/html/rfc8288#section-3.1))
 
 ```ruby
-link_headers = ['</index.html>; rel="home"']
-parsed_header = LinkHeaderParser.parse(link_headers, base: 'https://example.com/').first
+link_header = LinkHeaderParser.parse('</index.html>; rel="home"', base: 'https://example.com/').first
 
-parsed_header.target     # => '/index.html'
-parsed_header.target_uri # => 'https://example.com/index.html'
+link_header.target_string
+#=> "/index.html"
+
+link_header.target_uri
+#=> "https://example.com/index.html"
 ```
 
-The `target` method returns a string of the value between the opening and closing angle brackets at the beginning of the Link header. The `target_uri` method returns a string representing the resolved URL.
+The `target_string` method returns a string of the value between the opening and closing angle brackets at the beginning of the Link header. The `target_uri` method returns a string representing the resolved URL.
 
 #### Link Context ([§ 3.2](https://tools.ietf.org/html/rfc8288#section-3.2))
 
 ```ruby
-link_headers = ['<https://example.com/chapters/1>; anchor="#copyright"; rel="license"']
-parsed_header = LinkHeaderParser.parse(link_headers, base: 'https://example.com/').first
+link_header = LinkHeaderParser.parse('</chapters/1>; anchor="#copyright"; rel="license"', base: 'https://example.com/').first
+
+link_header.context_string
+#=> "#copyright"
 
-parsed_header.context     # => '#copyright'
-parsed_header.context_uri # => 'https://example.com/chapters/1#copyright'
+link_header.context_uri
+#=> "https://example.com/chapters/1#copyright"
 ```
 
-The `anchor` parameter's value may be a fragment identifier (e.g. `#foo`), a relative URL (e.g. `/foo`), or an absolute URL (e.g. `https://context.example.com`). The `context` method returns the `anchor` parameter's value (when present) and defaults to the `target` value.
+The `anchor` parameter's value may be a fragment identifier (e.g. `#foo`), a relative URL (e.g. `/foo`), or an absolute URL (e.g. `https://context.example.com`). The `context_string` method returns the `anchor` parameter's value (when present) and defaults to the `target_string` value. The `context_uri` method returns a string representing the resolved URL.
 
 #### Relation Type ([§ 3.3](https://tools.ietf.org/html/rfc8288#section-3.3))
 
 ```ruby
-link_headers = ['<https://example.com/chapters/1>; rel="prev start"']
-parsed_header = LinkHeaderParser.parse(link_headers, base: 'https://example.com/').first
+link_header = LinkHeaderParser.parse('</chapters/1>; rel="prev start"', base: 'https://example.com/').first
+
+link_header.relations_string
+#=> "prev start"
 
-parsed_header.relations      # => 'prev start'
-parsed_header.relation_types # => ['prev', 'start']
+link_header.relation_types
+#=> ["prev", "start"]
 ```
 
+#### Link Parameters ([Appendix B.3](https://tools.ietf.org/html/rfc8288#appendix-B.3))
+
+```ruby
+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 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).
+
 ## Contributing
 
-Interested in helping improve link-header-parser-ruby? Awesome! Your help is greatly appreciated. See [CONTRIBUTING.md](https://github.com/jgarber623/link-header-parser-ruby/blob/master/CONTRIBUTING.md) for details.
+Interested in helping improve link-header-parser-ruby? Awesome! Your help is greatly appreciated. See [CONTRIBUTING.md](https://github.com/jgarber623/link-header-parser-ruby/blob/main/CONTRIBUTING.md) for details.
 
 ## Acknowledgments
 

data/lib/link-header-parser.rb

@@ -1,17 +1,20 @@
-require 'ostruct'
+require 'forwardable'
 
-require 'absolutely'
+require 'addressable/uri'
 
 require 'link_header_parser/version'
-require 'link_header_parser/exceptions'
 
-require 'link_header_parser/parsed_header'
-require 'link_header_parser/parsed_header_collection'
+require 'link_header_parser/link_header'
+require 'link_header_parser/link_header_parameter'
+require 'link_header_parser/link_headers_collection'
 
 module LinkHeaderParser
-  class << self
-    def parse(*headers, base:)
-      ParsedHeaderCollection.new(headers, base: base)
-    end
+  # Parse an array of HTTP Link headers
+  #
+  # @param headers [Array<String>]
+  # @param base [String]
+  # @return [LinkHeaderParser::LinkHeadersCollection]
+  def self.parse(*headers, base:)
+    LinkHeadersCollection.new(*headers, base: base)
   end
 end

data/lib/link_header_parser/link_header.rb

@@ -0,0 +1,105 @@
+module LinkHeaderParser
+  class LinkHeader
+    FIELD_VALUE_REGEXP_PATTERN = /^\s*<\s*(?<target_string>[^>]+)\s*>\s*(?<parameters>;\s*.*)$/.freeze
+    PARAMETERS_REGEXP_PATTERN = /(?<!;)\s*([^;]+)/.freeze
+
+    attr_reader :field_value
+
+    # Create a new parsed Link header
+    # @see https://tools.ietf.org/html/rfc8288#appendix-B.2
+    #
+    # @param field_value [String]
+    # @param base [String]
+    def initialize(field_value, 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)
+    # @see https://tools.ietf.org/html/rfc8288#appendix-B.2 (Appendix B.2.2.11)
+    #
+    # @return [String]
+    def context_string
+      @context_string ||= grouped_link_parameters[:anchor]&.first || target_string
+    end
+
+    # The resolved context URL for this Link header
+    # @see https://tools.ietf.org/html/rfc8288#appendix-B.2 (Appendix B.2.2.12)
+    #
+    # @return [String]
+    def context_uri
+      @context_uri ||= Addressable::URI.join(target_uri, context_string).normalize.to_s
+    end
+
+    def inspect
+      format(%(#<#{self.class.name}:%#0x target_uri: #{target_uri.inspect}, relation_types: #{relation_types.inspect}>), object_id)
+    end
+
+    # The parsed parameters for this Link header extracted from field_value
+    # @see https://tools.ietf.org/html/rfc8288#appendix-B.3
+    #
+    # @return [Array<LinkHeaderParser::LinkHeaderParameter>]
+    def link_parameters
+      @link_parameters ||= field_value_match_data[:parameters].scan(PARAMETERS_REGEXP_PATTERN).flatten.map { |parameter| LinkHeaderParameter.new(parameter) }
+    end
+
+    # The relations_string value returned as an Array
+    # @see https://tools.ietf.org/html/rfc8288#appendix-B.2 (Appendix B.2.2.10 and Appendix B.2.2.17.1)
+    #
+    # @return [Array<String>]
+    def relation_types
+      @relation_types ||= relations_string.split.map(&:downcase)
+    end
+
+    # The relation types for this Link header extracted from field_value
+    # @see https://tools.ietf.org/html/rfc8288#appendix-B.2 (Appendix B.2.2.9)
+    #
+    # @return [String]
+    def relations_string
+      @relations_string ||= grouped_link_parameters[:rel]&.first.to_s
+    end
+
+    # The target URL for this Link header extracted from field_value
+    # @see https://tools.ietf.org/html/rfc8288#appendix-B.2 (Appendix B.2.2.4)
+    #
+    # @return [String]
+    def target_string
+      @target_string ||= field_value_match_data[:target_string]
+    end
+
+    # The resolved target URL for this Link header
+    # @see https://tools.ietf.org/html/rfc8288#appendix-B.2 (Appendix B.2.2.8)
+    #
+    # @return [String]
+    def target_uri
+      @target_uri ||= Addressable::URI.join(base, target_string).normalize.to_s
+    end
+
+    # @return [Hash{Symbol => String, Array, Hash{Symbol => Array}}]
+    def to_hash
+      {
+        target_string: target_string,
+        target_uri: target_uri,
+        context_string: context_string,
+        context_uri: context_uri,
+        relations_string: relations_string,
+        relation_types: relation_types,
+        link_parameters: grouped_link_parameters
+      }
+    end
+
+    alias to_h to_hash
+
+    private
+
+    attr_reader :base
+
+    def field_value_match_data
+      @field_value_match_data ||= field_value.match(FIELD_VALUE_REGEXP_PATTERN)
+    end
+
+    def grouped_link_parameters
+      @grouped_link_parameters ||= link_parameters.map(&:to_a).group_by(&:shift).transform_keys(&:to_sym).transform_values(&:flatten)
+    end
+  end
+end

data/lib/link_header_parser/link_header_parameter.rb

@@ -0,0 +1,43 @@
+module LinkHeaderParser
+  class LinkHeaderParameter
+    PARAMETER_REGEXP_PATTERN = /^(?<name>.+?)(?:="?(?<value>.*?)"?)?$/.freeze
+
+    attr_reader :parameter
+
+    # @param parameter [String]
+    def initialize(parameter)
+      @parameter = parameter.to_str
+    end
+
+    def inspect
+      format(%(#<#{self.class.name}:%#0x name: #{name.inspect}, value: #{value.inspect}>), object_id)
+    end
+
+    # @see https://tools.ietf.org/html/rfc8288#appendix-B.3 (Appendix B.3.2.9)
+    #
+    # @return [String]
+    def name
+      @name ||= parameter_match_data[:name].downcase
+    end
+
+    # @see https://tools.ietf.org/html/rfc8288#appendix-B.3 (Appendix B.3.2.8)
+    #
+    # @return [String]
+    def value
+      @value ||= parameter_match_data[:value].to_s
+    end
+
+    # @return [Array<String>]
+    def to_ary
+      [name, value]
+    end
+
+    alias to_a to_ary
+
+    private
+
+    def parameter_match_data
+      @parameter_match_data ||= parameter.match(PARAMETER_REGEXP_PATTERN)
+    end
+  end
+end

data/lib/link_header_parser/link_headers_collection.rb

@@ -0,0 +1,48 @@
+module LinkHeaderParser
+  class LinkHeadersCollection
+    extend Forwardable
+
+    include Enumerable
+
+    def_delegators :members, :[], :<<, :each, :last, :length, :push
+
+    attr_reader :headers
+
+    # @param headers [Array<String>]
+    # @param base [String]
+    def initialize(*headers, base:)
+      @headers = headers.to_ary.flatten.map(&:to_str)
+      @base = base.to_str
+
+      distinct_headers.each { |header| push(LinkHeader.new(header, base: base)) }
+    end
+
+    # @return [Hash{Symbol => Array<LinkHeaderParser::LinkHeader>}]
+    def group_by_relation_type
+      relation_types.map do |relation_type|
+        [relation_type, find_all { |member| member.relation_types.include?(relation_type) }]
+      end.to_h.transform_keys(&:to_sym)
+    end
+
+    def inspect
+      format(%(#<#{self.class.name}:%#0x headers: #{headers.inspect}, relation_types: #{relation_types.inspect}>), object_id)
+    end
+
+    # @return [Array<String>]
+    def relation_types
+      @relation_types ||= flat_map(&:relation_types).uniq.sort
+    end
+
+    private
+
+    attr_reader :base
+
+    def distinct_headers
+      @distinct_headers ||= headers.flat_map { |header| header.split(/,(?=[\s|<])/) }.map(&:strip)
+    end
+
+    def members
+      @members ||= []
+    end
+  end
+end

data/lib/link_header_parser/version.rb

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

data/link-header-parser.gemspec

@@ -1,10 +1,7 @@
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-
-require 'link_header_parser/version'
+require_relative 'lib/link_header_parser/version'
 
 Gem::Specification.new do |spec|
-  spec.required_ruby_version = ['>= 2.4', '< 2.8']
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5', '< 4')
 
   spec.name          = 'link-header-parser'
   spec.version       = LinkHeaderParser::VERSION
@@ -16,23 +13,14 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/jgarber623/link-header-parser-ruby'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(bin|spec)/}) }
+  spec.files         = Dir['lib/**/*'].reject { |f| File.directory?(f) }
+  spec.files        += %w[LICENSE CHANGELOG.md CONTRIBUTING.md README.md]
+  spec.files        += %w[link-header-parser.gemspec]
 
   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 'absolutely', '~> 3.1'
+  spec.add_runtime_dependency 'addressable', '~> 2.7'
 end

metadata

@@ -1,141 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: link-header-parser
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Jason Garber
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-01-20 00:00:00.000000000 Z
+date: 2021-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: addressable
   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: absolutely
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '2.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '2.7'
 description: Parse HTTP Link headers.
 email:
 - jason@sixtwothree.org
@@ -143,25 +31,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".editorconfig"
-- ".gitignore"
-- ".reek.yml"
-- ".rspec"
-- ".rubocop"
-- ".rubocop.yml"
-- ".ruby-version"
-- ".simplecov"
-- ".travis.yml"
 - CHANGELOG.md
 - CONTRIBUTING.md
-- Gemfile
 - LICENSE
 - README.md
-- Rakefile
 - lib/link-header-parser.rb
-- lib/link_header_parser/exceptions.rb
-- lib/link_header_parser/parsed_header.rb
-- lib/link_header_parser/parsed_header_collection.rb
+- lib/link_header_parser/link_header.rb
+- lib/link_header_parser/link_header_parameter.rb
+- lib/link_header_parser/link_headers_collection.rb
 - lib/link_header_parser/version.rb
 - link-header-parser.gemspec
 homepage: https://github.com/jgarber623/link-header-parser-ruby
@@ -169,8 +46,8 @@ 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/v0.3.0/CHANGELOG.md
-post_install_message: 
+  changelog_uri: https://github.com/jgarber623/link-header-parser-ruby/blob/v3.0.0/CHANGELOG.md
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -178,18 +55,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.5'
   - - "<"
     - !ruby/object:Gem::Version
-      version: '2.8'
+      version: '4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.2.16
+signing_key:
 specification_version: 4
 summary: Parse HTTP Link headers.
 test_files: []

data/.editorconfig

@@ -1,14 +0,0 @@
-# EditorConfig is awesome: https://EditorConfig.org
-root = true
-
-[*]
-charset = utf-8
-end_of_line = lf
-insert_final_newline = true
-indent_size = 2
-indent_style = space
-trim_trailing_whitespace = true
-
-[*.md]
-indent_size = 4
-indent_style = tab

data/.gitignore

@@ -1,34 +0,0 @@
-*.gem
-*.rbc
-/.config
-/coverage/
-/InstalledFiles
-/pkg/
-/spec/reports/
-/spec/examples.txt
-/test/tmp/
-/test/version_tmp/
-/tmp/
-
-# Used by dotenv library to load environment variables.
-# .env
-
-# Documentation cache and generated files:
-/.yardoc/
-/_yardoc/
-/doc/
-/rdoc/
-
-# Environment normalization:
-/.bundle/
-/vendor/bundle
-/lib/bundler/man/
-
-# for a library or gem, you might want to ignore these files since the code is
-# intended to run in multiple environments; otherwise, check them in:
-Gemfile.lock
-# .ruby-version
-# .ruby-gemset
-
-# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
-.rvmrc

data/.reek.yml

@@ -1,9 +0,0 @@
-detectors:
-  IrresponsibleModule:
-    enabled: false
-  NilCheck:
-    exclude:
-      - "LinkHeaderParser::ParsedHeader#relation_types"
-
-exclude_paths:
-  - vendor/

data/.rspec

@@ -1,2 +0,0 @@
---order random
---require spec_helper

data/.rubocop

@@ -1,3 +0,0 @@
---display-style-guide
---extra-details
---parallel

data/.rubocop.yml

@@ -1,26 +0,0 @@
-require:
-  - rubocop-performance
-  - rubocop-rspec
-
-Layout/HashAlignment:
-  EnforcedHashRocketStyle: table
-
-Layout/LineLength:
-  Enabled: false
-
-Metrics/ModuleLength:
-  Exclude:
-    - spec/support/**/*.rb
-
-Naming/FileName:
-  Exclude:
-    - lib/link-header-parser.rb
-
-Style/Documentation:
-  Enabled: false
-
-Style/FrozenStringLiteralComment:
-  Enabled: false
-
-Style/SymbolArray:
-  Enabled: false

data/.ruby-version

@@ -1 +0,0 @@
-2.4.9

data/.simplecov

@@ -1,11 +0,0 @@
-require 'simplecov-console'
-
-formatters = [SimpleCov::Formatter::HTMLFormatter]
-
-if RSpec.configuration.files_to_run.length > 1
-  formatters << SimpleCov::Formatter::Console
-end
-
-SimpleCov.start do
-  formatter SimpleCov::Formatter::MultiFormatter.new(formatters)
-end

data/.travis.yml

@@ -1,19 +0,0 @@
-dist: bionic
-language: ruby
-rvm:
-  - 2.4
-  - 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
-  - ./cc-test-reporter before-build
-after_script:
-  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
-notifications:
-  email: false
-  slack:
-    rooms:
-      secure: ZV5G4LIK9OXRXkXt3iC53QD1uVWmThzETj8CallRoZgGfUKfzzMjx2V7NqJLwkmFkaK9y/flt/bRVMVqkH60GY0Gq6YeS9zuKEWJYesC6+aWQa6scKaxgewLdfYth3ijMS91XbPKECbFj0LOs1WPTfqYDsdPpOnH2RBWUO6lx8ID4DZtvi7kMhcY2+K21Q3/3gW9y919KHSCppM24EsyIbkAlFce5RjXn5WmfyTOTyTrxbHyByFr3SSTGdyO3KK0Fa4hhKNC2pa5WmlLHvZ/c5P7MYf1Eo+Rji5I0QY3pcGOIvbK0xBBnXnGI6Zfp088evElGpw8qgUdkR03QbxjTYANdN6mlk9DvnHqPWjI6OalF3SA7PP9mYjKVb2THDPqWOAvqYdMrrLylduWfdCzpxk4Z13DwF6rYSRgz3juKeKx80rhcAFmptLAC3uzQxgSgKoj9xZbbcYqhh/JQL9lNBZYJyLO5M0fOzrEDbLyNrWFYzUgKYgxRAOLWhJ8V2FlN3oR2cXXcf6vmlpPYfoCA0a8Ig82Htapan0JEhNEU6sS1ctdS7NegccEB9P0V5hUDy3AooaqCy8gFYE3TENYI1vwrevo5vqtNffR1PXTsliGe/gIIeFET6H2IJ+HYG9DefMHwYIR97enMFe50PauNGqdHS9kCoUV59r1PDOBJuU=

data/Gemfile

@@ -1,4 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in link-header-parser.gemspec
-gemspec

data/Rakefile

@@ -1,18 +0,0 @@
-require 'bundler/gem_tasks'
-
-require 'reek/rake/task'
-require 'rspec/core/rake_task'
-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
-
-RuboCop::RakeTask.new do |task|
-  task.fail_on_error = false
-end
-
-task default: [:rubocop, :reek, :spec]

data/lib/link_header_parser/exceptions.rb

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

data/lib/link_header_parser/parsed_header.rb

@@ -1,70 +0,0 @@
-module LinkHeaderParser
-  class ParsedHeader
-    attr_reader :header
-
-    def initialize(header, base:)
-      raise ArgumentError, "header must be a String (given #{header.class})" unless header.is_a?(String)
-      raise ArgumentError, "base must be a String (given #{base.class})" unless base.is_a?(String)
-
-      @header = header
-      @base = base
-    end
-
-    # https://tools.ietf.org/html/rfc8288#section-3.2
-    def context
-      @context ||= parameters.anchor || target
-    end
-
-    def context_uri
-      @context_uri ||= Absolutely.to_abs(base: target_uri, relative: context)
-    end
-
-    def inspect
-      format(%(#<#{self.class.name}:%#0x @header="#{header.gsub('"', '\"')}">), object_id)
-    end
-
-    def parameters
-      @parameters ||= OpenStruct.new(header_attributes)
-    end
-
-    def relation_types
-      @relation_types ||= relations&.split(' ') || nil
-    end
-
-    # https://tools.ietf.org/html/rfc8288#section-3.3
-    def relations
-      @relations ||= parameters.rel || nil
-    end
-
-    # https://tools.ietf.org/html/rfc8288#section-3.1
-    def target
-      @target ||= header_match_data[:target]
-    end
-
-    def target_uri
-      @target_uri ||= Absolutely.to_abs(base: @base, relative: target)
-    end
-
-    def to_h
-      {
-        target: target,
-        target_uri: target_uri,
-        context: context,
-        context_uri: context_uri,
-        relations: relations,
-        relation_types: relation_types,
-        parameters: parameters.to_h
-      }
-    end
-
-    private
-
-    def header_attributes
-      @header_attributes ||= header_match_data[:attributes].tr('"', '').split(';').map { |tuple| tuple.split('=').map(&:strip) }.sort.to_h
-    end
-
-    def header_match_data
-      @header_match_data ||= header.match(/^<\s*(?<target>[^>]+)\s*>\s*;\s*(?<attributes>.*)$/)
-    end
-  end
-end

data/lib/link_header_parser/parsed_header_collection.rb

@@ -1,58 +0,0 @@
-module LinkHeaderParser
-  class ParsedHeaderCollection
-    include Enumerable
-
-    attr_reader :headers
-
-    def initialize(*headers, base:)
-      @headers = headers.flatten
-      @base = base
-    end
-
-    def by_relation_type
-      @by_relation_type ||= OpenStruct.new(mapped_relation_types)
-    end
-
-    def each
-      return to_enum unless block_given?
-
-      parsed_headers.each { |parsed_header| yield parsed_header }
-
-      self
-    end
-
-    def inspect
-      format(%(#<#{self.class.name}:%#0x @headers=#{headers}>), object_id)
-    end
-
-    def last
-      @last ||= parsed_headers[-1]
-    end
-
-    def length
-      @length ||= parsed_headers.length
-    end
-
-    def relation_types
-      @relation_types ||= parsed_headers.map(&:relation_types).flatten.uniq.sort
-    end
-
-    private
-
-    def find_all_by_relation_type(relation_type)
-      find_all { |parsed_header| parsed_header.relation_types.include?(relation_type) }
-    end
-
-    def mapped_relation_types
-      @mapped_relation_types ||= relation_types.map { |relation_type| [relation_type, find_all_by_relation_type(relation_type)] }.to_h
-    end
-
-    def parsed_headers
-      @parsed_headers ||= uniq_headers.map { |header| ParsedHeader.new(header, base: @base) }
-    end
-
-    def uniq_headers
-      @uniq_headers ||= headers.map { |header| header.split(/,(?=[\s|<])/) }.flatten.map(&:strip)
-    end
-  end
-end