raabro 1.1.4 → 1.3.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6159e68d6f573fed52d1dd3245c57bc4714a12b3a2f7c5eb75dfac4d364a1041
+  data.tar.gz: 50c1cce039e12ae3e3463eb2add731a7bf4395b6a82c92057676c3901b4d3f7e
+SHA512:
+  metadata.gz: e7e68e4de4f750d51194a1b963205ff7b30d0896389aabc5eeaaf8a0821903745dda173dc1325d3c0dbf20f32db5568f61f84d18f207c057c00b503f117aa2af
+  data.tar.gz: 1b48246a064ad905a77104bc49d582d0fdf3d879d5de13e45ecea4bf8fbd7f02cba3e7b94ac6bc043f643fd5e45d1856e86b461fb0659129d00562ecd4cfe71a

data/CHANGELOG.md

@@ -2,6 +2,33 @@
 # raabro CHANGELOG.md
 
 
+## raabro 1.3.2  released 2020-09-24
+
+* Make a tiny rewrite_ optimization
+
+
+## raabro 1.3.1  released 2020-05-10
+
+* Add '!' (not) seq quantifier
+
+
+## raabro 1.3.0  released 2020-05-10
+
+* Add `nott` parser element
+* Add Tree#strinp and #strim
+* Skip 1.2.0 to align on http://github.com/jmettraux/jaabro
+
+
+## raabro 1.1.6  released 2018-06-22
+
+* Remove unused `add` var, gh-2, thanks to https://github.com/utilum
+
+
+## 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/CREDITS.md

@@ -0,0 +1,14 @@
+
+# raabro credits
+
+* Utilum https://github.com/utilum removed unused var
+* John Mettraux https://github.com/jmettraux author and maintainer
+
+
+## aabro and jaabro credits
+
+Thanks to all the people who contributed to aabro and jaabro as well.
+
+* https://github.com/flon-io/aabro
+* https://github.com/jmettraux/jaabro
+

data/LICENSE.txt

@@ -1,5 +1,5 @@
 
-Copyright (c) 2015-2017, John Mettraux, jmettraux@gmail.com
+Copyright (c) 2015-2020, John Mettraux, jmettraux@gmail.com
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -19,3 +19,6 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 
+
+Made in Japan.
+

data/Makefile

@@ -1,9 +1,15 @@
 
+## gem tasks ##
+
 NAME = \
   $(shell ruby -e "s = eval(File.read(Dir['*.gemspec'][0])); puts s.name")
 VERSION = \
   $(shell ruby -e "s = eval(File.read(Dir['*.gemspec'][0])); puts s.version")
 
+count_lines:
+	find lib -name "*.rb" | xargs cat | ruby -e "p STDIN.readlines.count { |l| l = l.strip; l[0, 1] != '#' && l != '' }"
+	find spec -name "*_spec.rb" | xargs cat | ruby -e "p STDIN.readlines.count { |l| l = l.strip; l[0, 1] != '#' && l != '' }"
+cl: count_lines
 
 gemspec_validate:
 	@echo "---"
@@ -13,11 +19,21 @@ gemspec_validate:
 name: gemspec_validate
 	@echo "$(NAME) $(VERSION)"
 
+cw:
+	find lib -name "*.rb" -exec ruby -cw {} \;
+
 build: gemspec_validate
 	gem build $(NAME).gemspec
 	mkdir -p pkg
 	mv $(NAME)-$(VERSION).gem pkg/
 
 push: build
-	gem push pkg/$(NAME)-$(VERSION).gem
+	gem push --otp "$(OTP)" pkg/$(NAME)-$(VERSION).gem
+
+spec:
+	bundle exec rspec
+test: spec
+
+
+.PHONY: count_lines gemspec_validate name cw build push spec
 

data/README.md

@@ -1,7 +1,7 @@
 
 # raabro
 
-[![Build Status](https://secure.travis-ci.org/jmettraux/raabro.svg)](http://travis-ci.org/jmettraux/raabro)
+[![Build Status](https://secure.travis-ci.org/floraison/raabro.svg)](http://travis-ci.org/floraison/raabro)
 [![Gem Version](https://badge.fury.io/rb/raabro.svg)](http://badge.fury.io/rb/raabro)
 
 A very dumb PEG parser library.
@@ -27,31 +27,44 @@ module Fun include Raabro
   #
   # Last function is the root, "i" stands for "input".
 
-  def pa(i); rex(nil, i, /\(\s*/); end
-  def pz(i); rex(nil, i, /\)\s*/); end
-  def com(i); rex(nil, i, /,\s*/); end
+  def pstart(i); rex(nil, i, /\(\s*/); end
+  def pend(i); rex(nil, i, /\)\s*/); end
+    # parenthese start and end, including trailing white space
+
+  def comma(i); rex(nil, i, /,\s*/); end
+    # a comma, including trailing white space
 
   def num(i); rex(:num, i, /-?[0-9]+\s*/); end
+    # name is :num, a positive or negative integer
+
+  def args(i); eseq(nil, i, :pstart, :exp, :comma, :pend); end
+    # a set of :exp, beginning with a (, punctuated by commas and ending with )
 
-  def args(i); eseq(nil, i, :pa, :exp, :com, :pz); end
   def funame(i); rex(nil, i, /[a-z][a-z0-9]*/); end
   def fun(i); seq(:fun, i, :funame, :args); end
+    # name is :fun, a function composed of a function name
+    # followed by arguments
 
   def exp(i); alt(nil, i, :fun, :num); end
+    # an expression is either (alt) a function or a number
 
   # rewrite
   #
   # Names above (:num, :fun, ...) get a rewrite_xxx function.
   # "t" stands for "tree".
-  #
-  # The trees with a nil name are handled by rewrite_(tree) a default
-  # rewrite function
 
+  def rewrite_exp(t); rewrite(t.children[0]); end
   def rewrite_num(t); t.string.to_i; end
 
   def rewrite_fun(t)
-    [ t.children[0].string ] +
-    t.children[1].odd_children.collect { |a| rewrite(a) }
+
+    funame, args = t.children
+
+    [ funame.string ] +
+    args.gather.collect { |e| rewrite(e) }
+      #
+      # #gather collect all the children in a tree that have
+      # a name, in this example, names can be :exp, :num, :fun
   end
 end
 
@@ -121,6 +134,9 @@ def altg(name, input, *parsers)
 def rep(name, input, parser, min, max=0)
   # repeats the the wrapped parser
 
+def nott(name, input, parser)
+  # succeeds if the wrapped parser fails, fails if it succeeds
+
 def ren(name, input, parser)
   # renames the output of the wrapped parser
 
@@ -143,6 +159,8 @@ def eseq(name, input, startpa, eltpa, seppa, endpa)
 
 `seq` is special, it understands "quantifiers": `'?'`, `'+'` or `'*'`. They make behave `seq` a bit like a classical regex.
 
+The `'!'` (bang, not) quantifier is explained at the end of this section.
+
 ```ruby
 module CartParser include Raabro
 
@@ -162,6 +180,57 @@ end
 
 (Yes, this sample parser parses string like "appletomatocabbage", it's not very useful, but I hope you get the point about `.seq`)
 
+The `'!'` (bang, not) quantifier is a kind of "negative lookahead".
+
+```ruby
+  def menu(i)
+    seq(:menu, i, :mise_en_bouche, :main, :main, '!', :dessert)
+  end
+```
+
+Lousy example, but here a main cannot follow a main.
+
+
+## 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
 

data/lib/raabro.rb

@@ -1,31 +1,7 @@
-#--
-# Copyright (c) 2015-2017, John Mettraux, jmettraux@gmail.com
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
-#
-# Made in Japan.
-#++
-
 
 module Raabro
 
-  VERSION = '1.1.4'
+  VERSION = '1.3.2'
 
   class Input
 
@@ -102,17 +78,12 @@ module Raabro
       @children = successful_children
     end
 
-    def string
-
-      @input.string[@offset, @length]
-    end
-
-    def nonstring(l=7)
-
-      @input.string[@offset, l]
-    end
+    def string; @input.string[@offset, @length]; end
+    def strinp; @input.string[@offset, @length].strip; end
+    alias strim strinp
+    def nonstring(l=7); @input.string[@offset, l]; end
 
-    def lookup(name)
+    def lookup(name=nil)
 
       name = name ? name.to_s : nil
 
@@ -121,14 +92,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 +112,7 @@ module Raabro
       acc
     end
 
-    def subgather(name, acc=[])
+    def subgather(name=nil, acc=[])
 
       @children.each { |c| c.gather(name, acc) }
 
@@ -287,10 +258,11 @@ module Raabro
         # so that :plus and co can be overriden
 
       case parser
-        when '?', :q, :qmark then [ 0, 1 ]
-        when '*', :s, :star then [ 0, 0 ]
-        when '+', :p, :plus then [ 1, 0 ]
-        else nil
+      when '?', :q, :qmark then [ 0, 1 ]
+      when '*', :s, :star then [ 0, 0 ]
+      when '+', :p, :plus then [ 1, 0 ]
+      when '!' then :bang
+      else nil
       end
     end
 
@@ -322,7 +294,11 @@ module Raabro
         pa = parsers.shift
         break unless pa
 
-        if q = _quantify(parsers.first)
+        if parsers.first == '!'
+          parsers.shift
+          c = nott(nil, input, pa)
+          r.children << c
+        elsif q = _quantify(parsers.first)
           parsers.shift
           c = rep(nil, input, pa, *q)
           r.children.concat(c.children)
@@ -433,6 +409,22 @@ module Raabro
     end
     alias rename ren
 
+    def nott(name, input, parser)
+
+      start = input.offset
+
+      r = ::Raabro::Tree.new(name, :nott, input)
+      c = _parse(parser, input)
+      r.children << c
+
+      r.length = 0
+      r.result = c.result == 1 ? 0 : 1
+
+      input.offset = start
+
+      r
+    end
+
     def all(name, input, parser)
 
       start = input.offset
@@ -478,8 +470,6 @@ module Raabro
 
         loop do
 
-          add = true
-
           st = i > 0 ? _parse(seppa, input) : nil
           et = st == nil || st.result == 1 ? _parse(eltpa, input) : nil
 
@@ -575,7 +565,7 @@ module Raabro
 
     def rewrite(tree)
 
-      return !! methods.find { |m| m.to_s.match(/^rewrite_/) } if tree == 0
+      return !! methods.find { |m| m.to_s.match?(/^rewrite_/) } if tree == 0
         # return true when "rewrite_xxx" methods seem to have been provided
 
       send("rewrite_#{tree.name}", tree)

data/raabro.gemspec

@@ -9,9 +9,8 @@ Gem::Specification.new do |s|
 
   s.platform = Gem::Platform::RUBY
   s.authors = [ 'John Mettraux' ]
-  s.email = [ 'jmettraux@gmail.com' ]
-  s.homepage = 'http://github.com/jmettraux/raabro'
-  #s.rubyforge_project = 'rufus'
+  s.email = [ 'jmettraux+flor@gmail.com' ]
+  s.homepage = 'http://github.com/floraison/raabro'
   s.license = 'MIT'
   s.summary = 'a very dumb PEG parser library'
 
@@ -30,7 +29,7 @@ A very dumb PEG parser library, with a horrible interface.
 
   #s.add_runtime_dependency 'tzinfo'
 
-  s.add_development_dependency 'rspec', '~> 3.4.0'
+  s.add_development_dependency 'rspec', '~> 3.7'
 
   s.require_path = 'lib'
 end

metadata

@@ -1,68 +1,64 @@
 --- !ruby/object:Gem::Specification
 name: raabro
 version: !ruby/object:Gem::Version
-  version: 1.1.4
-  prerelease: 
+  version: 1.3.2
 platform: ruby
 authors:
 - John Mettraux
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-17 00:00:00.000000000 Z
+date: 2020-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: '3.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: '3.7'
 description: A very dumb PEG parser library, with a horrible interface.
 email:
-- jmettraux@gmail.com
+- jmettraux+flor@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- README.md
 - CHANGELOG.md
+- CREDITS.md
 - LICENSE.txt
 - Makefile
+- README.md
 - lib/raabro.rb
 - raabro.gemspec
-homepage: http://github.com/jmettraux/raabro
+homepage: http://github.com/floraison/raabro
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.23.2
+rubygems_version: 3.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: a very dumb PEG parser library
 test_files: []