master_slave 3.0.0

data/lib/master_slave/base.rb

@@ -0,0 +1,67 @@
+module MasterSlave
+  module Base
+    extend ActiveSupport::Concern
+
+    included do
+      cattr_accessor :slave_connection_names
+      self.slave_connection_names = []
+
+      class << self
+        alias_method :connection_without_master_slave, :connection
+        alias_method :connection, :connection_with_master_slave
+      end
+    end
+
+    module ClassMethods
+
+      def slave(&block)
+        slave_name = select_slave_connection_name
+        if slave_name.blank?
+          block.call
+        else
+          with_slave(slave_name) do
+            block.call
+          end
+        end
+      end
+
+      def using(slave_name, &block)
+        with_slave(slave_name) do
+          block.call
+        end
+      end
+
+      def connection_with_master_slave
+        slave_block        = MasterSlave::RuntimeRegistry.slave_block
+        current_slave_name = MasterSlave::RuntimeRegistry.current_slave_name
+
+        if defined?(Rails) && Rails.env.test?
+          connection_without_master_slave
+        elsif slave_block && current_slave_name
+          pool_name  = MasterSlave::ConnectionHandler.connection_pool_name(current_slave_name)
+          ar_proxy   = MasterSlave::ConnectionHandler::ArProxy.new(pool_name)
+          ActiveRecord::Base.connection_handler.retrieve_connection(ar_proxy)
+        else
+          connection_without_master_slave
+        end
+      end
+
+      protected
+
+      def select_slave_connection_name
+        ActiveRecord::Base.slave_connection_names[rand(ActiveRecord::Base.slave_connection_names.size)]
+      end
+
+      def with_slave(slave_name)
+        slave_name = slave_name.to_s.strip
+        raise "#{slave_name} not exist" unless ActiveRecord::Base.slave_connection_names.include?(slave_name)
+        MasterSlave::RuntimeRegistry.current_slave_name = slave_name
+        MasterSlave::RuntimeRegistry.slave_block        = true
+        yield
+      ensure
+        MasterSlave::RuntimeRegistry.current_slave_name = nil
+        MasterSlave::RuntimeRegistry.slave_block        = false
+      end
+    end
+  end
+end

data/lib/master_slave/config.rb

@@ -0,0 +1,38 @@
+module MasterSlave
+
+  def self.config
+    @config ||= MasterSlave::Configuration.new
+  end
+
+  class Configuration
+    cattr_accessor :config_file
+
+    def initialize
+      @content = load_config
+    end
+
+    def slave_names
+      raise "#{Rails.env}'s slave config not exist" if @content.blank?
+      @shard_names ||= @content.keys.sort
+    end
+
+    def slave_config(slave_name)
+      @content[slave_name]
+    end
+
+    def self.config_file
+      @@config_file ||= File.join(Rails.root, 'config', 'shards.yml')
+    end
+
+    private
+
+    def load_config
+      if File.exist?(self.class.config_file)
+        hash_config = YAML.load(ERB.new(File.open(self.class.config_file).read).result)
+        HashWithIndifferentAccess.new(hash_config)[Rails.env]
+      else
+        {}
+      end
+    end
+  end
+end

data/lib/master_slave/connection_handler.rb

@@ -0,0 +1,47 @@
+# encoding: utf-8
+module MasterSlave
+  class ConnectionHandler
+
+    class ArProxy
+      attr_reader :name
+
+      def initialize(name)
+        @name = name
+      end
+    end
+
+    class << self
+
+      def setup
+        setup_connection
+      end
+
+      def connection_pool_name(slave_name)
+        "master_slave_#{slave_name.to_s.strip}"
+      end
+
+      protected
+
+      def setup_connection
+        ActiveRecord::Base.slave_connection_names ||= []
+        MasterSlave.config.slave_names.each do |slave_name|
+          ActiveRecord::Base.slave_connection_names << slave_name.to_s.strip
+          configuration = MasterSlave.config.slave_config(slave_name).symbolize_keys
+          unless configuration.key?(:adapter) then raise AdapterNotSpecified, "database configuration does not specify adapter" end
+
+          adapter_method = "#{configuration[:adapter]}_connection"
+          unless ActiveRecord::Base.respond_to?(adapter_method)
+            raise AdapterNotFound, "database configuration specifies nonexistent #{spec.config[:adapter]} adapter"
+          end
+
+          # remove_connection 时会调用方法内部 ar_proxy.name
+          ar_proxy = ArProxy.new(connection_pool_name(slave_name))
+          ActiveRecord::Base.remove_connection(ar_proxy)
+
+          spec = ActiveRecord::Base::ConnectionSpecification.new(configuration, adapter_method)
+          ActiveRecord::Base.connection_handler.establish_connection ar_proxy.name, spec
+        end
+      end
+    end
+  end
+end

data/lib/master_slave/railtie.rb

@@ -0,0 +1,20 @@
+module MasterSlave
+  class Railtie < Rails::Railtie # :nodoc:
+
+    config.after_initialize do
+      if File.exist?(MasterSlave::Configuration.config_file)
+        puts "\033[32mmaster_slave is on!\033[0m"
+        ActiveRecord::Base.send :include, MasterSlave::Base
+        MasterSlave::ConnectionHandler.setup
+      else
+        puts "\033[31mNo such file #{MasterSlave::Configuration.config_file}\033[0m"
+        puts "\033[31mPlease execute `rails g master_slave:config`\033[0m"
+        puts "\033[31mmaster_slave is off!\033[0m"
+      end
+    end
+
+    generators do
+      require File.expand_path('../../rails/generators/config_generator', __FILE__)
+    end
+  end
+end

data/lib/master_slave/runtime_registry.rb

@@ -0,0 +1,32 @@
+begin
+  require 'active_support/per_thread_registry'
+rescue LoadError
+  module ActiveSupport
+    module PerThreadRegistry
+      protected
+
+        def method_missing(name, *args, &block) # :nodoc:
+          # Caches the method definition as a singleton method of the receiver.
+          define_singleton_method(name) do |*a, &b|
+            per_thread_registry_instance.public_send(name, *a, &b)
+          end
+
+          send(name, *args, &block)
+        end
+
+      private
+
+        def per_thread_registry_instance
+          Thread.current[name] ||= new
+        end
+    end
+  end
+end
+
+module MasterSlave
+  class RuntimeRegistry
+    extend ActiveSupport::PerThreadRegistry
+
+    attr_accessor :slave_block, :current_slave_name
+  end
+end

data/lib/master_slave/version.rb

@@ -0,0 +1,3 @@
+module MasterSlave
+  VERSION = '3.0.0'
+end

data/lib/master_slave.rb

@@ -0,0 +1,6 @@
+require 'master_slave/base'
+require 'master_slave/config'
+require 'master_slave/connection_handler'
+require 'master_slave/runtime_registry'
+require 'master_slave/version'
+require 'master_slave/railtie'

data/lib/rails/generators/config_generator.rb

@@ -0,0 +1,34 @@
+require "rails/generators/named_base"
+module MasterSlave
+  module Generators
+    class ConfigGenerator < Rails::Generators::Base
+      desc "Creates a MasterSlave configuration file at config/shards.yml"
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      argument :database_name, type: :string, optional: true
+
+      def app_name
+        Rails::Application.subclasses.first.parent.to_s.underscore
+      end
+
+      def create_config_file
+        template 'shards.yml', File.join(Rails.root, 'config', "shards.yml")
+      end
+
+      def mysql_socket
+        @mysql_socket ||= [
+          "/tmp/mysql.sock",                        # default
+          "/var/run/mysqld/mysqld.sock",            # debian/gentoo
+          "/var/tmp/mysql.sock",                    # freebsd
+          "/var/lib/mysql/mysql.sock",              # fedora
+          "/opt/local/lib/mysql/mysql.sock",        # fedora
+          "/opt/local/var/run/mysqld/mysqld.sock",  # mac + darwinports + mysql
+          "/opt/local/var/run/mysql4/mysqld.sock",  # mac + darwinports + mysql4
+          "/opt/local/var/run/mysql5/mysqld.sock",  # mac + darwinports + mysql5
+          "/opt/lampp/var/mysql/mysql.sock"         # xampp for linux
+        ].find { |f| File.exist?(f) } unless RbConfig::CONFIG['host_os'] =~ /mswin|mingw/
+      end
+    end
+  end
+end

data/lib/rails/generators/templates/shards.yml

@@ -0,0 +1,54 @@
+# MySQL.  Versions 4.1 and 5.0 are recommended.
+#
+# Install the MYSQL driver
+#   gem install mysql2
+#
+# Ensure the MySQL gem is defined in your Gemfile
+#   gem 'mysql2'
+#
+# And be sure to use new-style password hashing:
+#   http://dev.mysql.com/doc/refman/5.0/en/old-client.html
+development:
+  slave:
+    adapter: mysql2
+    encoding: utf8
+    database: <%= database_name || app_name %>_development_slave
+    pool: 5
+    username: root
+    password:
+<% if mysql_socket -%>
+    socket: <%= mysql_socket %>
+<% else -%>
+    host: localhost
+<% end -%>
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  slave:
+    adapter: mysql2
+    encoding: utf8
+    database: <%= database_name || app_name %>_test_slave
+    pool: 5
+    username: root
+    password:
+<% if mysql_socket -%>
+    socket: <%= mysql_socket %>
+<% else -%>
+    host: localhost
+<% end -%>
+
+production:
+  slave:
+    adapter: mysql2
+    encoding: utf8
+    database: <%= database_name || app_name %>_production_slave
+    pool: 5
+    username: root
+    password:
+<% if mysql_socket -%>
+    socket: <%= mysql_socket %>
+<% else -%>
+    host: localhost
+<% end -%>

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: master_slave
+version: !ruby/object:Gem::Version
+  version: 3.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Tumayun, Zhangyuan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+description: mysql separate read and write.
+email: tumayun.2010@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/master_slave.rb
+- lib/rails/generators/templates/shards.yml
+- lib/rails/generators/config_generator.rb
+- lib/master_slave/version.rb
+- lib/master_slave/railtie.rb
+- lib/master_slave/config.rb
+- lib/master_slave/connection_handler.rb
+- lib/master_slave/runtime_registry.rb
+- lib/master_slave/base.rb
+homepage: https://github.com/tumayun/master_slave
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: master_slave.
+test_files: []