activerecord-turntable 1.0.0

data/sample_app/public/robots.txt

@@ -0,0 +1,5 @@
+# See http://www.robotstxt.org/wc/norobots.html for documentation on how to use the robots.txt file
+#
+# To ban all spiders from the entire site uncomment the next two lines:
+# User-Agent: *
+# Disallow: /

data/sample_app/script/rails

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require File.expand_path('../../config/boot',  __FILE__)
+require 'rails/commands'

data/script/performance/algorithm

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+require 'rspec'
+require File.join(File.dirname(__FILE__), '../../../spec/spec_helper')
+require 'benchmark'
+
+def setup_algorithm(n, alg = "Range")
+  config = {
+    "shards" => n.times.map do |i|
+      {"connection" => "connection_#{i}", "less_than" => (i+1) * 100}
+    end
+  }
+  "ActiveRecord::Turntable::Algorithm::#{alg}Algorithm".constantize.new(config)
+end
+
+Benchmark.bm(40) do |x|
+  %w(Range RangeBsearch).each do |alg|
+    [2, 4, 8, 16, 32, 64, 128, 256, 512].map do |n|
+      algorithm = setup_algorithm(n, alg)
+      x.report("#{alg}: selrand(#{n}) * 1000") {
+        1000.times do
+          algorithm.calculate(rand(n*100))
+        end
+      }
+      x.report("#{alg}: sellast(#{n}) * 1000") {
+        1000.times do
+          algorithm.calculate(n*100-1)
+        end
+      }
+    end
+  end
+end
+

data/spec/active_record/turntable/active_record_ext/clever_load_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+require 'logger'
+
+describe ActiveRecord::Turntable::ActiveRecordExt::CleverLoad do
+  before(:all) do
+    reload_turntable!(File.join(File.dirname(__FILE__), "../../../config/turntable.yml"))
+  end
+
+  before(:each) do
+    establish_connection_to("test")
+    truncate_shard
+
+    @user1 = User.new({:nickname => 'user1'})
+    @user1.id = 1
+    @user1.save
+    @user1_status = @user1.create_user_status(:hp => 10, :mp => 10)
+    @user2 = User.new({:nickname => 'user2'})
+    @user2.id = 2
+    @user2.save
+    @user2_status = @user2.create_user_status(:hp => 20, :mp => 10)
+    ActiveRecord::Base.logger = Logger.new(STDOUT)
+  end
+
+  context "When a model has has_one relation" do
+    context "When call clever_load!" do
+      before(:each) do
+        @strio = StringIO.new
+        ActiveRecord::Base.logger = Logger.new(@strio)
+        @users = User.clever_load!(:user_status)
+        puts @strio.string
+      end
+      it "should send merged user_status select query" do
+        @strio.string.should =~ //
+      end
+
+      it "should target loaded" do
+        @users.each do |user|
+          user.association(:user_status).loaded?.should be_true
+        end
+      end
+
+      it "should assigned reverse relation" do
+        pending "should be implemented"
+      end
+    end
+  end
+
+  context "When a model has belongs_to relation" do
+    context "When call clever_load!" do
+      before(:each) do
+        @strio = StringIO.new
+        @strio = StringIO.new
+        ActiveRecord::Base.logger = Logger.new(@strio)
+        @user_statuses = UserStatus.clever_load!(:user)
+        puts @strio.string
+      end
+
+      it "should send merged user_status select query" do
+        @strio.string.should =~ //
+      end
+
+      it "should target loaded" do
+        @user_statuses.each do |user_status|
+          user_status.association(:user).loaded?.should be_true
+        end
+      end
+
+      it "should assigned reverse relation" do
+        pending "should be implemented"
+      end
+    end
+  end
+
+  context "When a model has has_many relation" do
+    it "should send query only 2 times." do
+      pending "not implemented yet"
+    end
+  end
+
+
+end

data/spec/active_record/turntable/active_record_ext/persistence_spec.rb

@@ -0,0 +1,151 @@
+require 'spec_helper'
+require 'logger'
+
+describe ActiveRecord::Turntable::ActiveRecordExt::Persistence do
+  before(:all) do
+    reload_turntable!(File.join(File.dirname(__FILE__), "../../../config/turntable.yml"))
+  end
+
+  before(:each) do
+    establish_connection_to("test")
+    truncate_shard
+    ActiveRecord::Base.logger = Logger.new(STDOUT)
+  end
+
+  let(:user) {
+    u = User.new({:nickname => 'foobar'})
+    u.id = 1
+    u.updated_at = Time.current - 1.day
+    u.save
+    u
+  }
+  let(:user_status){
+    stat = user.create_user_status(:hp => 10, :mp => 10)
+    stat.updated_at = Time.current - 1.day
+    stat.save
+    stat
+  }
+  let(:card){
+    Card.create!(:name => 'foobar')
+  }
+
+  context "When the model is sharded by surrogate key" do
+    it "should not changed from normal operation when updating" do
+      user.nickname = "fizzbuzz"
+      strio = StringIO.new
+      ActiveRecord::Base.logger = Logger.new(strio)
+      expect {
+        user.save!
+      }.to_not raise_error
+      strio.string.should =~ /WHERE `users`\.`id` = #{user.id}[^\s]*$/
+    end
+
+    it "should change updated_at when updating" do
+      user.nickname = "fizzbuzz"
+
+      lambda {
+        user.save!
+      }.should change(user, :updated_at)
+    end
+
+    it "should not changed from normal operation when destroying" do
+      strio = StringIO.new
+      ActiveRecord::Base.logger = Logger.new(strio)
+      expect {
+        user.destroy
+      }.to_not raise_error
+      strio.string.should =~ /WHERE `users`\.`id` = #{user.id}[^\s]*$/
+    end
+  end
+
+  context "When called Callbacks" do
+    before do
+      class ::User
+        after_destroy :on_destroy
+        after_save    :on_update
+
+        def on_destroy
+        end
+
+        def on_update
+        end
+      end
+    end
+
+    context "on update once" do
+      it "callback should be called once" do
+        mock(user).on_update.times(1)
+        user.save
+      end
+    end
+    context "on destroy once" do
+      it "callback should be called once" do
+        mock(user).on_destroy.times(1)
+        user.destroy
+      end
+    end
+  end
+
+  context "When the model is sharded by other key" do
+    it "should send shard_key condition when updating" do
+      user_status.hp = 20
+
+      strio = StringIO.new
+      ActiveRecord::Base.logger = Logger.new(strio)
+      expect {
+        user_status.save!
+      }.to_not raise_error
+      strio.string.should =~ /WHERE `user_statuses`\.`id` = #{user_status.id} AND `user_statuses`\.`user_id` = #{user_status.user_id}[^\s]*$/
+    end
+
+    it "should change updated_at when updating" do
+      user_status.hp = 20
+
+      lambda {
+        user_status.save!
+      }.should change(user_status, :updated_at)
+    end
+
+    it "should send shard_key condition when destroying" do
+      strio = StringIO.new
+      ActiveRecord::Base.logger = Logger.new(strio)
+      expect {
+        user_status.destroy
+      }.to_not raise_error
+      puts strio.string
+      strio.string.should =~ /WHERE `user_statuses`\.`id` = #{user_status.id} AND `user_statuses`\.`user_id` = #{user_status.user_id}[^\s]*$/
+    end
+
+    it "should warn when creating without shard_key" do
+      pending "doesn't need to implemented soon"
+    end
+  end
+
+  context "When the model is not sharded" do
+    it "should not send shard_key condition when updating" do
+      card.name = "barbaz"
+      strio = StringIO.new
+      ActiveRecord::Base.logger = Logger.new(strio)
+      expect {
+        card.save!
+      }.to_not raise_error
+      strio.string.should =~ /WHERE `cards`\.`id` = #{card.id}[^\s]*$/
+    end
+
+    it "should not send shard_key condition when destroying" do
+      strio = StringIO.new
+      ActiveRecord::Base.logger = Logger.new(strio)
+      expect {
+        card.destroy
+      }.to_not raise_error
+      strio.string.should =~ /WHERE `cards`\.`id` = #{card.id}[^\s]*$/
+    end
+  end
+
+  context "When call reload" do
+    subject { user_status.reload }
+    it { should be_instance_of(UserStatus)}
+    it { should == user_status }
+  end
+
+end

data/spec/active_record/turntable/algorithm/range_algorithm_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe ActiveRecord::Turntable::Algorithm::RangeAlgorithm do
+  before(:all) do
+    reload_turntable!(File.join(File.dirname(__FILE__), "../../../config/turntable.yml"))
+  end
+
+  context "When initialized" do
+    before do
+      @alg = ActiveRecord::Turntable::Algorithm::RangeAlgorithm.new(ActiveRecord::Base.turntable_config[:clusters][:user_cluster])
+    end
+
+    context "#calculate with 1" do
+      subject { @alg.calculate(1) }
+      it { should == ActiveRecord::Base.turntable_config[:clusters][:user_cluster][:shards][0][:connection] }
+    end
+
+    context "#calculate with 19999" do
+      subject { @alg.calculate(19999) }
+      it { should == ActiveRecord::Base.turntable_config[:clusters][:user_cluster][:shards][0][:connection] }
+    end
+
+    context "#calculate with 20000" do
+      subject { @alg.calculate(20000) }
+      it { should == ActiveRecord::Base.turntable_config[:clusters][:user_cluster][:shards][1][:connection] }
+    end
+
+    context "#calculate with 10000000" do
+      it "raises ActiveRecord::Turntable::CannotSpecifyShardError" do
+        lambda { @alg.calculate(10000000) }.should raise_error(ActiveRecord::Turntable::CannotSpecifyShardError)
+      end
+    end
+  end
+
+end

data/spec/active_record/turntable/algorithm_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe ActiveRecord::Turntable::Algorithm do
+  before(:all) do
+    reload_turntable!(File.join(File.dirname(__FILE__), "../../config/turntable.yml"))
+  end
+
+  describe ActiveRecord::Turntable::Algorithm::RangeBsearchAlgorithm do
+    let(:algorithm) { ActiveRecord::Turntable::Algorithm::RangeBsearchAlgorithm.new(ActiveRecord::Base.turntable_config[:clusters][:user_cluster]) }
+    context "#calculate" do
+      it "called with 1 returns user_shard_1" do
+        algorithm.calculate(1).should == "user_shard_1"
+      end
+
+      it "called with 100000 returns user_shard_3" do
+        algorithm.calculate(100000).should == "user_shard_3"
+      end
+    end
+
+    context "#calculate_used_shards_with_weight" do
+      it "called with 10 returns 1 item" do
+        algorithm.calculate_used_shards_with_weight(10).should have(1).items
+      end
+
+      it "called with 10 returns {\"user_shard_1\" => 10}" do
+        algorithm.calculate_used_shards_with_weight(10).should == {"user_shard_1" => 10}
+      end
+
+      it "called with 65000 returns 2 items" do
+        algorithm.calculate_used_shards_with_weight(65000).should have(2).items
+      end
+
+      it "called with 65000 returns {\"user_shard_1\" => 39999, \"user_shard_2\" => 25001}" do
+        algorithm.calculate_used_shards_with_weight(65000).should == {"user_shard_1" => 39999, "user_shard_2" => 25001}
+      end
+    end
+  end
+
+  describe ActiveRecord::Turntable::Algorithm::RangeAlgorithm do
+    let(:algorithm) { ActiveRecord::Turntable::Algorithm::RangeAlgorithm.new(ActiveRecord::Base.turntable_config[:clusters][:user_cluster]) }
+    context "#calculate" do
+      it "called with 1 returns user_shard_1" do
+        algorithm.calculate(1).should == "user_shard_1"
+      end
+
+      it "called with 100000 returns user_shard_3" do
+        algorithm.calculate(100000).should == "user_shard_3"
+      end
+    end
+
+    context "#calculate_used_shards_with_weight" do
+      it "called with 10 returns 1 item" do
+        algorithm.calculate_used_shards_with_weight(10).should have(1).items
+      end
+
+      it "called with 10 returns {\"user_shard_1\" => 10}" do
+        algorithm.calculate_used_shards_with_weight(10).should == {"user_shard_1" => 10}
+      end
+
+      it "called with 65000 returns 2 items" do
+        algorithm.calculate_used_shards_with_weight(65000).should have(2).items
+      end
+
+      it "called with 65000 returns {\"user_shard_1\" => 39999, \"user_shard_2\" => 25001}" do
+        algorithm.calculate_used_shards_with_weight(65000).should == {"user_shard_1" => 39999, "user_shard_2" => 25001}
+      end
+    end
+  end
+end

data/spec/active_record/turntable/base_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe ActiveRecord::Turntable::Base do
+  before(:all) do
+    reload_turntable!(File.join(File.dirname(__FILE__), "../../config/turntable.yml"))
+  end
+
+  context "When installed to ActiveRecord::Base" do
+    it "ActiveRecord::Base respond_to 'turntable'" do
+      ActiveRecord::Base.should respond_to(:turntable)
+    end
+  end
+end

data/spec/active_record/turntable/cluster_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe ActiveRecord::Turntable::Cluster do
+  before(:all) do
+    reload_turntable!(File.join(File.dirname(__FILE__), "../../config/turntable.yml"))
+  end
+
+  context "When initialized" do
+    before do
+      establish_connection_to("test")
+      truncate_shard
+    end
+
+    subject { ActiveRecord::Turntable::Cluster.new(User, ActiveRecord::Base.turntable_config[:clusters][:user_cluster]) }
+    its(:klass) { should == User }
+    its(:shards) { should have(3).items }
+  end
+end

data/spec/active_record/turntable/config_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe ActiveRecord::Turntable::Config do
+  before(:all) do
+    reload_turntable!(File.join(File.dirname(__FILE__), "../../config/turntable.yml"))
+  end
+
+  subject { ActiveRecord::Turntable::Config }
+
+  it "has config hash" do
+    subject.instance.instance_variable_get(:@config).should be_an_kind_of(Hash)
+  end
+
+  it "has cluster setting" do
+    subject[:clusters][:user_cluster].should be_instance_of(ActiveSupport::HashWithIndifferentAccess)
+  end
+end