sequitur 0.1.22 → 0.1.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8120ed261178fac280e46bcd3cc35edf3717603031738349f5177114b9fe8bc0
-  data.tar.gz: f799bff2dfaa09c0649e6416a789ab684e226e6eb1ccba974db8670932174050
+  metadata.gz: a1ba8348f20a1e800b1c7001090916dbe05159177471452fdcfa8925bc975431
+  data.tar.gz: a8002cab5a1f7ae7b20b347f4a5f79e92a2f979dca1fad2dad83e153f5969d22
 SHA512:
-  metadata.gz: ec4f16080571ec66e2256898b0f414815d430484ef5221d53e99acf8982da870ddb4a459158005c6f52107ccf7ef52af0e55cdd8a2b4b9982ff6066e189651b0
-  data.tar.gz: 95a95f2f8b5812e3e859b94909432d25f629682b1afa6aed8a6c17439d4e57b3d8abd055f3be3f4e4008a7927de22ee2201174f3ee602fd3c680623b7261c554
+  metadata.gz: 2a116b242f218d0c08740a0432b641f88dbaa7f65dd67b02a5339be208927c835db4965d6e3ede344d7d93a4bbea6d4468692c4b237f1f18a8bbd3f6ffb54037
+  data.tar.gz: 2b7ea3e4acf58cb45ed3c0b7081a35201c2a8aa5285e163e9845fd82f082e7dcfb563a063d566c2561bb81944cefec6a67d0d2203b2080cb12fd73f6ace3c53e

data/.rubocop.yml

@@ -1,199 +1,30 @@
 AllCops:
   Exclude:
-    - 'exp/**/*'
     - 'lab/**/*'
-
-Layout/CaseIndentation:
-  Enabled: false
-  
-Layout/ClosingHeredocIndentation:  
-  Enabled: false
-
-Layout/CommentIndentation:
-  Enabled: false
-
-Layout/ElseAlignment:
-  Enabled: false
-
-Layout/EmptyLines:
-  Enabled: false
-  
-Layout/EndAlignment:
-  Enabled: false
-
+    
 Layout/EndOfLine:
-  Enabled: true
-  EnforcedStyle: lf
-
-Layout/IndentationWidth:
-  Enabled: false
-
-Layout/IndentationConsistency:
-  Enabled: true
-  
-Layout/IndentHeredoc:
-  Enabled: false
-  
-Layout/MultilineHashBraceLayout:
-  Enabled: true
-
-Layout/SpaceAroundOperators:
-  Enabled: true
-
-Layout/SpaceInsideParens:
-  Enabled: true
-  
-Layout/Tab:
-  Enabled: true
-  
-Layout/TrailingBlankLines:
-  Enabled: true
-
-Layout/TrailingWhitespace:
-  Enabled: true
-
-Lint/Loop:
-  Enabled: true
-
-Lint/RescueException:
-  Enabled: true
-
-Lint/UnusedMethodArgument:
-  Enabled: true
-
-Lint/UselessAccessModifier:
-  Enabled: true
-
-Lint/Void:
-  Enabled: false
-
-Lint/UselessAssignment:
-  Enabled: true
+  Enabled: false # Make source portable!
 
 Metrics/AbcSize:
-  Enabled: false
-
-Metrics/BlockLength:
-  Enabled: true
-  Max: 350
+  Max: 22 
 
 Metrics/ClassLength:
-  Enabled: true
-  Max: 350
-
+  Max: 150
+  
 Metrics/CyclomaticComplexity:
-  Enabled: false
-
-Metrics/LineLength:
-  Enabled: false
-  Max: 90
+  Max: 10   
 
 Metrics/MethodLength:
-  Enabled: true
-  Max: 40
-
-Metrics/ModuleLength:
-  Enabled: true
-  Max: 500
-
+  Max: 50
+  
 Metrics/PerceivedComplexity:
-  Enabled: false
+  Max: 10  
 
-Naming/ConstantName:
+Naming/MethodParameterName:
   Enabled: false
-
-Naming/ClassAndModuleCamelCase:
-  Enabled: false
-  
-Naming/UncommunicativeBlockParamName:
-  Enabled: true
   
-Naming/UncommunicativeMethodParamName:
-  Enabled: false
-
 Naming/VariableName:
   Enabled: false
 
-Style/Alias:
-  Enabled: true
-
-Layout/AlignHash:
-  Enabled: false
-
-Style/AsciiComments:
-  Enabled: false
-
-Style/BarePercentLiterals:
-  Enabled: false
-
-Style/BlockComments:
-  Enabled: false
-
-Style/CharacterLiteral:
-  Enabled: false
-
-Style/ClassCheck:
-  Enabled: false
-
-Style/ClassVars:
-  Enabled: false
-
-Style/ColonMethodCall:
-  Enabled: false
-
-Style/CommentAnnotation:
-  Enabled: false
-
 Style/CommentedKeyword:
-  Enabled: false
-
-Style/ConditionalAssignment:
-  Enabled: false
-
-Style/DefWithParentheses:
-  Enabled: true
-
-Style/Documentation:
-  Enabled: false
-
-Style/ExpandPathArguments:
-  Enabled: false
-
-Style/GuardClause:
-  Enabled: false
-
-Style/IfUnlessModifier:
-  Enabled: false
-
-Style/InverseMethods:
-  Enabled: true
-
-Style/Next:
-  Enabled: false
-
-Style/RaiseArgs:
-  Enabled: true
-
-Style/RedundantReturn:
-  Enabled: false
-  
-Style/RedundantSelf:
-  Enabled: true
-
-Style/RegexpLiteral:
-  Enabled: false
-
-Style/PercentLiteralDelimiters:
-  Enabled: false
-  
-Style/StderrPuts:
-  Enabled: false  
-
-Style/StringLiterals:
-  Enabled: true
-
-Style/TernaryParentheses:
-  Enabled: false
-  
-Style/UnlessElse:
-  Enabled: false
+  Enabled: false  

data/CHANGELOG.md

@@ -1,5 +1,15 @@
+## [0.1.24] - 2021-07-01
+- Code restyling to please rubocop 1.53.1
+
+## [0.1.23] - 2021-09-04
+- Remove dependencies towards `coverall`, `simplecov`  
+- Code restyling to please rubocop 1.19.1
+
+* [CHANGE] File 'sequitur.gemspec' Remove dependencies towards `coverall`, `simplecov` 
+* [CHANGE] File 'sequitur.gemspec' Ruby version must be 2.5+
+
 ## [0.1.22] - 2019-08-18
-- Code refactoring to use string frozen magic comments (as a consequence, srl_ruby runs only on Rubies 2.3 or newer).  
+- Code refactoring to use string frozen magic comments (as a consequence, sequitur runs only on Rubies 2.3 or newer).  
 - Code restyling to please rubocop 0.7.40. 
 
 * [CHANGE] Files `Gemfile`, `.travis.yml`, `appveyor.yml` updated.

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014-2019 Dimitri Geshef
+Copyright (c) 2014-2023 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/Rakefile

@@ -19,12 +19,10 @@ RSpec::Core::RakeTask.new do |spec|
   spec.pattern = 'spec/**/*_spec.rb'
 end
 
-
 # Run RSpec tests
 desc 'Run tests, with RSpec'
 task test: [:spec]
 
-
 # Default rake task
 task default: :test
 

data/examples/integer_sample.rb

@@ -10,9 +10,8 @@ input_sequence = [1, 2, 1, 2, 3, 1, 2, 3, 4, 1, 2, 3, 4, 5]
 # Generate the grammar from the sequence
 grammar = Sequitur.build_from(input_sequence)
 
-
 # Use a formatter to display the grammar rules on the console output
-formatter = Sequitur::Formatter::BaseText.new(STDOUT)
+formatter = Sequitur::Formatter::BaseText.new($stdout)
 
 # Now render the rules
 formatter.render(grammar.visitor)

data/examples/porridge.rb

@@ -3,23 +3,23 @@
 require 'sequitur' # Load the Sequitur library
 
 # Purpose: demo to show that sequitur gem works on example from sequitur.info website
-input_sequence = <<-SNIPPET
-pease porridge hot,
-pease porridge cold,
-pease porridge in the pot,
-nine days old.
+input_sequence = <<~SNIPPET
+  pease porridge hot,
+  pease porridge cold,
+  pease porridge in the pot,
+  nine days old.
 
-some like it hot,
-some like it cold,
-some like it in the pot,
-nine days old.
+  some like it hot,
+  some like it cold,
+  some like it in the pot,
+  nine days old.
 SNIPPET
 
 grammar = Sequitur.build_from(input_sequence)
 
 # To display the grammar rules on the console output
 # We use a formatter
-formatter = Sequitur::Formatter::BaseText.new(STDOUT)
+formatter = Sequitur::Formatter::BaseText.new($stdout)
 
 # Now render the rules.
 formatter.render(grammar.visitor)

data/examples/simple_case.rb

@@ -11,7 +11,7 @@ grammar = Sequitur.build_from(input_sequence)
 
 # To display the grammar rules on the console output
 # We use a formatter
-formatter = Sequitur::Formatter::BaseText.new(STDOUT)
+formatter = Sequitur::Formatter::BaseText.new($stdout)
 
 # Now render the rules. Each rule is displayed with the format:
 # rule_id : a_sequence_grammar_symbols.

data/examples/symbol_sample.rb

@@ -15,7 +15,7 @@ input_sequence = %i[
 grammar = Sequitur.build_from(input_sequence)
 
 # Use a formatter to display the grammar rules on the console output
-formatter = Sequitur::Formatter::BaseText.new(STDOUT)
+formatter = Sequitur::Formatter::BaseText.new($stdout)
 
 # Now render the rules
 formatter.render(grammar.visitor)

data/examples/word_sample.rb

@@ -7,10 +7,10 @@ require 'sequitur' # Load the Sequitur library
 #
 
 # Raw input is one String containing repeated sentences...
-raw_input = <<-SNIPPET
-Error: unknown character '?' at position 6
-Error: illegal character '%' at position 20
-Error: unknown character '/' at position 9
+raw_input = <<~SNIPPET
+  Error: unknown character '?' at position 6
+  Error: illegal character '%' at position 20
+  Error: unknown character '/' at position 9
 SNIPPET
 
 # Convert into a sequence of words
@@ -18,9 +18,8 @@ input_sequence = raw_input.scan(/\w+/)
 # Generate the grammar from the sequence
 grammar = Sequitur.build_from(input_sequence)
 
-
 # Use a formatter to display the grammar rules on the console output
-formatter = Sequitur::Formatter::BaseText.new(STDOUT)
+formatter = Sequitur::Formatter::BaseText.new($stdout)
 
 # Now render the rules
 formatter.render(grammar.visitor)

data/lib/sequitur/constants.rb

@@ -4,8 +4,10 @@
 # Purpose: definition of Sequitur constants.
 
 module Sequitur # Module used as a namespace
+  # rubocop:disable Naming/ConstantName
+
   # The version number of the gem.
-  Version = '0.1.22'
+  Version = '0.1.24'
 
   # Brief description of the gem.
   Description = 'Ruby implementation of the Sequitur algorithm'
@@ -20,9 +22,10 @@ module Sequitur # 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
+  # rubocop:enable Naming/ConstantName
 end # module
 
 # End of file

data/lib/sequitur/digram.rb

@@ -28,7 +28,7 @@ module Sequitur # Module for classes implementing the Sequitur algorithm
     #   the sequence symbol1 symbol2 appears.
     def initialize(symbol1, symbol2, aProduction)
       @symbols = [symbol1, symbol2]
-      @key = symbol1.hash.to_s(16) + ':' + symbol2.hash.to_s(16)
+      @key = "#{symbol1.hash.to_s(16)}:#{symbol2.hash.to_s(16)}"
       @production = aProduction
     end
 
@@ -37,13 +37,13 @@ module Sequitur # Module for classes implementing the Sequitur algorithm
     # @param other [Digram] another to compare with
     # @return [true/false]
     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
     def repeating?
-      return symbols[0] == symbols[1]
+      symbols[0] == symbols[1]
     end
   end # class
 end # module

data/lib/sequitur/dynamic_grammar.rb

@@ -34,8 +34,7 @@ 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.
@@ -55,10 +54,10 @@ module Sequitur # Module for classes implementing the Sequitur algorithm
       puts to_string if trace
       prod = productions.delete_at(anIndex)
       # TODO: remove output
-      puts('Removed: ' + prod.to_string) if trace
+      puts("Removed: #{prod.to_string}") if trace
       prod.clear_rhs
 
-      return prod
+      prod
     end
 
     # Add the given token to the grammar.
@@ -83,7 +82,7 @@ module Sequitur # Module for classes implementing the Sequitur algorithm
     # Factory method. Returns a visitor for this grammar.
     # @return [GrammarVisitor]
     def visitor
-      return GrammarVisitor.new(self)
+      GrammarVisitor.new(self)
     end
 
     protected

data/lib/sequitur/formatter/base_formatter.rb

@@ -19,7 +19,7 @@ module Sequitur
       # and render the visit events in the output stream.
       # @param aGrmOrVisitor [DynamicGrammar or 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,8 @@ module Sequitur
     #   # Render the grammar (through a visitor)
     #   formatter.run(some_grammar.visitor)
     class BaseText < BaseFormatter
+      attr_reader :prod_lookup
+
       # Constructor.
       # @param anIO [IO] The output stream to which the rendered grammar
       # is written.
@@ -73,17 +75,11 @@ module Sequitur
 
       private
 
-      # Read accessor of the production lookup
-      def prod_lookup
-        return @prod_lookup
-      end
-
       # Generate a name of a given production.
       # @param aProduction [Production]
       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

data/lib/sequitur/grammar_visitor.rb

@@ -1,7 +1,7 @@
 # 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
     attr_reader(:grammar)