ring_buffer 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e07ec3f0bcf2339338a61268b3212cc5340d02bd
+  data.tar.gz: fa926215c7fe0b7806e1a50556fcd969f85f66b0
+SHA512:
+  metadata.gz: 403669104df1ef321ed05462d59341fbccc215f4258f400ae5ea20d207b8d38d2621e38711b574fa41ee6fea018bf0f32255f7535e5e23f6b0d0124a340a0d81
+  data.tar.gz: e69f51c42c402b1a1b161365e65813b6022aa9ed1f19a8355e50fa8840bb8e313550daad17c85a70925711bc0a04abc98b716377b2f5acd6202754febefa8b4e

data/.bundle/config

@@ -0,0 +1,3 @@
+---
+BUNDLE_PATH: "./vendor/.bundle"
+BUNDLE_DISABLE_SHARED_GEMS: "true"

data/.gitignore

@@ -0,0 +1,11 @@
+/vendor/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.3.5

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.2
+before_install: gem install bundler -v 1.15.4

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in ring_buffer.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    ring_buffer (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    method_source (0.9.0)
+    pry (0.11.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (12.1.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.15)
+  pry
+  rake (~> 12.1)
+  ring_buffer!
+  rspec (~> 3.6)
+
+BUNDLED WITH
+   1.15.4

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 TODO: Write your name
+
+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,68 @@
+# ring_buffer
+
+ring_buffer provides a simple ring buffer implementation in Ruby. A ring buffer
+is a queue with a maximum capacity. When the capacity exceeds, the first
+element inserted is removed.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ring_buffer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ring_buffer
+
+## Usage
+
+```ruby
+buffer = RingBuffer.new 2
+buffer << 'first element'
+buffer << 'second element'
+buffer << 'third element'
+p buffer
+# ['second element', 'third element']
+```
+
+## Development
+
+After checking out the repository, run `bin/setup` to install dependencies.
+Then, run `rake spec` to run the tests. You can also run `bin/console` for an
+interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+### Without installing Ruby globally
+
+On my work station, I prefer to use a Docker image with Ruby installed instead
+of installing Ruby locally. Hence, any `bundle …` command can be prefixed with
+`docker-compose run ring-buffer`. For instance, running the tests is done with
+the command `docker-compose run ring-buffer bundle exec rake spec`.
+
+## Acknowledgment
+
+This gem is a generalization of the wonderful work from
+[Nimster](https://github.com/Nimster/) and its
+[`ringbuffer`](https://gist.github.com/Nimster/4078106#file-ringbuffer-rb)
+gist.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/EtienneM/proc_parser.
+
+## License
+
+The gem is available as open source under the terms of the [MIT
+License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ring_buffer"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/docker-compose.yml

@@ -0,0 +1,12 @@
+version: '2'
+services:
+  ring-buffer:
+    image: ruby:2.3
+    environment:
+      BUNDLE_BIN: "/usr/src/app/vendor/.bundle/ruby/2.3.0/bin"
+      BUNDLE_PATH: "/usr/src/app/vendor/.bundle/ruby/2.3.0"
+      BUNDLE_APP_CONFIG: "/usr/src/app/.bundle"
+    working_dir: /usr/src/app
+    volumes:
+      - ./:/usr/src/app/
+    command: "true"

data/lib/ring_buffer.rb

@@ -0,0 +1,22 @@
+require 'ring_buffer/version'
+
+class RingBuffer < Array
+  attr_reader :max_size
+
+  alias :push :<<
+
+  def initialize(max_size)
+    raise 'max_size must be an integer' if !max_size.is_a? Integer
+    raise 'max_size must be positive' if max_size < 0
+
+    @max_size = max_size
+  end
+
+  def <<(element)
+    return super(element) if size < @max_size
+
+    # If the RingBuffer is full, remove the first element and add the new at the end.
+    shift
+    push element
+  end
+end

data/lib/ring_buffer/version.rb

@@ -0,0 +1,3 @@
+class RingBuffer < Array
+  VERSION = '1.0.0'
+end

data/ring_buffer.gemspec

@@ -0,0 +1,41 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ring_buffer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ring_buffer'
+  spec.version       = RingBuffer::VERSION
+  spec.authors       = ['Étienne Michon']
+  spec.email         = ['etienne@scalingo.com']
+
+  spec.summary       = 'RingBuffer provides a simple ring buffer implementation in Ruby'
+  spec.description   = 'RingBuffer provides a simple ring buffer implementation in Ruby. A ring
+                        buffer is a queue with a maximum capacity. When the capacity exceeds, the
+                        first element inserted is removed.'
+
+  spec.homepage      = 'https://github.com/EtienneM/ring_buffer'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '~> 12.1'
+  spec.add_development_dependency 'rspec', '~> 3.6'
+  spec.add_development_dependency 'pry'
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: ring_buffer
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Étienne Michon
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: |-
+  RingBuffer provides a simple ring buffer implementation in Ruby. A ring
+                          buffer is a queue with a maximum capacity. When the capacity exceeds, the
+                          first element inserted is removed.
+email:
+- etienne@scalingo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".bundle/config"
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- docker-compose.yml
+- lib/ring_buffer.rb
+- lib/ring_buffer/version.rb
+- ring_buffer.gemspec
+homepage: https://github.com/EtienneM/ring_buffer
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.2.1
+signing_key: 
+specification_version: 4
+summary: RingBuffer provides a simple ring buffer implementation in Ruby
+test_files: []