circular_queue 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec86881eee3351cb2f8f6dc4bd4bb36991a7a76331f5f31f51c108e0743b1d9b
-  data.tar.gz: 187c3358ade45e3e313b501182d1091abf9800949d23f6dc4aa6aef0862f1e33
+  metadata.gz: 13c1c8781ad3b18281cfde5ca4ab55ce37681dd6a6a808c23f86d3867184f81a
+  data.tar.gz: 526b06456b9a39091ded32db14bd77fd31d4dc3e877a3cd6605b8915e1ca0e3d
 SHA512:
-  metadata.gz: 7431d4752102a6e68a6196fdf3c3c766dca1c3db468a03d086aabda32f02831613c257c9b6e9dd517709e3f5f7f28ed7dfa1b099efe8fe0ca8b9386a74c9e993
-  data.tar.gz: 893ee822375a8b0b846e333967629e6a70cbb98e966f3b618283ec39b46ea3f8960365eec108fa33d9aca931332715c570390ff91dd26d0496ebbf592ada6c15
+  metadata.gz: ea4ae58974318d575d732988f4a7c87b7488982a19c25d402b830cb98f72e66b8f8ea7824f52dd612184748dfd5d422764f33c8356f39944fe8a1c3c6b10ef6a
+  data.tar.gz: d93519ec5e61ab5038c4338b1ec1681a49b851b7dc2c6a7e3fe6be12c122c7c0f43bb520897cdd17a66aea2692177e6cbdecc76ab1cdbafa87321d2af53caaee

data/CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.0.1] - 2019-04-22
+### Fixed
+- Maintain API compatibility with Queue from stdlib by returning `self` from `#clear`, `#enq`, and `#enq!`.
+
 ## [1.0.0] - 2019-04-18
 ### Added
 - Changelog (you're looking at!).

data/circular_queue.gemspec

@@ -3,7 +3,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |s|
   s.name        = "circular_queue"
-  s.version     = "1.0.0"
+  s.version     = "1.0.1"
   s.authors     = ["Andy Lindeman"]
   s.email       = ["alindeman@gmail.com"]
 
@@ -25,6 +25,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_development_dependency "bundler", "~> 2.0"
+  s.add_development_dependency "pry-byebug"
   s.add_development_dependency "rspec", "~> 3.8.0"
   s.add_development_dependency "rake"
   s.add_development_dependency "yard"

data/lib/circular_queue.rb

@@ -43,10 +43,12 @@ class CircularQueue
 
   # Adds an item to the queue
   # @param [Object] item item to add
+  # @return [CircularQueue] the queue itself
   def enq(item)
     @mutex.synchronize do
       enq_item(item)
       wakeup_next_waiter
+      self
     end
   end
   alias <<   enq
@@ -55,12 +57,14 @@ class CircularQueue
   # Adds an item to the queue, raising an error if the queue is full
   # @param [Object] item item to add
   # @raise [ThreadError] queue is full
+  # @return [CircularQueue] the queue itself
   def enq!(item)
     @mutex.synchronize do
       raise ThreadError.new("Queue is full") if full?
 
       enq_item(item)
       wakeup_next_waiter
+      self
     end
   end
   alias push! enq!
@@ -87,11 +91,13 @@ class CircularQueue
   alias pop   deq
 
   # Removes all items from the queue
+  # @return [CircularQueue] the queue itself
   def clear
     @mutex.synchronize do
       @size  = 0
       @front = 0
       @back  = 0
+      self
     end
   end
 

data/spec/circular_queue_spec.rb

@@ -16,6 +16,11 @@ RSpec.describe CircularQueue do
       expect(queue.deq).to eq(1234)
     end
 
+    it "maintains the same API as Queue, returning itself" do
+      expect(queue.enq(1)).to eq(queue)
+      expect(queue.enq!(2)).to eq(queue)
+    end
+
     it "increases its size when a new item is added" do
       queue.enq(1234)
       expect(queue.size).to eq(1)
@@ -117,6 +122,10 @@ RSpec.describe CircularQueue do
 
       expect(queue.size).to be_zero
     end
+
+    it "maintains the same API as Queue, returning itself" do
+      expect(queue.clear).to eq(queue)
+    end
   end
 
   describe "data" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: circular_queue
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Andy Lindeman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-18 00:00:00.000000000 Z
+date: 2019-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement