parse_queue 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 680c9173be954876332f5a14f657c07d077efa62
-  data.tar.gz: 57b611ff761a311887b602646f8027f7893ec5d7
+  metadata.gz: 36033d4abd23bd7092e28e8e1eb9fc405c87dbe1
+  data.tar.gz: c3d7c043db21c06ebd37e67ef0ab9e55fc7e59be
 SHA512:
-  metadata.gz: b90020ad6dda6613549e9b4da6f45992e23a11475225fc8f2b9c93764143514677dbba428d6dc88b1b722dda90df96a161606a2ad1692e7155c8ab1201a0c344
-  data.tar.gz: 8add940d513b2ba9883dc1c266d24511011f04b1205269f685133a0f68323f6fb8f4c833fba2427018dee0a0e13b4edd508b24a685110df58e90a84c6da94d0f
+  metadata.gz: 1fb132c9c248243091584674374a918723cd58e560202badf1675416f3d18bbda8ff4847628e8705522770bc74e827e6b6a6ca6808d098ef10619e36e63b1165
+  data.tar.gz: e1a412e86eb9bac422b7c387edd271d7fd4138ca237fb8a5ef2d4d1530a3823a04f87e7347bb4e6b2e17fc9389f1f15dc89294a71e62d1161df727976831759f

data/README.md

@@ -7,6 +7,12 @@ simple queue, it supports backing up or falling back to earlier states allowing
 the parser to try other paths in the syntax tree when one path runs into a
 dead end.
 
+The parse queue was created to simplify the design of both the lexical analyzer
+and the parser. Parsers often have a built-in limited "look-ahead" of tokens.
+This can be seen in parser names like LL(0), LL(1), LR(1), LALR(n), etc. The
+parse queue provides for a flexible look-ahead removing this burden from other
+compiler components.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -60,6 +66,12 @@ Getting an item from the queue is done with the get method. For example:
 This method returns the next unread item from the queue. Note that if no items
 are available, the exception **ParseQueueNoFwd** is raised.
 
+Note: The get! method is a get without backtracking. In effect it is a get
+followed by a shift (see Shifting below).
+
+```ruby
+  item = pq.get!
+```
 
 #### Backtracking:
 

data/lib/parse_queue.rb

@@ -39,6 +39,13 @@ class ParseQueue
     result
   end
 
+  # Get an item and shift the buffer.
+  def get!
+    result = get
+    shift
+    result
+  end
+
   # Fetch all possible items.
   def fetch_all
     loop do

data/lib/parse_queue/version.rb

@@ -1,3 +1,3 @@
 class ParseQueue
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: parse_queue
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - PeterCamilleri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-24 00:00:00.000000000 Z
+date: 2018-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler