rley 0.7.06 → 0.8.01

data/lib/rley/constants.rb

@@ -5,7 +5,7 @@
 
 module Rley # Module used as a namespace
   # The version number of the gem.
-  Version = '0.7.06'
+  Version = '0.8.01'
 
   # Brief description of the gem.
   Description = "Ruby implementation of the Earley's parsing algorithm"
@@ -20,7 +20,7 @@ module Rley # Module used as a namespace
     RootDir = begin
       require 'pathname' # Load Pathname class from standard library
       startdir = Pathname(__FILE__).dirname.parent.parent.expand_path
-      startdir.to_s + '/' # Append trailing slash character to it
+      "#{startdir}/" # Append trailing slash character to it
     end
   end
 end # module

data/lib/rley/engine.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative './syntax/grammar_builder'
+require_relative './notation/grammar_builder'
 require_relative './parser/gfg_earley_parser'
 require_relative './parse_tree_visitor'
 require_relative './parse_forest_visitor'
@@ -15,15 +15,14 @@ module Rley # This module is used as a namespace
     #   @return [Symbol] allowed values are: :parse_tree, :parse_forest
     :parse_repr,
     :repr_builder,
-    :diagnose
-  ) do
-    # Constructor with default initialization.
-    def initialize()
-      super()
-      self.parse_repr = :parse_tree
-      self.repr_builder = :default
-      self.diagnose = false
-    end
+    :diagnose) do
+      # Constructor with default initialization.
+      def initialize
+        super()
+        self.parse_repr = :parse_tree
+        self.repr_builder = :default
+        self.diagnose = false
+      end
   end
 
   # Implementation of the GoF Facade design pattern.
@@ -43,7 +42,7 @@ module Rley # This module is used as a namespace
     #   Engine.new do |config|
     #     config.parse_repr = :parse_forest
     #   end
-    def initialize()
+    def initialize
       @configuration = EngineConfig.new
       yield configuration if block_given?
     end
@@ -62,7 +61,7 @@ module Rley # This module is used as a namespace
     #     add_production('elements' => 'INTEGER')
     #   end
     def build_grammar(&aBlock)
-      builder = Rley::Syntax::GrammarBuilder.new(&aBlock)
+      builder = Rley::Notation::GrammarBuilder.new(&aBlock)
       @grammar = builder.grammar
     end
 
@@ -91,7 +90,7 @@ module Rley # This module is used as a namespace
       result = parser.parse(tokens)
       result.tidy_up!
 
-      return result
+      result
     end
 
     # Convert raw parse result into a more convenient representation
@@ -99,14 +98,12 @@ module Rley # This module is used as a namespace
     # @param aRawParse [Parser::GFGParsing]
     # @return [Rley::PTree::ParseTree, Rley::SPPF::ParseForest]
     def convert(aRawParse)
-      result = case configuration.parse_repr
-                 when :parse_tree
-                   to_ptree(aRawParse)
-                 when :parse_forest
-                   to_pforest(aRawParse)
-               end
-
-      return result
+      case configuration.parse_repr
+        when :parse_tree
+          to_ptree(aRawParse)
+        when :parse_forest
+          to_pforest(aRawParse)
+      end
     end
 
     # Convert raw parse result into a parse tree representation
@@ -120,7 +117,7 @@ module Rley # This module is used as a namespace
         result = factory.create(configuration.repr_builder)
       end
 
-      return result
+      result
     end
 
     # Convert raw parse result into a parse forest representation
@@ -134,7 +131,7 @@ module Rley # This module is used as a namespace
         result = factory.create(configuration.repr_builder)
       end
 
-      return result
+      result
     end
 
     # Build a visitor for the given parse tree
@@ -148,13 +145,13 @@ module Rley # This module is used as a namespace
     # @param aPForest [SPPF::ParseForest]
     # @return [ParseForestVisitor]
     def pforest_visitor(aPForest)
-      return ParseForestVisitor.new(aPForest)
+      ParseForestVisitor.new(aPForest)
     end
 
     protected
 
     def build_parser(aGrammar)
-      return Parser::GFGEarleyParser.new(aGrammar)
+      Parser::GFGEarleyParser.new(aGrammar)
     end
   end # class
 end # module

data/lib/rley/formatter/asciitree.rb

@@ -15,7 +15,7 @@ module Rley # This module is used as a namespace
       # Allowed string values are: 'first', 'last', 'first_and_last', 'other'
       attr_reader(:ranks)
 
-      # @return [String] The character pattern used for rendering 
+      # @return [String] The character pattern used for rendering
       # a parent - child nesting
       attr_reader(:nesting_prefix)
 
@@ -99,7 +99,7 @@ module Rley # This module is used as a namespace
       end
 
       # 'root', 'first', 'first_and_last', 'last', 'other'
-      def path_prefix()
+      def path_prefix
         return '' if ranks.empty?
 
         prefix = +''
@@ -116,7 +116,7 @@ module Rley # This module is used as a namespace
         end
 
         prefix << nesting_prefix
-        return prefix
+        prefix
       end
 
       def emit(aNode, aSuffix = '')

data/lib/rley/formatter/bracket_notation.rb

@@ -13,13 +13,6 @@ module Rley # This module is used as a namespace
     # For Ruby developers, there is RSyntaxTree by Yoichiro Hasebe.
     # (accessible via: http://yohasebe.com/rsyntaxtree/)
     class BracketNotation < BaseFormatter
-      # Constructor.
-      # @param anIO [IO] The output stream to which the rendered grammar
-      # is written.
-      def initialize(anIO)
-        super(anIO)
-      end
-
       # Method called by a ParseTreeVisitor to which the formatter subscribed.
       # Notification of a visit event: the visitor is about to visit
       # a non-terminal node
@@ -44,7 +37,7 @@ module Rley # This module is used as a namespace
         # Escape all opening and closing square brackets
         escape_lbrackets = aTerm.token.lexeme.gsub(/\[/, '\[')
         escaped = escape_lbrackets.gsub(/\]/, '\]')
-        write(escaped + ']')
+        write("#{escaped}]")
       end
 
       # Method called by a ParseTreeVisitor to which the formatter subscribed.

data/lib/rley/formatter/debug.rb

@@ -19,17 +19,17 @@ module Rley # This module is used as a namespace
         super(anIO)
         @indentation = 0
       end
-      
+
       # Indicates that this formatter accepts all visit events
       # provided their names start with 'before_' or 'after_'
       # @return [Boolean]
       def accept_all
         return true
       end
-      
+
       # Ghost method pattern.
-      def method_missing(mth, *args)    
-        mth_name = mth.to_s         
+      def method_missing(mth, *args)
+        mth_name = mth.to_s
         case mth_name
           when /^before_/
             output_event(mth_name, indentation)
@@ -44,11 +44,11 @@ module Rley # This module is used as a namespace
 
       private
 
-      def indent()
+      def indent
         @indentation += 1
       end
 
-      def dedent()
+      def dedent
         @indentation -= 1
       end
 

data/lib/rley/formatter/json.rb

@@ -94,11 +94,11 @@ module Rley # This module is used as a namespace
 
       private
 
-      def indent()
+      def indent
         @indentation += 1
       end
 
-      def dedent()
+      def dedent
         @indentation -= 1
       end
 

data/lib/rley/gfg/call_edge.rb

@@ -16,7 +16,7 @@ module Rley # This module is used as a namespace
       # Pre-condition: theSuccessor is an StartVertex
       def initialize(thePredecessor, theSuccessor)
         super(thePredecessor, theSuccessor)
-        do_set_key(thePredecessor, theSuccessor)      
+        do_set_key(thePredecessor, theSuccessor)
       end
 
       private

data/lib/rley/gfg/edge.rb

@@ -14,18 +14,18 @@ module Rley # This module is used as a namespace
       # @param theSuccessor [Vertex]
       def initialize(thePredecessor, theSuccessor)
         @successor = theSuccessor
-        thePredecessor.add_edge(self)
+        thePredecessor&.add_edge(self)
       end
 
       # @return [String]
-      def to_s()
+      def to_s
         " --> #{successor.label}"
       end
-      
-      # Returns a string containing a human-readable representation of the 
+
+      # Returns a string containing a human-readable representation of the
       # production.
       # @return [String]
-      def inspect()
+      def inspect
         to_s
       end
     end # class

data/lib/rley/gfg/end_vertex.rb

@@ -10,12 +10,8 @@ module Rley # This module is used as a namespace
     # Responsibilities (in addition to inherited ones):
     # - Know its related non-terminal symbol
     class EndVertex < NonTerminalVertex
-      def initialize(aNonTerminal)
-        super(aNonTerminal)
-      end
-
-      def label()
-        return "#{non_terminal}."
+      def label
+        "#{non_terminal}."
       end
     end # class
   end # module

data/lib/rley/gfg/epsilon_edge.rb

@@ -9,12 +9,8 @@ module Rley # This module is used as a namespace
     # Responsibilities:
     # - To know the successor vertex
     class EpsilonEdge < Edge
-      # The destination vertex of the edge .
+      # The destination vertex of the edge.
       attr_reader :successor
-
-      def initialize(thePredecessor, theSuccessor)
-        super(thePredecessor, theSuccessor)
-      end
     end # class
   end # module
 end # module

data/lib/rley/gfg/grm_flow_graph.rb

@@ -13,26 +13,26 @@ require_relative 'shortcut_edge'
 module Rley # This module is used as a namespace
   module GFG # This module is used as a namespace
     # A Grammar Flow Graph (GFG) represents the parsing states of productions
-    # rules from a context-free grammar. This representation is based on a 
-    # directed graph structure. The parsing process can then be re-formulated 
+    # rules from a context-free grammar. This representation is based on a
+    # directed graph structure. The parsing process can then be re-formulated
     # as a path problem in the graph. The theory behind GFGs can be found in
     # papers. The first article on GFG can be found here:
     # https://apps.cs.utexas.edu/tech_reports/reports/tr/TR-2102.pdf
-    # There are three types of vertex in a GFG: 
+    # There are three types of vertex in a GFG:
     # start vertex, end vertex and item vertex.
     # For each non-terminal symbol N of the grammar, there is:
     # a start vertex with label '.N'
     # an end vertex with label 'N.'
     # For each production rule of the grammar:
     # N => s1 s2 s3 (...) sk
-    # I.e. a rule with k grammar symbols in its right-handed side. 
+    # I.e. a rule with k grammar symbols in its right-handed side.
     # For such a rule there will be k + 1 item vertices. By convention,
     # the first item vertex is labelled as 'N => . s1 s2 s3 (...) sk'
     # the second item vertex is labelled as 'N => s1 . s2 s3 (...) sk'
     # the third item vertex is labelled as 'N => s1 s2 . s3 (...) sk'
     # and so on. In other words, the labels are obtained by moving a dot
-    # in successive positions in the rhs. The dot represents the 
-    # parse progress for the production rule. Symbols on the left of the 
+    # in successive positions in the rhs. The dot represents the
+    # parse progress for the production rule. Symbols on the left of the
     # dot represent the symbols that were successfully matched in the input.
     # A GFG has three types of directed edges linking the vertices.
     # call edge, return edge and scan edge.
@@ -60,24 +60,24 @@ module Rley # This module is used as a namespace
 
         build_graph(theDottedItems)
       end
-      
-      # Returns a string containing a human-readable representation of the 
+
+      # Returns a string containing a human-readable representation of the
       # production.
       # @return [String]
-      def inspect()
+      def inspect
         result = +"#<#{self.class.name}:#{object_id}"
         result << ' @vertices=['
         list = vertices.map { |v| "#<#{v.selfie}>" }
         result << list.join(', ')
         result << '] '
         edges = []
-        vertices.each do |v| 
+        vertices.each do |v|
           edges << v.edges do |e|
             result << "#{v.object_id} #{e.inspect}"
           end
         end
         result << "edges=[#{edges.join(",\n ")}]>"
-        return result
+        result
       end
 
       # Retrieve the vertex with given vertex label.
@@ -92,7 +92,7 @@ module Rley # This module is used as a namespace
       # If one wants to remove useless rules, then do first:
       # elimination of non-generating symbols
       # then elimination of unreachable symbols
-      def diagnose()
+      def diagnose
         mark_unreachable_symbols
       end
 
@@ -121,6 +121,7 @@ module Rley # This module is used as a namespace
       # @param aStartVertex [StartVertex] the depth-first traversal begins
       #   from here
       # @param _visitAction [Proc] block called when a new graph vertex is found
+      # rubocop: disable Lint/Loop
       def traverse_df(aStartVertex, &_visitAction)
         visited = Set.new
         stack = []
@@ -129,13 +130,13 @@ module Rley # This module is used as a namespace
 
         begin
           # print_vertex( 'Traversing', visitee)
-          
+
           first_time = !visited.include?(visitee)
           if first_time
             yield(visitee)
             visited << visitee
-          end         
-                      
+          end
+
           case visitee
             when Rley::GFG::StartVertex
               if first_time
@@ -155,12 +156,12 @@ module Rley # This module is used as a namespace
               if stack.last.done?
                 popped = stack.pop
                 break if stack.empty?
-                
+
                 # puts "Popped!"
                 return_key = popped.in_edge.key.sub(/^CALL/, 'RET')
                 curr_edge = visitee.edges.find { |e| e.key == return_key }
               else
-                curr_edge = stack.last.next_edge          
+                curr_edge = stack.last.next_edge
               end
 
             else
@@ -173,6 +174,7 @@ module Rley # This module is used as a namespace
         last_one = end_vertex_for[aStartVertex.non_terminal]
         yield(last_one) unless visited.include?(last_one)
       end
+      # rubocop: enable Lint/Loop
 
       private
 
@@ -183,16 +185,16 @@ module Rley # This module is used as a namespace
         @start_vertex = aVertex if vertices.empty?
         vertices << aVertex
       end
-      
+
       # For debugging purposes
       def print_vertex(aText, aVertex)
-        print aText + ' '
+        print "#{aText} "
         if aVertex.kind_of?(NonTerminalVertex)
           puts "#{aVertex.class} #{aVertex.non_terminal.name}"
         else
           p(aVertex.label)
-        end       
-      end      
+        end
+      end
 
       def build_graph(theDottedItems)
         build_all_starts_ends(theDottedItems)
@@ -200,7 +202,7 @@ module Rley # This module is used as a namespace
         curr_prod = nil
         theDottedItems.each_with_index do |d_item, index_item|
           next unless curr_prod.nil? || curr_prod != d_item.production
-          
+
           # Another production found...
           curr_prod = d_item.production
           if curr_prod.empty?
@@ -268,6 +270,7 @@ module Rley # This module is used as a namespace
       #     add a shortcut edge:
       # ( N => α[1] .A  α[n] ) -> ( N => α[1] A.  α[n] )
       def augment_graph(theDottedItems, firstItemPos)
+        # rubocop: disable Lint/RedundantSafeNavigation
         production = theDottedItems[firstItemPos].production
         max_index = production.rhs.size + 1
         prev_vertex = nil
@@ -298,6 +301,7 @@ module Rley # This module is used as a namespace
           prev_vertex = new_vertex
         end
       end
+      # rubocop: enable Lint/RedundantSafeNavigation
 
       # Create an entry edge for the given vertex
       def build_entry_edge(theVertex)
@@ -359,7 +363,7 @@ module Rley # This module is used as a namespace
       # Mark non-terminal symbols that cannot be derived from the start symbol.
       # In a GFG, a non-terminal symbol N is unreachable if there is no path
       # from the start symbol to the start node .N
-      def mark_unreachable_symbols()
+      def mark_unreachable_symbols
         # Mark all non-terminals as unreachable
         start_vertex_for.each_value do |a_vertex|
           a_vertex.non_terminal.unreachable = true