padrino-mailer 0.16.2 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6765495811d426407ef6a517df0623de4cd979a957b4e8eb889ef8cf6b8e4c2
-  data.tar.gz: 9fa8ad265be86fe4dbad73c31bbeb99824a45d16d8647be6fd2f4425a3a40c73
+  metadata.gz: 825e119978637255f86e4e8a3cbe59129020a951480750cd4d292731a112708c
+  data.tar.gz: 4cd8ae7354cfffabf9afa6a6b9b68158d6d37acf65b7053a79ca232ee208ad47
 SHA512:
-  metadata.gz: 6e8048c51f82f9bd08609467bb9ef7679595101f00d5b22e9a2be687ab7af0c05e3cdc1bc5fdc57f800b5da8ab59a3a37376b4f9da45f6ceb6adc05db0589004
-  data.tar.gz: cc6c06b2166b891aac8d1f24224b20bca3c05ddd159efc9082596d30cf7ee4a0998512c69f5720a5f7b8623d15abbfbabf568eb3b955981185dbd88bec329ff5
+  metadata.gz: ce4c8d3e8abb2b464939852ffc204a7fa1798daefb11b0119b7a642bd88b293d41f3c6b31d0fd357ce0b2e33c6688af2bdc96afea3e642611ff023283f9f8263
+  data.tar.gz: bca72b42a36c242cb4cd27662b5e386ffda7e027d46f2b0d14a762ac3477b22afb1530472716e7cf93e8024f4a1d07c10d84fa72c2246cfc1e4647684eaf8a24

data/lib/padrino-mailer/ext.rb

@@ -5,18 +5,19 @@ module Mail # @private
     include Sinatra::Templates
     include Padrino::Rendering if defined?(Padrino::Rendering)
     include Padrino::Helpers::RenderHelpers if defined? Padrino::Helpers::RenderHelpers
+    include Padrino::Helpers if defined?(Padrino::Helpers)
     attr_reader :template_cache
     attr_accessor :mailer_name, :message_name
 
     def initialize_with_app(*args, &block)
-      @template_cache = Tilt::Cache.new
+      @template_cache = Sinatra::TemplateCache.new
       # Check if we have an app passed into initialize
       if args[0].respond_to?(:views) && args[0].respond_to?(:reload_templates?)
         app                       = args.shift
-        settings.views            = File.join(app.views, 'mailers')
+        @_views                   = File.join(app.views, 'mailers')
         settings.reload_templates = app.reload_templates?
       else
-        settings.views = File.expand_path('./mailers')
+        @_views = File.expand_path('./mailers')
         settings.reload_templates = true
       end
 
@@ -107,7 +108,7 @@ module Mail # @private
     def part(params = {}, &block)
       part_block = params.delete(:part_block)
       new_part = Mail::Part.new(params)
-      new_part.settings.views = settings.views
+      new_part.views(@_views)
       new_part.settings.reload_templates = settings.reload_templates?
       new_part.instance_eval(&part_block) if part_block
       yield new_part if block_given?
@@ -137,14 +138,17 @@ module Mail # @private
     # Sinatra almost compatibility.
     #
     def self.set(name, value)
-      self.class.instance_eval { define_method(name) { value } unless method_defined?(:erb) }
+      singleton_class.class_eval do
+        define_method(name) { value } unless method_defined?(name)
+      end
     end
 
     ##
     # Sets the message defined template path to the given view path.
     #
     def views(value)
-      settings.views = value
+      @_views = value
+      @_mailer_views = false
     end
 
     ##
@@ -211,6 +215,21 @@ module Mail # @private
       @_defaults.each_pair { |k, v| default(k.to_sym, v) } if @_defaults.is_a?(Hash)
     end
 
+    ##
+    # Emails have no session to check a token against, so forms in mailer
+    # templates are built without a CSRF token.
+    #
+    def self.protect_from_csrf
+      false
+    end
+
+    ##
+    # The form builder form_for and fields_for use in mailer templates.
+    #
+    def self.default_builder
+      'StandardFormBuilder'
+    end
+
     ##
     # Check if we can log.
     #
@@ -259,28 +278,55 @@ module Mail # @private
       locals = @_locals || {} if !options[:locals] && locals.empty?
       @template_cache.clear if settings.reload_templates?
 
+      # render(nil, 'template', ...) as RenderHelpers#partial calls it: shift the arguments
+      # the way Padrino::Rendering#render does, before defaulting to the message name.
+      engine, data, options = data, options, locals if engine.nil? && data && !data.is_a?(Hash)
       engine ||= message_name
 
       if mailer_name && !engine.to_s.index('/')
-        settings.views += "/#{mailer_name}" unless settings.views.include?("/#{mailer_name}")
+        @_views = File.join(@_views, mailer_name.to_s) unless @_mailer_views
+        @_mailer_views = true
         engine = engine.to_s.sub(%r{^#{mailer_name}/}, '')
       end
 
-      provides.each do |format|
-        part do |p|
-          p.content_type(format)
-          p.send(:render, engine, data, options, locals, &block)
-          add_multipart_alternate_header if html_part || provides.include?(:html)
-        end
+      # Pass the views path per render: class-level settings are shared by every message.
+      if data.is_a?(Hash)
+        data = { views: @_views }.merge(data)
+      else
+        options = { views: @_views }.merge(options)
       end
 
-      self.body = super(engine, data, options, locals, &block) if provides.empty?
+      # A render nested in a template (a partial) returns its output; only the outermost one sets the body.
+      return super(engine, data, options, locals, &block) if @_rendering
+
+      begin
+        @_rendering = true
+        provides.each do |format|
+          part do |p|
+            p.content_type(format)
+            p.send(:render, engine, data, options, locals, &block)
+            add_multipart_alternate_header if html_part || provides.include?(:html)
+          end
+        end
+
+        self.body = super(engine, data, options, locals, &block) if provides.empty?
+      ensure
+        @_rendering = false
+      end
     end
 
     alias original_partial partial if instance_methods.include?(:partial)
     def partial(template, options = {}, &block)
       raise "gem 'padrino-helpers' is required to render partials" unless respond_to?(:original_partial)
-      self.body = original_partial(template, options, &block)
+      return original_partial(template, options, &block) if @_rendering
+
+      begin
+        @_rendering = true
+        output = original_partial(template, options, &block)
+      ensure
+        @_rendering = false
+      end
+      self.body = output
     end
 
     ##

data/test/fixtures/padrino_app/app.rb

@@ -37,12 +37,13 @@ class PadrinoApp < Padrino::Application
     end
 
     message :helper do |name|
-      subject 'Welcome Helper!'
-      to      'jim@fake.com'
-      from    'noreply@custom.com'
-      locals  name: name
-      via     :test
-      render  'sample/helper_message'
+      subject      'Welcome Helper!'
+      to           'jim@fake.com'
+      from         'noreply@custom.com'
+      content_type :html
+      locals       name: name
+      via          :test
+      render       'sample/helper_message'
     end
 
     message :default_mailer_name do |name|

data/test/test_email.rb

@@ -158,4 +158,133 @@ describe 'Email' do
       end
     end
   end
+
+  describe 'the mailer views path' do
+    def mailer_views(root)
+      views = File.join(@tmp, root, 'views')
+      { 'alpha/hello.erb' => 'alpha hello', 'beta/hello.erb' => 'beta hello',
+        'gamma/hello.plain.erb' => 'gamma plain', 'gamma/hello.html.erb' => 'gamma html' }.each do |path, content|
+        file = File.join(views, 'mailers', path)
+        FileUtils.mkdir_p(File.dirname(file))
+        File.write(file, content)
+      end
+      views
+    end
+
+    def mailer_app(views)
+      mock_app do
+        register Padrino::Mailer
+        set :views, views
+        set :delivery_method, :test
+        set :mailer_defaults, from: 'padrino@me.com', to: 'padrino@you.com'
+        mailer(:alpha) { email(:hello) { via :test; render :hello } }
+        mailer(:beta)  { email(:hello) { via :test; render :hello } }
+        mailer(:gamma) { email(:hello) { via :test; provides :plain, :html; render :hello } }
+      end
+    end
+
+    def build_message(mailer_name)
+      message = @app.settings._padrino_mailer::Message.new(@app)
+      message.mailer_name = mailer_name
+      message
+    end
+
+    before { @tmp = Dir.mktmpdir }
+    after  { FileUtils.rm_rf(@tmp) }
+
+    it 'should add the mailer name when the app path contains it' do
+      mailer_app(mailer_views('beta_site'))
+      email = @app.deliver(:beta, :hello)
+      assert_equal 'beta hello', email.body.to_s
+    end
+
+    it 'should not leak the mailer path between messages' do
+      mailer_app(mailer_views('site'))
+      alpha = build_message(:alpha)
+      beta = build_message(:beta)
+      assert_equal 'beta hello', beta.send(:render, :hello)
+      assert_equal 'alpha hello', alpha.send(:render, :hello)
+    end
+
+    it 'should not reuse a cached template from another mailer' do
+      views = mailer_views('site')
+      File.write(File.join(views, 'mailers', 'beta', 'greet.haml'), '%p beta greet')
+      File.write(File.join(views, 'mailers', 'alpha', 'greet.erb'), 'alpha greet')
+      mailer_app(views)
+      @app.set :reload_templates, false
+      @app.mailer(:alpha) { email(:greet) { via :test; render :greet } }
+      @app.mailer(:beta)  { email(:greet) { via :test; render :greet } }
+      assert_equal 'alpha greet', @app.deliver(:alpha, :greet).body.to_s
+      assert_equal '<p>beta greet</p>', @app.deliver(:beta, :greet).body.to_s.strip
+    end
+
+    it 'should render a partial from a mailer template' do
+      views = mailer_views('site')
+      File.write(File.join(views, 'mailers', 'alpha', 'listing.erb'), "<%= partial 'item', object: 'one' %>")
+      File.write(File.join(views, 'mailers', 'alpha', '_item.erb'), 'item <%= item %>')
+      mailer_app(views)
+      @app.mailer(:alpha) { email(:listing) { via :test; render :listing } }
+      assert_equal 'item one', @app.deliver(:alpha, :listing).body.to_s.strip
+    end
+
+    it 'should render the message template with options when the engine is nil' do
+      views = mailer_views('site')
+      File.write(File.join(views, 'mailers', 'alpha', 'boxed.erb'), 'boxed')
+      File.write(File.join(views, 'mailers', 'alpha', 'box.erb'), '[<%= yield %>]')
+      mailer_app(views)
+      @app.mailer(:alpha) { email(:boxed) { via :test; render nil, layout: :box } }
+      assert_equal '[boxed]', @app.deliver(:alpha, :boxed).body.to_s.strip
+    end
+
+    it 'should not add a part per partial to a message with an attachment' do
+      views = mailer_views('site')
+      File.write(File.join(views, 'mailers', 'alpha', 'listing.erb'), "<%= partial 'item', collection: %w[a b] %>")
+      File.write(File.join(views, 'mailers', 'alpha', '_item.erb'), '<%= item %>')
+      mailer_app(views)
+      @app.mailer(:alpha) { email(:listing) { via :test; add_file filename: 'a.txt', content: 'file'; render :listing } }
+      email = @app.deliver(:alpha, :listing)
+      assert_equal(%w[ab file], email.parts.map { |part| part.body.to_s.strip })
+    end
+
+    it 'should not reuse a cached layout from another mailer' do
+      views = mailer_views('site')
+      File.write(File.join(views, 'mailers', 'alpha', 'box.erb'), 'A[<%= yield %>]')
+      FileUtils.mkdir_p(File.join(views, 'mailers', 'beta', 'layouts'))
+      File.write(File.join(views, 'mailers', 'beta', 'layouts', 'box.erb'), 'B[<%= yield %>]')
+      mailer_app(views)
+      @app.set :reload_templates, false
+      @app.mailer(:alpha) { email(:boxed) { via :test; render :hello, layout: :box } }
+      @app.mailer(:beta)  { email(:boxed) { via :test; render :hello, layout: :box } }
+      assert_equal 'A[alpha hello]', @app.deliver(:alpha, :boxed).body.to_s.strip
+      assert_equal 'B[beta hello]', @app.deliver(:beta, :boxed).body.to_s.strip
+    end
+
+    MailerFormUser = Struct.new(:name) unless defined?(MailerFormUser)
+
+    it 'should build forms with form_for in a mailer template' do
+      views = mailer_views('site')
+      File.write(File.join(views, 'mailers', 'alpha', 'signup.erb'), "<% @user = MailerFormUser.new('Joe') %><%= form_for(:user, '/signup') { |f| f.text_field(:name) } %>")
+      mailer_app(views)
+      @app.mailer(:alpha) { email(:signup) { via :test; render :signup } }
+      body = @app.deliver(:alpha, :signup).body.to_s
+      assert_match(%r{<form[^>]*action="/signup"}, body)
+      assert_match(/<input type="text" name="mailer_form_user\[name\]" value="Joe"/, body)
+    end
+
+    it 'should build forms in a mailer template without a CSRF token' do
+      views = mailer_views('site')
+      File.write(File.join(views, 'mailers', 'alpha', 'confirm.erb'), "<%= button_to 'Confirm', '/confirm' %>")
+      mailer_app(views)
+      @app.mailer(:alpha) { email(:confirm) { via :test; render :confirm } }
+      body = @app.deliver(:alpha, :confirm).body.to_s
+      assert_match(%r{<form[^>]*action="/confirm"}, body)
+      refute_match(/authenticity_token/, body)
+    end
+
+    it 'should render each provided format from the mailer path' do
+      mailer_app(mailer_views('site'))
+      email = @app.deliver(:gamma, :hello)
+      assert_equal(['gamma plain', 'gamma html'], email.parts.map { |part| part.body.to_s })
+    end
+  end
 end

data/test/test_message.rb

@@ -166,4 +166,27 @@ describe 'Message' do
       assert_equal "Object 1<br>\nObject 2<br>\nObject &lt;evil&gt;<br>\nObject <good><br>", message.body.to_s.chomp
     end
   end
+
+  describe 'Mail::Message.set' do
+    it 'should define accessor methods for settings' do
+      Mail::Message.set(:_test_custom_setting, 'custom_value')
+      message = Mail::Message.new
+      assert_equal 'custom_value', message.settings._test_custom_setting
+    ensure
+      if Mail::Message.singleton_class.method_defined?(:_test_custom_setting)
+        Mail::Message.singleton_class.send(:remove_method, :_test_custom_setting)
+      end
+    end
+
+    it 'should not redefine an already defined method' do
+      Mail::Message.set(:_test_another_setting, 'first')
+      Mail::Message.set(:_test_another_setting, 'second')
+      message = Mail::Message.new
+      assert_equal 'first', message.settings._test_another_setting
+    ensure
+      if Mail::Message.singleton_class.method_defined?(:_test_another_setting)
+        Mail::Message.singleton_class.send(:remove_method, :_test_another_setting)
+      end
+    end
+  end
 end

data/test/test_padrino_mailer.rb

@@ -102,12 +102,11 @@ describe 'PadrinoMailer' do
     end
 
     it 'should be able to deliver a basic email using Padrino::Helpers' do
-      skip # FIXME
       post '/deliver/helper'
       assert_equal 'mail delivered', body
       assert_email_sent(to: 'jim@fake.com', from: 'noreply@custom.com',
                         content_type: 'text/html',
-                        subject: 'Welcome Helper!', body: '<a href="#">jim</a>')
+                        subject: 'Welcome Helper!', body: '<a href="#">Jim</a>')
     end
 
     it 'should fail with proper message if mailer is not registered' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: padrino-mailer
 version: !ruby/object:Gem::Version
-  version: 0.16.2
+  version: 0.17.0
 platform: ruby
 authors:
 - Padrino Team
@@ -19,14 +19,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.16.2
+        version: 0.17.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.16.2
+        version: 0.17.0
 - !ruby/object:Gem::Dependency
   name: mime-types
   requirement: !ruby/object:Gem::Requirement