philiprehberger-ring_buffer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 78fe92232bb0a8f2fd0e0f813e3cae0b84354a7d4bb564368cb24f87a1db2301
+  data.tar.gz: 59e0d616ef34b8768d0ee4a3a5c9d43e0bd64900102562b492083074be618765
+SHA512:
+  metadata.gz: 14a8d5350330173fe79afe892ecd084b3928b80d4d7803e237b7b140436710abb8a4c239671bdb6670319d79921af9f9d299c9266a96803805572a9f1f760b97
+  data.tar.gz: b98f3a834bcc2caac032b9afa42d71e4f17b85cf0a61f0480e79e877f734e2f9373d2d8c3b7bfdd424fc43da3095cd95ce691c411bbeb7b88de2f25b6cb5fce4

data/CHANGELOG.md

@@ -0,0 +1,19 @@
+# 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 gem adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2026-03-22
+
+### Added
+
+- Initial release
+- Fixed-capacity circular buffer with overflow
+- Push with automatic oldest-entry eviction
+- Statistics: average, sum, min, max
+- Last-n element retrieval
+- Enumerable support

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,96 @@
+# philiprehberger-ring_buffer
+
+[![Tests](https://github.com/philiprehberger/rb-ring-buffer/actions/workflows/ci.yml/badge.svg)](https://github.com/philiprehberger/rb-ring-buffer/actions/workflows/ci.yml)
+[![Gem Version](https://badge.fury.io/rb/philiprehberger-ring_buffer.svg)](https://rubygems.org/gems/philiprehberger-ring_buffer)
+[![License](https://img.shields.io/github/license/philiprehberger/rb-ring-buffer)](LICENSE)
+
+Fixed-size circular buffer with overflow, statistics, and enumeration
+
+## Requirements
+
+- Ruby >= 3.1
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem 'philiprehberger-ring_buffer'
+```
+
+Or install directly:
+
+```bash
+gem install philiprehberger-ring_buffer
+```
+
+## Usage
+
+```ruby
+require 'philiprehberger/ring_buffer'
+
+buf = Philiprehberger::RingBuffer.new(3)
+buf.push(1)
+buf.push(2)
+buf.push(3)
+buf.push(4)      # overwrites 1
+buf.to_a          # => [2, 3, 4]
+buf.full?         # => true
+```
+
+### Statistics
+
+```ruby
+buf = Philiprehberger::RingBuffer.new(100)
+[10, 20, 30].each { |v| buf.push(v) }
+
+buf.average  # => 20.0
+buf.sum      # => 60
+buf.min      # => 10
+buf.max      # => 30
+```
+
+### Last N Elements
+
+```ruby
+buf = Philiprehberger::RingBuffer.new(10)
+(1..10).each { |v| buf.push(v) }
+buf.last(3)  # => [8, 9, 10]
+```
+
+### Enumerable
+
+```ruby
+buf = Philiprehberger::RingBuffer.new(5)
+[1, 2, 3].each { |v| buf.push(v) }
+buf.map { |v| v * 2 }     # => [2, 4, 6]
+buf.select(&:odd?)        # => [1, 3]
+```
+
+## API
+
+| Method | Description |
+|--------|-------------|
+| `RingBuffer.new(capacity)` | Create a buffer with fixed capacity |
+| `#push(value)` | Add a value, overwriting oldest if full |
+| `#to_a` | Convert to array (oldest first) |
+| `#size` | Number of elements in the buffer |
+| `#full?` | Whether the buffer is at capacity |
+| `#empty?` | Whether the buffer has no elements |
+| `#average` | Average of numeric elements |
+| `#sum` | Sum of numeric elements |
+| `#min` | Minimum element |
+| `#max` | Maximum element |
+| `#last(n)` | Last n elements (most recent) |
+
+## Development
+
+```bash
+bundle install
+bundle exec rspec      # Run tests
+bundle exec rubocop    # Check code style
+```
+
+## License
+
+MIT

data/lib/philiprehberger/ring_buffer/version.rb

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

data/lib/philiprehberger/ring_buffer.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+require_relative 'ring_buffer/version'
+
+module Philiprehberger
+  class RingBuffer
+    include Enumerable
+
+    class Error < StandardError; end
+
+    attr_reader :capacity
+
+    # Create a new ring buffer with fixed capacity
+    #
+    # @param capacity [Integer] maximum number of elements
+    def initialize(capacity)
+      raise Error, 'capacity must be a positive integer' unless capacity.is_a?(Integer) && capacity.positive?
+
+      @capacity = capacity
+      @buffer = Array.new(capacity)
+      @head = 0
+      @count = 0
+    end
+
+    # Push a value into the buffer, overwriting oldest if full
+    #
+    # @param value [Object]
+    # @return [self]
+    def push(value)
+      @buffer[@head] = value
+      @head = (@head + 1) % @capacity
+      @count += 1 if @count < @capacity
+      self
+    end
+
+    # Convert buffer contents to an array (oldest first)
+    #
+    # @return [Array]
+    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
+    end
+
+    # Number of elements currently in the buffer
+    #
+    # @return [Integer]
+    def size
+      @count
+    end
+
+    # Check if the buffer is full
+    #
+    # @return [Boolean]
+    def full?
+      @count == @capacity
+    end
+
+    # Check if the buffer is empty
+    #
+    # @return [Boolean]
+    def empty?
+      @count.zero?
+    end
+
+    # Calculate average of numeric elements
+    #
+    # @return [Float]
+    def average
+      raise Error, 'buffer is empty' if empty?
+
+      sum.to_f / @count
+    end
+
+    # Calculate sum of numeric elements
+    #
+    # @return [Numeric]
+    def sum
+      raise Error, 'buffer is empty' if empty?
+
+      to_a.sum
+    end
+
+    # Find minimum element
+    #
+    # @return [Object]
+    def min
+      raise Error, 'buffer is empty' if empty?
+
+      to_a.min
+    end
+
+    # Find maximum element
+    #
+    # @return [Object]
+    def max
+      raise Error, 'buffer is empty' if empty?
+
+      to_a.max
+    end
+
+    # Return the last n elements (most recent)
+    #
+    # @param n [Integer] number of elements
+    # @return [Array]
+    def last(n = 1)
+      arr = to_a
+      arr.last(n)
+    end
+
+    # Iterate over elements (oldest first)
+    #
+    # @yield [element]
+    def each(&block)
+      to_a.each(&block)
+    end
+  end
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: philiprehberger-ring_buffer
+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: Fixed-capacity ring buffer that overwrites oldest entries on overflow,
+  with built-in statistics (average, sum, min, max), last-n retrieval, and Enumerable
+  support.
+email:
+- me@philiprehberger.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/philiprehberger/ring_buffer.rb
+- lib/philiprehberger/ring_buffer/version.rb
+homepage: https://github.com/philiprehberger/rb-ring-buffer
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/philiprehberger/rb-ring-buffer
+  source_code_uri: https://github.com/philiprehberger/rb-ring-buffer
+  changelog_uri: https://github.com/philiprehberger/rb-ring-buffer/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/philiprehberger/rb-ring-buffer/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: Fixed-size circular buffer with overflow, statistics, and enumeration
+test_files: []