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

roadie 2.4.3 → 3.0.0.pre1

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 (87) hide show

checksums.yaml +7 -0
data/.gitignore +3 -0
data/.travis.yml +9 -14
data/.yardopts +1 -1
data/Changelog.md +22 -10
data/Gemfile +3 -0
data/Guardfile +11 -1
data/README.md +165 -163
data/Rakefile +2 -19
data/lib/roadie.rb +14 -69
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 +21 -62
data/lib/roadie/inliner.rb +71 -218
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 +67 -0
data/lib/roadie/rspec.rb +1 -0
data/lib/roadie/rspec/asset_provider.rb +49 -0
data/lib/roadie/selector.rb +42 -18
data/lib/roadie/style_block.rb +33 -0
data/lib/roadie/style_properties.rb +29 -0
data/lib/roadie/style_property.rb +93 -0
data/lib/roadie/stylesheet.rb +65 -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 +6 -10
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 +16 -0
data/spec/lib/roadie/document_spec.rb +123 -0
data/spec/lib/roadie/filesystem_provider_spec.rb +25 -72
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 +81 -0
data/spec/lib/roadie/selector_spec.rb +7 -5
data/spec/lib/roadie/style_block_spec.rb +35 -0
data/spec/lib/roadie/style_properties_spec.rb +61 -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 +120 -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 +5 -60
data/spec/support/have_node_matcher.rb +2 -2
data/spec/support/have_selector_matcher.rb +1 -1
data/spec/support/have_styling_matcher.rb +48 -14
data/spec/support/test_provider.rb +13 -0
metadata +73 -177
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.
+      pending "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
+        improve("<html></html>").internal_subset.to_xml.should == "<!DOCTYPE html>"
+      end
+      it "does not insert duplicate doctypes" do
+        html = improve('<!DOCTYPE html><html><body></body></html>').to_html
+        html.scan('DOCTYPE').size.should == 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>"
+        improve(html).internal_subset.to_xml.strip.should == dtd
+      end
+    end
+    describe "basic HTML structure" do
+      it "inserts a <html> element as the root" do
+        improve("<h1>Hey!</h1>").should have_selector("html h1")
+        improve("<html></html>").css('html').size.should == 1
+      end
+      it "inserts <head> if not present" do
+        improve('<html><body></body></html>').should have_selector('html > head + body')
+        improve('<html></html>').should have_selector('html > head')
+        improve('Foo').should have_selector('html > head')
+        improve('<html><head></head></html>').css('head').size.should == 1
+      end
+      it "inserts <body> if not present" do
+        improve('<h1>Hey!</h1>').should have_selector('html > body > h1')
+        improve('<html><h1>Hey!</h1></html>').should have_selector('html > body > h1')
+        improve('<html><body><h1>Hey!</h1></body></html>').css('body').size.should == 1
+      end
+    end
+    describe "charset declaration" do
+      it "is inserted if missing" do
+        dom = improve('<html><head></head><body></body></html>')
+        dom.should have_selector('head meta')
+        meta = dom.at_css('head meta')
+        meta['http-equiv'].should == 'Content-Type'
+        meta['content'].should == 'text/html; charset=UTF-8'
+      end
+      it "is left alone when predefined" do
+        improve(<<-HTML).xpath('//meta').should 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)
+      stylesheet.should_not be_nil
+      stylesheet.name.should == "(null)"
+      stylesheet.should have(0).blocks
+      stylesheet.to_s.should 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,81 @@
+# 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]
+      provider.find_stylesheet("foo.css").to_s.should include "foo"
+      provider.find_stylesheet("bar.css").to_s.should include "bar"
+      provider.find_stylesheet("baz.css").should be_nil
+    end
+    it "is enumerable" do
+      provider.should be_kind_of(Enumerable)
+      provider.should respond_to(:each)
+      provider.each.to_a.should == [test_provider]
+    end
+    it "has a size" do
+      provider.size.should == 1
+    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 {
+        provider.pop.should == 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 {
+        provider.shift.should == other
+      }.to change(provider, :size).by(-1)
+    end
+    describe "wrapping" do
+      it "creates provider lists with the arguments" do
+        ProviderList.wrap(test_provider).should be_instance_of(ProviderList)
+        ProviderList.wrap(test_provider, test_provider).size.should == 2
+      end
+      it "flattens arrays" do
+        ProviderList.wrap([test_provider, test_provider], test_provider).size.should == 3
+        ProviderList.wrap([test_provider, test_provider]).size.should == 2
+      end
+      it "combines with providers from other lists" do
+        other_list = ProviderList.new([test_provider, test_provider])
+        ProviderList.wrap(test_provider, other_list).size.should == 3
+      end
+      it "returns the passed list if only a single ProviderList is passed" do
+        other_list = ProviderList.new([test_provider])
+        ProviderList.wrap(other_list).should eql other_list
+      end
+    end
+  end
+end

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

@@ -19,13 +19,10 @@ module Roadie
         p:link
         p:target
         p:visited
-        p:-ms-input-placeholder
-        p:-moz-placeholder
         p:before
         p:after
-        p:enabled
-        p:disabled
-        p:checked
+        p:-ms-input-placeholder
+        p:-moz-placeholder
       ].each do |bad_selector|
         Selector.new(bad_selector).should_not be_inlinable
       end
@@ -46,6 +43,11 @@ module Roadie
       Selector.new(selector).specificity.should == CssParser.calculate_specificity(selector)
     end
+    it "can be told about the specificity at initialization" do
+      selector = "html p.active.nice #main.deep-selector"
+      Selector.new(selector, 1337).specificity.should == 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"

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)
+      block.selector.should == selector
+      block.properties.should == properties
+    end
+    it "delegates #specificity to the selector" do
+      selector = double "Selector", specificity: 45
+      StyleBlock.new(selector, []).specificity.should == 45
+    end
+    it "delegates #inlinable? to the selector" do
+      selector = double "Selector", inlinable?: "maybe"
+      StyleBlock.new(selector, []).inlinable?.should == "maybe"
+    end
+    it "delegates #selector_string to selector#to_s" do
+      selector = double "Selector", to_s: "yey"
+      StyleBlock.new(selector, []).selector_string.should == "yey"
+    end
+    it "has a string representation" do
+      properties = [double(to_s: "bar"), double(to_s: "baz")]
+      StyleBlock.new(double(to_s: "foo"), properties).to_s.should == "foo{bar;baz}"
+    end
+  end
+end

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

@@ -0,0 +1,61 @@
+# encoding: UTF-8
+require 'spec_helper'
+module Roadie
+  describe StyleProperties do
+    it "has a list of properties" do
+      property = StyleProperty.new("color", "green", false, 1)
+      StyleProperties.new([property]).properties.should == [property]
+    end
+    it "can be merged with other properties" do
+      old = StyleProperty.new("color", "red", false, 1)
+      new = StyleProperty.new("color", "green", false, 5)
+      instance = StyleProperties.new([old])
+      instance.merge(StyleProperties.new([new])).properties.should == [old, new]
+      instance.merge([new]).properties.should == [old, new]
+      # Original is not mutated
+      instance.properties.should == [old]
+    end
+    it "can be destructively merged with other properties" do
+      old = StyleProperty.new("color", "red", false, 1)
+      new = StyleProperty.new("color", "green", false, 5)
+      instance = StyleProperties.new([old])
+      instance.merge!([new])
+      instance.properties.should == [old, new]
+    end
+    describe "string representation" do
+      class MockProperty
+        attr_reader :sort_value
+        include Comparable
+        def initialize(name, sort_value = 0)
+          @name, @sort_value = name, sort_value
+        end
+        def <=>(other) @sort_value <=> other.sort_value end
+        def to_s() @name.to_s end
+      end
+      it "joins properties together with semicolons" do
+        property = MockProperty.new("foo:bar")
+        StyleProperties.new([property, property]).to_s.should == "foo:bar;foo:bar"
+      end
+      it "sorts properties" do
+        important = MockProperty.new("super important", 100)
+        insignificant = MockProperty.new("insignificant", 2)
+        common = MockProperty.new("common", 20)
+        StyleProperties.new(
+          [important, insignificant, common]
+        ).to_s.should == "insignificant;common;super important"
+      end
+    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|
+        declaration.property.should == 'color'
+        declaration.value.should == 'green'
+        declaration.should be_important
+        declaration.specificity.should == 45
+      end
+    end
+    describe "string representation" do
+      it "is the property and the value joined with a colon" do
+        StyleProperty.new('color', 'green', false, 1).to_s.should == 'color:green'
+        StyleProperty.new('font-size', '1.1em', false, 1).to_s.should == 'font-size:1.1em'
+      end
+      it "contains the !important flag when set" do
+        StyleProperty.new('color', 'green', true, 1).to_s.should == '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
+        declaration(5).should be == declaration(5)
+        declaration(4).should be < declaration(5)
+        declaration(6).should be > declaration(5)
+      end
+      context "with an important declaration" do
+        it "is less than the important declaration regardless of the specificity" do
+          declaration(99, false).should be < declaration(1, true)
+        end
+        it "compares like normal when both declarations are important" do
+          declaration(5, true).should be == declaration(5, true)
+          declaration(4, true).should be < declaration(5, true)
+          declaration(6, true).should 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
+        parsing("color: green", 1).should == ["color", "green", false, 1]
+        parsing(" color:green; ", 1).should == ["color", "green", false, 1]
+        parsing("color: green  ", 1).should == ["color", "green", false, 1]
+        parsing("color: green  ; ", 1).should == ["color", "green", false, 1]
+      end
+      it "understands more complex values" do
+        parsing("padding:0 1px 5rem 9%;", 89).should == ["padding", "0 1px 5rem 9%", false, 89]
+      end
+      it "understands more complex names" do
+        parsing("font-size: 50%", 10).should == ["font-size", "50%", false, 10]
+      end
+      it "correctly reads !important declarations" do
+        parsing("color: green !important", 1).should == ["color", "green", true, 1]
+        parsing("color: green !important;", 1).should == ["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; }")
+      stylesheet.name.should == "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
+      stylesheet.should have(3).blocks
+      stylesheet.blocks.map(&:to_s).should == [
+        "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", "")
+      stylesheet.stub blocks: [bad, inlinable, bad]
+      stylesheet.each_inlinable_block.to_a.should == [
+        ["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 }")
+      stylesheet.to_s.should == "body{color:green}\na{color:red;font-size:small}"
+    end
+  end
+end