ar-octopus 0.1.2 → 0.2.0

data/README.mkdn

@@ -26,18 +26,22 @@ When using replication, all writes queries will be sent to master, and read quer
 ### Rails 2.x 
 
 Install  the octopus gem:
-<pre> sudo gem install ar-octopus </pre>
+
+    sudo gem install ar-octopus
 
 Add this line to enviroment.rb:
-<pre>config.gem 'ar-octopus', :lib => "octopus"</pre>
+
+    config.gem 'ar-octopus', :lib => "octopus"
 
 ### Rails 3.x 
 
 Add this line to Gemfile:
-<pre>gem 'ar-octopus', :require => "octopus"</pre>
+
+    gem 'ar-octopus', :require => "octopus"
 
 Runs a bundle install:
-<pre>bundle install</pre>
+
+    bundle install
 
 ## How to use Octopus? 
 
@@ -46,75 +50,70 @@ First, you need to create a config file, shards.yml, inside your config/ directo
 ### Syntax 
 
 Octopus adds a method to each AR Class and object: the using method is used to select the shard like this: 
-<pre>User.where(:name => "Thiago").limit(3).using(:slave_one) </pre>
+
+    User.where(:name => "Thiago").limit(3).using(:slave_one)
 
 Octopus also supports queries within a block. When you pass a block to the using method, all queries inside the block will be sent to the specified shard. 
-<pre>
-Octopus.using(:slave_two) do 
-  User.create(:name => "Mike")
-end
-</pre>
+
+    Octopus.using(:slave_two) do 
+      User.create(:name => "Mike")
+    end
 
 Each model instance knows which shard it came from so this will work automatically:
-<pre> 
-# This will find the user in the shard1
-@user = User.using(:shard1).find_by_name("Joao")
 
-# This will find the user in the master database
-@user2 = User.find_by_name("Jose")
+    # This will find the user in the shard1
+    @user = User.using(:shard1).find_by_name("Joao")
 
-#Sets the name
-@user.name = "Mike"
+    # This will find the user in the master database
+    @user2 = User.find_by_name("Jose")
 
-# Save the user in the correct shard, shard1. 
-@user.save
-</pre>
+    #Sets the name
+    @user.name = "Mike"
+
+    # Save the user in the correct shard, shard1. 
+    @user.save
 
 ### Migrations
 
 In migrations, you also have access to the using method. The syntax is basically the same. This migration will run in the brazil and canada shards.
-<pre>
-  class CreateUsersOnBothShards < ActiveRecord::Migration
-    using(:brazil, :canada)
 
-    def self.up
-      User.create!(:name => "Both")
-    end
+    class CreateUsersOnBothShards < ActiveRecord::Migration
+      using(:brazil, :canada)
 
-    def self.down
-      User.delete_all
+      def self.up
+        User.create!(:name => "Both")
+      end
+
+      def self.down
+        User.delete_all
+      end
     end
-  end
-</pre>
 
 You also could send a migration to a group of shards.  This migration will be sent to all shards that belongs to history_shards group, specified in shards.yml: 
-<pre>
-  class CreateUsersOnMultiplesGroups < ActiveRecord::Migration
-    using_group(:history_shards)
 
-    def self.up
-      User.create!(:name => "MultipleGroup")
-    end
+    class CreateUsersOnMultiplesGroups < ActiveRecord::Migration
+      using_group(:history_shards)
 
-    def self.down
-      User.delete_all
-    end
-  end
-</pre>
+      def self.up
+        User.create!(:name => "MultipleGroup")
+      end
 
+      def self.down
+        User.delete_all
+      end
+    end
 
 ### Rails Controllers
 
 If you want to send a specified action, or all actions from a controller, to a specific shard,  use this syntax:
-<pre>
-  class ApplicationController < ActionController::Base
-    around_filter :select_shard      
+  
+    class ApplicationController < ActionController::Base
+      around_filter :select_shard      
     
-    def select_shard(&block)
-      Octopus.using(:brazil, &block)
-    end    
-  end
-</pre>
+      def select_shard(&block)
+        Octopus.using(:brazil, &block)
+      end    
+    end
 
  To see the complete list of features and syntax, please check out our <a href="http://wiki.github.com/tchandy/octopus/"> Wiki</a>
 Want to see sample rails applications using octopus features? please check it out: <a href="http://github.com/tchandy/octopus_sharding_example">Sharding Example</a> and <a href="http://github.com/tchandy/octopus_replication_example">Replication Example</a>. Also, we have an example that shows how to use Octopus without Rails: <a href="http://github.com/tchandy/octopus_sinatra"> Octopus + Sinatra Example</a>.
@@ -123,33 +122,39 @@ Want to see sample rails applications using octopus features? please check it ou
 ## Important!
 Sometimes, when a connection isn't used for much time, this will makes ActiveRecord raising an exception. if you have this kind of applications, please, add the following line to your configuration:
 
-<pre>
-verify_connection: true
-</pre>
+    verify_connection: true
 
 This will tell Octopus to verify the connection before sending the query.
 
+## Mixing Octopus with the Rails multiple database model
+Octopus will respect if you declare some model to use a specific connection, with the rails syntax, like this example:
+
+    #This class sets its own connection
+    class CustomConnection < ActiveRecord::Base
+      establish_connection(:adapter => "mysql", :database => "octopus_shard2")
+    end
+    
 ## Contributing with Octopus
 Contributors are welcome! To run the test suite, you need mysql, postgresql and sqlite3 installed. This is what you need to setup your Octopus development environment:
 
-<pre>
-  git clone http://github.com/tchandy/octopus.git
-  cd octopus
-  bundle install
-  rake db:prepare
-  rake
-</pre>
+    git clone http://github.com/tchandy/octopus.git
+    cd octopus
+    bundle install
+    rake db:prepare
+    rake
 
 To run our integrations tests inside sample_app, you need to following commands:
 
-<pre>
-  cd sample_app
-  bundle install
-  cucumber
-</pre>
+    cd sample_app
+    bundle install
+    cucumber
 
 If you are having issues running the octopus spec suite, verify your database users and passwords match those inside the config files and your permissions are correct.
 
+## Contributors:
+- <a href="http://github.com/carlosbrando">Carlos Brando</a>
+- <a href="http://github.com/bjones">Brian Jones</a>
+
 ## Thanks
 
 This project is sponsored by the <a href="http://www.rubysoc.org">Ruby Summer of Code</a>,

data/Rakefile

@@ -37,7 +37,7 @@ begin
     gem.add_development_dependency "jeweler", ">= 1.4"
     gem.add_development_dependency "actionpack", ">= 2.3"
     gem.add_dependency('activerecord', '>= 2.3')
-    gem.version = "0.1.2"
+    gem.version = "0.2.0"
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError

data/ar-octopus.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ar-octopus}
-  s.version = "0.1.2"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Thiago Pradi", "Mike Perham"]
-  s.date = %q{2010-10-02}
+  s.date = %q{2010-10-24}
   s.description = %q{This gem allows you to use sharded databases with ActiveRecord. this also provides a interface for replication and for running migrations with multiples shards.}
   s.email = %q{tchandy@gmail.com}
   s.extra_rdoc_files = [

data/lib/octopus/model.rb

@@ -3,6 +3,9 @@ module Octopus::Model
     base.send(:include, InstanceMethods)
     base.extend(ClassMethods)
     base.hijack_connection()
+    class << base 
+      alias_method_chain(:establish_connection, :octopus)
+    end
   end
 
   module SharedMethods
@@ -43,7 +46,7 @@ module Octopus::Model
 
     def hijack_connection()
       def self.should_use_normal_connection?
-        defined?(Rails) && Octopus.config() && !Octopus.enviroments.include?(Rails.env.to_s)
+        (defined?(Rails) && Octopus.config() && !Octopus.enviroments.include?(Rails.env.to_s)) || self.read_inheritable_attribute(:establish_connection)
       end
       
       def self.connection_proxy
@@ -84,6 +87,11 @@ module Octopus::Model
     
     def sharded_model()
       write_inheritable_attribute(:sharded, true)      
+    end    
+    
+    def establish_connection_with_octopus(spec=nil)
+      write_inheritable_attribute(:establish_connection, true)
+      establish_connection_without_octopus(spec)
     end
   end
 end

data/spec/database_models.rb

@@ -19,6 +19,11 @@ class Cat < ActiveRecord::Base
   #sharded_model()
 end
 
+#This class sets its own connection
+class CustomConnection < ActiveRecord::Base
+  establish_connection(:adapter => "mysql", :database => "octopus_shard2", :username => "root", :password => "")
+end
+
 #This items belongs to a client
 class Item < ActiveRecord::Base
   belongs_to :client
@@ -63,4 +68,4 @@ end
 
 class Comment < ActiveRecord::Base
   belongs_to :commentable, :polymorphic => true
-end
+end

data/spec/octopus/model_spec.rb

@@ -172,6 +172,10 @@ describe Octopus::Model do
   end
 
   describe "AR basic methods" do
+    it "establish_connection" do
+      CustomConnection.connection.current_database.should == "octopus_shard2" 
+    end
+
     it "increment" do
       u = User.using(:brazil).create!(:name => "Teste", :number => 10)
       u = User.using(:brazil).find_by_number(10)
@@ -350,4 +354,4 @@ describe Octopus::Model do
       end
     end
   end
-end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ar-octopus
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
   - 2
-  version: 0.1.2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Thiago Pradi
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-02 00:00:00 -03:00
+date: 2010-10-24 00:00:00 -02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency