philiprehberger-queue_stack 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bb3c47dcfc192e615cba4fd45499c4795e9e75709dc5c2e3f49558e24f66079f
+  data.tar.gz: 47622c2ace206565ca68368c15c8b8145a825138cae4125b8fe65781938a36b2
+SHA512:
+  metadata.gz: a022329cdb118ca730b1ff1587bd3347cc5c42a5531f946e28a4cd660cce234ab38b0436afa3cdcb8d956afd571d97f7aeaf4db7465cad4df0bac33a90df5e54
+  data.tar.gz: 0b8843ed669a90e5e3f906fe64e5df242298d6a8d2e33a8206e2830dc59da164a112af8b2c1c0fb072b0c7c38a945777e826729aac2c4ef79ffbc9600494f02d

data/CHANGELOG.md

@@ -0,0 +1,20 @@
+# Changelog
+
+All notable changes to this gem will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2026-03-22
+
+### Added
+- Initial release
+- Thread-safe FIFO Queue with enqueue, dequeue, peek, and size
+- Thread-safe LIFO Stack with push, pop, peek, and size
+- Configurable capacity limits for both Queue and Stack
+- Blocking operations that wait when empty or at capacity
+- Timeout-based try_dequeue and try_pop operations
+- Empty and full status checks
+- Mutex and ConditionVariable for thread-safe access

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,117 @@
+# philiprehberger-queue_stack
+
+[![Tests](https://github.com/philiprehberger/rb-queue-stack/actions/workflows/ci.yml/badge.svg)](https://github.com/philiprehberger/rb-queue-stack/actions/workflows/ci.yml)
+[![Gem Version](https://badge.fury.io/rb/philiprehberger-queue_stack.svg)](https://rubygems.org/gems/philiprehberger-queue_stack)
+[![License](https://img.shields.io/github/license/philiprehberger/rb-queue-stack)](LICENSE)
+
+Thread-safe Queue and Stack with capacity limits and blocking operations
+
+## Requirements
+
+- Ruby >= 3.1
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem 'philiprehberger-queue_stack'
+```
+
+Or install directly:
+
+```bash
+gem install philiprehberger-queue_stack
+```
+
+## Usage
+
+```ruby
+require 'philiprehberger/queue_stack'
+
+q = Philiprehberger::QueueStack::Queue.new(capacity: 100)
+q.enqueue('task')
+item = q.dequeue  # => 'task'
+```
+
+### Queue (FIFO)
+
+```ruby
+q = Philiprehberger::QueueStack::Queue.new(capacity: 10)
+q.enqueue('first')
+q.enqueue('second')
+q.dequeue   # => 'first'
+q.peek      # => 'second'
+q.size      # => 1
+```
+
+### Stack (LIFO)
+
+```ruby
+s = Philiprehberger::QueueStack::Stack.new(capacity: 10)
+s.push('first')
+s.push('second')
+s.pop       # => 'second'
+s.peek      # => 'first'
+s.size      # => 1
+```
+
+### Blocking with Timeout
+
+```ruby
+q = Philiprehberger::QueueStack::Queue.new
+item = q.try_dequeue(timeout: 5)  # waits up to 5 seconds
+
+s = Philiprehberger::QueueStack::Stack.new
+item = s.try_pop(timeout: 5)  # waits up to 5 seconds
+```
+
+### Capacity Limits
+
+```ruby
+q = Philiprehberger::QueueStack::Queue.new(capacity: 3)
+q.full?   # => false
+3.times { |i| q.enqueue(i) }
+q.full?   # => true
+# enqueue blocks until space is available
+```
+
+## API
+
+### `Queue`
+
+| Method | Description |
+|--------|-------------|
+| `.new(capacity:)` | Create a queue with optional capacity limit |
+| `#enqueue(item)` | Add item to back (blocks if full) |
+| `#dequeue` | Remove and return front item (blocks if empty) |
+| `#try_dequeue(timeout:)` | Dequeue with timeout, returns nil on timeout |
+| `#peek` | View front item without removing |
+| `#size` | Number of items |
+| `#empty?` | Whether the queue is empty |
+| `#full?` | Whether the queue is at capacity |
+
+### `Stack`
+
+| Method | Description |
+|--------|-------------|
+| `.new(capacity:)` | Create a stack with optional capacity limit |
+| `#push(item)` | Push item on top (blocks if full) |
+| `#pop` | Remove and return top item (blocks if empty) |
+| `#try_pop(timeout:)` | Pop with timeout, returns nil on timeout |
+| `#peek` | View top item without removing |
+| `#size` | Number of items |
+| `#empty?` | Whether the stack is empty |
+| `#full?` | Whether the stack is at capacity |
+
+## Development
+
+```bash
+bundle install
+bundle exec rspec      # Run tests
+bundle exec rubocop    # Check code style
+```
+
+## License
+
+MIT

data/lib/philiprehberger/queue_stack/queue.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module Philiprehberger
+  module QueueStack
+    # Thread-safe FIFO queue with optional capacity limit and blocking operations.
+    #
+    # @example
+    #   q = Queue.new(capacity: 10)
+    #   q.enqueue('item')
+    #   q.dequeue  # => 'item'
+    class Queue
+      # Create a new queue.
+      #
+      # @param capacity [Integer, nil] maximum number of items (nil for unlimited)
+      def initialize(capacity: nil)
+        @items = []
+        @capacity = capacity
+        @mutex = Mutex.new
+        @not_empty = ConditionVariable.new
+        @not_full = ConditionVariable.new
+      end
+
+      # Add an item to the back of the queue. Blocks if at capacity.
+      #
+      # @param item [Object] the item to enqueue
+      # @return [void]
+      def enqueue(item)
+        @mutex.synchronize do
+          @not_full.wait(@mutex) while @capacity && @items.length >= @capacity
+          @items.push(item)
+          @not_empty.signal
+        end
+      end
+
+      # Remove and return the front item. Blocks if empty.
+      #
+      # @return [Object] the dequeued item
+      def dequeue
+        @mutex.synchronize do
+          @not_empty.wait(@mutex) while @items.empty?
+          item = @items.shift
+          @not_full.signal
+          item
+        end
+      end
+
+      # Try to dequeue an item with a timeout.
+      #
+      # @param timeout [Numeric] seconds to wait
+      # @return [Object, nil] the dequeued item or nil on timeout
+      def try_dequeue(timeout:)
+        deadline = Time.now + timeout
+        @mutex.synchronize do
+          while @items.empty?
+            remaining = deadline - Time.now
+            return nil if remaining <= 0
+
+            @not_empty.wait(@mutex, remaining)
+          end
+          item = @items.shift
+          @not_full.signal
+          item
+        end
+      end
+
+      # Peek at the front item without removing it.
+      #
+      # @return [Object, nil] the front item or nil if empty
+      def peek
+        @mutex.synchronize { @items.first }
+      end
+
+      # Return the number of items in the queue.
+      #
+      # @return [Integer]
+      def size
+        @mutex.synchronize { @items.length }
+      end
+
+      # Whether the queue is empty.
+      #
+      # @return [Boolean]
+      def empty?
+        @mutex.synchronize { @items.empty? }
+      end
+
+      # Whether the queue is at capacity.
+      #
+      # @return [Boolean]
+      def full?
+        @mutex.synchronize { @capacity ? @items.length >= @capacity : false }
+      end
+    end
+  end
+end

data/lib/philiprehberger/queue_stack/stack.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module Philiprehberger
+  module QueueStack
+    # Thread-safe LIFO stack with optional capacity limit and blocking operations.
+    #
+    # @example
+    #   s = Stack.new(capacity: 10)
+    #   s.push('item')
+    #   s.pop  # => 'item'
+    class Stack
+      # Create a new stack.
+      #
+      # @param capacity [Integer, nil] maximum number of items (nil for unlimited)
+      def initialize(capacity: nil)
+        @items = []
+        @capacity = capacity
+        @mutex = Mutex.new
+        @not_empty = ConditionVariable.new
+        @not_full = ConditionVariable.new
+      end
+
+      # Push an item onto the top of the stack. Blocks if at capacity.
+      #
+      # @param item [Object] the item to push
+      # @return [void]
+      def push(item)
+        @mutex.synchronize do
+          @not_full.wait(@mutex) while @capacity && @items.length >= @capacity
+          @items.push(item)
+          @not_empty.signal
+        end
+      end
+
+      # Pop and return the top item. Blocks if empty.
+      #
+      # @return [Object] the popped item
+      def pop
+        @mutex.synchronize do
+          @not_empty.wait(@mutex) while @items.empty?
+          item = @items.pop
+          @not_full.signal
+          item
+        end
+      end
+
+      # Try to pop an item with a timeout.
+      #
+      # @param timeout [Numeric] seconds to wait
+      # @return [Object, nil] the popped item or nil on timeout
+      def try_pop(timeout:)
+        deadline = Time.now + timeout
+        @mutex.synchronize do
+          while @items.empty?
+            remaining = deadline - Time.now
+            return nil if remaining <= 0
+
+            @not_empty.wait(@mutex, remaining)
+          end
+          item = @items.pop
+          @not_full.signal
+          item
+        end
+      end
+
+      # Peek at the top item without removing it.
+      #
+      # @return [Object, nil] the top item or nil if empty
+      def peek
+        @mutex.synchronize { @items.last }
+      end
+
+      # Return the number of items in the stack.
+      #
+      # @return [Integer]
+      def size
+        @mutex.synchronize { @items.length }
+      end
+
+      # Whether the stack is empty.
+      #
+      # @return [Boolean]
+      def empty?
+        @mutex.synchronize { @items.empty? }
+      end
+
+      # Whether the stack is at capacity.
+      #
+      # @return [Boolean]
+      def full?
+        @mutex.synchronize { @capacity ? @items.length >= @capacity : false }
+      end
+    end
+  end
+end

data/lib/philiprehberger/queue_stack/version.rb

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

data/lib/philiprehberger/queue_stack.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative 'queue_stack/version'
+require_relative 'queue_stack/queue'
+require_relative 'queue_stack/stack'
+
+module Philiprehberger
+  module QueueStack
+    class Error < StandardError; end
+  end
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: philiprehberger-queue_stack
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Philip Rehberger
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-03-22 00:00:00.000000000 Z
+dependencies: []
+description: Thread-safe queue and stack data structures with configurable capacity
+  limits, blocking enqueue/dequeue with timeouts, and peek operations. Uses Mutex
+  and ConditionVariable for safe concurrent access.
+email:
+- me@philiprehberger.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/philiprehberger/queue_stack.rb
+- lib/philiprehberger/queue_stack/queue.rb
+- lib/philiprehberger/queue_stack/stack.rb
+- lib/philiprehberger/queue_stack/version.rb
+homepage: https://github.com/philiprehberger/rb-queue-stack
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/philiprehberger/rb-queue-stack
+  source_code_uri: https://github.com/philiprehberger/rb-queue-stack
+  changelog_uri: https://github.com/philiprehberger/rb-queue-stack/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/philiprehberger/rb-queue-stack/issues
+  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.0
+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: Thread-safe Queue and Stack with capacity limits and blocking operations
+test_files: []