rails_email_preview 0.2.21 → 0.2.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e6a3a68dcd424b8bad4c8835e9a43cfb388ccadd
-  data.tar.gz: 0c878a6582eee10408bf7bc522b60fb49961b77e
+  metadata.gz: d7ac94c83aae345e79cac0653512e28f82bcd17f
+  data.tar.gz: e296d3e2c055f126c854654b08c7a601f033f316
 SHA512:
-  metadata.gz: cc4d460e598e8daaaa8b81ee000c51ae6fecd382be0a705ceff5bd36895f54e47f91b69cfb056f396012b0ace6fc29baf85f7038f559c76e914d77bdcba802a2
-  data.tar.gz: eee63446fb36c5e0c5675de0ed9d7a24f8bcedf4c1bd504ca2a1ac6f3a44ebdacd07593a3eed7e1b0c5aebd5671b50db0afb3764b68437fe307923489a48f41a
+  metadata.gz: 99d6e21a3414b6d3368cef021d8951500c4b9c71f4833a094aab5d52dd6298caae92c589de496af8e8868992beb648a900310688df284292cffb61dccb9a5394
+  data.tar.gz: 7d7a1eaae3a399ac69896a5d77b93ccac01ed40055c6692eae9c139c8221d8441637aea2d1e381ebcae57b784fcdf39986da848212ac599b70221c8be82c15d2

data/Gemfile

@@ -1,4 +1,4 @@
-source "http://rubygems.org"
+source 'https://rubygems.org'
 
 gemspec
 
@@ -6,9 +6,13 @@ gem 'rails'
 
 platform :rbx do
   gem 'rubysl', '~> 2.0'
-  gem 'rubysl-test-unit', '~> 2.0'
   gem 'racc'
 end
 
-# a debugger that works with MRI 2.0.0
-gem 'byebug', platforms: :ruby_21, groups: [:development, :test]
+group :test, :development do
+  gem 'byebug', platform: :mri_21, require: false
+end
+
+group :development do
+  gem 'puma'
+end

data/README.md

@@ -1,6 +1,6 @@
-# Rails Email Preview [![Build Status][travis-badge]][travis] [![Gem Version][gem-badge]][gem] [![Code Climate][codeclimate-badge]][codeclimate]
+# Rails Email Preview [![Build Status][travis-badge]][travis] [![Test Coverage][coverage-badge]][coverage] [![Code Climate][codeclimate-badge]][codeclimate]
 
-A Rails Engine to preview plain text and html email in your browser. Compatible with Rails 3 and 4.
+Preview email in the browser with this Rails engine. Compatible with Rails 3 and 4.
 
 Preview:
 ![screenshot][rep-show-screenshot]
@@ -8,48 +8,52 @@ Preview:
 List:
 ![screenshot][rep-nav-screenshot]
 
-REP can use the application styles and comes with [a bootstrap 3 theme][rep-show-default-screenshot] by default (default markup for [twbs/bootstrap](twbs/bootstrap) 3).
-*These screenshots are from [Zuigo](http://zuigo.com/), a platform to organize & discover events; using REP default markup and app styles*
+REP can use your application styles, markup is compatible with [bootstrap 3][rep-show-default-screenshot] by default.
+*These screenshots are using a custom Bootstrap theme*
 
-## How to
+## Installation
 
-Add to Gemfile
+Add [![Gem Version][gem-badge]][gem] to Gemfile:
 
 ```ruby
-gem 'rails_email_preview', '~> 0.2.21'
+gem 'rails_email_preview', '~> 0.2.22'
 ```
 
-REP handles setup for you:
+Add an initializer and the routes:
 
-```ruby
-# adds initializer and route:
-rails g rails_email_preview:install
+```console
+$ rails g rails_email_preview:install
+```
+
+Generate preview classes and method stubs in app/mailer_previews/
 
-# generates preview classes and method stubs in app/mailer_previews/:
-rails g rails_email_preview:update_previews
+```console
+$ rails g rails_email_preview:update_previews
 ```
 
-This last generator will add a stub for each of your emails, then you populate the stubs with mock data:
+## Usage
+
+The last generator above will add a stub for each of your emails, then you populate the stubs with mock data:
 
 ```ruby
 # app/mailer_previews/user_mailer_preview.rb:
 class UserMailerPreview
   # preview methods should return Mail objects, e.g.:
-  def invitation        
+  def invitation
     UserMailer.invitation mock_user('Alice'), mock_user('Bob')
   end
-        
-  def welcome                
-    UserMailer.welcome mock_user                            
+
+  def welcome
+    UserMailer.welcome mock_user
   end
-  
+
   private
   # You can put all your mock helpers in a module
   # or you can use your factories / fabricators, just make sure you are not creating anythin
   def mock_user(name = 'Bill Gates')
     fake_id User.new(name: name, email: "user#{rand 100}@test.com")
   end
-  
+
   def fake_id(obj)
     # overrides the method on just this object
     obj.define_singleton_method(:id) { 123 + rand(100) }
@@ -58,8 +62,27 @@ class UserMailerPreview
 end
 ```
 
+### Parameters as instance variables
+
+All parameters in the search query will be available to the preview class as instance variables.
+For example, if URL to mailer preview looks like:
+
+```ruby
+/emails/user_mailer_preview-welcome?user_id=1
+```
+
+The method `welcome` in `UserMailerPreview` have a `@user_id` instance variable defined:
+
+```ruby
+class UserMailerPreview
+  def welcome
+    user = @user_id ? User.find(@user_id) : mock_company
+    UserMailer.welcome(user)
+  end
+end
+```
 
-## Routing
+### Routing
 
 You can access REP urls like this:
 
@@ -72,7 +95,7 @@ rails_email_preview.rep_emails_url
 rails_email_preview.rep_email_url('user_mailer-welcome')
 ```
 
-## Send Emails
+### Sending Emails
 
 You can send emails via REP. This is especially useful when testing with limited clients (Blackberry, Outlook, etc.).
 This will use the environment's mailer settings, but the handler will `perform_deliveries`.
@@ -82,32 +105,36 @@ Uncomment this line in the initializer to disable sending test emails:
 config.enable_send_email = false
 ```
 
-## Email editing
+### Editing Emails
 
-You can use [comfortable_mexican_sofa](https://github.com/comfy/comfortable-mexican-sofa) for storing and editing emails.
-REP comes with an integration for it -- see [CMS Guide](https://github.com/glebm/rails_email_preview/wiki/Edit-Emails-with-Comfortable-Mexican-Sofa).
+Emails can be stored in the database and edited in the browser.
+REP works with [Comfortable Mexican Sofa CMS](https://github.com/comfy/comfortable-mexican-sofa) to achieve this -- see the [CMS Guide](https://github.com/glebm/rails_email_preview/wiki/Edit-Emails-with-Comfortable-Mexican-Sofa) to learn more.
 
 [![screenshot](https://raw.github.com/glebm/rails_email_preview/master/doc/img/rep-edit-sofa.png)](https://github.com/glebm/rails_email_preview/wiki/Edit-Emails-with-Comfortable-Mexican-Sofa)
 
-
-## Premailer
+### Premailer
 
 [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.
 
 To integrate Premailer with your Rails app you can use either [actionmailer_inline_css](https://github.com/ndbroadbent/actionmailer_inline_css) or [premailer-rails](https://github.com/fphilipe/premailer-rails).
 Simply uncomment the relevant options in [the initializer](https://github.com/glebm/rails_email_preview/blob/master/config/initializers/rails_email_preview.rb). *initializer is generated during `rails g rails_email_preview:install`*
 
-## I18n
+### I18n
 
 REP expects emails to use current `I18n.locale`:
 
 ```ruby
 # current locale
-AccountMailer.some_notification.deliver     
+AccountMailer.some_notification.deliver
 # different locale
-I18n.with_locale('es') { InviteMailer.send_invites.deliver }
-
+I18n.with_locale('es') do
+  InviteMailer.send_invites.deliver
+end
 ```
+
+If you are using `Resque::Mailer` or `Devise::Async`, you can automatically remember `I18n.locale` when the mail job is scheduled
+[with this initializer](https://gist.github.com/glebm/5725347).
+
 When linking to REP pages you can pass `email_locale` to set the locale for rendering:
 
 ```ruby
@@ -115,13 +142,9 @@ When linking to REP pages you can pass `email_locale` to set the locale for rend
 rails_email_preview.root_url(email_locale: 'es')
 ```
 
-
-If you are using `Resque::Mailer` or `Devise::Async`, you can automatically add I18n.locale information when the mail job is scheduled 
-[with this initializer](https://gist.github.com/glebm/5725347).
-
 REP displays too many locales? Make sure to set `config.i18n.available_locales`, since it defaults to *all* locales in Rails.
 
-User interface is available in English and German (Danke, @baschtl).
+User interface is available in English, German (Danke, @baschtl), and Russian.
 You can set the language in `config.to_prepare` section of the initializer, default is English.
 
 ```ruby
@@ -129,7 +152,7 @@ You can set the language in `config.to_prepare` section of the initializer, defa
 RailsEmailPreview.locale = :de
 ```
 
-## Views
+### Views
 
 You can render all REP views inside your app layout (this will need styling to look nice if you don't use bootstrap):
 
@@ -140,10 +163,10 @@ Rails.application.config.to_prepare do
 end
 ```
 
-REP allows you to customize some of the element classes via `RailsEmailPreview.style`:
+REP also allows you to customize some of the element classes via `RailsEmailPreview.style`:
 
 ```ruby
-{
+RailsEmailPreview.style = {
   btn_default_class:     'btn btn-default',
   btn_active_class:      'btn btn-primary active',
   btn_group_class:       'btn-group',
@@ -155,18 +178,12 @@ REP allows you to customize some of the element classes via `RailsEmailPreview.s
 }
 ```
 
-E.g., to change column class from `col-` to `column-` everywhere where REP uses columns:
-
-```ruby
-RailsEmailPreview.style[:column_class] = 'column-%{n}'
-```
-
 You can `//= require 'rails_email_preview/layout'` REP-specific styles (`@import 'rails_email_preview/layout'` for SASS).
 
 You can also override any individual view by placing a file with the same path in your project's `app/views`,
-e.g. `app/views/rails_email_preview/emails/index.html.slim`. *PRs accepted* if you need hooks. 
+e.g. `app/views/rails_email_preview/emails/index.html.slim`. *PRs accepted* if you need hooks.
 
-## Authentication & authorization
+### Authentication & authorization
 
 You can specify the parent controller for REP controller, and it will inherit all before filters.
 Note that this must be placed before any other references to REP application controller in the initializer (and before `layout=` call):
@@ -181,28 +198,25 @@ Alternatively, to have custom rules just for REP you can:
 Rails.application.config.to_prepare do
   RailsEmailPreview::ApplicationController.module_eval do
     before_filter :check_rep_permissions
-  
+
     private
     def check_rep_permissions
        render status: 403 unless current_user && can_manage_emails?(current_user)
     end
   end
-end 
+end
 ```
 
-
 This project rocks and uses MIT-LICENSE.
 
-  [rep-nav-screenshot]: https://raw.github.com/glebm/rails_email_preview/master/doc/img/rep-nav.png "Email List Screenshot"
-  [rep-show-screenshot]: https://raw.github.com/glebm/rails_email_preview/master/doc/img/rep-show.png "Show Email Screenshot"
-  [rep-show-default-screenshot]: https://raw.github.com/glebm/rails_email_preview/master/doc/img/rep-show-default.png "Show Email Screenshot (default styles)"
-
-
+[rep-nav-screenshot]: https://raw.github.com/glebm/rails_email_preview/master/doc/img/rep-nav.png "Email List Screenshot"
+[rep-show-screenshot]: https://raw.github.com/glebm/rails_email_preview/master/doc/img/rep-show.png "Show Email Screenshot"
+[rep-show-default-screenshot]: https://raw.github.com/glebm/rails_email_preview/master/doc/img/rep-show-default.png "Show Email Screenshot (default styles)"
 [travis]: http://travis-ci.org/glebm/rails_email_preview
 [travis-badge]: http://img.shields.io/travis/glebm/rails_email_preview.svg
 [gem]: https://rubygems.org/gems/rails_email_preview
 [gem-badge]: http://img.shields.io/gem/v/rails_email_preview.svg
 [codeclimate]: https://codeclimate.com/github/glebm/rails_email_preview
 [codeclimate-badge]: http://img.shields.io/codeclimate/github/glebm/rails_email_preview.svg
-[coveralls]: https://coveralls.io/r/glebm/rails_email_preview
-[coveralls-badge]: http://img.shields.io/coveralls/glebm/rails_email_preview.svg
+[coverage]: https://codeclimate.com/github/glebm/rails_email_preview
+[coverage-badge]: https://codeclimate.com/github/glebm/rails_email_preview/badges/coverage.svg

data/Rakefile

@@ -17,3 +17,18 @@ require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
 task default: :spec
+
+desc 'Start development web server'
+task :dev do
+  require 'puma'
+  require 'rails/commands/server'
+  ENV['RACK_ENV'] = ENV['RAILS_ENV'] = 'development'
+  Dir.chdir 'spec/dummy'
+  Rack::Server.start(
+      environment: 'development',
+      Host: 'localhost',
+      Port: 9292,
+      config: 'config.ru',
+      server: 'puma'
+  )
+end

data/app/assets/stylesheets/rails_email_preview/_layout.css.sass

@@ -11,11 +11,3 @@
   dd
     width: auto
     margin-left: 0
-
-.rep-email-options
-  margin-bottom: 0
-  padding: 8px
-  li
-    padding-top: 0.7em
-    &:first-child
-      padding-top: 0

data/app/controllers/rails_email_preview/application_controller.rb

@@ -1,5 +1,19 @@
 module RailsEmailPreview
   class ApplicationController < ::RailsEmailPreview.parent_controller.constantize
     layout 'rails_email_preview/application'
+
+    protected
+
+    def prevent_browser_caching
+      # Prevent back-button browser caching:
+      # HTTP/1.1
+      response.headers['Cache-Control'] = 'no-store, no-cache, must-revalidate'
+      # Date in the past
+      response.headers['Expires']       = 'Mon, 26 Jul 1997 05:00:00 GMT'
+      # Always modified
+      response.headers['Last-Modified'] = Time.now.httpdate
+      # HTTP/1.0
+      response.headers['Pragma']        = 'no-cache'
+    end
   end
 end

data/app/controllers/rails_email_preview/emails_controller.rb

@@ -1,116 +1,154 @@
-class RailsEmailPreview::EmailsController < ::RailsEmailPreview::ApplicationController
-  include ERB::Util
-  before_filter :load_preview, except: :index
-  around_filter :set_locale
-  before_filter :set_email_preview_locale
-
-  # list screen
-  def index
-    @previews = ::RailsEmailPreview::Preview.all
-    @previews_by_class = ::RailsEmailPreview::Preview.all_by_preview_class
-  end
+module RailsEmailPreview
+  class EmailsController < ::RailsEmailPreview::ApplicationController
+    include ERB::Util
+    before_filter :load_preview, except: :index
+    around_filter :set_locale
+    before_filter :set_email_preview_locale
+    helper_method :with_email_locale
 
-  # preview screen
-  def show
-    I18n.with_locale @email_locale do
-      @part_type = params[:part_type] || 'text/html'
-      if @preview.respond_to?(:preview_mail)
-        @mail = @preview.preview_mail
-      else
-        raise ArgumentError.new("#{@preview} is not a preview class, does not respond_to?(:preview_mail)")
+    # List of emails
+    def index
+      @previews = Preview.all
+      @list     = PreviewListPresenter.new(@previews)
+    end
+
+    # Preview an email
+    def show
+      prevent_browser_caching
+      cms_edit_links!
+      with_email_locale do
+        if @preview.respond_to?(:preview_mail)
+          @mail, body     = mail_and_body
+          @mail_body_html = render_to_string inline: body, layout: 'rails_email_preview/email'
+        else
+          raise ArgumentError.new("#{@preview} is not a preview class, does not respond_to?(:preview_mail)")
+        end
       end
     end
-  end
 
-  # render actual email content
-  def show_body
-    I18n.with_locale @email_locale do
-      @mail_body = mail_body(@preview, @part_type)
-      render :show_body, layout: 'rails_email_preview/email'
+    # Download attachment
+    def show_attachment
+      filename   = "#{params[:filename]}.#{request.format.symbol}"
+      attachment = preview_mail(false).attachments.find { |a| a.filename == filename }
+      send_data attachment.body.raw_source
     end
-  end
 
-  def show_attachment
-    @mail = @preview.preview_mail
-    attachment = @mail.attachments.find { |a| a.filename == "#{params[:filename]}.#{request.format.symbol}" }
-    send_data attachment.body.raw_source
-  end
+    # Really deliver an email
+    def test_deliver
+      redirect_url = rails_email_preview.rep_email_url(params.slice(:preview_id, :email_locale))
+      if (address = params[:recipient_email]).blank? || address !~ /@/
+        redirect_to redirect_url, alert: t('rep.test_deliver.provide_email')
+        return
+      end
+      with_email_locale do
+        delivery_handler = RailsEmailPreview::DeliveryHandler.new(preview_mail, to: address, cc: nil, bcc: nil)
+        deliver_email!(delivery_handler.mail)
+      end
+      delivery_method = Rails.application.config.action_mailer.delivery_method
+      if delivery_method
+        redirect_to redirect_url, notice: t('rep.test_deliver.sent_notice', address: address, delivery_method: delivery_method)
+      else
+        redirect_to redirect_url, alert: t('rep.test_deliver.no_delivery_method', environment: Rails.env)
+      end
+    end
 
-  def test_deliver
-    redirect_url = rails_email_preview.rep_email_url(params.slice(:preview_id, :email_locale))
-    if (address = params[:recipient_email]).blank? || address !~ /@/
-      redirect_to redirect_url, alert: t('rep.test_deliver.provide_email')
-      return
+    # Used by CMS integration to refetch header after editing
+    def headers
+      render partial: 'rails_email_preview/emails/headers', locals: {mail: mail_and_body.first}
     end
-    I18n.with_locale @email_locale do
-      delivery_handler = RailsEmailPreview::DeliveryHandler.new(@preview.preview_mail(true), to: address, cc: nil, bcc: nil)
-      deliver_email!(delivery_handler.mail)
+
+    # Used by the CMS integration to provide a link back to Show inside the edit iframe
+    def show_body
+      prevent_browser_caching
+      cms_edit_links!
+      with_email_locale do
+        _, body = mail_and_body
+        render inline: body, layout: 'rails_email_preview/email'
+      end
     end
-    if !(delivery_method = Rails.application.config.action_mailer.delivery_method)
-      redirect_to redirect_url, alert: t('rep.test_deliver.no_delivery_method', environment: Rails.env)
-    else
-      redirect_to redirect_url, notice: t('rep.test_deliver.sent_notice', address: address, delivery_method: delivery_method)
+
+    private
+
+    def deliver_email!(mail)
+      # support deliver! if present
+      if mail.respond_to?(:deliver!)
+        mail.deliver!
+      else
+        mail.deliver
+      end
     end
-  end
 
-  protected
+    # Load mail and its body for preview
+    # @return [[Mail, String]] the mail object and its body
+    def mail_and_body
+      mail = preview_mail
+      body = mail_body_content(mail, @part_type)
+      [mail, body]
+    end
 
-  def deliver_email!(mail)
-    # support deliver! if present
-    if mail.respond_to?(:deliver!)
-      mail.deliver!
-    else
-      mail.deliver
+    # @param [Boolean] run_handlers whether to run the registered handlers for Mail object
+    # @return [Mail]
+    def preview_mail(run_handlers = true)
+      @preview.preview_mail(run_handlers, params.except(*request.path_parameters.keys))
     end
-  end
 
-  def mail_body(preview, part_type, edit_links = (part_type == 'text/html'))
-    RequestStore.store[:rep_edit_links] = true if edit_links
-    mail = preview.preview_mail(true)
-    
-    return "<pre id='raw_message'>#{html_escape(mail.to_s)}</pre>".html_safe if part_type == 'raw'
-
-    body_part = if mail.multipart?
-                  (part_type =~ /html/ ? mail.html_part : mail.text_part)
-                else
-                  mail
-                end
-
-    if body_part.content_type =~ /plain/
-      "<pre id='message_body'>#{html_escape(body_part.body.to_s)}</pre>".html_safe
-    else
-      body_content = body_part.body.to_s
-
-      mail.attachments.each do |attachment|
-        web_url = rails_email_preview.rep_raw_email_attachment_url(params[:preview_id], attachment.filename)
-        body_content.gsub!(attachment.url, web_url)
+    # @param [Mail] mail
+    # @param ['html', 'plain', 'raw']
+    # @return [String] version of the email for HTML
+    def mail_body_content(mail, part_type)
+      return "<pre id='raw_message'>#{html_escape(mail.to_s)}</pre>".html_safe if part_type == 'raw'
+
+      body_part = if mail.multipart?
+                    (part_type =~ /html/ ? mail.html_part : mail.text_part)
+                  else
+                    mail
+                  end
+
+      if body_part.content_type =~ /plain/
+        "<pre id='message_body'>#{html_escape(body_part.body.to_s)}</pre>".html_safe
+      else
+        body_content = body_part.body.to_s
+
+        mail.attachments.each do |attachment|
+          web_url = rails_email_preview.rep_raw_email_attachment_url(params[:preview_id], attachment.filename)
+          body_content.gsub!(attachment.url, web_url)
+        end
+
+        body_content.html_safe
       end
+    end
 
-      body_content.html_safe
+    def with_email_locale(&block)
+      I18n.with_locale @email_locale, &block
     end
-  end
 
-  def set_email_preview_locale
-    @email_locale = (params[:email_locale] || RailsEmailPreview.default_email_locale || I18n.default_locale).to_s
-  end
+    def set_email_preview_locale
+      @email_locale = (params[:email_locale] || RailsEmailPreview.default_email_locale || I18n.default_locale).to_s
+    end
 
-  def set_locale
-    config_locale = RailsEmailPreview.locale
-    if !I18n.available_locales.map(&:to_s).include?(config_locale.to_s)
-      config_locale = :en
+    def set_locale
+      config_locale = RailsEmailPreview.locale
+      if !I18n.available_locales.map(&:to_s).include?(config_locale.to_s)
+        config_locale = :en
+      end
+      begin
+        locale_was  = I18n.locale
+        I18n.locale = config_locale
+        yield if block_given?
+      ensure
+        I18n.locale = locale_was
+      end
     end
-    begin
-      locale_was  = I18n.locale
-      I18n.locale = config_locale
-      yield if block_given?
-    ensure
-      I18n.locale = locale_was
+
+    # Let REP's `cms_email_snippet` know to render an Edit link
+    # Todo: Refactoring is especially welcome here
+    def cms_edit_links!
+      RequestStore.store[:rep_edit_links] = (@part_type == 'html')
     end
-  end
-  private
 
-  def load_preview
-    @preview     = ::RailsEmailPreview::Preview[params[:preview_id]] or raise ActionController::RoutingError.new('Not Found')
-    @part_type   = params[:part_type] || 'text/html'
+    def load_preview
+      @preview = ::RailsEmailPreview::Preview[params[:preview_id]] or raise ActionController::RoutingError.new('Not Found')
+      @part_type = params[:part_type] || 'html'
+    end
   end
 end