sequitur 0.1.23 → 0.1.25

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 281bd27d3f94acef7567bebbf56099c56a1dbc3c7df02d763ffd7793ff463b84
-  data.tar.gz: ea7881682da31b7de732d4160951bf1591cb26ecc8008f14603a55e8c8620bbe
+  metadata.gz: f70c8a02c1bf095a4ace46d340afe5479ca74fca119c99018f635d629e10af79
+  data.tar.gz: d61df7bc573f20b46edddafb207a5e1c8b98f5a940337b3d3ddcda378aed5f98
 SHA512:
-  metadata.gz: 553904778b8d61a96486e6f32ae0719d3a8b9f6ef99fb3b962f088f55097e6e23a5d75ca65c0ba916027a46d221deb5d7c9aed5a2927754d456c6f9e54658398
-  data.tar.gz: 2c67d893f9ec2d1ffc2523261f170a76de8e15dcf75f6069efe716ff3f48a8314c39a10ee53edd2938db71933a931a356258c694acd1c4b516fb1ec6fabcecce
+  metadata.gz: a0be273d0ae70f7cade11ff86af7ae8f52ca4c697c471a8925ee3e75d230d4c0df261fba908e875413903a6ad6e0cba067ca5778e0d91d4fc35e74f00a00c536
+  data.tar.gz: a352a03ebefe1683e74a59e5d5766eafb44780c65af7f65fe2b6441d15d00193cd1d913976bd7b8cc2e4414a888ec5bd5d6bb0b184be8ecee196398629af1458

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,12 @@
+## [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
 - Remove dependencies towards `coverall`, `simplecov`  
 - Code restyling to please rubocop 1.19.1

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'
 end

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/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-2013, 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/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/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/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,10 +4,12 @@
 # Purpose: definition of Sequitur constants.
 
 module Sequitur # Module used as a namespace
-  # The version number of the gem.
-  Version = '0.1.23'
+  # rubocop:disable Naming/ConstantName
 
-  # Brief description of the gem.
+  # @return [String] The version number of the gem.
+  Version = '0.1.25'
+
+  # @return [String] Brief description of the gem.
   Description = 'Ruby implementation of the Sequitur algorithm'
 
   # Constant Sequitur::RootDir contains the absolute path of Sequitur's
@@ -16,13 +18,14 @@ 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
       "#{startdir}/" # Append trailing slash character to it
     end
   end
+  # rubocop:enable Naming/ConstantName
 end # module
 
 # End of file