async-job-adapter-active_job 0.18.2 → 0.18.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78139525c5bd60e912b5c01d8061cdb88340ca1524e67bb69c5ab97e6c9b8d96
-  data.tar.gz: 835dc24d9d85c2ac5e63746ea508fa9bf3e739b3f4dbc7baeab6c57d86c4e5b7
+  metadata.gz: d1bbfff85274ea269f116a3f132597b47f3ea3b5c779e8f893be417667e97b51
+  data.tar.gz: df0c48976f7491946920cfc22d5f55c54ed721c3d2a64648132549f61704d53a
 SHA512:
-  metadata.gz: b3692d7a9129eaa924ebc56e184eaa7f40b865538eb0f264d59cebe96a120b143fb64710ac5c9b8a2e4485f2a0c55ac1195067e6e0fd18c33287c642c15d4c0b
-  data.tar.gz: a0370cb74d1250d67266508981dda880d02e2800309fb7a01b46e438c390e674992114082cd8498c25a5c0499371a70b500fc9304768807efb0fdae86826de61
+  metadata.gz: cfdbc700bb7a0590654d2738179d88da75fd3af5c8144283dd17a227ab57f81943f37b19b316a095165bb0f0590d299a331b114c11324abef2b1439d1e2bd9b5
+  data.tar.gz: eefa235bc071368f8d699556b682772e54d8d28dcb17ac2533c214be530b7504211208212320d3fc2d902dc50bd5f04b6b8c71d628f2f05743acd5b0ccde8e5a

data/context/getting-started.md

@@ -0,0 +1,98 @@
+# Getting Started
+
+This guide explains how to get started with the `async-job-adapter-active_job` gem.
+
+## Installation
+
+Add the gem to your Rails project:
+
+``` bash
+$ bundle add async-job-adapter-active_job
+```
+
+## Core Concepts
+
+The `async-job-adapter-active_job` gem provides an Active Job adapter for the `async-job` gem. This allows you to use the `async-job` gem with Rails' built-in Active Job framework.
+
+- The {ruby Async::Job::ActiveJob::Dispatcher} class manages zero or more queues.
+- The {ruby Async::Job::ActiveJob::Railtie} class provides a convenient interface for configuring the integration.
+
+In general, `Async::Job` has a concept of queues, where jobs enter into a queue, may get serialized to a queue, then deserialized and processed. This ActiveJob adapter provides {ruby Async::Job::ActiveJob::Interface} which goes at the head of the queue, and matches the interface that ActiveJob expects for enqueueing jobs. At the tail of the queue, the {ruby Async::Job::ActiveJob::Executor} class is responsible for processing jobs by dispatching back into ActiveJob.
+
+## Usage
+
+In order to use `Async::Job`, you need to define your queues and configure the Active Job adapter. Here is an example configuration:
+
+### `ActiveJob` Queue Adapter Configuration
+
+You can configure the ActiveJob queue adapter globally (in `config/application.rb`) or per-environment (in `config/environments/*.rb`).
+
+```
+# In config/application.rb or config/environments/*.rb
+
+config.active_job.queue_adapter = :async_job
+```
+
+### `Async::Job` Queue Configuration
+
+You can define your queues in an initializer file (e.g., `config/initializers/async_job.rb`). Here is an example configuration that sets up two queues: a default queue using Redis and a local queue that processes jobs inline.
+
+``` ruby
+# config/initializers/async_job.rb
+
+require "async/job/processor/redis"
+require "async/job/processor/inline"
+
+Rails.application.configure do
+	# Create a queue for the "default" backend:
+	config.async_job.define_queue "default" do
+		dequeue Async::Job::Processor::Redis
+	end
+	
+	# Create a queue named "local" which uses the Inline backend:
+	config.async_job.define_queue "local" do
+		dequeue Async::Job::Processor::Inline
+	end
+end
+```
+
+#### Job Specific Configuration
+
+Rather than using `Async::Job` for all jobs, you could opt in using a specific queue adapter for a specific job. Here is an example:
+
+``` ruby
+class MyJob < ApplicationJob
+	self.queue_adapter = :async_job
+	queue_as :local
+	
+	# ...
+end
+```
+
+### Running A Server
+
+If you are using a queue that requires a server (e.g. Redis), you will need to run a server. A simple server is provided `async-job-adapter-active_job-server`, which by default will run all define queues.
+
+``` bash
+$ bundle exec async-job-adapter-active_job-server
+```
+
+You can specify different queues using the `ASYNC_JOB_ADAPTER_ACTIVE_JOB_QUEUE_NAMES` environment variable.
+
+Alternatively, you may prefer to run your own service. See the code in `bin/async-job-adapter-active_job-server` for an example of how to run a server using a service definition.
+
+### Enqueuing Jobs
+
+To enqueue a job, you can use the `perform_later` method in your Active Job class. Here is an example:
+
+``` ruby
+class MyJob < ApplicationJob
+	queue_as :default
+	
+	def perform(message)
+		puts message
+	end
+end
+
+MyJob.perform_later("Hello, world!")
+```

data/context/index.yaml

@@ -0,0 +1,12 @@
+# Automatically generated context index for Utopia::Project guides.
+# Do not edit then files in this directory directly, instead edit the guides and then run `bake utopia:project:agent:context:update`.
+---
+description: A asynchronous job queue for Ruby on Rails.
+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
+files:
+- path: getting-started.md
+  title: Getting Started
+  description: This guide explains how to get started with the `async-job-adapter-active_job`
+    gem.

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

@@ -7,7 +7,7 @@ module Async
 	module Job
 		module Adapter
 			module ActiveJob
-				VERSION = "0.18.2"
+				VERSION = "0.18.3"
 			end
 		end
 	end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: async-job-adapter-active_job
 version: !ruby/object:Gem::Version
-  version: 0.18.2
+  version: 0.18.3
 platform: ruby
 authors:
 - Samuel Williams
@@ -74,6 +74,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - bin/async-job-adapter-active_job-server
+- context/getting-started.md
+- context/index.yaml
 - lib/active_job/queue_adapters/async_job_adapter.rb
 - lib/async/job/adapter/active_job.rb
 - lib/async/job/adapter/active_job/dispatcher.rb