rails_email_preview 0.0.4 → 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 84132ea530a47db404000e82a07251cd51706955
+  data.tar.gz: d0aef7d543f2138ddcf82f7a86e4cf538eb4f5b5
+SHA512:
+  metadata.gz: ba0961461268dd1f986431b84799d185cfb4431c5d10e7881e2c682d4c5dd7447237ad2d090f3dd30289f1cb3b4d5b2da78839bdc677738368c8281011a04fe5
+  data.tar.gz: 014c0c7c244ff70acf5de3059ddcf39963948297409221cd12fed4ed258db7bef604f94f819223d1d42884580abd7f876945e0ff0c9953669e06ef5322705d04

data/README.md

@@ -1,19 +1,15 @@
-RailsEmailPreview -- Visual email testing
+Rails Email Preview 
 ================================
 
-Preview plain text and html mail templates in your browser without redelivering it every time you make a change.
+A Rails Engine to preview plain text and html email in your browser. Compatible with Rails 3 and 4.
 
-Inspired by MailView: https://github.com/37signals/mail_view/
-However, implemented as a Rails engine, with layouts and multiple mailers support.
-
-Compatible with Rails version >= 3 only.
-
-Usage
+How to
 -----
 
-Since most emails do something interesting with database data, you'll need to write some scenarios to load messages with fake data. Its similar to writing mailer unit tests but you see a visual representation of the output instead.
+You will need to provide data for preview of each email:
 
-    class Notifier < ActionMailer::Base
+    # Say you have this mailer
+    class UserMailer < ActionMailer::Base
       def invitation(inviter, invitee)
         # ...
       end
@@ -21,75 +17,70 @@ Since most emails do something interesting with database data, you'll need to wr
       def welcome(user)
         # ...
       end
+    end
 
-      class Preview
-        # Pull data from existing fixtures
-        def invitation
-          account = Account.first
-          inviter, invitee = account.users[0, 2]
-          Notifier.invitation(inviter, invitee)
-        end
-
-        # Factory-like pattern
-        def welcome
-          user = User.create!
-          mail = Notifier.welcome(user)
-          user.destory
-          mail
-        end
+    # Define a Preview class with the same mail action names, but with no arguments
+    # mkdir -p app/mailer_previews/; touch app/mailer_previews/user_mailer_preview.rb
+    class UserMailerPreview
+      # preview methods should return Mail objects, e.g.:
+      def invitation        
+        UserMailer.invitation mock_user('Alice'), mock_user('Bob')
+      end
+            
+      def welcome                
+        UserMailer.welcome mock_user                            
+      end
+      
+      private
+      def mock_user(name = 'Bill Gates')
+        User.new(name: name, email: "user@test.com#{rand 100}").tap { |u| u.define_singleton_method(:id) { 123 + rand(100) } }      
       end
     end
 
-The methods must return a Mail object.
 
-Since this is a Rails engine, it can be configured in an initializer:
+Routing
+-------
+    
+    mount RailsEmailPreview::Engine, at: 'email_preview' # rails_email_preview.root_url #=> '/email_preview'    
+
 
-In config/initializers/rails_email_preview.rb
+Configuration 
+-------
+    
+    # touch config/initializers/rails_email_preview.rb
 
     require 'rails_email_preview'
     RailsEmailPreview.setup do |config|
-      config.preview_classes = [ Notifier::Preview ]
+      config.preview_classes = [ UserMailerPreview ]
     end
 
-    # If you want to render it within the application layout, uncomment the following lines:
-    # Rails.application.config.to_prepare do
-    #   RailsEmailPreview::ApplicationController.layout "application"
-    # end
-    # Note that if you do use it with your main_app layout, all the main_app URLs must be generated explicitly
-    # E.g. you would need to change links like login_url to main_app.login_url
-
-
-Routing is very simple
+    # To render previews within layout other than the default one. NB: that layout must reference application urls via `main_app`, e.g. `main_app.login_url` (due to how isolated engines are in rails):
 
-In config/routes.rb add:
-
-    if Rails.env.development?
-      mount RailsEmailPreview::Engine, :at => 'email_preview' # You can choose any URL here
+    Rails.application.config.to_prepare do
+      RailsEmailPreview::ApplicationController.layout 'admin'
     end
 
-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:
+[Premailer](https://github.com/alexdunae/premailer) automatically translates standard CSS rules into old-school inline styles. 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:
+To integrate Premailer with rails you can use either [actionmailer_inline_css](https://github.com/ndbroadbent/actionmailer_inline_css) or [premailer-rails](https://github.com/fphilipe/premailer-rails).
 
-    RailsEmailPreview.setup do |config|
-      config.before_render do |message|
-        ActionMailer::InlineCssHook.delivering_email(message)
-      end
-    end
+For [actionmailer_inline_css](https://github.com/ndbroadbent/actionmailer_inline_css), add to `RailsEmailPreview.setup`:
+    
+    config.before_render { |message| ActionMailer::InlineCssHook.delivering_email(message) }    
+
+For [premailer-rails](https://github.com/fphilipe/premailer-rails), add to `RailsEmailPreview.setup`:
+    
+    config.before_render { |message| Premailer::Rails::Hook.delivering_email(message) }    
 
-Interface
----------
 
-![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)
+Customizing views
+---------------------
 
-As this is a rails engine, you can ovveride any of the views, or make them use your layout.
+You can ovveride any `rails_email_preview` view by placing a file with the same path as in the gem in your project's `app/views`.
+You can also extend the `RailsEmailPreview::EmailsController` for further customization.
 
-This project rocks and uses MIT-LICENSE.
+This project rocks and uses MIT-LICENSE.

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

@@ -4,7 +4,7 @@
   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)
+  plain_url = if @mail.multipart? || @mail.content_type =~ %r(text/plain) || Object.const_defined?('PremailerRails')
    rails_email_preview.email_url(params.merge(:part_type => 'text/plain'))
   end
 
@@ -33,11 +33,6 @@
     %dd= @mail.to
 
 %iframe#src-iframe{:src => rails_email_preview.raw_email_url(params.slice(:mail_class, :mail_action, :part_type)),
-  :width => "100%", :height => "800", :onload => 'emailLoaded()', :style => "display:none"}
+  :width => "100%", :height => "800", :onload => "document.getElementById('src-iframe').style.display = 'block';document.getElementById('loading').style.display = 'none'", :style => "display:none"}
 %pre#loading Loading...
 
-:javascript
-  window.emailLoaded = function () {
-    document.getElementById('src-iframe').style.display = 'block';
-    document.getElementById('loading').style.display = 'none';
-  };

data/config/routes.rb

@@ -1,11 +1,11 @@
 RailsEmailPreview::Engine.routes.draw do
   root :to => 'emails#index'
-  match 'raw/:mail_class/:mail_action',
+  get 'raw/:mail_class/:mail_action',
         :as => :raw_email,
         :to => 'emails#show_raw',
         :mail_class => %r([\w/]+)
-  match ':mail_class/:mail_action',
+  get ':mail_class/:mail_action',
         :as => :email,
         :to => 'emails#show',
         :mail_class => %r([\w/]+)
-end
+end

data/lib/rails_email_preview/version.rb

@@ -1,3 +1,3 @@
 module RailsEmailPreview
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'
 end

metadata

@@ -1,72 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: rails_email_preview
 version: !ruby/object:Gem::Version
-  version: 0.0.4
-  prerelease: 
+  version: 0.0.5
 platform: ruby
 authors:
 - Gleb Mazovetskiy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-05 00:00:00.000000000Z
+date: 2013-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &16274540 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3.2'
   type: :runtime
   prerelease: false
-  version_requirements: *16274540
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &16273020 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3.2'
   type: :runtime
   prerelease: false
-  version_requirements: *16273020
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: haml
-  requirement: &16272560 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *16272560
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sass
-  requirement: &16272100 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *16272100
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Insert RailsEmailPreview description.
 email: glex.spb@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- app/assets/stylesheets/rails_email_preview/application.css.sass
 - app/controllers/rails_email_preview/application_controller.rb
 - app/controllers/rails_email_preview/emails_controller.rb
-- app/assets/stylesheets/rails_email_preview/application.css.sass
+- app/views/layouts/rails_email_preview/application.html.haml
 - app/views/rails_email_preview/emails/index.html.haml
 - app/views/rails_email_preview/emails/show.html.haml
-- app/views/layouts/rails_email_preview/application.html.haml
 - lib/rails_email_preview/engine.rb
 - lib/rails_email_preview/version.rb
 - lib/rails_email_preview.rb
@@ -77,26 +88,25 @@ files:
 - README.md
 homepage: 
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
-summary: Visual Email Preview for Rails >= 3, implemented as a Rails Engine. v0.0.4
+specification_version: 4
+summary: Visual Email Preview for Rails >= 3, implemented as a Rails Engine. v0.0.5
 test_files: []