Sha256: d459aa6917b3336c15e1310fa1292a268ca207c39595a60e645c884f569ed342

Contents?: true

Size: 1.42 KB

Versions: 35

Compression:

Stored size: 1.42 KB

Contents

module ActiveJob
  module QueueName
    extend ActiveSupport::Concern

    # Includes the ability to override the default queue name and prefix.
    module ClassMethods
      mattr_accessor(:queue_name_prefix)
      mattr_accessor(:default_queue_name) { "default" }

      # Specifies the name of the queue to process the job on.
      #
      #   class PublishToFeedJob < ActiveJob::Base
      #     queue_as :feeds
      #
      #     def perform(post)
      #       post.to_feed!
      #     end
      #   end
      def queue_as(part_name=nil, &block)
        if block_given?
          self.queue_name = block
        else
          self.queue_name = queue_name_from_part(part_name)
        end
      end

      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(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.
    def queue_name
      if @queue_name.is_a?(Proc)
        @queue_name = self.class.queue_name_from_part(instance_exec(&@queue_name))
      end
      @queue_name
    end

  end
end

Version data entries

35 entries across 35 versions & 4 rubygems

Version Path
activejob-5.0.7.2 lib/active_job/queue_name.rb
activejob-5.0.7.1 lib/active_job/queue_name.rb
activejob-5.0.7 lib/active_job/queue_name.rb
activejob-5.0.6 lib/active_job/queue_name.rb
activejob-5.0.6.rc1 lib/active_job/queue_name.rb
activejob-5.0.5 lib/active_job/queue_name.rb
activejob-5.0.5.rc2 lib/active_job/queue_name.rb
activejob-5.0.5.rc1 lib/active_job/queue_name.rb
activejob-5.0.4 lib/active_job/queue_name.rb
activejob-5.0.4.rc1 lib/active_job/queue_name.rb
activejob-5.0.3 lib/active_job/queue_name.rb
enju_leaf-1.2.1 vendor/bundle/ruby/2.3/gems/activejob-5.0.2/lib/active_job/queue_name.rb
activejob-5.0.2 lib/active_job/queue_name.rb
activejob-5.0.2.rc1 lib/active_job/queue_name.rb
autocompl-0.2.2 test/dummy/vendor/bundle/ruby/2.3.0/gems/activejob-5.0.1/lib/active_job/queue_name.rb
autocompl-0.2.1 test/dummy/vendor/bundle/ruby/2.3.0/gems/activejob-5.0.1/lib/active_job/queue_name.rb
autocompl-0.2.0 test/dummy/vendor/bundle/ruby/2.3.0/gems/activejob-5.0.1/lib/active_job/queue_name.rb
autocompl-0.1.2 test/dummy/vendor/bundle/ruby/2.3.0/gems/activejob-5.0.1/lib/active_job/queue_name.rb
autocompl-0.1.1 test/dummy/vendor/bundle/ruby/2.3.0/gems/activejob-5.0.1/lib/active_job/queue_name.rb
autocompl-0.1.0 test/dummy/vendor/bundle/ruby/2.3.0/gems/activejob-5.0.1/lib/active_job/queue_name.rb