sequitur 0.1.23 → 0.1.25

data/lib/sequitur/digram.rb

@@ -9,22 +9,22 @@ module Sequitur # Module for classes implementing the Sequitur algorithm
   # can be a terminal or not.
   class Digram
     # The sequence of two consecutive grammar symbols.
-    #   The two symbols should respond to the :hash message.
+    # @return [Array<String, Symbol>] The two symbols should respond to the :hash message.
     attr_reader(:symbols)
 
-    # An unique hash key of the digram
+    # @return [String] An unique hash key of the digram
     attr_reader(:key)
 
-    # The production in which the digram occurs
+    # @return [Sequitur::Production] The production in which the digram occurs
     attr_reader(:production)
 
     # Constructor.
     # A digram represents a sequence of two symbols
     # (that appears in a rhs of a production).
     # Terminal symbols must respond to the :hash message.
-    # @param symbol1 [StringOrSymbol] First element of the digram
-    # @param symbol2 [StringOrSymbol] Second element of the digram
-    # @param aProduction [Production] Production in which the RHS
+    # @param symbol1 [String, Symbol] First element of the digram
+    # @param symbol2 [String, Symbol] Second element of the digram
+    # @param aProduction [Sequitur::Production] Production in which the RHS
     #   the sequence symbol1 symbol2 appears.
     def initialize(symbol1, symbol2, aProduction)
       @symbols = [symbol1, symbol2]
@@ -34,16 +34,16 @@ module Sequitur # Module for classes implementing the Sequitur algorithm
 
     # Equality testing.
     #   true iff keys of both digrams are equal, false otherwise
-    # @param other [Digram] another to compare with
-    # @return [true/false]
+    # @param other [Sequitur::Digram] another to compare with
+    # @return [TrueClass, FalseClass]
     def ==(other)
-      return key == other.key
+      key == other.key
     end
 
     # Does the digram consists of twice the same symbols?
-    # @return [true/false] true when symbols.first == symbols.last
+    # @return [TrueClass, FalseClass] true when symbols.first == symbols.last
     def repeating?
-      return symbols[0] == symbols[1]
+      symbols[0] == symbols[1]
     end
   end # class
 end # module

data/lib/sequitur/dynamic_grammar.rb

@@ -13,13 +13,13 @@ module Sequitur # Module for classes implementing the Sequitur algorithm
   #   -terminal symbols (i.e. String, Ruby Symbol,...)
   #   -non-terminal symbols (i.e. ProductionRef)
   class DynamicGrammar
-    # Link to the start production.
+    # @return [Sequitur::Production] Link to the start production.
     attr_reader(:start)
 
-    # The set of production rules of the grammar
+    # @return [Array<Sequitur::Production>] The set of production rules of the grammar
     attr_reader(:productions)
 
-    # nodoc Trace the execution of the algorithm.
+    # @return [TrueClass, FalseClass] Trace the execution of the algorithm.
     attr_accessor(:trace)
 
     # Constructor.
@@ -34,12 +34,12 @@ module Sequitur # Module for classes implementing the Sequitur algorithm
     # Each production rule is emitted per line.
     # @return [String]
     def to_string
-      rule_text = productions.map(&:to_string).join("\n")
-      return rule_text
+      productions.map(&:to_string).join("\n")
     end
 
     # Add a given production to the grammar.
-    # @param aProduction [Production]
+    # @param aProduction [Sequitur::Production]
+    # @return [Array<Sequitur::Production>]
     def add_production(aProduction)
       # TODO: remove output
       puts "Adding #{aProduction.object_id}" if trace
@@ -48,8 +48,8 @@ module Sequitur # Module for classes implementing the Sequitur algorithm
     end
 
     # Remove a production with given index from the grammar
-    # @param anIndex [Fixnum]
-    # @return [Production] the production removed from the grammar.
+    # @param anIndex [Integer]
+    # @return [Sequitur::Production] the production removed from the grammar.
     def remove_production(anIndex)
       puts "Before production removal #{productions[anIndex].object_id}" if trace
       puts to_string if trace
@@ -58,7 +58,7 @@ module Sequitur # Module for classes implementing the Sequitur algorithm
       puts("Removed: #{prod.to_string}") if trace
       prod.clear_rhs
 
-      return prod
+      prod
     end
 
     # Add the given token to the grammar.
@@ -70,7 +70,7 @@ module Sequitur # Module for classes implementing the Sequitur algorithm
 
     # Part of the 'visitee' role in the Visitor design pattern.
     #   A visitee is expected to accept the visit from a visitor object
-    # @param aVisitor [GrammarVisitor] the visitor object
+    # @param aVisitor [Sequitur::GrammarVisitor] the visitor object
     def accept(aVisitor)
       aVisitor.start_visit_grammar(self)
 
@@ -81,9 +81,9 @@ module Sequitur # Module for classes implementing the Sequitur algorithm
     end
 
     # Factory method. Returns a visitor for this grammar.
-    # @return [GrammarVisitor]
+    # @return [Sequitur::GrammarVisitor]
     def visitor
-      return GrammarVisitor.new(self)
+      GrammarVisitor.new(self)
     end
 
     protected

data/lib/sequitur/formatter/base_formatter.rb

@@ -17,9 +17,9 @@ module Sequitur
 
       # Given a grammar or a grammar visitor, perform the visit
       # and render the visit events in the output stream.
-      # @param aGrmOrVisitor [DynamicGrammar or GrammarVisitor]
+      # @param aGrmOrVisitor [DynamicGrammar, GrammarVisitor]
       def render(aGrmOrVisitor)
-        a_visitor = if aGrmOrVisitor.kind_of?(GrammarVisitor)
+        a_visitor = if aGrmOrVisitor.is_a?(GrammarVisitor)
                       aGrmOrVisitor
                     else
                       aGrmOrVisitor.visitor

data/lib/sequitur/formatter/base_text.rb

@@ -12,6 +12,9 @@ module Sequitur
     #   # Render the grammar (through a visitor)
     #   formatter.run(some_grammar.visitor)
     class BaseText < BaseFormatter
+      # @return [Hash{Production => Integer}]
+      attr_reader :prod_lookup
+
       # Constructor.
       # @param anIO [IO] The output stream to which the rendered grammar
       # is written.
@@ -22,7 +25,7 @@ module Sequitur
 
       # Method called by a GrammarVisitor to which the formatter subscribed.
       # Notification of a visit event: the visitor is about to visit a grammar
-      # @param aGrammar [DynamicGrammar-like object]
+      # @param aGrammar [DynamicGrammar]
       def before_grammar(aGrammar)
         aGrammar.productions.each_with_index do |a_prod, index|
           prod_lookup[a_prod] = index
@@ -32,7 +35,7 @@ module Sequitur
       # Method called by a GrammarVisitor to which the formatter subscribed.
       # Notification of a visit event: the visitor is about to visit
       # a production
-      # @param aProduction [aProduction]
+      # @param aProduction [Production]
       def before_production(aProduction)
         p_name = prod_name(aProduction)
         output.print p_name
@@ -67,23 +70,19 @@ module Sequitur
       # Method called by a GrammarVisitor to which the formatter subscribed.
       # Notification of a visit event: the visitor complete the visit
       # of a production
+      # @param _ [Production]
       def after_production(_)
         output.print ".\n"
       end
 
       private
 
-      # Read accessor of the production lookup
-      def prod_lookup
-        return @prod_lookup
-      end
-
       # Generate a name of a given production.
       # @param aProduction [Production]
+      # @return [String]
       def prod_name(aProduction)
         prod_index = prod_lookup[aProduction]
-        name = prod_index.zero? ? 'start' : "P#{prod_index}"
-        return name
+        prod_index.zero? ? 'start' : "P#{prod_index}"
       end
     end # class
   end # module

data/lib/sequitur/formatter/debug.rb

@@ -2,7 +2,6 @@
 
 require_relative 'base_formatter'
 
-
 module Sequitur
   module Formatter
     # A formatter class that can render the notification events
@@ -14,7 +13,7 @@ module Sequitur
     #   # Render the visit notifications
     #   formatter.run(some_grammar.visitor)
     class Debug < BaseFormatter
-      # Current indentation level
+      # @return [Integer] Current indentation level
       attr_accessor(:indentation)
 
       # Constructor.
@@ -27,7 +26,7 @@ module Sequitur
 
       # Method called by a GrammarVisitor to which the formatter subscribed.
       # Notification of a visit event: the visitor is about to visit a grammar
-      # @param _ [DynamicGrammar-like object]
+      # @param _ [DynamicGrammar]
       def before_grammar(_)
         output_event(__method__, indentation)
         indent
@@ -36,7 +35,7 @@ module Sequitur
       # Method called by a GrammarVisitor to which the formatter subscribed.
       # Notification of a visit event: the visitor is about to visit
       # a production
-      # @param _ [aProduction]
+      # @param _ [Production]
       def before_production(_)
         output_event(__method__, indentation)
         indent
@@ -96,6 +95,7 @@ module Sequitur
       # Method called by a GrammarVisitor to which the formatter subscribed.
       # Notification of a visit event: the visitor completed the visit
       # of a production
+      # @param _ [Production]
       def after_production(_)
         dedent
         output_event(__method__, indentation)
@@ -104,6 +104,7 @@ module Sequitur
       # Method called by a GrammarVisitor to which the formatter subscribed.
       # Notification of a visit event: the visitor completed the visit
       # of a grammar
+      # @param _ [DynamicGrammar]
       def after_grammar(_)
         dedent
         output_event(__method__, indentation)
@@ -111,14 +112,19 @@ module Sequitur
 
       private
 
+      # @return [Integer]
       def indent
         @indentation += 1
       end
 
+      # @return [Integer]
       def dedent
         @indentation -= 1
       end
 
+      # @param anEvent [Symbol]
+      # @param indentationLevel [Integer]
+      # @return [NilClass]
       def output_event(anEvent, indentationLevel)
         output.puts "#{' ' * 2 * indentationLevel}#{anEvent}"
       end

data/lib/sequitur/grammar_visitor.rb

@@ -1,16 +1,16 @@
 # frozen_string_literal: true
 
 module Sequitur # Module for classes implementing the Sequitur algorithm
-# A visitor class dedicated in the visit of Grammar.
+  # A visitor class dedicated in the visit of Grammar.
   class GrammarVisitor
-    # Link to the grammar to visit
+    # @return [Sequitur::DynamicGrammar] Link to the grammar to visit
     attr_reader(:grammar)
 
-    # List of objects that subscribed to the visit event notification.
+    # @return [Object] List of objects that subscribed to the visit event notification.
     attr_reader(:subscribers)
 
     # Build a visitor for the given grammar.
-    # @param aGrammar [DynamicGrammar-like] the grammar to visit.
+    # @param aGrammar [DynamicGrammar] the grammar to visit.
     def initialize(aGrammar)
       @grammar = aGrammar
       @subscribers = []
@@ -35,13 +35,13 @@ module Sequitur # Module for classes implementing the Sequitur algorithm
     end
 
     # Visit event. The visitor is about to visit the grammar.
-    # @param aGrammar [DynamicGrammar-like] the grammar to visit.
+    # @param aGrammar [DynamicGrammar] the grammar to visit.
     def start_visit_grammar(aGrammar)
       broadcast(:before_grammar, aGrammar)
     end
 
     # Visit event. The visitor is about to visit the given production.
-    # @param aProduction [Production] the production to visit.
+    # @param aProduction [Sequitur::Production] the production to visit.
     def start_visit_production(aProduction)
       broadcast(:before_production, aProduction)
     end
@@ -82,7 +82,7 @@ module Sequitur # Module for classes implementing the Sequitur algorithm
     end
 
     # Visit event. The visitor has completed the visit of the grammar.
-    # @param aGrammar [DynamicGrammar-like] the grammar to visit.
+    # @param aGrammar [DynamicGrammar] the grammar to visit.
     def end_visit_grammar(aGrammar)
       broadcast(:after_grammar, aGrammar)
     end