sequitur 0.1.24 → 0.1.26

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1ba8348f20a1e800b1c7001090916dbe05159177471452fdcfa8925bc975431
-  data.tar.gz: a8002cab5a1f7ae7b20b347f4a5f79e92a2f979dca1fad2dad83e153f5969d22
+  metadata.gz: 86e5e7a51109f635607be37902ce3edf561b204119005eea6baa0f90d1dc90b8
+  data.tar.gz: 686f7ed1ba3e76ab16f06b891809025afd7b020009b3a67cba7600f4c66c18cc
 SHA512:
-  metadata.gz: 2a116b242f218d0c08740a0432b641f88dbaa7f65dd67b02a5339be208927c835db4965d6e3ede344d7d93a4bbea6d4468692c4b237f1f18a8bbd3f6ffb54037
-  data.tar.gz: 2b7ea3e4acf58cb45ed3c0b7081a35201c2a8aa5285e163e9845fd82f082e7dcfb563a063d566c2561bb81944cefec6a67d0d2203b2080cb12fd73f6ace3c53e
+  metadata.gz: ff134c984fe467059df107491030b84cfd1c73aca32ef78eca7fca90a5f207db06c552dab126e12e81eb97537789b6d24c36cdf79af0e7934fcf42ff17c818b1
+  data.tar.gz: b6c909ca88b6031252c53f11d4e07babae1c0fe0f3b146d50e0aaea55be7befa5a4fdf8ac456c8da76ecac0cfe579f41f939cdb569c605e9da6fb491d5182991

data/CHANGELOG.md

@@ -1,4 +1,10 @@
-## [0.1.24] - 2021-07-01
+## [0.1.25] - 2023-07-10
+- First version using RBS (Ruby Type System): new folder `sig` with `*.rbs` files
+- Yard documentation updated to align with RBS
+- File `appveyor.yml` updated to cover Rubies 2.6, .., 3.1
+- File `Gemfile`: removed dependencies to `simplecov` and `coverall`
+
+## [0.1.24] - 2023-07-01
 - Code restyling to please rubocop 1.53.1
 
 ## [0.1.23] - 2021-09-04

data/Gemfile

@@ -4,8 +4,6 @@ source 'https://rubygems.org'
 # Prevent Bundler to load the dependencies from our .gemspec file
 
 group :development do
-  gem 'coveralls', '>= 0.7.0'
-  gem 'rake', '>= 10.0.0'
-  gem 'rspec', '>= 3.0.0'
-  gem 'simplecov', '>= 0.8.0'
+  gem 'rake', '>= 13.1.0'
+  gem 'rspec', '>= 3.10.0'
 end

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014-2023 Dimitri Geshef
+Copyright (c) 2014-2025 Dimitri Geshef
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -3,9 +3,8 @@ Sequitur
 _Ruby gem implementing the Sequitur algorithm_  
 [Homepage](https://github.com/famished-tiger/Sequitur)  
 
-[![Linux Build Status](https://travis-ci.org/famished-tiger/Sequitur.svg?branch=master)](https://travis-ci.org/famished-tiger/Sequitur)
+
 [![Windows Build status](https://ci.appveyor.com/api/projects/status/nvi1be8mb0494dqw?svg=true)](https://ci.appveyor.com/project/famished-tiger/sequitur)
-[![Coverage Status](https://coveralls.io/repos/famished-tiger/Sequitur/badge.png?branch=master)](https://coveralls.io/r/famished-tiger/Sequitur)
 [![Gem Version](https://badge.fury.io/rb/sequitur.svg)](http://badge.fury.io/rb/sequitur)
 [![Inline docs](http://inch-ci.org/github/famished-tiger/Sequitur.svg?branch=master)](http://inch-ci.org/github/famished-tiger/Sequitur)
 [![Code Climate](https://codeclimate.com/github/famished-tiger/Sequitur.png)](https://codeclimate.com/github/famished-tiger/Sequitur)
@@ -247,4 +246,4 @@ More examples are available in the examples folder.
 
 Copyright
 ---------
-Copyright (c) 2014-2018, Dimitri Geshef. Sequitur is released under the MIT License see [LICENSE.txt](https://github.com/famished-tiger/Sequitur/blob/master/LICENSE.txt) for details.
+Copyright (c) 2014-2025, Dimitri Geshef. Sequitur is released under the MIT License see [LICENSE.txt](https://github.com/famished-tiger/Sequitur/blob/master/LICENSE.txt) for details.

data/appveyor.yml

@@ -2,19 +2,19 @@ version: '{build}'
 max_jobs: 5
 environment:
   matrix:
-  - Ruby_version: 26-x64
-  - Ruby_version: 25-x64
-  - Ruby_version: 24-x64
-  - Ruby_version: 23-x64
-  - Ruby_version: 26
-  - Ruby_version: 25
-  - Ruby_version: 24
-  - Ruby_version: 23
+  - Ruby_version: 31-x64
+  - Ruby_version: 30-x64
+  - Ruby_version: 27-x64
+  - Ruby_version: 31
+  - Ruby_version: 30
+  - Ruby_version: 27
 
+#   - gem update --system --source http://rubygems.org/
 install:
   - set PATH=C:\Ruby%Ruby_version%\bin;%PATH%
-  - gem update --system
-  - gem install bundler
+  - ruby --version
+  - gem install rubygems-update
+  - gem install bundler  
   - bundle install --retry=3 --clean --force
 
 build: off

data/examples/inductive_english.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# Demo of sequitur gem: from a set of sentences, generate a context-free grammar
+
+require 'engtagger'
+require 'sequitur'
+
+# Simple sentences taken from the first lesson of "Learn These Words First".
+# ( https://learnthesewordsfirst.com/  )
+sentences = <<~END_TEXT
+  Tony sees Lisa.
+  Tony sees something.
+  Lisa sees something.
+  Tony sees this thing.
+  Lisa sees the other thing.
+END_TEXT
+
+tagger = EngTagger.new
+pairs = tagger.tag_pairs(sentences)
+tag_sequence = pairs.map(&:last)
+
+# Generate the grammar from the tag sequence
+grammar = Sequitur.build_from(tag_sequence)
+
+# Use a formatter to display the grammar rules on the console output
+formatter = Sequitur::Formatter::BaseText.new($stdout)
+
+# Now render the rules
+formatter.render(grammar.visitor)
+# Rendered output is:
+# start : P1 nnp P2 P2 P4 nn P4 jj nn pp.
+#   P1 : nnp vbz.
+#   P2 : P3 nn.
+#   P3 : pp P1.
+#   P4 : P3 det.

data/lib/sequitur/constants.rb

@@ -3,13 +3,14 @@
 # File: constants.rb
 # Purpose: definition of Sequitur constants.
 
-module Sequitur # Module used as a namespace
+# Module used as a namespace for Sequitur classes
+module Sequitur
   # rubocop:disable Naming/ConstantName
 
-  # The version number of the gem.
-  Version = '0.1.24'
+  # @return [String] The version number of the gem.
+  Version = '0.1.26'
 
-  # Brief description of the gem.
+  # @return [String] Brief description of the gem.
   Description = 'Ruby implementation of the Sequitur algorithm'
 
   # Constant Sequitur::RootDir contains the absolute path of Sequitur's
@@ -18,7 +19,7 @@ module Sequitur # Module used as a namespace
     # The initialisation of constant RootDir is guarded in order
     # to avoid multiple initialisation (not allowed for constants)
 
-    # The start folder of Sequitur.
+    # @return [String] The start folder of Sequitur.
     RootDir = begin
       require 'pathname' # Load Pathname class from standard library
       startdir = Pathname(__FILE__).dirname.parent.parent.expand_path

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,14 +34,14 @@ 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)
       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?
       symbols[0] == symbols[1]
     end

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.
@@ -38,7 +38,8 @@ module Sequitur # Module for classes implementing the Sequitur algorithm
     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
@@ -47,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
@@ -69,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)
 
@@ -80,7 +81,7 @@ 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
       GrammarVisitor.new(self)
     end

data/lib/sequitur/formatter/base_formatter.rb

@@ -17,7 +17,7 @@ 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.is_a?(GrammarVisitor)
                       aGrmOrVisitor

data/lib/sequitur/formatter/base_text.rb

@@ -12,6 +12,7 @@ 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.
@@ -24,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
@@ -34,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
@@ -69,6 +70,7 @@ 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
@@ -77,6 +79,7 @@ module Sequitur
 
       # Generate a name of a given production.
       # @param aProduction [Production]
+      # @return [String]
       def prod_name(aProduction)
         prod_index = prod_lookup[aProduction]
         prod_index.zero? ? 'start' : "P#{prod_index}"

data/lib/sequitur/formatter/debug.rb

@@ -13,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.
@@ -26,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
@@ -35,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
@@ -95,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)
@@ -103,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)
@@ -110,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

@@ -3,14 +3,14 @@
 module Sequitur # Module for classes implementing the Sequitur algorithm
   # 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

data/lib/sequitur/production.rb

@@ -14,13 +14,14 @@ module Sequitur # Module for classes implementing the Sequitur algorithm
   # corresponding RHS.
   # Implementation note: the object id of the production is taken as its LHS.
   class Production
-    # The right-hand side (rhs) consists of a sequence of grammar symbols
+    # @return [Sequitur::SymbolSequence] The right-hand side (rhs)
+    #   consists of a sequence of grammar symbols
     attr_reader(:rhs)
 
-    # The reference count (= how times other productions reference this one)
+    # @return [Integer] The reference count (= how times other productions reference this one)
     attr_reader(:refcount)
 
-    # The sequence of digrams appearing in the RHS
+    # @return [Array<Sequitur::Digram>] The sequence of digrams appearing in the RHS
     attr_reader(:digrams)
 
     # Constructor.
@@ -32,8 +33,8 @@ module Sequitur # Module for classes implementing the Sequitur algorithm
     end
 
     # Identity testing.
-    # @param other [] another production or production reference.
-    # @return true when the receiver and other are the same.
+    # @param other [Production, ProductionRef] another production or production reference.
+    # @return [TrueClass, FalseClass] true when the receiver and other are the same.
     def ==(other)
       return true if object_id == other.object_id
 
@@ -45,17 +46,19 @@ module Sequitur # Module for classes implementing the Sequitur algorithm
     end
 
     # Is the rhs empty?
-    # @ return true if the rhs has no members.
+    # @return [TrueClass, FalseClass] true if the rhs has no members.
     def empty?
       rhs.empty?
     end
 
     # Increment the reference count by one.
+    # @return [Integer]
     def incr_refcount
       @refcount += 1
     end
 
     # Decrement the reference count by one.
+    # @return [Integer]
     def decr_refcount
       raise StandardError, 'Internal error' if @refcount.zero?
 
@@ -63,21 +66,21 @@ module Sequitur # Module for classes implementing the Sequitur algorithm
     end
 
     # Select the references to production appearing in the rhs.
-    # @return [Array of ProductionRef]
+    # @return [Array<ProductionRef>]
     def references
       rhs.references
     end
 
     # Look in the rhs all the references to a production passed a argument.
-    # aProduction [aProduction or ProductionRef] The production to search for.
-    # @return [Array] the array of ProductionRef to the passed production
+    # @param a_prod [Production, ProductionRef] The production to search for.
+    # @return [Array<ProductionRef>]
     def references_of(a_prod)
       real_prod = a_prod.is_a?(ProductionRef) ? a_prod.production : a_prod
       rhs.references_of(real_prod)
     end
 
     # Enumerate the digrams appearing in the right-hand side (rhs)
-    # @return [Array] the list of digrams found in rhs of this production.
+    # @return [Array<Sequitur::Digram>] the list of digrams found in rhs of this production.
     def recalc_digrams
       return [] if rhs.size < 2
 
@@ -87,7 +90,7 @@ module Sequitur # Module for classes implementing the Sequitur algorithm
     end
 
     # Does the rhs have exactly one digram only (= 2 symbols)?
-    # @return [true/false] true when the rhs contains exactly two symbols.
+    # @return [TrueClass, FalseClass] true when the rhs contains exactly two symbols.
     def single_digram?
       rhs.size == 2
     end
@@ -95,7 +98,7 @@ module Sequitur # Module for classes implementing the Sequitur algorithm
     # Detect whether the last digram occurs twice
     # Assumption: when a digram occurs twice in a production then it must occur
     # at the end of the rhs
-    # @return [true/false] true when the digram occurs twice in rhs.
+    # @return [TrueClass, FalseClass] true when the digram occurs twice in rhs.
     def repeated_digram?
       return false if rhs.size < 3
 
@@ -107,7 +110,7 @@ module Sequitur # Module for classes implementing the Sequitur algorithm
     end
 
     # Retrieve the last digram appearing in the RHS (if any).
-    # @return [Digram] last digram in the rhs otherwise nil.
+    # @return [Sequitur::Digram, NilClass] last digram in the rhs otherwise nil.
     def last_digram
       digrams.empty? ? nil : digrams.last
     end
@@ -150,7 +153,7 @@ module Sequitur # Module for classes implementing the Sequitur algorithm
     # Find all the positions where the digram occurs in the rhs
     # @param symb1 [Object] first symbol of the digram
     # @param symb2 [Object] second symbol of the digram
-    # @return [Array] the list of indices where the digram occurs in rhs.
+    # @return [Array<Integer>] the list of indices where the digram occurs in rhs.
     # @example
     #   # Given the production p : a b c a b a b d
     #   #Then ...
@@ -176,7 +179,7 @@ module Sequitur # Module for classes implementing the Sequitur algorithm
     # Given that the production P passed as argument has exactly 2 symbols
     #   in its rhs s1 s2, substitute in the rhs of self all occurrences of
     #   s1 s2 by a reference to P.
-    # @param another [Production or ProductionRef] a production that
+    # @param another [Production, ProductionRef] a production that
     #   consists exactly of one digram (= 2 symbols).
     def reduce_step(another)
       (symb1, symb2) = another.rhs.symbols
@@ -190,7 +193,7 @@ module Sequitur # Module for classes implementing the Sequitur algorithm
 
     # Replace every occurrence of 'another' production in self.rhs by
     #   the symbols in the rhs of 'another'.
-    # @param another [Production or ProductionRef] a production that
+    # @param another [Production, ProductionRef] a production that
     #   consists exactly of one digram (= 2 symbols).
     # @example Synopsis
     # # Given the production p_A : a p_B b p_B c
@@ -211,7 +214,7 @@ module Sequitur # Module for classes implementing the Sequitur algorithm
     end
 
     # Part of the 'visitee' role in Visitor design pattern.
-    # @param aVisitor[GrammarVisitor]
+    # @param aVisitor[Sequitur::GrammarVisitor]
     def accept(aVisitor)
       aVisitor.start_visit_production(self)
       rhs.accept(aVisitor)

data/lib/sequitur/production_ref.rb

@@ -17,11 +17,11 @@ module Sequitur # Module for classes implementing the Sequitur algorithm
   #   # ... Production reference count is updated...
   #   puts prod.refcount # outputs 1
   class ProductionRef
-    # Link to the production to reference.
+    # @return [Sequitur::Production] Link to the production to reference.
     attr_reader(:production)
 
     # Constructor
-    # @param target [Production or ProductionRef]
+    # @param target [Production, ProductionRef]
     #   The production that is being referenced.
     def initialize(target)
       bind_to(target)
@@ -51,8 +51,8 @@ module Sequitur # Module for classes implementing the Sequitur algorithm
     #   A production ref is equal to another one when its
     #   refers to the same production or when it is compared to
     #   the production it refers to.
-    # @param other [ProductionRef]
-    # @return [true / false]
+    # @param other [Production, ProductionRef]
+    # @return [TrueClass, FalseClass]
     def ==(other)
       return true if object_id == other.object_id
 
@@ -67,7 +67,7 @@ module Sequitur # Module for classes implementing the Sequitur algorithm
     #   A reference has no identity on its own,
     #   the method returns the hash value of the
     #   referenced production
-    # @return [Fixnum] the hash value
+    # @return [Integer] the hash value
     def hash
       raise StandardError, 'Nil production' if production.nil?
 
@@ -75,7 +75,7 @@ module Sequitur # Module for classes implementing the Sequitur algorithm
     end
 
     # Make this reference point to the given production.
-    # @param aProduction [Production or ProductionRef] the production
+    # @param aProduction [Production, ProductionRef] the production
     #   to refer to
     def bind_to(aProduction)
       return if aProduction == @production
@@ -90,20 +90,21 @@ module Sequitur # Module for classes implementing the Sequitur algorithm
     end
 
     # Clear the reference to the target production.
+    # return [NilClass]
     def unbind
       production.decr_refcount
       @production = nil
     end
 
     # Check that the this object doesn't refer to any production.
-    # @return [true / false] true when this object doesn't
+    # @return [TrueClass, FalseClass] true when this object doesn't
     #   point to a production.
     def unbound?
       production.nil?
     end
 
     # Part of the 'visitee' role in the Visitor design pattern.
-    # @param aVisitor [GrammarVisitor] the visitor
+    # @param aVisitor [Sequitur::GrammarVisitor] the visitor
     def accept(aVisitor)
       aVisitor.visit_prod_ref(self)
     end

data/lib/sequitur/symbol_sequence.rb

@@ -4,7 +4,7 @@ module Sequitur # Module for classes implementing the Sequitur algorithm
   # Represents a sequence (concatenation) of grammar symbols
   # as they appear in rhs of productions
   class SymbolSequence
-    # The sequence of symbols itself
+    # @return [Array] The sequence of symbols itself
     attr_reader(:symbols)
 
     # Create an empty sequence
@@ -59,9 +59,9 @@ module Sequitur # Module for classes implementing the Sequitur algorithm
     end
 
     # Equality testing.
-    # @param other [SymbolSequence or Array] the other other sequence
+    # @param other [SymbolSequence, Array] the other other sequence
     #   to compare to.
-    # @true when an item from self equals the corresponding
+    # @return [TrueClass, FalseClass] true when an item from self equals the corresponding
     #   item from 'other'
     def ==(other)
       true if object_id == other.object_id
@@ -119,9 +119,9 @@ module Sequitur # Module for classes implementing the Sequitur algorithm
     # Given that the production P passed as argument has exactly 2 symbols
     #   in its rhs s1 s2, substitute in the rhs of self all occurrences of
     #   s1 s2 by a reference to P.
-    # @param index [Fixnum] the position of a two symbol sequence to be replaced
+    # @param index [Integer] the position of a two symbol sequence to be replaced
     #   by the production
-    # @param aProduction [Production or ProductionRef] a production that
+    # @param aProduction [Production, ProductionRef] a production that
     #   consists exactly of one digram (= 2 symbols).
     def reduce_step(index, aProduction)
       if symbols[index].is_a?(ProductionRef)
@@ -141,7 +141,7 @@ module Sequitur # Module for classes implementing the Sequitur algorithm
     end
 
     # Remove the element at given position
-    # @param position [Fixnum] a zero-based index.
+    # @param position [Integer] a zero-based index.
     def delete_at(position)
       invalidate_refs if symbols[position].is_a?(ProductionRef)
       symbols.delete_at(position)