rley 0.7.03 → 0.7.08

data/lib/rley/gfg/vertex.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rley # This module is used as a namespace
   module GFG # This module is used as a namespace
     # Abstract class. Represents a vertex in a grammar flow graph
@@ -8,60 +10,65 @@ module Rley # This module is used as a namespace
       # The edges linking the successor vertices to this one.
       # @return [Array<Edge>] The edge(s) linking this vertex to successor(s)
       attr_reader :edges
-      
+
+      # Return the object id in string format
+      # @return [String]
+      attr_reader :oid_str
+
       # Constructor to extend in subclasses.
-      def initialize()
+      def initialize
         @edges = []
+        @oid_str = object_id.to_s
       end
-      
-      # Add an graph edge to this vertex.
-      # @param anEdge [Edge] the edge to be added.
-      def add_edge(anEdge)
-        arrow = check_add_edge(anEdge)
-        edges << arrow
-      end
-      
-      # Determine if the vertex corresponds to an dotted item that has 
+
+      # Determine if the vertex corresponds to an dotted item that has
       # its dot at the end of a production (i.e. is a reduced item).
       # @return [Boolean] true iff vertex corresponds to reduced item.
-      def complete?()
-        return false # Default implementation
+      def complete?
+        false # Default implementation
       end
-      
-      # Returns a string containing a human-readable representation of the 
+
+      # Returns a string containing a human-readable representation of the
       # vertex.
       # @return [String]
-      def inspect()
-        result = '#<'
+      def inspect
+        result = +'#<'
         result << selfie
         edges.each { |e| result << e.inspect }
         result << specific_inspect
         result << '>'
-        
-        return result
+
+        result
       end
-      
-      # Returns a string containing a human-readable representation of the 
+
+      # Returns a string containing a human-readable representation of the
       # vertex without the edges.
-      # @return [String]      
-      def selfie()
-        result = "#{self.class.name}:#{object_id}"
+      # @return [String]
+      def selfie
+        result = +"#{self.class.name}:#{object_id}"
         result << %( label="#{label}")
-        return result
+        result
       end
-      
+
       # Retrieve the grammar symbol before the dot.
       # @return [GrmSymbol, NilClass] The symbol or otherwise nil.
-      def prev_symbol()
-        return nil # Default implementation
-      end      
-      
+      def prev_symbol
+        nil # Default implementation
+      end
+
       # Retrieve the grammar symbol after the dot.
-      # @return [GrmSymbol, NilClass] The symbol or otherwise nil. 
-      def next_symbol()
-        return nil # Default implementation
+      # @return [GrmSymbol, NilClass] The symbol or otherwise nil.
+      def next_symbol
+        nil # Default implementation
       end
-      
+
+      # Add an graph edge to this vertex.
+      # @param anEdge [Edge] the edge to be added.
+      def add_edge(anEdge)
+        arrow = check_add_edge(anEdge)
+        edges << arrow
+      end
+
       protected
 
       # Validation method for adding an outgoing edge to the vertex.
@@ -69,14 +76,13 @@ module Rley # This module is used as a namespace
       # unless this method is overridden in subclasses
       def check_add_edge(anEdge)
         raise StandardError, 'At most one edge accepted' unless edges.empty?
-        
-        return anEdge
+
+        anEdge
+      end
+
+      def specific_inspect
+        ''
       end
-      
-      def specific_inspect()
-        return ''
-      end      
-      
     end # class
   end # module
 end # module

data/lib/rley/lexical/token.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rley # This module is used as a namespace
   module Lexical # This module is used as a namespace
     # A Position is the location of a lexeme within a source file.
@@ -23,7 +25,7 @@ module Rley # This module is used as a namespace
       # @return [String] Input substring that is an instance of the terminal.
       attr_reader(:lexeme)
 
-      # @return [Syntax::Terminal] Terminal symbol corresponding to the lexeme.
+      # @return [String] The name of terminal symbol matching the lexeme.
       attr_reader(:terminal)
 
       # @return [Position] The position of the lexeme in the source file.

data/lib/rley/lexical/token_range.rb

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 module Rley # This module is used as a namespace
   module Lexical # This module is used as a namespace
-    # A token range (also called an extent) represents an interval 
+    # A token range (also called an extent) represents an interval
     # of token positions that is matched by a given grammar symbol.
     # For instance consider the expression E: 3 + 11,
     # let's assume that the integer literal '3' is the fifth input token and
     # that the '+' and '11' tokens are respectively at position 6 and 7;
     # then the token range associated with E is [5, 7]
-    # While the parse tree/forest is being constructed the boundaries of the 
+    # While the parse tree/forest is being constructed the boundaries of the
     # token range can be temporarily undefined (= set to nil)
     class TokenRange
       # The index of the lower bound of token range
@@ -45,8 +47,8 @@ module Rley # This module is used as a namespace
       end
 
       # true when both bounds aren't nil.
-      def bounded?()
-        return !(low.nil? || high.nil?)
+      def bounded?
+        !(low.nil? || high.nil?)
       end
 
       # Conditional assign
@@ -71,8 +73,8 @@ module Rley # This module is used as a namespace
       def to_string(_indentation)
         low_text = low.nil? ? '?' : low.to_s
         high_text = high.nil? ? '?' : high.to_s
-        
-        return "[#{low_text}, #{high_text}]"
+
+        "[#{low_text}, #{high_text}]"
       end
 
       private

data/lib/rley/parse_forest_visitor.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # require 'pry'
 require 'prime'
 
@@ -13,8 +15,8 @@ module Rley # This module is used as a namespace
         @signatures = subnodes.map { |_| prime_enumerator.next }
       end
 
-      def signature_exist?()
-        @signatures.nil? ? false : true
+      def signature_exist?
+        !@signatures.nil?
       end
     end # class
   end # module
@@ -67,7 +69,7 @@ module Rley # This module is used as a namespace
     end
 
     # The signal to begin the visit of the parse forest.
-    def start()
+    def start
       pforest.accept(self)
     end
 
@@ -167,7 +169,7 @@ module Rley # This module is used as a namespace
     def broadcast(msg, *args)
       subscribers.each do |subscr|
         next unless subscr.respond_to?(msg) || subscr.respond_to?(:accept_all)
-        
+
         subscr.send(msg, *args)
       end
     end
@@ -188,7 +190,7 @@ module Rley # This module is used as a namespace
 
     def pop_node
       return if legs.empty?
-      
+
       legs.pop
     end
   end # class

data/lib/rley/parse_rep/ast_base_builder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../ptree/parse_tree'
 require_relative 'parse_tree_builder'
 
@@ -18,14 +20,14 @@ module Rley # This module is used as a namespace
       #   Returned hash contains pairs of the form:
       #   terminal name => Class implementing the terminal tokens
       #   terminal name => Hash with pairs: production name => Class
-      def terminal2node()
+      def terminal2node
         raise NotImplementedError
       end
 
       # Method to override in subclass.
       # Default class for representing terminal nodes.
       # @return [Class]
-      def terminalnode_class()
+      def terminalnode_class
         PTree::TerminalNode
       end
 
@@ -35,7 +37,7 @@ module Rley # This module is used as a namespace
       # @param aProductionName [String]
       # @return [String]
       def method_name(aProductionName)
-        return 'reduce_' + aProductionName
+        "reduce_#{aProductionName}"
       end
 
       # Utility method.
@@ -44,7 +46,7 @@ module Rley # This module is used as a namespace
       # @param _tokens [Array<Lexical::Token>]
       # @param theChildren [Array<Object>]
       def return_first_child(_range, _tokens, theChildren)
-        return theChildren[0]
+        theChildren[0]
       end
 
       # Utility method.
@@ -53,7 +55,7 @@ module Rley # This module is used as a namespace
       # @param _tokens [Array<Lexical::Token>]
       # @param theChildren [Array<Object>]
       def return_second_child(_range, _tokens, theChildren)
-        return theChildren[1]
+        theChildren[1]
       end
 
       # Utility method.
@@ -62,7 +64,7 @@ module Rley # This module is used as a namespace
       # @param _tokens [Array<Lexical::Token>]
       # @param theChildren [Array<Object>]
       def return_last_child(_range, _tokens, theChildren)
-        return theChildren[-1]
+        theChildren[-1]
       end
 
       # Simply return an epsilon symbol
@@ -70,7 +72,7 @@ module Rley # This module is used as a namespace
       # @param _tokens [Array<Lexical::Token>]
       # @param _children [Array<Object>]
       def return_epsilon(_range, _tokens, _children)
-        return nil
+        nil
       end
 
       protected
@@ -79,7 +81,7 @@ module Rley # This module is used as a namespace
       # Create a parse tree object with given
       # node as root node.
       def create_tree(aRootNode)
-        return Rley::PTree::ParseTree.new(aRootNode)
+        Rley::PTree::ParseTree.new(aRootNode)
       end
 
       # Factory method for creating a node object for the given
@@ -94,9 +96,7 @@ module Rley # This module is used as a namespace
           # Lexical ambiguity...
           klass = klass.fetch(aProduction.name)
         end
-        node = klass.new(aToken, aTokenPosition)
-
-        return node
+        klass.new(aToken, aTokenPosition)
       end
 
       # Method to override.

data/lib/rley/parse_rep/cst_builder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'parse_tree_builder'
 require_relative '../ptree/non_terminal_node'
 require_relative '../ptree/terminal_node'
@@ -14,13 +16,13 @@ module Rley # This module is used as a namespace
     # nodes) and using a step by step approach.
     class CSTBuilder < ParseTreeBuilder
       protected
-      
+
       # Method to override
       # Create a parse tree object with given
       # node as root node.
       def create_tree(aRootNode)
         return Rley::PTree::ParseTree.new(aRootNode)
-      end      
+      end
 
       # Method to override
       # Factory method for creating a node object for the given
@@ -40,8 +42,9 @@ module Rley # This module is used as a namespace
       # @param theChildren [Array] Children nodes (one per rhs symbol)
       def new_parent_node(aProduction, aRange, _tokens, theChildren)
         node = Rley::PTree::NonTerminalNode.new(aProduction.lhs, aRange)
-        theChildren.reverse_each { |child| node.add_subnode(child) }
-        return node
+        theChildren&.reverse_each { |child| node.add_subnode(child) }
+
+        node
       end
     end # class
   end # module

data/lib/rley/parse_rep/parse_forest_builder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../syntax/terminal'
 require_relative '../syntax/non_terminal'
 require_relative '../gfg/end_vertex'
@@ -40,9 +42,9 @@ module Rley # This module is used as a namespace
         @entry2node = {}
         @entry2path_to_alt = {}
       end
-      
+
       # Notify the builder that the construction is over
-      def done!()
+      def done!
         result.done!
       end
 
@@ -62,20 +64,21 @@ module Rley # This module is used as a namespace
       end
 
       # Return the current_parent node
-      def curr_parent()
-        return curr_path.last
+      def curr_parent
+        curr_path.last
       end
 
       private
 
       def process_start_entry(_anEvent, _anEntry, _anIndex)
         curr_path.pop
+        raise StandardError, "path is nil for #{anEntry}" if curr_path.nil?
       end
 
       def process_end_entry(anEvent, anEntry, anIndex)
         case anEvent
           when :visit
-            # create a node with the non-terminal
+            # create a forest node with the non-terminal
             #   with same right extent as curr_entry_set_index
             # add the new node as first child of current_parent
             # append the new node to the curr_path
@@ -87,16 +90,18 @@ module Rley # This module is used as a namespace
           when :backtrack
             # Restore path
             @curr_path = entry2path_to_alt[anEntry].dup
+            raise StandardError, "path is nil for #{anEntry}" if curr_path.nil?
 
           when :revisit
-            # Retrieve the already existing node corresponding
+            # Retrieve the already existing forest node corresponding
             # to re-visited entry
             popular = @entry2node[anEntry]
 
             # Share with parent (if needed)...
-            children = curr_parent.subnodes
-            curr_parent.add_subnode(popular) unless children.include? popular
-
+            if curr_parent
+              children = curr_parent.subnodes
+              curr_parent.add_subnode(popular) unless children.include? popular
+            end
           else
             raise NotImplementedError
         end
@@ -105,18 +110,18 @@ module Rley # This module is used as a namespace
       def process_item_entry(anEvent, anEntry, anIndex)
         case anEvent
           when :visit
-            if anEntry.exit_entry?
+            if anEntry.exit_entry? && last_visitee.end_entry? &&
+               last_visitee.antecedents.size > 1
               # Previous entry was an end entry (X. pattern)
               # Does the previous entry have multiple antecedent?
-              if last_visitee.end_entry? && last_visitee.antecedents.size > 1
-                # Store current path for later backtracking
-                # puts "Store backtrack context #{last_visitee}"
-                # puts "path [#{curr_path.map{|e|e.to_string(0)}.join(', ')}]"
-                entry2path_to_alt[last_visitee] = curr_path.dup
-                curr_parent.refinement = :or
-
-                create_alternative_node(anEntry)
-              end
+
+              # Store current path for later backtracking
+              # puts "Store backtrack context #{last_visitee}"
+              # puts "path [#{curr_path.map{|e|e.to_string(0)}.join(', ')}]"
+              entry2path_to_alt[last_visitee] = curr_path.dup
+              curr_parent.refinement = :or
+
+              create_alternative_node(anEntry)
             end
 
             # Does this entry have multiple antecedent?
@@ -149,6 +154,8 @@ module Rley # This module is used as a namespace
           when :backtrack
             # Restore path
             @curr_path = entry2path_to_alt[anEntry].dup
+            raise StandardError, 'path is nil' if curr_path.nil?
+
             create_alternative_node(anEntry)
 
           when :revisit
@@ -172,7 +179,7 @@ module Rley # This module is used as a namespace
 
       # Create an empty parse forest
       def create_forest(aRootNode)
-        return Rley::SPPF::ParseForest.new(aRootNode)
+        Rley::SPPF::ParseForest.new(aRootNode)
       end
 
       # Factory method. Build and return an SPPF non-terminal node.
@@ -183,7 +190,7 @@ module Rley # This module is used as a namespace
         add_subnode(new_node)
         # puts "FOREST ADD #{curr_parent.key if curr_parent}/#{new_node.key}"
 
-        return new_node
+        new_node
       end
 
       # Add an alternative node to the forest
@@ -195,7 +202,7 @@ module Rley # This module is used as a namespace
         result.is_ambiguous = true
         # puts "FOREST ADD #{alternative.key}"
 
-        return alternative
+        alternative
       end
 
       # create a token node,
@@ -209,7 +216,7 @@ module Rley # This module is used as a namespace
         candidate = add_node_to_forest(new_node)
         entry2node[anEntry] = candidate
 
-        return candidate
+        candidate
       end
 
       def create_epsilon_node(anEntry, anIndex)
@@ -217,7 +224,7 @@ module Rley # This module is used as a namespace
         candidate = add_node_to_forest(new_node)
         entry2node[anEntry] = candidate
 
-        return candidate
+        candidate
       end
 
       # Add the given node if not yet present in parse forest
@@ -232,15 +239,19 @@ module Rley # This module is used as a namespace
         end
         add_subnode(new_node, false)
 
-        return new_node
+        new_node
       end
 
       # Add the given node as sub-node of current parent node
       # Optionally add the node to the current path
+      # rubocop: disable Style/OptionalBooleanParameter
       def add_subnode(aNode, addToPath = true)
+        raise StandardError, 'node is nil' if aNode.nil?
+
         curr_parent.add_subnode(aNode) unless curr_path.empty?
         curr_path << aNode if addToPath
       end
+      # rubocop: enable Style/OptionalBooleanParameter
     end # class
   end # module
 end # module