LittleWeasel 3.0.3 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8077ebd3ea097532c9ca167b79b3195903a4ff1c
-  data.tar.gz: b7ff804920931aff1c2567ae0c056fdfc8768026
+SHA256:
+  metadata.gz: 96add6e70ce7b0619c3223931123d2ed9b438f7f294a2903053d2ba4a784af4b
+  data.tar.gz: bfe662b8c3a68295724139d68184f3413c7cad8193c491cae8737fadc29ea8ed
 SHA512:
-  metadata.gz: b6c3711660636e2cd4db68bd86308e31935659fc8499e6fbce8b46331dac57b0d70035a8988612d3fbe6c43eb495464aa021b21b3e12a2d8dbc9d0301227228e
-  data.tar.gz: d9a1bf68f2144b54a20ab7010708d0487e5168703dcee4828a2cf557ca4f111012fea5a70361b98e9fb600a36ab25c3d26fabd0aa92c374bb37581d2af4172e1
+  metadata.gz: c8959e2b10b5bb97caac98b64046595ac676b120073f0e30d5f6ff2603bca09254ef0e7053af9c38f9ed940a14ae39a003c0453fafbcb6245cb2031e6bd22329
+  data.tar.gz: 02d671ece9011d096f17cfd61e9871c11e8536ef277cc147f77ab3f2ae6821e87c9edb255ab1d8981199ec9bdce9232be8c127db9bf12f30776d03ed8a1587b1

data/.gitignore

@@ -16,3 +16,6 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+LittleWeasel.sublime-*
+scratch.txt
+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.1.0
+3.0.1

data/.yardopts

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

data/CHANGELOG.md

@@ -1,3 +1,24 @@
+### 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.
+
 ### 3.0.3
 
 * enhancements
@@ -9,4 +30,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/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.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.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