Add mailer previews feature based on mail_view gem

Author: pixeltrix

actionmailer/CHANGELOG.md

@@ -1,3 +1,7 @@
+*   Add mailer previews feature based on 37 Signals mail_view gem
+
+    *Andrew White*
+
 *   Calling `mail()` without arguments serves as getter for the current mail
     message and keeps previously set headers.
 

actionmailer/lib/action_mailer.rb

@@ -41,6 +41,8 @@ module ActionMailer
   autoload :Base
   autoload :DeliveryMethods
   autoload :MailHelper
+  autoload :Preview
+  autoload :Previews, 'action_mailer/preview'
   autoload :TestCase
   autoload :TestHelper
 end

actionmailer/lib/action_mailer/base.rb

@@ -308,6 +308,25 @@ module ActionMailer
   # Note that unless you have a specific reason to do so, you should prefer using before_action
   # rather than after_action in your ActionMailer classes so that headers are parsed properly.
   #
+  # = Previewing emails
+  #
+  # You can preview your email templates visually by adding a mailer preview file to the
+  # <tt>ActionMailer::Base.preview_path</tt>. Since most emails do something interesting
+  # with database data, you'll need to write some scenarios to load messages with fake data:
+  #
+  #   class NotifierPreview < ActionMailer::Preview
+  #     def welcome
+  #       Notifier.welcome(User.first)
+  #     end
+  #   end
+  #
+  # Methods must return a Mail::Message object which can be generated by calling the mailer
+  # method without the additional <tt>deliver</tt>. The location of the mailer previews
+  # directory can be configured using the <tt>preview_path</tt> option which has a default
+  # of <tt>test/mailers/previews</tt>:
+  #
+  #     config.action_mailer.preview_path = "#{Rails.root}/lib/mailer_previews"
+  #
   # = Configuration options
   #
   # These options are specified on the class level, like
@@ -362,6 +381,7 @@ module ActionMailer
   #   <tt>delivery_method :test</tt>. Most useful for unit and functional testing.
   class Base < AbstractController::Base
     include DeliveryMethods
+    include Previews
 
     abstract!
 

actionmailer/lib/action_mailer/preview.rb

@@ -0,0 +1,67 @@
+require 'active_support/descendants_tracker'
+
+module ActionMailer
+  module Previews #:nodoc:
+    extend ActiveSupport::Concern
+
+    included do
+      # Set the location of mailer previews through app configuration:
+      #
+      #     config.action_mailer.preview_path = "#{Rails.root}/lib/mailer_previews"
+      #
+      class_attribute :preview_path, instance_writer: false
+    end
+  end
+
+  class Preview
+    extend ActiveSupport::DescendantsTracker
+
+    class << self
+      # Returns all mailer preview classes
+      def all
+        load_previews if descendants.empty?
+        descendants
+      end
+
+      # Returns the mail object for the given email name
+      def call(email)
+        preview = self.new
+        preview.public_send(email)
+      end
+
+      # Returns all of the available email previews
+      def emails
+        public_instance_methods(false).map(&:to_s).sort
+      end
+
+      # Returns true if the email exists
+      def email_exists?(email)
+        emails.include?(email)
+      end
+
+      # Returns true if the preview exists
+      def exists?(preview)
+        all.any?{ |p| p.preview_name == preview }
+      end
+
+      # Find a mailer preview by its underscored class name
+      def find(preview)
+        all.find{ |p| p.preview_name == preview }
+      end
+
+      # Returns the underscored name of the mailer preview without the suffix
+      def preview_name
+        name.sub(/Preview$/, '').underscore
+      end
+
+      protected
+        def load_previews #:nodoc:
+          Dir["#{preview_path}/**/*_preview.rb"].each{ |file| require_dependency file }
+        end
+
+        def preview_path #:nodoc:
+          Base.preview_path
+        end
+    end
+  end
+end

actionmailer/lib/action_mailer/railtie.rb

@@ -40,5 +40,13 @@ class Railtie < Rails::Railtie # :nodoc:
         config.compile_methods! if config.respond_to?(:compile_methods!)
       end
     end
+
+    initializer "action_mailer.configure_mailer_previews", before: :set_autoload_paths do |app|
+      if Rails.env.development?
+        options = app.config.action_mailer
+        options.preview_path ||= defined?(Rails.root) ? "#{Rails.root}/test/mailers/previews" : nil
+        app.config.autoload_paths << options.preview_path
+      end
+    end
   end
 end

actionpack/lib/action_dispatch/routing/inspector.rb

@@ -69,7 +69,7 @@ def action
       end
 
       def internal?
-        controller.to_s =~ %r{\Arails/(info|welcome)} || path =~ %r{\A#{Rails.application.config.assets.prefix}}
+        controller.to_s =~ %r{\Arails/(info|mailers|welcome)} || path =~ %r{\A#{Rails.application.config.assets.prefix}}
       end
 
       def engine?

railties/lib/rails.rb

@@ -25,6 +25,7 @@ module Rails
 
   autoload :Info
   autoload :InfoController
+  autoload :MailersController
   autoload :WelcomeController
 
   class << self

railties/lib/rails/application/finisher.rb

@@ -22,6 +22,8 @@ module Finisher
       initializer :add_builtin_route do |app|
         if Rails.env.development?
           app.routes.append do
+            get '/rails/mailers'         => "rails/mailers#index"
+            get '/rails/mailers/*path'   => "rails/mailers#preview"
             get '/rails/info/properties' => "rails/info#properties"
             get '/rails/info/routes'     => "rails/info#routes"
             get '/rails/info'            => "rails/info#index"

railties/lib/rails/generators/test_unit/mailer/mailer_generator.rb

@@ -4,11 +4,18 @@ module TestUnit # :nodoc:
   module Generators # :nodoc:
     class MailerGenerator < Base # :nodoc:
       argument :actions, type: :array, default: [], banner: "method method"
-      check_class_collision suffix: "Test"
+
+      def check_class_collision
+        class_collisions "#{class_name}Test", "#{class_name}Preview"
+      end
 
       def create_test_files
         template "functional_test.rb", File.join('test/mailers', class_path, "#{file_name}_test.rb")
       end
+
+      def create_preview_files
+        template "preview.rb", File.join('test/mailers/previews', class_path, "#{file_name}_preview.rb")
+      end
     end
   end
 end

railties/lib/rails/generators/test_unit/mailer/templates/preview.rb

@@ -0,0 +1,11 @@
+<% module_namespacing do -%>
+class <%= class_name %>Preview < ActionMailer::Preview
+<% actions.each do |action| -%>
+
+  def <%= action %>
+    <%= class_name %>.<%= action %>
+  end
+<% end -%>
+
+end
+<% end -%>