parse_queue 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2dbdae6528358e96af53ee8a1021337dd6d9c2d8
-  data.tar.gz: 90ce08195ef61d12475c4b66e7751e248e5a5452
+  metadata.gz: 383a2388d540d992e658a3b6e3eff0a04ffcaab4
+  data.tar.gz: 63aac7b0b20544d1e596a58d8e1e88d8f6c012b0
 SHA512:
-  metadata.gz: 2dc54cd963668ab878f3fe69f6d2ffe7731dab1e5fbc9a49af619035b9d8ebe8df4f4aa93690c98810ae97dc660455932e9f001ed7c3e8d76ac4ca8db1663d4a
-  data.tar.gz: 749792d40d3992d2bdac14b70aecfa7021422127c71a589a2599dfa7173622136eb0f1f1e0c1d27bac5877ffc0ab13ea8631dcb205896925418788af413f2937
+  metadata.gz: 0f7a07e5d590f807e8d9097ac5ea0b9fd567f9366fef702a5d5e0cf2be17d07b22b8127107db635ea828964ca2044fcc9267a22c8554b57500265d0d35baa72e
+  data.tar.gz: 37fa8202815532981dfd6d5327117e6e83fc5618d9be63f2317ebcb2bdde2a9c059140823d5c1ce7eb48c072ba175adf576cbc08c768f2b1539c52fee6ff01e2

data/README.md

@@ -34,11 +34,21 @@ When creating a parse queue, an optional block parameter is passed in. This is
 called whenever more queue items are required. For example:
 
 ```ruby
-  pq = ParseQueue.new { lex.next }
+def open_file_tokenized(name)
+  txt = IO.readlines(name, nil)[0]
+  lex = LexicalAnalayzer.new(text: txt, rules: LEXICAL_RULES)
+  ParseQueue.new { lex.get }
+end
 ```
-If this block is omitted, then items will have to added to the parse queue
-using the add method. The add method accepts single items, multiple items or
-an array of items.
+This example above is a method that reads in the named file, creates an
+analyzer on it (see the
+[lexical_analyzer](https://rubygems.org/gems/lexical_analyzer)
+gem for more details) and then uses that as the source for the parse queue.
+The queue is returned for use by the compiler's parser.
+
+Note: If the fetch block is omitted, then items will have to added to the parse
+queue using the add method. The add method accepts single items, multiple items
+or an array of items.
 
 #### Getting a queued item:
 
@@ -120,7 +130,7 @@ a **ParseQueueNoRev** exception is raised.
 
 #### Plan A
 
-1. Fork it ( https://github.com/PeterCamilleri/parse_queue_dup/fork )
+1. Fork it ( https://github.com/PeterCamilleri/parse_queue/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
@@ -134,10 +144,10 @@ aspect that could use some TLC or a suggestion or an idea.
 ## License
 
 The gem is available as open source under the terms of the
-[MIT License](http://opensource.org/licenses/MIT).
+[MIT License](./LICENSE.txt).
 
 ## Code of Conduct
 
 Everyone interacting in the ParseQueue project’s codebases, issue trackers,
 chat rooms and mailing lists is expected to follow the
-[code of conduct](https://github.com/PeterCamilleri/parse_queue/blob/master/CODE_OF_CONDUCT.md).
+[code of conduct](./CODE_OF_CONDUCT.md).

data/lib/parse_queue/exceptions.rb

@@ -1,5 +1,3 @@
-# coding: utf-8
-
 # Exception types for the parse queue.
 
 # The base error class for the parse queue.

data/lib/parse_queue/version.rb

@@ -1,5 +1,3 @@
-# coding: utf-8
-
 class ParseQueue
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/parse_queue.rb

@@ -1,5 +1,3 @@
-# coding: utf-8
-
 # The Ruby Compiler Toolkit Project - Parse Queue
 # A queue for compiler objects between parser layers.
 
@@ -11,44 +9,54 @@ class ParseQueue
   # The current read point of the queue.
   attr_reader :position
 
-  # The number of old items removed from the queue.
-  attr_reader :offset
+  #The default fetch block
+  DFB = Proc.new { false }
 
   # Set up the parser queue.
   def initialize(&fetch)
-    @fetch = fetch || lambda { false }
+    @fetch  = fetch || DFB
     @buffer = []
     @offset = @position = 0
   end
 
   # How many unread items are in this parse queue?
-  def unread
-    @buffer.length - @position + @offset
+  def fwd_count
+    index_limit - @position
   end
 
-  # Manually add items to the buffer
-  def add(*items)
-    @buffer += items.flatten
+  # How many already read items are still in this parse queue?
+  def rev_count
+    @position - @offset
   end
 
   # Get an item from the buffer.
   def get
-    if @position >= (@buffer.length + @offset)
+    if @position == index_limit
       item = @fetch.call
-      fail ParseQueueNoFwd unless item
+
+      unless item
+        @fetch = DFB
+        fail ParseQueueNoFwd
+      end
+
       @buffer << item
     end
 
-    result = @buffer[@position - @offset]
+    result = @buffer[rev_count]
     @position += 1
     result
   end
 
-  # Get all possible items
-  def read_all
+  # Fetch all possible items.
+  def fetch_all
     loop do
       item = @fetch.call
-      return unless item
+
+      unless item
+        @fetch = DFB
+        return
+      end
+
       @buffer << item
     end
   end
@@ -60,40 +68,40 @@ class ParseQueue
   end
 
   # Undo the last get.
-  def back_up
-    @position -= 1
+  def unget(count=1)
+    @position -= count
     validate_position
   end
 
   # Release any items before the current item.
   def shift
-    @buffer.shift(@position - @offset)
+    @buffer.shift(rev_count)
     @offset = @position
   end
 
   # Try to process some items with roll back on failure.
   def try(&block)
     save = @position
-    @position = save unless block.call
-    validate_position
+    self.position = save unless (result = block.call)
+    result
   end
 
-  # Try to process some items with shift of success and roll back on failure.
+  # Process some items with a shift on success and a roll back on failure.
   def try!(&block)
-    save = @position
-
-    if block.call
-      shift
-    else
-      @position = save
-      validate_position
-    end
+    shift if (result = try(&block))
+    result
   end
 
+private
+
   # Is this a valid position?
   def validate_position
     fail ParseQueueNoRev if @position < @offset
-    fail ParseQueueNoFwd if @position >= (@buffer.length + @offset)
+    fail ParseQueueNoFwd if @position >= index_limit
   end
 
+  # The first index past the end of the array
+  def index_limit
+    @buffer.length + @offset
+  end
 end

data/parse_queue.gemspec

@@ -18,6 +18,8 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test)/}) }
   spec.require_paths = ["lib"]
 
+  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 "minitest", "~> 5.0"

data/rakefile.rb

@@ -8,3 +8,9 @@ Rake::TestTask.new(:test) do |t|
 end
 
 task :default => :test
+
+desc "What version of parse queue is this?"
+task :vers do |t|
+  puts
+  puts "parse_queue version = #{ParseQueue::VERSION}"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: parse_queue
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - PeterCamilleri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-22 00:00:00.000000000 Z
+date: 2018-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -96,7 +96,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="