simple-sharding 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 439cde292a9f44fc9ddbfcd2a24e264e421cf2e3
+  data.tar.gz: 3a9cc11ad9a77f0f45a5d2d7b755f2114d9a4b25
+SHA512:
+  metadata.gz: 7383af6ebf3e7601e667bad83e071e6338953c89aefeda42dd19500511faba12fcfb2df824df9b86b53130635508669de35dd05b4c4baedd4730b311483fabc1
+  data.tar.gz: 230d741a452b438f419e3397bd0ea34324d60133e4d946c5216ccf2cb1c5f134db45f32c93e12a0b45d0fd906b3005f41bb934144379319883869b317f65fe2d

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 qiqidone
+
+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,28 @@
+# Simple::Sharding
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simple-sharding'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install simple-sharding
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,33 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Simple::Sharding'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/simple/sharding.rb

@@ -0,0 +1,11 @@
+require 'rails'
+require 'simple/sharding/version'
+require 'simple/sharding/core'
+
+module Simple
+  module Sharding
+    def self.method_missing(method_sym, *arguments, &block)
+      Core.send(method_sym, *arguments, &block)
+    end
+  end
+end

data/lib/simple/sharding/active_record_extensions.rb

@@ -0,0 +1,68 @@
+module Simple::Sharding
+  module ActiveRecordExtensions
+    def self.extend_active_record_scope
+      # return if exist
+      return if ActiveRecord::Base.respond_to?(:sharding)
+
+      # include sharding in class and instance
+      ActiveRecord::Base.extend ScopeMethods
+      ActiveRecord::Base.include ScopeMethods
+      ActiveRecord::extend CaseFixer
+
+      # Includes scope method in scopes
+      ActiveRecord::Relation.include ScopeMethods
+      ActiveRecord::Relation.extend CaseFixer
+
+      # Includes scope method in has_many and habtm relations
+      ActiveRecord::Scoping.include ScopeMethods
+      ActiveRecord::Scoping.extend CaseFixer
+    end
+  end
+
+  module ScopeMethods
+    def sharding(shard_id)
+      raise 'Error for sharding block.' if block_given?
+
+
+    end
+  end
+
+  # Return value of the #sharding scope method. Allows us to chain the shard
+  # choice with other ActiveRecord scopes
+  class ScopeProxy
+    attr_accessor :original_scope
+
+    def initialize(shard_id, original_scope)
+      @shard_id = shard_id
+      @original_scope = original_scope
+    end
+
+    def sharding(shard_id)
+      @shard_id = shard_id
+      self
+    end
+
+    def method_missing(method, *args, &block)
+      res = Core.sharding(@shard_id) do
+        @original_scope.send(method, *args, &block)
+      end
+
+      # if result is still a scope (responds to to_sql), update original scope
+      # and return proxy to continue chaining
+      if res.respond_to?(:to_sql)
+        @original_scope = res
+        return self
+      end
+
+      # return res
+      res
+    end
+
+    # Delegates == to method_missing so that User.sharding(:id).where(:name => "Mike")
+    # gets run in the correct shard context when #== is evaluated.
+    def ==(other)
+      method_missing(:==, other)
+    end
+    alias_method :eql?, :==
+  end
+end

data/lib/simple/sharding/config.rb

@@ -0,0 +1,18 @@
+module Simple::Sharding
+  class Config
+    DEFAULT_CONFIG = {
+        shard_config_file: 'config/shard.yml'
+    }
+
+    # initialize config
+    DEFAULT_CONFIG.each do |config_name, default_value|
+      self.cattr_accessor config_name, instance_accessor: false
+      self.send(config_name.to_s + '=', default_value)
+    end
+
+    # methods
+    def self.config(name)
+      DEFAULT_CONFIG[name]
+    end
+  end
+end

data/lib/simple/sharding/connection_handler.rb

@@ -0,0 +1,72 @@
+module Simple::Sharding
+  class ConnectionHandler
+    # check
+    def check(shard_id)
+      shard_id.present?
+    end
+
+    # establish all connection
+    def connect_all
+      Core.config.keys.each do |shard_id|
+        connect(shard_id)
+      end
+    end
+
+    def connect(shard_id)
+      resolver = ActiveRecord::ConnectionAdapters::ConnectionSpecification::Resolver.new(Config.config(shard_id))
+      connect_spec = resolver.spec(shard_id.to_sym)
+      connect_spec
+    end
+
+    def self.setup
+      @@connection_handler = ActiveRecord::ConnectionAdapters::ConnectionHandler.new
+      @@connection_pool_owners = {}
+    end
+
+    def self.connection_handler
+      raise 'Shards::ConnectionHandler was not setup' unless defined? @@connection_handler
+      @@connection_handler
+    end
+
+    def self.connection_pool(shard_id)
+      connection_handler.retrieve_connection_pool(connection_pool_owner(shard_id))
+    end
+
+    def self.retrie_connection(shard_id)
+      connection_handler.retrieve_connection(connection_pool_owner(shard_id))
+    end
+
+    def self.connected?(shard_id)
+      connection_handler.connected?(connection_pool_owner(shard_id))
+    end
+
+    def self.remove_connection(shard_id)
+      connection_handler.remove_connection(connection_pool_owner(shard_id))
+    end
+
+    def self.connection_pool_owner(shard_id)
+      @@connection_pool_owners[shard_id] ||= ConnectionPoolOwner.new(shard_id)
+    end
+
+    # Connection pool need a class to own each connection
+    class ConnectionPoolOwner
+      attr_reader :name
+
+      def initialize(name)
+        @name = name
+      end
+
+      # Safeguard in case pool cannot be retrieved for owner. This makes the error clear
+      def superclass
+        raise Exception, "ConnectionPool could not be retrieved for #{self}. "
+      end
+
+      # in case owner ends up printed by rails in an error message when retrieving connection
+      def to_s
+        "ConnectionPoolOwner with name #{self.name}"
+      end
+    end
+  end
+
+
+end

data/lib/simple/sharding/core.rb

@@ -0,0 +1,43 @@
+require 'simple/sharding/active_record_extensions'
+require 'simple/sharding/config'
+require 'simple/sharding/connection_handler'
+require 'simple/sharding/shard_thread_registry'
+
+module Simple::Sharding
+  class Core
+    # block support
+    def self.sharding(shard_id)
+      begin
+        raise "no shard group #{shard_id} found in pool." if ConnectionHandler.check(shard_id)
+        ShardThreadRegistry.push_current_shard(shard_id)
+        yield
+      ensure
+        # Releases connections in case user left some connection in the reserved state
+        # (by calling retrieve_connection instead of with_connection). Also, using
+        # normal activerecord queries leaves a connection in the reserved state
+        # Obs: don't do this with a master database connection
+        ConnectionHandler.connection_pool(shard_id).release_connection if !shard_id.blank?
+      end
+
+    end
+
+    # configuration
+    def self.config(env=Rails.env)
+      @@db_config ||= YAML.load_file(Config.config(:shard_config_file))
+      env_config = @@db_config[env]
+      return env_config if env_config
+
+      # error
+      raise "No correct config for env: #{env}."
+    end
+
+    def setup
+      if block_given?
+        yield Config
+      end
+
+      ConnectionHandler.connect_all
+      ActiveRecordExtensions.extend_active_record_scope
+    end
+  end
+end

data/lib/simple/sharding/shard_thread_registry.rb

@@ -0,0 +1,61 @@
+require 'active_support/per_thread_registry'
+
+module Simple::Sharding
+  class ShardThreadRegistry
+    extend ActiveSupport::PerThreadRegistry
+    attr_accessor :_current_shard_id
+
+    # Creates two thread-specific stacks to store the shard of connection
+    # The top of the stack indicates the current connection
+    # This allows us to have nested blocks of #using_shard and keep track of the
+    # connections as we open/close those blocks
+    thread_mattr_accessor :_shard_id_stack
+    # auxiliary stack that keeps track of wether each shard connection was used
+    # inside its respective using_shard block (so we can print an alert if not)
+    thread_mattr_accessor :_shard_connection_used_stack
+
+    def self.shard_id_stack; self._shard_id_stack ||= [] end;
+    def self.shard_connection_used_stack; self._shard_connection_used_stack ||= [] end;
+
+
+    # Returns the current shard id (for the current Thread)
+    def self.current_shard_id
+      shard_id_stack.last
+    end
+
+
+    def self.connect_to_master?
+      _current_shard_id.nil?
+    end
+
+    def self.current_shard_id
+      _current_shard_id
+    end
+
+    def self.current_shard_id=(shard_id)
+      self._current_shard_id = shard_id.blank? ? nil : shard_id.to_sym
+    end
+
+    # adds shard connection to the stack
+    def self.push_current_shard(shard_id)
+      # this line supresses the unused connection warning when there are nested
+      # using_shard blocks. We suppress the warning because we view nested using_shard
+      # blocks as a override
+      notify_connection_retrieved
+      shard_id_stack.push(shard_id.blank? ? nil : shard_id.to_sym)
+      shard_connection_used_stack.push(false)
+    end
+
+
+    # notifies the current connection was used (wee keep track of this to warn
+    # the user in case the connection is not used)
+    def self.notify_connection_retrieved
+      shard_connection_used_stack[-1] = true if shard_connection_used_stack.present?
+    end
+
+    # removes shard connection to the stack
+    def self.pop_current_shard
+      [shard_id_stack.pop, shard_connection_used_stack.pop]
+    end
+  end
+end

data/lib/simple/sharding/version.rb

@@ -0,0 +1,5 @@
+module Simple
+  module Sharding
+    VERSION = '0.1.0'
+  end
+end

data/lib/tasks/simple/sharding_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :simple_sharding do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: simple-sharding
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- qiqidone
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.3
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: Description of Simple::Sharding.
+email:
+- qiqidone@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/simple/sharding.rb
+- lib/simple/sharding/active_record_extensions.rb
+- lib/simple/sharding/config.rb
+- lib/simple/sharding/connection_handler.rb
+- lib/simple/sharding/core.rb
+- lib/simple/sharding/shard_thread_registry.rb
+- lib/simple/sharding/version.rb
+- lib/tasks/simple/sharding_tasks.rake
+homepage: http://baidu.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.10
+signing_key: 
+specification_version: 4
+summary: Simple::Sharding to shard data.
+test_files: []