From 11ab04b11170253e96515c3ada6f2566b092533a Mon Sep 17 00:00:00 2001
From: Terry Meacham <zv1n.fire@gmail.com>
Date: Tue, 23 Sep 2014 15:51:44 -0500
Subject: Added queue_name_delimiter attribute.

- Added ActiveJob::Base#queue_name_delimiter to allow for
  developers using ActiveJob to change the delimiter from the default
  ('_') to whatever else they may be using (e.g., '.', '-', ...).

- Updated source guide to include a blurb about the delimiter.
---
 activejob/lib/active_job/queue_name.rb    |  5 ++++-
 activejob/test/cases/queue_naming_test.rb | 19 ++++++++++++++++++-
 guides/source/active_job_basics.md        | 23 +++++++++++++++++++++++
 3 files changed, 45 insertions(+), 2 deletions(-)

diff --git a/activejob/lib/active_job/queue_name.rb b/activejob/lib/active_job/queue_name.rb
index d167617e4e..6ee7142ce6 100644
--- a/activejob/lib/active_job/queue_name.rb
+++ b/activejob/lib/active_job/queue_name.rb
@@ -26,13 +26,16 @@ module ActiveJob
       def queue_name_from_part(part_name) #:nodoc:
         queue_name = part_name || default_queue_name
         name_parts = [queue_name_prefix.presence, queue_name]
-        name_parts.compact.join('_')
+        name_parts.compact.join(queue_name_delimiter)
       end
     end
 
     included do
       class_attribute :queue_name, instance_accessor: false
+      class_attribute :queue_name_delimiter, instance_accessor: false
+
       self.queue_name = default_queue_name
+      self.queue_name_delimiter = '_' # set default delimiter to '_'
     end
 
     # Returns the name of the queue the job will be run on
diff --git a/activejob/test/cases/queue_naming_test.rb b/activejob/test/cases/queue_naming_test.rb
index 886f41271a..898016a704 100644
--- a/activejob/test/cases/queue_naming_test.rb
+++ b/activejob/test/cases/queue_naming_test.rb
@@ -64,7 +64,7 @@ class QueueNamingTest < ActiveSupport::TestCase
     end
   end
 
-  test 'queu_name_prefix prepended to the queue name' do
+  test 'queue_name_prefix prepended to the queue name with default delimiter' do
     original_queue_name_prefix = ActiveJob::Base.queue_name_prefix
     original_queue_name = HelloJob.queue_name
 
@@ -78,6 +78,23 @@ class QueueNamingTest < ActiveSupport::TestCase
     end
   end
 
+  test 'queue_name_prefix prepended to the queue name with custom delimiter' do
+    original_queue_name_prefix = ActiveJob::Base.queue_name_prefix
+    original_queue_name_delimiter = ActiveJob::Base.queue_name_delimiter
+    original_queue_name = HelloJob.queue_name
+
+    begin
+      ActiveJob::Base.queue_name_delimiter = '.'
+      ActiveJob::Base.queue_name_prefix = 'aj'
+      HelloJob.queue_as :low
+      assert_equal 'aj.low', HelloJob.queue_name
+    ensure
+      ActiveJob::Base.queue_name_prefix = original_queue_name_prefix
+      ActiveJob::Base.queue_name_delimiter = original_queue_name_delimiter
+      HelloJob.queue_name = original_queue_name
+    end
+  end
+
   test 'uses queue passed to #set' do
     job = HelloJob.set(queue: :some_queue).perform_later
     assert_equal "some_queue", job.queue_name
diff --git a/guides/source/active_job_basics.md b/guides/source/active_job_basics.md
index 9c34418fab..0f63a1c7e7 100644
--- a/guides/source/active_job_basics.md
+++ b/guides/source/active_job_basics.md
@@ -149,6 +149,29 @@ end
 # environment
 ```
 
+The default queue name prefix delimiter is '_'.  This can be changed by setting
+`config.active_job.queue_name_delimiter` in `application.rb`:
+
+```ruby
+# config/application.rb
+module YourApp
+  class Application < Rails::Application
+    config.active_job.queue_name_prefix = Rails.env
+    config.active_job.queue_name_delimiter = '.'
+  end
+end
+
+# app/jobs/guests_cleanup.rb
+class GuestsCleanupJob < ActiveJob::Base
+  queue_as :low_priority
+  #....
+end
+
+# Now your job will run on queue production.low_priority on your
+# production environment and on staging.low_priority on your staging
+# environment
+```
+
 If you want more control on what queue a job will be run you can pass a :queue
 option to #set:
 
-- 
cgit v1.2.3