activerecord_worm_table 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 mccraig mccraig of the clan mccraig
+
+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.rdoc

@@ -0,0 +1,51 @@
+= activerecord_worm_table
+
+activerecord_worm_table manages multiple backing tables for an ActiveRecord model. there is
+a single active table, a different working table, and one or more history tables [default 1]
+
+inserts are done to the working table. the model's class method <tt>advance_version</tt> then makes
+the the active table history, the working table active, and creates a new working table with
+identical schema to the base table
+
+the model's +table_name+ method is overwritten to reflect the active table, so all ActiveRecord
+model methods, like finders, work transparently
+
+to use, just <tt>include ActiveRecord::WormTable</tt> into your model :
+
+  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.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
+
+the active table name is maintained as a row in an automatically created auxilliary table, 
+[<tt>foos_switch</tt> in the case of <tt>Foo</tt>], and this is updated in a transaction
+
+the presence of the historical tables [which are recycled] means that even though a transaction
+may advance_version, other transactions already in progress will continue to see the old 
+active table_name, and selects in progress will continue to completion without rollback [ provided
+they don't take longer to complete than it takes to recycle all history tables ]
+
+== Dependencies
+
+only works with MySQL at the moment : ddl statements are too database specific, and rails' schema
+operations too limited, to easily make it generic. wouldn't be too hard to extend for another db tho
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  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)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 mccraig mccraig of the clan mccraig. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "activerecord_worm_table"
+    gem.summary = %Q{WORM tables for ActiveRecord models}
+    gem.description = %Q{manage WriteOnceReadMany tables backing ActiveRecord models.
+                         there will be a switch table and multiple backing tables for each 
+                         ActiveRecord model, all created and managed automatically. a new
+                         version of a table is created by writing to the working table, and
+                         then Model.advance_version which makes the working table active,
+                         and creates a new working table from the base model schmea}
+    gem.email = "mccraigmccraig@googlemail.com"
+    gem.homepage = "http://github.com/mccraigmccraig/activerecord_worm_table"
+    gem.authors = ["mccraig mccraig of the clan mccraig"]
+    gem.add_development_dependency "rspec"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "activerecord_worm_table #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/activerecord_worm_table.rb

@@ -0,0 +1,151 @@
+# implements a write-once-read-many table, wherein there is a
+# currently active version of a table, one or more historical
+# versions and a working version. modifications are made
+# by writing new data to the working version of the table
+# and then switching the active version to what was the working version.
+#
+# each version is a separate database table, and there is a 
+# switch table with a single row which names the currently live
+# version table in the database
+
+module ActiveRecord
+  module WormTable
+    def self.included(mod)
+      mod.instance_eval do
+        class << self
+          include ClassMethods
+        end
+      end
+    end
+
+    module ClassMethods
+      ALPHABET = "abcdefghijklmnopqrstuvwxyz"
+
+      def ClassMethods.included(mod)
+        mod.instance_eval do
+          alias_method :org_table_name, :table_name
+          alias_method :table_name, :active_table_name
+        end
+      end
+      
+      # 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)
+        @base_table_name = name
+      end
+      alias :table_name= :set_table_name
+
+      def base_table_name
+        if !@base_table_name
+          @base_table_name = org_table_name
+          class << self
+            alias_method :table_name, :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}")
+        ct = connection.select_one( "show create table #{from}")["Create Table"]
+        new_ct = ct.gsub( /CREATE TABLE `#{from}`/, "CREATE TABLE `#{to}`")
+        connection.execute(new_ct)
+      end
+
+      def ensure_active_table(name)
+        if !connection.table_exists?(name) # don't execute ddl unless necessary
+          dup_table_schema(base_table_name, name)
+        end
+      end
+
+      # create a switch table of given name, if it doesn't already exist
+      def create_switch_table(name)
+        connection.execute( "create table if not exists #{name} (`current` varchar(255))" )
+      end
+
+      # create the switch table if it doesn't already exist. return the switch table name
+      def ensure_switch_table
+        stn = switch_table_name
+        if !connection.table_exists?(stn) # don't execute any ddl code if we don't need to
+          create_switch_table(stn)
+        end
+        stn
+      end
+
+      # name of the table with a row holding the active table name
+      def switch_table_name
+        base_table_name + "_switch"
+      end
+      
+      # list of suffixed table names
+      def suffixed_table_names
+        suffixes = []
+        (0...historical_version_count).each{ |i| suffixes << ALPHABET[i...i+1] }
+        suffixes.map do |suffix|
+          base_table_name + "_" + suffix
+        end
+      end
+      
+      # ordered vector of table version names, starting with base name
+      def table_version_names
+        [base_table_name] + suffixed_table_names
+      end
+
+      # name of the active table
+      def active_table_name
+        st = switch_table_name
+        begin
+          connection.select_value( "select current from #{st}" )
+        rescue
+        end || base_table_name
+      end
+
+      # name of the working table
+      def working_table_name
+        atn = active_table_name
+        tvn = table_version_names
+        tvn[ (tvn.index(atn) + 1) % tvn.size ]
+      end
+
+      # make working table active, then recreate new working table from base table schema
+      def advance_version
+        st = ensure_switch_table
+
+        # want a transaction at least here [surround is ok too] so 
+        # there is never an empty switch table
+        ActiveRecord::Base.transaction do
+          wtn = working_table_name
+          connection.execute( "delete from #{st}")
+          connection.execute( "insert into #{st} values (\'#{wtn}\')")
+        end
+
+        # ensure the presence of the new active and working tables. 
+        # happens after the switch table update, since this may commit a surrounding 
+        # transaction in dbs with retarded non-transactional ddl like, oh i dunno, MyFuckingSQL
+        ensure_active_table(active_table_name)
+
+        # recreate the new working table from the base schema. 
+        new_wtn = working_table_name
+        if new_wtn != base_table_name
+          dup_table_schema(base_table_name, new_wtn)
+        else
+          connection.execute( "truncate table #{new_wtn}" )
+        end
+
+      end
+    end
+  end
+end

data/spec/activerecord_worm_table_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "ActiverecordWormTable" do
+  it "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'activerecord_worm_table'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: activerecord_worm_table
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- mccraig mccraig of the clan mccraig
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-04 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: |-
+  manage WriteOnceReadMany tables backing ActiveRecord models.
+                           there will be a switch table and multiple backing tables for each 
+                           ActiveRecord model, all created and managed automatically. a new
+                           version of a table is created by writing to the working table, and
+                           then Model.advance_version which makes the working table active,
+                           and creates a new working table from the base model schmea
+email: mccraigmccraig@googlemail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/activerecord_worm_table.rb
+- spec/activerecord_worm_table_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/mccraigmccraig/activerecord_worm_table
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: WORM tables for ActiveRecord models
+test_files: 
+- spec/activerecord_worm_table_spec.rb
+- spec/spec_helper.rb