rley 0.4.06 → 0.4.07

data/examples/general/calc/calc_lexer.rb

@@ -1,7 +1,7 @@
 # File: calc_lexer.rb
 # Lexer for a basic arithmetical expression parser
 require 'strscan'
-require 'rley'  # Load the gem
+require 'rley' # Load the gem
 
 
 class CalcLexer
@@ -16,21 +16,20 @@ class CalcLexer
     '+' => 'PLUS',
     '-' => 'MINUS',
     '*' => 'STAR',
-    '/' => 'DIVIDE',
-  }
+    '/' => 'DIVIDE'
+  }.freeze
 
-  class ScanError < StandardError ; end
+  class ScanError < StandardError; end
 
-public
   def initialize(source, aGrammar)
     @scanner = StringScanner.new(source)
     @name2symbol = aGrammar.name2symbol
-    @lineno =  1
+    @lineno = 1
   end
 
   def tokens()
     tok_sequence = []
-    until @scanner.eos? do
+    until @scanner.eos?
       token = _next_token
       tok_sequence << token unless token.nil?
     end
@@ -38,13 +37,14 @@ public
     return tok_sequence
   end
 
-private
+  private
+
   def _next_token()
     token = nil
     skip_whitespaces
     curr_ch = scanner.getch # curr_ch is at start of token or eof reached...
 
-    begin
+    loop do
       break if curr_ch.nil?
 
       case curr_ch
@@ -66,15 +66,14 @@ private
           sequel = scanner.scan(/.{1,20}/)
           erroneous += sequel unless sequel.nil?
           raise ScanError.new("Unknown token #{erroneous}")
-      end #case
-
+      end # case
 
-    end while (token.nil? && curr_ch = scanner.getch())
+      break unless token.nil? && (curr_ch = scanner.getch)
+    end 
 
     return token
   end
 
-
   def skip_whitespaces()
     matched = scanner.scan(/[ \t\f\n\r]+/)
     return if matched.nil?
@@ -84,10 +83,8 @@ private
     newline_detected(newline_count)
   end
 
-
   def newline_detected(count)
     @lineno += count
-    @line_start = scanner.pos()
+    @line_start = scanner.pos
   end
-
-end # class
+end # class

data/examples/general/calc/calc_parser.rb

@@ -14,11 +14,11 @@ class CalcParser < Rley::Parser::GFGEarleyParser
   end
 
   def parse_expression(aText)
-    lexer = CalcLexer.new(aText, self.grammar)
+    lexer = CalcLexer.new(aText, grammar)
     result = parse(lexer.tokens)
 
     return result
   end
 end # class
 
-# End of file
+# End of file

data/lib/rley/constants.rb

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

data/lib/rley/formatter/asciitree.rb

@@ -13,14 +13,19 @@ module Rley # This module is used as a namespace
       # Allowed string values are: 'first', 'last', 'first_and_last', 'other'
       attr_reader(:ranks)
 
+      # @return [String] The character pattern used for rendering 
+      # a parent - child nesting
       attr_reader(:nesting_prefix)
 
+      # @return [String] The character pattern used for a blank indentation
       attr_reader(:blank_indent)
 
+      # @return [String] The character pattern for indentation and nesting
+      # continuation.
       attr_reader(:continuation_indent)
 
       # Constructor.
-      # @param anIO [IO] The output stream to which the rendered grammar
+      # @param anIO [IO] The output stream to which the parse tree
       # is written.
       def initialize(anIO)
         super(anIO)
@@ -32,18 +37,16 @@ module Rley # This module is used as a namespace
         @continuation_indent = '|   '
       end
 
-
       # Method called by a ParseTreeVisitor to which the formatter subscribed.
       # Notification of a visit event: the visitor is about to visit
       # the children of a non-terminal node
       # @param parent [NonTerminalNode]
-      # @param children [Array] array of children nodes
-      def before_subnodes(parent, children)
+      # @param children [Array<ParseTreeNode>] array of children nodes
+      def before_subnodes(parent, _children)
         rank_of(parent)
         curr_path << parent
       end
 
-
       # 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
@@ -52,7 +55,6 @@ module Rley # This module is used as a namespace
         emit(aNonTerm)
       end
 
-
       # Method called by a ParseTreeVisitor to which the formatter subscribed.
       # Notification of a visit event: the visitor is about to visit
       # a terminal node
@@ -61,7 +63,6 @@ module Rley # This module is used as a namespace
         emit(aTerm, ": '#{aTerm.token.lexeme}'")
       end
 
-
       # Method called by a ParseTreeVisitor to which the formatter subscribed.
       # Notification of a visit event: the visitor completed the visit of
       # the children of a non-terminal node.
@@ -86,13 +87,13 @@ module Rley # This module is used as a namespace
           siblings = parent.subnodes
           siblings_last_index = siblings.size - 1
           rank = case siblings.find_index(aChild)
-                 when 0 then 'first'
-                 when siblings_last_index then 'last'
-                 else
-                  'other'
+                   when 0 then 'first'
+                   when siblings_last_index then 'last'
+                   else
+                    'other'
                  end
         end
-        self.ranks << rank
+        ranks << rank
       end
 
       # 'root', 'first', 'first_and_last', 'last', 'other'
@@ -101,7 +102,7 @@ module Rley # This module is used as a namespace
 
         prefix = ''
         @ranks.each_with_index do |rank, i|
-          next if i == 0
+          next if i.zero?
 
           case rank
             when 'first', 'other'
@@ -109,7 +110,6 @@ module Rley # This module is used as a namespace
 
             when 'last', 'first_and_last', 'root'
               prefix << blank_indent
-            else
           end
         end
 
@@ -117,7 +117,6 @@ module Rley # This module is used as a namespace
         return prefix
       end
 
-
       def emit(aNode, aSuffix = '')
         output.puts("#{path_prefix}#{aNode.symbol.name}#{aSuffix}")
       end
@@ -125,4 +124,4 @@ module Rley # This module is used as a namespace
   end # module
 end # module
 
-# End of file
+# End of file

data/lib/rley/formatter/bracket_notation.rb

@@ -11,7 +11,6 @@ module Rley # This module is used as a namespace
     # For Ruby developers, there is RSyntaxTree by Yoichiro Hasebe.
     # (accessible via: http://yohasebe.com/rsyntaxtree/)
     class BracketNotation < BaseFormatter
-
       # Constructor.
       # @param anIO [IO] The output stream to which the rendered grammar
       # is written.
@@ -19,7 +18,6 @@ module Rley # This module is used as a namespace
         super(anIO)
       end
 
-
       # 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
@@ -28,7 +26,6 @@ module Rley # This module is used as a namespace
         write("[#{aNonTerm.symbol.name} ")
       end
 
-
       # Method called by a ParseTreeVisitor to which the formatter subscribed.
       # Notification of a visit event: the visitor is about to visit
       # a terminal node
@@ -43,8 +40,8 @@ module Rley # This module is used as a namespace
       # @param aTerm [TerminalNode]
       def after_terminal(aTerm)
         # Escape all opening and closing square brackets
-        escape_lbrackets = aTerm.token.lexeme.gsub(/\[/, "\\[")
-        escaped = escape_lbrackets.gsub(/\]/, "\\]")
+        escape_lbrackets = aTerm.token.lexeme.gsub(/\[/, '\[')
+        escaped = escape_lbrackets.gsub(/\]/, '\]')
         write(escaped + ']')
       end
 
@@ -65,4 +62,4 @@ module Rley # This module is used as a namespace
   end # module
 end # module
 
-# End of file
+# End of file

data/lib/rley/formatter/debug.rb

@@ -81,7 +81,6 @@ module Rley # This module is used as a namespace
         output_event(__method__, indentation)
       end
 
-
       # Method called by a ParseTreeVisitor to which the formatter subscribed.
       # Notification of a visit event: the visitor completed the visit
       # of the given parse tree

data/lib/rley/formatter/json.rb

@@ -68,7 +68,6 @@ module Rley # This module is used as a namespace
         sibling_flags[-1] = true
       end
 
-
       # Method called by a ParseTreeVisitor to which the formatter subscribed.
       # Notification of a visit event: the visitor completed the visit of
       # the children of a non-terminal node.

data/lib/rley/gfg/grm_flow_graph.rb

@@ -54,12 +54,12 @@ module Rley # This module is used as a namespace
         end
 
         def done?
-          self.to_visit.empty?
+          to_visit.empty?
         end
 
         def next_edge
-          next_one = self.to_visit.shift
-          self.visited << next_one.successor unless next_one.nil?
+          next_one = to_visit.shift
+          visited << next_one.successor unless next_one.nil?
 
           return next_one
         end
@@ -67,9 +67,11 @@ module Rley # This module is used as a namespace
 
       # Walk over all the vertices of the graph that are reachable from a given
       # start vertex. This is a depth-first graph traversal.
-      # @param aStartVertex [StartVertex] the depth-first traversal begins from here
-      # @param visitAction [Proc] block code called when a new graph vertex is found
-      def traverse_df(aStartVertex, &visitAction)
+      # @param aStartVertex [StartVertex] the depth-first traversal begins 
+      #   from here
+      # @param visitAction [Proc] block code called when a new graph vertex 
+      #   is found
+      def traverse_df(aStartVertex, &_visitAction)
         visited = Set.new
         stack = []
         visitee = aStartVertex
@@ -77,7 +79,7 @@ module Rley # This module is used as a namespace
         begin
           first_time = !visited.include?(visitee)
           if first_time
-            visitAction.call(visitee)
+            yield(visitee)
             visited << visitee
           end
 
@@ -104,7 +106,7 @@ module Rley # This module is used as a namespace
           visitee = curr_edge.successor unless curr_edge.nil?
         end until stack.empty?
         # Now process the end vertex matching the initial start vertex
-        visitAction.call(end_vertex_for[aStartVertex.non_terminal])
+        yield(end_vertex_for[aStartVertex.non_terminal])
       end
 
       private
@@ -165,7 +167,6 @@ module Rley # This module is used as a namespace
         add_vertex(new_end_vertex)
       end
 
-
       def add_single_item(aDottedItem)
         new_vertex = ItemVertex.new(aDottedItem)
         add_vertex(new_vertex)
@@ -265,7 +266,6 @@ module Rley # This module is used as a namespace
         ShortcutEdge.new(fromVertex, toVertex)
       end
 
-
       # Retrieve the return edge that matches the given
       # call edge.
       def get_matching_return(aCallEdge)
@@ -277,6 +277,7 @@ module Rley # This module is used as a namespace
 
         # Retrieve the return edge with specified key
         return_edge = end_vertex.edges.find { |edge| edge.key == ret_key }
+        return return_edge
       end
 
       # Mark non-terminal symbols that cannot be derived from the start symbol.

data/lib/rley/parse_forest_visitor.rb

@@ -40,14 +40,12 @@ module Rley # This module is used as a namespace
       pforest.accept(self)
     end
 
-
     # Visit event. The visitor is about to visit the pforest.
     # @param aParseForest [ParseForest] the pforest to visit.
     def start_visit_pforest(aParseForest)
       broadcast(:before_pforest, aParseForest)
     end
 
-
     # Visit event. The visitor is about to visit the given non terminal node.
     # @param aNonTerminalNode [NonTerminalNode] the node to visit.
     def visit_nonterminal(aNonTerminalNode)
@@ -69,7 +67,6 @@ module Rley # This module is used as a namespace
       broadcast(:after_terminal, aTerminalNode)
     end
 
-
     # Visit event. The visitor has completed its visit of the given
     # non-terminal node.
     # @param aNonTerminalNode [NonTerminalNode] the node to visit.

data/lib/rley/parse_tree_visitor.rb

@@ -37,14 +37,12 @@ module Rley # This module is used as a namespace
       ptree.accept(self)
     end
 
-
     # Visit event. The visitor is about to visit the ptree.
     # @param aParseTree [ParseTree] the ptree to visit.
     def start_visit_ptree(aParseTree)
       broadcast(:before_ptree, aParseTree)
     end
 
-
     # Visit event. The visitor is about to visit the given non terminal node.
     # @param aNonTerminalNode [NonTerminalNode] the node to visit.
     def visit_nonterminal(aNonTerminalNode)
@@ -66,7 +64,6 @@ module Rley # This module is used as a namespace
       broadcast(:after_terminal, aTerminalNode)
     end
 
-
     # Visit event. The visitor has completed its visit of the given
     # non-terminal node.
     # @param aNonTerminalNode [NonTerminalNode] the node to visit.

data/lib/rley/parser/error_reason.rb

@@ -16,7 +16,7 @@ module Rley # Module used as a namespace
 
       # Returns the result of invoking reason.to_s.
       def message()
-        return self.to_s
+        return to_s
       end
 
       # Return this reason's class name and message
@@ -68,10 +68,8 @@ module Rley # Module used as a namespace
                    end
         return explain
       end
-
     end # class
 
-
     # This parse error occurs when the current token from the input
     # is unexpected according to the grammar rules.
     class UnexpectedToken < ExpectationNotMet
@@ -86,7 +84,6 @@ module Rley # Module used as a namespace
       end
     end # class
 
-
     # 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    
@@ -103,4 +100,3 @@ module Rley # Module used as a namespace
 end # module
 
 # End of file
-

data/lib/rley/parser/gfg_chart.rb

@@ -12,7 +12,7 @@ module Rley # This module is used as a namespace
       # An array of entry sets (one per input token + 1)
       attr_reader(:sets)
 
-      # @param tokenCount [Fixnum] The number of lexemes in the input to parse.
+      # @param tokenCount [Integer] The number of lexemes in the input to parse.
       def initialize(tokenCount, aGFGraph)
         @sets = Array.new(tokenCount + 1) { |_| ParseEntrySet.new }
         push_entry(aGFGraph.start_vertex, 0, 0, :start_rule)
@@ -41,7 +41,7 @@ module Rley # This module is used as a namespace
       end
 
       # Push a parse entry for the chart entry with given index
-      def push_entry(aVertex, anOrigin, anIndex, aReason)
+      def push_entry(aVertex, anOrigin, anIndex, _reason)
         new_entry = ParseEntry.new(aVertex, anOrigin)
         pushed = self[anIndex].push_entry(new_entry)
 

data/lib/rley/parser/gfg_earley_parser.rb

@@ -21,7 +21,7 @@ module Rley # This module is used as a namespace
       def parse(aTokenSequence)
         result = GFGParsing.new(gf_graph, aTokenSequence)
         last_token_index = aTokenSequence.size
-        if last_token_index == 0 && !grammar.start_symbol.nullable?
+        if last_token_index.zero? && !grammar.start_symbol.nullable?
           return unexpected_empty_input(result)
         end
 
@@ -104,7 +104,6 @@ module Rley # This module is used as a namespace
         aParsing.faulty(NoInput.new)
         return aParsing
       end 
-
     end # class
   end # module
 end # module