LittleWeasel 3.0.4 → 4.0.0

data/spec/lib/LittleWeasel/services/dictionary_creator_service_spec.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe LittleWeasel::Services::DictionaryCreatorService do
+  include_context 'dictionary keys'
+  include_context 'mock word filters'
+  include_context 'mock word preprocessors'
+
+  subject { create(:dictionary_creator_service, dictionary_key: dictionary_key, dictionary_cache: dictionary_cache, dictionary_metadata: dictionary_metadata, word_filters: word_filters, word_preprocessors: word_preprocessors) }
+
+  let(:language) { :en }
+  let(:region) { :us }
+  let(:tag) {}
+  let(:dictionary_key) { create(:dictionary_key, language: language, region: region, tag: tag) }
+  let(:key) { dictionary_key.key }
+  let(:file) { dictionary_path_for(file_name: key) }
+  let(:dictionary_cache) { {} }
+  let(:dictionary_metadata) { {} }
+  let(:word_filters) {}
+  let(:word_preprocessors) {}
+
+  shared_examples 'it should' do
+    context 'with word_filters' do
+      context 'when argument word_filters contains word filters' do
+        let(:word_filters) do
+          [
+            DollarSignFilter.new,
+            LittleWeasel::Filters::EnUs::NumericFilter.new,
+            LittleWeasel::Filters::EnUs::SingleCharacterWordFilter.new
+          ]
+        end
+
+        it 'creates a dictionary with the word filters passed' do
+          expect(dictionary).to be_kind_of LittleWeasel::Dictionary
+          expect(dictionary.word_results('$').success?).to eq true
+          expect(dictionary.word_results('1000').success?).to eq true
+          expect(dictionary.word_results('A').success?).to eq true
+        end
+      end
+    end
+
+    context 'with NO word_filters' do
+      context 'when argument word_filters is an empty Array' do
+        let(:word_filters) { [] }
+
+        it 'creates a dictionary that uses no word filters' do
+          expect(dictionary).to be_kind_of LittleWeasel::Dictionary
+          expect(dictionary.word_filters).to be_blank
+        end
+      end
+
+      context 'when argument word_filters is nil' do
+        let(:word_filters) {}
+
+        it 'creates a dictionary that uses no word filters' do
+          expect(dictionary).to be_kind_of LittleWeasel::Dictionary
+          expect(dictionary.word_filters).to be_blank
+        end
+      end
+    end
+
+    context 'with word_preprocessors' do
+      let(:word_preprocessors) { [UpcaseWordPreprocessor.new(order: 0)] }
+      let(:word) { 'a' }
+
+      context 'when argument word_preprocessors contains word preprocessors' do
+        it 'creates a dictionary with the word preprocessors passed' do
+          expect(dictionary).to be_kind_of LittleWeasel::Dictionary
+          preprocessed_words = dictionary.word_results(word).preprocessed_words
+          expect(preprocessed_words.original_word).to eq word
+          expect(preprocessed_words.preprocessed_words.count).to eq 1
+          expect(preprocessed_words.preprocessed_words[0].original_word).to eq word
+          expect(preprocessed_words.preprocessed_words[0].preprocessed_word).to eq word.upcase
+          expect(preprocessed_words.preprocessed_words[0].preprocessor).to eq word_preprocessors[0].to_sym
+          expect(preprocessed_words.preprocessed_words[0].preprocessed).to eq true
+          expect(preprocessed_words.preprocessed_words[0].preprocessor_order).to eq word_preprocessors[0].order
+        end
+      end
+    end
+
+    context 'with NO word_preprocessors' do
+      context 'when argument word_preprocessors is an empty Array' do
+        let(:word_preprocessors) { [] }
+
+        it 'creates a dictionary that uses no word preprocessors' do
+          expect(dictionary).to be_kind_of LittleWeasel::Dictionary
+          expect(dictionary.word_preprocessors).to be_blank
+        end
+      end
+
+      context 'when argument word_preprocessors is nil' do
+        let(:word_preprocessors) {}
+
+        it 'creates a dictionary that uses no word preprocessors' do
+          expect(dictionary).to be_kind_of LittleWeasel::Dictionary
+          expect(dictionary.word_preprocessors).to be_blank
+        end
+      end
+    end
+  end
+
+  #from_file_source
+  describe '#from_file_source' do
+    let(:dictionary) { subject.from_file_source file: file }
+
+    it_behaves_like 'it should'
+  end
+
+  #from_memory_source
+  describe '#from_memory_source' do
+    let(:dictionary) { subject.from_memory_source dictionary_words: dictionary_words }
+    let(:dictionary_words) do
+      dictionary_words_for dictionary_file_path: file
+    end
+
+    it_behaves_like 'it should'
+  end
+end

data/spec/lib/LittleWeasel/services/dictionary_file_loader_service_spec.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe LittleWeasel::Services::DictionaryFileLoaderService do
+  include_context 'dictionary cache'
+
+  subject! { create(:dictionary_file_loader_service, dictionary_key: dictionary_key, dictionary_cache: dictionary_cache) }
+
+  before(:each) do
+    LittleWeasel::Services::DictionaryCacheService.init dictionary_cache: dictionary_cache
+  end
+
+  let(:dictionary_key) { create(:dictionary_key, language: :en, region: :us) }
+  let(:key) { dictionary_key.key }
+  let(:dictionary_cache) { {} }
+
+  #execute
+  describe '#execute' do
+    context 'when the dictionary is already loaded/cached' do
+      before do
+        create(:dictionary_cache_service, dictionary_key: dictionary_key, dictionary_cache: dictionary_cache, dictionary_file_source: true, load: true)
+      end
+
+      it 'raises an error' do
+        expect { subject.execute }.to raise_error "The dictionary associated with key '#{key}' already exists."
+      end
+    end
+
+    context 'when the dictionary is NOT already loaded/cached' do
+      before do
+        create(:dictionary_cache_service, dictionary_key: dictionary_key, dictionary_cache: dictionary_cache, dictionary_file_source: true)
+      end
+
+      let(:expected_key) { create(:dictionary_key, language: :en, region: :us).key }
+      let(:expected_results) do
+        ['apple',
+         'better',
+         'cat',
+         'dog',
+         'everyone',
+         'fat',
+         'game',
+         'help',
+         'italic',
+         'jasmine',
+         'kelp',
+         'love',
+         'man',
+         'nope',
+         'octopus',
+         'popeye',
+         'queue',
+         'ruby',
+         'stop',
+         'top',
+         'ultimate',
+         'very',
+         'was',
+         'xylophone',
+         'yes',
+         'zebra']
+      end
+
+      it 'returns an Array of dictionary words loaded from the file' do
+        expect(key).to eq expected_key
+        expect(subject.execute).to eq expected_results
+      end
+    end
+  end
+end

data/spec/lib/LittleWeasel/services/dictionary_loader_service_spec.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe LittleWeasel::Services::DictionaryLoaderService do
+  subject { create(:dictionary_loader_service, dictionary_key: dictionary_key, dictionary_cache: dictionary_cache, dictionary_metadata: dictionary_metadata) }
+
+  let(:language) { :en }
+  let(:region) { :us }
+  let(:tag) {}
+  let(:dictionary_key) { create(:dictionary_key, language: language, region: region, tag: tag) }
+  let(:dictionary_cache) { {} }
+  let(:dictionary_metadata) { {} }
+
+  #execute
+  describe '#execute' do
+    context 'when loading dictionaries created from a file' do
+      let!(:dictionary_cache_service) { create(:dictionary_cache_service, dictionary_file_source: true, dictionary_key: dictionary_key, dictionary_cache: dictionary_cache) }
+
+      context 'when the dictionary is not cached' do
+        it 'loads the dictionary file and returns the Dictionary' do
+          expect(dictionary_cache_service.dictionary_exists?).to be false
+          # Remove this line; there is a bug in SimpleCov that will not
+          # recognize #load_from_cache as having test coverage if we
+          # stub this out :(
+          # expect(subject).to_not receive(:load_from_cache)
+          expect(subject.execute).to be_kind_of LittleWeasel::Dictionary
+        end
+      end
+
+      context 'when the dictionary is cached' do
+        before do
+          # This will load the dictionary from disk, and cache it in
+          # the dictionary cache; the DictionaryLoaderService loads
+          # the dictionary into the dictionary cache if loaded from disk.
+          subject.execute
+        end
+
+        it 'loads the dictionary from the dictionary cache and returns the Dictionary' do
+          expect(dictionary_cache_service.dictionary_exists?).to be true
+          # Remove this line; there is a bug in SimpleCov that will not
+          # recognize #load_from_cache as having test coverage if we
+          # stub this out :(
+          # expect(subject).to receive(:load_from_cache).and_return(dictionary_cache_service.dictionary_object!)
+          expect(subject.execute).to be dictionary_cache_service.dictionary_object!
+        end
+      end
+    end
+  end
+end

data/spec/lib/LittleWeasel/services/dictionary_metadata_service_spec.rb

@@ -0,0 +1,279 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe LittleWeasel::Services::DictionaryMetadataService do
+  include_context 'dictionary cache'
+  include_context 'dictionary keys'
+
+  subject { create(:dictionary_metadata_service, dictionary_key: dictionary_key, dictionary_metadata: dictionary_metadata, dictionary_cache: dictionary_cache) }
+
+  let(:en_us_dictionary_key) { dictionary_key_for(language: :en, region: :us) }
+  let(:en_gb_dictionary_key) { dictionary_key_for(language: :en, region: :gb) }
+  let(:es_es_dictionary_key) { dictionary_key_for(language: :es, region: :es) }
+
+  let(:dictionary_key) { en_us_dictionary_key }
+  let(:key) { dictionary_key.key }
+  let(:file) { dictionary_path_for(file_name: key) }
+  let(:dictionary_cache) { {} }
+  let(:metadata_key) { :metadata_key }
+  let(:dictionary_metadata) do
+    {
+      0 => { metadata_key => :metadata_object0 },
+      1 => { metadata_key1: :metadata_object1 }
+    }
+  end
+
+  shared_examples 'the dictionary_metadata object reference has not changed' do
+    it 'the dictionary_metadata object has not changed' do
+      expect(actual_dictionary_metadata).to be expected_dictionary_metadata
+    end
+  end
+
+  shared_examples 'the dictionary_cache object reference has not changed' do
+    it 'the dictionary_cache object has not changed' do
+      expect(actual_dictionary_cache).to be expected_dictionary_cache
+    end
+  end
+
+  describe 'class methods' do
+    #.init
+    describe '.init' do
+      context 'with a valid dictionary metadata argument' do
+        it 'initializes the dictionary metadata' do
+          expect(described_class.init(dictionary_metadata: dictionary_metadata)).to eq({})
+        end
+
+        it_behaves_like 'the dictionary_metadata object reference has not changed' do
+          let(:expected_dictionary_metadata) { dictionary_metadata }
+          let(:actual_dictionary_metadata) { subject.dictionary_metadata }
+        end
+      end
+
+      context 'with an INVALID dictionary metadata argument' do
+        subject { described_class.init(dictionary_metadata: dictionary_metadata) }
+
+        it_behaves_like 'the dictionary_metadata is invalid'
+      end
+    end
+
+    #.init?
+    describe '.init?' do
+      context 'with a valid dictionary metadata argument' do
+        context 'when the dictionary metadata is in an initialized state' do
+          let(:dictionary_metadata) { {} }
+
+          it 'returns true' do
+            expect(described_class.init?(dictionary_metadata: dictionary_metadata)).to eq true
+          end
+        end
+
+        context 'when the dictionary metadata is NOT in an initialized state' do
+          it 'returns false' do
+            expect(described_class.init?(dictionary_metadata: dictionary_metadata)).to eq false
+          end
+        end
+      end
+
+      context 'with an INVALID dictionary metadata argument' do
+        subject { described_class.init?(dictionary_metadata: dictionary_metadata) }
+
+        it_behaves_like 'the dictionary_metadata is invalid'
+      end
+    end
+  end
+
+  #.new
+  describe '.new' do
+    context 'when the arguments are valid' do
+      it 'instantiates without errors' do
+        expect { subject }.to_not raise_error
+      end
+    end
+
+    it_behaves_like 'the dictionary_key is invalid'
+    it_behaves_like 'the dictionary_cache is invalid'
+    it_behaves_like 'the dictionary_metadata is invalid'
+  end
+
+  #init
+  describe '#init' do
+    let(:expected_dictionary_metadata) do
+      {
+        0 => { :metadata_key=>nil },
+        1 => { metadata_key1: :metadata_object1 }
+      }
+    end
+
+    context 'when the dictionary_id is valid' do
+      before do
+        allow(subject).to receive(:dictionary_id!).and_return(0)
+      end
+
+      it 'initializes the metadata associated with the dictionary id for the given metadata_key' do
+        expect(subject.get_dictionary_metadata(metadata_key: metadata_key)).to eq dictionary_metadata.dig(0, metadata_key)
+        subject.init(metadata_key: metadata_key)
+        expect(subject.get_dictionary_metadata(metadata_key: metadata_key)).to be_nil
+        expect(dictionary_metadata).to eq expected_dictionary_metadata
+      end
+
+      it_behaves_like 'the dictionary_metadata object reference has not changed' do
+        let(:expected_dictionary_metadata) { dictionary_metadata }
+        let(:actual_dictionary_metadata) { subject.dictionary_metadata }
+      end
+
+      it_behaves_like 'the dictionary_cache object reference has not changed' do
+        let(:expected_dictionary_cache) { dictionary_cache }
+        let(:actual_dictionary_cache) { subject.dictionary_cache_service.dictionary_cache }
+      end
+    end
+
+    context 'when the dictionary_id is INVALID' do
+      it 'raises an error' do
+        expect { subject.init(metadata_key: metadata_key) }.to raise_error "A dictionary id could not be found for key '#{key}'."
+      end
+    end
+  end
+
+  #dictionary_metadata?
+  describe '#dictionary_metadata?' do
+    before do
+      allow(subject).to receive(:dictionary_id).and_return(0)
+    end
+
+    context 'when there is dictionary metadata associated with the dictionary for the metadata_key' do
+      it 'returns true' do
+        expect(subject.dictionary_metadata?(metadata_key: metadata_key)).to eq true
+      end
+    end
+
+    context 'when there is NO dictionary metadata associated with the dictionary for the metadata_key' do
+      context 'when there is no dictionary metadata for the dictionary_id' do
+        let(:dictionary_metadata) do
+          {
+            99 => { metadata_key => :metadata_object }
+          }
+        end
+
+        it 'returns false' do
+          expect(subject.dictionary_metadata?(metadata_key: metadata_key)).to eq false
+        end
+      end
+
+      context 'when there is no dictionary metadata for the metadata_key' do
+        let(:dictionary_metadata) do
+          {
+            0 => { :wrong_metadata_key => :metadata_object }
+          }
+        end
+
+        it 'returns false' do
+          expect(subject.dictionary_metadata?(metadata_key: metadata_key)).to eq false
+        end
+      end
+
+      context 'when the dictionary metadata for the metadata_key is not present' do
+        let(:dictionary_metadata) do
+          {
+            0 => { metadata_key => nil }
+          }
+        end
+
+        it 'returns false' do
+          expect(subject.dictionary_metadata?(metadata_key: metadata_key)).to eq false
+        end
+      end
+    end
+  end
+
+  #get_dictionary_metadata
+  describe '#get_dictionary_metadata' do
+    before do
+      allow(subject).to receive(:dictionary_id!).and_return(0)
+    end
+
+    context 'when there is no dictionary_id found in the dictionary metadata associated with the dictionary key' do
+      before do
+        allow(subject).to receive(:dictionary_id!).and_call_original
+      end
+
+      it 'raises an error' do
+        expect { subject.get_dictionary_metadata(metadata_key: metadata_key) }.to raise_error "A dictionary id could not be found for key '#{key}'."
+      end
+    end
+
+    context 'when there is dictionary metadata associated with the dictionary for the metadata_key' do
+      it 'returns true' do
+        expect(subject.get_dictionary_metadata(metadata_key: metadata_key)).to eq :metadata_object0
+      end
+    end
+
+    context 'when there is NO dictionary metadata associated with the dictionary for the metadata_key' do
+      context 'when there is no dictionary metadata for the dictionary_id' do
+        let(:dictionary_metadata) do
+          {
+            99 => { metadata_key => :metadata_object0 }
+          }
+        end
+
+        it 'returns false' do
+          expect(subject.get_dictionary_metadata(metadata_key: metadata_key)).to eq nil
+        end
+      end
+
+      context 'when there is no dictionary metadata for the metadata_key' do
+        let(:dictionary_metadata) do
+          {
+            0 => { :wrong_metadata_key => :metadata_object0 }
+          }
+        end
+
+        it 'returns false' do
+          expect(subject.get_dictionary_metadata(metadata_key: metadata_key)).to eq nil
+        end
+      end
+
+      context 'when the dictionary metadata for the metadata_key is not present' do
+        let(:dictionary_metadata) do
+          {
+            0 => { metadata_key => nil }
+          }
+        end
+
+        it 'returns false' do
+          expect(subject.get_dictionary_metadata(metadata_key: metadata_key)).to eq nil
+        end
+      end
+    end
+  end
+
+  #set_dictionary_metadata
+  describe '#set_dictionary_metadata' do
+    before do
+      allow(subject).to receive(:dictionary_id!).and_return(0)
+    end
+
+    let(:new_metadata_object) { :new_metadata_object0 }
+
+    context 'when passing valid arguments' do
+      it 'returns self' do
+        expect(subject.set_dictionary_metadata(value: new_metadata_object, metadata_key: metadata_key)).to be subject
+      end
+
+      it 'sets the dictionary metadata value' do
+        subject.set_dictionary_metadata(value: new_metadata_object, metadata_key: metadata_key)
+        expect(subject.get_dictionary_metadata(metadata_key: metadata_key)).to eq new_metadata_object
+      end
+    end
+
+    context 'when there is no dictionary_id found in the dictionary metadata associated with the dictionary key' do
+      before do
+        allow(subject).to receive(:dictionary_id!).and_call_original
+      end
+
+      it 'raises an error' do
+        expect { subject.get_dictionary_metadata(metadata_key: metadata_key) }.to raise_error "A dictionary id could not be found for key '#{key}'."
+      end
+    end
+  end
+end