link-header-parser 3.0.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b2127eef719541b0ed02c6cb37c7271ed1c1bac8358f5808fb50c08d5ccada3
-  data.tar.gz: 999fdc8ea6ad395fe72e88094ed4e924063844600b25df4df5822b2e85b6c2aa
+  metadata.gz: a3bede096a22050eb158b8c5e55a8467cf2a0abb91a7058962ab99b1aebe9162
+  data.tar.gz: 02a647ff14be96c4dfc11f571694d90ef2e75fe2b3930ceb09c0ecb0ab55d92a
 SHA512:
-  metadata.gz: 90a5edd9b4ea7802818d84d858a365f365c6aee0cdcb9ec453feb5620ef7c6b2957da0063a8eaa2847318b69be5e668874a1bf4dc5b01cb36ff75cfd6190a33d
-  data.tar.gz: 676c81a374430b522d62d2cc569e149e4c18d5eead47db851cadc1fe509ff787d02b3ecdb823a1e70f8244a6f4d3fb8b122a18ca2dd4ea697eff6faa8c9e22a5
+  metadata.gz: af0da321a1652d3f6740fb4396a95d66213334b04eec1bd794652de894f2c7b6d9effd52701722ca851fbb01bcc38601e4c80b20290cede4b4856f36e6436520
+  data.tar.gz: ea527e8a58c23acafc460a73224d72204d9b82074dfa53275518eea5fd1aad940489d4efc5b770700a7aaf120160e8f589c36f56d9965ffba47d23174a09c73a

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 5.0.0 / 2022-11-09
+
+- **Breaking change:** Add `#to_ary`/`#to_a` method to `LinkHeadersCollection` (6a478ed)
+	- Note: marking this as a breaking change since it changes the existing behavior to return an `Array` of `Hash`es instead of an `Array` of `LinkHeader`s
+- **Breaking change:** Update project Ruby version to 2.7.6 and minimum Ruby version to 2.7 (1e9df45)
+- Improve documentation and privatize constants (8a68aa0)
+- Remove Reek development dependency (423bc7a)
+- Use ruby/debug gem instead of pry-byebug (4cd9d26)
+
+## 4.0.0 / 2022-01-06
+
+- Remove Addressable dependency (daedf22)
+- **Breaking change:** Update minimum Ruby version to 2.6 (e2343ed)
+- Migrate to GitHub Actions (509b2c4)
+- Update project Ruby version to 2.6.10 (c39bc66)
+
 ## 3.0.0 / 2021-05-22
 
 - Add implicit type conversion methods, alias explicit methods, and update specs (d132535)

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.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).
+link-header-parser-ruby is developed using Ruby 2.7.6 and is additionally tested against Ruby 3.0 and 3.1 using [GitHub Actions](https://github.com/jgarber623/link-header-parser-ruby/actions).
 
-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:
+Before making changes to link-header-parser-ruby, you'll want to install Ruby 2.7.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.7.6 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 `bin/ci`.
+1. If your changes would benefit from testing, add the necessary tests and verify everything passes by running `bundle exec rspec`.
 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

@@ -4,15 +4,15 @@
 
 [![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)
+[![Build](https://img.shields.io/github/workflow/status/jgarber623/link-header-parser-ruby/CI?logo=github&style=for-the-badge)](https://github.com/jgarber623/link-header-parser-ruby/actions/workflows/ci.yml)
 [![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.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).
+Before installing and using link-header-parser-ruby, you'll want to have [Ruby](https://www.ruby-lang.org) 2.7 (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.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).
+link-header-parser-ruby is developed using Ruby 2.7.6 and is additionally tested against Ruby 3.0 and 3.1 using [GitHub Actions](https://github.com/jgarber623/link-header-parser-ruby/actions).
 
 ## Installation
 
@@ -35,14 +35,13 @@ $ bundle install
 With link-header-parser-ruby added to your project's `Gemfile` and installed, you may parse a URL's HTTP Link headers by doing:
 
 ```ruby
-require 'http'
+require 'net/http'
 require 'link-header-parser'
 
-response = HTTP.get('https://sixtwothree.org')
+url = 'https://sixtwothree.org'
+link_headers = Net::HTTP.get_response(URI.parse(url)).get_fields('Link')
 
-link_headers = response.headers.get('link')
-
-collection = LinkHeaderParser.parse(link_headers, base: response.uri)
+collection = LinkHeaderParser.parse(link_headers, base: url)
 ```
 
 The `parse` method accepts two arguments:

data/lib/link-header-parser.rb

@@ -1,19 +1,28 @@
-require 'forwardable'
+# frozen_string_literal: true
 
-require 'addressable/uri'
+require 'forwardable'
 
-require 'link_header_parser/version'
+require_relative 'link_header_parser/version'
 
-require 'link_header_parser/link_header'
-require 'link_header_parser/link_header_parameter'
-require 'link_header_parser/link_headers_collection'
+require_relative 'link_header_parser/link_header'
+require_relative 'link_header_parser/link_header_parameter'
+require_relative 'link_header_parser/link_headers_collection'
 
 module LinkHeaderParser
-  # Parse an array of HTTP Link headers
+  # Parse an array of HTTP Link headers.
+  #
+  # Convenience method for {LinkHeaderParser::LinkHeadersCollection#initialize}.
+  #
+  # @example
+  #   require 'net/http'
+  #
+  #   url = 'https://sixtwothree.org'
+  #   link_headers = Net::HTTP.get_response(URI.parse(url)).get_fields('Link')
+  #
+  #   LinkHeaderParser.parse(link_headers, base: url)
   #
-  # @param headers [Array<String>]
-  # @param base [String]
-  # @return [LinkHeaderParser::LinkHeadersCollection]
+  # @param (see LinkHeaderParser::LinkHeadersCollection#initialize)
+  # @return (see LinkHeaderParser::LinkHeadersCollection#initialize)
   def self.parse(*headers, base:)
     LinkHeadersCollection.new(*headers, base: base)
   end

data/lib/link_header_parser/link_header.rb

@@ -1,80 +1,114 @@
+# frozen_string_literal: true
+
 module LinkHeaderParser
   class LinkHeader
     FIELD_VALUE_REGEXP_PATTERN = /^\s*<\s*(?<target_string>[^>]+)\s*>\s*(?<parameters>;\s*.*)$/.freeze
+    private_constant :FIELD_VALUE_REGEXP_PATTERN
+
     PARAMETERS_REGEXP_PATTERN = /(?<!;)\s*([^;]+)/.freeze
+    private_constant :PARAMETERS_REGEXP_PATTERN
 
+    # The +String+ value used to create this {LinkHeader}.
+    #
+    # @return [String]
     attr_reader :field_value
 
-    # Create a new parsed Link header
+    # Create a new parsed Link header.
+    #
     # @see https://tools.ietf.org/html/rfc8288#appendix-B.2
+    #   IETF RFC 8288 Web Linking Appendix B.2 Parsing a Link Field Value
     #
-    # @param field_value [String]
-    # @param base [String]
+    # @param field_value [String, #to_str]
+    # @param base [String, #to_str]
     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)
+    # 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
+    #   IETF RFC 8288 Web Linking Appendix B.2.2.11 Parsing a Link Field Value
     #
     # @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)
+    # The resolved context URL for this Link header.
+    #
+    # @see https://tools.ietf.org/html/rfc8288#appendix-B.2
+    #   IETF RFC 8288 Web Linking Appendix B.2.2.12 Parsing a Link Field Value
     #
     # @return [String]
     def context_uri
-      @context_uri ||= Addressable::URI.join(target_uri, context_string).normalize.to_s
+      @context_uri ||= URI.join(target_uri, context_string).normalize.to_s
     end
 
+    # @return [String]
     def inspect
-      format(%(#<#{self.class.name}:%#0x target_uri: #{target_uri.inspect}, relation_types: #{relation_types.inspect}>), object_id)
+      "#<#{self.class.name}:#{format('%#0x', object_id)} " \
+        "target_uri: #{target_uri.inspect}, " \
+        "relation_types: #{relation_types.inspect}>"
     end
 
-    # The parsed parameters for this Link header extracted from field_value
+    # The parsed parameters for this Link header extracted from +field_value+.
+    #
     # @see https://tools.ietf.org/html/rfc8288#appendix-B.3
+    #   IETF RFC 8288 Web Linking Appendix B.3 Parsing Parameters
     #
     # @return [Array<LinkHeaderParser::LinkHeaderParameter>]
     def link_parameters
-      @link_parameters ||= field_value_match_data[:parameters].scan(PARAMETERS_REGEXP_PATTERN).flatten.map { |parameter| LinkHeaderParameter.new(parameter) }
+      @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)
+    # The +relations_string+ value returned as an +Array+.
+    #
+    # @see LinkHeader#relations_string
+    #
+    # @see https://tools.ietf.org/html/rfc8288#appendix-B.2
+    #   IETF RFC 8288 Web Linking Appendix B.2.2.10 and Appendix B.2.2.17.1 Parsing a Link Field Value
     #
     # @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)
+    # The relation types for this Link header extracted from +field_value+.
+    #
+    # @see https://tools.ietf.org/html/rfc8288#appendix-B.2
+    #   IETF RFC 8288 Web Linking Appendix B.2.2.9 Parsing a Link Field Value
     #
     # @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)
+    # The target URL for this Link header extracted from +field_value+
+    #
+    # @see https://tools.ietf.org/html/rfc8288#appendix-B.2
+    #   IETF RFC 8288 Web Linking Appendix B.2.2.4 Parsing a Link Field Value
     #
     # @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)
+    # The resolved target URL for this Link header.
+    #
+    # @see https://tools.ietf.org/html/rfc8288#appendix-B.2
+    #   IETF RFC 8288 Web Linking Appendix B.2.2.8 Parsing a Link Field Value
     #
     # @return [String]
     def target_uri
-      @target_uri ||= Addressable::URI.join(base, target_string).normalize.to_s
+      @target_uri ||= URI.join(base, target_string).normalize.to_s
     end
 
+    # Return a +Hash+ representation of this {LinkHeader}.
+    #
     # @return [Hash{Symbol => String, Array, Hash{Symbol => Array}}]
     def to_hash
       {
@@ -99,7 +133,10 @@ module LinkHeaderParser
     end
 
     def grouped_link_parameters
-      @grouped_link_parameters ||= link_parameters.map(&:to_a).group_by(&:shift).transform_keys(&:to_sym).transform_values(&:flatten)
+      @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

@@ -1,32 +1,47 @@
+# frozen_string_literal: true
+
 module LinkHeaderParser
   class LinkHeaderParameter
     PARAMETER_REGEXP_PATTERN = /^(?<name>.+?)(?:="?(?<value>.*?)"?)?$/.freeze
+    private_constant :PARAMETER_REGEXP_PATTERN
 
+    # The +String+ value used to create this {LinkHeaderParameter}.
+    #
+    # @return [String]
     attr_reader :parameter
 
-    # @param parameter [String]
+    # Create a new parsed Link header parameter.
+    #
+    # @param parameter [String, #to_str]
     def initialize(parameter)
       @parameter = parameter.to_str
     end
 
+    # @return [String]
     def inspect
-      format(%(#<#{self.class.name}:%#0x name: #{name.inspect}, value: #{value.inspect}>), object_id)
+      "#<#{self.class.name}:#{format('%#0x', object_id)} " \
+        "name: #{name.inspect}, " \
+        "value: #{value.inspect}>"
     end
 
-    # @see https://tools.ietf.org/html/rfc8288#appendix-B.3 (Appendix B.3.2.9)
+    # @see https://tools.ietf.org/html/rfc8288#appendix-B.3
+    #   IETF RFC 8288 Web Linking Appendix B.3.2.9 Parsing Parameters
     #
     # @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)
+    # @see https://tools.ietf.org/html/rfc8288#appendix-B.3
+    #   IETF RFC 8288 Web Linking Appendix B.3.2.8 Parsing Parameters
     #
     # @return [String]
     def value
       @value ||= parameter_match_data[:value].to_s
     end
 
+    # Return an +Array+ representation of this {LinkHeaderParameter}.
+    #
     # @return [Array<String>]
     def to_ary
       [name, value]

data/lib/link_header_parser/link_headers_collection.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module LinkHeaderParser
   class LinkHeadersCollection
     extend Forwardable
@@ -6,43 +8,74 @@ module LinkHeaderParser
 
     def_delegators :members, :[], :<<, :each, :last, :length, :push
 
+    # The +Array+ of HTTP Link headers used to create this
+    # {LinkHeadersCollection}.
+    #
+    # @return [Array<String>]
     attr_reader :headers
 
-    # @param headers [Array<String>]
-    # @param base [String]
+    # Parse an array of HTTP Link headers.
+    #
+    # @param headers [Array<String, #to_str>]
+    # @param base [String, #to_str]
     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)) }
+      push(*distinct_link_headers)
     end
 
+    # Retrieve a +Hash+ of this collection's {LinkHeader}s grouped by their
+    # relation type(s).
+    #
     # @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)
+      relation_types.to_h do |relation_type|
+        [relation_type.to_sym, select_by_relation_type(relation_type)]
+      end
     end
 
+    # @return [String]
     def inspect
-      format(%(#<#{self.class.name}:%#0x headers: #{headers.inspect}, relation_types: #{relation_types.inspect}>), object_id)
+      "#<#{self.class.name}:#{format('%#0x', object_id)} " \
+        "headers: #{headers.inspect}, " \
+        "relation_types: #{relation_types.inspect}>"
     end
 
+    # Retrieve a unique sorted +Array+ of this collection's {LinkHeader}
+    # relation types.
+    #
     # @return [Array<String>]
     def relation_types
       @relation_types ||= flat_map(&:relation_types).uniq.sort
     end
 
+    # Return an +Array+ representation of this {LinkHeadersCollection}.
+    #
+    # @see LinkHeader#to_hash
+    #
+    # @return [Array<Hash>}>]
+    def to_ary
+      map(&:to_hash)
+    end
+
+    alias to_a to_ary
+
     private
 
     attr_reader :base
 
-    def distinct_headers
-      @distinct_headers ||= headers.flat_map { |header| header.split(/,(?=[\s|<])/) }.map(&:strip)
+    def distinct_link_headers
+      headers.flat_map { |header| header.split(/,(?=[\s|<])/) }
+             .map { |header| LinkHeader.new(header.strip, base: base) }
     end
 
     def members
       @members ||= []
     end
+
+    def select_by_relation_type(relation_type)
+      select { |member| member.relation_types.include?(relation_type) }
+    end
   end
 end

data/lib/link_header_parser/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module LinkHeaderParser
-  VERSION = '3.0.0'.freeze
+  VERSION = '5.0.0'
 end

data/link-header-parser.gemspec

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 require_relative 'lib/link_header_parser/version'
 
 Gem::Specification.new do |spec|
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.5', '< 4')
+  spec.required_ruby_version = '>= 2.7', '< 4'
 
   spec.name          = 'link-header-parser'
   spec.version       = LinkHeaderParser::VERSION
@@ -19,8 +21,9 @@ Gem::Specification.new do |spec|
 
   spec.require_paths = ['lib']
 
-  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'
+  spec.metadata = {
+    'bug_tracker_uri' => "#{spec.homepage}/issues",
+    'changelog_uri' => "#{spec.homepage}/blob/v#{spec.version}/CHANGELOG.md",
+    'rubygems_mfa_required' => 'true'
+  }
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: link-header-parser
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 5.0.0
 platform: ruby
 authors:
 - Jason Garber
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-22 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: addressable
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.7'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.7'
+date: 2022-11-09 00:00:00.000000000 Z
+dependencies: []
 description: Parse HTTP Link headers.
 email:
 - jason@sixtwothree.org
@@ -46,8 +32,9 @@ 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/v3.0.0/CHANGELOG.md
-post_install_message:
+  changelog_uri: https://github.com/jgarber623/link-header-parser-ruby/blob/v5.0.0/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -55,7 +42,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.7'
   - - "<"
     - !ruby/object:Gem::Version
       version: '4'
@@ -65,8 +52,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.16
-signing_key:
+rubygems_version: 3.3.16
+signing_key: 
 specification_version: 4
 summary: Parse HTTP Link headers.
 test_files: []