rails_email_preview 0.1.7 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 29c1a27975a3c37570a310cd5fd8fab3efa66c28
-  data.tar.gz: 254f09df4a0fe63b6e16c6f77d30fcea0fb0cada
+  metadata.gz: b9ef1fc8ffd22f2ccd7e15c77984a3daa0ac5acd
+  data.tar.gz: d456a66d74d63d7dea3ad69a0e640b2cc2496e92
 SHA512:
-  metadata.gz: 12ed93d3d7351dae246a430f2fd06ed69e9a6262b0d2dee452e8f2d24816ce3da2cc4f2e7057dd2feb3c08aa23712beff13107563c0325462b6d7bd79a3529c6
-  data.tar.gz: 65ca94712efcebb5e8200a7784831f73f6782dd15b0f0b8e2737e22c4cfbfa6a4f2b707942e0da9152d7441b089614eac2f5415734828dae1e04d1c1fd964003
+  metadata.gz: 5e86ba0b33764680726530b9fe0061997d0b9fd3ddcf6b7502a811b160ebd0b03b7d6296f493db2a18a92199f81a552969c1d5598d5a00f830746d844dfc96f3
+  data.tar.gz: cbcb488141a9ff3249074e6a01e632ab00fa0d01cc399999ce735785b3267226af226d7c7b630034939fdf6c722cf0a46ce8c228bce3aa97f839746e384c48ca

data/Gemfile

@@ -2,5 +2,9 @@ source "http://rubygems.org"
 
 gemspec
 
-gem "capybara", ">= 0.4.0"
-gem "sqlite3"
+group :development, :test do
+  gem "capybara", ">= 0.4.0"
+  gem "sqlite3"
+  # a debugger that works with MRI 2.0.0
+  gem 'byebug', platforms: :ruby_20
+end

data/README.md

@@ -12,7 +12,7 @@ How to
 
 Add to Gemfile
 
-    gem 'rails_email_preview', '~> 0.1.7'
+    gem 'rails_email_preview', '~> 0.2.0'
 
 REP handles setup for you:
 
@@ -55,32 +55,29 @@ Routing
 
 You can access REP urls like this:
 
-    rails_email_preview.root_url #=> '/emails'
-    
+    # 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")
+
 Email editing 
 -------------
 
 You can use [comfortable_mexican_sofa](https://github.com/comfy/comfortable-mexican-sofa) for storing and editing emails.
-REP comes with a CMS integration, see [ComfortableMexicanSofa integration guide](https://github.com/glebm/rails_email_preview/wiki/Edit-Emails-with-Comfortable-Mexican-Sofa).
+REP comes with an integration for it -- see [CMS Guide](https://github.com/glebm/rails_email_preview/wiki/Edit-Emails-with-Comfortable-Mexican-Sofa).
 
 ![CMS integration screenshot](http://screencloud.net//img/screenshots/b000595dbd13ae061373fd1473f113ba.png)
 
 
-Premailer integration
+Premailer
 ---------------------
 
 [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).
-
-For [actionmailer_inline_css](https://github.com/ndbroadbent/actionmailer_inline_css), add to `RailsEmailPreview.setup`:
-    
-    config.before_render { |message| ActionMailer::InlineCssHook.delivering_email(message) }    
-
-For [premailer-rails](https://github.com/fphilipe/premailer-rails), add to `RailsEmailPreview.setup`:
-    
-    config.before_render { |message| Premailer::Rails::Hook.delivering_email(message) }    
-
+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`*
 
 I18n
 -------------
@@ -102,30 +99,31 @@ Views
 
 You can render all REP views inside your own layout:
 
-    Rails.application.config.to_prepare do
-      RailsEmailPreview::ApplicationController.layout 'admin'      
-    end
-
-When using a layout other than the default, that layout has to access all route helpers via `main_app`, e.g. `main_app.login_url`.
-This is due to how [isolated engines](http://edgeapi.rubyonrails.org/classes/Rails/Engine.html#label-Isolated+Engine) work in Rails.
-
-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`.
-
-*Pull requests adding view hooks are welcome!*
+    # # Use admin layout with REP:
+    # RailsEmailPreview::ApplicationController.layout 'admin'
+    # # If you are using a custom layout, you will want to make app routes available to REP:
+    # Rails.application.config.to_prepare { RailsEmailPreview.inline_main_app_routes! }
 
+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.
 
 Authentication & authorization
 ------------------------------
 
-To only allow certain users view emails add a before filter to `RailsEmailPreview::ApplicationController`, e.g.:
+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:
+
+    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_permissions
+        before_filter :check_rep_permissions
       
         private
-        def check_permissions
-           render status: 403 unless current_user.try(:admin?)
+        def check_rep_permissions
+           render status: 403 unless current_user && can_manage_emails?(current_user)
         end
       end
     end 

data/app/controllers/rails_email_preview/application_controller.rb

@@ -1,5 +1,5 @@
 module RailsEmailPreview
-  class ApplicationController < ::ApplicationController
+  class ApplicationController < ::RailsEmailPreview.parent_controller.constantize
 
   end
-end
+end

data/app/controllers/rails_email_preview/emails_controller.rb

@@ -1,4 +1,4 @@
-class RailsEmailPreview::EmailsController < RailsEmailPreview::ApplicationController
+class RailsEmailPreview::EmailsController < ::RailsEmailPreview::ApplicationController
   include ERB::Util
   before_filter :load_preview_class, except: :index
   before_filter :set_email_preview_locale

data/app/helpers/rails_email_preview/rep_urls_helper.rb

@@ -0,0 +1,10 @@
+module RepUrlsHelper
+  # to make it easy to change root url without breaking backwards compatibility, declare them here as aliases
+  def rep_root_url
+    rails_email_preview.rep_emails_url
+  end
+
+  def rep_root_path
+    rails_email_preview.rep_emails_path
+  end
+end

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

@@ -12,5 +12,5 @@ javascript:
   }
 
 pre#loading-el.lead #{icon 'spinner', 'spin'} Loading...
-iframe#src-iframe[src=rails_email_preview.raw_email_url(params.slice(:mail_class, :mail_action, :part_type).merge(email_locale: @email_locale))
+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"]

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

@@ -1,9 +1,9 @@
 p.btn-group
   - { 'text/html' => 'HTML', 'text/plain' => 'Text', 'raw' => 'Raw'}.each do |mime, label|
-    a.btn.btn-link href=rails_email_preview.email_url(params.merge(part_type: mime)) class=('active' if @part_type == mime)
+    a.btn.btn-link href=rails_email_preview.rep_email_url(params.merge(part_type: mime)) class=('active' if @part_type == mime)
       = label
 br
 p.btn-group
   - I18n.available_locales.each do |locale|
-    a.btn.btn-link href=rails_email_preview.email_url(params.merge(part_type: @part_type, email_locale: locale)) class=('active' if @email_locale == locale.to_s)
+    a.btn.btn-link href=rails_email_preview.rep_email_url(params.merge(part_type: @part_type, email_locale: locale)) class=('active' if @email_locale == locale.to_s)
       = locale

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

@@ -6,5 +6,5 @@ ul.list-unstyled
       ul.list-group
         - m.constantize.instance_methods(false).map(&:to_s).each do |method|
           li.list-group-item
-            a href=rails_email_preview.email_url(mail_class: m.to_s.underscore, mail_action: method.to_s, email_locale: @email_locale)
+            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

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

@@ -1,4 +1,4 @@
-a.btn.btn-link href=rails_email_preview.root_url(email_locale: @email_locale) « Back to list
+a.btn.btn-link href=rails_email_preview.rep_emails_url(email_locale: @email_locale) « Back to list
 
 #email-show
   -# email format and language

data/config/initializers/rails_email_preview.rb

@@ -1,29 +1,31 @@
 require 'rails_email_preview'
 
-# Add this to process preview with premailer-rails
+#= Premailer
+#
+# # process preview with premailer-rails:
 # RailsEmailPreview.before_render { |message| Premailer::Rails::Hook.delivering_email(message) }
-
-# with actionmailer-inline-css
+# # process preview with actionmailer-inline-css:
 # RailsEmailPreview.before_render { |message| ActionMailer::InlineCssHook.delivering_email(message) }
 
+#= Comfortable Mexican Sofa
+#
+# # enable comfortable_mexican_sofa integration:
+# require 'rails_email_preview/integrations/comfortable_mexica_sofa'
+
+#= Application-specific
+#
+# # You can specify a controller for RailsEmailPreview::ApplicationController to inherit from:
+# RailsEmailPreview.parent_controller = 'Admin::ApplicationController' # default: '::ApplicationController'
+#
+# # Render REP inside a custom layout (set to 'application' to use app layout, default is REP's own layout)
+# RailsEmailPreview::ApplicationController.layout 'admin'
+
 Rails.application.config.to_prepare do
-  # Choose where to load preview_classes from:
+  # # If you use a *custom layout*, make route helpers available to REP:
+  # RailsEmailPreview.inline_main_app_routes!
+
+  # Auto-load preview classes from:
   RailsEmailPreview.preview_classes = Dir['app/mailer_previews/*_preview.rb'].map { |p|
     File.basename(p, '.rb').camelize
   }
-
-  # Use a custom layout
-  # RailsEmailPreview::ApplicationController.layout 'admin'
-
-  # Add authorization
-  # RailsEmailPreview::ApplicationController.module_eval do
-  #   before_filter :check_permissions
-  #   private
-  #   def check_permissions
-  #     render status: 403 unless current_user.try(:admin?)
-  #   end
-  # end
 end
-
-# Uncomment this to enable comfortable_mexican_sofa integration
-# require 'rails_email_preview/integrations/comfortable_mexica_sofa'

data/config/routes.rb

@@ -1,11 +1,9 @@
 RailsEmailPreview::Engine.routes.draw do
-  root :to => 'emails#index'
-  get 'raw/:mail_class/:mail_action',
-        :as => :raw_email,
-        :to => 'emails#show_raw',
-        :mail_class => %r([\w/]+)
-  get ':mail_class/:mail_action',
-        :as => :email,
-        :to => 'emails#show',
-        :mail_class => %r([\w/]+)
+  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
+
+  # define alias for the root url as part of stable api
+  get '/' => 'emails#index', as: :rep_root
 end

data/lib/generators/rails_email_preview/install_generator.rb

@@ -10,8 +10,7 @@ module RailsEmailPreview
 
       def generate_routing
         route "mount RailsEmailPreview::Engine, at: 'emails'"
-        log "# You can access REP urls like this:
-rails_email_preview.root_url #=> '/emails'"
+        log "# You can access REP urls like this: rails_email_preview.rep_emails_url #=> '/emails'"
       end
     end
   end

data/lib/rails_email_preview.rb

@@ -1,6 +1,13 @@
 require 'rails_email_preview/engine'
+require 'rails_email_preview/main_app_route_delegator'
+require 'rails_email_preview/version'
 
 module RailsEmailPreview
+
+  mattr_accessor :parent_controller
+  self.parent_controller = '::ApplicationController'
+
+  # auto-loading configured in initializer
   mattr_accessor :preview_classes
 
   class << self
@@ -14,6 +21,10 @@ module RailsEmailPreview
       ((@hooks ||= {})[:before_render] ||= []) << block
     end
 
+    def inline_main_app_routes!
+      ::RailsEmailPreview::ApplicationController.helper ::RailsEmailPreview::MainAppRouteDelegator
+    end
+
     def setup
       yield self
     end
@@ -22,7 +33,7 @@ module RailsEmailPreview
   # = Editing settings
   # edit link is rendered inside an iframe, so these options are provided for simple styling
   mattr_accessor :edit_link_text
-  self.edit_link_text  = '✎ Edit Text'
+  self.edit_link_text = '✎ Edit Text'
   mattr_accessor :edit_link_style
   self.edit_link_style = <<-CSS.strip.gsub(/\n+/m, ' ')
   display: block;

data/lib/rails_email_preview/main_app_route_delegator.rb

@@ -0,0 +1,14 @@
+module RailsEmailPreview::MainAppRouteDelegator
+  # delegate url helpers to main_app
+  def method_missing(method, *args, &block)
+    if method.to_s =~ /_(?:path|url)$/ && main_app.respond_to?(method)
+      main_app.send(method, *args)
+    else
+      super
+    end
+  end
+
+  def respond_to?(method)
+    super || main_app.respond_to?(method)
+  end
+end

data/lib/rails_email_preview/version.rb

@@ -1,3 +1,3 @@
 module RailsEmailPreview
-  VERSION = '0.1.7'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_email_preview
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.2.0
 platform: ruby
 authors:
 - Gleb Mazovetskiy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-14 00:00:00.000000000 Z
+date: 2013-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -106,6 +106,7 @@ 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/helpers/rails_email_preview/rep_urls_helper.rb
 - app/views/integrations/cms/_customize_cms_for_rails_email_preview.html.slim
 - app/views/layouts/rails_email_preview/application.html.slim
 - app/views/rails_email_preview/emails/_email_iframe.html.slim
@@ -117,6 +118,7 @@ files:
 - lib/generators/rails_email_preview/update_previews_generator.rb
 - lib/rails_email_preview/engine.rb
 - 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.rb
 - config/initializers/rails_email_preview.rb