ar-octopus 0.4.0 → 0.5.0

data/ar-octopus.gemspec

@@ -1,206 +1,33 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "octopus/version"
 
 Gem::Specification.new do |s|
-  s.name = %q{ar-octopus}
-  s.version = "0.4.0"
+  s.name        = "ar-octopus"
+  s.version     = Octopus::VERSION
+  s.authors     = ["Thiago Pradi", "Mike Perham", "Gabriel Sobrinho"]
+  s.email       = ["tchandy@gmail.com", "mperham@gmail.com", "gabriel.sobrinho@gmail.com"]
+  s.homepage    = "https://github.com/tchandy/octopus"
+  s.summary     = %q{Easy Database Sharding for ActiveRecord}
+  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.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Thiago Pradi", "Mike Perham"]
-  s.date = %q{2011-07-03}
-  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 = [
-    "README.mkdn"
-  ]
-  s.files = [
-    ".rspec",
-    "Gemfile",
-    "Gemfile.lock",
-    "README.mkdn",
-    "Rakefile",
-    "TODO.txt",
-    "ar-octopus.gemspec",
-    "init.rb",
-    "lib/octopus.rb",
-    "lib/octopus/association.rb",
-    "lib/octopus/association_collection.rb",
-    "lib/octopus/has_and_belongs_to_many_association.rb",
-    "lib/octopus/logger.rb",
-    "lib/octopus/migration.rb",
-    "lib/octopus/model.rb",
-    "lib/octopus/proxy.rb",
-    "lib/octopus/rails2/association.rb",
-    "lib/octopus/rails2/persistence.rb",
-    "lib/octopus/rails3/arel.rb",
-    "lib/octopus/rails3/association.rb",
-    "lib/octopus/rails3/persistence.rb",
-    "lib/octopus/scope_proxy.rb",
-    "rails/init.rb",
-    "sample_app/.gitignore",
-    "sample_app/.rspec",
-    "sample_app/Gemfile",
-    "sample_app/Gemfile.lock",
-    "sample_app/README",
-    "sample_app/Rakefile",
-    "sample_app/app/controllers/application_controller.rb",
-    "sample_app/app/helpers/application_helper.rb",
-    "sample_app/app/models/item.rb",
-    "sample_app/app/models/user.rb",
-    "sample_app/app/views/layouts/application.html.erb",
-    "sample_app/autotest/discover.rb",
-    "sample_app/config.ru",
-    "sample_app/config/application.rb",
-    "sample_app/config/boot.rb",
-    "sample_app/config/cucumber.yml",
-    "sample_app/config/database.yml",
-    "sample_app/config/environment.rb",
-    "sample_app/config/environments/development.rb",
-    "sample_app/config/environments/production.rb",
-    "sample_app/config/environments/test.rb",
-    "sample_app/config/initializers/backtrace_silencers.rb",
-    "sample_app/config/initializers/inflections.rb",
-    "sample_app/config/initializers/mime_types.rb",
-    "sample_app/config/initializers/secret_token.rb",
-    "sample_app/config/initializers/session_store.rb",
-    "sample_app/config/locales/en.yml",
-    "sample_app/config/routes.rb",
-    "sample_app/config/shards.yml",
-    "sample_app/db/migrate/20100720172715_create_users.rb",
-    "sample_app/db/migrate/20100720172730_create_items.rb",
-    "sample_app/db/migrate/20100720210335_create_sample_users.rb",
-    "sample_app/db/schema.rb",
-    "sample_app/db/seeds.rb",
-    "sample_app/doc/README_FOR_APP",
-    "sample_app/features/migrate.feature",
-    "sample_app/features/seed.feature",
-    "sample_app/features/step_definitions/seeds_steps.rb",
-    "sample_app/features/step_definitions/web_steps.rb",
-    "sample_app/features/support/env.rb",
-    "sample_app/features/support/paths.rb",
-    "sample_app/lib/tasks/.gitkeep",
-    "sample_app/lib/tasks/cucumber.rake",
-    "sample_app/public/404.html",
-    "sample_app/public/422.html",
-    "sample_app/public/500.html",
-    "sample_app/public/favicon.ico",
-    "sample_app/public/images/rails.png",
-    "sample_app/public/index.html",
-    "sample_app/public/javascripts/application.js",
-    "sample_app/public/javascripts/controls.js",
-    "sample_app/public/javascripts/dragdrop.js",
-    "sample_app/public/javascripts/effects.js",
-    "sample_app/public/javascripts/prototype.js",
-    "sample_app/public/javascripts/rails.js",
-    "sample_app/public/robots.txt",
-    "sample_app/public/stylesheets/.gitkeep",
-    "sample_app/script/cucumber",
-    "sample_app/script/rails",
-    "sample_app/spec/models/item_spec.rb",
-    "sample_app/spec/models/user_spec.rb",
-    "sample_app/spec/spec_helper.rb",
-    "sample_app/test/performance/browsing_test.rb",
-    "sample_app/test/test_helper.rb",
-    "sample_app/vendor/plugins/.gitkeep",
-    "spec/config/shards.yml",
-    "spec/database_connection.rb",
-    "spec/database_models.rb",
-    "spec/migrations/10_create_users_using_replication.rb",
-    "spec/migrations/11_add_field_in_all_slaves.rb",
-    "spec/migrations/12_create_users_using_block.rb",
-    "spec/migrations/13_create_users_using_block_and_using.rb",
-    "spec/migrations/1_create_users_on_master.rb",
-    "spec/migrations/2_create_users_on_canada.rb",
-    "spec/migrations/3_create_users_on_both_shards.rb",
-    "spec/migrations/4_create_users_on_shards_of_a_group.rb",
-    "spec/migrations/5_create_users_on_multiples_groups.rb",
-    "spec/migrations/6_raise_exception_with_invalid_shard_name.rb",
-    "spec/migrations/7_raise_exception_with_invalid_multiple_shard_names.rb",
-    "spec/migrations/8_raise_exception_with_invalid_group_name.rb",
-    "spec/migrations/9_raise_exception_with_multiple_invalid_group_names.rb",
-    "spec/octopus/association_spec.rb",
-    "spec/octopus/controller_spec.rb",
-    "spec/octopus/logger_spec.rb",
-    "spec/octopus/migration_spec.rb",
-    "spec/octopus/model_spec.rb",
-    "spec/octopus/octopus_spec.rb",
-    "spec/octopus/proxy_spec.rb",
-    "spec/octopus/replication_specs.rb",
-    "spec/octopus/scope_proxy_spec.rb",
-    "spec/octopus/sharded_spec.rb",
-    "spec/octopus_helper.rb",
-    "spec/spec_helper.rb"
-  ]
-  s.homepage = %q{http://github.com/tchandy/octopus}
+  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.rubygems_version = %q{1.4.2}
-  s.summary = %q{Easy Database Sharding for ActiveRecord}
-  s.test_files = [
-    "spec/database_connection.rb",
-    "spec/database_models.rb",
-    "spec/migrations/10_create_users_using_replication.rb",
-    "spec/migrations/11_add_field_in_all_slaves.rb",
-    "spec/migrations/12_create_users_using_block.rb",
-    "spec/migrations/13_create_users_using_block_and_using.rb",
-    "spec/migrations/1_create_users_on_master.rb",
-    "spec/migrations/2_create_users_on_canada.rb",
-    "spec/migrations/3_create_users_on_both_shards.rb",
-    "spec/migrations/4_create_users_on_shards_of_a_group.rb",
-    "spec/migrations/5_create_users_on_multiples_groups.rb",
-    "spec/migrations/6_raise_exception_with_invalid_shard_name.rb",
-    "spec/migrations/7_raise_exception_with_invalid_multiple_shard_names.rb",
-    "spec/migrations/8_raise_exception_with_invalid_group_name.rb",
-    "spec/migrations/9_raise_exception_with_multiple_invalid_group_names.rb",
-    "spec/octopus/association_spec.rb",
-    "spec/octopus/controller_spec.rb",
-    "spec/octopus/logger_spec.rb",
-    "spec/octopus/migration_spec.rb",
-    "spec/octopus/model_spec.rb",
-    "spec/octopus/octopus_spec.rb",
-    "spec/octopus/proxy_spec.rb",
-    "spec/octopus/replication_specs.rb",
-    "spec/octopus/scope_proxy_spec.rb",
-    "spec/octopus/sharded_spec.rb",
-    "spec/octopus_helper.rb",
-    "spec/spec_helper.rb"
-  ]
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
+  s.post_install_message = "Important: If you are upgrading from < Octopus 0.5.0 you need to run:\n" \
+                           "$ rake octopus:copy_schema_versions\n\n" \
+                           "Octopus now stores schema version information in each shard and migrations will not " \
+                           "work properly unless this task is invoked."
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<activerecord>, ["= 3.0.6"])
-      s.add_runtime_dependency(%q<actionpack>, ["= 3.0.6"])
-      s.add_development_dependency(%q<rspec>, [">= 2.0.0.beta.19"])
-      s.add_development_dependency(%q<mysql2>, [">= 0"])
-      s.add_development_dependency(%q<pg>, [">= 0.9.0"])
-      s.add_development_dependency(%q<sqlite3-ruby>, [">= 1.3.1"])
-      s.add_development_dependency(%q<jeweler>, [">= 1.4"])
-      s.add_development_dependency(%q<actionpack>, [">= 2.3"])
-      s.add_runtime_dependency(%q<activerecord>, [">= 2.3"])
-    else
-      s.add_dependency(%q<activerecord>, ["= 3.0.6"])
-      s.add_dependency(%q<actionpack>, ["= 3.0.6"])
-      s.add_dependency(%q<rspec>, [">= 2.0.0.beta.19"])
-      s.add_dependency(%q<mysql2>, [">= 0"])
-      s.add_dependency(%q<pg>, [">= 0.9.0"])
-      s.add_dependency(%q<sqlite3-ruby>, [">= 1.3.1"])
-      s.add_dependency(%q<jeweler>, [">= 1.4"])
-      s.add_dependency(%q<actionpack>, [">= 2.3"])
-      s.add_dependency(%q<activerecord>, [">= 2.3"])
-    end
-  else
-    s.add_dependency(%q<activerecord>, ["= 3.0.6"])
-    s.add_dependency(%q<actionpack>, ["= 3.0.6"])
-    s.add_dependency(%q<rspec>, [">= 2.0.0.beta.19"])
-    s.add_dependency(%q<mysql2>, [">= 0"])
-    s.add_dependency(%q<pg>, [">= 0.9.0"])
-    s.add_dependency(%q<sqlite3-ruby>, [">= 1.3.1"])
-    s.add_dependency(%q<jeweler>, [">= 1.4"])
-    s.add_dependency(%q<actionpack>, [">= 2.3"])
-    s.add_dependency(%q<activerecord>, [">= 2.3"])
-  end
+  s.add_dependency 'activerecord', '>= 2.3.0'
+  s.add_dependency 'activesupport', '>= 2.3.0'
+  s.add_development_dependency 'rake', '>= 0.8.7'
+  s.add_development_dependency 'rspec', '>= 2.0.0'
+  s.add_development_dependency 'mysql', '2.8.1'
+  s.add_development_dependency 'pg', '>= 0.11.0'
+  s.add_development_dependency 'sqlite3', '>= 1.3.4'
+  s.add_development_dependency 'pry'
+  s.add_development_dependency 'appraisal', '>= 0.3.8'
 end
-

data/lib/ar-octopus.rb

@@ -0,0 +1 @@
+require "octopus"

data/lib/octopus.rb

@@ -1,3 +1,7 @@
+require 'active_record'
+require 'active_support/version'
+require 'active_support/core_ext/class'
+
 require "yaml"
 require "erb"
 
@@ -10,26 +14,39 @@ module Octopus
     @rails_env ||= self.rails? ? Rails.env.to_s : 'shards'
   end
 
-  def self.config()
-    file_name = Octopus.directory() + "/config/shards.yml"
-
-    if File.exists? file_name
-      @config ||= HashWithIndifferentAccess.new(YAML.load(ERB.new(File.open(file_name).read()).result))[Octopus.env()]
+  def self.config
+    @config ||= begin
+      file_name = Octopus.directory() + "/config/shards.yml"
 
-      if @config && @config['environments']
-        self.environments = @config['environments']
+      if File.exists?(file_name)
+        config ||= HashWithIndifferentAccess.new(YAML.load(ERB.new(File.read(file_name)).result))[Octopus.env()]
+      else
+        config ||= HashWithIndifferentAccess.new
       end
-    else
-      @config ||= HashWithIndifferentAccess.new
+
+      config
     end
+  end
 
-    @config
+  # Public: Whether or not Octopus is configured and should hook into the
+  # current environment. Checks the environments config option for the Rails
+  # environment by default.
+  #
+  # Returns a boolean
+  def self.enabled?
+    if defined?(::Rails)
+      Octopus.environments.include?(Rails.env.to_s)
+    else
+      # TODO: This doens't feel right but !Octopus.config.blank? is breaking a
+      #       test. Also, Octopus.config is always returning a hash.
+      Octopus.config
+    end
   end
 
   # Returns the Rails.root_to_s when you are using rails
   # Running the current directory in a generic Ruby process
   def self.directory()
-    @directory ||= defined?(Rails) ?  Rails.root.to_s : Dir.pwd     
+    @directory ||= defined?(Rails) ?  Rails.root.to_s : Dir.pwd
   end
 
   # This is the default way to do Octopus Setup
@@ -44,33 +61,47 @@ module Octopus
   end
 
   def self.environments
-    @environments || ['production']
+    @environments ||= config['environments'] || ['production']
+  end
+
+  def self.rails2?
+    ActiveRecord::VERSION::MAJOR == 2
   end
 
   def self.rails3?
     ActiveRecord::VERSION::MAJOR == 3
   end
 
+  def self.rails30?
+    ActiveRecord::VERSION::MAJOR == 3 && ActiveRecord::VERSION::MINOR == 0
+  end
+
+  def self.rails31?
+    ActiveRecord::VERSION::MAJOR == 3 && ActiveRecord::VERSION::MINOR == 1
+  end
+
+  def self.rails32?
+    ActiveRecord::VERSION::MAJOR == 3 && ActiveRecord::VERSION::MINOR == 2
+  end
+
   def self.rails?
-    defined?(Rails) 
+    defined?(Rails)
   end
-  
+
   def self.shards=(shards)
-    @config ||= HashWithIndifferentAccess.new
-    @config[rails_env()] = HashWithIndifferentAccess.new(shards)
+    config[rails_env()] = HashWithIndifferentAccess.new(shards)
     ActiveRecord::Base.connection.initialize_shards(@config)
   end
-  
+
   def self.using(shard, &block)
-    ActiveRecord::Base.hijack_initializer()
     conn = ActiveRecord::Base.connection
-    
+
     if conn.is_a?(Octopus::Proxy)
       conn.run_queries_on_shard(shard, &block)
     else
       yield
     end
-  end  
+  end
 end
 
 
@@ -80,15 +111,32 @@ require "octopus/association_collection"
 require "octopus/has_and_belongs_to_many_association"
 require "octopus/association"
 
+if Octopus.rails2?
+  require "octopus/rails2/association"
+  require "octopus/rails2/persistence"
+  require "octopus/rails2/scope"
+end
+
 if Octopus.rails3?
-  require "octopus/rails3/association"
   require "octopus/rails3/persistence"
-  require "octopus/rails3/arel"
-else
+  require "octopus/rails3/log_subscriber"
+  require "octopus/rails3/abstract_adapter"
+  require "octopus/railtie"
+end
+
+if Octopus.rails30?
   require "octopus/rails2/association"
-  require "octopus/rails2/persistence"
+  require "octopus/rails3/arel"
+end
+
+if Octopus.rails31? || Octopus.rails32?
+  require "octopus/rails3.1/singular_association"
+end
+
+if Octopus.rails32?
+  require "octopus/rails3.2/persistence"
 end
 
 require "octopus/proxy"
 require "octopus/scope_proxy"
-require "octopus/logger"
+require "octopus/logger"

data/lib/octopus/association.rb

@@ -5,11 +5,12 @@ module Octopus::Association
 
   module InstanceMethods
     def set_connection_on_association(record)
+      return unless ::Octopus.enabled?
       return if !self.connection.respond_to?(:current_shard) || !self.respond_to?(:current_shard)
       if !record.current_shard.nil? && !self.current_shard.nil? && record.current_shard != self.current_shard
-        raise "Association Error: Records are from different shards" 
+        raise "Association Error: Records are from different shards"
       end
-      
+
       record.current_shard = self.connection.current_shard = self.current_shard if should_set_current_shard?
     end
   end
@@ -28,7 +29,7 @@ module Octopus::Association
     if options[:before_add].is_a?(Array)
       options[:before_add] << :set_connection_on_association
     elsif options[:before_add].is_a?(Symbol)
-      options[:before_add] = [:set_connection_on_association, options[:before_add]]      
+      options[:before_add] = [:set_connection_on_association, options[:before_add]]
     else
       options[:before_add] = :set_connection_on_association
     end
@@ -36,11 +37,11 @@ module Octopus::Association
     if options[:before_remove].is_a?(Array)
       options[:before_remove] << :set_connection_on_association
     elsif options[:before_remove].is_a?(Symbol)
-      options[:before_remove] = [:set_connection_on_association, options[:before_remove]]      
+      options[:before_remove] = [:set_connection_on_association, options[:before_remove]]
     else
       options[:before_remove] = :set_connection_on_association
     end
   end
 end
 
-ActiveRecord::Base.extend(Octopus::Association)
+ActiveRecord::Base.extend(Octopus::Association)

data/lib/octopus/association_collection.rb

@@ -1,15 +1,69 @@
-module Octopus::AssociationCollection   
+module Octopus::AssociationCollection
+
+  def self.included(base)
+    if Octopus.rails31? || Octopus.rails32?
+      base.instance_eval do
+        alias_method_chain :reader, :octopus
+        alias_method_chain :writer, :octopus
+        alias_method_chain :ids_reader, :octopus
+        alias_method_chain :ids_writer, :octopus
+        alias_method_chain :create, :octopus
+        alias_method_chain :create!, :octopus
+        alias_method_chain :build, :octopus
+      end
+    end
+  end
+
+  def build_with_octopus(*args, &block)
+    owner.reload_connection
+    build_without_octopus(*args, &block)
+  end
+
+  def reader_with_octopus(*args)
+    owner.reload_connection
+    reader_without_octopus(*args)
+  end
+
+  def writer_with_octopus(*args)
+    owner.reload_connection
+    writer_without_octopus(*args)
+  end
+
+  def ids_reader_with_octopus(*args)
+    owner.reload_connection
+    ids_reader_without_octopus(*args)
+  end
+
+  def ids_writer_with_octopus(*args)
+    owner.reload_connection
+    ids_writer_without_octopus(*args)
+  end
+
+  def create_with_octopus(*args, &block)
+    owner.reload_connection
+    create_without_octopus(*args, &block)
+  end
+
+  def create_with_octopus!(*args, &block)
+    owner.reload_connection
+    create_without_octopus!(*args, &block)
+  end
+
   def should_wrap_the_connection?
     @owner.respond_to?(:current_shard) && @owner.current_shard != nil
   end
 
   def count(*args)
     if should_wrap_the_connection?
-      Octopus.using(@owner.current_shard) { super } 
-    else        
+      Octopus.using(@owner.current_shard) { super }
+    else
       super
     end
   end
 end
 
-ActiveRecord::Associations::AssociationCollection.send(:include, Octopus::AssociationCollection)
+if Octopus.rails31? || Octopus.rails32?
+  ActiveRecord::Associations::CollectionAssociation.send(:include, Octopus::AssociationCollection)
+else
+  ActiveRecord::Associations::AssociationCollection.send(:include, Octopus::AssociationCollection)
+end