circular_queue 0.0.5 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ec86881eee3351cb2f8f6dc4bd4bb36991a7a76331f5f31f51c108e0743b1d9b
+  data.tar.gz: 187c3358ade45e3e313b501182d1091abf9800949d23f6dc4aa6aef0862f1e33
+SHA512:
+  metadata.gz: 7431d4752102a6e68a6196fdf3c3c766dca1c3db468a03d086aabda32f02831613c257c9b6e9dd517709e3f5f7f28ed7dfa1b099efe8fe0ca8b9386a74c9e993
+  data.tar.gz: 893ee822375a8b0b846e333967629e6a70cbb98e966f3b618283ec39b46ea3f8960365eec108fa33d9aca931332715c570390ff91dd26d0496ebbf592ada6c15

data/.gitignore

@@ -1,7 +1,9 @@
-bin/
 *.gem
 .bundle
-Gemfile.lock
-pkg/*
-doc
 .yardoc
+Gemfile.lock
+/tags
+/bin/
+/doc/
+/pkg/*
+/spec/failures.txt

data/.rspec

@@ -1,3 +1,2 @@
 --color
---format doc
---order random
+--require spec_helper

data/.travis.yml

@@ -1,9 +1,12 @@
+dist: xenial
+language: ruby
 rvm:
-  - 1.9.2
-  - 1.9.3
-  # - rbx-2.0 <https://github.com/rubinius/rubinius/issues/811>
+  - 2.4
+  - 2.5
+  - 2.6
   - jruby
-env:
-  - JRUBY_OPTS="--1.9" RBXOPT="-X19"
+before_install:
+  - gem update --system
+  - gem install bundler
 notifications:
   disabled: true

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.0.0] - 2019-04-18
+### Added
+- Changelog (you're looking at!).
+
+### Changed
+- Extract MIT License into its own file, for GitHub UX.
+
+### Removed
+- Drop support for older Rubies (Ruby 2.4+).

data/LICENSE.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright (c) 2011 Andy Lindeman
+
+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

@@ -1,36 +1,23 @@
 # Circular Queue
 
+[![Gem Version](https://badge.fury.io/rb/circular_queue.svg)](https://badge.fury.io/rb/circular_queue)
 [![Build Status](https://secure.travis-ci.org/alindeman/circular_queue.png)](http://travis-ci.org/alindeman/circular_queue)
 
-Data structure that uses a single, fixed-size buffer as if it were connected
-end-to-end.
+Data structure that uses a single, fixed-size buffer as if it were connected end-to-end.
 
-**circular_queue** *requires* Ruby 1.9 or a Ruby implementation that
-supports 1.9 syntax and standard library (e.g., JRuby in 1.9 mode;
-Rubinius 2.0 should work if/when Mutex#sleep is implemented).
+### Support
 
-Documentation, including example use, is covered in the [API
-Docs](http://rdoc.info/github/alindeman/circular_queue/master/CircularQueue).
+`circular_queue` officially supports the [currently supported Ruby versions][rubies], which tends to mean the last three major release.
+As of now that's Ruby 2.6, 2.5, and 2.4.
+Older Rubies, back to Ruby 1.9, *might* work, but are not officially supported.
 
-## License
+### Documentation
 
-Copyright (c) 2011 Andy Lindeman
+Documentation, including example use, is covered in the [API Docs][api-docs].
 
-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:
+### [Changelog](CHANGELOG.md)
 
-The above copyright notice and this permission notice shall be included
-in all copies or substantial portions of the Software.
+### [License](LICENSE.md)
 
-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.
+[api-docs]: http://rdoc.info/github/alindeman/circular_queue/master/CircularQueue
+[rubies]: https://www.ruby-lang.org/en/downloads/branches/ "Ruby Maintenance Branches"

data/Rakefile

@@ -2,4 +2,4 @@ require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
-task :default => :spec
+task default: :spec

data/circular_queue.gemspec

@@ -1,23 +1,31 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |s|
   s.name        = "circular_queue"
-  s.version     = "0.0.5"
+  s.version     = "1.0.0"
   s.authors     = ["Andy Lindeman"]
   s.email       = ["alindeman@gmail.com"]
+
+  s.summary     = "Data structure that uses a single, fixed-size buffer as if it were connected end-to-end"
   s.homepage    = "https://github.com/alindeman/circular_queue"
-  s.summary     = %q{Data structure that uses a single, fixed-size buffer as if it were connected end-to-end}
-  s.description = %q{A circular queue (also called a circular buffer or ring buffer) is useful when buffering data streams}
+  s.description = "A circular queue (also called a circular buffer or ring buffer) is useful when buffering data streams"
+  s.license     = "MIT"
+  s.metadata    = {
+    "homepage_uri" => "https://github.com/alindeman/circular_queue",
+    "changelog_uri" => "https://github.com/alindeman/circular_queue/blob/master/CHANGELOG.md",
+    "source_code_uri" => "https://github.com/alindeman/circular_queue",
+  }
 
   s.rubyforge_project = "circular_queue"
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_development_dependency "rspec", "~>2.11.0"
+  s.add_development_dependency "bundler", "~> 2.0"
+  s.add_development_dependency "rspec", "~> 3.8.0"
   s.add_development_dependency "rake"
   s.add_development_dependency "yard"
 end

data/lib/circular_queue.rb

@@ -1,5 +1,3 @@
-require "thread"
-
 # A thread-safe queue with a size limitation. When more elements than the
 # capacity are added, the queue either loops back on itself (removing the
 # oldest elements first) or raises an error (if `enq!` is used).
@@ -38,7 +36,7 @@ class CircularQueue
     @data     = Array.new(capacity)
 
     @mutex    = Mutex.new
-    @waiting  = Array.new
+    @waiting  = []
 
     clear
   end
@@ -73,7 +71,7 @@ class CircularQueue
   # @raise [ThreadError] non_block was true and the queue was empty
   def deq(non_block = false)
     @mutex.synchronize do
-      while true
+      loop do
         if empty?
           raise ThreadError.new("Queue is empty") if non_block
 
@@ -119,7 +117,7 @@ class CircularQueue
   end
 
   # Returns the last/most recent item in the queue
-  # @return [Object] 
+  # @return [Object]
   # Peek at last item without removing
   def back
     @mutex.synchronize do
@@ -173,12 +171,10 @@ class CircularQueue
   end
 
   def wakeup_next_waiter
-    begin
-      if thread = @waiting.shift
-        thread.wakeup
-      end
-    rescue ThreadError
-      retry
+    if thread = @waiting.shift
+      thread.wakeup
     end
+  rescue ThreadError
+    retry
   end
 end

data/spec/circular_queue_spec.rb

@@ -1,76 +1,74 @@
-require "spec_helper"
-
-describe CircularQueue do
+RSpec.describe CircularQueue do
   let(:capacity) { 5 }
-  subject        { described_class.new(capacity) }
+  subject(:queue) { described_class.new(capacity) }
 
   describe "initialization" do
     it "can be initialized with a capacity" do
-      subject.capacity.should == capacity
+      expect(queue.capacity).to eq(capacity)
     end
   end
 
   describe "adding items" do
     it "accepts new items" do
-      subject.enq(1234)
-      subject.front.should == 1234
-      subject.back.should == 1234
-      subject.deq.should == 1234
+      queue.enq(1234)
+      expect(queue.front).to eq(1234)
+      expect(queue.back).to eq(1234)
+      expect(queue.deq).to eq(1234)
     end
 
     it "increases its size when a new item is added" do
-      subject.enq(1234)
-      subject.size.should == 1
+      queue.enq(1234)
+      expect(queue.size).to eq(1)
     end
 
     it "allows for peeking at first and last items" do
-      subject.enq(1)
+      queue.enq(1)
 
-      subject.front.should == 1
-      subject.back.should == 1
+      expect(queue.front).to eq(1)
+      expect(queue.back).to eq(1)
 
-      2.upto(capacity) { |i| subject.enq(i) }
-      subject.front.should == 1
-      subject.back.should == capacity
+      2.upto(capacity) { |i| queue.enq(i) }
+      expect(queue.front).to eq(1)
+      expect(queue.back).to eq(capacity)
     end
 
     it "presents the appearance of accepting infinite items" do
-      1.upto(capacity * 2) { |i| subject.enq(i) }
+      1.upto(capacity * 2) { |i| queue.enq(i) }
 
       1.upto(capacity) do |i|
-        subject.deq.should == i + capacity
+        expect(queue.deq).to eq(i + capacity)
       end
 
-      subject.size.should be_zero
+      expect(queue.size).to be_zero
     end
 
     it "raises an error if the queue is full and enq! is used to add items" do
-      1.upto(capacity) { |i| subject.enq(i) }
+      1.upto(capacity) { |i| queue.enq(i) }
 
       expect {
-        subject.enq!(1)
+        queue.enq!(1)
       }.to raise_error(ThreadError)
     end
   end
 
   describe "removing items" do
     it "removes items from the queue until the queue is empty" do
-      1.upto(capacity) { |i| subject.enq(i) }
+      1.upto(capacity) { |i| queue.enq(i) }
 
       1.upto(capacity) do |i|
-        subject.deq.should == i
+        expect(queue.deq).to eq(i)
       end
 
-      subject.size.should be_zero
+      expect(queue.size).to be_zero
     end
 
     context "when empty" do
       context "non-blocking" do
         it "raises a ThreadError if the queue is empty" do
-          subject.clear
+          queue.clear
 
           expect {
-            subject.deq(true)
+            queue.deq(true)
           }.to raise_error(ThreadError)
         end
       end
@@ -82,15 +80,15 @@ describe CircularQueue do
           enqueue = false
           done    = false
 
-          enqueue_thread = Thread.new do
+          Thread.new do
             until done
-              subject.enq(1) if enqueue
+              queue.enq(1) if enqueue
             end
           end
 
           begin
             enqueue = true
-            subject.deq.should == 1
+            expect(queue.deq).to eq(1)
           ensure
             done = true
           end
@@ -100,35 +98,35 @@ describe CircularQueue do
 
     context "when full" do
       it "overrides elements at the beginning of the queue" do
-        1.upto(capacity) { |i| subject.enq(i) }
+        1.upto(capacity) { |i| queue.enq(i) }
 
         # Queue is full
-        subject.enq(capacity + 1)
+        queue.enq(capacity + 1)
 
         # Returns the item that's been waiting the longest, not the overridden
         # value. 1 was overridden.
-        subject.pop.should == 2
+        expect(queue.pop).to eq(2)
       end
     end
   end
 
   describe "clearing the queue" do
     it "removes all items from the queue" do
-      subject.enq(1)
-      subject.clear
+      queue.enq(1)
+      queue.clear
 
-      subject.size.should be_zero
+      expect(queue.size).to be_zero
     end
   end
 
   describe "data" do
     it "allows taking a snapshot of the data in the queue" do
-      subject.enq(1)
-      subject.enq(2)
-      subject.enq(3)
-      subject.deq
+      queue.enq(1)
+      queue.enq(2)
+      queue.enq(3)
+      queue.deq
 
-      subject.data.should == [2, 3]
+      expect(queue.data).to eq([2, 3])
     end
   end
 end

data/spec/spec_helper.rb

@@ -1 +1,41 @@
-require File.expand_path("../lib/circular_queue", File.dirname(__FILE__))
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require "circular_queue"
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+  config.filter_run_when_matching :focus
+  config.example_status_persistence_file_path = "spec/failures.txt"
+  config.disable_monkey_patching!
+  config.warnings = true
+
+  if config.files_to_run.one?
+    config.default_formatter = "doc"
+  end
+
+  config.profile_examples = 10
+  config.order = :random
+  Kernel.srand config.seed
+end

metadata

@@ -1,62 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: circular_queue
 version: !ruby/object:Gem::Version
-  version: 0.0.5
-  prerelease: 
+  version: 1.0.0
 platform: ruby
 authors:
 - Andy Lindeman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-12 00:00:00.000000000 Z
+date: 2019-04-18 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.11.0
+        version: 3.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.11.0
+        version: 3.8.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: A circular queue (also called a circular buffer or ring buffer) is useful
@@ -67,10 +74,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
+- LICENSE.md
 - README.md
 - Rakefile
 - circular_queue.gemspec
@@ -78,37 +87,32 @@ files:
 - spec/circular_queue_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/alindeman/circular_queue
-licenses: []
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/alindeman/circular_queue
+  changelog_uri: https://github.com/alindeman/circular_queue/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/alindeman/circular_queue
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1552142011722040456
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1552142011722040456
 requirements: []
-rubyforge_project: circular_queue
-rubygems_version: 1.8.24
+rubygems_version: 3.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Data structure that uses a single, fixed-size buffer as if it were connected
   end-to-end
 test_files:
 - spec/circular_queue_spec.rb
 - spec/spec_helper.rb
-has_rdoc: