roadie 2.3.4 → 2.4.0

data/.gitignore

@@ -7,4 +7,6 @@ pkg
 .idea/*
 .rvmrc
 
+Gemfile.lock
 doc
+tmp

data/.travis.yml

@@ -1,11 +1,22 @@
 bundler_args: --without guard
+before_install:
+  - gem install bundler --pre
 
 rvm:
   - 1.8.7
-  - 1.9.2
   - 1.9.3
+  - 2.0.0
+  - jruby
 
 gemfile:
-  - gemfiles/rails-3.0.gemfile
-  - gemfiles/rails-3.1.gemfile
-  - gemfiles/rails-3.2.gemfile
+  - gemfiles/rails_3.0.gemfile
+  - gemfiles/rails_3.1.gemfile
+  - gemfiles/rails_3.2.gemfile
+  - gemfiles/rails_4.0.gemfile
+
+matrix:
+  exclude:
+    - rvm: 1.8.7
+      gemfile: gemfiles/rails_4.0.gemfile
+  allow_failures:
+    - rvm: jruby

data/Appraisals

@@ -7,5 +7,9 @@ appraise 'rails-3.1' do
 end
 
 appraise 'rails-3.2' do
-  gem 'rails',      '~> 3.2.0.rc1'
+  gem 'rails',      '~> 3.2.0'
+end
+
+appraise 'rails-4.0' do
+  gem 'rails',      '~> 4.0'
 end

data/Changelog.md

@@ -1,8 +1,28 @@
 ### dev
 
-[full changelog](https://github.com/Mange/roadie/compare/v2.3.3...master)
+[full changelog](https://github.com/Mange/roadie/compare/v2.4.0...master)
 
-* Nothing yet
+* Nothing yet.
+
+### 2.4.0
+
+[full changelog](https://github.com/Mange/roadie/compare/v2.3.4...v2.4.0)
+
+* Enhancements:
+  * Support Rails 4.0, with the help of:
+    * [Ryunosuke SATO (tricknotes)](https://github.com/tricknotes)
+    * [Dylan Markow](https://github.com/dmarkow)
+  * Keep `!important` when outputting styles to help combat web mail styles being `!important`
+  * Support `:nth-child`, `:last-child`, etc.
+    * To make this work, Roadie have to catch errors from Nokogiri and ignore them. A warning will be printed when this happens so users can open issues with the project and tests can be expanded.
+  * Support for custom inliner (#58) — [Harish Shetty (kandadaboggu)](https://github.com/kandadaboggu) with friends
+* Bug fixes:
+  * Don't crash when URL options have protocols with "://" in them (#52).
+* Other:
+  * Be more specific on which versions are required; require newer `css_parser`
+  * Officially support MRI 2.0.0
+  * Add experimental support for JRuby
+  * Remove documentation that talks about passing CSS filenames as symbols; unsupported in Rails 4. (Thanks to [PikachuEXE](https://github.com/PikachuEXE))
 
 ### 2.3.4
 
@@ -30,7 +50,7 @@
 [full changelog](https://github.com/Mange/roadie/compare/v2.3.1...v2.3.2)
 
 * Bug fixes:
-  * Don't fail on selectors which start with @ (#28) – [Roman Shterenzon (romanbsd)](https://github.com/romanbsd)
+  * Don't fail on selectors which start with @ (#28) — [Roman Shterenzon (romanbsd)](https://github.com/romanbsd)
 
 ### 2.3.1
 
@@ -74,7 +94,7 @@
 
 [full changelog](https://github.com/Mange/roadie/compare/v2.1.0.pre1...v2.1.0.pre2)
 
-* Bug: Roadie broke url_for inside mailer views
+* Bug: Roadie broke `url_for` inside mailer views
 
 ### 2.1.0.pre1
 

data/Gemfile

@@ -1,4 +1,4 @@
-source :rubygems
+source 'https://rubygems.org'
 gemspec
 
 group :guard do

data/Guardfile

@@ -1,4 +1,4 @@
-guard 'rspec', :rvm => ['1.9.3', 'jruby-head', 'ruby-1.8.7-p358'] do
+guard 'rspec' do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
 

data/README.md

@@ -3,7 +3,7 @@ Roadie
 
 > Making HTML emails comfortable for the Rails rockstars
 
-Roadie tries to make sending HTML emails a little less painful in Rails 3 by inlining stylesheets and rewrite relative URLs for you.
+Roadie tries to make sending HTML emails a little less painful in Rails 3+ by inlining stylesheets and rewrite relative URLs for you.
 
 If you want to have this in Rails 2, please see [MailStyle](https://www.github.com/purify/mail_style).
 
@@ -23,16 +23,17 @@ Build Status
 
 [![Build history and status](https://secure.travis-ci.org/Mange/roadie.png)](http://travis-ci.org/#!/Mange/roadie)
 
-Tested with [Travis CI](http://travis-ci.org) using the [all combinations of](http://travis-ci.org/#!/Mange/roadie):
+Tested with [Travis CI](http://travis-ci.org) using [almost all combinations of](http://travis-ci.org/#!/Mange/roadie):
 
 * Ruby:
-  * 1.8.7
-  * 1.9.2
-  * 1.9.3
+  * MRI 1.8.7
+  * MRI 1.9.3
+  * MRI 2.0.0
 * Rails
   * 3.0
   * 3.1
   * 3.2
+  * 4.0
 
 Let me know if you want any other combination supported officially.
 
@@ -74,6 +75,7 @@ Roadie listens to the following options (set in `Application.rb` or in your envi
 * `config.action_mailer.default_url_options` - Used for making URLs absolute.
 * `config.assets.enabled` - If the asset pipeline is turned off, Roadie will default to searching for assets in `public/stylesheets`.
 * `config.roadie.provider` - Set the provider manually, ignoring all other options. Use for advanced cases, or when you have non-default paths or other options.
+* `config.roadie.after_inlining` - Set a custom inliner for the HTML document. The custom inliner in invoked after the default inliner.
 
 Usage
 -----
@@ -86,19 +88,19 @@ You can also specify the `:css` option to mailer to have it inlined automaticall
 
 ```ruby
 class Notifier < ActionMailer::Base
-  default :css => :email, :from => 'support@mycompany.com'
+  default :css => 'email', :from => 'support@mycompany.com'
 
   def registration_mail
     mail(:subject => 'Welcome Aboard', :to => 'someone@example.com')
   end
 
   def newsletter
-    mail(:subject => 'Newsletter', :to => 'someone@example.com', :css => [:email, :newsletter])
+    mail(:subject => 'Newsletter', :to => 'someone@example.com', :css => ['email', 'newsletter'])
   end
 end
 ```
 
-This will look for a css file called `email.css` in your assets. The `css` method can take either a string, a symbol or an array of both. The ".css" extension will be added automatically.
+This will look for a css file called `email.css` in your assets. The `css` method can take either a string or an array of strings. The ".css" extension will be added automatically.
 
 ### Image URL rewriting ###
 
@@ -140,7 +142,7 @@ If the `link` tag uses an absolute URL to the stylesheet, it will not be inlined
 Writing your own provider
 -------------------------
 
-A provider handles searching CSS files for you. Cou can easily create your own provider for your specific app by subclassing `Roadie::AssetProvider`. See the API documentation for information about how to build them.
+A provider handles searching CSS files for you. You can easily create your own provider for your specific app by subclassing `Roadie::AssetProvider`. See the API documentation for information about how to build them.
 
 Example Subclassing the `AssetPipelineProvider`:
 
@@ -151,11 +153,80 @@ config.roadie.provider = UserAssetsProvider.new
 # lib/user_assets_provider.rb
 class UserAssetsProvider < Roadie::AssetPipelineProvider
   def find(name)
-    super
-  rescue CSSFileNotFound
     user = User.find_by_name(name)
-    raise unless user
-    user.custom_css
+    if user
+      user.custom_css
+    else
+      super
+    end
+  end
+end
+```
+
+Writing your own inliner
+-------------------------
+
+A custom inliner transforms an outgoing HTML email using application specific rules. The custom inliner is invoked after the default inliner.
+
+A custom inliner can be created using a `lambda` that accepts one parameter or an object that responds to the `call` method with one parameter.
+
+Example for using lambda as custom inliner:
+
+```ruby
+# application.rb
+config.roadie.after_inlining = lambda do |document|
+  document.css("a#new_user").each do |link|
+    link['href'] = "http://www.foo.com#{link['href']}"
+  end
+end
+```
+
+Example for using object as custom inliner:
+
+```ruby
+# application.rb
+config.roadie.after_inlining = PromotionInliner.new
+
+# lib/product_link_inliner.rb
+class PromotionInliner
+  def call(document)
+    document.css("a.product").each do |link|
+      fix_link link
+    end
+  end
+
+  def fix_link(link)
+    if link['class'] =~ /\bsale\b/
+      link['href'] = link['href'] + '?source=newsletter'
+    end
+  end
+end
+```
+
+### Custom inliner scopes
+
+- **All HTML emails**
+
+```ruby
+# application.rb. Custom inliner for all emails.
+config.roadie.after_inlining = PromotionInliner.new
+```
+- **All HTML emails sent by a mailer**
+
+```ruby
+class MarketingMailer < ActionMailer::Base
+  # Custom inliner for all mailer methods.
+  default after_inlining: PromotionInliner.new
+end
+```
+
+- **All HTML emails sent by a specific mailer method**
+
+```ruby
+class UserMailer < ActionMailer::Base
+  def registration
+    # Custom inliner for registration emails
+    mail(after_inlining: MarketingMailer.new)
   end
 end
 ```
@@ -206,10 +277,11 @@ History and contributors
 Major contributors to Roadie:
 
 * [Arttu Tervo (arttu)](https://github.com/arttu) - Original Asset pipeline support
+* [Ryunosuke SATO (tricknotes)](https://github.com/tricknotes) - Initial Rails 4 support
 
 You can [see all contributors](https://github.com/Mange/roadie/contributors) on GitHub.
 
-This gem was originally developed for Rails 2 use on [Purify](http://purifyapp.com) under the name [MailStyle](https://www.github.com/purify/mail_style). However, the author stopped maintaining it and a fork took place to make it Rails 3 compatible.
+This gem was originally developed for Rails 2 use on [Purify](http://purifyapp.com) under the name [MailStyle](https://www.github.com/purify/mail_style). However, the author stopped maintaining it and a fork took place to make it Rails 3+ compatible.
 
 The following people have contributed to the orignal gem:
 
@@ -225,7 +297,7 @@ License
 
 (The MIT License)
 
-Copyright (c) 2009-2011
+Copyright (c) 2009-2013
 
 * [Jim Neath](http://jimneath.org)
 * Magnus Bergmark <magnus.bergmark@gmail.com>

data/gemfiles/{rails-3.0.gemfile → rails_3.0.gemfile}

@@ -1,6 +1,6 @@
 # This file was generated by Appraisal
 
-source :rubygems
+source "https://rubygems.org"
 
 gem "rails", "~> 3.0.0"
 

data/{Gemfile.lock → gemfiles/rails_3.0.gemfile.lock}

@@ -1,14 +1,14 @@
 PATH
-  remote: .
+  remote: /home/mange/Projects/roadie
   specs:
     roadie (2.3.4)
-      actionmailer (> 3.0.0, < 3.3.0)
-      css_parser
-      nokogiri (>= 1.4.4)
+      actionmailer (> 3.0.0, < 5.0.0)
+      css_parser (~> 1.3.4)
+      nokogiri (~> 1.6.0)
       sprockets
 
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
     abstract (1.0.0)
     actionmailer (3.0.17)
@@ -37,53 +37,31 @@ GEM
       activemodel (= 3.0.17)
       activesupport (= 3.0.17)
     activesupport (3.0.17)
-    addressable (2.3.2)
-    appraisal (0.5.0)
+    addressable (2.3.5)
+    appraisal (0.5.1)
       bundler
       rake
     arel (2.0.10)
     builder (2.1.2)
-    coderay (1.0.8)
-    css_parser (1.2.6)
+    css_parser (1.3.4)
       addressable
-      rdoc
     diff-lcs (1.1.3)
     erubis (2.6.6)
       abstract (>= 1.0.0)
-    growl (1.0.3)
-    guard (1.5.3)
-      listen (>= 0.4.2)
-      lumberjack (>= 1.0.2)
-      pry (>= 0.9.10)
-      thor (>= 0.14.6)
-    guard-rspec (2.1.1)
-      guard (>= 1.1)
-      rspec (~> 2.11)
-    hike (1.2.1)
+    hike (1.2.3)
     i18n (0.5.0)
     json (1.7.5)
-    json (1.7.5-java)
-    listen (0.5.3)
-    lumberjack (1.0.2)
     mail (2.2.19)
       activesupport (>= 2.3.6)
       i18n (>= 0.4.0)
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
-    method_source (0.8.1)
     mime-types (1.19)
-    multi_json (1.3.7)
-    nokogiri (1.5.5)
+    mini_portile (0.5.0)
+    multi_json (1.7.7)
+    nokogiri (1.6.0)
+      mini_portile (~> 0.5.0)
     polyglot (0.3.3)
-    pry (0.9.10)
-      coderay (~> 1.0.5)
-      method_source (~> 0.8)
-      slop (~> 3.3.1)
-    pry (0.9.10-java)
-      coderay (~> 1.0.5)
-      method_source (~> 0.8)
-      slop (~> 3.3.1)
-      spoon (~> 0.0)
     rack (1.2.5)
     rack-mount (0.6.14)
       rack (>= 1.0.0)
@@ -103,47 +81,43 @@ GEM
       rake (>= 0.8.7)
       rdoc (~> 3.4)
       thor (~> 0.14.4)
-    rake (0.9.2.2)
-    rb-fsevent (0.9.2)
+    rake (10.0.2)
     rdoc (3.12)
       json (~> 1.4)
-    rspec (2.11.0)
-      rspec-core (~> 2.11.0)
-      rspec-expectations (~> 2.11.0)
-      rspec-mocks (~> 2.11.0)
-    rspec-core (2.11.1)
-    rspec-expectations (2.11.3)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.1)
+    rspec-expectations (2.12.0)
       diff-lcs (~> 1.1.3)
-    rspec-mocks (2.11.3)
-    rspec-rails (2.11.4)
+    rspec-mocks (2.12.0)
+    rspec-rails (2.12.0)
       actionpack (>= 3.0)
       activesupport (>= 3.0)
       railties (>= 3.0)
-      rspec (~> 2.11.0)
-    slop (3.3.3)
-    spoon (0.0.1)
-    sprockets (2.8.1)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    sprockets (2.10.0)
       hike (~> 1.2)
       multi_json (~> 1.0)
       rack (~> 1.0)
       tilt (~> 1.1, != 1.3.0)
     thor (0.14.6)
-    tilt (1.3.3)
+    tilt (1.4.1)
     treetop (1.4.12)
       polyglot
       polyglot (>= 0.3.1)
     tzinfo (0.3.35)
 
 PLATFORMS
-  java
   ruby
 
 DEPENDENCIES
   appraisal
-  growl
-  guard
-  guard-rspec
-  rails
-  rb-fsevent (>= 0.9.0.pre5)
+  rails (~> 3.0.0)
+  rake
   roadie!
+  rspec
   rspec-rails

data/gemfiles/{rails-3.1.gemfile → rails_3.1.gemfile}

@@ -1,6 +1,6 @@
 # This file was generated by Appraisal
 
-source :rubygems
+source "https://rubygems.org"
 
 gem "rails", "~> 3.1.0"
 

data/gemfiles/{rails-3.1.gemfile.lock → rails_3.1.gemfile.lock}

@@ -1,14 +1,14 @@
 PATH
-  remote: /Users/mange/Projects/roadie
+  remote: /home/mange/Projects/roadie
   specs:
-    roadie (2.3.3)
-      actionmailer (> 3.0.0, < 3.3.0)
-      css_parser
-      nokogiri (>= 1.4.4)
+    roadie (2.3.4)
+      actionmailer (> 3.0.0, < 5.0.0)
+      css_parser (~> 1.3.4)
+      nokogiri (~> 1.6.0)
       sprockets
 
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
     actionmailer (3.1.4)
       actionpack (= 3.1.4)
@@ -38,29 +38,28 @@ GEM
       activesupport (= 3.1.4)
     activesupport (3.1.4)
       multi_json (~> 1.0)
-    addressable (2.3.2)
-    appraisal (0.4.1)
+    addressable (2.3.5)
+    appraisal (0.5.1)
       bundler
       rake
     arel (2.2.3)
     builder (3.0.0)
-    css_parser (1.2.6)
+    css_parser (1.3.4)
       addressable
-      rdoc
     diff-lcs (1.1.3)
     erubis (2.7.0)
     hike (1.2.1)
-    i18n (0.6.0)
-    json (1.6.5)
-    json (1.6.5-java)
+    i18n (0.6.1)
+    json (1.7.5)
     mail (2.3.3)
       i18n (>= 0.4.0)
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
-    mime-types (1.18)
-    multi_json (1.1.0)
-    nokogiri (1.5.5)
-    nokogiri (1.5.5-java)
+    mime-types (1.19)
+    mini_portile (0.5.0)
+    multi_json (1.4.0)
+    nokogiri (1.6.0)
+      mini_portile (~> 0.5.0)
     polyglot (0.3.3)
     rack (1.3.6)
     rack-cache (1.2)
@@ -69,7 +68,7 @@ GEM
       rack (>= 1.0.0)
     rack-ssl (1.3.2)
       rack
-    rack-test (0.6.1)
+    rack-test (0.6.2)
       rack (>= 1.0)
     rails (3.1.4)
       actionmailer (= 3.1.4)
@@ -86,39 +85,42 @@ GEM
       rake (>= 0.8.7)
       rdoc (~> 3.4)
       thor (~> 0.14.6)
-    rake (0.9.2.2)
+    rake (10.0.2)
     rdoc (3.12)
       json (~> 1.4)
-    rspec (2.9.0)
-      rspec-core (~> 2.9.0)
-      rspec-expectations (~> 2.9.0)
-      rspec-mocks (~> 2.9.0)
-    rspec-core (2.9.0)
-    rspec-expectations (2.9.0)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.1)
+    rspec-expectations (2.12.0)
       diff-lcs (~> 1.1.3)
-    rspec-mocks (2.9.0)
-    rspec-rails (2.9.0)
+    rspec-mocks (2.12.0)
+    rspec-rails (2.12.0)
       actionpack (>= 3.0)
       activesupport (>= 3.0)
       railties (>= 3.0)
-      rspec (~> 2.9.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
     sprockets (2.0.3)
       hike (~> 1.2)
       rack (~> 1.0)
       tilt (~> 1.1, != 1.3.0)
     thor (0.14.6)
     tilt (1.3.3)
-    treetop (1.4.10)
+    treetop (1.4.12)
       polyglot
       polyglot (>= 0.3.1)
-    tzinfo (0.3.32)
+    tzinfo (0.3.35)
 
 PLATFORMS
-  java
   ruby
 
 DEPENDENCIES
   appraisal
   rails (~> 3.1.0)
+  rake
   roadie!
+  rspec
   rspec-rails