Add release notes, modernize code.

samuel-williams-shopify · samuel-williams-shopify · commit bfdc5ea89ac7 · 2025-07-31T18:25:24.000+12:00
diff --git a/.github/workflows/documentation-coverage.yaml b/.github/workflows/documentation-coverage.yaml
@@ -6,7 +6,6 @@ permissions:
   contents: read
 
 env:
-  CONSOLE_OUTPUT: XTerm
   COVERAGE: PartialSummary
 
 jobs:
@@ -17,7 +16,7 @@ jobs:
     - uses: actions/checkout@v4
     - uses: ruby/setup-ruby@v1
       with:
-        ruby-version: "3.4"
+        ruby-version: ruby
         bundler-cache: true
     
     - name: Validate coverage
diff --git a/.github/workflows/documentation.yaml b/.github/workflows/documentation.yaml
@@ -17,7 +17,6 @@ concurrency:
   cancel-in-progress: true
 
 env:
-  CONSOLE_OUTPUT: XTerm
   BUNDLE_WITH: maintenance
 
 jobs:
@@ -29,7 +28,7 @@ jobs:
 
     - uses: ruby/setup-ruby@v1
       with:
-        ruby-version: "3.4"
+        ruby-version: ruby
         bundler-cache: true
     
     - name: Installing packages
diff --git a/.github/workflows/rubocop.yaml b/.github/workflows/rubocop.yaml
@@ -5,9 +5,6 @@ on: [push, pull_request]
 permissions:
   contents: read
 
-env:
-  CONSOLE_OUTPUT: XTerm
-
 jobs:
   check:
     runs-on: ubuntu-latest
diff --git a/.github/workflows/test-coverage.yaml b/.github/workflows/test-coverage.yaml
@@ -6,7 +6,6 @@ permissions:
   contents: read
 
 env:
-  CONSOLE_OUTPUT: XTerm
   COVERAGE: PartialSummary
 
 jobs:
@@ -21,7 +20,7 @@ jobs:
           - macos
         
         ruby:
-          - "3.4"
+          - ruby
     
     steps:
     - uses: actions/checkout@v4
@@ -49,7 +48,7 @@ jobs:
     - uses: actions/checkout@v4
     - uses: ruby/setup-ruby@v1
       with:
-        ruby-version: "3.4"
+        ruby-version: ruby
         bundler-cache: true
     
     - uses: actions/download-artifact@v4
diff --git a/.github/workflows/test-external.yaml b/.github/workflows/test-external.yaml
@@ -5,9 +5,6 @@ on: [push, pull_request]
 permissions:
   contents: read
 
-env:
-  CONSOLE_OUTPUT: XTerm
-
 jobs:
   test:
     name: ${{matrix.ruby}} on ${{matrix.os}}
diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml
@@ -5,9 +5,6 @@ on: [push, pull_request]
 permissions:
   contents: read
 
-env:
-  CONSOLE_OUTPUT: XTerm
-
 jobs:
   test:
     name: ${{matrix.ruby}} on ${{matrix.os}}
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,5 @@
 /.bundle
+/.context
 /pkg
 /gems.locked
 /.covered.db
diff --git a/.rubocop.yml b/.rubocop.yml
@@ -1,6 +1,12 @@
+plugins:
+  - rubocop-socketry
+
 AllCops:
   DisabledByDefault: true
 
+Layout/ConsistentBlankLineIndentation:
+  Enabled: true
+
 Layout/IndentationStyle:
   Enabled: true
   EnforcedStyle: tabs
diff --git a/bake.rb b/bake.rb
@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2025, by Samuel Williams.
+
+# Update the project documentation with the new version number.
+#
+# @parameter version [String] The new version number.
+def after_gem_release_version_increment(version)
+	context["releases:update"].call(version)
+	context["utopia:project:readme:update"].call
+end
diff --git a/config/sus.rb b/config/sus.rb
@@ -2,6 +2,7 @@
 
 # Released under the MIT License.
 # Copyright, 2024-2025, by Samuel Williams.
+# Copyright, 2025, by Shopify Inc.
 
 require "covered/sus"
 include Covered::Sus
diff --git a/examples/benchmark/async-job-client.rb b/examples/benchmark/async-job-client.rb
@@ -3,6 +3,7 @@
 
 # Released under the MIT License.
 # Copyright, 2024-2025, by Samuel Williams.
+# Copyright, 2025, by Shopify Inc.
 
 require_relative "config/environment"
 
diff --git a/examples/benchmark/async-job-server.rb b/examples/benchmark/async-job-server.rb
@@ -3,6 +3,7 @@
 
 # Released under the MIT License.
 # Copyright, 2024-2025, by Samuel Williams.
+# Copyright, 2025, by Shopify Inc.
 
 require "async/job/adapter/active_job/service"
 
diff --git a/examples/benchmark/benchmark_job.rb b/examples/benchmark/benchmark_job.rb
@@ -2,6 +2,7 @@
 
 # Released under the MIT License.
 # Copyright, 2024-2025, by Samuel Williams.
+# Copyright, 2025, by Shopify Inc.
 
 require "active_job"
 
diff --git a/examples/benchmark/config/environment.rb b/examples/benchmark/config/environment.rb
@@ -2,6 +2,7 @@
 
 # Released under the MIT License.
 # Copyright, 2024-2025, by Samuel Williams.
+# Copyright, 2025, by Shopify Inc.
 
 require "rails"
 require "active_job/railtie"
diff --git a/examples/benchmark/sidekiq-client.rb b/examples/benchmark/sidekiq-client.rb
@@ -3,6 +3,7 @@
 
 # Released under the MIT License.
 # Copyright, 2024-2025, by Samuel Williams.
+# Copyright, 2025, by Shopify Inc.
 
 require "rails"
 require "active_job/railtie"
diff --git a/examples/client_and_server/base_job.rb b/examples/client_and_server/base_job.rb
@@ -3,6 +3,7 @@
 # Released under the MIT License.
 # Copyright, 2024, by Alexey Ivanov.
 # Copyright, 2024-2025, by Samuel Williams.
+# Copyright, 2025, by Shopify Inc.
 
 class BaseJob
 	def initialize(id, *args, scheduled_at: nil, **kwargs)
diff --git a/examples/client_and_server/client.rb b/examples/client_and_server/client.rb
@@ -3,6 +3,7 @@
 # Released under the MIT License.
 # Copyright, 2024-2025, by Samuel Williams.
 # Copyright, 2024, by Alexey Ivanov.
+# Copyright, 2025, by Shopify Inc.
 
 require "async"
 require "async/redis"
diff --git a/examples/client_and_server/example_job.rb b/examples/client_and_server/example_job.rb
@@ -3,6 +3,7 @@
 # Released under the MIT License.
 # Copyright, 2024, by Alexey Ivanov.
 # Copyright, 2024-2025, by Samuel Williams.
+# Copyright, 2025, by Shopify Inc.
 
 require_relative "base_job"
 
diff --git a/examples/client_and_server/server.rb b/examples/client_and_server/server.rb
@@ -3,6 +3,7 @@
 # Released under the MIT License.
 # Copyright, 2024-2025, by Samuel Williams.
 # Copyright, 2024, by Alexey Ivanov.
+# Copyright, 2025, by Shopify Inc.
 
 require "async"
 require "async/redis"
diff --git a/gems.rb b/gems.rb
@@ -14,6 +14,7 @@
 group :maintenance, optional: true do
 	gem "bake-gem"
 	gem "bake-modernize"
+	gem "bake-releases"
 	
 	gem "utopia-project"
 end
@@ -22,7 +23,9 @@
 	gem "sus"
 	gem "covered"
 	gem "decode"
+
 	gem "rubocop"
+	gem "rubocop-socketry"
 	
 	gem "sus-fixtures-async"
 	gem "sus-fixtures-console"
diff --git a/lib/async/job/builder.rb b/lib/async/job/builder.rb
@@ -41,23 +41,23 @@ def initialize(delegate = nil)
 			# @parameter middleware [Class] The middleware class to add.
 			def enqueue(middleware, ...)
 				@enqueue << ->(delegate){middleware.new(delegate, ...)}
-
+				
 				return self
 			end
 			
 			# Add middleware to the dequeue pipeline.
 			# @parameter middleware [Class] The middleware class to add.
 			def dequeue(middleware, ...)
 				@dequeue << ->(delegate){middleware.new(delegate, ...)}
-
+				
 				return self
 			end
 			
 			# Set the delegate that will execute the jobs.
 			# @parameter delegate [Object] The delegate object.
 			def delegate(delegate)
 				@delegate = delegate
-
+				
 				return self
 			end
 			
diff --git a/readme.md b/readme.md
@@ -14,6 +14,10 @@ Please see the [project documentation](https://socketry.github.io/async-job/) fo
 
   - [Aggregate Queue](https://socketry.github.io/async-job/guides/aggregate-queue/index) - This guide explains how to use the Aggregate queue to reduce input latency and improve the performance of your application.
 
+## Releases
+
+There are no documented releases.
+
 ## See Also
 
   - [async-job-processor-redis](https://github.com/socketry/async-job-processor-redis) - Redis processor for `async-job` (similar to Sidekiq).
diff --git a/releases.md b/releases.md
@@ -0,0 +1,108 @@
+# Releases
+
+## Unreleased
+
+
+## v0.10.0
+
+  - **Breaking Change**: Extract redis support into separate gem.
+  - Remove block argument from job processing as it's no longer particularly useful.
+
+## v0.9.2
+
+  - Add documentation.
+  - Revert `fail` -> `retry` behavior.
+
+## v0.9.1
+
+  - Minor improvements.
+
+## v0.9.0
+
+  - **Breaking Change**: Reorganize processor code and add delayed processor.
+  - **Breaking Change**: Rename `queue` -> `processor` and `pipeline` -> `queue`.
+  - **Breaking Change**: Rename pipeline producer/consumer -> client/server.
+  - **Breaking Change**: Rename `Backend` -> `Queue`.
+  - Add generic backend implementation.
+  - Fix some words and reduce logging.
+
+## v0.8.0
+
+  - Add `#start`/`#stop` methods.
+
+## v0.7.1
+
+  - Minor improvements to aggregate backend.
+  - Ensure aggregate buffer shuts down gracefully (#4).
+
+## v0.7.0
+
+  - Add aggregation backend.
+  - Add documentation regarding aggregate backend.
+  - Prefer `before do` ... in tests.
+
+## v0.6.0
+
+  - Add support for delegate pass-through.
+  - Modernize gem.
+  - Add client and server example (#3).
+  - Fix gem name in guide.
+
+## v0.5.0
+
+  - Add benchmark example.
+  - Add support for `Async::Idler`.
+  - Add link to `async-job-adapter-active_job`.
+
+## v0.4.2
+
+  - "Fix" JSON coder.
+
+## v0.4.1
+
+  - Fix enqueue typo.
+  - Support returning nil => no-op in `Builder#build`.
+
+## v0.4.0
+
+  - Add more documentation.
+  - Modernize gem.
+  - Add pipeline builder.
+  - **Breaking Change**: Use String key for "scheduled_at".
+  - **Breaking Change**: Prefer `delegate` terminology for next step in the queue.
+  - **Breaking Change**: Rename `enqueue` -> `call` for consistency with queue metaphor.
+  - **Breaking Change**: Rename `perform_at` -> `scheduled_at`.
+  - Add support for coders, and remove `schedule` in favour of `enqueue`.
+  - Add redis to workflows.
+
+## v0.3.0
+
+  - Add inline backend + explicit handler for processing jobs.
+
+## v0.2.1
+
+  - Minor fixes.
+
+## v0.2.0
+
+  - Add generic backend constructor + tests.
+
+## v0.1.0
+
+  - Don't log all the things.
+  - Move ActiveJob adapter code to `async-job-adapter-active_job`.
+  - Add ActiveJobServer service.
+  - Fix invalid syntax.
+  - Add utopia-project for documentation.
+  - Add some basic tests.
+  - Add active_job adapter.
+
+## v0.0.0
+
+  - Initial release with `bake-gem` for release management.
+  - Add example client and server.
+  - Split `test.rb` -> `client.rb` and `server.rb` for easier testing.
+  - Tidy up job store implementation.
+  - Add generic job implementation.
+  - Redis backend working.
+  - Initial noodling.
diff --git a/test/async/job/buffer.rb b/test/async/job/buffer.rb
@@ -61,7 +61,7 @@ def stop
 			expect(buffer.pop).to be == job2
 			expect(buffer).to be(:empty?)
 		end
-				
+		
 		it "can start without a delegate" do
 			expect{buffer.start}.not.to raise_exception
 		end
diff --git a/test/async/job/builder.rb b/test/async/job/builder.rb
diff --git a/test/async/job/processor/aggregate.rb b/test/async/job/processor/aggregate.rb
diff --git a/test/async/job/processor/generic.rb b/test/async/job/processor/generic.rb
diff --git a/test/async/job/processor/inline.rb b/test/async/job/processor/inline.rb
diff --git a/test/async/job/queue.rb b/test/async/job/queue.rb

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`/.bundle`
	`2`	`+/.context`
`2`	`3`	`/pkg`
`3`	`4`	`/gems.locked`
`4`	`5`	`/.covered.db`