ebnf 1.2.0 → 2.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aae4c0b2a8f6d03654bc5436b36c90e577669c41ea4df25d881be3aef86e5ace
-  data.tar.gz: 7f1b7fe448ae87f3755e6da4fc0faf47dbb3d3b573a3e4a8be9b3066f0fac6fa
+  metadata.gz: d3b1d692ce9936bb68c8c89722a06b90b7cfd6c42231ff57d49780a98214a325
+  data.tar.gz: da6430584d824a1d070d364879c17b0b3b0bd8c9b32b44af841cd039e153e7f6
 SHA512:
-  metadata.gz: 6d0f441731842af8ac38f98352b96a47cf6810bfe81ce620f8ef57af87ce6d65c679d88903c35dbce99617b24bdea8fbb70a23d4873d941ae151275a11561627
-  data.tar.gz: f19f527e041a8f1c48da918497660466c5df71a02077e2183472b157a8611cbf87903fe2b6858e889c119211a7fedb279ad4889d811bec5d6132dd9287d74314
+  metadata.gz: 4e0bacbdef9b82ecca13fca9babcf8fe643acb3afaad077b05aebfc237f542859a1e6bea67e6b2e776c2e81b51dd7900cd24e39d9712582de6959d5e65ecfa42
+  data.tar.gz: 3001f1864c2cf8fade2856fb7d3383f4b1ac8519d2914e54cc55b8a461f6f208d41c3fa35539367bad104a74068cc868220255ce933f301894530eacb0abf51e

data/README.md

@@ -2,15 +2,25 @@
 
 [EBNF][] parser and generic parser generator.
 
-[![Gem Version](https://badge.fury.io/rb/ebnf.png)](http://badge.fury.io/rb/ebnf)
-[![Build Status](https://secure.travis-ci.org/dryruby/ebnf.png?branch=master)](http://travis-ci.org/dryruby/ebnf)
-[![Coverage Status](https://coveralls.io/repos/dryruby/ebnf/badge.svg)](https://coveralls.io/r/dryruby/ebnf)
-[![Dependency Status](https://gemnasium.com/dryruby/ebnf.png)](https://gemnasium.com/dryruby/ebnf)
+[![Gem Version](https://badge.fury.io/rb/ebnf.png)](https://badge.fury.io/rb/ebnf)
+[![Build Status](https://github.com/dryruby/ebnf/workflows/CI/badge.svg?branch=develop)](https://github.com/dryruby/ebnf/actions?query=workflow%3ACI)
+[![Coverage Status](https://coveralls.io/repos/dryruby/ebnf/badge.svg?branch=develop)](https://coveralls.io/r/dryruby/ebnf?branch=develop)
+[![Gitter chat](https://badges.gitter.im/ruby-rdf/rdf.png)](https://gitter.im/ruby-rdf/rdf)
 
 ## Description
-This is a [Ruby][] implementation of an [EBNF][] and [BNF][] parser and parser generator. It parses [EBNF][] grammars to [BNF][], generates [First/Follow][] and Branch tables for [LL(1)][] grammars, which can be used with the stream [Tokenizer][] and [LL(1) Parser][].
+This is a [Ruby][] implementation of an [EBNF][] and [BNF][] parser and parser generator.
 
-As LL(1) grammars operate using `alt` and `seq` primitives, allowing for a match on alternative productions or a sequence of productions, generating a parser requires turning the EBNF rules into BNF:
+### [PEG][]/[Packrat][] Parser
+In the primary mode, it supports a Parsing Expression Grammar ([PEG][]) parser generator. This performs more minmal transformations on the parsed grammar to extract sub-productions, which allows each component of a rule to generate its own parsing event.
+
+The resulting {EBNF::PEG::Rule} objects then parse each associated rule according to the operator semantics and use a [Packrat][] memoizer to reduce extra work when backtracking.
+
+These rules are driven using the {EBNF::PEG::Parser} module which calls invokes the starting rule and ensures that all input is consumed.
+
+### LL(1) Parser
+In another mode, it parses [EBNF][] grammars to [BNF][], generates [First/Follow][] and Branch tables for [LL(1)][] grammars, which can be used with the stream [Tokenizer][] and [LL(1) Parser][].
+
+As LL(1) grammars operate using `alt` and `seq` primitives, allowing for a match on alternative productions or a sequence of productions, generating a parser requires turning the [EBNF][] rules into [BNF][]:
 
 * Transform `a ::= b?` into `a ::= _empty | b`
 * Transform `a ::= b+` into `a ::= b b*`
@@ -23,213 +33,221 @@ As LL(1) grammars operate using `alt` and `seq` primitives, allowing for a match
 
 Of note in this implementation is that the tokenizer and parser are streaming, so that they can process inputs of arbitrary size.
 
+The _exception operator_ (`A - B`) is only supported on terminals.
+
+See {EBNF::LL1} and {EBNF::LL1::Parser} for further information.
+
 ## Usage
-### Parsing an LL(1) Grammar
+### Parsing an EBNF Grammar
 
     require 'ebnf'
 
-    ebnf = EBNF.parse(File.open('./etc/ebnf.ebnf'))
+    grammar = EBNF.parse(File.open('./etc/ebnf.ebnf'))
 
-Output rules and terminals as S-Expressions, Turtle, HTML or BNF
+Output rules and terminals as [S-Expressions][S-Expression], [Turtle][], HTML or [BNF][]
 
-    puts ebnf.to_sxp
-    puts ebnf.to_ttl
-    puts ebnf.to_html
-    puts ebnf.to_s
+    puts grammar.to_sxp
+    puts grammar.to_ttl
+    puts grammar.to_html
+    puts grammar.to_s
 
-Transform EBNF to BNF (generates sub-productions using `alt` or `seq` from `plus`, `star` or `opt`)
+Transform [EBNF][] to [PEG][] (generates sub-rules for embedded expressions) and the RULES table as Ruby for parsing grammars:
 
-    ebnf.make_bnf
+    grammar.make_peg
+    grammar.to_ruby
 
-Generate [First/Follow][] rules for BNF grammars
+Transform [EBNF][] to [BNF][] (generates sub-rules using `alt` or `seq` from `plus`, `star` or `opt`)
 
-    ebnf.first_follow(:ebnf)
+    grammar.make_bnf
 
-Generate Terminal, [First/Follow][], Cleanup and Branch tables as Ruby for parsing grammars
+Generate [First/Follow][] rules for BNF grammars (using "ebnf" as the starting production):
 
-    ebnf.build_tables
-    ebnf.to_ruby
+    grammar.first_follow(:ebnf)
 
-Generate formatted grammar using HTML (requires [Haml][Haml] gem)
+Generate Terminal, [First/Follow][], Cleanup and Branch tables as Ruby for parsing grammars:
 
-    ebnf.to_html
+    grammar.build_tables
+    grammar.to_ruby
 
-### Parser S-Expressions
-Intermediate representations of the grammar may be serialized to Lisp-like S-Expressions. For example, the rule `[1] ebnf        ::= (declaration | rule)*` is serialized as `(rule ebnf "1" (star (alt declaration rule)))`.
-
-Once the [LL(1)][] conversion is made, the [First/Follow][] table is generated, this rule expands as follows:
-
-     (rule ebnf "1"
-      (start #t)
-      (first "@pass" "@terminals" LHS _eps)
-      (follow _eof)
-      (cleanup star)
-      (alt _empty _ebnf_2))
-     (rule _ebnf_1 "1.1"
-      (first "@pass" "@terminals" LHS)
-      (follow "@pass" "@terminals" LHS _eof)
-      (alt declaration rule))
-     (rule _ebnf_2 "1.2"
-      (first "@pass" "@terminals" LHS)
-      (follow _eof)
-      (cleanup merge)
-      (seq _ebnf_1 ebnf))
-     (rule _ebnf_3 "1.3" (first "@pass" "@terminals" LHS _eps) (follow _eof) (seq ebnf))
-
-### Creating terminal definitions and parser rules to parse generated grammars
-The parser is initialized to callbacks invoked on entry and exit
-to each `terminal` and `production`. A trivial parser loop can be described as follows:
-
-    require 'ebnf/ll1/parser'
-    require 'meta'
-
-    class Parser
-      include Meta
-
-      terminal(:SYMBOL, /([a-z]|[A-Z]|[0-9]|_)+/) do |prod, token, input|
-        # Add data based on scanned token to input
-        input[:symbol] = token.value
-      end
-
-      start_production(:rule) do |input, current, callback|
-        # Process on start of production
-        # Set state for entry into recursed rules through current
-
-        # Callback to parser loop with callback
-      end
-
-      production(:rule) do |input, current, callback|
-        # Process on end of production
-        # return results in input, retrieve results from recursed rules in current
-
-        # Callback to parser loop with callback
-      end
-
-      def initialize(input)
-        parser_options = {
-          branch: BRANCH,
-          first: FIRST,
-          follow: FOLLOW,
-          cleanup: CLEANUP
-        }
-        parse(input, start_symbol, parser_options) do |context, *data|
-          # Process calls from callback from productions
-
-        rescue ArgumentError, RDF::LL1::Parser::Error => e
-          progress("Parsing completed with errors:\n\t#{e.message}")
-          raise RDF::ReaderError, e.message if validate?
-        end
-
-### Branch Table
-The Branch table is a hash mapping production rules to a hash relating terminals appearing in input to sequence of productions to follow when the corresponding input terminal is found. This allows either the `seq` primitive, where all terminals map to the same sequence of productions, or the `alt` primitive, where each terminal may map to a different production.
-
-    BRANCH = {
-      :alt => {
-        "(" => [:seq, :_alt_1],
-        :ENUM => [:seq, :_alt_1],
-        :HEX => [:seq, :_alt_1],
-        :O_ENUM => [:seq, :_alt_1],
-        :O_RANGE => [:seq, :_alt_1],
-        :RANGE => [:seq, :_alt_1],
-        :STRING1 => [:seq, :_alt_1],
-        :STRING2 => [:seq, :_alt_1],
-        :SYMBOL => [:seq, :_alt_1],
-      },
-      ...
-      :declaration => {
-        "@pass" => [:pass],
-        "@terminals" => ["@terminals"],
-      },
-      ...
-    }
-
-In this case the `alt` rule is `seq ('|' seq)*` can happen when any of the specified tokens appears on the input stream. The all cause the same token to be passed to the `seq` rule and follow with `_alt_1`, which handles the `('|' seq)*` portion of the rule, after the first sequence is matched.
-
-The `declaration` rule is `@terminals' | pass` using the `alt` primitive determining the production to run based on the terminal appearing on the input stream. Eventually, a terminal production is found and the token is consumed.
-
-### First/Follow Table
-The [First/Follow][] table is a hash mapping production rules to the terminals that may proceed or follow the rule. For example:
-
-    FIRST = {
-      :alt => [
-        :HEX,
-        :SYMBOL,
-        :ENUM,
-        :O_ENUM,
-        :RANGE,
-        :O_RANGE,
-        :STRING1,
-        :STRING2,
-        "("],
-      ...
-    }
-
-### Terminals Table
-This table is a simple list of the terminal productions found in the grammar. For example:
-
-    TERMINALS = ["(", ")", "-",
-      "@pass", "@terminals",
-      :ENUM, :HEX, :LHS, :O_ENUM, :O_RANGE,:POSTFIX,
-      :RANGE, :STRING1, :STRING2, :SYMBOL,"|"
-    ].freeze
-
-### Cleanup Table
-This table identifies productions which used EBNF rules, which are transformed to BNF for actual parsing. This allows the parser, in some cases, to reproduce *star*, *plus*, and *opt* rule matches. For example:
-
-    CLEANUP = {
-      :_alt_1 => :star,
-      :_alt_3 => :merge,
-      :_diff_1 => :opt,
-      :ebnf => :star,
-      :_ebnf_2 => :merge,
-      :_postfix_1 => :opt,
-      :seq => :plus,
-      :_seq_1 => :star,
-      :_seq_2 => :merge,
-    }.freeze
-
-In this case the `ebnf` rule was `(declaration | rule)*`. As BNF does not support a star operator, this is decomposed into a set of rules using `alt` and `seq` primitives:
-
-    ebnf    ::= _empty _ebnf_2
-    _ebnf_1 ::= declaration | rule
-    _ebnf_2 ::= _ebnf_1 ebnf
-    _ebnf_3 ::= ebnf
-
-The `_empty` production matches an empty string, so allows for now value. `_ebnf_2` matches `declaration | rule` (using the `alt` primitive) followed by `ebnf`, creating a sequence of zero or more `declaration` or `alt` members.
+Generate formatted grammar using HTML (requires [Haml][Haml] gem):
 
-## EBNF Grammar
-The [EBNF][] variant used here is based on [W3C](http://w3.org/) [EBNF][] (see {file:etc/ebnf.ebnf EBNF grammar}) as defined in the
-[XML 1.0 recommendation](http://www.w3.org/TR/REC-xml/), with minor extensions:
+    grammar.to_html
+
+### Parsing an ISO/IEC 14977 Grammar
+
+The EBNF gem can also parse [ISO/EIC 14977] Grammars (ISOEBNF) to [S-Expressions][S-Expression].
+
+    grammar = EBNF.parse(File.open('./etc/iso-ebnf.isoebnf', format: :isoebnf))
+
+### Parsing an ABNF Grammar
+
+The EBNF gem can also parse [ABNF] Grammars to [S-Expressions][S-Expression].
+
+    grammar = EBNF.parse(File.open('./etc/abnf.abnf', format: :abnf))
+
+### Parser Debugging
+
+Inevitably while implementing a parser for some specific grammar, a developer will need greater insight into the operation of the parser. While this can involve sorting through a tremendous amount of data, the parser can be provided a [Logger][] instance which will output messages at varying levels of detail to document the state of the parser at any given point. Most useful is likely the `INFO` level of debugging, but even more detail is revealed using the `DEBUG` level. `WARN` and `ERROR` statements will typically also be provided as part of an exception if parsing fails, but can be shown in the context of other parsing state with appropriate indentation as part of the logger.
+
+### Writing Grammars
+
+The {EBNF::Writer} class can be used to write parsed grammars out, either as formatted text, or HTML. Because grammars are written from the Abstract Syntax Tree, represented as [S-Expressions][S-Expression], this provides a means of transforming between grammar formats (e.g., W3C [EBNF][] to [ABNF][]), although with some potential loss in semantic fidelity (case-insensitive string matching vs. case-sensitive matching).
+
+The formatted HTML results are designed to be appropriate for including in specifications. If the [Nokogumbo](https://rubygems.org/gems/nokogumbo) gem list available, the resulting HTML encoded grammar will also be validated.
+
+### Parser Errors
+On a parsing failure, and exception is raised with information that may be useful in determining the source of the error.
 
-* Comments include `\\` and `#` through end of line (other than hex character) and `/* ... */ (* ... *) which may cross lines`
+## EBNF Grammar
+The [EBNF][] variant used here is based on [W3C](https://w3.org/) [EBNF][] (see {file:etc/ebnf.ebnf EBNF grammar}) as defined in the
+[XML 1.0 recommendation](https://www.w3.org/TR/REC-xml/), with minor extensions:
+
+Note that the grammar includes an optional `[identifer]` in front of rule names, which can be in conflict with the `RANGE` terminal. It is typically not a problem, but if it comes up, try parsing with the `native` parser,  add comments or sequences to disambiguate. EBNF does not have beginning of line checks as all whitespace is treated the same, so the common practice of identifying each rule inherently leads to such ambiguity.
+
+The character set for EBNF is UTF-8.
+
+The general form of a rule is:
+
+    symbol ::= expression
+
+which can also be proceeded by an optional number enclosed in square brackets to identify the rule number:
+
+    [1] symbol ::= expression
+
+(Note, this can introduce an ambiguity if the previous rule ends in a range or enum and the current rule has no identifier. In this case, enclosing `expression` within parentheses, or adding intervening comments can resolve the ambiguity.)
+
+Symbols are written in CAPITAL CASE if they are the start symbol of a regular language (terminals), otherwise with they are treated as non-terminal rules. Literal strings are quoted.
+
+Within the expression on the right-hand side of a rule, the following expressions are used to match strings of one or more characters:
+
+<table>
+  <tr><td><code>#xN</code></td>
+    <td>where <code>N</code> is a hexadecimal integer, the expression matches the character whose number (code point) in ISO/IEC 10646 is <code>N</code>. The number of leading zeros in the <code>#xN</code> form is insignificant.</td></tr>
+  <tr><td><code>[a-zA-Z], [#xN-#xN]</code>
+    <td>matches any Char or HEX with a value in the range(s) indicated (inclusive).</td></tr>
+  <tr><td><code>[abc], [#xN#xN#xN]</code></td>
+    <td>matches any UTF-8 R\_CHAR or HEX with a value among the characters enumerated. The last component may be '-'. Enumerations and ranges may be mixed in one set of brackets.</td></tr>
+  <tr><td><code>[^a-z], [^#xN-#xN]</code></td>
+    <td>matches any UTF-8 Char or HEX a value outside the range indicated.</td></tr>
+  <tr><td><code>[^abc], [^#xN#xN#xN]</code></td>
+    <td>matches any UTF-8 R\_CHAR or HEX with a value not among the characters given. The last component may be '-'. Enumerations and ranges of excluded values may be mixed in one set of brackets.</td></tr>
+  <tr><td><code>"string"</code></td>
+    <td>matches a literal string matching that given inside the double quotes.</td></tr>
+  <tr><td><code>'string'</code></td>
+    <td>matches a literal string matching that given inside the single quotes.</td></tr>
+  <tr><td><code>A (B | C)</code></td>
+    <td><code>(B | C)</code> is treated as a unit and may be combined as described in this list.</td></tr>
+  <tr><td><code>A?</code></td>
+    <td>matches A or nothing; optional A.</td></tr>
+  <tr><td><code>A B</code></td>
+    <td>matches <code>A</code> followed by <code>B</code>. This operator has higher precedence than alternation; thus <code>A B | C D</code> is identical to <code>(A B) | (C D)</code>.</td></tr>
+  <tr><td><code>A | B</code></td>
+    <td>matches <code>A</code> or <code>B</code>.</td></tr>
+  <tr><td><code>A - B</code></td>
+    <td>matches any string that matches <code>A</code> but does not match <code>B</code>. (Only supported on Terminals in LL(1) BNF).</td></tr>
+  <tr><td><code>A+</code></td>
+    <td>matches one or more occurrences of <code>A</code>. Concatenation has higher precedence than alternation; thus <code>A+ | B+</code> is identical to <code>(A+) | (B+)</code>.</td></tr>
+  <tr><td><code>A*</code></td>
+    <td>matches zero or more occurrences of <code>A</code>. Concatenation has higher precedence than alternation; thus <code>A* | B*</code> is identical to <code>(A*) | (B*)</code>.</td></tr>
+  <tr><td><code>@pass " "*</code></td>
+    <td>Defines consumed whitespace in the document. Any whitespace found between non-terminal rules is consumed and ignored.</td></tr>
+  <tr><td><code>@terminals</code></td>
+    <td>Introduces terminal rules. All rules defined after this point are treated as terminals.</td></tr>
+</table>
+
+* Comments include `//` and `#` through end of line (other than hex character) and `/* ... */ (* ... *) which may cross lines`
 * All rules **MAY** start with an identifier, contained within square brackets. For example `[1] rule`, where the value within the brackets is a symbol `([a-z] | [A-Z] | [0-9] | "_" | ".")+`
-* `@terminals` causes following rules to be treated as terminals. Any terminal which are entirely upper-case are also treated as terminals
+* `@terminals` causes following rules to be treated as terminals. Any terminal which is all upper-case (eg`TERMINAL`), or any rules with expressions that match characters (`#xN`, `[a-z]`, `[^a-z]`, `[abc]`, `[^abc]`, `"string"`, `'string'`, or `A - B`), are also treated as terminals.
 * `@pass` defines the expression used to detect whitespace, which is removed in processing.
 * No support for `wfc` (well-formedness constraint) or `vc` (validity constraint).
 
-Parsing this grammar yields an S-Expression version: {file:etc/ebnf.ll1.sxp}.
+Parsing this grammar yields an [S-Expression][] version: {file:etc/ebnf.sxp} (or [LL(1)][] version {file:etc/ebnf.ll1.sxp} or [PEG][] version {file:etc/ebnf.peg.sxp}).
+
+### Parser S-Expressions
+Intermediate representations of the grammar may be serialized to Lisp-like [S-Expressions][S-Expression]. For example, the rule
+
+    [1] ebnf        ::= (declaration | rule)*
+
+is serialized as
+
+    (rule ebnf "1" (star (alt declaration rule)))
+
+Different components of an EBNF rule expression are transformed into their own operator:
+
+<table>
+  <tr><td><code>#xN</code></td><td><code>(hex "#xN")</code></td></tr>
+  <tr><td><code>[a-z#xN-#xN]</code></td><td><code>(range "a-z#xN-#xN")</code></td></tr>
+  <tr><td><code>[abc#xN]</code></td><td><code>(range "abc#xN")</code></td></tr>
+  <tr><td><code>[^a-z#xN-#xN]</code></td><td><code>(range "^a-z#xN-#xN")</code></td></tr>
+  <tr><td><code>[^abc#xN]</code></td><td><code>(range "^abc#xN")</code></td></tr>
+  <tr><td><code>"string"</code></td><td><code>"string"</code></td></tr>
+  <tr><td><code>'string'</code></td><td><code>"string"</code></td></tr>
+  <tr><td><code>A (B | C)</code></td><td><code>(seq (A (alt B C)))</code></td></tr>
+  <tr><td><code>A?</code></td><td><code>(opt A)</code></td></tr>
+  <tr><td><code>A B</code></td><td><code>(seq A B)</code></td></tr>
+  <tr><td><code>A | B</code></td><td><code>(alt A B)</code></td></tr>
+  <tr><td><code>A - B</code></td>
+    <td><code>(diff A B) for terminals.<br/>
+      <code>(seq (not B) A) for non-terminals (PEG parsing only)</code></code></td></tr>
+  <tr><td><code>A+</code></td><td><code>(plus A)</code></td></tr>
+  <tr><td><code>A*</code></td><td><code>(star A)</code></td></tr>
+  <tr><td><code>@pass " "*</code></td><td><code>(pass _pass (star " "))</code></td></tr>
+  <tr><td><code>@terminals</code></td><td></td></tr>
+</table>
+
+Other rule operators are not directly supported in [EBNF][], but are included to support other notations (e.g., [ABNF][] and [ISO/IEC 14977][]):
+
+<table>
+  <tr><td><code>%i"StRiNg"</code></td><td><code>(istr "StRiNg")</code></td><td>Case-insensitive string matching</td></tr>
+  <tr><td><code>'' - A</code></td><td><code>(not A)</code></td><td>Negative look-ahead, used for non-terminal uses of `B - A`.</td></tr>
+  <tr><td><code>n*mA</code></td><td><code>(rept n m A)</code></td><td>Explicit repetition.</td></tr>
+</table>
+
+Additionally, rules defined with an UPPERCASE symbol are treated as terminals.
+
+For an [LL(1)][] parser generator, the {EBNF::BNF.make_bnf} method can be used to transform the EBNF rule into a BNF rule.
+
+    (rule ebnf "1" (alt _empty _ebnf_2))
+    (rule _ebnf_1 "1.1" (alt declaration rule))
+    (rule _ebnf_2 "1.2" (seq _ebnf_1 ebnf))
+    (rule _ebnf_3 "1.3" (seq ebnf))
+
+This allows [First/Follow][] and other tables used by a parser to parse examples of the associated grammar. For more, see {EBNF::LL1}.
+
+For a [PEG][] parser generator, there is a simpler transformation that reduces rules containing sub-expressions (composed of `star`, `alt`, `seq` and similar expressions) and creates named rules to allow appropriate callbacks and for naming elements of the generating abstract syntax tree. The {EBNF::PEG.make_peg} method transforms the original rule into the following two rules:
+
+    (rule ebnf "1" (star _ebnf_1))
+    (rule _ebnf_1 "1.1" (alt declaration rule))
+
+## Example parsers
+For a [PEG][] parser for a simple grammar implementing a calculator see [Calc example](https://dryruby.github.io/ebnf/examples/calc/doc/calc.html)
+
+For an example parser built using this gem that parses the [EBNF][] grammar, see [EBNF PEG Parser example](https://dryruby.github.io/ebnf/examples/ebnf-peg-parser/doc/parser.html). This example creates a parser for the [EBNF][] grammar which generates the same Abstract Syntax Tree as the built-in parser in the gem.
+
+There is also an
+[EBNF LL(1) Parser example](https://dryruby.github.io/ebnf/examples/ebnf-peg-parser/doc/parser.html).
+
+The [ISO EBNF Parser](https://dryruby.github.io/ebnf/examples/isoebnf/doc/parser.html) example parses [ISO/IEC 14977][] into [S-Expressions][S-Expression], which can be used to parse compatible grammars using this parser (either [PEG][] or [LL(1)][]).
 
-## Example parser
-For an example parser built using this gem, see {file:examples/ebnf-parser/README EBNF Parser example}. This example creates a parser for the [EBNF][] grammar which generates the same Abstract Syntax Tree as the built-in parser in the gem.
+The [ABNF Parser](https://dryruby.github.io/ebnf/examples/abnf/doc/parser.html) example parses [ABNF][] into [S-Expressions][S-Expression], which can be used to parse compatible grammars using this [PEG][] parser.
 
 ##  Acknowledgements
 Much of this work, particularly the generic parser, is inspired by work originally done by
-Tim Berners-Lee's Python [predictive parser](http://www.w3.org/2000/10/swap/grammar/predictiveParser.py).
+Tim Berners-Lee's Python [predictive parser](https://www.w3.org/2000/10/swap/grammar/predictiveParser.py).
 
-The EBNF parser was inspired by Dan Connolly's
-[EBNF to Turtle processor](http://www.w3.org/2000/10/swap/grammar/ebnf2turtle.py),
-[EBNF to BNF Notation-3 rules](http://www.w3.org/2000/10/swap/grammar/ebnf2bnf.n3),
-and [First Follow Notation-3 rules](http://www.w3.org/2000/10/swap/grammar/first_follow.n3). 
+The [LL(1)][] parser was inspired by Dan Connolly's
+[EBNF to Turtle processor](https://www.w3.org/2000/10/swap/grammar/ebnf2turtle.py),
+[EBNF to BNF Notation-3 rules](https://www.w3.org/2000/10/swap/grammar/ebnf2bnf.n3),
+and [First Follow Notation-3 rules](https://www.w3.org/2000/10/swap/grammar/first_follow.n3). 
 
 ## Documentation
 Full documentation available on [Rubydoc.info][EBNF doc].
 
 ## Future Work
 * Better LL(1) parser tests
-* Either generate [Packrat parser][Packrat] for a [Parsing Regular Expression Grammar][PEG], or integrate with [Treetop][] or similar.
 
 ## Author
-* [Gregg Kellogg](http://github.com/gkellogg) - <http://greggkellogg.net/>
+* [Gregg Kellogg](https://github.com/gkellogg) - <https://greggkellogg.net/>
 
 ## Contributing
 This repository uses [Git Flow](https://github.com/nvie/gitflow) to mange development and release activity. All submissions _must_ be on a feature branch based on the _develop_ branch to ease staging and integration.
@@ -244,26 +262,32 @@ This repository uses [Git Flow](https://github.com/nvie/gitflow) to mange develo
   list in the the `README`. Alphabetical order applies.
 * Do note that in order for us to merge any non-trivial changes (as a rule
   of thumb, additions larger than about 15 lines of code), we need an
-  explicit [public domain dedication][PDD] on record from you.
+  explicit [public domain dedication][PDD] on record from you,
+  which you will be asked to agree to on the first commit to a repo within the organization.
 
 ## License
 This is free and unencumbered public domain software. For more information,
-see <http://unlicense.org/> or the accompanying {file:UNLICENSE} file.
-
-A copy of the [Turtle EBNF][] and derived parser files are included in the repository, which are not covered under the UNLICENSE. These files are covered via the [W3C Document License](http://www.w3.org/Consortium/Legal/2002/copyright-documents-20021231).
-
-[Ruby]:         http://ruby-lang.org/
-[YARD]:         http://yardoc.org/
-[YARD-GS]:      http://rubydoc.info/docs/yard/file/docs/GettingStarted.md
-[PDD]:          http://lists.w3.org/Archives/Public/public-rdf-ruby/2010May/0013.html
-[EBNF]:         http://www.w3.org/TR/REC-xml/#sec-notation
-[EBNF doc]:     http://rubydoc.info/github/dryruby/ebnf/master/frames
-[First/Follow]: http://en.wikipedia.org/wiki/LL_parser#Constructing_an_LL.281.29_parsing_table
-[LL(1)]:        http://www.csd.uwo.ca/~moreno//CS447/Lectures/Syntax.html/node14.html
-[LL(1) Parser]: http://en.wikipedia.org/wiki/LL_parser
-[Tokenizer]:    http://en.wikipedia.org/wiki/Lexical_analysis#Tokenizer
-[Turtle EBNF]:  http://dvcs.w3.org/hg/rdf/file/default/rdf-turtle/turtle.bnf
-[Packrat]:      http://pdos.csail.mit.edu/~baford/packrat/thesis/
-[PEG]:          http://en.wikipedia.org/wiki/Parsing_expression_grammar
-[Treetop]:      http://rubygems.org/gems/treetop
-[Haml]:         http://rubygems.org/gems/haml
+see <https://unlicense.org/> or the accompanying {file:UNLICENSE} file.
+
+A copy of the [Turtle EBNF][] and derived parser files are included in the repository, which are not covered under the UNLICENSE. These files are covered via the [W3C Document License](https://www.w3.org/Consortium/Legal/2002/copyright-documents-20021231).
+
+[Ruby]:         https://ruby-lang.org/
+[YARD]:         https://yardoc.org/
+[YARD-GS]:      https://rubydoc.info/docs/yard/file/docs/GettingStarted.md
+[PDD]:          https://lists.w3.org/Archives/Public/public-rdf-ruby/2010May/0013.html
+[ABNF]:         https://www.rfc-editor.org/rfc/rfc5234
+[BNF]:          https://en.wikipedia.org/wiki/Backus–Naur_form
+[EBNF]:         https://www.w3.org/TR/REC-xml/#sec-notation
+[EBNF doc]:     https://rubydoc.info/github/dryruby/ebnf
+[First/Follow]: https://en.wikipedia.org/wiki/LL_parser#Constructing_an_LL.281.29_parsing_table
+[ISO/IEC 14977]:https://www.iso.org/standard/26153.html
+[LL(1)]:        https://www.csd.uwo.ca/~moreno//CS447/Lectures/Syntax.html/node14.html
+[LL(1) Parser]: https://en.wikipedia.org/wiki/LL_parser
+[Logger]:       https://ruby-doc.org/stdlib-2.4.0/libdoc/logger/rdoc/Logger.html
+[S-expression]: https://en.wikipedia.org/wiki/S-expression
+[Tokenizer]:    https://en.wikipedia.org/wiki/Lexical_analysis#Tokenizer
+[Turtle]:       https://www.w3.org/TR/2012/WD-turtle-20120710/
+[Turtle EBNF]:  https://dvcs.w3.org/hg/rdf/file/default/rdf-turtle/turtle.bnf
+[Packrat]:      https://pdos.csail.mit.edu/~baford/packrat/thesis/
+[PEG]:          https://en.wikipedia.org/wiki/Parsing_expression_grammar
+[Haml]:         https://rubygems.org/gems/haml