RubyGems - roadie - Versions diffs - 3.0.5 → 3.1.0.rc1 - Mend

roadie 3.0.5 → 3.1.0.rc1

Files changed (41) hide show

checksums.yaml +4 -4
data/.gitignore +2 -7
data/.travis.yml +1 -5
data/Changelog.md +20 -1
data/Guardfile +2 -1
data/README.md +193 -53
data/lib/roadie.rb +3 -2
data/lib/roadie/asset_scanner.rb +30 -10
data/lib/roadie/cached_provider.rb +77 -0
data/lib/roadie/document.rb +29 -10
data/lib/roadie/errors.rb +43 -1
data/lib/roadie/filesystem_provider.rb +3 -1
data/lib/roadie/inliner.rb +57 -27
data/lib/roadie/markup_improver.rb +2 -1
data/lib/roadie/net_http_provider.rb +70 -0
data/lib/roadie/null_provider.rb +3 -0
data/lib/roadie/path_rewriter_provider.rb +64 -0
data/lib/roadie/provider_list.rb +19 -1
data/lib/roadie/rspec.rb +1 -0
data/lib/roadie/rspec/cache_store.rb +25 -0
data/lib/roadie/stylesheet.rb +1 -0
data/lib/roadie/url_generator.rb +2 -1
data/lib/roadie/utils.rb +9 -0
data/lib/roadie/version.rb +1 -1
data/roadie.gemspec +2 -1
data/spec/hash_as_cache_store_spec.rb +7 -0
data/spec/integration_spec.rb +91 -0
data/spec/lib/roadie/asset_scanner_spec.rb +79 -25
data/spec/lib/roadie/cached_provider_spec.rb +52 -0
data/spec/lib/roadie/document_spec.rb +43 -7
data/spec/lib/roadie/filesystem_provider_spec.rb +5 -0
data/spec/lib/roadie/inliner_spec.rb +72 -15
data/spec/lib/roadie/net_http_provider_spec.rb +89 -0
data/spec/lib/roadie/path_rewriter_provider_spec.rb +39 -0
data/spec/lib/roadie/provider_list_spec.rb +31 -8
data/spec/lib/roadie/stylesheet_spec.rb +14 -8
data/spec/lib/roadie/utils_spec.rb +7 -0
data/spec/spec_helper.rb +1 -0
data/spec/support/have_styling_matcher.rb +1 -0
metadata +40 -9
data/lib/roadie/upgrade_guide.rb +0 -36

data/spec/lib/roadie/cached_provider_spec.rb ADDED

@@ -0,0 +1,52 @@
+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 }
+    subject(:provider) { CachedProvider.new(upstream, cache) }
+    it_behaves_like "roadie asset provider", valid_name: "good.css", invalid_name: "bad.css"
+    it "stores retrieved stylesheets in the cache" do
+      found = nil
+      expect {
+        found = provider.find_stylesheet("good.css")
+      }.to change(cache, :keys).to(["good.css"])
+      expect(cache["good.css"]).to eq found
+    end
+    it "reads from the cache first" do
+      found = upstream.find_stylesheet!("good.css")
+      cache["good.css"] = found
+      expect(upstream).to_not receive(:find_stylesheet)
+      expect(provider.find_stylesheet("good.css")).to eq found
+      expect(provider.find_stylesheet!("good.css")).to eq found
+    end
+    it "stores failed lookups in the cache" do
+      expect {
+        provider.find_stylesheet("foo.css")
+      }.to change(cache, :keys).to(["foo.css"])
+      expect(cache["foo.css"]).to be_nil
+    end
+    it "stores failed lookups even when raising errors" do
+      expect {
+        provider.find_stylesheet!("bar.css")
+      }.to raise_error CssNotFound
+      expect(cache.keys).to include "bar.css"
+      expect(cache["bar.css"]).to be_nil
+    end
+    it "defaults to a hash for cache storage" do
+      expect(CachedProvider.new(upstream).cache).to be_kind_of Hash
+    end
+  end
+end

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

@@ -16,17 +16,26 @@ module Roadie
       expect(document.url_options).to eq({host: "foo.bar"})
     end
-    it "has a ProviderList" do
+    it "has a setting for keeping uninlinable styles" do
+      expect(document.keep_uninlinable_css).to be true
+      document.keep_uninlinable_css = false
+      expect(document.keep_uninlinable_css).to be false
+    end
+    it "has a ProviderList for normal and external providers" do
       expect(document.asset_providers).to be_instance_of(ProviderList)
+      expect(document.external_asset_providers).to be_instance_of(ProviderList)
     end
-    it "defaults to having just a FilesystemProvider in the provider list" do
+    it "defaults to having just a FilesystemProvider in the normal provider list" do
       expect(document).to have(1).asset_providers
+      expect(document).to have(0).external_asset_providers
       provider = document.asset_providers.first
       expect(provider).to be_instance_of(FilesystemProvider)
     end
-    it "allows changes to the asset providers" do
+    it "allows changes to the normal asset providers" do
       other_provider = double "Other proider"
       old_list = document.asset_providers
@@ -38,6 +47,18 @@ module Roadie
       expect(document.asset_providers).to eq(old_list)
     end
+    it "allows changes to the external asset providers" do
+      other_provider = double "Other proider"
+      old_list = document.external_asset_providers
+      document.external_asset_providers = [other_provider]
+      expect(document.external_asset_providers).to be_instance_of(ProviderList)
+      expect(document.external_asset_providers.each.to_a).to eq([other_provider])
+      document.external_asset_providers = old_list
+      expect(document.external_asset_providers).to eq(old_list)
+    end
     it "can store callbacks for inlining" do
       callable = double "Callable"
@@ -51,17 +72,32 @@ module Roadie
     describe "transforming" do
       it "runs the before and after callbacks" do
         document = Document.new "<body></body>"
-        before = double call: nil
-        after = double call: nil
+        before = ->{}
+        after = ->{}
         document.before_transformation = before
         document.after_transformation = after
-        expect(before).to receive(:call).with(instance_of(Nokogiri::HTML::Document)).ordered
+        expect(before).to receive(:call).with(instance_of(Nokogiri::HTML::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::Document)).ordered
+        expect(after).to receive(:call).with(instance_of(Nokogiri::HTML::Document), document).ordered
         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
     end
   end

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

@@ -18,6 +18,11 @@ module Roadie
       expect(FilesystemProvider.new.path).to eq(Dir.pwd)
     end
+    it "shows the given path in string representation" do
+      expect(provider.to_s).to include provider.path.to_s
+      expect(provider.inspect).to include provider.path.to_s
+    end
     describe "finding stylesheets" do
       it "finds files in the path" do
         full_path = File.join(fixtures_path, "stylesheets", "green.css")

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

@@ -8,7 +8,7 @@ module Roadie
     def rendering(html, stylesheet = @stylesheet)
       dom = Nokogiri::HTML.parse html
-      Inliner.new([stylesheet]).inline(dom)
+      Inliner.new([stylesheet], dom).inline
       dom
     end
@@ -116,11 +116,11 @@ module Roadie
         dom = Nokogiri::HTML.parse "<p></p>"
         stylesheet = Stylesheet.new "foo.css", "p[%^=foo] { color: red; }"
-        inliner = Inliner.new([stylesheet])
-        expect(inliner).to receive(:warn).with(
-          %{Roadie cannot use "p[%^=foo]" (from "foo.css" stylesheet) when inlining stylesheets}
+        inliner = Inliner.new([stylesheet], dom)
+        expect(Utils).to receive(:warn).with(
+          %{Cannot inline "p[%^=foo]" from "foo.css" stylesheet. If this is valid CSS, please report a bug.}
         )
-        inliner.inline(dom)
+        inliner.inline
       end
       it "works with nth-child" do
@@ -134,16 +134,73 @@ module Roadie
         expect(result).to have_styling([['color', 'red'], ['color', 'green']]).at_selector('p:last')
       end
-      it "ignores selectors with @" do
-        use_css '@keyframes progress-bar-stripes {
-          from {
-            background-position: 40px 0;
-          }
-          to {
-            background-position: 0 0;
-          }
-        }'
-        expect { rendering('<p></p>') }.not_to raise_error
+      context "with uninlinable selectors" do
+        before do
+          allow(Roadie::Utils).to receive(:warn)
+        end
+        it "puts them in a new <style> element in the <head>" do
+          use_css 'a:hover { color: red; }'
+          result = rendering("
+            <html>
+              <head></head>
+              <body><a></a></body>
+            </html>
+          ")
+          expect(result).to have_selector("head > style")
+          expect(result.at_css("head > style").text).to eq "a:hover{color:red}"
+        end
+        it "puts them in <head> on unexpected inlining problems" do
+          use_css 'p:some-future-thing { color: red; }'
+          result = rendering("
+            <html>
+              <head></head>
+              <body><p></p></body>
+            </html>
+          ")
+          expect(result).to have_selector("head > style")
+          expect(result.at_css("head > style").text).to eq "p:some-future-thing{color:red}"
+        end
+        # This is not really wanted behavior, but there's nothing we can do
+        # about it because of limitations on CSS Parser.
+        it "puts does not put keyframes in <head>" do
+          css = '@keyframes progress-bar-stripes {
+            from {
+              background-position: 40px 0;
+            }
+            to {
+              background-position: 0 0;
+            }
+          }'
+          use_css css
+          result = rendering('<p></p>')
+          expect(result).to have_styling([]).at_selector("p")
+          # css_parser actually sees an empty @keyframes on JRuby, and nothing
+          # on the others
+          if (style_element = result.at_css("head > style"))
+            expect(style_element.text).to_not include "background-position"
+          end
+        end
+        it "ignores them if told not to keep them" do
+          stylesheet = use_css "
+            p:hover { color: red; }
+            p:some-future-thing { color: red; }
+          "
+          dom = Nokogiri::HTML.parse "
+            <html>
+              <head></head>
+              <body><p></p></body>
+            </html>
+          "
+          Inliner.new([stylesheet], dom).inline(false)
+          expect(dom).to_not have_selector("head > style")
+        end
       end
     end
   end

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

@@ -0,0 +1,89 @@
+require 'spec_helper'
+require 'roadie/rspec'
+require 'shared_examples/asset_provider'
+module Roadie
+  describe NetHttpProvider do
+    around do |example|
+      WebMock.disable_net_connect!
+      example.run
+      WebMock.allow_net_connect!
+    end
+    url = "http://example.com/style.css".freeze
+    it_behaves_like(
+      "roadie asset provider",
+      valid_name: "http://example.com/green.css",
+      invalid_name: "http://example.com/red.css"
+    ) do
+      before do
+        stub_request(:get, "http://example.com/green.css").and_return(body: "p { color: green; }")
+        stub_request(:get, "http://example.com/red.css").and_return(status: 404, body: "Not here!")
+      end
+    end
+    describe "error handling" do
+      it "handles timeouts" do
+        stub_request(:get, url).and_timeout
+        expect {
+          NetHttpProvider.new.find_stylesheet!(url)
+        }.to raise_error CssNotFound, /timeout/i
+        expect { NetHttpProvider.new.find_stylesheet(url) }.to_not raise_error
+      end
+      it "displays response code and beginning of message body" do
+        stub_request(:get, url).and_return(
+          status: 503,
+          body: "Whoah there! Didn't you see we have a service window at this
+                time? It's kind of disrespectful not to remember everything I tell
+                you all the time!"
+        )
+        expect {
+          NetHttpProvider.new.find_stylesheet!(url)
+        }.to raise_error CssNotFound, /503.*whoah/i
+      end
+    end
+    describe "whitelist" do
+      it "can have a whitelist of host names" do
+        provider = NetHttpProvider.new(whitelist: ["example.com", "foo.bar"])
+        expect(provider.whitelist).to eq Set["example.com", "foo.bar"]
+      end
+      it "defaults to empty whitelist" do
+        expect(NetHttpProvider.new.whitelist).to eq Set[]
+        expect(NetHttpProvider.new(whitelist: nil).whitelist).to eq Set[]
+      end
+      it "will not download from other hosts if set" do
+        provider = NetHttpProvider.new(whitelist: ["whitelisted.example.com"])
+        whitelisted_url = "http://whitelisted.example.com/style.css"
+        other_url       = "http://www.example.com/style.css"
+        whitelisted_request = stub_request(:get, whitelisted_url).and_return(body: "x")
+        other_request       = stub_request(:get, other_url).and_return(body: "x")
+        expect(provider.find_stylesheet(other_url)).to be_nil
+        expect {
+          provider.find_stylesheet!(other_url)
+        }.to raise_error CssNotFound, /whitelist/
+        expect {
+          expect(provider.find_stylesheet(whitelisted_url)).to_not be_nil
+          provider.find_stylesheet!(whitelisted_url)
+        }.to_not raise_error
+        expect(whitelisted_request).to have_been_made.twice
+        expect(other_request).to_not have_been_made
+      end
+      it "is displayed in the string representation" do
+        expect(NetHttpProvider.new(whitelist: ["bar.baz"]).to_s).to include "bar.baz"
+      end
+    end
+  end
+end

data/spec/lib/roadie/path_rewriter_provider_spec.rb ADDED

@@ -0,0 +1,39 @@
+require 'spec_helper'
+require 'roadie/rspec'
+require 'shared_examples/asset_provider'
+module Roadie
+  describe PathRewriterProvider do
+    let(:upstream) { TestProvider.new "good.css" => "body { color: green; }" }
+    subject(:provider) do
+      PathRewriterProvider.new(upstream) do |path|
+        path.gsub('well', 'good')
+      end
+    end
+    it_behaves_like "roadie asset provider", valid_name: "well.css", invalid_name: "bad"
+    it "does not call the upstream provider if block returns nil" do
+      provider = PathRewriterProvider.new(upstream) { nil }
+      expect(upstream).to_not receive(:find_stylesheet)
+      expect(upstream).to_not receive(:find_stylesheet!)
+      expect(provider.find_stylesheet("foo")).to be_nil
+      expect {
+        provider.find_stylesheet!("foo")
+      }.to raise_error(CssNotFound, /nil/)
+    end
+    it "does not call the upstream provider if block returns false" do
+      provider = PathRewriterProvider.new(upstream) { false }
+      expect(upstream).to_not receive(:find_stylesheet)
+      expect(upstream).to_not receive(:find_stylesheet!)
+      expect(provider.find_stylesheet("foo")).to be_nil
+      expect {
+        provider.find_stylesheet!("foo")
+      }.to raise_error(CssNotFound, /false/)
+    end
+  end
+end

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

@@ -68,14 +68,37 @@ module Roadie
       provider = double("Provider", to_s: "Some provider")
       sublist = ProviderList.new([provider, provider])
       list = ProviderList.new([provider, sublist, provider])
-      expect(list.to_s).to eql "ProviderList: [\n" +
-        "\tSome provider,\n" +
-        "\tProviderList: [\n" +
-          "\t\tSome provider,\n" +
-          "\t\tSome provider\n" +
-        "\t],\n" +
-        "\tSome provider\n" +
-      "]"
+      expect(list.to_s).to eql(
+        "ProviderList: [\n" +
+          "\tSome provider,\n" +
+          "\tProviderList: [\n" +
+            "\t\tSome provider,\n" +
+            "\t\tSome provider\n" +
+          "\t],\n" +
+          "\tSome provider\n" +
+        "]"
+      )
+    end
+    it "raises a readable error message" do
+      provider = double("Provider", to_s: "Some provider")
+      allow(provider).to receive(:find_stylesheet!).and_raise(
+        CssNotFound.new("style.css", "I tripped", provider)
+      )
+      sublist = ProviderList.new([provider, provider])
+      list = ProviderList.new([provider, sublist, provider])
+      expect { list.find_stylesheet!("style.css") }.to raise_error { |error|
+        expect(error.message).to eq(
+          "Could not find stylesheet \"style.css\": All providers failed\n" +
+          "Used providers:\n" +
+            "\tSome provider: I tripped\n" +
+            "\tSome provider: I tripped\n" +
+            "\tSome provider: I tripped\n" +
+            "\tSome provider: I tripped\n"
+        )
+      }
     end
     describe "wrapping" do

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

@@ -21,16 +21,22 @@ module Roadie
       ])
     end
-    it "can iterate all inlinable blocks" do
-      inlinable = double(inlinable?: true, selector: "good", properties: "props")
-      bad = double(inlinable?: false, selector: "bad", properties: "props")
+    if VERSION < "4.0"
+      it "can iterate all inlinable blocks" do
+        inlinable = double(inlinable?: true, selector: "good", properties: "props")
+        bad = double(inlinable?: false, selector: "bad", properties: "props")
-      stylesheet = Stylesheet.new("example.css", "")
-      allow(stylesheet).to receive_messages blocks: [bad, inlinable, bad]
+        stylesheet = Stylesheet.new("example.css", "")
+        allow(stylesheet).to receive_messages blocks: [bad, inlinable, bad]
-      expect(stylesheet.each_inlinable_block.to_a).to eq([
-        ["good", "props"],
-      ])
+        expect(stylesheet.each_inlinable_block.to_a).to eq([
+          ["good", "props"],
+        ])
+      end
+    else
+      it "should no longer have #each_inlinable_block" do
+        fail "Remove #each_inlinable_block"
+      end
     end
     it "has a string representation of the contents" do