dendroid 0.0.11 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2564f1269225e08732a9f995b10ebbbbf4710b0a1b0aea73e7fe4b486c34a1aa
-  data.tar.gz: db15f965e9365276ffc576435d514cd6c9170a8727c7fafe1425a9de7ed3e0cd
+  metadata.gz: 56842965215f0cef73b768223b5acb907fc1642b57528a9e616852ae6adab2cc
+  data.tar.gz: d53478ebcb86c89a407d648c67bfd34dd1f3333f41f7b6e0eac1dcb3e2a25cb6
 SHA512:
-  metadata.gz: 2517fd57cca364571e19ddd183d53fcd4fd642f0cf83ecc58ef0f62e5c7512c343cc3db4f31ee621dad5009386db0161e7c2f67944820dd36cb2a253a4d7af80
-  data.tar.gz: 24b77e7c0c5e97df315102c3434dddd251eacab96efaa3d194006c3874f6d260aeafa076ec5b6bd1bed296fbc675bef00e2fcf49a1e4516c20cc6b3e3b0aefdb
+  metadata.gz: 7ef9e4766ad0c786471d08ba6cffcdffaec2d9acf734e25dafa796e714e1103ee838421b3b817c0c732b91c1a238c5fd32c9c3a6f2954926880336b70caab8b9
+  data.tar.gz: 7e389e83762cedfbdbdf23acbcf821f478a237d8e2b6da6c4299db17d0ade7e760f77328e8f9f59cb10c251f6b1711257793c2b94c12e7ddd8bde2bcad5add66

data/.rubocop.yml

@@ -12,7 +12,7 @@ Metrics/BlockLength:
 
 Metrics/ClassLength:
   Enabled: true
-  Max: 200
+  Max: 300
   
 Metrics/CyclomaticComplexity:  
   Enabled: true

data/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 ## [Unreleased]
 
+## [0.0.12] - 2023-11-02
+Added more tests.
+
+### Added
+- Added more tests to spec file of `Grammar` class.
+- Added more tests to spec file of `Recognizer` class.
+
 ## [0.0.11] - 2023-11-02
 Added Earley recognizer and its ancillary classes.
 

data/lib/dendroid/recognizer/chart.rb

@@ -4,9 +4,11 @@ require_relative 'item_set'
 
 module Dendroid
   module Recognizer
-    # Also called a parse table.
-    # Assuming that n == number of input tokens,
-    # then the chart is an array with n + 1 entry sets.
+    # Also called a parse table. It records the progress of the
+    # Earley recognizer whens its verifies the compliance of the input text
+    # to the language grammar rules.
+    # It essentially consists in an array of item sets.
+    # If n is the number of input tokens then the chart has n + 1 entry sets.
     class Chart
       extend Forwardable
 
@@ -33,7 +35,7 @@ module Dendroid
       end
 
       # Add a new empty item set at the end of the array of item sets
-      def append_new_set()
+      def append_new_set
         item_sets << ItemSet.new
       end
 

data/lib/dendroid/recognizer/e_item.rb

@@ -45,4 +45,3 @@ module Dendroid
     end # class
   end # module
 end # module
-

data/lib/dendroid/recognizer/item_set.rb

@@ -8,6 +8,7 @@ module Dendroid
 
       # @return [Recognizer::EItem]
       attr_reader :items
+
       def_delegators :@items, :clear, :each, :empty?, :select, :size
 
       def initialize

data/lib/dendroid/recognizer/recognizer.rb

@@ -16,11 +16,16 @@ module Dendroid
       # @return [Object]
       attr_reader :tokenizer
 
+      # @param grammar [Dendroid::Syntax::Grammar]
+      # @param tokenizer [Object]
       def initialize(grammar, tokenizer)
         @grm_analysis = GrmAnalysis::GrmAnalyzer.new(grammar)
         @tokenizer = tokenizer
       end
 
+      # Try to read the `source` text and verify that it is syntactically correct.
+      # @param source [String] Input text to recognize
+      # @return [Dendroid::Recognizer::Chart]
       def run(source)
         tokenizer.input = source
         tok = tokenizer.next_token
@@ -34,6 +39,8 @@ module Dendroid
         end
       end
 
+      # Run the Earley algorithm
+      # @param initial_token [Dednroid::Lexical::Token]
       def earley_parse(initial_token)
         chart = new_chart
         tokens = [initial_token]
@@ -42,7 +49,7 @@ module Dendroid
         rank = 0
 
         loop do
-          eos_reached = advance_next_token(tokens, predicted_symbols) unless eos_reached
+          eos_reached ||= advance_next_token(tokens, predicted_symbols)
 
           advance = false
           curr_rank = rank
@@ -55,7 +62,7 @@ module Dendroid
 
           rank += 1 if advance
           break if eos_reached && !advance
-          break if ! advance
+          break if !advance
         end
 
         determine_outcome(chart, tokens)
@@ -106,15 +113,14 @@ module Dendroid
 
         advance
       end
-=begin
-    procedure PREDICTOR((A → α•Bβ, j), k)
-        for each (B → γ) in GRAMMAR_RULES_FOR(B) do
-            ADD_TO_SET((B → •γ, k), S[k])
-        end
-      Assuming next symbol is a non-terminal
 
-      Error case: next actual token matches none of the expected tokens.
-=end
+      # procedure PREDICTOR((A → α•Bβ, j), k)
+      #     for each (B → γ) in GRAMMAR_RULES_FOR(B) do
+      #         ADD_TO_SET((B → •γ, k), S[k])
+      #     end
+      #   Assuming next symbol is a non-terminal
+      #
+      #   Error case: next actual token matches none of the expected tokens.
       def predictor(chart, item, rank, tokens, mode, predicted_symbols)
         next_symbol = item.next_symbol
         if mode == :genuine
@@ -152,13 +158,11 @@ module Dendroid
         end
       end
 
-=begin
-    procedure SCANNER((A → α•aβ, j), k, words)
-        if j < LENGTH(words) and a ⊂ PARTS_OF_SPEECH(words[k]) then
-            ADD_TO_SET((A → αa•β, j), S[k+1])
-        end
-    Assuming next symbol is a terminal
-=end
+      # procedure SCANNER((A → α•aβ, j), k, words)
+      #     if j < LENGTH(words) and a ⊂ PARTS_OF_SPEECH(words[k]) then
+      #         ADD_TO_SET((A → αa•β, j), S[k+1])
+      #     end
+      # Assuming next symbol is a terminal
       def scanner(chart, scan_item, rank, tokens)
         advance = false
         dit = scan_item.dotted_item
@@ -174,12 +178,10 @@ module Dendroid
         advance
       end
 
-=begin
-    procedure COMPLETER((B → γ•, x), k)
-        for each (A → α•Bβ, j) in S[x] do
-            ADD_TO_SET((A → αB•β, j), S[k])
-        end
-=end
+      # procedure COMPLETER((B → γ•, x), k)
+      #     for each (A → α•Bβ, j) in S[x] do
+      #         ADD_TO_SET((A → αB•β, j), S[k])
+      #     end
       def completer(chart, item, rank, tokens, mode)
         origin = item.origin
 
@@ -190,6 +192,7 @@ module Dendroid
         callers.each do |call_item|
           return_item = grm_analysis.next_item(call_item.dotted_item)
           next unless return_item
+
           member = return_item.next_symbol
           if member&.terminal? && (mode == :genuine)
             next unless next_token
@@ -222,12 +225,13 @@ module Dendroid
           end
           last_set = chart.item_sets.last
           last_set.each do |entry|
-            next if ((!entry.origin.zero?) || ! final_items.include?(entry.dotted_item))
+            next if ((!entry.origin.zero?) || !final_items.include?(entry.dotted_item))
+
             success = true
           end
         end
 
-        if !success
+        unless success
           # Error detected...
           replay_last_set(chart, tokens)
           if chart.size < tokens.size + 1
@@ -242,7 +246,7 @@ module Dendroid
             end
             terminals.uniq!
             prefix = "Syntax error at or near token line #{line}, column #{col} >>>#{offending_token.source}<<<"
-            expectation = terminals.size == 1 ? "#{terminals[0].name}" : "one of: [#{terminals.map(&:name).join(', ')}]"
+            expectation = terminals.size == 1 ? terminals[0].name.to_s : "one of: [#{terminals.map(&:name).join(', ')}]"
             err_msg = "#{prefix} Expected #{expectation}, found a #{offending_token.terminal} instead."
             chart.failure_class = StandardError
             chart.failure_reason = err_msg
@@ -259,7 +263,7 @@ module Dendroid
             terminals.uniq!
 
             prefix = "Line #{line}, column #{col}: Premature end of input after '#{last_token.source}'"
-            expectation = terminals.size == 1 ? "#{terminals[0].name}" : "one of: [#{terminals.map(&:name).join(', ')}]"
+            expectation = terminals.size == 1 ? terminals[0].name.to_s : "one of: [#{terminals.map(&:name).join(', ')}]"
             err_msg = "#{prefix}, expected: #{expectation}."
             chart.failure_class = StandardError
             chart.failure_reason = err_msg
@@ -279,4 +283,4 @@ module Dendroid
       end
     end # class
   end # module
-end # module
+end # module

data/lib/dendroid/syntax/grammar.rb

@@ -47,7 +47,7 @@ module Dendroid
         end
         # TODO: add test for duplicate productions
         if nonterm2productions[rule.head]&.include? rule
-          raise StandardError, "Production rule '#{production}' appears more than once in the grammar."
+          raise StandardError, "Production rule '#{rule}' appears more than once in the grammar."
         end
 
         add_symbol(rule.head)

data/spec/dendroid/recognizer/chart_spec.rb

@@ -1,2 +1 @@
 # frozen_string_literal: true
-

data/spec/dendroid/recognizer/e_item_spec.rb

@@ -41,6 +41,8 @@ describe Dendroid::Recognizer::EItem do
       expect(subject.lhs).to eq(expr_symb)
     end # context
 
+    # rubocop: disable Lint/BinaryOperatorWithIdenticalOperands
+
     it 'can compare with another EItem' do
       expect(subject == subject).to be_truthy
       expect(subject == described_class.new(sample_dotted, sample_origin)).to be_truthy
@@ -48,6 +50,8 @@ describe Dendroid::Recognizer::EItem do
       expect(subject == described_class.new(other_dotted, sample_origin)).to be_falsey
     end
 
+    # rubocop: enable Lint/BinaryOperatorWithIdenticalOperands
+
     it 'can renders a String representation of itself' do
       expect(subject.to_s).to eq("#{sample_dotted} @ #{sample_origin}")
     end

data/spec/dendroid/recognizer/item_set_spec.rb

@@ -60,4 +60,4 @@ describe Dendroid::Recognizer::ItemSet do
       expect(subject.to_s).to eq(expectations)
     end
   end # context
-end # describe
+end # describe