LittleWeasel 3.0.3 → 5.0.0

data/spec/support/files/en-US-tagged.txt

@@ -0,0 +1,26 @@
+a
+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

data/spec/support/files/en-US.txt

@@ -0,0 +1,26 @@
+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

data/spec/support/files/en.txt

@@ -0,0 +1,26 @@
+a
+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

data/spec/support/files/es-ES.txt

@@ -0,0 +1,27 @@
+armadillo
+biblioteca
+carcajada
+decidir
+elefante
+falsificar
+gigante
+hechizo
+iniciar
+jajajear
+kaki
+labial
+mamá
+nene
+ñoño
+coco
+papá
+quiquiriquí
+ronronear
+sisear
+tetera
+ulular
+vivir
+wifi
+sexto
+yoyó
+zarzamora

data/spec/support/files/es.txt

@@ -0,0 +1,27 @@
+armadillo
+biblioteca
+carcajada
+decidir
+elefante
+falsificar
+gigante
+hechizo
+iniciar
+jajajear
+kaki
+labial
+mamá
+nene
+ñoño
+coco
+papá
+quiquiriquí
+ronronear
+sisear
+tetera
+ulular
+vivir
+wifi
+sexto
+yoyó
+zarzamora

data/spec/support/general_helpers.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Support
+  # Provides miscellaneous help methods for use in specs.
+  module GeneralHelpers
+    # For some reason, passing create(described_class) raises
+    # a "KeyError: Factory not registered: LittleWeasel::Klass"
+    # error where Klass == (for example) any Dictionary or
+    # subclass. This creates a symbol from the class name that
+    # factory_bot will like.
+
+    # :reek:UtilityFunction - ignored, this is only spec support.
+    def sym_for(klass)
+      klass.name.demodulize.underscore.to_sym
+    end
+
+    module DictionaryResultsHelpers
+      module_function
+
+      def print_word_results(word, word_results, comments = nil)
+        puts "# Comments: #{comments}" unless comments.nil?
+        puts "# Results of calling #word_results for '#{word}'..."
+        print_results(word: word, results: word_results, indent: 1)
+      end
+
+      def print_block_results(word_block, block_results, comments = nil)
+        puts "# Comments: #{comments}" unless comments.nil?
+        puts '# Results of calling #word_block with:'
+        puts "#   \"#{word_block}\"..."
+        puts
+        puts 'block_results #=>'
+        puts "  #preprocessed_words_or_original_words #=> #{block_results.preprocessed_words_or_original_words}"
+
+        puts 'word_results #=>'
+        block_results.word_results.each do |word_results|
+          print_results(word: word_results.original_word, results: word_results, indent: 1)
+        end
+      end
+
+      def print_results(word:, results:, indent: 0)
+        indent = '   ' * indent
+        puts "#{indent}word_results #=>"
+        puts "#{indent * 2}original_word #=> \"#{results.original_word}\""
+        puts "#{indent * 2}preprocessed_word #=> #{string_or_nil results.preprocessed_word}"
+        puts "#{indent * 2}success? #=> #{results.success?}"
+        puts "#{indent * 2}word_valid? #=> #{results.word_valid?}"
+        puts "#{indent * 2}word_cached? #=> #{results.word_cached?}"
+        puts "#{indent * 2}preprocessed_word? #=> #{results.preprocessed_word?}"
+        puts "#{indent * 2}preprocessed_word_or_original_word #=> #{string_or_nil results.preprocessed_word_or_original_word}"
+        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|
+          puts "#{indent * 3}preprocessed_words[#{index}] #=>"
+          puts "#{indent * 4}preprocessed_word #=>"
+          puts "#{indent * 5}preprocessor: :#{preprocessed_word.preprocessor}"
+          puts "#{indent * 5}preprocessor_order: #{preprocessed_word.preprocessor_order}"
+        end
+        puts
+      end
+
+      def string_or_nil(value)
+        return 'nil' if value.nil?
+        "\"#{value}\""
+      end
+    end
+  end
+end

data/spec/support/shared_contexts.rb

@@ -0,0 +1,107 @@
+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 }])
+  end
+
+  # This method simple returns a snapshot of what the dictionary cache would
+  # look like if the given dictionary_key(s) were added as a dictionary reference.
+  # This method expects an Array of Hashes having the following format; if
+  # load is omitted, 'load: false' is the default:
+  #
+  # [
+  #  {
+  #    dictionary_key: <dictionary_key>
+  #    dictionary_file_source: nil | true | false | <file name minus extension>,
+  #    dictionary_memory_source: nil | true | false |,
+  #    [, load: true | false]
+  #  }
+  # ]
+  def dictionary_cache_from(dictionary_keys:)
+    raise ArgumentError, 'Argument dictionary_keys is not an Array' unless dictionary_keys.is_a? Array
+
+    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
+
+      create(:dictionary_cache_service,
+        dictionary_cache: dictionary_cache,
+        dictionary_key: hash[:dictionary_key],
+        dictionary_file_source: hash[:dictionary_file_source],
+        dictionary_memory_source: hash[:dictionary_memory_source],
+        load: hash.fetch(:load, false))
+    end
+
+    dictionary_cache
+  end
+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)
+  end
+end
+
+RSpec.shared_context 'mock word filters' do
+  unless Object.const_defined?('WordFilter01')
+    class WordFilter01 < LittleWeasel::Filters::WordFilter
+      class << self
+        def filter_match?(word)
+          true
+        end
+      end
+    end
+  end
+
+  unless Object.const_defined?('WordFilter02')
+    class WordFilter02 < LittleWeasel::Filters::WordFilter
+      class << self
+        def filter_match?(word)
+          true
+        end
+      end
+    end
+  end
+
+  unless Object.const_defined?('DollarSignFilter')
+    class DollarSignFilter < LittleWeasel::Filters::WordFilter
+      class << self
+        def filter_match?(word)
+          word == '$'
+        end
+      end
+    end
+  end
+end
+
+RSpec.shared_context 'mock word preprocessors' do
+  class UpcaseWordPreprocessor < LittleWeasel::Preprocessors::WordPreprocessor
+    class << self
+      def preprocess(word)
+        [true, word.upcase];
+      end
+    end
+  end
+
+  class DowncaseWordPreprocessor < LittleWeasel::Preprocessors::WordPreprocessor
+    class << self
+      def preprocess(word)
+        [true, word.downcase];
+      end
+    end
+  end
+end
+
+RSpec.shared_context 'dictionary sourceable' do
+  def memory_source
+    LittleWeasel::Modules::DictionarySourceable.memory_source
+  end
+end
+
+RSpec.configure do |config|
+  config.include_context 'dictionary cache', include_shared: true
+  config.include_context 'dictionary keys', include_shared: true
+  config.include_context 'dictionary sourceable', include_shared: true
+  config.include_context 'mock word filters', include_shared: true
+  config.include_context 'mock word preprocessors', include_shared: true
+end

data/spec/support/shared_examples.rb

@@ -0,0 +1,105 @@
+RSpec.shared_examples 'the dictionary_key is invalid' do
+  context 'when the dictionary_key is nil' do
+    let(:dictionary_key) {}
+
+    it 'raises an error' do
+      expect { subject }.to raise_error "Argument dictionary_key is not a valid DictionaryKey object: #{dictionary_key.class}"
+    end
+  end
+
+  context 'when the dictionary_key is the wrong type' do
+    let(:dictionary_key) { :bad_dictionary_key }
+
+    it 'raises an error' do
+      expect { subject }.to raise_error "Argument dictionary_key is not a valid DictionaryKey object: #{dictionary_key.class}"
+    end
+  end
+end
+
+RSpec.shared_examples 'the dictionary_cache is invalid' do
+  context 'when the dictionary_cache is nil' do
+    let(:dictionary_cache) {}
+
+    it 'raises an error' do
+      expect { subject }.to raise_error "Argument dictionary_cache is not a valid Hash object: #{dictionary_cache.class}"
+    end
+  end
+
+  context 'when the dictionary_cache is the wrong type' do
+    let(:dictionary_cache) { :bad_dictionary_cache }
+
+    it 'raises an error' do
+      expect { subject }.to raise_error "Argument dictionary_cache is not a valid Hash object: #{dictionary_cache.class}"
+    end
+  end
+end
+
+RSpec.shared_examples 'the dictionary_metadata is invalid' do
+  context 'when the dictionary_metadata is nil' do
+    let(:dictionary_metadata) {}
+
+    it 'raises an error' do
+      expect { subject }.to raise_error "Argument dictionary_metadata is not a valid Hash object: #{dictionary_metadata.class}"
+    end
+  end
+
+  context 'when the dictionary_metadata is the wrong type' do
+    let(:dictionary_metadata) { :bad_dictionary_metadata }
+
+    it 'raises an error' do
+      expect { subject }.to raise_error "Argument dictionary_metadata is not a valid Hash object: #{dictionary_metadata.class}"
+    end
+  end
+end
+
+# Word filter shared examples
+
+RSpec.shared_examples 'the filter matches and #filter_on? is true' do
+  it 'returns true' do
+    expect(subject.filter_match? word).to eq true
+  end
+end
+
+RSpec.shared_examples 'the filter DOES NOT match and #filter_on? is true' do
+  it 'returns false' do
+    expect(subject.filter_match? word).to eq false
+  end
+end
+
+RSpec.shared_examples 'the filter matches and #filter_on? is false' do
+  it 'returns false' do
+    expect(subject.filter_match? word).to eq false
+  end
+end
+
+RSpec.shared_examples 'the filter DOES NOT match and #filter_on? is false' do
+  it 'returns false' do
+    expect(subject.filter_match? word).to eq false
+  end
+end
+
+# Preprocessor shared examples
+
+RSpec.shared_examples 'the preprocessor matches and #preprocessor_on? is true' do
+  it 'returns true' do
+    expect(subject.preprocess? word).to eq true
+  end
+end
+
+RSpec.shared_examples 'the preprocessor DOES NOT match and #preprocessor_on? is true' do
+  it 'returns false' do
+    expect(subject.preprocess? word).to eq false
+  end
+end
+
+RSpec.shared_examples 'the preprocessor matches and #preprocessor_on? is false' do
+  it 'returns false' do
+    expect(subject.preprocess? word).to eq false
+  end
+end
+
+RSpec.shared_examples 'the preprocessor DOES NOT match and #preprocessor_on? is false' do
+  it 'returns false' do
+    expect(subject.preprocess? word).to eq false
+  end
+end