RubyGems - roadie - Versions diffs - 4.0.0 → 5.0.0 - Mend

roadie 4.0.0 → 5.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (65) hide show

checksums.yaml +4 -4
data/.github/workflows/main.yml +43 -0
data/.solargraph.yml +16 -0
data/Changelog.md +14 -2
data/Gemfile +5 -2
data/README.md +11 -13
data/Rakefile +2 -2
data/lib/roadie/asset_provider.rb +3 -1
data/lib/roadie/asset_scanner.rb +6 -6
data/lib/roadie/cached_provider.rb +1 -0
data/lib/roadie/deduplicator.rb +1 -0
data/lib/roadie/document.rb +7 -10
data/lib/roadie/errors.rb +18 -14
data/lib/roadie/filesystem_provider.rb +13 -3
data/lib/roadie/inliner.rb +49 -19
data/lib/roadie/markup_improver.rb +22 -31
data/lib/roadie/net_http_provider.rb +25 -11
data/lib/roadie/null_provider.rb +18 -5
data/lib/roadie/null_url_rewriter.rb +6 -2
data/lib/roadie/path_rewriter_provider.rb +4 -1
data/lib/roadie/provider_list.rb +15 -11
data/lib/roadie/rspec/asset_provider.rb +4 -1
data/lib/roadie/rspec.rb +2 -2
data/lib/roadie/selector.rb +15 -5
data/lib/roadie/style_attribute_builder.rb +2 -1
data/lib/roadie/style_block.rb +3 -3
data/lib/roadie/style_property.rb +3 -2
data/lib/roadie/stylesheet.rb +2 -13
data/lib/roadie/url_generator.rb +24 -8
data/lib/roadie/url_rewriter.rb +6 -3
data/lib/roadie/utils.rb +1 -1
data/lib/roadie/version.rb +1 -2
data/lib/roadie.rb +23 -23
data/roadie.gemspec +23 -25
data/spec/hash_as_cache_store_spec.rb +1 -1
data/spec/integration_spec.rb +41 -44
data/spec/lib/roadie/asset_scanner_spec.rb +9 -4
data/spec/lib/roadie/cached_provider_spec.rb +4 -4
data/spec/lib/roadie/css_not_found_spec.rb +8 -5
data/spec/lib/roadie/deduplicator_spec.rb +3 -3
data/spec/lib/roadie/document_spec.rb +45 -27
data/spec/lib/roadie/filesystem_provider_spec.rb +8 -10
data/spec/lib/roadie/inliner_spec.rb +40 -44
data/spec/lib/roadie/markup_improver_spec.rb +17 -25
data/spec/lib/roadie/net_http_provider_spec.rb +8 -8
data/spec/lib/roadie/null_provider_spec.rb +2 -2
data/spec/lib/roadie/null_url_rewriter_spec.rb +2 -2
data/spec/lib/roadie/path_rewriter_provider_spec.rb +4 -4
data/spec/lib/roadie/provider_list_spec.rb +25 -21
data/spec/lib/roadie/selector_spec.rb +4 -4
data/spec/lib/roadie/style_attribute_builder_spec.rb +5 -5
data/spec/lib/roadie/style_block_spec.rb +1 -1
data/spec/lib/roadie/style_property_spec.rb +8 -8
data/spec/lib/roadie/stylesheet_spec.rb +2 -20
data/spec/lib/roadie/test_provider_spec.rb +4 -4
data/spec/lib/roadie/url_generator_spec.rb +1 -1
data/spec/lib/roadie/url_rewriter_spec.rb +6 -4
data/spec/spec_helper.rb +8 -8
data/spec/support/have_attribute_matcher.rb +1 -2
data/spec/support/have_node_matcher.rb +3 -3
data/spec/support/have_selector_matcher.rb +2 -3
data/spec/support/have_styling_matcher.rb +10 -11
data/spec/support/have_xpath_matcher.rb +2 -3
metadata +22 -21
data/.travis.yml +0 -20

data/spec/integration_spec.rb CHANGED Viewed

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
-require 'spec_helper'
+require "spec_helper"
 describe "Roadie functionality" do
   describe "on full documents" do
@@ -13,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>")
@@ -47,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
@@ -112,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
@@ -127,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
@@ -151,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
@@ -175,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
@@ -197,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
@@ -232,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
@@ -324,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>
@@ -353,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>
@@ -390,20 +385,20 @@ 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
+    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>
@@ -432,7 +427,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}
@@ -441,8 +436,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
@@ -474,8 +469,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
@@ -523,7 +518,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
@@ -531,7 +526,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
@@ -547,8 +544,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
@@ -563,8 +560,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
@@ -581,8 +578,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
@@ -615,7 +612,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 CHANGED Viewed

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
-require 'spec_helper'
+require "spec_helper"
 module Roadie
   describe AssetScanner do
@@ -8,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
@@ -111,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 CHANGED Viewed

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
-require 'spec_helper'
-require 'roadie/rspec'
-require 'shared_examples/asset_provider'
+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 CHANGED Viewed

@@ -1,24 +1,27 @@
 # frozen_string_literal: true
-require 'spec_helper'
+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

data/spec/lib/roadie/deduplicator_spec.rb CHANGED Viewed

@@ -9,13 +9,13 @@ module Roadie
         ["a", "1"],
         ["b", "2"],
         ["a", "3"],
-        ["a", "1"],
+        ["a", "1"]
       ]
       expect(Deduplicator.apply(input)).to eq [
         ["b", "2"],
         ["a", "3"],
-        ["a", "1"],
+        ["a", "1"]
       ]
     end
@@ -23,7 +23,7 @@ module Roadie
       input = [
         ["a", "1"],
         ["a", "3"],
-        ["a", "2"],
+        ["a", "2"]
       ]
       expect(Deduplicator.apply(input)).to eq input

data/spec/lib/roadie/document_spec.rb CHANGED Viewed

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
-require 'spec_helper'
+require "spec_helper"
 module Roadie
   describe Document do
@@ -70,6 +70,9 @@ module Roadie
       document.mode = :html
       expect(document.mode).to eq(:html)
+      document.mode = :xml
+      expect(document.mode).to eq(:xml)
     end
     it "does not allow unknown modes" do
@@ -91,8 +94,8 @@ module Roadie
     describe "transforming" do
       it "runs the before and after callbacks" do
         document = Document.new "<body></body>"
-        before = ->{}
-        after = ->{}
+        before = -> {}
+        after = -> {}
         document.before_transformation = before
         document.after_transformation = after
@@ -103,21 +106,6 @@ module Roadie
         document.transform
       end
-      # TODO: Remove on next major version.
-      it "works on callables that don't expect more than one argument" do
-        document = Document.new "<body></body>"
-        document.before_transformation = ->(first) { }
-        document.after_transformation = ->(first = nil) { }
-        expect { document.transform }.to_not raise_error
-        # It still supplies the second argument, if possible.
-        document.after_transformation = ->(first, second = nil) {
-          raise "Oops" unless second
-        }
-        expect { document.transform }.to_not raise_error
-      end
       context "in HTML mode" do
         it "does not escape curly braces" do
           document = Document.new "<body><a href='https://google.com/{{hello}}'>Hello</a></body>"
@@ -126,26 +114,41 @@ module Roadie
           expect(document.transform).to include("{{hello}}")
         end
       end
+      context "in XML mode" do
+        it "doesn't replace empty tags with self-closed ones" do
+          document = Document.new "<img src='https://google.com/image.png'></img>"
+          document.mode = :xml
+          expect(document.transform_partial).to end_with("</img>")
+        end
+        it "does not escape curly braces" do
+          document = Document.new "<a href='https://google.com/{{hello}}'>Hello</a>"
+          document.mode = :xml
+          expect(document.transform_partial).to include("{{hello}}")
+        end
+      end
     end
     describe "partial transforming" do
       it "runs the before and after callbacks" do
         document = Document.new "<p></p>"
-        before = ->{}
-        after = ->{}
+        before = -> {}
+        after = -> {}
         document.before_transformation = before
         document.after_transformation = after
         expect(before).to receive(:call).with(
           instance_of(Nokogiri::HTML::DocumentFragment),
-          document,
+          document
         ).ordered
         expect(Inliner).to receive(:new).ordered.and_return double.as_null_object
         expect(after).to receive(:call).with(
           instance_of(Nokogiri::HTML::DocumentFragment),
-          document,
+          document
         ).ordered
         document.transform_partial
@@ -159,6 +162,21 @@ module Roadie
           expect(document.transform_partial).to include("{{hello}}")
         end
       end
+      context "in XML mode" do
+        it "doesn't replace empty tags with self-closed ones" do
+          document = Document.new "<img src='https://google.com/image.png'></img>"
+          document.mode = :xml
+          expect(document.transform_partial).to end_with("</img>")
+        end
+        it "does not escape curly braces" do
+          document = Document.new "<a href='https://google.com/{{hello}}'>Hello</a>"
+          document.mode = :xml
+          expect(document.transform_partial).to include("{{hello}}")
+        end
+      end
     end
   end
@@ -179,11 +197,11 @@ module Roadie
       result = Nokogiri::HTML.parse document.transform
-      expect(result).to have_selector('html > head > title')
-      expect(result.at_css('title').text).to eq("Greetings")
+      expect(result).to have_selector("html > head > title")
+      expect(result.at_css("title").text).to eq("Greetings")
-      expect(result).to have_selector('html > body > p')
-      paragraph = result.at_css('p')
+      expect(result).to have_selector("html > body > p")
+      paragraph = result.at_css("p")
       expect(paragraph.text).to eq("Hello, world!")
       expect(paragraph.to_xml).to eq('<p style="color:green">Hello, world!</p>')
     end
@@ -202,7 +220,7 @@ module Roadie
       HTML
       document.asset_providers = TestProvider.new({
-        "/sample.css" => "p { color: red; text-align: right; }",
+        "/sample.css" => "p { color: red; text-align: right; }"
       })
       document.add_css "p { color: green; text-size: 2em; }"

data/spec/lib/roadie/filesystem_provider_spec.rb CHANGED Viewed

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
-require 'spec_helper'
-require 'roadie/rspec'
-require 'shared_examples/asset_provider'
+require "spec_helper"
+require "roadie/rspec"
+require "shared_examples/asset_provider"
 module Roadie
   describe FilesystemProvider do
@@ -63,13 +63,11 @@ module Roadie
       end
       it "shows that the query string is ignored inside raised errors" do
-        begin
-          provider.find_stylesheet!("/foo.css?query-string")
-          fail "No error was raised"
-        rescue CssNotFound => error
-          expect(error.css_name).to eq("foo.css")
-          expect(error.to_s).to include("/foo.css?query-string")
-        end
+        provider.find_stylesheet!("/foo.css?query-string")
+        fail "No error was raised"
+      rescue CssNotFound => error
+        expect(error.css_name).to eq("foo.css")
+        expect(error.to_s).to include("/foo.css?query-string")
       end
     end
   end