JSQueue 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6ec8036ff7e1adf1dee14b9bfb7e2916a82f3bed
-  data.tar.gz: 405d1ba43932527c1e54ea1ea2fadb2059f4d9ea
+  metadata.gz: 4a77f351086b55cbfdf216ab768fa0ca077d99a6
+  data.tar.gz: fa14fd8c07d7df933da37ba2f9ba106b8d5c8a27
 SHA512:
-  metadata.gz: c760df615eb8930ab0199fdae960d97c600003e61d727e42bb7c57a355e1ce650d068ceb4c443c7bf70f6286744f283b3c7802292a2728b8f72547fd4f2130d3
-  data.tar.gz: 0f2d413c3c5d944196e2b76ceee75fdc1d2bdba8ed424131350bab8cd7def9a3cd6641f8d28589ad0470fbdcb829cf99ff963628362c94f3884e70116bb12e23
+  metadata.gz: 461c4b61f32090cfc175004809b8093390efbfefe7e1b26d4350f4b901f38a6eb949bef3b27ef4bf715824d8fa24d031b6be044f0f3655c352b2afdca3396a30
+  data.tar.gz: b931f3ff762c8c8b682573ae2eb5d0f847d049a3c889f9e4a79e94e90208f1bc3fe239bc157c935ffa6a7d5e3aadb6d8e771ba6b467b2349e8ae436c65b1a839

data/lib/js_queue.rb

@@ -3,11 +3,22 @@ require_relative 'queue_node'
 class JSQueue
   attr_accessor :first, :last
 
-  def initialize(data)
-    @first = QueueNode.new data
+  ##
+  # Creates a new queue with an optional first item +data+.
+  #
+  # If an initial value is provided, it will be considered both the +first+ and
+  # +last+ item in the queue.
+  def initialize(data=nil)
+    @first = QueueNode.new data unless data.nil?
+    @first ||= nil
     @last = @first
   end
 
+  ##
+  # Adds the provided value +data+ to the back of the queue.
+  #
+  # If it is the only item in the queue, it will be considered both the +first+
+  # and the +last+.
   def enqueue(data)
     node = QueueNode.new data
     unless last.nil?
@@ -17,6 +28,11 @@ class JSQueue
     @first = node if @first.nil?
   end
 
+  ##
+  # Removes and returns the data value of the +first+ item in the queue.
+  #
+  # == Example
+  #   queue.dequeue # => 'I was first in line'
   def dequeue
     return if @first.nil?
     data = @first.data
@@ -25,10 +41,20 @@ class JSQueue
     data
   end
 
+  ##
+  # Returns the +first+ enqueued item's value, without removing it.
+  #
+  # == Example
+  #   queue.peek # => 'I am first in line'
   def peek
     first.nil? ? nil : first.data
   end
 
+  ##
+  # Returns a Boolean indicating whether the queue has any items.
+  #
+  # == Example
+  #   queue.empty? # => false
   def empty?
     first.nil?
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: JSQueue
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Josh Saint Jacque