annotate .svn/pristine/98/98c0db76d6e760140185877cec36781da99e0334.svn-base @ 1524:82fac3dcf466 redmine-2.5-integration

Fix failure to interpret Javascript when autocompleting members for project
author Chris Cannam <chris.cannam@soundsoftware.ac.uk>
date Thu, 11 Sep 2014 10:24:38 +0100
parents 261b3d9a4903
children
rev   line source
Chris@1464 1 # Copyright (c) 2005 Rick Olson
Chris@1464 2 #
Chris@1464 3 # Permission is hereby granted, free of charge, to any person obtaining
Chris@1464 4 # a copy of this software and associated documentation files (the
Chris@1464 5 # "Software"), to deal in the Software without restriction, including
Chris@1464 6 # without limitation the rights to use, copy, modify, merge, publish,
Chris@1464 7 # distribute, sublicense, and/or sell copies of the Software, and to
Chris@1464 8 # permit persons to whom the Software is furnished to do so, subject to
Chris@1464 9 # the following conditions:
Chris@1464 10 #
Chris@1464 11 # The above copyright notice and this permission notice shall be
Chris@1464 12 # included in all copies or substantial portions of the Software.
Chris@1464 13 #
Chris@1464 14 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
Chris@1464 15 # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
Chris@1464 16 # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
Chris@1464 17 # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
Chris@1464 18 # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
Chris@1464 19 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
Chris@1464 20 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Chris@1464 21
Chris@1464 22 module ActiveRecord #:nodoc:
Chris@1464 23 module Acts #:nodoc:
Chris@1464 24 # Specify this act if you want to save a copy of the row in a versioned table. This assumes there is a
Chris@1464 25 # versioned table ready and that your model has a version field. This works with optimistic locking if the lock_version
Chris@1464 26 # column is present as well.
Chris@1464 27 #
Chris@1464 28 # The class for the versioned model is derived the first time it is seen. Therefore, if you change your database schema you have to restart
Chris@1464 29 # your container for the changes to be reflected. In development mode this usually means restarting WEBrick.
Chris@1464 30 #
Chris@1464 31 # class Page < ActiveRecord::Base
Chris@1464 32 # # assumes pages_versions table
Chris@1464 33 # acts_as_versioned
Chris@1464 34 # end
Chris@1464 35 #
Chris@1464 36 # Example:
Chris@1464 37 #
Chris@1464 38 # page = Page.create(:title => 'hello world!')
Chris@1464 39 # page.version # => 1
Chris@1464 40 #
Chris@1464 41 # page.title = 'hello world'
Chris@1464 42 # page.save
Chris@1464 43 # page.version # => 2
Chris@1464 44 # page.versions.size # => 2
Chris@1464 45 #
Chris@1464 46 # page.revert_to(1) # using version number
Chris@1464 47 # page.title # => 'hello world!'
Chris@1464 48 #
Chris@1464 49 # page.revert_to(page.versions.last) # using versioned instance
Chris@1464 50 # page.title # => 'hello world'
Chris@1464 51 #
Chris@1464 52 # page.versions.earliest # efficient query to find the first version
Chris@1464 53 # page.versions.latest # efficient query to find the most recently created version
Chris@1464 54 #
Chris@1464 55 #
Chris@1464 56 # Simple Queries to page between versions
Chris@1464 57 #
Chris@1464 58 # page.versions.before(version)
Chris@1464 59 # page.versions.after(version)
Chris@1464 60 #
Chris@1464 61 # Access the previous/next versions from the versioned model itself
Chris@1464 62 #
Chris@1464 63 # version = page.versions.latest
Chris@1464 64 # version.previous # go back one version
Chris@1464 65 # version.next # go forward one version
Chris@1464 66 #
Chris@1464 67 # See ActiveRecord::Acts::Versioned::ClassMethods#acts_as_versioned for configuration options
Chris@1464 68 module Versioned
Chris@1464 69 CALLBACKS = [:set_new_version, :save_version_on_create, :save_version?, :clear_altered_attributes]
Chris@1464 70 def self.included(base) # :nodoc:
Chris@1464 71 base.extend ClassMethods
Chris@1464 72 end
Chris@1464 73
Chris@1464 74 module ClassMethods
Chris@1464 75 # == Configuration options
Chris@1464 76 #
Chris@1464 77 # * <tt>class_name</tt> - versioned model class name (default: PageVersion in the above example)
Chris@1464 78 # * <tt>table_name</tt> - versioned model table name (default: page_versions in the above example)
Chris@1464 79 # * <tt>foreign_key</tt> - foreign key used to relate the versioned model to the original model (default: page_id in the above example)
Chris@1464 80 # * <tt>inheritance_column</tt> - name of the column to save the model's inheritance_column value for STI. (default: versioned_type)
Chris@1464 81 # * <tt>version_column</tt> - name of the column in the model that keeps the version number (default: version)
Chris@1464 82 # * <tt>sequence_name</tt> - name of the custom sequence to be used by the versioned model.
Chris@1464 83 # * <tt>limit</tt> - number of revisions to keep, defaults to unlimited
Chris@1464 84 # * <tt>if</tt> - symbol of method to check before saving a new version. If this method returns false, a new version is not saved.
Chris@1464 85 # For finer control, pass either a Proc or modify Model#version_condition_met?
Chris@1464 86 #
Chris@1464 87 # acts_as_versioned :if => Proc.new { |auction| !auction.expired? }
Chris@1464 88 #
Chris@1464 89 # or...
Chris@1464 90 #
Chris@1464 91 # class Auction
Chris@1464 92 # def version_condition_met? # totally bypasses the <tt>:if</tt> option
Chris@1464 93 # !expired?
Chris@1464 94 # end
Chris@1464 95 # end
Chris@1464 96 #
Chris@1464 97 # * <tt>if_changed</tt> - Simple way of specifying attributes that are required to be changed before saving a model. This takes
Chris@1464 98 # either a symbol or array of symbols. WARNING - This will attempt to overwrite any attribute setters you may have.
Chris@1464 99 # Use this instead if you want to write your own attribute setters (and ignore if_changed):
Chris@1464 100 #
Chris@1464 101 # def name=(new_name)
Chris@1464 102 # write_changed_attribute :name, new_name
Chris@1464 103 # end
Chris@1464 104 #
Chris@1464 105 # * <tt>extend</tt> - Lets you specify a module to be mixed in both the original and versioned models. You can also just pass a block
Chris@1464 106 # to create an anonymous mixin:
Chris@1464 107 #
Chris@1464 108 # class Auction
Chris@1464 109 # acts_as_versioned do
Chris@1464 110 # def started?
Chris@1464 111 # !started_at.nil?
Chris@1464 112 # end
Chris@1464 113 # end
Chris@1464 114 # end
Chris@1464 115 #
Chris@1464 116 # or...
Chris@1464 117 #
Chris@1464 118 # module AuctionExtension
Chris@1464 119 # def started?
Chris@1464 120 # !started_at.nil?
Chris@1464 121 # end
Chris@1464 122 # end
Chris@1464 123 # class Auction
Chris@1464 124 # acts_as_versioned :extend => AuctionExtension
Chris@1464 125 # end
Chris@1464 126 #
Chris@1464 127 # Example code:
Chris@1464 128 #
Chris@1464 129 # @auction = Auction.find(1)
Chris@1464 130 # @auction.started?
Chris@1464 131 # @auction.versions.first.started?
Chris@1464 132 #
Chris@1464 133 # == Database Schema
Chris@1464 134 #
Chris@1464 135 # The model that you're versioning needs to have a 'version' attribute. The model is versioned
Chris@1464 136 # into a table called #{model}_versions where the model name is singlular. The _versions table should
Chris@1464 137 # contain all the fields you want versioned, the same version column, and a #{model}_id foreign key field.
Chris@1464 138 #
Chris@1464 139 # A lock_version field is also accepted if your model uses Optimistic Locking. If your table uses Single Table inheritance,
Chris@1464 140 # then that field is reflected in the versioned model as 'versioned_type' by default.
Chris@1464 141 #
Chris@1464 142 # Acts_as_versioned comes prepared with the ActiveRecord::Acts::Versioned::ActMethods::ClassMethods#create_versioned_table
Chris@1464 143 # method, perfect for a migration. It will also create the version column if the main model does not already have it.
Chris@1464 144 #
Chris@1464 145 # class AddVersions < ActiveRecord::Migration
Chris@1464 146 # def self.up
Chris@1464 147 # # create_versioned_table takes the same options hash
Chris@1464 148 # # that create_table does
Chris@1464 149 # Post.create_versioned_table
Chris@1464 150 # end
Chris@1464 151 #
Chris@1464 152 # def self.down
Chris@1464 153 # Post.drop_versioned_table
Chris@1464 154 # end
Chris@1464 155 # end
Chris@1464 156 #
Chris@1464 157 # == Changing What Fields Are Versioned
Chris@1464 158 #
Chris@1464 159 # By default, acts_as_versioned will version all but these fields:
Chris@1464 160 #
Chris@1464 161 # [self.primary_key, inheritance_column, 'version', 'lock_version', versioned_inheritance_column]
Chris@1464 162 #
Chris@1464 163 # You can add or change those by modifying #non_versioned_columns. Note that this takes strings and not symbols.
Chris@1464 164 #
Chris@1464 165 # class Post < ActiveRecord::Base
Chris@1464 166 # acts_as_versioned
Chris@1464 167 # self.non_versioned_columns << 'comments_count'
Chris@1464 168 # end
Chris@1464 169 #
Chris@1464 170 def acts_as_versioned(options = {}, &extension)
Chris@1464 171 # don't allow multiple calls
Chris@1464 172 return if self.included_modules.include?(ActiveRecord::Acts::Versioned::ActMethods)
Chris@1464 173
Chris@1464 174 send :include, ActiveRecord::Acts::Versioned::ActMethods
Chris@1464 175
Chris@1464 176 cattr_accessor :versioned_class_name, :versioned_foreign_key, :versioned_table_name, :versioned_inheritance_column,
Chris@1464 177 :version_column, :max_version_limit, :track_altered_attributes, :version_condition, :version_sequence_name, :non_versioned_columns,
Chris@1464 178 :version_association_options
Chris@1464 179
Chris@1464 180 # legacy
Chris@1464 181 alias_method :non_versioned_fields, :non_versioned_columns
Chris@1464 182 alias_method :non_versioned_fields=, :non_versioned_columns=
Chris@1464 183
Chris@1464 184 class << self
Chris@1464 185 alias_method :non_versioned_fields, :non_versioned_columns
Chris@1464 186 alias_method :non_versioned_fields=, :non_versioned_columns=
Chris@1464 187 end
Chris@1464 188
Chris@1464 189 send :attr_accessor, :altered_attributes
Chris@1464 190
Chris@1464 191 self.versioned_class_name = options[:class_name] || "Version"
Chris@1464 192 self.versioned_foreign_key = options[:foreign_key] || self.to_s.foreign_key
Chris@1464 193 self.versioned_table_name = options[:table_name] || "#{table_name_prefix}#{base_class.name.demodulize.underscore}_versions#{table_name_suffix}"
Chris@1464 194 self.versioned_inheritance_column = options[:inheritance_column] || "versioned_#{inheritance_column}"
Chris@1464 195 self.version_column = options[:version_column] || 'version'
Chris@1464 196 self.version_sequence_name = options[:sequence_name]
Chris@1464 197 self.max_version_limit = options[:limit].to_i
Chris@1464 198 self.version_condition = options[:if] || true
Chris@1464 199 self.non_versioned_columns = [self.primary_key, inheritance_column, 'version', 'lock_version', versioned_inheritance_column]
Chris@1464 200 self.version_association_options = {
Chris@1464 201 :class_name => "#{self.to_s}::#{versioned_class_name}",
Chris@1464 202 :foreign_key => versioned_foreign_key,
Chris@1464 203 :dependent => :delete_all
Chris@1464 204 }.merge(options[:association_options] || {})
Chris@1464 205
Chris@1464 206 if block_given?
Chris@1464 207 extension_module_name = "#{versioned_class_name}Extension"
Chris@1464 208 silence_warnings do
Chris@1464 209 self.const_set(extension_module_name, Module.new(&extension))
Chris@1464 210 end
Chris@1464 211
Chris@1464 212 options[:extend] = self.const_get(extension_module_name)
Chris@1464 213 end
Chris@1464 214
Chris@1464 215 class_eval do
Chris@1464 216 has_many :versions, version_association_options do
Chris@1464 217 # finds earliest version of this record
Chris@1464 218 def earliest
Chris@1464 219 @earliest ||= order('version').first
Chris@1464 220 end
Chris@1464 221
Chris@1464 222 # find latest version of this record
Chris@1464 223 def latest
Chris@1464 224 @latest ||= order('version desc').first
Chris@1464 225 end
Chris@1464 226 end
Chris@1464 227 before_save :set_new_version
Chris@1464 228 after_create :save_version_on_create
Chris@1464 229 after_update :save_version
Chris@1464 230 after_save :clear_old_versions
Chris@1464 231 after_save :clear_altered_attributes
Chris@1464 232
Chris@1464 233 unless options[:if_changed].nil?
Chris@1464 234 self.track_altered_attributes = true
Chris@1464 235 options[:if_changed] = [options[:if_changed]] unless options[:if_changed].is_a?(Array)
Chris@1464 236 options[:if_changed].each do |attr_name|
Chris@1464 237 define_method("#{attr_name}=") do |value|
Chris@1464 238 write_changed_attribute attr_name, value
Chris@1464 239 end
Chris@1464 240 end
Chris@1464 241 end
Chris@1464 242
Chris@1464 243 include options[:extend] if options[:extend].is_a?(Module)
Chris@1464 244 end
Chris@1464 245
Chris@1464 246 # create the dynamic versioned model
Chris@1464 247 const_set(versioned_class_name, Class.new(ActiveRecord::Base)).class_eval do
Chris@1464 248 def self.reloadable? ; false ; end
Chris@1464 249 # find first version before the given version
Chris@1464 250 def self.before(version)
Chris@1464 251 order('version desc').
Chris@1464 252 where("#{original_class.versioned_foreign_key} = ? and version < ?", version.send(original_class.versioned_foreign_key), version.version).
Chris@1464 253 first
Chris@1464 254 end
Chris@1464 255
Chris@1464 256 # find first version after the given version.
Chris@1464 257 def self.after(version)
Chris@1464 258 order('version').
Chris@1464 259 where("#{original_class.versioned_foreign_key} = ? and version > ?", version.send(original_class.versioned_foreign_key), version.version).
Chris@1464 260 first
Chris@1464 261 end
Chris@1464 262
Chris@1464 263 def previous
Chris@1464 264 self.class.before(self)
Chris@1464 265 end
Chris@1464 266
Chris@1464 267 def next
Chris@1464 268 self.class.after(self)
Chris@1464 269 end
Chris@1464 270
Chris@1464 271 def versions_count
Chris@1464 272 page.version
Chris@1464 273 end
Chris@1464 274 end
Chris@1464 275
Chris@1464 276 versioned_class.cattr_accessor :original_class
Chris@1464 277 versioned_class.original_class = self
Chris@1464 278 versioned_class.table_name = versioned_table_name
Chris@1464 279 versioned_class.belongs_to self.to_s.demodulize.underscore.to_sym,
Chris@1464 280 :class_name => "::#{self.to_s}",
Chris@1464 281 :foreign_key => versioned_foreign_key
Chris@1464 282 versioned_class.send :include, options[:extend] if options[:extend].is_a?(Module)
Chris@1464 283 versioned_class.set_sequence_name version_sequence_name if version_sequence_name
Chris@1464 284 end
Chris@1464 285 end
Chris@1464 286
Chris@1464 287 module ActMethods
Chris@1464 288 def self.included(base) # :nodoc:
Chris@1464 289 base.extend ClassMethods
Chris@1464 290 end
Chris@1464 291
Chris@1464 292 # Finds a specific version of this record
Chris@1464 293 def find_version(version = nil)
Chris@1464 294 self.class.find_version(id, version)
Chris@1464 295 end
Chris@1464 296
Chris@1464 297 # Saves a version of the model if applicable
Chris@1464 298 def save_version
Chris@1464 299 save_version_on_create if save_version?
Chris@1464 300 end
Chris@1464 301
Chris@1464 302 # Saves a version of the model in the versioned table. This is called in the after_save callback by default
Chris@1464 303 def save_version_on_create
Chris@1464 304 rev = self.class.versioned_class.new
Chris@1464 305 self.clone_versioned_model(self, rev)
Chris@1464 306 rev.version = send(self.class.version_column)
Chris@1464 307 rev.send("#{self.class.versioned_foreign_key}=", self.id)
Chris@1464 308 rev.save
Chris@1464 309 end
Chris@1464 310
Chris@1464 311 # Clears old revisions if a limit is set with the :limit option in <tt>acts_as_versioned</tt>.
Chris@1464 312 # Override this method to set your own criteria for clearing old versions.
Chris@1464 313 def clear_old_versions
Chris@1464 314 return if self.class.max_version_limit == 0
Chris@1464 315 excess_baggage = send(self.class.version_column).to_i - self.class.max_version_limit
Chris@1464 316 if excess_baggage > 0
Chris@1464 317 sql = "DELETE FROM #{self.class.versioned_table_name} WHERE version <= #{excess_baggage} AND #{self.class.versioned_foreign_key} = #{self.id}"
Chris@1464 318 self.class.versioned_class.connection.execute sql
Chris@1464 319 end
Chris@1464 320 end
Chris@1464 321
Chris@1464 322 def versions_count
Chris@1464 323 version
Chris@1464 324 end
Chris@1464 325
Chris@1464 326 # Reverts a model to a given version. Takes either a version number or an instance of the versioned model
Chris@1464 327 def revert_to(version)
Chris@1464 328 if version.is_a?(self.class.versioned_class)
Chris@1464 329 return false unless version.send(self.class.versioned_foreign_key) == self.id and !version.new_record?
Chris@1464 330 else
Chris@1464 331 return false unless version = versions.find_by_version(version)
Chris@1464 332 end
Chris@1464 333 self.clone_versioned_model(version, self)
Chris@1464 334 self.send("#{self.class.version_column}=", version.version)
Chris@1464 335 true
Chris@1464 336 end
Chris@1464 337
Chris@1464 338 # Reverts a model to a given version and saves the model.
Chris@1464 339 # Takes either a version number or an instance of the versioned model
Chris@1464 340 def revert_to!(version)
Chris@1464 341 revert_to(version) ? save_without_revision : false
Chris@1464 342 end
Chris@1464 343
Chris@1464 344 # Temporarily turns off Optimistic Locking while saving. Used when reverting so that a new version is not created.
Chris@1464 345 def save_without_revision
Chris@1464 346 save_without_revision!
Chris@1464 347 true
Chris@1464 348 rescue
Chris@1464 349 false
Chris@1464 350 end
Chris@1464 351
Chris@1464 352 def save_without_revision!
Chris@1464 353 without_locking do
Chris@1464 354 without_revision do
Chris@1464 355 save!
Chris@1464 356 end
Chris@1464 357 end
Chris@1464 358 end
Chris@1464 359
Chris@1464 360 # Returns an array of attribute keys that are versioned. See non_versioned_columns
Chris@1464 361 def versioned_attributes
Chris@1464 362 self.attributes.keys.select { |k| !self.class.non_versioned_columns.include?(k) }
Chris@1464 363 end
Chris@1464 364
Chris@1464 365 # If called with no parameters, gets whether the current model has changed and needs to be versioned.
Chris@1464 366 # If called with a single parameter, gets whether the parameter has changed.
Chris@1464 367 def changed?(attr_name = nil)
Chris@1464 368 attr_name.nil? ?
Chris@1464 369 (!self.class.track_altered_attributes || (altered_attributes && altered_attributes.length > 0)) :
Chris@1464 370 (altered_attributes && altered_attributes.include?(attr_name.to_s))
Chris@1464 371 end
Chris@1464 372
Chris@1464 373 # keep old dirty? method
Chris@1464 374 alias_method :dirty?, :changed?
Chris@1464 375
Chris@1464 376 # Clones a model. Used when saving a new version or reverting a model's version.
Chris@1464 377 def clone_versioned_model(orig_model, new_model)
Chris@1464 378 self.versioned_attributes.each do |key|
Chris@1464 379 new_model.send("#{key}=", orig_model.send(key)) if orig_model.respond_to?(key)
Chris@1464 380 end
Chris@1464 381
Chris@1464 382 if self.class.columns_hash.include?(self.class.inheritance_column)
Chris@1464 383 if orig_model.is_a?(self.class.versioned_class)
Chris@1464 384 new_model[new_model.class.inheritance_column] = orig_model[self.class.versioned_inheritance_column]
Chris@1464 385 elsif new_model.is_a?(self.class.versioned_class)
Chris@1464 386 new_model[self.class.versioned_inheritance_column] = orig_model[orig_model.class.inheritance_column]
Chris@1464 387 end
Chris@1464 388 end
Chris@1464 389 end
Chris@1464 390
Chris@1464 391 # Checks whether a new version shall be saved or not. Calls <tt>version_condition_met?</tt> and <tt>changed?</tt>.
Chris@1464 392 def save_version?
Chris@1464 393 version_condition_met? && changed?
Chris@1464 394 end
Chris@1464 395
Chris@1464 396 # Checks condition set in the :if option to check whether a revision should be created or not. Override this for
Chris@1464 397 # custom version condition checking.
Chris@1464 398 def version_condition_met?
Chris@1464 399 case
Chris@1464 400 when version_condition.is_a?(Symbol)
Chris@1464 401 send(version_condition)
Chris@1464 402 when version_condition.respond_to?(:call) && (version_condition.arity == 1 || version_condition.arity == -1)
Chris@1464 403 version_condition.call(self)
Chris@1464 404 else
Chris@1464 405 version_condition
Chris@1464 406 end
Chris@1464 407 end
Chris@1464 408
Chris@1464 409 # Executes the block with the versioning callbacks disabled.
Chris@1464 410 #
Chris@1464 411 # @foo.without_revision do
Chris@1464 412 # @foo.save
Chris@1464 413 # end
Chris@1464 414 #
Chris@1464 415 def without_revision(&block)
Chris@1464 416 self.class.without_revision(&block)
Chris@1464 417 end
Chris@1464 418
Chris@1464 419 # Turns off optimistic locking for the duration of the block
Chris@1464 420 #
Chris@1464 421 # @foo.without_locking do
Chris@1464 422 # @foo.save
Chris@1464 423 # end
Chris@1464 424 #
Chris@1464 425 def without_locking(&block)
Chris@1464 426 self.class.without_locking(&block)
Chris@1464 427 end
Chris@1464 428
Chris@1464 429 def empty_callback() end #:nodoc:
Chris@1464 430
Chris@1464 431 protected
Chris@1464 432 # sets the new version before saving, unless you're using optimistic locking. In that case, let it take care of the version.
Chris@1464 433 def set_new_version
Chris@1464 434 self.send("#{self.class.version_column}=", self.next_version) if new_record? || (!locking_enabled? && save_version?)
Chris@1464 435 end
Chris@1464 436
Chris@1464 437 # Gets the next available version for the current record, or 1 for a new record
Chris@1464 438 def next_version
Chris@1464 439 return 1 if new_record?
Chris@1464 440 (versions.maximum('version') || 0) + 1
Chris@1464 441 end
Chris@1464 442
Chris@1464 443 # clears current changed attributes. Called after save.
Chris@1464 444 def clear_altered_attributes
Chris@1464 445 self.altered_attributes = []
Chris@1464 446 end
Chris@1464 447
Chris@1464 448 def write_changed_attribute(attr_name, attr_value)
Chris@1464 449 # Convert to db type for comparison. Avoids failing Float<=>String comparisons.
Chris@1464 450 attr_value_for_db = self.class.columns_hash[attr_name.to_s].type_cast(attr_value)
Chris@1464 451 (self.altered_attributes ||= []) << attr_name.to_s unless self.changed?(attr_name) || self.send(attr_name) == attr_value_for_db
Chris@1464 452 write_attribute(attr_name, attr_value_for_db)
Chris@1464 453 end
Chris@1464 454
Chris@1464 455 module ClassMethods
Chris@1464 456 # Finds a specific version of a specific row of this model
Chris@1464 457 def find_version(id, version = nil)
Chris@1464 458 return find(id) unless version
Chris@1464 459
Chris@1464 460 conditions = ["#{versioned_foreign_key} = ? AND version = ?", id, version]
Chris@1464 461 options = { :conditions => conditions, :limit => 1 }
Chris@1464 462
Chris@1464 463 if result = find_versions(id, options).first
Chris@1464 464 result
Chris@1464 465 else
Chris@1464 466 raise RecordNotFound, "Couldn't find #{name} with ID=#{id} and VERSION=#{version}"
Chris@1464 467 end
Chris@1464 468 end
Chris@1464 469
Chris@1464 470 # Finds versions of a specific model. Takes an options hash like <tt>find</tt>
Chris@1464 471 def find_versions(id, options = {})
Chris@1464 472 versioned_class.all({
Chris@1464 473 :conditions => ["#{versioned_foreign_key} = ?", id],
Chris@1464 474 :order => 'version' }.merge(options))
Chris@1464 475 end
Chris@1464 476
Chris@1464 477 # Returns an array of columns that are versioned. See non_versioned_columns
Chris@1464 478 def versioned_columns
Chris@1464 479 self.columns.select { |c| !non_versioned_columns.include?(c.name) }
Chris@1464 480 end
Chris@1464 481
Chris@1464 482 # Returns an instance of the dynamic versioned model
Chris@1464 483 def versioned_class
Chris@1464 484 const_get versioned_class_name
Chris@1464 485 end
Chris@1464 486
Chris@1464 487 # Rake migration task to create the versioned table using options passed to acts_as_versioned
Chris@1464 488 def create_versioned_table(create_table_options = {})
Chris@1464 489 # create version column in main table if it does not exist
Chris@1464 490 if !self.content_columns.find { |c| %w(version lock_version).include? c.name }
Chris@1464 491 self.connection.add_column table_name, :version, :integer
Chris@1464 492 end
Chris@1464 493
Chris@1464 494 self.connection.create_table(versioned_table_name, create_table_options) do |t|
Chris@1464 495 t.column versioned_foreign_key, :integer
Chris@1464 496 t.column :version, :integer
Chris@1464 497 end
Chris@1464 498
Chris@1464 499 updated_col = nil
Chris@1464 500 self.versioned_columns.each do |col|
Chris@1464 501 updated_col = col if !updated_col && %(updated_at updated_on).include?(col.name)
Chris@1464 502 self.connection.add_column versioned_table_name, col.name, col.type,
Chris@1464 503 :limit => col.limit,
Chris@1464 504 :default => col.default,
Chris@1464 505 :scale => col.scale,
Chris@1464 506 :precision => col.precision
Chris@1464 507 end
Chris@1464 508
Chris@1464 509 if type_col = self.columns_hash[inheritance_column]
Chris@1464 510 self.connection.add_column versioned_table_name, versioned_inheritance_column, type_col.type,
Chris@1464 511 :limit => type_col.limit,
Chris@1464 512 :default => type_col.default,
Chris@1464 513 :scale => type_col.scale,
Chris@1464 514 :precision => type_col.precision
Chris@1464 515 end
Chris@1464 516
Chris@1464 517 if updated_col.nil?
Chris@1464 518 self.connection.add_column versioned_table_name, :updated_at, :timestamp
Chris@1464 519 end
Chris@1464 520 end
Chris@1464 521
Chris@1464 522 # Rake migration task to drop the versioned table
Chris@1464 523 def drop_versioned_table
Chris@1464 524 self.connection.drop_table versioned_table_name
Chris@1464 525 end
Chris@1464 526
Chris@1464 527 # Executes the block with the versioning callbacks disabled.
Chris@1464 528 #
Chris@1464 529 # Foo.without_revision do
Chris@1464 530 # @foo.save
Chris@1464 531 # end
Chris@1464 532 #
Chris@1464 533 def without_revision(&block)
Chris@1464 534 class_eval do
Chris@1464 535 CALLBACKS.each do |attr_name|
Chris@1464 536 alias_method "orig_#{attr_name}".to_sym, attr_name
Chris@1464 537 alias_method attr_name, :empty_callback
Chris@1464 538 end
Chris@1464 539 end
Chris@1464 540 block.call
Chris@1464 541 ensure
Chris@1464 542 class_eval do
Chris@1464 543 CALLBACKS.each do |attr_name|
Chris@1464 544 alias_method attr_name, "orig_#{attr_name}".to_sym
Chris@1464 545 end
Chris@1464 546 end
Chris@1464 547 end
Chris@1464 548
Chris@1464 549 # Turns off optimistic locking for the duration of the block
Chris@1464 550 #
Chris@1464 551 # Foo.without_locking do
Chris@1464 552 # @foo.save
Chris@1464 553 # end
Chris@1464 554 #
Chris@1464 555 def without_locking(&block)
Chris@1464 556 current = ActiveRecord::Base.lock_optimistically
Chris@1464 557 ActiveRecord::Base.lock_optimistically = false if current
Chris@1464 558 result = block.call
Chris@1464 559 ActiveRecord::Base.lock_optimistically = true if current
Chris@1464 560 result
Chris@1464 561 end
Chris@1464 562 end
Chris@1464 563 end
Chris@1464 564 end
Chris@1464 565 end
Chris@1464 566 end
Chris@1464 567
Chris@1464 568 ActiveRecord::Base.send :include, ActiveRecord::Acts::Versioned