Add mailer previews feature based on mail_view gem

1 files changed, 388 insertions, 0 deletions

diff --git a/railties/test/application/mailer_previews_test.rb b/railties/test/application/mailer_previews_test.rb
new file mode 100644
index 0000000000..14abb33cc6
--- /dev/null
+++ b/railties/test/application/mailer_previews_test.rb
@@ -0,0 +1,388 @@
+require 'isolation/abstract_unit'
+require 'rack/test'
+module ApplicationTests
+  class MailerPreviewsTest < ActiveSupport::TestCase
+    include ActiveSupport::Testing::Isolation
+    include Rack::Test::Methods
+
+    def setup
+      build_app
+      boot_rails
+    end
+
+    def teardown
+      teardown_app
+    end
+
+    test "/rails/mailers is accessible in development" do
+      app("development")
+      get "/rails/mailers"
+      assert_equal 200, last_response.status
+    end
+
+    test "/rails/mailers is not accessible in production" do
+      app("production")
+      get "/rails/mailers"
+      assert_equal 404, last_response.status
+    end
+
+    test "mailer previews are loaded from the default preview_path" do
+      mailer 'notifier', <<-RUBY
+        class Notifier < ActionMailer::Base
+          default from: "from@example.com"
+
+          def foo
+            mail to: "to@example.org"
+          end
+        end
+      RUBY
+
+      text_template 'notifier/foo', <<-RUBY
+        Hello, World!
+      RUBY
+
+      mailer_preview 'notifier', <<-RUBY
+        class NotifierPreview < ActionMailer::Preview
+          def foo
+            Notifier.foo
+          end
+        end
+      RUBY
+
+      app('development')
+
+      get "/rails/mailers"
+      assert_match '<h3><a href="/rails/mailers/notifier">Notifier</a></h3>', last_response.body
+      assert_match '<li><a href="/rails/mailers/notifier/foo">foo</a></li>', last_response.body
+    end
+
+    test "mailer previews are loaded from a custom preview_path" do
+      add_to_config "config.action_mailer.preview_path = '#{app_path}/lib/mailer_previews'"
+
+      mailer 'notifier', <<-RUBY
+        class Notifier < ActionMailer::Base
+          default from: "from@example.com"
+
+          def foo
+            mail to: "to@example.org"
+          end
+        end
+      RUBY
+
+      text_template 'notifier/foo', <<-RUBY
+        Hello, World!
+      RUBY
+
+      app_file 'lib/mailer_previews/notifier_preview.rb', <<-RUBY
+        class NotifierPreview < ActionMailer::Preview
+          def foo
+            Notifier.foo
+          end
+        end
+      RUBY
+
+      app('development')
+
+      get "/rails/mailers"
+      assert_match '<h3><a href="/rails/mailers/notifier">Notifier</a></h3>', last_response.body
+      assert_match '<li><a href="/rails/mailers/notifier/foo">foo</a></li>', last_response.body
+    end
+
+    test "mailer previews are reloaded across requests" do
+      app('development')
+
+      get "/rails/mailers"
+      assert_no_match '<h3><a href="/rails/mailers/notifier">Notifier</a></h3>', last_response.body
+
+      mailer 'notifier', <<-RUBY
+        class Notifier < ActionMailer::Base
+          default from: "from@example.com"
+
+          def foo
+            mail to: "to@example.org"
+          end
+        end
+      RUBY
+
+      text_template 'notifier/foo', <<-RUBY
+        Hello, World!
+      RUBY
+
+      mailer_preview 'notifier', <<-RUBY
+        class NotifierPreview < ActionMailer::Preview
+          def foo
+            Notifier.foo
+          end
+        end
+      RUBY
+
+      get "/rails/mailers"
+      assert_match '<h3><a href="/rails/mailers/notifier">Notifier</a></h3>', last_response.body
+
+      remove_file 'test/mailers/previews/notifier_preview.rb'
+      sleep(1)
+
+      get "/rails/mailers"
+      assert_no_match '<h3><a href="/rails/mailers/notifier">Notifier</a></h3>', last_response.body
+    end
+
+    test "mailer preview actions are added and removed" do
+      mailer 'notifier', <<-RUBY
+        class Notifier < ActionMailer::Base
+          default from: "from@example.com"
+
+          def foo
+            mail to: "to@example.org"
+          end
+        end
+      RUBY
+
+      text_template 'notifier/foo', <<-RUBY
+        Hello, World!
+      RUBY
+
+      mailer_preview 'notifier', <<-RUBY
+        class NotifierPreview < ActionMailer::Preview
+          def foo
+            Notifier.foo
+          end
+        end
+      RUBY
+
+      app('development')
+
+      get "/rails/mailers"
+      assert_match '<h3><a href="/rails/mailers/notifier">Notifier</a></h3>', last_response.body
+      assert_match '<li><a href="/rails/mailers/notifier/foo">foo</a></li>', last_response.body
+      assert_no_match '<li><a href="/rails/mailers/notifier/bar">bar</a></li>', last_response.body
+
+      mailer 'notifier', <<-RUBY
+        class Notifier < ActionMailer::Base
+          default from: "from@example.com"
+
+          def foo
+            mail to: "to@example.org"
+          end
+
+          def bar
+            mail to: "to@example.net"
+          end
+        end
+      RUBY
+
+      text_template 'notifier/foo', <<-RUBY
+        Hello, World!
+      RUBY
+
+      text_template 'notifier/bar', <<-RUBY
+        Goodbye, World!
+      RUBY
+
+      mailer_preview 'notifier', <<-RUBY
+        class NotifierPreview < ActionMailer::Preview
+          def foo
+            Notifier.foo
+          end
+
+          def bar
+            Notifier.bar
+          end
+        end
+      RUBY
+
+      sleep(1)
+
+      get "/rails/mailers"
+      assert_match '<h3><a href="/rails/mailers/notifier">Notifier</a></h3>', last_response.body
+      assert_match '<li><a href="/rails/mailers/notifier/foo">foo</a></li>', last_response.body
+      assert_match '<li><a href="/rails/mailers/notifier/bar">bar</a></li>', last_response.body
+
+      mailer 'notifier', <<-RUBY
+        class Notifier < ActionMailer::Base
+          default from: "from@example.com"
+
+          def foo
+            mail to: "to@example.org"
+          end
+        end
+      RUBY
+
+      remove_file 'app/views/notifier/bar.text.erb'
+
+      mailer_preview 'notifier', <<-RUBY
+        class NotifierPreview < ActionMailer::Preview
+          def foo
+            Notifier.foo
+          end
+        end
+      RUBY
+
+      sleep(1)
+
+      get "/rails/mailers"
+      assert_match '<h3><a href="/rails/mailers/notifier">Notifier</a></h3>', last_response.body
+      assert_match '<li><a href="/rails/mailers/notifier/foo">foo</a></li>', last_response.body
+      assert_no_match '<li><a href="/rails/mailers/notifier/bar">bar</a></li>', last_response.body
+    end
+
+    test "mailer preview not found" do
+      app('development')
+      get "/rails/mailers/notifier"
+      assert last_response.not_found?
+      assert_match "Mailer preview &#39;notifier&#39; not found", last_response.body
+    end
+
+    test "mailer preview email not found" do
+      mailer 'notifier', <<-RUBY
+        class Notifier < ActionMailer::Base
+          default from: "from@example.com"
+
+          def foo
+            mail to: "to@example.org"
+          end
+        end
+      RUBY
+
+      text_template 'notifier/foo', <<-RUBY
+        Hello, World!
+      RUBY
+
+      mailer_preview 'notifier', <<-RUBY
+        class NotifierPreview < ActionMailer::Preview
+          def foo
+            Notifier.foo
+          end
+        end
+      RUBY
+
+      app('development')
+
+      get "/rails/mailers/notifier/bar"
+      assert last_response.not_found?
+      assert_match "Email &#39;bar&#39; not found in NotifierPreview", last_response.body
+    end
+
+    test "mailer preview email part not found" do
+      mailer 'notifier', <<-RUBY
+        class Notifier < ActionMailer::Base
+          default from: "from@example.com"
+
+          def foo
+            mail to: "to@example.org"
+          end
+        end
+      RUBY
+
+      text_template 'notifier/foo', <<-RUBY
+        Hello, World!
+      RUBY
+
+      mailer_preview 'notifier', <<-RUBY
+        class NotifierPreview < ActionMailer::Preview
+          def foo
+            Notifier.foo
+          end
+        end
+      RUBY
+
+      app('development')
+
+      get "/rails/mailers/notifier/foo?part=text%2Fhtml"
+      assert last_response.not_found?
+      assert_match "Email part &#39;text/html&#39; not found in NotifierPreview#foo", last_response.body
+    end
+
+    test "message header uses full display names" do
+      mailer 'notifier', <<-RUBY
+        class Notifier < ActionMailer::Base
+          default from: "Ruby on Rails <core@rubyonrails.org>"
+
+          def foo
+            mail to: "Andrew White <andyw@pixeltrix.co.uk>",
+                 cc: "David Heinemeier Hansson <david@heinemeierhansson.com>"
+          end
+        end
+      RUBY
+
+      text_template 'notifier/foo', <<-RUBY
+        Hello, World!
+      RUBY
+
+      mailer_preview 'notifier', <<-RUBY
+        class NotifierPreview < ActionMailer::Preview
+          def foo
+            Notifier.foo
+          end
+        end
+      RUBY
+
+      app('development')
+
+      get "/rails/mailers/notifier/foo"
+      assert_equal 200, last_response.status
+      assert_match "Ruby on Rails &lt;core@rubyonrails.org&gt;", last_response.body
+      assert_match "Andrew White &lt;andyw@pixeltrix.co.uk&gt;", last_response.body
+      assert_match "David Heinemeier Hansson &lt;david@heinemeierhansson.com&gt;", last_response.body
+    end
+
+    test "part menu selects correct option" do
+      mailer 'notifier', <<-RUBY
+        class Notifier < ActionMailer::Base
+          default from: "from@example.com"
+
+          def foo
+            mail to: "to@example.org"
+          end
+        end
+      RUBY
+
+      html_template 'notifier/foo', <<-RUBY
+        <p>Hello, World!</p>
+      RUBY
+
+      text_template 'notifier/foo', <<-RUBY
+        Hello, World!
+      RUBY
+
+      mailer_preview 'notifier', <<-RUBY
+        class NotifierPreview < ActionMailer::Preview
+          def foo
+            Notifier.foo
+          end
+        end
+      RUBY
+
+      app('development')
+
+      get "/rails/mailers/notifier/foo.html"
+      assert_equal 200, last_response.status
+      assert_match '<option selected value="?part=text%2Fhtml">View as HTML email</option>', last_response.body
+
+      get "/rails/mailers/notifier/foo.txt"
+      assert_equal 200, last_response.status
+      assert_match '<option selected value="?part=text%2Fplain">View as plain-text email</option>', last_response.body
+    end
+
+    private
+      def build_app
+        super
+        app_file 'config/routes.rb', "Rails.application.routes.draw do; end"
+      end
+
+      def mailer(name, contents)
+        app_file("app/mailers/#{name}.rb", contents)
+      end
+
+      def mailer_preview(name, contents)
+        app_file("test/mailers/previews/#{name}_preview.rb", contents)
+      end
+
+      def html_template(name, contents)
+        app_file("app/views/#{name}.html.erb", contents)
+      end
+
+      def text_template(name, contents)
+        app_file("app/views/#{name}.text.erb", contents)
+      end
+  end
+end