Add SortingPreference concern

Sorting preference functionality has been extracted
from `IssuableCollections` to a new `SortingPreference`
concern in order to reuse this functionality in projects
(and groups in the future).

4 files changed, 166 insertions, 102 deletions

diff --git a/spec/controllers/concerns/issuable_collections_spec.rb b/spec/controllers/concerns/issuable_collections_spec.rb
index f210537aad5..7bdf5c49425 100644
--- a/spec/controllers/concerns/issuable_collections_spec.rb
+++ b/spec/controllers/concerns/issuable_collections_spec.rb
@@ -24,78 +24,6 @@ describe IssuableCollections do
     controller
   end
 
-  describe '#set_sort_order_from_user_preference' do
-    describe 'when sort param given' do
-      let(:params) { { sort: 'updated_desc' } }
-
-      context 'when issuable_sorting_field is defined' do
-        before do
-          controller.class.define_method(:issuable_sorting_field) { :issues_sort}
-        end
-
-        it 'sets user_preference with the right value' do
-          controller.send(:set_sort_order_from_user_preference)
-
-          expect(user.user_preference.reload.issues_sort).to eq('updated_desc')
-        end
-      end
-
-      context 'when no issuable_sorting_field is defined on the controller' do
-        it 'does not touch user_preference' do
-          allow(user).to receive(:user_preference)
-
-          controller.send(:set_sort_order_from_user_preference)
-
-          expect(user).not_to have_received(:user_preference)
-        end
-      end
-    end
-
-    context 'when a user sorting preference exists' do
-      let(:params) { {} }
-
-      before do
-        controller.class.define_method(:issuable_sorting_field) { :issues_sort }
-      end
-
-      it 'returns the set preference' do
-        user.user_preference.update(issues_sort: 'updated_asc')
-
-        sort_preference = controller.send(:set_sort_order_from_user_preference)
-
-        expect(sort_preference).to eq('updated_asc')
-      end
-    end
-  end
-
-  describe '#set_set_order_from_cookie' do
-    describe 'when sort param given' do
-      let(:cookies) { {} }
-      let(:params) { { sort: 'downvotes_asc' } }
-
-      it 'sets the cookie with the right values and flags' do
-        allow(controller).to receive(:cookies).and_return(cookies)
-
-        controller.send(:set_sort_order_from_cookie)
-
-        expect(cookies['issue_sort']).to eq({ value: 'popularity', secure: false, httponly: false })
-      end
-    end
-
-    describe 'when cookie exists' do
-      let(:cookies) { { 'issue_sort' => 'id_asc' } }
-      let(:params) { {} }
-
-      it 'sets the cookie with the right values and flags' do
-        allow(controller).to receive(:cookies).and_return(cookies)
-
-        controller.send(:set_sort_order_from_cookie)
-
-        expect(cookies['issue_sort']).to eq({ value: 'created_asc', secure: false, httponly: false })
-      end
-    end
-  end
-
   describe '#page_count_for_relation' do
     let(:params) { { state: 'opened' } }
 
diff --git a/spec/controllers/concerns/sorting_preference_spec.rb b/spec/controllers/concerns/sorting_preference_spec.rb
new file mode 100644
index 00000000000..a36124c6776
--- /dev/null
+++ b/spec/controllers/concerns/sorting_preference_spec.rb
@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe SortingPreference do
+  let(:user) { create(:user) }
+
+  let(:controller_class) do
+    Class.new do
+      def self.helper_method(name); end
+
+      include SortingPreference
+      include SortingHelper
+    end
+  end
+
+  let(:controller) { controller_class.new }
+
+  before do
+    allow(controller).to receive(:params).and_return(ActionController::Parameters.new(params))
+    allow(controller).to receive(:current_user).and_return(user)
+    allow(controller).to receive(:legacy_sort_cookie_name).and_return('issuable_sort')
+    allow(controller).to receive(:sorting_field).and_return(:issues_sort)
+  end
+
+  describe '#set_sort_order_from_user_preference' do
+    subject { controller.send(:set_sort_order_from_user_preference) }
+
+    context 'when sort param given' do
+      let(:params) { { sort: 'updated_desc' } }
+
+      context 'when sorting_field is defined' do
+        it 'sets user_preference with the right value' do
+          is_expected.to eq('updated_desc')
+        end
+      end
+
+      context 'when no sorting_field is defined on the controller' do
+        before do
+          allow(controller).to receive(:sorting_field).and_return(nil)
+        end
+
+        it 'does not touch user_preference' do
+          expect(user).not_to receive(:user_preference)
+
+          subject
+        end
+      end
+    end
+
+    context 'when a user sorting preference exists' do
+      let(:params) { {} }
+
+      before do
+        user.user_preference.update!(issues_sort: 'updated_asc')
+      end
+
+      it 'returns the set preference' do
+        is_expected.to eq('updated_asc')
+      end
+    end
+  end
+
+  describe '#set_set_order_from_cookie' do
+    subject { controller.send(:set_sort_order_from_cookie) }
+
+    before do
+      allow(controller).to receive(:cookies).and_return(cookies)
+    end
+
+    context 'when sort param given' do
+      let(:cookies) { {} }
+      let(:params) { { sort: 'downvotes_asc' } }
+
+      it 'sets the cookie with the right values and flags' do
+        subject
+
+        expect(cookies['issue_sort']).to eq(value: 'popularity', secure: false, httponly: false)
+      end
+    end
+
+    context 'when cookie exists' do
+      let(:cookies) { { 'issue_sort' => 'id_asc' } }
+      let(:params) { {} }
+
+      it 'sets the cookie with the right values and flags' do
+        subject
+
+        expect(cookies['issue_sort']).to eq(value: 'created_asc', secure: false, httponly: false)
+      end
+    end
+  end
+end
diff --git a/spec/controllers/dashboard/projects_controller_spec.rb b/spec/controllers/dashboard/projects_controller_spec.rb
index 6591901a9dc..8b95c9f2496 100644
--- a/spec/controllers/dashboard/projects_controller_spec.rb
+++ b/spec/controllers/dashboard/projects_controller_spec.rb
@@ -40,6 +40,14 @@ describe Dashboard::ProjectsController do
 
         expect(assigns(:projects)).to eq([project, project2])
       end
+
+      context 'project sorting' do
+        let(:project) { create(:project) }
+
+        it_behaves_like 'set sort order from user preference' do
+          let(:sorting_param) { 'created_asc' }
+        end
+      end
     end
   end
 
diff --git a/spec/controllers/explore/projects_controller_spec.rb b/spec/controllers/explore/projects_controller_spec.rb
index 463586ee422..6752d2b8ebd 100644
--- a/spec/controllers/explore/projects_controller_spec.rb
+++ b/spec/controllers/explore/projects_controller_spec.rb
@@ -3,56 +3,91 @@
 require 'spec_helper'
 
 describe Explore::ProjectsController do
-  describe 'GET #index.json' do
-    render_views
+  shared_examples 'explore projects' do
+    describe 'GET #index.json' do
+      render_views
 
-    before do
-      get :index, format: :json
+      before do
+        get :index, format: :json
+      end
+
+      it { is_expected.to respond_with(:success) }
     end
 
-    it { is_expected.to respond_with(:success) }
-  end
+    describe 'GET #trending.json' do
+      render_views
 
-  describe 'GET #trending.json' do
-    render_views
+      before do
+        get :trending, format: :json
+      end
 
-    before do
-      get :trending, format: :json
+      it { is_expected.to respond_with(:success) }
+    end
+
+    describe 'GET #starred.json' do
+      render_views
+
+      before do
+        get :starred, format: :json
+      end
+
+      it { is_expected.to respond_with(:success) }
     end
 
-    it { is_expected.to respond_with(:success) }
+    describe 'GET #trending' do
+      context 'sorting by update date' do
+        let(:project1) { create(:project, :public, updated_at: 3.days.ago) }
+        let(:project2) { create(:project, :public, updated_at: 1.day.ago) }
+
+        before do
+          create(:trending_project, project: project1)
+          create(:trending_project, project: project2)
+        end
+
+        it 'sorts by last updated' do
+          get :trending, params: { sort: 'updated_desc' }
+
+          expect(assigns(:projects)).to eq [project2, project1]
+        end
+
+        it 'sorts by oldest updated' do
+          get :trending, params: { sort: 'updated_asc' }
+
+          expect(assigns(:projects)).to eq [project1, project2]
+        end
+      end
+    end
   end
 
-  describe 'GET #starred.json' do
-    render_views
+  context 'when user is signed in' do
+    let(:user) { create(:user) }
 
     before do
-      get :starred, format: :json
+      sign_in(user)
     end
 
-    it { is_expected.to respond_with(:success) }
-  end
+    include_examples 'explore projects'
 
-  describe 'GET #trending' do
-    context 'sorting by update date' do
-      let(:project1) { create(:project, :public, updated_at: 3.days.ago) }
-      let(:project2) { create(:project, :public, updated_at: 1.day.ago) }
+    context 'user preference sorting' do
+      let(:project) { create(:project) }
 
-      before do
-        create(:trending_project, project: project1)
-        create(:trending_project, project: project2)
+      it_behaves_like 'set sort order from user preference' do
+        let(:sorting_param) { 'created_asc' }
       end
+    end
+  end
 
-      it 'sorts by last updated' do
-        get :trending, params: { sort: 'updated_desc' }
+  context 'when user is not signed in' do
+    include_examples 'explore projects'
 
-        expect(assigns(:projects)).to eq [project2, project1]
-      end
+    context 'user preference sorting' do
+      let(:project) { create(:project) }
+      let(:sorting_param) { 'created_asc' }
 
-      it 'sorts by oldest updated' do
-        get :trending, params: { sort: 'updated_asc' }
+      it 'does not set sort order from user preference' do
+        expect_any_instance_of(UserPreference).not_to receive(:update)
 
-        expect(assigns(:projects)).to eq [project1, project2]
+        get :index, params: { sort: sorting_param }
       end
     end
   end