philiprehberger-priority_queue 0.1.7 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6c6189abf62a5cd7a03eec4626b908cfb8fbfd954e8183dbb5ebe43f421105f
-  data.tar.gz: 8af43691f143f9c673f56fed46d90486d9e0616ca938939bd99e5e62262b0bb9
+  metadata.gz: e95bdf19e31db232c54ac6ee645aa4a9023fc87140d2be6310c8469e4a5440d2
+  data.tar.gz: 944088fb4246573e985496a73fa8ca50a369da021274c050b8db926e3a6f7b4c
 SHA512:
-  metadata.gz: fbb8db631237032ac270c43fe2c5a1f9e9c33a906a4e2c60def195451ade5d930196ffdaf44cd3342d21228a870c98d493ff31764fe0f7587e488b74a82003e7
-  data.tar.gz: 12603ff8ef9d42bbac4fb3f364dab1b6edda0904962752e5ada257a022ec060f801d27175a7954c0849a2bd7499d78d9899d2a578bd6b1019ad26a32761a95cc
+  metadata.gz: 5c21fb11db45c81cc229b54ac6a8589000543141859a47abe483be620825e7662ce5b89228b278927e5665e842443300421641a9e494d372d3921f43bbcaad5a
+  data.tar.gz: 7efaf2fe7884442250b83e94e4c9e472f82b50e0ce7ee7ae8cc0f2390674cdd7827176de9c77baefd7df1a81b02ffca32260429545dbda04e9ea0566e0602db1

data/CHANGELOG.md

@@ -7,6 +7,23 @@ and this gem adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 ## [Unreleased]
 
+## [0.1.10] - 2026-03-31
+
+### Changed
+- Standardize README badges, support section, and license format
+
+## [0.1.9] - 2026-03-26
+
+### Changed
+- Add Sponsor badge to README
+- Fix License section format
+
+
+## [0.1.8] - 2026-03-24
+
+### Changed
+- Add Usage subsections and expand API table in README
+
 ## [0.1.7] - 2026-03-24
 
 ### Fixed

data/README.md

@@ -2,7 +2,7 @@
 
 [![Tests](https://github.com/philiprehberger/rb-priority-queue/actions/workflows/ci.yml/badge.svg)](https://github.com/philiprehberger/rb-priority-queue/actions/workflows/ci.yml)
 [![Gem Version](https://badge.fury.io/rb/philiprehberger-priority_queue.svg)](https://rubygems.org/gems/philiprehberger-priority_queue)
-[![License](https://img.shields.io/github/license/philiprehberger/rb-priority-queue)](LICENSE)
+[![Last updated](https://img.shields.io/github/last-commit/philiprehberger/rb-priority-queue)](https://github.com/philiprehberger/rb-priority-queue/commits/main)
 
 Binary heap priority queue with min/max modes, custom comparators, and priority updates
 
@@ -31,45 +31,78 @@ require "philiprehberger/priority_queue"
 
 # Min-heap (default) - lowest priority first
 queue = Philiprehberger::PriorityQueue::Queue.new
-queue.push('low', priority: 1)
-queue.push('high', priority: 10)
-queue.push('mid', priority: 5)
+queue.push("low", priority: 1)
+queue.push("high", priority: 10)
+queue.push("mid", priority: 5)
 
 queue.pop   # => "low"
 queue.pop   # => "mid"
 queue.pop   # => "high"
 
-# Max-heap - highest priority first
+# Peek without removing
+queue.push("item", priority: 1)
+queue.peek   # => "item"
+queue.size   # => 1
+queue.empty? # => false
+
+# Shovel operator for hash-based push
+queue << { item: "task", priority: 3 }
+```
+
+### Max-Heap Mode
+
+Pass `mode: :max` to pop the highest priority first.
+
+```ruby
 queue = Philiprehberger::PriorityQueue::Queue.new(mode: :max)
-queue.push('task_a', priority: 3)
-queue.push('task_b', priority: 7)
-queue.pop   # => "task_b"
+queue.push("task_a", priority: 3)
+queue.push("task_b", priority: 7)
+queue.push("task_c", priority: 1)
+
+queue.pop # => "task_b"
+queue.pop # => "task_a"
+queue.pop # => "task_c"
+```
+
+### Custom Comparator
 
-# Custom comparator
+Supply a block to define your own ordering. The block receives two priorities and must return `-1`, `0`, or `1`.
+
+```ruby
 queue = Philiprehberger::PriorityQueue::Queue.new { |a, b| a.length <=> b.length }
-queue.push('short', priority: 'short')
-queue.push('very long', priority: 'very long')
-queue.pop   # => "short"
+queue.push("short", priority: "short")
+queue.push("very long", priority: "very long")
+queue.pop # => "short"
+```
 
-# Peek without removing
-queue = Philiprehberger::PriorityQueue::Queue.new
-queue.push('item', priority: 1)
-queue.peek  # => "item"
-queue.size  # => 1
+### Priority Updates
+
+Change the priority of an item already in the queue. The heap re-balances automatically.
 
-# Change priority
+```ruby
 queue = Philiprehberger::PriorityQueue::Queue.new
-queue.push('task', priority: 10)
-queue.change_priority('task', 1)  # now highest priority in min-heap
+queue.push("task_a", priority: 10)
+queue.push("task_b", priority: 5)
+
+queue.change_priority("task_a", 1) # task_a is now highest priority
+queue.pop # => "task_a"
+```
+
+### Merging Queues
 
-# Merge queues
-merged = queue1.merge(queue2)
+Combine two queues into a new queue. The originals are unchanged.
 
-# Other operations
-queue.include?('task')  # => true
-queue.to_a              # => items sorted by priority
-queue.empty?            # => false
-queue.clear             # removes all items
+```ruby
+q1 = Philiprehberger::PriorityQueue::Queue.new
+q1.push("a", priority: 1)
+q1.push("b", priority: 3)
+
+q2 = Philiprehberger::PriorityQueue::Queue.new
+q2.push("c", priority: 2)
+
+merged = q1.merge(q2)
+merged.to_a # => ["a", "c", "b"]
+merged.size # => 3
 ```
 
 ## API
@@ -77,15 +110,16 @@ queue.clear             # removes all items
 | Method | Description |
 |--------|-------------|
 | `Queue.new(mode: :min, &comparator)` | Create a priority queue; mode can be `:min` or `:max`; optional custom comparator block |
-| `#push(item, priority:)` | Add an item with the given priority |
-| `#pop` | Remove and return the highest-priority item |
-| `#peek` | Return the highest-priority item without removing it |
+| `#push(item, priority:)` | Add an item with the given priority; returns `self` for chaining |
+| `#<<(item:, priority:)` | Shovel operator; push via a hash with `:item` and `:priority` keys |
+| `#pop` | Remove and return the highest-priority item; returns `nil` when empty |
+| `#peek` | Return the highest-priority item without removing it; returns `nil` when empty |
 | `#size` | Return the number of items in the queue |
 | `#empty?` | Return `true` if the queue has no items |
-| `#change_priority(item, new_priority)` | Update the priority of an existing item and re-heapify |
-| `#to_a` | Return all items sorted by priority |
+| `#change_priority(item, new_priority)` | Update the priority of an existing item and re-heapify; raises `ArgumentError` if item not found |
+| `#to_a` | Return all items sorted by priority with FIFO tie-breaking |
 | `#include?(item)` | Return `true` if the item is in the queue |
-| `#clear` | Remove all items from the queue |
+| `#clear` | Remove all items from the queue; returns `self` |
 | `#merge(other)` | Return a new queue containing items from both queues |
 
 ## Development
@@ -96,6 +130,24 @@ bundle exec rspec
 bundle exec rubocop
 ```
 
+## Support
+
+If you find this project useful:
+
+⭐ [Star the repo](https://github.com/philiprehberger/rb-priority-queue)
+
+🐛 [Report issues](https://github.com/philiprehberger/rb-priority-queue/issues?q=is%3Aissue+is%3Aopen+label%3Abug)
+
+💡 [Suggest features](https://github.com/philiprehberger/rb-priority-queue/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement)
+
+❤️ [Sponsor development](https://github.com/sponsors/philiprehberger)
+
+🌐 [All Open Source Projects](https://philiprehberger.com/open-source-packages)
+
+💻 [GitHub Profile](https://github.com/philiprehberger)
+
+🔗 [LinkedIn Profile](https://www.linkedin.com/in/philiprehberger)
+
 ## License
 
-MIT
+[MIT](LICENSE)

data/lib/philiprehberger/priority_queue/version.rb

@@ -2,6 +2,6 @@
 
 module Philiprehberger
   module PriorityQueue
-    VERSION = '0.1.7'
+    VERSION = '0.1.10'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: philiprehberger-priority_queue
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.10
 platform: ruby
 authors:
 - philiprehberger
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-03-25 00:00:00.000000000 Z
+date: 2026-03-31 00:00:00.000000000 Z
 dependencies: []
 description: A binary heap-based priority queue supporting min-heap, max-heap, and
   custom comparator modes. Features O(log n) push/pop, priority changes, merge operations,