rley 0.7.03 → 0.7.08

data/examples/general/left.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Purpose: define a grammar with left-recursive rule
 require 'rley' # Load Rley library
 
@@ -6,10 +8,10 @@ builder = Rley::Syntax::GrammarBuilder.new do
   # The grammar defines a language that consists in a sequence
   # of 0 or more dots...
   add_terminals('DOT')
-  
+
   # Grammar with left recursive rule.
   rule 'l_dots' => []
-  rule 'l_dots' => %w[l_dots DOT]  
+  rule 'l_dots' => %w[l_dots DOT]
 end
 
 # And now, let's build the grammar...

data/examples/general/right.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Purpose: define a grammar with right-recursive rule
 require 'rley' # Load Rley library
 
@@ -6,10 +8,10 @@ builder = Rley::Syntax::GrammarBuilder.new do
   # The grammar defines a language that consists in a sequence
   # of 0 or more dots...
   add_terminals('DOT')
-  
+
   # Grammar with right recursive rule.
   rule 'r_dots' => []
-  rule 'r_dots' => %w[DOT r_dots]  
+  rule 'r_dots' => %w[DOT r_dots]
 end
 
 # And now, let's build the grammar...

data/lib/rley.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # File: rley.rb
 # This file acts as a jumping-off point for loading dependencies expected
 # for a Rley client.

data/lib/rley/base/base_parser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../syntax/grammar'
 require_relative 'grm_items_builder' # Use mix-in module
 

data/lib/rley/base/dotted_item.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rley # This module is used as a namespace
   module Base # This module is used as a namespace
     # A dotted item is a parse state for a given production/grammar rule
@@ -17,14 +19,14 @@ module Rley # This module is used as a namespace
     class DottedItem
       # Production rule
       # @return [Syntax::Production]
-      attr_reader(:production)
+      attr_reader :production
 
       # Index of the next symbol (from the rhs) after the 'dot'.
       # If the dot is at the end of the rhs (i.e.) there is no next
       # symbol, then the position takes the value -1.
       # It the rhs is empty, then the position is -2
       # @return [Integer]
-      attr_reader(:position)
+      attr_reader :position
 
       # @param aProduction [Syntax::Production]
       # @param aPosition [Integer] Position of the dot in rhs of production.
@@ -35,23 +37,23 @@ module Rley # This module is used as a namespace
 
       # Return a String representation of the dotted item.
       # @return [String]
-      def to_s()
+      def to_s
         prefix = "#{production.lhs} => "
         text_values = production.rhs.map(&:to_s)
-        if position < 0
+        if position.negative?
           text_values << '.'
         else
           text_values.insert(position, '.')
         end
         suffix = text_values.join(' ')
 
-        return prefix + suffix
+        prefix + suffix
       end
 
       # Return true if the dot position is at the start of the rhs.
       # @return [Boolean]
-      def at_start?()
-        return position.zero? || position == -2
+      def at_start?
+        position.zero? || position == -2
       end
 
       # An item with the dot at the beginning is called
@@ -60,51 +62,48 @@ module Rley # This module is used as a namespace
 
       # A dotted item is called a reduce item if the dot is at the end.
       # @return [Boolean]
-      def reduce_item?()
-        return position < 0 # Either -1 or -2
+      def reduce_item?
+        position.negative? # Either -1 or -2
       end
 
       # The non-terminal symbol that is on the left-side of the production
       # @return [Syntax::NonTerminal]
-      def lhs()
-        return production.lhs
+      def lhs
+        production.lhs
       end
 
       # Return the symbol before the dot.
       # nil is returned if the dot is at the start of the rhs
       # @return [Syntax::GrmSymbol, NilClass]
-      def prev_symbol()
+      def prev_symbol
         before_position = prev_position
-        result = if before_position.nil?
-                   nil
-                 else
-                   production.rhs[before_position]
-                 end
-
-        return result
+        before_position.nil? ? nil : production.rhs[before_position]
       end
 
       # Return the symbol after the dot.
       # nil is returned if the dot is at the end
       # @return [Syntax::GrmSymbol, NilClass]
-      def next_symbol()
-        return position < 0 ? nil : production.rhs[position]
+      def next_symbol
+        position.negative? ? nil : production.rhs[position]
       end
 
       # Calculate the position of the dot if were moved by
       # one step on the left.
       # @return [Integer]
-      def prev_position()
-        case position
-          when -2, 0
-            result = nil
-          when -1
-            result = production.rhs.size == 1 ? 0 : production.rhs.size - 1
-          else
-            result = position - 1
+      def prev_position
+        unless @k_prev_position
+          case position
+            when -2, 0
+              result = nil
+            when -1
+              result = production.rhs.size == 1 ? 0 : production.rhs.size - 1
+            else
+              result = position - 1
+          end
+          @k_prev_position = [result]
         end
 
-        return result
+        @k_prev_position[0]
       end
 
       # Return true if this dotted item has a dot one place
@@ -117,7 +116,7 @@ module Rley # This module is used as a namespace
         to_the_left = prev_position
         return false if to_the_left.nil?
 
-        return to_the_left == another.position
+        to_the_left == another.position
       end
 
 
@@ -126,19 +125,17 @@ module Rley # This module is used as a namespace
       # Return the given position after its validation.
       def valid_position(aPosition)
         rhs_size = production.rhs.size
-        if aPosition < 0 || aPosition > rhs_size
+        if aPosition.negative? || aPosition > rhs_size
           raise StandardError, 'Out of bound index'
         end
 
-        index = if rhs_size.zero?
-                  -2 # Minus 2 at start/end of empty production
-                elsif aPosition == rhs_size
-                  -1 # Minus 1 at end of non-empty production
-                else
-                  aPosition
-                end
-
-        return index
+        if rhs_size.zero?
+          -2 # Minus 2 at start/end of empty production
+        elsif aPosition == rhs_size
+          -1 # Minus 1 at end of non-empty production
+        else
+          aPosition
+        end
       end
     end # class
   end # module

data/lib/rley/base/grm_items_builder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'dotted_item'
 
 module Rley # This module is used as a namespace

data/lib/rley/constants.rb

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 # File: constants.rb
 # Purpose: definition of Rley constants.
 
 module Rley # Module used as a namespace
   # The version number of the gem.
-  Version = '0.7.03'.freeze
+  Version = '0.7.08'
 
   # Brief description of the gem.
-  Description = "Ruby implementation of the Earley's parsing algorithm".freeze
+  Description = "Ruby implementation of 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.
@@ -18,7 +20,7 @@ module Rley # Module used as a namespace
     RootDir = begin
       require 'pathname' # Load Pathname class from standard library
       startdir = Pathname(__FILE__).dirname.parent.parent.expand_path
-      startdir.to_s + '/' # Append trailing slash character to it
+      "#{startdir}/" # Append trailing slash character to it
     end
   end
 end # module

data/lib/rley/engine.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative './syntax/grammar_builder'
 require_relative './parser/gfg_earley_parser'
 require_relative './parse_tree_visitor'
@@ -13,16 +15,14 @@ module Rley # This module is used as a namespace
     #   @return [Symbol] allowed values are: :parse_tree, :parse_forest
     :parse_repr,
     :repr_builder,
-    :diagnose
-  ) do
-
-    # Constructor with default initialization.
-    def initialize()
-      super()
-      self.parse_repr = :parse_tree
-      self.repr_builder = :default
-      self.diagnose = false
-    end
+    :diagnose) do
+      # Constructor with default initialization.
+      def initialize
+        super()
+        self.parse_repr = :parse_tree
+        self.repr_builder = :default
+        self.diagnose = false
+      end
   end
 
   # Implementation of the GoF Facade design pattern.
@@ -42,7 +42,7 @@ module Rley # This module is used as a namespace
     #   Engine.new do |config|
     #     config.parse_repr = :parse_forest
     #   end
-    def initialize()
+    def initialize
       @configuration = EngineConfig.new
       yield configuration if block_given?
     end
@@ -90,7 +90,7 @@ module Rley # This module is used as a namespace
       result = parser.parse(tokens)
       result.tidy_up!
 
-      return result
+      result
     end
 
     # Convert raw parse result into a more convenient representation
@@ -98,14 +98,12 @@ module Rley # This module is used as a namespace
     # @param aRawParse [Parser::GFGParsing]
     # @return [Rley::PTree::ParseTree, Rley::SPPF::ParseForest]
     def convert(aRawParse)
-      result = case configuration.parse_repr
-                 when :parse_tree
-                   to_ptree(aRawParse)
-                 when :parse_forest
-                   to_pforest(aRawParse)
-               end
-
-      return result
+      case configuration.parse_repr
+        when :parse_tree
+          to_ptree(aRawParse)
+        when :parse_forest
+          to_pforest(aRawParse)
+      end
     end
 
     # Convert raw parse result into a parse tree representation
@@ -119,7 +117,7 @@ module Rley # This module is used as a namespace
         result = factory.create(configuration.repr_builder)
       end
 
-      return result
+      result
     end
 
     # Convert raw parse result into a parse forest representation
@@ -133,7 +131,7 @@ module Rley # This module is used as a namespace
         result = factory.create(configuration.repr_builder)
       end
 
-      return result
+      result
     end
 
     # Build a visitor for the given parse tree
@@ -147,13 +145,13 @@ module Rley # This module is used as a namespace
     # @param aPForest [SPPF::ParseForest]
     # @return [ParseForestVisitor]
     def pforest_visitor(aPForest)
-      return ParseForestVisitor.new(aPForest)
+      ParseForestVisitor.new(aPForest)
     end
 
     protected
 
     def build_parser(aGrammar)
-      return Parser::GFGEarleyParser.new(aGrammar)
+      Parser::GFGEarleyParser.new(aGrammar)
     end
   end # class
 end # module

data/lib/rley/formatter/asciitree.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'base_formatter'
 
 
@@ -13,7 +15,7 @@ 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 
+      # @return [String] The character pattern used for rendering
       # a parent - child nesting
       attr_reader(:nesting_prefix)
 
@@ -97,10 +99,10 @@ module Rley # This module is used as a namespace
       end
 
       # 'root', 'first', 'first_and_last', 'last', 'other'
-      def path_prefix()
+      def path_prefix
         return '' if ranks.empty?
 
-        prefix = ''
+        prefix = +''
         @ranks.each_with_index do |rank, i|
           next if i.zero?
 
@@ -114,7 +116,7 @@ module Rley # This module is used as a namespace
         end
 
         prefix << nesting_prefix
-        return prefix
+        prefix
       end
 
       def emit(aNode, aSuffix = '')

data/lib/rley/formatter/base_formatter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rley # This module is used as a namespace
   # Namespace dedicated to parse tree formatters.
   module Formatter

data/lib/rley/formatter/bracket_notation.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'base_formatter'
 
 
@@ -11,13 +13,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.
-      def initialize(anIO)
-        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
@@ -42,7 +37,7 @@ module Rley # This module is used as a namespace
         # Escape all opening and closing square brackets
         escape_lbrackets = aTerm.token.lexeme.gsub(/\[/, '\[')
         escaped = escape_lbrackets.gsub(/\]/, '\]')
-        write(escaped + ']')
+        write("#{escaped}]")
       end
 
       # Method called by a ParseTreeVisitor to which the formatter subscribed.

data/lib/rley/formatter/debug.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'base_formatter'
 
 
@@ -17,17 +19,17 @@ module Rley # This module is used as a namespace
         super(anIO)
         @indentation = 0
       end
-      
+
       # Indicates that this formatter accepts all visit events
       # provided their names start with 'before_' or 'after_'
       # @return [Boolean]
       def accept_all
         return true
       end
-      
+
       # Ghost method pattern.
-      def method_missing(mth, *args)    
-        mth_name = mth.to_s         
+      def method_missing(mth, *args)
+        mth_name = mth.to_s
         case mth_name
           when /^before_/
             output_event(mth_name, indentation)
@@ -42,11 +44,11 @@ module Rley # This module is used as a namespace
 
       private
 
-      def indent()
+      def indent
         @indentation += 1
       end
 
-      def dedent()
+      def dedent
         @indentation -= 1
       end