LittleWeasel 4.0.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d55524bb27846962bd5cd9b83bf2b141c6f34ca723721630d980963be51f1e24
-  data.tar.gz: 8f7efc3fb0db218dd6355f194b92352d12f901955c5388fe8f97e108cac7426b
+  metadata.gz: 96add6e70ce7b0619c3223931123d2ed9b438f7f294a2903053d2ba4a784af4b
+  data.tar.gz: bfe662b8c3a68295724139d68184f3413c7cad8193c491cae8737fadc29ea8ed
 SHA512:
-  metadata.gz: 4027802eab13cb465e419dc8a95a6b3d6d905b6fffcc772bb33d485239fe2260bef778a0f33b526d5bc040dff59fb2c5cfb712b4a47cd4aa29e117c603fea886
-  data.tar.gz: a54d138d51f8c66b42ff0a17880f6633370207223822dd6200766fd00fa70e6e19c4a29a9148183b586ed49f35eaf58d22b52d745059799f7147ec6a5c07a96d
+  metadata.gz: c8959e2b10b5bb97caac98b64046595ac676b120073f0e30d5f6ff2603bca09254ef0e7053af9c38f9ed940a14ae39a003c0453fafbcb6245cb2031e6bd22329
+  data.tar.gz: 02d671ece9011d096f17cfd61e9871c11e8536ef277cc147f77ab3f2ae6821e87c9edb255ab1d8981199ec9bdce9232be8c127db9bf12f30776d03ed8a1587b1

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+### 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 +30,4 @@
   * None
 
 * bug fix
-  * Calling #exists? no longer alters the original input.
+  * Calling #exists? no longer alters the original input.

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

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.version       = LittleWeasel::VERSION
   spec.authors       = ['Gene M. Angelo, Jr.']
   spec.email         = ['public.gma@gmail.com']
-  spec.description   = 'Simple spellchecker for single, or multiple word blocks.'
-  spec.summary       = 'Simply checks a word or group of words for validity against an english dictionary file.'
+  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'
 
@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
   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', '~> 0'
+  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'

data/README.md

@@ -4,7 +4,7 @@
 [![](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/simple_command_dispatcher/issues)
+[![Report Issues](https://img.shields.io/badge/report-issues-red.svg)](https://github.com/gangelo/LittleWeasel/issues)
 
 [![License](http://img.shields.io/badge/license-MIT-yellowgreen.svg)](#license)
 

data/lib/LittleWeasel/dictionary_key.rb

@@ -19,10 +19,10 @@ module LittleWeasel
 
     def initialize(language:, region: nil, tag: nil)
       validate_language language: language
-      self.language = self.class.normalize_language language
+      self.language = normalize_language language
 
       validate_region region: region
-      self.region = self.class.normalize_region region
+      self.region = normalize_region region
 
       validate_tag tag: tag
       self.tag = tag

data/lib/LittleWeasel/dictionary_manager.rb

@@ -17,12 +17,18 @@ module LittleWeasel
       init
     end
 
-    def dictionary_for(dictionary_key:)
+    # Returns true if a Dictionary object exists in the dictionary cache
+    # for the given dictionary_key.
+    def dictionary_exist?(dictionary_key:)
       validate_dictionary_key dictionary_key: dictionary_key
 
-      unless dictionary_cache_service(dictionary_key: dictionary_key).dictionary_exists?
-        # TODO: Raise an error or let the service handle it?
-      end
+      dictionary_cache_service(dictionary_key: dictionary_key).dictionary_exist?
+    end
+
+    # Returns the Dictionary object associated with the dictionary_key. If the
+    # Dictionary object does not exist in the dictionary cache, an error is raised.
+    def dictionary_for(dictionary_key:)
+      validate_dictionary_key dictionary_key: dictionary_key
 
       dictionary_cache_service(dictionary_key: dictionary_key).dictionary_object!
     end

data/lib/LittleWeasel/metadata/metadatable.rb

@@ -7,6 +7,8 @@ module LittleWeasel
   module Metadata
     # This module defines methods to support objects that manage other objects
     # that manage metadata related to a dictionary/ies.
+    # rubocop: disable Lint/UnusedMethodArgument, ignored - Methods in this
+    #          module need to keep their argument names because of specs.
     module Metadatable
       def self.included(base)
         base.extend ClassMethods
@@ -52,12 +54,9 @@ module LittleWeasel
       #     self.metadata = Services::InvalidWordsService.new(dictionary_words).execute
       #     self
       #   end
-      #
-      # rubocop: disable Lint/UnusedMethodArgument
       def init(params: nil)
         raise Errors::MustOverrideError
       end
-      # rubocop: enable Lint/UnusedMethodArgument
 
       # This method should refresh the local metadata from the dictionary cache,
       # if metadata exists in the dictionary cache for the given metatata_key.
@@ -74,11 +73,9 @@ module LittleWeasel
       #     init unless metadata.present?
       #     self
       #   end
-      # rubocop: disable Lint/UnusedMethodArgument
       def refresh(params: nil)
         raise Errors::MustOverrideError
       end
-      # rubocop: enable Lint/UnusedMethodArgument
 
       private
 
@@ -126,11 +123,12 @@ module LittleWeasel
       #     dictionary_cache_service.dictionary_metadata_set(
       #       metadata_key: metadata_key, value: value)
       #   end
-      # rubocop: disable Lint/UnusedMethodArgument
+      # :reek:UnusedParameters, ignored - This method is meant to be called with the given argument and raises an
+      #   error if not overridden
       def update_dictionary_metadata(value:)
         raise Errors::MustOverrideError
       end
-      # rubocop: enable Lint/UnusedMethodArgument
     end
+    # rubocop: enable Lint/UnusedMethodArgument
   end
 end

data/lib/LittleWeasel/modules/dictionary_cache_validatable.rb

@@ -7,13 +7,11 @@ module LittleWeasel
     # related to one or more dictionaries. Dictionary cache objects are
     # normally specific to a DictionaryManager object.
     module DictionaryCacheValidatable
-      def self.validate(dictionary_cache:)
-        raise ArgumentError, "Argument dictionary_cache is not a valid Hash object: #{dictionary_cache.class}" \
-          unless dictionary_cache.is_a? Hash
-      end
+      module_function
 
       def validate_dictionary_cache(dictionary_cache:)
-        DictionaryCacheValidatable.validate dictionary_cache: dictionary_cache
+        raise ArgumentError, "Argument dictionary_cache is not a valid Hash object: #{dictionary_cache.class}" \
+          unless dictionary_cache.is_a? Hash
       end
     end
   end

data/lib/LittleWeasel/modules/dictionary_key_validatable.rb

@@ -6,13 +6,11 @@ module LittleWeasel
   module Modules
     # Provides methods to validate a dictionary key object.
     module DictionaryKeyValidatable
-      def self.validate(dictionary_key:)
-        raise ArgumentError, "Argument dictionary_key is not a valid DictionaryKey object: #{dictionary_key.class}" \
-          unless dictionary_key.is_a? DictionaryKey
-      end
+      module_function
 
       def validate_dictionary_key(dictionary_key:)
-        DictionaryKeyValidatable.validate(dictionary_key: dictionary_key)
+        raise ArgumentError, "Argument dictionary_key is not a valid DictionaryKey object: #{dictionary_key.class}" \
+          unless dictionary_key.is_a? DictionaryKey
       end
     end
   end

data/lib/LittleWeasel/modules/dictionary_metadata_validatable.rb

@@ -4,13 +4,11 @@ module LittleWeasel
   module Modules
     # This module provides methods to validate a dictionary metadata object.
     module DictionaryMetadataValidatable
-      def self.validate(dictionary_metadata:)
-        raise ArgumentError, "Argument dictionary_metadata is not a valid Hash object: #{dictionary_metadata.class}" \
-          unless dictionary_metadata.is_a? Hash
-      end
+      module_function
 
       def validate_dictionary_metadata(dictionary_metadata:)
-        DictionaryMetadataValidatable.validate dictionary_metadata: dictionary_metadata
+        raise ArgumentError, "Argument dictionary_metadata is not a valid Hash object: #{dictionary_metadata.class}" \
+          unless dictionary_metadata.is_a? Hash
       end
     end
   end

data/lib/LittleWeasel/modules/dictionary_source_validatable.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module LittleWeasel
+  module Modules
+    # This module provides methods to validate a dictionary source.
+    module DictionarySourceValidatable
+      module_function
+
+      def validate_dictionary_source(dictionary_source:)
+        raise ArgumentError, 'Argument dictionary_source is not present' \
+          unless dictionary_source.present?
+      end
+    end
+  end
+end

data/lib/LittleWeasel/modules/dictionary_sourceable.rb

@@ -1,26 +1,86 @@
 # frozen_string_literal: true
 
 require 'securerandom'
+require_relative '../modules/dictionary_cache_keys'
+require_relative '../modules/dictionary_source_validatable'
+require_relative '../modules/dictionary_validatable'
 
 module LittleWeasel
   module Modules
     # This module provides methods to manage dictionary sources.
     module DictionarySourceable
-      MEMORY_SOURCE = '*'
+      include Modules::DictionaryCacheKeys
+      include Modules::DictionarySourceValidatable
+      include Modules::DictionaryValidatable
 
-      module_function
+      MEMORY_SOURCE = '*'
 
-      def file_source?(source)
-        !memory_source? source
+      def self.file_source?(dictionary_source)
+        !memory_source? dictionary_source
       end
 
-      def memory_source?(source)
-        source =~ /^#{Regexp.quote(MEMORY_SOURCE)}[0-9a-fA-F]{8}$/
+      def self.memory_source?(dictionary_source)
+        dictionary_source =~ /^#{Regexp.quote(MEMORY_SOURCE)}[0-9a-fA-F]{8}$/
       end
 
       def memory_source
         "#{MEMORY_SOURCE}#{SecureRandom.uuid[0..7]}"
       end
+      module_function :memory_source
+
+      # Adds a dictionary source. A "dictionary source" specifies the source from which
+      # the dictionary ultimately obtains its words.
+      #
+      # @param source [String] the dictionary source. This can be a file path
+      # or a memory source indicator to signify that the dictionary was created
+      # dynamically from memory.
+      def add_dictionary_source(dictionary_source:)
+        validate_dictionary_source_does_not_exist dictionary_cache_service: self
+
+        set_dictionary_reference \
+          dictionary_id: dictionary_id_associated_with(dictionary_source: dictionary_source)
+        # Only set the dictionary source if it doesn't already exist because settings
+        # the dictionary source wipes out the #dictionary_object; dictionary objects
+        # can have more than one dictionary reference pointing to them, and we don't
+        # want to blow away the #dictionary_object, metadata, or any other data
+        # associated with it if it already exists.
+        set_dictionary_source(dictionary_source: dictionary_source) unless dictionary?
+        self
+      end
+
+      def dictionary_source
+        dictionary_cache.dig(DICTIONARY_CACHE, DICTIONARIES, dictionary_id, SOURCE)
+      end
+      alias dictionary_file dictionary_source
+
+      def dictionary_source!
+        raise ArgumentError, "A dictionary source could not be found for key '#{key}'." \
+          unless dictionary_reference?
+
+        dictionary_cache[DICTIONARY_CACHE][DICTIONARIES][dictionary_id!][SOURCE]
+      end
+      alias dictionary_file! dictionary_source!
+
+      private
+
+      # Sets the dictionary source in the dictionary cache.
+      def set_dictionary_source(dictionary_source:)
+        dictionary_cache[DICTIONARY_CACHE][DICTIONARIES][dictionary_id!] = {
+          SOURCE => dictionary_source,
+          DICTIONARY_OBJECT => {}
+        }
+      end
+
+      # Returns the dictionary_id for the dictionary_source if it exists in
+      # dictionaries; otherwise, returns the new dictionary id that should
+      # be used.
+      def dictionary_id_associated_with(dictionary_source:)
+        dictionaries = dictionary_cache.dig(DICTIONARY_CACHE, DICTIONARIES)
+        dictionaries&.each_pair do |dictionary_id, dictionary_hash|
+          return dictionary_id if dictionary_source == dictionary_hash[SOURCE]
+        end
+        SecureRandom.uuid[0..7]
+      end
     end
   end
 end

data/lib/LittleWeasel/modules/dictionary_validatable.rb

@@ -13,18 +13,6 @@ module LittleWeasel
           raise "The dictionary source associated with key '#{dictionary_cache_service.key}' already exists."
         end
       end
-
-      def validate_dictionary_does_not_exist(dictionary_cache_service:)
-        if dictionary_cache_service.dictionary_exists?
-          raise "The dictionary associated with key '#{dictionary_cache_service.key}' already exists."
-        end
-      end
-
-      def validate_dictionary_reference_does_not_exist(dictionary_cache_service:)
-        if dictionary_cache_service.dictionary_reference?
-          raise "A dictionary reference associated with key '#{dictionary_cache_service.key}' already exists."
-        end
-      end
     end
   end
 end

data/lib/LittleWeasel/modules/language.rb

@@ -1,22 +1,23 @@
 # frozen_string_literal: true
 
+require 'active_support/core_ext/object/blank'
+
 module LittleWeasel
   module Modules
     # Provides methods for normalizing language for a locale.
     module Language
-      def self.included(base)
-        base.extend(ClassMethods)
+      def language?
+        language.present?
       end
 
-      # class method inclusions for convenience.
-      module ClassMethods
-        def normalize_language(language)
-          language&.downcase
-        end
+      def normalize_language!
+        self.language = normalize_language language
       end
 
-      def normalize_language
-        self.class.normalize_language language
+      module_function
+
+      def normalize_language(language)
+        language&.downcase
       end
     end
   end

data/lib/LittleWeasel/modules/language_validatable.rb

@@ -4,12 +4,10 @@ module LittleWeasel
   module Modules
     # This module provides methods to validate a language.
     module LanguageValidatable
-      def self.validate(language:)
-        raise ArgumentError, "Argument language '#{language}' is not a Symbol." unless language.is_a? Symbol
-      end
+      module_function
 
       def validate_language(language:)
-        LanguageValidatable.validate language: language
+        raise ArgumentError, "Argument language '#{language}' is not a Symbol." unless language.is_a? Symbol
       end
     end
   end

data/lib/LittleWeasel/modules/locale.rb

@@ -8,32 +8,15 @@ module LittleWeasel
     # This module provides methods to handle conversion of parts of a locale to
     # their string counter parts.
     module Locale
-      def self.included(base)
-        base.extend(ClassMethods)
-        base.include(Language)
-        base.include(Region)
-      end
-
-      # class method inclusions for convenience.
-      module ClassMethods
-        def locale(language:, region: nil)
-          raise ArgumentError, 'Argument language does not respond to :downcase' unless language.respond_to? :downcase
-
-          if region.present? && !region.respond_to?(:upcase)
-            raise ArgumentError,
-              'Argument region does not respond to :upcase'
-          end
-
-          language = normalize_language language
-          return language.to_s unless region.present?
-
-          region = normalize_region region
-          "#{language}-#{region}"
-        end
-      end
+      include Language
+      include Region
 
       def locale
-        self.class.locale language: language, region: region
+        language = normalize_language self.language
+        return language.to_s unless region?
+
+        region = normalize_region self.region
+        "#{language}-#{region}"
       end
     end
   end

data/lib/LittleWeasel/modules/order_validatable.rb

@@ -5,13 +5,11 @@ module LittleWeasel
     # This module provides methods to validate a value that can be used
     # in sorting.
     module OrderValidatable
-      def self.validate(order:)
-        raise ArgumentError, "Argument order is not an Integer: #{order.class}" unless order.is_a? Integer
-        raise ArgumentError, "Argument order '#{order}' is not a a number from 0-n" if order.negative?
-      end
+      module_function
 
       def validate_order(order:)
-        OrderValidatable.validate order: order
+        raise ArgumentError, "Argument order is not an Integer: #{order.class}" unless order.is_a? Integer
+        raise ArgumentError, "Argument order '#{order}' is not a a number from 0-n" if order.negative?
       end
     end
   end

data/lib/LittleWeasel/modules/region.rb

@@ -1,22 +1,23 @@
 # frozen_string_literal: true
 
+require 'active_support/core_ext/object/blank'
+
 module LittleWeasel
   module Modules
     # Provides methods for normalizing a region for a locale.
     module Region
-      def self.included(base)
-        base.extend(ClassMethods)
+      def region?
+        region.present?
       end
 
-      # class method inclusions for convenience.
-      module ClassMethods
-        def normalize_region(region)
-          region&.upcase
-        end
+      def normalize_region!
+        self.region = normalize_region region
       end
 
-      def normalize_region
-        self.class.normalize_region region
+      module_function
+
+      def normalize_region(region)
+        region&.upcase
       end
     end
   end

data/lib/LittleWeasel/modules/region_validatable.rb

@@ -4,12 +4,10 @@ module LittleWeasel
   module Modules
     # This module provides methods to validate a region.
     module RegionValidatable
-      def self.validate(region:)
-        raise ArgumentError, "Argument region '#{region}' is not a Symbol." unless region.blank? || region.is_a?(Symbol)
-      end
+      module_function
 
       def validate_region(region:)
-        RegionValidatable.validate region: region
+        raise ArgumentError, "Argument region '#{region}' is not a Symbol." unless region.blank? || region.is_a?(Symbol)
       end
     end
   end

data/lib/LittleWeasel/modules/tag_validatable.rb

@@ -4,12 +4,10 @@ module LittleWeasel
   module Modules
     # This module provides methods to validate a tag.
     module TagValidatable
-      def self.validate(tag:)
-        raise ArgumentError, "Argument tag '#{tag}' is not a Symbol." unless tag.blank? || tag.is_a?(Symbol)
-      end
+      module_function
 
       def validate_tag(tag:)
-        TagValidatable.validate tag: tag
+        raise ArgumentError, "Argument tag '#{tag}' is not a Symbol." unless tag.blank? || tag.is_a?(Symbol)
       end
     end
   end

data/lib/LittleWeasel/preprocessors/preprocessed_word.rb

@@ -7,6 +7,7 @@ module LittleWeasel
     # are used to preprocess a word before it is passed to any
     # Filters::WordFilters, and before it is compared against the
     # dictionary for validity.
+    # :reek:Attribute, ignored - Fixing this would result in nothing but trivial setter methods
     class PreprocessedWord
       attr_accessor :original_word, :preprocessed, :preprocessed_word, :preprocessor, :preprocessor_order
 

data/lib/LittleWeasel/preprocessors/preprocessed_word_validatable.rb

@@ -4,6 +4,7 @@ module LittleWeasel
   module Preprocessors
     # This module provides functionality that validates preprocessed word types.
     # rubocop: disable Layout/LineLength
+    # :reek:ManualDispatch, ignored - these methods are raising errors, not performing conditional code execution
     module PreprocessedWordValidatable
       module_function
 

data/lib/LittleWeasel/preprocessors/preprocessed_words.rb

@@ -5,8 +5,7 @@ module LittleWeasel
     # This class provides a container for Preprocessors::PreprocessedWord
     # objects.
     class PreprocessedWords
-      attr_reader :original_word
-      attr_accessor :preprocessed_words
+      attr_reader :original_word, :preprocessed_words
 
       # original_word:String the unsullied word before any preprocessing has
       # been applied to it.
@@ -38,6 +37,11 @@ module LittleWeasel
         end
       end
 
+      def preprocessed_words=(value)
+        value ||= []
+        @preprocessed_words = value
+      end
+
       def preprocessed_word
         self.class.preprocessed_word preprocessed_words: preprocessed_words
       end

data/lib/LittleWeasel/preprocessors/preprocessed_words_validatable.rb

@@ -9,6 +9,7 @@ module LittleWeasel
     module PreprocessedWordsValidatable
       module_function
 
+      # :reek:ManualDispatch, ignored - this is raising an error, not conditional code execution
       def validate_prepreprocessed_words(preprocessed_words:)
         raise ArgumentError, validation_error_message(object: preprocessed_words, respond_to: :original_word) unless preprocessed_words.respond_to? :original_word
         raise ArgumentError, validation_error_message(object: preprocessed_words, respond_to: :preprocessed_words) unless preprocessed_words.respond_to? :preprocessed_words

data/lib/LittleWeasel/preprocessors/word_preprocessor.rb

@@ -11,6 +11,7 @@ module LittleWeasel
     # word preprocessors. A "word preprocessor" is an object that manipulates a
     # word before it is passed to any word filters and before it is compared
     # against the dictionary for validity.
+    # :reek:MissingSafeMethod, ignored - safe methods for preprocessor_on!/off! make no sense in this case
     class WordPreprocessor
       include Modules::ClassNameToSymbol
       include Modules::Orderable