Sha256: 430f886b7363d5de0777e82706ea0255d24097e8775a51820b1f4435c4d715bd

Contents?: true

Size: 1.82 KB

Versions: 6

Compression:

Stored size: 1.82 KB

Contents

# frozen_string_literal: true

require "sucker_punch"

module ActiveJob
  module QueueAdapters
    # = Sucker Punch adapter for Active Job
    #
    # Sucker Punch is a single-process Ruby asynchronous processing library.
    # This reduces the cost of hosting on a service like Heroku along
    # with the memory footprint of having to maintain additional jobs if
    # hosting on a dedicated server. All queues can run within a
    # single application (e.g. \Rails, Sinatra, etc.) process.
    #
    # Read more about Sucker Punch {here}[https://github.com/brandonhilkert/sucker_punch].
    #
    # To use Sucker Punch set the queue_adapter config to +:sucker_punch+.
    #
    #   Rails.application.config.active_job.queue_adapter = :sucker_punch
    class SuckerPunchAdapter < AbstractAdapter
      def check_adapter
        ActiveJob.deprecator.warn <<~MSG.squish
          The `sucker_punch` adapter is deprecated and will be removed in Rails 8.1.
          Please use the `async` adapter instead.
        MSG
      end

      def enqueue(job) # :nodoc:
        if JobWrapper.respond_to?(:perform_async)
          # sucker_punch 2.0 API
          JobWrapper.perform_async job.serialize
        else
          # sucker_punch 1.0 API
          JobWrapper.new.async.perform job.serialize
        end
      end

      def enqueue_at(job, timestamp) # :nodoc:
        if JobWrapper.respond_to?(:perform_in)
          delay = timestamp - Time.current.to_f
          JobWrapper.perform_in delay, job.serialize
        else
          raise NotImplementedError, "sucker_punch 1.0 does not support `enqueue_at`. Please upgrade to version ~> 2.0.0 to enable this behavior."
        end
      end

      class JobWrapper # :nodoc:
        include SuckerPunch::Job

        def perform(job_data)
          Base.execute job_data
        end
      end
    end
  end
end

Version data entries

6 entries across 6 versions & 1 rubygems

Version Path
activejob-8.0.1 lib/active_job/queue_adapters/sucker_punch_adapter.rb
activejob-8.0.0.1 lib/active_job/queue_adapters/sucker_punch_adapter.rb
activejob-8.0.0 lib/active_job/queue_adapters/sucker_punch_adapter.rb
activejob-8.0.0.rc2 lib/active_job/queue_adapters/sucker_punch_adapter.rb
activejob-8.0.0.rc1 lib/active_job/queue_adapters/sucker_punch_adapter.rb
activejob-8.0.0.beta1 lib/active_job/queue_adapters/sucker_punch_adapter.rb