RubyGems - roadie - Versions diffs - 2.4.3 → 3.0.0 - Mend

roadie 2.4.3 → 3.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 (89) hide show

checksums.yaml +7 -0
data/.gitignore +3 -0
data/.travis.yml +10 -14
data/.yardopts +1 -1
data/Changelog.md +38 -5
data/Gemfile +3 -4
data/Guardfile +12 -1
data/README.md +168 -164
data/Rakefile +2 -19
data/lib/roadie.rb +15 -68
data/lib/roadie/asset_provider.rb +7 -58
data/lib/roadie/asset_scanner.rb +92 -0
data/lib/roadie/document.rb +103 -0
data/lib/roadie/errors.rb +57 -0
data/lib/roadie/filesystem_provider.rb +30 -60
data/lib/roadie/inliner.rb +72 -217
data/lib/roadie/markup_improver.rb +88 -0
data/lib/roadie/null_provider.rb +13 -0
data/lib/roadie/null_url_rewriter.rb +12 -0
data/lib/roadie/provider_list.rb +71 -0
data/lib/roadie/rspec.rb +1 -0
data/lib/roadie/rspec/asset_provider.rb +49 -0
data/lib/roadie/selector.rb +43 -18
data/lib/roadie/style_attribute_builder.rb +25 -0
data/lib/roadie/style_block.rb +32 -0
data/lib/roadie/style_property.rb +93 -0
data/lib/roadie/stylesheet.rb +65 -0
data/lib/roadie/upgrade_guide.rb +36 -0
data/lib/roadie/url_generator.rb +126 -0
data/lib/roadie/url_rewriter.rb +84 -0
data/lib/roadie/version.rb +1 -1
data/roadie.gemspec +8 -11
data/spec/fixtures/big_em.css +1 -0
data/spec/fixtures/stylesheets/green.css +1 -0
data/spec/integration_spec.rb +125 -95
data/spec/lib/roadie/asset_scanner_spec.rb +153 -0
data/spec/lib/roadie/css_not_found_spec.rb +17 -0
data/spec/lib/roadie/document_spec.rb +123 -0
data/spec/lib/roadie/filesystem_provider_spec.rb +44 -68
data/spec/lib/roadie/inliner_spec.rb +105 -537
data/spec/lib/roadie/markup_improver_spec.rb +78 -0
data/spec/lib/roadie/null_provider_spec.rb +21 -0
data/spec/lib/roadie/null_url_rewriter_spec.rb +19 -0
data/spec/lib/roadie/provider_list_spec.rb +89 -0
data/spec/lib/roadie/selector_spec.rb +15 -10
data/spec/lib/roadie/style_attribute_builder_spec.rb +29 -0
data/spec/lib/roadie/style_block_spec.rb +35 -0
data/spec/lib/roadie/style_property_spec.rb +82 -0
data/spec/lib/roadie/stylesheet_spec.rb +41 -0
data/spec/lib/roadie/test_provider_spec.rb +29 -0
data/spec/lib/roadie/url_generator_spec.rb +121 -0
data/spec/lib/roadie/url_rewriter_spec.rb +79 -0
data/spec/shared_examples/asset_provider.rb +11 -0
data/spec/shared_examples/url_rewriter.rb +23 -0
data/spec/spec_helper.rb +6 -60
data/spec/support/have_attribute_matcher.rb +2 -2
data/spec/support/have_node_matcher.rb +4 -4
data/spec/support/have_selector_matcher.rb +3 -3
data/spec/support/have_styling_matcher.rb +51 -15
data/spec/support/test_provider.rb +13 -0
metadata +86 -175
data/Appraisals +0 -15
data/gemfiles/rails_3.0.gemfile +0 -7
data/gemfiles/rails_3.0.gemfile.lock +0 -123
data/gemfiles/rails_3.1.gemfile +0 -7
data/gemfiles/rails_3.1.gemfile.lock +0 -126
data/gemfiles/rails_3.2.gemfile +0 -7
data/gemfiles/rails_3.2.gemfile.lock +0 -124
data/gemfiles/rails_4.0.gemfile +0 -7
data/gemfiles/rails_4.0.gemfile.lock +0 -119
data/lib/roadie/action_mailer_extensions.rb +0 -95
data/lib/roadie/asset_pipeline_provider.rb +0 -28
data/lib/roadie/css_file_not_found.rb +0 -22
data/lib/roadie/railtie.rb +0 -39
data/lib/roadie/style_declaration.rb +0 -42
data/spec/fixtures/app/assets/stylesheets/integration.css +0 -10
data/spec/fixtures/public/stylesheets/integration.css +0 -10
data/spec/fixtures/views/integration_mailer/marketing.html.erb +0 -2
data/spec/fixtures/views/integration_mailer/notification.html.erb +0 -8
data/spec/fixtures/views/integration_mailer/notification.text.erb +0 -6
data/spec/lib/roadie/action_mailer_extensions_spec.rb +0 -227
data/spec/lib/roadie/asset_pipeline_provider_spec.rb +0 -65
data/spec/lib/roadie/css_file_not_found_spec.rb +0 -29
data/spec/lib/roadie/style_declaration_spec.rb +0 -49
data/spec/lib/roadie_spec.rb +0 -101
data/spec/shared_examples/asset_provider_examples.rb +0 -11
data/spec/support/anonymous_mailer.rb +0 -21
data/spec/support/change_url_options.rb +0 -5
data/spec/support/parse_styling.rb +0 -25

data/spec/lib/roadie/markup_improver_spec.rb ADDED Viewed

@@ -0,0 +1,78 @@
+# encoding: UTF-8
+require 'spec_helper'
+module Roadie
+  describe MarkupImprover do
+    def improve(html)
+      dom = Nokogiri::HTML.parse html
+      MarkupImprover.new(dom, html).improve
+      dom
+    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 pending_for_buggy_jruby
+      # No reason to check for version yet since no existing version has a fix.
+      skip "Pending until Nokogiri issue #984 is fixed and released" if defined?(JRuby)
+    end
+    describe "automatic doctype" do
+      it "inserts a HTML5 doctype if no doctype is present" do
+        pending_for_buggy_jruby
+        expect(improve("<html></html>").internal_subset.to_xml).to eq("<!DOCTYPE html>")
+      end
+      it "does not insert duplicate doctypes" do
+        html = improve('<!DOCTYPE html><html><body></body></html>').to_html
+        expect(html.scan('DOCTYPE').size).to eq(1)
+      end
+      it "leaves other doctypes alone" do
+        dtd = "<!DOCTYPE html PUBLIC \"-//W3C//DTD HTML 4.0 Transitional//EN\" \"http://www.w3.org/TR/REC-html40/loose.dtd\">"
+        html = "#{dtd}<html></html>"
+        expect(improve(html).internal_subset.to_xml.strip).to eq(dtd)
+      end
+    end
+    describe "basic HTML structure" do
+      it "inserts a <html> element as the root" do
+        expect(improve("<h1>Hey!</h1>")).to have_selector("html h1")
+        expect(improve("<html></html>").css('html').size).to eq(1)
+      end
+      it "inserts <head> if not present" do
+        expect(improve('<html><body></body></html>')).to have_selector('html > head + body')
+        expect(improve('<html></html>')).to have_selector('html > head')
+        expect(improve('Foo')).to have_selector('html > head')
+        expect(improve('<html><head></head></html>').css('head').size).to eq(1)
+      end
+      it "inserts <body> if not present" do
+        expect(improve('<h1>Hey!</h1>')).to have_selector('html > body > h1')
+        expect(improve('<html><h1>Hey!</h1></html>')).to have_selector('html > body > h1')
+        expect(improve('<html><body><h1>Hey!</h1></body></html>').css('body').size).to eq(1)
+      end
+    end
+    describe "charset declaration" do
+      it "is inserted if missing" do
+        dom = improve('<html><head></head><body></body></html>')
+        expect(dom).to have_selector('head meta')
+        meta = dom.at_css('head meta')
+        expect(meta['http-equiv']).to eq('Content-Type')
+        expect(meta['content']).to eq('text/html; charset=UTF-8')
+      end
+      it "is left alone when predefined" do
+        expect(improve(<<-HTML).xpath('//meta')).to have(1).item
+        <html>
+          <head>
+            <meta http-equiv="content-type" content="text/html; charset=iso-8859-1" />
+          </head>
+        </html>
+        HTML
+      end
+    end
+  end
+end

data/spec/lib/roadie/null_provider_spec.rb ADDED Viewed

@@ -0,0 +1,21 @@
+# encoding: UTF-8
+require 'spec_helper'
+require 'shared_examples/asset_provider'
+module Roadie
+  describe NullProvider do
+    it_behaves_like "asset provider role"
+    def expect_empty_stylesheet(stylesheet)
+      expect(stylesheet).not_to be_nil
+      expect(stylesheet.name).to eq("(null)")
+      expect(stylesheet).to have(0).blocks
+      expect(stylesheet.to_s).to be_empty
+    end
+    it "finds an empty stylesheet for every name" do
+      expect_empty_stylesheet NullProvider.new.find_stylesheet("omg wtf bbq")
+      expect_empty_stylesheet NullProvider.new.find_stylesheet!("omg wtf bbq")
+    end
+  end
+end

data/spec/lib/roadie/null_url_rewriter_spec.rb ADDED Viewed

@@ -0,0 +1,19 @@
+# encoding: UTF-8
+require 'spec_helper'
+require 'shared_examples/url_rewriter'
+module Roadie
+  describe NullUrlRewriter do
+    let(:generator) { double "URL generator" }
+    subject(:rewriter) { NullUrlRewriter.new(generator) }
+    it_behaves_like "url rewriter"
+    it "does nothing when transforming DOM" do
+      dom = double "DOM tree"
+      expect {
+        NullUrlRewriter.new(generator).transform_dom dom
+      }.to_not raise_error
+    end
+  end
+end

data/spec/lib/roadie/provider_list_spec.rb ADDED Viewed

@@ -0,0 +1,89 @@
+# encoding: UTF-8
+require 'spec_helper'
+require 'roadie/rspec'
+module Roadie
+  describe ProviderList do
+    let(:test_provider) { TestProvider.new }
+    subject(:provider) { ProviderList.new([test_provider]) }
+    it_behaves_like "roadie asset provider", valid_name: "valid", invalid_name: "invalid" do
+      let(:test_provider) { TestProvider.new "valid" => "" }
+    end
+    it "finds using all given providers" do
+      first = TestProvider.new "foo.css" => "foo { color: green; }"
+      second = TestProvider.new "bar.css" => "bar { color: green; }"
+      provider = ProviderList.new [first, second]
+      expect(provider.find_stylesheet("foo.css").to_s).to include "foo"
+      expect(provider.find_stylesheet("bar.css").to_s).to include "bar"
+      expect(provider.find_stylesheet("baz.css")).to be_nil
+    end
+    it "is enumerable" do
+      expect(provider).to be_kind_of(Enumerable)
+      expect(provider).to respond_to(:each)
+      expect(provider.each.to_a).to eq([test_provider])
+    end
+    it "has a size" do
+      expect(provider.size).to eq(1)
+      expect(provider).not_to be_empty
+    end
+    it "has a first and a last element" do
+      providers = [double("1"), double("2"), double("3")]
+      list = ProviderList.new(providers)
+      expect(list.first).to eq(providers.first)
+      expect(list.last).to eq(providers.last)
+    end
+    it "can have providers pushed and popped" do
+      other = double "Some other provider"
+      expect {
+        provider.push other
+        provider << other
+      }.to change(provider, :size).by(2)
+      expect {
+        expect(provider.pop).to eq(other)
+      }.to change(provider, :size).by(-1)
+    end
+    it "can have providers shifted and unshifted" do
+      other = double "Some other provider"
+      expect {
+        provider.unshift other
+      }.to change(provider, :size).by(1)
+      expect {
+        expect(provider.shift).to eq(other)
+      }.to change(provider, :size).by(-1)
+    end
+    describe "wrapping" do
+      it "creates provider lists with the arguments" do
+        expect(ProviderList.wrap(test_provider)).to be_instance_of(ProviderList)
+        expect(ProviderList.wrap(test_provider, test_provider).size).to eq(2)
+      end
+      it "flattens arrays" do
+        expect(ProviderList.wrap([test_provider, test_provider], test_provider).size).to eq(3)
+        expect(ProviderList.wrap([test_provider, test_provider]).size).to eq(2)
+      end
+      it "combines with providers from other lists" do
+        other_list = ProviderList.new([test_provider, test_provider])
+        expect(ProviderList.wrap(test_provider, other_list).size).to eq(3)
+      end
+      it "returns the passed list if only a single ProviderList is passed" do
+        other_list = ProviderList.new([test_provider])
+        expect(ProviderList.wrap(other_list)).to eql other_list
+      end
+    end
+  end
+end

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

@@ -4,11 +4,11 @@ require 'spec_helper'
 module Roadie
   describe Selector do
     it "can be coerced into String" do
-      ("I love " + Selector.new("html")).should == "I love html"
+      expect("I love " + Selector.new("html")).to eq("I love html")
     end
     it "can be inlined when simple" do
-      Selector.new("html body #main p.class").should be_inlinable
+      expect(Selector.new("html body #main p.class")).to be_inlinable
     end
     it "cannot be inlined when containing pseudo functions" do
@@ -27,32 +27,37 @@ module Roadie
         p:disabled
         p:checked
       ].each do |bad_selector|
-        Selector.new(bad_selector).should_not be_inlinable
+        expect(Selector.new(bad_selector)).not_to be_inlinable
       end
-      Selector.new('p.active').should be_inlinable
+      expect(Selector.new('p.active')).to be_inlinable
     end
     it "cannot be inlined when containing pseudo elements" do
-      Selector.new('p::some-element').should_not be_inlinable
+      expect(Selector.new('p::some-element')).not_to be_inlinable
     end
     it "cannot be inlined when selector is an at-rule" do
-      Selector.new('@keyframes progress-bar-stripes').should_not be_inlinable
+      expect(Selector.new('@keyframes progress-bar-stripes')).not_to be_inlinable
     end
     it "has a calculated specificity" do
       selector = "html p.active.nice #main.deep-selector"
-      Selector.new(selector).specificity.should == CssParser.calculate_specificity(selector)
+      expect(Selector.new(selector).specificity).to eq(CssParser.calculate_specificity(selector))
+    end
+    it "can be told about the specificity at initialization" do
+      selector = "html p.active.nice #main.deep-selector"
+      expect(Selector.new(selector, 1337).specificity).to eq(1337)
     end
     it "is equal to other selectors when they match the same things" do
-      Selector.new("foo").should == Selector.new("foo ")
-      Selector.new("foo").should_not == "foo"
+      expect(Selector.new("foo")).to eq(Selector.new("foo "))
+      expect(Selector.new("foo")).not_to eq("foo")
     end
     it "strips the given selector" do
-      Selector.new(" foo  \n").to_s.should == Selector.new("foo").to_s
+      expect(Selector.new(" foo  \n").to_s).to eq(Selector.new("foo").to_s)
     end
   end
 end

data/spec/lib/roadie/style_attribute_builder_spec.rb ADDED Viewed

@@ -0,0 +1,29 @@
+require 'spec_helper'
+module Roadie
+  describe StyleAttributeBuilder do
+    it "sorts the added properties" do
+      builder = StyleAttributeBuilder.new
+      builder << StyleProperty.new("color", "green", true, 1)
+      builder << StyleProperty.new("font-size", "110%", false, 15)
+      builder << StyleProperty.new("color", "red", false, 15)
+      expect(builder.attribute_string).to eq "font-size:110%;color:red;color:green !important"
+    end
+    it "preserves the order of added attributes with the same specificity" do
+      builder = StyleAttributeBuilder.new
+      builder << StyleProperty.new("color", "pink",  false, 50)
+      builder << StyleProperty.new("color", "red",   false, 50)
+      builder << StyleProperty.new("color", "green", false, 50)
+      # We need one different element to trigger the problem with Ruby's
+      # unstable sort
+      builder << StyleProperty.new("background", "white", false, 1)
+      expect(builder.attribute_string).to eq "background:white;color:pink;color:red;color:green"
+    end
+  end
+end

data/spec/lib/roadie/style_block_spec.rb ADDED Viewed

@@ -0,0 +1,35 @@
+# encoding: UTF-8
+require 'spec_helper'
+module Roadie
+  describe StyleBlock do
+    it "has a selector and a list of properties" do
+      properties = []
+      selector = double "Selector"
+      block = StyleBlock.new(selector, properties)
+      expect(block.selector).to eq(selector)
+      expect(block.properties).to eq(properties)
+    end
+    it "delegates #specificity to the selector" do
+      selector = double "Selector", specificity: 45
+      expect(StyleBlock.new(selector, []).specificity).to eq(45)
+    end
+    it "delegates #inlinable? to the selector" do
+      selector = double "Selector", inlinable?: "maybe"
+      expect(StyleBlock.new(selector, []).inlinable?).to eq("maybe")
+    end
+    it "delegates #selector_string to selector#to_s" do
+      selector = double "Selector", to_s: "yey"
+      expect(StyleBlock.new(selector, []).selector_string).to eq("yey")
+    end
+    it "has a string representation" do
+      properties = [double(to_s: "bar"), double(to_s: "baz")]
+      expect(StyleBlock.new(double(to_s: "foo"), properties).to_s).to eq("foo{bar;baz}")
+    end
+  end
+end

data/spec/lib/roadie/style_property_spec.rb ADDED Viewed

@@ -0,0 +1,82 @@
+require 'spec_helper'
+module Roadie
+  describe StyleProperty do
+    it "is initialized with a property, value, if it is marked as important, and the specificity" do
+      StyleProperty.new('color', 'green', true, 45).tap do |declaration|
+        expect(declaration.property).to eq('color')
+        expect(declaration.value).to eq('green')
+        expect(declaration).to be_important
+        expect(declaration.specificity).to eq(45)
+      end
+    end
+    describe "string representation" do
+      it "is the property and the value joined with a colon" do
+        expect(StyleProperty.new('color', 'green', false, 1).to_s).to eq('color:green')
+        expect(StyleProperty.new('font-size', '1.1em', false, 1).to_s).to eq('font-size:1.1em')
+      end
+      it "contains the !important flag when set" do
+        expect(StyleProperty.new('color', 'green', true, 1).to_s).to eq('color:green !important')
+      end
+    end
+    describe "comparing" do
+      def declaration(specificity, important = false)
+        StyleProperty.new('color', 'green', important, specificity)
+      end
+      it "compares on specificity" do
+        expect(declaration(5)).to eq(declaration(5))
+        expect(declaration(4)).to be < declaration(5)
+        expect(declaration(6)).to be > declaration(5)
+      end
+      context "with an important declaration" do
+        it "is less than the important declaration regardless of the specificity" do
+          expect(declaration(99, false)).to be < declaration(1, true)
+        end
+        it "compares like normal when both declarations are important" do
+          expect(declaration(5, true)).to eq(declaration(5, true))
+          expect(declaration(4, true)).to be < declaration(5, true)
+          expect(declaration(6, true)).to be > declaration(5, true)
+        end
+      end
+    end
+    describe "parsing" do
+      def parsing(declaration, specificity)
+        property = StyleProperty.parse(declaration, specificity)
+        [property.property, property.value, property.important?, property.specificity]
+      end
+      it "understands simple declarations" do
+        expect(parsing("color: green", 1)).to eq(["color", "green", false, 1])
+        expect(parsing(" color:green; ", 1)).to eq(["color", "green", false, 1])
+        expect(parsing("color: green  ", 1)).to eq(["color", "green", false, 1])
+        expect(parsing("color: green  ; ", 1)).to eq(["color", "green", false, 1])
+      end
+      it "understands more complex values" do
+        expect(parsing("padding:0 1px 5rem 9%;", 89)).to eq(["padding", "0 1px 5rem 9%", false, 89])
+      end
+      it "understands more complex names" do
+        expect(parsing("font-size: 50%", 10)).to eq(["font-size", "50%", false, 10])
+      end
+      it "correctly reads !important declarations" do
+        expect(parsing("color: green !important", 1)).to eq(["color", "green", true, 1])
+        expect(parsing("color: green !important;", 1)).to eq(["color", "green", true, 1])
+      end
+      it "raises an error on unparseable declarations" do
+        expect {
+          parsing("I want a red apple!", 1)
+        }.to raise_error(Roadie::UnparseableDeclaration, /red apple/)
+      end
+    end
+  end
+end

data/spec/lib/roadie/stylesheet_spec.rb ADDED Viewed

@@ -0,0 +1,41 @@
+# encoding: UTF-8
+require 'spec_helper'
+module Roadie
+  describe Stylesheet do
+    it "is initialized with a name and CSS" do
+      stylesheet = Stylesheet.new("foo.css", "body { color: green; }")
+      expect(stylesheet.name).to eq("foo.css")
+    end
+    it "has a list of blocks" do
+      stylesheet = Stylesheet.new("foo.css", <<-CSS)
+        body { color: green !important; font-size: 200%; }
+        a, i { color: red; }
+      CSS
+      expect(stylesheet).to have(3).blocks
+      expect(stylesheet.blocks.map(&:to_s)).to eq([
+        "body{color:green !important;font-size:200%}",
+        "a{color:red}",
+        "i{color:red}",
+      ])
+    end
+    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]
+      expect(stylesheet.each_inlinable_block.to_a).to eq([
+        ["good", "props"],
+      ])
+    end
+    it "has a string representation of the contents" do
+      stylesheet = Stylesheet.new("example.css", "body { color: green;}a{ color: red; font-size: small }")
+      expect(stylesheet.to_s).to eq("body{color:green}\na{color:red;font-size:small}")
+    end
+  end
+end