delayed_job-active_job 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 73a9d8e3e9c660ca02a3912662159c63885f34fee8a5b979443022a6ef6e8c64
+  data.tar.gz: 3c7dc284a05854437c0a870b497327561e7c3e6d5d1e2f74e735585d07713418
+SHA512:
+  metadata.gz: b20d80faf8e3bc9ba422c8079c1f7bae1183aeaca711820999c42ae293c205390ad0624dfc5aefa830876dbe3ec1d4f6d8f115dbe5764a324669f8e64075e061
+  data.tar.gz: b5726d299fbd037909bc3e14093f6d369f5f3dfd705e127a4e64da7384737b282a9071bc24e131e116e02b82797547c6f38d10de6a7fa526bd8c5e1b506401e1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Alex
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,47 @@
+# delayed_job-active_job
+
+[![Gem Version](https://img.shields.io/gem/v/delayed_job-active_job)](https://rubygems.org/gems/delayed_job-active_job)
+[![Gem Downloads](https://img.shields.io/gem/dt/delayed_job-active_job)](https://www.ruby-toolbox.com/projects/delayed_job-active_job)
+[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/TandaHQ/delayed_job-active_job/ci.yml)](https://github.com/TandaHQ/delayed_job-active_job/actions/workflows/ci.yml)
+
+The Delayed Job adapter will be [removed from Rails soon](https://github.com/rails/rails/commit/d55ec9d5831b05ea5de75c105635c80376c0bf11). This gem extracts it so that you can continue using Delayed Job with Active Job.
+
+If you are using a version of Rails that includes a Delayed Job adapter, using this gem will replace Rails' version with this gem's.
+
+This gem implements some new features beyond what the Rails adapter did:
+
+- Support for [`perform_all_later`](https://github.com/rails/rails/pull/46603).
+- You can set `run_at` directly on a job instance.
+- You can persist extra attributes on a job by writing to `job_attributes`.
+
+---
+
+- [Quick start](#quick-start)
+- [Support](#support)
+- [License](#license)
+- [Contribution guide](#contribution-guide)
+
+## Quick start
+
+```
+gem install delayed_job-active_job
+```
+
+Configure the Active Job backend. [See the Rails docs for more information](https://guides.rubyonrails.org/active_job_basics.html#alternate-queuing-backends).
+
+```ruby
+# config/application.rb
+config.active_job.queue_adapter = :delayed_job
+```
+
+## Support
+
+If you want to report a bug, or have ideas, feedback or questions about the gem, [let me know via GitHub issues](https://github.com/TandaHQ/delayed_job-active_job/issues/new) and I will do my best to provide a helpful answer. Happy hacking!
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](LICENSE.txt).
+
+## Contribution guide
+
+Pull requests are welcome!

data/lib/delayed_job/active_job/job_attributes.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module ActiveJob
+  # Includes the ability to store extra attributes on a job instance, that are persisted into the delayed_jobs table.
+  module JobAttributes
+    extend ActiveSupport::Concern
+    included do
+      class_attribute :job_attributes, instance_writer: true, instance_accessor: true, default: {}
+    end
+  end
+end
+
+ActiveSupport.on_load(:active_job) do
+  include ActiveJob::JobAttributes
+end

data/lib/delayed_job/active_job/run_at.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module ActiveJob
+  # Includes the ability to override when a job should run.
+  module RunAt
+    extend ActiveSupport::Concern
+    included do
+      class_attribute :run_at, instance_writer: true, instance_accessor: false, default: -> { Time.current }
+    end
+
+    def run_at
+      @run_at = instance_exec(&@run_at) if @run_at.is_a?(Proc)
+      @run_at
+    end
+  end
+end
+
+ActiveSupport.on_load(:active_job) do
+  include ActiveJob::RunAt
+end

data/lib/delayed_job/active_job/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module DelayedJob
+  module ActiveJob
+    VERSION = "1.0.0"
+  end
+end

data/lib/delayed_job/active_job.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require_relative "delayed_job_adapter"
+require_relative "active_job/version"
+require_relative "active_job/run_at"
+require_relative "active_job/job_attributes"

data/lib/delayed_job/delayed_job_adapter.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require "delayed_job"
+require "active_job"
+require "active_support/core_ext/string/inflections"
+
+module ActiveJob
+  module QueueAdapters
+    # Override existing Rails adapter.
+    remove_const :DelayedJobAdapter if constants.include?(:DelayedJobAdapter)
+
+    # = Delayed Job adapter for Active Job
+    #
+    # Delayed::Job (or DJ) encapsulates the common pattern of asynchronously
+    # executing longer tasks in the background. Although DJ can have many
+    # storage backends, one of the most used is based on Active Record.
+    # Read more about Delayed Job {here}[https://github.com/collectiveidea/delayed_job].
+    #
+    # To use Delayed Job, set the queue_adapter config to +:delayed_job+.
+    #
+    #   Rails.application.config.active_job.queue_adapter = :delayed_job
+    class DelayedJobAdapter < ActiveJob::QueueAdapters::AbstractAdapter
+      def enqueue(job)
+        delayed_job = Delayed::Job.enqueue(
+          JobWrapper.new(job.serialize),
+          queue: job.queue_name,
+          priority: job.priority,
+          run_at: job.run_at,
+          **job.job_attributes
+        )
+        job.provider_job_id = delayed_job.id
+        delayed_job
+      end
+
+      def enqueue_at(job, timestamp)
+        delayed_job = Delayed::Job.enqueue(
+          JobWrapper.new(job.serialize),
+          queue: job.queue_name,
+          priority: job.priority,
+          run_at: job.run_at || Time.at(timestamp),
+          **job.job_attributes
+        )
+        job.provider_job_id = delayed_job.id
+        delayed_job
+      end
+
+      def enqueue_all(jobs)
+        wrapped_jobs = jobs.filter_map do |job|
+          options = Delayed::Backend::JobPreparer.new(
+            JobWrapper.new(job.serialize),
+            queue: job.queue_name,
+            priority: job.priority,
+            run_at: job.run_at,
+            **job.job_attributes
+          ).prepare
+          job_to_enqueue = Delayed::Job.new(options)
+          if Delayed::Worker.delay_job?(job_to_enqueue)
+            job_to_enqueue.attributes.except("id", "created_at", "updated_at")
+          else
+            job_to_enqueue.invoke_job
+            nil
+          end
+        end
+        Delayed::Job.insert_all(wrapped_jobs)
+      end
+
+      class JobWrapper # :nodoc:
+        attr_accessor :job_data
+
+        def initialize(job_data)
+          @job_data = job_data
+        end
+
+        def display_name
+          base_name = "#{job_data['job_class']} [#{job_data['job_id']}] from DelayedJob(#{job_data['queue_name']})"
+
+          return base_name unless log_arguments?
+
+          "#{base_name} with arguments: #{job_data['arguments']}"
+        end
+
+        def perform
+          Base.execute(job_data)
+        end
+
+        private
+
+        def log_arguments?
+          job_data["job_class"].constantize.log_arguments?
+        rescue NameError
+          false
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: delayed_job-active_job
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Alex
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-04-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activejob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '8'
+- !ruby/object:Gem::Dependency
+  name: delayed_job_active_record
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- alex@tanda.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/delayed_job/active_job.rb
+- lib/delayed_job/active_job/job_attributes.rb
+- lib/delayed_job/active_job/run_at.rb
+- lib/delayed_job/active_job/version.rb
+- lib/delayed_job/delayed_job_adapter.rb
+homepage: https://github.com/TandaHQ/delayed_job-active_job
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/TandaHQ/delayed_job-active_job/issues
+  changelog_uri: https://github.com/TandaHQ/delayed_job-active_job/releases
+  source_code_uri: https://github.com/TandaHQ/delayed_job-active_job
+  homepage_uri: https://github.com/TandaHQ/delayed_job-active_job
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.23
+signing_key:
+specification_version: 4
+summary: Active Job adapter for Delayed Job
+test_files: []