activerecord_worm_table 0.4.0 → 0.5.0

data/README.rdoc

@@ -12,13 +12,14 @@ model methods, like finders, work transparently
 
 to use, just <tt>include ActiveRecord::WormTable</tt> into your model :
 
-  class Foo \< ActiveRecord::Base
+  class Foo < ActiveRecord::Base
     include ActiveRecord::WormTable
   end
 
 there are class methods to get the different table names, and manipulate the version :
 
 * <tt>Foo.table_name</tt> : current active table name
+* <tt>Foo.advance_version(&block)</tt> : run +block+ to create a new version of the table. the working table will appear active to the +Thread+ running +block+ , and if +block+ completes then the working table will become permanently globally active
 * <tt>Foo.working_table_name</tt> : current working table name
 * <tt>Foo.advance_version</tt> : make active table historical, working table active and create a new working table
 
@@ -43,7 +44,7 @@ operations too limited, to easily make it generic. wouldn't be too hard to exten
   future version unintentionally.
 * Commit, do not mess with rakefile, version, or history.
   (if you want to have your own version, that is fine but
-   bump version in a commit by itself I can ignore when I pull)
+  bump version in a commit by itself I can ignore when I pull)
 * Send me a pull request. Bonus points for topic branches.
 
 == Copyright

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.5.0

data/lib/activerecord_worm_table.rb

@@ -26,10 +26,24 @@ module ActiveRecord
       def ClassMethods.included(mod)
         mod.instance_eval do
           alias_method :org_table_name, :table_name
-          alias_method :table_name, :active_table_name
+          alias_method :table_name, :active_working_table_or_active_table_name
         end
       end
       
+      # number of historical tables to keep around for posterity, or more likely
+      # to ensure running transactions aren't taken down by advance_version
+      # recreating a table. default 2
+      def historical_version_count
+        @historical_version_count || 2
+      end
+
+      # set the number of historical tables to keep around to ensure running 
+      # transactions aren't interrupted by truncating working tables. 2 is default
+      def set_historical_version_count(count)
+        @historical_version_count = count
+      end
+      alias :historical_version_count= :set_historical_version_count
+
       # hide the ActiveRecord::Base method, which redefines a table_name method,
       # and instead capture the given name as the base_table_name
       def set_table_name(name)
@@ -40,25 +54,14 @@ module ActiveRecord
       def base_table_name
         if !@base_table_name
           @base_table_name = org_table_name
+          # the original table_name method re-aliases itself !
           class << self
-            alias_method :table_name, :active_table_name
+            alias_method :table_name, :active_working_table_or_active_table_name
           end
         end
         @base_table_name
       end
 
-      # number of historical tables to keep around for posterity, or more likely
-      # to ensure running transactions aren't taken down by advance_version
-      # recreating a table
-      def historical_version_count
-        @historical_version_count || 2
-      end
-
-      def set_historical_version_count(count)
-        @historical_version_count = count
-      end
-      alias :historical_version_count= :set_historical_version_count
-
       # use schema of from table to recreate to table
       def dup_table_schema(from, to)
         connection.execute( "drop table if exists #{to}")
@@ -121,7 +124,7 @@ module ActiveRecord
         end
       end
 
-      # name of the active table
+      # name of the active table read direct from db
       def active_table_name
         st = switch_table_name
         begin
@@ -168,7 +171,37 @@ module ActiveRecord
         else
           connection.execute( "truncate table #{new_wtn}" )
         end
+      end
+
+      def thread_local_key_name
+        "ActiveRecord::WormTable::" + self.to_s
+      end
 
+      def active_working_table_name
+        Thread.current[thread_local_key_name]
+      end
+
+      def active_working_table_name=(name)
+        Thread.current[thread_local_key_name] = name
+      end
+
+      # name of the active table, or the working table if inside a new_version block
+      def active_working_table_or_active_table_name
+        active_working_table_name || active_table_name
+      end
+
+      # make the working table temporarily active [ for this thread only ], 
+      # execute the block, and if completed without exception then
+      # make the working table permanently active
+      def new_version(&block)
+        begin
+          self.active_working_table_name = working_table_name
+          r = block.call
+          advance_version
+          r
+        ensure
+          self.active_working_table_name = nil
+        end
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: activerecord_worm_table
 version: !ruby/object:Gem::Version 
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors: 
 - mccraig mccraig of the clan mccraig
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-05 00:00:00 +00:00
+date: 2009-11-12 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency