jro_apps/redmine Commit - r5183:87bcb2156302

1

# Helpers to sort tables using clickable column headers.

1

# Helpers to sort tables using clickable column headers.

2

#

2

#

3

# Author: Stuart Rackham <srackham@methods.co.nz>, March 2005.

3

# Author: Stuart Rackham <srackham@methods.co.nz>, March 2005.

4

# Jean-Philippe Lang, 2009

4

# Jean-Philippe Lang, 2009

5

# License: This source code is released under the MIT license.

5

# License: This source code is released under the MIT license.

6

#

6

#

7

# - Consecutive clicks toggle the column's sort order.

7

# - Consecutive clicks toggle the column's sort order.

8

# - Sort state is maintained by a session hash entry.

8

# - Sort state is maintained by a session hash entry.

9

# - CSS classes identify sort column and state.

9

# - CSS classes identify sort column and state.

10

# - Typically used in conjunction with the Pagination module.

10

# - Typically used in conjunction with the Pagination module.

11

#

11

#

12

# Example code snippets:

12

# Example code snippets:

13

#

13

#

14

# Controller:

14

# Controller:

15

#

15

#

16

# helper :sort

16

# helper :sort

17

# include SortHelper

17

# include SortHelper

18

#

18

#

19

# def list

19

# def list

20

# sort_init 'last_name'

20

# sort_init 'last_name'

21

# sort_update %w(first_name last_name)

21

# sort_update %w(first_name last_name)

22

# @items = Contact.find_all nil, sort_clause

22

# @items = Contact.find_all nil, sort_clause

23

# end

23

# end

24

#

24

#

25

# Controller (using Pagination module):

25

# Controller (using Pagination module):

26

#

26

#

27

# helper :sort

27

# helper :sort

28

# include SortHelper

28

# include SortHelper

29

#

29

#

30

# def list

30

# def list

31

# sort_init 'last_name'

31

# sort_init 'last_name'

32

# sort_update %w(first_name last_name)

32

# sort_update %w(first_name last_name)

33

# @contact_pages, @items = paginate :contacts,

33

# @contact_pages, @items = paginate :contacts,

34

# :order_by => sort_clause,

34

# :order_by => sort_clause,

35

# :per_page => 10

35

# :per_page => 10

36

# end

36

# end

37

#

37

#

38

# View (table header in list.rhtml):

38

# View (table header in list.rhtml):

39

#

39

#

40

# <thead>

40

# <thead>

41

# <tr>

41

# <tr>

42

# <%= sort_header_tag('id', :title => 'Sort by contact ID') %>

42

# <%= sort_header_tag('id', :title => 'Sort by contact ID') %>

43

# <%= sort_header_tag('last_name', :caption => 'Name') %>

43

# <%= sort_header_tag('last_name', :caption => 'Name') %>

44

# <%= sort_header_tag('phone') %>

44

# <%= sort_header_tag('phone') %>

45

# <%= sort_header_tag('address', :width => 200) %>

45

# <%= sort_header_tag('address', :width => 200) %>

46

# </tr>

46

# </tr>

47

# </thead>

47

# </thead>

48

#

48

#

49

# - Introduces instance variables: @sort_default, @sort_criteria

49

# - Introduces instance variables: @sort_default, @sort_criteria

50

# - Introduces param :sort

50

# - Introduces param :sort

51

#

51

#

52

53

module SortHelper

53

module SortHelper

54

class SortCriteria

54

class SortCriteria

55

56

def initialize

56

def initialize

57

@criteria = []

57

@criteria = []

58

end

58

end

59

60

def available_criteria=(criteria)

60

def available_criteria=(criteria)

61

unless criteria.is_a?(Hash)

61

unless criteria.is_a?(Hash)

62

criteria = criteria.inject({}) {|h,k| h[k] = k; h}

62

criteria = criteria.inject({}) {|h,k| h[k] = k; h}

63

end

63

end

64

@available_criteria = criteria

64

@available_criteria = criteria

65

end

65

end

66

67

def from_param(param)

67

def from_param(param)

68

@criteria = param.to_s.split(',').collect {|s| s.split(':')[0..1]}

68

@criteria = param.to_s.split(',').collect {|s| s.split(':')[0..1]}

69

normalize!

69

normalize!

70

end

70

end

71

72

def criteria=(arg)

72

def criteria=(arg)

73

@criteria = arg

73

@criteria = arg

74

normalize!

74

normalize!

75

end

75

end

76

77

def to_param

77

def to_param

78

@criteria.collect {|k,o| k + (o ? '' : ':desc')}.join(',')

78

@criteria.collect {|k,o| k + (o ? '' : ':desc')}.join(',')

79

end

79

end

80

81

def to_sql

81

def to_sql

82

sql = @criteria.collect do |k,o|

82

sql = @criteria.collect do |k,o|

83

if s = @available_criteria[k]

83

if s = @available_criteria[k]

84

(o ? s.to_a : s.to_a.collect {|c| append_desc(c)}).join(', ')

84

(o ? s.to_a : s.to_a.collect {|c| append_desc(c)}).join(', ')

85

end

85

end

86

end.compact.join(', ')

86

end.compact.join(', ')

87

sql.blank? ? nil : sql

87

sql.blank? ? nil : sql

88

end

88

end

89

90

def add!(key, asc)

90

def add!(key, asc)

91

@criteria.delete_if {|k,o| k == key}

91

@criteria.delete_if {|k,o| k == key}

92

@criteria = [[key, asc]] + @criteria

92

@criteria = [[key, asc]] + @criteria

93

normalize!

93

normalize!

94

end

94

end

95

96

def add(*args)

96

def add(*args)

97

r = self.class.new.from_param(to_param)

97

r = self.class.new.from_param(to_param)

98

r.add!(*args)

98

r.add!(*args)

99

r

99

r

100

end

100

end

101

102

def first_key

102

def first_key

103

@criteria.first && @criteria.first.first

103

@criteria.first && @criteria.first.first

104

end

104

end

105

106

def first_asc?

106

def first_asc?

107

@criteria.first && @criteria.first.last

107

@criteria.first && @criteria.first.last

108

end

108

end

109

110

def empty?

110

def empty?

111

@criteria.empty?

111

@criteria.empty?

112

end

112

end

113

114

private

114

private

115

116

def normalize!

116

def normalize!

117

@criteria ||= []

117

@criteria ||= []

118

@criteria = @criteria.collect {|s| s = s.to_a; [s.first, (s.last == false || s.last == 'desc') ? false : true]}

118

@criteria = @criteria.collect {|s| s = s.to_a; [s.first, (s.last == false || s.last == 'desc') ? false : true]}

119

@criteria = @criteria.select {|k,o| @available_criteria.has_key?(k)} if @available_criteria

119

@criteria = @criteria.select {|k,o| @available_criteria.has_key?(k)} if @available_criteria

120

@criteria.slice!(3)

120

@criteria.slice!(3)

121

self

121

self

122

end

122

end

123

124

# Appends DESC to the sort criterion unless it has a fixed order

124

# Appends DESC to the sort criterion unless it has a fixed order

125

def append_desc(criterion)

125

def append_desc(criterion)

126

if criterion =~ / (asc|desc)$/i

126

if criterion =~ / (asc|desc)$/i

127

criterion

127

criterion

128

else

128

else

129

"#{criterion} DESC"

129

"#{criterion} DESC"

130

end

130

end

131

end

131

end

132

end

132

end

133

134

def sort_name

134

def sort_name

135

controller_name + '_' + action_name + '_sort'

135

controller_name + '_' + action_name + '_sort'

136

end

136

end

137

138

# Initializes the default sort.

138

# Initializes the default sort.

139

# Examples:

139

# Examples:

140

#

140

#

141

# sort_init 'name'

141

# sort_init 'name'

142

# sort_init 'id', 'desc'

142

# sort_init 'id', 'desc'

143

# sort_init ['name', ['id', 'desc']]

143

# sort_init ['name', ['id', 'desc']]

144

# sort_init [['name', 'desc'], ['id', 'desc']]

144

# sort_init [['name', 'desc'], ['id', 'desc']]

145

#

145

#

146

def sort_init(*args)

146

def sort_init(*args)

147

case args.size

147

case args.size

148

when 1

148

when 1

149

@sort_default = args.first.is_a?(Array) ? args.first : [[args.first]]

149

@sort_default = args.first.is_a?(Array) ? args.first : [[args.first]]

150

when 2

150

when 2

151

@sort_default = [[args.first, args.last]]

151

@sort_default = [[args.first, args.last]]

152

else

152

else

153

raise ArgumentError

153

raise ArgumentError

154

end

154

end

155

end

155

end

156

157

# Updates the sort state. Call this in the controller prior to calling

157

# Updates the sort state. Call this in the controller prior to calling

158

# sort_clause.

158

# sort_clause.

159

# - criteria can be either an array or a hash of allowed keys

159

# - criteria can be either an array or a hash of allowed keys

160

#

160

#

161

def sort_update(criteria)

161

def sort_update(criteria)

162

@sort_criteria = SortCriteria.new

162

@sort_criteria = SortCriteria.new

163

@sort_criteria.available_criteria = criteria

163

@sort_criteria.available_criteria = criteria

164

@sort_criteria.from_param(params[:sort] || session[sort_name])

164

@sort_criteria.from_param(params[:sort] || session[sort_name])

165

@sort_criteria.criteria = @sort_default if @sort_criteria.empty?

165

@sort_criteria.criteria = @sort_default if @sort_criteria.empty?

166

session[sort_name] = @sort_criteria.to_param

166

session[sort_name] = @sort_criteria.to_param

167

end

167

end

168

169

# Clears the sort criteria session data

169

# Clears the sort criteria session data

170

#

170

#

171

def sort_clear

171

def sort_clear

172

session[sort_name] = nil

172

session[sort_name] = nil

173

end

173

end

174

175

# Returns an SQL sort clause corresponding to the current sort state.

175

# Returns an SQL sort clause corresponding to the current sort state.

176

# Use this to sort the controller's table items collection.

176

# Use this to sort the controller's table items collection.

177

#

177

#

178

def sort_clause()

178

def sort_clause()

179

@sort_criteria.to_sql

179

@sort_criteria.to_sql

180

end

180

end

181

182

# Returns a link which sorts by the named column.

182

# Returns a link which sorts by the named column.

183

#

183

#

184

# - column is the name of an attribute in the sorted record collection.

184

# - column is the name of an attribute in the sorted record collection.

185

# - the optional caption explicitly specifies the displayed link text.

185

# - the optional caption explicitly specifies the displayed link text.

186

# - 2 CSS classes reflect the state of the link: sort and asc or desc

186

# - 2 CSS classes reflect the state of the link: sort and asc or desc

187

#

187

#

188

def sort_link(column, caption, default_order)

188

def sort_link(column, caption, default_order)

189

css, order = nil, default_order

189

css, order = nil, default_order

190

191

if column.to_s == @sort_criteria.first_key

191

if column.to_s == @sort_criteria.first_key

192

if @sort_criteria.first_asc?

192

if @sort_criteria.first_asc?

193

css = 'sort asc'

193

css = 'sort asc'

194

order = 'desc'

194

order = 'desc'

195

else

195

else

196

css = 'sort desc'

196

css = 'sort desc'

197

order = 'asc'

197

order = 'asc'

198

end

198

end

199

end

199

end

200

caption = column.to_s.humanize unless caption

200

caption = column.to_s.humanize unless caption

201

202

sort_options = { :sort => @sort_criteria.add(column.to_s, order).to_param }

202

sort_options = { :sort => @sort_criteria.add(column.to_s, order).to_param }

203

# don't reuse params if filters are present

203

url_options = params.merge(sort_options)

204

url_options = params.has_key?(:set_filter) ? sort_options : params.merge(sort_options)

205

204

206

# Add project_id to url_options

205

# Add project_id to url_options

207

url_options = url_options.merge(:project_id => params[:project_id]) if params.has_key?(:project_id)

206

url_options = url_options.merge(:project_id => params[:project_id]) if params.has_key?(:project_id)

208

207

209

link_to_content_update(caption, url_options, :class => css)

208

link_to_content_update(caption, url_options, :class => css)

210

end

209

end

211

210

212

# Returns a table header <th> tag with a sort link for the named column

211

# Returns a table header <th> tag with a sort link for the named column

213

# attribute.

212

# attribute.

214

#

213

#

215

# Options:

214

# Options:

216

# :caption The displayed link name (defaults to titleized column name).

215

# :caption The displayed link name (defaults to titleized column name).

217

# :title The tag's 'title' attribute (defaults to 'Sort by :caption').

216

# :title The tag's 'title' attribute (defaults to 'Sort by :caption').

218

#

217

#

219

# Other options hash entries generate additional table header tag attributes.

218

# Other options hash entries generate additional table header tag attributes.

220

#

219

#

221

# Example:

220

# Example:

222

#

221

#

223

# <%= sort_header_tag('id', :title => 'Sort by contact ID', :width => 40) %>

222

# <%= sort_header_tag('id', :title => 'Sort by contact ID', :width => 40) %>

224

#

223

#

225

def sort_header_tag(column, options = {})

224

def sort_header_tag(column, options = {})

226

caption = options.delete(:caption) || column.to_s.humanize

225

caption = options.delete(:caption) || column.to_s.humanize

227

default_order = options.delete(:default_order) || 'asc'

226

default_order = options.delete(:default_order) || 'asc'

228

options[:title] = l(:label_sort_by, "\"#{caption}\"") unless options[:title]

227

options[:title] = l(:label_sort_by, "\"#{caption}\"") unless options[:title]

229

content_tag('th', sort_link(column, caption, default_order), options)

228

content_tag('th', sort_link(column, caption, default_order), options)

230

end

229

end

231

end

230

end

232

231

	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

             # 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
                 def to_sql
                   sql = @criteria.collect do |k,o|
                     if s = @available_criteria[k]
                       (o ? s.to_a : s.to_a.collect {|c| append_desc(c)}).join(', ')
                     end
                   end.compact.join(', ')
                   sql.blank? ? nil : sql
                 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 = s.to_a; [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)
                   if criterion =~ / (asc|desc)$/i
                     criterion
                   else
                     "#{criterion} DESC"
                   end
                 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_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
               # 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 }
-                # don't reuse params if filters are present
+                url_options = params.merge(sort_options)
-                url_options = params.has_key?(:set_filter) ? sort_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(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
             end