ar-octopus 0.4.0 → 0.5.0

data/lib/octopus/rails2/persistence.rb

@@ -2,7 +2,7 @@ module Octopus
   module Rails2
     module Persistence
       def self.included(base)
-        base.instance_eval do 
+        base.instance_eval do
           alias_method_chain :destroy, :octopus
           alias_method_chain :delete, :octopus
           alias_method_chain :reload, :octopus

data/lib/octopus/rails2/scope.rb

@@ -0,0 +1,17 @@
+module Octopus
+  module Rails2
+    module Scope
+      def self.included(base)
+        base.instance_eval do
+          alias_method_chain :proxy_found, :octopus
+        end
+      end
+
+      def proxy_found_with_octopus
+        load_found
+      end
+    end
+  end
+end
+
+ActiveRecord::NamedScope::Scope.send(:include, Octopus::Rails2::Scope)

data/lib/octopus/rails3.1/singular_association.rb

@@ -0,0 +1,34 @@
+module Octopus::SingularAssociation
+  def self.included(base)
+    base.instance_eval do
+      alias_method_chain :reader, :octopus
+      alias_method_chain :writer, :octopus
+      alias_method_chain :create, :octopus
+      alias_method_chain :create!, :octopus
+      alias_method_chain :build, :octopus
+    end
+  end
+
+  def reader_with_octopus(*args)
+    owner.reload_connection_safe { reader_without_octopus(*args) }
+  end
+
+  def writer_with_octopus(*args)
+    owner.reload_connection_safe { writer_without_octopus(*args) }
+  end
+
+  def create_with_octopus(*args)
+    owner.reload_connection_safe { create_without_octopus(*args) }
+  end
+
+  def create_with_octopus!(*args)
+    owner.reload_connection_safe { create_without_octopus!(*args) }
+  end
+
+  def build_with_octopus(*args)
+    owner.reload_connection_safe { build_without_octopus(*args) }
+  end
+
+end
+
+ActiveRecord::Associations::SingularAssociation.send(:include, Octopus::SingularAssociation)

data/lib/octopus/rails3.2/persistence.rb

@@ -0,0 +1,12 @@
+module Octopus
+  module Rails32
+    module Persistence
+      def update_column(*args)
+        reload_connection()
+        super
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send(:include, Octopus::Rails32::Persistence)

data/lib/octopus/rails3/abstract_adapter.rb

@@ -0,0 +1,39 @@
+# Implementation courtesy of db-charmer.
+module Octopus
+  module AbstractAdapter
+    module OctopusShard
+
+      class InstrumenterDecorator < ActiveSupport::BasicObject
+        def initialize(adapter, instrumenter)
+          @adapter = adapter
+          @instrumenter = instrumenter
+        end
+
+        def instrument(name, payload = {}, &block)
+          payload[:octopus_shard] ||= @adapter.octopus_shard
+          @instrumenter.instrument(name, payload, &block)
+        end
+
+        def method_missing(meth, *args, &block)
+          @instrumenter.send(meth, *args, &block)
+        end
+      end
+
+      def self.included(base)
+        base.alias_method_chain :initialize, :octopus_shard
+      end
+
+      def octopus_shard
+        @config[:octopus_shard]
+      end
+
+      def initialize_with_octopus_shard(*args)
+        initialize_without_octopus_shard(*args)
+        @instrumenter = InstrumenterDecorator.new(self, @instrumenter)
+      end
+
+    end
+  end
+end
+
+ActiveRecord::ConnectionAdapters::AbstractAdapter.send(:include, Octopus::AbstractAdapter::OctopusShard)

data/lib/octopus/rails3/arel.rb

@@ -1,13 +1,13 @@
 class Arel::Visitors::ToSql
   def quote value, column = nil
-    ActiveRecord::Base.connection.quote value, column
+    @connection.quote value, column
   end
-  
+
   def quote_table_name name
-    ActiveRecord::Base.connection.quote_table_name(name)
+    @connection.quote_table_name(name)
   end
 
   def quote_column_name name
-    Arel::Nodes::SqlLiteral === name ? name : ActiveRecord::Base.connection.quote_column_name(name)
+    Arel::Nodes::SqlLiteral === name ? name : @connection.quote_column_name(name)
   end
-end
+end

data/lib/octopus/rails3/log_subscriber.rb

@@ -0,0 +1,22 @@
+# Implementation courtesy of db-charmer.
+module Octopus
+  module LogSubscriber
+    def self.included(base)
+      base.send(:attr_accessor, :octopus_shard)
+      base.alias_method_chain :sql, :octopus_shard
+      base.alias_method_chain :debug, :octopus_shard
+    end
+
+    def sql_with_octopus_shard(event)
+      self.octopus_shard = event.payload[:octopus_shard]
+      sql_without_octopus_shard(event)
+    end
+
+    def debug_with_octopus_shard(msg)
+      conn = octopus_shard ? color("[Shard: #{octopus_shard}]", ActiveSupport::LogSubscriber::GREEN, true) : ''
+      debug_without_octopus_shard(conn + msg)
+    end
+  end
+end
+
+ActiveRecord::LogSubscriber.send(:include, Octopus::LogSubscriber)

data/lib/octopus/rails3/persistence.rb

@@ -1,24 +1,24 @@
 module Octopus
   module Rails3
     module Persistence
-      def update_attribute(name, value)
+      def update_attribute(*args)
         reload_connection()
         super
       end
 
-      def update_attributes(attributes)
+      def update_attributes(*args)
         reload_connection()
         super
       end
 
-      def update_attributes!(attributes)
+      def update_attributes!(*args)
         reload_connection()
         super
       end
 
-      def reload(options = nil)
+      def reload(*args)
         reload_connection()
-        super(options)
+        super
       end
 
       def delete
@@ -30,6 +30,11 @@ module Octopus
         reload_connection()
         super
       end
+
+      def touch(name=nil)
+        reload_connection()
+        super
+      end
     end
   end
 end

data/lib/octopus/railtie.rb

@@ -0,0 +1,13 @@
+begin
+  require "rails/railtie"
+
+  module Octopus
+    class Railtie < Rails::Railtie
+      rake_tasks do
+        Dir[File.join(File.dirname(__FILE__), "../tasks/*.rake")].each { |ext| load ext }
+      end
+    end
+  end
+rescue LoadError
+  # nop
+end

data/lib/octopus/scope_proxy.rb

@@ -1,40 +1,46 @@
 class Octopus::ScopeProxy
   attr_accessor :shard, :klass
-  
+
   def initialize(shard, klass)
     @shard = shard
     @klass = klass
   end
-  
+
   def using(shard)
     raise "Nonexistent Shard Name: #{shard}" if @klass.connection.instance_variable_get(:@shards)[shard].nil?
     @shard = shard
     return self
   end
-  
+
   # Transaction Method send all queries to a specified shard.
   def transaction(options = {}, &block)
     @klass.connection.run_queries_on_shard(@shard) do
       @klass = @klass.connection().transaction(options, &block)
-    end      
+    end
   end
-    
+
   def connection
     @klass.connection().current_shard = @shard
     @klass.connection()
   end
-  
-  def method_missing(method, *args, &block)        
-    @klass.connection.run_queries_on_shard(@shard) do
-      @klass = @klass.send(method, *args, &block)
+
+  def method_missing(method, *args, &block)
+    result = @klass.connection.run_queries_on_shard(@shard) do
+      @klass.send(method, *args, &block)
     end
-                
-    return @klass if @klass.is_a?(ActiveRecord::Base) or @klass.is_a?(Array) or @klass.is_a?(Fixnum) or @klass.nil?
-    return self
+
+    if result.respond_to?(:scoped)
+      @klass = result
+      return self
+    end
+
+    result
   end
-  
-  def ==(other)
-    @shard == other.shard
-    @klass == other.klass
+
+  # Delegates to method_missing (instead of @klass) so that User.using(:blah).where(:name => "Mike")
+  # gets run in the correct shard context when #== is evaluated.
+  def ==(*args)
+    method_missing(:==, *args)
   end
+  alias :eql? :==
 end

data/lib/octopus/version.rb

@@ -0,0 +1,3 @@
+module Octopus
+  VERSION = '0.5.0'
+end

data/lib/tasks/octopus.rake

@@ -0,0 +1,20 @@
+namespace :octopus do
+  desc "Copy schema version information from master to all shards"
+  task :copy_schema_versions => :environment do
+    abort("Octopus is not enabled for this environment") unless Octopus.enabled?
+
+    connection = ActiveRecord::Base.connection
+
+    current_version  = ActiveRecord::Migrator.current_version
+    migrations_paths = if Octopus.rails31? || Octopus.rails32?
+                         ActiveRecord::Migrator.migrations_paths
+                       else
+                         ActiveRecord::Migrator.migrations_path
+                       end
+
+    connection.send_queries_to_multiple_shards(connection.shard_names) do
+      ActiveRecord::Schema.initialize_schema_migrations_table
+      ActiveRecord::Schema.assume_migrated_upto_version(current_version, migrations_paths)
+    end
+  end
+end

data/sample_app/Gemfile

@@ -8,13 +8,13 @@ gem 'rails', '3.0.5'
 gem 'sqlite3-ruby', :require => 'sqlite3'
 gem 'ar-octopus', :git => 'git://github.com/tchandy/octopus.git', :require => "octopus"
 
-group :test do 
+group :test do
   gem 'capybara'
   gem 'database_cleaner'
   gem 'cucumber-rails'
   gem 'cucumber'
   gem 'spork'
-  gem 'launchy'   
+  gem 'launchy'
   gem "rspec-rails", ">= 2.0.0.beta.16"
   gem 'ruby-debug' if RUBY_VERSION < "1.9"
   gem "aruba"

data/sample_app/config/initializers/inflections.rb

@@ -1,6 +1,6 @@
 # Be sure to restart your server when you modify this file.
 
-# Add new inflection rules using the following format 
+# Add new inflection rules using the following format
 # (all these examples are active by default):
 # ActiveSupport::Inflector.inflections do |inflect|
 #   inflect.plural /^(ox)$/i, '\1en'

data/sample_app/config/initializers/secret_token.rb

@@ -2,6 +2,6 @@
 
 # Your secret key for verifying the integrity of signed cookies.
 # If you change this key, all old signed cookies will become invalid!
-# Make sure the secret is at least 30 characters and all random, 
+# Make sure the secret is at least 30 characters and all random,
 # no regular words or you'll be exposed to dictionary attacks.
 Rails.application.config.secret_token = '1b60fd7d627c1749f508e1578d14555c4c2122a8988e34f94c8e9dbe62df7f688462445badf79594a193542a32d0b1fdbfdf2c42539e212cbf6ad9b1c769c6f6'

data/sample_app/db/migrate/20100720172730_create_items.rb

@@ -1,6 +1,6 @@
 class CreateItems < ActiveRecord::Migration
   using(:master, :asia, :europe, :america)
-  
+
   def self.up
     create_table :items do |t|
       t.string :name

data/sample_app/db/migrate/20100720210335_create_sample_users.rb

@@ -1,6 +1,6 @@
 class CreateSampleUsers < ActiveRecord::Migration
   using(:master, :asia, :europe, :america)
-  
+
   def self.up
     User.create!(:name => "Exception")
   end

data/sample_app/db/seeds.rb

@@ -9,7 +9,7 @@ Octopus.using(:asia) do
   User.create!(:name => "Asia User")
 end
 
-Octopus.using(:america) do 
+Octopus.using(:america) do
   users_america = User.create([{ :name => 'America User 1' }, { :name => 'America User 2' }])
 end
 

data/sample_app/features/migrate.feature

@@ -4,16 +4,16 @@ Feature: rake db:migrate
   I want to use the rake db:migrate command
 
   Scenario: db:migrate should work with octopus
-    When I run inside my Rails project "rake db:migrate" with enviroment "development"  
+    When I run inside my Rails project "rake db:migrate" with enviroment "development"
     Then the output should contain "CreateUsers: migrating - Shard: master"
     Then the output should contain "CreateUsers: migrating - Shard: asia"
     Then the output should contain "CreateUsers: migrating - Shard: europe"
     Then the output should contain "CreateUsers: migrating - Shard: america"
 
   Scenario: db:migrate:redo should work with octopus
-    When I run inside my Rails project "rake db:migrate VERSION=20100720172715" with enviroment "development"  
-    When I run inside my Rails project "rake db:migrate VERSION=20100720172730" with enviroment "development"  
-    When I run inside my Rails project "rake db:migrate:redo" with enviroment "development"  
+    When I run inside my Rails project "rake db:migrate VERSION=20100720172715" with enviroment "development"
+    When I run inside my Rails project "rake db:migrate VERSION=20100720172730" with enviroment "development"
+    When I run inside my Rails project "rake db:migrate:redo" with enviroment "development"
     Then the output should contain "CreateItems: reverting - Shard: master"
     Then the output should contain "CreateItems: reverting - Shard: asia"
     Then the output should contain "CreateItems: reverting - Shard: europe"
@@ -22,9 +22,9 @@ Feature: rake db:migrate
     Then the output should contain "CreateItems: migrating - Shard: asia"
     Then the output should contain "CreateItems: migrating - Shard: europe"
     Then the output should contain "CreateItems: migrating - Shard: america"
-    
+
   Scenario: db:migrate finishing the migration
-    When I run inside my Rails project "rake db:migrate" with enviroment "development"  
+    When I run inside my Rails project "rake db:migrate" with enviroment "development"
     Then the output should contain "CreateSampleUsers: migrating - Shard: america"
     Then the output should contain "CreateSampleUsers: migrating - Shard: master"
     Then the output should contain "CreateSampleUsers: migrating - Shard: asia"
@@ -34,12 +34,12 @@ Feature: rake db:migrate
     Then the version of "america" shard should be "nil"
     Then the version of "europe" shard should be "nil"
     Then the version of "asia" shard should be "nil"
-    
+
   Scenario: after running rake db:migrate
-    When I run inside my Rails project "rake db:abort_if_pending_migrations" with enviroment "development"  
+    When I run inside my Rails project "rake db:abort_if_pending_migrations" with enviroment "development"
     Then the output should contain "pending migrations"
-    When I run inside my Rails project "rake db:migrate" with enviroment "development"  
-    When I run inside my Rails project "rake db:abort_if_pending_migrations RAILS_ENV=development" with enviroment "development"  
+    When I run inside my Rails project "rake db:migrate" with enviroment "development"
+    When I run inside my Rails project "rake db:abort_if_pending_migrations RAILS_ENV=development" with enviroment "development"
     Then the output should not contain "pending migrations"
-    
-  
+
+

data/sample_app/features/seed.feature

@@ -4,12 +4,12 @@ Feature: rake db:seed
   I want to use the rake db:seed command
 
   Scenario: db:seed should fail
-    When I run inside my Rails project "rake db:seed" with enviroment "development"   
+    When I run inside my Rails project "rake db:seed" with enviroment "development"
     Then the output should contain "pending migrations"
-    
+
   Scenario: db:seed should work with octopus
     When I run inside my Rails project "rake db:migrate" with enviroment "development"
-    When I run inside my Rails project "rake db:seed" with enviroment "development"   
+    When I run inside my Rails project "rake db:seed" with enviroment "development"
     Then the "asia" shard should have one user named "Asia User"
     Then the "america" shard should have one user named "America User 1"
     Then the "america" shard should have one user named "America User 2"

data/sample_app/features/step_definitions/web_steps.rb

@@ -1,6 +1,6 @@
 # IMPORTANT: This file is generated by cucumber-rails - edit at your own peril.
-# It is recommended to regenerate this file in the future when you upgrade to a 
-# newer version of cucumber-rails. Consider adding your own code to a new file 
+# It is recommended to regenerate this file in the future when you upgrade to a
+# newer version of cucumber-rails. Consider adding your own code to a new file
 # instead of editing this one. Cucumber will automatically load all features/**/*.rb
 # files.
 
@@ -191,7 +191,7 @@ Then /^the "([^"]*)" checkbox(?: within "([^"]*)")? should not be checked$/ do |
     end
   end
 end
- 
+
 Then /^(?:|I )should be on (.+)$/ do |page_name|
   current_path = URI.parse(current_url).path
   if current_path.respond_to? :should
@@ -205,8 +205,8 @@ Then /^(?:|I )should have the following query string:$/ do |expected_pairs|
   query = URI.parse(current_url).query
   actual_params = query ? CGI.parse(query) : {}
   expected_params = {}
-  expected_pairs.rows_hash.each_pair{|k,v| expected_params[k] = v.split(',')} 
-  
+  expected_pairs.rows_hash.each_pair{|k,v| expected_params[k] = v.split(',')}
+
   if actual_params.respond_to? :should
     actual_params.should == expected_params
   else