jro_apps/redmine Commit - r13825:873dff0d364e

Merged r14165 and r14166 (#19544)....

Jean-Philippe Lang -

r13825:873dff0d364e

parent child

Context file:

r13825:873dff0d364e

Collapse all files

The requested changes are too big and content was truncated. Show full diff

app/helpers/sort_helper.rb +9 -4

              # encoding: utf-8
              #
              # Helpers to sort tables using clickable column headers.
              #
              # Author:  Stuart Rackham <srackham@methods.co.nz>, March 2005.
              #          Jean-Philippe Lang, 2009
              # License: This source code is released under the MIT license.
              #
              # - Consecutive clicks toggle the column's sort order.
              # - Sort state is maintained by a session hash entry.
              # - CSS classes identify sort column and state.
              # - Typically used in conjunction with the Pagination module.
              #
              # Example code snippets:
              #
              # Controller:
              #
              #   helper :sort
              #   include SortHelper
              #
              #   def list
              #     sort_init 'last_name'
              #     sort_update %w(first_name last_name)
              #     @items = Contact.find_all nil, sort_clause
              #   end
              #
              # Controller (using Pagination module):
              #
              #   helper :sort
              #   include SortHelper
              #
              #   def list
              #     sort_init 'last_name'
              #     sort_update %w(first_name last_name)
              #     @contact_pages, @items = paginate :contacts,
              #       :order_by => sort_clause,
              #       :per_page => 10
              #   end
              #
              # View (table header in list.rhtml):
              #
              #   <thead>
              #     <tr>
              #       <%= sort_header_tag('id', :title => 'Sort by contact ID') %>
              #       <%= sort_header_tag('last_name', :caption => 'Name') %>
              #       <%= sort_header_tag('phone') %>
              #       <%= sort_header_tag('address', :width => 200) %>
              #     </tr>
              #   </thead>
              #
              # - Introduces instance variables: @sort_default, @sort_criteria
              # - Introduces param :sort
              #
              module SortHelper
                class SortCriteria
                  def initialize
                    @criteria = []
                  end
                  def available_criteria=(criteria)
                    unless criteria.is_a?(Hash)
                      criteria = criteria.inject({}) {|h,k| h[k] = k; h}
                    end
                    @available_criteria = criteria
                  end
                  def from_param(param)
                    @criteria = param.to_s.split(',').collect {|s| s.split(':')[0..1]}
                    normalize!
                  end
                  def criteria=(arg)
                    @criteria = arg
                    normalize!
                  end
                  def to_param
                    @criteria.collect {|k,o| k + (o ? '' : ':desc')}.join(',')
                  end
                  # Returns an array of SQL fragments used to sort the list
                  def to_sql
                    sql = @criteria.collect do |k,o|
                      if s = @available_criteria[k]
                        s = [s] unless s.is_a?(Array)
-                       (o ? s : s.collect {|c| append_desc(c)})
+                       s.collect {|c| append_order(c, o ? "ASC" : "DESC")}
                      end
                    end.flatten.compact
                    sql.blank? ? nil : sql
                  end
                  def to_a
                    @criteria.dup
                  end
                  def add!(key, asc)
                    @criteria.delete_if {|k,o| k == key}
                    @criteria = [[key, asc]] + @criteria
                    normalize!
                  end
                  def add(*args)
                    r = self.class.new.from_param(to_param)
                    r.add!(*args)
                    r
                  end
                  def first_key
                    @criteria.first && @criteria.first.first
                  end
                  def first_asc?
                    @criteria.first && @criteria.first.last
                  end
                  def empty?
                    @criteria.empty?
                  end
                  private
                  def normalize!
                    @criteria ||= []
                    @criteria = @criteria.collect {|s| s = Array(s); [s.first, (s.last == false || s.last == 'desc') ? false : true]}
                    @criteria = @criteria.select {|k,o| @available_criteria.has_key?(k)} if @available_criteria
                    @criteria.slice!(3)
                    self
                  end
-                 # Appends DESC to the sort criterion unless it has a fixed order
-                 def append_desc(criterion)
+                 # Appends ASC/DESC to the sort criterion unless it has a fixed order
+                 def append_order(criterion, order)
                    if criterion =~ / (asc|desc)$/i
                      criterion
                    else
-                     "#{criterion} DESC"
+                     "#{criterion} #{order}"
                    end
                  end
+                 # Appends DESC to the sort criterion unless it has a fixed order
+                 def append_desc(criterion)
+                   append_order(criterion, "DESC")
+                 end
                end
                def sort_name
                  controller_name + '_' + action_name + '_sort'
                end
                # Initializes the default sort.
                # Examples:
                #
                #   sort_init 'name'
                #   sort_init 'id', 'desc'
                #   sort_init ['name', ['id', 'desc']]
                #   sort_init [['name', 'desc'], ['id', 'desc']]
                #
                def sort_init(*args)
                  case args.size
                  when 1
                    @sort_default = args.first.is_a?(Array) ? args.first : [[args.first]]
                  when 2
                    @sort_default = [[args.first, args.last]]
                  else
                    raise ArgumentError
                  end
                end
                # Updates the sort state. Call this in the controller prior to calling
                # sort_clause.
                # - criteria can be either an array or a hash of allowed keys
                #
                def sort_update(criteria, sort_name=nil)
                  sort_name ||= self.sort_name
                  @sort_criteria = SortCriteria.new
                  @sort_criteria.available_criteria = criteria
                  @sort_criteria.from_param(params[:sort] || session[sort_name])
                  @sort_criteria.criteria = @sort_default if @sort_criteria.empty?
                  session[sort_name] = @sort_criteria.to_param
                end
                # Clears the sort criteria session data
                #
                def sort_clear
                  session[sort_name] = nil
                end
                # Returns an SQL sort clause corresponding to the current sort state.
                # Use this to sort the controller's table items collection.
                #
                def sort_clause()
                  @sort_criteria.to_sql
                end
                def sort_criteria
                  @sort_criteria
                end
                # Returns a link which sorts by the named column.
                #
                # - column is the name of an attribute in the sorted record collection.
                # - the optional caption explicitly specifies the displayed link text.
                # - 2 CSS classes reflect the state of the link: sort and asc or desc
                #
                def sort_link(column, caption, default_order)
                  css, order = nil, default_order
                  if column.to_s == @sort_criteria.first_key
                    if @sort_criteria.first_asc?
                      css = 'sort asc'
                      order = 'desc'
                    else
                      css = 'sort desc'
                      order = 'asc'
                    end
                  end
                  caption = column.to_s.humanize unless caption
                  sort_options = { :sort => @sort_criteria.add(column.to_s, order).to_param }
                  url_options = params.merge(sort_options)
                   # Add project_id to url_options
                  url_options = url_options.merge(:project_id => params[:project_id]) if params.has_key?(:project_id)
                  link_to_content_update(h(caption), url_options, :class => css)
                end
                # Returns a table header <th> tag with a sort link for the named column
                # attribute.
                #
                # Options:
                #   :caption     The displayed link name (defaults to titleized column name).
                #   :title       The tag's 'title' attribute (defaults to 'Sort by :caption').
                #
                # Other options hash entries generate additional table header tag attributes.
                #
                # Example:
                #
                #   <%= sort_header_tag('id', :title => 'Sort by contact ID', :width => 40) %>
                #
                def sort_header_tag(column, options = {})
                  caption = options.delete(:caption) || column.to_s.humanize
                  default_order = options.delete(:default_order) || 'asc'
                  options[:title] = l(:label_sort_by, "\"#{caption}\"") unless options[:title]
                  content_tag('th', sort_link(column, caption, default_order), options)
                end
                # Returns the css classes for the current sort order
                #
                # Example:
                #
                #   sort_css_classes
                #   # => "sort-by-created-on sort-desc"
                def sort_css_classes
                  if @sort_criteria.first_key
                    "sort-by-#{@sort_criteria.first_key.to_s.dasherize} sort-#{@sort_criteria.first_asc? ? 'asc' : 'desc'}"
                  end
                end
              end

test/functional/issues_controller_test.rb 0 0

	1		NO CONTENT: modified file
The requested commit or file is too big and content was truncated. Show full diff

test/unit/helpers/sort_helper_test.rb +2 -2

              # Redmine - project management software
              # Copyright (C) 2006-2015  Jean-Philippe Lang
              #
              # This program is free software; you can redistribute it and/or
              # modify it under the terms of the GNU General Public License
              # as published by the Free Software Foundation; either version 2
              # of the License, or (at your option) any later version.
              #
              # This program is distributed in the hope that it will be useful,
              # but WITHOUT ANY WARRANTY; without even the implied warranty of
              # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
              # GNU General Public License for more details.
              #
              # You should have received a copy of the GNU General Public License
              # along with this program; if not, write to the Free Software
              # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
              require File.expand_path('../../../test_helper', __FILE__)
              class SortHelperTest < ActionView::TestCase
                include SortHelper
                include Redmine::I18n
                include ERB::Util
                def setup
                  @session = nil
                  @sort_param = nil
                end
                def test_default_sort_clause_with_array
                  sort_init 'attr1', 'desc'
                  sort_update(['attr1', 'attr2'])
                  assert_equal ['attr1 DESC'], sort_clause
                end
                def test_default_sort_clause_with_hash
                  sort_init 'attr1', 'desc'
                  sort_update({'attr1' => 'table1.attr1', 'attr2' => 'table2.attr2'})
                  assert_equal ['table1.attr1 DESC'], sort_clause
                end
                def test_default_sort_clause_with_multiple_columns
                  sort_init 'attr1', 'desc'
                  sort_update({'attr1' => ['table1.attr1', 'table1.attr2'], 'attr2' => 'table2.attr2'})
                  assert_equal ['table1.attr1 DESC', 'table1.attr2 DESC'], sort_clause
                end
                def test_params_sort
                  @sort_param = 'attr1,attr2:desc'
                  sort_init 'attr1', 'desc'
                  sort_update({'attr1' => 'table1.attr1', 'attr2' => 'table2.attr2'})
-                 assert_equal ['table1.attr1', 'table2.attr2 DESC'], sort_clause
+                 assert_equal ['table1.attr1 ASC', 'table2.attr2 DESC'], sort_clause
                  assert_equal 'attr1,attr2:desc', @session['foo_bar_sort']
                end
                def test_invalid_params_sort
                  @sort_param = 'invalid_key'
                  sort_init 'attr1', 'desc'
                  sort_update({'attr1' => 'table1.attr1', 'attr2' => 'table2.attr2'})
                  assert_equal ['table1.attr1 DESC'], sort_clause
                  assert_equal 'attr1:desc', @session['foo_bar_sort']
                end
                def test_invalid_order_params_sort
                  @sort_param = 'attr1:foo:bar,attr2'
                  sort_init 'attr1', 'desc'
                  sort_update({'attr1' => 'table1.attr1', 'attr2' => 'table2.attr2'})
-                 assert_equal ['table1.attr1', 'table2.attr2'], sort_clause
+                 assert_equal ['table1.attr1 ASC', 'table2.attr2 ASC'], sort_clause
                  assert_equal 'attr1,attr2', @session['foo_bar_sort']
                end
                def test_sort_css_without_params_should_use_default_sort
                  sort_init 'attr1', 'desc'
                  sort_update(['attr1', 'attr2'])
                  assert_equal 'sort-by-attr1 sort-desc', sort_css_classes
                end
                def test_sort_css_should_use_params
                  @sort_param = 'attr2,attr1'
                  sort_init 'attr1', 'desc'
                  sort_update(['attr1', 'attr2'])
                  assert_equal 'sort-by-attr2 sort-asc', sort_css_classes
                end
                def test_sort_css_should_dasherize_sort_name
                  sort_init 'foo_bar'
                  sort_update(['foo_bar'])
                  assert_equal 'sort-by-foo-bar sort-asc', sort_css_classes
                end
                private
                def controller_name; 'foo'; end
                def action_name; 'bar'; end
                def params; {:sort => @sort_param}; end
                def session; @session ||= {}; end
              end

General Comments 0

Write
Preview

You need to be logged in to leave comments. Login now

No TODOs yet

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages