##// END OF EJS Templates
jro_apps » redmine
RSS
Rails4: replace deprecated Relation#update_all at acts_as_list...
Toshi MARUYAMA -
r12251:78ca50560a25
parent child
Show More
Side by Side Unified
Context file:
r12251:78ca50560a25 Loading diff...:
Show file before | Show file after | Hide comments
@@ -1,279 +1,280
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
134 reset_positions_in_list
135 end
135 end
136
136
137 def reset_positions_in_list
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|
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)
139 unless item.send(position_column) == (i + 1)
140 acts_as_list_class.update_all({position_column => (i + 1)}, {:id => item.id})
140 acts_as_list_class.where({:id => item.id}).
141 update_all({position_column => (i + 1)})
141 end
142 end
142 end
143 end
143 end
144 end
144
145
145 # Removes the item from the list.
146 # Removes the item from the list.
146 def remove_from_list
147 def remove_from_list
147 if in_list?
148 if in_list?
148 decrement_positions_on_lower_items
149 decrement_positions_on_lower_items
149 update_attribute position_column, nil
150 update_attribute position_column, nil
150 end
151 end
151 end
152 end
152
153
153 # Increase the position of this item without adjusting the rest of the list.
154 # Increase the position of this item without adjusting the rest of the list.
154 def increment_position
155 def increment_position
155 return unless in_list?
156 return unless in_list?
156 update_attribute position_column, self.send(position_column).to_i + 1
157 update_attribute position_column, self.send(position_column).to_i + 1
157 end
158 end
158
159
159 # Decrease the position of this item without adjusting the rest of the list.
160 # Decrease the position of this item without adjusting the rest of the list.
160 def decrement_position
161 def decrement_position
161 return unless in_list?
162 return unless in_list?
162 update_attribute position_column, self.send(position_column).to_i - 1
163 update_attribute position_column, self.send(position_column).to_i - 1
163 end
164 end
164
165
165 # Return +true+ if this object is the first in the list.
166 # Return +true+ if this object is the first in the list.
166 def first?
167 def first?
167 return false unless in_list?
168 return false unless in_list?
168 self.send(position_column) == 1
169 self.send(position_column) == 1
169 end
170 end
170
171
171 # Return +true+ if this object is the last in the list.
172 # Return +true+ if this object is the last in the list.
172 def last?
173 def last?
173 return false unless in_list?
174 return false unless in_list?
174 self.send(position_column) == bottom_position_in_list
175 self.send(position_column) == bottom_position_in_list
175 end
176 end
176
177
177 # Return the next higher item in the list.
178 # Return the next higher item in the list.
178 def higher_item
179 def higher_item
179 return nil unless in_list?
180 return nil unless in_list?
180 acts_as_list_class.where(
181 acts_as_list_class.where(
181 "#{scope_condition} AND #{position_column} = #{(send(position_column).to_i - 1).to_s}"
182 "#{scope_condition} AND #{position_column} = #{(send(position_column).to_i - 1).to_s}"
182 ).first
183 ).first
183 end
184 end
184
185
185 # Return the next lower item in the list.
186 # Return the next lower item in the list.
186 def lower_item
187 def lower_item
187 return nil unless in_list?
188 return nil unless in_list?
188 acts_as_list_class.where(
189 acts_as_list_class.where(
189 "#{scope_condition} AND #{position_column} = #{(send(position_column).to_i + 1).to_s}"
190 "#{scope_condition} AND #{position_column} = #{(send(position_column).to_i + 1).to_s}"
190 ).first
191 ).first
191 end
192 end
192
193
193 # Test if this record is in a list
194 # Test if this record is in a list
194 def in_list?
195 def in_list?
195 !send(position_column).nil?
196 !send(position_column).nil?
196 end
197 end
197
198
198 private
199 private
199 def add_to_list_top
200 def add_to_list_top
200 increment_positions_on_all_items
201 increment_positions_on_all_items
201 end
202 end
202
203
203 def add_to_list_bottom
204 def add_to_list_bottom
204 self[position_column] = bottom_position_in_list.to_i + 1
205 self[position_column] = bottom_position_in_list.to_i + 1
205 end
206 end
206
207
207 # Overwrite this method to define the scope of the list changes
208 # Overwrite this method to define the scope of the list changes
208 def scope_condition() "1" end
209 def scope_condition() "1" end
209
210
210 # Returns the bottom position number in the list.
211 # Returns the bottom position number in the list.
211 # bottom_position_in_list # => 2
212 # bottom_position_in_list # => 2
212 def bottom_position_in_list(except = nil)
213 def bottom_position_in_list(except = nil)
213 item = bottom_item(except)
214 item = bottom_item(except)
214 item ? item.send(position_column) : 0
215 item ? item.send(position_column) : 0
215 end
216 end
216
217
217 # Returns the bottom item
218 # Returns the bottom item
218 def bottom_item(except = nil)
219 def bottom_item(except = nil)
219 conditions = scope_condition
220 conditions = scope_condition
220 conditions = "#{conditions} AND #{self.class.primary_key} != #{except.id}" if except
221 conditions = "#{conditions} AND #{self.class.primary_key} != #{except.id}" if except
221 acts_as_list_class.where(conditions).reorder("#{position_column} DESC").first
222 acts_as_list_class.where(conditions).reorder("#{position_column} DESC").first
222 end
223 end
223
224
224 # Forces item to assume the bottom position in the list.
225 # Forces item to assume the bottom position in the list.
225 def assume_bottom_position
226 def assume_bottom_position
226 update_attribute(position_column, bottom_position_in_list(self).to_i + 1)
227 update_attribute(position_column, bottom_position_in_list(self).to_i + 1)
227 end
228 end
228
229
229 # Forces item to assume the top position in the list.
230 # Forces item to assume the top position in the list.
230 def assume_top_position
231 def assume_top_position
231 update_attribute(position_column, 1)
232 update_attribute(position_column, 1)
232 end
233 end
233
234
234 # This has the effect of moving all the higher items up one.
235 # This has the effect of moving all the higher items up one.
235 def decrement_positions_on_higher_items(position)
236 def decrement_positions_on_higher_items(position)
236 acts_as_list_class.
237 acts_as_list_class.
237 where("#{scope_condition} AND #{position_column} <= #{position}").
238 where("#{scope_condition} AND #{position_column} <= #{position}").
238 update_all("#{position_column} = (#{position_column} - 1)")
239 update_all("#{position_column} = (#{position_column} - 1)")
239 end
240 end
240
241
241 # This has the effect of moving all the lower items up one.
242 # This has the effect of moving all the lower items up one.
242 def decrement_positions_on_lower_items
243 def decrement_positions_on_lower_items
243 return unless in_list?
244 return unless in_list?
244 acts_as_list_class.
245 acts_as_list_class.
245 where("#{scope_condition} AND #{position_column} > #{send(position_column).to_i}").
246 where("#{scope_condition} AND #{position_column} > #{send(position_column).to_i}").
246 update_all("#{position_column} = (#{position_column} - 1)")
247 update_all("#{position_column} = (#{position_column} - 1)")
247 end
248 end
248
249
249 # This has the effect of moving all the higher items down one.
250 # This has the effect of moving all the higher items down one.
250 def increment_positions_on_higher_items
251 def increment_positions_on_higher_items
251 return unless in_list?
252 return unless in_list?
252 acts_as_list_class.
253 acts_as_list_class.
253 where("#{scope_condition} AND #{position_column} < #{send(position_column).to_i}").
254 where("#{scope_condition} AND #{position_column} < #{send(position_column).to_i}").
254 update_all("#{position_column} = (#{position_column} + 1)")
255 update_all("#{position_column} = (#{position_column} + 1)")
255 end
256 end
256
257
257 # This has the effect of moving all the lower items down one.
258 # This has the effect of moving all the lower items down one.
258 def increment_positions_on_lower_items(position)
259 def increment_positions_on_lower_items(position)
259 acts_as_list_class.
260 acts_as_list_class.
260 where("#{scope_condition} AND #{position_column} >= #{position}").
261 where("#{scope_condition} AND #{position_column} >= #{position}").
261 update_all("#{position_column} = (#{position_column} + 1)")
262 update_all("#{position_column} = (#{position_column} + 1)")
262 end
263 end
263
264
264 # Increments position (<tt>position_column</tt>) of all items in the list.
265 # Increments position (<tt>position_column</tt>) of all items in the list.
265 def increment_positions_on_all_items
266 def increment_positions_on_all_items
266 acts_as_list_class.
267 acts_as_list_class.
267 where("#{scope_condition}").
268 where("#{scope_condition}").
268 update_all("#{position_column} = (#{position_column} + 1)")
269 update_all("#{position_column} = (#{position_column} + 1)")
269 end
270 end
270
271
271 def insert_at_position(position)
272 def insert_at_position(position)
272 remove_from_list
273 remove_from_list
273 increment_positions_on_lower_items(position)
274 increment_positions_on_lower_items(position)
274 self.update_attribute(position_column, position)
275 self.update_attribute(position_column, position)
275 end
276 end
276 end
277 end
277 end
278 end
278 end
279 end
279 end
280 end
General Comments 0
You need to be logged in to leave comments. Login now