async-job-adapter-active_job 0.14.1 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea1f70c52b6ac8fef768e6f873af46fc7d41f0fcaf2135821a85a6585289b3e5
-  data.tar.gz: 10961b83ada11d421f0c253f54c342323e87961a8f5718326a17323aaf7d004b
+  metadata.gz: 754e798963465a3af74167d1fed826c57f37dd843bb5e0150ab4109e940c3658
+  data.tar.gz: e8d8dd967ce0f5f444f1fffa3091a7081c87678b33c8607e8ffb111057d7b51f
 SHA512:
-  metadata.gz: c1624087283cb466494db419e184a624826b072db17782e7b69a650f4acce0ef11a4f072645b1304580f5ea4febf50f1dad3c0a632ca5c9d956241f3d905f7f1
-  data.tar.gz: a890ddfc103218be83e6eb954c619e21bb1991c5c16e7a58b1c061d9c19013c3c181bd75a5c453af2c6a0b6a62cffbadfd54ab1b96aede5406aa64e9e7ca7cc0
+  metadata.gz: 335a1ede4d6f09e76f11ec86abb87481e5e64ab7fd100fd2614ee7e828a5a5bce1687aab08d919c559769181346e7b7f0fa230866a6a7a1f2bb073c97004953e
+  data.tar.gz: dc681b9ed7b5ec17af74784b3404d92e6f60d5d9a9d0afb5c0a87c8eb0b9be08ae40f5561009989fcad6e862715a568a65eae3828d4092510552cee4e8fed519

data/bin/async-job-adapter-active_job-server

@@ -1,10 +1,10 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require 'async/service/configuration'
-require 'async/service/controller'
+require "async/service/configuration"
+require "async/service/controller"
 
-require 'async/job/adapter/active_job/environment'
+require "async/job/adapter/active_job/environment"
 
 configuration = Async::Service::Configuration.build do
 	service "async-job-adapter-active_job-server" do

data/lib/active_job/queue_adapters/async_job_adapter.rb

@@ -3,18 +3,24 @@
 # Released under the MIT License.
 # Copyright, 2024, by Samuel Williams.
 
-require 'active_job/queue_adapters/abstract_adapter'
+require "active_job/queue_adapters/abstract_adapter"
 
-require 'kernel/sync'
+require "kernel/sync"
 
+# @namespace
 module ActiveJob
+	# @namespace
 	module QueueAdapters
+		# ActiveJob adapter for async-job, providing asynchronous job processing capabilities.
 		class AsyncJobAdapter < AbstractAdapter
+			# Initialize the adapter with a dispatcher.
+			# @parameter dispatcher [Object] The job dispatcher, defaults to the Railtie dispatcher.
 			def initialize(dispatcher = ::Async::Job::Adapter::ActiveJob::Railtie.dispatcher)
 				@dispatcher = dispatcher
 			end
 			
 			# Enqueue a job for processing.
+			# @parameter job [ActiveJob::Base] The job to enqueue.
 			def enqueue(job)
 				Sync do
 					@dispatcher.call(job)
@@ -22,7 +28,11 @@ module ActiveJob
 			end
 			
 			# Enqueue a job for processing at a specific time.
+			# @parameter job [ActiveJob::Base] The job to enqueue.
+			# @parameter timestamp [Time] The time at which to enqueue the job.
 			def enqueue_at(job, timestamp)
+				job.scheduled_at = timestamp
+				
 				Sync do
 					@dispatcher.call(job)
 				end

data/lib/async/job/adapter/active_job/dispatcher.rb

@@ -3,10 +3,10 @@
 # Released under the MIT License.
 # Copyright, 2024, by Samuel Williams.
 
-require_relative 'executor'
+require_relative "executor"
 
-require 'async/job'
-require 'async/job/builder'
+require "async/job"
+require "async/job/builder"
 
 module Async
 	module Job
@@ -42,6 +42,8 @@ module Async
 						end
 					end
 					
+					# Dispatch a job to the appropriate queue.
+					# @parameter job [ActiveJob::Base] The job to dispatch.
 					def call(job)
 						name = @aliases.fetch(job.queue_name, job.queue_name)
 						
@@ -53,6 +55,8 @@ module Async
 						self[name].server.start
 					end
 					
+					# Get the names of all available queue definitions.
+					# @returns [Array<String>] The queue definition names.
 					def keys
 						@definitions.keys
 					end

data/lib/async/job/adapter/active_job/environment.rb

@@ -3,7 +3,7 @@
 # Released under the MIT License.
 # Copyright, 2024, by Samuel Williams.
 
-require_relative 'service'
+require_relative "service"
 
 module Async
 	module Job
@@ -16,18 +16,22 @@ module Async
 						Service
 					end
 					
+					# The rails root.
+					# @return [String]
 					def root
-						ENV.fetch('RAILS_ROOT', Dir.pwd)
+						ENV.fetch("RAILS_ROOT", Dir.pwd)
 					end
 					
+					# Get the default dispatcher instance.
+					# @returns [Object] The dispatcher from the Railtie.
 					def dispatcher
 						Railtie.dispatcher
 					end
 					
 					# The name of the queue to use.
 					def queue_names
-						if queue_names = ENV['ASYNC_JOB_ADAPTER_ACTIVE_JOB_QUEUE_NAMES']
-							queue_names.split(',')
+						if queue_names = ENV["ASYNC_JOB_ADAPTER_ACTIVE_JOB_QUEUE_NAMES"]
+							queue_names.split(",")
 						else
 							dispatcher.keys
 						end

data/lib/async/job/adapter/active_job/executor.rb

@@ -3,13 +3,13 @@
 # Released under the MIT License.
 # Copyright, 2024, by Samuel Williams.
 
-require 'json'
+require "json"
 
-require 'console'
-require 'console/event/failure'
+require "console"
+require "console/event/failure"
 
-require 'active_job'
-require 'active_job/base'
+require "active_job"
+require "active_job/base"
 
 module Async
 	module Job
@@ -17,10 +17,14 @@ module Async
 			module ActiveJob
 				# An executor for processing jobs using `ActiveJob`.
 				class Executor
+					# Initialize the executor with an optional delegate.
+					# @parameter delegate [Object] An optional delegate object for handling lifecycle methods.
 					def initialize(delegate = nil)
 						@delegate = delegate
 					end
 					
+					# Execute a job with the given data.
+					# @parameter job_data [Hash] Serialized job data from ActiveJob.
 					def execute(job_data)
 						::ActiveJob::Callbacks.run_callbacks(:execute) do
 							job = ::ActiveJob::Base.deserialize(job_data)
@@ -46,10 +50,12 @@ module Async
 						@delegate&.call(job)
 					end
 					
+					# Start the delegate if present.
 					def start
 						@delegate&.start
 					end
 					
+					# Stop the delegate if present.
 					def stop
 						@delegate&.stop
 					end

data/lib/async/job/adapter/active_job/railtie.rb

@@ -3,10 +3,10 @@
 # Released under the MIT License.
 # Copyright, 2024, by Samuel Williams.
 
-require 'async/job'
-require 'async/job/processor/inline'
+require "async/job"
+require "async/job/processor/inline"
 
-require_relative 'thread_local_dispatcher'
+require_relative "thread_local_dispatcher"
 
 module Async
 	module Job
@@ -19,6 +19,7 @@ module Async
 						dequeue Processor::Inline
 					end
 					
+					# Initialize the railtie with default queue configuration.
 					def initialize
 						@definitions = {"default" => DEFAULT_QUEUE_DEFINITION}
 						@aliases = {}

data/lib/async/job/adapter/active_job/service.rb

@@ -3,9 +3,11 @@
 # Released under the MIT License.
 # Copyright, 2024, by Samuel Williams.
 
-require 'async/service/generic'
-require 'console/event/failure'
-require 'async/barrier'
+require "async/service/generic"
+require "console/event/failure"
+
+require "async"
+require "async/barrier"
 
 module Async
 	module Job
@@ -18,7 +20,7 @@ module Async
 						container.run(name: self.name, restart: true) do |instance|
 							evaluator = @environment.evaluator
 							
-							require File.expand_path('config/environment', evaluator.root)
+							require File.expand_path("config/environment", evaluator.root)
 							
 							dispatcher = evaluator.dispatcher
 							

data/lib/async/job/adapter/active_job/thread_local_dispatcher.rb

@@ -3,7 +3,7 @@
 # Released under the MIT License.
 # Copyright, 2024, by Samuel Williams.
 
-require_relative 'dispatcher'
+require_relative "dispatcher"
 
 Thread.attr_accessor :async_job_adapter_active_job_dispatcher
 
@@ -13,6 +13,9 @@ module Async
 			module ActiveJob
 				# Used for dispatching jobs to a thread-local queue to avoid thread-safety issues.
 				class ThreadLocalDispatcher
+					# Initialize with queue definitions and aliases.
+					# @parameter definitions [Hash] The queue definitions.
+					# @parameter aliases [Hash] The queue aliases.
 					def initialize(definitions, aliases)
 						@definitions = definitions
 						@aliases = aliases
@@ -31,10 +34,14 @@ module Async
 						Thread.current.async_job_adapter_active_job_dispatcher ||= Dispatcher.new(@definitions, @aliases)
 					end
 					
+					# Get a queue by name.
+					# @parameter name [String] The queue name.
 					def [](name)
 						dispatcher[name]
 					end
 					
+					# Dispatch a job using the thread-local dispatcher.
+					# @parameter job [ActiveJob::Base] The job to dispatch.
 					def call(job)
 						dispatcher.call(job)
 					end

data/lib/async/job/adapter/active_job/version.rb

@@ -7,7 +7,7 @@ module Async
 	module Job
 		module Adapter
 			module ActiveJob
-				VERSION = "0.14.1"
+				VERSION = "0.15.0"
 			end
 		end
 	end

data/lib/async/job/adapter/active_job.rb

@@ -10,3 +10,16 @@ if defined?(Rails::Railtie)
 	require_relative "active_job/railtie"
 	require "active_job/queue_adapters/async_job_adapter"
 end
+
+# @namespace
+module Async
+	# @namespace
+	module Job
+		# @namespace
+		module Adapter
+			# @namespace
+			module ActiveJob
+			end
+		end
+	end
+end

data/license.md

@@ -1,6 +1,7 @@
 # MIT License
 
 Copyright, 2024, by Samuel Williams.  
+Copyright, 2024, by Trevor Turk.  
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/readme.md

@@ -8,7 +8,61 @@ Provides an adapter for ActiveJob on top of `Async::Job`.
 
 Please see the [project documentation](https://socketry.github.io/async-job-adapter-active_job/) for more details.
 
-  - [Getting Started](https://socketry.github.io/async-job-adapter-active_job/guides/getting-started/index) - This guide explains how to get started with the `async-job-active_job-adapter` gem.
+  - [Getting Started](https://socketry.github.io/async-job-adapter-active_job/guides/getting-started/index) - This guide explains how to get started with the `async-job-adapter-active_job` gem.
+
+## Releases
+
+Please see the [project releases](https://socketry.github.io/async-job-adapter-active_job/releases/index) for all releases.
+
+### v0.15.0
+
+  - Fix handling of scheduled jobs with proper `scheduled_at` assignment.
+  - 100% documentation coverage.
+  - 100% test coverage.
+  - Modernize code formatting and structure.
+  - Fix typo in gem name (\#7).
+
+### v0.14.1
+
+  - Ensure the adapter wraps enqueue operations with `Sync` (\#10).
+
+### v0.14.0
+
+  - Support for running multiple queues.
+  - Minor documentation fixes.
+
+### v0.13.0
+
+  - Add support for `:async_job` queue adapter name.
+  - Require `active_job` in the executor.
+  - Updated logging examples and documentation.
+  - Remove `thread-local` gem dependency.
+  - Improve error handling - don't log failures as ActiveJob already handles this.
+
+### v0.12.1
+
+  - Force string names for queue identifiers, fixes \#5.
+
+### v0.12.0
+
+  - Improved error handling - let ActiveJob handle retry logic.
+
+### v0.11.0
+
+  - Prefer `define_queue` and `alias_queue` methods for queue configuration.
+
+### v0.10.0
+
+  - Rename "pipeline" concept to "queue" for consistency.
+
+### v0.9.0
+
+  - Update interface to suit upstream async-job changes.
+
+### v0.8.0
+
+  - Add `#start`/`#stop` delegators for better lifecycle management.
+  - Performance improvements with benchmarking.
 
 ## Contributing
 

data/releases.md

@@ -0,0 +1,86 @@
+# Releases
+
+## v0.15.0
+
+  - Fix handling of scheduled jobs with proper `scheduled_at` assignment.
+  - 100% documentation coverage.
+  - 100% test coverage.
+  - Modernize code formatting and structure.
+  - Fix typo in gem name (\#7).
+
+## v0.14.1
+
+  - Ensure the adapter wraps enqueue operations with `Sync` (\#10).
+
+## v0.14.0
+
+  - Support for running multiple queues.
+  - Minor documentation fixes.
+
+## v0.13.0
+
+  - Add support for `:async_job` queue adapter name.
+  - Require `active_job` in the executor.
+  - Updated logging examples and documentation.
+  - Remove `thread-local` gem dependency.
+  - Improve error handling - don't log failures as ActiveJob already handles this.
+
+## v0.12.1
+
+  - Force string names for queue identifiers, fixes \#5.
+
+## v0.12.0
+
+  - Improved error handling - let ActiveJob handle retry logic.
+
+## v0.11.0
+
+  - Prefer `define_queue` and `alias_queue` methods for queue configuration.
+
+## v0.10.0
+
+  - Rename "pipeline" concept to "queue" for consistency.
+
+## v0.9.0
+
+  - Update interface to suit upstream async-job changes.
+
+## v0.8.0
+
+  - Add `#start`/`#stop` delegators for better lifecycle management.
+  - Performance improvements with benchmarking.
+
+## v0.7.0
+
+  - Major modernization of the gem structure.
+  - Improved documentation generation.
+  - Drop Ruby 3.0 support.
+  - Fix server binary and add default server configuration.
+
+## v0.6.0
+
+  - Update dependency on `async-service`.
+  - Add explicit `Environment` class for better configuration.
+
+## v0.5.0
+
+  - Move builder pattern to `async-job` library.
+  - Significantly improved test coverage.
+
+## v0.4.0
+
+  - Add Redis workflow support.
+
+## v0.3.0
+
+  - Introduce builder pattern for constructing adapters and queues.
+  - Support for multiple queues.
+
+## v0.2.0
+
+  - Add support for basic configuration.
+  - Initial test suite.
+
+## v0.1.0
+
+  - Initial extraction of ActiveJob adapter code from `async-job`.

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: async-job-adapter-active_job
 version: !ruby/object:Gem::Version
-  version: 0.14.1
+  version: 0.15.0
 platform: ruby
 authors:
 - Samuel Williams
-autorequire:
+- Trevor Turk
 bindir: bin
 cert_chain:
 - |
@@ -37,7 +37,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-08-14 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-job
@@ -67,8 +67,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.12'
-description:
-email:
 executables:
 - async-job-adapter-active_job-server
 extensions: []
@@ -86,13 +84,13 @@ files:
 - lib/async/job/adapter/active_job/version.rb
 - license.md
 - readme.md
+- releases.md
 homepage: https://github.com/socketry/async-job-adapter-active_job
 licenses:
 - MIT
 metadata:
   documentation_uri: https://socketry.github.io/async-job-adapter-active_job/
   source_code_uri: https://github.com/socketry/async-job-adapter-active_job.git
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -100,15 +98,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.1'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
 summary: A asynchronous job queue for Ruby on Rails.
 test_files: []