shard_handler 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c2728db474dde6a413de4340acebf59e340bd929
+  data.tar.gz: f4c4df74df1ea909359edf2f8f79fff624824090
+SHA512:
+  metadata.gz: bac3f0308f32e0aee8f1ddd1e9e196b06902041158db7567f206435b549e58a944894ef21176007d4871b238175bf9b6cbffbbd6386781e72511e3933010296c
+  data.tar.gz: e90d66071b5e082ae1e09c071e204d74adc0b8b033f71715e27d1972ee277836c60c8c961fbf67833044bf7ea605f2d74f29ae0eb6788ca44257fb785762862f

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/spec/database.yml
+/spec/shards.yml

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.3
+before_install: gem install bundler -v 1.10.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in shard_handler.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Locaweb
+
+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,65 @@
+# ShardHandler
+
+This gem is a simple sharding solution for Rails applications. It was created
+to be used in multitenant applications, when data is shared across multiple
+databases but accessed through the same ActiveRecord model.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'shard_handler'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install shard_handler
+
+## Usage
+
+All models that need sharding must inherit from `ShardHandler::Model`. For
+example:
+
+```ruby
+class Post < ShardHandler::Model
+end
+```
+
+Before executing any query, you must switch to the appropriate shard:
+
+```ruby
+ShardHandler.current_shard = :shard1
+puts Post.pluck(:title)
+
+# or
+
+ShardHandler.using(:shard1) do
+  puts Post.pluck(:title)
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake test` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/shard_handler.
+
+
+## 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,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'shard_handler'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/shard_handler.rb

@@ -0,0 +1,8 @@
+require 'shard_handler/version'
+require 'shard_handler/model'
+require 'shard_handler/handler'
+require 'shard_handler/thread_registry'
+require 'shard_handler/errors'
+
+module ShardHandler
+end

data/lib/shard_handler/errors.rb

@@ -0,0 +1,9 @@
+module ShardHandler
+  # This error is raised when one tries to perform a query on {Model} without
+  # setting it up first.
+  class SetupError < StandardError; end
+
+  # This error is raised when using a shard name that does not exist in the
+  # configuration.
+  class UnknownShardError < StandardError; end
+end

data/lib/shard_handler/handler.rb

@@ -0,0 +1,49 @@
+module ShardHandler
+  # Handles which {ConnectionHandler} instance should be used based on the
+  # shard name that is set for the Thread. Each {Model} class has its own
+  # {Handler}.
+  #
+  # @see Model
+  # @api private
+  class Handler
+    # @param klass [ActiveRecord::Base] model class
+    # @param configs [Hash] a hash with database connection settings
+    def initialize(klass, configs)
+      @klass = klass
+      @configs = configs
+      @cache = {}
+    end
+
+    # Creates a {ConnectionHandler} instance for each configured shard and puts
+    # it on cache to be used later by {#connection_handler_for}.
+    def setup
+      resolver = ActiveRecord::ConnectionAdapters::ConnectionSpecification::Resolver.new(@configs)
+
+      @configs.each do |name, _|
+        name = name.to_sym
+
+        connection_handler = ActiveRecord::ConnectionAdapters::ConnectionHandler.new
+        connection_handler.establish_connection(@klass, resolver.spec(name))
+
+        @cache[name] = connection_handler
+      end
+    end
+
+    # Returns the appropriate ConnectionHandler instance for the given shard
+    # name.
+    #
+    # @param name [Symbol, String] shard name
+    # @return [ActiveRecord::ConnectionAdapters::ConnectionHandler]
+    def connection_handler_for(name)
+      return if name.nil?
+      @cache.fetch(name.to_sym) do
+        fail UnknownShardError, "#{name.inspect} is not a valid shard name"
+      end
+    end
+
+    # Disconnects from all shards.
+    def disconnect_all
+      @cache.values.map(&:clear_all_connections!)
+    end
+  end
+end

data/lib/shard_handler/model.rb

@@ -0,0 +1,88 @@
+require 'active_record'
+
+module ShardHandler
+  # This is an abstract model that adds sharding capabilities on ActiveRecord.
+  # When you need to query different shards using the same model, you must
+  # inherit from this class and configure it.
+  #
+  # @example
+  #   class Post < ShardHandler::Model
+  #   end
+  #
+  #   Post.setup({
+  #     'shard1' => {
+  #       'adapter' => 'postgresql',
+  #       'database' => 'shard_handler_development',
+  #       'username' => 'postgres',
+  #       'password' => ''
+  #     }
+  #   })
+  #
+  #   Post.using(:shard1) do
+  #     Post.update_all(title: 'foo')
+  #   end
+  class Model < ActiveRecord::Base
+    self.abstract_class = true
+
+    class << self
+      # @api private
+      # @return [Handler]
+      def handler
+        @@handler
+      end
+
+      # This method creates an instance of {Handler} for this class. This method
+      # must be called before performing any query on shards.
+      #
+      # @param config [Hash] a hash with database connection settings
+      def setup(config)
+        @@handler = Handler.new(self, config)
+        @@handler.setup
+      end
+
+      # Returns the current shard name for the current Thread.
+      #
+      # @return [Symbol]
+      def current_shard
+        ThreadRegistry.current_shard
+      end
+
+      # Sets the current shard name for the current Thread.
+      #
+      # @param name [Symbol, String] shard name configured using {.setup}
+      def current_shard=(name)
+        ThreadRegistry.current_shard = name.nil? ? nil : name.to_sym
+      end
+
+      # Overrides ActiveRecord::Core#connection_handler method to return the
+      # appropriate ConnectionHandler for the current shard. This is the
+      # integration point between ActiveRecord and this gem.
+      #
+      # @api private
+      # @return (see Handler#connection_handler_for)
+      def connection_handler
+        fail(SetupError, 'the model was not setup') unless @@handler
+        @@handler.connection_handler_for(current_shard) || super
+      end
+
+      # This method will switch to the passed shard making all queries be
+      # executed using the shard connection.
+      #
+      # @param shard [Symbol, String] shard name configured using .setup
+      # @yield The block that must be executed using the shard connection
+      def using(shard)
+        old_shard = current_shard
+        self.current_shard = shard
+        yield
+      ensure
+        # Returns any connections in use by the current thread back to the pool.
+        # It must be executed before changing the shard name back to its
+        # old value.
+        self.clear_active_connections!
+        self.current_shard = old_shard
+      end
+
+      private :establish_connection
+    end
+  end
+end

data/lib/shard_handler/thread_registry.rb

@@ -0,0 +1,15 @@
+require 'active_support/per_thread_registry'
+
+module ShardHandler
+  # This class is used as a registry for the shard name that is being used in
+  # the current thread. Because ActiveRecord's connections are global in the
+  # thread scope, we need to make sure that the shard name is change only for
+  # the current thread and not on process or other threads.
+  #
+  # @see ActiveSupport::PerThreadRegistry
+  # @api private
+  class ThreadRegistry
+    extend ActiveSupport::PerThreadRegistry
+    attr_accessor :current_shard
+  end
+end

data/lib/shard_handler/version.rb

@@ -0,0 +1,3 @@
+module ShardHandler
+  VERSION = '0.1.3'
+end

data/shard_handler.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'shard_handler/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'shard_handler'
+  spec.version       = ShardHandler::VERSION
+  spec.authors       = ['Lenon Marcel', 'Rafael Timbó', 'Lucas Nogueira',
+                        'Rodolfo Liviero']
+  spec.email         = ['lenon.marcel@gmail.com', 'rafaeltimbosoares@gmail.com',
+                        'lukspn.27@gmail.com', 'rodolfoliviero@gmail.com']
+  spec.summary       = 'This gem is a simple sharding solution for Rails applications'
+  spec.description   = 'This gem is a simple sharding solution for Rails applications'
+  spec.homepage      = 'https://github.com/locaweb/shard_handler'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activerecord', '~> 4.2.0'
+  spec.add_dependency 'activesupport', '~> 4.2.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'pg'
+  spec.add_development_dependency 'yard'
+end

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: shard_handler
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Lenon Marcel
+- Rafael Timbó
+- Lucas Nogueira
+- Rodolfo Liviero
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: pg
+  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'
+- !ruby/object:Gem::Dependency
+  name: yard
+  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: This gem is a simple sharding solution for Rails applications
+email:
+- lenon.marcel@gmail.com
+- rafaeltimbosoares@gmail.com
+- lukspn.27@gmail.com
+- rodolfoliviero@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/shard_handler.rb
+- lib/shard_handler/errors.rb
+- lib/shard_handler/handler.rb
+- lib/shard_handler/model.rb
+- lib/shard_handler/thread_registry.rb
+- lib/shard_handler/version.rb
+- shard_handler.gemspec
+homepage: https://github.com/locaweb/shard_handler
+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.4.6
+signing_key: 
+specification_version: 4
+summary: This gem is a simple sharding solution for Rails applications
+test_files: []
+has_rdoc: