jro_apps/redmine Commit - r2322:2fc789704439

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

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

4

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

5

#

5

#

6

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

6

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

7

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

7

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

8

# - Icon image identifies sort column and state.

8

# - Icon image identifies sort column and state.

9

# - Typically used in conjunction with the Pagination module.

9

# - Typically used in conjunction with the Pagination module.

10

#

10

#

11

# Example code snippets:

11

# Example code snippets:

12

#

12

#

13

# Controller:

13

# Controller:

14

#

14

#

15

# helper :sort

15

# helper :sort

16

# include SortHelper

16

# include SortHelper

17

#

17

#

18

# def list

18

# def list

19

# sort_init 'last_name'

19

# sort_init 'last_name'

20

# sort_update

20

# sort_update

21

# @items = Contact.find_all nil, sort_clause

21

# @items = Contact.find_all nil, sort_clause

22

# end

22

# end

23

#

23

#

24

# Controller (using Pagination module):

24

# Controller (using Pagination module):

25

#

25

#

26

# helper :sort

26

# helper :sort

27

# include SortHelper

27

# include SortHelper

28

#

28

#

29

# def list

29

# def list

30

# sort_init 'last_name'

30

# sort_init 'last_name'

31

# sort_update

31

# sort_update

32

# @contact_pages, @items = paginate :contacts,

32

# @contact_pages, @items = paginate :contacts,

33

# :order_by => sort_clause,

33

# :order_by => sort_clause,

34

# :per_page => 10

34

# :per_page => 10

35

# end

35

# end

36

#

36

#

37

# View (table header in list.rhtml):

37

# View (table header in list.rhtml):

38

#

38

#

39

# <thead>

39

# <thead>

40

# <tr>

40

# <tr>

41

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

41

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

42

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

42

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

43

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

43

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

44

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

44

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

45

# </tr>

45

# </tr>

46

# </thead>

46

# </thead>

47

#

47

#

48

# - The ascending and descending sort icon images are sort_asc.png and

48

# - The ascending and descending sort icon images are sort_asc.png and

49

# sort_desc.png and reside in the application's images directory.

49

# sort_desc.png and reside in the application's images directory.

50

# - Introduces instance variables: @sort_name, @sort_default.

50

# - Introduces instance variables: @sort_name, @sort_default.

51

# - Introduces params :sort_key and :sort_order.

51

# - Introduces params :sort_key and :sort_order.

52

#

52

#

53

module SortHelper

53

module SortHelper

54

55

# Initializes the default sort column (default_key) and sort order

55

# Initializes the default sort column (default_key) and sort order

56

# (default_order).

56

# (default_order).

57

#

57

#

58

# - default_key is a column attribute name.

58

# - default_key is a column attribute name.

59

# - default_order is 'asc' or 'desc'.

59

# - default_order is 'asc' or 'desc'.

60

# - name is the name of the session hash entry that stores the sort state,

60

# - name is the name of the session hash entry that stores the sort state,

61

# defaults to '<controller_name>_sort'.

61

# defaults to '<controller_name>_sort'.

62

#

62

#

63

def sort_init(default_key, default_order='asc', name=nil)

63

def sort_init(default_key, default_order='asc', name=nil)

64

@sort_name = name || params[:controller] + params[:action] + '_sort'

64

@sort_name = name || params[:controller] + params[:action] + '_sort'

65

@sort_default = {:key => default_key, :order => default_order}

65

@sort_default = {:key => default_key, :order => default_order}

66

end

66

end

67

68

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

68

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

69

# sort_clause.

69

# sort_clause.

70

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

70

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

71

def sort_update(sort_keys)

71

def sort_update(sort_keys)

72

sort_key = params[:sort_key]

72

sort_key = params[:sort_key]

73

sort_key = nil unless (sort_keys.is_a?(Array) ? sort_keys.include?(sort_key) : sort_keys[sort_key])

73

sort_key = nil unless (sort_keys.is_a?(Array) ? sort_keys.include?(sort_key) : sort_keys[sort_key])

74

75

sort_order = (params[:sort_order] == 'desc' ? 'DESC' : 'ASC')

75

sort_order = (params[:sort_order] == 'desc' ? 'DESC' : 'ASC')

76

77

if sort_key

77

if sort_key

78

sort = {:key => sort_key, :order => sort_order}

78

sort = {:key => sort_key, :order => sort_order}

79

elsif session[@sort_name]

79

elsif session[@sort_name]

80

sort = session[@sort_name] # Previous sort.

80

sort = session[@sort_name] # Previous sort.

81

else

81

else

82

sort = @sort_default

82

sort = @sort_default

83

end

83

end

84

session[@sort_name] = sort

84

session[@sort_name] = sort

85

86

sort_column = (sort_keys.is_a?(Hash) ? sort_keys[sort[:key]] : sort[:key])

86

sort_column = (sort_keys.is_a?(Hash) ? sort_keys[sort[:key]] : sort[:key])

87

@sort_clause = (sort_column.blank? ? nil : "#{sort_column} #{sort[:order]}")

87

@sort_clause = (sort_column.blank? ? nil : "#{sort_column} #{sort[:order]}")

88

end

88

end

89

90

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

90

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

91

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

91

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

92

#

92

#

93

def sort_clause()

93

def sort_clause()

94

@sort_clause

94

@sort_clause

95

end

95

end

96

97

# Returns a link which sorts by the named column.

97

# Returns a link which sorts by the named column.

98

#

98

#

99

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

99

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

100

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

100

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

101

# - A sort icon image is positioned to the right of the sort link.

101

# - A sort icon image is positioned to the right of the sort link.

102

#

102

#

103

def sort_link(column, caption, default_order)

103

def sort_link(column, caption, default_order)

104

key, order = session[@sort_name][:key], session[@sort_name][:order]

104

key, order = session[@sort_name][:key], session[@sort_name][:order]

105

if key == column

105

if key == column

106

if order.downcase == 'asc'

106

if order.downcase == 'asc'

107

icon = 'sort_asc.png'

107

icon = 'sort_asc.png'

108

order = 'desc'

108

order = 'desc'

109

else

109

else

110

icon = 'sort_desc.png'

110

icon = 'sort_desc.png'

111

order = 'asc'

111

order = 'asc'

112

end

112

end

113

else

113

else

114

icon = nil

114

icon = nil

115

order = default_order

115

order = default_order

116

end

116

end

117

caption = titleize(Inflector::humanize(column)) unless caption

117

caption = titleize(Inflector::humanize(column)) unless caption

118

119

sort_options = { :sort_key => column, :sort_order => order }

119

sort_options = { :sort_key => column, :sort_order => order }

120

# don't reuse params if filters are present

120

# don't reuse params if filters are present

121

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

121

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

122

123

# Add project_id to url_options

124

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

125

123

link_to_remote(caption,

126

link_to_remote(caption,

124

{:update => "content", :url => url_options, :method => :get},

127

{:update => "content", :url => url_options, :method => :get},

125

{:href => url_for(url_options)}) +

128

{:href => url_for(url_options)}) +

126

(icon ? nbsp(2) + image_tag(icon) : '')

129

(icon ? nbsp(2) + image_tag(icon) : '')

127

end

130

end

128

131

129

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

132

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

130

# attribute.

133

# attribute.

131

#

134

#

132

# Options:

135

# Options:

133

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

136

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

134

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

137

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

135

#

138

#

136

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

139

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

137

#

140

#

138

# Example:

141

# Example:

139

#

142

#

140

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

143

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

141

#

144

#

142

# Renders:

145

# Renders:

143

#

146

#

144

# <th title="Sort by contact ID" width="40">

147

# <th title="Sort by contact ID" width="40">

145

# <a href="/contact/list?sort_order=desc&sort_key=id">Id</a>

148

# <a href="/contact/list?sort_order=desc&sort_key=id">Id</a>

146

#   <img alt="Sort_asc" src="/images/sort_asc.png" />

149

#   <img alt="Sort_asc" src="/images/sort_asc.png" />

147

# </th>

150

# </th>

148

#

151

#

149

def sort_header_tag(column, options = {})

152

def sort_header_tag(column, options = {})

150

caption = options.delete(:caption) || titleize(Inflector::humanize(column))

153

caption = options.delete(:caption) || titleize(Inflector::humanize(column))

151

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

154

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

152

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

155

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

153

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

156

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

154

end

157

end

155

158

156

private

159

private

157

160

158

# Return n non-breaking spaces.

161

# Return n non-breaking spaces.

159

def nbsp(n)

162

def nbsp(n)

160

' ' * n

163

' ' * n

161

end

164

end

162

165

163

# Return capitalized title.

166

# Return capitalized title.

164

def titleize(title)

167

def titleize(title)

165

title.split.map {|w| w.capitalize }.join(' ')

168

title.split.map {|w| w.capitalize }.join(' ')

166

end

169

end

167

170

168

end

171

end

	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.
             # 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.
             # - Icon image identifies 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
             #     @items = Contact.find_all nil, sort_clause
             #   end
             #
             # Controller (using Pagination module):
             #
             #   helper :sort
             #   include SortHelper
             #
             #   def list
             #     sort_init 'last_name'
             #     sort_update
             #     @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>
             #
             # - The ascending and descending sort icon images are sort_asc.png and
             #   sort_desc.png and reside in the application's images directory.
             # - Introduces instance variables: @sort_name, @sort_default.
             # - Introduces params :sort_key and :sort_order.
             #
             module SortHelper
               # Initializes the default sort column (default_key) and sort order
               # (default_order).
               #
               # - default_key is a column attribute name.
               # - default_order is 'asc' or 'desc'.
               # - name is the name of the session hash entry that stores the sort state,
               #   defaults to '<controller_name>_sort'.
               #
               def sort_init(default_key, default_order='asc', name=nil)
                 @sort_name = name || params[:controller] + params[:action] + '_sort'
                 @sort_default = {:key => default_key, :order => default_order}
               end
               # Updates the sort state. Call this in the controller prior to calling
               # sort_clause.
               # sort_keys can be either an array or a hash of allowed keys
               def sort_update(sort_keys)
                 sort_key = params[:sort_key]
                 sort_key = nil unless (sort_keys.is_a?(Array) ? sort_keys.include?(sort_key) : sort_keys[sort_key])
                 sort_order = (params[:sort_order] == 'desc' ? 'DESC' : 'ASC')
                 if sort_key
                   sort = {:key => sort_key, :order => sort_order}
                 elsif session[@sort_name]
                   sort = session[@sort_name]   # Previous sort.
                 else
                   sort = @sort_default
                 end
                 session[@sort_name] = sort
                 sort_column = (sort_keys.is_a?(Hash) ? sort_keys[sort[:key]] : sort[:key])
                 @sort_clause = (sort_column.blank? ? nil : "#{sort_column} #{sort[:order]}")
               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_clause
               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.
               # - A sort icon image is positioned to the right of the sort link.
               #
               def sort_link(column, caption, default_order)
                 key, order = session[@sort_name][:key], session[@sort_name][:order]
                 if key == column
                   if order.downcase == 'asc'
                     icon = 'sort_asc.png'
                     order = 'desc'
                   else
                     icon = 'sort_desc.png'
                     order = 'asc'
                   end
                 else
                   icon = nil
                   order = default_order
                 end
                 caption = titleize(Inflector::humanize(column)) unless caption
                 sort_options = { :sort_key => column, :sort_order => order }
                 # don't reuse params if filters are present
                 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_remote(caption,
                               {:update => "content", :url => url_options, :method => :get},
                               {:href => url_for(url_options)}) +
                 (icon ? nbsp(2) + image_tag(icon) : '')
               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) %>
               #
               # Renders:
               #
               #   <th title="Sort by contact ID" width="40">
               #     <a href="/contact/list?sort_order=desc&amp;sort_key=id">Id</a>
               #     &nbsp;&nbsp;<img alt="Sort_asc" src="/images/sort_asc.png" />
               #   </th>
               #
               def sort_header_tag(column, options = {})
                 caption = options.delete(:caption) || titleize(Inflector::humanize(column))
                 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
               private
                 # Return n non-breaking spaces.
                 def nbsp(n)
                   '&nbsp;' * n
                 end
                 # Return capitalized title.
                 def titleize(title)
                   title.split.map {|w| w.capitalize }.join(' ')
                 end
             end