roadie 4.0.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17f87e779aab695788d0361a733cd56f81b74d4d89bc9c82eb1949f9bdec1796
-  data.tar.gz: 608a6d3a482a827123818c45acaf9709f4dd214328809e43d327fd860ce0d455
+  metadata.gz: 5ba6c121fdd1072479afeee70b785db020df45cbe3b45350a20f9cfd4f8d0164
+  data.tar.gz: bfd6faa52b576fba65b8d2281b213ceabf137f08551749dc842b9a9477566fd2
 SHA512:
-  metadata.gz: d512b9c8568ec0514161689fa8cb678d3c975b11ec9b6d9b7b1f31c09ad166788c88e195161b7b101256d229de36dec6abcc77f420dfddd6b663ce82233cdfcd
-  data.tar.gz: c94e1245d485c0824057868010d849b24b37faf6fd69ab59989a3f6bae0bf02284255550fa67fef79c0355c95a149d1ad34ec9e22b0ecc8b8c1eec6888ae0545
+  metadata.gz: 0b897b87d20fdd739110788a21f2b16c5c4a86726b876cfe2a1c815bc671341a02172eaca5bb65729e14cc10e06b7baa076832bd55cb36db927fb4c548eb117e
+  data.tar.gz: 290845f661cf1d913fcf01b3c66eeb6e6ec096667a64c21b81fa912950e42a0d1a8294532e28b01f283cf9215a5da028c3559e2fa6cac54860d9c006bce7f401

data/.github/workflows/main.yml

@@ -0,0 +1,43 @@
+name: Main
+on:
+  push:
+    branches:
+      - main
+      - master
+
+  pull_request:
+    types: [opened, synchronize, reopened]
+
+jobs:
+  base:
+    name: Ruby ${{ matrix.ruby }}
+    runs-on: ubuntu-20.04
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ["2.6", "2.7", "3.0", "3.1"]
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      # This setup is not compatible with the way Travis CI was
+      # setup, so the cache will only work for the root folder.
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Rake
+        run: bundle exec rake
+
+      - uses: codecov/codecov-action@v2
+
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: standardrb
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        uses: amoeba/standardrb-action@v2

data/.solargraph.yml

@@ -0,0 +1,16 @@
+---
+include:
+  - "**/*.rb"
+exclude:
+  - spec/**/*
+  - test/**/*
+  - vendor/**/*
+  - ".bundle/**/*"
+require: []
+domains: []
+plugins:
+  - solargraph-standardrb
+reporters:
+  - standardrb
+require_paths: []
+max_files: 5000

data/Changelog.md

@@ -1,9 +1,21 @@
 ### dev
 
-[full changelog](https://github.com/Mange/roadie/compare/v4.0.0...master)
+[full changelog](https://github.com/Mange/roadie/compare/v5.0.0...master)
 
 Nothing yet.
 
+### 5.0.0
+
+[full changelog](https://github.com/Mange/roadie/compare/v4.0.0...v5.0.0)
+
+* Drop support for Ruby 2.4 and Ruby 2.5
+* Drop support for JRuby and Rubinius
+* Test with Ruby 2.7 - [aried3r (Anton Rieder)](https://github.com/aried3r) (#167)
+* Test with Ruby 3.0 and Ruby 3.1
+* Add standardrb as code formatter
+* Drop support for callbacks that accepts only a single argument.
+* Change signature of `Roadie::CssNotFound` and `Roadie::ProvidersFailed`.
+
 ### 4.0.0
 
 [full changelog](https://github.com/Mange/roadie/compare/v3.5.1...v4.0.0)
@@ -11,6 +23,7 @@ Nothing yet.
 * Drop support for Ruby 2.1, 2.2, and 2.3 and
   add support for frozen string literals and Ruby 2.6 - [adamkiczula (Adam
   Kiczula)](https://github.com/adamkiczula) (#164)
+* `Roadie::Stylesheet#each_inlinable_block` is now removed.
 
 ### 3.5.1
 
@@ -386,4 +399,3 @@ Roadie fork!
   * + some other enhancements
 * Deprecations:
   * Removed support for Rails 2.x
-

data/Gemfile

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
 
-source 'https://rubygems.org'
+source "https://rubygems.org"
 gemspec
 
 # Added here so it does not show up on the Gemspec; I only want it for CI builds
-gem 'codecov', group: :test, require: false
+gem "codecov", group: :test, require: false
+# Not actually required to run the tests for the gem, but a real convenience
+# for local development.
+gem "standard", group: [:test, :development], require: false

data/README.md

@@ -1,7 +1,6 @@
 Roadie
 ======
 
-[![Build history and status](https://travis-ci.org/Mange/roadie.svg?branch=master)](http://travis-ci.org/#!/Mange/roadie)
 [![Code Climate](https://codeclimate.com/github/Mange/roadie.png)](https://codeclimate.com/github/Mange/roadie)
 [![Code coverage status](https://codecov.io/github/Mange/roadie/coverage.svg?branch=master)](https://codecov.io/github/Mange/roadie?branch=master)
 [![Gem](https://img.shields.io/gem/v/roadie.svg)](https://rubygems.org/gems/roadie)
@@ -333,7 +332,10 @@ class UserAssetsProvider
   end
 
   def find_stylesheet!(name)
-    find_stylesheet(name) or raise Roadie::CssNotFound.new(name, "does not match a user stylesheet", self)
+    find_stylesheet(name) or
+      raise Roadie::CssNotFound.new(
+        css_name: name, message: "does not match a user stylesheet", provider: self
+      )
   end
 
   # Instead of implementing #find_stylesheet!, you could also:
@@ -444,18 +446,14 @@ Partial documents does not have a `<!DOCTYPE>`.
 Build Status
 ------------
 
-Tested with [Travis CI](http://travis-ci.org) using:
+Tested with Github CI using:
 
-* MRI 2.1
-* MRI 2.2
-* MRI 2.3
-* MRI 2.4
-* JRuby (latest)
-* Rubinius (failures on Rubinius will not fail the build due to a long history of instability in `rbx`)
+* MRI 2.6
+* MRI 2.7
+* MRI 3.0
+* MRI 3.1
 
-[(Build status)](http://travis-ci.org/#!/Mange/roadie)
-
-Let me know if you want any other VM supported officially.
+Let me know if you want any other runtime supported officially.
 
 ### Versioning ###
 
@@ -565,7 +563,7 @@ License
 
 (The MIT License)
 
-Copyright (c) 2009-2018 Magnus Bergmark, Jim Neath / Purify, and contributors.
+Copyright (c) 2009-2022 Magnus Bergmark, Jim Neath / Purify, and contributors.
 
 * [Magnus Bergmark](https://github.com/Mange) <magnus.bergmark@gmail.com>
 

data/Rakefile

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'bundler/setup'
+require "bundler/setup"
 
 Bundler::GemHelper.install_tasks
 
@@ -10,4 +10,4 @@ task :spec do
 end
 
 desc "Default: Run specs"
-task :default => :spec
+task default: :spec

data/lib/roadie/asset_provider.rb

@@ -7,7 +7,9 @@ module Roadie
   # It helps you by declaring {#find_stylesheet!} in the terms of #find_stylesheet in your own class.
   module AssetProvider
     def find_stylesheet!(name)
-      find_stylesheet(name) or raise CssNotFound.new(name, nil, self)
+      find_stylesheet(name) or raise(
+        CssNotFound.new(css_name: name, provider: self)
+      )
     end
   end
 end

data/lib/roadie/asset_scanner.rb

@@ -43,15 +43,15 @@ module Roadie
     # @see #find_css
     # @return [Enumerable<Stylesheet>] every extracted stylesheet
     def extract_css
-      stylesheets = @dom.css(STYLE_ELEMENT_QUERY).map { |element|
+      @dom.css(STYLE_ELEMENT_QUERY).map { |element|
         stylesheet = read_stylesheet(element)
         element.remove if stylesheet
         stylesheet
       }.compact
-      stylesheets
     end
 
     private
+
     STYLE_ELEMENT_QUERY = (
       "style:not([data-roadie-ignore]), " +
       # TODO: When using Nokogiri 1.6.1 and later; we may use a double :not here
@@ -75,7 +75,7 @@ module Roadie
     def read_stylesheet(element)
       if element.name == "style"
         read_style_element element
-      elsif element.name == "link" && element['media'] != "print" && element["href"]
+      elsif element.name == "link" && element["media"] != "print" && element["href"]
         read_link_element element
       end
     end
@@ -86,14 +86,14 @@ module Roadie
 
     def read_link_element(element)
       if Utils.path_is_absolute?(element["href"])
-        external_asset_provider.find_stylesheet! element['href'] if should_find_external?
+        external_asset_provider.find_stylesheet! element["href"] if should_find_external?
       else
-        normal_asset_provider.find_stylesheet! element['href']
+        normal_asset_provider.find_stylesheet! element["href"]
       end
     end
 
     def clean_css(css)
-      css.gsub(CLEANING_MATCHER, '')
+      css.gsub(CLEANING_MATCHER, "")
     end
 
     def should_find_external?

data/lib/roadie/cached_provider.rb

@@ -69,6 +69,7 @@ module Roadie
     end
 
     private
+
     def cache_fetch(name)
       cache[name] || cache[name] = yield
     rescue CssNotFound

data/lib/roadie/deduplicator.rb

@@ -26,6 +26,7 @@ module Roadie
     end
 
     private
+
     attr_reader :input, :latest_occurance
 
     def has_duplicates?

data/lib/roadie/document.rb

@@ -142,6 +142,7 @@ module Roadie
     # Valid modes:
     #   `:html` (default)
     #   `:xhtml`
+    #   `:xml`
     def mode=(mode)
       if VALID_MODES.include?(mode)
         @mode = mode
@@ -151,7 +152,8 @@ module Roadie
     end
 
     private
-    VALID_MODES = %i[html xhtml].freeze
+
+    VALID_MODES = %i[html xhtml xml].freeze
     private_constant :VALID_MODES
 
     def stylesheet
@@ -168,7 +170,7 @@ module Roadie
       Inliner.new(dom_stylesheets + [stylesheet], dom).inline(
         keep_uninlinable_css: keep_uninlinable_css,
         keep_uninlinable_in: keep_uninlinable_in,
-        merge_media_queries: merge_media_queries,
+        merge_media_queries: merge_media_queries
       )
     end
 
@@ -182,6 +184,7 @@ module Roadie
       format = {
         html: save_options::AS_HTML,
         xhtml: save_options::AS_XHTML,
+        xml: save_options::AS_XML
       }.fetch(mode)
 
       dom.dup.to_html(
@@ -189,7 +192,7 @@ module Roadie
           save_options::NO_DECLARATION |
           save_options::NO_EMPTY_TAGS |
           format
-        ),
+        )
       )
     end
 
@@ -203,13 +206,7 @@ module Roadie
 
     def callback(callable, dom)
       if callable.respond_to?(:call)
-        # Arity checking is to support the API without bumping a major version.
-        # TODO: Remove on next major version (v4.0)
-        if !callable.respond_to?(:parameters) || callable.parameters.size == 1
-          callable.(dom)
-        else
-          callable.(dom, self)
-        end
+        callable.call(dom, self)
       end
     end
 

data/lib/roadie/errors.rb

@@ -18,10 +18,10 @@ module Roadie
 
     def initialize(given_path, cause = nil)
       @cause = cause
-      if cause
-        cause_message = " Caused by: #{cause}"
+      cause_message = if cause
+        " Caused by: #{cause}"
       else
-        cause_message = ""
+        ""
       end
       super "Cannot use path \"#{given_path}\" in URL generation.#{cause_message}"
     end
@@ -43,23 +43,22 @@ module Roadie
     # Extra message
     attr_reader :extra_message
 
-    # TODO: Change signature in the next major version of Roadie.
-    def initialize(css_name, extra_message = nil, provider = nil)
+    def initialize(css_name:, message: nil, provider: nil)
       @css_name = css_name
       @provider = provider
-      @extra_message = extra_message
-      super build_message(extra_message)
+      @extra_message = message
+      super build_message
     end
 
     protected
+
     def error_row
-      "#{provider || "Unknown provider"}: #{extra_message || message}"
+      "#{provider || "Unknown provider"}: #{extra_message}"
     end
 
     private
-    # Redundant method argument is to keep API compatability without major version bump.
-    # TODO: Remove argument on version 4.0.
-    def build_message(extra_message = @extra_message)
+
+    def build_message
       message = +%(Could not find stylesheet "#{css_name}")
       message << ": #{extra_message}" if extra_message
       message << "\nUsed provider:\n#{provider}" if provider
@@ -70,13 +69,18 @@ module Roadie
   class ProvidersFailed < CssNotFound
     attr_reader :errors
 
-    def initialize(css_name, provider_list, errors)
+    def initialize(css_name:, providers:, errors:)
       @errors = errors
-      super(css_name, "All providers failed", provider_list)
+      super(
+        css_name: css_name,
+        message: "All providers failed",
+        provider: providers
+      )
     end
 
     private
-    def build_message(extra_message)
+
+    def build_message
       message = +%(Could not find stylesheet "#{css_name}": #{extra_message}\nUsed providers:\n)
       each_error_row(errors) do |row|
         message << "\t" << row << "\n"

data/lib/roadie/filesystem_provider.rb

@@ -32,14 +32,24 @@ module Roadie
         Stylesheet.new file_path, File.read(file_path)
       else
         basename = File.basename file_path
-        raise CssNotFound.new(basename, %{#{file_path} does not exist. (Original name was "#{name}")}, self)
+        raise CssNotFound.new(
+          css_name: basename,
+          message: %{#{file_path} does not exist. (Original name was "#{name}")},
+          provider: self
+        )
       end
     end
 
-    def to_s() inspect end
-    def inspect() "#<#{self.class} #@path>" end
+    def to_s
+      inspect
+    end
+
+    def inspect
+      "#<#{self.class} #{@path}>"
+    end
 
     private
+
     def build_file_path(name)
       raise InsecurePathError, name if name.include?("..")
       File.join(@path, name[/^([^?]+)/])

data/lib/roadie/inliner.rb

@@ -1,21 +1,28 @@
 # frozen_string_literal: true
 
-require 'set'
-require 'nokogiri'
-require 'uri'
-require 'css_parser'
+require "set"
+require "nokogiri"
+require "uri"
+require "css_parser"
 
 module Roadie
   # @api private
   # The Inliner inlines stylesheets to the elements of the DOM.
   #
   # Inlining means that {StyleBlock}s and a DOM tree are combined:
-  #   a { color: red; } # StyleBlock
-  #   <a href="/"></a>  # DOM
+  #
+  # ```css
+  # a { color: red; } # StyleBlock
+  # ```
+  # ```html
+  # <a href="/"></a>  # DOM
+  # ```
   #
   # becomes
   #
-  #   <a href="/" style="color:red"></a>
+  # ```html
+  # <a href="/" style="color:red"></a>
+  # ```
   class Inliner
     # @param [Array<Stylesheet>] stylesheets the stylesheets to use in the inlining
     # @param [Nokogiri::HTML::Document] dom
@@ -47,9 +54,11 @@ module Roadie
     end
 
     protected
+
     attr_reader :stylesheets, :dom
 
     private
+
     def consume_stylesheets
       style_map = StyleMap.new
       extra_blocks = []
@@ -91,12 +100,18 @@ module Roadie
     # with having to rescue errors.
     # Pseudo selectors that are known to be bad are skipped automatically but
     # this will catch the rest.
-    rescue Nokogiri::XML::XPath::SyntaxError, Nokogiri::CSS::SyntaxError => error
-      Utils.warn "Cannot inline #{selector.inspect} from \"#{stylesheet.name}\" stylesheet. If this is valid CSS, please report a bug."
+    rescue Nokogiri::XML::XPath::SyntaxError, Nokogiri::CSS::SyntaxError
+      Utils.warn(
+        "Cannot inline #{selector.inspect} from \"#{stylesheet.name}\" " \
+          "stylesheet. If this is valid CSS, please report a bug."
+      )
       nil
     rescue => error
-      Utils.warn "Got error when looking for #{selector.inspect} (from \"#{stylesheet.name}\" stylesheet): #{error}"
-      raise unless error.message.include?('XPath')
+      Utils.warn(
+        "Got error when looking for #{selector.inspect} " \
+          "(from \"#{stylesheet.name}\" stylesheet): #{error}"
+      )
+      raise unless error.message.include?("XPath")
       nil
     end
 
@@ -122,12 +137,12 @@ module Roadie
     end
 
     def find_head
-      dom.at_xpath('html/head')
+      dom.at_xpath("html/head")
     end
 
     def create_style_element(style_blocks, parent, merge_media_queries)
       return unless parent
-      element = Nokogiri::XML::Node.new('style', parent.document)
+      element = Nokogiri::XML::Node.new("style", parent.document)
 
       element.content =
         if merge_media_queries
@@ -141,17 +156,23 @@ module Roadie
     # For performance reasons, we should group styles with the same media types within
     # one media query instead of creating thousands of media queries.
     # https://github.com/artifex404/media-queries-benchmark
-    # Example result: ["@media(max-width: 600px) { .col-12 { display: block; } }"]
+    #
+    # Example result:
+    #
+    # ```ruby
+    # ["@media(max-width: 600px) { .col-12 { display: block; } }"]
+    # ```
+    #
     # @param {Array<StyleBlock>} style_blocks  Style blocks that could not be inlined
     # @return {Array<String>}
     def styles_in_shared_media_queries(style_blocks)
       style_blocks.group_by(&:media).map do |media_types, blocks|
         css_rules = blocks.map(&:to_s).join("\n")
 
-        if media_types == ['all']
+        if media_types == ["all"]
           css_rules
         else
-          "@media #{media_types.join(', ')} {\n#{css_rules}\n}"
+          "@media #{media_types.join(", ")} {\n#{css_rules}\n}"
         end
       end
     end
@@ -159,27 +180,36 @@ module Roadie
     # Some users might prefer to not group rules within media queries because
     # it will result in rules getting reordered.
     # e.g.
+    #
+    # ```css
     # @media(max-width: 600px) { .col-6 { display: block; } }
     # @media(max-width: 400px) { .col-12 { display: inline-block; } }
     # @media(max-width: 600px) { .col-12 { display: block; } }
+    # ````
+    #
     # will become
+    #
+    # ```css
     # @media(max-width: 600px) { .col-6 { display: block; } .col-12 { display: block; } }
     # @media(max-width: 400px) { .col-12 { display: inline-block; } }
+    # ```
+    #
+    #
     # which would change the styling on the page
     # (before it would've yielded display: block; for .col-12 at max-width: 600px
     # and now it yields inline-block;)
     #
     # If merge_media_queries is set to false,
-    # we will generate #{style_blocks.size} media queries, potentially
+    # we will generate `style_blocks.size` media queries, potentially
     # causing performance issues.
     # @param {Array<StyleBlock>} style_blocks  All style blocks
     # @return {Array<String>}
     def styles_in_individual_media_queries(style_blocks)
       style_blocks.map do |css_rule|
-        if css_rule.media == ['all']
+        if css_rule.media == ["all"]
           css_rule
         else
-          "@media #{css_rule.media.join(', ')} {\n#{css_rule}\n}"
+          "@media #{css_rule.media.join(", ")} {\n#{css_rule}\n}"
         end
       end
     end

data/lib/roadie/markup_improver.rb

@@ -7,13 +7,10 @@ module Roadie
   # This class will improve the following aspects of the DOM:
   # * A HTML5 doctype will be added if missing, other doctypes will be left as-is.
   # * Basic HTML elements will be added if missing.
-  #   * +<html>+
-  #   * +<head>+
-  #   * +<body>+
-  #   * +<meta>+ declaring charset and content-type (text/html)
-  #
-  # @note Due to a Nokogiri bug, the HTML5 doctype cannot be added under JRuby. No doctype is outputted under JRuby.
-  #   See https://github.com/sparklemotion/nokogiri/issues/984
+  #   * `<html>`
+  #   * `<head>`
+  #   * `<body>`
+  #   * `<meta>` declaring charset and content-type (text/html)
   class MarkupImprover
     # The original HTML must also be passed in in order to handle the doctypes
     # since a +Nokogiri::HTML::Document+ will always have a doctype, no matter if
@@ -33,45 +30,39 @@ module Roadie
     end
 
     protected
+
     attr_reader :dom
 
     private
+
     def ensure_doctype_present
-      return if uses_buggy_jruby?
-      return if @html.include?('<!DOCTYPE ')
+      return if @html.include?("<!DOCTYPE ")
       # Nokogiri adds a "default" doctype to the DOM, which we will remove
-      dom.internal_subset.remove unless dom.internal_subset.nil?
-      dom.create_internal_subset 'html', nil, nil
-    end
-
-    # JRuby up to at least 1.6.0 has a bug where the doctype of a document cannot be changed.
-    # See https://github.com/sparklemotion/nokogiri/issues/984
-    def uses_buggy_jruby?
-      # No reason to check for version yet since no existing version has a fix.
-      defined?(JRuby)
+      dom.internal_subset&.remove
+      dom.create_internal_subset "html", nil, nil
     end
 
     def ensure_html_element_present
-      return if dom.at_xpath('html')
-      html = Nokogiri::XML::Node.new 'html', dom
+      return if dom.at_xpath("html")
+      html = Nokogiri::XML::Node.new "html", dom
       dom << html
     end
 
     def ensure_head_element_present
-      if (head = dom.at_xpath('html/head'))
+      if (head = dom.at_xpath("html/head"))
         head
       else
-        create_head_element dom.at_xpath('html')
+        create_head_element dom.at_xpath("html")
       end
     end
 
     def create_head_element(parent)
-      head = Nokogiri::XML::Node.new 'head', dom
-      unless parent.children.empty?
+      head = Nokogiri::XML::Node.new "head", dom
+      if parent.children.empty?
+        parent << head
+      else
         # Crashes when no children are present
         parent.children.before head
-      else
-        parent << head
       end
       head
     end
@@ -83,15 +74,15 @@ module Roadie
     end
 
     def content_type_meta_element_missing?
-      dom.xpath('html/head/meta').none? do |meta|
-        meta['http-equiv'].to_s.downcase == 'content-type'
+      dom.xpath("html/head/meta").none? do |meta|
+        meta["http-equiv"].to_s.downcase == "content-type"
       end
     end
 
     def make_content_type_element
-      meta = Nokogiri::XML::Node.new('meta', dom)
-      meta['http-equiv'] = 'Content-Type'
-      meta['content'] = 'text/html; charset=UTF-8'
+      meta = Nokogiri::XML::Node.new("meta", dom)
+      meta["http-equiv"] = "Content-Type"
+      meta["content"] = "text/html; charset=UTF-8"
       meta
     end
   end