replicat 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a4318b9a2e2e1c7e637af213a8ae09f2d292235e
+  data.tar.gz: 5063232ce2dcc9403137e7d4ec2f5ea4d011a5b9
+SHA512:
+  metadata.gz: 8220a33336d837f1adfe5b848eaf9a301ddbdf9c9487abb4f7c90a6e6558f43907195e517ef435ab18c60b3b75ac08a605202646d5e08ff52b0a5d9225125e1d
+  data.tar.gz: 66bf65c92a44b0935e92473c77a0ecae0f09b72b64668e33ef7c56a58b0fde6068e594fc24613c43fcc24f010d812d202e354993da4475e6acdf4279b39d5986

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+log/*.log
+pkg
+rdoc
+spec/dummy/.sass-cache
+spec/dummy/db/*.sqlite3
+spec/dummy/log/*.log
+spec/dummy/tmp/
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in replicat.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Ryo Nakamura
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,135 @@
+# Replicat
+master-slave replication helper for ActiveRecord.
+
+## Installation
+```ruby
+# Gemfile
+gem "replicat"
+```
+
+## Usage
+Modify your replicable models & config/database.yml.
+
+### model
+```ruby
+# app/models/user.rb
+class User < ActiveRecord::Base
+  replicate
+end
+
+# config/database.yml
+production:
+  adapter: mysql2
+  encoding: utf8
+  host: 192.168.24.1
+  port: 3306
+  replications:
+    slave1:
+      adapter: mysql2
+      encoding: utf8
+      host: 192.168.24.2
+      port: 3306
+    slave2:
+      adapter: mysql2
+      encoding: utf8
+      host: 192.168.24.3
+      port: 3306
+    slave3:
+      adapter: mysql2
+      encoding: utf8
+      host: 192.168.24.4
+      port: 3306
+```
+
+### replication
+Now SELECT queries of User model will be sent to slave connections.
+
+```ruby
+User.create(name: "replicat")
+User.first #=> nil
+```
+
+### using
+`using` can help you specify particular connection.
+`using(:master)` uses master connection.
+
+```ruby
+User.create(name: "replicat")
+User.using(:master) { User.first } #=> #<User id: 2, name: "replicat">
+```
+
+### round-robin
+slave connections are balanced by round-robin way.
+
+```ruby
+User.using(:slave1) { User.create(name: "replicat") }
+User.first #=> #<User id: 2, name: "replicat">
+User.first #=> nil
+User.first #=> nil
+User.first #=> #<User id: 2, name: "replicat">
+User.first #=> nil
+User.first #=> nil
+User.first #=> #<User id: 2, name: "replicat">
+User.first #=> nil
+User.first #=> nil
+```
+
+### multi master-slave set
+Pass the master's connection name to `replicate` method.
+
+```ruby
+# app/models/user.rb
+class User < ActiveRecord::Base
+  replicate "production_user"
+end
+
+# app/models/recipe.rb
+class Recipe < ActiveRecord::Base
+  replicate "production_recipe"
+end
+
+# config/database.yml
+production_user:
+  <<: *production
+  host: 192.168.24.1
+  replications:
+    slave1:
+      <<: *slave
+      host: 192.168.24.2
+    slave2:
+      <<: *slave
+      host: 192.168.24.3
+    slave3:
+      <<: *slave
+      host: 192.168.24.4
+
+production_recipe:
+  <<: *production
+  host: 192.168.24.5
+  replications:
+    slave1:
+      <<: *slave
+      host: 192.168.24.6
+    slave2:
+      <<: *slave
+      host: 192.168.24.7
+    slave3:
+      <<: *slave
+      host: 192.168.24.8
+```
+
+
+## For contributors
+```sh
+# setup gems
+bundle install
+
+# setup database
+cd spec/dummy
+rake db:create
+rake db:schema:load RAILS_ENV=test
+cd ../../
+
+# run tests
+bundle exec rspec
+```

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/replicat.rb

@@ -0,0 +1,6 @@
+require "active_record"
+require "replicat/model"
+require "replicat/proxy"
+require "replicat/replicable"
+require "replicat/version"
+require "replicat/active_record"

data/lib/replicat/active_record.rb

@@ -0,0 +1 @@
+ActiveRecord::Base.extend Replicat::Model

data/lib/replicat/model.rb

@@ -0,0 +1,9 @@
+module Replicat
+  module Model
+    def replicate(connection_name = nil)
+      raise "You must set `connection_name` of this model class." if !connection_name && !defined?(Rails)
+      include Replicat::Replicable
+      self.connection_name = connection_name || Rails.env.to_s
+    end
+  end
+end

data/lib/replicat/proxy.rb

@@ -0,0 +1,100 @@
+require "active_support/core_ext/object/try"
+
+module Replicat
+  class Proxy
+    REPLICABLE_METHOD_NAMES = %w[select_all schema_cache]
+    REPLICABLE_METHOD_NAMES_REGEXP = /\A#{Regexp.union(REPLICABLE_METHOD_NAMES)}\z/
+
+    attr_accessor :current_connection_name
+
+    attr_writer :index
+
+    def initialize(model_class)
+      @model_class = model_class
+    end
+
+    private
+
+    def method_missing(method_name, *args, &block)
+      if current_connection_name
+        current_connection.send(method_name, *args, &block)
+      else
+        connection_by_method_name(method_name).send(method_name, *args, &block)
+      end
+    end
+
+    def connection_by_method_name(method_name)
+      REPLICABLE_METHOD_NAMES_REGEXP === method_name ? slave_connection : master_connection
+    end
+
+    def current_connection
+      if current_connection_name.to_s == "master"
+        master_connection
+      else
+        slave_connection_pool_table[current_connection_name.to_s].try(:connection) or raise_connection_not_found
+      end
+    end
+
+    def master_connection
+      @model_class.connection_without_proxy
+    end
+
+    def slave_connection
+      slave_connection_pool.connection
+    end
+
+    def slave_connection_pool
+      slave_connection_pool_table.values[slave_connection_index]
+    end
+
+    def slave_connection_pool_table
+      @slave_connection_pools ||= @model_class.replications.inject({}) do |table, (name, configuration)|
+        table.merge(name => ConnectionPoolCreater.create(configuration))
+      end
+    end
+
+    def raise_connection_not_found
+      raise Error, "connection #{current_connection_name} is not found"
+    end
+
+    def slave_connection_index
+      index.tap { increment_slave_connection_index }
+    end
+
+    def increment_slave_connection_index
+      self.index = (index + 1) % slave_connection_pool_table.size
+    end
+
+    def clear_query_cache
+      master_connection.clear_query_cache
+      slave_connection_pool_table.values.map {|pool| pool.connection.clear_query_cache }
+    end
+
+    def index
+      @index ||= rand(slave_connection_pool_table.size)
+    end
+
+    # Creates database connection pool from configuration Hash table.
+    class ConnectionPoolCreater
+      def self.create(*args)
+        new(*args).create
+      end
+
+      def initialize(configuration)
+        @configuration = configuration.dup
+      end
+
+      def create
+        ActiveRecord::ConnectionAdapters::ConnectionPool.new(
+          ActiveRecord::ConnectionAdapters::ConnectionSpecification::Resolver.new(
+            @configuration,
+            nil,
+          ).spec,
+        )
+      end
+    end
+
+    class Error < StandardError
+    end
+  end
+end

data/lib/replicat/replicable.rb

@@ -0,0 +1,54 @@
+require "active_record"
+require "active_support/concern"
+require "active_support/core_ext/module/aliasing"
+
+module Replicat
+  module Replicable
+    extend ActiveSupport::Concern
+
+    included do
+      class << self
+        def proxy
+          @proxy ||= Proxy.new(self)
+        end
+
+        alias_method_chain :connection, :proxy
+
+        attr_accessor :connection_name
+      end
+    end
+
+    module ClassMethods
+      def connection_with_proxy
+        if has_any_replication?
+          proxy
+        else
+          connection_without_proxy
+        end
+      end
+
+      def has_any_replication?
+        has_configuration? && replications.present?
+      end
+
+      def has_configuration?
+        !!configuration
+      end
+
+      def configuration
+        connection_name && configurations[connection_name]
+      end
+
+      def replications
+        configuration["replications"]
+      end
+
+      def using(connection_name)
+        proxy.current_connection_name = connection_name
+        yield
+      ensure
+        proxy.current_connection_name = nil
+      end
+    end
+  end
+end

data/lib/replicat/version.rb

@@ -0,0 +1,3 @@
+module Replicat
+  VERSION = "0.0.1"
+end

data/replicat.gemspec

@@ -0,0 +1,33 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "replicat/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "replicat"
+  spec.version       = Replicat::VERSION
+  spec.authors       = ["Ryo Nakamura"]
+  spec.email         = ["r7kamura@gmail.com"]
+  spec.summary       = "master-slave replication helper for ActiveRecord"
+  spec.homepage      = "https://github.com/r7kamura/replicat"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activerecord"
+  spec.add_dependency "activesupport"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "coffee-rails", ">= 3.0.10"
+  spec.add_development_dependency "jquery-rails"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-rails"
+  spec.add_development_dependency "rails", ">= 3.0.10"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", ">= 2.14.1"
+  spec.add_development_dependency "rspec-rails", ">= 2.14.0"
+  spec.add_development_dependency "sass-rails", ">= 3.0.10"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "uglifier"
+end

data/spec/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .