LittleWeasel 3.0.4 → 4.0.0

data/spec/lib/LittleWeasel/filters/en_us/currency_filter_spec.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe LittleWeasel::Filters::EnUs::CurrencyFilter do
+  subject { described_class.new }
+
+  #filter_match?
+  describe 'filter_match?' do
+    context 'when word is currency' do
+      it 'returns true' do
+        expect(subject.filter_match?('-$1.00')).to eq true
+        expect(subject.filter_match?('-$1')).to eq true
+        expect(subject.filter_match?('$0')).to eq true
+        expect(subject.filter_match?('$1')).to eq true
+        expect(subject.filter_match?('$100')).to eq true
+        expect(subject.filter_match?('$100.10')).to eq true
+        expect(subject.filter_match?('$123456')).to eq true
+        expect(subject.filter_match?('+$110.09')).to eq true
+        expect(subject.filter_match?('-$1,000.09')).to eq true
+        expect(subject.filter_match?('$1000000.00')).to eq true
+        expect(subject.filter_match?('$1100000.10')).to eq true
+        expect(subject.filter_match?('$120000.01')).to eq true
+        expect(subject.filter_match?('$1,000,000.01')).to eq true
+      end
+    end
+
+    context 'when word has decimals, but not 2 decimal places' do
+      it 'returns false' do
+        expect(subject.filter_match?('-$1.1')).to eq false
+        expect(subject.filter_match?('$0.1')).to eq false
+        expect(subject.filter_match?('$100.9')).to eq false
+        expect(subject.filter_match?('+$100.2')).to eq false
+        expect(subject.filter_match?('$1000000.0')).to eq false
+        expect(subject.filter_match?('$1000000.1')).to eq false
+        expect(subject.filter_match?('$1000000.5')).to eq false
+      end
+    end
+
+    context 'when word is NOT currency' do
+      it 'returns false' do
+        expect(subject.filter_match? 'a').to eq false
+        expect(subject.filter_match? :a).to eq false
+        expect(subject.filter_match? Object.new).to eq false
+      end
+    end
+
+    let(:word) { 1 }
+
+    context 'when #filter_match? returns true' do
+      before { allow(subject.class).to receive(:filter_match?).and_return(true) }
+
+      context 'when #filter_on? is true' do
+        it_behaves_like 'the filter matches and #filter_on? is true'
+      end
+
+      context 'when #filter_on? is false' do
+        before do
+          subject.filter_on = false
+        end
+
+        it_behaves_like 'the filter matches and #filter_on? is false'
+      end
+    end
+
+    context 'when #filter_match? returns false' do
+      before { allow(subject.class).to receive(:filter_match?).and_return(false) }
+
+      context 'when #filter_on? is true' do
+        it_behaves_like 'the filter DOES NOT match and #filter_on? is true'
+      end
+
+      context 'when #filter_on? is false' do
+        let(:filter_on) { false }
+
+        it_behaves_like 'the filter DOES NOT match and #filter_on? is false'
+      end
+    end
+  end
+end

data/spec/lib/LittleWeasel/filters/en_us/numeric_filter_spec.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe LittleWeasel::Filters::EnUs::NumericFilter do
+  subject { described_class.new }
+
+  #filter_match?
+  describe 'filter_match?' do
+    context 'when word is a number' do
+      it 'returns true' do
+        expect(subject.filter_match?('-1.00')).to eq true
+        expect(subject.filter_match?('-1')).to eq true
+        expect(subject.filter_match?('0')).to eq true
+        expect(subject.filter_match?('1')).to eq true
+        expect(subject.filter_match?('100')).to eq true
+        expect(subject.filter_match?('100.10')).to eq true
+        expect(subject.filter_match?(1234_56)).to eq true
+        expect(subject.filter_match?('+100.0')).to eq true
+        expect(subject.filter_match?(1_000_000.00)).to eq true
+        expect(subject.filter_match?(1_000_000.10)).to eq true
+        expect(subject.filter_match?(1_000_000.01)).to eq true
+      end
+    end
+
+    context 'when word is NOT a number' do
+      it 'returns false' do
+        expect(subject.filter_match? 'a').to eq false
+        expect(subject.filter_match? :a).to eq false
+        expect(subject.filter_match? Object.new).to eq false
+      end
+    end
+
+    let(:word) { 1 }
+
+    context 'when #filter_match? returns true' do
+      before { allow(subject.class).to receive(:filter_match?).and_return(true) }
+
+      context 'when #filter_on? is true' do
+        it_behaves_like 'the filter matches and #filter_on? is true'
+      end
+
+      context 'when #filter_on? is false' do
+        before do
+          subject.filter_on = false
+        end
+
+        it_behaves_like 'the filter matches and #filter_on? is false'
+      end
+    end
+
+    context 'when #filter_match? returns false' do
+      before { allow(subject.class).to receive(:filter_match?).and_return(false) }
+
+      context 'when #filter_on? is true' do
+        it_behaves_like 'the filter DOES NOT match and #filter_on? is true'
+      end
+
+      context 'when #filter_on? is false' do
+        let(:filter_on) { false }
+
+        it_behaves_like 'the filter DOES NOT match and #filter_on? is false'
+      end
+    end
+  end
+end

data/spec/lib/LittleWeasel/filters/en_us/single_character_word_filter_spec.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe LittleWeasel::Filters::EnUs::SingleCharacterWordFilter do
+  subject { described_class.new }
+
+  #filter_match?
+  describe '#filter_match?' do
+    context 'when word single character word' do
+      it 'returns true' do
+        %w(a A I).each do |number|
+          expect(subject.filter_match? number).to eq true
+        end
+      end
+    end
+
+    context 'when word is NOT a single character word' do
+      it 'returns false' do
+        expect(subject.filter_match? 'X').to eq false
+        expect(subject.filter_match? :a).to eq false
+        expect(subject.filter_match? Object.new).to eq false
+      end
+    end
+
+    let(:word) { 'x' }
+
+    context 'when #filter_match? returns true' do
+      before { allow(subject.class).to receive(:filter_match?).and_return(true) }
+
+      context 'when #filter_on? is true' do
+        it_behaves_like 'the filter matches and #filter_on? is true'
+      end
+
+      context 'when #filter_on? is false' do
+        before do
+          subject.filter_on = false
+        end
+
+        it_behaves_like 'the filter matches and #filter_on? is false'
+      end
+    end
+
+    context 'when #filter_match? returns false' do
+      before { allow(subject.class).to receive(:filter_match?).and_return(false) }
+
+      context 'when #filter_on? is true' do
+        it_behaves_like 'the filter DOES NOT match and #filter_on? is true'
+      end
+
+      context 'when #filter_on? is false' do
+        let(:filter_on) { false }
+
+        it_behaves_like 'the filter DOES NOT match and #filter_on? is false'
+      end
+    end
+  end
+end

data/spec/lib/LittleWeasel/filters/word_filter_managable_spec.rb

@@ -0,0 +1,180 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe LittleWeasel::Filters::WordFilterManagable, type: :module do
+  include_context 'mock word filters'
+
+  WordFilterManagable = described_class
+
+  subject do
+    Class.new do
+      include WordFilterManagable
+      include LittleWeasel::Modules::Configurable
+
+      def initialize(word_filters)
+        self.word_filters = word_filters
+      end
+    end.new(word_filters)
+  end
+
+  let(:word_filters) { [numeric_filter] }
+  let(:numeric_filter) { LittleWeasel::Filters::EnUs::NumericFilter.new }
+
+  #clear_filters
+  describe '#clear_filters' do
+    it 'sets #word_filters to an empty Array ([])' do
+      expect { subject.clear_filters }.to \
+        change { subject.word_filters.count }.from(1).to(0)
+    end
+  end
+
+  #add_filters
+  describe '#add_filters' do
+    context 'when argument word_filters is nil' do
+      context 'when no block is passed' do
+        it 'raises an error' do
+          expect { subject.add_filters }.to raise_error 'A block is required if argument word_filters is nil'
+        end
+      end
+
+      context 'when a block is passed' do
+        before do
+          subject.add_filters do |word_filters|
+            word_filters << WordFilter01.new
+            word_filters << WordFilter02.new
+          end
+        end
+
+        it 'the word filters are appended to the word_filters Array' do
+          expect(subject.word_filters.count).to eq 3
+          expect(subject.word_filters).to include(a_kind_of(WordFilter01))
+          expect(subject.word_filters).to include(a_kind_of(WordFilter02))
+          expect(subject.word_filters).to include(a_kind_of(LittleWeasel::Filters::EnUs::NumericFilter))
+        end
+      end
+    end
+
+    context 'when argument word_filters is a blank Array ([])' do
+      it 'nothing is changed' do
+        expect { subject.add_filters(word_filters: []) }.to_not change { subject.word_filters.count }.from(subject.word_filters.count)
+      end
+    end
+
+    context 'when argument word_filters is not an Array' do
+      it 'raises an error' do
+        expect { subject.add_filters(word_filters: :not_an_array) }.to raise_error(/Argument word_filters is not an Array:/)
+      end
+    end
+
+    context 'when argument word_filters is NOT nil' do
+      it 'the word filters passed to the method are appended to the #word_filters Array' do
+        expect(subject.add_filters(word_filters: [WordFilter01.new, WordFilter02.new]).count).to eq 3
+        expect(subject.word_filters).to include(a_kind_of(WordFilter01))
+        expect(subject.word_filters).to include(a_kind_of(WordFilter02))
+        expect(subject.word_filters).to include(a_kind_of(LittleWeasel::Filters::EnUs::NumericFilter))
+      end
+    end
+
+    context 'when a block is passed' do
+      before do
+        subject.add_filters do |word_filters|
+          word_filters << WordFilter01.new
+          word_filters << WordFilter02.new
+        end
+      end
+
+      it 'word filters added from the block are appended to the #word_filters Array' do
+        expect(subject.word_filters.count).to eq 3
+        expect(subject.word_filters).to include(a_kind_of(WordFilter01))
+        expect(subject.word_filters).to include(a_kind_of(WordFilter02))
+        expect(subject.word_filters).to include(a_kind_of(LittleWeasel::Filters::EnUs::NumericFilter))
+      end
+    end
+  end
+
+  #replace_filters
+  describe '#replace_filters' do
+    it 'replaces any existing word filters' do
+      expect(subject.word_filters.count).to eq 1
+      expect(subject.word_filters).to include(a_kind_of(LittleWeasel::Filters::EnUs::NumericFilter))
+      expect(subject.replace_filters(word_filters: [WordFilter01.new, WordFilter02.new]).count).to eq 2
+      expect(subject.word_filters).to include(a_kind_of(WordFilter01))
+      expect(subject.word_filters).to include(a_kind_of(WordFilter02))
+    end
+  end
+
+  #filters_on=
+  describe '#filters_on=' do
+    context 'when a boolean is not passed' do
+      it 'raises an error' do
+        expect { subject.filters_on = :not_a_boolean }.to raise_error(/Argument on is not true or false:/)
+      end
+    end
+
+    context 'when true is assigned' do
+      it 'turns all the filters on' do
+        expect(subject.word_filters.count).to_not be_zero
+        expect(subject.word_filters.all? { |word_filter| word_filter.filter_on? })
+        subject.filters_on = true
+        expect(subject.word_filters.all? { |word_filter| word_filter.filter_off? })
+      end
+    end
+
+    context 'when false is assigned' do
+      before do
+        subject.filters_on = false
+      end
+
+      it 'turns all the filters off' do
+        expect(subject.word_filters.count).to_not be_zero
+        expect(subject.word_filters.all? { |word_filter| word_filter.filter_off? })
+        subject.filters_on = false
+        expect(subject.word_filters.all? { |word_filter| word_filter.filter_on? })
+      end
+    end
+  end
+
+  #filter_match?
+  describe '#filter_match?' do
+    context 'when argument word is not a String' do
+      let(:word) { :not_a_string }
+
+      it 'raises an error' do
+        expect { subject.filter_match? word }.to raise_error "Argument word is not a String: #{word.class}"
+      end
+    end
+
+    context 'when argument word is empty' do
+      let(:word) { '' }
+
+      it 'returns false' do
+        expect(subject.filter_match? word).to eq false
+      end
+    end
+
+    context 'when argument word matches a filter' do
+      before do
+        subject.filters_on = true
+      end
+
+      let(:word) { '123456789' }
+
+      it 'returns true' do
+        expect(subject.filter_match? word).to eq true
+      end
+    end
+
+    context 'when argument word DOES NOT match a filter' do
+      before do
+        subject.filters_on = false
+      end
+
+      let(:word) { '123456789' }
+
+      it 'returns false' do
+        expect(subject.filter_match? word).to eq false
+      end
+    end
+  end
+end

data/spec/lib/LittleWeasel/filters/word_filter_spec.rb

@@ -0,0 +1,151 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe LittleWeasel::Filters::WordFilter do
+  subject { described_class.new }
+
+  #.new
+  describe '.new' do
+    it 'instantiates the object' do
+      expect { subject }.to_not raise_error
+    end
+
+    it 'sets #filter_on to true by default' do
+      expect(subject.filter_on).to eq true
+    end
+  end
+
+  #filter_off!
+  describe '#filter_off!' do
+    before do
+      subject.filter_off!
+    end
+
+    it 'sets the filter off' do
+      expect(subject.filter_off?).to eq true
+    end
+  end
+
+  #filter_on
+  describe '#filter_on' do
+    context 'when set to true' do
+      before do
+        subject.filter_on = true
+      end
+
+      it 'returns true' do
+        expect(subject.filter_on).to eq true
+      end
+    end
+
+    context 'when set to false' do
+      before do
+        subject.filter_on = false
+      end
+
+      it 'returns false' do
+        expect(subject.filter_on).to eq false
+      end
+    end
+  end
+
+  #filter_on=
+  describe '#filter_on=' do
+    context 'when argument value is valid' do
+      context 'when true' do
+        before do
+          subject.filter_on = false
+          expect(subject.filter_off?).to eq true
+        end
+
+        it 'sets #filter_on to true' do
+          subject.filter_on = true
+          expect(subject.filter_on).to eq true
+        end
+      end
+
+      context 'when false' do
+        before do
+          subject.filter_on = true
+          expect(subject.filter_on?).to eq true
+        end
+
+        it 'sets #filter_on to false' do
+          subject.filter_on = false
+          expect(subject.filter_on).to eq false
+        end
+      end
+    end
+
+    context 'when argument value is INVALID' do
+      context 'when argument value is not true or false' do
+        let(:filter_on) { :not_true_or_false }
+
+        it 'raises an error' do
+          expect { subject.filter_on = filter_on }.to raise_error(/Argument value is not true or false/)
+        end
+      end
+    end
+  end
+
+  #filter_on?
+  describe '#filter_on?' do
+    context 'when #filter_on is true' do
+      it 'returns true' do
+        subject.filter_on = true
+        expect(subject.filter_on?).to eq true
+      end
+    end
+
+    context 'when #filter_on is false' do
+      it 'returns false' do
+        subject.filter_on = false
+        expect(subject.filter_on?).to eq false
+      end
+    end
+  end
+
+  #filter_match?
+  describe '#filter_match?' do
+    let(:word) { 'word' }
+
+    context 'when not overridden' do
+      it 'raises an error' do
+        expect { subject.filter_match? 'boom' }.to raise_error LittleWeasel::Errors::MustOverrideError
+      end
+    end
+
+    context 'when #filter_match? returns true' do
+      before { allow(subject.class).to receive(:filter_match?).and_return(true) }
+
+      context 'when #filter_on? is true' do
+        it_behaves_like 'the filter matches and #filter_on? is true'
+      end
+
+      context 'when #filter_on? is false' do
+        before do
+          subject.filter_on = false
+        end
+
+        it_behaves_like 'the filter matches and #filter_on? is false'
+      end
+    end
+
+    context 'when #filter_match? returns false' do
+      before { allow(subject.class).to receive(:filter_match?).and_return(false) }
+
+      context 'when #filter_on? is true' do
+        it_behaves_like 'the filter DOES NOT match and #filter_on? is true'
+      end
+
+      context 'when #filter_on? is false' do
+        before do
+          subject.filter_on = false
+        end
+
+        it_behaves_like 'the filter DOES NOT match and #filter_on? is false'
+      end
+    end
+  end
+end