rails_email_preview 0.0.2 → 0.0.3

data/README.md

@@ -69,9 +69,27 @@ In config/routes.rb add:
 
 To get the url of RailsEmailPreview in your main app you can call rails_email_preview.root_url
 
+
+Premailer integration
+---------------------
+
+[Premailer](https://github.com/alexdunae/premailer) (CSS inlining) integration can be done by using the <code>before_render</code> hook:
+
+For example, to process the previews with [ActionMailer Inline CSS](https://github.com/ndbroadbent/actionmailer_inline_css)
+can be done like so:
+
+    RailsEmailPreview.setup do |config|
+      config.before_render do |message|
+        ActionMailer::InlineCssHook.delivering_email(message)
+      end
+    end
+
 Interface
 ---------
 
-ToDo: Add a screenshot
+![List of application mails](http://4.bp.blogspot.com/-hkZlhO7ze8I/Tylinqxas2I/AAAAAAAABQo/17eEkwBkdnQ/s1600/email-preview-index.png)
+![Viewing an email](http://3.bp.blogspot.com/-Y6aM_RVrZXE/TyliuI3P6AI/AAAAAAAABQ0/_YJkeC9D5xg/s1600/email-preview-show.png)
+
+As this is a rails engine, you can ovveride any of the views, or make them use your layout.
 
 This project rocks and uses MIT-LICENSE.

data/app/controllers/rails_email_preview/emails_controller.rb

@@ -1,7 +1,9 @@
 class RailsEmailPreview::EmailsController < RailsEmailPreview::ApplicationController
+  include ERB::Util
   before_filter :load_preview_class, :except => :index
+
   def index
-    @preview_classes = (RailsEmailPreview.preview_classes || [])
+    @preview_class_names = (RailsEmailPreview.preview_classes || []).map { |klass| klass.is_a?(String) ? klass : klass.name }
   end
 
   def show
@@ -10,20 +12,29 @@ class RailsEmailPreview::EmailsController < RailsEmailPreview::ApplicationContro
 
   def show_raw
     @mail = @preview_class.new.send(params[:mail_action])
-    body_part = @mail
-    if @mail.multipart?
-      body_part = @mail.parts.find { |part| part.content_type.start_with?(@part_type) } || @mail.parts.first
-    end
-    body = body_part.body
-    if body_part.content_type =~ /plain/
-      body = "<pre id='message_body'>#{body}</body>"
+    RailsEmailPreview.run_before_render(@mail)
+    if @part_type == 'raw'
+      body = "<pre id='raw_message'>#{html_escape(@mail.to_s)}</pre>"
+    else
+      body_part = @mail
+      if @mail.multipart?
+        body_part = @mail.parts.find { |part| part.content_type.start_with?(@part_type) } || @mail.parts.first
+      end
+      body = body_part.body
+      if body_part.content_type =~ /plain/
+        body = "<pre id='message_body'>#{body}</body>"
+      end
     end
+
     render :text => body, :layout => false
   end
 
   private
   def load_preview_class
-    @preview_class = (RailsEmailPreview.preview_classes || []).find {|pc| pc.name.underscore == params[:mail_class]}
+    @preview_class = (RailsEmailPreview.preview_classes || []).find { |pc|
+      (pc.is_a?(String) ? pc : pc.name).underscore == params[:mail_class]
+    }
+    @preview_class = @preview_class.constantize if @preview_class.is_a?(String)
     @part_type = params[:part_type] || 'text/html'
   end
 end

data/app/views/rails_email_preview/emails/index.html.haml

@@ -1,9 +1,9 @@
-%h1 Available Mailers
+%h1 Application Emails
 %ul
-  - @preview_classes.each do |m|
+  - @preview_class_names.each do |m|
     %li
-      %h2= m.name
+      %h2= m.underscore.humanize
       %ul
-        - m.instance_methods(false).map(&:to_s).each do |method|
+        - m.constantize.instance_methods(false).map(&:to_s).each do |method|
           %li
-            %a{:href => rails_email_preview.email_url(:mail_class => m.name.underscore, :mail_action => method)}= method
+            %a{:href => rails_email_preview.email_url(:mail_class => m.underscore, :mail_action => method)}= method.humanize

data/app/views/rails_email_preview/emails/show.html.haml

@@ -1,11 +1,23 @@
 %a#back-to-all{:href => rails_email_preview.root_url} « Back to list
+:ruby
+  raw_url  = rails_email_preview.email_url(params.merge(:part_type => 'raw'))
+  html_url = if @mail.multipart? || @mail.content_type =~ %r(text/html)
+   rails_email_preview.email_url(params.merge(:part_type => 'text/html'))
+  end
+  plain_url = if @mail.multipart? || @mail.content_type =~ %r(text/plain)
+   rails_email_preview.email_url(params.merge(:part_type => 'text/plain'))
+  end
+
 #message_headers
-  - if @mail.multipart?
-    %p.alternate
-      - if @part_type == 'text/html'
-        %a{:href => rails_email_preview.email_url(params.merge(:part_type => 'text/plain'))} View plain text version
-      - else
-        %a{:href => rails_email_preview.email_url(params.merge(:part_type => 'text/html'))} View HTML version
+  %p.alternate
+    - if @part_type != 'raw'
+      %a{:href => raw_url} View Original Message (raw)
+      %br
+    - if @part_type != 'text/html' && html_url
+      %a{:href => html_url} View HTML version
+      %br
+    - if @part_type != 'text/plain' && plain_url
+      %a{:href => plain_url} View plain text version
   %dl
     %dt From:
     %dd= @mail.from

data/lib/rails_email_preview.rb

@@ -3,7 +3,19 @@ require 'rails_email_preview/engine'
 module RailsEmailPreview
   mattr_accessor :preview_classes
 
-  def self.setup
-    yield self
+  class << self
+    def run_before_render(mail)
+      (defined?(@hooks) && @hooks[:before_render] || []).each do |block|
+        block.call(mail)
+      end
+    end
+
+    def before_render(&block)
+      ((@hooks ||= {})[:before_render] ||= []) << block
+    end
+
+    def setup
+      yield self
+    end
   end
 end

data/lib/rails_email_preview/version.rb

@@ -1,3 +1,3 @@
 module RailsEmailPreview
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_email_preview
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-30 00:00:00.000000000Z
+date: 2012-02-01 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &20440480 !ruby/object:Gem::Requirement
+  requirement: &16757680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '3.2'
   type: :runtime
   prerelease: false
-  version_requirements: *20440480
+  version_requirements: *16757680
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &20438980 !ruby/object:Gem::Requirement
+  requirement: &16756180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '3.2'
   type: :runtime
   prerelease: false
-  version_requirements: *20438980
+  version_requirements: *16756180
 - !ruby/object:Gem::Dependency
   name: haml
-  requirement: &20438580 !ruby/object:Gem::Requirement
+  requirement: &16755720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *20438580
+  version_requirements: *16755720
 - !ruby/object:Gem::Dependency
   name: sass
-  requirement: &20438120 !ruby/object:Gem::Requirement
+  requirement: &16755260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *20438120
+  version_requirements: *16755260
 description: Insert RailsEmailPreview description.
 email: glex.spb@gmail.com
 executables: []
@@ -98,5 +98,5 @@ rubyforge_project:
 rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
-summary: Visual Email Preview for Rails >= 3, implemented as a Rails Engine. v0.0.2
+summary: Visual Email Preview for Rails >= 3, implemented as a Rails Engine. v0.0.3
 test_files: []