rails_email_preview 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aa7d4eb9873fb41236d985af8f4d4944a6aa7056
-  data.tar.gz: a2b36c22f1f76369e2f400fecda49383fa1f0dfa
+  metadata.gz: 52a17e3d36b0d7cf89ee5d5cd203f46c24710a36
+  data.tar.gz: 3e80c0aa0452d9048e2325e2fb16fd18aa0ac32a
 SHA512:
-  metadata.gz: 67f0eb7c5cb4ad07bd3f991aa0cc8c000a67d56982c140cc46a70a5674e75aa125096d6ac1ee376a8d00d1923bfd20ca0aad4e1724b71a1efff8ccaf8fce2b3f
-  data.tar.gz: af01ce4227f49d190fb846a1152e5ecf611b69397b0fa1d40eedfb5c7727bbced5d741cec44e951ab872c5ed211a4a198bf9e6a994cfa3f9b4d0d06b49cb4ba7
+  metadata.gz: 0f33ae9252698108f4e03fb383239d777e96fad40abbf390f1fdfda54fbed1d54f95c2935c002386444d0d8270655a18326f5ed14b385d2b1a3a6925b579abc4
+  data.tar.gz: 59faa202e37281f126da6813783b6297267b4d3b5ae9f09bcaa7ba875f6000a467aa3654b8d632a57fbd093c1d54c75613bc723621e2bc30918bdc953475f8c5

data/README.md

@@ -10,21 +10,22 @@ A Rails Engine to preview plain text and html email in your browser. Compatible
 How to
 -----
 
-You will need to provide data for preview of each email:
+Add to Gemfile
 
-    # Say you have this mailer
-    class UserMailer < ActionMailer::Base
-      def invitation(inviter, invitee)
-        # ...
-      end
+    gem 'rails_email_preview'
 
-      def welcome(user)
-        # ...
-      end
-    end
+Run generators
+
+  # Add initializer and route
+  rails g rails_email_preview:install
+
+  # Generate preview classes and method stubs in app/mailer_previews/
+  rails g rails_email_preview:update_previews
+
+You will need to provide data for preview of each email:
 
-    # Define a Preview class with the same mail action names, but with no arguments
-    # mkdir -p app/mailer_previews/; touch app/mailer_previews/user_mailer_preview.rb
+    # Say there is a UserMailer with 2 actions
+    # in app/mailer_previews/user_mailer_preview.rb initialize the emails for preview:
     class UserMailerPreview
       # preview methods should return Mail objects, e.g.:
       def invitation        
@@ -36,24 +37,24 @@ You will need to provide data for preview of each email:
       end
       
       private
+      # You can put all your mock helpers in a module
+      # Or, if you have factories/fabricators for your tests you could use those, but be careful not to create anything!
       def mock_user(name = 'Bill Gates')
-        User.new(name: name, email: "user@test.com#{rand 100}").tap { |u| u.define_singleton_method(:id) { 123 + rand(100) } }      
+        fake_id User.new(name: name, email: "user#{rand 100}@test.com")
+      end
+
+      def fake_id(obj)
+        obj.define_singleton_method(:id) { 123 + rand(100) }
+        obj
       end
-    end
-    
-    # Let REP know about UserMailerPreview:
-    # touch config/initializers/rails_email_preview.rb    
-    RailsEmailPreview.setup do |config|
-      config.preview_classes = %w( UserMailerPreview )
     end
 
 
 Routing
 -------
-    
-    mount RailsEmailPreview::Engine, at: 'emails' 
-    
-    # You can access REP urls like this:
+
+You can access REP urls like this:
+
     rails_email_preview.root_url #=> '/emails'
     
 Email editing 

data/app/controllers/rails_email_preview/emails_controller.rb

@@ -12,7 +12,17 @@ class RailsEmailPreview::EmailsController < RailsEmailPreview::ApplicationContro
   def show
     I18n.with_locale @email_locale do
       @part_type = params[:part_type] || 'text/html'
-      @mail      = @preview_class.new.send(params[:mail_action])
+      if @preview_class.respond_to?(:new)
+        @mail = @preview_class.new.send(params[:mail_action])
+      else
+        # @preview_class is not a preview class
+        arg_info = "#{@preview_class}"
+        if @preview_class.is_a?(Module)
+          chain = @preview_class.ancestors.map(&:to_s)
+          chain = chain[1 .. chain.index { |c| c =~ /^Application[A-Z][A-z]+$/ } || -1]
+        end
+        raise ArgumentError.new("#{arg_info} is not a preview class #{"(ancestors: #{chain * ' < '})"} ")
+      end
     end
     render
   end
@@ -42,7 +52,7 @@ class RailsEmailPreview::EmailsController < RailsEmailPreview::ApplicationContro
   protected
 
   def set_email_preview_locale
-    @email_locale = (params[:email_locale] || I18n.locale).to_s
+    @email_locale = (params[:email_locale] || I18n.default_locale).to_s
   end
 
   private

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

@@ -7,14 +7,15 @@ javascript:
       $('.center-column').css('margin', 0);
 
       // Snippet form:
-      var control = function(name) { return $('[name="snippet[' + name + ']"]').closest('.control-group'); };
+      var control = function(name) { return $('[name^="snippet[' + name + ']"]').closest('.control-group'); };
 
+      // retext labels
       control('label').find('.control-label').text("Subject");
       control('content').find('.control-label').text("Body");
 
-      // Hide identifier and categories
+      // hide identifier and categories
       control('identifier').hide();
-      $('label[for="snippet_"]').closest('.control-group').hide();
+      control('category_ids').hide()
 
       // Do not mess with identifier
       $('[data-slug]').removeAttr('data-slug');

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

@@ -1,14 +1,14 @@
 ruby:
   headers = {
-    'From'    => @mail.from,
-    'To'      => @mail.to,
-    'CC'      => @mail.cc,
-    'BCC'     => @mail.bcc,
-    'Subject' => @mail.subject || '(no subject)'
+    'From'     => @mail.from,
+    'To'       => @mail.to,
+    'Reply to' => @mail.reply_to,
+    'CC'       => @mail.cc,
+    'BCC'      => @mail.bcc,
+    'Subject'  => @mail.subject || '(no subject)'
   }.delete_if { |k, v| v.blank? }
 
 
-
 dl
   - headers.each do |header, value|
     dt #{header}

data/config/initializers/rails_email_preview.rb

@@ -0,0 +1,29 @@
+require 'rails_email_preview'
+
+# Add this to process preview with premailer-rails
+# RailsEmailPreview.before_render { |message| Premailer::Rails::Hook.delivering_email(message) }
+
+# with actionmailer-inline-css
+# RailsEmailPreview.before_render { |message| ActionMailer::InlineCssHook.delivering_email(message) }
+
+Rails.application.config.to_prepare do
+  # Choose where to 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/lib/generators/rails_email_preview/install_generator.rb

@@ -0,0 +1,18 @@
+module RailsEmailPreview
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc "creates an initializer file at config/initializers/rails_email_preview.rb and adds REP route to config/routes.rb"
+      source_root File.expand_path('../../../..', __FILE__)
+
+      def generate_initialization
+        copy_file 'config/initializers/rails_email_preview.rb', 'config/initializers/rails_email_preview.rb'
+      end
+
+      def generate_routing
+        route "mount RailsEmailPreview::Engine, at: 'emails'"
+        log "# You can access REP urls like this:
+rails_email_preview.root_url #=> '/emails'"
+      end
+    end
+  end
+end

data/lib/generators/rails_email_preview/update_previews_generator.rb

@@ -0,0 +1,45 @@
+module RailsEmailPreview
+  module Generators
+    class UpdatePreviewsGenerator < Rails::Generators::Base
+      desc "creates app/mailer_previews/NEW_MAILER_preview.rb for each new mailer"
+      def generate_mailer_previews
+        previews_dir = 'app/mailer_previews/'
+        empty_directory previews_dir
+        Dir['app/mailers/*.rb'].each do |p|
+          basename = File.basename(p, '.rb')
+          if basename == 'application_mailer' || File.read(p) !~ /\bdef\s/
+            shell.say_status :skip, basename, :blue
+            next
+          end
+          preview_path = File.join(previews_dir, "#{basename}_preview.rb")
+          if File.exists?(preview_path)
+            shell.say_status :exist, preview_path, :blue
+            next
+          end
+          create_file preview_path, mailer_class_body(basename.camelize)
+        end
+      end
+
+      private
+
+      def mailer_class_body(mailer_class_name)
+<<-RUBY
+class #{mailer_class_name}Preview
+#{mailer_methods(mailer_class_name) * "\n\n"}
+end
+RUBY
+      end
+
+      def mailer_methods(mailer_class_name)
+        mailer_class = mailer_class_name.constantize
+        mailer_class.instance_methods(false).map do |m|
+<<-RUBY
+  def #{m}
+    #{mailer_class_name}.#{m.to_s} #{mailer_class.instance_method(m).parameters.map(&:second) * ', '}
+  end
+RUBY
+        end
+      end
+    end
+  end
+end

data/lib/rails_email_preview/engine.rb

@@ -1,6 +1,7 @@
 module ::RailsEmailPreview
   class Engine < Rails::Engine
     isolate_namespace RailsEmailPreview
+    load_generators
 
     class << self
       attr_accessor :root

data/lib/rails_email_preview/version.rb

@@ -1,3 +1,3 @@
 module RailsEmailPreview
-  VERSION = '0.1.5'
+  VERSION = '0.1.6'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_email_preview
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Gleb Mazovetskiy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-12 00:00:00.000000000 Z
+date: 2013-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -66,6 +66,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |-
   Implemented as a rails engine with a simple UI for previewing your app emails,
   I18n support, easy premailer integration and editing integration via comfortable_mexican_sofa CMS.
@@ -85,10 +99,13 @@ files:
 - app/views/rails_email_preview/emails/_options.html.slim
 - app/views/rails_email_preview/emails/index.html.slim
 - app/views/rails_email_preview/emails/show.html.slim
+- lib/generators/rails_email_preview/install_generator.rb
+- 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/version.rb
 - lib/rails_email_preview.rb
+- config/initializers/rails_email_preview.rb
 - config/routes.rb
 - MIT-LICENSE
 - Rakefile