Refactor EventFilter and increase its test coverage1801-allow-event_filter-to-be-set-in-the-url

Signed-off-by: Rémy Coutable <remy@rymai.me>

1 files changed, 96 insertions, 35 deletions

diff --git a/spec/lib/event_filter_spec.rb b/spec/lib/event_filter_spec.rb
index 87ae6b6cf01..30016da6828 100644
--- a/spec/lib/event_filter_spec.rb
+++ b/spec/lib/event_filter_spec.rb
@@ -1,58 +1,119 @@
 require 'spec_helper'
 
 describe EventFilter do
+  describe 'FILTERS' do
+    it 'returns a definite list of filters' do
+      expect(described_class::FILTERS).to eq(%w[all push merged issue comments team])
+    end
+  end
+
+  describe '#filter' do
+    it 'returns "all" if given filter is nil' do
+      expect(described_class.new(nil).filter).to eq(described_class::ALL)
+    end
+
+    it 'returns "all" if given filter is ""' do
+      expect(described_class.new('').filter).to eq(described_class::ALL)
+    end
+
+    it 'returns "all" if given filter is "foo"' do
+      expect(described_class.new('foo').filter).to eq('all')
+    end
+  end
+
   describe '#apply_filter' do
-    let(:source_user) { create(:user) }
-    let!(:public_project) { create(:project, :public) }
+    set(:public_project) { create(:project, :public) }
+
+    set(:push_event)     { create(:push_event,        project: public_project) }
+    set(:merged_event)   { create(:event, :merged,    project: public_project, target: public_project) }
+    set(:created_event)  { create(:event, :created,   project: public_project, target: public_project) }
+    set(:updated_event)  { create(:event, :updated,   project: public_project, target: public_project) }
+    set(:closed_event)   { create(:event, :closed,    project: public_project, target: public_project) }
+    set(:reopened_event) { create(:event, :reopened,  project: public_project, target: public_project) }
+    set(:comments_event) { create(:event, :commented, project: public_project, target: public_project) }
+    set(:joined_event)   { create(:event, :joined,    project: public_project, target: public_project) }
+    set(:left_event)     { create(:event, :left,      project: public_project, target: public_project) }
 
-    let!(:push_event)     { create(:push_event,        project: public_project, author: source_user) }
-    let!(:merged_event)   { create(:event, :merged,    project: public_project, target: public_project, author: source_user) }
-    let!(:created_event)  { create(:event, :created,   project: public_project, target: public_project, author: source_user) }
-    let!(:updated_event)  { create(:event, :updated,   project: public_project, target: public_project, author: source_user) }
-    let!(:closed_event)   { create(:event, :closed,    project: public_project, target: public_project, author: source_user) }
-    let!(:reopened_event) { create(:event, :reopened,  project: public_project, target: public_project, author: source_user) }
-    let!(:comments_event) { create(:event, :commented, project: public_project, target: public_project, author: source_user) }
-    let!(:joined_event)   { create(:event, :joined,    project: public_project, target: public_project, author: source_user) }
-    let!(:left_event)     { create(:event, :left,      project: public_project, target: public_project, author: source_user) }
+    let(:filtered_events) { described_class.new(filter).apply_filter(Event.all) }
 
-    it 'applies push filter' do
-      events = described_class.new(described_class.push).apply_filter(Event.all)
-      expect(events).to contain_exactly(push_event)
+    context 'with the "push" filter' do
+      let(:filter) { described_class::PUSH }
+
+      it 'filters push events only' do
+        expect(filtered_events).to contain_exactly(push_event)
+      end
     end
 
-    it 'applies merged filter' do
-      events = described_class.new(described_class.merged).apply_filter(Event.all)
-      expect(events).to contain_exactly(merged_event)
+    context 'with the "merged" filter' do
+      let(:filter) { described_class::MERGED }
+
+      it 'filters merged events only' do
+        expect(filtered_events).to contain_exactly(merged_event)
+      end
     end
 
-    it 'applies issue filter' do
-      events = described_class.new(described_class.issue).apply_filter(Event.all)
-      expect(events).to contain_exactly(created_event, updated_event, closed_event, reopened_event)
+    context 'with the "issue" filter' do
+      let(:filter) { described_class::ISSUE }
+
+      it 'filters issue events only' do
+        expect(filtered_events).to contain_exactly(created_event, updated_event, closed_event, reopened_event)
+      end
     end
 
-    it 'applies comments filter' do
-      events = described_class.new(described_class.comments).apply_filter(Event.all)
-      expect(events).to contain_exactly(comments_event)
+    context 'with the "comments" filter' do
+      let(:filter) { described_class::COMMENTS }
+
+      it 'filters comment events only' do
+        expect(filtered_events).to contain_exactly(comments_event)
+      end
     end
 
-    it 'applies team filter' do
-      events = described_class.new(described_class.team).apply_filter(Event.all)
-      expect(events).to contain_exactly(joined_event, left_event)
+    context 'with the "team" filter' do
+      let(:filter) { described_class::TEAM }
+
+      it 'filters team events only' do
+        expect(filtered_events).to contain_exactly(joined_event, left_event)
+      end
     end
 
-    it 'applies all filter' do
-      events = described_class.new(described_class.all).apply_filter(Event.all)
-      expect(events).to contain_exactly(push_event, merged_event, created_event, updated_event, closed_event, reopened_event, comments_event, joined_event, left_event)
+    context 'with the "all" filter' do
+      let(:filter) { described_class::ALL }
+
+      it 'returns all events' do
+        expect(filtered_events).to eq(Event.all)
+      end
+    end
+
+    context 'with an unknown filter' do
+      let(:filter) { 'foo' }
+
+      it 'returns all events' do
+        expect(filtered_events).to eq(Event.all)
+      end
+    end
+
+    context 'with a nil filter' do
+      let(:filter) { nil }
+
+      it 'returns all events' do
+        expect(filtered_events).to eq(Event.all)
+      end
+    end
+  end
+
+  describe '#active?' do
+    let(:event_filter) { described_class.new(described_class::TEAM) }
+
+    it 'returns false if filter does not include the given key' do
+      expect(event_filter.active?('foo')).to eq(false)
     end
 
-    it 'applies no filter' do
-      events = described_class.new(nil).apply_filter(Event.all)
-      expect(events).to contain_exactly(push_event, merged_event, created_event, updated_event, closed_event, reopened_event, comments_event, joined_event, left_event)
+    it 'returns false if the given key is nil' do
+      expect(event_filter.active?(nil)).to eq(false)
     end
 
-    it 'applies unknown filter' do
-      events = described_class.new('').apply_filter(Event.all)
-      expect(events).to contain_exactly(push_event, merged_event, created_event, updated_event, closed_event, reopened_event, comments_event, joined_event, left_event)
+    it 'returns true if filter does not include the given key' do
+      expect(event_filter.active?(described_class::TEAM)).to eq(true)
     end
   end
 end