roadie 3.5.1 → 5.1.0

data/lib/roadie/url_generator.rb

@@ -1,4 +1,6 @@
-require 'set'
+# frozen_string_literal: true
+
+require "set"
 
 module Roadie
   # @api private
@@ -21,8 +23,15 @@ module Roadie
     # @option url_options [String] :scheme URL scheme ("http" is default)
     # @option url_options [String] :protocol alias for :scheme
     def initialize(url_options)
-      raise ArgumentError, "No URL options were specified" unless url_options
-      raise ArgumentError, "No :host was specified; options are: #{url_options.inspect}" unless url_options[:host]
+      unless url_options
+        raise ArgumentError, "No URL options were specified"
+      end
+
+      unless url_options[:host]
+        raise ArgumentError,
+          "No :host was specified; options were: #{url_options.inspect}"
+      end
+
       validate_options url_options
 
       @url_options = url_options
@@ -56,7 +65,7 @@ module Roadie
     # @param [String] base The base which the relative path comes from
     # @return [String] an absolute URL
     def generate_url(path, base = "/")
-      return root_uri.to_s if path.nil? or path.empty?
+      return root_uri.to_s if path.nil? || path.empty?
       return path if path_is_anchor?(path)
       return add_scheme(path) if path_is_schemeless?(path)
       return path if Utils.path_is_absolute?(path)
@@ -65,13 +74,20 @@ module Roadie
     end
 
     protected
+
     attr_reader :root_uri, :scheme
 
     private
+
     def build_root_uri
       path = make_absolute url_options[:path]
       port = parse_port url_options[:port]
-      URI::Generic.build(scheme: scheme, host: url_options[:host], port: port, path: path)
+      URI::Generic.build(
+        scheme: scheme,
+        host: url_options[:host],
+        port: port,
+        path: path
+      )
     end
 
     def add_scheme(path)
@@ -96,7 +112,7 @@ module Roadie
 
     # Strip :// from any scheme, if present
     def normalize_scheme(scheme)
-      return 'http' unless scheme
+      return "http" unless scheme
       scheme.to_s[/^\w+/]
     end
 
@@ -117,7 +133,7 @@ module Roadie
     end
 
     def path_is_anchor?(path)
-      path.start_with? '#'
+      path.start_with? "#"
     end
 
     VALID_OPTIONS = Set[:host, :port, :path, :protocol, :scheme].freeze
@@ -125,7 +141,9 @@ module Roadie
     def validate_options(options)
       keys = Set.new(options.keys)
       unless keys.subset? VALID_OPTIONS
-        raise ArgumentError, "Passed invalid options: #{(keys - VALID_OPTIONS).to_a}, valid options are: #{VALID_OPTIONS.to_a}"
+        raise ArgumentError,
+          "Passed invalid options: #{(keys - VALID_OPTIONS).to_a}, " \
+            "valid options are: #{VALID_OPTIONS.to_a}"
       end
     end
   end

data/lib/roadie/url_rewriter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Roadie
   # @api private
   #
@@ -23,9 +25,9 @@ module Roadie
       dom.css(
         "a[href]:not([data-roadie-ignore]), " \
           "img[src]:not([data-roadie-ignore]), " \
-          "*[style]:not([data-roadie-ignore])",
+          "*[style]:not([data-roadie-ignore])"
       ).each do |element|
-        transform_element_style element if element.has_attribute?('style')
+        transform_element_style element if element.has_attribute?("style")
         transform_element element
       end
       nil
@@ -35,20 +37,22 @@ module Roadie
     #
     # This will make all URLs inside url() absolute.
     #
-    # [nil] is returned so no one can misunderstand that this method mutates
-    # the passed string.
+    # Copy of CSS that is mutated is returned, passed string is not mutated.
     #
     # @param [String] css the css to mutate
-    # @return [nil] css is mutated
+    # @return [String] copy of css that is mutated
     def transform_css(css)
-      css.gsub!(CSS_URL_REGEXP) do
+      css.gsub(CSS_URL_REGEXP) do
         matches = Regexp.last_match
         "url(#{matches[:quote]}#{generate_url(matches[:url])}#{matches[:quote]})"
       end
     end
 
     private
-    def generate_url(*args) @generator.generate_url(*args) end
+
+    def generate_url(*args)
+      @generator.generate_url(*args)
+    end
 
     # Regexp matching all the url() declarations in CSS
     #
@@ -81,8 +85,7 @@ module Roadie
       # We need to use a setter for Nokogiri to detect the string mutation.
       # If nokogiri used "dumber" data structures, this would all be redundant.
       css = element["style"]
-      transform_css css
-      element["style"] = css
+      element["style"] = transform_css(css)
     end
   end
 end

data/lib/roadie/utils.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Roadie
   module Utils
     # @api private
@@ -8,7 +10,7 @@ module Roadie
       #
       # URLs that start with double slashes (//css/app.css) are also absolute
       # in modern browsers, but most email clients do not understand them.
-      return true if path =~ %r{^(\w+:|//)}
+      return true if %r{^(\w+:|//)}.match?(path)
 
       begin
         !URI.parse(path).relative?

data/lib/roadie/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Roadie
-  VERSION = "3.5.1"
+  VERSION = "5.1.0"
 end

data/lib/roadie.rb

@@ -1,30 +1,32 @@
+# frozen_string_literal: true
+
 module Roadie
 end
 
-require 'roadie/version'
-require 'roadie/errors'
+require "roadie/version"
+require "roadie/errors"
 
-require 'roadie/utils'
-require 'roadie/deduplicator'
+require "roadie/utils"
+require "roadie/deduplicator"
 
-require 'roadie/stylesheet'
-require 'roadie/selector'
-require 'roadie/style_property'
-require 'roadie/style_attribute_builder'
-require 'roadie/style_block'
+require "roadie/stylesheet"
+require "roadie/selector"
+require "roadie/style_property"
+require "roadie/style_attribute_builder"
+require "roadie/style_block"
 
-require 'roadie/asset_provider'
-require 'roadie/provider_list'
-require 'roadie/filesystem_provider'
-require 'roadie/null_provider'
-require 'roadie/net_http_provider'
-require 'roadie/cached_provider'
-require 'roadie/path_rewriter_provider'
+require "roadie/asset_provider"
+require "roadie/provider_list"
+require "roadie/filesystem_provider"
+require "roadie/null_provider"
+require "roadie/net_http_provider"
+require "roadie/cached_provider"
+require "roadie/path_rewriter_provider"
 
-require 'roadie/asset_scanner'
-require 'roadie/markup_improver'
-require 'roadie/url_generator'
-require 'roadie/url_rewriter'
-require 'roadie/null_url_rewriter'
-require 'roadie/inliner'
-require 'roadie/document'
+require "roadie/asset_scanner"
+require "roadie/markup_improver"
+require "roadie/url_generator"
+require "roadie/url_rewriter"
+require "roadie/null_url_rewriter"
+require "roadie/inliner"
+require "roadie/document"

data/roadie.gemspec

@@ -1,33 +1,33 @@
 # roadie.gemspec
-# -*- encoding: utf-8 -*-
+# frozen_string_literal: true
 
 $:.push File.expand_path("../lib", __FILE__)
-require 'roadie/version'
+require "roadie/version"
 
 Gem::Specification.new do |s|
-  s.name        = 'roadie'
-  s.version     = Roadie::VERSION
-  s.platform    = Gem::Platform::RUBY
-  s.authors     = ['Magnus Bergmark']
-  s.email       = ['magnus.bergmark@gmail.com']
-  s.homepage    = 'http://github.com/Mange/roadie'
-  s.summary     = %q{Making HTML emails comfortable for the Ruby rockstars}
-  s.description = %q{Roadie tries to make sending HTML emails a little less painful by inlining stylesheets and rewriting relative URLs for you.}
-  s.license     = "MIT"
-
-  s.required_ruby_version = ">= 1.9"
-
-  s.add_dependency 'nokogiri', '~> 1.8'
-  s.add_dependency 'css_parser', '~> 1.4'
-
-  s.add_development_dependency 'rspec', '~> 3.0'
-  s.add_development_dependency 'rspec-collection_matchers', '~> 1.0'
-  s.add_development_dependency 'webmock', '~> 3.0'
+  s.name = "roadie"
+  s.version = Roadie::VERSION
+  s.platform = Gem::Platform::RUBY
+  s.authors = ["Magnus Bergmark"]
+  s.email = ["magnus.bergmark@gmail.com"]
+  s.homepage = "http://github.com/Mange/roadie"
+  s.summary = "Making HTML emails comfortable for the Ruby rockstars"
+  s.description = "Roadie tries to make sending HTML emails a little less painful by inlining stylesheets and rewriting relative URLs for you."
+  s.license = "MIT"
+
+  s.required_ruby_version = ">= 2.6"
+
+  s.add_dependency "nokogiri", "~> 1.8"
+  s.add_dependency "css_parser", "~> 1.4"
+
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec", "~> 3.0"
+  s.add_development_dependency "rspec-collection_matchers", "~> 1.0"
+  s.add_development_dependency "webmock", "~> 3.0"
 
   s.extra_rdoc_files = %w[README.md Changelog.md]
   s.require_paths = %w[lib]
 
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- spec/*`.split("\n")
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- spec/*`.split("\n")
 end
-

data/spec/hash_as_cache_store_spec.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 require "roadie/rspec"
 
 describe "Using Hash as a cache store" do
-  subject(:hash) { Hash.new }
+  subject(:hash) { {} }
   it_behaves_like "roadie cache store"
 end

data/spec/integration_spec.rb

@@ -1,4 +1,6 @@
-require 'spec_helper'
+# frozen_string_literal: true
+
+require "spec_helper"
 
 describe "Roadie functionality" do
   describe "on full documents" do
@@ -11,14 +13,7 @@ describe "Roadie functionality" do
       document = Roadie::Document.new(html)
       result = document.transform
 
-      unless defined?(JRuby)
-        # JRuby has a bug that makes DTD manipulation impossible
-        # See Nokogiri bugs #984 and #985
-        # https://github.com/sparklemotion/nokogiri/issues/984
-        # https://github.com/sparklemotion/nokogiri/issues/985
-        expect(result).to include("<!DOCTYPE html>")
-      end
-
+      expect(result).to include("<!DOCTYPE html>")
       expect(result).to include("<html>")
       expect(result).to include("<head>")
       expect(result).to include("<body>")
@@ -45,8 +40,8 @@ describe "Roadie functionality" do
       CSS
 
       result = parse_html document.transform
-      expect(result).to have_styling('text-align' => 'center').at_selector('h1')
-      expect(result).to have_styling('color' => 'red').at_selector('p > em')
+      expect(result).to have_styling("text-align" => "center").at_selector("h1")
+      expect(result).to have_styling("color" => "red").at_selector("p > em")
     end
 
     it "stores styles that cannot be inlined in the <head>" do
@@ -110,7 +105,7 @@ describe "Roadie functionality" do
       HTML
 
       result = parse_html document.transform
-      expect(result).to have_styling('font-size' => '200%').at_selector('p > em')
+      expect(result).to have_styling("font-size" => "200%").at_selector("p > em")
     end
 
     it "crashes when stylesheets cannot be found, unless using NullProvider" do
@@ -125,7 +120,9 @@ describe "Roadie functionality" do
         </html>
       HTML
 
-      expect { document.transform }.to raise_error(Roadie::CssNotFound, /does_not_exist\.css/)
+      expect {
+        document.transform
+      }.to raise_error(Roadie::CssNotFound, /does_not_exist\.css/)
 
       document.asset_providers << Roadie::NullProvider.new
       expect { document.transform }.to_not raise_error
@@ -149,8 +146,8 @@ describe "Roadie functionality" do
       document.external_asset_providers = []
 
       result = parse_html document.transform
-      expect(result).to have_selector('head > link')
-      expect(result).to have_styling([]).at_selector('p > em')
+      expect(result).to have_selector("head > link")
+      expect(result).to have_styling([]).at_selector("p > em")
     end
 
     it "inlines external css if configured" do
@@ -173,8 +170,8 @@ describe "Roadie functionality" do
       )
 
       result = parse_html document.transform
-      expect(result).to have_styling('font-size' => '200%').at_selector('p > em')
-      expect(result).to_not have_selector('head > link')
+      expect(result).to have_styling("font-size" => "200%").at_selector("p > em")
+      expect(result).to_not have_selector("head > link")
     end
 
     it "does not inline the same properties several times" do
@@ -195,8 +192,8 @@ describe "Roadie functionality" do
 
       result = parse_html document.transform
       expect(result).to have_styling([
-        ['color', 'red']
-      ]).at_selector('p')
+        ["color", "red"]
+      ]).at_selector("p")
     end
 
     it "makes URLs absolute" do
@@ -230,7 +227,7 @@ describe "Roadie functionality" do
       ).at_selector("body")
 
       expect(result).to have_styling(
-        "background" => 'url(https://myapp.com/rails/app/assets/link-abcdef1234567890.png)'
+        "background" => "url(https://myapp.com/rails/app/assets/link-abcdef1234567890.png)"
       ).at_selector("a")
     end
 
@@ -322,10 +319,10 @@ describe "Roadie functionality" do
       )
 
       result = parse_html document.transform
-      expect(result).to have_styling('color' => 'green').at_selector('.colorful')
+      expect(result).to have_styling("color" => "green").at_selector(".colorful")
     end
 
-    it 'puts non-inlineable media queries in the head' do
+    it "puts non-inlineable media queries in the head" do
       document = Roadie::Document.new <<-HTML
         <html>
           <head>
@@ -351,18 +348,18 @@ describe "Roadie functionality" do
 
       result = parse_html document.transform
 
-      styles = result.at_css('html > head > style').text
+      styles = result.at_css("html > head > style").text
       expected_result = <<-CSS
         @media screen and (max-width 800px) { .colorful{color:blue} }
         @media screen, print and (max-width 800px) { .colorful{color:blue} }
       CSS
-      expected_result = expected_result.gsub(/[\s]+/, ' ').strip
-      actual_result = styles.gsub(/[\s]+/, ' ').strip
+      expected_result = expected_result.gsub(/\s+/, " ").strip
+      actual_result = styles.gsub(/\s+/, " ").strip
 
       expect(actual_result).to eq(expected_result)
     end
 
-    it 'groups non-inlineable media queries in the head by default' do
+    it "groups non-inlineable media queries in the head by default" do
       document = Roadie::Document.new <<-HTML
         <html>
           <head>
@@ -388,20 +385,52 @@ describe "Roadie functionality" do
 
       result = parse_html document.transform
 
-      styles = result.at_css('html > head > style').text
+      styles = result.at_css("html > head > style").text
       expected_result = <<-CSS
         @media screen and (max-width 600px) {
           .colorful{color:red;width:600px}
           .colorful-2{color:red;width:600px}
         }
       CSS
-      expected_result = expected_result.gsub(/[\s]+/, ' ').strip
-      actual_result = styles.gsub(/[\s]+/, ' ').strip
+      expected_result = expected_result.gsub(/\s+/, " ").strip
+      actual_result = styles.gsub(/\s+/, " ").strip
 
       expect(actual_result).to eq(expected_result)
     end
 
-    describe 'if merge_media_queries is set to false' do
+    it "adds XML declaration into XHTML with no serialization options prohibiting it" do
+      document = Roadie::Document.new <<-HTML
+        <html>
+          <head>
+            <title>Greetings</title>
+          </head>
+        </html>
+      HTML
+
+      document.mode = :xhtml
+      document.serialization_options = 0
+      result = document.transform
+
+      expect(result).to match(/\A<\?xml[^>]*?>/i)
+    end
+
+    it "does not add XML declaration into XHTML with serialization options prohibiting it" do
+      document = Roadie::Document.new <<-HTML
+        <html>
+          <head>
+            <title>Greetings</title>
+          </head>
+        </html>
+      HTML
+
+      document.mode = :xhtml
+      document.serialization_options = Nokogiri::XML::Node::SaveOptions::NO_DECLARATION
+      result = document.transform
+
+      expect(result).not_to match(/\A<\?xml[^>]*?>/i)
+    end
+
+    describe "if merge_media_queries is set to false" do
       it "doesn't group non-inlineable media queries in the head" do
         document = Roadie::Document.new <<-HTML
           <html>
@@ -430,7 +459,7 @@ describe "Roadie functionality" do
 
         result = parse_html document.transform
 
-        styles = result.at_css('html > head > style').text
+        styles = result.at_css("html > head > style").text
         expected_result = <<-CSS
           @media screen and (max-width 600px) {
             .colorful{color:red;width:600px}
@@ -439,8 +468,8 @@ describe "Roadie functionality" do
             .colorful-2{color:red;width:600px}
           }
         CSS
-        expected_result = expected_result.gsub(/[\s]+/, ' ').strip
-        actual_result = styles.gsub(/[\s]+/, ' ').strip
+        expected_result = expected_result.gsub(/\s+/, " ").strip
+        actual_result = styles.gsub(/\s+/, " ").strip
 
         expect(actual_result).to eq(expected_result)
       end
@@ -472,8 +501,8 @@ describe "Roadie functionality" do
       CSS
 
       result = parse_html document.transform_partial
-      expect(result).to have_styling('text-align' => 'center').at_selector('h1')
-      expect(result).to have_styling('color' => 'red').at_selector('p > em')
+      expect(result).to have_styling("text-align" => "center").at_selector("h1")
+      expect(result).to have_styling("color" => "red").at_selector("p > em")
     end
 
     it "stores styles that cannot be inlined in a new <style> element" do
@@ -521,7 +550,7 @@ describe "Roadie functionality" do
       HTML
 
       result = parse_html document.transform_partial
-      expect(result).to have_styling('font-size' => '200%').at_selector('p > em')
+      expect(result).to have_styling("font-size" => "200%").at_selector("p > em")
     end
 
     it "crashes when stylesheets cannot be found, unless using NullProvider" do
@@ -529,7 +558,9 @@ describe "Roadie functionality" do
         <link rel="stylesheet" href="/spec/fixtures/does_not_exist.css">
       HTML
 
-      expect { document.transform_partial }.to raise_error(Roadie::CssNotFound, /does_not_exist\.css/)
+      expect {
+        document.transform_partial
+      }.to raise_error(Roadie::CssNotFound, /does_not_exist\.css/)
 
       document.asset_providers << Roadie::NullProvider.new
       expect { document.transform_partial }.to_not raise_error
@@ -545,8 +576,8 @@ describe "Roadie functionality" do
       document.external_asset_providers = []
 
       result = parse_html document.transform_partial
-      expect(result).to have_xpath('./link')
-      expect(result).to have_styling([]).at_selector('p > em')
+      expect(result).to have_xpath("./link")
+      expect(result).to have_styling([]).at_selector("p > em")
     end
 
     it "inlines external css if configured" do
@@ -561,8 +592,8 @@ describe "Roadie functionality" do
       )
 
       result = parse_html document.transform_partial
-      expect(result).to have_styling('font-size' => '200%').at_selector('p > em')
-      expect(result).to_not have_xpath('./link')
+      expect(result).to have_styling("font-size" => "200%").at_selector("p > em")
+      expect(result).to_not have_xpath("./link")
     end
 
     it "does not inline the same properties several times" do
@@ -579,8 +610,8 @@ describe "Roadie functionality" do
 
       result = parse_html document.transform_partial
       expect(result).to have_styling([
-        ['color', 'red']
-      ]).at_selector('p')
+        ["color", "red"]
+      ]).at_selector("p")
     end
 
     it "makes URLs absolute" do
@@ -613,7 +644,7 @@ describe "Roadie functionality" do
       ).at_selector("div")
 
       expect(result).to have_styling(
-        "background" => 'url(https://myapp.com/rails/app/assets/link-abcdef1234567890.png)'
+        "background" => "url(https://myapp.com/rails/app/assets/link-abcdef1234567890.png)"
       ).at_selector("a")
     end
 

data/spec/lib/roadie/asset_scanner_spec.rb

@@ -1,5 +1,6 @@
-# encoding: UTF-8
-require 'spec_helper'
+# frozen_string_literal: true
+
+require "spec_helper"
 
 module Roadie
   describe AssetScanner do
@@ -7,8 +8,13 @@ module Roadie
     let(:external_provider) { ProviderList.empty }
     let(:dom) { dom_document "<html></html>" }
 
-    def dom_fragment(html); Nokogiri::HTML.fragment html; end
-    def dom_document(html); Nokogiri::HTML.parse html; end
+    def dom_fragment(html)
+      Nokogiri::HTML.fragment html
+    end
+
+    def dom_document(html)
+      Nokogiri::HTML.parse html
+    end
 
     it "is initialized with a DOM tree, a normal asset provider set, and an external asset provider set" do
       scanner = AssetScanner.new dom, normal_provider, external_provider
@@ -110,7 +116,7 @@ module Roadie
         expect(scanner.find_css).to eq([])
       end
 
-      it 'ignores HTML comments and CDATA sections' do
+      it "ignores HTML comments and CDATA sections" do
         # TinyMCE posts invalid CSS. We support that just to be pragmatic.
         dom = dom_fragment %(<style><![CDATA[
           <!--

data/spec/lib/roadie/cached_provider_spec.rb

@@ -1,11 +1,13 @@
-require 'spec_helper'
-require 'roadie/rspec'
-require 'shared_examples/asset_provider'
+# frozen_string_literal: true
+
+require "spec_helper"
+require "roadie/rspec"
+require "shared_examples/asset_provider"
 
 module Roadie
   describe CachedProvider do
     let(:upstream) { TestProvider.new("good.css" => "body { color: green; }") }
-    let(:cache) { Hash.new }
+    let(:cache) { {} }
     subject(:provider) { CachedProvider.new(upstream, cache) }
 
     it_behaves_like "roadie asset provider", valid_name: "good.css", invalid_name: "bad.css"

data/spec/lib/roadie/css_not_found_spec.rb

@@ -1,22 +1,27 @@
-require 'spec_helper'
+# frozen_string_literal: true
+
+require "spec_helper"
 
 module Roadie
   describe CssNotFound do
     it "is initialized with a name" do
-      error = CssNotFound.new('style.css')
-      expect(error.css_name).to eq('style.css')
+      error = CssNotFound.new(css_name: "style.css")
+      expect(error.css_name).to eq("style.css")
       expect(error.message).to eq('Could not find stylesheet "style.css"')
     end
 
     it "can be initialized with an extra message" do
-      expect(CssNotFound.new('file.css', "directory is missing").message).to eq(
+      error = CssNotFound.new(css_name: "file.css", message: "directory is missing")
+      expect(error.message).to eq(
         'Could not find stylesheet "file.css": directory is missing'
       )
     end
 
     it "shows information about used provider when given" do
       provider = double("Some cool provider")
-      expect(CssNotFound.new('style.css', nil, provider).message).to eq(
+      error = CssNotFound.new(css_name: "style.css", provider: provider)
+
+      expect(error.message).to eq(
         %(Could not find stylesheet "style.css"\nUsed provider:\n#{provider})
       )
     end