rails_email_preview 0.2.22 → 0.2.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d7ac94c83aae345e79cac0653512e28f82bcd17f
-  data.tar.gz: e296d3e2c055f126c854654b08c7a601f033f316
+  metadata.gz: c931cf860483798ae783d2a8009543fa2c1d267a
+  data.tar.gz: d24a6cedfdbd15dbdad7d36929f266c643abc0f7
 SHA512:
-  metadata.gz: 99d6e21a3414b6d3368cef021d8951500c4b9c71f4833a094aab5d52dd6298caae92c589de496af8e8868992beb648a900310688df284292cffb61dccb9a5394
-  data.tar.gz: 7d7a1eaae3a399ac69896a5d77b93ccac01ed40055c6692eae9c139c8221d8441637aea2d1e381ebcae57b784fcdf39986da848212ac599b70221c8be82c15d2
+  metadata.gz: 5ffb92ddf75f5b2e12ab1fda1edbcbc37ab952f2613b6202802390335629e9e9b548e05538da6617fe3f33325d5e867efe76558dc349a4561c5f6b027c1848d3
+  data.tar.gz: 27229704b52d6d92a3f8dccbdc7bda3b0f742d49907c8ac047e77da2502cad344043f6de44c262a78ec2aa288d75d09be27dafff791053b87364649e734b4f1e

data/README.md

@@ -16,7 +16,7 @@ REP can use your application styles, markup is compatible with [bootstrap 3][rep
 Add [![Gem Version][gem-badge]][gem] to Gemfile:
 
 ```ruby
-gem 'rails_email_preview', '~> 0.2.22'
+gem 'rails_email_preview', '~> 0.2.23'
 ```
 
 Add an initializer and the routes:
@@ -67,21 +67,21 @@ end
 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
-```
+/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
+    user = @user_id ? User.find(@user_id) : mock_user
     UserMailer.welcome(user)
   end
 end
 ```
 
+Now you can preview or send the welcome email to a specific user.
+
 ### Routing
 
 You can access REP urls like this:
@@ -117,7 +117,7 @@ REP works with [Comfortable Mexican Sofa CMS](https://github.com/comfy/comfortab
 [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`*
+Simply uncomment the relevant options in [the initializer](https://github.com/glebm/rails_email_preview/config/initializers/rails_email_preview.rb). *initializer is generated during `rails g rails_email_preview:install`*
 
 ### I18n
 
@@ -163,29 +163,32 @@ Rails.application.config.to_prepare do
 end
 ```
 
-REP also allows you to customize some of the element classes via `RailsEmailPreview.style`:
+You can `//= require 'rails_email_preview/layout'` REP-specific styles (`@import 'rails_email_preview/layout'` for SASS).
+
+REP also allows you to customize some of the element classes via [`RailsEmailPreview.style`](/lib/rails_email_preview.rb#L34).
+
+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`.
+
+#### Hooks
+
+You can add content around or replacing REP UI elements by registering view hooks in the initializer:
 
 ```ruby
-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}'
-}
-```
+# Pass position (before, after, or replace) and render arguments:
+RailsEmailPreview.view_hooks.add_render :list, :before, partial: 'shared/hello'
 
-You can `//= require 'rails_email_preview/layout'` REP-specific styles (`@import 'rails_email_preview/layout'` for SASS).
+# Pass hook id and position (before, after, or replace):
+RailsEmailPreview.view_hooks.add :headers_content, :after do |mail:, preview:|
+  raw "<dt>ID</dt><dd>#{h mail.header['X-APP-EMAIL-ID']}</dd>"
+end
+```
 
-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.
+All of the available hooks can be found [here](/lib/rails_email_preview/view_hooks.rb#L10).
 
 ### Authentication & authorization
 
-You can specify the parent controller for REP controller, and it will inherit all before filters.
+You can specify the parent controller for REP controller, and it will inherit all the before filters.
 Note that this must be placed before any other references to REP application controller in the initializer (and before `layout=` call):
 
 ```ruby
@@ -207,6 +210,20 @@ Rails.application.config.to_prepare do
 end
 ```
 
+## Development
+
+Run the tests:
+
+```console
+$ rspec
+```
+
+Start a development web server on [localhost:9292](http://localhost:9292):
+
+```console
+$ rake dev
+```
+
 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"

data/Rakefile

@@ -20,14 +20,16 @@ task default: :spec
 
 desc 'Start development web server'
 task :dev do
+  host = 'localhost'
+  port = 9292
   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,
+      Host: host,
+      Port: port,
       config: 'config.ru',
       server: 'puma'
   )

data/app/controllers/rails_email_preview/emails_controller.rb

@@ -28,9 +28,9 @@ module RailsEmailPreview
 
     # Download attachment
     def show_attachment
-      filename   = "#{params[:filename]}.#{request.format.symbol}"
+      filename   = "#{params[:filename]}.#{params[:format]}"
       attachment = preview_mail(false).attachments.find { |a| a.filename == filename }
-      send_data attachment.body.raw_source
+      send_data attachment.body.raw_source, filename: filename
     end
 
     # Really deliver an email
@@ -53,7 +53,7 @@ module RailsEmailPreview
     end
 
     # Used by CMS integration to refetch header after editing
-    def headers
+    def show_headers
       render partial: 'rails_email_preview/emails/headers', locals: {mail: mail_and_body.first}
     end
 
@@ -103,7 +103,7 @@ module RailsEmailPreview
                   else
                     mail
                   end
-
+      return "<pre id='error'>#{html_escape(t('rep.errors.email_missing_format'))}</pre>" if !body_part
       if body_part.content_type =~ /plain/
         "<pre id='message_body'>#{html_escape(body_part.body.to_s)}</pre>".html_safe
       else

data/app/helpers/rails_email_preview/emails_helper.rb

@@ -39,9 +39,9 @@ module RailsEmailPreview::EmailsHelper
 
   def attachment_links(mail)
     mail.attachments.map do |attachment|
-      url = rails_email_preview.rep_raw_email_attachment_path(params[:preview_id], attachment.filename)
+      url = rails_email_preview.rep_raw_email_attachment_path(preview_params.merge(filename: attachment.filename))
       link_to(attachment.filename, url)
-    end.join('').html_safe
+    end.to_sentence.html_safe
   end
 
   def format_header_value(value)
@@ -76,4 +76,25 @@ module RailsEmailPreview::EmailsHelper
   def rep_btn_group_class
     rep_style[:btn_group_class]
   end
+
+
+  def with_index_hook(key, &block)
+    render_hook key, list: @list, previews: @previews, &block
+  end
+
+  def with_show_hook(key, &block)
+    render_hook key, mail: @mail, preview: @preview, &block
+  end
+
+  def render_hook(key, args, &block)
+    view_hooks.render(key, args, self, &block)
+  end
+
+  def hook?(key)
+    view_hooks.for?(key)
+  end
+
+  def view_hooks
+    RailsEmailPreview.view_hooks
+  end
 end

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

@@ -7,6 +7,15 @@ html
         font-family: Monaco, Menlo, Consolas, "Courier New", monospace;
         word-break: break-word;
       }
+      #error {
+        padding: 15px;
+        margin-bottom: 20px;
+        border: 1px solid transparent;
+        border-radius: 4px;
+        background-color: #f2dede;
+        border-color: #ebccd1;
+        color: #a94442;
+      }
       body {
         background-color:white;
       }

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

@@ -1,5 +1,6 @@
-span class=rep_btn_group_class
-  - @preview.formats.each do |format|
-    a *change_format_attr(format)
-      = format_label format
+p
+  span class=rep_btn_group_class
+    - @preview.formats.each do |format|
+      a *change_format_attr(format)
+        = format_label format
 

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

@@ -1,4 +1,6 @@
-dl.rep-headers-list.dl-horizontal
-  - human_headers mail do |name, value|
-    dt = name
-    dd = value
+= with_show_hook :headers do
+  dl.rep-headers-list.dl-horizontal
+    = with_show_hook :headers_content do
+      - human_headers mail do |name, value|
+        dt = name
+        dd = value

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

@@ -0,0 +1,8 @@
+div class=rep_style[:panel_class]
+  div class=rep_style[:panel_body_class]
+    div class=rep_style[:row_class]
+      #email-headers data-url=rails_email_preview.rep_email_headers_path(preview_params) class=rep_col_class(8)
+        / content updated by JS on demand from the iframe
+        = render 'rails_email_preview/emails/headers', mail: @mail
+      .text-right class=rep_col_class(4)
+        = render 'nav'

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

@@ -1,4 +1,5 @@
-span class=rep_btn_group_class
-  - @preview.locales.each do |locale|
-    a *change_locale_attr(locale)
-      = locale_name locale
+p
+  span class=rep_btn_group_class
+    - @preview.locales.each do |locale|
+      a *change_locale_attr(locale)
+        = locale_name locale

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

@@ -0,0 +1,13 @@
+-# Locale, format and actions
+= with_show_hook :nav do
+
+  .rep-email-options.text-right
+    - if I18n.available_locales.length > 1
+      = with_show_hook :nav_i18n do
+        = render 'rails_email_preview/emails/i18n_nav'
+    = with_show_hook :nav_format do
+      = render 'rails_email_preview/emails/format_nav'
+    - if RailsEmailPreview.enable_send_email
+      = with_show_hook :nav_send do
+        = render 'rails_email_preview/emails/send_form'
+

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

@@ -4,15 +4,16 @@ ruby:
 
 h1 = t '.list_title'
 
-div class=rep_row_class
-  - list.columns do |groups|
-    div class=rep_col_class(6)
-      - groups.each do |title, group_previews|
-        h2 = title
-        div class=rep_style[:list_group_class]
-          - group_previews.each do |p|
-            a class=rep_style[:list_group_item_class] href=rails_email_preview.rep_email_path(preview_id: p.id, email_locale: @email_locale)
-              = p.method_name
+= with_index_hook :list do
+  div class=rep_row_class
+    - list.columns do |groups|
+      div class=rep_col_class(6)
+        - groups.each do |title, group_previews|
+          h2 = title
+          div class=rep_style[:list_group_class]
+            - group_previews.each do |p|
+              a class=rep_style[:list_group_item_class] href=rails_email_preview.rep_email_path(preview_id: p.id, email_locale: @email_locale)
+                = p.method_name
 hr
 p.text-center.text-small.text-info
   | #{t 'rep.base.email', count: previews.length} #{t 'rep.base.in'} #{t 'rep.base.mailer', count: list.groups.length }

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

@@ -5,21 +5,9 @@
         li: a href=rails_email_preview.rep_emails_path(email_locale: @email_locale) #{t '.breadcrumb_list'}
         li.active: a href=(request.path) = @preview.name
 
-  div class=rep_style[:panel_class]
-    div class=rep_style[:panel_body_class]
-      div class=rep_style[:row_class]
-        -# From, To, Subject and other headers
-        #email-headers data-url=rails_email_preview.rep_email_headers_path(preview_params) class=rep_col_class(8)
-          = render 'rails_email_preview/emails/headers', mail: @mail
-        -# Locale, format and actions
-        .text-right class=rep_col_class(4)
-          .rep-email-options.text-right
-            - if I18n.available_locales.length > 1
-              p= render 'rails_email_preview/emails/i18n_nav'
-            p= render 'rails_email_preview/emails/format_nav'
-            - if RailsEmailPreview.enable_send_email
-              = render 'rails_email_preview/emails/send_form'
+  = with_show_hook :headers_and_nav do
+    = render 'rails_email_preview/emails/headers_and_nav'
 
-
-  -# actual email content, rendered in an iframe to prevent browser styles from interfering
-  = render 'rails_email_preview/emails/email_iframe'
+  = with_show_hook :email_body do
+    / actual email content, rendered in an iframe to prevent browser styles from interfering
+    = render 'rails_email_preview/emails/email_iframe'

data/config/locales/de.yml

@@ -22,6 +22,8 @@ de:
       cc: CC
       bcc: BCC
       attachments: Anhänge
+    errors:
+      email_missing_format: Format fehlenden
   layouts:
     rails_email_preview:
       application:

data/config/locales/en.yml

@@ -22,6 +22,8 @@ en:
       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}
+    errors:
+      email_missing_format: Format missing
   layouts:
     rails_email_preview:
       application:

data/config/locales/ru.yml

@@ -26,6 +26,8 @@ ru:
       no_delivery_method: "Настройте 'config.action_mailer.delivery_method', чтобы отправлять письма в среде '%{environment}'"
       provide_email: "На какой адрес отправить?"
       sent_notice: "Оправлено на %{address} через %{delivery_method}"
+    errors:
+      email_missing_format: "Формат отсутствует"
   layouts:
     rails_email_preview:
       application:

data/config/routes.rb

@@ -3,16 +3,18 @@ RailsEmailPreview::Engine.routes.draw do
     scope path: '(:email_locale)',
           # This constraint resolves ambiguity with :preview_id, allowing locale to be optional
           constraints: {email_locale: /#{I18n.available_locales.map(&Regexp.method(:escape)) * '|'}/},
-          defaults: {email_locale: I18n.default_locale} do
+          defaults: {email_locale: I18n.default_locale.to_s} do
       get '/' => :index, as: :rep_emails
       scope path: ':preview_id', constraints: {preview_id: /\w+-\w+/} do
-        scope '(:part_type)', defaults: {part_type: 'html'} do
+        scope '(:part_type)',
+              constraints: {part_type: /html|plain|raw/},
+              defaults: {part_type: 'html'} do
           get '' => :show, as: :rep_email
           get 'body' => :show_body, as: :rep_raw_email
         end
         post 'deliver' => :test_deliver, as: :rep_test_deliver
         get 'attachments/:filename' => :show_attachment, as: :rep_raw_email_attachment
-        get 'headers' => :headers, as: :rep_email_headers
+        get 'headers' => :show_headers, as: :rep_email_headers
       end
       # alias rep_emails_url to its stable api name
       get '/' => :index, as: :rep_root

data/lib/rails_email_preview/version.rb

@@ -1,3 +1,3 @@
 module RailsEmailPreview
-  VERSION = '0.2.22'
+  VERSION = '0.2.23'
 end

data/lib/rails_email_preview/view_hooks.rb

@@ -0,0 +1,102 @@
+module RailsEmailPreview
+  # Add hooks before, after, or replacing a UI element
+  class ViewHooks
+    args      = {
+        index: [:list, :previews].freeze,
+        show:  [:mail, :preview].freeze
+    }
+    # All valid hooks and their argument names
+    SCHEMA    = {
+        list:            args[:index],
+        headers_and_nav: args[:show],
+        headers:         args[:show],
+        headers_content: args[:show],
+        nav:             args[:show],
+        nav_i18n:        args[:show],
+        nav_format:      args[:show],
+        nav_send:        args[:show],
+        email_body:      args[:show],
+    }
+    POSITIONS = [:before, :replace, :after].freeze
+
+    def initialize
+      @hooks = Hooks.new
+    end
+
+    # @param [Symbol] id
+    # @param [:before, :replace, :after] pos
+    # @example
+    #   view_hooks.add_render :list, :before, partial: 'shared/hello'
+    def add_render(id, pos, *render_args)
+      render_args = render_args.deep_dup
+      render_opts = render_args.extract_options!
+      add id, pos do |locals = {}|
+        render *render_args, render_opts.merge(
+            locals: (render_opts[:locals] || {}).merge(locals))
+      end
+    end
+
+    # @param [Symbol] id
+    # @param [:before, :replace, :after] pos
+    # @example
+    #   view_hooks.add :headers_content, :after do |mail:, preview:|
+    #     raw "<b>ID</b>: #{h mail.header['X-APP-EMAIL-ID']}"
+    #   end
+    def add(id, pos, &block)
+      @hooks[id][pos] << block
+    end
+
+    def render(hook_id, locals, template, &content)
+      at = @hooks[hook_id]
+      validate_locals! hook_id, locals
+      parts = [
+          render_providers(at[:before], locals, template),
+          if at[:replace].present?
+            render_providers(at[:replace], locals, template)
+          else
+            template.capture { content.call(locals) }
+          end,
+          render_providers(at[:after], locals, template)
+      ]
+      template.safe_join(parts, '')
+    end
+
+    # Find available hooks with simple static analysis of the gem's views
+    # @return [Array<String>] return hook names
+
+    private
+
+    def render_providers(providers, locals, template)
+      template.safe_join providers.map { |provider| template.instance_exec(locals, &provider) }, ''
+    end
+
+    def validate_locals!(hook_id, locals)
+      if locals.keys.sort != SCHEMA[hook_id].sort
+        raise ArgumentError.new("Invalid arguments #{locals.keys}. Valid: #{SCHEMA[hook_id]}")
+      end
+    end
+
+    class Hooks < DelegateClass(Hash)
+      def initialize
+        super Hash.new { |h, id|
+          validate_id! id
+          h[id] = Hash.new { |hh, pos|
+            validate_pos! pos
+            hh[pos] = []
+          }
+        }
+      end
+
+      private
+
+      def validate_id!(id)
+        raise ArgumentError.new('hook id must be a symbol') unless Symbol === id
+        raise ArgumentError.new("Invalid hook #{id}. Valid: #{SCHEMA.keys * ', '}.") unless SCHEMA.key?(id)
+      end
+
+      def validate_pos!(pos)
+        raise ArgumentError.new("Invalid position #{pos}. Valid: #{POSITIONS * ', '}") unless POSITIONS.include?(pos)
+      end
+    end
+  end
+end

data/lib/rails_email_preview.rb

@@ -3,6 +3,7 @@ require 'rails_email_preview/engine'
 require 'rails_email_preview/main_app_route_delegator'
 require 'rails_email_preview/version'
 require 'rails_email_preview/delivery_handler'
+require 'rails_email_preview/view_hooks'
 
 require 'slim'
 require 'slim-rails'
@@ -43,7 +44,10 @@ module RailsEmailPreview
       column_class:          'col-sm-%{n}'
   }
 
+  @view_hooks = RailsEmailPreview::ViewHooks.new
   class << self
+    # @return [RailsEmailPreview::ViewHooks]
+    attr_reader :view_hooks
     def preview_classes=(classes)
       @preview_classes = classes
       RailsEmailPreview::Preview.load_all(classes)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_email_preview
 version: !ruby/object:Gem::Version
-  version: 0.2.22
+  version: 0.2.23
 platform: ruby
 authors:
 - Gleb Mazovetskiy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-17 00:00:00.000000000 Z
+date: 2014-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -178,7 +178,10 @@ files:
 - app/views/rails_email_preview/emails/_email_iframe.html.slim
 - app/views/rails_email_preview/emails/_format_nav.html.slim
 - app/views/rails_email_preview/emails/_headers.html.slim
+- app/views/rails_email_preview/emails/_headers_and_nav.html.slim
+- app/views/rails_email_preview/emails/_headers_content.html.slim
 - app/views/rails_email_preview/emails/_i18n_nav.html.slim
+- app/views/rails_email_preview/emails/_nav.html.slim
 - app/views/rails_email_preview/emails/_send_form.html.slim
 - app/views/rails_email_preview/emails/index.html.slim
 - app/views/rails_email_preview/emails/show.html.slim
@@ -196,6 +199,7 @@ files:
 - lib/rails_email_preview/integrations/comfortable_mexica_sofa.rb
 - lib/rails_email_preview/main_app_route_delegator.rb
 - lib/rails_email_preview/version.rb
+- lib/rails_email_preview/view_hooks.rb
 homepage: https://github.com/glebm/rails_email_preview
 licenses:
 - MIT