tiny_ring 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0310e9d9d45217d00a3c355cd4858c8643ee3e35461c97d61e55a71afd70f66f
+  data.tar.gz: a0cd6337aa725c55a617bc9e39a44ab1d8e411359824f87cf5eae09db8553f99
+SHA512:
+  metadata.gz: 98a113680b76baab7dbc4f2c2273aa142c12ef6c69a29de626e99d913e3fbc7a5b1df1970ed497b812b4da47972fd539c9ef14d94dffc29e14dc284dd5c5a0f3
+  data.tar.gz: feb8d20566eb55c86fa194c35577b17db3f9407288b42dd7164f2707d63c2f88545dc3e921d8a2ad8db4385c1c819d6b4288de2afea2a2ff218df8d7593d87b3

data/lib/tiny_ring.rb

@@ -0,0 +1,35 @@
+# memory efficient ring buffer implementation
+#
+# usage:
+#   > tr = TinyRing.new(3)
+#   > tr << 1               # => [1, nil, nil]
+#   > tr << 2               # => [1, 2, nil]
+#   > tr << 3               # => [1, 2, 3]
+#   > tr << 4               # => [4, 2, 3]
+#   > puts tr.to_a.inspect  # => [2, 3, 4]
+class TinyRing
+  def initialize(size)
+    @size = size
+    @buffer = Array.new(size)
+    @current_index = 0
+  end
+
+  def push(item)
+    @buffer[@current_index] = item
+    @current_index = (@current_index + 1) % @size
+  end
+  alias << push
+
+  # returns the items most recently inserted into the ring buffer the most
+  #   recently added item item added to the buffer.
+  # returns nil if the buffer is empty
+  def last
+    previous_index = (@current_index - 1) % @size
+    @buffer[previous_index]
+  end
+
+  # Returns the contents of the buffer as an Array, ordered from oldest to newest.
+  def to_a
+    (@buffer[@current_index..-1] + @buffer[0...@current_index]).compact
+  end
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: tiny_ring
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jeff Lunt
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-09-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: a tiny ring buffer implementation
+email: jefflunt@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/tiny_ring.rb
+homepage: https://github.com/jefflunt/tiny_ring
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: a tiny ring buffer implementation that is memory efficient
+test_files: []