roadie 3.0.0.pre1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8dbb2ff6110e3730b2c4b818bbfa1724ad8912ea
-  data.tar.gz: fe0bf94a18e731475ee8bcf1e16d4d6cd6692071
+  metadata.gz: fb9d9810978beb19ef7c13d2ef8953827b418bb1
+  data.tar.gz: db5db2dc87d93790b131fd0b3c515e9c24114525
 SHA512:
-  metadata.gz: 97d48f412f42884ab58afa39325178256bee9f81a5822e8415e746cd3181931048d982a607d12ec5cf11efd5ad11c439cf88f8165f05c7df781f02002641082c
-  data.tar.gz: bdb1604da3762385097b4e156fe38300580d4f3d899dda4d4ed66e5a8fd846405be0eb99df85e54c07cceda0f5a37f0af277773ecd3adf61050f0445ae6d947d
+  metadata.gz: 7cf63f4924682f07f21960926b8b804e9d82e7db8b8c90b2e658557983e9e098534841b823d162736a3d3cc973c23f568987db3e3911fbadcdc0234998c09587
+  data.tar.gz: c65545723737f33444e7c2797a8b01b288d0945a556100217fe7b0f86748bcfbc00908e1cd2204ea21fe26b543f0ebbf40e510831ba681fa6f66cc43ec67e981

data/.travis.yml

@@ -2,6 +2,7 @@ language: ruby
 rvm:
   - 1.9.3
   - 2.0.0
+  - 2.1.2
   - jruby
   - rbx
 

data/Changelog.md

@@ -1,6 +1,27 @@
 ### dev
 
-[full changelog](https://github.com/Mange/roadie/compare/v2.4.2...master)
+[full changelog](https://github.com/Mange/roadie/compare/v3.0.0...master)
+
+* Nothing yet.
+
+### 3.0.0
+
+[full changelog](https://github.com/Mange/roadie/compare/v3.0.0.pre1...v3.0.0)
+
+* Enhancements:
+  * `Roadie::ProviderList` responds to `#empty?` and `#last`
+  *   `Roadie::FilesystemProvider` ignores query string in filename.
+
+      Older versions of Rails generated `<link>` tags with query strings in their URLs, like such:
+       `/stylesheets/email.css?1380694096`
+  * Blacklist `:enabled`, `:disabled` and `:checked` pseudo functions - [Tyler Hunt (tylerhunt)](https://github.com/tylerhunt).
+  * Add MRI 2.1.2 to Travis build matrix - [Grey Baker (greysteil)](https://github.com/greysteil).
+  * Try to detect an upgrade from Roadie 2 and mention how to make it work with the new version.
+  * Styles emitted in the `style` attribute should now be ordered as they were in the source CSS.
+
+### 3.0.0.pre1
+
+[full changelog](https://github.com/Mange/roadie/compare/v2.4.2...v3.0.0.pre1)
 
 Complete rewrite of most of the code and a new direction for the gem.
 

data/Gemfile

@@ -7,8 +7,4 @@ gem 'coveralls', group: :test, require: nil
 group :guard do
   gem 'guard'
   gem 'guard-rspec'
-
-  # Guard for Mac
-  gem 'rb-fsevent', '>= 0.9.0.pre5'
-  gem 'growl'
 end

data/Guardfile

@@ -1,6 +1,6 @@
 rspec_options = {
-  cmd: 'rspec -f nested',
-  keep_failed: true,
+  cmd: 'rspec -f documentation',
+  failed_mode: :keep,
   all_after_pass: true,
   all_on_start: true,
   run_all: {cmd: 'rspec -f progress'}
@@ -9,6 +9,7 @@ rspec_options = {
 guard 'rspec', rspec_options do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('lib/roadie.rb')   { "spec" }
 
   watch(%r{lib/roadie/rspec/.*\.rb}) { "spec" }
 

data/README.md

@@ -7,7 +7,7 @@ Roadie
 [![Gem Version](https://badge.fury.io/rb/roadie.png)](http://badge.fury.io/rb/roadie)
 [![Dependency Status](https://gemnasium.com/Mange/roadie.png)](https://gemnasium.com/Mange/roadie)
 
-**Note: This README details the prerelease 3.0 version of Roadie. You might be using 2.0, which is much older and only for Rails.**
+**Note: This README details the 3.x version of Roadie. You might be using 2.x, which is much older and only for Rails.**
 
 > Making HTML emails comfortable for the Ruby rockstars
 
@@ -70,11 +70,11 @@ Your document instance can be configured several options:
 In order to make URLs absolute you need to first configure the URL options of the document.
 
 ```ruby
-html = "... <a href="/about-us">Read more!</a> ..."
+html = '... <a href="/about-us">Read more!</a> ...'
 document = Roadie::Document.new html
 document.url_options = {host: "myapp.com", protocol: "https"}
 document.transform
-  # => "... <a href="https://myapp.com/about-us">Read more!</a> ..."
+  # => "... <a href=\"https://myapp.com/about-us\">Read more!</a> ..."
 ```
 
 The following URLs will be rewritten for you:
@@ -235,6 +235,7 @@ Tested with [Travis CI](http://travis-ci.org) using:
 
 * MRI 1.9.3
 * MRI 2.0.0
+* MRI 2.1.2
 * JRuby (latest)
 * Rubinius >= 2.1 (experimental)
 
@@ -273,6 +274,7 @@ Documentation
 
 * [Online documentation for gem](http://rubydoc.info/gems/roadie/frames)
 * [Online documentation for master](http://rubydoc.info/github/Mange/roadie/master/frames)
+* [Online documentation for Roadie 2.4](http://rubydoc.info/gems/roadie/2.4/frames)
 * [Changelog](https://github.com/Mange/roadie/blob/master/Changelog.md)
 
 Running specs
@@ -300,7 +302,7 @@ License
 
 (The MIT License)
 
-Copyright (c) 2009-2013
+Copyright (c) 2009-2014
 
 * [Magnus Bergmark](https://github.com/Mange) <magnus.bergmark@gmail.com>
 

data/lib/roadie.rb

@@ -7,7 +7,7 @@ require 'roadie/errors'
 require 'roadie/stylesheet'
 require 'roadie/selector'
 require 'roadie/style_property'
-require 'roadie/style_properties'
+require 'roadie/style_attribute_builder'
 require 'roadie/style_block'
 
 require 'roadie/asset_provider'
@@ -22,3 +22,5 @@ require 'roadie/url_rewriter'
 require 'roadie/null_url_rewriter'
 require 'roadie/inliner'
 require 'roadie/document'
+
+require 'roadie/upgrade_guide'

data/lib/roadie/filesystem_provider.rb

@@ -15,7 +15,6 @@ module Roadie
       @path = path
     end
 
-    # @raise InsecurePathError
     # @return [Stylesheet, nil]
     def find_stylesheet(name)
       file_path = build_file_path(name)
@@ -24,10 +23,22 @@ module Roadie
       end
     end
 
+    # @raise InsecurePathError
+    # @return [Stylesheet]
+    def find_stylesheet!(name)
+      file_path = build_file_path(name)
+      if File.exist? file_path
+        Stylesheet.new file_path, File.read(file_path)
+      else
+        clean_name = File.basename file_path
+        raise CssNotFound.new(clean_name, %{#{file_path} does not exist. (Original name was "#{name}")})
+      end
+    end
+
     private
     def build_file_path(name)
       raise InsecurePathError, name if name.include?("..")
-      File.join(@path, name)
+      File.join(@path, name[/^([^?]+)/])
     end
   end
 end

data/lib/roadie/inliner.rb

@@ -33,8 +33,8 @@ module Roadie
     attr_reader :stylesheets
 
     def apply(style_map)
-      style_map.each_element do |element, properties|
-        apply_element_style element, properties
+      style_map.each_element do |element, builder|
+        apply_element_style element, builder
       end
     end
 
@@ -57,8 +57,8 @@ module Roadie
       end
     end
 
-    def apply_element_style(element, properties)
-      element["style"] = [properties.to_s, element["style"]].compact.join(";")
+    def apply_element_style(element, builder)
+      element["style"] = [builder.attribute_string, element["style"]].compact.join(";")
     end
 
     def elements_matching_selector(stylesheet, selector, dom)
@@ -77,23 +77,25 @@ module Roadie
     end
 
     # @api private
-    # StyleMap is a map between a DOM element and {StyleProperties}. Basically,
+    # StyleMap is a map between a DOM element and {StyleAttributeBuilder}. Basically,
     # it's an accumulator for properties, scoped on specific elements.
     class StyleMap
       def initialize
         @map = Hash.new { |hash, key|
-          hash[key] = StyleProperties.new([])
+          hash[key] = StyleAttributeBuilder.new
         }
       end
 
       def add(elements, new_properties)
         Array(elements).each do |element|
-          @map[element].merge!(new_properties)
+          new_properties.each do |property|
+            @map[element] << property
+          end
         end
       end
 
       def each_element
-        @map.each_pair { |element, properties| yield element, properties }
+        @map.each_pair { |element, builder| yield element, builder }
       end
     end
   end

data/lib/roadie/markup_improver.rb

@@ -74,7 +74,7 @@ module Roadie
 
     def content_type_meta_element_missing?
       dom.xpath('html/head/meta').none? do |meta|
-        meta['http-equiv'].downcase == 'content-type'
+        meta['http-equiv'].to_s.downcase == 'content-type'
       end
     end
 

data/lib/roadie/provider_list.rb

@@ -52,6 +52,8 @@ module Roadie
     #   @see Array#each
     # @!method size
     #   @see Array#size
+    # @!method empty?
+    #   @see Array#empty?
     # @!method push
     #   @see Array#push
     # @!method <<
@@ -62,6 +64,8 @@ module Roadie
     #   @see Array#unshift
     # @!method shift
     #   @see Array#shift
-    def_delegators :@providers, :each, :size, :push, :<<, :pop, :unshift, :shift
+    # @!method last
+    #   @see Array#last
+    def_delegators :@providers, :each, :size, :empty?, :push, :<<, :pop, :unshift, :shift, :last
   end
 end

data/lib/roadie/rspec/asset_provider.rb

@@ -3,26 +3,26 @@ shared_examples_for "roadie asset provider" do |options|
   invalid_name = options[:invalid_name] or raise "You must provide an :invalid_name option to the shared examples"
 
   def verify_stylesheet(stylesheet)
-    stylesheet.should_not be_nil
+    expect(stylesheet).to_not be_nil
 
     # Name
-    stylesheet.name.should be_a(String)
-    stylesheet.name.should_not be_empty
+    expect(stylesheet.name).to be_a(String)
+    expect(stylesheet.name).to_not be_empty
 
     # We do not want to force clients to always return non-empty files.
     # Stylesheet#initialize should crash when given a non-valid CSS (like nil,
     # for example)
-    # stylesheet.blocks.should_not be_empty
+    # expect(stylesheet.blocks).to_not be_empty
   end
 
   it "responds to #find_stylesheet" do
-    subject.should respond_to(:find_stylesheet)
-    subject.method(:find_stylesheet).arity.should == 1
+    expect(subject).to respond_to(:find_stylesheet)
+    expect(subject.method(:find_stylesheet).arity).to eq 1
   end
 
   it "responds to #find_stylesheet!" do
-    subject.should respond_to(:find_stylesheet!)
-    subject.method(:find_stylesheet!).arity.should == 1
+    expect(subject).to respond_to(:find_stylesheet!)
+    expect(subject.method(:find_stylesheet!).arity).to eq 1
   end
 
   describe "#find_stylesheet" do
@@ -31,7 +31,7 @@ shared_examples_for "roadie asset provider" do |options|
     end
 
     it "cannot find an invalid stylesheet" do
-      subject.find_stylesheet(invalid_name).should be_nil
+      expect(subject.find_stylesheet(invalid_name)).to be_nil
     end
   end
 

data/lib/roadie/selector.rb

@@ -57,6 +57,7 @@ module Roadie
       :active :focus :hover :link :target :visited
       :-ms-input-placeholder :-moz-placeholder
       :before :after
+      :enabled :disabled :checked
     ].freeze
 
     def pseudo_element?

data/lib/roadie/style_attribute_builder.rb

@@ -0,0 +1,25 @@
+module Roadie
+  class StyleAttributeBuilder
+    def initialize
+      @styles = []
+    end
+
+    def <<(style)
+      @styles << style
+    end
+
+    def attribute_string
+      stable_sort(@styles).map(&:to_s).join(';')
+    end
+
+    private
+    def stable_sort(list)
+      # Ruby's sort is unstable for performance reasons. We need it to be
+      # stable, e.g. to preserve order of elements that are compared equal in
+      # the sorting.
+      # We can accomplish this by using the original array index as a second
+      # comparator for when the first one is equal.
+      list.each_with_index.sort_by { |item, index| [item, index] }.map(&:first)
+    end
+  end
+end

data/lib/roadie/style_block.rb

@@ -11,7 +11,6 @@ module Roadie
     # @param [Array<StyleProperty>] properties
     def initialize(selector, properties)
       @selector = selector
-      # TODO: Should we use {StyleProperties} instead? Why? Why not?
       @properties = properties
     end
 

data/lib/roadie/upgrade_guide.rb

@@ -0,0 +1,36 @@
+#
+# Let the user know that they need to act to get Roadie compatible with their
+# Rails apps if they might have upgraded from Roadie 2.
+# TODO: Remove this file by the time of version 3.1.
+#
+
+if defined?(Rails) && !defined?(ROADIE_I_KNOW_ABOUT_VERSION_3)
+  begin
+    require 'roadie/rails'
+  rescue LoadError
+    warn <<-WARNING
+Hey there! It looks like you might have tried to upgrade to Roadie 3 from Roadie 2.
+
+Roadie 3 is a completely new version that is no longer interfacing with Rails
+out-of-the-box. In order to use it you need to add the gem roadie-rails too.
+
+You should really read the upgrade guide since the API have changed:
+
+  https://github.com/Mange/roadie-rails/blob/master/Upgrading.md#upgrading-from-roadie-2
+
+I hope this new version will work better for you, but if you are not ready to
+upgrade right now add a version specifier to your Gemfile:
+
+  gem 'roadie', '~> 2.4' # Support any minor version in the Roadie 2 series.
+
+In case you have a need for Roadie without the default Rails integration you
+can remove this warning by setting a constant:
+
+  # config/application.rb
+  ROADIE_I_KNOW_ABOUT_VERSION_3 = true # Remove after Roadie 3.1
+
+Thank you for your attention.
+WARNING
+    raise
+  end
+end

data/lib/roadie/version.rb

@@ -1,3 +1,3 @@
 module Roadie
-  VERSION = '3.0.0.pre1'
+  VERSION = '3.0.0'
 end

data/roadie.gemspec

@@ -20,7 +20,8 @@ Gem::Specification.new do |s|
   s.add_dependency 'nokogiri', '~> 1.6.0'
   s.add_dependency 'css_parser', '~> 1.3.4'
 
-  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rspec', '~> 3.0'
+  s.add_development_dependency 'rspec-collection_matchers', '~> 1.0'
 
   s.extra_rdoc_files = %w[README.md Changelog.md]
   s.require_paths = %w[lib]

data/spec/integration_spec.rb

@@ -15,15 +15,15 @@ describe "Roadie functionality" do
       # See Nokogiri bugs #984 and #985
       # https://github.com/sparklemotion/nokogiri/issues/984
       # https://github.com/sparklemotion/nokogiri/issues/985
-      result.should include("<!DOCTYPE html>")
+      expect(result).to include("<!DOCTYPE html>")
     end
 
-    result.should include("<html>")
-    result.should include("<head>")
-    result.should include("<body>")
+    expect(result).to include("<html>")
+    expect(result).to include("<head>")
+    expect(result).to include("<body>")
 
-    result.should include("<meta")
-    result.should include("text/html; charset=Shift_JIS")
+    expect(result).to include("<meta")
+    expect(result).to include("text/html; charset=Shift_JIS")
   end
 
   it "inlines given css" do
@@ -44,8 +44,8 @@ describe "Roadie functionality" do
     CSS
 
     result = parse_html document.transform
-    result.should have_styling('text-align' => 'center').at_selector('h1')
-    result.should 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 "inlines css from disk" do
@@ -64,7 +64,7 @@ describe "Roadie functionality" do
     HTML
 
     result = parse_html document.transform
-    result.should 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
@@ -107,15 +107,15 @@ describe "Roadie functionality" do
     document.url_options = {host: "myapp.com", scheme: "https", path: "rails/app/"}
     result = parse_html document.transform
 
-    result.at_css("a")["href"].should == "https://myapp.com/rails/app/about_us"
+    expect(result.at_css("a")["href"]).to eq("https://myapp.com/rails/app/about_us")
 
-    result.at_css("img")["src"].should == "https://myapp.com/rails/app/assets/about_us-abcdef1234567890.png"
+    expect(result.at_css("img")["src"]).to eq("https://myapp.com/rails/app/assets/about_us-abcdef1234567890.png")
 
-    result.should have_styling(
+    expect(result).to have_styling(
       "background" => 'url("https://myapp.com/rails/app/assets/bg-abcdef1234567890.png")'
     ).at_selector("body")
 
-    result.should have_styling(
+    expect(result).to have_styling(
       "background" => 'url(https://myapp.com/rails/app/assets/link-abcdef1234567890.png)'
     ).at_selector("a")
   end
@@ -134,7 +134,7 @@ describe "Roadie functionality" do
     document.after_transformation = proc { |dom| dom.at_css("span").remove }
 
     result = parse_html document.transform
-    result.at_css("body")["class"].should == "roadie"
-    result.at_css("span").should be_nil
+    expect(result.at_css("body")["class"]).to eq("roadie")
+    expect(result.at_css("span")).to be_nil
   end
 end