ar-octopus 0.4.0 → 0.5.0

data/.gitignore

@@ -0,0 +1,11 @@
+*.gem
+*.sqlite3
+.bundle
+.rvmrc
+Gemfile.lock
+gemfiles/*
+pkg/*
+*.rbc
+tmp/*
+.*.sw[a-z]
+database.log

data/.travis.yml

@@ -0,0 +1,22 @@
+language: ruby
+env:
+  - CI=true
+before_script:
+ - "bundle install"
+ - "bundle exec rake db:prepare"
+bundler_args: --without development
+
+rvm:
+  - 1.8.7
+  - 1.9.3
+
+gemfile:
+  - gemfiles/rails2.gemfile
+  - gemfiles/rails3.gemfile
+  - gemfiles/rails31.gemfile
+  - gemfiles/rails32.gemfile
+
+notifications:
+  recipients:
+    - gabriel.sobrinho@gmail.com
+    - thiago.pradi@gmail.com

data/Appraisals

@@ -0,0 +1,18 @@
+appraise "rails2" do
+  gem "activerecord", "~> 2.3"
+  gem "actionpack",   "~> 2.3"
+end
+
+appraise "rails30" do
+  gem "activerecord", "~> 3.0.11"
+end
+
+appraise "rails31" do
+  gem "activerecord", "~> 3.1.3"
+end
+
+appraise "rails32" do
+  gem "activerecord", "~> 3.2.0"
+end
+
+# vim: ft=ruby

data/Gemfile

@@ -1,13 +1,4 @@
-source :rubygems
+source "http://rubygems.org"
 
-gem 'activerecord', '3.0.6'
-gem 'actionpack', '3.0.6'
-
-group :test do
-  gem "rake", ">= 0.8.7"
-  gem "jeweler", ">= 1.4"
-  gem "rspec"
-  gem "mysql2"
-  gem "pg", ">= 0.9.0"
-  gem "sqlite3-ruby", ">= 1.3.1"
-end
+# Specify your gem's dependencies in ar-octopus.gemspec
+gemspec

data/README.mkdn

@@ -1,5 +1,7 @@
 # Octopus  - Easy Database Sharding for ActiveRecord
 
+[![Build Status](https://travis-ci.org/tchandy/octopus.png)](https://travis-ci.org/tchandy/octopus) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/tchandy/octopus)
+
 Octopus is a better way to do Database Sharding in ActiveRecord. Sharding allows multiple databases in the same rails application. While there are several projects that implement Sharding (e.g. DbCharmer, DataFabric, MultiDb), each project has its own limitations. The main goal of octopus project is to provide a better way of doing Database Sharding.
 
 ## Feature list:
@@ -16,14 +18,14 @@ Octopus supports:
 When using replication, all writes queries will be sent to master, and read queries to slaves. More info could be found at: <a href="http://wiki.github.com/tchandy/octopus/replication"> Wiki</a>
 
 ### Sharding
- When using sharding, you need to specify which shard to send the query. Octopus supports selecting the shard inside a controller, or manually in each object. More could be found at <a href="http://wiki.github.com/tchandy/octopus/sharding"> Wiki</a> 
+ When using sharding, you need to specify which shard to send the query. Octopus supports selecting the shard inside a controller, or manually in each object. More could be found at <a href="http://wiki.github.com/tchandy/octopus/sharding"> Wiki</a>
 
 ### Replication + Sharding
  Replication + Sharding isn't supported yet. This is on our TODO list and will be done ASAP. If you need, feel free to fork and implement it.
 
-## Install 
+## Install
 
-### Rails 2.x 
+### Rails 2.x
 
 Install  the octopus gem:
 
@@ -33,29 +35,51 @@ Add this line to enviroment.rb:
 
     config.gem 'ar-octopus', :lib => "octopus"
 
-### Rails 3.x 
+### Rails 3.x
 
 Add this line to Gemfile:
 
-    gem 'ar-octopus', :require => "octopus"
+    gem 'ar-octopus', :require => 'octopus'
+
+**Note**: The `ar-octopus` gem build is out of date. Until a new build is created, we recommend using the gem from this repo by placing `gem "ar-octopus", github: "tchandy/octopus", require: "octopus"` in your Gemfile instead of the above line. Alternatively you can [create your own fork](https://github.com/tchandy/octopus/fork_select) (for added stability against changes to master) and reference that fork from your Gemfile: `gem "ar-octopus", github: "<fork owner>/octopus", require: "octopus"`.
 
-Runs a bundle install:
+Run a bundle install:
 
     bundle install
 
-## How to use Octopus? 
+## Upgrading
+
+### From < 0.5.0
+
+Octopus < 0.5.0 stored schema version information in the master database defined in the database.yml file, and assumed
+that each shard's schema matched the others and the master database. Beginning with Octopus 0.5.0, the schema version
+information for each shard is stored within that shard's database.
+
+If you are upgrading from < 0.5.0 run the `copy_schema_versions` rake task to copy the schema version information in the
+master database to each of the shards:
+
+    rake octopus:copy_schema_versions
+
+Once the task completes migrations will operate normally and schema information will be stored in each shard database
+going forward.
+
+In order to run this task in Rails 2.3, you'll need to tell Rails to load Octopus' rake tasks by adding this to your `Rakefile`:
+
+    Dir["#{Gem.searcher.find('ar-octopus').full_gem_path}/lib/tasks/**/*.rake"].each { |ext| load ext }
+
+## How to use Octopus?
 
 First, you need to create a config file, shards.yml, inside your config/ directory. to see the syntax and how this file should look, please checkout <a href="http://wiki.github.com/tchandy/octopus/config-file">this page on wiki</a>.
 
-### Syntax 
+### Syntax
 
-Octopus adds a method to each AR Class and object: the using method is used to select the shard like this: 
+Octopus adds a method to each AR Class and object: the using method is used to select the shard like this:
 
     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. 
+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.
 
-    Octopus.using(:slave_two) do 
+    Octopus.using(:slave_two) do
       User.create(:name => "Mike")
     end
 
@@ -70,7 +94,7 @@ Each model instance knows which shard it came from so this will work automatical
     #Sets the name
     @user.name = "Mike"
 
-    # Save the user in the correct shard, shard1. 
+    # Save the user in the correct shard, shard1.
     @user.save
 
 ### Migrations
@@ -89,7 +113,7 @@ In migrations, you also have access to the using method. The syntax is basically
       end
     end
 
-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: 
+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:
 
     class CreateUsersOnMultiplesGroups < ActiveRecord::Migration
       using_group(:history_shards)
@@ -106,13 +130,13 @@ You also could send a migration to a group of shards.  This migration will be se
 ### Rails Controllers
 
 If you want to send a specified action, or all actions from a controller, to a specific shard,  use this syntax:
-  
+
     class ApplicationController < ActionController::Base
-      around_filter :select_shard      
-    
+      around_filter :select_shard
+
       def select_shard(&block)
         Octopus.using(:brazil, &block)
-      end    
+      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>
@@ -120,23 +144,36 @@ 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:
+Occasionally, an application might lose a connection to a database; when this happens, ActiveRecord will raise an exception. Add the following line to your application configuration if you are experiencing this issue:
 
     verify_connection: true
 
 This will tell Octopus to verify the connection before sending the query.
 
 ## Mixing Octopus with the Rails multiple database model
-If you want to set a custom connection to a specific model, use this syntax:
+If you want to set a custom connection to a specific model, use the syntax `octopus_establish_connection` syntax:
 
     #This class sets its own connection
-    # establish_connection will not work, use octopus_establish_connection instead.
     class CustomConnection < ActiveRecord::Base
       octopus_establish_connection(:adapter => "mysql", :database => "octopus_shard2")
     end
 
 ## Set table names
-If you want to use specific table names, please visit: <a href="https://github.com/tchandy/octopus/wiki/Table-names"> this link</a>
+If you want to use specific table names, use the correct syntax for your version of Rails.
+
+### Rails <= 3.1
+
+    class Bacon < ActiveRecord::Base
+      set_table_name("yummy")
+    end
+
+### Rails >= 3.2
+
+    class Bacon < ActiveRecord::Base
+      self.table_name = "yummy"
+    end
+
+Unfortunately the `self.table_name=` syntax isn't supported on versions of Rails <= 3.1.
 
 ## 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:
@@ -144,9 +181,11 @@ Contributors are welcome! To run the test suite, you need mysql, postgresql and
     git clone http://github.com/tchandy/octopus.git
     cd octopus
     bundle install
-    rake db:prepare
-    rake
+    bundle exec rake db:prepare
+    bundle exec rake appraisal:install
+    bundle exec rake spec
 
+This command will run the spec suite for all rails versions supported (Rails 2.3, Rails 3.0 and Rails 3.1).
 To run our integrations tests inside sample_app, you need to following commands:
 
     cd sample_app
@@ -168,4 +207,4 @@ and my mentors <a href="http://github.com/mperham">Mike Perham</a> and <a href="
 
 ## Copyright
 
-Copyright (c) 2010 Thiago Pradi, released under the MIT license.
+Copyright (c) Thiago Pradi, released under the MIT license.

data/Rakefile

@@ -1,168 +1,146 @@
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'lib'))
-$LOAD_PATH << (File.dirname(__FILE__) + '/spec')
-require 'rubygems'
-require 'rake'
-require 'rake/tasklib'
-require "yaml"
-require "bundler"
-Bundler.setup()
-
-begin
-  require 'metric_fu'
-  MetricFu::Configuration.run do |config|
-    config.metrics  = [:churn,:flay, :flog, :reek, :roodi, :saikuro]
-    config.graphs   = [:flog, :flay, :reek, :roodi]
-    config.flay     = { :dirs_to_flay => ['spec', 'lib']  }
-    config.flog     = { :dirs_to_flog => ['spec', 'lib']  }
-    config.reek     = { :dirs_to_reek => ['spec', 'lib']  }
-    config.roodi    = { :dirs_to_roodi => ['spec', 'lib'] }
-    config.churn    = { :start_date => "1 year ago", :minimum_churn_count => 10}
-  end
-rescue LoadError
-end
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "ar-octopus"
-    gem.summary = "Easy Database Sharding for ActiveRecord"
-    gem.description = "This gem allows you to use sharded databases with ActiveRecord. this also provides a interface for replication and for running migrations with multiples shards."
-    gem.email = "tchandy@gmail.com"
-    gem.homepage = "http://github.com/tchandy/octopus"
-    gem.authors = ["Thiago Pradi", "Mike Perham"]
-    gem.add_development_dependency "rspec", ">= 2.0.0.beta.19"
-    gem.add_development_dependency "mysql2"
-    gem.add_development_dependency "pg", ">= 0.9.0"
-    gem.add_development_dependency "sqlite3-ruby", ">= 1.3.1"
-    gem.add_development_dependency "jeweler", ">= 1.4"
-    gem.add_development_dependency "actionpack", ">= 2.3"
-    gem.add_dependency('activerecord', '>= 2.3')
-    gem.version = "0.4.0"
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
-end
-
-require 'rspec/core'
+require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec) do |spec|
-end
-
-RSpec::Core::RakeTask.new(:rcov) do |spec|
-end
+require 'appraisal'
 
 task :default => :spec
 
+RSpec::Core::RakeTask.new(:spec) do |spec|
+end
 
 namespace :db do
   desc 'Build the databases for tests'
   task :build_databases do
-    mysql_user = ENV['MYSQL_USER'] || "root"
-    postgres_user = ENV['POSTGRES_USER'] || "postgres"
-    (1..5).each do |idx|
-      %x( echo "create DATABASE octopus_shard#{idx} DEFAULT CHARACTER SET utf8 DEFAULT COLLATE utf8_unicode_ci " | mysql --user=#{mysql_user})
+    pg_spec = {
+      :adapter  => 'postgresql',
+      :host     => 'localhost',
+      :username => (ENV['POSTGRES_USER'] || "postgres"),
+      :encoding => 'utf8'
+    }
+
+    mysql_spec = {
+      :adapter  => 'mysql',
+      :host     => 'localhost',
+      :username => (ENV['MYSQL_USER'] || "root"),
+      :encoding => 'utf8'
+    }
+
+    %x( rm -f /tmp/database.sqlite3 )
+
+    require "active_record"
+
+    # Connects to PostgreSQL
+    ActiveRecord::Base.establish_connection(pg_spec.merge('database' => 'postgres', 'schema_search_path' => 'public'))
+    (1..2).map do |i|
+      # drop the old database (if it exists)
+      ActiveRecord::Base.connection.drop_database("octopus_shard_#{i}")
+      # create new database
+      ActiveRecord::Base.connection.create_database("octopus_shard_#{i}")
     end
 
-    %x( createdb -E UTF8 -U #{postgres_user} octopus_shard1 )
-  end
-
-  desc 'Drop the tests databases'
-  task :drop_databases do
-    mysql_user = ENV['MYSQL_USER'] || "root"
-    postgres_user = ENV['POSTGRES_USER'] || "postgres"
-    (1..5).each do |idx|
-      %x( mysqladmin --user=#{mysql_user} -f drop octopus_shard#{idx} )
+    # Connect to MYSQL
+    ActiveRecord::Base.establish_connection(mysql_spec)
+    (1..5).map do |i|
+      # drop the old database (if it exists)
+      ActiveRecord::Base.connection.drop_database("octopus_shard_#{i}")
+      # create new database
+      ActiveRecord::Base.connection.create_database("octopus_shard_#{i}")
     end
-
-    %x( dropdb -U #{postgres_user} octopus_shard1 )
-    %x(rm -f /tmp/database.sqlite3)
   end
 
   desc 'Create tables on tests databases'
   task :create_tables do
-    Dir.chdir(File.expand_path(File.dirname(__FILE__) + "/spec"))
-    require "database_connection"
     require "octopus"
-    [:master, :brazil, :canada, :russia, :alone_shard, :postgresql_shard, :sqlite_shard].each do |shard_symbol|
-      ActiveRecord::Base.using(shard_symbol).connection.initialize_schema_migrations_table()
+    # Set the octopus variable directory to spec dir, in order to load the config/shards.yml file.
+    Octopus.instance_variable_set(:@directory, "#{File.dirname(__FILE__)}/spec/" )
+
+    # Require the database connection
+    require "#{File.dirname(__FILE__)}/spec/support/database_connection"
+
+    [:master, :brazil, :canada, :russia, :alone_shard, :postgresql_shard, :sqlite_shard, :protocol_shard].each do |shard_symbol|
+      # Rails 3.1 needs to do some introspection around the base class, which requires
+      # the model be a descendent of ActiveRecord::Base.
+      class BlankModel < ActiveRecord::Base; end;
+
+      BlankModel.using(shard_symbol).connection.initialize_schema_migrations_table()
 
-      ActiveRecord::Base.using(shard_symbol).connection.create_table(:users) do |u|
+      BlankModel.using(shard_symbol).connection.create_table(:users) do |u|
         u.string :name
         u.integer :number
         u.boolean :admin
+        u.datetime :created_at
+        u.datetime :updated_at
       end
 
-      ActiveRecord::Base.using(shard_symbol).connection.create_table(:clients) do |u|
+      BlankModel.using(shard_symbol).connection.create_table(:clients) do |u|
         u.string :country
         u.string :name
       end
 
-      ActiveRecord::Base.using(shard_symbol).connection.create_table(:cats) do |u|
+      BlankModel.using(shard_symbol).connection.create_table(:cats) do |u|
         u.string :name
       end
 
-      ActiveRecord::Base.using(shard_symbol).connection.create_table(:items) do |u|
+      BlankModel.using(shard_symbol).connection.create_table(:items) do |u|
         u.string :name
         u.integer :client_id
       end
 
-      ActiveRecord::Base.using(shard_symbol).connection.create_table(:computers) do |u|
+      BlankModel.using(shard_symbol).connection.create_table(:computers) do |u|
         u.string :name
       end
 
-      ActiveRecord::Base.using(shard_symbol).connection.create_table(:keyboards) do |u|
+      BlankModel.using(shard_symbol).connection.create_table(:keyboards) do |u|
         u.string :name
         u.integer :computer_id
       end
 
-      ActiveRecord::Base.using(shard_symbol).connection.create_table(:roles) do |u|
+      BlankModel.using(shard_symbol).connection.create_table(:roles) do |u|
         u.string :name
       end
 
-      ActiveRecord::Base.using(shard_symbol).connection.create_table(:permissions) do |u|
+      BlankModel.using(shard_symbol).connection.create_table(:permissions) do |u|
         u.string :name
       end
 
-      ActiveRecord::Base.using(shard_symbol).connection.create_table(:permissions_roles, :id => false) do |u|
+      BlankModel.using(shard_symbol).connection.create_table(:permissions_roles, :id => false) do |u|
         u.integer :role_id
         u.integer :permission_id
       end
 
-      ActiveRecord::Base.using(shard_symbol).connection.create_table(:assignments) do |u|
+      BlankModel.using(shard_symbol).connection.create_table(:assignments) do |u|
         u.integer :programmer_id
         u.integer :project_id
       end
 
-      ActiveRecord::Base.using(shard_symbol).connection.create_table(:programmers) do |u|
+      BlankModel.using(shard_symbol).connection.create_table(:programmers) do |u|
         u.string :name
       end
 
-      ActiveRecord::Base.using(shard_symbol).connection.create_table(:projects) do |u|
+      BlankModel.using(shard_symbol).connection.create_table(:projects) do |u|
         u.string :name
       end
 
-      ActiveRecord::Base.using(shard_symbol).connection.create_table(:comments) do |u|
+      BlankModel.using(shard_symbol).connection.create_table(:comments) do |u|
         u.string :name
         u.string :commentable_type
         u.integer :commentable_id
       end
 
-      ActiveRecord::Base.using(shard_symbol).connection.create_table(:parts) do |u|
+      BlankModel.using(shard_symbol).connection.create_table(:parts) do |u|
         u.string :name
         u.integer :item_id
       end
 
-      ActiveRecord::Base.using(shard_symbol).connection.create_table(:yummy) do |u|
+      BlankModel.using(shard_symbol).connection.create_table(:yummy) do |u|
+        u.string :name
+      end
+
+      BlankModel.using(shard_symbol).connection.create_table(:adverts) do |u|
         u.string :name
       end
     end
   end
 
   desc 'Prepare the test databases'
-  task :prepare => [:drop_databases, :build_databases, :create_tables]
+  task :prepare => [:build_databases, :create_tables]
 end
-
-
-