async-job-adapter-active_job 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37290d3cfe5fd027791f3789dd53094e0ce4cbb5923933072dd2d1b3a01f806a
-  data.tar.gz: 7365c94254728a5be3e8c3215338f6afccd189a837349cda3835c221d42c417f
+  metadata.gz: 65f9e22e242a8c2d9c96fd81e52e5e4ec0d4eeddda402544f808b59d3633cbdb
+  data.tar.gz: e1cf84731daf4ec7d0739fce4d205544c66a111a753b4817939379d816a22a1c
 SHA512:
-  metadata.gz: 518dd58363f88565bc7ce20625bdd3b851012af3b92b772eb236630669c11e662c0012364aeaf5afc901107cd62b4a6fe72cf10deb01984c822ab00aba6dfad9
-  data.tar.gz: 7b8c08c2ec99ea1f2847a1fd01029870b92571c6da41cf9733ba38df489e01de4a17ca4b361976c6f08bbac3bcd67723c0e351e4b7745171509875d6addf0a48
+  metadata.gz: 7cbb5ac1d912f5a1e59ab1d781f8caf3d5de955722195bf407301c1a6bb49a2933d94e3315ad14aa102986be58b70b7b0260e3a8f11b6770c9d30b4b1d1f074a
+  data.tar.gz: 575b40692b1d57984bae97ab7308a194821733299beb0efc03d9d53ba05a9b45a30138c4412d1e0404622c12c95ac4add153118f5fe86374e7423dfc4d40ace8

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

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+
+require 'async/service/configuration'
+require 'async/service/controller'
+
+require 'async/job/adapter/active_job/environment'
+
+configuration = Async::Service::Configuration.build do
+	service "async-job-server" do
+		include Async::Job::Adapter::ActiveJob::Environment
+		
+		root {ENV.fetch('RAILS_ROOT', Dir.pwd)}
+		
+		# If you have multiple queues, you may want to run a separate server for each queue.
+		queue_name ENV.fetch('ASYNC_JOB_ADAPTER_ACTIVE_JOB_QUEUE_NAME', 'default')
+	end
+end
+
+Async::Service::Controller.run(configuration)

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

@@ -14,7 +14,11 @@ module Async
 	module Job
 		module Adapter
 			module ActiveJob
+				# A dispatcher for managing multiple backends.
 				class Dispatcher
+					# Prepare the dispacher with the given backends and aliases.
+					# @parameter backends [Hash(String, Proc)] The backends to use for processing jobs.
+					# @parameter aliases [Hash(String, Proc)] The aliases for the backends.
 					def initialize(backends, aliases = {})
 						@backends = backends
 						@aliases = aliases
@@ -22,10 +26,14 @@ module Async
 						@pipelines = {}
 					end
 					
+					# @attribute [Hash(String, Proc)] The backends to use for processing jobs.
 					attr :backends
 					
+					# @attribute [Hash(String, String)] The aliases for the backends.
 					attr :aliases
 					
+					# Lookup a pipeline by name, constructing it if necessary using the given backend.
+					# @parameter name [String] The name of the pipeline/backend.
 					def [](name)
 						@pipelines.fetch(name) do
 							backend = @backends.fetch(name)
@@ -33,18 +41,21 @@ module Async
 						end
 					end
 					
+					# Enqueue a job for processing.
 					def enqueue(job)
 						name = @aliases.fetch(job.queue_name, job.queue_name)
 						
 						self[name].producer.enqueue(job)
 					end
 					
+					# Enqueue a job for processing at a specific time.
 					def enqueue_at(job, timestamp)
 						name = @aliases.fetch(job.queue_name, job.queue_name)
 						
 						self[name].producer.enqueue_at(job, timestamp)
 					end
 					
+					# Start processing jobs in the given pipeline.
 					def start(name)
 						self[name].consumer.start
 					end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2024, by Samuel Williams.
+
+require_relative 'service'
+
+module Async
+	module Job
+		module Adapter
+			module ActiveJob
+				# The environment for the ActiveJob server.
+				module Environment
+					# The service class to use.
+					def service_class
+						Service
+					end
+					
+					# The name of the queue to use.
+					def queue_name
+						"default"
+					end
+				end
+			end
+		end
+	end
+end

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

@@ -9,11 +9,13 @@ module Async
 	module Job
 		module Adapter
 			module ActiveJob
+				# An executor for processing jobs using `ActiveJob`.
 				class Executor
 					def initialize(delegate = nil)
 						@delegate = delegate
 					end
 					
+					# Execute the given job.
 					def call(job)
 						# Console.debug(self, "Executing job...", id: job["job_id"])
 						::ActiveJob::Base.execute(job)

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

@@ -7,16 +7,19 @@ module Async
 	module Job
 		module Adapter
 			module ActiveJob
+				# An interface for `ActiveJob` that allows you to use `Async::Job` as the backend.
 				class Interface
 					def initialize(delegate)
 						@delegate = delegate
 					end
 					
+					# Enqueue a job for processing.
 					def enqueue(job)
 						# Console.debug(self, "Enqueueing job...", id: job.job_id)
 						@delegate.call(serialize(job))
 					end
 					
+					# Enqueue a job for processing at a specific time.
 					def enqueue_at(job, timestamp)
 						# We assume the given timestamp is the same as `job.scheduled_at` which is true in every case we've seen so far.
 						# Console.debug(self, "Scheduling job...", id: job.job_id, scheduled_at: job.scheduled_at)

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

@@ -8,15 +8,15 @@ require 'thread/local'
 
 require_relative 'dispatcher'
 
-class Thread
-	attr_accessor :async_job_adapter_active_job_dispatcher
-end
+Thread.attr_accessor :async_job_adapter_active_job_dispatcher
 
 module Async
 	module Job
 		module Adapter
 			module ActiveJob
+				# A Rails-specific adapter for `ActiveJob` that allows you to use `Async::Job` as the backend.
 				class Railtie < ::Rails::Railtie
+					# The default pipeline for processing jobs, using the `Inline` backend.
 					DEFAULT_PIPELINE = proc do
 						queue Async::Job::Backend::Inline
 					end
@@ -26,10 +26,16 @@ module Async
 						@aliases = {}
 					end
 					
+					# The backends that are available for processing jobs.
 					attr :backends
 					
+					# The aliases for the backends.
 					attr :aliases
 					
+					# Define a new backend for processing jobs.
+					# @parameter name [String] The name of the backend.
+					# @parameter aliases [Array(String)] The aliases for the backend.
+					# @parameter block [Proc] The block that defines the backend.
 					def backend_for(name, *aliases, &block)
 						@backends[name] = block
 						
@@ -38,6 +44,7 @@ module Async
 						end
 					end
 					
+					# Define an alias for a backend.
 					def alias_for(name, *aliases)
 						aliases.each do |alias_name|
 							@aliases[alias_name] = name
@@ -51,23 +58,29 @@ module Async
 							@aliases = aliases
 						end
 						
+						# The dispatcher for the current thread.
 						def dispatcher
 							Thread.current.async_job_adapter_active_job_dispatcher ||= Dispatcher.new(@backends)
 						end
 						
+						# Enqueue a job to be processed at a specific time.
 						def enqueue_at(job, timestamp)
 							dispatcher.enqueue_at(job, timestamp)
 						end
 						
+						# Enqueue a job to be processed as soon as possible.
 						def enqueue(job)
 							dispatcher.enqueue(job)
 						end
 						
+						# Start processing jobs in the queue with the given name.
+						# @parameter name [String] The name of the backend.
 						def start(name)
 							dispatcher.start(name)
 						end
 					end
 					
+					# Start the job server with the given name.
 					def start(name = "default")
 						config.active_job.queue_adapter.start(name)
 					end

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

@@ -9,21 +9,9 @@ module Async
 	module Job
 		module Adapter
 			module ActiveJob
+				# A job server that can be run as a service.
 				class Service < Async::Service::Generic
-					module Environment
-						def service_class
-							Service
-						end
-						
-						def queue_name
-							"default"
-						end
-					end
-					
-					def self.included(base)
-						base.include(Environment)
-					end
-					
+					# Load the Rails environment and start the job server.
 					def setup(container)
 						container.run(name: self.name, restart: true) do |instance|
 							evaluator = @environment.evaluator

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

@@ -7,7 +7,7 @@ module Async
 	module Job
 		module Adapter
 			module ActiveJob
-				VERSION = "0.6.0"
+				VERSION = "0.7.0"
 			end
 		end
 	end

data/readme.md

@@ -6,45 +6,9 @@ Provides an adapter for ActiveJob on top of `Async::Job`.
 
 ## Usage
 
-Basically, just add this gem to your gemfile:
+Please see the [project documentation](https://socketry.github.io/async-job-adapter-active_job/) for more details.
 
-``` shell
-$ bundle add async-job-adapter-active_job
-```
-
-To run a server, create a service file, e.g. `job-server.rb` with the following content:
-
-``` ruby
-#!/usr/bin/env async-service
-
-require 'async/job/adapter/active_job/service'
-
-service "job-server" do
-	include Async::Job::Adapter::ActiveJob::Service
-end
-```
-
-Then run it:
-
-``` shell
-$ bundle exec ./job-server.rb
-```
-
-### Configuration
-
-``` ruby
-Rails.application.configure do
-	config.async_job.backend_for :default, :critical do
-		queue Async::Job::Backend::Redis, endpoint: Async::IO::Endpoint.tcp('redis.local')
-	end
-	
-	config.async_job.aliases_for :default, :email
-	
-	config.async_job.backend_for :local do
-		queue Async::Job::Backend::Inline
-	end
-end
-```
+  - [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.
 
 ## Contributing
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: async-job-adapter-active_job
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -37,7 +37,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-03-22 00:00:00.000000000 Z
+date: 2024-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-job
@@ -45,28 +45,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.1
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.1
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: async-service
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: '0.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: '0.12'
 - !ruby/object:Gem::Dependency
   name: thread-local
   requirement: !ruby/object:Gem::Requirement
@@ -83,12 +83,15 @@ dependencies:
         version: '0'
 description:
 email:
-executables: []
+executables:
+- async-job-adapter-active_job-server
 extensions: []
 extra_rdoc_files: []
 files:
+- bin/async-job-adapter-active_job-server
 - lib/async/job/adapter/active_job.rb
 - lib/async/job/adapter/active_job/dispatcher.rb
+- lib/async/job/adapter/active_job/environment.rb
 - lib/async/job/adapter/active_job/executor.rb
 - lib/async/job/adapter/active_job/interface.rb
 - lib/async/job/adapter/active_job/railtie.rb
@@ -96,11 +99,12 @@ files:
 - lib/async/job/adapter/active_job/version.rb
 - license.md
 - readme.md
-homepage:
+homepage: https://github.com/socketry/async-job-adapter-active_job
 licenses:
 - MIT
 metadata:
-  documentation_uri: https://socketry.github.io/async-job-adapter-active_job
+  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:
@@ -109,7 +113,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="