rails_email_preview 0.2.6 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cdd99b26068ba1bed5683224775565b4542a3b82
-  data.tar.gz: fa1c1a594e220635f6c90cc8127d88f6c4ed86ef
+  metadata.gz: 737f667f2755587a5e1058c0b23ebd67f2b1b9cb
+  data.tar.gz: 0501a6d93155acc2cd89b7c7d2d8c50fa28ff92b
 SHA512:
-  metadata.gz: d33f26c046cf0ffe23c0cdc040ce2dcb2df2ffe3aad97ce82a4ba96bbf5a2334de544be8581fded6032930d8986174c85b484605379468803aad846eb1e52d6c
-  data.tar.gz: 565a76ef4e8231d9090e489afa51886b5233ee8f8510e40ec59ac58d090c21a2be07ca8fbbf473d12ead45f954dce2013e559f8a0afe776068a074cb681dc506
+  metadata.gz: 70d12a90a5f9a4988fc4374ef33011f88ccd8905d3c505c9f70567549720251fe93fb5e00419cfc5e3c01d637bca5e38db0154006976daadd05332d700a4fac4
+  data.tar.gz: d27179e2f3e89963fe4005a48cdfb53d84aa36c10352f88ec972fbb62813e4d3d4b5910659e920cbd0b768cae3014261299adcbed93fb10b26084555f32602e6

data/README.md

@@ -9,7 +9,7 @@ Preview:
 List:
 ![screenshot][rep-nav-screenshot]
 
-REP can use the application styles and comes with a [simple look][rep-show-default-screenshot] by default (default markup for [twbs/bootstrap](twbs/bootstrap) 3).
+REP can use the application styles and comes with [simple styles][rep-show-default-screenshot] by default (default markup for [twbs/bootstrap](twbs/bootstrap) 3).
 *These screenshots are from [Zuigo](http://zuigo.com/), a platform to organize & discover events; using REP default markup and app styles*
 
 How to
@@ -17,7 +17,7 @@ How to
 
 Add to Gemfile
 
-    gem 'rails_email_preview', '~> 0.2.0'
+    gem 'rails_email_preview', '~> 0.2'
 
 REP handles setup for you:
 
@@ -116,7 +116,24 @@ If you are using `Resque::Mailer` or `Devise::Async`, you can automatically add
 Views
 ---------------------
 
-You can render all REP views inside your own layout:
+REP allows you to customize some of the 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}'
+    }
+
+E.g., to change column class from `col-` to `column-` everywhere where REP uses columns:
+
+    RailsEmailPreview.style[:column_class] = 'column-%{n}'
+
+If you want to really integrate REP, ou can render all its views inside your own layout (this will need styling to look nice if you don't use bootstrap):
 
     # # Use admin layout with REP:
     # RailsEmailPreview::ApplicationController.layout 'admin'

data/app/helpers/rails_email_preview/emails_helper.rb

@@ -9,12 +9,12 @@ module RailsEmailPreview::EmailsHelper
 
   def change_locale_attr(locale)
     {href:  rails_email_preview.rep_email_url(params.merge(part_type: @part_type, email_locale: locale)),
-     class: ('active btn-primary' if @email_locale == locale.to_s)}
+     class: rep_btn_class(@email_locale == locale.to_s)}
   end
 
   def change_format_attr(mime)
     {href: rails_email_preview.rep_email_url(params.merge(part_type: mime)),
-     class: ('active btn-primary' if @part_type == mime)}
+     class: rep_btn_class(@part_type == mime)}
   end
 
   def locale_name(locale)
@@ -67,4 +67,25 @@ module RailsEmailPreview::EmailsHelper
     cols[1].reverse!
     cols
   end
+
+  # style
+  def rep_style
+    RailsEmailPreview.style
+  end
+
+  def rep_btn_class(active = false)
+    rep_style[:"btn_#{active ? 'active' : 'default'}_class"]
+  end
+
+  def rep_row_class
+    rep_style[:row_class]
+  end
+
+  def rep_col_class(n)
+    rep_style[:column_class] % {n: n}
+  end
+
+  def rep_btn_group_class
+    rep_style[:btn_group_class]
+  end
 end

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

@@ -1,11 +1,9 @@
 -# When rendering inside rails_email_preview hide nav, and hide irrelevant things from the form
 ruby:
-  prefix = 'email-'
-  if @snippet && @snippet.identifier.try(:start_with?, prefix) && %w(new edit create update).include?(params[:action])
-    url_params = {part_type: 'text/html'}
-    url_params[:mail_class], url_params[:mail_action] = @snippet.identifier[prefix.length..-1].split('-')
-    url_params[:mail_class] += '_preview'
-    show_url = rails_email_preview.rep_raw_email_url url_params
+  snippet = @snippet || @record.is_a?(Cms::Snippet) && @record
+  if snippet
+    p = ::RailsEmailPreview::Integrations::ComfortableMexicanSofa.rep_email_params_from_snippet(snippet)
+    show_url = rails_email_preview.rep_raw_email_url(p.merge part_type: 'text/html')
   end
 javascript:
   jQuery(function($) {
@@ -15,7 +13,7 @@ javascript:
       $('.center-column').css('margin', 0);
       $('.page-header h2').html(
         "Editing email" +
-        " <a href='#{show_url}'>#{t 'rep.view_link'}</a>"
+        " <a class='btn btn-primary' href='#{show_url}'>#{t 'rep.view_link'}</a>"
       )
 
       // Snippet form:

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

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

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

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

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

@@ -4,15 +4,15 @@ h1
 - previews_group = proc do |m|
   - capture do
     h2 = preview_class_human_name(m)
-    ul.list-group
+    ul class=rep_style[:list_group_class]
       - email_methods(m).each do |method|
-        li.list-group-item
+        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
 
-.row
+div class=rep_row_class
   - split_in_halves(@preview_class_names) { |c| email_methods(c).length }.each do |classes|
-    .col-sm-6.col-lg-6
+    div class=rep_col_class(6)
       - classes.each do |class_name|
         = previews_group.call(class_name)
 

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

@@ -1,19 +1,21 @@
 .rep-email-show#email-show
-  .row
+  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.active: a href=(request.url) = current_email_name
 
-  .panel: .row
-    -# From, To, Subject and other headers
-    .col-8= render 'rails_email_preview/emails/headers'
-
-    -# Locale, format and actions
-    .col-4: ul.list-unstyled.text-right.rep-email-options
-      li= render 'rails_email_preview/emails/i18n_nav'
-      li= render 'rails_email_preview/emails/send_form' if RailsEmailPreview.enable_send_email
-      li= render 'rails_email_preview/emails/format_nav'
+  div class=rep_style[:panel_class]
+    div class=rep_style[:row_class]
+      -# From, To, Subject and other headers
+      div class=rep_col_class(8)
+        = render 'rails_email_preview/emails/headers'
+      -# Locale, format and actions
+      div class=rep_col_class(4)
+        ul.list-unstyled.text-right.rep-email-options
+          li= render 'rails_email_preview/emails/i18n_nav'
+          li= render 'rails_email_preview/emails/send_form' if RailsEmailPreview.enable_send_email
+          li= render 'rails_email_preview/emails/format_nav'
 
   -# actual email content, rendered in an iframe to prevent browser styles from interfering
   .margin-right

data/lib/rails_email_preview.rb

@@ -20,6 +20,19 @@ module RailsEmailPreview
   mattr_accessor :enable_send_email
   self.enable_send_email = true
 
+  # some easy visual settings
+  mattr_accessor :style
+  self.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}'
+  }
+
   class << self
     def run_before_render(mail, preview_class_name, mailer_action)
       (defined?(@hooks) && @hooks[:before_render] || []).each do |block|

data/lib/rails_email_preview/integrations/comfortable_mexica_sofa.rb

@@ -18,15 +18,15 @@ module RailsEmailPreview
       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(locale)
+          site    = Cms::Site.find_by_locale(locale)
           snippet = site.snippets.find_by_identifier(snippet_id)
           next unless snippet.try(:content).present?
 
           # interpolate even if keys/values are missing
-          title = snippet.label.to_s
+          title         = snippet.label.to_s
           interpolation = interpolation.stringify_keys
           # set all missing values to ''
-          title.scan(/%{([^}]+)}/) { |m| interpolation[m[0]] ||= ''}
+          title.scan(/%{([^}]+)}/) { |m| interpolation[m[0]] ||= '' }
           # remove all missing keys
           subject = title % interpolation.symbolize_keys.delete_if { |k, v| title !~ /%{#{k}}/ }
 
@@ -60,7 +60,7 @@ module RailsEmailPreview
 
           cms_path = if snippet
                        unless content
-                         fallback_snippet = default_site.snippets.find_by_identifier(snippet_id)
+                         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,
@@ -84,6 +84,16 @@ module RailsEmailPreview
       def cms_edit_email_snippet_link(path)
         link_to(RailsEmailPreview.edit_link_text, path, style: RailsEmailPreview.edit_link_style.html_safe, 'onClick' => '')
       end
+
+      def self.rep_email_params_from_snippet(snippet)
+        id_prefix = 'email-'
+        return unless snippet && 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}
+      end
     end
   end
 end

data/lib/rails_email_preview/version.rb

@@ -1,3 +1,3 @@
 module RailsEmailPreview
-  VERSION = '0.2.6'
+  VERSION = '0.2.7'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_email_preview
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.7
 platform: ruby
 authors:
 - Gleb Mazovetskiy