LittleWeasel 4.0.0 → 5.0.0

data/lib/LittleWeasel/services/dictionary_cache_service.rb

@@ -4,7 +4,6 @@ require_relative '../modules/dictionary_cache_keys'
 require_relative '../modules/dictionary_cache_validatable'
 require_relative '../modules/dictionary_keyable'
 require_relative '../modules/dictionary_sourceable'
-require_relative '../modules/dictionary_validatable'
 
 module LittleWeasel
   module Services
@@ -17,11 +16,10 @@ module LittleWeasel
     # objects to share dictionary information, in particular, the dictionary
     # file and dictionary metadata.
     class DictionaryCacheService
-      include Modules::DictionaryKeyable
-      include Modules::DictionaryCacheValidatable
       include Modules::DictionaryCacheKeys
+      include Modules::DictionaryCacheValidatable
+      include Modules::DictionaryKeyable
       include Modules::DictionarySourceable
-      include Modules::DictionaryValidatable
 
       attr_reader :dictionary_cache
 
@@ -129,26 +127,6 @@ module LittleWeasel
         dictionary_cache[DICTIONARY_CACHE][DICTIONARIES].key? dictionary_id
       end
 
-      # 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(source:)
-        validate_dictionary_source_does_not_exist dictionary_cache_service: self
-
-        dictionary_id = dictionary_id_for_dictionary_source(source: source)
-        self.dictionary_reference = dictionary_id
-        # 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.
-        self.dictionary_source = source unless dictionary?
-        self
-      end
-
       # Returns the dictionary id if there is a dictionary id in the dictionary
       # cache associated with the given key; nil otherwise.
       def dictionary_id
@@ -164,25 +142,19 @@ module LittleWeasel
         raise ArgumentError, "A dictionary id could not be found for key '#{key}'."
       end
 
-      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!
-
-      def dictionary_source
-        dictionary_cache.dig(DICTIONARY_CACHE, DICTIONARIES, dictionary_id, SOURCE)
-      end
-      alias dictionary_file dictionary_source
-
       # This method returns true if the dictionary associated with the
       # given dictionary key is loaded/cached. If this is the case,
       # a dictionary object is available in the dictionary cache.
       def dictionary_object?
         dictionary_object.present?
       end
-      alias dictionary_exists? dictionary_object?
+      alias dictionary_exist? dictionary_object?
+
+      # <b>DEPRECATED:</b> Use <tt>dictionary_exist?</tt> instead.
+      def dictionary_exists?
+        warn "[DEPRECATION] 'dictionary_exists?' is deprecated. Please use 'dictionary_exist?' instead."
+        dictionary_object?
+      end
 
       # Returns the dictionary object from the dictionary cache for the given
       # key. This method raises an error if the dictionary is not in the cache;
@@ -209,7 +181,7 @@ module LittleWeasel
         end
         return if object.equal? dictionary_object
 
-        if dictionary_exists?
+        if dictionary_exist?
           raise ArgumentError,
             "The dictionary is already loaded/cached for key '#{key}'; use #unload or #kill first."
         end
@@ -225,35 +197,12 @@ module LittleWeasel
         dictionary_cache.dig(DICTIONARY_CACHE, DICTIONARY_REFERENCES, key)
       end
 
-      def dictionary_reference=(dictionary_id)
+      def set_dictionary_reference(dictionary_id:)
         dictionary_cache[DICTIONARY_CACHE][DICTIONARY_REFERENCES][key] = {
           DICTIONARY_ID => dictionary_id
         }
       end
 
-      # Returns the dictionary_id for the source if it exists in dictionaries;
-      # otherwise, returns the new dictionary id that should be used.
-      def dictionary_id_for_dictionary_source(source:)
-        dictionary_source?(source: source) || SecureRandom.uuid[0..7]
-      end
-
-      # Returns the dictionary_id associated with source if source exists;
-      # nil otherwise.
-      def dictionary_source?(source:)
-        dictionaries = dictionary_cache.dig(DICTIONARY_CACHE, DICTIONARIES)
-        dictionaries&.each_pair do |dictionary_id, dictionary_hash|
-          return dictionary_id if source == dictionary_hash[SOURCE]
-        end
-        nil
-      end
-
-      def dictionary_source=(source)
-        dictionary_cache[DICTIONARY_CACHE][DICTIONARIES][dictionary_id!] = {
-          SOURCE => source,
-          DICTIONARY_OBJECT => {}
-        }
-      end
-
       def dictionary_id?
         dictionary_id.present?
       end

data/lib/LittleWeasel/services/dictionary_creator_service.rb

@@ -77,7 +77,7 @@ module LittleWeasel
       #
       # @return returns a reference to self.
       def add_dictionary_file_source(file:)
-        dictionary_cache_service.add_dictionary_source(source: file)
+        dictionary_cache_service.add_dictionary_source(dictionary_source: file)
       end
 
       # Adds a dictionary memory source. A "memory source" indicates that the
@@ -87,7 +87,7 @@ module LittleWeasel
       #
       # @return returns a reference to self.
       def add_dictionary_memory_source
-        dictionary_cache_service.add_dictionary_source(source: memory_source)
+        dictionary_cache_service.add_dictionary_source(dictionary_source: memory_source)
       end
     end
   end

data/lib/LittleWeasel/services/dictionary_file_loader_service.rb

@@ -25,7 +25,7 @@ module LittleWeasel
       end
 
       def execute
-        if dictionary_cache_service.dictionary_exists?
+        if dictionary_cache_service.dictionary_exist?
           raise ArgumentError,
             "The dictionary associated with key '#{key}' already exists."
         end

data/lib/LittleWeasel/services/dictionary_metadata_service.rb

@@ -42,7 +42,8 @@ module LittleWeasel
         # initialized state - all data is lost, but the object reference is
         # maintained.
         def init(dictionary_metadata:)
-          Modules::DictionaryMetadataValidatable.validate dictionary_metadata: dictionary_metadata
+          Modules::DictionaryMetadataValidatable.validate_dictionary_metadata \
+            dictionary_metadata: dictionary_metadata
 
           dictionary_metadata.each_key { |key| dictionary_metadata.delete(key) }
           dictionary_metadata
@@ -52,7 +53,8 @@ module LittleWeasel
         # it's in the same state the dictionary metadata would be in if #init
         # were called.
         def init?(dictionary_metadata:)
-          Modules::DictionaryMetadataValidatable.validate dictionary_metadata: dictionary_metadata
+          Modules::DictionaryMetadataValidatable.validate_dictionary_metadata \
+            dictionary_metadata: dictionary_metadata
 
           initialized_dictionary_metadata = init(dictionary_metadata: {})
           dictionary_metadata.eql?(initialized_dictionary_metadata)

data/lib/LittleWeasel/version.rb

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

data/spec/factories/dictionary_cache_service.rb

@@ -70,9 +70,9 @@ FactoryBot.define do
         else
           dictionary_file_source
         end
-        dictionary_cache_service.add_dictionary_source(source: dictionary_path_for(file_name: file_name))
+        dictionary_cache_service.add_dictionary_source(dictionary_source: dictionary_path_for(file_name: file_name))
       elsif dictionary_memory_source
-        dictionary_cache_service.add_dictionary_source(source: LittleWeasel::Modules::DictionarSourceable.memory_source)
+        dictionary_cache_service.add_dictionary_source(dictionary_source: LittleWeasel::Modules::DictionarSourceable.memory_source)
       end
 
       if load

data/spec/lib/LittleWeasel/dictionary_manager_spec.rb

@@ -3,6 +3,8 @@
 require 'spec_helper'
 
 RSpec.describe LittleWeasel::DictionaryManager do
+  include_context 'dictionary keys'
+
   subject { create(:dictionary_manager) }
 
   let(:dictionary_cache_service) { create(:dictionary_cache_service, dictionary_key: dictionary_key, dictionary_cache: dictionary_cache)}
@@ -31,6 +33,54 @@ RSpec.describe LittleWeasel::DictionaryManager do
     end
   end
 
+  #dictionary_exist?
+  describe '#dictionary_exist?' do
+    let!(:expected_dictionary_object) do
+      subject.create_dictionary_from_memory(dictionary_key: dictionary_key,
+          dictionary_words:  %w(My dictionary words) )
+    end
+
+    context 'when the dictionary exists' do
+      it 'returns true' do
+        expect(subject.dictionary_exist? dictionary_key: dictionary_key)
+          .to eq true
+      end
+    end
+
+    context 'when the dictionary DOES NOT exist' do
+      let(:en_gb_dictionary_key) { dictionary_key_for(language: :en, region: :gb) }
+
+      it 'returns false' do
+        expect(subject.dictionary_exist? dictionary_key: en_gb_dictionary_key)
+          .to eq false
+      end
+    end
+  end
+
+  #dictionary_for
+  describe '#dictionary_for' do
+    let!(:expected_dictionary_object) do
+      subject.create_dictionary_from_memory(dictionary_key: dictionary_key,
+          dictionary_words:  %w(My dictionary words) )
+    end
+
+    context 'when the dictionary exists' do
+      it 'returns the dictionary object' do
+        expect(subject.dictionary_for dictionary_key: dictionary_key)
+          .to be expected_dictionary_object
+      end
+    end
+
+    context 'when the dictionary DOES NOT exist' do
+      let(:en_gb_dictionary_key) { dictionary_key_for(language: :en, region: :gb) }
+
+      it 'raises an error' do
+        expect { subject.dictionary_for dictionary_key: en_gb_dictionary_key }
+          .to raise_error("The dictionary object associated with argument key '#{en_gb_dictionary_key.key}' is not in the cache.")
+      end
+    end
+  end
+
   #create_dictionary_from_file
   describe '#create_dictionary_from_file' do
     context 'when the dictionary DOES NOT exist' do
@@ -85,7 +135,7 @@ RSpec.describe LittleWeasel::DictionaryManager do
       it 'removes the dictionary, file source reference and metadata from the dictionary cache' do
         metadata_key # Capture this before we unload the dictionary
         subject.kill_dictionary(dictionary_key: dictionary_key)
-        expect(dictionary_cache_service.dictionary_exists?).to eq false
+        expect(dictionary_cache_service.dictionary_exist?).to eq false
         expect(dictionary_cache_service.dictionary_reference?).to eq false
         expect(dictionary_metadata_service.dictionary_metadata?(metadata_key: metadata_key)).to eq false
       end
@@ -103,7 +153,7 @@ RSpec.describe LittleWeasel::DictionaryManager do
       it 'removes the dictionary, memory source reference and metadata from the dictionary cache' do
         metadata_key # Capture this before we unload the dictionary
         subject.kill_dictionary(dictionary_key: dictionary_key)
-        expect(dictionary_cache_service.dictionary_exists?).to eq false
+        expect(dictionary_cache_service.dictionary_exist?).to eq false
         expect(dictionary_cache_service.dictionary_reference?).to eq false
         expect(dictionary_metadata_service.dictionary_metadata?(metadata_key: metadata_key)).to eq false
       end

data/spec/lib/LittleWeasel/metadata/invalid_words_metadata_spec.rb

@@ -35,7 +35,7 @@ RSpec.describe LittleWeasel::Metadata::InvalidWordsMetadata do
       subject { invalid_words_metadata }
 
       before do
-        dictionary_cache_service.add_dictionary_source(source: file)
+        dictionary_cache_service.add_dictionary_source(dictionary_source: file)
       end
 
       context 'with invalid dictionary metadata object' do

data/spec/lib/LittleWeasel/modules/dictionary_sourceable_spec.rb

@@ -3,10 +3,24 @@
 require 'spec_helper'
 
 RSpec.describe LittleWeasel::Modules::DictionarySourceable, type: :module do
+  subject { MockDictionarySourceable.new(dictionary_memory_source) }
+
+  DictionarySourceable = described_class
+
+  class MockDictionarySourceable
+    include DictionarySourceable
+
+    def initialize(dictionary_source)
+      self.dictionary_source = dictionary_source
+    end
+  end
+
+  let(:dictionary_memory_source) { described_class.memory_source }
+  let(:dictionary_file_source) { language_dictionary_path language: :en }
 
   #.MEMORY_SOURCE
   describe '::MEMORY_SOURCE' do
-    it 'returns the memory source value' do
+    it 'returns the memory source prefix' do
       expect(described_class::MEMORY_SOURCE).to eq '*'
     end
   end
@@ -14,31 +28,54 @@ RSpec.describe LittleWeasel::Modules::DictionarySourceable, type: :module do
   #.memory_source
   describe '.memory_source' do
     it 'returns a new memory source' do
-      expect(described_class.memory_source?(described_class.memory_source)).to be_truthy
+      expect(described_class.memory_source).to be_truthy
+    end
+  end
+
+  #.file_source?
+  describe '.file_source?' do
+    context 'when dictionary_source is a file source' do
+      it 'returns truthy' do
+        expect(described_class.file_source? dictionary_file_source).to be_truthy
+      end
+    end
+
+    context 'when dictionary_source is NOT a file source' do
+      it 'returns falsey' do
+        expect(described_class.file_source? dictionary_memory_source).to be_falsey
+      end
     end
   end
 
   #.memory_source?
   describe '.memory_source?' do
-    it 'returns truthy if argument is a valid memory source' do
-      expect(described_class.memory_source? '*12345678').to be_truthy
-      expect(described_class.memory_source? '*abcdef00').to be_truthy
-      expect(described_class.memory_source? '*ABCDEF00').to be_truthy
-      expect(described_class.memory_source? '*aBcDeF00').to be_truthy
+    context 'when dictionary_source is a memory source' do
+      it 'returns truthy if argument is a valid memory source' do
+        expect(described_class.memory_source? '*12345678').to be_truthy
+        expect(described_class.memory_source? '*abcdef00').to be_truthy
+        expect(described_class.memory_source? '*ABCDEF00').to be_truthy
+        expect(described_class.memory_source? '*aBcDeF00').to be_truthy
+      end
+
+      it 'returns falsey if argument is NOT a memory source' do
+        expect(described_class.memory_source? '*123456789').to be_falsey
+        expect(described_class.memory_source? '*abcdefg0').to be_falsey
+        expect(described_class.memory_source? '*ABCDEFG0').to be_falsey
+        expect(described_class.memory_source? '*aBcDeFg0').to be_falsey
+        expect(described_class.memory_source? '$12345678').to be_falsey
+
+        expect(described_class.memory_source? '123456789').to be_falsey
+        expect(described_class.memory_source? 'abcdefg0').to be_falsey
+        expect(described_class.memory_source? 'ABCDEFG0').to be_falsey
+        expect(described_class.memory_source? 'aBcDeFg0').to be_falsey
+        expect(described_class.memory_source? '123456789').to be_falsey
+      end
     end
 
-    it 'returns falsey if argument is NOT a memory source' do
-      expect(described_class.memory_source? '*123456789').to be_falsey
-      expect(described_class.memory_source? '*abcdefg0').to be_falsey
-      expect(described_class.memory_source? '*ABCDEFG0').to be_falsey
-      expect(described_class.memory_source? '*aBcDeFg0').to be_falsey
-      expect(described_class.memory_source? '$12345678').to be_falsey
-
-      expect(described_class.memory_source? '123456789').to be_falsey
-      expect(described_class.memory_source? 'abcdefg0').to be_falsey
-      expect(described_class.memory_source? 'ABCDEFG0').to be_falsey
-      expect(described_class.memory_source? 'aBcDeFg0').to be_falsey
-      expect(described_class.memory_source? '123456789').to be_falsey
+    context 'when dictionary_source is a file source' do
+      it 'returns falsey' do
+        expect(described_class.memory_source? dictionary_file_source).to be_falsey
+      end
     end
   end
 end

data/spec/lib/LittleWeasel/modules/language_spec.rb

@@ -23,14 +23,66 @@ RSpec.describe LittleWeasel::Modules::Language, type: :module do
 
   let(:language) {}
 
-  #normalize_language
-  describe '#normalize_language' do
+  #language?
+  describe '#language?' do
+    context 'when language is present?' do
+      let(:language) { :es }
+
+      it 'returns true' do
+        expect(subject.language?).to eq true
+      end
+    end
+
+    context 'when language is NOT present?' do
+      it 'returns false' do
+        expect(subject.language?).to eq false
+      end
+    end
+  end
+
+  #normalize_language!
+  describe '#normalize_language!' do
+    context 'when language is present?' do
+      context 'when language responds to #upcase!' do
+        before do
+          subject.normalize_language!
+        end
+
+        let(:language) { :AA }
+
+        it 'changes language to lower case' do
+          expect(subject.language).to eq :aa
+        end
+      end
+
+      context 'when language DOES NOT respond to #downcase' do
+        let(:language) { Object.new }
+
+        it 'raises an error' do
+          expect { subject.normalize_language! }.to raise_error(NoMethodError, /undefined method `downcase'/)
+        end
+      end
+    end
+
+    context 'when language is NOT present?' do
+      before do
+        subject.normalize_language!
+      end
+
+      it 'does nothing' do
+        expect(subject.language).to be_nil
+      end
+    end
+  end
+
+  #.normalize_language
+  describe '#.normalize_language' do
     context 'with a non-nil language' do
       context 'when passing a Symbol' do
         let(:language) { :AbCdEfG }
 
         it 'converts the language to a lower-case Symbol' do
-          expect(subject.normalize_language).to eq :abcdefg
+          expect(described_class.normalize_language(language)).to eq :abcdefg
         end
       end
 
@@ -38,14 +90,22 @@ RSpec.describe LittleWeasel::Modules::Language, type: :module do
         let(:language) { 'AbCdEfG' }
 
         it 'converts the language to a lower-case String' do
-          expect(subject.normalize_language).to eq 'abcdefg'
+          expect(described_class.normalize_language(language)).to eq 'abcdefg'
         end
       end
     end
 
     context 'with a nil language' do
       it 'returns nil' do
-        expect(subject.normalize_language).to be_nil
+        expect(described_class.normalize_language(language)).to be_nil
+      end
+    end
+
+    context 'when language does not respond to #downcase' do
+      let(:language) { 1 }
+
+      it 'returns nil' do
+        expect { described_class.normalize_language(language) }.to raise_error(NoMethodError, /undefined method `downcase'/)
       end
     end
   end

data/spec/lib/LittleWeasel/modules/locale_spec.rb

@@ -25,51 +25,6 @@ RSpec.describe LittleWeasel::Modules::Locale, type: :module do
   let(:language) {}
   let(:region) {}
 
-  #.locale
-  describe '.locale' do
-    it 'adds the class method when included' do
-      expect(subject.class).to respond_to(:locale)
-    end
-
-    context 'with valid arguments' do
-      let(:language) { :en }
-      let(:region) { :us }
-
-      it 'returns the locale as a string' do
-        expect(subject.class.locale language: language, region: region).to eq 'en-US'
-      end
-    end
-
-    context 'with INVALID arguments' do
-      context 'with an invalid language' do
-        let(:language) {}
-        let(:region) { :us }
-
-        it 'raises an error' do
-          expect { subject.class.locale language: language, region: region }.to raise_error 'Argument language does not respond to :downcase'
-        end
-      end
-
-      context 'when region is nil' do
-        let(:language) { :en }
-        let(:region) {}
-
-        it 'returns the expected locale as a string' do
-          expect(subject.class.locale language: language, region: region).to eq language.downcase.to_s
-        end
-      end
-
-      context 'when region is invalid' do
-        let(:language) { :en }
-        let(:region) { 1 }
-
-        it 'raises an error' do
-          expect { subject.class.locale language: language, region: region }.to raise_error 'Argument region does not respond to :upcase'
-        end
-      end
-    end
-  end
-
   #locale
   describe '#locale' do
     context 'with valid arguments' do
@@ -119,20 +74,20 @@ RSpec.describe LittleWeasel::Modules::Locale, type: :module do
     end
 
     context 'with invalid arguments' do
-      context 'with invalid language' do
+      context 'when argument language does not respond to #downcase' do
         let(:language) { 1 }
 
         it 'raises an error' do
-          expect { subject.locale }.to raise_error 'Argument language does not respond to :downcase'
+          expect { subject.locale }.to raise_error(NoMethodError, /undefined method `downcase'/)
         end
       end
 
-      context 'with invalid region' do
+      context 'when argument region does not respond to #upcase' do
         let(:language) { :en }
         let(:region) { 1 }
 
         it 'raises an error' do
-          expect { subject.locale }.to raise_error 'Argument region does not respond to :upcase'
+          expect { subject.locale }.to raise_error(NoMethodError, /undefined method `upcase'/)
         end
       end
     end

data/spec/lib/LittleWeasel/modules/region_spec.rb

@@ -23,14 +23,66 @@ RSpec.describe LittleWeasel::Modules::Region, type: :module do
 
   let(:region) {}
 
-  #normalize_region
-  describe '#normalize_region' do
+  #region?
+  describe '#region?' do
+    context 'when region is present?' do
+      let(:region) { :es }
+
+      it 'returns true' do
+        expect(subject.region?).to eq true
+      end
+    end
+
+    context 'when region is NOT present?' do
+      it 'returns false' do
+        expect(subject.region?).to eq false
+      end
+    end
+  end
+
+  #normalize_region!
+  describe '#normalize_region!' do
+    context 'when region is present?' do
+      context 'when region responds to #upcase' do
+        before do
+          subject.normalize_region!
+        end
+
+        let(:region) { :aa }
+
+        it 'changes region to upper case' do
+          expect(subject.region).to eq :AA
+        end
+      end
+
+      context 'when region DOES NOT respond to #upcase' do
+        let(:region) { Object.new }
+
+        it 'raises an error' do
+          expect { subject.normalize_region! }.to raise_error(NoMethodError, /undefined method `upcase'/)
+        end
+      end
+    end
+
+    context 'when region is NOT present?' do
+      before do
+        subject.normalize_region!
+      end
+
+      it 'does nothing' do
+        expect(subject.region).to be_nil
+      end
+    end
+  end
+
+  #.normalize_region
+  describe '#.normalize_region' do
     context 'with a non-nil region' do
       context 'when passing a Symbol' do
         let(:region) { :AbCdEfG }
 
         it 'converts the region to a upper-case Symbol' do
-          expect(subject.normalize_region).to eq :ABCDEFG
+          expect(described_class.normalize_region(region)).to eq :ABCDEFG
         end
       end
 
@@ -38,14 +90,22 @@ RSpec.describe LittleWeasel::Modules::Region, type: :module do
         let(:region) { 'AbCdEfG' }
 
         it 'converts the region to a upper-case String' do
-          expect(subject.normalize_region).to eq 'ABCDEFG'
+          expect(described_class.normalize_region(region)).to eq 'ABCDEFG'
         end
       end
     end
 
     context 'with a nil region' do
       it 'returns nil' do
-        expect(subject.normalize_region).to be_nil
+        expect(described_class.normalize_region(region)).to be_nil
+      end
+    end
+
+    context 'when region does not respond to #upcase' do
+      let(:region) { 1 }
+
+      it 'returns nil' do
+        expect { described_class.normalize_region(region) }.to raise_error(NoMethodError, /undefined method `upcase'/)
       end
     end
   end