annotate .svn/pristine/b7/b78206ca607096e92e37aa8306eed7eb741f79b9.svn-base @ 1478:5ca1f4a47171 bibplugin_db_migrations

Close obsolete branch bibplugin_db_migrations
author Chris Cannam
date Fri, 30 Nov 2012 14:40:50 +0000
parents cbb26bc654de
children
rev   line source
Chris@909 1 # encoding: utf-8
Chris@909 2 #
Chris@909 3 # Helpers to sort tables using clickable column headers.
Chris@909 4 #
Chris@909 5 # Author: Stuart Rackham <srackham@methods.co.nz>, March 2005.
Chris@909 6 # Jean-Philippe Lang, 2009
Chris@909 7 # License: This source code is released under the MIT license.
Chris@909 8 #
Chris@909 9 # - Consecutive clicks toggle the column's sort order.
Chris@909 10 # - Sort state is maintained by a session hash entry.
Chris@909 11 # - CSS classes identify sort column and state.
Chris@909 12 # - Typically used in conjunction with the Pagination module.
Chris@909 13 #
Chris@909 14 # Example code snippets:
Chris@909 15 #
Chris@909 16 # Controller:
Chris@909 17 #
Chris@909 18 # helper :sort
Chris@909 19 # include SortHelper
Chris@909 20 #
Chris@909 21 # def list
Chris@909 22 # sort_init 'last_name'
Chris@909 23 # sort_update %w(first_name last_name)
Chris@909 24 # @items = Contact.find_all nil, sort_clause
Chris@909 25 # end
Chris@909 26 #
Chris@909 27 # Controller (using Pagination module):
Chris@909 28 #
Chris@909 29 # helper :sort
Chris@909 30 # include SortHelper
Chris@909 31 #
Chris@909 32 # def list
Chris@909 33 # sort_init 'last_name'
Chris@909 34 # sort_update %w(first_name last_name)
Chris@909 35 # @contact_pages, @items = paginate :contacts,
Chris@909 36 # :order_by => sort_clause,
Chris@909 37 # :per_page => 10
Chris@909 38 # end
Chris@909 39 #
Chris@909 40 # View (table header in list.rhtml):
Chris@909 41 #
Chris@909 42 # <thead>
Chris@909 43 # <tr>
Chris@909 44 # <%= sort_header_tag('id', :title => 'Sort by contact ID') %>
Chris@909 45 # <%= sort_header_tag('last_name', :caption => 'Name') %>
Chris@909 46 # <%= sort_header_tag('phone') %>
Chris@909 47 # <%= sort_header_tag('address', :width => 200) %>
Chris@909 48 # </tr>
Chris@909 49 # </thead>
Chris@909 50 #
Chris@909 51 # - Introduces instance variables: @sort_default, @sort_criteria
Chris@909 52 # - Introduces param :sort
Chris@909 53 #
Chris@909 54
Chris@909 55 module SortHelper
Chris@909 56 class SortCriteria
Chris@909 57
Chris@909 58 def initialize
Chris@909 59 @criteria = []
Chris@909 60 end
Chris@909 61
Chris@909 62 def available_criteria=(criteria)
Chris@909 63 unless criteria.is_a?(Hash)
Chris@909 64 criteria = criteria.inject({}) {|h,k| h[k] = k; h}
Chris@909 65 end
Chris@909 66 @available_criteria = criteria
Chris@909 67 end
Chris@909 68
Chris@909 69 def from_param(param)
Chris@909 70 @criteria = param.to_s.split(',').collect {|s| s.split(':')[0..1]}
Chris@909 71 normalize!
Chris@909 72 end
Chris@909 73
Chris@909 74 def criteria=(arg)
Chris@909 75 @criteria = arg
Chris@909 76 normalize!
Chris@909 77 end
Chris@909 78
Chris@909 79 def to_param
Chris@909 80 @criteria.collect {|k,o| k + (o ? '' : ':desc')}.join(',')
Chris@909 81 end
Chris@909 82
Chris@909 83 def to_sql
Chris@909 84 sql = @criteria.collect do |k,o|
Chris@909 85 if s = @available_criteria[k]
Chris@909 86 (o ? s.to_a : s.to_a.collect {|c| append_desc(c)}).join(', ')
Chris@909 87 end
Chris@909 88 end.compact.join(', ')
Chris@909 89 sql.blank? ? nil : sql
Chris@909 90 end
Chris@909 91
Chris@909 92 def add!(key, asc)
Chris@909 93 @criteria.delete_if {|k,o| k == key}
Chris@909 94 @criteria = [[key, asc]] + @criteria
Chris@909 95 normalize!
Chris@909 96 end
Chris@909 97
Chris@909 98 def add(*args)
Chris@909 99 r = self.class.new.from_param(to_param)
Chris@909 100 r.add!(*args)
Chris@909 101 r
Chris@909 102 end
Chris@909 103
Chris@909 104 def first_key
Chris@909 105 @criteria.first && @criteria.first.first
Chris@909 106 end
Chris@909 107
Chris@909 108 def first_asc?
Chris@909 109 @criteria.first && @criteria.first.last
Chris@909 110 end
Chris@909 111
Chris@909 112 def empty?
Chris@909 113 @criteria.empty?
Chris@909 114 end
Chris@909 115
Chris@909 116 private
Chris@909 117
Chris@909 118 def normalize!
Chris@909 119 @criteria ||= []
Chris@909 120 @criteria = @criteria.collect {|s| s = s.to_a; [s.first, (s.last == false || s.last == 'desc') ? false : true]}
Chris@909 121 @criteria = @criteria.select {|k,o| @available_criteria.has_key?(k)} if @available_criteria
Chris@909 122 @criteria.slice!(3)
Chris@909 123 self
Chris@909 124 end
Chris@909 125
Chris@909 126 # Appends DESC to the sort criterion unless it has a fixed order
Chris@909 127 def append_desc(criterion)
Chris@909 128 if criterion =~ / (asc|desc)$/i
Chris@909 129 criterion
Chris@909 130 else
Chris@909 131 "#{criterion} DESC"
Chris@909 132 end
Chris@909 133 end
Chris@909 134 end
Chris@909 135
Chris@909 136 def sort_name
Chris@909 137 controller_name + '_' + action_name + '_sort'
Chris@909 138 end
Chris@909 139
Chris@909 140 # Initializes the default sort.
Chris@909 141 # Examples:
Chris@909 142 #
Chris@909 143 # sort_init 'name'
Chris@909 144 # sort_init 'id', 'desc'
Chris@909 145 # sort_init ['name', ['id', 'desc']]
Chris@909 146 # sort_init [['name', 'desc'], ['id', 'desc']]
Chris@909 147 #
Chris@909 148 def sort_init(*args)
Chris@909 149 case args.size
Chris@909 150 when 1
Chris@909 151 @sort_default = args.first.is_a?(Array) ? args.first : [[args.first]]
Chris@909 152 when 2
Chris@909 153 @sort_default = [[args.first, args.last]]
Chris@909 154 else
Chris@909 155 raise ArgumentError
Chris@909 156 end
Chris@909 157 end
Chris@909 158
Chris@909 159 # Updates the sort state. Call this in the controller prior to calling
Chris@909 160 # sort_clause.
Chris@909 161 # - criteria can be either an array or a hash of allowed keys
Chris@909 162 #
Chris@909 163 def sort_update(criteria)
Chris@909 164 @sort_criteria = SortCriteria.new
Chris@909 165 @sort_criteria.available_criteria = criteria
Chris@909 166 @sort_criteria.from_param(params[:sort] || session[sort_name])
Chris@909 167 @sort_criteria.criteria = @sort_default if @sort_criteria.empty?
Chris@909 168 session[sort_name] = @sort_criteria.to_param
Chris@909 169 end
Chris@909 170
Chris@909 171 # Clears the sort criteria session data
Chris@909 172 #
Chris@909 173 def sort_clear
Chris@909 174 session[sort_name] = nil
Chris@909 175 end
Chris@909 176
Chris@909 177 # Returns an SQL sort clause corresponding to the current sort state.
Chris@909 178 # Use this to sort the controller's table items collection.
Chris@909 179 #
Chris@909 180 def sort_clause()
Chris@909 181 @sort_criteria.to_sql
Chris@909 182 end
Chris@909 183
Chris@909 184 # Returns a link which sorts by the named column.
Chris@909 185 #
Chris@909 186 # - column is the name of an attribute in the sorted record collection.
Chris@909 187 # - the optional caption explicitly specifies the displayed link text.
Chris@909 188 # - 2 CSS classes reflect the state of the link: sort and asc or desc
Chris@909 189 #
Chris@909 190 def sort_link(column, caption, default_order)
Chris@909 191 css, order = nil, default_order
Chris@909 192
Chris@909 193 if column.to_s == @sort_criteria.first_key
Chris@909 194 if @sort_criteria.first_asc?
Chris@909 195 css = 'sort asc'
Chris@909 196 order = 'desc'
Chris@909 197 else
Chris@909 198 css = 'sort desc'
Chris@909 199 order = 'asc'
Chris@909 200 end
Chris@909 201 end
Chris@909 202 caption = column.to_s.humanize unless caption
Chris@909 203
Chris@909 204 sort_options = { :sort => @sort_criteria.add(column.to_s, order).to_param }
Chris@909 205 url_options = params.merge(sort_options)
Chris@909 206
Chris@909 207 # Add project_id to url_options
Chris@909 208 url_options = url_options.merge(:project_id => params[:project_id]) if params.has_key?(:project_id)
Chris@909 209
Chris@909 210 link_to_content_update(h(caption), url_options, :class => css)
Chris@909 211 end
Chris@909 212
Chris@909 213 # Returns a table header <th> tag with a sort link for the named column
Chris@909 214 # attribute.
Chris@909 215 #
Chris@909 216 # Options:
Chris@909 217 # :caption The displayed link name (defaults to titleized column name).
Chris@909 218 # :title The tag's 'title' attribute (defaults to 'Sort by :caption').
Chris@909 219 #
Chris@909 220 # Other options hash entries generate additional table header tag attributes.
Chris@909 221 #
Chris@909 222 # Example:
Chris@909 223 #
Chris@909 224 # <%= sort_header_tag('id', :title => 'Sort by contact ID', :width => 40) %>
Chris@909 225 #
Chris@909 226 def sort_header_tag(column, options = {})
Chris@909 227 caption = options.delete(:caption) || column.to_s.humanize
Chris@909 228 default_order = options.delete(:default_order) || 'asc'
Chris@909 229 options[:title] = l(:label_sort_by, "\"#{caption}\"") unless options[:title]
Chris@909 230 content_tag('th', sort_link(column, caption, default_order), options)
Chris@909 231 end
Chris@909 232 end
Chris@909 233