LittleWeasel 5.0.10 → 5.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed8ab6b42033fadcc7cc14fe6cf270831cc07a4d619d3c726ba2a37220e68f91
-  data.tar.gz: 560d08ec9a9221fece78a957b7b8abe42d8d0c1fdbee87547eb9b85788850968
+  metadata.gz: 482215cb6c09deff74d3d4ec5c04cbf2f2b28638be7a9c7e4db54bd08b4e044f
+  data.tar.gz: 61e36d7c84d0bf524340c5354dea6e5531d06d712f9e784ffa74394a18afe695
 SHA512:
-  metadata.gz: fca98f865141c33efe43435cff387263c506db30c33992c335542afa11a0d599d8f2594135c7b543f33dcfff94b08b0d6f9c87689f2b8738aa0493d92e1529c8
-  data.tar.gz: ae65613cffe2b137cef35ff857ccacbe4cfe6c2013ac3eb275ad1e8eba4197b2e7d9458c9c524dd072a4e906b174237d1e28c8e6d26a3e7bc44263f43324bb7d
+  metadata.gz: 59f4fc68c4b6590cb71302ad2a7512bb6160225d962bcd4b337571112aa576c72b15f3841b13e9ecfc67bc104c81869dced42765667e0cedb5fb051467da72f5
+  data.tar.gz: 876cac504cde595a3dbf3d8da467cd9d608f1bf28766c8c96230e2d057c19d7426386ed0c4e666c25c2d0bfc943784b234a1f16250b7626879a66c4a3d1b8130

data/.rubocop.yml

@@ -3,6 +3,7 @@ require:
   - rubocop-rspec
 
 AllCops:
+  SuggestExtensions: false
   TargetRubyVersion: 3.0.1
   NewCops: enable
   Exclude:

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+### 5.0.11 2024-02-18
+
+* Changes
+ * Update gems.
+
 ### 5.0.10 2024-01-07
 
 * Changes

data/Gemfile

@@ -5,18 +5,28 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in LittleWeasel.gemspec
 gemspec
 
-gem 'benchmark-ips', '>= 2.3', '< 3.0'
+group :development, :test do
+  gem 'factory_bot', '>= 6.3', '< 7.0'
+  gem 'pry-byebug', '>= 3.9', '< 4.0'
+  gem 'reek', '>= 6.0', '< 7.0'
+  gem 'rspec', '>= 3.12', '< 4.0'
+  gem 'rubocop', '>= 1.56', '< 2.0'
+  gem 'rubocop-performance', '>= 1.19', '< 2.0'
+  gem 'rubocop-rspec', '>= 2.23', '< 3.0'
+  gem 'simplecov', '>= 0.22.0', '< 1.0'
+end
+
+group :benchmarking do
+  gem 'benchmark-ips', '>= 2.3', '< 3.0'
+end
+
+group :documentation do
+  # Needed for yard
+  gem 'webrick', '>= 1.7', '< 2.0'
+  gem 'yard', '>= 0.9.26', '< 1.0'
+end
+
+# Global gems, commonly used in development but not necessarily tied to a specific task
 gem 'bundler', '~> 2.5', '>= 2.5.3'
-gem 'factory_bot', '>= 6.3', '< 7.0'
-gem 'pry-byebug', '>= 3.9', '< 4.0'
 gem 'rake', '>= 13.0', '< 14'
 gem 'redcarpet', '>= 3.5', '< 4.0'
-gem 'reek', '>= 6.0', '< 7.0'
-gem 'rspec', '>= 3.12', '< 4.0'
-gem 'rubocop', '>= 1.56', '< 2.0'
-gem 'rubocop-performance', '>= 1.19', '< 2.0'
-gem 'rubocop-rspec', '>= 2.23', '< 3.0'
-gem 'simplecov', '>= 0.22.0', '< 1.0'
-# Needed for yard
-gem 'webrick', '>= 1.7', '< 2.0'
-gem 'yard', '>= 0.9.26', '< 1.0'

data/Gemfile.lock

@@ -1,13 +1,13 @@
 PATH
   remote: .
   specs:
-    LittleWeasel (5.0.10)
+    LittleWeasel (5.0.11)
       activesupport (>= 7.0.8, < 8.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.1.2)
+    activesupport (7.1.3)
       base64
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
@@ -20,12 +20,12 @@ GEM
     ast (2.4.2)
     base64 (0.2.0)
     benchmark-ips (2.13.0)
-    bigdecimal (3.1.5)
+    bigdecimal (3.1.6)
     byebug (11.1.3)
     coderay (1.1.3)
-    concurrent-ruby (1.2.2)
+    concurrent-ruby (1.2.3)
     connection_pool (2.4.1)
-    diff-lcs (1.5.0)
+    diff-lcs (1.5.1)
     docile (1.4.0)
     drb (2.2.0)
       ruby2_keywords
@@ -56,17 +56,17 @@ GEM
       dry-inflector (~> 1.0)
       dry-logic (~> 1.4)
       zeitwerk (~> 2.6)
-    factory_bot (6.4.5)
+    factory_bot (6.4.6)
       activesupport (>= 5.0.0)
     i18n (1.14.1)
       concurrent-ruby (~> 1.0)
     json (2.7.1)
     language_server-protocol (3.17.0.3)
     method_source (1.0.0)
-    minitest (5.20.0)
+    minitest (5.22.2)
     mutex_m (0.2.0)
     parallel (1.24.0)
-    parser (3.2.2.4)
+    parser (3.3.0.5)
       ast (~> 2.4.1)
       racc
     pry (0.14.2)
@@ -79,31 +79,31 @@ GEM
     rainbow (3.1.1)
     rake (13.1.0)
     redcarpet (3.6.0)
-    reek (6.2.0)
+    reek (6.3.0)
       dry-schema (~> 1.13.0)
-      parser (~> 3.2.0)
+      parser (~> 3.3.0)
       rainbow (>= 2.0, < 4.0)
       rexml (~> 3.1)
-    regexp_parser (2.8.3)
+    regexp_parser (2.9.0)
     rexml (3.2.6)
-    rspec (3.12.0)
-      rspec-core (~> 3.12.0)
-      rspec-expectations (~> 3.12.0)
-      rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.2)
-      rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.3)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.6)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-support (3.12.1)
-    rubocop (1.59.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.0)
+    rubocop (1.60.2)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.2.2.4)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
@@ -114,9 +114,9 @@ GEM
       parser (>= 3.2.1.0)
     rubocop-capybara (2.20.0)
       rubocop (~> 1.41)
-    rubocop-factory_bot (2.25.0)
-      rubocop (~> 1.33)
-    rubocop-performance (1.20.1)
+    rubocop-factory_bot (2.25.1)
+      rubocop (~> 1.41)
+    rubocop-performance (1.20.2)
       rubocop (>= 1.48.1, < 2.0)
       rubocop-ast (>= 1.30.0, < 2.0)
     rubocop-rspec (2.26.1)
@@ -136,7 +136,7 @@ GEM
     unicode-display_width (2.5.0)
     webrick (1.8.1)
     yard (0.9.34)
-    zeitwerk (2.6.12)
+    zeitwerk (2.6.13)
 
 PLATFORMS
   ruby

data/README.md

@@ -1,6 +1,6 @@
 [![Ruby](https://github.com/gangelo/LittleWeasel/actions/workflows/ruby.yml/badge.svg)](https://github.com/gangelo/LittleWeasel/actions/workflows/ruby.yml)
-[![GitHub version](http://badge.fury.io/gh/gangelo%2FLittleWeasel.svg?version=1)](https://badge.fury.io/gh/gangelo%2FLittleWeasel)
-[![Gem Version](https://badge.fury.io/rb/LittleWeasel.svg?version=1)](https://badge.fury.io/rb/LittleWeasel)
+[![GitHub version](http://badge.fury.io/gh/gangelo%2FLittleWeasel.svg?version=2)](https://badge.fury.io/gh/gangelo%2FLittleWeasel)
+[![Gem Version](https://badge.fury.io/rb/LittleWeasel.svg?version=2)](https://badge.fury.io/rb/LittleWeasel)
 [![](http://ruby-gem-downloads-badge.herokuapp.com/LittleWeasel?type=total)](http://www.rubydoc.info/gems/LittleWeasel/)
 [![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](http://www.rubydoc.info/gems/LittleWeasel/)
 [![Report Issues](https://img.shields.io/badge/report-issues-red.svg)](https://github.com/gangelo/LittleWeasel/issues)

data/Rakefile

@@ -1,10 +1,11 @@
-# frozen_string_literal: true
+# frozen_string_literal: false
 
 require 'active_support/core_ext/object/try.rb'
 require 'active_support/inflector'
 require 'benchmark/ips'
 require 'bundler/gem_tasks'
 require 'pry'
+require 'rubocop/rake_task'
 
 require_relative 'lib/LittleWeasel'
 require_relative 'spec/support/file_helpers'
@@ -30,7 +31,7 @@ end
 # Tasks related to the #word_results API
 
 namespace 'word_results' do
-  # Creates a dictionary from a file on disk
+  desc 'Creates a dictionary from a file on disk - perform basic word search results operations'
   task :basic do
     LittleWeasel.configure do |config|
       # TODO: Configure as needed here.
@@ -67,7 +68,7 @@ namespace 'word_results' do
     end
   end
 
-  # Creates a dictionary of names from memory
+  desc 'Creates a dictionary from memory - perform basic word search results operations'
   task :from_memory do
     LittleWeasel.configure do |config|
       # TODO: Configure as needed here.
@@ -101,7 +102,7 @@ namespace 'word_results' do
     end
   end
 
-  # Shows application of word filters and word preprocessors.
+  desc 'Creates a dictionary from memory - perform advanced word search results operations using word filters and preprocessors'
   task :advanced do
     LittleWeasel.configure do |config|
       # TODO: Configure as needed here.
@@ -175,6 +176,7 @@ namespace 'word_results' do
     end
   end
 
+  desc 'Creates a dictionary from memory - perform advanced word search results operations using word filters and preprocessors'
   task :word_filters do
     LittleWeasel.configure do |config|
       # TODO: Configure as needed here.
@@ -217,6 +219,7 @@ end
 # Tasks related to the #block_results API
 
 namespace 'block_results' do
+  desc 'Perform basic #block_results API operations'
   task :basic do
     LittleWeasel.configure do |config|
       # TODO: Configure as needed here.
@@ -253,32 +256,17 @@ namespace 'block_results' do
 end
 
 namespace :bm do
+  desc 'Performs benchmarking on Hash lookups performance.'
   task :hash do
     STRING_LOCALE = { 'en-US' => 'en-us' }
-    SYMBOL_LOCALE = { 'en-US' => :enUS }
+    SYMBOL_LOCALE = { enUS: 'en-US' }
 
-    puts 'String variable vs. normal String.'
+    puts "Benchmark Hash lookups using different Hash key data types."
     Benchmark.ips do |x|
-      string_variable = 'string_variable'
+      string_variable = 'en-US'
+      x.report('hard-coded string') { STRING_LOCALE['en-US'] }
+      x.report('hard-coded frozen string') { STRING_LOCALE['en-US'.freeze] }
       x.report('string variable') { STRING_LOCALE[string_variable] }
-      x.report('normal') { STRING_LOCALE['en-US'] }
-    end
-
-    puts 'String#freeze vs. normal String.'
-    Benchmark.ips do |x|
-      x.report('freeze') { STRING_LOCALE['en-US'.freeze] }
-      x.report('normal') { STRING_LOCALE['en-US'] }
-    end
-
-    puts 'String vs Symbol'
-    Benchmark.ips do |x|
-      x.report('string') { STRING_LOCALE['en-US'] }
-      x.report('symbol') { SYMBOL_LOCALE[:enUS] }
-    end
-
-    puts 'String#freeze vs. Symbol'
-    Benchmark.ips do |x|
-      x.report('string') { STRING_LOCALE['en-US'.freeze] }
       x.report('symbol') { SYMBOL_LOCALE[:enUS] }
     end
   rescue StandardError => e
@@ -288,6 +276,7 @@ namespace :bm do
     end
   end
 
+  desc 'Performs benchmarking on the DictionaryKey class.'
   task :dictionary_key do
     puts 'DictionaryKey test'
     Benchmark.ips do |x|
@@ -303,4 +292,9 @@ namespace :bm do
   end
 end
 
-task default: :spec
+
+desc 'Run LittleWeasel benchmark tests.'
+task benchmarking: %w[bm:hash bm:dictionary_key]
+
+RuboCop::RakeTask.new
+task default: %i[spec rubocop]

data/lib/LittleWeasel/dictionary.rb

@@ -21,7 +21,7 @@ module LittleWeasel
 
     attr_reader :dictionary_metadata_object, :dictionary_words
 
-    def initialize(dictionary_key:, dictionary_words:, dictionary_cache:,
+    def initialize(dictionary_key:, dictionary_words:, dictionary_cache:, # rubocop:disable Metrics/ParameterLists
       dictionary_metadata:, word_filters: nil, word_preprocessors: nil)
       validate_dictionary_key dictionary_key: dictionary_key
       self.dictionary_key = dictionary_key

data/lib/LittleWeasel/version.rb

@@ -2,5 +2,5 @@
 
 # The version of this gem
 module LittleWeasel
-  VERSION = '5.0.10'
+  VERSION = '5.0.11'
 end

data/lib/LittleWeasel.rb

@@ -1,72 +1,11 @@
+# rubocop:disable Naming/FileName
 # frozen_string_literal: true
 
 require 'active_support/core_ext/object/blank'
 
-require_relative 'LittleWeasel/block_results'
-require_relative 'LittleWeasel/configure'
-require_relative 'LittleWeasel/dictionary'
-require_relative 'LittleWeasel/dictionary_key'
-require_relative 'LittleWeasel/dictionary_manager'
-require_relative 'LittleWeasel/errors/dictionary_file_already_loaded_error'
-require_relative 'LittleWeasel/errors/dictionary_file_empty_error'
-require_relative 'LittleWeasel/errors/dictionary_file_not_found_error'
-require_relative 'LittleWeasel/errors/dictionary_file_too_large_error'
-require_relative 'LittleWeasel/errors/language_required_error'
-require_relative 'LittleWeasel/errors/must_override_error'
-require_relative 'LittleWeasel/filters/en_us/currency_filter'
-require_relative 'LittleWeasel/filters/en_us/numeric_filter'
-require_relative 'LittleWeasel/filters/en_us/single_character_word_filter'
-require_relative 'LittleWeasel/filters/word_filter'
-require_relative 'LittleWeasel/filters/word_filter_managable'
-require_relative 'LittleWeasel/filters/word_filter_validatable'
-require_relative 'LittleWeasel/filters/word_filterable'
-require_relative 'LittleWeasel/filters/word_filters_validatable'
-require_relative 'LittleWeasel/metadata/dictionary_metadata'
-require_relative 'LittleWeasel/metadata/invalid_words_metadata'
-require_relative 'LittleWeasel/metadata/invalid_words_service_results'
-require_relative 'LittleWeasel/metadata/metadata_observable_validatable'
-require_relative 'LittleWeasel/metadata/metadata_observerable'
-require_relative 'LittleWeasel/metadata/metadatable'
-require_relative 'LittleWeasel/modules/class_name_to_symbol'
-require_relative 'LittleWeasel/modules/configurable'
-require_relative 'LittleWeasel/modules/deep_dup'
-require_relative 'LittleWeasel/modules/dictionary_cache_keys'
-require_relative 'LittleWeasel/modules/dictionary_cache_servicable'
-require_relative 'LittleWeasel/modules/dictionary_cache_validatable'
-require_relative 'LittleWeasel/modules/dictionary_creator_servicable'
-require_relative 'LittleWeasel/modules/dictionary_file_loader'
-require_relative 'LittleWeasel/modules/dictionary_key_validatable'
-require_relative 'LittleWeasel/modules/dictionary_keyable'
-require_relative 'LittleWeasel/modules/dictionary_metadata_servicable'
-require_relative 'LittleWeasel/modules/dictionary_metadata_validatable'
-require_relative 'LittleWeasel/modules/dictionary_source_validatable'
-require_relative 'LittleWeasel/modules/dictionary_sourceable'
-require_relative 'LittleWeasel/modules/dictionary_validatable'
-require_relative 'LittleWeasel/modules/language'
-require_relative 'LittleWeasel/modules/language_validatable'
-require_relative 'LittleWeasel/modules/locale'
-require_relative 'LittleWeasel/modules/order_validatable'
-require_relative 'LittleWeasel/modules/orderable'
-require_relative 'LittleWeasel/modules/region'
-require_relative 'LittleWeasel/modules/region_validatable'
-require_relative 'LittleWeasel/modules/tag_validatable'
-require_relative 'LittleWeasel/modules/taggable'
-require_relative 'LittleWeasel/modules/word_results_validatable'
-require_relative 'LittleWeasel/preprocessors/en_us/capitalize_preprocessor'
-require_relative 'LittleWeasel/preprocessors/preprocessed_word'
-require_relative 'LittleWeasel/preprocessors/preprocessed_word_validatable'
-require_relative 'LittleWeasel/preprocessors/preprocessed_words'
-require_relative 'LittleWeasel/preprocessors/preprocessed_words_validatable'
-require_relative 'LittleWeasel/preprocessors/word_preprocessable'
-require_relative 'LittleWeasel/preprocessors/word_preprocessor'
-require_relative 'LittleWeasel/preprocessors/word_preprocessor_managable'
-require_relative 'LittleWeasel/preprocessors/word_preprocessor_validatable'
-require_relative 'LittleWeasel/preprocessors/word_preprocessors_validatable'
-require_relative 'LittleWeasel/services/dictionary_cache_service'
-require_relative 'LittleWeasel/services/dictionary_creator_service'
-require_relative 'LittleWeasel/services/dictionary_file_loader_service'
-require_relative 'LittleWeasel/services/dictionary_killer_service'
-require_relative 'LittleWeasel/services/dictionary_metadata_service'
-require_relative 'LittleWeasel/services/invalid_words_service'
-require_relative 'LittleWeasel/version'
-require_relative 'LittleWeasel/word_results'
+Dir.glob(File.join(__dir__, 'LittleWeasel', '**', '*.rb')).each do |file|
+  # Require the file relative to this file's directory
+  require_relative file.sub(File.join(__dir__, '/'), '')
+end
+
+# rubocop:enable Naming/FileName

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: LittleWeasel
 version: !ruby/object:Gem::Version
-  version: 5.0.10
+  version: 5.0.11
 platform: ruby
 authors:
 - Gene M. Angelo, Jr.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-07 00:00:00.000000000 Z
+date: 2024-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport