sequitur 0.1.23 → 0.1.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 281bd27d3f94acef7567bebbf56099c56a1dbc3c7df02d763ffd7793ff463b84
-  data.tar.gz: ea7881682da31b7de732d4160951bf1591cb26ecc8008f14603a55e8c8620bbe
+  metadata.gz: a1ba8348f20a1e800b1c7001090916dbe05159177471452fdcfa8925bc975431
+  data.tar.gz: a8002cab5a1f7ae7b20b347f4a5f79e92a2f979dca1fad2dad83e153f5969d22
 SHA512:
-  metadata.gz: 553904778b8d61a96486e6f32ae0719d3a8b9f6ef99fb3b962f088f55097e6e23a5d75ca65c0ba916027a46d221deb5d7c9aed5a2927754d456c6f9e54658398
-  data.tar.gz: 2c67d893f9ec2d1ffc2523261f170a76de8e15dcf75f6069efe716ff3f48a8314c39a10ee53edd2938db71933a931a356258c694acd1c4b516fb1ec6fabcecce
+  metadata.gz: 2a116b242f218d0c08740a0432b641f88dbaa7f65dd67b02a5339be208927c835db4965d6e3ede344d7d93a4bbea6d4468692c4b237f1f18a8bbd3f6ffb54037
+  data.tar.gz: 2b7ea3e4acf58cb45ed3c0b7081a35201c2a8aa5285e163e9845fd82f082e7dcfb563a063d566c2561bb81944cefec6a67d0d2203b2080cb12fd73f6ace3c53e

data/.rubocop.yml

@@ -1,456 +1,30 @@
 AllCops:
   Exclude:
-    - 'exp/**/*'
     - 'lab/**/*'
-
-Gemspec/DateAssignment:
-  Enabled: true
-
-Layout/ArgumentAlignment:
-  Enabled: false
-
-Layout/ArrayAlignment:
-  Enabled: true
-  EnforcedStyle: with_fixed_indentation
-
-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/FirstArgumentIndentation:
-  Enabled: false
-
-Layout/HashAlignment:
-  Enabled: false
-
-Layout/IndentationWidth:
-  Enabled: false
-
-Layout/IndentationConsistency:
-  Enabled: true
-
-Layout/HeredocIndentation:
-  Enabled: false
-
-Layout/LineEndStringConcatenationIndentation:
-  Enabled: true
-
-Layout/MultilineHashBraceLayout:
-  Enabled: true
-
-Layout/MultilineMethodCallBraceLayout:
-  Enabled: true
-  EnforcedStyle: same_line
-
-Layout/SpaceAroundOperators:
-  Enabled: true
-
-Layout/SpaceBeforeBrackets:
-  Enabled: true
-
-Layout/SpaceInsideParens:
-  Enabled: true
-
-Layout/IndentationStyle:
-  Enabled: true
-
-Layout/SpaceAroundMethodCallOperator:
-  Enabled: true
-
-Layout/TrailingEmptyLines:
-  Enabled: true
-
-Layout/TrailingWhitespace:
-  Enabled: true
-
-Lint/AmbiguousAssignment:
-  Enabled: true
-
-Lint/AmbiguousRange:
-  Enabled: true
-
-Lint/DeprecatedConstants:
-  Enabled: true
-
-Lint/DuplicateBranch:
-  Enabled: true
-
-Lint/DuplicateRegexpCharacterClassElement:
-  Enabled: true
-
-Lint/EmptyBlock:
-  Enabled: true
-
-Lint/EmptyClass:
-  Enabled: false
-
-Lint/EmptyInPattern:
-  Enabled: true
-
-Lint/LambdaWithoutLiteralBlock:
-  Enabled: true
-
-Lint/Loop:
-  Enabled: true
-
-Lint/NoReturnInBeginEndBlocks:
-  Enabled: true
-
-Lint/NumberedParameterAssignment:
-  Enabled: true
-
-Lint/OrAssignmentToConstant:
-  Enabled: true
-
-Lint/RaiseException:
-  Enabled: true
-
-Lint/RedundantDirGlobSort:
-  Enabled: true
-
-Lint/RescueException:
-  Enabled: true
-
-Lint/StructNewOverride:
-  Enabled: true
-
-Lint/SymbolConversion:
-  Enabled: true
-
-Lint/ToEnumArguments:
-  Enabled: true
-
-Lint/TripleQuotes:
-  Enabled: true
-
-Lint/UnexpectedBlockArity:
-  Enabled: true
-
-Lint/UnmodifiedReduceAccumulator:
-  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
-
-Metrics/BlockNesting:
-  Enabled: true
-  Max: 5
+  Max: 22 
 
 Metrics/ClassLength:
-  Enabled: true
-  Max: 450
-
+  Max: 150
+  
 Metrics/CyclomaticComplexity:
-  Enabled: false
-
-Layout/LineLength:
-  Enabled: false
-  Max: 90
+  Max: 10   
 
 Metrics/MethodLength:
-  Enabled: true
-  Max: 60
-
-Metrics/ModuleLength:
-  Enabled: true
-  Max: 500
-
+  Max: 50
+  
 Metrics/PerceivedComplexity:
-  Enabled: false
-
-Naming/ConstantName:
-  Enabled: false
-
-Naming/ClassAndModuleCamelCase:
-  Enabled: false
-
-Naming/BlockParameterName:
-  Enabled: true
-
-Naming/InclusiveLanguage:
-  Enabled: true
+  Max: 10  
 
 Naming/MethodParameterName:
   Enabled: false
-
-Naming/MethodName:
-  Enabled: false
-
+  
 Naming/VariableName:
   Enabled: false
 
-Style/AccessorGrouping:
-  Enabled: false
-
-Style/Alias:
-  Enabled: true
-
-Style/ArgumentsForwarding:
-  Enabled: true
-
-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/CollectionCompact:
-  Enabled: true
-
-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/DocumentDynamicEvalDefinition:
-  Enabled: false
-
-Style/EmptyElse:
-  Enabled: true
-  EnforcedStyle: empty
-
-Style/ExpandPathArguments:
-  Enabled: false
-
-Style/ExponentialNotation:
-  Enabled: true
-
-Style/GuardClause:
-  Enabled: false
-
-Style/HashEachMethods:
-  Enabled: true
-
-Style/HashExcept:
-  Enabled: true
-
-Style/HashTransformKeys:
-  Enabled: true
-
-Style/HashTransformValues:
-  Enabled: true
-
-Style/IfUnlessModifier:
-  Enabled: false
-
-Style/InPatternThen:
-  Enabled: true
-
-Style/InverseMethods:
-  Enabled: false
-
-Style/MissingRespondToMissing:
-  Enabled: false
-
-Style/MultilineInPatternThen:
-  Enabled: true
-
-Style/NegatedIfElseCondition:
-  Enabled: true
-
-Style/Next:
-  Enabled: false
-
-Style/NilLambda:
-  Enabled: true
-
-Style/NumericLiterals:
-  Enabled: false
-
-Style/QuotedSymbols:
-  Enabled: true
-
-Style/RaiseArgs:
-  Enabled: true
-
-Style/RedundantArgument:
-  Enabled: true
-
-Style/RedundantReturn:
-  Enabled: false
-
-Style/RedundantSelf:
-  Enabled: true
-
-Style/RedundantSelfAssignmentBranch:
-  Enabled: true
-
-Style/RegexpLiteral:
-  Enabled: false
-
-Style/PercentLiteralDelimiters:
-  Enabled: false
-
-Style/StderrPuts:
-  Enabled: false
-
-Style/StringLiterals:
-  Enabled: true
-
-Style/SwapValues:
-  Enabled: true
-
-Style/TernaryParentheses:
-  Enabled: false
-
-Style/UnlessElse:
-  Enabled: false
-
-# Rubocop complains when it doesn't find an explicit setting for the following cops:
-Layout/EmptyLinesAroundAttributeAccessor:
-  Enabled: true
-
-Lint/BinaryOperatorWithIdenticalOperands:
-  Enabled: true
-
-Lint/DeprecatedOpenSSLConstant:
-  Enabled: true
-
-Lint/DuplicateElsifCondition:
-  Enabled: true
-
-Lint/DuplicateRescueException:
-  Enabled: true
-
-Lint/EmptyConditionalBody:
-  Enabled: true
-
-Lint/FloatComparison:
-  Enabled: true
-
-Lint/MissingSuper:
-  Enabled: true
-
-Lint/MixedRegexpCaptureTypes:
-  Enabled: true
-
-Lint/OutOfRangeRegexpRef:
-  Enabled: true
-
-Lint/SelfAssignment:
-  Enabled: true
-
-Lint/TopLevelReturnWithArgument:
-  Enabled: true
-
-Lint/UnreachableLoop:
-  Enabled: true
-
-Style/ArrayCoercion:
-  Enabled: true
-
-Style/BisectedAttrAccessor:
-  Enabled: true
-
-Style/CaseLikeIf:
-  Enabled: true
-
-Style/EndlessMethod:
-  Enabled: true
-
-Style/ExplicitBlockArgument:
-  Enabled: true
-
-Style/GlobalStdStream:
-  Enabled: true
-
-Style/HashAsLastArrayItem:
-  Enabled: true
-
-Style/HashConversion:
-  Enabled: true
-
-Style/HashLikeCase:
-  Enabled: true
-
-Style/IfWithBooleanLiteralBranches:
-  Enabled: true
-
-Style/OptionalBooleanParameter:
-  Enabled: true
-
-Style/RedundantAssignment:
-  Enabled: true
-
-Style/RedundantFetchBlock:
-  Enabled: true
-
-Style/RedundantFileExtensionInRequire:
-  Enabled: true
-
-Style/RedundantRegexpCharacterClass:
-  Enabled: true
-
-Style/RedundantRegexpEscape:
-  Enabled: true
-
-Style/SingleArgumentDig:
-  Enabled: true
-
-Style/SlicingWithRange:
-  Enabled: true
-
-Style/StringChars:
-  Enabled: true
-
-Style/StringConcatenation:
-  Enabled: true
+  Enabled: false  

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## [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

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,7 +10,6 @@ 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)
 

data/examples/porridge.rb

@@ -3,16 +3,16 @@
 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)

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,7 +18,6 @@ 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)
 

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.23'
+  Version = '0.1.24'
 
   # Brief description of the gem.
   Description = 'Ruby implementation of the Sequitur algorithm'
@@ -23,6 +25,7 @@ module Sequitur # Module used as a namespace
       "#{startdir}/" # Append trailing slash character to it
     end
   end
+  # rubocop:enable Naming/ConstantName
 end # module
 
 # End of file

data/lib/sequitur/digram.rb

@@ -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.
@@ -58,7 +57,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.
@@ -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)