fresh_connection 0.1.8 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 145cd233562347272db93ca9a321d741c2d20228
+  data.tar.gz: 47b006e8bb8ac186726d6b71decbb337bd9ebd93
+SHA512:
+  metadata.gz: faf4ef73727580b787ee41e7b2d7ceea4181687fb6ac9a4343272e32341ab7c36a6d431a471b87172748a48595af33bd00b6e33eed30ebeb4620e43bca0c63ba
+  data.tar.gz: 09e031f971560f1a235bb83adf3b679621671f9c308de92d8bfc98ea100222f3ea9477b51b8ff4726abb76be0b313bc1e1c0a51da474922c8d832caf12521c0e

data/.gitignore

@@ -0,0 +1,8 @@
+*.gem
+.bundle
+.ruby-version
+Gemfile.lock
+gemfiles/*.lock
+bundle
+log/*
+.*.sw[a-z]

data/Appraisals

@@ -0,0 +1,17 @@
+appraise "rails3" do
+  gem "activerecord", "~> 3.2.0"
+  gem "activesupport", "~> 3.2.0"
+  gem "railties", "~> 3.2.0"
+end
+
+appraise "rails40" do
+  gem "activerecord", "~> 4.0.0"
+  gem "activesupport", "~> 4.0.0"
+  gem "railties", "~> 4.0.0"
+end
+
+appraise "rails41" do
+  gem "activerecord", "~> 4.1.0"
+  gem "activesupport", "~> 4.1.0"
+  gem "railties", "~> 4.1.0"
+end

data/README.md

@@ -18,9 +18,6 @@ Or install it yourself as:
 
     $ gem install fresh_connection
 
-### For Rails2.3
-
-    $ gem install fresh_connection -v 0.0.7
 
 ## Config
 ### config/database.yml
@@ -41,14 +38,62 @@ Or install it yourself as:
         password: slave
         host: slave
 
-slave is config to connect to slave servers.
+```slave``` is config to connect to slave servers.
 Others will use the master setting. If you want to change, write in the slave.
 
-### config/initializers/fresh_connection.rb
+### use multiple slave servers group
+If you may want to user multiple slave group, write multiple slave group to config/database.yml. 
+
+    production:
+      adapter: mysql2
+      encoding: utf8
+      reconnect: true
+      database: kaeru
+      pool: 5
+      username: master
+      password: master
+      host: localhost
+      socket: /var/run/mysqld/mysqld.sock
+
+      slave:
+        username: slave
+        password: slave
+        host: slave
+
+      admin_slave:
+        username: slave
+        password: slave
+        host: admin_slaves
+
+And call establish_fresh_connection method in model that access to ```admin_slave``` slave group.
+
+    class AdminUser < ActiveRecord::Base
+      establish_fresh_connection :admin_slave
+    end
+
+The children is access to same slave group of parent.
+
+    class Parent < ActiveRecord::Base
+      establish_fresh_connection :admin_slave
+    end
+
+    class AdminUser < Parent
+    end
+
+    class Benefit < Parent
+    end
+
+AdminUser and Benefit access to ```admin_slave``` slave group.
+
 
-    FreshConnection::SlaveConnection.ignore_models = %w|Model1 Model2|
+### Declare model that doesn't use slave db
 
-If models that ignore access to slave servers is exist, You can write model name at FreshConnection::SlaveConnection.ignore models.
+    class SomethingModel < ActiveRecord::Base
+      master_db_only!
+    end
+
+If model that always access to master servers is exist, You may want to write ```master_db_only!```  in model.
+The model that master_db_only model's child is always access to master db.
 
 ### Slave Connection Manager
 Default slave connection manager is FreshConnection::ConnectionManager.
@@ -56,7 +101,7 @@ If you would like to change slave connection manager, assign yourself slave conn
 
 #### config/initializers/fresh_connection.rb
 
-    FreshConnection::SlaveConnection.connection_manager = MySlaveConnection
+    FreshConnection.connection_manager = MySlaveConnection
 
 
 Yourself Slave Connection Manager should be inherited FreshConnection::AbstractConnectionManager
@@ -99,3 +144,22 @@ In transaction, Always will be access to master server.
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+## Test
+
+I'm glad that you would do test!
+To run the test suite, you need mysql installed.
+How to setup your test environment.
+
+```bash
+bundle install --path bundle
+GEM_HOME=bundle/ruby/(your ruby version) gem install bundler --pre
+bundle exec appraisal install
+```
+
+This command run the spec suite for all rails versions supported.
+
+```base
+bundle exec appraisal rake spec
+```
+

data/Rakefile

@@ -1 +1,6 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/fresh_connection.gemspec

@@ -19,7 +19,12 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency 'activerecord', '>= 3.2.0'
+  spec.add_dependency 'activesupport', '>= 3.2.0'
+  spec.add_dependency 'railties', '>= 3.2.0'
 
   spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rake", '>= 10.0.0'
+  spec.add_development_dependency "rspec", '>= 2.14.1'
+  spec.add_development_dependency 'mysql2', '>= 0.3.15'
+  spec.add_development_dependency 'appraisal', '>= 1.0.0'
 end

data/gemfiles/rails3.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 3.2.0"
+gem "activesupport", "~> 3.2.0"
+gem "railties", "~> 3.2.0"
+
+gemspec :path => "../"

data/gemfiles/rails40.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 4.0.0"
+gem "activesupport", "~> 4.0.0"
+gem "railties", "~> 4.0.0"
+
+gemspec :path => "../"

data/gemfiles/rails41.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 4.1.0"
+gem "activesupport", "~> 4.1.0"
+gem "railties", "~> 4.1.0"
+
+gemspec :path => "../"

data/lib/fresh_connection.rb

@@ -1,9 +1,39 @@
-require "fresh_connection/version"
-require "fresh_connection/connection_manager"
-require "fresh_connection/slave_connection"
-require "fresh_connection/rack/connection_management"
-require "fresh_connection/active_record/relation"
-require "fresh_connection/active_record/abstract_adapter"
-require "fresh_connection/active_record/mysql2_adapter"
-
-require "fresh_connection/railtie.rb" if defined?(Rails)
+require 'active_record'
+require 'active_support/core_ext'
+require 'active_support/dependencies/autoload'
+
+module FreshConnection
+  extend ActiveSupport::Autoload
+
+  autoload :AccessControl
+  autoload :ConnectionManager
+  autoload :SlaveConnectionHandler
+  autoload :Initializer
+  autoload :SlaveConnection
+
+  class << self
+    attr_writer :connection_manager, :ignore_configure_connection, :retry_limit
+
+    def connection_manager
+      @connection_manager || ConnectionManager
+    end
+
+    def ignore_configure_connection?
+      !!@ignore_configure_connection
+    end
+
+    def retry_limit
+      @retry_limit || 3
+    end
+
+    def rails_3?
+      ActiveRecord::VERSION::MAJOR == 3
+    end
+
+    def rails_4?
+      ActiveRecord::VERSION::MAJOR == 4
+    end
+  end
+end
+
+require "fresh_connection/railtie.rb"

data/lib/fresh_connection/abstract_connection_manager.rb

@@ -6,8 +6,11 @@ module FreshConnection
       "Can't connect to local MySQL server"
     ].map{|msg| Regexp.escape(msg)}.join("|")
 
-    def initialize
+    attr_reader :slave_group
+
+    def initialize(slave_group = "slave")
       @mutex = Mutex.new
+      @slave_group = (slave_group.presence || "slave").to_s
     end
 
     def slave_connection

data/lib/fresh_connection/access_control.rb

@@ -0,0 +1,56 @@
+module FreshConnection
+  class AccessControl
+    class << self
+      def force_master_access
+        db = access_db
+        access_to(:master)
+        yield
+      ensure
+        access_to(db)
+      end
+
+      def access(enable_slave_access)
+        access_in(enable_slave_access ? :slave : :master)
+        yield
+      ensure
+        access_out
+      end
+
+      def slave_access?
+        access_db == :slave
+      end
+
+      private
+
+      def access_in(db)
+        increment_access_count
+        access_to(db) unless access_db
+      end
+
+      def access_out
+        decrement_access_count
+        access_to(nil) if access_count == 0
+      end
+
+      def access_db
+        Thread.current[:fresh_connection_access_target]
+      end
+
+      def access_to(db)
+        Thread.current[:fresh_connection_access_target] = db
+      end
+
+      def access_count
+        Thread.current['fresh_connection_access_count'] || 0
+      end
+
+      def increment_access_count
+        Thread.current['fresh_connection_access_count'] = access_count + 1
+      end
+
+      def decrement_access_count
+        Thread.current['fresh_connection_access_count'] = access_count - 1
+      end
+    end
+  end
+end

data/lib/fresh_connection/connection_manager.rb

@@ -36,7 +36,7 @@ module FreshConnection
     end
 
     def new_connection
-      ActiveRecord::Base.send("#{spec["adapter"]}_connection", spec)
+      ActiveRecord::Base.send("mysql2_connection", spec)
     end
 
     def spec
@@ -45,7 +45,7 @@ module FreshConnection
 
     def get_spec
       ret = ActiveRecord::Base.configurations[Rails.env]
-      ret.merge(ret["slave"] || {})
+      ret.merge(ret[@slave_group] || {})
     end
   end
 end

data/lib/fresh_connection/extend/ar_base.rb

@@ -0,0 +1,47 @@
+module FreshConnection
+  module Extend
+    module ArBase
+      def self.extended(base)
+        base.class_attribute :slave_connection_handler, :instance_writer => false
+        base.slave_connection_handler = FreshConnection::SlaveConnectionHandler.new
+      end
+
+      def manage_access(slave_access, &block)
+        if master_db_only?
+          FreshConnection::AccessControl.force_master_access(&block)
+        else
+          FreshConnection::AccessControl.access(slave_access, &block)
+        end
+      end
+
+      def establish_fresh_connection(slave_group = nil)
+        slave_connection_handler.establish_connection(name, slave_group)
+      end
+
+      def slave_connection
+        slave_connection_handler.connection(self)
+      end
+
+      def master_db_only!
+        @_fresh_connection_master_only = true
+      end
+
+      def master_db_only?
+        @_fresh_connection_master_only ||
+          (self != ActiveRecord::Base && superclass.master_db_only?)
+      end
+
+      def put_aside!
+        slave_connection_handler.put_aside!
+      end
+
+      def recovery(failure_connection, exception)
+        slave_connection_handler.recovery(self, failure_connection, exception)
+      end
+
+      def slave_group
+        slave_connection_handler.slave_group(self)
+      end
+    end
+  end
+end

data/lib/fresh_connection/extend/ar_relation.rb

@@ -0,0 +1,44 @@
+module FreshConnection
+  module Extend
+    module ArRelation
+      def self.included(base)
+        base.alias_method_chain :exec_queries, :fresh_connection
+
+        if FreshConnection.rails_4?
+          base.__send__(:include, ForRails4)
+        elsif FreshConnection.rails_3?
+          base.__send__(:include, ForRails3)
+        end
+      end
+
+      def calculate(operation, column_name, options = {})
+        slave_access = enable_slave_access && options[:readonly] != false
+        @klass.manage_access(slave_access) { super }
+      end
+
+      private
+
+      def exec_queries_with_fresh_connection
+        return @records if loaded?
+
+        @klass.manage_access(enable_slave_access) do
+          exec_queries_without_fresh_connection
+        end
+      end
+
+      module ForRails4
+        private
+        def enable_slave_access
+          connection.open_transactions == 0 && (readonly_value.nil? || readonly_value)
+        end
+      end
+
+      module ForRails3
+        private
+        def enable_slave_access
+          connection.open_transactions == 0 && (@readonly_value.nil? || @readonly_value)
+        end
+      end
+    end
+  end
+end

data/lib/fresh_connection/extend/connection_handler.rb

@@ -0,0 +1,16 @@
+module FreshConnection
+  module Extend
+    module ConnectionHandler
+      def self.included(base)
+        base.alias_method_chain :retrieve_connection, :fresh_connection
+      end
+
+      def retrieve_connection_with_fresh_connection(klass)
+        c = retrieve_connection_without_fresh_connection(klass)
+        c.model_class = klass
+        c
+      end
+    end
+  end
+end
+