tako 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5d57edc16d1cde1831865a7eba1414a489cbbe1d
-  data.tar.gz: ecc1d7552a3c079f4a45e5c44fac71352eb736c2
+  metadata.gz: 9861d9ec9b928c4ed0bbe68ada132a9335fd6077
+  data.tar.gz: 78351b4438784d0b40bf5a4e3b826ef5c60624eb
 SHA512:
-  metadata.gz: 7ecf25dffebf58ec6f5076eb53b510a455cc14912ca78bafdd50670cf46d401af4d91d48ea2aacf72e126de4593c5521a0617a03bd6fe8467a1cef744fac7f1b
-  data.tar.gz: 5d168488bddb04febbdd27177d927f7d095eb434b411e6981f8c7219cea588b3da3d3e318f51a32c75ee827aaef291f28e26e1842f9e7cb604a625193f2f8900
+  metadata.gz: cbb4e884798a8dbb5d2de722ffcc196c048a82df49ce45b56c9530c878e492489bae0f8e5d3a71f577f765c8c41ff87fb90da93877b7efdc7237075838f66acc
+  data.tar.gz: 29f14c874dbf1d539dfbdfc263121406daee76fd53f3ca44a9c06eeec724cadcea11adfee04fde6aab5b1512d71f53164340adac25a96cc802749fe7efa7fbb9

data/README.md

@@ -53,6 +53,16 @@ ModelA.shard(:slave_two) do
 end
 ```
 
+## Vertical Sharding
+
+Add `force_shard` definition to your Vertical-Sharding model
+
+```ruby
+class YourModel < ActiveRecord::Base
+  force_shard :shard01
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/bin/console

@@ -10,5 +10,17 @@ require "tako"
 # require "pry"
 # Pry.start
 
-require "irb"
-IRB.start
+require "pry"
+
+require File.join(File.dirname(__FILE__), "../../", "spec/support/model_class")
+
+ENV["RAILS_ENV"] ||= 'test'
+ENV['TAKO_CONFIG_FILE_PATH'] ||= File.join(File.dirname(__FILE__), "../", "spec/config/shards.yml")
+
+database_yml_path = File.join(File.dirname(__FILE__), "../", "spec/config/database.yml")
+database_yml = YAML.load(ERB.new(File.read(database_yml_path)).result).with_indifferent_access[:test]
+Tako.load_connections_from_yaml
+ActiveRecord::Base.establish_connection(database_yml)
+
+opts = Pry::CLI.parse_options
+Pry::CLI.start(opts)

data/lib/tako/active_record_ext/association.rb

@@ -0,0 +1,18 @@
+module Tako
+  module ActiveRecordExt
+    module Association
+      def current_shard
+        owner.current_shard
+      end
+
+      def self.included(mod)
+        mod.extend(ShardedMethods)
+        mod.sharded_methods :target_scope
+      end
+    end
+  end
+end
+
+ActiveRecord::Associations::Association.class_eval do
+  include Tako::ActiveRecordExt::Association
+end

data/lib/tako/active_record_ext/association_relation.rb

@@ -0,0 +1,39 @@
+module Tako
+  module ActiveRecordExt
+    module AssociationRelation
+      def self.included(mod)
+        mod.extend(ShardedMethods)
+        mod.sharded_methods :any?,
+                            :build,
+                            :count,
+                            :create,
+                            :create!,
+                            :delete,
+                            :delete_all,
+                            :destroy,
+                            :destroy_all,
+                            :empty?,
+                            :find,
+                            :first,
+                            :include?,
+                            :last,
+                            :length,
+                            :many?,
+                            :pluck,
+                            :select,
+                            :size,
+                            :sum,
+                            :to_a,
+                            :uniq
+      end
+
+      def current_shard
+        @association.owner.current_shard
+      end
+    end
+  end
+end
+
+ActiveRecord::AssociationRelation.class_eval do
+  include Tako::ActiveRecordExt::AssociationRelation
+end

data/lib/tako/active_record_ext/base.rb

@@ -0,0 +1,61 @@
+module Tako
+  module ActiveRecordExt
+    module Base
+      module ClassMethods
+        def shard(shard_name)
+          if block_given?
+            Tako.shard(shard_name) do
+              yield
+            end
+          else
+            Tako::QueryChain.new(
+              Tako::Repository.create_proxy(shard_name),
+              self
+            )
+          end
+        end
+
+        def force_shard(shard_name)
+          @force_shard = shard_name
+        end
+
+        def force_shard?
+          @force_shard.present?
+        end
+      end
+
+      module InstanceMethods
+        attr_accessor :current_shard
+
+        def self.included(mod)
+          mod.extend(ShardedMethods)
+          mod.sharded_methods :update_attribute,
+                              :update_attributes,
+                              :update_attributes!,
+                              :reload,
+                              :delete,
+                              :destroy,
+                              :touch,
+                              :update_column,
+                              :save,
+                              :save!
+
+          mod.class_eval do
+            after_initialize :set_current_shard
+
+            private
+
+              def set_current_shard
+                @current_shard = ::Tako::ProxyStack.top.try(:shard_name)
+              end
+          end
+        end
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.class_eval do
+  extend Tako::ActiveRecordExt::Base::ClassMethods
+  include Tako::ActiveRecordExt::Base::InstanceMethods
+end

data/lib/tako/active_record_ext/collection_association.rb

@@ -0,0 +1,33 @@
+module Tako
+  module ActiveRecordExt
+    module CollectionAssociation
+      def self.included(mod)
+        mod.extend(ShardedMethods)
+        mod.sharded_methods :reader,
+                            :writer,
+                            :ids_reader,
+                            :ids_writer,
+                            :create,
+                            :create!,
+                            :build,
+                            :any?,
+                            :count,
+                            :empty?,
+                            :first,
+                            :include?,
+                            :last,
+                            :length,
+                            :load_target,
+                            :many?,
+                            :reload,
+                            :size,
+                            :select,
+                            :uniq
+      end
+    end
+  end
+end
+
+ActiveRecord::Associations::CollectionAssociation.class_eval do
+  include Tako::ActiveRecordExt::CollectionAssociation
+end

data/lib/tako/active_record_ext/collection_proxy.rb

@@ -0,0 +1,41 @@
+module Tako
+  module ActiveRecordExt
+    module CollectionProxy
+      def self.included(mod)
+        mod.extend(ShardedMethods)
+        mod.sharded_methods :any?,
+                            :build,
+                            :count,
+                            :create,
+                            :create!,
+                            :concat,
+                            :delete,
+                            :delete_all,
+                            :destroy,
+                            :destroy_all,
+                            :empty?,
+                            :find,
+                            :first,
+                            :include?,
+                            :last,
+                            :length,
+                            :many?,
+                            :pluck,
+                            :replace,
+                            :select,
+                            :size,
+                            :sum,
+                            :to_a,
+                            :uniq
+      end
+
+      def current_shard
+        @association.owner.current_shard
+      end
+    end
+  end
+end
+
+ActiveRecord::Associations::CollectionProxy.class_eval do
+  include Tako::ActiveRecordExt::CollectionProxy
+end

data/lib/tako/active_record_ext/connection_handling.rb

@@ -0,0 +1,18 @@
+module Tako
+  module ActiveRecordExt
+    module ConnectionHandling
+      def connection
+        return Tako::Repository.create_proxy(@force_shard).connection if force_shard?
+        if Tako::ProxyStack.top
+          Tako::ProxyStack.top.connection
+        else
+          super
+        end
+      end
+    end
+  end
+end
+
+ActiveRecord::ConnectionHandling.class_eval do
+  prepend Tako::ActiveRecordExt::ConnectionHandling
+end

data/lib/tako/active_record_ext/log_subscriber.rb

@@ -0,0 +1,22 @@
+module Tako
+  module ActiveRecordExt
+    module LogSubscriber
+      CLEAR   = "\e[0m"
+      GREEN   = "\e[32m"
+
+      def debug(msg)
+        current_shard = ::Tako::ProxyStack.top.try(:shard_name)
+
+        if current_shard
+          super("#{GREEN}[Shard: #{current_shard}]#{CLEAR}" + msg)
+        else
+          super
+        end
+      end
+    end
+  end
+end
+
+ActiveRecord::LogSubscriber.class_eval do
+  prepend Tako::ActiveRecordExt::LogSubscriber
+end

data/lib/tako/active_record_ext/sharded_methods.rb

@@ -0,0 +1,19 @@
+module Tako
+  module ActiveRecordExt
+    module ShardedMethods
+      def sharded_methods(*method_names)
+        method_names.each do |method_name|
+          define_method(:"#{method_name}_with_tako") do |*params, &block|
+            if current_shard
+              ::Tako.shard(current_shard) { send(:"#{method_name}_without_tako",*params, &block) }
+            else
+              send(:"#{method_name}_without_tako",*params, &block)
+            end
+          end
+          send(:alias_method, :"#{method_name}_without_tako", method_name)
+          send(:alias_method, method_name, :"#{method_name}_with_tako")
+        end
+      end
+    end
+  end
+end

data/lib/tako/active_record_ext/singular_association.rb

@@ -0,0 +1,18 @@
+module Tako
+  module ActiveRecordExt
+    module SingularAssociation
+      def self.included(mod)
+        mod.extend(ShardedMethods)
+        mod.sharded_methods :reader,
+                            :writer,
+                            :create,
+                            :create!,
+                            :build
+      end
+    end
+  end
+end
+
+ActiveRecord::Associations::SingularAssociation.class_eval do
+  include Tako::ActiveRecordExt::SingularAssociation
+end

data/lib/tako/active_record_ext.rb

@@ -1,32 +1,4 @@
 module Tako
   module ActiveRecordExt
-    module ConnectionHandling
-      module Prepend
-        def connection
-          if Tako::ProxyStack.top
-            Tako::ProxyStack.top.connection
-          else
-            super
-          end
-        end
-      end
-    end
-
-    module Base
-      module Extend
-        def shard(shard_name)
-          if block_given?
-            Tako.shard(shard_name) do
-              yield
-            end
-          else
-            Tako::QueryChain.new(
-              Tako::Repository.shard(shard_name),
-              self
-            )
-          end
-        end
-      end
-    end
   end
 end

data/lib/tako/proxy.rb

@@ -2,16 +2,14 @@ module Tako
   class Proxy
     attr_reader :shard_name
     attr_reader :connection
-    attr_accessor :base
 
-    def initialize(shard_name, connection, base)
+    def initialize(shard_name, connection)
       @shard_name = shard_name
       @connection = connection
-      @base = base
     end
 
-    def in_proxy
-      Tako::ProxyStack.in_piles(self) do
+    def with_shard
+      Tako::ProxyStack.with_shard(self) do
         yield
       end
     end

data/lib/tako/proxy_stack.rb

@@ -5,13 +5,13 @@ module Tako
         @current
       end
 
-      def in_piles(proxy)
-        proxy.base ||= @current
+      def with_shard(proxy)
+        previous ||= @current
         @current = proxy
 
         yield
       ensure
-        @current = @current.base
+        @current = previous
       end
     end
   end

data/lib/tako/query_chain.rb

@@ -9,22 +9,38 @@ module Tako
     end
 
     def method_missing(method, *args)
-      @proxy.in_proxy do
-        if block_given?
-          base_object.send(method, *args) do
-            yield
-          end
-        else
-          base_object.send(method, *args)
+      @proxy.with_shard do
+        result = if block_given?
+                    base_object.send(method, *args) do
+                      yield
+                    end
+                  else
+                    base_object.send(method, *args)
+                  end
+
+        if chain_available?(result)
+          @base_object = result
+          return self
         end
+
+        result
       end
     end
 
     def shard(shard_name)
       new(
-        Tako::Repository.shard(shard_name),
+        Tako::Repository.create_proxy(shard_name),
         self
       )
     end
+
+    private
+
+    def chain_available?(obj)
+      [
+        ::ActiveRecord::Relation,
+        ::ActiveRecord::QueryMethods::WhereChain
+      ].any? { |anc| obj.is_a?(anc) }
+    end
   end
 end

data/lib/tako/repository.rb

@@ -21,8 +21,8 @@ module Tako
         proxy_configs[shard_name] = conf
       end
 
-      def shard(shard_name, base = nil)
-        Proxy.new(shard_name, proxy_connections[shard_name.to_sym], base)
+      def create_proxy(shard_name)
+        Proxy.new(shard_name, proxy_connections[shard_name.to_sym])
       end
 
       def shard_names

data/lib/tako/version.rb

@@ -1,3 +1,3 @@
 module Tako
-  VERSION = "0.2.2"
+  VERSION = "0.3.0"
 end

data/lib/tako.rb

@@ -14,7 +14,7 @@ module Tako
   class << self
     def shard(shard_name)
       if block_given?
-        Tako::Repository.shard(shard_name).in_proxy do
+        Tako::Repository.create_proxy(shard_name).with_shard do
           yield
         end
       else
@@ -39,13 +39,14 @@ module Tako
 end
 
 require 'active_record'
-
-ActiveRecord::ConnectionHandling.class_eval do
-  prepend Tako::ActiveRecordExt::ConnectionHandling::Prepend
-end
-
-ActiveRecord::Base.class_eval do
-  extend Tako::ActiveRecordExt::Base::Extend
-end
+require 'tako/active_record_ext/sharded_methods'
+require 'tako/active_record_ext/connection_handling'
+require 'tako/active_record_ext/base'
+require 'tako/active_record_ext/association'
+require 'tako/active_record_ext/collection_association'
+require 'tako/active_record_ext/singular_association'
+require 'tako/active_record_ext/collection_proxy'
+require 'tako/active_record_ext/association_relation'
+require 'tako/active_record_ext/log_subscriber'
 
 require 'tako/railtie' if defined?(::Rails)

data/tako.gemspec

@@ -32,4 +32,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.11"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tako
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Masashi AKISUE
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-04 00:00:00.000000000 Z
+date: 2016-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - masashi.akisue@aktsk.jp
@@ -100,6 +114,15 @@ files:
 - circle.yml
 - lib/tako.rb
 - lib/tako/active_record_ext.rb
+- lib/tako/active_record_ext/association.rb
+- lib/tako/active_record_ext/association_relation.rb
+- lib/tako/active_record_ext/base.rb
+- lib/tako/active_record_ext/collection_association.rb
+- lib/tako/active_record_ext/collection_proxy.rb
+- lib/tako/active_record_ext/connection_handling.rb
+- lib/tako/active_record_ext/log_subscriber.rb
+- lib/tako/active_record_ext/sharded_methods.rb
+- lib/tako/active_record_ext/singular_association.rb
 - lib/tako/config.rb
 - lib/tako/multi_shard_execution.rb
 - lib/tako/proxy.rb