rley 0.7.06 → 0.8.01

data/lib/rley/parser/parse_walker_factory.rb

@@ -21,16 +21,13 @@ module Rley # This module is used as a namespace
       # non-terminal symbol => { index(=origin) => start entry }
       :return_stack, # @return [Array<ParseEntry>] A stack of parse entries
       :backtrack_points,
-      :lazy_walk # If true and revisit end vertex then jump to start vertex
-    )
-
+      :lazy_walk) # If true and revisit end vertex then jump to start vertex
 
     WalkerBacktrackpoint = Struct.new(
       :entry_set_index, # Sigma set index of current parse entry
       :return_stack, # A stack of parse entries
       :visitee, # The parse entry being visited
-      :antecedent_index
-    )
+      :antecedent_index)
 
     # A factory that creates an Enumerator object
     # that itself walks through a GFGParsing object.
@@ -53,6 +50,7 @@ module Rley # This module is used as a namespace
       # @param lazyWalk [Boolean] if true then take some shortcut in re-visits.
       # @return [Enumerator] yields visit events when walking over the
       #   parse result
+      # rubocop: disable Style/OptionalBooleanParameter
       def build_walker(acceptingEntry, maxIndex, lazyWalk = false)
         msg = 'Internal error: nil entry argument'
         raise StandardError, msg if acceptingEntry.nil?
@@ -60,7 +58,7 @@ module Rley # This module is used as a namespace
         # Local context for the enumerator
         ctx = init_context(acceptingEntry, maxIndex, lazyWalk)
 
-        walker = Enumerator.new do |receiver| # 'receiver' is a Yielder
+        Enumerator.new do |receiver| # 'receiver' is a Yielder
           # At this point: current entry == accepting entry
 
           loop do
@@ -70,7 +68,7 @@ module Rley # This module is used as a namespace
             if ctx.curr_entry.orphan? # No antecedent?...
               msg_prefix = "No antecedent for #{ctx.curr_entry}"
               msg_suffix = "at rank #{ctx.entry_set_index}"
-              err_msg = msg_prefix + ' ' + msg_suffix
+              err_msg = "#{msg_prefix} #{msg_suffix}"
               raise StandardError, err_msg unless ctx.curr_entry.start_entry?
               break if ctx.backtrack_points.empty?
 
@@ -84,9 +82,8 @@ module Rley # This module is used as a namespace
             ctx.curr_entry = result.last
           end
         end
-
-        return walker
       end
+      # rubocop: enable Style/OptionalBooleanParameter
 
       private
 
@@ -101,12 +98,12 @@ module Rley # This module is used as a namespace
         context.backtrack_points = []
         context.lazy_walk = lazyWalk
 
-        return context
+        context
       end
 
       # Initialize the non-terminal to start entry mapping
-      def init_nterm2start()
-        h = Hash.new do |hsh, defval|
+      def init_nterm2start
+        Hash.new do |hsh, defval|
           entry, index = defval
           nonterm = entry.vertex.non_terminal
           if hsh.include? nonterm
@@ -116,11 +113,10 @@ module Rley # This module is used as a namespace
             hsh[nonterm] = { index => entry }
           end
         end
-
-        return h
       end
 
       # [event, entry, index, vertex]
+      # rubocop: disable Lint/DuplicateBranch
       def visit_entry(anEntry, aContext)
         index = aContext.entry_set_index
         aContext.nterm2start[[anEntry, index]] if anEntry.start_entry?
@@ -156,11 +152,12 @@ module Rley # This module is used as a namespace
           event = [:visit, anEntry, index]
         end
 
-        return event
+        event
       end
+      # rubocop: enable Lint/DuplicateBranch
 
       def detect_scan_edge(_ctx)
-        return nil unless aContext.curr_entry.dotted_entry?
+        nil unless aContext.curr_entry.dotted_entry?
       end
 
       # Given the current entry from context object
@@ -170,13 +167,11 @@ module Rley # This module is used as a namespace
         entries = []
         return entries if aContext.curr_entry.orphan?
 
-        entries = if aContext.curr_entry.antecedents.size == 1
-                    antecedent_of(aContext)
-                  else
-                    select_antecedent(aContext)
-                  end
-
-        entries
+        if aContext.curr_entry.antecedents.size == 1
+          antecedent_of(aContext)
+        else
+          select_antecedent(aContext)
+        end
       end
 
       # Handle the case of an entry having one antecedent only
@@ -205,7 +200,7 @@ module Rley # This module is used as a namespace
           raise NotImplementedError, "edge is a #{traversed_edge.class}"
         end
 
-        return events
+        events
       end
 
       # Handle the case of an entry having multiple antecedents
@@ -231,7 +226,7 @@ module Rley # This module is used as a namespace
             raise StandardError, 'Internal error'
         end
 
-        return [new_entry]
+        [new_entry]
       end
 
       def add_backtrack_point(aContext)
@@ -243,7 +238,7 @@ module Rley # This module is used as a namespace
         bp.antecedent_index = 0
         aContext.backtrack_points << bp
         # puts "Backtrack size after addition #{aContext.backtrack_points.size}"
-        return bp
+        bp
       end
 
       def use_backtrack_point(aContext)
@@ -263,7 +258,7 @@ module Rley # This module is used as a namespace
         # puts "Backtrack size after backtracking #{aContext.backtrack_points.size}"
 
         # Emit a backtrack event
-        return [:backtrack, bp.visitee, aContext.entry_set_index]
+        [:backtrack, bp.visitee, aContext.entry_set_index]
       end
 
       # From the antecedent of the current parse entry
@@ -287,7 +282,7 @@ module Rley # This module is used as a namespace
         new_entry ||= aContext.curr_entry
 
         # puts "Pop from return stack matching entry #{new_entry}"
-        return new_entry
+        new_entry
       end
     end # class
   end # module

data/lib/rley/ptree/non_terminal_node.rb

@@ -18,20 +18,22 @@ module Rley # This module is used as a namespace
       def add_subnode(aSubnode)
         subnodes.unshift(aSubnode)
       end
-      
+
       # Emit a (formatted) string representation of the node.
       # Mainly used for diagnosis/debugging purposes.
+      # rubocop: disable Style/StringConcatenation
       def to_string(indentation)
         connector = '+- '
         selfie = super(indentation)
         prefix = "\n" + (' ' * connector.size * indentation) + connector
         subnodes_repr = subnodes.reduce(+'') do |sub_result, subnode|
-          sub_result << prefix + subnode.to_string(indentation + 1) 
+          sub_result << prefix + subnode.to_string(indentation + 1)
         end
-        
-        return selfie + subnodes_repr        
+
+        selfie + subnodes_repr
       end
-      
+      # rubocop: enable Style/StringConcatenation
+
       # Part of the 'visitee' role in Visitor design pattern.
       # @param aVisitor[ParseTreeVisitor] the visitor
       def accept(aVisitor)

data/lib/rley/ptree/parse_tree.rb

@@ -6,12 +6,12 @@ require_relative 'non_terminal_node'
 module Rley # This module is used as a namespace
   module PTree # This module is used as a namespace
     # A parse tree (a.k.a. concrete syntax tree) is a tree-based representation
-    # for the parse that corresponds to the input text. In a parse tree, 
+    # for the parse that corresponds to the input text. In a parse tree,
     # a node corresponds to a grammar symbol used during the parsing:
     # - a leaf node maps to a terminal symbol occurring in
     # the input, and
     # - a intermediate node maps to a non-terminal node reduced
-    # during the parse. 
+    # during the parse.
     # The root node corresponds to the main/start symbol of the grammar.
     class ParseTree
       # @return [ParseTreeNode] The root node of the tree.
@@ -21,7 +21,7 @@ module Rley # This module is used as a namespace
       def initialize(theRootNode)
         @root = theRootNode
       end
-      
+
       # Notification from the builder telling that the parse tree construction
       # is over. This method can be overriden.
       def done!

data/lib/rley/ptree/parse_tree_node.rb

@@ -15,9 +15,9 @@ module Rley # This module is used as a namespace
         @symbol = aSymbol
         @range = Lexical::TokenRange.new(aRange)
       end
-      
+
       # Notify the builder that the construction is over
-      def done!()
+      def done!
         # Do nothing
       end
 
@@ -29,13 +29,13 @@ module Rley # This module is used as a namespace
       # Emit a (formatted) string representation of the node.
       # Mainly used for diagnosis/debugging purposes.
       def to_string(indentation)
-        return "#{symbol.name}#{range.to_string(indentation)}"
+        "#{symbol.name}#{range.to_string(indentation)}"
       end
 
       # Emit a short string representation of the node.
       # Mainly used for diagnosis/debugging purposes.
-      def to_s()
-        return "#{symbol.name}#{range.to_string(0)}"
+      def to_s
+        "#{symbol.name}#{range.to_string(0)}"
       end
     end # class
   end # module

data/lib/rley/ptree/terminal_node.rb

@@ -9,10 +9,10 @@ module Rley # This module is used as a namespace
       attr_reader(:token)
 
       # @param aToken [Lexical::Token] Input Token object
-      # @param aPos [Integer] position of the token in the input stream.      
+      # @param aPos [Integer] position of the token in the input stream.
       def initialize(aToken, aPos)
-        # (major, minor) =  
-        
+        # (major, minor) =
+
         # Use '1.class' trick to support both Integer and Fixnum classes
         range = aPos.kind_of?(1.class) ? { low: aPos, high: aPos + 1 } : aPos
         super(aToken.terminal, range)
@@ -24,18 +24,18 @@ module Rley # This module is used as a namespace
       def to_string(indentation)
         return super + ": '#{token.lexeme}'"
       end
-      
+
       # Emit a short string representation of the node.
       # Mainly used for diagnosis/debugging purposes.
-      def to_s()
+      def to_s
         return super + ": '#{token.lexeme}'"
-      end      
+      end
 
       # Part of the 'visitee' role in Visitor design pattern.
       # @param aVisitor[ParseTreeVisitor] the visitor
       def accept(aVisitor)
         aVisitor.visit_terminal(self)
-      end      
+      end
     end # class
   end # module
 end # module

data/lib/rley/rley_error.rb

@@ -1,12 +1,12 @@
-# frozen_string_literal: true
-
-# File: rley_error.rb
-
-module Rley # Module used as a namespace
-  # @abstract
-  # Base class for any exception explicitly raised by Rley code.
-  class RleyError < StandardError
-  end # class
-end # module
-
-# End of file
+# frozen_string_literal: true
+
+# File: rley_error.rb
+
+module Rley # Module used as a namespace
+  # @abstract
+  # Base class for any exception explicitly raised by Rley code.
+  class RleyError < StandardError
+  end # class
+end # module
+
+# End of file

data/lib/rley/sppf/alternative_node.rb

@@ -13,10 +13,10 @@ module Rley # This module is used as a namespace
       # @return [Syntax::NonTerminal] Link to lhs symbol
       attr_reader(:symbol)
 
-      # @param aVertex [GFG::ItemVertex] 
-      #   A GFG vertex that corresponds to a dotted item 
+      # @param aVertex [GFG::ItemVertex]
+      #   A GFG vertex that corresponds to a dotted item
       #   with the dot at the end) for the alternative under consideration.
-      # @param aRange [Lexical::TokenRange] 
+      # @param aRange [Lexical::TokenRange]
       #   A range of token indices corresponding to this node.
       def initialize(aVertex, aRange)
         super(aRange)
@@ -28,14 +28,14 @@ module Rley # This module is used as a namespace
       # Mainly used for diagnosis/debugging purposes.
       # @return [String]
       def to_string(indentation)
-        return "Alt(#{label})#{range.to_string(indentation)}"
+        "Alt(#{label})#{range.to_string(indentation)}"
       end
-      
+
       # Part of the 'visitee' role in Visitor design pattern.
       # @param aVisitor[ParseTreeVisitor] the visitor
       def accept(aVisitor)
         aVisitor.visit_alternative(self)
-      end      
+      end
     end # class
   end # module
 end # module

data/lib/rley/sppf/composite_node.rb

@@ -9,11 +9,11 @@ module Rley # This module is used as a namespace
     class CompositeNode < SPPFNode
       # @return [Array<SPFFNode>] Sub-nodes (children).
       attr_reader(:subnodes)
-      
-      alias children subnodes      
+
+      alias children subnodes
 
       # Constructor
-      # @param aRange [Lexical::TokenRange]      
+      # @param aRange [Lexical::TokenRange]
       def initialize(aRange)
         super(aRange)
         @subnodes = []
@@ -24,14 +24,14 @@ module Rley # This module is used as a namespace
       def add_subnode(aSubnode)
         subnodes.unshift(aSubnode)
       end
-      
+
       # @return [String] a text representation of the node.
-      def inspect()
+      def inspect
         key
-      end      
+      end
 
       # @return [String]
-      def key()
+      def key
         @key ||= to_string(0)
       end
     end # class

data/lib/rley/sppf/epsilon_node.rb

@@ -17,14 +17,14 @@ module Rley # This module is used as a namespace
       # Mainly used for diagnosis/debugging purposes.
       # @return [String]
       def to_string(indentation)
-        return "_#{range.to_string(indentation)}"
+        "_#{range.to_string(indentation)}"
       end
-      
+
       # Part of the 'visitee' role in Visitor design pattern.
       # @param aVisitor[ParseTreeVisitor] the visitor
       def accept(aVisitor)
         aVisitor.visit_epsilon(self)
-      end      
+      end
     end # class
   end # module
 end # module

data/lib/rley/sppf/leaf_node.rb

@@ -8,14 +8,14 @@ module Rley # This module is used as a namespace
     # child node.
     class LeafNode < SPPFNode
       # @return [String] a text representation of the node.
-      def inspect()
+      def inspect
         key
       end
 
       # @return [String]
-      def key()
+      def key
         @key ||= to_string(0)
-      end    
+      end
     end # class
   end # module
 end # module

data/lib/rley/sppf/parse_forest.rb

@@ -7,19 +7,19 @@ require_relative 'alternative_node'
 module Rley # This module is used as a namespace
   module SPPF # This module is used as a namespace
     # In an ambiguous grammar there are valid inputs that can result in multiple
-    # parse trees. A set of parse trees is commonly referred to as a parse 
-    # forest. More specifically a parse forest is a graph data 
+    # parse trees. A set of parse trees is commonly referred to as a parse
+    # forest. More specifically a parse forest is a graph data
     # structure designed to represent a set of equally syntactically correct
     # parse trees. Parse forests generated by Rley are so-called Shared Packed
-    # Parse Forests (SPPF). SPPFs allow very compact representation of parse 
+    # Parse Forests (SPPF). SPPFs allow very compact representation of parse
     # trees by sharing common sub-tree amongst the parse trees.
     class ParseForest
       # The root node of the forest
       attr_reader(:root)
-      
+
       # A Hash with pairs of the kind node key => node
       attr_reader(:key2node)
-      
+
       # A setter that tells that the parse is ambiguous.
       attr_writer(:is_ambiguous)
 
@@ -30,34 +30,34 @@ module Rley # This module is used as a namespace
         @key2node = {}
         @is_ambiguous = false
       end
-      
+
       # Notification that the SPPF construction is over
       def done!
         # Do nothing
       end
-      
+
       # Returns true if the given node is present in the forest.
       def include?(aNode)
-        return key2node.include?(aNode)
+        key2node.include?(aNode)
       end
-      
+
       # Returns true if the parse encountered a structural ambiguity
       # (i.e. more than one parse tree for the given input)
-      def ambiguous?()
-        return @is_ambiguous
+      def ambiguous?
+        @is_ambiguous
       end
-      
-      # Create an Enumerator that helps to iterate over the possible 
-      # parse trees. That enumerator will generate a parse tree when 
+
+      # Create an Enumerator that helps to iterate over the possible
+      # parse trees. That enumerator will generate a parse tree when
       # called with `next` method.
       # @return [Enumerator]
-      def to_ptree_enum()
+      def to_ptree_enum
         # How to implement?
         # One visits the forest => beware of dependency
         # At each visited item create a corresponding  tree node.
         # At end of visit & stack not empty
         # Re-generate another ptree
-      end      
+      end
 
       # Part of the 'visitee' role in the Visitor design pattern.
       #   A visitee is expected to accept the visit from a visitor object