rails_email_preview 0.0.9 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8bee2bfee317025f4b297f8982ae6322714d6854
-  data.tar.gz: dd9b7bc1aa56a14dce7a96a55ee348b92e4ad3d8
+  metadata.gz: 37f26bca79a358d23b5558ccdf69ec9d14806c8c
+  data.tar.gz: 212af63e4f7389f0c7b10170ccd09c382fa1a0b9
 SHA512:
-  metadata.gz: 35e24aa93dbb5ea4884b55a2764234b7e155074f3016f3fb4563c3c479dea01a6b0b197362b2ff39c5a294922203e093d48050e9e40008212a21f4a5d641a359
-  data.tar.gz: 7206cf3f0c4fe7a629a88cb66a1709704b5f03d184f23bddf4bbc274cb3e15cf009fb39d4343489e7b906e912bb9ad79b2b0790feda7e4af6209a1be280e0060
+  metadata.gz: 1b52eef72bf07ada652564f93e1a068ae7ad5046c2fa927a6f47cebc96e8b567da4726ff124d6857c6c097b95970b710a1a8d68601b17e07ea18a07a5aaf1b0c
+  data.tar.gz: 8b9a369c78e56782055e007cdc1b732230207318b98d1e0b50e10536062b3f04611d64eac600028c3a8725faf4bdd42b7c201b22da8693f88b903971886a00ab

data/README.md

@@ -3,8 +3,9 @@ Rails Email Preview
 
 A Rails Engine to preview plain text and html email in your browser. Compatible with Rails 3 and 4.
 
-![screenshot](http://screencloud.net//img/screenshots/749d6c6a84b5d79b436ad627902944a8.png)
-*Preview UI*
+![screenshot](http://screencloud.net//img/screenshots/8861336ed60923429d3747e1fd379619.png)
+![screenshot](http://screencloud.net//img/screenshots/22aa58b651815068f4b0676754275c6a.png)
+*Rendered within an application layout*
 
 How to
 -----
@@ -57,19 +58,12 @@ Configuration
       config.preview_classes = [ UserMailerPreview ]
     end
 
-    # 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):
-
-    Rails.application.config.to_prepare do
-      RailsEmailPreview::ApplicationController.layout 'admin'
-    end
-
-
 Premailer integration
 ---------------------
 
 [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 rails you can use either [actionmailer_inline_css](https://github.com/ndbroadbent/actionmailer_inline_css) or [premailer-rails](https://github.com/fphilipe/premailer-rails).
+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).
 
 For [actionmailer_inline_css](https://github.com/ndbroadbent/actionmailer_inline_css), add to `RailsEmailPreview.setup`:
     
@@ -83,24 +77,57 @@ Email editing
 -------------
 
 You can use [comfortable_mexican_sofa](https://github.com/comfy/comfortable-mexican-sofa) for storing and editing emails.
-See [ComfortableMexicanSofa integration guide](https://github.com/glebm/rails_email_preview/wiki/Edit-Emails-with-Comfortable-Mexican-Sofa).
-
-This is what it looks like:
+REP comes with a CMS integration, see [ComfortableMexicanSofa integration guide](https://github.com/glebm/rails_email_preview/wiki/Edit-Emails-with-Comfortable-Mexican-Sofa).
 
-![CMS integration screenshot](http://screencloud.net//img/screenshots/c3437edd8cdd52dbff58663a0b30d6ca.png)
+![CMS integration screenshot](http://screencloud.net//img/screenshots/b000595dbd13ae061373fd1473f113ba.png)
 
 I18n
 -------------
 
-Rails Email Preview sets `I18n.locale` for rendering an email.
-This means your emails should use I18n.locale but not set it.
-If you are using `Resque::Mailer` or `Devise::Async`, you will want to [inject I18n.locale into the job](https://gist.github.com/glebm/5725347).
+Rails Email Preview expect emails to be rendered using `I18n.locale`:
+    
+    # current locale
+    AccountMailer.some_notification.deliver     
+    # different locale
+    I18n.with_locale('es') { InviteMailer.send_invites.deliver }
+
+
+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).
 
 
-Customizing views
+Views
 ---------------------
 
-You can override 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.
+You can render all REP views inside your own layout:
+
+    Rails.application.config.to_prepare do
+      RailsEmailPreview::ApplicationController.layout 'admin'      
+    end
+
+When using a layout other than the default, that layout has to access all route helpers via `main_app`, e.g. `main_app.login_url`.
+This is due to how [isolated engines](http://edgeapi.rubyonrails.org/classes/Rails/Engine.html#label-Isolated+Engine) work in Rails.
+
+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`.
+
+*Pull requests adding view hooks are welcome!*
+
+
+Authentication & authorization
+------------------------------
+
+To only allow certain users view emails add a before filter to `RailsEmailPreview::ApplicationController`, e.g.:
+
+    Rails.application.config.to_prepare do
+      RailsEmailPreview::ApplicationController.module_eval do
+        before_filter :check_permissions
+      
+        private
+        def check_permissions
+           render status: 403 unless current_user.try(:admin?)
+        end
+      end
+    end 
+
 
 This project rocks and uses MIT-LICENSE.

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

@@ -1,30 +1,32 @@
-#message_headers 
+#email-show
   padding: 10px 0 0 0
   margin: 0
-  background: #fff
+  background: rgb(242, 236, 245)
   font-size: 12px
-  font-family: "Lucida Grande"
-  border-bottom: 1px solid #dedede
+  font-family: "Monaco", "Lucida Grande", sans-serif
+  border-bottom: 1px solid rgb(142, 137, 148)
   overflow: hidden
 
+  .pull-right
+    float: right
+
+  .btn-group
+    a
+      display: inline-block
+
   dl
     margin: 0
     padding: 0
 
-
   dt
     width: 60px
     padding: 1px
     float: left
     text-align: right
     font-weight: bold
-    color: #7f7f7f
-
+    color: rgb(142, 137, 148)
 
   dd
     margin-left: 70px
     padding: 1px
 
-
-  p.alternate
-    float: right

data/app/controllers/rails_email_preview/emails_controller.rb

@@ -1,7 +1,7 @@
 class RailsEmailPreview::EmailsController < RailsEmailPreview::ApplicationController
   include ERB::Util
   before_filter :load_preview_class, except: :index
-  around_filter :with_email_locale, only: [:show, :show_raw]
+  before_filter :set_email_preview_locale
 
   # list screen
   def index
@@ -10,35 +10,39 @@ class RailsEmailPreview::EmailsController < RailsEmailPreview::ApplicationContro
 
   # preview screen
   def show
-    @part_type = params[:part_type] || 'text/html'
-    @mail      = @preview_class.new.send(params[:mail_action])
+    I18n.with_locale @email_locale do
+      @part_type = params[:part_type] || 'text/html'
+      @mail      = @preview_class.new.send(params[:mail_action])
+    end
+    render
   end
 
   # render actual email content
   def show_raw
-    @mail = @preview_class.new.send(params[:mail_action])
-    RailsEmailPreview.run_before_render(@mail)
-    if @part_type == 'raw'
-      body = "<pre id='raw_message'>#{html_escape(@mail.to_s)}</pre>"
-    else
-      if @mail.multipart?
-        body_part = (@part_type =~ /html/ ? @mail.html_part : @mail.text_part)
+    I18n.with_locale @email_locale do
+      @mail = @preview_class.new.send(params[:mail_action])
+      RailsEmailPreview.run_before_render(@mail)
+      if @part_type == 'raw'
+        body = "<pre id='raw_message'>#{html_escape(@mail.to_s)}</pre>"
       else
-        body_part = @mail
-      end
-      body = body_part.body
-      if body_part.content_type =~ /plain/
-        body = "<pre id='message_body'>#{body}</body>"
+        if @mail.multipart?
+          body_part = (@part_type =~ /html/ ? @mail.html_part : @mail.text_part)
+        else
+          body_part = @mail
+        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
-    render text: body, layout: false
   end
 
   protected
 
-  def with_email_locale(&block)
+  def set_email_preview_locale
     @email_locale = (params[:email_locale] || I18n.locale).to_s
-    I18n.with_locale @email_locale, &block
   end
 
   private

data/app/views/integrations/cms/_customize_cms_for_rails_email_preview.html.slim

@@ -0,0 +1,17 @@
+-# Hide nav when rendering inside rails_email_preview
+javascript:
+  jQuery(function($) {
+    if (window.parent && /email/.test(parent.location.href)) {
+      $('.left-column,.right-column').hide();
+      $('.center-column').css('margin', 0);
+    }
+    // Snippet form:
+    // * Label -> Subject
+    $('[name="snippet[label]"]').closest('.control-group').find('.control-label').text("Subject");
+    // * Content -> Body
+    $('[name="snippet[content]"]').closest('.control-group').find('.control-label').text("Body");
+    // * Hide identifier
+    $('[name="snippet[identifier]"]').closest('.control-group').hide();
+    // * Hide categories
+    $('label[for="snippet_"]').closest('.control-group').hide();
+  });

data/app/views/rails_email_preview/emails/_email_iframe.html.slim

@@ -0,0 +1,16 @@
+javascript:
+  function iFrameLoad(id){
+    var resize = function(id) {
+      var el = document.getElementById(id),
+          w = jQuery(el.parentNode).innerWidth(),
+          h = el.contentWindow.document.body.scrollHeight;
+      el.height = (h) + "px";
+      el.width  = (w) + "px";
+    };
+    document.getElementById('loading-el').style.display = 'none';
+    setTimeout(function() { resize(id) });
+  }
+
+pre#loading-el.lead #{icon 'spinner', 'spin'} Loading...
+iframe#src-iframe[src=rails_email_preview.raw_email_url(params.slice(:mail_class, :mail_action, :part_type).merge(email_locale: @email_locale))
+  width="100%" height=1 onLoad="iFrameLoad('src-iframe')" style="border:none;padding:0;margin:0"]

data/app/views/rails_email_preview/emails/_headers.html.slim

@@ -0,0 +1,4 @@
+dl
+  - { 'From' => @mail.from * ', ', 'To' => @mail.to  * ', ', 'Subject' => @mail.subject}.each do |header, value|
+    dt #{header}
+    dd #{value}

data/app/views/rails_email_preview/emails/_options.html.slim

@@ -0,0 +1,9 @@
+p.btn-group
+  - { 'text/html' => 'HTML', 'text/plain' => 'Text', 'raw' => 'Raw'}.each do |mime, label|
+    a.btn.btn-link href=rails_email_preview.email_url(params.merge(part_type: mime)) class=('active' if @part_type == mime)
+      = label
+br
+p.btn-group
+  - I18n.available_locales.each do |locale|
+    a.btn.btn-link href=rails_email_preview.email_url(params.merge(part_type: @part_type, email_locale: locale)) class=('active' if @email_locale == locale.to_s)
+      = locale

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

@@ -6,5 +6,5 @@ ul.list-unstyled
       ul.list-group
         - m.constantize.instance_methods(false).map(&:to_s).each do |method|
           li.list-group-item
-            a href=rails_email_preview.email_url(mail_class: m.to_s.underscore, mail_action: method.to_s)
+            a href=rails_email_preview.email_url(mail_class: m.to_s.underscore, mail_action: method.to_s, email_locale: @email_locale)
               = method.to_s.humanize

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

@@ -1,44 +1,11 @@
-a.btn.btn-link href=rails_email_preview.root_url « Back to list
+a.btn.btn-link href=rails_email_preview.root_url(email_locale: @email_locale) « Back to list
 
-#message_headers
-  .pull-right
-    p.btn-group
-      - { 'text/html' => 'HTML', 'text/plain' => 'Text', 'raw' => 'Raw'}.each do |mime, label|
-        a.btn.btn-link href=rails_email_preview.email_url(params.merge(part_type: mime)) class=('active' if @part_type == mime) = label
-    br
-    p.btn-group
-      - I18n.available_locales.each do |locale|
-        a.btn.btn-link href=rails_email_preview.email_url(params.merge(part_type: @part_type, email_locale: locale)) class=('active' if @email_locale == locale.to_s) = locale
-  dl
-    dt From:
-    dd= @mail.from * ', '
+#email-show
+  -# email format and language
+  .pull-right = render 'rails_email_preview/emails/options'
 
-    dt To:
-    dd= @mail.to  * ', '
+  -# from, to, subject
+  = render 'rails_email_preview/emails/headers'
 
-    dt Subject:
-    dd
-      strong= @mail.subject
-
-javascript:
-  function iFrameAutoResize(id){
-      document.getElementById('loading-el').style.display = 'none';
-      setTimeout(function(){
-      var newheight;
-      var newwidth;
-
-      if(document.getElementById){
-          newheight = document.getElementById(id).contentWindow.document.body.scrollHeight;
-
-          newwidth  = $(document.getElementById(id).parentNode).innerWidth();
-      }
-
-      var el    = document.getElementById(id);
-      el.height = (newheight) + "px";
-      el.width  = (newwidth) + "px";
-      });
-  }
-
-pre#loading-el.lead #{icon 'spinner', 'spin'} Loading...
-iframe#src-iframe[src=rails_email_preview.raw_email_url(params.slice(:mail_class, :mail_action, :part_type).merge(email_locale: @email_locale))
-  width="100%" height=1 onLoad="iFrameAutoResize('src-iframe')" style="border:none;padding:0;margin:0"]
+-# actual email content, rendered in an iframe to prevent browser styles from interfering
+= render 'rails_email_preview/emails/email_iframe'

data/lib/rails_email_preview.rb

@@ -18,4 +18,19 @@ module RailsEmailPreview
       yield self
     end
   end
-end
+
+  # = Editing settings
+  # edit link is rendered inside an iframe, so these options are provided for simple styling
+  mattr_accessor :edit_link_text
+  self.edit_link_text  = '✎ Edit Text'
+  mattr_accessor :edit_link_style
+  self.edit_link_style = <<-CSS.strip.gsub(/\n+/m, ' ')
+    display: block;
+    font-family: "Monaco", "Helvetica", sans-serif;
+    color: #7a4b8a;
+    border: 2px dashed #7a4b8a;
+    font-size: 20px;
+    padding: 8px 12px;
+    margin-top: 1em;
+  CSS
+end

data/lib/rails_email_preview/integrations/comfortable_mexica_sofa.rb

@@ -0,0 +1,86 @@
+# simply require this file to enable Comfortable Mexican Sofa integration
+# read more https://github.com/glebm/rails_email_preview/wiki/Edit-Emails-with-Comfortable-Mexican-Sofa
+
+module RailsEmailPreview
+  module Integrations
+    module ComfortableMexicanSofa
+      # returns CMS identifier for the current email
+      # ModerationMailer#approve -> "moderation_mailer-approve"
+      def cms_email_id
+        mailer = respond_to?(:controller) ? controller : self
+        "#{mailer.class.name.underscore}-#{action_name}"
+      end
+
+      # Will return snippet title interpolated with passed variables
+      #   E.g, for snippet with title "Welcome, %{name}!"
+      #      cms_email_subject(name: "Alice") #=> "Welcome, Alice!"
+      def cms_email_subject(interpolation = {})
+        snippet_id = "email-#{cms_email_id}"
+        [I18n.locale, I18n.default_locale].compact.each do |locale|
+          site = Cms::Site.find_by_locale(I18n.locale)
+          snippet = site.snippets.find_by_identifier(snippet_id)
+
+          # interpolate even if keys/values are missing
+          title = snippet.label.to_s
+          interpolation = interpolation.stringify_keys
+          # set all missing values to ''
+          title.scan(/%{([^}]+)}/) { |key| interpolation[key] ||= ''}
+          # remove all missing keys
+          subject = title % interpolation.delete_if { |k, v| title !~ /%{#{k}}/ }
+
+          return subject if subject.present?
+        end
+      end
+
+      # Will return snippet content, passing through Kramdown
+      # Will also render an "✎ Edit text" link if used from
+      def cms_email_snippet(snippet_id = self.cms_email_id)
+        snippet_id = "email-#{snippet_id}"
+        site       = Cms::Site.find_by_locale(I18n.locale)
+
+        # Fallback default locale: (# prefill)
+        unless (content = cms_snippet_content(snippet_id, site).presence)
+          default_site     = Cms::Site.find_by_locale(I18n.default_locale)
+          fallback_content = cms_snippet_content(snippet_id, default_site).presence
+        end
+        result = content || fallback_content
+
+        # If rendering in preview from admin, add edit/create lnk
+        if caller.grep(/emails_controller/).present?
+          snippet = site.snippets.find_by_identifier(snippet_id)
+
+
+          cms_path = if snippet
+                       unless content
+                         fallback_snippet = default_site.snippets.find_by_identifier(snippet_id)
+                         prefill_from_default = {label: fallback_snippet.label, content: fallback_snippet.content}
+                       end
+                       edit_cms_admin_site_snippet_path(site_id: site.id, id: snippet.id,
+                                                        snippet: prefill_from_default || nil)
+                     else
+                       new_cms_admin_site_snippet_path(site_id: site.id, snippet: {
+                           label:        "#{snippet_id.sub('-', ' / ').humanize}",
+                           identifier:   snippet_id,
+                           category_ids: [site.categories.find_by_label('email').try(:id)]
+                       })
+                     end
+
+          result += cms_edit_email_snippet_link(cms_path)
+        end
+        result
+      end
+
+      def cms_edit_email_snippet_link(path)
+        link_to(RailsEmailPreview.edit_link_text, path, style: RailsEmailPreview.edit_link_style, 'onClick' => '')
+      end
+    end
+  end
+end
+
+ActionMailer::Base.module_eval do
+  include ::RailsEmailPreview::Integrations::ComfortableMexicanSofa
+  helper ::RailsEmailPreview::Integrations::ComfortableMexicanSofa
+end
+
+require 'comfortable_mexican_sofa'
+ComfortableMexicanSofa::ViewHooks.add :header, 'integrations/cms/customize_cms_for_rails_email_preview'

data/lib/rails_email_preview/version.rb

@@ -1,3 +1,3 @@
 module RailsEmailPreview
-  VERSION = '0.0.9'
+  VERSION = '0.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_email_preview
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.0
 platform: ruby
 authors:
 - Gleb Mazovetskiy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-07 00:00:00.000000000 Z
+date: 2013-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -68,8 +68,7 @@ dependencies:
         version: '0'
 description: |-
   Implemented as a rails engine with a simple UI for previewing your app emails,
-  I18n support, easy premailer integration and editing via comfortable_mexican_sofa
-  (https://github.com/comfy/comfortable-mexican-sofa).
+  I18n support, easy premailer integration and editing integration via comfortable_mexican_sofa CMS.
 email: glex.spb@gmail.com
 executables: []
 extensions: []
@@ -78,10 +77,15 @@ 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/views/integrations/cms/_customize_cms_for_rails_email_preview.html.slim
 - app/views/layouts/rails_email_preview/application.html.slim
+- app/views/rails_email_preview/emails/_email_iframe.html.slim
+- app/views/rails_email_preview/emails/_headers.html.slim
+- app/views/rails_email_preview/emails/_options.html.slim
 - app/views/rails_email_preview/emails/index.html.slim
 - app/views/rails_email_preview/emails/show.html.slim
 - lib/rails_email_preview/engine.rb
+- lib/rails_email_preview/integrations/comfortable_mexica_sofa.rb
 - lib/rails_email_preview/version.rb
 - lib/rails_email_preview.rb
 - config/routes.rb