activerecord-slave 0.0.2

data/lib/active_record/slave/model.rb

@@ -0,0 +1,44 @@
+require "active_support/concern"
+
+module ActiveRecord
+  module Slave
+    module Model
+      extend ActiveSupport::Concern
+
+      included do
+        private_class_method :define_slave_class
+      end
+
+      module ClassMethods
+        def use_slave(replication_name)
+          replication_config  = ActiveRecord::Slave.config.fetch_replication_config replication_name
+          @replication_router = ActiveRecord::Slave::ReplicationRouter.new replication_config
+
+          establish_connection replication_config.master_connection_name
+
+          @slave_class_repository = {}
+          base_class = self
+          replication_config.slave_connection_names.keys.each do |connection_name|
+            @slave_class_repository[connection_name] = define_slave_class base_class, connection_name
+          end
+        end
+
+        def slave_for
+          @slave_class_repository.fetch @replication_router.slave_connection_name
+        end
+
+        def define_slave_class(base_class, connection_name)
+          model = Class.new(base_class) do
+            module_eval <<-RUBY, __FILE__, __LINE__ + 1
+                    def self.name
+                      "#{base_class.name}::Slave::#{connection_name}"
+                    end
+                  RUBY
+          end
+          model.class_eval { establish_connection(connection_name) }
+          model
+        end
+      end
+    end
+  end
+end

data/lib/active_record/slave/railtie.rb

@@ -0,0 +1,9 @@
+module ActiveRecord
+  module Slave
+    class Railtie < ::Rails::Railtie
+      rake_tasks do
+        load File.expand_path("../../../tasks/activerecord-slave.rake", __FILE__)
+      end
+    end
+  end
+end

data/lib/active_record/slave/replication_config.rb

@@ -0,0 +1,28 @@
+module ActiveRecord
+  module Slave
+    class ReplicationConfig
+      attr_reader :name, :master_connection_name
+
+      def initialize(replication_name)
+        @name = replication_name
+      end
+
+      def validate_config!
+        fail "Nothing register master connection." unless @master_connection_name
+      end
+
+      def register_master(connection_name)
+        @master_connection_name = connection_name
+      end
+
+      def register_slave(connection_name, weight)
+        @slave_connection_registory ||= {}
+        @slave_connection_registory.store connection_name, weight
+      end
+
+      def slave_connection_names
+        @slave_connection_registory
+      end
+    end
+  end
+end

data/lib/active_record/slave/replication_router.rb

@@ -0,0 +1,21 @@
+require "pickup"
+
+module ActiveRecord
+  module Slave
+    class ReplicationRouter
+      def initialize(replication_config)
+        fail "Not ActiveRecord::Slave::ReplicationConfig object." unless replication_config.is_a? ActiveRecord::Slave::ReplicationConfig
+        @replication_config = replication_config
+      end
+
+      def master_connection_name
+        @replication_config.master_connection_name
+      end
+
+      def slave_connection_name
+        slaves = Pickup.new(@replication_config.slave_connection_names)
+        slaves.pick(1)
+      end
+    end
+  end
+end

data/lib/active_record/slave/version.rb

@@ -0,0 +1,5 @@
+module ActiveRecord
+  module Slave
+    VERSION = "0.0.2"
+  end
+end

data/lib/activerecord-slave.rb

@@ -0,0 +1,26 @@
+require "active_support/lazy_load_hooks"
+
+require "active_record"
+
+require "active_record/slave/version"
+require "active_record/slave/config"
+require "active_record/slave/replication_config"
+require "active_record/slave/replication_router"
+require "active_record/slave/model"
+require "active_record/slave/database_tasks"
+
+module ActiveRecord
+  module Slave
+    class << self
+      def config
+        @config ||= Config.new
+      end
+
+      def configure(&block)
+        config.instance_eval(&block)
+      end
+    end
+  end
+end
+
+require "active_record/slave/railtie" if defined? Rails

data/lib/tasks/activerecord-slave.rake

@@ -0,0 +1,13 @@
+namespace :active_record do
+  namespace :slave do
+    desc "Create database for replicaition master"
+    task :db_create, %i(replicaition) => %i(environment) do |_, args|
+      ActiveRecord::Slave::DatabaseTasks.create_database args
+    end
+
+    desc "Drop database for replicaition master"
+    task :db_drop, %i(replicaition) => %i(environment) do |_, args|
+      ActiveRecord::Slave::DatabaseTasks.drop_database args
+    end
+  end
+end

data/spec/active_record/slave/config_spec.rb

@@ -0,0 +1,17 @@
+describe ActiveRecord::Slave::Config do
+  let!(:config) do
+    config = ActiveRecord::Slave::Config.new
+    config.define_replication(:test) do |replication|
+      replication.register_master :test_master
+      replication.register_slave :test_slave_001, 70
+      replication.register_slave :test_slave_002, 30
+    end
+    config
+  end
+
+  describe "#fetch_replication_config" do
+    it "returns :test replication config" do
+      expect(config.fetch_replication_config :test).to be_a ActiveRecord::Slave::ReplicationConfig
+    end
+  end
+end

data/spec/active_record/slave/database_tasks_spec.rb

@@ -0,0 +1,21 @@
+describe ActiveRecord::Slave::DatabaseTasks do
+  let(:args) do
+    { replicaition: "task" }
+  end
+
+  after(:each) do
+    ActiveRecord::Base.establish_connection(:test)
+  end
+
+  it "Create database" do
+    ActiveRecord::Slave::DatabaseTasks.create_database args
+    expect(ActiveRecord::Base.connection.execute("SHOW DATABASES").include? ["test_task"]).to be true
+  end
+
+  context "Created task replicaition database" do
+    it "Drop database" do
+      ActiveRecord::Slave::DatabaseTasks.drop_database args
+      expect(ActiveRecord::Base.connection.execute("SHOW DATABASES").include? ["test_task"]).to be false
+    end
+  end
+end

data/spec/active_record/slave/model_spec.rb

@@ -0,0 +1,98 @@
+describe ActiveRecord::Slave::Model do
+  it "connect to master" do
+    expect(User.connection.pool.spec.config[:port]).to eq 21891
+  end
+
+  it "connect to slaves", retry: 3 do
+    slave_ports = 10.times.map { User.slave_for.connection.pool.spec.config[:port] }.uniq
+    expect(slave_ports.count).to eq 2
+    expect(slave_ports).to include 21892
+    expect(slave_ports).to include 21893
+  end
+
+  it "connect to default" do
+    expect(Item.connection.pool.spec.config[:port]).to eq 3306
+  end
+
+  describe "Write to master, Read from slave" do
+    it "returns user object from slave database" do
+      user_from_master = User.create name: "alice"
+
+      user_from_slave  = User.slave_for.find user_from_master.id
+
+      expect(user_from_master.id).to eq user_from_slave.id
+      expect(user_from_master.name).to eq user_from_slave.name
+    end
+  end
+
+  describe "Assosiations" do
+    let(:user) { User.create name: "alice" }
+
+    context "has_many object" do
+      context "in default database" do
+        let(:item) { Item.create name: "foo", count: 1, user: user }
+
+        it "returns user object, belongs_to" do
+          expect(item.user).to be_a User
+          expect(item.user.id).to eq user.id
+        end
+
+        describe "model connect to default database" do
+          it "returns has_many objects" do
+            expect { item }.to change { user.items.count }.from(0).to(1)
+            expect { Item.create name: "bar", count: 1, user: user }.to change { user.items.count }.from(1).to(2)
+          end
+
+          it "returns replication model object" do
+            expect(Item.find(item.id).user).to eq user
+          end
+
+          it "returns default database service port" do
+            expect(Item.connection.pool.spec.config[:port]).to eq 3306
+          end
+        end
+      end
+
+      context "in replication database" do
+        let(:skill) { Skill.create name: "bar", user: user }
+
+        it "returns user object, belongs_to" do
+          expect(skill.user).to be_a User
+          expect(skill.user.id).to eq user.id
+        end
+
+        describe "model connect to raplication databases" do
+          it "returns has_many objects" do
+            expect { skill }.to change { user.skills.count }.from(0).to(1)
+            expect { Skill.create name: "foobar", user: user }.to change { user.skills.count }.from(1).to(2)
+            expect(user.skills.count).to eq Skill.slave_for.where(user_id: user.id).count
+          end
+
+          it "returns other model object from master" do
+            expect(Skill.find(skill.id).user).to eq user
+          end
+
+          it "returns other model object from slaves" do
+            expect(Skill.slave_for.find(skill.id).user).to eq user
+          end
+
+          it "returns master database service port" do
+            expect(Skill.connection.pool.spec.config[:port]).to eq 21891
+          end
+
+          it "returns slave database service port" do
+            expect(Skill.slave_for.connection.pool.spec.config[:port]).to eq(21892) | eq(21893)
+          end
+        end
+      end
+    end
+
+    context "Enable DatabaseRewinder, delete records at each after specs" do
+      it "No records in DataBases" do
+        expect(User.all.count).to eq 0
+        expect(Item.all.count).to eq 0
+        expect(Skill.all.count).to eq 0
+      end
+    end
+  end
+end

data/spec/active_record/slave/replication_config_spec.rb

@@ -0,0 +1,46 @@
+describe ActiveRecord::Slave::ReplicationConfig do
+  let!(:replication_config) do
+    config = ActiveRecord::Slave::ReplicationConfig.new :test_replication
+
+    config.register_master :test_master
+
+    config.register_slave :test_slave_001, 70
+    config.register_slave :test_slave_002, 30
+
+    config
+  end
+
+  context "not setup config for ReplicationConfig object" do
+    context "#validate_config!" do
+      let!(:not_setup_replication_config) { ActiveRecord::Slave::ReplicationConfig.new :test_replication }
+
+      it "returns raise, nothing register master connection" do
+        expect { not_setup_replication_config.validate_config! }.to raise_error "Nothing register master connection."
+      end
+
+      it "returns nil, config is valid" do
+        expect(replication_config.validate_config!).to be nil
+      end
+    end
+  end
+
+  context "#name" do
+    it "returns replication name" do
+      expect(replication_config.name).to eq :test_replication
+    end
+  end
+
+  context "#master_connection_name" do
+    it "returns master database connection name" do
+      expect(replication_config.master_connection_name).to eq :test_master
+    end
+  end
+
+  context "#slave_connection_names" do
+    it "returns slave database connection names" do
+      expect(replication_config.slave_connection_names).to be_a Hash
+      expect(replication_config.slave_connection_names).to include test_slave_001: 70
+      expect(replication_config.slave_connection_names).to include test_slave_002: 30
+    end
+  end
+end

data/spec/active_record/slave/replication_router_spec.rb

@@ -0,0 +1,41 @@
+describe ActiveRecord::Slave::ReplicationRouter do
+  let!(:replication_config) do
+    config = ActiveRecord::Slave::Config.new
+    config.define_replication(:test) do |replication|
+      replication.register_master :test_master
+      replication.register_slave :test_slave_001, 70
+      replication.register_slave :test_slave_002, 30
+    end
+    config.fetch_replication_config :test
+  end
+
+  let!(:replication_router) do
+    ActiveRecord::Slave::ReplicationRouter.new replication_config
+  end
+
+  describe "#new" do
+    it "Make instance object" do
+      expect(ActiveRecord::Slave::ReplicationRouter.new replication_config).to be_a ActiveRecord::Slave::ReplicationRouter
+    end
+
+    it "Raise error" do
+      expect { ActiveRecord::Slave::ReplicationRouter.new "test" }.to raise_error "Not ActiveRecord::Slave::ReplicationConfig object."
+    end
+  end
+
+  describe "#master_connection_name" do
+    it "returns master database conneciton name" do
+      expect(replication_router.master_connection_name).to eq :test_master
+    end
+  end
+
+  describe "#slave_connection_name" do
+    it "returns slave database conneciton name, by wait lottery confidence 99%", retry: 3  do
+      slave_connection_names = 10000.times.map { replication_router.slave_connection_name }
+      expect(slave_connection_names.count(:test_slave_001)).to be_between 7000 - 60, 7000 + 60
+      expect(slave_connection_names.count(:test_slave_002)).to be_between 3000 - 60, 3000 + 60
+      expect(slave_connection_names).to include :test_slave_001
+      expect(slave_connection_names).to include :test_slave_002
+    end
+  end
+end

data/spec/active_record/slave/version_spec.rb

@@ -0,0 +1,5 @@
+describe "ActiveRecord::Slave::VERSION" do
+  it "return version number" do
+    expect(ActiveRecord::Slave::VERSION).to be_a String
+  end
+end

data/spec/models.rb

@@ -0,0 +1,49 @@
+base = { "adapter" => "mysql2", "encoding" => "utf8", "pool" => 5, "username" => "root", "password" => "msandbox", "host" => "127.0.0.1" }
+
+ActiveRecord::Base.configurations = {
+  "test_master"    => base.merge("database" => "test_slave", "port" => 21891),
+  "test_slave_001" => base.merge("database" => "test_slave", "port" => 21892),
+  "test_slave_002" => base.merge("database" => "test_slave", "port" => 21893),
+  "test"           => base.merge("database" => "test", "port" => 3306, "password" => ""),
+
+  "test_task_master" => base.merge("database" => "test_task", "port" => 21891),
+  "test_task_slave_001"   => base.merge("database" => "test_task", "port" => 21892),
+  "test_task_slave_002"   => base.merge("database" => "test_task", "port" => 21893)
+}
+
+ActiveRecord::Slave.configure do |config|
+  config.define_replication(:user) do |replication|
+    replication.register_master(:test_master)
+
+    replication.register_slave(:test_slave_001, 70)
+    replication.register_slave(:test_slave_002, 30)
+  end
+
+  config.define_replication(:task) do |replication|
+    replication.register_master(:test_task_master)
+
+    replication.register_slave(:test_task_slave_001, 1)
+    replication.register_slave(:test_task_slave_002, 1)
+  end
+end
+
+ActiveRecord::Base.establish_connection(:test)
+
+class User < ActiveRecord::Base
+  has_many :items
+  has_many :skills
+
+  include ActiveRecord::Slave::Model
+  use_slave :user
+end
+
+class Item < ActiveRecord::Base
+  belongs_to :user
+end
+
+class Skill < ActiveRecord::Base
+  belongs_to :user
+
+  include ActiveRecord::Slave::Model
+  use_slave :user
+end

data/spec/schema.rb

@@ -0,0 +1,26 @@
+ActiveRecord::Schema.define(version: 0) do
+  create_table "users", force: :cascade do |t|
+    t.string "name", null: false
+    t.datetime "created_at",   null: false
+    t.datetime "updated_at",   null: false
+  end
+end
+
+ActiveRecord::Schema.define(version: 1) do
+  create_table "items", force: :cascade do |t|
+    t.integer "user_id", null: false
+    t.string "name", null: false
+    t.integer "count", null: false
+    t.datetime "created_at",   null: false
+    t.datetime "updated_at",   null: false
+  end
+end
+
+ActiveRecord::Schema.define(version: 2) do
+  create_table "skills", force: :cascade do |t|
+    t.integer "user_id", null: false
+    t.string "name", null: false
+    t.datetime "created_at",   null: false
+    t.datetime "updated_at",   null: false
+  end
+end