rley 0.8.15 → 0.9.02

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e2ff00bd9b05a972b081dbcde3e9b6ff36f639fc9a9b2ae3bd22a494dd991d8
-  data.tar.gz: 17cc2cd1544312b3781a9015de83df250519f9dc39353d172cdcfa70597af181
+  metadata.gz: 1f4f4a6f94d92e3d014a12bf3f979d2be06139987df1754006992468f8968fb5
+  data.tar.gz: c2a708692519342e598b33acb39dfdc098209f2508255c90b355d832bf279d0a
 SHA512:
-  metadata.gz: 2f90be1939b2698dfb830b765e2857693b55b3626c610c220d2abb8beecf0e67e23c02ebb65da3dd57fbcb6e08e5170ac0847d8677b370bcdd9b119c3f59346a
-  data.tar.gz: 7c689384cc04ec1dd61b098a2280b8814611ba220ef7f745f55872b2e03ecdd7bc6f62de527a47a04e432ead8346a411c49995a429a5677320217abe7a30d1e4
+  metadata.gz: fcb1d7119d6475ddf9ad8c87d64ccb645e8fa80082b0dc004647141146db54d7ecba1d788280dc6ab3e62fdaf70cc814b4e6d67d365d0bddbdeaec0c11218510
+  data.tar.gz: a689799d6eeac5238c6baee2f4b6d0cad0b6f6e1c66e32e3e294279d5388f4c7774a603e2f55870f33d9b8cd513908c7ab810f312f70ce01c077d8c167391970

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+### 0.9.02 / 2025-03-18
+Version bumped.
+* [FIX] Change in previous version in method `ParseTreeBuilder#terminal_before_dot?` was code breaking.
+* [CHANGE] File `rley.gemspec`: made the external dependencies more lenient...
+
+
+### 0.9.01 / 2025-03-16
+Version bumped.
+* [CHANGED] Updated `.rbs` signature files.
+
+### 0.9.00 / 2025-03-08
+Version bumped.
+* [NEW] Added `sig` folder with `.rbs` signature files.
+- [FIX] Broken Cucumber test. Replaced reference to `GrammarBuilder` by `BaseGrammarBuilder`.
+- [FIX] File `rley.gemspec` now returns a GemSpecification as expected by Bundler.
+- [CHANGE] File `Gemfile` refers to gemspec
+
 ### 0.8.15 / 2025-02-28
 - [FIX] Re-styled spec files
 

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify the gem's dependencies in rley.gemspec
+gemspec

data/lib/rley/constants.rb

@@ -5,10 +5,10 @@
 
 module Rley # Module used as a namespace
   # The version number of the gem.
-  Version = '0.8.15'
+  Version = '0.9.02'
 
   # Brief description of the gem.
-  Description = "Ruby implementation of the Earley's parsing algorithm"
+  Description = "A parsing library based on the Earley's parsing algorithm."
 
   # Constant Rley::RootDir contains the absolute path of Rley's
   # start directory. Note: it also ends with a slash character.

data/lib/rley/engine.rb

@@ -19,6 +19,7 @@ module Rley # This module is used as a namespace
       # Constructor with default initialization.
       def initialize
         super()
+        # @type self: EngineConfig
         self.parse_repr = :parse_tree
         self.repr_builder = :default
         self.diagnose = false
@@ -80,7 +81,7 @@ module Rley # This module is used as a namespace
       aTokenizer.each do |a_token|
         next unless a_token
 
-        if a_token.terminal.kind_of?(String)
+        if a_token.terminal.is_a?(String)
           term_name = a_token.terminal
           term_symb = grammar.name2symbol[term_name]
           a_token.instance_variable_set(:@terminal, term_symb)
@@ -133,6 +134,7 @@ module Rley # This module is used as a namespace
         result = factory.create(configuration.repr_builder)
       end
 
+      # @type var result : Rley::SPPF::ParseForest
       result
     end
 

data/lib/rley/formatter/asciitree.rb

@@ -82,9 +82,10 @@ module Rley # This module is used as a namespace
       def rank_of(aChild)
         if curr_path.empty?
           rank = 'root'
-        elsif curr_path[-1].subnodes.size == 1
+        elsif curr_path[-1].subnodes.size == 1 # steep:ignore
           rank = 'first_and_last'
         else
+          # @type var parent : Rley::PTree::NonTerminalNode
           parent = curr_path[-1]
           siblings = parent.subnodes
           siblings_last_index = siblings.size - 1
@@ -96,6 +97,8 @@ module Rley # This module is used as a namespace
                  end
         end
         ranks << rank
+
+        rank
       end
 
       # 'root', 'first', 'first_and_last', 'last', 'other'

data/lib/rley/gfg/epsilon_edge.rb

@@ -9,8 +9,6 @@ module Rley # This module is used as a namespace
     # Responsibilities:
     # - To know the successor vertex
     class EpsilonEdge < Edge
-      # The destination vertex of the edge.
-      attr_reader :successor
     end # class
   end # module
 end # module

data/lib/rley/gfg/grm_flow_graph.rb

@@ -40,7 +40,7 @@ module Rley # This module is used as a namespace
       attr_reader :vertices
 
       # The vertex marked as start node of the graph
-      # @return [StartVertex>]
+      # @return [StartVertex]
       attr_reader :start_vertex
 
       # A Hash with pairs of the form: non-terminal symbol => start node
@@ -188,7 +188,7 @@ module Rley # This module is used as a namespace
       # For debugging purposes
       def print_vertex(aText, aVertex)
         print "#{aText} "
-        if aVertex.kind_of?(NonTerminalVertex)
+        if aVertex.is_a?(NonTerminalVertex)
           puts "#{aVertex.class} #{aVertex.non_terminal.name}"
         else
           p(aVertex.label)
@@ -222,7 +222,7 @@ module Rley # This module is used as a namespace
         productions.each do |prod|
           all_nterms << prod.lhs
           nterms_of_rhs = prod.rhs.members.select do |symb|
-            symb.kind_of?(Syntax::NonTerminal)
+            symb.is_a?(Syntax::NonTerminal)
           end
           all_nterms.merge(nterms_of_rhs)
         end
@@ -285,7 +285,7 @@ module Rley # This module is used as a namespace
             # At least one symbol before the dot
             # Retrieve the symbol before the dot...
             prev_symbol = current_item.prev_symbol
-            if prev_symbol.kind_of?(Syntax::Terminal)
+            if prev_symbol.is_a?(Syntax::Terminal)
               build_scan_edge(vertices[-2], new_vertex)
             else
               # ...non-terminal
@@ -294,7 +294,7 @@ module Rley # This module is used as a namespace
           end
 
           prev_symbol = current_item.prev_symbol
-          if prev_symbol&.kind_of?(Syntax::NonTerminal)
+          if prev_symbol&.is_a?(Syntax::NonTerminal)
             build_shortcut_edge(prev_vertex, new_vertex)
           end
           prev_vertex = new_vertex
@@ -355,8 +355,7 @@ module Rley # This module is used as a namespace
         end_vertex = end_vertex_for[aCallEdge.successor.non_terminal]
 
         # Retrieve the return edge with specified key
-        return_edge = end_vertex.edges.find { |edge| edge.key == ret_key }
-        return return_edge
+        end_vertex.edges.find { |edge| edge.key == ret_key }
       end
 
       # Mark non-terminal symbols that cannot be derived from the start symbol.
@@ -372,7 +371,7 @@ module Rley # This module is used as a namespace
         # and mark all visited non-terminals as reachable
         traverse_df(start_vertex) do |a_vertex|
           # print_vertex('  Visiting', a_vertex)
-          if a_vertex.kind_of?(StartVertex)
+          if a_vertex.is_a?(StartVertex)
             a_vertex.non_terminal.unreachable = false
           end
         end

data/lib/rley/gfg/item_vertex.rb

@@ -30,7 +30,7 @@ module Rley # This module is used as a namespace
       # Set the "shortcut" edge.
       # @param aShortcut [ShortcutEdge] the "shortcut" edge.
       def shortcut=(aShortcut)
-        unless aShortcut.kind_of?(ShortcutEdge)
+        unless aShortcut.is_a?(ShortcutEdge)
           raise StandardError, 'Invalid shortcut argument'
         end
 

data/lib/rley/gfg/vertex.rb

@@ -69,6 +69,17 @@ module Rley # This module is used as a namespace
         edges << arrow
       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
+        raise NotImplementedError
+      end
+
+      def dotted_item
+        raise NotImplementedError
+      end
+
       protected
 
       # Validation method for adding an outgoing edge to the vertex.

data/lib/rley/lexical/token.rb

@@ -5,13 +5,20 @@ module Rley # This module is used as a namespace
   # as return values from a tokenizer / lexer.
   module Lexical
     # A Position is the location of a lexeme within a source file.
-    Position = Struct.new(:line, :column) do
+    class Position
+      attr_reader :line
+      attr_reader :column
+
+      def initialize(aLine, aCol)
+        @line = aLine
+        @column = aCol
+      end
+
       def to_s
         "line #{line}, column #{column}"
       end
     end
 
-
     # In Rley, a (lexical) token is an object created by a lexer (tokenizer)
     # and passed to the parser. Such token an object is created when a lexer
     # detects that a sequence of characters(a lexeme) from the input stream
@@ -27,7 +34,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 [String] The name of terminal symbol matching the lexeme.
+      # @return [Syntax::Terminal] The name of terminal symbol matching the lexeme.
       attr_reader(:terminal)
 
       # @return [Position] The position -in "editor" coordinates- of the lexeme in the source file.

data/lib/rley/parse_forest_visitor.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-# require 'pry'
 require 'prime'
 
 module Rley # This module is used as a namespace
@@ -145,9 +144,10 @@ module Rley # This module is used as a namespace
       # Let's proceed with the visit of children
       children.each_with_index do |a_node, i|
         edge_sign = aParentNode.signatures[i]
-        if a_node.kind_of?(SPPF::CompositeNode)
+        if a_node.is_a?(SPPF::CompositeNode)
           push_node(a_node, edge_sign)
           access_paths = node_accesses[a_node]
+          # @type var last_path : Integer
           last_path = legs.last[-1]
           path_reused = access_paths.include?(last_path)
           unless path_reused
@@ -178,8 +178,8 @@ module Rley # This module is used as a namespace
       if legs.empty?
         legs << [aCompositeNode, anEdgeSignature]
       else
+        # @type var path_signature : Integer
         path_signature = legs.last[-1]
-        # binding.pry if anEdgeSignature == 37 && path_signature != 230
         if (path_signature % anEdgeSignature).zero?
           legs << [aCompositeNode, path_signature]
         else

data/lib/rley/parse_rep/ast_base_builder.rb

@@ -94,9 +94,10 @@ module Rley # This module is used as a namespace
         klass = terminal2node.fetch(aTerminal.name, terminalnode_class)
         if klass.is_a?(Hash)
           # Lexical ambiguity...
-          klass = klass.fetch(aProduction.name)
+          klass = klass.fetch(aProduction.name) # steep:ignore ArgumentTypeMismatch
         end
-        klass.new(aToken, aTokenPosition)
+
+        klass.new(aToken, aTokenPosition) # steep:ignore
       end
 
       # Method to override.
@@ -106,7 +107,7 @@ module Rley # This module is used as a namespace
       # @param theTokens [Array] The input tokens
       # @param theChildren [Array] Children nodes (one per rhs symbol)
       def new_parent_node(aProduction, aRange, theTokens, theChildren)
-        mth_name = method_name(aProduction.name)
+        mth_name = method_name(aProduction.name) # steep:ignore ArgumentTypeMismatch
         if respond_to?(mth_name, true)
           node = send(mth_name, aProduction, aRange, theTokens, theChildren)
         else
@@ -139,7 +140,7 @@ module Rley # This module is used as a namespace
       # Implicit rule generated for * modifier
       # rule('X') => 'X item'.as '_star_more'
       def reduce__star_more(_production, _range, _tokens, theChildren)
-        theChildren[0] << theChildren[1]
+        theChildren[0] << theChildren[1] # steep:ignore NoMethod
         theChildren[0]
       end
 
@@ -152,7 +153,7 @@ module Rley # This module is used as a namespace
       # Implicit rule generated for + modifier
       # rule('X') => 'X item'.as '_plus_more'
       def reduce__plus_more(_production, _range, _tokens, theChildren)
-        theChildren[0] << theChildren[1]
+        theChildren[0] << theChildren[1] # steep:ignore NoMethod
         theChildren[0]
       end
 

data/lib/rley/parse_rep/parse_forest_builder.rb

@@ -148,7 +148,7 @@ module Rley # This module is used as a namespace
                   # ... without changing current path
                   create_epsilon_node(anEntry, anIndex)
                 end
-                curr_path.pop if curr_parent.kind_of?(SPPF::AlternativeNode)
+                curr_path.pop if curr_parent.is_a?(SPPF::AlternativeNode)
             end
 
           when :backtrack
@@ -172,7 +172,7 @@ module Rley # This module is used as a namespace
                   # ... without changing current path
                   create_epsilon_node(anEntry, anIndex)
                 end
-                curr_path.pop if curr_parent.kind_of?(SPPF::AlternativeNode)
+                curr_path.pop if curr_parent.is_a?(SPPF::AlternativeNode)
             end
         end
       end
@@ -221,6 +221,8 @@ module Rley # This module is used as a namespace
 
       def create_epsilon_node(anEntry, anIndex)
         new_node = SPPF::EpsilonNode.new(anIndex)
+
+        # @type var candidate : SPPF::EpsilonNode
         candidate = add_node_to_forest(new_node)
         entry2node[anEntry] = candidate
 

data/lib/rley/parse_rep/parse_tree_builder.rb

@@ -19,6 +19,7 @@ module Rley # This module is used as a namespace
       # @param aSymbol [Syntax::Symbol] A symbol from grammar.
       def initialize(aRange, aSymbol)
         super
+        # @type self:CSTRawNode
         self.range = aRange
         self.symbol = aSymbol
         self.children = nil
@@ -77,7 +78,7 @@ module Rley # This module is used as a namespace
 
       protected
 
-      # Return the stack
+      # Return the stack of CSTRawNode
       attr_reader(:stack)
 
       # Overriding method.
@@ -180,6 +181,7 @@ module Rley # This module is used as a namespace
         # For debugging purposes
         raise StandardError if previous_tos.symbol != non_terminal
 
+        # @type var previous_tos : CSTRawNode
         new_node = new_parent_node(rule, previous_tos.range,
                                    tokens, previous_tos.children)
         if stack.empty?
@@ -207,7 +209,9 @@ module Rley # This module is used as a namespace
       # @param anEntry [ParseEntry] The entry being visited
       def terminal_before_dot?(anEntry)
         prev_symbol = anEntry.prev_symbol
-        prev_symbol&.terminal?
+
+        # @type var prev_symbol : Syntax::GrmSymbol
+        prev_symbol.nil? ? false : prev_symbol.terminal?
       end
 
       # A terminal symbol was detected at left of dot.
@@ -262,6 +266,14 @@ module Rley # This module is used as a namespace
 
         non_terminal
       end
+
+      def new_leaf_node(_aProduction, _aTerminal, _aTokenPosition, _aToken)
+        raise NotImplementedError
+      end
+
+      def new_parent_node(_aProduction, _aRange, _theTokens, _theChildren)
+        raise NotImplementedError
+      end
     end # class
   end # module
 end # module

data/lib/rley/parse_rep/parse_tree_factory.rb

@@ -15,7 +15,7 @@ module Rley # This module is used as a namespace
       # that will create piece by piece the forest
       def builder(aParseResult, aBuilder = nil)
         if aBuilder
-          aBuilder.new(aParseResult.tokens)
+          aBuilder.new(aParseResult.tokens) # steep:ignore UnexpectedPositionalArgument
         else
           CSTBuilder.new(aParseResult.tokens)
         end

data/lib/rley/parser/error_reason.rb

@@ -7,11 +7,11 @@ module Rley # Module used as a namespace
     # detected by Rley.
     class ErrorReason
       # @!attribute [r] rank
-      #   @return [Fixnum] The rank number of the offending input token
+      #   @return [Integer] The rank number of the offending input token
       attr_reader(:rank)
 
       # Constructor
-      # @param aRank [Fixnum] The sequence number of the offending input token.
+      # @param aRank [Integer] The sequence number of the offending input token.
       def initialize(aRank)
         @rank = aRank
       end

data/lib/rley/parser/gfg_chart.rb

@@ -98,7 +98,7 @@ module Rley # This module is used as a namespace
         new_entry = ParseEntry.new(aVertex, anOrigin)
         result = self[anIndex].push_entry(new_entry)
 
-        if aVertex.kind_of?(GFG::ItemVertex) && aVertex.dotted_item.constraint
+        if aVertex.is_a?(GFG::ItemVertex) && aVertex.dotted_item.constraint
           ct = aVertex.dotted_item.constraint
 
           case ct
@@ -198,8 +198,8 @@ module Rley # This module is used as a namespace
       private
 
       def add_entry_set
-         @sets << ParseEntrySet.new
          @constraints << []
+         @sets << ParseEntrySet.new
       end
 
       def update_match_closest(aConstraint, anIndex)

data/lib/rley/parser/gfg_earley_parser.rb

@@ -32,7 +32,7 @@ module Rley # This module is used as a namespace
 
         aTokenSequence.each_with_index do |token, i|
           parse_for_token(result, i)
-          if token.terminal.kind_of?(String)
+          if token.terminal.is_a?(String)
             symb = grammar.name2symbol[token.terminal]
             token.instance_variable_set(:@terminal, symb)
           end
@@ -51,7 +51,7 @@ module Rley # This module is used as a namespace
         result.chart[index].each do |entry|
           # Is entry of the form? [A => alpha . B beta, k]...
           next_symbol = entry.next_symbol
-          if next_symbol.kind_of?(Syntax::NonTerminal)
+          if next_symbol.is_a?(Syntax::NonTerminal)
             # ...apply the Call rule
             call_rule(result, entry, index)
           end

data/lib/rley/parser/gfg_parsing.rb

@@ -338,7 +338,7 @@ module Rley # This module is used as a namespace
         full_range = { low: 0, high: anIndex }
         start_production = chart.start_dotted_rule.production
 
-        ParseForestBuilder.new(start_production, full_range)
+        ParseRep::ParseForestBuilder.new(start_production, full_range)
       end
 
       # Factory method. Creates and initializes a ParseEntryTracker instance.

data/lib/rley/parser/parse_entry.rb

@@ -62,13 +62,13 @@ module Rley # This module is used as a namespace
 
       # Returns true iff the vertex is a start vertex (i.e. of the form: .X)
       def start_entry?
-        vertex.kind_of?(GFG::StartVertex)
+        vertex.is_a?(GFG::StartVertex)
       end
 
       # Returns true iff the vertex is at the start of rhs
       # (i.e. of the form: X => .Y
       def entry_entry?
-        return false unless vertex.kind_of?(GFG::ItemVertex)
+        return false unless vertex.is_a?(GFG::ItemVertex)
 
         vertex.dotted_item.at_start?
       end
@@ -76,7 +76,7 @@ module Rley # This module is used as a namespace
       # Returns true iff the vertex corresponds to a dotted item
       # X => Y
       def dotted_entry?
-        vertex.kind_of?(GFG::ItemVertex)
+        vertex.is_a?(GFG::ItemVertex)
       end
 
       # Returns true iff the vertex is at end of rhs (i.e. of the form: X => Y.)
@@ -86,7 +86,7 @@ module Rley # This module is used as a namespace
 
       # Returns true iff the vertex is an end vertex (i.e. of the form: X.)
       def end_entry?
-        vertex.kind_of?(GFG::EndVertex)
+        vertex.is_a?(GFG::EndVertex)
       end
 
       # Return the symbol before the dot (if any)

data/lib/rley/parser/parse_entry_set.rb

@@ -62,6 +62,7 @@ module Rley # This module is used as a namespace
       # @return [ParseEntry] the passed parse entry if it pushes it
       def push_entry(anEntry)
         entry_key = anEntry.hash
+        # @type var result : ParseEntry | false
         result = membership.fetch(entry_key, false)
         unless result
           @entries << anEntry
@@ -71,6 +72,7 @@ module Rley # This module is used as a namespace
           result = anEntry
         end
 
+        # @type var result : ParseEntry
         result
       end
 
@@ -111,9 +113,10 @@ module Rley # This module is used as a namespace
 
       def add_lookup4symbol(anEntry)
         symb = anEntry.next_symbol
-        if symb.kind_of?(Syntax::Terminal)
+        if symb.is_a?(Syntax::Terminal)
           @entries4term[symb] << anEntry
         else
+          # @type var symb : Syntax::NonTerminal
           @entries4n_term[symb] << anEntry
         end
       end

data/lib/rley/parser/parse_entry_tracker.rb

@@ -21,31 +21,34 @@ module Rley # This module is used as a namespace
 
       # Write accessor. Sets the value of the entry set index
       def entry_set_index=(anIndex)
-        @entry_set_index = anIndex
         @processed_entries = {}
+        @entry_set_index = anIndex
       end
 
       # Write accessor. Set the given parse entry as the current one.
       def parse_entry=(aParseEntry)
         raise StandardError, 'Nil parse entry' if aParseEntry.nil?
 
-        @parse_entry = aParseEntry
+        # @type var parse_entry : Rley::Parser::ParseEntry
         processed_entries[parse_entry] = true
+        @parse_entry = aParseEntry
       end
 
       # Take the first provided entry that wasn't processed yet.
-      def select_entry(theEntrys)
-        a_entry = theEntrys.find { |st| !processed_entries.include?(st) }
-        self.parse_entry = a_entry
+      def select_entry(entries)
+        a_entry = entries.find { |st| !processed_entries.include?(st) }
+        self.parse_entry = a_entry # steep:ignore
       end
 
       # The dotted item for the current parse entry.
+      # @return [Rley::Base::DottedItem, nil]
       def curr_dotted_item
-        parse_entry.dotted_rule
+        parse_entry&.vertex.dotted_item # steep:ignore
       end
 
+      # @return [Syntax::GrmSymbol, nil] Return the symbol before the dot
       def symbol_on_left
-        curr_dotted_item.prev_symbol
+        curr_dotted_item&.prev_symbol
       end
 
       # Notification that one begins with the previous entry set

data/lib/rley/parser/parse_walker_factory.rb

@@ -118,8 +118,9 @@ module Rley # This module is used as a namespace
       # rubocop: disable Lint/DuplicateBranch
       def visit_entry(anEntry, aContext)
         index = aContext.entry_set_index
-        aContext.nterm2start[[anEntry, index]] if anEntry.start_entry?
+        aContext.nterm2start[[anEntry, index]] if anEntry.start_entry? # steep:ignore
 
+        # @type var event : [Symbol, ParseEntry, Integer]
         if aContext.visitees.include?(anEntry) # Already visited?...
           case anEntry.vertex
             when GFG::EndVertex
@@ -155,8 +156,8 @@ module Rley # This module is used as a namespace
       end
       # rubocop: enable Lint/DuplicateBranch
 
-      def detect_scan_edge(_ctx)
-        nil unless aContext.curr_entry.dotted_entry?
+      def detect_scan_edge(ctx)
+        nil unless ctx.curr_entry.dotted_entry?
       end
 
       # Given the current entry from context object
@@ -178,22 +179,22 @@ module Rley # This module is used as a namespace
         new_entry = aContext.curr_entry.antecedents.first
         events = [new_entry]
         traversed_edge = new_entry.vertex.edges.first
-        if new_entry.vertex.kind_of?(GFG::EndVertex)
+        if new_entry.vertex.is_a?(GFG::EndVertex)
           # Return edge encountered
           # Push current entry onto stack
           # puts "Push on return stack #{aContext.curr_entry}"
           aContext.return_stack << aContext.curr_entry
-        elsif traversed_edge.kind_of?(GFG::CallEdge)
+        elsif traversed_edge.is_a?(GFG::CallEdge)
           # Pop top of stack
           err_msg = 'Return stack empty!'
           raise ScriptError, err_msg if aContext.return_stack.empty?
 
           aContext.return_stack.pop
           # puts "Pop from return stack matching entry #{new_entry}"
-        elsif traversed_edge.kind_of?(GFG::ScanEdge)
+        elsif traversed_edge.is_a?(GFG::ScanEdge)
           # Scan edge encountered, decrease sigma set index
           aContext.entry_set_index -= 1
-        elsif traversed_edge.kind_of?(GFG::EpsilonEdge)
+        elsif traversed_edge.is_a?(GFG::EpsilonEdge)
           # Do nothing
         else
           raise NotImplementedError, "edge is a #{traversed_edge.class}"
@@ -269,6 +270,7 @@ module Rley # This module is used as a namespace
         raise ScriptError, 'Empty return stack' if aContext.return_stack.empty?
 
         # Retrieve top of stack
+        # @type var tos : Rley::Parser::ParseEntry
         tos = aContext.return_stack.pop
         tos_dotted_item = tos.vertex.dotted_item
 

data/lib/rley/ptree/parse_tree_node.rb

@@ -37,6 +37,12 @@ module Rley # This module is used as a namespace
       def to_s
         "#{symbol.name}#{range.to_string(0)}"
       end
+
+      # Part of the 'visitee' role in Visitor design pattern.
+      # @param aVisitor[ParseTreeVisitor] the visitor
+      def accept(aVisitor)
+        raise NotImplementedError
+      end
     end # class
   end # module
 end # module

data/lib/rley/ptree/terminal_node.rb

@@ -14,7 +14,7 @@ module Rley # This module is used as a namespace
         # (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
+        range = aPos.is_a?(1.class) ? { low: aPos, high: aPos + 1 } : aPos
         super(aToken.terminal, range)
         @token = aToken
       end

data/lib/rley/rgn/ast_builder.rb

@@ -29,7 +29,7 @@ module Rley
       protected
 
       def terminal2node
-        Terminal2NodeClass
+        Terminal2NodeClass # steep:ignore UnknownConstant
       end
 
       # Method override
@@ -166,7 +166,7 @@ module Rley
       # rule('key_value' => 'KEY value')
       def reduce_raw_pair(_production, _range, _tokens, theChildren)
         key = theChildren[0].token.lexeme
-        value = if theChildren[1].kind_of?(Rley::PTree::TerminalNode)
+        value = if theChildren[1].is_a?(Rley::PTree::TerminalNode)
                   theChildren[1].token.lexeme
                 else
                   theChildren[1]

data/lib/rley/rgn/ast_node.rb

@@ -22,7 +22,7 @@ module Rley
       def annotation_to_text
         map_arr = []
         @annotation.each_pair do |key, val|
-          literal = val.kind_of?(String) ? "'#{val}'" : val
+          literal = val.is_a?(String) ? "'#{val}'" : val
           map_arr << "#{key}: #{literal}"
         end
 
@@ -34,6 +34,16 @@ module Rley
         # Default: do nothing ...
       end
 
+      # @nodoc
+      def name
+        raise NotImplementedError
+      end
+
+      # @nodoc
+      def to_text
+        raise NotImplementedError
+      end
+
       # Abstract method (must be overriden in subclasses).
       # Part of the 'visitee' role in Visitor design pattern.
       # @param _visitor [ASTVisitor] the visitor

data/lib/rley/rgn/ast_visitor.rb

@@ -75,7 +75,7 @@ module Rley
 
       # Visit event. The visitor is about to visit the subnodes of a non
       # terminal node.
-      # @param aParentNode [Ast::LocCompoundExpr] the parent node.
+      # @param aParentNode [CompositeNode] the parent node.
       def traverse_subnodes(aParentNode)
         subnodes = aParentNode.subnodes
         broadcast(:before_subnodes, aParentNode, subnodes)
@@ -88,7 +88,7 @@ module Rley
 
       # Visit event. The visitor is about to visit one given subnode of a non
       # terminal node.
-      # @param aParentNode [Ast::LocCompoundExpr] the parent node.
+      # @param aParentNode [CompositeNode] the parent node.
       # @param index [integer] index of child subnode
       def traverse_given_subnode(aParentNode, index)
         subnode = aParentNode.subnodes[index]

data/lib/rley/rgn/composite_node.rb

@@ -10,7 +10,7 @@ module Rley
       # @return [Array<ASTNode>]
       attr_reader :subnodes
 
-      # @return [Hash]
+      # @return [Array<Syntax::MatchClosest>]
       attr_accessor :constraints
 
       # @param children [Array<ASTNode>] sequence of children nodes

data/lib/rley/rgn/grammar_builder.rb

@@ -7,7 +7,7 @@ require_relative '../syntax/match_closest'
 module Rley # This module is used as a namespace
   # Namespace for classes that define RGN (Rley Grammar Notation)
   module RGN # This module is used as a namespace
-    # Structure used by Rley to generate implicdit production rules.
+    # Structure used by Rley to generate implicit production rules.
     RawRule = Struct.new(:lhs, :rhs, :tag, :simple, :constraints)
 
     # Builder GoF pattern. Builder builds a complex object
@@ -65,10 +65,10 @@ module Rley # This module is used as a namespace
       # Add the given marker symbol to the grammar of the language
       # @param aMarkerSymbol [String] A marker symbol
       # @return [void]
-      def add_marker(aMarkerSymbol)
-        new_symb = build_symbol(Syntax::Marker, aMarkerSymbol)
-        symbols[new_symb.name] = new_symb
-      end
+      # def add_marker(aMarkerSymbol)
+      #   new_symb = build_symbol(Syntax::Marker, aMarkerSymbol)
+      #   symbols[new_symb.name] = new_symb
+      # end
 
       # Add a production rule in the grammar given one
       # key-value pair of the form: String => String.
@@ -85,7 +85,7 @@ module Rley # This module is used as a namespace
       def add_production(aProductionRepr)
         aProductionRepr.each_pair do |(lhs_name, rhs_repr)|
           lhs = get_grm_symbol(lhs_name)
-          rhs = rhs_repr.kind_of?(Array) && rhs_repr.empty? ? '' : rhs_repr.strip
+          rhs = rhs_repr.is_a?(Array) && rhs_repr.empty? ? '' : rhs_repr.strip
           constraints = []
           if rhs.empty?
             rhs_members = []
@@ -96,7 +96,7 @@ module Rley # This module is used as a namespace
             visitor.subscribe(self)
             visitor.start
             root_node = ast.root
-            constraints = root_node.constraints unless root_node.kind_of?(SymbolNode)
+            constraints = root_node.constraints unless root_node.is_a?(SymbolNode)
 
             rhs_members = visitor2rhs.delete(visitor)
           end
@@ -120,12 +120,12 @@ module Rley # This module is used as a namespace
 
           # Check that each terminal appears at least in a rhs of a production
           all_terminals = symbols.values.select do |a_symb|
-            a_symb.kind_of?(Syntax::Terminal)
+            a_symb.is_a?(Syntax::Terminal)
           end
           in_use = Set.new
           productions.each do |prod|
             prod.rhs.members.each do |symb|
-              in_use << symb if symb.kind_of?(Syntax::Terminal)
+              in_use << symb if symb.is_a?(Syntax::Terminal)
             end
           end
 
@@ -293,7 +293,7 @@ module Rley # This module is used as a namespace
         aProductionRepr.each_pair do |(lhs_name, rhs_repr)|
           lhs = get_grm_symbol(lhs_name)
 
-          if rhs_repr.kind_of?(String)
+          if rhs_repr.is_a?(String)
             rhs = rhs_repr.strip.scan(/\S+/)
           else
             rhs = rhs_repr
@@ -338,7 +338,7 @@ module Rley # This module is used as a namespace
       # @param aSymbolArg [GrmSymbol-like or String]
       # @return [Array] list of grammar symbols
       def build_symbol(aClass, aSymbolArg)
-        if aSymbolArg.kind_of?(Syntax::GrmSymbol)
+        if aSymbolArg.is_a?(Syntax::GrmSymbol)
           aSymbolArg
         else
           aClass.new(aSymbolArg)
@@ -385,7 +385,7 @@ module Rley # This module is used as a namespace
       end
 
       def node_base_name(aNode)
-        if aNode.kind_of?(SymbolNode)
+        if aNode.is_a?(SymbolNode)
           aNode.name
         else
           sequence_name(aNode)

data/lib/rley/rgn/parser.rb

@@ -37,7 +37,7 @@ module Rley
 
       # Parse the given RGN snippet into a parse tree.
       # @param source [String] Snippet to parse
-      # @return [Rley::ParseTree] A parse tree equivalent to the RGN input.
+      # @return [Rley::PTree::ParseTree] A parse tree equivalent to the RGN input.
       def parse(source)
         lexer = Tokenizer.new(source)
         result = engine.parse(lexer.tokens)
@@ -49,7 +49,7 @@ module Rley
           raise SyntaxError, line1 + line2
         end
 
-        return engine.convert(result) # engine.to_ptree(result)
+        engine.convert(result) # engine.to_ptree(result)
       end
     end # class
   end # module

data/lib/rley/rley_error.rb

@@ -1,12 +1,8 @@
 # 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/composite_node.rb

@@ -34,6 +34,12 @@ module Rley # This module is used as a namespace
       def key
         @key ||= to_string(0)
       end
+
+      # Part of the 'visitee' role in Visitor design pattern.
+      # @param aVisitor[ParseTreeVisitor] the visitor
+      def accept(aVisitor)
+        raise NotImplementedError
+      end
     end # class
   end # module
 end # module

data/lib/rley/sppf/parse_forest.rb

@@ -51,13 +51,13 @@ module Rley # This module is used as a namespace
       # parse trees. That enumerator will generate a parse tree when
       # called with `next` method.
       # @return [Enumerator]
-      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
+      # 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
 
       # Part of the 'visitee' role in the Visitor design pattern.
       #   A visitee is expected to accept the visit from a visitor object

data/lib/rley/sppf/sppf_node.rb

@@ -20,9 +20,23 @@ module Rley # This module is used as a namespace
       # Return the origin, that is, the index of the
       # first token matched by this node.
       # @return [Integer]
-      def origin
+      def origin # steep:ignore MethodBodyTypeMismatch
         range.low
       end
+
+      # Emit a (formatted) string representation of the node.
+      # Mainly used for diagnosis/debugging purposes.
+      # @param indentation [Integer]
+      # @return [String]
+      def to_string(indentation)
+        raise NotImplementedError
+      end
+
+      # Part of the 'visitee' role in Visitor design pattern.
+      # @param aVisitor[ParseForestVisitor] the visitor
+      def accept(aVisitor)
+        raise NotImplementedError
+      end
     end # class
   end # module
 end # module

data/lib/rley/syntax/base_grammar_builder.rb

@@ -53,14 +53,6 @@ module Rley # This module is used as a namespace
         symbols.merge!(new_symbs)
       end
 
-      # Add the given marker symbol to the grammar of the language
-      # @param aMarkerSymbol [Syntax::Marker] A mazker symbol
-      # @return [void]
-      def add_marker(aMarkerSymbol)
-        new_symb = build_symbol(Marker, aMarkerSymbol)
-        symbols[aMarkerSymbol.name] = new_symb
-      end
-
       # Add a production rule in the grammar given one
       # key-value pair of the form: String => Array.
       #   Where the key is the name of the non-terminal appearing in the
@@ -106,12 +98,12 @@ module Rley # This module is used as a namespace
 
           # Check that each terminal appears at least in a rhs of a production
           all_terminals = symbols.values.select do |a_symb|
-            a_symb.kind_of?(Terminal)
+            a_symb.is_a?(Terminal)
           end
           in_use = Set.new
           productions.each do |prod|
             prod.rhs.members.each do |symb|
-              in_use << symb if symb.kind_of?(Syntax::Terminal)
+              in_use << symb if symb.is_a?(Syntax::Terminal)
             end
           end
 
@@ -168,7 +160,7 @@ module Rley # This module is used as a namespace
       # @param aSymbolArg [GrmSymbol-like or String]
       # @return [Array] list of grammar symbols
       def build_symbol(aClass, aSymbolArg)
-        if aSymbolArg.kind_of?(GrmSymbol)
+        if aSymbolArg.is_a?(GrmSymbol)
           aSymbolArg
         else
           aClass.new(aSymbolArg)

data/lib/rley/syntax/grammar.rb

@@ -48,7 +48,7 @@ module Rley # This module is used as a namespace
 
       # @return [Array] The list of non-terminals in the grammar.
       def non_terminals
-        @non_terminals ||= symbols.select { |s| s.kind_of?(NonTerminal) }
+        @non_terminals ||= symbols.select { |s| s.is_a?(NonTerminal) }
       end
 
       # @return [Production] The start production of the grammar (i.e.
@@ -73,6 +73,7 @@ module Rley # This module is used as a namespace
         add_symbol(the_lhs)
 
         aProduction.rhs.each { |symb| add_symbol(symb) }
+        aProduction
       end
 
       # If the production is anonymous, then assign it
@@ -81,12 +82,15 @@ module Rley # This module is used as a namespace
         return unless aProduction.name.nil?
 
         index = rules.find_index(aProduction)
+        # @type var index : Integer
+
         prefix = aProduction.lhs.name.dup
         previous = index.zero? ? nil : rules[index - 1]
         if previous.nil? || previous.lhs != aProduction.lhs
           suffix = '_0'
         else
-          prev_serial = previous.name.match(/_(\d+)$/)
+          # @type var previous : Production
+          prev_serial = previous.name&.match(/_(\d+)$/)
           if prev_serial
             suffix = "_#{prev_serial[1].to_i + 1}"
           else
@@ -144,6 +148,8 @@ module Rley # This module is used as a namespace
             end
 
             last_considered = nil
+            # @type var last_considered : Rley::Syntax::GrmSymbol
+
             a_rule.rhs.members.each do |symbol|
               last_considered = symbol
               break unless symbol.generative?
@@ -199,7 +205,7 @@ module Rley # This module is used as a namespace
         # Drop productions with one terminal in rhs or with a nullable lhs
         filtered_rules = rules.reject do |prod|
           prod.lhs.nullable? || prod.rhs.find do |symb|
-            symb.kind_of?(Terminal)
+            symb.is_a?(Terminal)
           end
         end
 

data/lib/rley/syntax/production.rb

@@ -92,7 +92,7 @@ module Rley # This module is used as a namespace
       # Validation method. Return the validated input argument or
       # raise an exception.
       def valid_lhs(aNonTerminal)
-        unless aNonTerminal.kind_of?(NonTerminal)
+        unless aNonTerminal.is_a?(NonTerminal)
           msg_prefix = 'Left side of production must be a non-terminal symbol'
           msg_suffix = ", found a #{aNonTerminal.class} instead."
           raise StandardError, msg_prefix + msg_suffix

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rley
 version: !ruby/object:Gem::Version
-  version: 0.8.15
+  version: 0.9.02
 platform: ruby
 authors:
 - Dimitri Geshef
 bindir: bin
 cert_chain: []
-date: 2025-02-28 00:00:00.000000000 Z
+date: 2025-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prime
@@ -29,47 +29,47 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.1.0
+        version: '13'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 13.1.0
+        version: 13.0.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.1.0
+        version: '13'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 13.1.0
+        version: 13.0.6
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.12.0
+        version: '3.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.12.0
+        version: '3.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.12.0
+        version: '3.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.12.0
+        version: '3.12'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.34
+        version: '0.9'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.34
@@ -79,7 +79,7 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.34
+        version: '0.9'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.34
@@ -95,6 +95,7 @@ files:
 - ".ruby-gemset"
 - ".yardopts"
 - CHANGELOG.md
+- Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -316,9 +317,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.6
 specification_version: 4
-summary: Ruby implementation of the Earley's parsing algorithm
+summary: A parsing library based on the Earley's parsing algorithm.
 test_files:
 - spec/rley/base/dotted_item_spec.rb
 - spec/rley/base/grm_items_builder_spec.rb