RubyGems - roadie - Versions diffs - 3.2.2 → 3.3.0 - Mend

roadie 3.2.2 → 3.3.0

Files changed (19) hide show

checksums.yaml +4 -4
data/.travis.yml +4 -0
data/Changelog.md +15 -1
data/README.md +88 -8
data/lib/roadie/asset_scanner.rb +0 -7
data/lib/roadie/document.rb +83 -7
data/lib/roadie/inliner.rb +28 -11
data/lib/roadie/net_http_provider.rb +16 -1
data/lib/roadie/url_rewriter.rb +5 -1
data/lib/roadie/version.rb +1 -1
data/spec/integration_spec.rb +464 -234
data/spec/lib/roadie/asset_scanner_spec.rb +0 -19
data/spec/lib/roadie/document_spec.rb +82 -0
data/spec/lib/roadie/inliner_spec.rb +31 -1
data/spec/lib/roadie/net_http_provider_spec.rb +35 -0
data/spec/lib/roadie/url_rewriter_spec.rb +16 -0
data/spec/support/have_selector_matcher.rb +2 -2
data/spec/support/have_xpath_matcher.rb +6 -0
metadata +5 -3

data/spec/lib/roadie/asset_scanner_spec.rb CHANGED

@@ -192,25 +192,6 @@ module Roadie
         expect(dom).to_not have_selector("link[href*=some]")
         expect(dom).to have_selector("link[href*=other]")
       end
-      it "removes the data-roadie-ignore markers" do
-        dom = dom_document <<-HTML
-          <html>
-            <head>
-              <link rel="stylesheet" href="/cool.css" data-roadie-ignore id="first">
-            </head>
-            <body>
-              <style data-roadie-ignore id="second">a { color: red; }</style>
-            </body>
-          </html>
-        HTML
-        scanner = AssetScanner.new dom, TestProvider.new, external_provider
-        scanner.extract_css
-        expect(dom.at_css("#first").attributes).to_not include("data-roadie-ignore")
-        expect(dom.at_css("#second").attributes).to_not include("data-roadie-ignore")
-      end
     end
   end
 end

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

@@ -35,6 +35,10 @@ module Roadie
       expect(provider).to be_instance_of(FilesystemProvider)
     end
+    it "defaults to HTML mode" do
+      expect(document.mode).to eq(:html)
+    end
     it "allows changes to the normal asset providers" do
       other_provider = double "Other proider"
       old_list = document.asset_providers
@@ -59,6 +63,20 @@ module Roadie
       expect(document.external_asset_providers).to eq(old_list)
     end
+    it "allows changes to the mode setting" do
+      document.mode = :xhtml
+      expect(document.mode).to eq(:xhtml)
+      document.mode = :html
+      expect(document.mode).to eq(:html)
+    end
+    it "does not allow unknown modes" do
+      expect {
+        document.mode = :other
+      }.to raise_error(ArgumentError, /:other/)
+    end
     it "can store callbacks for inlining" do
       callable = double "Callable"
@@ -98,6 +116,48 @@ module Roadie
         }
         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>"
+          document.mode = :xhtml
+          expect(document.transform).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 = ->{}
+        document.before_transformation = before
+        document.after_transformation = after
+        expect(before).to receive(:call).with(
+          instance_of(Nokogiri::HTML::DocumentFragment),
+          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,
+        ).ordered
+        document.transform_partial
+      end
+      context "in HTML mode" do
+        it "does not escape curly braces" do
+          document = Document.new "<a href='https://google.com/{{hello}}'>Hello</a>"
+          document.mode = :xhtml
+          expect(document.transform_partial).to include("{{hello}}")
+        end
+      end
     end
   end
@@ -155,5 +215,27 @@ module Roadie
         %w[text-size 2em]
       ]).at_selector("p")
     end
+    it "removes data-roadie-ignore markers" do
+      document = Document.new <<-HTML
+        <html>
+          <head>
+            <link rel="stylesheet" href="/cool.css" data-roadie-ignore id="first">
+          </head>
+          <body>
+            <style data-roadie-ignore id="second">a { color: red; }</style>
+            <a href="#" data-roadie-ignore>
+              Hello world!
+              <span data-roadie-ignore></span>
+            </a>
+          </body>
+        </html>
+      HTML
+      result = Nokogiri::HTML.parse document.transform
+      expect(result).to have_selector("body > a > span")
+      expect(result).not_to have_selector("[data-roadie-ignore]")
+    end
   end
 end

data/spec/lib/roadie/inliner_spec.rb CHANGED

@@ -219,9 +219,39 @@ module Roadie
               <body><p></p></body>
             </html>
           "
-          Inliner.new([stylesheet], dom).inline(false)
+          Inliner.new([stylesheet], dom).inline(keep_uninlinable_css: false)
           expect(dom).to_not have_selector("head > style")
         end
+        it "puts the <style> element at the root when told so" do
+          stylesheet = use_css 'a:hover { color: red; }'
+          dom = Nokogiri::HTML.fragment("
+            <a></a>
+          ")
+          Inliner.new([stylesheet], dom).inline(
+            keep_uninlinable_css: true,
+            keep_uninlinable_in: :root,
+          )
+          expect(dom).to have_xpath("./a")
+          expect(dom).to have_xpath("./style")
+        end
+        it "raises error when told to save styles in an unknown place" do
+          stylesheet = use_css 'a:hover { color: red; }'
+          dom = Nokogiri::HTML.fragment("
+            <a></a>
+          ")
+          inliner = Inliner.new([stylesheet], dom)
+          expect {
+            inliner.inline(
+              keep_uninlinable_css: true,
+              keep_uninlinable_in: :unknown_place,
+            )
+          }.to raise_error(ArgumentError, /:unknown_place/)
+        end
       end
     end
   end

data/spec/lib/roadie/net_http_provider_spec.rb CHANGED

@@ -43,6 +43,41 @@ module Roadie
       }.to_not raise_error
     end
+    it "applies encoding from the response" do
+      # Net::HTTP always returns the body string as a byte-encoded string
+      # (US-ASCII). The headers will indicate what charset the client should
+      # use when trying to make sense of these bytes.
+      stub_request(:get, url).and_return(
+        body: %(p::before { content: "l\xF6ve" }).force_encoding("US-ASCII"),
+        headers: {"Content-Type" => "text/css;charset=ISO-8859-1"},
+      )
+      # Seems like CssParser strips out the non-ascii character for some
+      # reason.
+      # stylesheet = NetHttpProvider.new.find_stylesheet!(url)
+      # expect(stylesheet.to_s).to eq('p::before{content:"löve"}')
+      allow(Stylesheet).to receive(:new).and_return(instance_double(Stylesheet))
+      NetHttpProvider.new.find_stylesheet!(url)
+      expect(Stylesheet).to have_received(:new).with(url, 'p::before { content: "löve" }')
+    end
+    it "assumes UTF-8 encoding if server headers do not specify a charset" do
+      stub_request(:get, url).and_return(
+        body: %(p::before { content: "Åh nej" }).force_encoding("US-ASCII"),
+        headers: {"Content-Type" => "text/css"},
+      )
+      # Seems like CssParser strips out the non-ascii characters for some
+      # reason.
+      # stylesheet = NetHttpProvider.new.find_stylesheet!(url)
+      # expect(stylesheet.to_s).to eq('p::before{content:"Åh nej"}')
+      allow(Stylesheet).to receive(:new).and_return(instance_double(Stylesheet))
+      NetHttpProvider.new.find_stylesheet!(url)
+      expect(Stylesheet).to have_received(:new).with(url, 'p::before { content: "Åh nej" }')
+    end
     describe "error handling" do
       it "handles timeouts" do
         stub_request(:get, url).and_timeout

data/spec/lib/roadie/url_rewriter_spec.rb CHANGED

@@ -49,6 +49,22 @@ module Roadie
           rewriter.transform_dom dom
         }.to change { dom.at_css("div")["style"] }.to 'background-image: url("http://foo.com/image.jpg");'
       end
+      it "skips elements with data-roadie-ignore attributes" do
+        allow(generator).to receive(:generate_url).and_return("http://example.com")
+        dom = dom_document <<-HTML
+          <body>
+            <a href="some/path.jpg" data-roadie-ignore>Image</a>
+            <img src="some/path.jpg" data-roadie-ignore>
+            <div style="background-image: url(&quot;some/path.jpg&quot;);" data-roadie-ignore>
+          </body>
+        HTML
+        rewriter.transform_dom dom
+        expect(generator).not_to have_received(:generate_url)
+      end
     end
     describe "transforming css" do

data/spec/support/have_selector_matcher.rb CHANGED

@@ -1,6 +1,6 @@
 RSpec::Matchers.define :have_selector do |selector|
   match { |document| !document.css(selector).empty? }
-  failure_message { "expected document to #{name_to_sentence}#{to_sentence selector}"}
-  failure_message_when_negated { "expected document to not #{name_to_sentence}#{to_sentence selector}"}
+  failure_message { "expected document to have selector #{selector.inspect}"}
+  failure_message_when_negated { "expected document to not have selector #{selector.inspect}"}
 end

data/spec/support/have_xpath_matcher.rb ADDED

@@ -0,0 +1,6 @@
+RSpec::Matchers.define :have_xpath do |xpath|
+  match { |document| !document.xpath(xpath).empty? }
+  failure_message { "expected document to have xpath #{xpath.inspect}"}
+  failure_message_when_negated { "expected document to not have xpath #{xpath.inspect}"}
+end

metadata CHANGED

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roadie
 version: !ruby/object:Gem::Version
-  version: 3.2.2
+  version: 3.3.0
 platform: ruby
 authors:
 - Magnus Bergmark
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-06-13 00:00:00.000000000 Z
+date: 2018-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -162,6 +162,7 @@ files:
 - spec/support/have_node_matcher.rb
 - spec/support/have_selector_matcher.rb
 - spec/support/have_styling_matcher.rb
+- spec/support/have_xpath_matcher.rb
 - spec/support/test_provider.rb
 homepage: http://github.com/Mange/roadie
 licenses:
@@ -183,7 +184,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.6.12
+rubygems_version: 2.6.14
 signing_key:
 specification_version: 4
 summary: Making HTML emails comfortable for the Ruby rockstars
@@ -221,4 +222,5 @@ test_files:
 - spec/support/have_node_matcher.rb
 - spec/support/have_selector_matcher.rb
 - spec/support/have_styling_matcher.rb
+- spec/support/have_xpath_matcher.rb
 - spec/support/test_provider.rb