LittleWeasel 3.0.4 → 5.0.1

data/spec/lib/LittleWeasel/preprocessors/word_preprocessor_spec.rb

@@ -0,0 +1,218 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe LittleWeasel::Preprocessors::WordPreprocessor do
+  subject do
+    word_preprocessor = described_class.new order: order
+    word_preprocessor.preprocessor_on = preprocessor_on
+    word_preprocessor
+  end
+
+  let(:preprocessor_on) { true }
+  let(:order) { 0 }
+  let(:word) { 'word' }
+
+  #.new
+  describe '.new' do
+    context 'when arguments are valid' do
+      it 'instantiates the object' do
+        expect { subject }.to_not raise_error
+      end
+    end
+
+    context 'when arguments are INVALID' do
+      context 'when argument order is invalid' do
+        context 'when order is not an Integer' do
+          let(:order) { :not_an_integer }
+
+          it 'raises an error' do
+            expect { subject }.to raise_error(/Argument order is not an Integer/)
+          end
+        end
+
+        context 'when order is negative' do
+          let(:order) { -1 }
+
+          it 'raises an error' do
+            expect { subject }.to raise_error "Argument order '#{order}' is not a a number from 0-n"
+          end
+        end
+      end
+
+      context 'when argument preprocessor_on is invalid' do
+        context 'when preprocessor_on is not true or false' do
+          let(:preprocessor_on) { :not_true_or_false }
+
+          it 'raises an error' do
+            expect { subject }.to raise_error "Argument value is not true or false: #{preprocessor_on}"
+          end
+        end
+      end
+    end
+  end
+
+  #.preprocess
+  describe '.preprocess' do
+    context 'when not overridden' do
+      it 'raises an error' do
+        expect { subject.class.preprocess word }.to raise_error LittleWeasel::Errors::MustOverrideError
+      end
+    end
+  end
+
+  #preprocessor_on
+  describe '#preprocessor_on' do
+    context 'when set to true' do
+      before do
+        subject.preprocessor_on = true
+      end
+
+      it 'returns true' do
+        expect(subject.preprocessor_on).to eq true
+      end
+    end
+
+    context 'when set to false' do
+      before do
+        subject.preprocessor_on = false
+      end
+
+      it 'returns false' do
+        expect(subject.preprocessor_on).to eq false
+      end
+    end
+  end
+
+  #preprocessor_on!
+  describe '#preprocessor_on!' do
+    before do
+      expect(subject.preprocessor_off?).to eq true
+    end
+
+    let(:preprocessor_on) { false }
+
+    it 'turns the preprocessor on' do
+      subject.preprocessor_on!
+      expect(subject.preprocessor_on).to eq true
+    end
+  end
+
+  #preprocessor_on?
+  describe '#preprocessor_on?' do
+    context 'when #preprocessor_on is true' do
+      it 'returns true' do
+        expect(subject.preprocessor_on?).to eq true
+      end
+    end
+
+    context 'when #preprocessor_on is false' do
+      let(:preprocessor_on) { false }
+
+      it 'returns false' do
+        expect(subject.preprocessor_on?).to eq false
+      end
+    end
+  end
+
+  #preprocess
+  describe '#preprocess' do
+    context 'when not overridden' do
+      it 'raises an error' do
+        expect { subject.preprocess 'x' }.to raise_error LittleWeasel::Errors::MustOverrideError
+      end
+    end
+
+    context 'when overridden' do
+      before do
+        allow(described_class).to receive(:preprocess?)
+          .and_return true
+        allow(described_class).to receive(:preprocess)
+          .and_return [true, 'preprocessed-word']
+      end
+
+      context 'when #preprocessor_on? is true' do
+        it 'calls .preprocess and returns a ProcessedWord object' do
+          expect(described_class).to receive(:preprocess)
+          expect(subject.preprocess word).to be_kind_of LittleWeasel::Preprocessors::PreprocessedWord
+        end
+      end
+
+      context 'when #preprocessor_on? is false' do
+        let(:preprocessor_on) { false }
+
+        it 'does NOT call .preprocess and returns a ProcessedWord object' do
+          expect(described_class).to_not receive(:preprocess)
+          expect(subject.preprocess word).to be_kind_of LittleWeasel::Preprocessors::PreprocessedWord
+        end
+
+      end
+    end
+  end
+
+  #preprocess?
+  describe '#preprocess?' do
+    let(:word) { 'word' }
+
+    it 'returns true by default' do
+      expect(subject.preprocess? word).to be true
+    end
+
+    context 'when #preprocess? returns true' do
+      before { allow(subject.class).to receive(:preprocess?).and_return(true) }
+
+      context 'when #preprocessor_on? is true' do
+        it_behaves_like 'the preprocessor matches and #preprocessor_on? is true'
+      end
+
+      context 'when #preprocessor_on? is false' do
+        let(:preprocessor_on) { false }
+
+        it_behaves_like 'the preprocessor matches and #preprocessor_on? is false'
+      end
+    end
+
+    context 'when #preprocess? returns false' do
+      before { allow(subject.class).to receive(:preprocess?).and_return(false) }
+
+      context 'when #preprocessor_on? is true' do
+        it_behaves_like 'the preprocessor DOES NOT match and #preprocessor_on? is true'
+      end
+
+      context 'when #preprocessor_on? is false' do
+        let(:preprocessor_on) { false }
+
+        it_behaves_like 'the preprocessor DOES NOT match and #preprocessor_on? is false'
+      end
+    end
+  end
+
+  #preprocessor_off?
+  describe '#preprocessor_off?' do
+    context 'when #preprocessor_on is false' do
+      let(:preprocessor_on) { false }
+
+      it 'returns true' do
+        expect(subject.preprocessor_off?).to eq true
+      end
+    end
+
+    context 'when #preprocessor_on is true' do
+      it 'returns false' do
+        expect(subject.preprocessor_off?).to eq false
+      end
+    end
+  end
+
+  #preprocessor_off!
+  describe '#preprocessor_off!' do
+    before do
+      expect(subject.preprocessor_on?).to eq true
+    end
+
+    it 'turns the preprocessor off' do
+      subject.preprocessor_off!
+      expect(subject.preprocessor_on).to eq false
+    end
+  end
+end

data/spec/lib/LittleWeasel/preprocessors/word_preprocessor_validatable_spec.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe LittleWeasel::Preprocessors::WordPreprocessorValidatable, type: :module do
+  subject { MockSubject.new }
+
+  WordPreprocessorValidatable = described_class
+
+  class MockSubject
+    include WordPreprocessorValidatable
+  end
+
+  class MockWordPreprocessor < LittleWeasel::Preprocessors::WordPreprocessor
+    def preprocess(word)
+      [true, "#{word}-preprocessed"]
+    end
+  end
+
+  let(:order) { 0 }
+  let(:preprocessor_on) { true }
+  let(:word_preprocessor) do
+    word_preprocessor = MockWordPreprocessor.new order: order
+    word_preprocessor.preprocessor_on = preprocessor_on
+    word_preprocessor
+  end
+
+  shared_examples 'an instance method is missing' do
+    before do
+      allow(word_preprocessor).to receive(:respond_to?).with(method).and_return(false)
+    end
+
+    it 'raises an error' do
+      expect { WordPreprocessorValidatable.validate_word_preprocessor word_preprocessor: word_preprocessor }.to raise_error expected_error_message
+    end
+  end
+
+  shared_examples 'a class method is missing' do
+    before do
+      allow(word_preprocessor.class).to receive(:respond_to?).with(method).and_return(false)
+    end
+
+    it 'raises an error' do
+      expect { WordPreprocessorValidatable.validate_word_preprocessor word_preprocessor: word_preprocessor }.to raise_error expected_error_message
+    end
+  end
+
+  #.validate_word_preprocessor
+  describe '.validate_word_preprocessor' do
+    before do
+      allow(word_preprocessor.class).to receive(:respond_to?).and_call_original
+      allow(word_preprocessor).to receive(:respond_to?).and_call_original
+    end
+
+    context 'when the object quacks right' do
+      it 'passes validation' do
+        expect { WordPreprocessorValidatable.validate_word_preprocessor word_preprocessor: word_preprocessor }.to_not raise_error
+      end
+    end
+
+    context 'when the object DOES NOT quack right' do
+      let(:expected_error_message) { /Argument word_preprocessor: does not respond to/ }
+
+      context 'when a class method is missing' do
+        context 'when the class does not respond to .preprocess' do
+          let(:method) { :preprocess }
+          it_behaves_like 'a class method is missing'
+        end
+
+        context 'when the class does not respond to .preprocess?' do
+          let(:method) { :preprocess? }
+          it_behaves_like 'a class method is missing'
+        end
+      end
+
+      context 'when an instance method is missing' do
+        context 'when the object does not respond to #preprocess' do
+          let(:method) { :preprocess }
+          it_behaves_like 'an instance method is missing'
+        end
+
+        context 'when the object does not respond to #preprocess?' do
+          let(:method) { :preprocess? }
+          it_behaves_like 'an instance method is missing'
+        end
+
+        context 'when the object does not respond to #preprocessor_off?' do
+          let(:method) { :preprocessor_off? }
+          it_behaves_like 'an instance method is missing'
+        end
+
+        context 'when the object does not respond to #preprocessor_on' do
+          let(:method) { :preprocessor_on }
+          it_behaves_like 'an instance method is missing'
+        end
+
+        context 'when the object does not respond to #preprocessor_on=' do
+          let(:method) { :preprocessor_on= }
+          it_behaves_like 'an instance method is missing'
+        end
+
+        context 'when the object does not respond to #preprocessor_on?' do
+          let(:method) { :preprocessor_on? }
+          it_behaves_like 'an instance method is missing'
+        end
+      end
+    end
+  end
+end

data/spec/lib/LittleWeasel/preprocessors/word_preprocessors_validatable_spec.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe LittleWeasel::Preprocessors::WordPreprocessorsValidatable, type: :module do
+  subject { MockSubject.new }
+
+  WordPreprocessorsValidatable = described_class
+
+  class MockSubject
+    include WordPreprocessorsValidatable
+  end
+
+  subject { MockSubject.new }
+
+  class MockWordPreprocessor < LittleWeasel::Preprocessors::WordPreprocessor
+    def initialize(order: 0)
+      super order: order
+      self.preprocessor_on = preprocessor_on
+    end
+
+    class << self
+      def preprocess(word) [true, "#{word}-0"]; end
+    end
+  end
+
+  #.validate_word_preprocessors
+  describe '.validate_word_preprocessors' do
+    context 'when passing a blank Array' do
+      it 'passes validaton' do
+        expect { WordPreprocessorsValidatable.validate_word_preprocessors(word_preprocessors: []) }.to_not raise_error
+      end
+    end
+
+    context 'when passing a an Array with valid word preprocessors' do
+      it 'passes validation' do
+        expect { WordPreprocessorsValidatable.validate_word_preprocessors(word_preprocessors: [MockWordPreprocessor.new]) }.to_not raise_error
+      end
+    end
+
+    context 'when passing an INVALID argument' do
+      context 'when passing an invalid Array' do
+        it 'raises an error' do
+          expect { WordPreprocessorsValidatable.validate_word_preprocessors(word_preprocessors: :not_an_array) }.to raise_error(/Argument word_preprocessors is not an Array/)
+        end
+      end
+    end
+  end
+end