acts_as_versioned 0.1.3 → 0.2

data/CHANGELOG

@@ -1,3 +1,14 @@
+*0.2* 
+
+* (6 Oct 2005)  added find_versions and find_version class methods.
+
+* (6 Oct 2005)  removed transaction from create_versioned_table().  
+  this way you can specify your own transaction around a group of operations.
+
+* (30 Sep 2005) fixed bug where find_versions() would order by 'version' twice. (found by Joe Clark)
+
+* (26 Sep 2005) added :sequence_name option to acts_as_versioned to set the sequence name on the versioned model
+
 *0.1.3* (18 Sep 2005)
 
 * First RubyForge release

data/README

@@ -2,19 +2,27 @@
 
 This library adds simple versioning to an ActiveRecord module.  ActiveRecord is required.
 
-== Install
+== Resources
 
-Gem installation:
+Install
 
-  gem install acts_as_versioned
-  
-Download: 
+* gem install acts_as_versioned
 
-  http://rubyforge.org/projects/ar-versioned/
+Rubyforge project
 
-== Documentation
+* http://rubyforge.org/projects/ar-versioned
 
-RDocs are online at http://ar-versioned.rubyforge.org
+RDocs
+
+* http://ar-versioned.rubyforge.org
+
+Subversion
+
+* http://techno-weenie.net/svn/projects/acts_as_versioned
+
+Collaboa
+
+* http://collaboa.techno-weenie.net/repository/browse/acts_as_versioned
 
 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/lib/acts_as_versioned.rb

@@ -60,6 +60,7 @@ module ActiveRecord #:nodoc:
         # * <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>sequence_name</tt> - name of the custom sequence to be used by the versioned model.
         # * <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?
@@ -107,7 +108,7 @@ module ActiveRecord #:nodoc:
           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
+              :version_column, :max_version_limit, :track_changed_attributes, :version_condition, :version_sequence_name
             attr_accessor :changed_attributes
           end
           
@@ -116,6 +117,7 @@ module ActiveRecord #:nodoc:
           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.version_sequence_name = options[:sequence_name]
           self.max_version_limit = options[:limit].to_i
           self.version_condition = options[:if] || true
 
@@ -143,12 +145,16 @@ module ActiveRecord #:nodoc:
           end
           
           # create the dynamic versioned model
-          eval <<-EOV
+          # maybe if i sit down long enough i can think up a better way to do this.
+          dynamic_model = <<-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
+          
+          dynamic_model += %Q{set_sequence_name "#{version_sequence_name}"\n} if version_sequence_name
+          
+          eval dynamic_model + 'end'
         end
       end
     
@@ -191,7 +197,7 @@ module ActiveRecord #:nodoc:
         
         # Finds versions of this model.  Takes an options hash like <tt>find</tt>
         def find_versions(options = {})
-          versions.find(:all, {:order => 'version'}.merge(options))
+          versions.find(:all, options)
         end
 
         # Reverts a model to a given version.  Takes either a version number or an instance of the versioned model
@@ -312,6 +318,20 @@ module ActiveRecord #:nodoc:
         end
 
         module ClassMethods
+          # Finds a specific version of a specific row of this model
+          def find_version(id, version)
+            find_versions(id, 
+              :conditions => ["#{versioned_foreign_key} = ? AND version = ?", id, version], 
+              :limit => 1).first
+          end
+        
+          # Finds versions of a specific model.  Takes an options hash like <tt>find</tt>
+          def find_versions(id, options = {})
+            versioned_class.find :all, {
+              :conditions => ["#{versioned_foreign_key} = ?", id],
+              :order      => 'version' }.merge(options)
+          end
+        
           # 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) }
@@ -329,34 +349,32 @@ module ActiveRecord #:nodoc:
           
           # 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
+            # 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
           

data/test/debug.log

@@ -0,0 +1,99 @@
+# Logfile created on Thu Sep 29 08:57:24 CDT 2005 by logger.rb/1.5.2.4
+  SQL (0.001227)   PRAGMA table_info(locked_pages)
+  SQL (0.000842)   INSERT INTO locked_pages ('title', 'lock_version', 'type') VALUES('title', 1, NULL)
+  SQL (0.001495)   PRAGMA table_info(locked_pages_revisions)
+  SQL (0.001511)   INSERT INTO locked_pages_revisions ('updated_at', 'version_type', 'title', 'page_id', 'version') VALUES('2005-09-29 08:57:25', NULL, 'title', 3, 1)
+  ActiveRecord::Acts::Versioned::LockedPageRevision Load (0.001209)   SELECT * FROM locked_pages_revisions WHERE locked_pages_revisions.page_id = 3 ORDER BY version 
+  LockedPage Update with optimistic locking (0.002959)    UPDATE locked_pages
+ SET 'title' = 'title', 'type' = NULL, 'lock_version' = 2
+ WHERE id = 3 AND lock_version = 1
+
+  ActiveRecord::Acts::Versioned::LockedPageRevision Load (0.001171)   SELECT * FROM locked_pages_revisions WHERE locked_pages_revisions.page_id = 3 ORDER BY version 
+  LockedPage Update with optimistic locking (0.001465)    UPDATE locked_pages
+ SET 'title' = 'updated title', 'type' = NULL, 'lock_version' = 3
+ WHERE id = 3 AND lock_version = 2
+
+  SQL (0.001484)   INSERT INTO locked_pages_revisions ('updated_at', 'version_type', 'title', 'page_id', 'version') VALUES('2005-09-29 08:57:25', NULL, 'updated title', 3, 3)
+  SQL (0.000553)   DELETE FROM locked_pages_revisions WHERE version <= 1 AND page_id = 3
+  ActiveRecord::Acts::Versioned::LockedPageRevision Load (0.001214)   SELECT * FROM locked_pages_revisions WHERE locked_pages_revisions.page_id = 3 ORDER BY version 
+  LockedPage Update with optimistic locking (0.001613)    UPDATE locked_pages
+ SET 'title' = 'updated title!', 'type' = NULL, 'lock_version' = 4
+ WHERE id = 3 AND lock_version = 3
+
+  SQL (0.001447)   INSERT INTO locked_pages_revisions ('updated_at', 'version_type', 'title', 'page_id', 'version') VALUES('2005-09-29 08:57:25', NULL, 'updated title!', 3, 4)
+  SQL (0.000522)   DELETE FROM locked_pages_revisions WHERE version <= 2 AND page_id = 3
+  ActiveRecord::Acts::Versioned::LockedPageRevision Load (0.001439)   SELECT * FROM locked_pages_revisions WHERE locked_pages_revisions.page_id = 3 ORDER BY version 
+  SQL (0.001207)   PRAGMA table_info(locked_pages)
+  SQL (0.000549)   INSERT INTO locked_pages ('title', 'lock_version', 'type') VALUES('title', 1, NULL)
+  SQL (0.001507)   PRAGMA table_info(locked_pages_revisions)
+  SQL (0.001516)   INSERT INTO locked_pages_revisions ('updated_at', 'version_type', 'title', 'page_id', 'version') VALUES('2005-09-29 09:02:00', NULL, 'title', 3, 1)
+  ActiveRecord::Acts::Versioned::LockedPageRevision Load (0.001315)   SELECT * FROM locked_pages_revisions WHERE locked_pages_revisions.page_id = 3 ORDER BY version 
+  LockedPage Update with optimistic locking (0.001660)    UPDATE locked_pages
+ SET 'title' = 'title', 'type' = NULL, 'lock_version' = 2
+ WHERE id = 3 AND lock_version = 1
+
+  ActiveRecord::Acts::Versioned::LockedPageRevision Load (0.001203)   SELECT * FROM locked_pages_revisions WHERE locked_pages_revisions.page_id = 3 ORDER BY version 
+  LockedPage Update with optimistic locking (0.003941)    UPDATE locked_pages
+ SET 'title' = 'updated title', 'type' = NULL, 'lock_version' = 3
+ WHERE id = 3 AND lock_version = 2
+
+  SQL (0.001514)   INSERT INTO locked_pages_revisions ('updated_at', 'version_type', 'title', 'page_id', 'version') VALUES('2005-09-29 09:02:12', NULL, 'updated title', 3, 3)
+  SQL (0.000591)   DELETE FROM locked_pages_revisions WHERE version <= 1 AND page_id = 3
+  LockedPage Update with optimistic locking (0.001470)    UPDATE locked_pages
+ SET 'title' = 'updated title', 'type' = NULL, 'lock_version' = 4
+ WHERE id = 3 AND lock_version = 3
+
+  SQL (0.000550)   DELETE FROM locked_pages_revisions WHERE version <= 2 AND page_id = 3
+  LockedPage Load (0.001156)   SELECT * FROM locked_pages WHERE locked_pages.id = 1 LIMIT 1
+  SQL (0.001285)   PRAGMA table_info(locked_pages)
+  ActiveRecord::Acts::Versioned::LockedPageRevision Count (0.001063)   SELECT COUNT(*) FROM locked_pages_revisions WHERE locked_pages_revisions.page_id = 1 
+  ActiveRecord::Acts::Versioned::LockedPageRevision Load (0.001321)   SELECT * FROM locked_pages_revisions WHERE locked_pages_revisions.page_id = 1 AND (title LIKE '%weblog%') ORDER BY version, version 
+  ActiveRecord::Acts::Versioned::LockedPageRevision Load (0.001450)   SELECT * FROM locked_pages_revisions WHERE locked_pages_revisions.page_id = 1 AND (title LIKE '%web%') ORDER BY version, version 
+  LockedPage Load (0.001090)   SELECT * FROM locked_pages WHERE locked_pages.id = 2 LIMIT 1
+  SQL (0.001236)   PRAGMA table_info(locked_pages)
+  ActiveRecord::Acts::Versioned::LockedPageRevision Load (0.000906)   SELECT * FROM locked_pages_revisions WHERE locked_pages_revisions.page_id = 2 AND (title LIKE '%web%') ORDER BY version, version 
+  ActiveRecord::Acts::Versioned::LockedPageRevision Load (0.001316)   SELECT * FROM locked_pages_revisions WHERE locked_pages_revisions.page_id = 1 ORDER BY version, version 
+  LockedPage Load (0.001179)   SELECT * FROM locked_pages WHERE locked_pages.id = 2 LIMIT 1
+  LockedPage Load (0.001558)   SELECT * FROM locked_pages WHERE locked_pages.id = 2 LIMIT 1
+  SpecialLockedPage Update with optimistic locking (0.001752)    UPDATE locked_pages
+ SET 'title' = 'fresh title', 'type' = 'SpecialLockedPage', 'lock_version' = 25
+ WHERE id = 2 AND lock_version = 24
+
+  SQL (0.001611)   PRAGMA table_info(locked_pages_revisions)
+  SQL (0.001602)   INSERT INTO locked_pages_revisions ('updated_at', 'version_type', 'title', 'page_id', 'version') VALUES('2005-09-30 12:06:35', 'SpecialLockedPage', 'fresh title', 2, 25)
+  SQL (0.000741)   DELETE FROM locked_pages_revisions WHERE version <= 23 AND page_id = 2
+  ActiveRecord::Acts::Versioned::LockedPageRevision Count (0.001129)   SELECT COUNT(*) FROM locked_pages_revisions WHERE locked_pages_revisions.page_id = 2 
+  SpecialLockedPage Update with optimistic locking (0.001867)    UPDATE locked_pages
+ SET 'title' = 'stale title', 'type' = 'SpecialLockedPage', 'lock_version' = 25
+ WHERE id = 2 AND lock_version = 24
+
+  LockedPage Load (0.001088)   SELECT * FROM locked_pages WHERE locked_pages.id = 1 LIMIT 1
+  LockedPage Load (0.001127)   SELECT * FROM locked_pages WHERE locked_pages.id = 2 LIMIT 1
+  LockedPage Load (0.003112)   SELECT * FROM locked_pages WHERE locked_pages.id = 1 LIMIT 1
+  LockedPage Load (0.001110)   SELECT * FROM locked_pages WHERE locked_pages.id = 2 LIMIT 1
+  SQL (0.001694)   PRAGMA table_info(locked_pages)
+  LockedPage Load (0.001492)   SELECT * FROM locked_pages WHERE locked_pages.id = 1 LIMIT 1
+  LockedPage Load (0.001084)   SELECT * FROM locked_pages WHERE locked_pages.id = 2 LIMIT 1
+  SQL (0.001457)   PRAGMA table_info(locked_pages)
+  ActiveRecord::Acts::Versioned::LockedPageRevision Load (0.001049)   SELECT * FROM locked_pages_revisions WHERE locked_pages_revisions.page_id = 1 AND (version = NULL) ORDER BY version, version LIMIT 1
+  ActiveRecord::Acts::Versioned::LockedPageRevision Load (0.035705)   SELECT * FROM locked_pages_revisions WHERE locked_pages_revisions.page_id = 1 AND (version = NULL) ORDER BY version, version LIMIT 1
+  ActiveRecord::Acts::Versioned::LockedPageRevision Load (0.000930)   SELECT * FROM locked_pages_revisions WHERE locked_pages_revisions.page_id = 1 AND (version = NULL) ORDER BY version, version LIMIT 1
+  LockedPage Load (0.001490)   SELECT * FROM locked_pages WHERE locked_pages.id = 1 LIMIT 1
+  LockedPage Load (0.001195)   SELECT * FROM locked_pages WHERE locked_pages.id = 2 LIMIT 1
+  SQL (0.001632)   PRAGMA table_info(locked_pages)
+  ActiveRecord::Acts::Versioned::LockedPageRevision Load (0.001005)   SELECT * FROM locked_pages_revisions WHERE locked_pages_revisions.page_id = 1 AND (version = NULL) ORDER BY version, version LIMIT 1
+  LockedPage Load (0.001169)   SELECT * FROM locked_pages WHERE locked_pages.id = 1 LIMIT 1
+  LockedPage Load (0.001370)   SELECT * FROM locked_pages WHERE locked_pages.id = 2 LIMIT 1
+  SQL (0.005599)   PRAGMA table_info(locked_pages)
+  ActiveRecord::Acts::Versioned::LockedPageRevision Load (0.001175)   SELECT * FROM locked_pages_revisions WHERE locked_pages_revisions.page_id = 1 AND (version = NULL) ORDER BY version, version LIMIT 1
+  Page Load (0.002110)   SELECT * FROM pages WHERE pages.id = 1 LIMIT 1
+  SQL (0.001568)   PRAGMA table_info(pages)
+  ActiveRecord::Acts::Versioned::PageVersion Load (0.001352)   SELECT * FROM page_versions WHERE page_versions.page_id = 1 ORDER BY version 
+  SQL (0.003145)   PRAGMA table_info(page_versions)
+  ActiveRecord::Acts::Versioned::PageVersion Load (0.001432)   SELECT * FROM page_versions WHERE page_versions.page_id = 1 AND (version = 23) ORDER BY version, version LIMIT 1
+  Page Update (0.002421)   UPDATE pages SET 'updated_on' = '2005-09-30 12:11:01', 'body' = 'Such a lovely day', 'version' = 23, 'title' = 'Welcome to the weblg' WHERE id = 1
+  Page Load (0.001187)   SELECT * FROM pages WHERE pages.id = 1 LIMIT 1
+  SQL (0.001723)   PRAGMA table_info(pages)
+  ActiveRecord::Acts::Versioned::PageVersion Load (0.001722)   SELECT * FROM page_versions WHERE page_versions.page_id = 1 ORDER BY version 
+  SQL (0.001417)   PRAGMA table_info(page_versions)
+  ActiveRecord::Acts::Versioned::PageVersion Load (0.001533)   SELECT * FROM page_versions WHERE page_versions.page_id = 1 AND (version = 23) ORDER BY version LIMIT 1

data/test/fixtures/db_definitions/postgresql.sql

@@ -31,4 +31,22 @@ CREATE TABLE locked_pages_revisions (
   title        VARCHAR(255),
   version_type VARCHAR(255),
   updated_at   TIMESTAMP
-);
+);
+
+CREATE TABLE widgets (
+  id   SERIAL,
+  name VARCHAR(50),
+  version    INTEGER,
+  updated_at   TIMESTAMP
+);
+
+CREATE SEQUENCE widgets_seq START 101;
+
+CREATE TABLE widget_versions (
+  id        INTEGER DEFAULT nextval('widgets_seq'),
+  widget_id INTEGER,
+  name      VARCHAR(50),
+  version    INTEGER,
+  updated_at   TIMESTAMP,
+  PRIMARY KEY (id)
+);

data/test/fixtures/widget.rb

@@ -0,0 +1,3 @@
+class Widget < ActiveRecord::Base
+  acts_as_versioned :sequence_name => 'widgets_seq'
+end

data/test/migration_test.rb

@@ -7,9 +7,6 @@ if ActiveRecord::Base.connection.supports_migrations?
   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"
@@ -21,9 +18,14 @@ if ActiveRecord::Base.connection.supports_migrations?
         
     def test_versioned_migration
       assert_raises(ActiveRecord::StatementInvalid) { Thing.create :title => 'blah blah' }
+      # take 'er up
       ActiveRecord::Migrator.up(File.dirname(__FILE__) + '/fixtures/migrations/')
       t = Thing.create :title => 'blah blah'
       assert_equal 1, t.versions.size
+
+      # now lets take 'er back down
+      ActiveRecord::Migrator.down(File.dirname(__FILE__) + '/fixtures/migrations/')
+      assert_raises(ActiveRecord::StatementInvalid) { Thing.create :title => 'blah blah' }
     end
   end
 end

data/test/versioned_test.rb

@@ -1,5 +1,6 @@
 require 'abstract_unit'
 require 'fixtures/page'
+require 'fixtures/widget'
 
 class VersionedTest < Test::Unit::TestCase
   fixtures :pages, :page_versions, :locked_pages, :locked_pages_revisions
@@ -225,4 +226,13 @@ class VersionedTest < Test::Unit::TestCase
     assert_equal 0, locked_pages(:thinking).find_versions(:conditions => ['title LIKE ?', '%web%']).length
     assert_equal 2, locked_pages(:welcome).find_versions.length
   end
+  
+  def test_with_sequence
+    assert_equal 'widgets_seq', Widget.versioned_class.sequence_name
+    Widget.create :name => 'new widget'
+    Widget.create :name => 'new widget'
+    Widget.create :name => 'new widget'
+    assert_equal 3, Widget.count
+    assert_equal 3, Widget.versions.size
+  end
 end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.10
 specification_version: 1
 name: acts_as_versioned
 version: !ruby/object:Gem::Version 
-  version: 0.1.3
-date: 2005-09-18
+  version: "0.2"
+date: 2005-10-06
 summary: Simple versioning with active record models
 require_paths: 
   - lib
@@ -30,6 +30,7 @@ files:
   - lib/acts_as_versioned.rb
   - test/abstract_unit.rb
   - test/connections
+  - test/debug.log
   - test/fixtures
   - test/migration_test.rb
   - test/tests.rb
@@ -50,6 +51,7 @@ files:
   - test/connections/native_sqlite3/connection.rb
   - test/connections/native_sqlserver/connection.rb
   - test/connections/native_sqlserver_odbc/connection.rb
+  - test/fixtures/activerecord_versioned.sqlite
   - test/fixtures/activerecord_versioned.sqlite3
   - test/fixtures/db_definitions
   - test/fixtures/locked_pages.yml
@@ -58,6 +60,7 @@ files:
   - test/fixtures/page.rb
   - test/fixtures/page_versions.yml
   - test/fixtures/pages.yml
+  - test/fixtures/widget.rb
   - test/fixtures/db_definitions/mysql.drop.sql
   - test/fixtures/db_definitions/mysql.sql
   - test/fixtures/db_definitions/postgresql.drop.sql