philiprehberger-task_queue 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0234cce054f1fc8e8923a25a414198c1863bfa035f9e9881ab38b48c484460d4
+  data.tar.gz: e93358c9bec5ab194464dbdec66cdbf9ff414970d21e4539b578c9f01effd6ff
+SHA512:
+  metadata.gz: 045c07963ff8f40a847eb375b2b04830f092fe5d0355fc3cf0db59865328083141f6859b2c18abbe46d844c8cd4af3b25143cfa79f4b01fabb28fc7e3acf0a2f
+  data.tar.gz: f6d1b9a18e472fc17b717b65a076918319e83445d30f668df121833207fe7b70345d6e1b0264951b95e3f39f79643c4d6f8e3d0e575ee918175dc152cf2d9470

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [0.1.0] - 2026-03-10
+
+### Added
+
+- Initial release
+- In-process async job queue with configurable concurrency
+- Thread-safe task enqueuing with `push` / `<<`
+- Graceful shutdown with timeout support
+- Auto-starting worker threads on first push

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 philiprehberger
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,58 @@
+# philiprehberger-task_queue
+
+[![Gem Version](https://badge.fury.io/rb/philiprehberger-task_queue.svg)](https://rubygems.org/gems/philiprehberger-task_queue)
+[![CI](https://github.com/philiprehberger/rb-task-queue/actions/workflows/ci.yml/badge.svg)](https://github.com/philiprehberger/rb-task-queue/actions/workflows/ci.yml)
+
+In-process async job queue with concurrency control for Ruby.
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem "philiprehberger-task_queue"
+```
+
+Or install directly:
+
+```sh
+gem install philiprehberger-task_queue
+```
+
+## Usage
+
+```ruby
+require "philiprehberger/task_queue"
+
+queue = Philiprehberger::TaskQueue.new(concurrency: 4)
+
+10.times do |i|
+  queue.push { puts "Processing job #{i}" }
+end
+
+puts queue.size      # number of pending tasks
+puts queue.running?  # => true
+
+queue.shutdown(timeout: 30)
+```
+
+### Using the `<<` alias
+
+```ruby
+queue << -> { puts "Hello from a task!" }
+```
+
+## API
+
+| Method | Description |
+|---|---|
+| `.new(concurrency: 4)` | Create a new queue with the given max worker count |
+| `#push(&block)` | Enqueue a task (block) for async execution |
+| `#<< (&block)` | Alias for `#push` |
+| `#size` | Number of pending (not yet started) tasks |
+| `#running?` | Whether the queue is accepting new tasks |
+| `#shutdown(timeout: 30)` | Gracefully stop all workers, waiting up to `timeout` seconds |
+
+## License
+
+[MIT](LICENSE)

data/lib/philiprehberger/task_queue/queue.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+require_relative "worker"
+
+module Philiprehberger
+  module TaskQueue
+    # In-process async job queue with concurrency control.
+    #
+    # Tasks are enqueued as blocks or callable objects and executed by a pool of
+    # worker threads. The queue is fully thread-safe.
+    class Queue
+      # @param concurrency [Integer] maximum number of concurrent worker threads
+      def initialize(concurrency: 4)
+        @concurrency = concurrency
+        @tasks = []
+        @mutex = Mutex.new
+        @condition = ConditionVariable.new
+        @workers = []
+        @running = true
+        @started = false
+      end
+
+      # Enqueue a task to be processed asynchronously.
+      #
+      # @param callable [#call, nil] a callable object (used by +<<+)
+      # @yield the block to execute (takes precedence over +callable+)
+      # @return [self]
+      def push(callable = nil, &block)
+        task = block || callable
+        raise ArgumentError, "a block is required" unless task
+
+        @mutex.synchronize do
+          raise "queue is shut down" unless @running
+
+          start_workers unless @started
+          @tasks << task
+          @condition.signal
+        end
+
+        self
+      end
+
+      alias << push
+
+      # Number of pending (not yet started) tasks.
+      #
+      # @return [Integer]
+      def size
+        @mutex.synchronize { @tasks.size }
+      end
+
+      # Whether the queue is accepting new tasks.
+      #
+      # @return [Boolean]
+      def running?
+        @mutex.synchronize { @running }
+      end
+
+      # Gracefully shut down the queue.
+      #
+      # Signals all workers to finish their current task and drain remaining
+      # tasks, then waits up to +timeout+ seconds for threads to exit.
+      #
+      # @param timeout [Numeric] seconds to wait for workers to finish
+      # @return [void]
+      def shutdown(timeout: 30)
+        signal_shutdown
+        wait_for_workers(timeout)
+        nil
+      end
+
+      private
+
+      def signal_shutdown
+        @mutex.synchronize do
+          return unless @running
+
+          @running = false
+          @workers.each(&:stop)
+          @condition.broadcast
+        end
+      end
+
+      def wait_for_workers(timeout)
+        deadline = Process.clock_gettime(Process::CLOCK_MONOTONIC) + timeout
+        @workers.each do |worker|
+          remaining = deadline - Process.clock_gettime(Process::CLOCK_MONOTONIC)
+          worker.thread&.join([remaining, 0].max)
+        end
+      end
+
+      def start_workers
+        @concurrency.times do
+          @workers << Worker.new(@tasks, @mutex, @condition)
+        end
+        @started = true
+      end
+    end
+  end
+end

data/lib/philiprehberger/task_queue/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Philiprehberger
+  module TaskQueue
+    VERSION = "0.1.0"
+  end
+end

data/lib/philiprehberger/task_queue/worker.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Philiprehberger
+  module TaskQueue
+    # Worker processes tasks from the queue in a dedicated thread.
+    class Worker
+      attr_reader :thread
+
+      def initialize(queue, mutex, condition)
+        @queue = queue
+        @mutex = mutex
+        @condition = condition
+        @running = true
+        @thread = Thread.new { run }
+      end
+
+      def stop
+        @running = false
+      end
+
+      def alive?
+        @thread&.alive? || false
+      end
+
+      private
+
+      def run
+        loop do
+          task = next_task
+          break unless task
+
+          execute(task)
+        end
+      end
+
+      def next_task
+        @mutex.synchronize do
+          @condition.wait(@mutex) while @queue.empty? && @running
+          return nil unless @running || !@queue.empty?
+
+          @queue.shift
+        end
+      end
+
+      def execute(task)
+        task.call
+      rescue StandardError
+        # Swallow exceptions to keep the worker alive.
+      end
+    end
+  end
+end

data/lib/philiprehberger/task_queue.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative "task_queue/version"
+require_relative "task_queue/queue"
+
+module Philiprehberger
+  module TaskQueue
+    # Convenience constructor.
+    #
+    # @param options [Hash] forwarded to {Queue#initialize}
+    # @return [Queue]
+    def self.new(**options)
+      Queue.new(**options)
+    end
+  end
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: philiprehberger-task_queue
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Philip Rehberger
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-03-10 00:00:00.000000000 Z
+dependencies: []
+description: A lightweight, zero-dependency, thread-safe in-process async job queue
+  with configurable concurrency for Ruby applications.
+email:
+- me@philiprehberger.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/philiprehberger/task_queue.rb
+- lib/philiprehberger/task_queue/queue.rb
+- lib/philiprehberger/task_queue/version.rb
+- lib/philiprehberger/task_queue/worker.rb
+homepage: https://github.com/philiprehberger/rb-task-queue
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/philiprehberger/rb-task-queue
+  source_code_uri: https://github.com/philiprehberger/rb-task-queue
+  changelog_uri: https://github.com/philiprehberger/rb-task-queue/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: In-process async job queue with concurrency control
+test_files: []