rails_email_preview 0.2.14 → 0.2.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 470b4acb87f3f09970b99c473dc2513e4e7b4cd7
-  data.tar.gz: 1a408bcd46fb2917eb812098a1d5da1d0c2e0498
+  metadata.gz: c104f566ecd1afcf4b0cd18f5c3b381bf5e6b5bf
+  data.tar.gz: 0920be3ca35eece7accba7a99bb8c3fba89dbe70
 SHA512:
-  metadata.gz: 535c2d3ea7abdab5ce70e4031354958ebf1eab6788676215cce6642b875e5871cb6bef12343674a010db05e48b43a0038a93ae8bbb27321de97377626a5bd419
-  data.tar.gz: 2b8825c44c05aaa3dbf24fc82e2d7d42cbcf5cd7ba3c52f654a4afbf0165e9d7877652342483d77d9574528fc04dc25234499e9566935a5d276a2089f4e457fd
+  metadata.gz: 6371877837cc223fb9d7caf8974e2b4f2e640faea4625f4edf081936c4cafab8a323bf7cec516def9b3b93399808288a1a5d828f01f0251d8af0d8eb58bd0a23
+  data.tar.gz: 61d62058d0313dcd163800b3f4209b97118a8fdaaa7fa15722d4cc6c7b2c38b0887e03f53d212c8502ceca09153efff92bc13d00ba93411aa803cb57049b489c

data/Gemfile

@@ -2,7 +2,14 @@ source "http://rubygems.org"
 
 gemspec
 
+platform :rbx do
+  gem 'rubysl', '~> 2.0'
+  gem 'rubysl-test-unit', '~> 2.0'
+  gem 'racc'
+end
+
 group :development, :test do
+  gem 'i18n-tasks'
   gem 'capybara', '>= 0.4.0'
   gem 'rspec', '2.12.0' #, git: 'https://github.com/rspec/rspec'
   gem 'rspec-rails' #, git: 'https://github.com/rspec/rspec-rails'

data/Rakefile

@@ -6,12 +6,16 @@ rescue LoadError
 end
 
 # Load dummy app tasks
-APP_RAKEFILE = File.expand_path('../spec/dummy/Rakefile', __FILE__)
-load 'rails/tasks/engine.rake'
+if ENV['DUMMY']
+  APP_RAKEFILE = File.expand_path('../spec/dummy/Rakefile', __FILE__)
+  load 'rails/tasks/engine.rake'
+end
 
 Bundler::GemHelper.install_tasks
 
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
-task default: :spec
+load 'tasks/i18n-tasks.rake'
+
+task default: :spec

data/app/controllers/rails_email_preview/emails_controller.rb

@@ -1,49 +1,36 @@
 class RailsEmailPreview::EmailsController < ::RailsEmailPreview::ApplicationController
   include ERB::Util
-  before_filter :load_preview_class, except: :index
+  before_filter :load_preview, except: :index
   before_filter :set_email_preview_locale
 
   # list screen
   def index
-    @preview_class_names = (RailsEmailPreview.preview_classes || []).map { |klass| klass.is_a?(String) ? klass : klass.name }.sort
+    @previews = ::RailsEmailPreview::Preview.all
+    @previews_by_class = ::RailsEmailPreview::Preview.all_by_preview_class
   end
 
   # preview screen
   def show
     I18n.with_locale @email_locale do
       @part_type = params[:part_type] || 'text/html'
-      if @preview_class.respond_to?(:new)
-        @mail = preview_mail
+      if @preview.respond_to?(:preview_mail)
+        @mail = @preview.preview_mail
       else
-        raise ArgumentError.new("#{@preview_class} is not a preview class, does not respond_to?(:new)")
+        raise ArgumentError.new("#{@preview} is not a preview class, does not respond_to?(:preview_mail)")
       end
     end
   end
 
   # render actual email content
-  def show_raw
+  def show_body
     I18n.with_locale @email_locale do
-      @mail = preview_mail(edit_links: (@part_type == 'text/html'))
-      RailsEmailPreview.run_before_render(@mail, @preview_class.name, @mail_action)
-      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)
-        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
+      @mail_body = mail_body(@preview, @part_type)
+      render :show_body, layout: 'rails_email_preview/email'
     end
   end
 
   def test_deliver
-    redirect_url = rep_email_url(params.slice(:mail_class, :mail_action, :email_locale))
+    redirect_url = rails_email_preview.rep_email_url(params.slice(:mail_class, :mail_action, :email_locale))
     if (address = params[:recipient_email]).blank? || address !~ /@/
       redirect_to redirect_url, alert: t('rep.test_deliver.provide_email')
       return
@@ -70,24 +57,32 @@ class RailsEmailPreview::EmailsController < ::RailsEmailPreview::ApplicationCont
     end
   end
 
-  def preview_mail(opt = {})
-    RequestStore.store[:rep_edit_links] = true if opt[:edit_links]
-    mail = @preview_class.new.send(@mail_action)
-    mail
+  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
+    RailsEmailPreview.run_before_render(mail, preview)
+    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_part.body.to_s.html_safe
+    end
   end
 
   def set_email_preview_locale
-    @email_locale = (params[:email_locale] || I18n.default_locale).to_s
+    @email_locale = (params[:email_locale] || RailsEmailPreview.default_email_locale || I18n.default_locale).to_s
   end
 
   private
 
-  def load_preview_class
-    @preview_class = (RailsEmailPreview.preview_classes || []).find { |pc|
-      (pc.is_a?(String) ? pc : pc.name).underscore == params[:mail_class]
-    }
-    @preview_class = @preview_class.constantize if @preview_class.is_a?(String)
-    @mail_action = params[:mail_action]
+  def load_preview
+    @preview     = ::RailsEmailPreview::Preview[params[:preview_id]] or raise ActionController::RoutingError.new('Not Found')
     @part_type   = params[:part_type] || 'text/html'
   end
 end

data/app/helpers/rails_email_preview/emails_helper.rb

@@ -1,10 +1,9 @@
 module RailsEmailPreview::EmailsHelper
-  def current_email_name
-    "#{preview_class_human_name}: #{@mail_action.to_s.humanize}"
-  end
 
-  def preview_class_human_name(preview_class = @preview_class)
-    preview_class.to_s.underscore.sub(/(_mailer)?_preview$/, '').humanize
+  MIME_LABELS = { 'text/html' => 'HTML', 'text/plain' => 'Text', 'raw' => 'Raw'}
+
+  def format_label(mime_type)
+    MIME_LABELS[mime_type]
   end
 
   def change_locale_attr(locale)
@@ -46,14 +45,6 @@ module RailsEmailPreview::EmailsHelper
     end
   end
 
-  def email_methods(m)
-    m.constantize.instance_methods(false).map(&:to_s).sort
-  end
-
-  def total_emails
-    @total_emails ||= @preview_class_names.sum { |p| email_methods(p).length }
-  end
-
   def split_in_halves(elements, &weight)
     tot_w  = elements.map(&weight).sum
     cols   = [elements.dup, []]

data/app/models/rails_email_preview/preview.rb

@@ -0,0 +1,71 @@
+module RailsEmailPreview
+  # This class represents an email preview
+  class Preview
+    attr_accessor :id, :preview_class_name, :preview_method
+
+    def initialize(attr = {})
+      attr.each { |k, v| self.send "#{k}=", v }
+    end
+
+    def locales
+      I18n.available_locales
+    end
+
+    def formats
+      %w(text/html text/plain raw)
+    end
+
+    def preview_mail
+      preview_class_name.constantize.new.send(preview_method)
+    end
+
+    def name
+      @name ||= "#{group_name}: #{method_name}"
+    end
+
+    def method_name
+      @action_name ||= preview_method.to_s.humanize
+    end
+
+    def group_name
+      @group_name ||= preview_class_name.to_s.underscore.sub(/(_mailer)?_preview$/, '').humanize
+    end
+
+    class << self
+      def find(email_id)
+        @by_id[email_id]
+      end
+
+      alias_method :[], :find
+
+      attr_reader :all, :all_by_preview_class
+
+      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}-#{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)
+        @all_by_preview_class = @all.group_by(&:preview_class_name)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+doctype html
+= "\n"
+html
+  head
+    css:
+      #message_body, #raw_message {
+        font-family: Monaco, Menlo, Consolas, "Courier New", monospace;
+        word-break: break-word;
+      }
+
+    = yield(:head)
+  body
+    #content.container
+      = render 'layouts/rails_email_preview/flash_notices'
+      = yield

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

@@ -1,5 +1,5 @@
 div class=rep_btn_group_class
-  - { 'text/html' => 'HTML', 'text/plain' => 'Text', 'raw' => 'Raw'}.each do |mime, label|
-    a.btn-xs *change_format_attr(mime)
-      = label
+  - @preview.formats.each do |format|
+    a.btn-xs *change_format_attr(format)
+      = format_label format
 

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

@@ -1,5 +1,5 @@
 div class=rep_btn_group_class
-  - I18n.available_locales.each do |locale|
+  - @preview.locales.each do |locale|
     -# href, active class from change_locale_attr(locale)
     a.btn *change_locale_attr(locale)
       = locale_name(locale)

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

@@ -1,24 +1,17 @@
-h1
-  | #{t '.list_title'}
-
-- previews_group = proc do |m|
-  - capture do
-    h2 = preview_class_human_name(m)
-    ul class=rep_style[:list_group_class]
-      - email_methods(m).each do |method|
-        li class=rep_style[:list_group_item_class]
-          a href=rails_email_preview.rep_email_url(mail_class: m.to_s.underscore, mail_action: method.to_s, email_locale: @email_locale)
-            = method.to_s.humanize
+h1 = t '.list_title'
 
 div class=rep_row_class
-  - split_in_halves(@preview_class_names) { |c| email_methods(c).length }.each do |classes|
+  - split_in_halves(@previews_by_class.keys) { |c| @previews_by_class[c].length }.each do |classes|
     div class=rep_col_class(6)
-      - classes.each do |class_name|
-        = previews_group.call(class_name)
+      - classes.map { |c| @previews_by_class[c] }.each do |previews|
+        h2 = previews[0].group_name
+        div class=rep_style[:list_group_class]
+          - previews.each do |p|
+            a class=rep_style[:list_group_item_class] href=rails_email_preview.rep_email_url(preview_id: p.id, email_locale: @email_locale)
+              = p.method_name
 
 hr
-
 p.text-center.text-small.text-info
-  | #{t 'rep.base.email', count: total_emails} #{t 'rep.base.in'} #{t 'rep.base.mailer', count: @preview_class_names.length }
+  | #{t 'rep.base.email', count: @previews.length} #{t 'rep.base.in'} #{t 'rep.base.mailer', count: @previews_by_class.values.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

@@ -3,7 +3,7 @@
     .pull-left
       ul.breadcrumb
         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
+        li.active: a href=(request.url) = @preview.name
 
   div class=rep_style[:panel_class]
     div class=rep_style[:panel_body_class]

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

@@ -0,0 +1 @@
+= @mail_body

data/config/i18n-tasks.yml

@@ -0,0 +1,6 @@
+base_locale: en
+locales: [en, de]
+
+ignore_eq_base:
+  en,de:
+  - rep.base.in

data/config/routes.rb

@@ -1,9 +1,9 @@
 RailsEmailPreview::Engine.routes.draw do
   get '/' => 'emails#index', as: :rep_emails
 
-  get 'raw/:mail_class/:mail_action' => 'emails#show_raw', as: :rep_raw_email
-  get ':mail_class/:mail_action' => 'emails#show', as: :rep_email
-  post 'test_deliver/:mail_class/:mail_action' => 'emails#test_deliver', as: :rep_test_deliver
+  get 'raw/:preview_id' => 'emails#show_body', as: :rep_raw_email
+  get ':preview_id' => 'emails#show', as: :rep_email
+  post 'test_deliver/:preview_id' => 'emails#test_deliver', as: :rep_test_deliver
 
   # define alias for the root url as part of stable api
   get '/' => 'emails#index', as: :rep_root

data/lib/rails_email_preview.rb

@@ -19,6 +19,9 @@ module RailsEmailPreview
   # auto-loading configured in initializer
   mattr_accessor :preview_classes
 
+  # default email locale
+  mattr_accessor :default_email_locale
+
   # send email button
   mattr_accessor :enable_send_email
   self.enable_send_email = true
@@ -38,6 +41,11 @@ module RailsEmailPreview
   }
 
   class << self
+    def preview_classes=(classes)
+      @preview_classes = classes
+      RailsEmailPreview::Preview.load_all(classes)
+    end
+
     def layout=(layout)
       [::RailsEmailPreview::ApplicationController, ::RailsEmailPreview::EmailsController].each { |ctrl| ctrl.layout layout }
       if layout && layout !~ %r(^rails_email_preview/)
@@ -46,9 +54,9 @@ module RailsEmailPreview
       end
     end
 
-    def run_before_render(mail, preview_class_name, mailer_action)
+    def run_before_render(mail, preview)
       (defined?(@hooks) && @hooks[:before_render] || []).each do |block|
-        block.call(mail, preview_class_name, mailer_action)
+        block.call(mail, preview)
       end
     end
 

data/lib/rails_email_preview/integrations/comfortable_mexica_sofa.rb

@@ -93,10 +93,8 @@ module RailsEmailPreview
         id_prefix = 'email-'
         return unless snippet && snippet.identifier && snippet.identifier.starts_with?(id_prefix)
         mailer_cl, act = snippet.identifier[id_prefix.length..-1].split('-')
-        mailer_cl += '_preview'
-        { mail_class: mailer_cl,
-          mail_action: act,
-          email_locale: snippet.site.locale}
+        { preview_id: "#{mailer_cl}_preview-#{act}",
+          email_locale: snippet.site.locale }
       end
     end
   end
@@ -108,4 +106,4 @@ ActionMailer::Base.module_eval do
 end
 
 require 'comfortable_mexican_sofa'
-ComfortableMexicanSofa::ViewHooks.add :navigation, 'integrations/cms/customize_cms_for_rails_email_preview'
+ComfortableMexicanSofa::ViewHooks.add :navigation, 'integrations/cms/customize_cms_for_rails_email_preview'

data/lib/rails_email_preview/version.rb

@@ -1,3 +1,3 @@
 module RailsEmailPreview
-  VERSION = '0.2.14'
+  VERSION = '0.2.15'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_email_preview
 version: !ruby/object:Gem::Version
-  version: 0.2.14
+  version: 0.2.15
 platform: ruby
 authors:
 - Gleb Mazovetskiy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-22 00:00:00.000000000 Z
+date: 2014-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -95,9 +95,11 @@ files:
 - app/controllers/rails_email_preview/application_controller.rb
 - app/controllers/rails_email_preview/emails_controller.rb
 - app/helpers/rails_email_preview/emails_helper.rb
+- app/models/rails_email_preview/preview.rb
 - app/views/integrations/cms/_customize_cms_for_rails_email_preview.html.slim
 - app/views/layouts/rails_email_preview/_flash_notices.html.slim
 - app/views/layouts/rails_email_preview/application.html.slim
+- app/views/layouts/rails_email_preview/email.html.slim
 - 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
@@ -105,6 +107,7 @@ files:
 - 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
+- app/views/rails_email_preview/emails/show_body.html.slim
 - lib/generators/rails_email_preview/install_generator.rb
 - lib/generators/rails_email_preview/update_previews_generator.rb
 - lib/rails_email_preview/delivery_handler.rb
@@ -113,6 +116,7 @@ files:
 - lib/rails_email_preview/main_app_route_delegator.rb
 - lib/rails_email_preview/version.rb
 - lib/rails_email_preview.rb
+- config/i18n-tasks.yml
 - config/initializers/rails_email_preview.rb
 - config/locales/de.yml
 - config/locales/en.yml
@@ -141,7 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.10
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Preview emails in browser (rails engine)