100% documentation coverage.

Author: samuel-williams-shopify

lib/active_job/queue_adapters/async_job_adapter.rb

@@ -7,9 +7,14 @@
 
 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

lib/async/job/adapter/active_job.rb

@@ -10,3 +10,16 @@
 	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

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

@@ -42,6 +42,8 @@ def [](name)
 						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 @@ def start(name)
 						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

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

@@ -22,6 +22,8 @@ def root
 						ENV.fetch("RAILS_ROOT", Dir.pwd)
 					end
 
+					# Get the default dispatcher instance.
+					# @returns [Object] The dispatcher from the Railtie.
 					def dispatcher
 						Railtie.dispatcher
 					end

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

@@ -17,10 +17,14 @@ module Adapter
 			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 @@ def call(job)
 						@delegate&.call(job)
 					end
 
+					# Start the delegate if present.
 					def start
 						@delegate&.start
 					end
 
+					# Stop the delegate if present.
 					def stop
 						@delegate&.stop
 					end

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

@@ -19,6 +19,7 @@ class Railtie < ::Rails::Railtie
 						dequeue Processor::Inline
 					end
 
+					# Initialize the railtie with default queue configuration.
 					def initialize
 						@definitions = {"default" => DEFAULT_QUEUE_DEFINITION}
 						@aliases = {}

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

@@ -13,6 +13,9 @@ module Adapter
 			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 @@ def dispatcher
 						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