rails_email_preview 0.2.11 → 0.2.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1d58be6aaa4a03a2f9d35a845740d8c3d6858dcc
-  data.tar.gz: 069597aebef68a33e6ca6dc71d51f7a589023d35
+  metadata.gz: 528049f3b44f95cb5ce989849643ea8cd8dd4420
+  data.tar.gz: 9706cd13d2749ccc82a80cd8b43864867a6d6598
 SHA512:
-  metadata.gz: d2aa70c01c5e03699d7c14a5566a0fe378bec24b6a8114bcde0431a973bf4447fee6c3cee8d4f152e5638b987b4a81d1af1c1b4a03b776f9277151d83381bbef
-  data.tar.gz: 565177dd762effc6e9ce78ff5e09d3663b035aa488890c7cd88c0cfe65f770987816e8a91bc1f272c15de6c0c82c3c91322edce7d225f9ac7f7a7c6fd093f698
+  metadata.gz: cce764481f48980482629a5e84feb9f13c5b95472f2a65f2b06a028a67754fa6d302c6fb276fce1e10b69e79deca1a0e72cfcff50dbd2fd0b4ac0d5ed04d4415
+  data.tar.gz: 1699e0d59af2b6af7a67d4bfc2197ce93a7c206307e5459c1ab28ec776fb5a83b7da1f79df8146a97279373cc4b2f31a47e47adf0f888c5470ea9a793725650b

data/README.md

@@ -17,42 +17,48 @@ How to
 
 Add to Gemfile
 
-    gem 'rails_email_preview', '~> 0.2.10'
+```ruby
+gem 'rails_email_preview', '~> 0.2.12'
+```
 
 REP handles setup for you:
 
-    # adds initializer and route:
-    rails g rails_email_preview:install
+```ruby
+# adds initializer and route:
+rails g rails_email_preview:install
 
-    # generates preview classes and method stubs in app/mailer_previews/:
-    rails g rails_email_preview:update_previews
+# generates preview classes and method stubs in app/mailer_previews/:
+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:
 
-    # 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
-      # 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) }
-        obj
-      end
-    end
+```ruby
+# 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
+  # 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) }
+    obj
+  end
+end
+```
 
 
 Routing
@@ -60,12 +66,14 @@ Routing
 
 You can access REP urls like this:
 
-    # engine root:
-    rails_email_preview.rep_root_url
-    # list of emails (same as root):
-    rails_email_preview.rep_emails_url
-    # email show:
-    rails_email_preview.rep_email_url(mail_class: "user_mailer", mail_action: "welcome")
+```ruby
+# engine root:
+rails_email_preview.rep_root_url
+# list of emails (same as root):
+rails_email_preview.rep_emails_url
+# email show:
+rails_email_preview.rep_email_url(mail_class: "user_mailer", mail_action: "welcome")
+```
 
 Send Emails
 -------------------
@@ -74,7 +82,9 @@ You can send emails via REP. This is especially useful when testing with limited
 This will use the environment's mailer settings, but the handler will `perform_deliveries`.
 Uncomment this line in the initializer to disable sending test emails:
 
-    config.enable_send_email = false
+```ruby
+config.enable_send_email = false
+```
 
 Email editing 
 -------------
@@ -97,16 +107,20 @@ I18n
 -------------
 
 REP expects emails to use current `I18n.locale`:
-    
-    # current locale
-    AccountMailer.some_notification.deliver     
-    # different locale
-    I18n.with_locale('es') { InviteMailer.send_invites.deliver }
-    
+
+```ruby
+# current locale
+AccountMailer.some_notification.deliver     
+# different locale
+I18n.with_locale('es') { InviteMailer.send_invites.deliver }
+
+```
 When linking to REP pages you can pass `email_locale` to set the locale for rendering:
 
-    # will render email in Spanish:
-    rails_email_preview.root_url(email_locale: 'es')
+```ruby
+# will render email in Spanish:
+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 
@@ -114,32 +128,40 @@ If you are using `Resque::Mailer` or `Devise::Async`, you can automatically add
 
 REP displays too many locales? Make sure to set `config.i18n.available_locales`, since it defaults to *all* locales in Rails.
 
+REP's own UI is fully localized, available locales are: en, de.
+
 Views
 ---------------------
 
 You can render all REP views inside your app layout (this will need styling to look nice if you don't use bootstrap):
 
-    Rails.application.config.to_prepare do
-      # Use admin layout with REP (this will also make app routes accessible within REP):
-      RailsEmailPreview.layout = 'admin'
-    end
+```ruby
+Rails.application.config.to_prepare do
+  # Use admin layout with REP (this will also make app routes accessible within REP):
+  RailsEmailPreview.layout = 'admin'
+end
+```
 
 REP allows you to customize some of the element classes via `RailsEmailPreview.style`:
 
-    {
-      btn_default_class:     'btn btn-default',
-      btn_active_class:      'btn btn-primary active',
-      btn_group_class:       'btn-group',
-      list_group_class:      'list-group',
-      list_group_item_class: 'list-group-item',
-      panel_class:           'panel',
-      row_class:             'row',
-      column_class:          'col-%{n}'
-    }
+```ruby
+{
+  btn_default_class:     'btn btn-default',
+  btn_active_class:      'btn btn-primary active',
+  btn_group_class:       'btn-group',
+  list_group_class:      'list-group',
+  list_group_item_class: 'list-group-item',
+  panel_class:           'panel',
+  row_class:             'row',
+  column_class:          'col-%{n}'
+}
+```
 
 E.g., to change column class from `col-` to `column-` everywhere where REP uses columns:
 
-    RailsEmailPreview.style[:column_class] = 'column-%{n}'
+```ruby
+RailsEmailPreview.style[:column_class] = 'column-%{n}'
+```
 
 You can `//= require 'rails_email_preview/layout'` REP-specific styles (`@import 'rails_email_preview/layout'` for SASS).
 
@@ -152,20 +174,24 @@ 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):
 
-    RailsEmailPreview.parent_controller = 'Admin::ApplicationController' # default: '::ApplicationController'
+```ruby
+RailsEmailPreview.parent_controller = 'Admin::ApplicationController' # default: '::ApplicationController'
+```
 
 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 
+```ruby
+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 
+```
 
 
 This project rocks and uses MIT-LICENSE.

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

@@ -13,8 +13,8 @@ ruby:
         $('.left-column,.right-column').hide();
         $('.center-column').css('margin', 0);
         $('.page-header h2').html(
-          "Editing email" +
-          " <a class='btn btn-primary' href='#{show_url}'>#{t 'rep.view_link'}</a>"
+          "#{t '.edit_email'}" +
+          " <a class='btn btn-primary' href='#{show_url}'>#{t '.view_link'}</a>"
         )
 
         // Snippet form:

data/app/views/layouts/rails_email_preview/application.html.slim

@@ -2,7 +2,7 @@ doctype html
 = "\n"
 html
   head
-    title = t('rep.head_title')
+    title = t('.head_title')
     = stylesheet_link_tag 'rails_email_preview/application'
     = javascript_include_tag 'rails_email_preview/application'
     = yield(:head)

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

@@ -1,18 +1,30 @@
 javascript:
-  function iFrameLoad(id){
-    var resize = function(id) {
-      var el = document.getElementById(id),
-          w = el.parentNode.clientWidth,
-          h = el.contentWindow.document.body.scrollHeight;
-      el.height = (h) + "px";
-      el.width  = (w) + "px";
+  (function(doc){
+    var rep = window.rep = window['rep'] || {
+       resizeIframe: function(id) {
+          var el = doc.getElementById(id),
+              w = el.parentNode.clientWidth,
+              h = el.contentWindow.document.body.scrollHeight;
+          el.height = (h) + "px";
+          el.width  = (w) + "px";
+        },
+        iframeLoad: function(id){
+          document.getElementById('loading-el').style.display = 'none';
+          setTimeout(function() { rep.resizeIframe(id); rep.loaded = true; });
+        },
+        resizeAttached: false
     };
-    document.getElementById('loading-el').style.display = 'none';
-    setTimeout(function() { resize(id) });
-  }
+    rep.loaded = false;
+    if (!rep.resizeAttached) {
+      window.addEventListener('resize', function() {
+        if (rep.loaded) rep.resizeIframe('src-iframe');
+      });
+      rep.resizeAttached = true
+    }
+  })(document)
 
 pre#loading-el.lead
   i.icon-spinner.icon-spin
-  |  Loading...
+  |  #{t 'rep.base.loading'}
 iframe#src-iframe[src=rails_email_preview.rep_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"]
+  width="100%" height=1 onLoad="rep.iframeLoad('src-iframe')" style="border:none;padding:0;margin:0"]

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

@@ -2,5 +2,5 @@
   = form_tag rails_email_preview.rep_test_deliver_url, method: :post do
     = hidden_field_tag :email_locale, @email_locale
     .input-group
-      span.input-group-btn: button.btn.btn-danger type='submit' data-confirm=t('rep.send_are_you_sure') #{t('rep.send_btn')}
-      = text_field_tag :recipient_email, '', class: 'form-control', placeholder: t('rep.send_recipient_placeholder')
+      span.input-group-btn: button.btn.btn-danger type='submit' data-confirm=t('.send_are_you_sure') #{t('.send_btn')}
+      = text_field_tag :recipient_email, '', class: 'form-control', placeholder: t('.send_recipient_placeholder')

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

@@ -1,5 +1,5 @@
 h1
-  | #{t 'rep.list_title'}
+  | #{t '.list_title'}
 
 - previews_group = proc do |m|
   - capture do
@@ -19,6 +19,6 @@ div class=rep_row_class
 hr
 
 p.text-center.text-small.text-info
-  | #{total_emails} emails in #{@preview_class_names.length} mailers
+  | #{t 'rep.base.email', count: total_emails} #{t 'rep.base.in'} #{t 'rep.base.mailer', count: @preview_class_names.length }
   br
   a href="https://github.com/glebm/rails_email_preview" target='_blank' REP #{RailsEmailPreview::VERSION}

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

@@ -2,7 +2,7 @@
   div class=rep_row_class
     .pull-left
       ul.breadcrumb
-        li: a href=rails_email_preview.rep_emails_url(email_locale: @email_locale) #{t 'rep.breadcrumb_list'}
+        li: a href=rails_email_preview.rep_emails_url(email_locale: @email_locale) #{t '.breadcrumb_list'}
         li.active: a href=(request.url) = current_email_name
 
   div class=rep_style[:panel_class]

data/config/locales/de.yml

@@ -0,0 +1,33 @@
+de:
+  rep:
+    base:
+      email:
+        one: "1 E-Mail"
+        other: "%{count} E-Mails"
+      mailer:
+        one: "1 Mailer"
+        other: "%{count} Mailer"
+      in: "in"
+      loading: "Lade..."
+    test_deliver:
+      no_delivery_method: "Bitte setze 'config.action_mailer.delivery_method' um E-Mails in der „%{environment}“ Umgebung zu senden."
+      provide_email: "An welche Adresse senden?"
+      sent_notice: "Senden an %{address} mit %{delivery_method}"
+  layouts:
+    rails_email_preview:
+      application:
+        head_title: "E-Mails - REP"
+  rails_email_preview:
+    emails:
+      index:
+        list_title: "Anwendungs E-Mails"
+      show:
+        breadcrumb_list: "E-Mails"
+      send_form:
+        send_are_you_sure: "Diese Aktion wird diese E-Mail wirklich versenden. Bist du sicher?"
+        send_btn: "Senden an"
+        send_recipient_placeholder: "E-Mails"
+  integrations:
+    cms:
+      edit_email: "E-Mail bearbeiten"
+      view_link: "Anzeigen"

data/config/locales/en.yml

@@ -0,0 +1,33 @@
+en:
+  rep:
+    base:
+      email:
+        one: "1 email"
+        other: "%{count} emails"
+      mailer:
+        one: "1 mailer"
+        other: "%{count} mailers"
+      in: "in"
+      loading: "Loading..."
+    test_deliver:
+      no_delivery_method: "Please set 'config.action_mailer.delivery_method' to send emails in '%{environment}' environment"
+      provide_email: "Send to which address?"
+      sent_notice: "Sent to %{address} via %{delivery_method}"
+  layouts:
+    rails_email_preview:
+      application:
+        head_title: "Emails - REP"
+  rails_email_preview:
+    emails:
+      index:
+        list_title: "Application Emails"
+      show:
+        breadcrumb_list: "Emails"
+      send_form:
+        send_are_you_sure: "This will actually send this email. Are you sure?"
+        send_btn: "Send to"
+        send_recipient_placeholder: "Email"
+  integrations:
+    cms:
+      edit_email: "Editing email"
+      view_link: "View"

data/lib/rails_email_preview/version.rb

@@ -1,3 +1,3 @@
 module RailsEmailPreview
-  VERSION = '0.2.11'
+  VERSION = '0.2.12'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_email_preview
 version: !ruby/object:Gem::Version
-  version: 0.2.11
+  version: 0.2.12
 platform: ruby
 authors:
 - Gleb Mazovetskiy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-29 00:00:00.000000000 Z
+date: 2013-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -170,7 +170,8 @@ files:
 - lib/rails_email_preview/version.rb
 - lib/rails_email_preview.rb
 - config/initializers/rails_email_preview.rb
-- config/locales/rep.en.yml
+- config/locales/de.yml
+- config/locales/en.yml
 - config/routes.rb
 - MIT-LICENSE
 - Rakefile

data/config/locales/rep.en.yml

@@ -1,14 +0,0 @@
-en:
-  rep:
-    test_deliver:
-      no_delivery_method: Please set "config.action_mailer.delivery_method" to send emails in "%{environment}" environment
-      provide_email: Send to which address?
-      sent_notice: "Sent to %{address} via %{delivery_method}"
-    list_title: Application Emails
-    breadcrumb_list: Emails
-    send_recipient_placeholder: Email
-    send_btn: Send to
-    send_are_you_sure: This will actually send this email. Are you sure?
-    view_link: View
-    head_title: Emails - REP
-