philiprehberger-queue_stack 0.4.0 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 8f720c2ee97526d57826cb37fba4be96e6e1143879b7627a2792cef97ffaa1dc
4
- data.tar.gz: 311fdae1a3eb9f31d27f4ef77006eae1f224050418ac97721540d761ac081ac0
3
+ metadata.gz: dba395bc3ee76baae4cdbbbb100fc91103049635c386e02fe5ac3ae118e9997a
4
+ data.tar.gz: 921a8e4241383d570d951e154b19e7abcce5cdb682d93b42888d36c9804871a2
5
5
  SHA512:
6
- metadata.gz: fd4c5bc553fde4d2278b2efa422ed0c4c67aaf63d9c5bc049bce395066ab544533bf2b11696a564769cbd6dbdd900a4c802a12abec032d888d17c0d0d5d0dc36
7
- data.tar.gz: aa1cc6ea3d889cde7c372943df2bb9b5c46d0f87f3e628659e01ebbbf3697a8ce548f41c36508a3f82af14818ca0bd852da74aa577e13abf29899f1b60e6a162
6
+ metadata.gz: 30320f35b2ae5d2e01221091e203c31cc799ec5d6a1ff279a0201a04dd9c038f254ad8319d1e4f8cf3a50e1e292e2522a813e8330383f2f49ce99b86d5704b1c
7
+ data.tar.gz: 2ddd79499fa0b97b99fcb45c5c941984c1f8b3ddeee25cc4edeed317b9317509d9ade981940ca685266770db6dc3d472b11e3fdb8610b45731abd44f7f3a284e
data/CHANGELOG.md CHANGED
@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
7
7
 
8
8
  ## [Unreleased]
9
9
 
10
+ ## [0.5.0] - 2026-04-16
11
+
12
+ ### Added
13
+ - `Queue#dequeue_if { |item| ... }` conditionally removes and returns the front item only when the block returns truthy; returns `nil` when empty or the block returns false (non-blocking)
14
+ - `Stack#pop_if { |item| ... }` conditionally removes and returns the top item only when the block returns truthy; returns `nil` when empty or the block returns false (non-blocking)
15
+
10
16
  ## [0.4.0] - 2026-04-15
11
17
 
12
18
  ### Added
data/README.md CHANGED
@@ -70,6 +70,25 @@ s = Philiprehberger::QueueStack::Stack.new
70
70
  item = s.try_pop(timeout: 5) # waits up to 5 seconds
71
71
  ```
72
72
 
73
+ ### Conditional Removal
74
+
75
+ Remove the front/top item only when a predicate holds. Non-blocking; returns `nil` if the collection is empty or the block returns false (the item stays put).
76
+
77
+ ```ruby
78
+ q = Philiprehberger::QueueStack::Queue.new
79
+ q.enqueue({ priority: 10 })
80
+ q.enqueue({ priority: 2 })
81
+
82
+ # Only take high-priority work
83
+ q.dequeue_if { |job| job[:priority] >= 5 } # => { priority: 10 }
84
+ q.dequeue_if { |job| job[:priority] >= 5 } # => nil (head priority 2 left intact)
85
+
86
+ s = Philiprehberger::QueueStack::Stack.new
87
+ s.push(:ready)
88
+ s.pop_if { |item| item == :ready } # => :ready
89
+ s.pop_if { |item| item == :ready } # => nil (empty)
90
+ ```
91
+
73
92
  ### Drain
74
93
 
75
94
  ```ruby
@@ -150,6 +169,7 @@ q.full? # => true
150
169
  | `#enqueue(item)` | Add item to back (blocks if full) |
151
170
  | `#try_enqueue(item, timeout: nil)` | Non-blocking enqueue, returns true/false (waits up to timeout if given) |
152
171
  | `#dequeue` | Remove and return front item (blocks if empty) |
172
+ | `#dequeue_if { \|item\| ... }` | Remove and return the front item only if the block is truthy (non-blocking) |
153
173
  | `#try_dequeue(timeout:)` | Dequeue with timeout, returns nil on timeout |
154
174
  | `#clear` | Remove all items without returning them |
155
175
  | `#peek` | View front item without removing |
@@ -171,6 +191,7 @@ q.full? # => true
171
191
  | `#push(item)` | Push item on top (blocks if full) |
172
192
  | `#try_push(item, timeout: nil)` | Non-blocking push, returns true/false (waits up to timeout if given) |
173
193
  | `#pop` | Remove and return top item (blocks if empty) |
194
+ | `#pop_if { \|item\| ... }` | Remove and return the top item only if the block is truthy (non-blocking) |
174
195
  | `#try_pop(timeout:)` | Pop with timeout, returns nil on timeout |
175
196
  | `#clear` | Remove all items without returning them |
176
197
  | `#peek` | View top item without removing |
@@ -96,6 +96,24 @@ module Philiprehberger
96
96
  end
97
97
  end
98
98
 
99
+ # Conditionally dequeue the front item. The block is called with the item
100
+ # that would be dequeued next. If the block returns truthy, the item is
101
+ # removed and returned. Otherwise the item is left in place and +nil+ is
102
+ # returned. Returns +nil+ immediately if the queue is empty (non-blocking).
103
+ #
104
+ # @yield [item] the front item
105
+ # @return [Object, nil] the removed item, or nil if empty or block returned false
106
+ def dequeue_if
107
+ @mutex.synchronize do
108
+ return nil if @items.empty?
109
+ return nil unless yield(@items.first)
110
+
111
+ item = @items.shift
112
+ @not_full.signal
113
+ item
114
+ end
115
+ end
116
+
99
117
  # Try to dequeue an item with a timeout.
100
118
  #
101
119
  # @param timeout [Numeric] seconds to wait
@@ -96,6 +96,24 @@ module Philiprehberger
96
96
  end
97
97
  end
98
98
 
99
+ # Conditionally pop the top item. The block is called with the item that
100
+ # would be popped next. If the block returns truthy, the item is removed
101
+ # and returned. Otherwise the item is left in place and +nil+ is returned.
102
+ # Returns +nil+ immediately if the stack is empty (non-blocking).
103
+ #
104
+ # @yield [item] the top item
105
+ # @return [Object, nil] the removed item, or nil if empty or block returned false
106
+ def pop_if
107
+ @mutex.synchronize do
108
+ return nil if @items.empty?
109
+ return nil unless yield(@items.last)
110
+
111
+ item = @items.pop
112
+ @not_full.signal
113
+ item
114
+ end
115
+ end
116
+
99
117
  # Try to pop an item with a timeout.
100
118
  #
101
119
  # @param timeout [Numeric] seconds to wait
@@ -2,6 +2,6 @@
2
2
 
3
3
  module Philiprehberger
4
4
  module QueueStack
5
- VERSION = '0.4.0'
5
+ VERSION = '0.5.0'
6
6
  end
7
7
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: philiprehberger-queue_stack
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.4.0
4
+ version: 0.5.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Philip Rehberger
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2026-04-15 00:00:00.000000000 Z
11
+ date: 2026-04-16 00:00:00.000000000 Z
12
12
  dependencies: []
13
13
  description: Thread-safe queue and stack data structures with configurable capacity
14
14
  limits, blocking enqueue/dequeue with timeouts, and peek operations. Uses Mutex