LittleWeasel 5.0.4 → 5.0.6

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

@@ -3,11 +3,11 @@
 require 'spec_helper'
 
 RSpec.describe LittleWeasel::Services::DictionaryMetadataService do
+  subject { create(:dictionary_metadata_service, dictionary_key: dictionary_key, dictionary_metadata: dictionary_metadata, dictionary_cache: dictionary_cache) }
+
   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) }
@@ -37,7 +37,7 @@ RSpec.describe LittleWeasel::Services::DictionaryMetadataService do
   end
 
   describe 'class methods' do
-    #.init
+    # .init
     describe '.init' do
       context 'with a valid dictionary metadata argument' do
         it 'initializes the dictionary metadata' do
@@ -57,20 +57,20 @@ RSpec.describe LittleWeasel::Services::DictionaryMetadataService do
       end
     end
 
-    #.init?
+    # .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
+            expect(described_class.init?(dictionary_metadata: dictionary_metadata)).to be 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
+            expect(described_class.init?(dictionary_metadata: dictionary_metadata)).to be false
           end
         end
       end
@@ -83,11 +83,11 @@ RSpec.describe LittleWeasel::Services::DictionaryMetadataService do
     end
   end
 
-  #.new
+  # .new
   describe '.new' do
     context 'when the arguments are valid' do
       it 'instantiates without errors' do
-        expect { subject }.to_not raise_error
+        expect { subject }.not_to raise_error
       end
     end
 
@@ -96,11 +96,11 @@ RSpec.describe LittleWeasel::Services::DictionaryMetadataService do
     it_behaves_like 'the dictionary_metadata is invalid'
   end
 
-  #init
+  # init
   describe '#init' do
     let(:expected_dictionary_metadata) do
       {
-        0 => { :metadata_key=>nil },
+        0 => { metadata_key: nil },
         1 => { metadata_key1: :metadata_object1 }
       }
     end
@@ -135,7 +135,7 @@ RSpec.describe LittleWeasel::Services::DictionaryMetadataService do
     end
   end
 
-  #dictionary_metadata?
+  # dictionary_metadata?
   describe '#dictionary_metadata?' do
     before do
       allow(subject).to receive(:dictionary_id).and_return(0)
@@ -143,7 +143,7 @@ RSpec.describe LittleWeasel::Services::DictionaryMetadataService do
 
     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
+        expect(subject.dictionary_metadata?(metadata_key: metadata_key)).to be true
       end
     end
 
@@ -156,19 +156,19 @@ RSpec.describe LittleWeasel::Services::DictionaryMetadataService do
         end
 
         it 'returns false' do
-          expect(subject.dictionary_metadata?(metadata_key: metadata_key)).to eq false
+          expect(subject.dictionary_metadata?(metadata_key: metadata_key)).to be 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 }
+            0 => { wrong_metadata_key: :metadata_object }
           }
         end
 
         it 'returns false' do
-          expect(subject.dictionary_metadata?(metadata_key: metadata_key)).to eq false
+          expect(subject.dictionary_metadata?(metadata_key: metadata_key)).to be false
         end
       end
 
@@ -180,13 +180,13 @@ RSpec.describe LittleWeasel::Services::DictionaryMetadataService do
         end
 
         it 'returns false' do
-          expect(subject.dictionary_metadata?(metadata_key: metadata_key)).to eq false
+          expect(subject.dictionary_metadata?(metadata_key: metadata_key)).to be false
         end
       end
     end
   end
 
-  #get_dictionary_metadata
+  # get_dictionary_metadata
   describe '#get_dictionary_metadata' do
     before do
       allow(subject).to receive(:dictionary_id!).and_return(0)
@@ -217,19 +217,19 @@ RSpec.describe LittleWeasel::Services::DictionaryMetadataService do
         end
 
         it 'returns false' do
-          expect(subject.get_dictionary_metadata(metadata_key: metadata_key)).to eq nil
+          expect(subject.get_dictionary_metadata(metadata_key: metadata_key)).to be_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 }
+            0 => { wrong_metadata_key: :metadata_object0 }
           }
         end
 
         it 'returns false' do
-          expect(subject.get_dictionary_metadata(metadata_key: metadata_key)).to eq nil
+          expect(subject.get_dictionary_metadata(metadata_key: metadata_key)).to be_nil
         end
       end
 
@@ -241,13 +241,13 @@ RSpec.describe LittleWeasel::Services::DictionaryMetadataService do
         end
 
         it 'returns false' do
-          expect(subject.get_dictionary_metadata(metadata_key: metadata_key)).to eq nil
+          expect(subject.get_dictionary_metadata(metadata_key: metadata_key)).to be_nil
         end
       end
     end
   end
 
-  #set_dictionary_metadata
+  # set_dictionary_metadata
   describe '#set_dictionary_metadata' do
     before do
       allow(subject).to receive(:dictionary_id!).and_return(0)

data/spec/lib/LittleWeasel/word_results_spec.rb

@@ -19,11 +19,11 @@ RSpec.describe LittleWeasel::WordResults do
   let(:word_cached) { false }
   let(:word_valid) { false }
 
-  #.new
+  # .new
   describe '.new' do
     context 'with valid arguments' do
       it 'instantiates the object' do
-        expect { subject }.to_not raise_error
+        expect { subject }.not_to raise_error
       end
     end
 
@@ -70,7 +70,7 @@ RSpec.describe LittleWeasel::WordResults do
     end
   end
 
-  #original_word=
+  # original_word=
   describe '#original_word=' do
     let(:changed_value) { "#{original_word}-changed" }
 
@@ -81,7 +81,7 @@ RSpec.describe LittleWeasel::WordResults do
     end
   end
 
-  #filters_matched=
+  # filters_matched=
   describe '#filters_matched=' do
     let(:filters_matched) { [:filters_matched] }
     let(:changed_value) { [:filters_matched_changed] }
@@ -93,7 +93,7 @@ RSpec.describe LittleWeasel::WordResults do
     end
   end
 
-  #word_cached=
+  # word_cached=
   describe '#word_cached=' do
     let(:changed_value) { !word_cached }
 
@@ -104,7 +104,7 @@ RSpec.describe LittleWeasel::WordResults do
     end
   end
 
-  #word_valid=
+  # word_valid=
   describe '#word_valid=' do
     let(:changed_value) { !word_valid }
 
@@ -115,7 +115,7 @@ RSpec.describe LittleWeasel::WordResults do
     end
   end
 
-  #preprocesed_words=
+  # preprocesed_words=
   describe '#preprocesed_words=' do
     let(:changed_value) do
       create(:preprocessed_words, with_word_processors: 2, original_word: original_word)
@@ -123,18 +123,17 @@ RSpec.describe LittleWeasel::WordResults do
 
     it 'sets @preprocesed_words' do
       expect { subject.preprocessed_words = changed_value }.to \
-        change { subject.preprocessed_words }
+        change(subject, :preprocessed_words)
         .from(preprocessed_words)
         .to(changed_value)
     end
   end
 
-  #success?
+  # success?
   describe '#success?' do
     context 'when #filter_match? is false AND #word_valid? is false' do
       before do
-        allow(subject).to receive(:filter_match?).and_return false
-        allow(subject).to receive(:word_valid?).and_return false
+        allow(subject).to receive_messages(filter_match?: false, word_valid?: false)
       end
 
       it 'returns false' do
@@ -145,8 +144,7 @@ RSpec.describe LittleWeasel::WordResults do
     context 'when #filter_match? is true OR #word_valid? is true' do
       context 'when #filter_match? is true' do
         before do
-          allow(subject).to receive(:filter_match?).and_return true
-          allow(subject).to receive(:word_valid?).and_return false
+          allow(subject).to receive_messages(filter_match?: true, word_valid?: false)
         end
 
         it 'returns true' do
@@ -156,8 +154,7 @@ RSpec.describe LittleWeasel::WordResults do
 
       context 'when #word_valid? is true' do
         before do
-          allow(subject).to receive(:filter_match?).and_return false
-          allow(subject).to receive(:word_valid?).and_return true
+          allow(subject).to receive_messages(filter_match?: false, word_valid?: true)
         end
 
         it 'returns true' do
@@ -167,58 +164,58 @@ RSpec.describe LittleWeasel::WordResults do
     end
   end
 
-  #filter_match?
+  # filter_match?
   describe '#filter_match?' do
-    context '#when filters_matched is present' do
+    describe '#when filters_matched is present' do
       let(:filters_matched) { [:matched_filter] }
 
       it 'returns true' do
-        expect(subject.filter_match?).to eq true
+        expect(subject.filter_match?).to be true
       end
     end
 
-    context '#when filters_matched is NOT present' do
+    describe '#when filters_matched is NOT present' do
       it 'returns false' do
-        expect(subject.filter_match?).to eq false
+        expect(subject.filter_match?).to be false
       end
     end
   end
 
-  #word_cached?
+  # word_cached?
   describe '#word_cached?' do
-    context '#when word_cached is true' do
+    describe '#when word_cached is true' do
       let(:word_cached) { true }
 
       it 'returns true' do
-        expect(subject.word_cached?).to eq true
+        expect(subject.word_cached?).to be true
       end
     end
 
-    context '#when word_cached is false' do
+    describe '#when word_cached is false' do
       it 'returns false' do
-        expect(subject.word_cached?).to eq false
+        expect(subject.word_cached?).to be false
       end
     end
   end
 
-  #word_valid?
+  # word_valid?
   describe '#word_valid?' do
-    context '#when word_valid is true' do
+    describe '#when word_valid is true' do
       let(:word_valid) { true }
 
       it 'returns true' do
-        expect(subject.word_valid?).to eq true
+        expect(subject.word_valid?).to be true
       end
     end
 
-    context '#when word_valid is false' do
+    describe '#when word_valid is false' do
       it 'returns false' do
-        expect(subject.word_valid?).to eq false
+        expect(subject.word_valid?).to be false
       end
     end
   end
 
-  #preprocessed_word?
+  # preprocessed_word?
   describe '#preprocessed_word?' do
     subject do
       create(:word_results,
@@ -250,7 +247,7 @@ RSpec.describe LittleWeasel::WordResults do
     end
   end
 
-  #preprocessed_word_or_original_word
+  # preprocessed_word_or_original_word
   describe '#preprocessed_word_or_original_word' do
     let(:original_word) { 'word' }
 

data/spec/lib/LittleWeasel/workflow/workflow_spec.rb

@@ -3,11 +3,11 @@
 require 'spec_helper'
 
 RSpec.describe 'Workflow tests' do
+  subject { LittleWeasel::DictionaryManager.new }
+
   include_context 'dictionary cache'
   include_context 'dictionary keys'
 
-  subject { LittleWeasel::DictionaryManager.new }
-
   # This loads the BIG en-US-big dictionary
   let(:en_us_dictionary_key) { dictionary_key_for(language: :en, region: :us, tag: :big) }
   let(:en_gb_dictionary_key) { dictionary_key_for(language: :en, region: :gb) }

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pry-byebug'
 require 'simplecov'
 
@@ -5,7 +7,7 @@ SimpleCov.start do
   add_filter 'spec'
 end
 
-require File.expand_path(File.dirname(__FILE__) + '../../lib/LittleWeasel')
+require File.expand_path("#{File.dirname(__FILE__)}../../lib/LittleWeasel")
 Dir[File.join('.', 'spec/support/**/*.rb')].each do |f|
   require f
 end
@@ -56,68 +58,66 @@ RSpec.configure do |config|
   # triggering implicit auto-inclusion in groups with matching metadata.
   config.shared_context_metadata_behavior = :apply_to_host_groups
 
-# The settings below are suggested to provide a good initial experience
-# with RSpec, but feel free to customize to your heart's content.
-=begin
-  # This allows you to limit a spec run to individual examples or groups
-  # you care about by tagging them with `:focus` metadata. When nothing
-  # is tagged with `:focus`, all examples get run. RSpec also provides
-  # aliases for `it`, `describe`, and `context` that include `:focus`
-  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
-  config.filter_run_when_matching :focus
-
-  # Allows RSpec to persist some state between runs in order to support
-  # the `--only-failures` and `--next-failure` CLI options. We recommend
-  # you configure your source control system to ignore this file.
-  config.example_status_persistence_file_path = "spec/examples.txt"
-
-  # Limits the available syntax to the non-monkey patched syntax that is
-  # recommended. For more details, see:
-  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
-  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
-  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
-  config.disable_monkey_patching!
-
-  # This setting enables warnings. It's recommended, but in some cases may
-  # be too noisy due to issues in dependencies.
-  config.warnings = true
-
-  # Many RSpec users commonly either run the entire suite or an individual
-  # file, and it's useful to allow more verbose output when running an
-  # individual spec file.
-  if config.files_to_run.one?
-    # Use the documentation formatter for detailed output,
-    # unless a formatter has already been configured
-    # (e.g. via a command-line flag).
-    config.default_formatter = "doc"
-  end
-
-  # Print the 10 slowest examples and example groups at the
-  # end of the spec run, to help surface which specs are running
-  # particularly slow.
-  config.profile_examples = 10
-
-  # Run specs in random order to surface order dependencies. If you find an
-  # order dependency and want to debug it, you can fix the order by providing
-  # the seed, which is printed after each run.
-  #     --seed 1234
-  config.order = :random
-
-  # Seed global randomization in this process using the `--seed` CLI option.
-  # Setting this allows you to use `--seed` to deterministically reproduce
-  # test failures related to randomization by passing the same `--seed` value
-  # as the one that triggered the failure.
-  Kernel.srand config.seed
-=end
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
+  #   # This allows you to limit a spec run to individual examples or groups
+  #   # you care about by tagging them with `:focus` metadata. When nothing
+  #   # is tagged with `:focus`, all examples get run. RSpec also provides
+  #   # aliases for `it`, `describe`, and `context` that include `:focus`
+  #   # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  #   config.filter_run_when_matching :focus
+  #
+  #   # Allows RSpec to persist some state between runs in order to support
+  #   # the `--only-failures` and `--next-failure` CLI options. We recommend
+  #   # you configure your source control system to ignore this file.
+  #   config.example_status_persistence_file_path = "spec/examples.txt"
+  #
+  #   # Limits the available syntax to the non-monkey patched syntax that is
+  #   # recommended. For more details, see:
+  #   #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  #   config.disable_monkey_patching!
+  #
+  #   # This setting enables warnings. It's recommended, but in some cases may
+  #   # be too noisy due to issues in dependencies.
+  #   config.warnings = true
+  #
+  #   # Many RSpec users commonly either run the entire suite or an individual
+  #   # file, and it's useful to allow more verbose output when running an
+  #   # individual spec file.
+  #   if config.files_to_run.one?
+  #     # Use the documentation formatter for detailed output,
+  #     # unless a formatter has already been configured
+  #     # (e.g. via a command-line flag).
+  #     config.default_formatter = "doc"
+  #   end
+  #
+  #   # Print the 10 slowest examples and example groups at the
+  #   # end of the spec run, to help surface which specs are running
+  #   # particularly slow.
+  #   config.profile_examples = 10
+  #
+  #   # Run specs in random order to surface order dependencies. If you find an
+  #   # order dependency and want to debug it, you can fix the order by providing
+  #   # the seed, which is printed after each run.
+  #   #     --seed 1234
+  #   config.order = :random
+  #
+  #   # Seed global randomization in this process using the `--seed` CLI option.
+  #   # Setting this allows you to use `--seed` to deterministically reproduce
+  #   # test failures related to randomization by passing the same `--seed` value
+  #   # as the one that triggered the failure.
+  #   Kernel.srand config.seed
 
   # Enable both should and expect until the old specs are upgraded.
   config.expect_with :rspec do |c|
-    c.syntax = %i[should, expect]
+    c.syntax = %i[should expect]
   end
 
   # Load support files
   config.include Support::FileHelpers
   config.include Support::GeneralHelpers
 
-  config.before(:each) { LittleWeasel.configure { |config| config.reset } }
+  config.before { LittleWeasel.configure(&:reset) }
 end

data/spec/support/factory_bot.rb

@@ -3,7 +3,7 @@
 require 'factory_bot'
 require_relative 'file_helpers'
 
-FactoryBot::SyntaxRunner.send(:include, Support::FileHelpers)
+FactoryBot::SyntaxRunner.include Support::FileHelpers
 
 RSpec.configure do |config|
   config.include FactoryBot::Syntax::Methods
@@ -12,4 +12,3 @@ RSpec.configure do |config|
     FactoryBot.find_definitions
   end
 end
-

data/spec/support/file_helpers.rb

@@ -23,12 +23,12 @@ module Support
       Locale.new(language: language, region: region).locale
     end
 
-    def region_dictionary_path language:, region:
+    def region_dictionary_path(language:, region:)
       file_name = locale_for language: language, region: region
       dictionary_path_for file_name: file_name
     end
 
-    def language_dictionary_path language:
+    def language_dictionary_path(language:)
       file_name = locale_for language: language
       dictionary_path_for file_name: file_name
     end

data/spec/support/general_helpers.rb

@@ -50,7 +50,7 @@ module Support
         puts "#{indent * 2}filter_match? #=> #{results.filter_match?}"
         puts "#{indent * 2}filters_matched: #=> #{results.filters_matched}"
         puts "#{indent * 2}preprocessed_words #=>"
-        results.preprocessed_words&.preprocessed_words.each_with_index do |preprocessed_word, index|
+        results.preprocessed_words&.preprocessed_words&.each_with_index do |preprocessed_word, index|
           puts "#{indent * 3}preprocessed_words[#{index}] #=>"
           puts "#{indent * 4}preprocessed_word #=>"
           puts "#{indent * 5}preprocessor: :#{preprocessed_word.preprocessor}"
@@ -61,6 +61,7 @@ module Support
 
       def string_or_nil(value)
         return 'nil' if value.nil?
+
         "\"#{value}\""
       end
     end

data/spec/support/shared_contexts.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 RSpec.shared_context 'dictionary cache' do
   def dictionary_cache_for(dictionary_key:, dictionary_file_source: true, load: false)
     dictionary_cache_from(dictionary_keys: [{ dictionary_key: dictionary_key, dictionary_file_source: dictionary_file_source, load: load }])
@@ -22,7 +24,9 @@ RSpec.shared_context 'dictionary cache' do
     dictionary_cache = {}
 
     dictionary_keys.each do |hash|
-      raise ArgumentError, "Expected required Hash key :dictionary_key but it was not found" unless hash.key? :dictionary_key
+      unless hash.key? :dictionary_key
+        raise ArgumentError, 'Expected required Hash key :dictionary_key but it was not found'
+      end
 
       create(:dictionary_cache_service,
         dictionary_cache: dictionary_cache,
@@ -38,32 +42,32 @@ end
 
 RSpec.shared_context 'dictionary keys' do
   def dictionary_key_for(language:, region: nil, tag: nil)
-   create(:dictionary_key, language: language, region: region, tag: tag)
+    create(:dictionary_key, language: language, region: region, tag: tag)
   end
 end
 
 RSpec.shared_context 'mock word filters' do
-  unless Object.const_defined?('WordFilter01')
+  unless Object.const_defined?(:WordFilter01)
     class WordFilter01 < LittleWeasel::Filters::WordFilter
       class << self
-        def filter_match?(word)
+        def filter_match?(_word)
           true
         end
       end
     end
   end
 
-  unless Object.const_defined?('WordFilter02')
+  unless Object.const_defined?(:WordFilter02)
     class WordFilter02 < LittleWeasel::Filters::WordFilter
       class << self
-        def filter_match?(word)
+        def filter_match?(_word)
           true
         end
       end
     end
   end
 
-  unless Object.const_defined?('DollarSignFilter')
+  unless Object.const_defined?(:DollarSignFilter)
     class DollarSignFilter < LittleWeasel::Filters::WordFilter
       class << self
         def filter_match?(word)
@@ -78,7 +82,7 @@ RSpec.shared_context 'mock word preprocessors' do
   class UpcaseWordPreprocessor < LittleWeasel::Preprocessors::WordPreprocessor
     class << self
       def preprocess(word)
-        [true, word.upcase];
+        [true, word.upcase]
       end
     end
   end
@@ -86,7 +90,7 @@ RSpec.shared_context 'mock word preprocessors' do
   class DowncaseWordPreprocessor < LittleWeasel::Preprocessors::WordPreprocessor
     class << self
       def preprocess(word)
-        [true, word.downcase];
+        [true, word.downcase]
       end
     end
   end