rley 0.7.03 → 0.7.08

data/lib/rley/formatter/json.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'base_formatter'
 
 
@@ -92,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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'edge'
 
 module Rley # This module is used as a namespace
@@ -14,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

@@ -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 an edge in a grammar flow graph.
@@ -12,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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'non_terminal_vertex'
 
 module Rley # This module is used as a namespace
@@ -8,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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'edge'
 
 module Rley # This module is used as a namespace
@@ -7,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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'set'
 require_relative 'start_vertex'
 require_relative 'end_vertex'
@@ -11,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.
@@ -58,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()
-        result = "#<#{self.class.name}:#{object_id}"
+      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.
@@ -90,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
 
@@ -119,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 = []
@@ -127,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
@@ -153,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
@@ -171,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
 
@@ -181,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)
@@ -198,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?
@@ -266,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
@@ -290,12 +295,13 @@ module Rley # This module is used as a namespace
           end
 
           prev_symbol = current_item.prev_symbol
-          if prev_symbol && prev_symbol.kind_of?(Syntax::NonTerminal)
+          if prev_symbol&.kind_of?(Syntax::NonTerminal)
             build_shortcut_edge(prev_vertex, new_vertex)
           end
           prev_vertex = new_vertex
         end
       end
+      # rubocop: enable Lint/RedundantSafeNavigation
 
       # Create an entry edge for the given vertex
       def build_entry_edge(theVertex)
@@ -357,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

data/lib/rley/gfg/item_vertex.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../syntax/non_terminal'
 require_relative 'vertex'
 
@@ -30,53 +32,41 @@ module Rley # This module is used as a namespace
       def shortcut=(aShortcut)
         unless aShortcut.kind_of?(ShortcutEdge)
           raise StandardError, 'Invalid shortcut argument'
-
-        end
-        
-=begin
-        unless next_symbol && next_symbol.kind_of?(Syntax::NonTerminal)
-          raise StandardError, 'Invalid shortcut usage'
         end
 
-        shortcut_d_item = aShortcut.successor.dotted_item
-        unless (dotted_item.production == shortcut_d_item.production) &&
-          (dotted_item.position == shortcut_d_item.prev_position)
-          raise StandardError, 'Shortcut refers to wrong vertex'
-        end
-=end
         @shortcut = aShortcut
       end
 
       # The label of this vertex.
       # It is the same as the label of the corresponding dotted item.
       # @return [String] Label for this vertex
-      def label()
-        return dotted_item.to_s
+      def label
+        dotted_item.to_s
       end
 
       # Returns true if the dotted item has a dot at the end of the production.
       # @return [Boolean]
-      def complete?()
-        return dotted_item.reduce_item?
+      def complete?
+        dotted_item.reduce_item?
       end
 
       # Return the symbol before the dot.
       # @return [Syntax::GrmSymbol, NilClass] Previous symbol otherwise nil.
-      def prev_symbol()
-        return dotted_item.prev_symbol
+      def prev_symbol
+        dotted_item.prev_symbol
       end
 
       # Return the symbol after the dot.
       # @return [Syntax::GrmSymbol, NilClass] Next grammar symbol otherwise nil.
-      def next_symbol()
-        return dotted_item.next_symbol
+      def next_symbol
+        @next_symbol ||= dotted_item.next_symbol
       end
 
       # Return the non-terminal symbol at the left-hand side of the production
       # @return [Syntax::GrmSymbol]
       #   The non-terminal symbol at left side of production.
-      def lhs()
-        return dotted_item.lhs
+      def lhs
+        dotted_item.lhs
       end
     end # class
   end # module

data/lib/rley/gfg/non_terminal_vertex.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 require_relative 'vertex'
 
 module Rley # This module is used as a namespace
   module GFG # This module is used as a namespace
     # Abstract class.
-    # Represents a specialized vertex in a grammar flow graph 
+    # Represents a specialized vertex in a grammar flow graph
     # that is associated to a given non-terminal symbol and
     # that may have in-degree or out-degree > 1
     # Responsibilities (in addition to inherited ones):
@@ -12,20 +14,20 @@ module Rley # This module is used as a namespace
       # The non-terminal symbol associated to the vertex
       # @return [Syntax::NonTerminal]
       attr_reader :non_terminal
-      
+
       # Constructor to specialize in subclasses.
       # @param aNonTerminal [Syntax::NonTerminal]
       def initialize(aNonTerminal)
         super()
         @non_terminal = aNonTerminal
       end
-      
+
       protected
 
       # Validation method for adding an outgoing edge to the vertex.
       # A start vertex may accept an indegree and outdegree greater than one
       def check_add_edge(anEdge)
-        return anEdge
+        anEdge
       end
     end # class
   end # module

data/lib/rley/gfg/return_edge.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'edge'
 
 module Rley # This module is used as a namespace

data/lib/rley/gfg/scan_edge.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'edge'
 
 module Rley # This module is used as a namespace
@@ -15,7 +17,7 @@ module Rley # This module is used as a namespace
         @terminal = aTerminal
       end
 
-      def to_s()
+      def to_s
         " -#{terminal}-> #{successor.label}"
       end
     end # class

data/lib/rley/gfg/shortcut_edge.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'edge'
 
 module Rley # This module is used as a namespace
@@ -10,12 +12,12 @@ module Rley # This module is used as a namespace
       attr_reader :nonterminal
 
       def initialize(thePredecessor, theSuccessor)
-        @successor = theSuccessor
+        super(nil, theSuccessor)
         @nonterminal = thePredecessor.next_symbol
         thePredecessor.shortcut = self
       end
 
-      def to_s()
+      def to_s
         " -#{nonterminal}-> #{successor.label}"
       end
     end # class

data/lib/rley/gfg/start_vertex.rb

@@ -1,21 +1,19 @@
+# frozen_string_literal: true
+
 require_relative 'non_terminal_vertex'
 
 module Rley # This module is used as a namespace
   module GFG # This module is used as a namespace
     # TODO: change definition.
-    # Represents a specialized vertex in a grammar flow graph 
+    # Represents a specialized vertex in a grammar flow graph
     # that is associated to a given non-terminal symbol.
     # Responsibilities (in addition to inherited ones):
     # - Know its related non-terminal symbol
     class StartVertex < NonTerminalVertex
-      def initialize(aNonTerminal)
-        super(aNonTerminal)
-      end
-
       # @return [String]
-      def label()
-        return ".#{non_terminal}"
-      end       
+      def label
+        ".#{non_terminal}"
+      end
     end # class
   end # module
 end # module