Module: SortingHelper

Includes:
ButtonHelper, SortingTitlesValuesHelper
Included in:
Admin::UsersController, Dashboard::ProjectsController, Explore::ProjectsController, Groups::ApplicationController, Groups::GroupMembersController, IssuableCollections, Projects::BranchesController, Projects::ProjectMembersController, Projects::StarrersController, Projects::TagsController, SortingPreference, WorkItemsCollections
Defined in:
app/helpers/sorting_helper.rb

Constant Summary

Constants included from SortingTitlesValuesHelper

SortingTitlesValuesHelper::SORT_NAME, SortingTitlesValuesHelper::SORT_UPDATED_OLDEST, SortingTitlesValuesHelper::SORT_UPDATED_RECENT

Instance Method Summary collapse

Methods included from ButtonHelper

#clipboard_button, #dropdown_item_with_description, #http_clone_button, #http_dropdown_description, #link_button_to, #ssh_clone_button

Methods included from SortingTitlesValuesHelper

#sort_title_closed_date, #sort_title_closed_earlier, #sort_title_closed_recently, #sort_title_contacted_date, #sort_title_created_date, #sort_title_downvotes, #sort_title_due_date, #sort_title_due_date_later, #sort_title_due_date_soon, #sort_title_expire_date, #sort_title_label_priority, #sort_title_largest_group, #sort_title_largest_repo, #sort_title_latest_activity, #sort_title_merged_date, #sort_title_merged_earlier, #sort_title_merged_recently, #sort_title_milestone, #sort_title_milestone_later, #sort_title_milestone_soon, #sort_title_most_stars, #sort_title_name, #sort_title_name_asc, #sort_title_name_desc, #sort_title_oldest_activity, #sort_title_oldest_created, #sort_title_oldest_last_activity, #sort_title_oldest_signin, #sort_title_oldest_starred, #sort_title_oldest_updated, #sort_title_popularity, #sort_title_priority, #sort_title_recently_created, #sort_title_recently_last_activity, #sort_title_recently_signin, #sort_title_recently_starred, #sort_title_recently_updated, #sort_title_relative_position, #sort_title_relevance, #sort_title_size, #sort_title_stars, #sort_title_start_date_later, #sort_title_start_date_soon, #sort_title_title, #sort_title_upvotes, #sort_title_version_asc, #sort_title_version_desc, #sort_value_closed_date, #sort_value_closed_earlier, #sort_value_closed_recently, #sort_value_contacted_date, #sort_value_created_date, #sort_value_downvotes, #sort_value_due_date, #sort_value_due_date_later, #sort_value_due_date_soon, #sort_value_expire_date, #sort_value_label_priority, #sort_value_largest_group, #sort_value_largest_repo, #sort_value_latest_activity, #sort_value_least_popular, #sort_value_merged_date, #sort_value_merged_earlier, #sort_value_merged_recently, #sort_value_milestone, #sort_value_milestone_later, #sort_value_milestone_soon, #sort_value_most_popular, #sort_value_name, #sort_value_name_desc, #sort_value_oldest_activity, #sort_value_oldest_created, #sort_value_oldest_last_activity, #sort_value_oldest_signin, #sort_value_oldest_updated, #sort_value_popularity, #sort_value_priority, #sort_value_recently_created, #sort_value_recently_last_activity, #sort_value_recently_signin, #sort_value_recently_updated, #sort_value_relative_position, #sort_value_relevance, #sort_value_size, #sort_value_stars_desc, #sort_value_start_date_later, #sort_value_start_date_soon, #sort_value_title, #sort_value_title_desc, #sort_value_upvotes, #sort_value_version_asc, #sort_value_version_desc

Instance Method Details

#admin_users_sort_options(path_params) ⇒ Object 



281
282
283
284
285
286
287
288
289
 
# File 'app/helpers/sorting_helper.rb', line 281

def admin_users_sort_options(path_params)
  users_sort_options_hash.map do |value, text|
    {
      value: value,
      text: text,
      href: admin_users_path(path_params.slice(:filter, :search_query, :admin_role_id).merge(sort: value))
    }
  end
end

#branches_sort_options_hash ⇒ Object 



83
84
85
86
87
88
89
 
# File 'app/helpers/sorting_helper.rb', line 83

def branches_sort_options_hash
  {
    sort_value_name => sort_title_name,
    sort_value_oldest_updated => sort_title_oldest_updated,
    sort_value_recently_updated => sort_title_recently_updated
  }
end

#can_sort_by_issue_weight?(_viewing_issues) ⇒ Boolean

Returns:

  • (Boolean) 


198
199
200
 
# File 'app/helpers/sorting_helper.rb', line 198

def can_sort_by_issue_weight?(_viewing_issues)
  false
end

#can_sort_by_merged_date?(viewing_merge_requests) ⇒ Boolean

Returns:

  • (Boolean) 


202
203
204
 
# File 'app/helpers/sorting_helper.rb', line 202

def can_sort_by_merged_date?(viewing_merge_requests)
  viewing_merge_requests && %w[all merged].include?(params[:state])
end

#due_date_option ⇒ Object 



206
207
208
 
# File 'app/helpers/sorting_helper.rb', line 206

def due_date_option
  { value: sort_value_due_date, text: sort_title_due_date, href: page_filter_path(sort: sort_value_due_date) }
end

#forks_reverse_sort_options_hash ⇒ Object 



63
64
65
66
67
68
69
70
 
# File 'app/helpers/sorting_helper.rb', line 63

def forks_reverse_sort_options_hash
  {
    sort_value_recently_created => sort_value_oldest_created,
    sort_value_oldest_created => sort_value_recently_created,
    sort_value_latest_activity => sort_value_oldest_activity,
    sort_value_oldest_activity => sort_value_latest_activity
  }
end

#forks_sort_direction_button(sort_value, without = [:state, :scope, :label_name, :milestone_id, :assignee_id, :author_id]) ⇒ Object 



271
272
273
274
275
276
277
278
279
 
# File 'app/helpers/sorting_helper.rb', line 271

def forks_sort_direction_button(
  sort_value,
  without = [:state, :scope, :label_name, :milestone_id, :assignee_id, :author_id]
)
  reverse_sort = forks_reverse_sort_options_hash[sort_value]
  url = page_filter_path(sort: reverse_sort, without: without)

  sort_direction_button(url, reverse_sort, sort_value)
end

#issuable_reverse_sort_order_hash ⇒ Object 



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'app/helpers/sorting_helper.rb', line 150

def issuable_reverse_sort_order_hash
  {
    sort_value_created_date => sort_value_oldest_created,
    sort_value_recently_created => sort_value_oldest_created,
    sort_value_recently_updated => sort_value_oldest_updated,
    sort_value_milestone => sort_value_milestone_later,
    sort_value_due_date => sort_value_due_date_later,
    sort_value_due_date_soon => sort_value_due_date_later,
    sort_value_merged_date => sort_value_merged_recently,
    sort_value_merged_earlier => sort_value_merged_recently,
    sort_value_closed_date => sort_value_closed_recently,
    sort_value_closed_earlier => sort_value_closed_recently,
    sort_value_popularity => sort_value_least_popular,
    sort_value_most_popular => sort_value_least_popular,
    sort_value_title => sort_value_title_desc
  }.merge(issuable_sort_option_overrides)
end

#issuable_sort_direction_button(sort_value) ⇒ Object 



264
265
266
267
268
269
 
# File 'app/helpers/sorting_helper.rb', line 264

def issuable_sort_direction_button(sort_value)
  reverse_sort = issuable_reverse_sort_order_hash[sort_value]
  url = page_filter_path(sort: reverse_sort)

  sort_direction_button(url, reverse_sort, sort_value)
end

#issuable_sort_option_overrides ⇒ Object 



137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'app/helpers/sorting_helper.rb', line 137

def issuable_sort_option_overrides
  {
    sort_value_oldest_created => sort_value_created_date,
    sort_value_oldest_updated => sort_value_recently_updated,
    sort_value_milestone_later => sort_value_milestone,
    sort_value_due_date_later => sort_value_due_date,
    sort_value_merged_recently => sort_value_merged_date,
    sort_value_closed_recently => sort_value_closed_date,
    sort_value_least_popular => sort_value_popularity,
    sort_value_title_desc => sort_value_title
  }
end

#issuable_sort_options(viewing_issues, viewing_merge_requests) ⇒ Object 



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'app/helpers/sorting_helper.rb', line 168

def issuable_sort_options(viewing_issues, viewing_merge_requests)
  options = [
    { value: sort_value_priority, text: sort_title_priority, href: page_filter_path(sort: sort_value_priority) },
    {
      value: sort_value_created_date,
      text: sort_title_created_date,
      href: page_filter_path(sort: sort_value_created_date)
    },
    {
      value: sort_value_closed_date,
      text: sort_title_closed_date,
      href: page_filter_path(sort: sort_value_closed_date)
    },
    {
      value: sort_value_recently_updated,
      text: sort_title_recently_updated,
      href: page_filter_path(sort: sort_value_recently_updated)
    },
    { value: sort_value_milestone, text: sort_title_milestone, href: page_filter_path(sort: sort_value_milestone) }
  ]

  options.concat([due_date_option]) if viewing_issues

  options.concat([popularity_option, label_priority_option])
  options.concat([merged_option]) if can_sort_by_merged_date?(viewing_merge_requests)
  options.concat([relative_position_option]) if viewing_issues

  options.concat([title_option])
end

#label_priority_option ⇒ Object 



214
215
216
217
218
219
220
 
# File 'app/helpers/sorting_helper.rb', line 214

def label_priority_option
  {
    value: sort_value_label_priority,
    text: sort_title_label_priority,
    href: page_filter_path(sort: sort_value_label_priority)
  }
end

#label_sort_options_hash ⇒ Object 



101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'app/helpers/sorting_helper.rb', line 101

def label_sort_options_hash
  options = {}
  options[sort_value_relevance] = sort_title_relevance if params[:search].present?
  options.merge({
    sort_value_name => sort_title_name,
    sort_value_name_desc => sort_title_name_desc,
    sort_value_recently_created => sort_title_recently_created,
    sort_value_oldest_created => sort_title_oldest_created,
    sort_value_recently_updated => sort_title_recently_updated,
    sort_value_oldest_updated => sort_title_oldest_updated
  })
end

#merged_option ⇒ Object 



222
223
224
225
226
227
228
 
# File 'app/helpers/sorting_helper.rb', line 222

def merged_option
  {
    value: sort_value_merged_date,
    text: sort_title_merged_date,
    href: page_filter_path(sort: sort_value_merged_date)
  }
end

#milestones_sort_options_hash ⇒ Object 



72
73
74
75
76
77
78
79
80
81
 
# File 'app/helpers/sorting_helper.rb', line 72

def milestones_sort_options_hash
  {
    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
  }
end

#popularity_option ⇒ Object 



210
211
212
 
# File 'app/helpers/sorting_helper.rb', line 210

def popularity_option
  { value: sort_value_popularity, text: sort_title_popularity, href: page_filter_path(sort: sort_value_popularity) }
end

#projects_sort_options_hash ⇒ Object

rubocop: enable Metrics/AbcSize



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'app/helpers/sorting_helper.rb', line 47

def projects_sort_options_hash
  options = {
    sort_value_latest_activity => sort_title_latest_activity,
    sort_value_name => sort_title_name,
    sort_value_name_desc => sort_title_name_desc,
    sort_value_oldest_activity => sort_title_oldest_activity,
    sort_value_oldest_created => sort_title_oldest_created,
    sort_value_recently_created => sort_title_recently_created,
    sort_value_stars_desc => sort_title_most_stars
  }

  options[sort_value_largest_repo] = sort_title_largest_repo if current_controller?('admin/projects')

  options
end

#relative_position_option ⇒ Object 



230
231
232
233
234
235
236
 
# File 'app/helpers/sorting_helper.rb', line 230

def relative_position_option
  {
    value: sort_value_relative_position,
    text: sort_title_relative_position,
    href: page_filter_path(sort: sort_value_relative_position)
  }
end

#sort_direction_button(reverse_url, reverse_sort, sort_value) ⇒ Object 



251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'app/helpers/sorting_helper.rb', line 251

def sort_direction_button(reverse_url, reverse_sort, sort_value)
  link_class = 'has-tooltip reverse-sort-btn rspec-reverse-sort'
  icon = sort_direction_icon(sort_value)
  url = reverse_url

  unless reverse_sort
    url = '#'
    link_class += ' disabled'
  end

  link_button_to nil, url, class: link_class, title: s_('SortOptions|Sort direction'), icon: icon
end

#sort_direction_icon(sort_value) ⇒ Object 



242
243
244
245
246
247
248
249
 
# File 'app/helpers/sorting_helper.rb', line 242

def sort_direction_icon(sort_value)
  case sort_value
  when sort_value_milestone, sort_value_due_date, sort_value_merged_date, sort_value_closed_date, /_asc\z/
    'sort-lowest'
  else
    'sort-highest'
  end
end

#sort_options_hash ⇒ Object

rubocop: disable Metrics/AbcSize



8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'app/helpers/sorting_helper.rb', line 8

def sort_options_hash
  {
    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_updated => sort_title_oldest_updated,
    sort_value_recently_created => sort_title_recently_created,
     => ,
    sort_value_recently_updated => sort_title_recently_updated,
    sort_value_popularity => sort_title_popularity,
    sort_value_priority => sort_title_priority,
    sort_value_merged_date => sort_title_merged_date,
    sort_value_merged_recently => sort_title_merged_recently,
    sort_value_merged_earlier => sort_title_merged_earlier,
    sort_value_closed_date => sort_title_closed_date,
    sort_value_closed_recently => sort_title_closed_recently,
    sort_value_closed_earlier => sort_title_closed_earlier,
    sort_value_upvotes => sort_title_upvotes,
    sort_value_contacted_date => sort_title_contacted_date,
    sort_value_relative_position => sort_title_relative_position,
    sort_value_size => sort_title_size,
    sort_value_expire_date => sort_title_expire_date,
    sort_value_title => sort_title_title
  }
end

#starrers_sort_options_hash ⇒ Object 



128
129
130
131
132
133
134
135
 
# File 'app/helpers/sorting_helper.rb', line 128

def starrers_sort_options_hash
  {
    sort_value_name => sort_title_name,
    sort_value_name_desc => sort_title_name_desc,
    sort_value_recently_created => sort_title_recently_starred,
    sort_value_oldest_created => sort_title_oldest_starred
  }
end

#tags_sort_options_hash ⇒ Object 



91
92
93
94
95
96
97
98
99
 
# File 'app/helpers/sorting_helper.rb', line 91

def tags_sort_options_hash
  {
    sort_value_name => sort_title_name,
    sort_value_oldest_updated => sort_title_oldest_updated,
    sort_value_recently_updated => sort_title_recently_updated,
    sort_value_version_desc => sort_title_version_desc,
    sort_value_version_asc => sort_title_version_asc
  }
end

#title_option ⇒ Object 



238
239
240
 
# File 'app/helpers/sorting_helper.rb', line 238

def title_option
  { value: sort_value_title, text: sort_title_title, href: page_filter_path(sort: sort_value_title) }
end

#users_sort_options_hash ⇒ Object 



114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'app/helpers/sorting_helper.rb', line 114

def users_sort_options_hash
  {
    sort_value_name => sort_title_name,
     => ,
     => ,
    sort_value_recently_created => sort_title_recently_created,
    sort_value_oldest_created => sort_title_oldest_created,
    sort_value_recently_updated => sort_title_recently_updated,
    sort_value_oldest_updated => sort_title_oldest_updated,
    sort_value_recently_last_activity => sort_title_recently_last_activity,
    sort_value_oldest_last_activity => sort_title_oldest_last_activity
  }
end