ar-octopus 0.8.1 → 0.10.2

data/lib/octopus.rb

@@ -2,24 +2,24 @@ require 'active_record'
 require 'active_support/version'
 require 'active_support/core_ext/class'
 
-require "yaml"
-require "erb"
+require 'yaml'
+require 'erb'
 
 module Octopus
-  def self.env()
+  def self.env
     @env ||= 'octopus'
   end
 
-  def self.rails_env()
-    @rails_env ||= self.rails? ? Rails.env.to_s : 'shards'
+  def self.rails_env
+    @rails_env ||= defined?(::Rails.env) ? Rails.env.to_s : 'shards'
   end
 
   def self.config
     @config ||= begin
-      file_name = Octopus.directory() + "/config/shards.yml"
+      file_name = File.join(Octopus.directory, 'config/shards.yml').to_s
 
-      if File.exists?(file_name) || File.symlink?(file_name)
-        config ||= HashWithIndifferentAccess.new(YAML.load(ERB.new(File.read(file_name)).result))[Octopus.env()]
+      if File.exist?(file_name) || File.symlink?(file_name)
+        config ||= HashWithIndifferentAccess.new(YAML.load(ERB.new(File.read(file_name)).result))[Octopus.env]
       else
         config ||= HashWithIndifferentAccess.new
       end
@@ -28,13 +28,25 @@ module Octopus
     end
   end
 
+  def self.load_balancer=(balancer)
+    @load_balancer = balancer
+  end
+
+  def self.load_balancer
+    @load_balancer ||= Octopus::LoadBalancing::RoundRobin
+  end
+
+  def self.master_shard
+    ((config && config[:master_shard]) || :master).to_sym
+  end
+
   # 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)
+    if defined?(::Rails.env)
       Octopus.environments.include?(Rails.env.to_s)
     else
       # TODO: This doens't feel right but !Octopus.config.blank? is breaking a
@@ -45,8 +57,8 @@ module Octopus
 
   # 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
+  def self.directory
+    @directory ||= defined?(::Rails.root) ? Rails.root.to_s : Dir.pwd
   end
 
   # This is the default way to do Octopus Setup
@@ -57,27 +69,71 @@ module Octopus
   end
 
   def self.environments=(environments)
-    @environments = environments.map { |element| element.to_s }
+    @environments = environments.map(&:to_s)
   end
 
   def self.environments
     @environments ||= config['environments'] || ['production']
   end
 
-  def self.rails3?
-    ActiveRecord::VERSION::MAJOR <= 3
+  def self.robust_environments=(environments)
+    @robust_environments = environments.map(&:to_s)
+  end
+
+  # Environments in which to swallow failures from a single shard
+  # when iterating through all.
+  def self.robust_environments
+    @robust_environments ||= config['robust_environments'] || ['production']
+  end
+
+  def self.robust_environment?
+    robust_environments.include? rails_env
   end
 
   def self.rails4?
-    ActiveRecord::VERSION::MAJOR >= 4
+    ActiveRecord::VERSION::MAJOR == 4
+  end
+
+  def self.rails42?
+    rails4? && ActiveRecord::VERSION::MINOR == 2
+  end
+
+  def self.rails50?
+    ActiveRecord::VERSION::MAJOR == 5 && ActiveRecord::VERSION::MINOR == 0
+  end
+  
+  def self.atleast_rails50?
+    ActiveRecord::VERSION::MAJOR >= 5
+  end
+
+  def self.rails51?
+    ActiveRecord::VERSION::MAJOR == 5 && ActiveRecord::VERSION::MINOR == 1
   end
 
-  def self.rails?
-    defined?(Rails)
+  def self.rails52?
+    ActiveRecord::VERSION::MAJOR == 5 && ActiveRecord::VERSION::MINOR == 2
+  end
+
+  def self.atleast_rails51?
+    ActiveRecord::VERSION::MAJOR > 5 || (ActiveRecord::VERSION::MAJOR == 5 && ActiveRecord::VERSION::MINOR >= 1)
+  end
+
+  def self.atleast_rails52?
+    ActiveRecord::VERSION::MAJOR > 5 || (ActiveRecord::VERSION::MAJOR == 5 && ActiveRecord::VERSION::MINOR > 1)
+  end
+
+  attr_writer :logger
+
+  def self.logger
+    if defined?(Rails.logger)
+      @logger ||= Rails.logger
+    else
+      @logger ||= Logger.new($stderr)
+    end
   end
 
   def self.shards=(shards)
-    config[rails_env()] = HashWithIndifferentAccess.new(shards)
+    config[rails_env] = HashWithIndifferentAccess.new(shards)
     ActiveRecord::Base.connection.initialize_shards(@config)
   end
 
@@ -90,23 +146,59 @@ module Octopus
       yield
     end
   end
-end
 
+  def self.using_group(group, &block)
+    conn = ActiveRecord::Base.connection
 
-require "octopus/model"
-require "octopus/migration"
-require "octopus/association_collection"
-require "octopus/has_and_belongs_to_many_association"
-require "octopus/association"
-require "octopus/rails3/persistence"
-require "octopus/rails3/log_subscriber"
-require "octopus/rails3/abstract_adapter"
-require "octopus/rails3/singular_association"
+    if conn.is_a?(Octopus::Proxy)
+      conn.send_queries_to_group(group, &block)
+    else
+      yield
+    end
+  end
 
-if defined?(::Rails)
-  require "octopus/railtie"
-end
+  def self.using_all(&block)
+    conn = ActiveRecord::Base.connection
+
+    if conn.is_a?(Octopus::Proxy)
+      conn.send_queries_to_all_shards(&block)
+    else
+      yield
+    end
+  end
 
+  def self.fully_replicated(&_block)
+    old_fully_replicated = Thread.current[Octopus::ProxyConfig::FULLY_REPLICATED_KEY]
+    Thread.current[Octopus::ProxyConfig::FULLY_REPLICATED_KEY] = true
+    yield
+  ensure
+    Thread.current[Octopus::ProxyConfig::FULLY_REPLICATED_KEY] = old_fully_replicated
+  end
+end
 
-require "octopus/proxy"
-require "octopus/scope_proxy"
+require 'octopus/exception'
+
+require 'octopus/shard_tracking'
+require 'octopus/shard_tracking/attribute'
+require 'octopus/shard_tracking/dynamic'
+
+require 'octopus/model'
+require 'octopus/result_patch'
+require 'octopus/migration'
+require 'octopus/association'
+require 'octopus/collection_association'
+require 'octopus/association_shard_tracking'
+require 'octopus/persistence'
+require 'octopus/log_subscriber'
+require 'octopus/abstract_adapter'
+require 'octopus/singular_association'
+require 'octopus/finder_methods'
+require 'octopus/query_cache_for_shards' unless Octopus.rails4?
+
+require 'octopus/railtie' if defined?(::Rails::Railtie)
+
+require 'octopus/proxy_config'
+require 'octopus/proxy'
+require 'octopus/collection_proxy'
+require 'octopus/relation_proxy'
+require 'octopus/scope_proxy'

data/lib/tasks/octopus.rake

@@ -1,7 +1,7 @@
 namespace :octopus do
-  desc "Copy schema version information from master to all shards"
+  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?
+    abort('Octopus is not enabled for this environment') unless Octopus.enabled?
 
     connection = ActiveRecord::Base.connection
 

data/sample_app/Gemfile

@@ -14,7 +14,7 @@ group :test do
   gem 'capybara'
   gem 'cucumber-rails', :require => false
   gem 'launchy'
-  gem "rspec-rails"
-  gem "aruba"
-  gem "database_cleaner"
+  gem 'rspec-rails'
+  gem 'aruba'
+  gem 'database_cleaner'
 end

data/sample_app/autotest/discover.rb

@@ -1,2 +1,2 @@
-Autotest.add_discovery { "rails" }
-Autotest.add_discovery { "rspec2" }
+Autotest.add_discovery { 'rails' }
+Autotest.add_discovery { 'rspec2' }

data/sample_app/config/application.rb

@@ -34,7 +34,7 @@ module SampleApp
     # config.i18n.default_locale = :de
 
     # Configure the default encoding used in templates for Ruby 1.9.
-    config.encoding = "utf-8"
+    config.encoding = 'utf-8'
 
     # Configure sensitive parameters which will be filtered from the log file.
     config.filter_parameters += [:password]

data/sample_app/config/boot.rb

@@ -3,4 +3,4 @@ require 'rubygems'
 # Set up gems listed in the Gemfile.
 ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
 
-require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])

data/sample_app/config/environments/test.rb

@@ -9,7 +9,7 @@ SampleApp::Application.configure do
 
   # Configure static asset server for tests with Cache-Control for performance
   config.serve_static_assets = true
-  config.static_cache_control = "public, max-age=3600"
+  config.static_cache_control = 'public, max-age=3600'
 
   # Log error messages when you accidentally call methods on nil
   config.whiny_nils = true

data/sample_app/config/initializers/session_store.rb

@@ -1,6 +1,6 @@
 # Be sure to restart your server when you modify this file.
 
-SampleApp::Application.config.session_store :cookie_store, key: '_sample_app_session'
+SampleApp::Application.config.session_store :cookie_store, :key => '_sample_app_session'
 
 # Use the database for sessions instead of the cookie-based default,
 # which shouldn't be used to store highly confidential information

data/sample_app/config/initializers/wrap_parameters.rb

@@ -5,7 +5,7 @@
 
 # Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array.
 ActiveSupport.on_load(:action_controller) do
-  wrap_parameters format: [:json]
+  wrap_parameters :format => [:json]
 end
 
 # Disable root element in JSON by default.

data/sample_app/config/routes.rb

@@ -1,4 +1,4 @@
-SampleApp::Application.routes.draw do 
+SampleApp::Application.routes.draw do
   # The priority is based upon order of creation:
   # first created -> highest priority.
 

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

@@ -2,10 +2,10 @@ class CreateSampleUsers < ActiveRecord::Migration
   using(:master, :asia, :europe, :america)
 
   def self.up
-    User.create!(:name => "Exception")
+    User.create!(:name => 'Exception')
   end
 
   def self.down
-    User.find_by_name("Exception").delete()
+    User.find_by_name('Exception').delete
   end
 end

data/sample_app/db/schema.rb

@@ -11,19 +11,19 @@
 #
 # It's strongly recommended to check this file into your version control system.
 
-ActiveRecord::Schema.define(:version => 20100720210335) do
+ActiveRecord::Schema.define(:version => 20_100_720_210_335) do
 
-  create_table "items", :force => true do |t|
-    t.string   "name"
-    t.integer  "user_id"
-    t.datetime "created_at", :null => false
-    t.datetime "updated_at", :null => false
+  create_table 'items', :force => true do |t|
+    t.string 'name'
+    t.integer 'user_id'
+    t.datetime 'created_at', :null => false
+    t.datetime 'updated_at', :null => false
   end
 
-  create_table "users", :force => true do |t|
-    t.string   "name"
-    t.datetime "created_at", :null => false
-    t.datetime "updated_at", :null => false
+  create_table 'users', :force => true do |t|
+    t.string 'name'
+    t.datetime 'created_at', :null => false
+    t.datetime 'updated_at', :null => false
   end
 
 end

data/sample_app/db/seeds.rb

@@ -6,11 +6,11 @@
 #   cities = City.create([{ :name => 'Chicago' }, { :name => 'Copenhagen' }])
 #   Mayor.create(:name => 'Daley', :city => cities.first)
 Octopus.using(:asia) do
-  User.create!(:name => "Asia User")
+  User.create!(:name => 'Asia User')
 end
 
 Octopus.using(:america) do
-  users_america = User.create([{ :name => 'America User 1' }, { :name => 'America User 2' }])
+  User.create([{ :name => 'America User 1' }, { :name => 'America User 2' }])
 end
 
-User.create!(:name => "Teste")
+User.create!(:name => 'Teste')

data/sample_app/features/step_definitions/seeds_steps.rb

@@ -3,11 +3,11 @@ Then /^the "([^"]*)" shard should have one user named "([^"]*)"$/ do |shard_name
 end
 
 Then /^the version of "([^"]*)" shard should be "([^"]*)"$/ do |shard_name, version|
-  ab = ActiveRecord::Base.using(shard_name.to_sym).connection.select_value("select * from schema_migrations order by version desc limit 1;")
-  version = "" if version == "nil"
+  ab = ActiveRecord::Base.using(shard_name.to_sym).connection.select_value('select * from schema_migrations order by version desc limit 1;')
+  version = '' if version == 'nil'
   ab.to_s.should == version
 end
 
 When /^I run inside my Rails project "([^"]*)" with enviroment "([^"]*)"$/ do |command, enviroment|
-  run("cd #{Rails.root.to_s} && RAILS_ENV=#{enviroment} #{command}")
-end
+  run("cd #{Rails.root} && RAILS_ENV=#{enviroment} #{command}")
+end

data/sample_app/features/step_definitions/web_steps.rb

@@ -4,10 +4,9 @@
 # instead of editing this one. Cucumber will automatically load all features/**/*.rb
 # files.
 
-
 require 'uri'
 require 'cgi'
-require File.expand_path(File.join(File.dirname(__FILE__), "..", "support", "paths"))
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'support', 'paths'))
 
 module WithinHelpers
   def with_scope(locator)
@@ -62,7 +61,7 @@ end
 When /^(?:|I )fill in the following(?: within "([^"]*)")?:$/ do |selector, fields|
   with_scope(selector) do
     fields.rows_hash.each do |name, value|
-      When %{I fill in "#{name}" with "#{value}"}
+      When %(I fill in "#{name}" with "#{value}")
     end
   end
 end
@@ -205,7 +204,7 @@ 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

data/sample_app/features/support/env.rb

@@ -12,8 +12,8 @@ require 'cucumber/rails'
 # Capybara.default_selector = :xpath
 
 # By default, any exception happening in your Rails application will bubble up
-# to Cucumber so that your scenario will fail. This is a different from how 
-# your application behaves in the production environment, where an error page will 
+# to Cucumber so that your scenario will fail. This is a different from how
+# your application behaves in the production environment, where an error page will
 # be rendered instead.
 #
 # Sometimes we want to override this default behaviour and allow Rails to rescue
@@ -33,7 +33,7 @@ ActionController::Base.allow_rescue = false
 begin
   DatabaseCleaner.strategy = :transaction
 rescue NameError
-  raise "You need to add database_cleaner to your Gemfile (in the :test group) if you wish to use it."
+  raise 'You need to add database_cleaner to your Gemfile (in the :test group) if you wish to use it.'
 end
 
 # You may also want to configure DatabaseCleaner to use different strategies for certain features and scenarios.
@@ -55,4 +55,3 @@ end
 # The :transaction strategy is faster, but might give you threading problems.
 # See https://github.com/cucumber/cucumber-rails/blob/master/features/choose_javascript_database_strategy.feature
 Cucumber::Rails::Database.javascript_strategy = :truncation
-

data/sample_app/features/support/paths.rb

@@ -20,10 +20,10 @@ module NavigationHelpers
     else
       begin
         page_name =~ /the (.*) page/
-        path_components = $1.split(/\s+/)
-        self.send(path_components.push('path').join('_').to_sym)
-      rescue Object => e
-        raise "Can't find mapping from \"#{page_name}\" to a path.\n" +
+        path_components = Regexp.last_match[1].split(/\s+/)
+        send(path_components.push('path').join('_').to_sym)
+      rescue
+        raise "Can't find mapping from \"#{page_name}\" to a path.\n" \
           "Now, go and add a mapping in #{__FILE__}"
       end
     end

data/sample_app/lib/tasks/cucumber.rake

@@ -4,62 +4,61 @@
 # instead of editing this one. Cucumber will automatically load all features/**/*.rb
 # files.
 
+unless ARGV.any? { |a| a =~ /^gems/ } # Don't load anything when running the gems:* tasks
 
-unless ARGV.any? {|a| a =~ /^gems/} # Don't load anything when running the gems:* tasks
+  vendored_cucumber_bin = Dir["#{Rails.root}/vendor/{gems,plugins}/cucumber*/bin/cucumber"].first
+  $LOAD_PATH.unshift(File.dirname(vendored_cucumber_bin) + '/../lib') unless vendored_cucumber_bin.nil?
 
-vendored_cucumber_bin = Dir["#{Rails.root}/vendor/{gems,plugins}/cucumber*/bin/cucumber"].first
-$LOAD_PATH.unshift(File.dirname(vendored_cucumber_bin) + '/../lib') unless vendored_cucumber_bin.nil?
+  begin
+    require 'cucumber/rake/task'
 
-begin
-  require 'cucumber/rake/task'
+    namespace :cucumber do
+      Cucumber::Rake::Task.new({ :ok => 'test:prepare' }, 'Run features that should pass') do |t|
+        t.binary = vendored_cucumber_bin # If nil, the gem's binary is used.
+        t.fork = true # You may get faster startup if you set this to false
+        t.profile = 'default'
+      end
 
-  namespace :cucumber do
-    Cucumber::Rake::Task.new({:ok => 'test:prepare'}, 'Run features that should pass') do |t|
-      t.binary = vendored_cucumber_bin # If nil, the gem's binary is used.
-      t.fork = true # You may get faster startup if you set this to false
-      t.profile = 'default'
-    end
-
-    Cucumber::Rake::Task.new({:wip => 'test:prepare'}, 'Run features that are being worked on') do |t|
-      t.binary = vendored_cucumber_bin
-      t.fork = true # You may get faster startup if you set this to false
-      t.profile = 'wip'
-    end
+      Cucumber::Rake::Task.new({ :wip => 'test:prepare' }, 'Run features that are being worked on') do |t|
+        t.binary = vendored_cucumber_bin
+        t.fork = true # You may get faster startup if you set this to false
+        t.profile = 'wip'
+      end
 
-    Cucumber::Rake::Task.new({:rerun => 'test:prepare'}, 'Record failing features and run only them if any exist') do |t|
-      t.binary = vendored_cucumber_bin
-      t.fork = true # You may get faster startup if you set this to false
-      t.profile = 'rerun'
-    end
+      Cucumber::Rake::Task.new({ :rerun => 'test:prepare' }, 'Record failing features and run only them if any exist') do |t|
+        t.binary = vendored_cucumber_bin
+        t.fork = true # You may get faster startup if you set this to false
+        t.profile = 'rerun'
+      end
 
-    desc 'Run all features'
-    task :all => [:ok, :wip]
+      desc 'Run all features'
+      task :all => [:ok, :wip]
 
-    task :statsetup do
-      require 'rails/code_statistics'
-      ::STATS_DIRECTORIES << %w(Cucumber\ features features) if File.exist?('features')
-      ::CodeStatistics::TEST_TYPES << "Cucumber features" if File.exist?('features')
+      task :statsetup do
+        require 'rails/code_statistics'
+        ::STATS_DIRECTORIES << %w(Cucumber\ features features) if File.exist?('features')
+        ::CodeStatistics::TEST_TYPES << 'Cucumber features' if File.exist?('features')
+      end
     end
-  end
-  desc 'Alias for cucumber:ok'
-  task :cucumber => 'cucumber:ok'
+    desc 'Alias for cucumber:ok'
+    task :cucumber => 'cucumber:ok'
 
-  task :default => :cucumber
+    task :default => :cucumber
 
-  task :features => :cucumber do
-    STDERR.puts "*** The 'features' task is deprecated. See rake -T cucumber ***"
-  end
+    task :features => :cucumber do
+      STDERR.puts "*** The 'features' task is deprecated. See rake -T cucumber ***"
+    end
 
-  # In case we don't have the generic Rails test:prepare hook, append a no-op task that we can depend upon.
-  task 'test:prepare' do
-  end
+    # In case we don't have the generic Rails test:prepare hook, append a no-op task that we can depend upon.
+    task 'test:prepare' do
+    end
 
-  task :stats => 'cucumber:statsetup'
-rescue LoadError
-  desc 'cucumber rake task not available (cucumber not installed)'
-  task :cucumber do
-    abort 'Cucumber rake task is not available. Be sure to install cucumber as a gem or plugin'
+    task :stats => 'cucumber:statsetup'
+  rescue LoadError
+    desc 'cucumber rake task not available (cucumber not installed)'
+    task :cucumber do
+      abort 'Cucumber rake task is not available. Be sure to install cucumber as a gem or plugin'
+    end
   end
-end
 
 end

data/sample_app/spec/spec_helper.rb

@@ -1,12 +1,12 @@
 # This file is copied to ~/spec when you run 'ruby script/generate rspec'
 # from the project root directory.
-ENV["RAILS_ENV"] ||= 'test'
-require File.expand_path("../../config/environment", __FILE__)
+ENV['RAILS_ENV'] ||= 'test'
+require File.expand_path('../../config/environment', __FILE__)
 require 'rspec/rails'
 
 # Requires supporting files with custom matchers and macros, etc,
 # in ./support/ and its subdirectories.
-Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
 
 RSpec.configure do |config|
   # == Mock Framework