rley 0.7.00 → 0.7.01

data/examples/data_formats/JSON/json_demo.rb

@@ -28,6 +28,7 @@ case cli_options[:format]
   when :minify
     msg = "minify format works for 'cst' representation only"
     raise StandardError, msg if tree_rep == :ast
+
     renderer = JSONMinifier.new($stdout)
   when :ruby
     msg = "ruby format works for 'ast' representation only"

data/examples/data_formats/JSON/json_lexer.rb

@@ -67,6 +67,7 @@ class JSONLexer
           end_delimiter = scanner.getch
           err_msg = 'No closing quotes (") found'
           raise ScanError.new(err_msg) if end_delimiter.nil?
+
           token = build_token(value, 'string')
 
         when /[-0-9]/ # Start character of number literal found
@@ -85,7 +86,7 @@ class JSONLexer
 
     return token
   end
-  
+
   def build_token(lexeme, token)
     pos = Rley::Lexical::Position.new(lineno, scanner.pos - line_start)
     Rley::Lexical::Token.new(lexeme, token, pos)

data/lib/rley/base/dotted_item.rb

@@ -113,8 +113,10 @@ module Rley # This module is used as a namespace
       # @return [Boolean]
       def successor_of?(another)
         return false if production != another.production
+
         to_the_left = prev_position
         return false if to_the_left.nil?
+
         return to_the_left == another.position
       end
 

data/lib/rley/constants.rb

@@ -3,7 +3,7 @@
 
 module Rley # Module used as a namespace
   # The version number of the gem.
-  Version = '0.7.00'.freeze
+  Version = '0.7.01'.freeze
 
   # Brief description of the gem.
   Description = "Ruby implementation of the Earley's parsing algorithm".freeze

data/lib/rley/engine.rb

@@ -30,11 +30,11 @@ module Rley # This module is used as a namespace
   # Rley client code from the lower-level classes.
   class Engine
     # @!attribute [r] configuration
-    # @return [EngineConfig] the engine's configuration 
+    # @return [EngineConfig] the engine's configuration
     attr_reader :configuration
-    
+
     # @!attribute [r] grammar
-    # @return [Rley::Syntax::Grammar] the grammar of the language to parse    
+    # @return [Rley::Syntax::Grammar] the grammar of the language to parse
     attr_reader :grammar
 
     # Constructor.
@@ -54,17 +54,17 @@ module Rley # This module is used as a namespace
     #   instance = Engine.new
     #   instance.build_grammar do
     #     add_terminals('LBRACKET', 'RBRACKET', 'COMMA', 'INTEGER')
-    #     add_production('start' => 'array')    
+    #     add_production('start' => 'array')
     #     add_production('array' => 'LBRACKET elements RBRACKET')
     #     add_production('array' => 'LBRACKET RBRACKET')
     #     add_production('elements' => 'elements COMMA INTEGER')
-    #     add_production('elements' => 'INTEGER')    
+    #     add_production('elements' => 'INTEGER')
     #   end
     def build_grammar(&aBlock)
       builder = Rley::Syntax::GrammarBuilder.new(&aBlock)
       @grammar = builder.grammar
     end
-    
+
     # Use the given grammar.
     # @param aGrammar [Rley::Syntax::Grammar]
     # @return [Rley::Syntax::Grammar] the grammar of the language to parse.
@@ -79,6 +79,7 @@ module Rley # This module is used as a namespace
       tokens = []
       aTokenizer.each do |a_token|
         next unless a_token
+
         term_name = a_token.terminal
         term_symb = grammar.name2symbol[term_name]
         a_token.instance_variable_set(:@terminal, term_symb)
@@ -88,7 +89,7 @@ module Rley # This module is used as a namespace
       parser.gf_graph.diagnose if configuration.diagnose
       result = parser.parse(tokens)
       result.tidy_up!
-      
+
       return result
     end
 

data/lib/rley/gfg/grm_flow_graph.rb

@@ -153,6 +153,7 @@ 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 }
@@ -197,6 +198,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?

data/lib/rley/gfg/item_vertex.rb

@@ -30,7 +30,9 @@ 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'

data/lib/rley/gfg/vertex.rb

@@ -46,7 +46,7 @@ module Rley # This module is used as a namespace
       # @return [String]      
       def selfie()
         result = "#{self.class.name}:#{object_id}"
-        result << %Q( label="#{label}")
+        result << %( label="#{label}")
         return result
       end
       
@@ -69,6 +69,7 @@ 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
       end
       

data/lib/rley/lexical/token.rb

@@ -6,8 +6,8 @@ module Rley # This module is used as a namespace
         "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
@@ -25,8 +25,8 @@ module Rley # This module is used as a namespace
 
       # @return [Syntax::Terminal] Terminal symbol corresponding to the lexeme.
       attr_reader(:terminal)
-      
-      # @return [Position] The position of the lexeme in the source file.      
+
+      # @return [Position] The position of the lexeme in the source file.
       attr_reader(:position)
 
       # Constructor.
@@ -35,6 +35,7 @@ module Rley # This module is used as a namespace
       #   The terminal symbol corresponding to the lexeme.
       def initialize(theLexeme, aTerminal, aPosition)
         raise 'Internal error: nil terminal symbol detected' if aTerminal.nil?
+
         @lexeme = theLexeme
         @terminal = aTerminal
         @position = aPosition

data/lib/rley/parse_forest_visitor.rb

@@ -50,7 +50,7 @@ module Rley # This module is used as a namespace
       @subscribers = []
       @prime_enum = Prime.instance.each
       @legs = []
-      @node_accesses = Hash.new { |h, key| h[key] = Array.new }
+      @node_accesses = Hash.new { |h, key| h[key] = [] }
     end
 
     # Add a subscriber for the visit event notifications.
@@ -81,9 +81,9 @@ module Rley # This module is used as a namespace
     # @param nonTerminalNd [NonTerminalNode] the node to visit.
     def visit_nonterminal(nonTerminalNd)
       broadcast(:before_non_terminal, nonTerminalNd)
-     unless nonTerminalNd.signature_exist?
-       nonTerminalNd.add_edge_signatures(prime_enum)
-     end
+      unless nonTerminalNd.signature_exist?
+        nonTerminalNd.add_edge_signatures(prime_enum)
+      end
       traverse_children(nonTerminalNd)
       broadcast(:after_non_terminal, nonTerminalNd)
     end
@@ -122,7 +122,7 @@ module Rley # This module is used as a namespace
     # non-terminal node.
     # @param aNonTerminalNode [NonTerminalNode] the node to visit.
     # def end_visit_nonterminal(aNonTerminalNode)
-      # broadcast(:after_non_terminal, aNonTerminalNode)
+    #   broadcast(:after_non_terminal, aNonTerminalNode)
     # end
 
     # Visit event. The visitor has completed the visit of the pforest.
@@ -167,6 +167,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
@@ -187,6 +188,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

@@ -17,7 +17,7 @@ module Rley # This module is used as a namespace
       # @return [Hash{String => Class}, Hash{String => Hash{String => Class}}]
       #   Returned hash contains pairs of the form:
       #   terminal name => Class implementing the terminal tokens
-      #   terminal name => Hash with pairs: rule name => Class
+      #   terminal name => Hash with pairs: production name => Class
       def terminal2node()
         raise NotImplementedError
       end

data/lib/rley/parse_rep/parse_rep_creator.rb

@@ -28,8 +28,8 @@ module Rley # This module is used as a namespace
             # puts "EVENT #{event[0]} #{event[1]}"
             a_builder.receive_event(*event)
           end
-        rescue StopIteration => exc
-          # Do nothing
+        rescue StopIteration
+          # Do nothing: gobble the exception
         end
         
         a_builder.done!

data/lib/rley/parse_rep/parse_tree_builder.rb

@@ -85,6 +85,7 @@ module Rley # This module is used as a namespace
       # node as root node.
       def create_tree(aRootNode)
         raise StandardError, 'Root node of parse tree is nil!' if aRootNode.nil?
+        
         return Rley::PTree::ParseTree.new(aRootNode)
       end      
 

data/lib/rley/parse_tree_visitor.rb

@@ -15,6 +15,7 @@ module Rley # This module is used as a namespace
     # @param aParseTree [ParseTree] the parse tree to visit.
     def initialize(aParseTree, aTraversalStrategy = :post_order)
       raise StandardError if aParseTree.nil?
+
       @ptree = aParseTree
       @subscribers = []
       @traversal = aTraversalStrategy
@@ -99,6 +100,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

data/lib/rley/parser/error_reason.rb

@@ -5,7 +5,7 @@ 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 [Fixnum] The rank number of the offending input token
       attr_reader(:rank)
 
       # Constructor
@@ -45,27 +45,29 @@ module Rley # Module used as a namespace
     class ExpectationNotMet < ErrorReason
       # The last input token read when error was detected
       attr_reader(:last_token)
-      
+
       # The terminal symbols expected when error was occurred
       attr_reader(:expected_terminals)
 
       def initialize(aRank, lastToken, expectedTerminals)
         super(aRank)
         raise StandardError, 'Internal error: nil token' if lastToken.nil?
+
         @last_token = lastToken.dup
         @expected_terminals = expectedTerminals.dup
       end
 
       protected
-      
+
       def position()
         return last_token.position if last_token.respond_to?(:position)
+
         rank + 1
       end
-      
+
       # Emit a text explaining the expected terminal symbols
       def expectations
-        term_names = expected_terminals.map(&:name)      
+        term_names = expected_terminals.map(&:name)
         explain = 'Expected one '
         explain << if expected_terminals.size > 1
                      "of: ['#{term_names.join("', '")}']"
@@ -92,7 +94,7 @@ module Rley # Module used as a namespace
 
     # This parse error occurs when all input tokens were consumed
     # but the parser still expected one or more tokens from the input.
-    class PrematureInputEnd < ExpectationNotMet    
+    class PrematureInputEnd < ExpectationNotMet
       # Returns the reason's message.
       def to_s
         err_msg = "Premature end of input after '#{last_token.lexeme}'"

data/lib/rley/parser/gfg_chart.rb

@@ -13,7 +13,7 @@ module Rley # This module is used as a namespace
       attr_reader(:sets)
 
       # @param aGFGraph [GFG::GrmFlowGraph] The GFG for the grammar in use.
-      def initialize( aGFGraph)
+      def initialize(aGFGraph)
         @sets = [ ParseEntrySet.new ]
         push_entry(aGFGraph.start_vertex, 0, 0, :start_rule)
       end
@@ -45,7 +45,7 @@ module Rley # This module is used as a namespace
       # Push a parse entry for the chart entry with given index
       # @param anIndex [Integer] The rank of the token in the input stream.
       # @return [ParseEntry] the passed parse entry if it is pushed
-      def push_entry(aVertex, anOrigin, anIndex, _reason)
+      def push_entry(aVertex, anOrigin, anIndex, reason)
         # puts "push_entry:"
         # puts "  aVertex #{aVertex.inspect}"
         # puts "  anOrigin: #{anOrigin}"
@@ -53,8 +53,9 @@ module Rley # This module is used as a namespace
         # puts "  _reason: #{_reason}"
         new_entry = ParseEntry.new(aVertex, anOrigin)
         if anIndex == sets.size
-          err_msg = "Internal error: unexpected push reason #{_reason}"
-          raise StandardError, err_msg if _reason != :scan_rule
+          err_msg = "Internal error: unexpected push reason #{reason}"
+          raise StandardError, err_msg if reason != :scan_rule
+          
           add_entry_set 
         end
         pushed = self[anIndex].push_entry(new_entry)
@@ -98,7 +99,6 @@ module Rley # This module is used as a namespace
       def add_entry_set()
          @sets << ParseEntrySet.new
       end
-
     end # class
   end # module
 end # module

data/lib/rley/parser/gfg_parsing.rb

@@ -176,6 +176,7 @@ module Rley # This module is used as a namespace
       # followed the syntax specified by the grammar)
       def success?()
         return false if @failure_reason
+        
         return chart.accepting_entry ? true : false
       end
 
@@ -272,6 +273,7 @@ END_MSG
             # Rule: has 1..* antecedents, all of them are exit items
             antecedents.each do |antec|
               next if antec.exit_entry?
+
               msg_prefix = "End vertex parse entry #{consequent}"
               msg_suffix = " has for antecedent #{antec}"
               raise StandardError, msg_prefix + msg_suffix
@@ -280,16 +282,18 @@ END_MSG
           when Rley::GFG::ItemVertex
             # Rule: has exactly one antecedent
             # if antecedents.size > 1
-              # msg_prefix = "Parse entry #{consequent} | #{aPosition}"
-              # msg = " has more than one antecedent:\n"
-              # msg_suffix = antecedents.map(&:to_s).join("\n")
-              # raise(StandardError, msg_prefix + msg + msg_suffix)
+            #   msg_prefix = "Parse entry #{consequent} | #{aPosition}"
+            #   msg = " has more than one antecedent:\n"
+            #   msg_suffix = antecedents.map(&:to_s).join("\n")
+            #   raise(StandardError, msg_prefix + msg + msg_suffix)
             # end
 
           when Rley::GFG::StartVertex
-            # Rule: has 0..* antecedents, all of them are item vertices but not exit items
+            # Rule: has 0..* antecedents, all of them are
+            # item vertices but not exit items
             antecedents.each do |antec|
               next if antec.dotted_entry? && !antec.end_entry?
+
               msg_prefix = "Parse entry #{consequent}"
               msg_suffix = " has for antecedent #{antec}"
               raise StandardError, msg_prefix + msg_suffix
@@ -304,6 +308,7 @@ END_MSG
       # chart entry with given index if it isn't yet in the chart entry.
       def push_entry(aVertex, anOrigin, aChartIndex, aReason)
         raise StandardError, 'Vertex may not be nil' if aVertex.nil?
+
         chart.push_entry(aVertex, anOrigin, aChartIndex, aReason)
       end
 

data/lib/rley/parser/parse_entry_tracker.rb

@@ -26,6 +26,7 @@ module Rley # This module is used as a namespace
       # 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
         processed_entries[parse_entry] = true
       end

data/lib/rley/parser/parse_state.rb

@@ -16,7 +16,7 @@ module Rley # This module is used as a namespace
       def ==(other)
         return true if object_id == other.object_id
 
-        result = (dotted_rule == other.dotted_rule) && 
+        result = (dotted_rule == other.dotted_rule) &&
                  (origin == other.origin)
 
         return result
@@ -43,6 +43,7 @@ module Rley # This module is used as a namespace
         return false if other == self
 
         return false unless origin == other.origin
+
         other_production = other.dotted_rule.production
         return false unless dotted_rule.production == other_production
 

data/lib/rley/parser/parse_state_tracker.rb

@@ -26,6 +26,7 @@ module Rley # This module is used as a namespace
       # Write accessor. Set the given parse state as the current one.
       def parse_state=(aParseState)
         raise StandardError, 'Nil parse state' if aParseState.nil?
+        
         @parse_state = aParseState
         processed_states[parse_state] = true
       end

data/lib/rley/parser/parse_walker_factory.rb

@@ -54,6 +54,7 @@ module Rley # This module is used as a namespace
       def build_walker(acceptingEntry, maxIndex, lazyWalk = false)
         msg = 'Internal error: nil entry argument'
         raise StandardError, msg if acceptingEntry.nil?
+
         # Local context for the enumerator
         ctx = init_context(acceptingEntry, maxIndex, lazyWalk)
 
@@ -65,9 +66,12 @@ module Rley # This module is used as a namespace
             receiver << event unless event.nil?
 
             if ctx.curr_entry.orphan? # No antecedent?...
-              err_msg = "No antecedent for #{ctx.curr_entry} at rank #{ctx.entry_set_index}"
+              msg_prefix = "No antecedent for #{ctx.curr_entry}"
+              msg_suffix = "at rank #{ctx.entry_set_index}"
+              err_msg = msg_prefix + ' ' + msg_suffix
               raise StandardError, err_msg unless ctx.curr_entry.start_entry?
               break if ctx.backtrack_points.empty?
+
               receiver << use_backtrack_point(ctx)
               receiver << visit_entry(ctx.curr_entry, ctx)
             end
@@ -187,6 +191,7 @@ module Rley # This module is used as a namespace
           # 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)
@@ -264,6 +269,7 @@ module Rley # This module is used as a namespace
       # to a item vertex
       def select_calling_entry(aContext)
         raise ScriptError, 'Empty return stack' if aContext.return_stack.empty?
+
         # Retrieve top of stack
         tos = aContext.return_stack.pop
         tos_dotted_item = tos.vertex.dotted_item