parse_queue 0.2.2 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 36033d4abd23bd7092e28e8e1eb9fc405c87dbe1
-  data.tar.gz: c3d7c043db21c06ebd37e67ef0ab9e55fc7e59be
+  metadata.gz: 63bff899ff5bf108e50afeba001b1a08569d6c1d
+  data.tar.gz: 61238d41bdf7df2ce742b29820dbd711c94be06f
 SHA512:
-  metadata.gz: 1fb132c9c248243091584674374a918723cd58e560202badf1675416f3d18bbda8ff4847628e8705522770bc74e827e6b6a6ca6808d098ef10619e36e63b1165
-  data.tar.gz: e1a412e86eb9bac422b7c387edd271d7fd4138ca237fb8a5ef2d4d1530a3823a04f87e7347bb4e6b2e17fc9389f1f15dc89294a71e62d1161df727976831759f
+  metadata.gz: 21fd07a6b7f3d3d4d18ccd8a196886eb661a2f2c332b3a0eac34649d86d449e3973f494fecf80b0e8a4a1724a1bac418cfd2d6df228f43b4d50c4d2ed13079ec
+  data.tar.gz: 25e4f71011d19f30b72f8eef5c4fb3db59a836d4715c3e5dc95f355948701a35085a678c0f288419ecd7f6c1c5cc3949c7385b9194f0b41d970972374271e82d

data/README.md

@@ -13,6 +13,10 @@ 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.
 
+The operation of the parse queue is summarized in the following diagram:
+
+![parse queue](./images/queue.png)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -104,7 +108,7 @@ a value saved off at an earlier point of the processing. For example:
 
 #### Shifting
 
-So far, items have been retained in the queue, even when are done being
+So far, items have been retained in the queue, even after they are done being
 processed. For large files, this may use a large amount of memory. To avoid
 this, used items need to be shifted out of the parse queue. This can be done as
 follows:
@@ -118,9 +122,9 @@ follows:
   }
 ```
 Note how the try! block returns a value called success. If this value is false
-or nil, the parse queue is rolled back to its condition at the start of the try
-block. Otherwise, any changes to the parse queue are retained and processed
-items are removed.
+or nil, the parse queue is rolled back to its condition at the start of the
+try! block. Otherwise, any changes to the parse queue are retained and
+processed items are removed.
 
 This too can be done manually as shown below:
 
@@ -138,6 +142,16 @@ This too can be done manually as shown below:
 Note that if an attempt is made to fall back to data that has been shifted out,
 a **ParseQueueNoRev** exception is raised.
 
+#### Exceptions
+
+The parse queue uses the following exception classes:
+
+    Exception              # From Ruby.
+      StandardError        # From Ruby.
+        ParseQueueError    # The abstract root of parse queue exceptions.
+          ParseQueueNoFwd  # Error: Can't go forward.
+          ParseQueueNoRev  # Error: Can't fall back.
+
 ## Contributing
 
 #### Plan A

data/lib/parse_queue/version.rb

@@ -1,3 +1,3 @@
 class ParseQueue
-  VERSION = "0.2.2"
+  VERSION = "0.2.4".freeze
 end

data/parse_queue.gemspec

@@ -21,8 +21,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>=2.3.0'
 
   spec.add_development_dependency "bundler", "~> 1.15"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", ">= 12.3.3"
   spec.add_development_dependency "minitest", "~> 5.0"
-  spec.add_development_dependency 'minitest_visible', "~> 0.1"
   spec.add_development_dependency 'reek', "~> 5.0.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: parse_queue
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.4
 platform: ruby
 authors:
 - PeterCamilleri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-01 00:00:00.000000000 Z
+date: 2020-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,16 +28,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -52,20 +52,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
-- !ruby/object:Gem::Dependency
-  name: minitest_visible
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: reek
   requirement: !ruby/object:Gem::Requirement
@@ -93,6 +79,7 @@ files:
 - Gemfile
 - LICENSE.txt
 - README.md
+- images/queue.png
 - lib/parse_queue.rb
 - lib/parse_queue/exceptions.rb
 - lib/parse_queue/version.rb