Merge pull request #16485 from seuros/activejob

Integrate ActiveJob / DeliverLater / GlobalID with Rails

Author: dhh

.travis.yml

@@ -12,7 +12,7 @@ rvm:
 env:
   - "GEM=railties"
   - "GEM=ap"
-  - "GEM=am,amo,as,av"
+  - "GEM=am,amo,as,av,aj"
   - "GEM=ar:mysql"
   - "GEM=ar:mysql2"
   - "GEM=ar:sqlite3"

Gemfile

@@ -35,6 +35,20 @@ end
 # AS
 gem 'dalli', '>= 2.2.1'
 
+# ActiveJob
+gem 'globalid', github: 'rails/globalid'
+gem 'resque', require: false
+gem 'resque-scheduler', require: false
+gem 'sidekiq', require: false
+gem 'sucker_punch', require: false
+gem 'delayed_job', require: false
+gem 'queue_classic', require: false
+gem 'sneakers', '0.1.1.pre', require: false
+gem 'que', require: false
+gem 'backburner', require: false
+gem 'qu-rails', github: "bkeepers/qu", branch: "master", require: false
+gem 'qu-redis', require: false
+
 # Add your own local bundler stuff
 local_gemfile = File.dirname(__FILE__) + "/.Gemfile"
 instance_eval File.read local_gemfile if File.exist? local_gemfile

Rakefile

@@ -11,7 +11,7 @@ task :build => "all:build"
 desc "Release all gems to rubygems and create a tag"
 task :release => "all:release"
 
-PROJECTS = %w(activesupport activemodel actionpack actionview actionmailer activerecord railties)
+PROJECTS = %w(activesupport activemodel actionpack actionview actionmailer activerecord railties activejob)
 
 desc 'Run all tests by default'
 task :default => %w(test test:isolated)

actionmailer/CHANGELOG.md

@@ -1,3 +1,9 @@
+*   Make ActionMailer::Previews methods class methods. Previously they were
+    instance methods and ActionMailer tries to render a message when they
+    are called.
+
+    *Cristian Bica*
+
 *   Deprecate `*_path` helpers in email views. When used they generate
     non-working links and are not the intention of most developers. Instead
     we recommend to use `*_url` helper.

actionmailer/lib/action_mailer.rb

@@ -45,4 +45,6 @@ module ActionMailer
   autoload :Previews, 'action_mailer/preview'
   autoload :TestCase
   autoload :TestHelper
+  autoload :MessageDelivery
+  autoload :DeliveryJob
 end

actionmailer/lib/action_mailer/base.rb

@@ -548,8 +548,8 @@ def set_payload_for_mail(payload, mail) #:nodoc:
       end
 
       def method_missing(method_name, *args) # :nodoc:
-        if respond_to?(method_name)
-          new(method_name, *args).message
+        if action_methods.include?(method_name.to_s)
+          MessageDelivery.new(self, method_name, *args)
         else
           super
         end
@@ -586,6 +586,10 @@ def process(method_name, *args) #:nodoc:
     class NullMail #:nodoc:
       def body; '' end
 
+      def respond_to?(string, include_all=false)
+        true
+      end
+
       def method_missing(*args)
         nil
       end

actionmailer/lib/action_mailer/delivery_job.rb

@@ -0,0 +1,11 @@
+require 'active_job'
+
+module ActionMailer
+  class DeliveryJob < ActiveJob::Base
+    queue_as :mailers
+
+    def perform(mailer, mail_method, delivery_method, *args)
+      mailer.constantize.public_send(mail_method, *args).send(delivery_method)
+    end
+  end
+end

actionmailer/lib/action_mailer/message_delivery.rb

@@ -0,0 +1,45 @@
+require 'delegate'
+
+module ActionMailer
+  class MessageDelivery < Delegator
+    def initialize(mailer, mail_method, *args)
+      @mailer = mailer
+      @mail_method = mail_method
+      @args = args
+    end
+
+    def __getobj__
+      @obj ||= @mailer.send(:new, @mail_method, *@args).message
+    end
+
+    def __setobj__(obj)
+      @obj = obj
+    end
+
+    def message #:nodoc:
+      __getobj__
+    end
+
+    def deliver_later!(options={})
+      enqueue_delivery :deliver!, options
+    end
+
+    def deliver_later(options={})
+      enqueue_delivery :deliver, options
+    end
+
+    private
+    def enqueue_delivery(delivery_method, options={})
+      args = @mailer.name, @mail_method.to_s, delivery_method.to_s, *@args
+      enqueue_method = :enqueue
+      if options[:at]
+        enqueue_method = :enqueue_at
+        args.unshift options[:at]
+      elsif options[:in]
+        enqueue_method = :enqueue_in
+        args.unshift options[:in]
+      end
+      ActionMailer::DeliveryJob.send enqueue_method, *args
+    end
+  end
+end

actionmailer/lib/action_mailer/preview.rb

@@ -22,7 +22,9 @@ module Previews #:nodoc:
       # :nodoc:
       mattr_accessor :preview_interceptors, instance_writer: false
       self.preview_interceptors = []
+    end
 
+    module ClassMethods
       # Register one or more Interceptors which will be called before mail is previewed.
       def register_preview_interceptors(*interceptors)
         interceptors.flatten.compact.each { |interceptor| register_preview_interceptor(interceptor) }

actionmailer/test/base_test.rb

@@ -243,7 +243,7 @@ def welcome
       end
     end
 
-    e = assert_raises(RuntimeError) { LateAttachmentMailer.welcome }
+    e = assert_raises(RuntimeError) { LateAttachmentMailer.welcome.message }
     assert_match(/Can't add attachments after `mail` was called./, e.message)
   end
 
@@ -255,7 +255,7 @@ def welcome
       end
     end
 
-    e = assert_raises(RuntimeError) { LateInlineAttachmentMailer.welcome }
+    e = assert_raises(RuntimeError) { LateInlineAttachmentMailer.welcome.message }
     assert_match(/Can't add attachments after `mail` was called./, e.message)
   end