RubyGems - mail_style - Versions diffs - 0.1.4 → 0.1.5 - Mend

mail_style 0.1.4 → 0.1.5

Files changed (6) hide show

data/lib/mail_style/inline_styles.rb +75 -39
data/lib/mail_style/sass_support.rb +5 -3
data/readme.textile +22 -4
data/spec/inline_styles_spec.rb +113 -39
data/spec/spec_helper.rb +6 -1
metadata +2 -2

data/lib/mail_style/inline_styles.rb CHANGED Viewed

@@ -5,21 +5,29 @@ require 'css_parser'
 module MailStyle
   module InlineStyles
     DOCTYPE = '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
     module InstanceMethods
       def create_mail_with_inline_styles
-        write_inline_styles if @css.present?
+        write_inline_styles
         create_mail_without_inline_styles
       end
       protected
+      # Flatten nested parts
+      def collect_parts(parts)
+        nested = parts.present? ? parts.map { |p| collect_parts(p.parts) }.flatten : []
+        [parts, nested].flatten
+      end
       def write_inline_styles
+        parts = collect_parts(@parts)
         # Parse only text/html parts
         parsable_parts(@parts).each do |part|
           part.body = parse_html(part.body)
         end
         # Parse single part emails if the body is html
         real_content_type, ctype_attrs = parse_content_type
         self.body = parse_html(body) if body.is_a?(String) && real_content_type == 'text/html'
@@ -27,9 +35,9 @@ module MailStyle
       def parsable_parts(parts)
         selected = []
-        parts.each do |p|
-          selected << p if p.content_type == 'text/html'
-          selected += parsable_parts(p.parts)
+        parts.each do |part|
+          selected << part if part.content_type == 'text/html'
+          selected += parsable_parts(part.parts)
         end
         selected
       end
@@ -41,17 +49,18 @@ module MailStyle
         # Write inline styles
         element_styles = {}
         css_parser.each_selector do |selector, declaration, specificity|
+          next if selector.include?(':')
           html_document.css(selector).each do |element|
             declaration.to_s.split(';').each do |style|
               # Split style in attribute and value
               attribute, value = style.split(':').map(&:strip)
               # Set element style defaults
               element_styles[element] ||= {}
               element_styles[element][attribute] ||= { :specificity => 0, :value => '' }
               # Update attribute value if specificity is higher than previous values
               if element_styles[element][attribute][:specificity] <= specificity
                 element_styles[element][attribute] = { :specificity => specificity, :value => value }
@@ -59,12 +68,12 @@ module MailStyle
             end
           end
         end
         # Loop through element styles
         element_styles.each_pair do |element, attributes|
           # Elements current styles
           current_style = element['style'].to_s.split(';').sort
           # Elements new styles
           new_style = attributes.map{|attribute, style| "#{attribute}: #{update_image_urls(style[:value])}"}
@@ -74,94 +83,121 @@ module MailStyle
           # Set new styles
           element['style'] = style.join(';')
         end
         # Return HTML
         html_document.to_html
       end
       def absolutize_image_sources(document)
         document.css('img').each do |img|
           src = img['src']
           img['src'] = src.gsub(src, absolutize_url(src))
         end
         document
       end
       # Create Nokogiri html document from part contents and add/amend certain elements.
       # Reference: http://www.creativeglo.co.uk/email-design/html-email-design-and-coding-tips-part-2/
       def create_html_document(body)
         # Add doctype to html along with body
         document = Nokogiri::HTML.parse(DOCTYPE + body)
         # Set some meta stuff
         html = document.at_css('html')
         html['xmlns'] = 'http://www.w3.org/1999/xhtml'
         # Create <head> element if missing
         head = document.at_css('head')
         unless head.present?
           head = Nokogiri::XML::Node.new('head', document)
           document.at_css('body').add_previous_sibling(head)
         end
         # Add utf-8 content type meta tag
         meta = Nokogiri::XML::Node.new('meta', document)
         meta['http-equiv'] = 'Content-Type'
         meta['content'] = 'text/html; charset=utf-8'
         head.add_child(meta)
+        # Grab all the styles that are inside <style> elements already in the document
+        @inline_rules = ""
+        document.css("style").each do |style|
+          # Do not inline print media styles
+          next if style['media'] == 'print'
+          # <style data-immutable="true"> are kept in the document
+          next if style['data-immutable'] == 'true'
+          @inline_rules << style.content
+          style.remove
+        end
         # Return document
         document
       end
       # Update image urls
       def update_image_urls(style)
         if default_url_options[:host].present?
           # Replace urls in stylesheets
           style.gsub!($1, absolutize_url($1, 'stylesheets')) if style[/url\(['"]?(.*)['"]?\)/i]
         end
         style
       end
-      # Absolutize URL (Absolutize? Seriously?)
+       # Absolutize URL (Absolutize? Seriously?)
       def absolutize_url(url, base_path = '')
         original_url = url
         unless original_url[URI::regexp(%w[http https])]
-          # Calculate new path
+          protocol = default_url_options[:protocol]
+          protocol = "http://" if protocol.blank?
+          protocol+= "://" unless protocol.include?("://")
           host = default_url_options[:host]
-          url = URI.join("http://#{host}/", File.join(base_path, original_url)).to_s
+          [host,protocol].each{|r| original_url.gsub!(r,"") }
+          host = protocol+host unless host[URI::regexp(%w[http https])]
+          url = URI.join host, base_path, original_url
         end
-        url
+        url.to_s
       end
       # Css Parser
       def css_parser
         parser = CssParser::Parser.new
-        parser.add_block!(css_rules)
+        parser.add_block!(css_rules) if @css.present?
+        parser.add_block!(@inline_rules)
         parser
       end
       # Css Rules
       def css_rules
-        File.read(css_file)
+        if @css.is_a?(Array)
+          @css.collect{|r| File.read(css_file(r)) }.join("\n")
+        else
+          File.read css_file(@css)
+        end
       end
       # Find the css file
-      def css_file
-        if @css.present?
-          css = @css.to_s
+      def css_file(name=nil)
+        if name.present?
+          css = name.to_s
           css = css[/\.css$/] ? css : "#{css}.css"
           path = File.join(RAILS_ROOT, 'public', 'stylesheets', css)
           File.exist?(path) ? path : raise(CSSFileNotFound)
         end
       end
     end
     def self.included(receiver)
       receiver.send :include, InstanceMethods
       receiver.class_eval do

data/lib/mail_style/sass_support.rb CHANGED Viewed

@@ -2,14 +2,16 @@ module MailStyle
   module InlineStyles
     module InstanceMethods
       def css_file_with_sass
+        p "css_file_with_sass"
         if !Sass::Plugin.checked_for_updates || Sass::Plugin.options[:always_update] || Sass::Plugin.options[:always_check]
           Sass::Plugin.update_stylesheets
         end
         css_file_without_sass
       end
-      alias_method_chain :css_file, :sass
+      #alias_method_chain :css_file, :sass
     end
   end
 end

data/readme.textile CHANGED Viewed

@@ -11,9 +11,9 @@ h2. Install
 First install the dependencies:
 <pre><code>sudo gem install nokogiri css_parser</code></pre>
 Then install MailStyle to your rails app, either as a plugin:
 <pre><code>script/plugin install http://github.com/purify/mail_style</code></pre>
 Or you can install the gem:
@@ -36,16 +36,33 @@ Simply add the <code>css</code> method to your deliver actions:
 <pre><code>class Notifier < ActionMailer::Base
   def welcome_email
     css :email
     subject 'Welcome Aboard'
     recipients 'someone@example.com'
     from 'jimneath@googlemail.com'
     sent_on Time.now
   end
+  def newsletter_email
+    css [:email,:newsletter]
+    subject 'Newsletter'
+    recipients 'someone@example.com'
+    from 'jimneath@googlemail.com'
+    sent_on Time.now
+  end
 end</code></pre>
 This will look for a css file called _email.css_ in your _public/stylesheets_ folder. The <code>css</code> method can take either a string or a symbol. You can also pass the css file name with or without the .css extension.
+h3. Styles in the email's HEAD
+By default, &lt;style&gt; elements in the email document's &lt;head&gt; are processed and removed from the &lt;head&gt;.
+Style elements with <code>media="print"</code> are ignored.
+You can set a special <code>data-immutable="true"</code> attribute on &lt;style&gt; tags you do not want to be processed and removed from the document's &lt;head&gt;.
 h2. Image URL Correcting
 If you have _default_url_options[:host]_ set in your mailer, then MailStyle will do it's best to make the urls of images absolute.
@@ -84,4 +101,5 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of
 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-THE SOFTWARE IS PROVIDED ‘AS IS’, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THE SOFTWARE IS PROVIDED ‘AS IS’, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/spec/inline_styles_spec.rb CHANGED Viewed

@@ -1,5 +1,5 @@
 # coding: utf-8
-require File.dirname(__FILE__) + '/spec_helper'
+require 'spec_helper'
 RAILS_ROOT = File.join(File.dirname(__FILE__), '../../../../')
@@ -15,7 +15,23 @@ class TestMailer < ActionMailer::Base
   def test_multipart(css_file = nil)
     setup_email(css_file)
     content_type 'multipart/alternative'
-    part :content_type => 'text/html', :body => '<p class="text">Hello World</p>'
+    part :content_type => 'text/html', :body => '<p class="text">Hello <a href="htt://example.com/">World</a></p>'
+    part :content_type => 'text/plain', :body => 'Hello World'
+  end
+  def test_nested_multipart_mixed(css_file = nil)
+    setup_email(css_file)
+    content_type "multipart/mixed"
+    part :content_type => "multipart/alternative", :content_disposition => "inline" do |p|
+      p.part :content_type => 'text/html', :body => '<p class="text">Hello World</p>'
+      p.part :content_type => 'text/plain', :body => 'Hello World'
+    end
+  end
+  def test_inline_rules(rules)
+    setup_email(nil)
+    content_type 'multipart/alternative'
+    part :content_type => 'text/html', :body => "#{rules}<p class=\"text\">Hello World</p>"
     part :content_type => 'text/plain', :body => 'Hello World'
   end
@@ -50,6 +66,47 @@ class TestMailer < ActionMailer::Base
   end
 end
+shared_examples_for "inline styles" do
+  before(:each) do
+    css_rules <<-EOF
+      body { background: #000 }
+      .text { color: #0f0; font-size: 14px }
+      p { color: #f00; line-height: 1.5 }
+    EOF
+  end
+  it "should add the correct xml namespace" do
+    should match(/<html xmlns="http:\/\/www\.w3\.org\/1999\/xhtml">/)
+  end
+  it "should write the xhtml 1.0 doctype" do
+    should match(/<!DOCTYPE html PUBLIC "-\/\/W3C\/\/DTD XHTML 1\.0 Transitional\/\/EN" "http:\/\/www.w3.org\/TR\/xhtml1\/DTD\/xhtml1-transitional\.dtd">/mi)
+  end
+  it "should write utf-8 content type meta tag" do
+    should match(/<head>.*<meta http\-equiv="Content\-Type" content="text\/html; charset=utf\-8">.*<\/head>/mi)
+  end
+  it "should wrap with html and body tag if missing" do
+    should match(/<html.*>.*<body.*>.*<\/body>.*<\/html>/m)
+  end
+  it "should add style to body" do
+    should match(/<body style="background: #000">/)
+  end
+  it "should add both styles to paragraph" do
+    should match(/<p class="text" style="color: #0f0;font-size: 14px;line-height: 1.5">/)
+  end
+  it "should not crash on :pseudo-classes" do
+    css_rules("a:link { color: #f00 }")
+    expect do
+      subject
+    end.to_not raise_error(StandardError)
+  end
+end
 describe 'Inline styles' do
   describe 'singlepart' do
     before(:each) do
@@ -95,41 +152,9 @@ describe 'Inline styles' do
     end
     describe 'rendering inline styles' do
-      before(:each) do
-        css_rules <<-EOF
-          body { background: #000 }
-          .text { color: #0f0; font-size: 14px }
-          p { color: #f00; line-height: 1.5 }
-        EOF
-        # Generate email
-        @email = TestMailer.deliver_test_multipart(:real)
-        @html = html_part(@email)
-      end
-      it "should add the correct xml namespace" do
-        @html.should match(/<html xmlns="http:\/\/www\.w3\.org\/1999\/xhtml">/)
-      end
-      it "should write the xhtml 1.0 doctype" do
-        @html.should match(/<!DOCTYPE html PUBLIC "-\/\/W3C\/\/DTD XHTML 1\.0 Transitional\/\/EN" "http:\/\/www.w3.org\/TR\/xhtml1\/DTD\/xhtml1-transitional\.dtd">/mi)
-      end
-      it "should write utf-8 content type meta tag" do
-        @html.should match(/<head>.*<meta http\-equiv="Content\-Type" content="text\/html; charset=utf\-8">.*<\/head>/mi)
-      end
-      it "should wrap with html and body tag if missing" do
-        @html.should match(/<html.*>.*<body.*>.*<\/body>.*<\/html>/m)
-      end
-      it "should add style to body" do
-        @html.should match(/<body style="background: #000">/)
-      end
-      it "should add both styles to paragraph" do
-        @html.should match(/<p class="text" style="color: #0f0;font-size: 14px;line-height: 1.5">/)
-      end
+      let(:email) { TestMailer.deliver_test_multipart(:real) }
+      subject     { html_part(email) }
+      it_should_behave_like("inline styles")
     end
     describe 'combining styles' do
@@ -155,9 +180,13 @@ describe 'Inline styles' do
     end
     describe 'css file' do
-      it "should do nothing if no css file is set" do
+      it "should not change the styles nothing if no css file is set" do
+        css_rules <<-EOF
+          .text { color: #0f0; }
+          p { color: #f00; }
+        EOF
         @email = TestMailer.deliver_test_multipart(nil)
-        html_part(@email).should eql('<p class="text">Hello World</p>')
+        html_part(@email).should match(/<p class="text">/)
       end
       it "should raise MailStyle::CSSFileNotFound if css file does not exist" do
@@ -184,4 +213,49 @@ describe 'Inline styles' do
       @email.parts.length.should eql(2)
     end
   end
+  describe "multipart mixed" do
+    let(:email) { TestMailer.deliver_test_nested_multipart_mixed(:real) }
+    subject     { html_part(email) }
+    it_should_behave_like("inline styles")
+  end
+  describe "inline rules" do
+    let(:email) { TestMailer.deliver_test_inline_rules("<style> .text { color: #f00; line-height: 1.5 } </style>") }
+    subject     { html_part(email) }
+    it "should style the elements with rules inside the document" do
+      should match(/<p class="text" style="color:\s+#f00;\s*line-height:\s+1.5">/)
+    end
+    it "should remove the styles from the document" do
+      should_not match(/<style/)
+    end
+  end
+  describe "inline rules for print media" do
+    let(:email) { TestMailer.deliver_test_inline_rules('<style media="print"> .text { color: #f00; } </style>') }
+    subject     { html_part(email) }
+    it "should not change element styles" do
+      should match(/<p class="text">/)
+    end
+    it "should not remove the styles from the document" do
+      should match(/<style media="print"/)
+    end
+  end
+  describe "inline immutable styles" do
+    let(:email) { TestMailer.deliver_test_inline_rules('<style data-immutable="true"> .text { color: #f00; } </style>') }
+    subject     { html_part(email) }
+    it "should not change element styles" do
+      should match(/<p class="text">/)
+    end
+    it "should not remove the styles from the document" do
+      should match(/<style data-immutable="true"/)
+    end
+  end
 end

data/spec/spec_helper.rb CHANGED Viewed

@@ -5,9 +5,14 @@ require 'spec'
 require 'action_mailer'
 require 'mail_style'
+def flatten_parts(parts)
+  nested = !parts.empty? ? parts.map { |p| flatten_parts(p.parts) }.flatten : []
+  [parts, nested].flatten
+end
 # Extract HTML Part
 def html_part(email)
-  email.parts.select{|part| part.content_type == 'text/html'}.first.body
+  flatten_parts(email.parts).select{|part| part.content_type == 'text/html'}.first.body
 end
 def css_rules(css)

metadata CHANGED Viewed

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments:
   - 0
   - 1
-  - 4
-  version: 0.1.4
+  - 5
+  version: 0.1.5
 platform: ruby
 authors:
 - Jim Neath