data_fabric 1.1.0 → 1.2.0

data/lib/data_fabric/ar22.rb

@@ -0,0 +1,172 @@
+module DataFabric
+  module Extensions
+    def self.included(model)
+      # Wire up ActiveRecord::Base
+      model.extend ClassMethods
+      ConnectionProxy.shard_pools = {}
+    end
+
+    # Class methods injected into ActiveRecord::Base
+    module ClassMethods
+      def data_fabric(options)
+        DataFabric.log { "Creating data_fabric proxy for class #{name}" }
+        @proxy = DataFabric::ConnectionProxy.new(self, options)
+        
+        class << self
+          def connection
+            @proxy
+          end
+
+          def connected?
+            @proxy.connected?
+          end
+
+          def remove_connection(klass)
+            DataFabric.log(Logger::ERROR) { "remove_connection not implemented by data_fabric" }
+          end
+
+          def connection_pool
+            raise "dynamic connection switching means you cannot get direct access to a pool"
+          end
+        end
+      end
+    end
+  end
+
+  class ConnectionProxy
+    cattr_accessor :shard_pools
+    
+    def initialize(model_class, options)
+      @model_class = model_class      
+      @replicated  = options[:replicated]
+      @shard_group = options[:shard_by]
+      @prefix      = options[:prefix]
+      set_role('slave') if @replicated
+
+      @model_class.send :include, ActiveRecordConnectionMethods if @replicated
+    end
+
+    delegate :insert, :update, :delete, :create_table, :rename_table, :drop_table, :add_column, :remove_column, 
+      :change_column, :change_column_default, :rename_column, :add_index, :remove_index, :initialize_schema_information,
+      :dump_schema_information, :execute, :execute_ignore_duplicate, :to => :master
+
+    delegate :insert_many, :to => :master # ar-extensions bulk insert support
+
+    def transaction(start_db_transaction = true, &block)
+      # Transaction is not re-entrant in SQLite 3 so we
+      # need to track if we've already started an XA to avoid
+      # calling it twice.
+      return yield if in_transaction?
+
+      with_master do
+        connection.transaction(start_db_transaction, &block) 
+      end
+    end
+
+    def method_missing(method, *args, &block)
+      DataFabric.log(Logger::DEBUG) { "Calling #{method} on #{connection}" }
+      connection.send(method, *args, &block)
+    end
+
+    def connection_name
+      connection_name_builder.join('_')
+    end
+
+    def with_master
+      # Allow nesting of with_master.
+      old_role = current_role
+      set_role('master')
+      yield
+    ensure
+      set_role(old_role)
+    end
+    
+    def connected?
+      current_pool.connected?
+    end
+
+  private
+
+    def in_transaction?
+      current_role == 'master'
+    end
+
+    def current_pool
+      name = connection_name
+      self.class.shard_pools[name] ||= begin
+        config = ActiveRecord::Base.configurations[name]
+        raise ArgumentError, "Unknown database config: #{name}, have #{ActiveRecord::Base.configurations.inspect}" unless config
+        ActiveRecord::ConnectionAdapters::ConnectionPool.new(spec_for(config))
+      end
+    end
+    
+    def spec_for(config)
+      # XXX This looks pretty fragile.  Will break if AR changes how it initializes connections and adapters.
+      config = config.symbolize_keys
+      adapter_method = "#{config[:adapter]}_connection"
+      initialize_adapter(config[:adapter])
+      ActiveRecord::Base::ConnectionSpecification.new(config, adapter_method)
+    end
+    
+    def initialize_adapter(adapter)
+      begin
+        require 'rubygems'
+        gem "activerecord-#{adapter}-adapter"
+        require "active_record/connection_adapters/#{adapter}_adapter"
+      rescue LoadError
+        begin
+          require "active_record/connection_adapters/#{adapter}_adapter"
+        rescue LoadError
+          raise "Please install the #{adapter} adapter: `gem install activerecord-#{adapter}-adapter` (#{$!})"
+        end
+      end
+    end      
+
+    def connection_name_builder
+      @connection_name_builder ||= begin
+        clauses = []
+        clauses << @prefix if @prefix
+        clauses << @shard_group if @shard_group
+        clauses << StringProxy.new { DataFabric.active_shard(@shard_group) } if @shard_group
+        clauses << RAILS_ENV
+        clauses << StringProxy.new { current_role } if @replicated
+        clauses
+      end
+    end
+    
+    def connection
+      current_pool.connection
+    end
+
+    def set_role(role)
+      Thread.current[:data_fabric_role] = role
+    end
+    
+    def current_role
+      Thread.current[:data_fabric_role]
+    end
+
+    def master
+      with_master { return connection }
+    end
+  end
+
+  module ActiveRecordConnectionMethods
+    def self.included(base)
+      base.alias_method_chain :reload, :master
+    end
+
+    def reload_with_master(*args, &block)
+      connection.with_master { reload_without_master }
+    end
+  end
+
+  class StringProxy
+    def initialize(&block)
+      @proc = block
+    end
+    def to_s
+      @proc.call
+    end
+  end
+end

data/lib/data_fabric/version.rb

@@ -1,5 +1,5 @@
 module DataFabric
 	module Version
-		STRING = "1.1.0"
+		STRING = "1.2.0"
 	end
 end

data/test/connection_test.rb

@@ -36,7 +36,7 @@ end
 
 class RawConnection
   def method_missing(name, *args)
-      puts "#{self.class.name} missing '#{name}': #{args.inspect}"
+    puts "#{self.class.name} missing '#{name}': #{args.inspect}"
   end
 end
 
@@ -96,7 +96,11 @@ class ConnectionTest < Test::Unit::TestCase
   private
   
   def setup_configuration_for(clazz, name)
-    flexmock(clazz).should_receive(:mysql_connection).and_return(AdapterMock.new(RawConnection.new))
+    if ar22?
+      flexmock(ActiveRecord::ConnectionAdapters::ConnectionPool).new_instances.should_receive(:new_connection).and_return(AdapterMock.new(RawConnection.new))
+    else
+      flexmock(clazz).should_receive(:mysql_connection).and_return(AdapterMock.new(RawConnection.new))      
+    end
     ActiveRecord::Base.configurations ||= HashWithIndifferentAccess.new
     ActiveRecord::Base.configurations[name] = HashWithIndifferentAccess.new({ :adapter => 'mysql', :database => name, :host => 'localhost'})
   end

data/test/database_test.rb

@@ -10,6 +10,29 @@ class DatabaseTest < Test::Unit::TestCase
   
   def setup
     ActiveRecord::Base.configurations = load_database_yml
+    if ar22?
+      DataFabric::ConnectionProxy.shard_pools.clear
+    end
+  end
+
+  def test_ar22_features
+    return unless ar22?
+
+    DataFabric.activate_shard :city => :dallas do
+      assert_equal 'fiveruns_city_dallas_test_slave', TheWholeBurrito.connection.connection_name
+
+      assert_raises RuntimeError do
+        TheWholeBurrito.connection_pool
+      end
+
+      assert !TheWholeBurrito.connected?
+
+      # Should use the slave
+      burrito = TheWholeBurrito.find(1)
+      assert_match 'vr_dallas_slave', burrito.name
+
+      assert TheWholeBurrito.connected?
+    end
   end
 
   def test_live_burrito
@@ -19,18 +42,19 @@ class DatabaseTest < Test::Unit::TestCase
       # Should use the slave
       burrito = TheWholeBurrito.find(1)
       assert_match 'vr_dallas_slave', burrito.name
-      
+
       # Should use the master
       burrito.reload
       assert_match 'vr_dallas_master', burrito.name
 
       # ...but immediately set it back to default to the slave
       assert_equal 'fiveruns_city_dallas_test_slave', TheWholeBurrito.connection.connection_name
-      
+
       # Should use the master
       TheWholeBurrito.transaction do
         burrito = TheWholeBurrito.find(1)
         assert_match 'vr_dallas_master', burrito.name
+        burrito.name = 'foo'
         burrito.save!
       end
     end

data/test/test_helper.rb

@@ -1,34 +1,40 @@
-if !defined?(ROOT_PATH) # Don't evaluate this file twice.
-  ENV['RAILS_ENV'] = 'test'
-  RAILS_ENV = 'test'
-  ROOT_PATH = File.expand_path(File.join(File.dirname(__FILE__), ".."))
-  DATABASE_YML_PATH = File.join(ROOT_PATH, "test", "database.yml")
-  Dir.chdir(ROOT_PATH)
+ENV['RAILS_ENV'] = 'test'
+RAILS_ENV = 'test'
+ROOT_PATH = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+DATABASE_YML_PATH = File.join(ROOT_PATH, "test", "database.yml")
+Dir.chdir(ROOT_PATH)
 
-  require 'rubygems'
-  require 'test/unit'
+require 'rubygems'
+require 'test/unit'
 
-  # Bootstrap AR
-  gem 'activerecord', '=2.0.2'
-  require 'active_record'
-  require 'active_record/version'
-  ActiveRecord::Base.logger = Logger.new(STDOUT)
-  ActiveRecord::Base.logger.level = Logger::WARN
-  ActiveRecord::Base.allow_concurrency = false
+version = ENV['AR_VERSION']
+if version
+  puts "Testing ActiveRecord #{version}"
+  gem 'activerecord', "=#{version}"
+end
+
+require 'active_record'
+require 'active_record/version'
+ActiveRecord::Base.logger = Logger.new(STDOUT)
+ActiveRecord::Base.logger.level = Logger::WARN
 
-  # Bootstrap DF
-  Dependencies.load_paths << File.join(File.dirname(__FILE__), '../lib')
-  require 'init'
+# Bootstrap DF
+deps = defined?(ActiveSupport::Dependencies) ? ActiveSupport::Dependencies : Dependencies
+deps.load_paths << File.join(File.dirname(__FILE__), '../lib')
+require 'init'
 
-  def load_database_yml
-    filename = DATABASE_YML_PATH
-    YAML::load(ERB.new(IO.read(filename)).result)
-  end
+def load_database_yml
+  filename = DATABASE_YML_PATH
+  YAML::load(ERB.new(IO.read(filename)).result)
+end
+
+def ar22?
+  ActiveRecord::VERSION::STRING >= '2.2.0'
+end
 
-  if !File.exist?(DATABASE_YML_PATH)
-    STDERR.puts "\n*** ERROR ***:\n" <<
-      "You must have a 'test/database.yml' file in order to run the unit tests. " <<
-      "An example is provided in 'test/database.yml.example'.\n\n"
-    exit 1
-  end
+if !File.exist?(DATABASE_YML_PATH)
+  puts "\n*** ERROR ***:\n" <<
+    "You must have a 'test/database.yml' file in order to run the unit tests. " <<
+    "An example is provided in 'test/database.yml.example'.\n\n"
+  exit 1
 end

data/test/thread_test.rb

@@ -4,20 +4,28 @@ require 'erb'
 class ThreadTest < Test::Unit::TestCase
   
   MUTEX = Mutex.new
-  
-  def test_concurrency_not_allowed
-    assert_raise ArgumentError do
-      Object.class_eval %{
-        class ThreadedEnchilada < ActiveRecord::Base
-          self.allow_concurrency = true
-          set_table_name :enchiladas
-          data_fabric :prefix => 'fiveruns', :replicated => true, :shard_by => :city
-        end
-      }
+
+  if ActiveRecord::VERSION::STRING < '2.2.0'
+    def test_concurrency_not_allowed
+      assert_raise ArgumentError do
+        Object.class_eval %{
+          class ThreadedEnchilada < ActiveRecord::Base
+            self.allow_concurrency = true
+            set_table_name :enchiladas
+            data_fabric :prefix => 'fiveruns', :replicated => true, :shard_by => :city
+          end
+        }
+      end
     end
   end
   
-  def xtest_class_and_instance_connections
+  def test_class_and_instance_connections
+    Object.class_eval %{
+      class ThreadedEnchilada < ActiveRecord::Base
+        set_table_name :enchiladas
+        data_fabric :prefix => 'fiveruns', :replicated => true, :shard_by => :city
+      end
+    }
     ActiveRecord::Base.configurations = load_database_yml
 
     cconn = ThreadedEnchilada.connection

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: data_fabric
 version: !ruby/object:Gem::Version 
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors: 
 - Mike Perham
@@ -9,11 +9,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-11-22 00:00:00 -06:00
+date: 2008-12-01 00:00:00 -06:00
 default_executable: 
 dependencies: []
 
-description: Sharding and replication support for ActiveRecord 2.0 and 2.1
+description: Sharding and replication support for ActiveRecord 2.x
 email: mperham@gmail.com
 executables: []
 
@@ -21,6 +21,8 @@ extensions: []
 
 extra_rdoc_files: 
 - CHANGELOG
+- lib/data_fabric/ar20.rb
+- lib/data_fabric/ar22.rb
 - lib/data_fabric/version.rb
 - lib/data_fabric.rb
 - README.rdoc
@@ -46,9 +48,15 @@ files:
 - example/config/initializers/mime_types.rb
 - example/config/initializers/new_rails_defaults.rb
 - example/config/routes.rb
+- example/db/development.sqlite3
 - example/db/migrate/20080702154628_create_accounts.rb
 - example/db/migrate/20080702154820_create_figments.rb
+- example/db/s0_development.sqlite3
+- example/db/s0_test.sqlite3
+- example/db/s1_development.sqlite3
+- example/db/s1_test.sqlite3
 - example/db/schema.rb
+- example/db/test.sqlite3
 - example/public/404.html
 - example/public/422.html
 - example/public/500.html
@@ -82,7 +90,70 @@ files:
 - example/test/functional/accounts_controller_test.rb
 - example/test/integration/account_figments_test.rb
 - example/test/test_helper.rb
+- example/vendor/plugins/data_fabric/init.rb
+- example/vendor/plugins/data_fabric/lib/data_fabric/ar20.rb
+- example/vendor/plugins/data_fabric/lib/data_fabric/ar22.rb
+- example/vendor/plugins/data_fabric/lib/data_fabric/version.rb
+- example/vendor/plugins/data_fabric/lib/data_fabric.rb
+- example22/app/controllers/accounts_controller.rb
+- example22/app/controllers/application.rb
+- example22/app/controllers/figments_controller.rb
+- example22/app/helpers/application_helper.rb
+- example22/app/models/account.rb
+- example22/app/models/figment.rb
+- example22/app/views/accounts/index.html.erb
+- example22/app/views/layouts/application.html.erb
+- example22/config/boot.rb
+- example22/config/database.yml
+- example22/config/environment.rb
+- example22/config/environments/development.rb
+- example22/config/environments/production.rb
+- example22/config/environments/test.rb
+- example22/config/initializers/inflections.rb
+- example22/config/initializers/mime_types.rb
+- example22/config/initializers/new_rails_defaults.rb
+- example22/config/locales/en.yml
+- example22/config/routes.rb
+- example22/db/migrate/20080702154628_create_accounts.rb
+- example22/db/migrate/20080702154820_create_figments.rb
+- example22/public/404.html
+- example22/public/422.html
+- example22/public/500.html
+- example22/public/dispatch.cgi
+- example22/public/dispatch.fcgi
+- example22/public/dispatch.rb
+- example22/public/favicon.ico
+- example22/public/images/rails.png
+- example22/public/index.html
+- example22/public/javascripts/application.js
+- example22/public/javascripts/controls.js
+- example22/public/javascripts/dragdrop.js
+- example22/public/javascripts/effects.js
+- example22/public/javascripts/prototype.js
+- example22/public/robots.txt
+- example22/Rakefile
+- example22/script/about
+- example22/script/console
+- example22/script/dbconsole
+- example22/script/destroy
+- example22/script/generate
+- example22/script/performance/benchmarker
+- example22/script/performance/profiler
+- example22/script/performance/request
+- example22/script/plugin
+- example22/script/process/inspector
+- example22/script/process/reaper
+- example22/script/process/spawner
+- example22/script/runner
+- example22/script/server
+- example22/test/fixtures/accounts.yml
+- example22/test/functional/accounts_controller_test.rb
+- example22/test/integration/account_figments_test.rb
+- example22/test/performance/browsing_test.rb
+- example22/test/test_helper.rb
 - init.rb
+- lib/data_fabric/ar20.rb
+- lib/data_fabric/ar22.rb
 - lib/data_fabric/version.rb
 - lib/data_fabric.rb
 - Manifest
@@ -95,6 +166,10 @@ files:
 - test/shard_test.rb
 - test/test_helper.rb
 - test/thread_test.rb
+- test/vr_austin_master.db
+- test/vr_austin_slave.db
+- test/vr_dallas_master.db
+- test/vr_dallas_slave.db
 - TESTING.rdoc
 - data_fabric.gemspec
 has_rdoc: true
@@ -127,10 +202,9 @@ rubyforge_project: fiveruns
 rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
-summary: Sharding and replication support for ActiveRecord 2.0 and 2.1
+summary: Sharding and replication support for ActiveRecord 2.x
 test_files: 
 - test/connection_test.rb
 - test/database_test.rb
 - test/shard_test.rb
-- test/test_helper.rb
 - test/thread_test.rb