activerecord-connections 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in activerecord-connections.gemspec
+gemspec
+
+group :development do
+  gem 'activerecord', '3.1.0.rc6'
+  gem 'activesupport', '3.1.0.rc6'
+end

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Gabriel Sobrinho
+
+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.markdown

@@ -0,0 +1,66 @@
+# ActiveRecord::Connections - Easy multiple databases for ActiveRecord
+
+ActiveRecord::Connections provides a new way to manage multi-tenant applications based on multiples databases.
+
+## Install
+
+Install the activerecord-connections gem:
+
+    gem install activerecord-connections
+
+Add this line to Gemfile:
+
+    gem 'activerecord-connections'
+
+Runs a bundle install:
+
+    bundle install
+
+## Usage
+
+ActiveRecord::Connections add this syntax to ActiveRecord::Base:
+
+    ActiveRecord::Base.using_connection(connection_name, connection_spec) do
+      # Use database connection inside this block
+    end
+
+If you are using Rails, you could use this way:
+
+    class ApplicationController < ActionController::Base
+      around_filter :handle_customer
+
+      protected
+
+      def handle_customer(&block)
+        customer = Customer.find_by_domain!(request.domain)
+        customer.using_connection(&block)
+      end
+    end
+
+    class Customer < ActiveRecord::Base
+      serialize :connection_spec
+
+      def using_connection(&block)
+        ActiveRecord::Base.using_connection(id, connection_spec, &block)
+      end
+    end
+
+### Known issues
+
+* Do not work with multi-threads
+* Do not manage activerecord migrations for different databases
+* Similar objects of different connections do not differ
+* Coverage is not the best of the world (you could help easily)
+* You will lost the connection if you call using_connection nested
+
+### Sharding and replication
+
+Need sharding or replication? Check out one of these bad boys:
+
+* [ar-octopus](https://github.com/tchandy/octopus)
+* [db-charmer](https://github.com/kovyrin/db-charmer)
+* [data-fabric](https://github.com/mperham/data_fabric)
+
+## Copyright
+
+Copyright (c) 2011 Gabriel Sobrinho, released under the MIT license.

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+end
+
+task :default => :test

data/activerecord-connections.gemspec

@@ -0,0 +1,22 @@
+Gem::Specification.new do |s|
+  s.name        = "activerecord-connections"
+  s.version     = "0.0.1"
+  s.authors     = ["Gabriel Sobrinho"]
+  s.email       = ["gabriel.sobrinho@gmail.com"]
+  s.homepage    = "https://github.com/sobrinho/activerecord-connections"
+  s.summary     = %q{A new way to manage multi-tenant applications based on multiples databases}
+  s.description = %q{A new way to manage multi-tenant applications based on multiples databases}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'activesupport', '>= 3.0'
+  s.add_dependency 'activerecord', '>= 3.0'
+
+  s.add_development_dependency 'rake', '>= 0.8.7'
+  s.add_development_dependency 'minitest', '>= 2.3.1'
+  s.add_development_dependency 'minitest-colorize', '>= 0.0.4'
+  s.add_development_dependency 'sqlite3', '>= 1.3.4'
+end

data/lib/active_record/connections.rb

@@ -0,0 +1,64 @@
+require 'active_support/concern'
+
+module ActiveRecord
+  module Connections
+    autoload :ConnectionFactory, 'active_record/connections/connection_factory'
+
+    extend ActiveSupport::Concern
+
+    included do
+      cattr_accessor :proxy_connection
+    end
+
+    module ClassMethods
+      # Using on ApplicationController:
+      #
+      #   class ApplicationController < ActionController::Base
+      #     before_filter :handle_customer
+      #
+      #     protected
+      #
+      #     def handle_customer(&block)
+      #       customer = Customer.find_by_domain!(request.domain)
+      #       ActiveRecord::Base.using_connection(customer.id, customer.connection_spec, &block)
+      #     end
+      #   end
+      #
+      # Using directly on models:
+      #
+      #   customer = Customer.first
+      #
+      #   ActiveRecord::Base.using_connection(customer.id, customer.connection_spec) do
+      #     User.count # => 3
+      #   end
+      #
+      def using_connection(connection_name, connection_spec)
+        self.proxy_connection = ConnectionFactory.establish_connection(connection_name, connection_spec)
+
+        def self.connection_pool
+          connection_handler.retrieve_connection_pool(proxy_connection)
+        end
+
+        def self.retrieve_connection
+          connection_handler.retrieve_connection(proxy_connection)
+        end
+
+        yield
+      ensure
+        self.proxy_connection = nil
+
+        def self.connection_pool
+          connection_handler.retrieve_connection_pool(self)
+        end
+
+        def self.retrieve_connection
+          connection_handler.retrieve_connection(self)
+        end
+      end
+    end
+  end
+end
+
+ActiveSupport.on_load(:active_record) do
+  include ActiveRecord::Connections
+end

data/lib/active_record/connections/connection_factory.rb

@@ -0,0 +1,43 @@
+#
+# This class is used to automatically generate small abstract ActiveRecord classes
+# that would then be used as a source of database connections for ActiveRecord::Connections.
+# This way we do not need to re-implement all the connection establishing code
+# that ActiveRecord already has and we make our code less dependant on Rails versions.
+#
+module ActiveRecord
+  module Connections
+    class ConnectionFactory
+      cattr_accessor :connection_classes
+      self.connection_classes = {}
+
+      # Establishes connection or return an existing one from cache
+      def self.establish_connection(connection_name, connection_spec)
+        connection_classes[connection_name] ||= make_connection_klass(connection_name, connection_spec)
+      end
+
+      protected
+
+      # Generate an abstract AR class with specified connection established
+      def self.make_connection_klass(connection_name, connection_spec)
+        # Generate class
+        klass = generate_connection_klass(connection_name)
+
+        # Establish connection
+        klass.establish_connection(connection_spec)
+
+        # Return the class
+        return klass
+      end
+
+      def self.generate_connection_klass(connection_name)
+        class_eval <<-RUBY
+          class AbstractConnection#{connection_name} < ActiveRecord::Base
+            self.abstract_class = true
+
+            self
+          end
+        RUBY
+      end
+    end
+  end
+end

data/lib/activerecord-connections.rb

@@ -0,0 +1 @@
+require 'active_record/connections'

data/test/active_record/connections_test.rb

@@ -0,0 +1,76 @@
+require 'test_helper'
+require 'active_record'
+require 'active_record/connections'
+require 'support/customer'
+require 'support/contact'
+
+class ActiveRecord::ConnectionsTest < MiniTest::Unit::TestCase
+  MIGRATIONS_PATH = File.expand_path('../../db/migrate', __FILE__)
+
+  def setup
+    ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => ':memory:')
+
+    ActiveRecord::Migration.verbose = false
+    ActiveRecord::Migrator.migrate(MIGRATIONS_PATH)
+
+    @customer_1 = Customer.create!(:name => 'Customer 1')
+    @customer_2 = Customer.create!(:name => 'Customer 2')
+    @customer_3 = Customer.create!(:name => 'Customer 3')
+
+    self.each_customer do
+      ActiveRecord::Migrator.migrate(MIGRATIONS_PATH)
+    end
+
+    self.each_customer do |customer|
+      Contact.create!(:name => "Gabriel Sobrinho")
+    end
+  end
+
+  def teardown
+    self.each_customer do
+      Contact.destroy_all
+    end
+
+    Customer.destroy_all
+  end
+
+  def test_count
+    self.each_customer do |customer|
+      assert_equal 1, Contact.count, "#{customer.name} should have one contact"
+    end
+  end
+
+  def test_create
+    self.each_customer do |customer|
+      assert Contact.first, "#{customer.name} should have Gabriel Sobrinho as contact"
+    end
+  end
+
+  def test_update
+    self.each_customer do |customer|
+      Contact.update_all(:name => customer.name)
+    end
+
+    self.each_customer do |customer|
+      assert_equal customer.name, Contact.first.name, "#{customer.name} should have itself as contact"
+    end
+  end
+
+  def test_destroy
+    self.each_customer do
+      Contact.destroy_all
+    end
+
+    self.each_customer do |customer|
+      assert_equal 0, Contact.count, "#{customer.name} should have no contacts"
+    end
+  end
+
+  protected
+
+  def each_customer(&block)
+    Customer.find_each do |customer|
+      customer.using_connection(&block)
+    end
+  end
+end

data/test/db/migrate/20110822114329_create_customers.rb

@@ -0,0 +1,7 @@
+class CreateCustomers < ActiveRecord::Migration
+  def change
+    create_table :customers do |t|
+      t.string :name
+    end
+  end
+end

data/test/db/migrate/20110822114413_create_contacts.rb

@@ -0,0 +1,7 @@
+class CreateContacts < ActiveRecord::Migration
+  def change
+    create_table :contacts do |t|
+      t.string :name
+    end
+  end
+end

data/test/support/contact.rb

@@ -0,0 +1,2 @@
+class Contact < ActiveRecord::Base
+end

data/test/support/customer.rb

@@ -0,0 +1,11 @@
+class Customer < ActiveRecord::Base
+  def using_connection
+    ActiveRecord::Base.using_connection(id, database_spec) do
+      yield self
+    end
+  end
+
+  def database_spec
+    { :adapter => 'sqlite3', :database => ':memory:' }
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'bundler/setup'
+require 'minitest/autorun'
+require 'minitest/colorize'

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification 
+name: activerecord-connections
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Gabriel Sobrinho
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-22 00:00:00 -03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "3.0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "3.0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.8.7
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: minitest
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.1
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: minitest-colorize
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.0.4
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.3.4
+  type: :development
+  version_requirements: *id006
+description: A new way to manage multi-tenant applications based on multiples databases
+email: 
+- gabriel.sobrinho@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- MIT-LICENSE
+- README.markdown
+- Rakefile
+- activerecord-connections.gemspec
+- lib/active_record/connections.rb
+- lib/active_record/connections/connection_factory.rb
+- lib/activerecord-connections.rb
+- test/active_record/connections_test.rb
+- test/db/migrate/20110822114329_create_customers.rb
+- test/db/migrate/20110822114413_create_contacts.rb
+- test/support/contact.rb
+- test/support/customer.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: https://github.com/sobrinho/activerecord-connections
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: A new way to manage multi-tenant applications based on multiples databases
+test_files: 
+- test/active_record/connections_test.rb
+- test/db/migrate/20110822114329_create_customers.rb
+- test/db/migrate/20110822114413_create_contacts.rb
+- test/support/contact.rb
+- test/support/customer.rb
+- test/test_helper.rb