acts_as_versioned 0.1.2

data/CHANGELOG

@@ -0,0 +1,11 @@
+*0.1.2*
+
+* check if module is already included when acts_as_versioned is called
+
+*0.1.1*
+
+* Adding tests and rdocs
+
+*0.1* 
+
+* Initial transfer from Rails ticket: http://dev.rubyonrails.com/ticket/1974

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2005 Rick Olson
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,19 @@
+= acts_as_versioned
+
+This library adds simple versioning to an ActiveRecord module.  ActiveRecord is required.
+
+== Download
+
+Gem installation:
+
+  gem install acts_as_versioned --source=http://techno-weenie.net/code
+  
+Get a gzipped tar at http://techno-weenie.net/code/pkg
+
+== Usage
+
+RDocs are online at http://techno-weenie.net/code/doc/acts_as_versioned/.  Start with the 
+ActiveRecord::Acts::Versioned module.
+
+Special thanks to Dreamer on ##rubyonrails for help in early testing.  His ServerSideWiki (http://serversidewiki.com) 
+was the first project to use acts_as_versioned <em>in the wild</em>.

data/RUNNING_UNIT_TESTS

@@ -0,0 +1,41 @@
+== Creating the test database
+
+The default name for the test databases is "activerecord_versioned". If you 
+want to use another database name then be sure to update the connection 
+adapter setups you want to test with in test/connections/<your database>/connection.rb. 
+When you have the database online, you can import the fixture tables with 
+the test/fixtures/db_definitions/*.sql files.
+
+Make sure that you create database objects with the same user that you specified in i
+connection.rb otherwise (on Postgres, at least) tests for default values will fail.
+
+== Running with Rake
+
+The easiest way to run the unit tests is through Rake. The default task runs
+the entire test suite for all the adapters. You can also run the suite on just
+one adapter by using the tasks test_mysql_ruby, test_ruby_mysql, test_sqlite, 
+or test_postresql. For more information, checkout the full array of rake tasks with "rake -T"
+
+Rake can be found at http://rake.rubyforge.org
+
+== Running by hand
+
+Unit tests are located in test directory. If you only want to run a single test suite, 
+or don't want to bother with Rake, you can do so with something like:
+
+   cd test; ruby -I "connections/native_mysql" base_test.rb
+   
+That'll run the base suite using the MySQL-Ruby adapter. Change the adapter
+and test suite name as needed.
+
+== Faster tests
+
+If you are using a database that supports transactions, you can set the
+"AR_TX_FIXTURES" environment variable to "yes" to use transactional fixtures.
+This gives a very large speed boost. With rake:
+
+  rake AR_TX_FIXTURES=yes
+
+Or, by hand:
+
+  AR_TX_FIXTURES=yes ruby -I connections/native_sqlite3 base_test.rb

data/lib/acts_as_versioned.rb

@@ -0,0 +1,373 @@
+# Copyright (c) 2005 Rick Olson
+# 
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+module ActiveRecord #:nodoc:
+  module Acts #:nodoc:
+    # Specify this act if you want to save a copy of the row in a versioned table.  This assumes there is a 
+    # versioned table ready and that your model has a version field.  This works with optimisic locking if the lock_version
+    # column is present as well.
+    #
+    #   class Page < ActiveRecord::Base
+    #     # assumes pages_versions table
+    #     acts_as_versioned
+    #   end
+    #
+    # Example:
+    #
+    #   page = Page.create(:title => 'hello world!')
+    #   page.version       # => 1
+    #
+    #   page.title = 'hello world'
+    #   page.save
+    #   page.version       # => 2
+    #   page.versions.size # => 2
+    #
+    #   page.revert_to(1)  # using version number
+    #   page.title         # => 'hello world!'
+    #
+    #   page.revert_to(page.versions.last) # using versioned instance
+    #   page.title         # => 'hello world'
+    #
+    # See ActiveRecord::Acts::Versioned::ClassMethods#acts_as_versioned for configuration options
+    module Versioned
+      def self.included(base) # :nodoc:
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+        # == Configuration options
+        #
+        # * <tt>class_name</tt> - versioned model class name (default: PageVersion in the above example)
+        # * <tt>table_name</tt> - versioned model table name (default: page_versions in the above example)
+        # * <tt>foreign_key</tt> - foreign key used to relate the versioned model to the original model (default: page_id in the above example)
+        # * <tt>inheritance_column</tt> - name of the column to save the model's inheritance_column value for STI.  (default: versioned_type)
+        # * <tt>version_column</tt> - name of the column in the model that keeps the version number (default: version)
+        # * <tt>limit</tt> - number of revisions to keep, defaults to unlimited
+        # * <tt>if</tt> - symbol of method to check before saving a new version.  If this method returns false, a new version is not saved.
+        #   For finer control, pass either a Proc or modify Model#version_condition_met?
+        #
+        #     acts_as_versioned :if => Proc.new { |auction| !auction.expired? }
+        #
+        #   or...
+        #
+        #     class Auction
+        #       def version_condition_met? # totally bypasses the <tt>:if</tt> option
+        #         !expired?
+        #       end
+        #     end
+        #
+        # * <tt>if_changed</tt> - Simple way of specifying attributes that are required to be changed before saving a model.  This takes
+        #   either a symbol or array of symbols.
+        #
+        # == Database Schema
+        #
+        # The model that you're versioning needs to have a 'version' attribute. The model is versioned 
+        # into a table called #{model}_versions where the model name is singlular. The _versions table should 
+        # contain all the fields you want versioned, the same version column, and a #{model}_id foreign key field.
+        #
+        # A lock_version field is also accepted if your model uses Optimistic Locking.  If your table uses Single Table inheritance,
+        # then that field is reflected in the versioned model as 'versioned_type' by default.
+        #
+        # Acts_as_versioned comes prepared with the ActiveRecord::Acts::Versioned::ActMethods::ClassMethods#create_versioned_table 
+        # method, perfect for a migration.  It will also create the version column if the main model does not already have it.
+        #
+        #   class AddVersions < ActiveRecord::Migration
+        #     def self.up
+        #       # create_versioned_table takes the same options hash
+        #       # that create_table does
+        #       Post.create_versioned_table
+        #     end
+        #   
+        #     def self.down
+        #       Post.drop_versioned_table
+        #     end
+        #   end
+        def acts_as_versioned(options = {})
+          # don't allow multiple calls
+          return if self.included_modules.include?(ActiveRecord::Acts::Versioned::ActMethods)
+
+          class_eval do
+            include ActiveRecord::Acts::Versioned::ActMethods
+            cattr_accessor :versioned_class_name, :versioned_foreign_key, :versioned_table_name, :versioned_inheritance_column, 
+              :version_column, :max_version_limit, :track_changed_attributes, :version_condition
+            attr_accessor :changed_attributes
+          end
+          
+          self.versioned_class_name = options[:class_name] || "#{self.to_s.demodulize}Version"
+          self.versioned_foreign_key = options[:foreign_key] || self.to_s.foreign_key
+          self.versioned_table_name = options[:table_name] || "#{table_name_prefix}#{Inflector.underscore(Inflector.demodulize(class_name_of_active_record_descendant(self)))}_versions#{table_name_suffix}"            
+          self.versioned_inheritance_column = options[:inheritance_column] || "versioned_#{inheritance_column}"
+          self.version_column = options[:version_column] || 'version'
+          self.max_version_limit = options[:limit].to_i
+          self.version_condition = options[:if] || true
+
+          class_eval do
+            has_many :versions, 
+              :class_name  => "ActiveRecord::Acts::Versioned::#{versioned_class_name}",
+              :foreign_key => "#{versioned_foreign_key}",
+              :order       => 'version'
+            before_save  :set_new_version
+            after_create :save_version_on_create
+            after_update :save_version
+            after_save   :clear_old_versions
+            after_save   :clear_changed_attributes
+            
+            unless options[:if_changed].nil?
+              self.track_changed_attributes = true
+              options[:if_changed] = [options[:if_changed]] unless options[:if_changed].is_a?(Array)
+              options[:if_changed].each do |attr_name|
+                define_method("#{attr_name}=") do |value|
+                  (self.changed_attributes ||= []) << attr_name.to_s unless self.dirty?(attr_name) or self.send(attr_name) == value
+                  write_attribute(attr_name.to_s, value)
+                end
+              end
+            end
+          end
+          
+          # create the dynamic versioned model
+          eval <<-EOV
+            class ActiveRecord::Acts::Versioned::#{versioned_class_name} < ActiveRecord::Base
+              set_table_name "#{versioned_table_name}"
+              belongs_to :#{self.to_s.demodulize.underscore}, :class_name => "#{self.to_s}"
+            end
+          EOV
+        end
+      end
+    
+      module ActMethods
+        def self.included(base) # :nodoc:
+          base.extend ClassMethods
+        end
+        
+        # Saves a version of the model if applicable
+        def save_version
+          save_version_on_create if save_version?
+        end
+        
+        # Saves a version of the model in the versioned table.  This is called in the after_save callback by default
+        def save_version_on_create
+          rev = self.class.versioned_class.new
+          self.clone_versioned_model(self, rev)
+          rev.version = send(self.class.version_column)
+          rev.send("#{self.class.versioned_foreign_key}=", self.id)
+          rev.save
+        end
+
+        # Clears old revisions if a limit is set with the :limit option in <tt>acts_as_versioned</tt>.
+        # Override this method to set your own criteria for clearing old versions.
+        def clear_old_versions
+          return if self.class.max_version_limit.blank?
+          excess_baggage = send(self.class.version_column).to_i - self.class.max_version_limit
+          if excess_baggage > 0
+            sql = "DELETE FROM #{self.class.versioned_table_name} WHERE version <= #{excess_baggage} AND #{self.class.versioned_foreign_key} = #{self.id}"
+            self.class.versioned_class.connection.execute sql
+          end
+        end
+
+        # Finds a specific version of this model.
+        def find_version(version)
+          return version if version.is_a?(self.class.versioned_class)
+          return nil if version.is_a?(ActiveRecord::Base)
+          find_versions(:conditions => ['version = ?', version], :limit => 1).first
+        end
+        
+        # Finds versions of this model.  Takes an options hash like <tt>find</tt>
+        def find_versions(options = {})
+          versions.find(:all, {:order => 'version'}.merge(options))
+        end
+
+        # Reverts a model to a given version.  Takes either a version number or an instance of the versioned model
+        def revert_to(version)
+          if version.is_a?(self.class.versioned_class)
+            return false unless version.send(self.class.versioned_foreign_key) == self.id and !version.new_record?
+          else
+            return false unless version = find_version(version)
+          end
+          self.clone_versioned_model(version, self)
+          self.send("#{self.class.version_column}=", version.version)
+          true
+        end
+
+        # Reverts a model to a given version and saves the model.  
+        # Takes either a version number or an instance of the versioned model
+        def revert_to!(version)
+          revert_to(version) ? save_without_revision : false
+        end
+
+        # Temporarily turns off Optimistic Locking while saving.  Used when reverting so that a new version is not created.
+        def save_without_revision
+          old_lock_value = ActiveRecord::Base.lock_optimistically
+          ActiveRecord::Base.lock_optimistically = false if old_lock_value
+          disable_acts_as_versioned_callbacks
+          save_result = self.save
+          enable_acts_as_versioned_callbacks
+          ActiveRecord::Base.lock_optimistically = true if old_lock_value
+          save_result
+        end
+      
+        # Returns an array of attribute keys that are versioned.  See non_versioned_fields
+        def versioned_attributes
+          self.attributes.keys.select { |k| !self.class.non_versioned_fields.include?(k) }
+        end
+        
+        # If called with no parameters, gets whether the current model is dirty and needs to be versioned.
+        # If called with a single parameter, gets whether the parameter is currently dirty.
+        def dirty?(attr_name = nil)
+          attr_name.nil? ?
+            (!self.class.track_changed_attributes or (changed_attributes and changed_attributes.length > 0)) :
+            (changed_attributes and changed_attributes.include?(attr_name.to_s))
+        end
+        
+        # Clones a model.  Used when saving a new version or reverting a model's version.
+        def clone_versioned_model(orig_model, new_model)
+          self.versioned_attributes.each do |key|
+            new_model.send("#{key}=", orig_model.attributes[key]) if orig_model.attribute_present?(key)
+          end
+          
+          if orig_model.is_a?(self.class.versioned_class)
+            new_model[new_model.class.inheritance_column] = orig_model[self.class.versioned_inheritance_column]
+          elsif new_model.is_a?(self.class.versioned_class)
+            new_model[self.class.versioned_inheritance_column] = orig_model[orig_model.class.inheritance_column]
+          end
+        end
+        
+        # Checks whether a new version shall be saved or not.  Calls <tt>version_condition_met?</tt> and <tt>dirty?</tt>.
+        def save_version?
+          version_condition_met? and dirty?
+        end
+        
+        # Checks condition set in the :if option to check whether a revision should be created or not.  Override this for
+        # custom version condition checking.
+        def version_condition_met?
+          case
+          when version_condition.is_a?(Symbol)
+            send(version_condition)
+          when version_condition.respond_to?(:call) && (version_condition.arity == 1 || version_condition.arity == -1)
+            version_condition.call(self)
+          else
+            version_condition
+          end          
+        end
+
+        protected
+        # sets the new version before saving, unless you're using optimistic locking.  In that case, let it take care of the version.
+        def set_new_version
+          self.send("#{self.class.version_column}=", self.next_version) if new_record? or (!locking_enabled? and save_version?)
+        end
+        
+        # Gets the next available version for the current record, or 1 for a new record
+        def next_version
+          return 1 if new_record?
+          connection.select_one("SELECT MAX(version)+1 AS next_version FROM #{self.class.versioned_table_name} WHERE #{self.class.versioned_foreign_key} = #{self.id}")['next_version'] || 1
+        end
+        
+        # clears current dirty attributes.  Called after save.
+        def clear_changed_attributes
+          self.changed_attributes = []
+        end
+
+        private
+        unless defined?(ACTS_AS_VERSIONED_CALLBACKS)
+          ACTS_AS_VERSIONED_CALLBACKS =  [:set_new_version, :save_version_on_create, :save_version, :clear_changed_attributes]
+        end
+
+        ACTS_AS_VERSIONED_CALLBACKS.each do |attr_name| 
+          alias_method "orig_#{attr_name}".to_sym, attr_name
+        end
+        
+        def empty_callback() end #:nodoc:
+
+        def enable_acts_as_versioned_callbacks
+          self.class.class_eval do 
+            ACTS_AS_VERSIONED_CALLBACKS.each do |attr_name|
+              alias_method attr_name, "orig_#{attr_name}".to_sym
+            end
+          end
+        end
+
+        def disable_acts_as_versioned_callbacks
+          self.class.class_eval do 
+            ACTS_AS_VERSIONED_CALLBACKS.each do |attr_name| 
+              alias_method attr_name, :empty_callback
+            end
+          end
+        end
+
+        module ClassMethods
+          # Returns an array of columns that are versioned.  See non_versioned_fields
+          def versioned_columns
+            self.columns.select { |c| !non_versioned_fields.include?(c.name) }
+          end
+    
+          # Returns an instance of the dynamic versioned model
+          def versioned_class
+            "ActiveRecord::Acts::Versioned::#{versioned_class_name}".constantize
+          end
+          
+          # An array of fields that are not saved in the versioned table
+          def non_versioned_fields
+            [self.primary_key, inheritance_column, 'version', 'lock_version', versioned_inheritance_column]
+          end
+          
+          # Rake migration task to create the versioned table using options passed to acts_as_versioned
+          def create_versioned_table(create_table_options = {})
+            self.transaction do
+              # create version column in main table if it does not exist
+              if !self.content_columns.find { |c| %w(version lock_version).include? c.name }
+                self.connection.add_column table_name, :version, :integer
+              end
+              
+              self.connection.create_table(versioned_table_name, create_table_options) do |t|
+                t.column versioned_foreign_key, :integer
+                t.column :version, :integer
+              end
+              
+              updated_col = nil
+              self.versioned_columns.each do |col| 
+                updated_col = col if !updated_col and %(updated_at updated_on).include?(col.name)
+                self.connection.add_column versioned_table_name, col.name, col.type, 
+                  :limit => col.limit, 
+                  :default => col.default
+              end
+          
+              if type_col = self.columns_hash[inheritance_column]
+                self.connection.add_column versioned_table_name, versioned_inheritance_column, type_col.type, 
+                  :limit => type_col.limit, 
+                  :default => type_col.default
+              end
+      
+              if updated_col.nil?
+                self.connection.add_column versioned_table_name, :updated_at, :timestamp
+              end
+            end
+          end
+          
+          # Rake migration task to drop the versioned table
+          def drop_versioned_table
+            self.connection.drop_table versioned_table_name
+          end
+        end
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.class_eval { include ActiveRecord::Acts::Versioned }

data/test/abstract_unit.rb

@@ -0,0 +1,25 @@
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'rubygems'
+require 'test/unit'
+require 'active_record'
+require 'active_record/fixtures'
+require 'active_support/binding_of_caller'
+require 'active_support/breakpoint'
+require 'connection'
+require 'acts_as_versioned'
+
+class Test::Unit::TestCase #:nodoc:
+  def create_fixtures(*table_names)
+    if block_given?
+      Fixtures.create_fixtures(File.dirname(__FILE__) + "/fixtures/", table_names) { yield }
+    else
+      Fixtures.create_fixtures(File.dirname(__FILE__) + "/fixtures/", table_names)
+    end
+  end
+end
+
+Test::Unit::TestCase.fixture_path = File.dirname(__FILE__) + "/fixtures/"
+Test::Unit::TestCase.use_instantiated_fixtures = false
+Test::Unit::TestCase.use_transactional_fixtures = (ENV['AR_TX_FIXTURES'] == "yes")
+

data/test/connections/native_db2/connection.rb

@@ -0,0 +1,14 @@
+print "Using native DB2\n"
+require 'logger'
+
+ActiveRecord::Base.logger = Logger.new("debug.log")
+
+db1 = 'arversioned'
+
+ActiveRecord::Base.establish_connection(
+  :adapter  => "db2",
+  :host     => "localhost",
+  :username => "arunit",
+  :password => "arunit",
+  :database => db1
+)

data/test/connections/native_mysql/connection.rb

@@ -0,0 +1,14 @@
+print "Using native MySQL\n"
+require 'logger'
+
+ActiveRecord::Base.logger = Logger.new("debug.log")
+
+db1 = 'activerecord_versioned'
+
+ActiveRecord::Base.establish_connection(
+  :adapter  => "mysql",
+  :host     => "localhost",
+  :username => "rails",
+  :password => "",
+  :database => db1
+)

data/test/connections/native_oci/connection.rb

@@ -0,0 +1,15 @@
+print "Using OCI Oracle\n"
+require 'logger'
+
+ActiveRecord::Base.logger = Logger.new STDOUT
+ActiveRecord::Base.logger.level = Logger::WARN
+
+db1 = 'activerecord_versioned'
+
+ActiveRecord::Base.establish_connection(
+  :adapter  => 'oci',
+  :host     => '',          # can use an oracle SID
+  :username => 'arunit',
+  :password => 'arunit',
+  :database => db1
+)

data/test/connections/native_postgresql/connection.rb

@@ -0,0 +1,14 @@
+print "Using native PostgreSQL\n"
+require 'logger'
+
+ActiveRecord::Base.logger = Logger.new("debug.log")
+
+db1 = 'activerecord_versioned'
+
+ActiveRecord::Base.establish_connection(
+  :adapter  => "postgresql",
+  :host     => nil, 
+  :username => "postgres",
+  :password => "postgres", 
+  :database => db1
+)

data/test/connections/native_sqlite/connection.rb

@@ -0,0 +1,34 @@
+print "Using native SQlite\n"
+require 'logger'
+ActiveRecord::Base.logger = Logger.new("debug.log")
+
+class SqliteError < StandardError
+end
+
+BASE_DIR = File.expand_path(File.dirname(__FILE__) + '/../../fixtures')
+sqlite_test_db  = "#{BASE_DIR}/activerecord_versioned.sqlite"
+
+def make_connection(clazz, db_file, db_definitions_file)
+  unless File.exist?(db_file)
+    puts "SQLite database not found at #{db_file}. Rebuilding it."
+    sqlite_command = %Q{sqlite #{db_file} "create table a (a integer); drop table a;"}
+    puts "Executing '#{sqlite_command}'"
+    raise SqliteError.new("Seems that there is no sqlite executable available") unless system(sqlite_command)
+    clazz.establish_connection(
+        :adapter => "sqlite",
+        :dbfile  => db_file)
+    script = File.read("#{BASE_DIR}/db_definitions/#{db_definitions_file}")
+    # SQLite-Ruby has problems with semi-colon separated commands, so split and execute one at a time
+    script.split(';').each do
+      |command|
+      clazz.connection.execute(command) unless command.strip.empty?
+    end
+  else
+    clazz.establish_connection(
+        :adapter => "sqlite",
+        :dbfile  => db_file)
+  end
+end
+
+make_connection(ActiveRecord::Base, sqlite_test_db, 'sqlite.sql')
+

data/test/connections/native_sqlite3/connection.rb

@@ -0,0 +1,33 @@
+print "Using native SQLite3\n"
+require 'logger'
+ActiveRecord::Base.logger = Logger.new("debug.log")
+
+class SqliteError < StandardError
+end
+
+BASE_DIR = File.expand_path(File.dirname(__FILE__) + '/../../fixtures')
+sqlite_test_db  = "#{BASE_DIR}/activerecord_versioned.sqlite3"
+
+def make_connection(clazz, db_file, db_definitions_file)
+  unless File.exist?(db_file)
+    puts "SQLite3 database not found at #{db_file}. Rebuilding it."
+    sqlite_command = %Q{sqlite3 #{db_file} "create table a (a integer); drop table a;"}
+    puts "Executing '#{sqlite_command}'"
+    raise SqliteError.new("Seems that there is no sqlite3 executable available") unless system(sqlite_command)
+    clazz.establish_connection(
+        :adapter => "sqlite3",
+        :dbfile  => db_file)
+    script = File.read("#{BASE_DIR}/db_definitions/#{db_definitions_file}")
+    # SQLite-Ruby has problems with semi-colon separated commands, so split and execute one at a time
+    script.split(';').each do
+      |command|
+      clazz.connection.execute(command) unless command.strip.empty?
+    end
+  else
+    clazz.establish_connection(
+        :adapter => "sqlite3",
+        :dbfile  => db_file)
+  end
+end
+
+make_connection(ActiveRecord::Base, sqlite_test_db, 'sqlite.sql')

data/test/connections/native_sqlserver/connection.rb

@@ -0,0 +1,14 @@
+print "Using native SQLServer\n"
+require 'logger'
+
+ActiveRecord::Base.logger = Logger.new("debug.log")
+
+db1 = 'activerecord_versioned'
+
+ActiveRecord::Base.establish_connection(
+  :adapter  => "sqlserver",
+  :host     => "localhost",
+  :username => "sa",
+  :password => "",
+  :database => db1
+)

data/test/connections/native_sqlserver_odbc/connection.rb

@@ -0,0 +1,15 @@
+print "Using native SQLServer via ODBC\n"
+require 'logger'
+
+ActiveRecord::Base.logger = Logger.new("debug.log")
+
+dsn1 = 'activerecord_versioned'
+
+ActiveRecord::Base.establish_connection(
+  :adapter  => "sqlserver",
+  :mode     => "ODBC",
+  :host     => "localhost",
+  :username => "sa",
+  :password => "",
+  :dsn => dsn1
+)

data/test/fixtures/db_definitions/mysql.drop.sql

@@ -0,0 +1,4 @@
+DROP TABLE pages;
+DROP TABLE page_versions;
+DROP TABLE locked_pages;
+DROP TABLE locked_pages_revisions;

data/test/fixtures/db_definitions/mysql.sql

@@ -0,0 +1,36 @@
+CREATE TABLE `pages` (
+  `id`         int(11) NOT NULL auto_increment,
+  `version`    int(11) default NULL,
+  `title`      varchar(255) default NULL,
+  `body`       TEXT NOT NULL,
+  `updated_on` datetime default NULL,
+  PRIMARY KEY  (`id`)
+) TYPE=InnoDB;
+
+CREATE TABLE `page_versions` (
+  `id`         int(11) NOT NULL auto_increment,
+  `page_id`    int(11) default NULL,
+  `version`      int(11) default NULL,
+  `title`      varchar(255) default NULL,
+  `body`       TEXT NOT NULL,
+  `updated_on` datetime default NULL,
+  PRIMARY KEY  (`id`)
+) TYPE=InnoDB;
+
+CREATE TABLE `locked_pages` (
+  `id`           int(11) NOT NULL auto_increment,
+  `lock_version` int(11) default NULL,
+  `title`        varchar(255) default NULL,
+  `type`         varchar(255) default NULL,
+  PRIMARY KEY  (`id`)
+) TYPE=InnoDB;
+
+CREATE TABLE `locked_pages_revisions` (
+  `id`           int(11) NOT NULL auto_increment,
+  `page_id`      int(11) default NULL,
+  `version`      int(11) default NULL,
+  `title`        varchar(255) default NULL,
+  `version_type` varchar(255) default NULL,
+  `updated_at`   datetime default NULL,
+  PRIMARY KEY  (`id`)
+) TYPE=InnoDB;

data/test/fixtures/db_definitions/postgresql.drop.sql

@@ -0,0 +1,4 @@
+DROP TABLE pages;
+DROP TABLE page_versions;
+DROP TABLE locked_pages;
+DROP TABLE locked_pages_revisions;

data/test/fixtures/db_definitions/postgresql.sql

@@ -0,0 +1,34 @@
+CREATE TABLE pages (
+  id         SERIAL,
+  version    INTEGER,
+  title      VARCHAR(255),
+  body       TEXT,
+  updated_on TIMESTAMP
+);
+SELECT setval('pages_id_seq', 100);
+
+CREATE TABLE page_versions (
+  id         SERIAL,
+  page_id    INTEGER,
+  version    INTEGER,
+  title      VARCHAR(255),
+  body       TEXT,
+  updated_on TIMESTAMP
+);
+
+CREATE TABLE locked_pages (
+  id           SERIAL,
+  lock_version INTEGER,
+  title        VARCHAR(255),
+  type         VARCHAR(255)
+);
+SELECT setval('pages_id_seq', 100);
+
+CREATE TABLE locked_pages_revisions (
+  id           SERIAL,
+  page_id      INTEGER,
+  version      INTEGER,
+  title        VARCHAR(255),
+  version_type VARCHAR(255),
+  updated_at   TIMESTAMP
+);

data/test/fixtures/db_definitions/sqlite.drop.sql

@@ -0,0 +1,4 @@
+DROP TABLE pages;
+DROP TABLE page_versions;
+DROP TABLE locked_pages;
+DROP TABLE locked_pages_revisions;

data/test/fixtures/db_definitions/sqlite.sql

@@ -0,0 +1,32 @@
+CREATE TABLE 'pages' (
+  'id'         INTEGER NOT NULL PRIMARY KEY,
+  'version'    INTEGER,
+  'title'      VARCHAR(255),
+  'body'       TEXT,
+  'updated_on' DATETIME DEFAULT NULL
+);
+
+CREATE TABLE 'page_versions' (
+  'id'         INTEGER NOT NULL PRIMARY KEY,
+  'page_id'    INTEGER NOT NULL,
+  'version'    INTEGER NOT NULL,
+  'title'      VARCHAR(255),
+  'body'       TEXT DEFAULT NULL,
+  'updated_on' DATETIME DEFAULT NULL
+);
+
+CREATE TABLE 'locked_pages' (
+  'id'           INTEGER NOT NULL PRIMARY KEY,
+  'lock_version' INTEGER NOT NULL,
+  'title'        VARCHAR(255),
+  'type'         VARCHAR(255)
+);
+
+CREATE TABLE 'locked_pages_revisions' (
+  'id'           INTEGER NOT NULL PRIMARY KEY,
+  'page_id'      INTEGER NOT NULL,
+  'version'      INTEGER NOT NULL,
+  'title'        VARCHAR(255),
+  'version_type' VARCHAR(255),
+  'updated_at'   DATETIME DEFAULT NULL
+);

data/test/fixtures/locked_pages.yml

@@ -0,0 +1,10 @@
+welcome:
+  id: 1
+  title: Welcome to the weblog
+  lock_version: 24
+  type: LockedPage
+thinking:
+  id: 2
+  title: So I was thinking
+  lock_version: 24
+  type: SpecialLockedPage

data/test/fixtures/locked_pages_revisions.yml

@@ -0,0 +1,27 @@
+welcome_1:
+  id: 1
+  page_id: 1
+  title: Welcome to the weblg
+  version: 23
+  version_type: LockedPage
+
+welcome_2:
+  id: 2
+  page_id: 1
+  title: Welcome to the weblog
+  version: 24
+  version_type: LockedPage
+
+thinking_1:
+  id: 3
+  page_id: 2
+  title: So I was thinking!!!
+  version: 23
+  version_type: SpecialLockedPage
+
+thinking_2:
+  id: 4
+  page_id: 2
+  title: So I was thinking
+  version: 24
+  version_type: SpecialLockedPage

data/test/fixtures/migrations/1_add_versioned_tables.rb

@@ -0,0 +1,13 @@
+class AddVersionedTables < ActiveRecord::Migration
+  def self.up
+    create_table("things") do |t|
+      t.column :title, :text
+    end
+    Thing.create_versioned_table
+  end
+  
+  def self.down
+    Thing.drop_versioned_table
+    drop_table "things" rescue nil
+  end
+end

data/test/fixtures/page.rb

@@ -0,0 +1,24 @@
+class Page < ActiveRecord::Base
+  cattr_accessor :feeling_good
+  @@feeling_good = true
+  
+  acts_as_versioned :if => :feeling_good?
+    
+  def feeling_good?
+    @@feeling_good == true
+  end
+end
+
+class LockedPage < ActiveRecord::Base
+  acts_as_versioned \
+    :inheritance_column => :version_type, 
+    :foreign_key        => :page_id, 
+    :table_name         => :locked_pages_revisions, 
+    :class_name         => 'LockedPageRevision',
+    :version_column     => :lock_version,
+    :limit              => 2,
+    :if_changed         => :title
+end
+
+class SpecialLockedPage < LockedPage
+end

data/test/fixtures/page_versions.yml

@@ -0,0 +1,12 @@
+welcome_2:
+  id: 1
+  page_id: 1
+  title: Welcome to the weblog
+  body: Such a lovely day
+  version: 24
+welcome_1:
+  id: 2
+  page_id: 1
+  title: Welcome to the weblg
+  body: Such a lovely day
+  version: 23

data/test/fixtures/pages.yml

@@ -0,0 +1,5 @@
+welcome:
+  id: 1
+  title: Welcome to the weblog
+  body: Such a lovely day
+  version: 24

data/test/migration_test.rb

@@ -0,0 +1,29 @@
+require 'abstract_unit'
+
+if ActiveRecord::Base.connection.supports_migrations? 
+  class Thing < ActiveRecord::Base
+    attr_accessor :version
+    acts_as_versioned
+  end
+
+  class MigrationTest < Test::Unit::TestCase
+    def setup
+    end
+
+    def teardown
+      ActiveRecord::Base.connection.initialize_schema_information
+      ActiveRecord::Base.connection.update "UPDATE schema_info SET version = 0"
+
+      Thing.connection.drop_table "things" rescue nil
+      Thing.connection.drop_table "thing_versions" rescue nil
+      Thing.reset_column_information
+    end
+        
+    def test_versioned_migration
+      assert_raises(ActiveRecord::StatementInvalid) { Thing.create :title => 'blah blah' }
+      ActiveRecord::Migrator.up(File.dirname(__FILE__) + '/fixtures/migrations/')
+      t = Thing.create :title => 'blah blah'
+      assert_equal 1, t.versions.size
+    end
+  end
+end

data/test/tests.rb

@@ -0,0 +1,2 @@
+$:.unshift "../lib"
+Dir["**/*_test.rb"].each { |f| load f }

data/test/versioned_test.rb

@@ -0,0 +1,228 @@
+require 'abstract_unit'
+require 'fixtures/page'
+
+class VersionedTest < Test::Unit::TestCase
+  fixtures :pages, :page_versions, :locked_pages, :locked_pages_revisions
+
+  def test_saves_versioned_copy
+    p = Page.create :title => 'first title', :body => 'first body'
+    assert !p.new_record?
+    assert_equal 1, p.versions.size
+    assert_equal 1, p.version
+    assert_instance_of Page.versioned_class, p.versions.first
+  end
+
+  def test_rollback_with_version_number
+    p = pages(:welcome)
+    assert_equal 24, p.version
+    assert_equal 'Welcome to the weblog', p.title
+    
+    assert p.revert_to!(p.versions.first.version), "Couldn't revert to 23"
+    assert_equal 23, p.version
+    assert_equal 'Welcome to the weblg', p.title
+  end
+
+  def test_versioned_class_name
+    assert_equal 'PageVersion', Page.versioned_class_name
+    assert_equal 'LockedPageRevision', LockedPage.versioned_class_name
+  end
+
+  def test_rollback_with_version_class
+    p = pages(:welcome)
+    assert_equal 24, p.version
+    assert_equal 'Welcome to the weblog', p.title
+    
+    assert p.revert_to!(p.versions.first), "Couldn't revert to 23"
+    assert_equal 23, p.version
+    assert_equal 'Welcome to the weblg', p.title
+  end
+  
+  def test_rollback_fails_with_invalid_revision
+    p = locked_pages(:welcome)
+    assert !p.revert_to!(locked_pages(:thinking))
+  end
+
+  def test_saves_versioned_copy_with_options
+    p = LockedPage.create :title => 'first title'
+    assert !p.new_record?
+    assert_equal 1, p.versions.size
+    assert_instance_of LockedPage.versioned_class, p.versions.first
+  end
+  
+  def test_rollback_with_version_number_with_options
+    p = locked_pages(:welcome)
+    assert_equal 'Welcome to the weblog', p.title
+    assert_equal 'LockedPage', p.versions.first.version_type
+    
+    assert p.revert_to!(p.versions.first.version), "Couldn't revert to 23"
+    assert_equal 'Welcome to the weblg', p.title
+    assert_equal 'LockedPage', p.versions.first.version_type
+  end
+  
+  def test_rollback_with_version_class_with_options
+    p = locked_pages(:welcome)
+    assert_equal 'Welcome to the weblog', p.title
+    assert_equal 'LockedPage', p.versions.first.version_type
+    
+    assert p.revert_to!(p.versions.first), "Couldn't revert to 1"
+    assert_equal 'Welcome to the weblg', p.title
+    assert_equal 'LockedPage', p.versions.first.version_type
+  end
+  
+  def test_saves_versioned_copy_with_sti
+    p = SpecialLockedPage.create :title => 'first title'
+    assert !p.new_record?
+    assert_equal 1, p.versions.size
+    assert_instance_of LockedPage.versioned_class, p.versions.first
+    assert_equal 'SpecialLockedPage', p.versions.first.version_type
+  end
+  
+  def test_rollback_with_version_number_with_sti
+    p = locked_pages(:thinking)
+    assert_equal 'So I was thinking', p.title
+    
+    assert p.revert_to!(p.versions.first.version), "Couldn't revert to 1"
+    assert_equal 'So I was thinking!!!', p.title
+    assert_equal 'SpecialLockedPage', p.versions.first.version_type
+  end
+
+  def test_lock_version_works_with_versioning
+    p = locked_pages(:thinking)
+    p2 = LockedPage.find(p.id)
+    
+    p.title = 'fresh title'
+    p.save
+    assert_equal 2, p.versions.size # limit!
+    
+    assert_raises(ActiveRecord::StaleObjectError) do
+      p2.title = 'stale title'
+      p2.save
+    end
+  end
+
+  def test_version_if_condition
+    p = Page.create :title => "title"
+    assert_equal 1, p.version
+    
+    Page.feeling_good = false
+    p.save
+    assert_equal 1, p.version
+    Page.feeling_good = true
+  end
+  
+  def test_version_if_condition2
+    # set new if condition
+    Page.class_eval do
+      def new_feeling_good() title[0..0] == 'a'; end
+      alias_method :old_feeling_good, :feeling_good?
+      alias_method :feeling_good?, :new_feeling_good
+    end
+    
+    p = Page.create :title => "title"
+    assert_equal 1, p.version # version does not increment
+    assert_equal 1, p.versions(true).size
+    
+    p.update_attributes(:title => 'new title')
+    assert_equal 1, p.version # version does not increment
+    assert_equal 1, p.versions(true).size
+    
+    p.update_attributes(:title => 'a title')
+    assert_equal 2, p.version
+    assert_equal 2, p.versions(true).size
+    
+    # reset original if condition
+    Page.class_eval { alias_method :feeling_good?, :old_feeling_good }
+  end
+  
+  def test_version_if_condition_with_block
+    # set new if condition
+    old_condition = Page.version_condition
+    Page.version_condition = Proc.new { |page| page.title[0..0] == 'b' }
+    
+    p = Page.create :title => "title"
+    assert_equal 1, p.version # version does not increment
+    assert_equal 1, p.versions(true).size
+    
+    p.update_attributes(:title => 'a title')
+    assert_equal 1, p.version # version does not increment
+    assert_equal 1, p.versions(true).size
+    
+    p.update_attributes(:title => 'b title')
+    assert_equal 2, p.version
+    assert_equal 2, p.versions(true).size
+    
+    # reset original if condition
+    Page.version_condition = old_condition
+  end
+
+  def test_version_no_limit
+    p = Page.create :title => "title", :body => 'first body'
+    p.save
+    p.save
+    5.times do |i|
+      assert_page_title p, i
+    end
+  end
+
+  def test_version_max_limit
+    p = LockedPage.create :title => "title"
+    p.update_attributes(:title => "title1")
+    p.update_attributes(:title => "title2")
+    5.times do |i|
+      assert_page_title p, i, :lock_version
+      assert p.versions(true).size <= 2, "locked version can only store 2 versions"
+    end
+  end
+  
+  def test_track_changed_attributes_default_value
+    assert !Page.track_changed_attributes
+    assert LockedPage.track_changed_attributes
+    assert SpecialLockedPage.track_changed_attributes
+  end
+  
+  def test_version_order
+    assert_equal 23, pages(:welcome).versions.first.version
+    assert_equal 24, pages(:welcome).versions.last.version
+    assert_equal 23, pages(:welcome).find_versions.first.version
+    assert_equal 24, pages(:welcome).find_versions.last.version
+  end
+  
+  def test_track_changed_attributes    
+    p = LockedPage.create :title => "title"
+    assert_equal 1, p.lock_version
+    assert_equal 1, p.versions(true).size
+    
+    p.title = 'title'
+    assert !p.save_version?
+    p.save
+    assert_equal 2, p.lock_version # still increments version because of optimistic locking
+    assert_equal 1, p.versions(true).size
+    
+    p.title = 'updated title'
+    assert p.save_version?
+    p.save
+    assert_equal 3, p.lock_version
+    assert_equal 1, p.versions(true).size # version 1 deleted
+
+    p.title = 'updated title!'
+    assert p.save_version?
+    p.save
+    assert_equal 4, p.lock_version
+    assert_equal 2, p.versions(true).size # version 1 deleted
+  end
+    
+  def assert_page_title(p, i, version_field = :version)
+    p.title = "title#{i}"
+    p.save
+    assert_equal "title#{i}", p.title
+    assert_equal (i+4), p.send(version_field)
+  end
+  
+  def test_find_versions
+    assert_equal 2, locked_pages(:welcome).versions.size
+    assert_equal 1, locked_pages(:welcome).find_versions(:conditions => ['title LIKE ?', '%weblog%']).length
+    assert_equal 2, locked_pages(:welcome).find_versions(:conditions => ['title LIKE ?', '%web%']).length
+    assert_equal 0, locked_pages(:thinking).find_versions(:conditions => ['title LIKE ?', '%web%']).length
+    assert_equal 2, locked_pages(:welcome).find_versions.length
+  end
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.8.10
+specification_version: 1
+name: acts_as_versioned
+version: !ruby/object:Gem::Version 
+  version: 0.1.2
+date: 2005-09-18
+summary: Simple versioning with active record models
+require_paths: 
+  - lib
+email: technoweenie@gmail.com
+homepage: http://techno-weenie.net
+rubyforge_project: 
+description: 
+autorequire: acts_as_versioned
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+    - 
+      - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+  version: 
+platform: ruby
+authors: 
+  - Rick Olson
+files: 
+  - lib/acts_as_versioned.rb
+  - test/abstract_unit.rb
+  - test/connections
+  - test/fixtures
+  - test/migration_test.rb
+  - test/tests.rb
+  - test/versioned_test.rb
+  - test/connections/native_db2
+  - test/connections/native_mysql
+  - test/connections/native_oci
+  - test/connections/native_postgresql
+  - test/connections/native_sqlite
+  - test/connections/native_sqlite3
+  - test/connections/native_sqlserver
+  - test/connections/native_sqlserver_odbc
+  - test/connections/native_db2/connection.rb
+  - test/connections/native_mysql/connection.rb
+  - test/connections/native_oci/connection.rb
+  - test/connections/native_postgresql/connection.rb
+  - test/connections/native_sqlite/connection.rb
+  - test/connections/native_sqlite3/connection.rb
+  - test/connections/native_sqlserver/connection.rb
+  - test/connections/native_sqlserver_odbc/connection.rb
+  - test/fixtures/activerecord_versioned.sqlite3
+  - test/fixtures/db_definitions
+  - test/fixtures/locked_pages.yml
+  - test/fixtures/locked_pages_revisions.yml
+  - test/fixtures/migrations
+  - test/fixtures/page.rb
+  - test/fixtures/page_versions.yml
+  - test/fixtures/pages.yml
+  - test/fixtures/db_definitions/mysql.drop.sql
+  - test/fixtures/db_definitions/mysql.sql
+  - test/fixtures/db_definitions/postgresql.drop.sql
+  - test/fixtures/db_definitions/postgresql.sql
+  - test/fixtures/db_definitions/sqlite.drop.sql
+  - test/fixtures/db_definitions/sqlite.sql
+  - test/fixtures/migrations/1_add_versioned_tables.rb
+  - README
+  - MIT-LICENSE
+  - CHANGELOG
+  - RUNNING_UNIT_TESTS
+test_files: 
+  - test/tests.rb
+rdoc_options: []
+extra_rdoc_files: []
+executables: []
+extensions: []
+requirements: []
+dependencies: 
+  - !ruby/object:Gem::Dependency 
+    name: activerecord
+    version_requirement: 
+    version_requirements: !ruby/object:Gem::Version::Requirement 
+      requirements: 
+        - 
+          - ">="
+          - !ruby/object:Gem::Version 
+            version: 1.10.1
+      version: 
+  - !ruby/object:Gem::Dependency 
+    name: activesupport
+    version_requirement: 
+    version_requirements: !ruby/object:Gem::Version::Requirement 
+      requirements: 
+        - 
+          - ">="
+          - !ruby/object:Gem::Version 
+            version: 1.1.1
+      version: