activerecord-turntable 2.1.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7a4bd6cbf61673b4f11bba18e22ff888a694f09a
-  data.tar.gz: b94e9d04efa41f8b58f5b65bdcc51bd4cb2a890c
+  metadata.gz: 8b5ef39b2f1a9eaa4b861f4e7ac57aabc2fffa21
+  data.tar.gz: 9cf6ae9ab38f0ebc8268a63fe188ed354b14deb5
 SHA512:
-  metadata.gz: 4c41774f64e47dde724ecd71b6eabe913c165d40ed159d73b867e0447ae64313437f0db4a4dcb98fb0e85f467ba3985b8a1974c6c97b558a9b793f115e093071
-  data.tar.gz: 63184562e69d48c2b2ae73b70878d1b01e850c1caf5ff11fd7a21ebe3c5e157b12f4a84e79da4cb94b198fa82193aa86328f7b493078aaf5ac7644c9f59345c5
+  metadata.gz: 26b6729a9cfe48c15982a3c23b748a2cc23746a79a16cc6a522f9e84dab6095ad156b7d193d9c324c5a76b4ccdcbd5b295ef95ff306dbf396819bfee6d473502
+  data.tar.gz: b96d8f0a07f38f527e6298c48fa7017fb6ffb3596c78410f4a0b0ebb57c1c29446aec04b27d98ccc5c1a34aaa9f464460c6a87c58eb687f18690d679996896f0

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+## activerecord-turntable 2.2.0 ##
+
+### Features
+
+* Add `modulo` algorithm (thx tatsuma)
+
+### Improvements
+
+* Add err detail to Building Fader exception log (thx tatsuma)
+
+### Bugfixes
+
+* Fix building cluster with mysql sequencer (fixes #25) (thx tatsuma)
+
+### Documentation
+
+* Fix seqeucner example (thx akicho8, tatsuma)
+
 ## activerecord-turntable 2.1.1 ##
 
 ### Bugfixes

data/README.md

@@ -22,7 +22,7 @@ Currently supports mysql only.
 Add to Gemfile:
 
 ```ruby
-gem 'activerecord-turntable', '~> 2.0.0'
+gem 'activerecord-turntable', '~> 2.1.1'
 ```
 
 Run a bundle install:
@@ -90,14 +90,14 @@ Edit turntable.yml and database.yml. See below example config.
     development:
       clusters:
         user_cluster: # <-- cluster name
-          algorithm: range_bsearch # <-- `range` or `range_bsearch`
+          algorithm: range_bsearch # <-- `range`, `range_bsearch` or `modulo`
           seq:
             user_seq: # <-- sequencer name
               seq_type: mysql # <-- sequencer type
               connection: user_seq_1 # <-- sequencer database connection setting
           shards:
             - connection: user_shard_1 # <-- shard name
-              less_than: 100           # <-- shard range(like mysql partitioning)
+              less_than: 100           # <-- shard range(like mysql partitioning) If you are using a modulo algorithm, it doesn't need it.
             - connection: user_shard_2
               less_than: 200
             - connection: user_shard_3
@@ -178,13 +178,13 @@ Add turntable [shard_key_name] to the model class:
 ```ruby
 class User < ActiveRecord::Base
   turntable :user_cluster, :id
-  sequencer
+  sequencer :user_seq
   has_one :status
 end
 
 class Status < ActiveRecord::Base
   turntable :user_cluster, :user_id
-  sequencer
+  sequencer :user_seq
   belongs_to :user
 end
 ```
@@ -296,7 +296,7 @@ Next, add sequencer definition to the model:
 ```ruby
   class User < ActiveRecord::Base
     turntable :id
-    sequencer :users_seq # <-- this line enables sequencer module
+    sequencer :user_seq # <-- this line enables sequencer module
     has_one :status
   end
 ```

data/lib/active_record/turntable/algorithm.rb

@@ -6,6 +6,7 @@ module ActiveRecord::Turntable
       autoload :Base
       autoload :RangeAlgorithm
       autoload :RangeBsearchAlgorithm
+      autoload :ModuloAlgorithm
     end
   end
 end

data/lib/active_record/turntable/algorithm/modulo_algorithm.rb

@@ -0,0 +1,14 @@
+# -*- coding: utf-8 -*-
+module ActiveRecord::Turntable::Algorithm
+  class ModuloAlgorithm < Base
+    def initialize(config)
+      @config = config
+    end
+
+    def calculate(key)
+      @config["shards"][key % @config["shards"].size]["connection"]
+    rescue
+      raise ActiveRecord::Turntable::CannotSpecifyShardError, "cannot specify shard for key:#{key}"
+    end
+  end
+end

data/lib/active_record/turntable/cluster.rb

@@ -14,8 +14,11 @@ module ActiveRecord::Turntable
       @shards = {}.with_indifferent_access
 
       # setup sequencer
-      if (seq = (@options[:seq] || @config[:seq])) && seq[:type] == :mysql
-        @seq_shard = SeqShard.new(seq)
+      seq = (@options[:seq] || @config[:seq])
+      if seq 
+        if seq.values.size > 0 && seq.values.first["seq_type"] == "mysql"
+          @seq_shard = SeqShard.new(seq.values.first)
+        end
       end
 
       # setup shards

data/lib/active_record/turntable/mixer.rb

@@ -48,7 +48,7 @@ module ActiveRecord::Turntable
                            method, query, *args, &block)
       end
     rescue Exception => err
-      logger.warn { "[ActiveRecord::Turntable] Error on Building Fader: #{binded_query}, on_method: #{method_name}" }
+      logger.warn { "[ActiveRecord::Turntable] Error on Building Fader: #{binded_query}, on_method: #{method_name}, err: #{err}" }
       raise err
     end
 

data/lib/active_record/turntable/seq_shard.rb

@@ -2,6 +2,13 @@ module ActiveRecord::Turntable
   class SeqShard < Shard
     private
 
+    def create_connection_class
+      klass = get_or_set_connection_class
+      klass.remove_connection
+      klass.establish_connection ActiveRecord::Base.connection_pool.spec.config[:seq][name].with_indifferent_access
+      klass
+    end
+ 
     def retrieve_connection_pool
       ActiveRecord::Base.turntable_connections[name] ||=
         begin

data/lib/active_record/turntable/shard.rb

@@ -30,7 +30,7 @@ module ActiveRecord::Turntable
       @connection_klass ||= create_connection_class
     end
 
-    def create_connection_class
+    def get_or_set_connection_class
       if Connections.const_defined?(name.classify)
         klass = Connections.const_get(name.classify)
       else
@@ -38,6 +38,11 @@ module ActiveRecord::Turntable
         Connections.const_set(name.classify, klass)
         klass.abstract_class = true
       end
+      klass
+    end
+
+    def create_connection_class
+      klass = get_or_set_connection_class
       klass.remove_connection
       klass.establish_connection ActiveRecord::Base.connection_pool.spec.config[:shards][name].with_indifferent_access
       klass

data/lib/active_record/turntable/version.rb

@@ -1,5 +1,5 @@
 module ActiveRecord
   module Turntable
-    VERSION = "2.1.1"
+    VERSION = "2.2.0"
   end
 end

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

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe ActiveRecord::Turntable::Algorithm::ModuloAlgorithm 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::ModuloAlgorithm.new(ActiveRecord::Base.turntable_config[:clusters][:mod_cluster])
+    end
+
+    context "#calculate with 1" do
+      subject { @alg.calculate(1) }
+      it { is_expected.to eq(ActiveRecord::Base.turntable_config[:clusters][:user_cluster][:shards][1][:connection]) }
+    end
+
+    context "#calculate with 3" do
+      subject { @alg.calculate(3) }
+      it { is_expected.to eq(ActiveRecord::Base.turntable_config[:clusters][:user_cluster][:shards][3][:connection]) }
+    end
+
+    context "#calculate with 5" do
+      subject { @alg.calculate(5) }
+      it { is_expected.to eq(ActiveRecord::Base.turntable_config[:clusters][:user_cluster][:shards][0][:connection]) }
+    end
+
+    context "#calculate with a value that is not a number" do
+      it "raises ActiveRecord::Turntable::CannotSpecifyShardError" do
+        expect { @alg.calculate('a') }.to raise_error(ActiveRecord::Turntable::CannotSpecifyShardError)
+      end
+    end
+  end
+
+end

data/spec/active_record/turntable/algorithm_spec.rb

@@ -82,4 +82,19 @@ describe ActiveRecord::Turntable::Algorithm do
       end
     end
   end
+
+  describe ActiveRecord::Turntable::Algorithm::ModuloAlgorithm do
+    let(:algorithm) { ActiveRecord::Turntable::Algorithm::ModuloAlgorithm.new(ActiveRecord::Base.turntable_config[:clusters][:mod_cluster]) }
+    context "#calculate" do
+      it "called with 1 return user_shard_2" do
+        expect(algorithm.calculate(1)).to eq("user_shard_2")
+      end
+      it "called with 3 return user_shard_2" do
+        expect(algorithm.calculate(3)).to eq("user_shard_2")
+      end
+      it "called with 5 return user_shard_1" do
+        expect(algorithm.calculate(5)).to eq("user_shard_1")
+      end
+    end
+  end
 end

data/spec/active_record/turntable/cluster_spec.rb

@@ -11,6 +11,8 @@ describe ActiveRecord::Turntable::Cluster do
   end
   let(:cluster_config) { ActiveRecord::Base.turntable_config[:clusters][:user_cluster] }
   let(:cluster) { ActiveRecord::Turntable::Cluster.new(cluster_config) }
+  let(:mysql_mod_cluster_config) { ActiveRecord::Base.turntable_config[:clusters][:mysql_mod_cluster] }
+  let(:mysql_mod_cluster) { ActiveRecord::Turntable::Cluster.new(mysql_mod_cluster_config) }
   let(:in_range_shard_key_value) { cluster_config[:shards].last[:less_than] - 1 }
   let(:out_of_range_shard_key_value) { cluster_config[:shards].last[:less_than] }
 
@@ -20,6 +22,13 @@ describe ActiveRecord::Turntable::Cluster do
     its(:shards) { should have(3).items }
   end
 
+  context "When initialized mysql sequencer type cluster" do
+    subject { mysql_mod_cluster }
+
+    its(:shards) { should have(2).items }
+    its(:seq)    { is_expected.not_to be nil }
+  end
+
   describe "#shard_for" do
     subject { cluster.shard_for(value) }
 

data/spec/config/turntable.yml

@@ -32,3 +32,25 @@ test:
           less_than: 80000
         - connection: user_shard_6
           less_than: 10000000
+    mod_cluster:
+      algorithm: modulo
+      seq:
+        user_seq:
+          connection: turntable_user_seq_test
+      shards:
+        - connection: user_shard_1
+        - connection: user_shard_2
+        - connection: user_shard_1
+        - connection: user_shard_2
+        - connection: user_shard_3
+    mysql_mod_cluster:
+      algorithm: modulo
+      seq:
+        user_seq:
+          seq_type: mysql
+          connection: user_seq
+      shards:
+        - connection: user_shard_1
+        - connection: user_shard_2
+        - connection: user_shard_2
+ 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-turntable
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.2.0
 platform: ruby
 authors:
 - gussan
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-26 00:00:00.000000000 Z
+date: 2015-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -364,6 +364,7 @@ files:
 - lib/active_record/turntable/algorithm.rb
 - lib/active_record/turntable/algorithm/.gitkeep
 - lib/active_record/turntable/algorithm/base.rb
+- lib/active_record/turntable/algorithm/modulo_algorithm.rb
 - lib/active_record/turntable/algorithm/range_algorithm.rb
 - lib/active_record/turntable/algorithm/range_bsearch_algorithm.rb
 - lib/active_record/turntable/base.rb
@@ -412,6 +413,7 @@ files:
 - spec/active_record/turntable/active_record_ext/migration_spec.rb
 - spec/active_record/turntable/active_record_ext/persistence_spec.rb
 - spec/active_record/turntable/active_record_ext/test_fixtures_spec.rb
+- spec/active_record/turntable/algorithm/modulo_algorithm_spec.rb
 - spec/active_record/turntable/algorithm/range_algorithm_spec.rb
 - spec/active_record/turntable/algorithm/range_bsearch_algorithm_spec.rb
 - spec/active_record/turntable/algorithm_spec.rb
@@ -482,6 +484,7 @@ test_files:
 - spec/active_record/turntable/active_record_ext/migration_spec.rb
 - spec/active_record/turntable/active_record_ext/persistence_spec.rb
 - spec/active_record/turntable/active_record_ext/test_fixtures_spec.rb
+- spec/active_record/turntable/algorithm/modulo_algorithm_spec.rb
 - spec/active_record/turntable/algorithm/range_algorithm_spec.rb
 - spec/active_record/turntable/algorithm/range_bsearch_algorithm_spec.rb
 - spec/active_record/turntable/algorithm_spec.rb