roadie 3.5.1 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19c2bb2df5f06249e20336bee272088f2224749fcb20741c411647428221e20e
-  data.tar.gz: cd7e290f724bf71fd8b56d8f013ebc2dd246b5594fc730d5899639d1dbdada38
+  metadata.gz: 39c01590157057fcedad04740a1594a45f18150d74c7e8fe071dd3aea6908e1f
+  data.tar.gz: 490cc578b42057ca635ce613d8e50b05401b0a07597761f70423467aa99aa673
 SHA512:
-  metadata.gz: 8767e97ed3592ff69e969d646537775b9a0c571d62f54bb02555e102f5acedf5813435d0f4b1b58b52adb4187608cfe33020a7019c98aebd8ad5077ef3e3b4e8
-  data.tar.gz: 220fdd872e42acea4e4aebe9dc04f34d3a9e996254d5135af4663d98534362ade3b0d1c21368afd6c046282814b4f0d061f8e20f14451d295fb511f0c4888366
+  metadata.gz: d71f85f1aba91c711351972b65074835f690f62d0cd4a0feb663f67df89a86d8acddc855fe7be4e23601fe3b0508c1558f6c18cc260c69c1ad5b1b1857ad04e2
+  data.tar.gz: 1d708c10a62800d44efbe825601546a8713b953f81a2549d91a23e74e26048839adc418d38c38bbd08bd885bc6504a3a07c5cca46f94d3ad147d347f3086ffaa

data/.github/workflows/main.yml

@@ -0,0 +1,46 @@
+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
+    permissions:
+      checks: write
+      contents: read

data/.rubocop.yml

@@ -0,0 +1,5 @@
+AllCops:
+  DisabledByDefault: true
+
+Style/FrozenStringLiteralComment:
+  Enabled: true

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,10 +1,42 @@
 ### dev
 
-### dev
+[full changelog](https://github.com/Mange/roadie/compare/v5.1.0...master)
+
+### 5.1.0
+
+[full changelog](https://github.com/Mange/roadie/compare/v5.0.1...v5.1.0)
+
+* Support passing serialization options to Nokogiri with `serialization_options=` method -
+  [Dmytro Savochkin](https://github.com/dmytro-savochkin). (#171)
+
+### 5.0.1
+
+[full changelog](https://github.com/Mange/roadie/compare/v5.0.0...v5.0.1)
 
-[full changelog](https://github.com/Mange/roadie/compare/v3.5.1...master)
+* Don't try to inline [the `:host`
+  pseudo-class](https://developer.mozilla.org/en-US/docs/Web/CSS/:host) -
+  [viamin (Bart Agapinan)](https://github.com/viamin). (#170)
 
-* 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)
+
+* 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
 
@@ -380,4 +412,3 @@ Roadie fork!
   * + some other enhancements
 * Deprecations:
   * Removed support for Rails 2.x
-

data/Gemfile

@@ -1,5 +1,10 @@
-source 'https://rubygems.org'
+# frozen_string_literal: true
+
+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)
@@ -55,7 +54,7 @@ Install & Usage
 [Add this gem to your Gemfile as recommended by Rubygems](http://rubygems.org/gems/roadie) and run `bundle install`.
 
 ```ruby
-gem 'roadie', '~> 3.5'
+gem 'roadie', '~> 4.0'
 ```
 
 You can then create a new instance of a Roadie document:
@@ -95,6 +94,8 @@ Your document instance can be configured with several options:
 * `external_asset_providers` - A list of asset providers that are invoked when absolute CSS URLs are referenced. See below.
 * `before_transformation` - A callback run before transformation starts.
 * `after_transformation` - A callback run after transformation is completed.
+* `serialization_options` - An integer bitmap of options passed along to Nokogiri during serialization.
+By default it's `Nokogiri::XML::Node::SaveOptions::NO_DECLARATION | Nokogiri::XML::Node::SaveOptions::NO_EMPTY_TAGS`.
 
 ### Making URLs absolute ###
 
@@ -333,7 +334,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 +448,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 +565,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,5 +1,6 @@
-# encoding: utf-8
-require 'bundler/setup'
+# frozen_string_literal: true
+
+require "bundler/setup"
 
 Bundler::GemHelper.install_tasks
 
@@ -9,4 +10,4 @@ task :spec do
 end
 
 desc "Default: Run specs"
-task :default => :spec
+task default: :spec

data/lib/roadie/asset_provider.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Roadie
   # This module can be included in your own code to help you implement the
   # standard behavior for asset providers.
@@ -5,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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Roadie
   # @api private
   #
@@ -41,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
@@ -73,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
@@ -84,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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Roadie
   # @api public
   # The {CachedProvider} wraps another provider (or {ProviderList}) and caches
@@ -67,6 +69,7 @@ module Roadie
     end
 
     private
+
     def cache_fetch(name)
       cache[name] || cache[name] = yield
     rescue CssNotFound

data/lib/roadie/deduplicator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Roadie
   class Deduplicator
     def self.apply(input)
@@ -24,6 +26,7 @@ module Roadie
     end
 
     private
+
     attr_reader :input, :latest_occurance
 
     def has_duplicates?

data/lib/roadie/document.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Roadie
   # The main entry point for Roadie. A document represents a working unit and
   # is built with the input HTML and the configuration options you need.
@@ -40,6 +42,10 @@ module Roadie
     # which would change the styling on the page
     attr_accessor :merge_media_queries
 
+    # Integer representing a bitmap set of options used by Nokogiri during serialization.
+    # For the complete set of available options look into +Nokogiri::XML::Node::SaveOptions+.
+    attr_reader :serialization_options
+
     # The mode to generate markup in. Valid values are `:html` (default) and `:xhtml`.
     attr_reader :mode
 
@@ -47,10 +53,13 @@ module Roadie
     def initialize(html)
       @keep_uninlinable_css = true
       @merge_media_queries = true
+      @serialization_options =
+        Nokogiri::XML::Node::SaveOptions::NO_DECLARATION |
+        Nokogiri::XML::Node::SaveOptions::NO_EMPTY_TAGS
       @html = html
       @asset_providers = ProviderList.wrap(FilesystemProvider.new)
       @external_asset_providers = ProviderList.empty
-      @css = ""
+      @css = +""
       @mode = :html
     end
 
@@ -135,11 +144,19 @@ module Roadie
       @external_asset_providers = ProviderList.wrap(list)
     end
 
+    # Integer representing a bitmap set of options used by Nokogiri during serialization.
+    # For the complete set of available options look into +Nokogiri::XML::Node::SaveOptions+.
+    # (To change the mode in which the document is generated use {#mode=} however.)
+    def serialization_options=(options)
+      @serialization_options = options || 0
+    end
+
     # Change the mode. The mode affects how the resulting markup is generated.
     #
     # Valid modes:
     #   `:html` (default)
     #   `:xhtml`
+    #   `:xml`
     def mode=(mode)
       if VALID_MODES.include?(mode)
         @mode = mode
@@ -149,7 +166,8 @@ module Roadie
     end
 
     private
-    VALID_MODES = %i[html xhtml].freeze
+
+    VALID_MODES = %i[html xhtml xml].freeze
     private_constant :VALID_MODES
 
     def stylesheet
@@ -166,7 +184,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
 
@@ -180,15 +198,10 @@ module Roadie
       format = {
         html: save_options::AS_HTML,
         xhtml: save_options::AS_XHTML,
+        xml: save_options::AS_XML
       }.fetch(mode)
 
-      dom.dup.to_html(
-        save_with: (
-          save_options::NO_DECLARATION |
-          save_options::NO_EMPTY_TAGS |
-          format
-        ),
-      )
+      dom.dup.to_html(save_with: (serialization_options | format))
     end
 
     def make_url_rewriter
@@ -201,13 +214,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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Roadie
   # Base class for all Roadie errors. Rescue this if you want to catch errors
   # from Roadie.
@@ -16,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
@@ -41,24 +43,23 @@ 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)
-      message = %(Could not find stylesheet "#{css_name}")
+
+    def build_message
+      message = +%(Could not find stylesheet "#{css_name}")
       message << ": #{extra_message}" if extra_message
       message << "\nUsed provider:\n#{provider}" if provider
       message
@@ -68,14 +69,19 @@ 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)
-      message = %(Could not find stylesheet "#{css_name}": #{extra_message}\nUsed providers:\n)
+
+    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"
       end

data/lib/roadie/filesystem_provider.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Roadie
   # Asset provider that looks for files on your local filesystem.
   #
@@ -30,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[/^([^?]+)/])