roadie 3.5.1 → 5.1.0

data/lib/roadie/inliner.rb

@@ -1,19 +1,28 @@
-require 'set'
-require 'nokogiri'
-require 'uri'
-require 'css_parser'
+# frozen_string_literal: true
+
+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
@@ -45,9 +54,11 @@ module Roadie
     end
 
     protected
+
     attr_reader :stylesheets, :dom
 
     private
+
     def consume_stylesheets
       style_map = StyleMap.new
       extra_blocks = []
@@ -89,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
 
@@ -120,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
@@ -139,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
@@ -157,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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Roadie
   # @api private
   # Class that improves the markup of a HTML DOM tree
@@ -5,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
@@ -31,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
@@ -81,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

data/lib/roadie/net_http_provider.rb

@@ -1,7 +1,8 @@
-# encoding: UTF-8
-require 'set'
-require 'uri'
-require 'net/http'
+# frozen_string_literal: true
+
+require "set"
+require "uri"
+require "net/http"
 
 module Roadie
   # @api public
@@ -33,19 +34,29 @@ module Roadie
 
     def find_stylesheet!(url)
       response = download(url)
-      if response.kind_of? Net::HTTPSuccess
+      if response.is_a? Net::HTTPSuccess
         Stylesheet.new(url, response_body(response))
       else
-        raise CssNotFound.new(url, "Server returned #{response.code}: #{truncate response.body}", self)
+        raise CssNotFound.new(
+          css_name: url,
+          message: "Server returned #{response.code}: #{truncate response.body}",
+          provider: self
+        )
       end
     rescue Timeout::Error
-      raise CssNotFound.new(url, "Timeout", self)
+      raise CssNotFound.new(css_name: url, message: "Timeout", provider: self)
     end
 
-    def to_s() inspect end
-    def inspect() "#<#{self.class} whitelist: #{whitelist.inspect}>" end
+    def to_s
+      inspect
+    end
+
+    def inspect
+      "#<#{self.class} whitelist: #{whitelist.inspect}>"
+    end
 
     private
+
     def host_set(hosts)
       hosts.each { |host| validate_host(host) }.to_set
     end
@@ -62,7 +73,11 @@ module Roadie
       if access_granted_to?(uri.host)
         get_response(uri)
       else
-        raise CssNotFound.new(url, "#{uri.host} is not part of whitelist!", self)
+        raise CssNotFound.new(
+          css_name: url,
+          message: "#{uri.host} is not part of whitelist!",
+          provider: self
+        )
       end
     end
 
@@ -70,7 +85,7 @@ module Roadie
       if RUBY_VERSION >= "2.0.0"
         Net::HTTP.get_response(uri)
       else
-        Net::HTTP.start(uri.host, uri.port, use_ssl: (uri.scheme == 'https')) do |http|
+        Net::HTTP.start(uri.host, uri.port, use_ssl: (uri.scheme == "https")) do |http|
           http.request(Net::HTTP::Get.new(uri.request_uri))
         end
       end
@@ -91,7 +106,7 @@ module Roadie
     def response_body(response)
       # Make sure we respect encoding because Net:HTTP will encode body as ASCII by default
       # which will break if the response is not compatible.
-      supplied_charset = response.type_params['charset']
+      supplied_charset = response.type_params["charset"]
       body = response.body
 
       if supplied_charset

data/lib/roadie/null_provider.rb

@@ -1,16 +1,31 @@
+# frozen_string_literal: true
+
 module Roadie
   # An asset provider that returns empty stylesheets for any name.
   #
   # Use it to ignore missing assets or in your tests when you need a provider
   # but you do not care what it contains or that it is even referenced at all.
   class NullProvider
-    def find_stylesheet(name) empty_stylesheet end
-    def find_stylesheet!(name) empty_stylesheet end
+    def find_stylesheet(name)
+      empty_stylesheet
+    end
+
+    def find_stylesheet!(name)
+      empty_stylesheet
+    end
 
-    def to_s() inspect end
-    def inspect() "#<#{self.class}>" end
+    def to_s
+      inspect
+    end
+
+    def inspect
+      "#<#{self.class}>"
+    end
 
     private
-    def empty_stylesheet() Stylesheet.new "(null)", "" end
+
+    def empty_stylesheet
+      Stylesheet.new "(null)", ""
+    end
   end
 end

data/lib/roadie/null_url_rewriter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Roadie
   # @api private
   # Null Object for the URL rewriter role.
@@ -5,8 +7,14 @@ module Roadie
   # Used whenever client does not pass any URL options and no URL rewriting
   # should take place.
   class NullUrlRewriter
-    def initialize(generator = nil) end
-    def transform_dom(dom) end
-    def transform_css(css) end
+    def initialize(generator = nil)
+    end
+
+    def transform_dom(dom)
+    end
+
+    def transform_css(css)
+      css
+    end
   end
 end

data/lib/roadie/path_rewriter_provider.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Roadie
   # @api public
   # This provider acts a bit like a pipeline in normal UNIX parlour by enabling
@@ -57,7 +59,10 @@ module Roadie
       if new_path
         provider.find_stylesheet!(new_path)
       else
-        raise CssNotFound, "Filter returned #{new_path.inspect}"
+        raise CssNotFound.new(
+          css_name: path,
+          message: "Filter returned #{new_path.inspect}"
+        )
       end
     end
   end

data/lib/roadie/provider_list.rb

@@ -1,4 +1,6 @@
-require 'forwardable'
+# frozen_string_literal: true
+
+require "forwardable"
 
 module Roadie
   # An asset provider that just composes a list of other asset providers.
@@ -23,7 +25,7 @@ module Roadie
     # @overload wrap(provider1, provider2, ...)
     #   @return a new {ProviderList} with all the passed providers in it.
     def self.wrap(*providers)
-      if providers.size == 1 && providers.first.class == self
+      if providers.size == 1 && providers.first.instance_of?(self)
         providers.first
       else
         new(providers.flatten)
@@ -31,7 +33,9 @@ module Roadie
     end
 
     # Returns a new empty list.
-    def self.empty() new([]) end
+    def self.empty
+      new([])
+    end
 
     def initialize(providers)
       @providers = providers
@@ -53,13 +57,13 @@ module Roadie
     def find_stylesheet!(name)
       errors = []
       @providers.each do |provider|
-        begin
-          return provider.find_stylesheet!(name)
-        rescue CssNotFound => error
-          errors << error
-        end
+        return provider.find_stylesheet!(name)
+      rescue CssNotFound => error
+        errors << error
       end
-      raise ProvidersFailed.new(name, self, errors)
+      raise ProvidersFailed.new(
+        css_name: name, providers: self, errors: errors
+      )
     end
 
     def to_s
@@ -67,12 +71,14 @@ module Roadie
         # Indent every line one level
         provider.to_s.split("\n").join("\n\t")
       }
-      "ProviderList: [\n\t#{list.join(",\n\t")}\n]"
+      "ProviderList: [\n\t#{list.join(",\n\t")}\n]\n"
     end
 
     # ProviderList can be coerced to an array. This makes Array#flatten work
     # with it, among other things.
-    def to_ary() to_a end
+    def to_ary
+      to_a
+    end
 
     # @!method each
     #   @see Array#each

data/lib/roadie/rspec/asset_provider.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 shared_examples_for "roadie asset provider" do |options|
   valid_name = options[:valid_name] or raise "You must provide a :valid_name option to the shared examples"
   invalid_name = options[:invalid_name] or raise "You must provide an :invalid_name option to the shared examples"
@@ -43,7 +45,10 @@ shared_examples_for "roadie asset provider" do |options|
     it "raises Roadie::CssNotFound on invalid stylesheets" do
       expect {
         subject.find_stylesheet!(invalid_name)
-      }.to raise_error Roadie::CssNotFound, Regexp.new(Regexp.quote(invalid_name))
+      }.to raise_error(
+        Roadie::CssNotFound,
+        Regexp.new(Regexp.quote(invalid_name))
+      )
     end
   end
 end

data/lib/roadie/rspec/cache_store.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 shared_examples_for "roadie cache store" do
   it "allows storing Stylesheets" do
     stylesheet = Roadie::Stylesheet.new("foo.css", "body { color: green; }")

data/lib/roadie/rspec.rb

@@ -1,2 +1,4 @@
-require 'roadie/rspec/asset_provider'
-require 'roadie/rspec/cache_store'
+# frozen_string_literal: true
+
+require "roadie/rspec/asset_provider"
+require "roadie/rspec/cache_store"

data/lib/roadie/selector.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Roadie
   # @api private
   #
@@ -35,9 +37,17 @@ module Roadie
       !(pseudo_element? || at_rule? || pseudo_function?)
     end
 
-    def to_s() selector end
-    def to_str() to_s end
-    def inspect() selector.inspect end
+    def to_s
+      selector
+    end
+
+    def to_str
+      to_s
+    end
+
+    def inspect
+      selector.inspect
+    end
 
     # {Selector}s are equal to other {Selector}s if, and only if, their string
     # representations are equal.
@@ -50,22 +60,25 @@ module Roadie
     end
 
     protected
+
     attr_reader :selector
 
     private
+
     BAD_PSEUDO_FUNCTIONS = %w[
       :active :focus :hover :link :target :visited
       :-ms-input-placeholder :-moz-placeholder
       :before :after
       :enabled :disabled :checked
+      :host
     ].freeze
 
     def pseudo_element?
-      selector.include? '::'
+      selector.include? "::"
     end
 
     def at_rule?
-      selector[0, 1] == '@'
+      selector[0, 1] == "@"
     end
 
     def pseudo_function?

data/lib/roadie/style_attribute_builder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Roadie
   class StyleAttributeBuilder
     def initialize
@@ -9,10 +11,11 @@ module Roadie
     end
 
     def attribute_string
-      Deduplicator.apply(stable_sort(@styles).map(&:to_s)).join(';')
+      Deduplicator.apply(stable_sort(@styles).map(&:to_s)).join(";")
     end
 
     private
+
     def stable_sort(list)
       # Ruby's sort is unstable for performance reasons. We need it to be
       # stable, e.g. to preserve order of elements that are compared equal in

data/lib/roadie/style_block.rb

@@ -1,4 +1,6 @@
-require 'forwardable'
+# frozen_string_literal: true
+
+require "forwardable"
 
 module Roadie
   # @api private
@@ -37,7 +39,7 @@ module Roadie
     # @return {String}
     def to_s
       # NB - leave off redundant final semicolon - see https://www.w3.org/TR/CSS2/syndata.html#declaration
-      "#{selector}{#{properties.map(&:to_s).join(';')}}"
+      "#{selector}{#{properties.map(&:to_s).join(";")}}"
     end
 
     private
@@ -47,7 +49,7 @@ module Roadie
     # @media only screen and (max-width: 600px) {...} cannot be inlined
     # @return {Boolean}
     def inlinable_media?
-      @media.none? { |media_query| media_query.include? '(' }
+      @media.none? { |media_query| media_query.include? "(" }
     end
   end
 end

data/lib/roadie/style_property.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Roadie
   # @api private
   # Domain object for a CSS property such as "color: red !important".
@@ -36,14 +38,15 @@ module Roadie
     end
 
     def to_s
-      [property, value_with_important].join(':')
+      [property, value_with_important].join(":")
     end
 
     def inspect
-      "#{to_s} (#{specificity})"
+      "#{self} (#{specificity})"
     end
 
     private
+
     def value_with_important
       if important
         "#{value} !important"

data/lib/roadie/stylesheet.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Roadie
   # Domain object that represents a stylesheet (from disc, perhaps).
   #
@@ -6,7 +8,7 @@ module Roadie
   # @attr_reader [String] name the name of the stylesheet ("stylesheets/main.css", "Admin user styles", etc.). The name of the stylesheet will be visible if any errors occur.
   # @attr_reader [Array<StyleBlock>] blocks
   class Stylesheet
-    BOM = "\xEF\xBB\xBF".force_encoding('UTF-8').freeze
+    BOM = (+"\xEF\xBB\xBF").force_encoding("UTF-8").freeze
 
     attr_reader :name, :blocks
 
@@ -19,23 +21,12 @@ module Roadie
       @blocks = parse_blocks(css.sub(BOM, ""))
     end
 
-    # @yield [selector, properties]
-    # @yieldparam [Selector] selector
-    # @yieldparam [Array<StyleProperty>] properties
-    # @deprecated Iterate over the #{blocks} instead. Will be removed on version 4.0.
-    def each_inlinable_block(&block)
-      # #map and then #each in order to support chained enumerations, etc. if
-      # no block is provided
-      inlinable_blocks.map { |style_block|
-        [style_block.selector, style_block.properties]
-      }.each(&block)
-    end
-
     def to_s
       blocks.join("\n")
     end
 
     private
+
     def inlinable_blocks
       blocks.select(&:inlinable?)
     end