dendroid 0.2.02 → 0.2.04

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb58d7b275f7eb65ccfef37ee213fc53319c5634cf8dbd79020451c79769a3c3
-  data.tar.gz: f075b751545df13bda67d3e2df1c3861dfdaffa8fc416a7a735d0c4fc2da01bb
+  metadata.gz: 27c301e0fa5d044507f9b3b670305852444b9dcd31592fa862fed32df0d1a46a
+  data.tar.gz: abd3263f035f72641bbf4f9a1219eb160be179d593487c3a4afd9a8889e479d6
 SHA512:
-  metadata.gz: 1f3598bbc4f19ff183e655a92ca86908615a10b2f142982c09eb11b01b9fd05296db1ce5b9fa14be9d5f71c8358fd60535a0eb8b0feea8fcddafae5100fe8df4
-  data.tar.gz: c3227a5e8cb2675d2de6d011091e3b665e0217e62401619db36e43967a9d407c06a50205031c03dacc43f72b01cd1b0ebf66132240194d61de1ae1e167594113
+  metadata.gz: 011f8688d569b73abacfd4a75c4b6dea7f1524701e4af98fad7ebd426bb3ed01e0552e4eb80a0c6d633c4c28d8805c48d6dd75879d73274f6a898cbf70f1c83c
+  data.tar.gz: add10309df54041eef176bb38190c86fc3bfda400148dfc784863d69a9765fee37e9491449a62b35c805fc67338825791c82429c0a4527dc6ccf782ef2921a99

data/CHANGELOG.md

@@ -2,6 +2,27 @@
 
 ## [Unreleased]
 
+## [0.2.04] - 2023-12-24
+Some code refactoring.
+
+### Added
+- File `walk_progress_spec.rb`
+
+### Changed
+- Class `WalkProgress` refactoring & documentation
+- Class `ChartWalker` refactoring & documentation
+
+## [0.2.03] - 2023-12-21
+
+### Added
+- YARD documentation for the `ParseNode` hierarchy.
+- Classes `Token` and `Literal` added the predicate method `literal?`
+
+### Changed
+- Class rename: `ANDNode` became `AndNode`
+- Class `ParseNode`: method rename: `ParseNode#to_s` became `ParseNode#range_to_s`
+- Class `ParseNode`: attribute `range` is now of type `Range` 
+
 ## [0.2.02] - 2023-12-18
 Code re-styling to fix most Rubocop offenses.
 

data/lib/dendroid/formatters/bracket_notation.rb

@@ -6,7 +6,7 @@ class BracketNotation < BaseFormatter
   # Method called by a ParseTreeVisitor to which the formatter subscribed.
   # Notification of a visit event: the visitor is about to visit
   # a non-terminal node
-  # @param and_node [ANDNode]
+  # @param and_node [AndNode]
   def before_and_node(and_node)
     write("[#{and_node.rule.lhs.name} ")
   end

data/lib/dendroid/grm_analysis/dotted_item.rb

@@ -21,7 +21,7 @@ module Dendroid
     # An item with the dot not at the beginning is sometimes referred to as a kernel item
     class DottedItem
       # (Weak) reference to the production rule
-      # @return [Dendroid::Syntax::Production]
+      # @return [Dendroid::Syntax::Rule]
       attr_reader :rule
 
       # @return [Integer] the dot position
@@ -31,12 +31,12 @@ module Dendroid
       attr_reader :alt_index
 
       # Constructor.
-      # @param aChoice [Dendroid::Syntax::Rule]
+      # @param aRule[Dendroid::Syntax::Rule]
       # @param aPosition [Integer] Position of the dot in rhs of production.
       # @param index [Integer] the rank of the alternative at hand
-      def initialize(aChoice, aPosition, index)
+      def initialize(aRule, aPosition, index)
         @alt_index = index
-        @rule = WeakRef.new(aChoice)
+        @rule = WeakRef.new(aRule)
         @position = valid_position(aPosition)
       end
 

data/lib/dendroid/lexical/literal.rb

@@ -23,6 +23,11 @@ module Dendroid
         super(original, pos, symbol)
         @value = aValue
       end
+
+      # @return [Boolean] true if the token is a literal (has a value associated with is)
+      def literal?
+        true
+      end
     end # class
   end # module
 end # module

data/lib/dendroid/lexical/token.rb

@@ -41,6 +41,11 @@ module Dendroid
       def pos_to_s
         position.to_s
       end
+
+      # @return [Boolean] true if the token is a literal (has a value associated with is)
+      def literal?
+        false
+      end
     end # class
   end # module
 end # module

data/lib/dendroid/parsing/and_node.rb

@@ -4,10 +4,18 @@ require_relative 'composite_parse_node'
 
 module Dendroid
   module Parsing
-    class ANDNode < CompositeParseNode
+    # A composite parse node that matches the sequence of grammar symbols from
+    # a right-hand side of a rule to a range of input tokens. The child nodes
+    # correspond to the grammar symbols in the RHS of the rule.
+    class AndNode < CompositeParseNode
+      # @return [WeakRef<Dendroid::Syntax::Rule>] Grammar rule
       attr_reader :rule
+
+      # @return [Integer] Index of the rule alternative.
       attr_reader :alt_index
 
+      # @param anEItem [Dendroid::Recognizer::EItem] An entry from the chart.
+      # @param rank [Integer] rank of the last input token matched by this node
       def initialize(anEItem, rank)
         @rule = WeakRef.new(anEItem.dotted_item.rule)
         @alt_index = anEItem.dotted_item.alt_index
@@ -15,14 +23,22 @@ module Dendroid
         super(anEItem.origin, upper_bound, rule.rhs[alt_index].size)
       end
 
+      # Add a child a given available position.
+      # @param child_node [Dendroid::Parsing::ParseNode] Node to add as a child
+      # @param index [Integer] position of the child node in the `children` array
       def add_child(child_node, index)
         raise StandardError unless children[index].nil? # Is slot available?
 
         super(child_node, index)
       end
 
+      # Is the given chart entry matching this node?
+      # The chart entry matches this node if:
+      #   - its origin equals to the start of the range; and,
+      #   - both rules are the same; and,
+      # @return [Boolean] true if the entry corresponds to this node.
       def match(anEItem)
-        return false if range[0] != anEItem.origin
+        return false if range.begin != anEItem.origin
 
         dotted = anEItem.dotted_item
         same_rule = (rule.lhs == dotted.rule.lhs) && (alt_index == dotted.alt_index)
@@ -31,17 +47,23 @@ module Dendroid
         dotted.initial_pos? ? true : partial?
       end
 
+      # Is this node expecting at given RHS index, the given symbol?
+      # @param symbol [Dendroid::Syntax::GrmSymbol]
+      # @param position [Integer] index of given member in RHS of the rule
       def expecting?(symbol, position)
         symb_seq = rule.rhs[alt_index]
         symb_seq[position] == symbol
       end
 
+      # @return [Boolean] true if at least one of the children slots is free.
       def partial?
         children.any?(&:nil?)
       end
 
+      # Return a String representation of itself
+      # @return [String] text representation of itself
       def to_s
-        "#{rule.lhs} => #{rule.rhs[alt_index]} #{range}"
+        "#{rule.lhs} => #{rule.rhs[alt_index]} #{range_to_s}"
       end
 
       # Part of the 'visitee' role in Visitor design pattern.