nokogiri-html-ext 0.3.1 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b7b920edbff5d762b7c2da37c37b59ae2455e0d1991b74595856098749e4fce
-  data.tar.gz: 457aa965cba9c5a01802efd664b5accc08298691d9b05a0f5dcf8c05e9fb37f6
+  metadata.gz: d7967d8d98d8778c9a5690637757071c8357b3c55e14d100d508f6ce12469887
+  data.tar.gz: b8f5601a2c40f4edaf77c60afda07a6adf848052d2bf0810cef1c497691c22f2
 SHA512:
-  metadata.gz: 80fa06b7ffbbce44179b2f44aa19f42d70eb82145d8c52fd2a3eca57a4eade23b5d5ee81e7477c7e5bb2948cd54725e0096d5b34194921aad1b56cb73e46301c
-  data.tar.gz: 41332d2498b1796f8d2a97f0e43da23cc30522681f001099ef63d3cc75892b97f2753682021e2594f86e008cfcf11bb17e6ff15a0122e11e25cb11f173e58661
+  metadata.gz: f9d396e7c18ecce3e9d19f97e90c3ea6753861ce8f5b330e7db1f7d5e9e0ae888b65e388cd6b745fc250b559ab6ed519b79151e2d802f94086c278cb6b756968
+  data.tar.gz: 56dcade1b0b103b7174fa567082007f9d9bd24bc01af8f8bb1a3babaf56844eedd839be9a213861c0c655f204704145fd1c758c9943285e2489a1259b420157a

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## 0.4.1 / 2023-12-07
+
+- Add publish workflow (039abd0)
+- Use `filter_map` instead of `compact` and `map` (ab574c9)
+- Add ignored revs file (3e24d9f)
+- RuboCop: address Style/StringLiterals warnings (a04b4d3)
+- Update to newest rubocop-configs format (0ed51ce)
+- Update RSpec configuration (#8) (4968bee)
+- Update development Ruby version (#7) (0e4613a)
+- Refactor CI workflow (#6) (5259b68)
+- Remove CodeClimate (#5) (284fce7)
+
+## 0.4.0 / 2023-01-20
+
+- Improve (hopefully) handling of non-ASCII input (6d1fc4d)
+- Update Nokogiri version constraint to >= 1.14 (4b7ed74)
+
 ## 0.3.1 / 2023-01-19
 
 - Revert removal of escaping/unescaping code in relative URL resolution (a78e83a)

data/README.md

@@ -5,8 +5,6 @@
 [![Gem](https://img.shields.io/gem/v/nokogiri-html-ext.svg?logo=rubygems&style=for-the-badge)](https://rubygems.org/gems/nokogiri-html-ext)
 [![Downloads](https://img.shields.io/gem/dt/nokogiri-html-ext.svg?logo=rubygems&style=for-the-badge)](https://rubygems.org/gems/nokogiri-html-ext)
 [![Build](https://img.shields.io/github/actions/workflow/status/jgarber623/nokogiri-html-ext/ci.yml?branch=main&logo=github&style=for-the-badge)](https://github.com/jgarber623/nokogiri-html-ext/actions/workflows/ci.yml)
-[![Maintainability](https://img.shields.io/codeclimate/maintainability/jgarber623/nokogiri-html-ext.svg?logo=code-climate&style=for-the-badge)](https://codeclimate.com/github/jgarber623/nokogiri-html-ext)
-[![Coverage](https://img.shields.io/codeclimate/c/jgarber623/nokogiri-html-ext.svg?logo=code-climate&style=for-the-badge)](https://codeclimate.com/github/jgarber623/nokogiri-html-ext/code)
 
 ## Key features
 
@@ -16,24 +14,18 @@
 
 ## Getting Started
 
-Before installing and using nokogiri-html-ext, 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).
+Before installing and using nokogiri-html-ext, you'll want to have [Ruby](https://www.ruby-lang.org) 2.7 (or newer) installed. Using 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) is recommended.
 
-nokogiri-html-ext is developed using Ruby 2.7.7 and is additionally tested against Ruby 3.0, 3.1, and 3.2 using [GitHub Actions](https://github.com/jgarber623/nokogiri-html-ext/actions).
+nokogiri-html-ext is developed using Ruby 2.7.8 and is tested against additional Ruby versions using [GitHub Actions](https://github.com/indieweb/nokogiri-html-ext/actions).
 
 ## Installation
 
-If you're using [Bundler](https://bundler.io) to manage gem dependencies, add nokogiri-html-ext to your project's Gemfile:
+Add nokogiri-html-ext to your project's `Gemfile` and run `bundle install`:
 
 ```ruby
-gem 'nokogiri-html-ext'
-```
-
-…and run `bundle install` in your shell.
-
-To install the gem manually, run the following in your shell:
+source "https://rubygems.org"
 
-```sh
-gem install nokogiri-html-ext
+gem "nokogiri-html-ext"
 ```
 
 ## Usage
@@ -43,19 +35,19 @@ gem install nokogiri-html-ext
 nokogiri-html-ext provides two helper methods for getting and setting a document's `<base>` element's `href` attribute. The first, `base_href`, retrieves the element's `href` attribute value if it exists.
 
 ```ruby
-require 'nokogiri/html-ext'
+require "nokogiri/html-ext"
 
-doc = Nokogiri::HTML('<html><body>Hello, world!</body></html>')
+doc = Nokogiri::HTML(%(<html><body>Hello, world!</body></html>))
 
 doc.base_href
 #=> nil
 
-doc = Nokogiri::HTML('<html><head><base target="_top"><body>Hello, world!</body></html>')
+doc = Nokogiri::HTML(%(<html><head><base target="_top"><body>Hello, world!</body></html>))
 
 doc.base_href
 #=> nil
 
-doc = Nokogiri::HTML('<html><head><base href="/foo"><body>Hello, world!</body></html>')
+doc = Nokogiri::HTML(%(<html><head><base href="/foo"><body>Hello, world!</body></html>))
 
 doc.base_href
 #=> "/foo"
@@ -64,22 +56,22 @@ doc.base_href
 The `base_href=` method allows you to manipulate the document's `<base>` element.
 
 ```ruby
-require 'nokogiri/html-ext'
+require "nokogiri/html-ext"
 
-doc = Nokogiri::HTML('<html><body>Hello, world!</body></html>')
+doc = Nokogiri::HTML(%(<html><body>Hello, world!</body></html>))
 
-doc.base_href = '/foo'
+doc.base_href = "/foo"
 #=> "/foo"
 
-doc.at_css('base').to_s
+doc.at_css("base").to_s
 #=> "<base href=\"/foo\">"
 
-doc = Nokogiri::HTML('<html><head><base href="/foo"><body>Hello, world!</body></html>')
+doc = Nokogiri::HTML(%(<html><head><base href="/foo"><body>Hello, world!</body></html>))
 
-doc.base_href = '/bar'
+doc.base_href = "/bar"
 #=> "/bar"
 
-doc.at_css('base').to_s
+doc.at_css("base").to_s
 #=> "<base href=\"/bar\">"
 ```
 
@@ -96,7 +88,7 @@ URL resolution uses Ruby's built-in URL parsing and normalizing capabilities. Ab
 An abbreviated example:
 
 ```ruby
-require 'nokogiri/html-ext'
+require "nokogiri/html-ext"
 
 markup = <<-HTML
   <html>
@@ -107,7 +99,7 @@ markup = <<-HTML
   </html>
 HTML
 
-doc = Nokogiri::HTML(markup, 'https://jgarber.example')
+doc = Nokogiri::HTML(markup, "https://jgarber.example")
 
 doc.url
 #=> "https://jgarber.example"
@@ -115,18 +107,18 @@ doc.url
 doc.base_href
 #=> nil
 
-doc.base_href = '/foo/bar/biz'
+doc.base_href = "/foo/bar/biz"
 #=> "/foo/bar/biz"
 
 doc.resolve_relative_urls!
 
-doc.at_css('base')['href']
+doc.at_css("base")["href"]
 #=> "https://jgarber.example/foo/bar/biz"
 
-doc.at_css('a')['href']
+doc.at_css("a")["href"]
 #=> "https://jgarber.example/home"
 
-doc.at_css('img').to_s
+doc.at_css("img").to_s
 #=> "<img src=\"https://jgarber.example/foo.png\" srcset=\"https://jgarber.example/foo/bar.png 720w\">"
 ```
 
@@ -135,16 +127,12 @@ doc.at_css('img').to_s
 You may also resolve an arbitrary `String` representing a relative URL against the document's URL (or `<base>` element's `href` attribute value):
 
 ```ruby
-doc = Nokogiri::HTML('<html><base href="/foo/bar"></html>', 'https://jgarber.example')
+doc = Nokogiri::HTML(%(<html><base href="/foo/bar"></html>), "https://jgarber.example")
 
-doc.resolve_relative_url('biz/baz')
+doc.resolve_relative_url("biz/baz")
 #=> "https://jgarber.example/foo/biz/baz"
 ```
 
-## Contributing
-
-Interested in helping improve nokogiri-html-ext? Awesome! Your help is greatly appreciated. See [CONTRIBUTING.md](https://github.com/jgarber623/nokogiri-html-ext/blob/main/CONTRIBUTING.md) for details.
-
 ## Acknowledgments
 
 nokogiri-html-ext wouldn't exist without the [Nokogiri](https://nokogiri.org) project and its [community](https://github.com/sparklemotion/nokogiri).

data/lib/nokogiri/html-ext.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'html_ext/version'
+require_relative "html_ext/version"
 
-require_relative 'html_ext/document'
+require_relative "html_ext/document"

data/lib/nokogiri/html_ext/document.rb

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
 
-require 'nokogiri'
+require "nokogiri"
 
 module Nokogiri
   module HTML4
     class Document < Nokogiri::XML::Document
-      # A map of HTML `srcset` attributes and their associated element names.
+      # A map of HTML +srcset+ attributes and their associated element names.
       #
       # @see https://html.spec.whatwg.org/#srcset-attributes
       # @see https://html.spec.whatwg.org/#attributes-3
       IMAGE_CANDIDATE_STRINGS_ATTRIBUTES_MAP = {
-        'imagesrcset' => %w[link],
-        'srcset'      => %w[img source]
+        "imagesrcset" => %w[link],
+        "srcset"      => %w[img source]
       }.freeze
 
       private_constant :IMAGE_CANDIDATE_STRINGS_ATTRIBUTES_MAP
@@ -20,30 +20,30 @@ module Nokogiri
       #
       # @see https://html.spec.whatwg.org/#attributes-3
       URL_ATTRIBUTES_MAP = {
-        'action'     => %w[form],
-        'cite'       => %w[blockquote del ins q],
-        'data'       => %w[object],
-        'formaction' => %w[button input],
-        'href'       => %w[a area base link],
-        'ping'       => %w[a area],
-        'poster'     => %w[video],
-        'src'        => %w[audio embed iframe img input script source track video]
+        "action"     => %w[form],
+        "cite"       => %w[blockquote del ins q],
+        "data"       => %w[object],
+        "formaction" => %w[button input],
+        "href"       => %w[a area base link],
+        "ping"       => %w[a area],
+        "poster"     => %w[video],
+        "src"        => %w[audio embed iframe img input script source track video]
       }.freeze
 
       private_constant :URL_ATTRIBUTES_MAP
 
-      # Get the <base> element's HREF attribute value.
+      # Get the +<base>+ element's HREF attribute value.
       #
       # @return [String, nil]
       def base_href
-        (base = at_xpath('//base[@href]')) && base['href'].strip
+        (base = at_xpath("//base[@href]")) && base["href"].strip
       end
 
-      # Set the <base> element's HREF attribute value.
+      # Set the +<base>+ element's HREF attribute value.
       #
-      # If a <base> element exists, its HREF attribute value is replaced with
-      # the given value. If no <base> element exists, this method will create
-      # one and append it to the document's <head> (creating that element if
+      # If a +<base>+ element exists, its HREF attribute value is replaced with
+      # the given value. If no +<base>+ element exists, this method will create
+      # one and append it to the document's +<head>+ (creating that element if
       # necessary).
       #
       # @param url [String, #to_s]
@@ -52,12 +52,12 @@ module Nokogiri
       def base_href=(url)
         url_str = url.to_s
 
-        if (base = at_xpath('//base'))
-          base['href'] = url_str
+        if (base = at_xpath("//base"))
+          base["href"] = url_str
           url_str
         else
-          base = XML::Node.new('base', self)
-          base['href'] = url_str
+          base = XML::Node.new("base", self)
+          base["href"] = url_str
 
           set_metadata_element(base)
         end
@@ -71,13 +71,16 @@ module Nokogiri
       def resolve_relative_url(url)
         url_str = url.to_s
 
+        # Escape each component before joining (Ruby's +URI.parse+ only likes
+        # ASCII) and subsequently unescaping.
         uri_parser.unescape(
-          uri_parser.join(*[document.url.strip, base_href, url_str].compact.map { |u| uri_parser.escape(u) })
-                    .normalize
-                    .to_s
+          uri_parser
+            .join(*[doc_url_str, base_href, url_str].filter_map { |u| uri_parser.escape(u) unless u.nil? })
+            .normalize
+            .to_s
         )
       rescue URI::InvalidComponentError, URI::InvalidURIError
-        url
+        url_str
       end
 
       # Convert the document's relative URLs to absolute URLs.
@@ -90,9 +93,9 @@ module Nokogiri
 
         resolve_relative_urls_for(IMAGE_CANDIDATE_STRINGS_ATTRIBUTES_MAP) do |value|
           value
-            .split(',')
+            .split(",")
             .map { |candidate| candidate.strip.sub(/^(.+?)(\s+.+)?$/) { "#{resolve_relative_url($1)}#{$2}" } }
-            .join(', ')
+            .join(", ")
         end
 
         self
@@ -101,6 +104,13 @@ module Nokogiri
 
       private
 
+      # +Nokogiri::HTML4::Document#url+ may be double-escaped if the parser
+      # detects non-ASCII characters. For example, +https://[skull emoji].example+
+      # is returned as +"https%3A//%25E2%2598%25A0%25EF%25B8%258F.example+.
+      def doc_url_str
+        @doc_url_str ||= uri_parser.unescape(uri_parser.unescape(document.url)).strip
+      end
+
       def resolve_relative_urls_for(attributes_map)
         attributes_map.each do |attribute, names|
           xpaths = names.map { |name| "//#{name}[@#{attribute}]" }

data/lib/nokogiri/html_ext/version.rb

@@ -2,6 +2,6 @@
 
 module Nokogiri
   module HTMLExt
-    VERSION = '0.3.1'
+    VERSION = "0.4.1"
   end
 end

data/nokogiri-html-ext.gemspec

@@ -1,31 +1,31 @@
 # frozen_string_literal: true
 
-require_relative 'lib/nokogiri/html_ext/version'
+require_relative "lib/nokogiri/html_ext/version"
 
 Gem::Specification.new do |spec|
-  spec.required_ruby_version = '>= 2.7'
+  spec.required_ruby_version = ">= 2.7"
 
-  spec.name          = 'nokogiri-html-ext'
+  spec.name          = "nokogiri-html-ext"
   spec.version       = Nokogiri::HTMLExt::VERSION
-  spec.authors       = ['Jason Garber']
-  spec.email         = ['jason@sixtwothree.org']
+  spec.authors       = ["Jason Garber"]
+  spec.email         = ["jason@sixtwothree.org"]
 
-  spec.summary       = 'Extend Nokogiri with several useful HTML-centric features.'
+  spec.summary       = "Extend Nokogiri with several useful HTML-centric features."
   spec.description   = spec.summary
-  spec.homepage      = 'https://github.com/jgarber623/nokogiri-html-ext'
-  spec.license       = 'MIT'
+  spec.homepage      = "https://github.com/jgarber623/nokogiri-html-ext"
+  spec.license       = "MIT"
 
-  spec.files         = Dir['lib/**/*'].reject { |f| File.directory?(f) }
-  spec.files        += %w[LICENSE CHANGELOG.md CONTRIBUTING.md README.md]
+  spec.files         = Dir["lib/**/*"].reject { |f| File.directory?(f) }
+  spec.files        += %w[LICENSE CHANGELOG.md README.md]
   spec.files        += %w[nokogiri-html-ext.gemspec]
 
-  spec.require_paths = ['lib']
+  spec.require_paths = ["lib"]
 
   spec.metadata = {
-    'bug_tracker_uri'       => "#{spec.homepage}/issues",
-    'changelog_uri'         => "#{spec.homepage}/blob/v#{spec.version}/CHANGELOG.md",
-    'rubygems_mfa_required' => 'true'
+    "bug_tracker_uri"       => "#{spec.homepage}/issues",
+    "changelog_uri"         => "#{spec.homepage}/blob/v#{spec.version}/CHANGELOG.md",
+    "rubygems_mfa_required" => "true"
   }
 
-  spec.add_runtime_dependency 'nokogiri', '>= 1.13'
+  spec.add_runtime_dependency "nokogiri", ">= 1.14"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nokogiri-html-ext
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.1
 platform: ruby
 authors:
 - Jason Garber
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-19 00:00:00.000000000 Z
+date: 2023-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '1.14'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '1.14'
 description: Extend Nokogiri with several useful HTML-centric features.
 email:
 - jason@sixtwothree.org
@@ -32,7 +32,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
-- CONTRIBUTING.md
 - LICENSE
 - README.md
 - lib/nokogiri/html-ext.rb
@@ -44,7 +43,7 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/jgarber623/nokogiri-html-ext/issues
-  changelog_uri: https://github.com/jgarber623/nokogiri-html-ext/blob/v0.3.1/CHANGELOG.md
+  changelog_uri: https://github.com/jgarber623/nokogiri-html-ext/blob/v0.4.1/CHANGELOG.md
   rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
@@ -61,7 +60,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Extend Nokogiri with several useful HTML-centric features.

data/CONTRIBUTING.md

@@ -1,37 +0,0 @@
-# Contributing to nokogiri-html-ext
-
-There are a couple ways you can help improve nokogiri-html-ext:
-
-1. Fix an existing [issue][issues] and submit a [pull request][pulls].
-1. Review open [pull requests][pulls].
-1. Report a new [issue][issues]. _Only do this after you've made sure the behavior or problem you're observing isn't already documented in an open issue._
-
-## Getting Started
-
-nokogiri-html-ext is developed using Ruby 2.7.7 and is additionally tested against Ruby 3.0, 3.1, and 3.2 using [GitHub Actions](https://github.com/jgarber623/nokogiri-html-ext/actions).
-
-Before making changes to nokogiri-html-ext, you'll want to install Ruby 2.7.7. 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.7 using your method of choice, install the project's gems by running:
-
-```sh
-bundle install
-```
-
-## Making Changes
-
-1. Fork and clone the project's repo.
-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. 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.
-
-## Code Style
-
-Code formatting conventions are defined in the `.editorconfig` file which uses the [EditorConfig](http://editorconfig.org) syntax. There are [plugins for a variety of editors](http://editorconfig.org/#download) that utilize the settings in the `.editorconfig` file. We recommended you install the EditorConfig plugin for your editor of choice.
-
-Your bug fix or feature addition won't be rejected if it runs afoul of any (or all) of these guidelines, but following the guidelines will definitely make everyone's lives a little easier.
-
-[issues]: https://github.com/jgarber623/nokogiri-html-ext/issues
-[pulls]: https://github.com/jgarber623/nokogiri-html-ext/pulls