LittleWeasel 3.0.4 → 5.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: df58b4978d62918800204788d128be7549284bee
-  data.tar.gz: 9a023735953290cea1a6e8f52f14110d86ee8d64
+SHA256:
+  metadata.gz: 99ff1b68a2ef5252c7db91a9407b9f580c41fcf994b9f139e3f0df05a3a747bc
+  data.tar.gz: 107edfb03a8a9b60a2701005175b6352b699279abb0d3d11f9f1708df09755cc
 SHA512:
-  metadata.gz: 67e12da5910b23fcf50a2a8d3f3fcc28c1c31d87dd3e1df05727359b1ddb362f95c917e00646d568b0d1558530a7379b1b7eb3ee6eb2a8d321d2282b093fd984
-  data.tar.gz: 2155e97a76545a9b5608b7ae7d7cf12c8bb0b26403d1ad7435a42efabc0ae332e6c19775a63910488341222e4e7fb2764c0efc8f3383a126cd2c05c41ab53e72
+  metadata.gz: 0fafbb1416486a516734f2ea08bc464a797bb63ed14388ed837e3f812cfe0e9bb600aa9b36b0608eb196ae18a4bb6f49423b2594a3ac565ef3ecece8e9733bec
+  data.tar.gz: c8dc7d656636e4dc17a32341c324cd7c0e83271251b355c6ac1e1cc87746088745251e32d4cc9352f5cd296829abe2b3fac491d4b201b10cb66c6a45fb99fe63

data/.github/workflows/codeql-analysis.yml

@@ -0,0 +1,72 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ "master" ]
+  schedule:
+    - cron: '38 19 * * 0'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'ruby' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        
+        # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        # queries: security-extended,security-and-quality
+
+        
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v2
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+    #   If the Autobuild fails above, remove it and uncomment the following three lines. 
+    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+
+    # - run: |
+    #   echo "Run, Build Application using script"
+    #   ./location_of_script_within_repo/buildscript.sh
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2

data/.gitignore

@@ -1,18 +1,20 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+/rdoc/
 *.gem
-*.rbc
-.bundle
-.config
-.yardoc
-credentials
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
+
+# rspec failure tracking
+.rspec_status
+
+/.vscode/
+*.code-workspace
+
+scratch.rb
+readme.txt

data/.reek.yml

@@ -0,0 +1,17 @@
+exclude_paths:
+  - vendor
+detectors:
+  TooManyInstanceVariables:
+    exclude:
+      - "LittleWeasel::Configuration"
+      - "LittleWeasel::WordResults"
+  # private methods do not have to depend on instance state
+  # https://github.com/troessner/reek/blob/master/docs/Utility-Function.md
+  UtilityFunction:
+    public_methods_only: true
+  # Check for variable name that doesn't communicate its intent well enough
+  # https://github.com/troessner/reek/blob/master/docs/Uncommunicative-Variable-Name.md
+  UncommunicativeVariableName:
+    accept:
+      - /^_$/
+      - /^e$/

data/.rspec

@@ -1,2 +1,4 @@
---color
---profile
+--require spec_helper
+--format d
+--force-color
+--warnings

data/.rubocop.yml

@@ -0,0 +1,187 @@
+require:
+  - rubocop-performance
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 3.0.1
+  NewCops: enable
+  Exclude:
+    - '.git/**/*'
+    - '.idea/**/*'
+    - 'init/*'
+    - 'Rakefile'
+    - '*.gemspec'
+    - 'spec/**/*'
+    - 'vendor/**/*'
+
+# Align the elements of a hash literal if they span more than one line.
+Layout/HashAlignment:
+  EnforcedLastArgumentHashStyle: always_ignore
+
+# Alignment of parameters in multi-line method definition.
+#   The `with_fixed_indentation` style aligns the following lines with one
+#   level of indentation relative to the start of the line with the method
+#   definition.
+#
+#   def my_method(a,
+#     b)
+Layout/ParameterAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+# Alignment of parameters in multi-line method call.
+#   The `with_fixed_indentation` style aligns the following lines with one
+#   level of indentation relative to the start of the line with the method call.
+#
+#   my_method(a,
+#     b)
+Layout/ArgumentAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+# a = case n
+# when 0
+#   x * 2
+# else
+#   y / 3
+# end
+Layout/CaseIndentation:
+  EnforcedStyle: end
+
+# Enforces a configured order of definitions within a class body
+Layout/ClassStructure:
+  Enabled: true
+
+# Align `end` with the matching keyword or starting expression except for
+#   assignments, where it should be aligned with the LHS.
+Layout/EndAlignment:
+  EnforcedStyleAlignWith: variable
+  AutoCorrect: true
+
+# The `consistent` style enforces that the first element in an array
+#   literal where the opening bracket and the first element are on
+#   seprate lines is indented the same as an array literal which is not
+#   defined inside a method call.
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
+
+# The `consistent` style enforces that the first key in a hash
+#   literal where the opening brace and the first key are on
+#   seprate lines is indented the same as a hash literal which is not
+#   defined inside a method call.
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+
+# Indent multi-line methods instead of aligning with periods
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+# Allow `debug` in tasks for now
+Lint/Debugger:
+  Exclude:
+    - 'RakeFile'
+
+# A calculated magnitude based on number of assignments, branches, and
+#   conditions.
+# NOTE: This is temporarily disabled until we can eliminate existing Rubocop
+#   complaints
+Metrics/AbcSize:
+  Enabled: false
+
+# Avoid long blocks with many lines.
+Metrics/BlockLength:
+  Exclude:
+    - 'RakeFile'
+    - 'db/seeds.rb'
+    - 'spec/**/*.rb'
+
+# Avoid classes longer than 100 lines of code.
+# NOTE: This is temporarily disabled until we can eliminate existing Rubocop
+#   complaints
+Metrics/ClassLength:
+  Max: 200
+  Exclude:
+    - 'spec/**/*.rb'
+
+# A complexity metric that is strongly correlated to the number of test cases
+#   needed to validate a method.
+Metrics/CyclomaticComplexity:
+  Max: 9
+
+# Limit lines to 80 characters
+Layout/LineLength:
+  Exclude:
+    - 'RakeFile'
+    - 'spec/**/*.rb'
+
+# Avoid methods longer than 15 lines of code.
+Metrics/MethodLength:
+  Max: 20
+  IgnoredMethods:
+    - swagger_path
+    - operation
+
+
+# A complexity metric geared towards measuring complexity for a human reader.
+Metrics/PerceivedComplexity:
+  Max: 10
+
+Naming/FileName:
+  Exclude:
+    - 'lib/LittleWeasel.rb'
+
+# Allow `downcase == ` instead of forcing `casecmp`
+Performance/Casecmp:
+  Enabled: false
+
+# Require children definitions to be nested or compact in classes and modules
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+# Document classes and non-namespace modules.
+#   (Disabled for now, may revisit later)
+Style/Documentation:
+  Enabled: false
+
+# Checks the formatting of empty method definitions.
+Style/EmptyMethod:
+  EnforcedStyle: expanded
+
+# Add the frozen_string_literal comment to the top of files to help transition
+#   to frozen string literals by default.
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: always
+
+# Check for conditionals that can be replaced with guard clauses
+Style/GuardClause:
+  Enabled: false
+
+Style/MixinUsage:
+  Exclude:
+    - 'RakeFile'
+
+# Avoid multi-line method signatures.
+Style/MultilineMethodSignature:
+  Enabled: true
+
+# Don't use option hashes when you can use keyword arguments.
+Style/OptionHash:
+  Enabled: true
+
+# Use return instead of return nil.
+Style/ReturnNil:
+  Enabled: true
+
+# Allow code like `return x, y` as it's occasionally handy.
+Style/RedundantReturn:
+  AllowMultipleReturnValues: true
+
+# Prefer symbols instead of strings as hash keys.
+Style/StringHashKeys:
+  Enabled: true
+
+# Checks if configured preferred methods are used over non-preferred.
+Style/StringMethods:
+  Enabled: true
+
+# Checks for use of parentheses around ternary conditions.
+Style/TernaryParentheses:
+  EnforcedStyle: require_parentheses_when_complex

data/.ruby-version

@@ -1 +1 @@
-2.0.0-p481
+3.0.1

data/.yardopts

@@ -0,0 +1,2 @@
+--protected
+--private

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+### 5.0.1
+* bug fix
+  * Fix error loading support files in LittleWeasel.rb.
+### 5.0.0
+* changes
+  * Add spec coverage where lacking.
+  * Remove unused DictionaryLoaderService and associated modules, specs, factories.
+  * Refactor Locale, Language and Region modules to simplify.
+  * Fix up DictionaryManager#dictionary_for which was published
+    half-baked in 4.0.0.
+  * DeprecateDictionaryCacheService#dictionary_exists? (plural); add typical DeprecateDictionaryCacheService#dictionary_exist? method in its palce.
+  *  Update rake gem version to eliminate command injection vulerability.
+  * Change description and summary reflecting 4.0.0 changes.
+  * Various reek gem violation fixes/suppressions where reasonable.
+  * Fix most rubocop violations.
+
+### 4.0.0
+* enhancements
+  * Complete overhaul; see README.md
+
 ### 3.0.4
 * enhancements
   * Relax requirements on ruby version to ~> 2.0.
@@ -13,4 +33,4 @@
   * None
 
 * bug fix
-  * Calling #exists? no longer alters the original input.
+  * Calling #exists? no longer alters the original input.

data/Gemfile

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in LittleWeasel.gemspec
-gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,114 @@
+PATH
+  remote: .
+  specs:
+    LittleWeasel (5.0.1)
+      activesupport (~> 6.1, >= 6.1.3.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.1.6.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    ast (2.4.2)
+    benchmark-ips (2.10.0)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.10)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    factory_bot (6.2.1)
+      activesupport (>= 5.0.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    kwalify (0.7.2)
+    method_source (1.0.0)
+    minitest (5.16.3)
+    parallel (1.22.1)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.10.1)
+      byebug (~> 11.0)
+      pry (>= 0.13, < 0.15)
+    rainbow (3.1.1)
+    rake (12.3.3)
+    redcarpet (3.5.1)
+    reek (6.1.1)
+      kwalify (~> 0.7.0)
+      parser (~> 3.1.0)
+      rainbow (>= 2.0, < 4.0)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.9.1)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.21.0)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.14.3)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rspec (2.4.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.2.0)
+    webrick (1.7.0)
+    yard (0.9.28)
+      webrick (~> 1.7.0)
+    zeitwerk (2.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  LittleWeasel!
+  benchmark-ips (~> 2.3)
+  bundler (~> 2.2, >= 2.2.17)
+  factory_bot (~> 6.2)
+  pry-byebug (~> 3.9)
+  rake (~> 12.3, >= 12.3.3)
+  redcarpet (~> 3.5, >= 3.5.1)
+  reek (~> 6.0, >= 6.0.4)
+  rspec (~> 3.10)
+  rubocop (~> 1.9.1)
+  rubocop-performance (~> 1.11, >= 1.11.3)
+  rubocop-rspec (~> 2.3)
+  simplecov (~> 0.21.2)
+  webrick (~> 1.7)
+  yard (~> 0.9.26)
+
+BUNDLED WITH
+   2.2.17

data/Jenkinsfile

@@ -0,0 +1,20 @@
+pipeline {
+  agent { docker { image 'ruby:3.0.1' } }
+  stages {
+    stage('requirements') {
+      steps {
+        sh 'gem install bundler -v 2.2.17'
+      }
+    }
+    stage('build') {
+      steps {
+        sh 'bundle install'
+      }
+    }
+    stage('test') {
+      steps {
+        sh 'bundle exec rspec'
+      }
+    }
+  }
+}

data/LittleWeasel.gemspec

@@ -1,28 +1,41 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'LittleWeasel/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "LittleWeasel"
+  spec.name          = 'LittleWeasel'
   spec.version       = LittleWeasel::VERSION
-  spec.authors       = ["Gene M. Angelo, Jr."]
-  spec.email         = ["public.gma@gmail.com"]
-  spec.description   = %q{Simple spellchecker for single, or multiple word blocks.}
-  spec.summary       = %q{Simply checks a word or group of words for validity against an english dictionary file.}
-  spec.homepage      = "http://www.geneangelo.com"
-  spec.license       = "MIT"
+  spec.authors       = ['Gene M. Angelo, Jr.']
+  spec.email         = ['public.gma@gmail.com']
+  spec.description   = 'Spellchecker+ with preprocessing and filtering for single and multiple word blocks.'
+  spec.summary       = 'Checks a word or group of words for validity against a dictionary/ies provided. Word filtering and word preprocessing is available.'
+  spec.homepage      = 'http://www.geneangelo.com'
+  spec.license       = 'MIT'
 
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '~> 2.0'
-  spec.add_runtime_dependency 'activesupport', '~> 4.1', '>= 4.1.1'
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake", '~> 0'
-  spec.add_development_dependency "rspec", '~> 3.0', '>= 3.0.0'
-  spec.add_development_dependency "yard", "0.8.6.1"
-  spec.add_development_dependency "redcarpet", '~> 2.3', '>= 2.3.0'
+  spec.required_ruby_version = '~> 3.0', '>= 3.0.1'
+  spec.add_runtime_dependency 'activesupport', '~> 6.1', '>= 6.1.3.2'
+  spec.add_development_dependency 'benchmark-ips', '~> 2.3'
+  spec.add_development_dependency 'bundler', '~> 2.2', '>= 2.2.17'
+  spec.add_development_dependency 'factory_bot', '~> 6.2'
+  spec.add_development_dependency 'pry-byebug', '~> 3.9'
+  spec.add_development_dependency 'rake',  '~> 12.3', '>= 12.3.3'
+  spec.add_development_dependency 'redcarpet', '~> 3.5', '>= 3.5.1'
+  spec.add_development_dependency 'reek', '~> 6.0', '>= 6.0.4'
+  spec.add_development_dependency 'rspec', '~> 3.10'
+  # This verson of rubocop is returning errors.
+  # spec.add_development_dependency 'rubocop', '~> 1.14'
+  spec.add_development_dependency 'rubocop', '~> 1.9.1'
+  spec.add_development_dependency 'rubocop-performance', '~> 1.11', '>= 1.11.3'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.3'
+  spec.add_development_dependency 'simplecov', '~> 0.21.2'
+  # Needed for yard
+  spec.add_development_dependency 'webrick', '~> 1.7'
+  spec.add_development_dependency 'yard', '~> 0.9.26'
 end