tako 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: a1b4936efb2bb9c024c85a7e41d835a1c0c23041
4
+ data.tar.gz: d8392ebb554a5186db289f7ecfcdc7f81ebf9188
5
+ SHA512:
6
+ metadata.gz: 7e6af9b9c02d28b361469c626ec181bddfc448804aa5444a4f16b19c813ab0f5e6a8a327712f1c3d6098853e573dc50cb333f9d87aae425afa05e0c44ca977d7
7
+ data.tar.gz: afc1f92c71a81c670b3ad139a0a654f629d51c96e53853511b60742c258342cca5b6e0d690f2efe8bfa93ad239c080c990b4399057bd0226f00d9872a5aa9dbc
data/.gitignore ADDED
@@ -0,0 +1,10 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
10
+ *.swp
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
data/.travis.yml ADDED
@@ -0,0 +1,4 @@
1
+ language: ruby
2
+ rvm:
3
+ - 2.3.0
4
+ before_install: gem install bundler -v 1.11.2
@@ -0,0 +1,49 @@
1
+ # Contributor Code of Conduct
2
+
3
+ As contributors and maintainers of this project, and in the interest of
4
+ fostering an open and welcoming community, we pledge to respect all people who
5
+ contribute through reporting issues, posting feature requests, updating
6
+ documentation, submitting pull requests or patches, and other activities.
7
+
8
+ We are committed to making participation in this project a harassment-free
9
+ experience for everyone, regardless of level of experience, gender, gender
10
+ identity and expression, sexual orientation, disability, personal appearance,
11
+ body size, race, ethnicity, age, religion, or nationality.
12
+
13
+ Examples of unacceptable behavior by participants include:
14
+
15
+ * The use of sexualized language or imagery
16
+ * Personal attacks
17
+ * Trolling or insulting/derogatory comments
18
+ * Public or private harassment
19
+ * Publishing other's private information, such as physical or electronic
20
+ addresses, without explicit permission
21
+ * Other unethical or unprofessional conduct
22
+
23
+ Project maintainers have the right and responsibility to remove, edit, or
24
+ reject comments, commits, code, wiki edits, issues, and other contributions
25
+ that are not aligned to this Code of Conduct, or to ban temporarily or
26
+ permanently any contributor for other behaviors that they deem inappropriate,
27
+ threatening, offensive, or harmful.
28
+
29
+ By adopting this Code of Conduct, project maintainers commit themselves to
30
+ fairly and consistently applying these principles to every aspect of managing
31
+ this project. Project maintainers who do not follow or enforce the Code of
32
+ Conduct may be permanently removed from the project team.
33
+
34
+ This code of conduct applies both within project spaces and in public spaces
35
+ when an individual is representing the project or its community.
36
+
37
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
38
+ reported by contacting a project maintainer at masashi.akisue@aktsk.jp. All
39
+ complaints will be reviewed and investigated and will result in a response that
40
+ is deemed necessary and appropriate to the circumstances. Maintainers are
41
+ obligated to maintain confidentiality with regard to the reporter of an
42
+ incident.
43
+
44
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage],
45
+ version 1.3.0, available at
46
+ [http://contributor-covenant.org/version/1/3/0/][version]
47
+
48
+ [homepage]: http://contributor-covenant.org
49
+ [version]: http://contributor-covenant.org/version/1/3/0/
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in tako.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2016 Masashi AKISUE
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,61 @@
1
+ # Tako
2
+
3
+ Provides Horizontal-Sharding for ActiveRecord.
4
+
5
+ ## Installation
6
+
7
+ Add this line to your application's Gemfile:
8
+
9
+ ```ruby
10
+ gem 'tako'
11
+ ```
12
+
13
+ And then execute:
14
+
15
+ $ bundle
16
+
17
+ Or install it yourself as:
18
+
19
+ $ gem install tako
20
+
21
+ ## Usage
22
+ ## How to use Tako?
23
+ First, you need to create a config file, shards.yml, inside your config/ directory.
24
+ Also you can override config file path with environment variable.
25
+
26
+ ### Syntax
27
+ Tako adds a method to each AR Class and object: the shard method is used to select the shard like this:
28
+
29
+ ```ruby
30
+ User.shard(:slave_one).where(:name => "Thiago").limit(3)
31
+ ```
32
+
33
+ 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.
34
+
35
+ ```ruby
36
+ Tako.shard(:slave_two) do
37
+ User.create(:name => "Mike")
38
+ end
39
+
40
+ # or
41
+
42
+ ModelA.shard(:slave_two) do
43
+ User.create(:name => "Mike")
44
+ end
45
+ ```
46
+
47
+ ## Development
48
+
49
+ 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.
50
+
51
+ 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).
52
+
53
+ ## Contributing
54
+
55
+ 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.
56
+
57
+
58
+ ## License
59
+
60
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
61
+
data/Rakefile ADDED
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "tako"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,32 @@
1
+ module Tako
2
+ module ActiveRecordExt
3
+ module ConnectionHandling
4
+ module Prepend
5
+ def connection
6
+ if Tako::ProxyStack.top
7
+ Tako::ProxyStack.top.connection
8
+ else
9
+ super
10
+ end
11
+ end
12
+ end
13
+ end
14
+
15
+ module Base
16
+ module Extend
17
+ def shard(shard_name)
18
+ if block_given?
19
+ Tako.shard(shard_name) do
20
+ yield
21
+ end
22
+ else
23
+ Tako::QueryChain.new(
24
+ Tako::Repository.shard(shard_name),
25
+ self
26
+ )
27
+ end
28
+ end
29
+ end
30
+ end
31
+ end
32
+ end
@@ -0,0 +1,23 @@
1
+ module Tako
2
+ class Config
3
+ class << self
4
+ def shards_yml
5
+ YAML.load(ERB.new(File.read(yml_path)).result).with_indifferent_access
6
+ end
7
+
8
+ def env
9
+ defined?(::Rails.env) ? Rails.env : (ENV['RAILS_ENV'] || :default)
10
+ end
11
+
12
+ private
13
+
14
+ def yml_path
15
+ File.join(directory, ENV['TAKO_CONFIG_FILE_PATH'] || "config/shards.yml")
16
+ end
17
+
18
+ def directory
19
+ defined?(::Rails.root) ? Rails.root.to_s : Dir.pwd
20
+ end
21
+ end
22
+ end
23
+ end
data/lib/tako/proxy.rb ADDED
@@ -0,0 +1,19 @@
1
+ module Tako
2
+ class Proxy
3
+ attr_reader :shard_name
4
+ attr_reader :connection
5
+ attr_accessor :base
6
+
7
+ def initialize(shard_name, connection, base)
8
+ @shard_name = shard_name
9
+ @connection = connection
10
+ @base = base
11
+ end
12
+
13
+ def in_proxy
14
+ Tako::ProxyStack.in_piles(self) do
15
+ yield
16
+ end
17
+ end
18
+ end
19
+ end
@@ -0,0 +1,18 @@
1
+ module Tako
2
+ class ProxyStack
3
+ class << self
4
+ def top
5
+ @current
6
+ end
7
+
8
+ def in_piles(proxy)
9
+ proxy.base ||= @current
10
+ @current = proxy
11
+
12
+ yield
13
+ ensure
14
+ @current = @current.base
15
+ end
16
+ end
17
+ end
18
+ end
@@ -0,0 +1,24 @@
1
+ module Tako
2
+ class QueryChain
3
+ attr_reader :proxy
4
+ attr_reader :base_object
5
+
6
+ def initialize(proxy, base_object)
7
+ @proxy = proxy
8
+ @base_object = base_object
9
+ end
10
+
11
+ def method_missing(method, *args)
12
+ @proxy.in_proxy do
13
+ base_object.send(method, *args)
14
+ end
15
+ end
16
+
17
+ def shard(shard_name)
18
+ new(
19
+ Tako::Repository.shard(shard_name),
20
+ self
21
+ )
22
+ end
23
+ end
24
+ end
@@ -0,0 +1,32 @@
1
+ module Tako
2
+ class Repository
3
+ class << self
4
+ def proxy_configs
5
+ @proxy_configs
6
+ end
7
+
8
+ def proxy_connections
9
+ @proxy_connections
10
+ end
11
+
12
+ def add(shard_name, conf)
13
+ @proxy_configs ||= {}
14
+ @proxy_connections ||= {}
15
+
16
+ shard_name = shard_name.to_sym
17
+ return if @proxy_configs[shard_name]
18
+
19
+ temporary_class = Class.new(ActiveRecord::Base)
20
+ const_set("TAKO_AR_CLASS_#{shard_name.upcase}", temporary_class)
21
+ temporary_class.establish_connection(conf)
22
+
23
+ @proxy_connections[shard_name] = temporary_class.connection
24
+ @proxy_configs[shard_name] = conf
25
+ end
26
+
27
+ def shard(shard_name, base = nil)
28
+ Proxy.new(shard_name, @proxy_connections[shard_name.to_sym], base)
29
+ end
30
+ end
31
+ end
32
+ end
@@ -0,0 +1,3 @@
1
+ module Tako
2
+ VERSION = "0.1.0"
3
+ end
data/lib/tako.rb ADDED
@@ -0,0 +1,38 @@
1
+ require 'erb'
2
+ require "tako/version"
3
+ require "tako/config"
4
+ require "tako/active_record_ext"
5
+ require "tako/repository"
6
+ require "tako/proxy_stack"
7
+ require "tako/proxy"
8
+ require "tako/query_chain"
9
+
10
+ module Tako
11
+ class << self
12
+ def shard(shard_name)
13
+ if block_given?
14
+ Tako::Repository.shard(shard_name).in_proxy do
15
+ yield
16
+ end
17
+ else
18
+ raise "gimme a block!"
19
+ end
20
+ end
21
+
22
+ def load_connections_from_yaml(config = Tako::Config.shards_yml)
23
+ (config[:tako][Tako::Config.env] || []).each do |shard_name, conf|
24
+ Tako::Repository.add(shard_name, conf)
25
+ end
26
+ end
27
+ end
28
+ end
29
+
30
+ require 'active_record'
31
+
32
+ ActiveRecord::ConnectionHandling.class_eval do
33
+ prepend Tako::ActiveRecordExt::ConnectionHandling::Prepend
34
+ end
35
+
36
+ ActiveRecord::Base.class_eval do
37
+ extend Tako::ActiveRecordExt::Base::Extend
38
+ end
data/tako.gemspec ADDED
@@ -0,0 +1,35 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'tako/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "tako"
8
+ spec.version = Tako::VERSION
9
+ spec.authors = ["Masashi AKISUE"]
10
+ spec.email = ["masashi.akisue@aktsk.jp"]
11
+
12
+ spec.summary = %q{Provides Horizontal-sharing for ActiveRecord}
13
+ spec.homepage = "https://github.com/the40san/tako"
14
+ spec.license = "MIT"
15
+
16
+ # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
17
+ # delete this section to allow pushing this gem to any host.
18
+ if spec.respond_to?(:metadata)
19
+ spec.metadata['allowed_push_host'] = "https://rubygems.org"
20
+ else
21
+ raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
22
+ end
23
+
24
+ spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
25
+ spec.bindir = "exe"
26
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
27
+ spec.require_paths = ["lib"]
28
+
29
+ spec.add_dependency "activerecord", "> 4.1"
30
+
31
+ spec.add_development_dependency "mysql2"
32
+ spec.add_development_dependency "bundler", "~> 1.11"
33
+ spec.add_development_dependency "rake", "~> 10.0"
34
+ spec.add_development_dependency "rspec", "~> 3.0"
35
+ end
metadata ADDED
@@ -0,0 +1,135 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: tako
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Masashi AKISUE
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2016-09-30 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: activerecord
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ">"
18
+ - !ruby/object:Gem::Version
19
+ version: '4.1'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ">"
25
+ - !ruby/object:Gem::Version
26
+ version: '4.1'
27
+ - !ruby/object:Gem::Dependency
28
+ name: mysql2
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - ">="
32
+ - !ruby/object:Gem::Version
33
+ version: '0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - ">="
39
+ - !ruby/object:Gem::Version
40
+ version: '0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: bundler
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '1.11'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '1.11'
55
+ - !ruby/object:Gem::Dependency
56
+ name: rake
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '10.0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '10.0'
69
+ - !ruby/object:Gem::Dependency
70
+ name: rspec
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: '3.0'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: '3.0'
83
+ description:
84
+ email:
85
+ - masashi.akisue@aktsk.jp
86
+ executables: []
87
+ extensions: []
88
+ extra_rdoc_files: []
89
+ files:
90
+ - ".gitignore"
91
+ - ".rspec"
92
+ - ".travis.yml"
93
+ - CODE_OF_CONDUCT.md
94
+ - Gemfile
95
+ - LICENSE.txt
96
+ - README.md
97
+ - Rakefile
98
+ - bin/console
99
+ - bin/setup
100
+ - lib/tako.rb
101
+ - lib/tako/active_record_ext.rb
102
+ - lib/tako/config.rb
103
+ - lib/tako/proxy.rb
104
+ - lib/tako/proxy_stack.rb
105
+ - lib/tako/query_chain.rb
106
+ - lib/tako/repository.rb
107
+ - lib/tako/version.rb
108
+ - tako.gemspec
109
+ homepage: https://github.com/the40san/tako
110
+ licenses:
111
+ - MIT
112
+ metadata:
113
+ allowed_push_host: https://rubygems.org
114
+ post_install_message:
115
+ rdoc_options: []
116
+ require_paths:
117
+ - lib
118
+ required_ruby_version: !ruby/object:Gem::Requirement
119
+ requirements:
120
+ - - ">="
121
+ - !ruby/object:Gem::Version
122
+ version: '0'
123
+ required_rubygems_version: !ruby/object:Gem::Requirement
124
+ requirements:
125
+ - - ">="
126
+ - !ruby/object:Gem::Version
127
+ version: '0'
128
+ requirements: []
129
+ rubyforge_project:
130
+ rubygems_version: 2.5.1
131
+ signing_key:
132
+ specification_version: 4
133
+ summary: Provides Horizontal-sharing for ActiveRecord
134
+ test_files: []
135
+ has_rdoc: