raabro 1.1.4 → 1.1.5

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 # raabro CHANGELOG.md
 
 
+## raabro 1.1.5  released 2017-08-19
+
+* Default name to nil for Tree#subgather, #gather, #sublookup, and #lookup
+
+
 ## raabro 1.1.4  released 2017-08-17
 
 * fail with ArgumentError if Raabro.pp input is not a Raabro::Tree

data/README.md

@@ -163,6 +163,47 @@ end
 (Yes, this sample parser parses string like "appletomatocabbage", it's not very useful, but I hope you get the point about `.seq`)
 
 
+## trees
+
+An instance of `Raabro::Tree` is passed to `rewrite()` and `rewrite_{name}()` functions.
+
+The most useful methods of this class are:
+```ruby
+class Raabro::Tree
+
+  # Look for the first child or sub-child with the given name.
+  # If the given name is nil, looks for the first child with a name (not nil).
+  #
+  def sublookup(name=nil)
+
+  # Gathers all the children or sub-children with the given name.
+  # If the given name is nil, gathers all the children with a name (not nil).
+  # When a child matches, does not pursue gathering from the children of the
+  # matching child.
+  #
+  def subgather(name=nil)
+end
+```
+
+I'm using "child or sub-child" instead of "descendant" because once a child or sub-child matches, those methods do not consider the children or sub-children of that matching entity.
+
+Here is a closeup on the rewrite functions of the sample parser at [doc/readme1.rb](doc/readme1.rb) (extracted from an early version of [floraison/dense](https://github.com/floraison/dense):
+```ruby
+require 'raabro'
+
+module PathParser include Raabro
+
+  # (...)
+
+  def rewrite_name(t); t.string; end
+  def rewrite_off(t); t.string.to_i; end
+  def rewrite_index(t); rewrite(t.sublookup); end
+  def rewrite_path(t); t.subgather(:index).collect { |tt| rewrite(tt) }; end
+end
+```
+Where `rewrite_index(t)` returns the result of the rewrite of the first of its children that has a name and `rewrite_path(t)` collects the result of the rewrite of all of its children that have the "index" name.
+
+
 ## errors
 
 By default, a parser will return nil when it cannot successfully parse the input.

data/lib/raabro.rb

@@ -25,7 +25,7 @@
 
 module Raabro
 
-  VERSION = '1.1.4'
+  VERSION = '1.1.5'
 
   class Input
 
@@ -112,7 +112,7 @@ module Raabro
       @input.string[@offset, l]
     end
 
-    def lookup(name)
+    def lookup(name=nil)
 
       name = name ? name.to_s : nil
 
@@ -121,14 +121,14 @@ module Raabro
       sublookup(name)
     end
 
-    def sublookup(name)
+    def sublookup(name=nil)
 
       @children.each { |c| if n = c.lookup(name); return n; end }
 
       nil
     end
 
-    def gather(name, acc=[])
+    def gather(name=nil, acc=[])
 
       name = name ? name.to_s : nil
 
@@ -141,7 +141,7 @@ module Raabro
       acc
     end
 
-    def subgather(name, acc=[])
+    def subgather(name=nil, acc=[])
 
       @children.each { |c| c.gather(name, acc) }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: raabro
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 1.1.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-17 00:00:00.000000000 Z
+date: 2017-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec