tako 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a1b4936efb2bb9c024c85a7e41d835a1c0c23041
+  data.tar.gz: d8392ebb554a5186db289f7ecfcdc7f81ebf9188
+SHA512:
+  metadata.gz: 7e6af9b9c02d28b361469c626ec181bddfc448804aa5444a4f16b19c813ab0f5e6a8a327712f1c3d6098853e573dc50cb333f9d87aae425afa05e0c44ca977d7
+  data.tar.gz: afc1f92c71a81c670b3ad139a0a654f629d51c96e53853511b60742c258342cca5b6e0d690f2efe8bfa93ad239c080c990b4399057bd0226f00d9872a5aa9dbc

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.swp

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at masashi.akisue@aktsk.jp. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Masashi AKISUE
+
+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,61 @@
+# Tako
+
+Provides Horizontal-Sharding for ActiveRecord.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tako'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tako
+
+## Usage
+## How to use Tako?
+First, you need to create a config file, shards.yml, inside your config/ directory.
+Also you can override config file path with environment variable.
+
+### Syntax
+Tako adds a method to each AR Class and object: the shard method is used to select the shard like this:
+
+```ruby
+  User.shard(:slave_one).where(:name => "Thiago").limit(3)
+```
+
+Tako also supports queries within a block. When you pass a block to the shard method, all queries inside the block will be sent to the specified shard.
+
+```ruby
+Tako.shard(:slave_two) do
+  User.create(:name => "Mike")
+end
+
+# or
+
+ModelA.shard(:slave_two) do
+  User.create(:name => "Mike")
+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.
+
+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/the40san/tako. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "tako"
+
+# 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,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/tako/active_record_ext.rb

@@ -0,0 +1,32 @@
+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/config.rb

@@ -0,0 +1,23 @@
+module Tako
+  class Config
+    class << self
+      def shards_yml
+        YAML.load(ERB.new(File.read(yml_path)).result).with_indifferent_access
+      end
+
+      def env
+        defined?(::Rails.env) ? Rails.env : (ENV['RAILS_ENV'] || :default)
+      end
+
+      private
+
+      def yml_path
+        File.join(directory, ENV['TAKO_CONFIG_FILE_PATH'] || "config/shards.yml")
+      end
+
+      def directory
+        defined?(::Rails.root) ? Rails.root.to_s : Dir.pwd
+      end
+    end
+  end
+end

data/lib/tako/proxy.rb

@@ -0,0 +1,19 @@
+module Tako
+  class Proxy
+    attr_reader :shard_name
+    attr_reader :connection
+    attr_accessor :base
+
+    def initialize(shard_name, connection, base)
+      @shard_name = shard_name
+      @connection = connection
+      @base = base
+    end
+
+    def in_proxy
+      Tako::ProxyStack.in_piles(self) do
+        yield
+      end
+    end
+  end
+end

data/lib/tako/proxy_stack.rb

@@ -0,0 +1,18 @@
+module Tako
+  class ProxyStack
+    class << self
+      def top
+        @current
+      end
+
+      def in_piles(proxy)
+        proxy.base ||= @current
+        @current = proxy
+
+        yield
+      ensure
+        @current = @current.base
+      end
+    end
+  end
+end

data/lib/tako/query_chain.rb

@@ -0,0 +1,24 @@
+module Tako
+  class QueryChain
+    attr_reader :proxy
+    attr_reader :base_object
+
+    def initialize(proxy, base_object)
+      @proxy = proxy
+      @base_object = base_object
+    end
+
+    def method_missing(method, *args)
+      @proxy.in_proxy do
+        base_object.send(method, *args)
+      end
+    end
+
+    def shard(shard_name)
+      new(
+        Tako::Repository.shard(shard_name),
+        self
+      )
+    end
+  end
+end

data/lib/tako/repository.rb

@@ -0,0 +1,32 @@
+module Tako
+  class Repository
+    class << self
+      def proxy_configs
+        @proxy_configs
+      end
+
+      def proxy_connections
+        @proxy_connections
+      end
+
+      def add(shard_name, conf)
+        @proxy_configs ||= {}
+        @proxy_connections ||= {}
+
+        shard_name = shard_name.to_sym
+        return if @proxy_configs[shard_name]
+
+        temporary_class = Class.new(ActiveRecord::Base)
+        const_set("TAKO_AR_CLASS_#{shard_name.upcase}", temporary_class)
+        temporary_class.establish_connection(conf)
+
+        @proxy_connections[shard_name] = temporary_class.connection
+        @proxy_configs[shard_name] = conf
+      end
+
+      def shard(shard_name, base = nil)
+        Proxy.new(shard_name, @proxy_connections[shard_name.to_sym], base)
+      end
+    end
+  end
+end

data/lib/tako/version.rb

@@ -0,0 +1,3 @@
+module Tako
+  VERSION = "0.1.0"
+end

data/lib/tako.rb

@@ -0,0 +1,38 @@
+require 'erb'
+require "tako/version"
+require "tako/config"
+require "tako/active_record_ext"
+require "tako/repository"
+require "tako/proxy_stack"
+require "tako/proxy"
+require "tako/query_chain"
+
+module Tako
+  class << self
+    def shard(shard_name)
+      if block_given?
+        Tako::Repository.shard(shard_name).in_proxy do
+          yield
+        end
+      else
+        raise "gimme a block!"
+      end
+    end
+
+    def load_connections_from_yaml(config = Tako::Config.shards_yml)
+      (config[:tako][Tako::Config.env] || []).each do |shard_name, conf|
+        Tako::Repository.add(shard_name, conf)
+      end
+    end
+  end
+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

data/tako.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tako/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tako"
+  spec.version       = Tako::VERSION
+  spec.authors       = ["Masashi AKISUE"]
+  spec.email         = ["masashi.akisue@aktsk.jp"]
+
+  spec.summary       = %q{Provides Horizontal-sharing for ActiveRecord}
+  spec.homepage      = "https://github.com/the40san/tako"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  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.1"
+
+  spec.add_development_dependency "mysql2"
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: tako
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Masashi AKISUE
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-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.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- masashi.akisue@aktsk.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/tako.rb
+- lib/tako/active_record_ext.rb
+- lib/tako/config.rb
+- lib/tako/proxy.rb
+- lib/tako/proxy_stack.rb
+- lib/tako/query_chain.rb
+- lib/tako/repository.rb
+- lib/tako/version.rb
+- tako.gemspec
+homepage: https://github.com/the40san/tako
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Provides Horizontal-sharing for ActiveRecord
+test_files: []
+has_rdoc: