##// END OF EJS Templates
jro_apps » redmine
RSS
Merged r9781 from trunk....
Jean-Philippe Lang -
r9610:f9ee57f2c18c
parent child
Show More
Side by Side Unified
Context file:
r9610:f9ee57f2c18c Loading diff...:
Show file before | Show file after | Hide comments
@@ -1,270 +1,279
1 module ActiveRecord
1 module ActiveRecord
2 module Acts #:nodoc:
2 module Acts #:nodoc:
3 module List #:nodoc:
3 module List #:nodoc:
4 def self.included(base)
4 def self.included(base)
5 base.extend(ClassMethods)
5 base.extend(ClassMethods)
6 end
6 end
7
7
8 # This +acts_as+ extension provides the capabilities for sorting and reordering a number of objects in a list.
8 # This +acts_as+ extension provides the capabilities for sorting and reordering a number of objects in a list.
9 # The class that has this specified needs to have a +position+ column defined as an integer on
9 # The class that has this specified needs to have a +position+ column defined as an integer on
10 # the mapped database table.
10 # the mapped database table.
11 #
11 #
12 # Todo list example:
12 # Todo list example:
13 #
13 #
14 # class TodoList < ActiveRecord::Base
14 # class TodoList < ActiveRecord::Base
15 # has_many :todo_items, :order => "position"
15 # has_many :todo_items, :order => "position"
16 # end
16 # end
17 #
17 #
18 # class TodoItem < ActiveRecord::Base
18 # class TodoItem < ActiveRecord::Base
19 # belongs_to :todo_list
19 # belongs_to :todo_list
20 # acts_as_list :scope => :todo_list
20 # acts_as_list :scope => :todo_list
21 # end
21 # end
22 #
22 #
23 # todo_list.first.move_to_bottom
23 # todo_list.first.move_to_bottom
24 # todo_list.last.move_higher
24 # todo_list.last.move_higher
25 module ClassMethods
25 module ClassMethods
26 # Configuration options are:
26 # Configuration options are:
27 #
27 #
28 # * +column+ - specifies the column name to use for keeping the position integer (default: +position+)
28 # * +column+ - specifies the column name to use for keeping the position integer (default: +position+)
29 # * +scope+ - restricts what is to be considered a list. Given a symbol, it'll attach <tt>_id</tt>
29 # * +scope+ - restricts what is to be considered a list. Given a symbol, it'll attach <tt>_id</tt>
30 # (if it hasn't already been added) and use that as the foreign key restriction. It's also possible
30 # (if it hasn't already been added) and use that as the foreign key restriction. It's also possible
31 # to give it an entire string that is interpolated if you need a tighter scope than just a foreign key.
31 # to give it an entire string that is interpolated if you need a tighter scope than just a foreign key.
32 # Example: <tt>acts_as_list :scope => 'todo_list_id = #{todo_list_id} AND completed = 0'</tt>
32 # Example: <tt>acts_as_list :scope => 'todo_list_id = #{todo_list_id} AND completed = 0'</tt>
33 def acts_as_list(options = {})
33 def acts_as_list(options = {})
34 configuration = { :column => "position", :scope => "1 = 1" }
34 configuration = { :column => "position", :scope => "1 = 1" }
35 configuration.update(options) if options.is_a?(Hash)
35 configuration.update(options) if options.is_a?(Hash)
36
36
37 configuration[:scope] = "#{configuration[:scope]}_id".intern if configuration[:scope].is_a?(Symbol) && configuration[:scope].to_s !~ /_id$/
37 configuration[:scope] = "#{configuration[:scope]}_id".intern if configuration[:scope].is_a?(Symbol) && configuration[:scope].to_s !~ /_id$/
38
38
39 if configuration[:scope].is_a?(Symbol)
39 if configuration[:scope].is_a?(Symbol)
40 scope_condition_method = %(
40 scope_condition_method = %(
41 def scope_condition
41 def scope_condition
42 if #{configuration[:scope].to_s}.nil?
42 if #{configuration[:scope].to_s}.nil?
43 "#{configuration[:scope].to_s} IS NULL"
43 "#{configuration[:scope].to_s} IS NULL"
44 else
44 else
45 "#{configuration[:scope].to_s} = \#{#{configuration[:scope].to_s}}"
45 "#{configuration[:scope].to_s} = \#{#{configuration[:scope].to_s}}"
46 end
46 end
47 end
47 end
48 )
48 )
49 else
49 else
50 scope_condition_method = "def scope_condition() \"#{configuration[:scope]}\" end"
50 scope_condition_method = "def scope_condition() \"#{configuration[:scope]}\" end"
51 end
51 end
52
52
53 class_eval <<-EOV
53 class_eval <<-EOV
54 include ActiveRecord::Acts::List::InstanceMethods
54 include ActiveRecord::Acts::List::InstanceMethods
55
55
56 def acts_as_list_class
56 def acts_as_list_class
57 ::#{self.name}
57 ::#{self.name}
58 end
58 end
59
59
60 def position_column
60 def position_column
61 '#{configuration[:column]}'
61 '#{configuration[:column]}'
62 end
62 end
63
63
64 #{scope_condition_method}
64 #{scope_condition_method}
65
65
66 before_destroy :remove_from_list
66 before_destroy :remove_from_list
67 before_create :add_to_list_bottom
67 before_create :add_to_list_bottom
68 EOV
68 EOV
69 end
69 end
70 end
70 end
71
71
72 # All the methods available to a record that has had <tt>acts_as_list</tt> specified. Each method works
72 # All the methods available to a record that has had <tt>acts_as_list</tt> specified. Each method works
73 # by assuming the object to be the item in the list, so <tt>chapter.move_lower</tt> would move that chapter
73 # by assuming the object to be the item in the list, so <tt>chapter.move_lower</tt> would move that chapter
74 # lower in the list of all chapters. Likewise, <tt>chapter.first?</tt> would return +true+ if that chapter is
74 # lower in the list of all chapters. Likewise, <tt>chapter.first?</tt> would return +true+ if that chapter is
75 # the first in the list of all chapters.
75 # the first in the list of all chapters.
76 module InstanceMethods
76 module InstanceMethods
77 # Insert the item at the given position (defaults to the top position of 1).
77 # Insert the item at the given position (defaults to the top position of 1).
78 def insert_at(position = 1)
78 def insert_at(position = 1)
79 insert_at_position(position)
79 insert_at_position(position)
80 end
80 end
81
81
82 # Swap positions with the next lower item, if one exists.
82 # Swap positions with the next lower item, if one exists.
83 def move_lower
83 def move_lower
84 return unless lower_item
84 return unless lower_item
85
85
86 acts_as_list_class.transaction do
86 acts_as_list_class.transaction do
87 lower_item.decrement_position
87 lower_item.decrement_position
88 increment_position
88 increment_position
89 end
89 end
90 end
90 end
91
91
92 # Swap positions with the next higher item, if one exists.
92 # Swap positions with the next higher item, if one exists.
93 def move_higher
93 def move_higher
94 return unless higher_item
94 return unless higher_item
95
95
96 acts_as_list_class.transaction do
96 acts_as_list_class.transaction do
97 higher_item.increment_position
97 higher_item.increment_position
98 decrement_position
98 decrement_position
99 end
99 end
100 end
100 end
101
101
102 # Move to the bottom of the list. If the item is already in the list, the items below it have their
102 # Move to the bottom of the list. If the item is already in the list, the items below it have their
103 # position adjusted accordingly.
103 # position adjusted accordingly.
104 def move_to_bottom
104 def move_to_bottom
105 return unless in_list?
105 return unless in_list?
106 acts_as_list_class.transaction do
106 acts_as_list_class.transaction do
107 decrement_positions_on_lower_items
107 decrement_positions_on_lower_items
108 assume_bottom_position
108 assume_bottom_position
109 end
109 end
110 end
110 end
111
111
112 # Move to the top of the list. If the item is already in the list, the items above it have their
112 # Move to the top of the list. If the item is already in the list, the items above it have their
113 # position adjusted accordingly.
113 # position adjusted accordingly.
114 def move_to_top
114 def move_to_top
115 return unless in_list?
115 return unless in_list?
116 acts_as_list_class.transaction do
116 acts_as_list_class.transaction do
117 increment_positions_on_higher_items
117 increment_positions_on_higher_items
118 assume_top_position
118 assume_top_position
119 end
119 end
120 end
120 end
121
121
122 # Move to the given position
122 # Move to the given position
123 def move_to=(pos)
123 def move_to=(pos)
124 case pos.to_s
124 case pos.to_s
125 when 'highest'
125 when 'highest'
126 move_to_top
126 move_to_top
127 when 'higher'
127 when 'higher'
128 move_higher
128 move_higher
129 when 'lower'
129 when 'lower'
130 move_lower
130 move_lower
131 when 'lowest'
131 when 'lowest'
132 move_to_bottom
132 move_to_bottom
133 end
133 end
134 reset_positions_in_list
135 end
136
137 def reset_positions_in_list
138 acts_as_list_class.where(scope_condition).reorder("#{position_column} ASC, id ASC").each_with_index do |item, i|
139 unless item.send(position_column) == (i + 1)
140 acts_as_list_class.update_all({position_column => (i + 1)}, {:id => item.id})
141 end
142 end
134 end
143 end
135
144
136 # Removes the item from the list.
145 # Removes the item from the list.
137 def remove_from_list
146 def remove_from_list
138 if in_list?
147 if in_list?
139 decrement_positions_on_lower_items
148 decrement_positions_on_lower_items
140 update_attribute position_column, nil
149 update_attribute position_column, nil
141 end
150 end
142 end
151 end
143
152
144 # Increase the position of this item without adjusting the rest of the list.
153 # Increase the position of this item without adjusting the rest of the list.
145 def increment_position
154 def increment_position
146 return unless in_list?
155 return unless in_list?
147 update_attribute position_column, self.send(position_column).to_i + 1
156 update_attribute position_column, self.send(position_column).to_i + 1
148 end
157 end
149
158
150 # Decrease the position of this item without adjusting the rest of the list.
159 # Decrease the position of this item without adjusting the rest of the list.
151 def decrement_position
160 def decrement_position
152 return unless in_list?
161 return unless in_list?
153 update_attribute position_column, self.send(position_column).to_i - 1
162 update_attribute position_column, self.send(position_column).to_i - 1
154 end
163 end
155
164
156 # Return +true+ if this object is the first in the list.
165 # Return +true+ if this object is the first in the list.
157 def first?
166 def first?
158 return false unless in_list?
167 return false unless in_list?
159 self.send(position_column) == 1
168 self.send(position_column) == 1
160 end
169 end
161
170
162 # Return +true+ if this object is the last in the list.
171 # Return +true+ if this object is the last in the list.
163 def last?
172 def last?
164 return false unless in_list?
173 return false unless in_list?
165 self.send(position_column) == bottom_position_in_list
174 self.send(position_column) == bottom_position_in_list
166 end
175 end
167
176
168 # Return the next higher item in the list.
177 # Return the next higher item in the list.
169 def higher_item
178 def higher_item
170 return nil unless in_list?
179 return nil unless in_list?
171 acts_as_list_class.find(:first, :conditions =>
180 acts_as_list_class.find(:first, :conditions =>
172 "#{scope_condition} AND #{position_column} = #{(send(position_column).to_i - 1).to_s}"
181 "#{scope_condition} AND #{position_column} = #{(send(position_column).to_i - 1).to_s}"
173 )
182 )
174 end
183 end
175
184
176 # Return the next lower item in the list.
185 # Return the next lower item in the list.
177 def lower_item
186 def lower_item
178 return nil unless in_list?
187 return nil unless in_list?
179 acts_as_list_class.find(:first, :conditions =>
188 acts_as_list_class.find(:first, :conditions =>
180 "#{scope_condition} AND #{position_column} = #{(send(position_column).to_i + 1).to_s}"
189 "#{scope_condition} AND #{position_column} = #{(send(position_column).to_i + 1).to_s}"
181 )
190 )
182 end
191 end
183
192
184 # Test if this record is in a list
193 # Test if this record is in a list
185 def in_list?
194 def in_list?
186 !send(position_column).nil?
195 !send(position_column).nil?
187 end
196 end
188
197
189 private
198 private
190 def add_to_list_top
199 def add_to_list_top
191 increment_positions_on_all_items
200 increment_positions_on_all_items
192 end
201 end
193
202
194 def add_to_list_bottom
203 def add_to_list_bottom
195 self[position_column] = bottom_position_in_list.to_i + 1
204 self[position_column] = bottom_position_in_list.to_i + 1
196 end
205 end
197
206
198 # Overwrite this method to define the scope of the list changes
207 # Overwrite this method to define the scope of the list changes
199 def scope_condition() "1" end
208 def scope_condition() "1" end
200
209
201 # Returns the bottom position number in the list.
210 # Returns the bottom position number in the list.
202 # bottom_position_in_list # => 2
211 # bottom_position_in_list # => 2
203 def bottom_position_in_list(except = nil)
212 def bottom_position_in_list(except = nil)
204 item = bottom_item(except)
213 item = bottom_item(except)
205 item ? item.send(position_column) : 0
214 item ? item.send(position_column) : 0
206 end
215 end
207
216
208 # Returns the bottom item
217 # Returns the bottom item
209 def bottom_item(except = nil)
218 def bottom_item(except = nil)
210 conditions = scope_condition
219 conditions = scope_condition
211 conditions = "#{conditions} AND #{self.class.primary_key} != #{except.id}" if except
220 conditions = "#{conditions} AND #{self.class.primary_key} != #{except.id}" if except
212 acts_as_list_class.find(:first, :conditions => conditions, :order => "#{position_column} DESC")
221 acts_as_list_class.where(conditions).reorder("#{position_column} DESC").first
213 end
222 end
214
223
215 # Forces item to assume the bottom position in the list.
224 # Forces item to assume the bottom position in the list.
216 def assume_bottom_position
225 def assume_bottom_position
217 update_attribute(position_column, bottom_position_in_list(self).to_i + 1)
226 update_attribute(position_column, bottom_position_in_list(self).to_i + 1)
218 end
227 end
219
228
220 # Forces item to assume the top position in the list.
229 # Forces item to assume the top position in the list.
221 def assume_top_position
230 def assume_top_position
222 update_attribute(position_column, 1)
231 update_attribute(position_column, 1)
223 end
232 end
224
233
225 # This has the effect of moving all the higher items up one.
234 # This has the effect of moving all the higher items up one.
226 def decrement_positions_on_higher_items(position)
235 def decrement_positions_on_higher_items(position)
227 acts_as_list_class.update_all(
236 acts_as_list_class.update_all(
228 "#{position_column} = (#{position_column} - 1)", "#{scope_condition} AND #{position_column} <= #{position}"
237 "#{position_column} = (#{position_column} - 1)", "#{scope_condition} AND #{position_column} <= #{position}"
229 )
238 )
230 end
239 end
231
240
232 # This has the effect of moving all the lower items up one.
241 # This has the effect of moving all the lower items up one.
233 def decrement_positions_on_lower_items
242 def decrement_positions_on_lower_items
234 return unless in_list?
243 return unless in_list?
235 acts_as_list_class.update_all(
244 acts_as_list_class.update_all(
236 "#{position_column} = (#{position_column} - 1)", "#{scope_condition} AND #{position_column} > #{send(position_column).to_i}"
245 "#{position_column} = (#{position_column} - 1)", "#{scope_condition} AND #{position_column} > #{send(position_column).to_i}"
237 )
246 )
238 end
247 end
239
248
240 # This has the effect of moving all the higher items down one.
249 # This has the effect of moving all the higher items down one.
241 def increment_positions_on_higher_items
250 def increment_positions_on_higher_items
242 return unless in_list?
251 return unless in_list?
243 acts_as_list_class.update_all(
252 acts_as_list_class.update_all(
244 "#{position_column} = (#{position_column} + 1)", "#{scope_condition} AND #{position_column} < #{send(position_column).to_i}"
253 "#{position_column} = (#{position_column} + 1)", "#{scope_condition} AND #{position_column} < #{send(position_column).to_i}"
245 )
254 )
246 end
255 end
247
256
248 # This has the effect of moving all the lower items down one.
257 # This has the effect of moving all the lower items down one.
249 def increment_positions_on_lower_items(position)
258 def increment_positions_on_lower_items(position)
250 acts_as_list_class.update_all(
259 acts_as_list_class.update_all(
251 "#{position_column} = (#{position_column} + 1)", "#{scope_condition} AND #{position_column} >= #{position}"
260 "#{position_column} = (#{position_column} + 1)", "#{scope_condition} AND #{position_column} >= #{position}"
252 )
261 )
253 end
262 end
254
263
255 # Increments position (<tt>position_column</tt>) of all items in the list.
264 # Increments position (<tt>position_column</tt>) of all items in the list.
256 def increment_positions_on_all_items
265 def increment_positions_on_all_items
257 acts_as_list_class.update_all(
266 acts_as_list_class.update_all(
258 "#{position_column} = (#{position_column} + 1)", "#{scope_condition}"
267 "#{position_column} = (#{position_column} + 1)", "#{scope_condition}"
259 )
268 )
260 end
269 end
261
270
262 def insert_at_position(position)
271 def insert_at_position(position)
263 remove_from_list
272 remove_from_list
264 increment_positions_on_lower_items(position)
273 increment_positions_on_lower_items(position)
265 self.update_attribute(position_column, position)
274 self.update_attribute(position_column, position)
266 end
275 end
267 end
276 end
268 end
277 end
269 end
278 end
270 end
279 end
Show file before | Show file after | Hide comments
@@ -1,38 +1,63
1 # Redmine - project management software
1 # Redmine - project management software
2 # Copyright (C) 2006-2012 Jean-Philippe Lang
2 # Copyright (C) 2006-2012 Jean-Philippe Lang
3 #
3 #
4 # This program is free software; you can redistribute it and/or
4 # This program is free software; you can redistribute it and/or
5 # modify it under the terms of the GNU General Public License
5 # modify it under the terms of the GNU General Public License
6 # as published by the Free Software Foundation; either version 2
6 # as published by the Free Software Foundation; either version 2
7 # of the License, or (at your option) any later version.
7 # of the License, or (at your option) any later version.
8 #
8 #
9 # This program is distributed in the hope that it will be useful,
9 # This program is distributed in the hope that it will be useful,
10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 # GNU General Public License for more details.
12 # GNU General Public License for more details.
13 #
13 #
14 # You should have received a copy of the GNU General Public License
14 # You should have received a copy of the GNU General Public License
15 # along with this program; if not, write to the Free Software
15 # along with this program; if not, write to the Free Software
16 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17
17
18 require File.expand_path('../../test_helper', __FILE__)
18 require File.expand_path('../../test_helper', __FILE__)
19
19
20 class IssuePriorityTest < ActiveSupport::TestCase
20 class IssuePriorityTest < ActiveSupport::TestCase
21 fixtures :enumerations, :issues
21 fixtures :enumerations, :issues
22
22
23 def test_should_be_an_enumeration
23 def test_should_be_an_enumeration
24 assert IssuePriority.ancestors.include?(Enumeration)
24 assert IssuePriority.ancestors.include?(Enumeration)
25 end
25 end
26
26
27 def test_objects_count
27 def test_objects_count
28 # low priority
28 # low priority
29 assert_equal 6, IssuePriority.find(4).objects_count
29 assert_equal 6, IssuePriority.find(4).objects_count
30 # urgent
30 # urgent
31 assert_equal 0, IssuePriority.find(7).objects_count
31 assert_equal 0, IssuePriority.find(7).objects_count
32 end
32 end
33
33
34 def test_option_name
34 def test_option_name
35 assert_equal :enumeration_issue_priorities, IssuePriority.new.option_name
35 assert_equal :enumeration_issue_priorities, IssuePriority.new.option_name
36 end
36 end
37 end
38
37
38 def test_should_be_created_at_last_position
39 IssuePriority.delete_all
40
41 priorities = [1, 2, 3].map {|i| IssuePriority.create!(:name => "P#{i}")}
42 assert_equal [1, 2, 3], priorities.map(&:position)
43 end
44
45 def test_reset_positions_in_list_should_set_sequential_positions
46 IssuePriority.delete_all
47
48 priorities = [1, 2, 3].map {|i| IssuePriority.create!(:name => "P#{i}")}
49 priorities[0].update_attribute :position, 4
50 priorities[1].update_attribute :position, 2
51 priorities[2].update_attribute :position, 7
52 assert_equal [4, 2, 7], priorities.map(&:reload).map(&:position)
53
54 priorities[0].reset_positions_in_list
55 assert_equal [2, 1, 3], priorities.map(&:reload).map(&:position)
56 end
57
58 def test_moving_in_list_should_reset_positions
59 priority = IssuePriority.first
60 priority.expects(:reset_positions_in_list).once
61 priority.move_to = 'higher'
62 end
63 end
General Comments 0
You need to be logged in to leave comments. Login now