philiprehberger-ring_buffer 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c769e36a185afb7b7b200d7fc7d29822c067460b135f64f32ca5157164f070fc
-  data.tar.gz: 40ce5c2dc5f27dc4aab0ebf8fe376e5e971c31acac25cb47248c7b212eadeeed
+  metadata.gz: 8d3a987697f096aa8b9d085eeb0a4bcd6f83a5af1a0c2afcae477a6e789bbcdf
+  data.tar.gz: 66b3843e018fbb2f2e02d72d6b727e7cae71a64c299ac7e4e29747aebc8cf351
 SHA512:
-  metadata.gz: a9a1dc2bdbbe335dccf1607aea535bbf7baf21e5b1bcbcd3e4d05f49a84f0a13f927abdc1086b70d3019c13e6ed495105a25e1145f73550135851ef2b05a0c7a
-  data.tar.gz: 873932dfa685d64a5ceaa0d677241ffa821a917ced571dbbf5b97a737d53fcc85024ce28f6d01004b2045737bae0f1325a62f72607a6261bf8b6335a76b24716
+  metadata.gz: 10d2a15e1fc6afeb68d4c8a760170eddbec9c833c3c552fb72d9c3ea72d9efe5c741c1f0beca5375592344ffbac699b27d49fd3c18f75988bbc0e289078eb7f4
+  data.tar.gz: be638339a29c4492487f1aefca54a2235256b09a7a8f3c07eda3b72a7e5df29e9aea9f77d9e2a7225ef9c54735b6ab17a173e0b1153edb23549ca9e0a3b1f133

data/CHANGELOG.md

@@ -7,6 +7,26 @@ and this gem adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 ## [Unreleased]
 
+## [0.4.0] - 2026-04-14
+
+### Added
+- `#resize(new_capacity)` to dynamically change buffer capacity while preserving elements
+- `#inspect` for human-readable string representation
+
+### Fixed
+- Bug report template: Ruby version now required, gem version field added
+- Feature request template: added "Alternatives considered" field and API placeholder
+
+## [0.3.0] - 2026-04-09
+
+### Added
+- `#shift` removes and returns the oldest element
+- `#pop` removes and returns the newest element
+- `#oldest` and `#newest` peek without mutating
+
+### Changed
+- Internal `to_a` now derives the start index from `@head` and `@count`, supporting consumption via `shift`/`pop` while preserving all existing semantics
+
 ## [0.2.0] - 2026-04-03
 
 ### Added
@@ -57,3 +77,14 @@ and this gem adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 - Statistics: average, sum, min, max
 - Last-n element retrieval
 - Enumerable support
+
+[0.4.0]: https://github.com/philiprehberger/rb-ring-buffer/releases/tag/v0.4.0
+[0.3.0]: https://github.com/philiprehberger/rb-ring-buffer/releases/tag/v0.3.0
+[0.2.0]: https://github.com/philiprehberger/rb-ring-buffer/releases/tag/v0.2.0
+[0.1.6]: https://github.com/philiprehberger/rb-ring-buffer/releases/tag/v0.1.6
+[0.1.5]: https://github.com/philiprehberger/rb-ring-buffer/releases/tag/v0.1.5
+[0.1.4]: https://github.com/philiprehberger/rb-ring-buffer/releases/tag/v0.1.4
+[0.1.3]: https://github.com/philiprehberger/rb-ring-buffer/releases/tag/v0.1.3
+[0.1.2]: https://github.com/philiprehberger/rb-ring-buffer/releases/tag/v0.1.2
+[0.1.1]: https://github.com/philiprehberger/rb-ring-buffer/releases/tag/v0.1.1
+[0.1.0]: https://github.com/philiprehberger/rb-ring-buffer/releases/tag/v0.1.0

data/README.md

@@ -70,6 +70,24 @@ buf.size   # => 0
 buf.empty? # => true
 ```
 
+### Consuming Elements
+
+```ruby
+buf = Philiprehberger::RingBuffer.new(3)
+[1, 2, 3].each { |v| buf.push(v) }
+
+buf.shift    # => 1   (removes oldest)
+buf.pop      # => 3   (removes newest)
+buf.to_a     # => [2]
+
+buf.push(4)
+buf.push(5)
+buf.oldest   # => 2   (peek, no mutation)
+buf.newest   # => 5
+```
+
+`shift`, `pop`, `oldest`, and `newest` all return `nil` when the buffer is empty.
+
 ### Statistics
 
 ```ruby
@@ -85,6 +103,20 @@ buf.stddev    # => 8.16496580927726
 buf.median    # => 20.0
 ```
 
+### Resize
+
+```ruby
+buf = Philiprehberger::RingBuffer.new(3)
+[1, 2, 3].each { |v| buf.push(v) }
+
+buf.resize(5)
+buf.capacity     # => 5
+buf.to_a         # => [1, 2, 3]
+
+buf.resize(2)
+buf.to_a         # => [2, 3] (keeps most recent)
+```
+
 ### Enumerable
 
 ```ruby
@@ -100,6 +132,10 @@ buf.select(&:odd?)        # => [1, 3]
 |--------|-------------|
 | `RingBuffer.new(capacity)` | Create a buffer with fixed capacity |
 | `#push(value)` | Add a value, overwriting oldest if full |
+| `#shift` | Remove and return the oldest element (or `nil`) |
+| `#pop` | Remove and return the newest element (or `nil`) |
+| `#oldest` | Peek the oldest element without removing (or `nil`) |
+| `#newest` | Peek the newest element without removing (or `nil`) |
 | `#[](index)` | Access by index (0 = oldest, -1 = newest) |
 | `#to_a` | Convert to array (oldest first) |
 | `#size` | Number of elements in the buffer |
@@ -108,6 +144,8 @@ buf.select(&:odd?)        # => [1, 3]
 | `#first(n)` | First n elements (oldest) |
 | `#last(n)` | Last n elements (most recent) |
 | `#clear` | Remove all elements, reset state |
+| `#resize(new_capacity)` | Change buffer capacity, keeping most recent elements |
+| `#inspect` | Human-readable string representation |
 | `#average` | Average of numeric elements |
 | `#sum` | Sum of numeric elements |
 | `#min` | Minimum element |

data/lib/philiprehberger/ring_buffer/version.rb

@@ -2,6 +2,6 @@
 
 module Philiprehberger
   class RingBuffer
-    VERSION = '0.2.0'
+    VERSION = '0.4.0'
   end
 end

data/lib/philiprehberger/ring_buffer.rb

@@ -39,12 +39,53 @@ module Philiprehberger
     def to_a
       return [] if @count.zero?
 
-      if @count < @capacity
-        @buffer[0...@count]
-      else
-        start = @head
-        Array.new(@capacity) { |i| @buffer[(start + i) % @capacity] }
-      end
+      start = (@head - @count) % @capacity
+      Array.new(@count) { |i| @buffer[(start + i) % @capacity] }
+    end
+
+    # Remove and return the oldest element
+    #
+    # @return [Object, nil]
+    def shift
+      return nil if empty?
+
+      start = (@head - @count) % @capacity
+      value = @buffer[start]
+      @buffer[start] = nil
+      @count -= 1
+      value
+    end
+
+    # Remove and return the newest element
+    #
+    # @return [Object, nil]
+    def pop
+      return nil if empty?
+
+      newest_idx = (@head - 1) % @capacity
+      value = @buffer[newest_idx]
+      @buffer[newest_idx] = nil
+      @head = newest_idx
+      @count -= 1
+      value
+    end
+
+    # Return the oldest element without removing it
+    #
+    # @return [Object, nil]
+    def oldest
+      return nil if empty?
+
+      @buffer[(@head - @count) % @capacity]
+    end
+
+    # Return the newest element without removing it
+    #
+    # @return [Object, nil]
+    def newest
+      return nil if empty?
+
+      @buffer[(@head - 1) % @capacity]
     end
 
     # Number of elements currently in the buffer
@@ -180,6 +221,36 @@ module Philiprehberger
       end
     end
 
+    # Change the buffer capacity, preserving elements
+    #
+    # If the new capacity is smaller than the current element count,
+    # the oldest elements are discarded and only the most recent
+    # new_capacity elements are kept.
+    #
+    # @param new_capacity [Integer] the new maximum number of elements
+    # @return [self]
+    def resize(new_capacity)
+      raise Error, 'capacity must be a positive integer' unless new_capacity.is_a?(Integer) && new_capacity.positive?
+      return self if new_capacity == @capacity
+
+      elements = to_a
+      elements = elements.last(new_capacity) if elements.length > new_capacity
+
+      @capacity = new_capacity
+      @buffer = Array.new(new_capacity)
+      @head = 0
+      @count = 0
+      elements.each { |e| push(e) }
+      self
+    end
+
+    # Human-readable string representation
+    #
+    # @return [String]
+    def inspect
+      "#<#{self.class} capacity=#{@capacity} size=#{@count} elements=#{to_a.inspect}>"
+    end
+
     # Iterate over elements (oldest first)
     #
     # @yield [element]

metadata

@@ -1,18 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: philiprehberger-ring_buffer
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Philip Rehberger
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-04-03 00:00:00.000000000 Z
+date: 2026-04-14 00:00:00.000000000 Z
 dependencies: []
 description: Fixed-capacity ring buffer that overwrites oldest entries on overflow,
-  with index access, built-in statistics (average, sum, min, max, variance, stddev,
-  median), first/last-n retrieval, and Enumerable support.
+  with index access, push/pop/shift mutation, oldest/newest peek, built-in statistics
+  (average, sum, min, max, variance, stddev, median), first/last-n retrieval, and
+  Enumerable support.
 email:
 - me@philiprehberger.com
 executables: []