Improve list of sorting options

6 files changed, 227 insertions, 188 deletions

diff --git a/app/controllers/concerns/issuable_collections.rb b/app/controllers/concerns/issuable_collections.rb
index 0d0e53d4b76..8921d55c3d0 100644
--- a/app/controllers/concerns/issuable_collections.rb
+++ b/app/controllers/concerns/issuable_collections.rb
@@ -117,19 +117,32 @@ module IssuableCollections
     key = 'issuable_sort'
 
     cookies[key] = params[:sort] if params[:sort].present?
-
-    # id_desc and id_asc are old values for these two.
-    cookies[key] = sort_value_recently_created if cookies[key] == 'id_desc'
-    cookies[key] = sort_value_oldest_created if cookies[key] == 'id_asc'
-
+    cookies[key] = update_cookie_value(cookies[key])
     params[:sort] = cookies[key]
   end
 
   def default_sort_order
     case params[:state]
-    when 'opened', 'all' then sort_value_recently_created
+    when 'opened', 'all'    then sort_value_created_date
     when 'merged', 'closed' then sort_value_recently_updated
-    else sort_value_recently_created
+    else sort_value_created_date
+    end
+  end
+
+  # Update old values to the actual ones.
+  def update_cookie_value(value)
+    case value
+    when 'id_asc'             then sort_value_oldest_created
+    when 'id_desc'            then sort_value_recently_created
+    when 'created_asc'        then sort_value_created_date
+    when 'created_desc'       then sort_value_created_date
+    when 'due_date_asc'       then sort_value_due_date
+    when 'due_date_desc'      then sort_value_due_date
+    when 'milestone_due_asc'  then sort_value_milestone
+    when 'milestone_due_desc' then sort_value_milestone
+    when 'downvotes_asc'      then sort_value_popularity
+    when 'downvotes_desc'     then sort_value_popularity
+    else value
     end
   end
 end
diff --git a/app/helpers/sorting_helper.rb b/app/helpers/sorting_helper.rb
index c4a73bedbcd..1b542ed2a96 100644
--- a/app/helpers/sorting_helper.rb
+++ b/app/helpers/sorting_helper.rb
@@ -1,34 +1,38 @@
 module SortingHelper
   def sort_options_hash
     {
-      sort_value_name => sort_title_name,
-      sort_value_name_desc => sort_title_name_desc,
-      sort_value_recently_updated => sort_title_recently_updated,
-      sort_value_oldest_updated => sort_title_oldest_updated,
+      sort_value_created_date     => sort_title_created_date,
+      sort_value_downvotes        => sort_title_downvotes,
+      sort_value_due_date         => sort_title_due_date,
+      sort_value_due_date_later   => sort_title_due_date_later,
+      sort_value_due_date_soon    => sort_title_due_date_soon,
+      sort_value_label_priority   => sort_title_label_priority,
+      sort_value_largest_group    => sort_title_largest_group,
+      sort_value_largest_repo     => sort_title_largest_repo,
+      sort_value_milestone        => sort_title_milestone,
+      sort_value_milestone_later  => sort_title_milestone_later,
+      sort_value_milestone_soon   => sort_title_milestone_soon,
+      sort_value_name             => sort_title_name,
+      sort_value_name_desc        => sort_title_name_desc,
+      sort_value_oldest_created   => sort_title_oldest_created,
+      sort_value_oldest_signin    => sort_title_oldest_signin,
+      sort_value_oldest_updated   => sort_title_oldest_updated,
       sort_value_recently_created => sort_title_recently_created,
-      sort_value_oldest_created => sort_title_oldest_created,
-      sort_value_milestone_soon => sort_title_milestone_soon,
-      sort_value_milestone_later => sort_title_milestone_later,
-      sort_value_due_date_soon => sort_title_due_date_soon,
-      sort_value_due_date_later => sort_title_due_date_later,
-      sort_value_largest_repo => sort_title_largest_repo,
-      sort_value_largest_group => sort_title_largest_group,
-      sort_value_recently_signin => sort_title_recently_signin,
-      sort_value_oldest_signin => sort_title_oldest_signin,
-      sort_value_downvotes => sort_title_downvotes,
-      sort_value_upvotes => sort_title_upvotes,
-      sort_value_priority => sort_title_priority,
-      sort_value_label_priority => sort_title_label_priority
+      sort_value_recently_signin  => sort_title_recently_signin,
+      sort_value_recently_updated => sort_title_recently_updated,
+      sort_value_popularity       => sort_title_popularity,
+      sort_value_priority         => sort_title_priority,
+      sort_value_upvotes          => sort_title_upvotes
     }
   end
 
   def projects_sort_options_hash
     options = {
-      sort_value_name => sort_title_name,
-      sort_value_latest_activity => sort_title_latest_activity,
-      sort_value_oldest_activity => sort_title_oldest_activity,
-      sort_value_recently_created => sort_title_recently_created,
-      sort_value_oldest_created => sort_title_oldest_created
+      sort_value_latest_activity  => sort_title_latest_activity,
+      sort_value_name             => sort_title_name,
+      sort_value_oldest_activity  => sort_title_oldest_activity,
+      sort_value_oldest_created   => sort_title_oldest_created,
+      sort_value_recently_created => sort_title_recently_created
     }
 
     if current_controller?('admin/projects')
@@ -40,160 +44,174 @@ module SortingHelper
 
   def member_sort_options_hash
     {
-      sort_value_access_level_asc => sort_title_access_level_asc,
+      sort_value_access_level_asc  => sort_title_access_level_asc,
       sort_value_access_level_desc => sort_title_access_level_desc,
-      sort_value_last_joined => sort_title_last_joined,
-      sort_value_oldest_joined => sort_title_oldest_joined,
-      sort_value_name => sort_title_name_asc,
-      sort_value_name_desc => sort_title_name_desc,
-      sort_value_recently_signin => sort_title_recently_signin,
-      sort_value_oldest_signin => sort_title_oldest_signin
+      sort_value_last_joined       => sort_title_last_joined,
+      sort_value_name              => sort_title_name_asc,
+      sort_value_name_desc         => sort_title_name_desc,
+      sort_value_oldest_joined     => sort_title_oldest_joined,
+      sort_value_oldest_signin     => sort_title_oldest_signin,
+      sort_value_recently_signin   => sort_title_recently_signin
     }
   end
 
   def milestone_sort_options_hash
     {
-      sort_value_name => sort_title_name_asc,
-      sort_value_name_desc => sort_title_name_desc,
-      sort_value_due_date_soon => sort_title_due_date_soon,
-      sort_value_due_date_later => sort_title_due_date_later,
-      sort_value_start_date_soon => sort_title_start_date_soon,
-      sort_value_start_date_later => sort_title_start_date_later
+      sort_value_name             => sort_title_name_asc,
+      sort_value_name_desc        => sort_title_name_desc,
+      sort_value_due_date_later   => sort_title_due_date_later,
+      sort_value_due_date_soon    => sort_title_due_date_soon,
+      sort_value_start_date_later => sort_title_start_date_later,
+      sort_value_start_date_soon  => sort_title_start_date_soon
     }
   end
 
   def branches_sort_options_hash
     {
-      sort_value_name => sort_title_name,
-      sort_value_recently_updated => sort_title_recently_updated,
-      sort_value_oldest_updated => sort_title_oldest_updated
+      sort_value_name             => sort_title_name,
+      sort_value_oldest_updated   => sort_title_oldest_updated,
+      sort_value_recently_updated => sort_title_recently_updated
     }
   end
 
   def tags_sort_options_hash
     {
-      sort_value_name => sort_title_name,
-      sort_value_recently_updated => sort_title_recently_updated,
-      sort_value_oldest_updated => sort_title_oldest_updated
+      sort_value_name             => sort_title_name,
+      sort_value_oldest_updated   => sort_title_oldest_updated,
+      sort_value_recently_updated => sort_title_recently_updated
     }
   end
 
-  def sort_title_priority
-    s_('SortOptions|Priority')
+  def sortable_item(item, path, sorted_by)
+    link_to item, path, class: sorted_by == item ? 'is-active' : ''
   end
 
-  def sort_title_label_priority
-    s_('SortOptions|Label priority')
+  # Titles.
+  def sort_title_access_level_asc
+    s_('SortOptions|Access level, ascending')
   end
 
-  def sort_title_oldest_updated
-    s_('SortOptions|Oldest updated')
+  def sort_title_access_level_desc
+    s_('SortOptions|Access level, descending')
   end
 
-  def sort_title_recently_updated
-    s_('SortOptions|Last updated')
+  def sort_title_created_date
+    s_('SortOptions|Created date')
   end
 
-  def sort_title_oldest_activity
-    s_('SortOptions|Oldest updated')
+  def sort_title_downvotes
+    s_('SortOptions|Least popular')
   end
 
-  def sort_title_latest_activity
-    s_('SortOptions|Last updated')
+  def sort_title_due_date
+    s_('SortOptions|Due date')
   end
 
-  def sort_title_oldest_created
-    s_('SortOptions|Oldest created')
+  def sort_title_due_date_later
+    s_('SortOptions|Due later')
   end
 
-  def sort_title_recently_created
-    s_('SortOptions|Last created')
+  def sort_title_due_date_soon
+    s_('SortOptions|Due soon')
   end
 
-  def sort_title_milestone_soon
-    s_('SortOptions|Milestone due soon')
+  def sort_title_label_priority
+    s_('SortOptions|Label priority')
   end
 
-  def sort_title_milestone_later
-    s_('SortOptions|Milestone due later')
+  def sort_title_largest_group
+    s_('SortOptions|Largest group')
   end
 
-  def sort_title_due_date_soon
-    s_('SortOptions|Due soon')
+  def sort_title_largest_repo
+    s_('SortOptions|Largest repository')
   end
 
-  def sort_title_due_date_later
-    s_('SortOptions|Due later')
+  def sort_title_last_joined
+    s_('SortOptions|Last joined')
   end
 
-  def sort_title_start_date_soon
-    s_('SortOptions|Start soon')
+  def sort_title_latest_activity
+    s_('SortOptions|Last updated')
   end
 
-  def sort_title_start_date_later
-    s_('SortOptions|Start later')
+  def sort_title_milestone
+    s_('SortOptions|Milestone')
+  end
+
+  def sort_title_milestone_later
+    s_('SortOptions|Milestone due later')
+  end
+
+  def sort_title_milestone_soon
+    s_('SortOptions|Milestone due soon')
   end
 
   def sort_title_name
     s_('SortOptions|Name')
   end
 
-  def sort_title_largest_repo
-    s_('SortOptions|Largest repository')
+  def sort_title_name_asc
+    s_('SortOptions|Name, ascending')
   end
 
-  def sort_title_largest_group
-    s_('SortOptions|Largest group')
+  def sort_title_name_desc
+    s_('SortOptions|Name, descending')
   end
 
-  def sort_title_recently_signin
-    s_('SortOptions|Recent sign in')
+  def sort_title_oldest_activity
+    s_('SortOptions|Oldest updated')
   end
 
-  def sort_title_oldest_signin
-    s_('SortOptions|Oldest sign in')
+  def sort_title_oldest_created
+    s_('SortOptions|Oldest created')
   end
 
-  def sort_title_downvotes
-    s_('SortOptions|Least popular')
+  def sort_title_oldest_joined
+    s_('SortOptions|Oldest joined')
   end
 
-  def sort_title_upvotes
-    s_('SortOptions|Most popular')
+  def sort_title_oldest_signin
+    s_('SortOptions|Oldest sign in')
   end
 
-  def sort_title_last_joined
-    s_('SortOptions|Last joined')
+  def sort_title_oldest_updated
+    s_('SortOptions|Oldest updated')
   end
 
-  def sort_title_oldest_joined
-    s_('SortOptions|Oldest joined')
+  def sort_title_popularity
+    s_('SortOptions|Popularity')
   end
 
-  def sort_title_access_level_asc
-    s_('SortOptions|Access level, ascending')
+  def sort_title_priority
+    s_('SortOptions|Priority')
   end
 
-  def sort_title_access_level_desc
-    s_('SortOptions|Access level, descending')
+  def sort_title_recently_created
+    s_('SortOptions|Last created')
   end
 
-  def sort_title_name_asc
-    s_('SortOptions|Name, ascending')
+  def sort_title_recently_signin
+    s_('SortOptions|Recent sign in')
   end
 
-  def sort_title_name_desc
-    s_('SortOptions|Name, descending')
+  def sort_title_recently_updated
+    s_('SortOptions|Last updated')
   end
 
-  def sort_value_last_joined
-    'last_joined'
+  def sort_title_start_date_later
+    s_('SortOptions|Start later')
   end
 
-  def sort_value_oldest_joined
-    'oldest_joined'
+  def sort_title_start_date_soon
+    s_('SortOptions|Start soon')
   end
 
+  def sort_title_upvotes
+    s_('SortOptions|Most popular')
+  end
+
+  # Values.
   def sort_value_access_level_asc
     'access_level_asc'
   end
@@ -202,88 +220,112 @@ module SortingHelper
     'access_level_desc'
   end
 
-  def sort_value_name_desc
-    'name_desc'
+  def sort_value_created_date
+    'created_date'
   end
 
-  def sort_value_priority
-    'priority'
+  def sort_value_downvotes
+    'downvotes_desc'
+  end
+
+  def sort_value_due_date
+    'due_date'
+  end
+
+  def sort_value_due_date_later
+    'due_date_desc'
+  end
+
+  def sort_value_due_date_soon
+    'due_date_asc'
   end
 
   def sort_value_label_priority
     'label_priority'
   end
 
-  def sort_value_oldest_updated
-    'updated_asc'
+  def sort_value_largest_group
+    'storage_size_desc'
   end
 
-  def sort_value_recently_updated
-    'updated_desc'
+  def sort_value_largest_repo
+    'storage_size_desc'
   end
 
-  def sort_value_oldest_activity
-    'latest_activity_asc'
+  def sort_value_last_joined
+    'last_joined'
   end
 
   def sort_value_latest_activity
     'latest_activity_desc'
   end
 
-  def sort_value_oldest_created
-    'created_asc'
+  def sort_value_milestone
+    'milestone'
   end
 
-  def sort_value_recently_created
-    'created_desc'
+  def sort_value_milestone_later
+    'milestone_due_desc'
   end
 
   def sort_value_milestone_soon
     'milestone_due_asc'
   end
 
-  def sort_value_milestone_later
-    'milestone_due_desc'
+  def sort_value_name
+    'name_asc'
   end
 
-  def sort_value_due_date_soon
-    'due_date_asc'
+  def sort_value_name_desc
+    'name_desc'
   end
 
-  def sort_value_due_date_later
-    'due_date_desc'
+  def sort_value_oldest_activity
+    'latest_activity_asc'
   end
 
-  def sort_value_start_date_soon
-    'start_date_asc'
+  def sort_value_oldest_created
+    'created_asc'
   end
 
-  def sort_value_start_date_later
-    'start_date_desc'
+  def sort_value_oldest_signin
+    'oldest_sign_in'
   end
 
-  def sort_value_name
-    'name_asc'
+  def sort_value_oldest_joined
+    'oldest_joined'
   end
 
-  def sort_value_largest_repo
-    'storage_size_desc'
+  def sort_value_oldest_updated
+    'updated_asc'
   end
 
-  def sort_value_largest_group
-    'storage_size_desc'
+  def sort_value_popularity
+    'popularity'
+  end
+
+  def sort_value_priority
+    'priority'
+  end
+
+  def sort_value_recently_created
+    'created_desc'
   end
 
   def sort_value_recently_signin
     'recent_sign_in'
   end
 
-  def sort_value_oldest_signin
-    'oldest_sign_in'
+  def sort_value_recently_updated
+    'updated_desc'
   end
 
-  def sort_value_downvotes
-    'downvotes_desc'
+  def sort_value_start_date_later
+    'start_date_desc'
+  end
+
+  def sort_value_start_date_soon
+    'start_date_asc'
   end
 
   def sort_value_upvotes
diff --git a/app/models/concerns/issuable.rb b/app/models/concerns/issuable.rb
index 265f6e48540..fc30d008dea 100644
--- a/app/models/concerns/issuable.rb
+++ b/app/models/concerns/issuable.rb
@@ -143,16 +143,18 @@ module Issuable
     end
 
     def sort(method, excluded_labels: [])
-      sorted = case method.to_s
-               when 'milestone_due_asc' then order_milestone_due_asc
-               when 'milestone_due_desc' then order_milestone_due_desc
-               when 'downvotes_desc' then order_downvotes_desc
-               when 'upvotes_desc' then order_upvotes_desc
-               when 'label_priority' then order_labels_priority(excluded_labels: excluded_labels)
-               when 'priority' then order_due_date_and_labels_priority(excluded_labels: excluded_labels)
-               else
-                 order_by(method)
-               end
+      sorted =
+        case method.to_s
+        when 'downvotes_desc'     then order_downvotes_desc
+        when 'label_priority'     then order_labels_priority(excluded_labels: excluded_labels)
+        when 'milestone'          then order_milestone_due_asc
+        when 'milestone_due_asc'  then order_milestone_due_asc
+        when 'milestone_due_desc' then order_milestone_due_desc
+        when 'popularity'         then order_upvotes_desc
+        when 'priority'           then order_due_date_and_labels_priority(excluded_labels: excluded_labels)
+        when 'upvotes_desc'       then order_upvotes_desc
+        else order_by(method)
+        end
 
       # Break ties with the ID column for pagination
       sorted.order(id: :desc)
@@ -214,7 +216,7 @@ module Issuable
     def grouping_columns(sort)
       grouping_columns = [arel_table[:id]]
 
-      if %w(milestone_due_desc milestone_due_asc).include?(sort)
+      if %w(milestone_due_desc milestone_due_asc milestone).include?(sort)
         milestone_table = Milestone.arel_table
         grouping_columns << milestone_table[:id]
         grouping_columns << milestone_table[:due_date]
diff --git a/app/models/concerns/sortable.rb b/app/models/concerns/sortable.rb
index db3cd257584..cefa5c13c5f 100644
--- a/app/models/concerns/sortable.rb
+++ b/app/models/concerns/sortable.rb
@@ -19,14 +19,15 @@ module Sortable
   module ClassMethods
     def order_by(method)
       case method.to_s
-      when 'name_asc' then order_name_asc
-      when 'name_desc' then order_name_desc
-      when 'updated_asc' then order_updated_asc
-      when 'updated_desc' then order_updated_desc
-      when 'created_asc' then order_created_asc
+      when 'created_asc'  then order_created_asc
+      when 'created_date' then order_created_desc
       when 'created_desc' then order_created_desc
-      when 'id_desc' then order_id_desc
-      when 'id_asc' then order_id_asc
+      when 'id_asc'       then order_id_asc
+      when 'id_desc'      then order_id_desc
+      when 'name_asc'     then order_name_asc
+      when 'name_desc'    then order_name_desc
+      when 'updated_asc'  then order_updated_asc
+      when 'updated_desc' then order_updated_desc
       else
         all
       end
diff --git a/app/models/issue.rb b/app/models/issue.rb
index 92a454300af..155c5d972b7 100644
--- a/app/models/issue.rb
+++ b/app/models/issue.rb
@@ -116,7 +116,8 @@ class Issue < ActiveRecord::Base
 
   def self.sort(method, excluded_labels: [])
     case method.to_s
-    when 'due_date_asc' then order_due_date_asc
+    when 'due_date'      then order_due_date_asc
+    when 'due_date_asc'  then order_due_date_asc
     when 'due_date_desc' then order_due_date_desc
     else
       super
diff --git a/app/views/shared/_sort_dropdown.html.haml b/app/views/shared/_sort_dropdown.html.haml
index 785a500e44e..7ff5e679f17 100644
--- a/app/views/shared/_sort_dropdown.html.haml
+++ b/app/views/shared/_sort_dropdown.html.haml
@@ -1,36 +1,16 @@
+- sorted_by = sort_options_hash[@sort]
 - viewing_issues = controller.controller_name == 'issues' || controller.action_name == 'issues'
 
 .dropdown.inline.prepend-left-10
-  %button.dropdown-toggle{ type: 'button', data: {toggle: 'dropdown' } }
-    - if @sort.present?
-      = sort_options_hash[@sort]
-    - else
-      = sort_title_recently_created
+  %button.dropdown-toggle{ type: 'button', data: { toggle: 'dropdown' } }
+    = sorted_by
     = icon('chevron-down')
-  %ul.dropdown-menu.dropdown-menu-align-right.dropdown-menu-sort
+  %ul.dropdown-menu.dropdown-menu-align-right.dropdown-menu-selectable.dropdown-menu-sort
     %li
-      = link_to page_filter_path(sort: sort_value_priority, label: true) do
-        = sort_title_priority
-      = link_to page_filter_path(sort: sort_value_label_priority, label: true) do
-        = sort_title_label_priority
-      = link_to page_filter_path(sort: sort_value_recently_created, label: true) do
-        = sort_title_recently_created
-      = link_to page_filter_path(sort: sort_value_oldest_created, label: true) do
-        = sort_title_oldest_created
-      = link_to page_filter_path(sort: sort_value_recently_updated, label: true) do
-        = sort_title_recently_updated
-      = link_to page_filter_path(sort: sort_value_oldest_updated, label: true) do
-        = sort_title_oldest_updated
-      = link_to page_filter_path(sort: sort_value_milestone_soon, label: true) do
-        = sort_title_milestone_soon
-      = link_to page_filter_path(sort: sort_value_milestone_later, label: true) do
-        = sort_title_milestone_later
-      - if viewing_issues
-        = link_to page_filter_path(sort: sort_value_due_date_soon, label: true) do
-          = sort_title_due_date_soon
-        = link_to page_filter_path(sort: sort_value_due_date_later, label: true) do
-          = sort_title_due_date_later
-      = link_to page_filter_path(sort: sort_value_upvotes, label: true) do
-        = sort_title_upvotes
-      = link_to page_filter_path(sort: sort_value_downvotes, label: true) do
-        = sort_title_downvotes
+      = sortable_item(sort_title_priority,         page_filter_path(sort: sort_value_priority,         label: true), sorted_by)
+      = sortable_item(sort_title_created_date,     page_filter_path(sort: sort_value_created_date,     label: true), sorted_by)
+      = sortable_item(sort_title_recently_updated, page_filter_path(sort: sort_value_recently_updated, label: true), sorted_by)
+      = sortable_item(sort_title_milestone,        page_filter_path(sort: sort_value_milestone,        label: true), sorted_by)
+      = sortable_item(sort_title_due_date,         page_filter_path(sort: sort_value_due_date,         label: true), sorted_by) if viewing_issues
+      = sortable_item(sort_title_popularity,       page_filter_path(sort: sort_value_popularity,       label: true), sorted_by)
+      = sortable_item(sort_title_label_priority,   page_filter_path(sort: sort_value_label_priority,   label: true), sorted_by)