ProjectsFinder should handle more options

Extended ProjectFinder in order to handle the following options:
 - current_user - which user use
 - project_ids_relation: int[] - project ids to use
 - params:
   -  trending: boolean
   -  non_public: boolean
   -  starred: boolean
   -  sort: string
   -  visibility_level: int
   -  tags: string[]
   -  personal: boolean
   -  search: string
   -  non_archived: boolean

GroupProjectsFinder now inherits from ProjectsFinder.
Changed the code in order to use the new available options.

changelogs/unreleased/28810-projectfinder-should-handle-more-options.yml

+---
+title: ProjectsFinder should handle more options
+merge_request: 9682
+author: Jacopo Beschi @jacopo-beschi

lib/api/groups.rb

@@ -142,7 +142,7 @@ module API
       end
       get ":id/projects" do
         group = find_group!(params[:id])
-        projects = GroupProjectsFinder.new(group).execute(current_user)
+        projects = GroupProjectsFinder.new(group: group, current_user: current_user).execute
         projects = filter_projects(projects)
         entity = params[:simple] ? Entities::BasicProjectDetails : Entities::Project
         present paginate(projects), with: entity, current_user: current_user

lib/api/projects.rb

@@ -84,7 +84,7 @@ module API
       end
       get do
         entity = current_user ? Entities::ProjectWithAccess : Entities::BasicProjectDetails
-        present_projects ProjectsFinder.new.execute(current_user), with: entity, statistics: params[:statistics]
+        present_projects ProjectsFinder.new(current_user: current_user).execute, with: entity, statistics: params[:statistics]
       end
       desc 'Create new project' do

lib/api/users.rb

@@ -341,7 +341,7 @@ module API
         not_found!('User') unless user
         events = user.events.
-          merge(ProjectsFinder.new.execute(current_user)).
+          merge(ProjectsFinder.new(current_user: current_user).execute).
           references(:project).
           with_associations.
           recent

lib/api/v3/groups.rb

@@ -151,7 +151,7 @@ module API
         end
         get ":id/projects" do
           group = find_group!(params[:id])
-          projects = GroupProjectsFinder.new(group).execute(current_user)
+          projects = GroupProjectsFinder.new(group: group, current_user: current_user).execute
           projects = filter_projects(projects)
           entity = params[:simple] ? ::API::Entities::BasicProjectDetails : Entities::Project
           present paginate(projects), with: entity, current_user: current_user

lib/api/v3/projects.rb

@@ -107,7 +107,7 @@ module API
         end
         get '/visible' do
           entity = current_user ? ::API::V3::Entities::ProjectWithAccess : ::API::Entities::BasicProjectDetails
-          present_projects ProjectsFinder.new.execute(current_user), with: entity
+          present_projects ProjectsFinder.new(current_user: current_user).execute, with: entity
         end
         desc 'Get a projects list for authenticated user' do

lib/api/v3/users.rb

@@ -138,7 +138,7 @@ module API
           not_found!('User') unless user
           events = user.events.
-            merge(ProjectsFinder.new.execute(current_user)).
+            merge(ProjectsFinder.new(current_user: current_user).execute).
             references(:project).
             with_associations.
             recent

spec/finders/group_projects_finder_spec.rb

@@ -3,8 +3,9 @@ require 'spec_helper'
 describe GroupProjectsFinder do
   let(:group) { create(:group) }
   let(:current_user) { create(:user) }
-  let(:finder) { described_class.new(source_user) }
+  let(:options) { {} }
+  let(:finder) { described_class.new(group: group, current_user: current_user, options: options) }
   let!(:public_project) { create(:empty_project, :public, group: group, path: '1') }
   let!(:private_project) { create(:empty_project, :private, group: group, path: '2') }
@@ -18,22 +19,27 @@ describe GroupProjectsFinder do
     shared_project_3.project_group_links.create(group_access: Gitlab::Access::MASTER, group: group)
   end
+  subject { finder.execute }
+
   describe 'with a group member current user' do
-    before  { group.add_user(current_user, Gitlab::Access::MASTER) }
+    before do
+      group.add_master(current_user)
+    end
     context "only shared" do
-      subject { described_class.new(group, only_shared: true).execute(current_user) }
-      it      { is_expected.to eq([shared_project_3, shared_project_2, shared_project_1]) }
+      let(:options) { { only_shared: true } }
+
+      it { is_expected.to match_array([shared_project_3, shared_project_2, shared_project_1]) }
     end
     context "only owned" do
-      subject { described_class.new(group, only_owned: true).execute(current_user) }
-      it      { is_expected.to eq([private_project, public_project]) }
+      let(:options) { { only_owned: true } }
+
+      it { is_expected.to match_array([private_project, public_project]) }
     end
     context "all" do
-      subject { described_class.new(group).execute(current_user) }
-      it      { is_expected.to eq([shared_project_3, shared_project_2, shared_project_1, private_project, public_project]) }
+      it { is_expected.to match_array([shared_project_3, shared_project_2, shared_project_1, private_project, public_project]) }
     end
   end
@@ -44,47 +50,57 @@ describe GroupProjectsFinder do
     end
     context "only shared" do
+      let(:options) { { only_shared: true } }
+
       context "without external user" do
-        subject { described_class.new(group, only_shared: true).execute(current_user) }
-        it      { is_expected.to eq([shared_project_3, shared_project_2, shared_project_1]) }
+        it { is_expected.to match_array([shared_project_3, shared_project_2, shared_project_1]) }
       end
       context "with external user" do
-        before  { current_user.update_attributes(external: true) }
-        subject { described_class.new(group, only_shared: true).execute(current_user) }
-        it      { is_expected.to eq([shared_project_2, shared_project_1]) }
+        before do
+          current_user.update_attributes(external: true)
+        end
+
+        it { is_expected.to match_array([shared_project_2, shared_project_1]) }
       end
     end
     context "only owned" do
+      let(:options) { { only_owned: true } }
+
       context "without external user" do
-        before  { private_project.team << [current_user, Gitlab::Access::MASTER] }
-        subject { described_class.new(group, only_owned: true).execute(current_user) }
-        it      { is_expected.to eq([private_project, public_project]) }
+        before do
+          private_project.team << [current_user, Gitlab::Access::MASTER]
+        end
+
+        it { is_expected.to match_array([private_project, public_project]) }
       end
       context "with external user" do
-        before  { current_user.update_attributes(external: true) }
-        subject { described_class.new(group, only_owned: true).execute(current_user) }
-        it      { is_expected.to eq([public_project]) }
-      end
-      context "all" do
-        subject { described_class.new(group).execute(current_user) }
-        it      { is_expected.to eq([shared_project_3, shared_project_2, shared_project_1, public_project]) }
+        before do
+          current_user.update_attributes(external: true)
+        end
+        it { is_expected.to eq([public_project]) }
       end
     end
+
+    context "all" do
+      it { is_expected.to match_array([shared_project_3, shared_project_2, shared_project_1, public_project]) }
+    end
   end
   describe "no user" do
     context "only shared" do
-      subject { described_class.new(group, only_shared: true).execute(current_user) }
-      it      { is_expected.to eq([shared_project_3, shared_project_1]) }
+      let(:options) { { only_shared: true } }
+
+      it { is_expected.to match_array([shared_project_3, shared_project_1]) }
     end
     context "only owned" do
-      subject { described_class.new(group, only_owned: true).execute(current_user) }
-      it      { is_expected.to eq([public_project]) }
+      let(:options) { { only_owned: true } }
+
+      it { is_expected.to eq([public_project]) }
     end
   end
 end

spec/finders/projects_finder_spec.rb

@@ -21,38 +21,144 @@ describe ProjectsFinder do
       create(:empty_project, :private, name: 'D', path: 'D')
     end
-    let(:finder) { described_class.new }
+    let(:params) { {} }
+    let(:current_user) { user }
+    let(:project_ids_relation) { nil }
+    let(:finder) { described_class.new(params: params, current_user: current_user, project_ids_relation: project_ids_relation) }
+
+    subject { finder.execute }
     describe 'without a user' do
-      subject { finder.execute }
+      let(:current_user) { nil }
       it { is_expected.to eq([public_project]) }
     end
     describe 'with a user' do
-      subject { finder.execute(user) }
-
       describe 'without private projects' do
-        it { is_expected.to eq([public_project, internal_project]) }
+        it { is_expected.to match_array([public_project, internal_project]) }
       end
       describe 'with private projects' do
         before do
-          private_project.add_user(user, Gitlab::Access::MASTER)
+          private_project.add_master(user)
         end
-        it do
-          is_expected.to eq([public_project, internal_project, private_project])
-        end
+        it { is_expected.to match_array([public_project, internal_project, private_project]) }
       end
     end
     describe 'with project_ids_relation' do
       let(:project_ids_relation) { Project.where(id: internal_project.id) }
-      subject { finder.execute(user, project_ids_relation) }
-
       it { is_expected.to eq([internal_project]) }
     end
+
+    describe 'filter by visibility_level' do
+      before do
+        private_project.add_master(user)
+      end
+
+      context 'private' do
+        let(:params) { { visibility_level: Gitlab::VisibilityLevel::PRIVATE } }
+
+        it { is_expected.to eq([private_project]) }
+      end
+
+      context 'internal' do
+        let(:params) { { visibility_level: Gitlab::VisibilityLevel::INTERNAL } }
+
+        it { is_expected.to eq([internal_project]) }
+      end
+
+      context 'public' do
+        let(:params) { { visibility_level: Gitlab::VisibilityLevel::PUBLIC } }
+
+        it { is_expected.to eq([public_project]) }
+      end
+    end
+
+    describe 'filter by tags' do
+      before do
+        public_project.tag_list.add('foo')
+        public_project.save!
+      end
+
+      let(:params) { { tag: 'foo' } }
+
+      it { is_expected.to eq([public_project]) }
+    end
+
+    describe 'filter by personal' do
+      let!(:personal_project) { create(:empty_project, namespace: user.namespace) }
+      let(:params) { { personal: true } }
+
+      it { is_expected.to eq([personal_project]) }
+    end
+
+    describe 'filter by search' do
+      let(:params) { { search: 'C' } }
+
+      it { is_expected.to eq([public_project]) }
+    end
+
+    describe 'filter by name for backward compatibility' do
+      let(:params) { { name: 'C' } }
+
+      it { is_expected.to eq([public_project]) }
+    end
+
+    describe 'filter by archived' do
+      let!(:archived_project) { create(:empty_project, :public, :archived, name: 'E', path: 'E') }
+
+      context 'non_archived=true' do
+        let(:params) { { non_archived: true } }
+
+        it { is_expected.to match_array([public_project, internal_project]) }
+      end
+
+      context 'non_archived=false' do
+        let(:params) { { non_archived: false } }
+
+        it { is_expected.to match_array([public_project, internal_project, archived_project]) }
+      end
+
+      describe 'filter by archived for backward compatibility' do
+        let(:params) { { archived: false } }
+
+        it { is_expected.to match_array([public_project, internal_project]) }
+      end
+    end
+
+    describe 'filter by trending' do
+      let!(:trending_project) { create(:trending_project, project: public_project)  }
+      let(:params) { { trending: true } }
+
+      it { is_expected.to eq([public_project]) }
+    end
+
+    describe 'filter by non_public' do
+      let(:params) { { non_public: true } }
+      before do
+        private_project.add_developer(current_user)
+      end
+
+      it { is_expected.to eq([private_project]) }
+    end
+
+    describe 'filter by viewable_starred_projects' do
+      let(:params) { { starred: true } }
+      before do
+        current_user.toggle_star(public_project)
+      end
+
+      it { is_expected.to eq([public_project]) }
+    end
+
+    describe 'sorting' do
+      let(:params) { { sort: 'name_asc' } }
+
+      it { is_expected.to eq([internal_project, public_project]) }
+    end
   end
 end