simple_email_preview 1.0.0

data/app/assets/stylesheets/simple_email_preview/application.scss

@@ -0,0 +1,10 @@
+@import "simple_email_preview/default";
+
+body {
+  margin: 0;
+  padding: 0;
+}
+
+.rep-standalone-container {
+  padding: 0 15px;
+}

data/app/controllers/simple_email_preview/application_controller.rb

@@ -0,0 +1,19 @@
+module SimpleEmailPreview
+  class ApplicationController < ::SimpleEmailPreview.parent_controller.constantize
+    layout 'simple_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/simple_email_preview/emails_controller.rb

@@ -0,0 +1,194 @@
+module SimpleEmailPreview
+  class EmailsController < ::SimpleEmailPreview::ApplicationController
+    include ERB::Util
+    include Rails.application.routes.url_helpers
+    before_action :load_preview, except: :index
+    # around_action :set_locale
+    before_action :set_email_preview_locale
+    helper_method :with_email_locale
+    helper_method :preview_params
+    before_action :add_breadcrumbs
+    before_action :set_title
+
+    def add_breadcrumbs
+      super if defined?(super)
+    end
+
+    def set_title
+      if defined?(super)
+        super
+      else
+        @title = t('email_preview')
+      end
+    end
+
+    # List of emails
+    def index
+      if defined?(super)
+        super
+      else
+        @previews = Preview.all
+        @list     = PreviewListPresenter.new(@previews)
+      end
+    end
+
+    # Preview an email
+    def show
+      if defined?(super)
+        super
+      else
+        prevent_browser_caching
+        # with_email_locale do
+        if @preview.respond_to?(:preview_mail)
+          @mail, body     = mail_and_body
+          @mail_body_html = render_to_string(inline: body, layout: 'simple_email_preview/email')
+        else
+          raise ArgumentError, "#{@preview} is not a preview class, does not respond_to?(:preview_mail)"
+        end
+      end
+    end
+
+    # Really deliver an email
+    def test_deliver
+      redirect_url = simple_email_preview.rep_email_url(preview_params.except(:recipient_email))
+      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 = SimpleEmailPreview::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
+
+    # Download attachment
+    def show_attachment
+      with_email_locale do
+        filename   = "#{params[:filename]}.#{params[:format]}"
+        attachment = preview_mail(false).attachments.find { |a| a.filename == filename }
+        send_data attachment.body.raw_source, filename: filename
+      end
+    end
+
+    # Render headers partial. Used by the CMS integration to refetch headers after editing.
+    def show_headers
+      mail = with_email_locale { mail_and_body.first }
+      render partial: 'simple_email_preview/emails/headers', locals: { mail: mail }
+    end
+
+    # Render email body iframe HTML. Used by the CMS integration to provide a link back to Show from Edit.
+    def show_body
+      prevent_browser_caching
+      cms_edit_links!
+      with_email_locale do
+        _, body = mail_and_body
+        render inline: body, layout: 'simple_email_preview/email'
+      end
+    end
+
+    private
+
+    def preview_params
+      if Rails::VERSION::MAJOR >= 5
+        params.to_unsafe_h.except(*(request.path_parameters.keys - [:email_locale]))
+      else
+        params.except(*(request.path_parameters.keys - [:email_locale]))
+      end
+    end
+
+    def deliver_email!(mail)
+      if mail.respond_to?(:deliver_now!)
+        # ActiveJob
+        mail.deliver_now!
+      elsif mail.respond_to?(:deliver!)
+        # support deliver! if present (resque-mailer etc)
+        mail.deliver!
+      else
+        mail.deliver
+      end
+    end
+
+    # 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
+
+    # @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, preview_params)
+    end
+
+    # @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
+      return "<pre id='error'>#{html_escape(t('rep.errors.email_missing_format', locale: @ui_locale))}</pre>" unless body_part
+      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 = simple_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
+
+    def with_email_locale(&block)
+      I18n.with_locale @email_locale, &block
+    end
+
+    # Email content locale
+    def set_email_preview_locale
+      @email_locale = (params[:email_locale] || SimpleEmailPreview.default_email_locale || I18n.default_locale).to_s
+    end
+
+    # UI locale
+    def set_locale
+      @ui_locale = SimpleEmailPreview.locale
+      unless I18n.available_locales.map(&:to_s).include?(@ui_locale.to_s)
+        @ui_locale = :en
+      end
+      begin
+        locale_was  = I18n.locale
+        I18n.locale = @ui_locale
+        yield if block_given?
+      ensure
+        I18n.locale = locale_was
+      end
+    end
+
+    # 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
+
+    def load_preview
+      @preview = ::SimpleEmailPreview::Preview[params[:preview_id]]
+      raise ActionController::RoutingError.new('Not Found') unless @preview
+      # @preview = ::RailsEmailPreview::Preview[params[:preview_id]] || raise ActionController::RoutingError.new('Not Found')
+      @part_type = params[:part_type] || 'text'
+    end
+  end
+end

data/app/helpers/simple_email_preview/emails_helper.rb

@@ -0,0 +1,85 @@
+module SimpleEmailPreview::EmailsHelper
+  FORMAT_LABELS = { 'html' => 'HTML', 'plain' => 'Text', 'raw' => 'Raw' }.freeze
+
+  def format_label(mime_type)
+    FORMAT_LABELS[mime_type]
+  end
+
+  def change_locale_attr(locale)
+    { href:  simple_email_preview.rep_email_path(preview_params.merge(part_type: @part_type, email_locale: locale)),
+      class: rep_btn_class(@email_locale == locale.to_s) }
+  end
+
+  def change_format_attr(format)
+    { href: simple_email_preview.rep_email_path(preview_params.merge(part_type: format)),
+      class: rep_btn_class(@part_type == format) }
+  end
+
+  def locale_name(locale)
+    if defined?(TwitterCldr)
+      TwitterCldr::Shared::LanguageCodes.to_language(locale.to_s, :bcp_47)
+    else
+      locale.to_s
+    end
+  end
+
+  def human_headers(mail)
+    { t('rep.headers.subject') => mail.subject || '(no subject)',
+      t('rep.headers.from')        => mail.from,
+      t('rep.headers.reply_to')    => mail.reply_to,
+      t('rep.headers.to')          => mail.to,
+      t('rep.headers.cc')          => mail.cc,
+      t('rep.headers.bcc')         => mail.bcc,
+      t('rep.headers.attachments') => attachment_links(mail) }.each do |name, value|
+      yield(name, format_header_value(value)) unless value.blank?
+    end
+  end
+
+  def attachment_links(mail)
+    mail.attachments.map do |attachment|
+      url = simple_email_preview.rep_raw_email_attachment_path(preview_params.merge(filename: attachment.filename))
+      link_to(attachment.filename, url, title: attachment.header.to_s)
+    end.to_sentence.html_safe
+  end
+
+  def format_header_value(value)
+    if value.is_a?(Array)
+      value.map(&:to_s) * ', '
+    else
+      value.to_s
+    end
+  end
+
+  # style
+  def rep_style
+    SimpleEmailPreview.style
+  end
+
+  def rep_btn_class(active = false)
+    [rep_style[:btn_default_class], (rep_style[:btn_active_class_modifier] if active)].compact * ' '
+  end
+
+  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
+    SimpleEmailPreview.view_hooks
+  end
+end

data/app/models/simple_email_preview/preview.rb

@@ -0,0 +1,86 @@
+module SimpleEmailPreview
+  # Preview for one mailer method
+  class Preview
+    attr_accessor :id, :preview_class_name, :preview_method
+
+    def initialize(attr = {})
+      attr.each { |k, v| send "#{k}=", v }
+    end
+
+    def locales
+      I18n.available_locales
+    end
+
+    def formats
+      %w[plain raw]
+    end
+
+    def preview_mail(run_hooks = false, search_query_params = {})
+      preview_instance = preview_class_name.constantize.new
+      setup_instance_variables(preview_instance, search_query_params)
+
+      preview_instance.send(preview_method).tap do |mail|
+        SimpleEmailPreview.run_before_render(mail, self) if run_hooks
+      end
+    end
+
+    def name
+      @name ||= "#{group_name}: #{humanized_method_name}"
+    end
+
+    def humanized_method_name
+      @action_name ||= preview_method.to_s.humanize
+    end
+
+    # @deprecated {#method_name} is deprecated and will be removed in v3
+    alias method_name humanized_method_name
+
+    def group_name
+      @group_name ||= preview_class_name.to_s.underscore.gsub('/', ': ').sub(/(_mailer)?_preview$/, '').humanize
+    end
+
+    class << self
+      def find(email_id)
+        @by_id[email_id]
+      end
+
+      alias [] find
+
+      attr_reader :all
+
+      def mail_methods(mailer)
+        mailer.public_instance_methods(false).map(&:to_s)
+      end
+
+      def load_all(class_names)
+        @all   = []
+        @by_id = {}
+        class_names.each do |preview_class_name|
+          preview_class = preview_class_name.constantize
+
+          mail_methods(preview_class).sort.each do |preview_method|
+            mailer_method = preview_method
+            id            = "#{preview_class_name.underscore.gsub('/', '__')}-#{mailer_method}"
+
+            email = new(
+              id:                 id,
+              preview_class_name: preview_class_name,
+              preview_method:     preview_method
+            )
+            @all << email
+            @by_id[id] = email
+          end
+        end
+        @all.sort_by!(&:name)
+      end
+    end
+
+    private
+
+    def setup_instance_variables(object, params)
+      unless params.empty?
+        params.each { |k, v| object.instance_variable_set("@#{k}", v) }
+      end
+    end
+  end
+end

data/app/presenters/simple_email_preview/preview_list_presenter.rb

@@ -0,0 +1,38 @@
+
+module SimpleEmailPreview
+  class PreviewListPresenter
+    attr_reader :previews
+
+    def initialize(previews)
+      @previews = previews
+    end
+
+    def columns(&block)
+      return to_enum(:columns) unless block_given?
+      split_in_halves(groups) { |_k, v| v.length }.each do |column_groups|
+        block.yield(column_groups)
+      end
+    end
+
+    def groups
+      @groups ||= by_class_name.inject({}) do |h, (_class_name, previews)|
+        h.update previews.first.group_name => previews
+      end
+    end
+
+    private
+
+    def split_in_halves(xs, &weight)
+      xs    = xs.to_a
+      ws    = xs.map(&weight)
+      col_w = (ws.sum + 1) / 2
+      cur_w = 0
+      mid   = ws.find_index { |w| (cur_w += w) >= col_w + w } || [ws.length - 1, 0].max
+      [xs.first(mid), xs.from(mid)]
+    end
+
+    def by_class_name
+      @by_class_name ||= previews.group_by(&:preview_class_name)
+    end
+  end
+end

data/app/views/layouts/simple_email_preview/_flash_notices.html.erb

@@ -0,0 +1,7 @@
+<% flash.each do |name, msg| %>
+  <% next unless msg.is_a?(String) %>
+  <div class="alert alert-<%= name.to_s =~ /notice/ ? 'success' : 'error' %>">
+    <button class="close" type="button" data-dismiss="alert"><i class="icon-remove"></i> &times;</button>
+    <%= content_tag :div, name.to_s.end_with?('_html') ? msg.html_safe : h(msg).gsub("\n", "<br>").html_safe, id: "flash_#{name.to_s.sub(/_html$/, '')}" %>
+  </div>
+<% end %>

data/app/views/layouts/simple_email_preview/application.html.erb

@@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title><%= t('.head_title') %></title>
+  <%= stylesheet_link_tag 'simple_email_preview/application' %>
+  <%= javascript_include_tag 'simple_email_preview/application' %>
+  <%= favicon_link_tag 'simple_email_preview/favicon.png' %>
+  <%= yield(:head) %>
+</head>
+<body>
+<div class="rep-standalone-container">
+  <%= render 'layouts/simple_email_preview/flash_notices' %>
+  <%= yield %>
+</div>
+</body>
+</html>