activerecord-shard_for 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 63902d23b9848938b672498a54cbd5585c1606b5
+  data.tar.gz: f02378bc48f50bf8aff0c6de70d8d36e6d952770
+SHA512:
+  metadata.gz: 1dfd3d667c3a89ef8d2b375bbdec286c3135d5384fe4f8179773e4828ba8bc75f136d536f4d9084d6b2c19f1342f5ff1e3e02a3984473ccc18c198b0bb9da9f1
+  data.tar.gz: 0651cf764cb9c49db9ca299487090b12a5437be918b888e662e7eae2626c397bbe015aa99103a45030040e327e634bc2166f39c64877669ff67bfc0bb272ac98

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,28 @@
+AllCops:
+  TargetRubyVersion: 2.3
+  Exclude:
+    - activerecord-shard_for.gemspec
+    - Guardfile
+    - lib/activerecord/tasks/activerecord_shard_for.rake
+  DisplayCopNames: true
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 128
+
+Style/EmptyCaseCondition:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 15
+
+Style/ParallelAssignment:
+  Enabled: false
+
+Style/Alias:
+  EnforcedStyle: prefer_alias_method

data/.travis.yml

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

data/Appraisals

@@ -0,0 +1,26 @@
+# vim: set ft=ruby
+
+appraise 'ar-4.1.0' do
+  gem 'activerecord', '4.1.0'
+end
+
+appraise 'ar-4.1.7' do
+  gem 'activerecord', '4.1.7'
+end
+
+appraise 'ar-4.1.8' do
+  gem 'activerecord', '4.1.8'
+end
+
+appraise 'ar-4.2' do
+  gem 'activerecord', '~> 4.2'
+end
+
+appraise 'ar-5.0' do
+  gem 'activerecord', '~> 5.0.0'
+end
+
+appraise 'rails-edge' do
+  gem 'activerecord', github: 'rails/rails'
+  gem 'arel', github: 'rails/arel'
+end

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 yuemori@aiming-inc.com. 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,5 @@
+# frozen_string_literal: true
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in activerecord-shard_for.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,21 @@
+guard :rspec, cmd: 'bundle exec appraisal rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end
+
+guard :rubocop, cmd: 'bundle exec rubocop' do
+  watch(/.+\.rb$/)
+  watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 yuemori
+
+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,296 @@
+# ActiveRecord::ShardFor
+
+This is Sharding Library for ActiveRecord, inspire and import codes from [mixed_gauge](https://github.com/taiki45/mixed_gauge) and [activerecord-sharding](https://github.com/hirocaster/activerecord-sharding) (Thanks!).
+
+## Concept
+
+`activerecord-shard_for` have 3 concepts.
+
+- simple
+- small
+- pluggable
+
+### Simple
+
+This idea principal take over from `mixed_gauge`, and `activerecord-sharding`. `activerecord-shard_for` needs minimum and simply of settings.
+
+### Small
+
+- Small Dependency: To facilitate version up (important!).
+- Small code: Easy to read code when cause trouble.
+
+### pluggable
+
+Default sharding rule is [modulo with hashed key](https://github.com/yuemori/activerecord-shard_for/blob/master/lib/activerecord/shard_for/hash_modulo_router.rb). But, `activerecord-shard_for` adopt pluggable structer. This rule can be easy to change!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activerecord-shard_for'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activerecord-shard_for
+
+## Usage
+
+Add additional database connection config to database.yml.
+
+```yaml
+# database.yml
+production_user_001:
+  adapter: mysql2
+  username: user_writable
+  host: db-user-001
+production_user_002:
+  adapter: mysql2
+  username: user_writable
+  host: db-user-002
+production_user_003:
+  adapter: mysql2
+  username: user_writable
+  host: db-user-003
+production_user_004:
+  adapter: mysql2
+  username: user_writable
+  host: db-user-004
+```
+
+Define cluster in initializers (e.g `initializers/active_record_shard_for.rb`)
+
+```ruby
+ActiveRecord::ShardFor.configure do |config|
+  config.define_cluster(:user) do |cluster|
+    # unique identifier, connection name
+    cluster.register(0, :production_user_001)
+    cluster.register(1, :production_user_002)
+    cluster.register(2, :production_user_003)
+    cluster.register(3, :production_user_004)
+  end
+end
+```
+
+Include `ActiveRecord::ShardFor::Model` to your model class, specify cluster name and router name for the model, specify distkey which determines node to store.
+
+```ruby
+class User < ActiveRecord::Base
+  include ActiveRecord::ShardFor::Model
+  use_cluster :user, :hash_modulo # hash_modulo is presented by this library.
+  def_distkey :email
+end
+```
+
+Use `.get` to retrive single record which is connected to proper database node. Use .put! to create new record to proper database node.
+
+`.all_shards` returns each model class which is connected to proper database node. You can query with these models and aggregate result.
+
+```ruby
+User.put!(email: 'alice@example.com', name: 'alice')
+
+alice = User.get('alice@example.com')
+alice.age = 1
+alice.save!
+
+User.all_shards.flat_map {|m| m.find_by(name: 'alice') }.compact
+```
+
+When you want to execute queries in all nodes in parallel, use .all_shards_in_parallel. It returns `ActiveRecord::ShardFor::AllShardsInParallel` and it offers some collection actions which runs in parallel. It is aliased to .parallel.
+
+```ruby
+User.all_shards_in_parallel.map(&count) #=> 1
+User.parallel.flat_map {|m| m.where(age: 1) }.size #=> 1
+```
+
+
+Sometimes you want to generates distkey value before validation. Since activerecord-shard_for generates sub class of your models, AR's callback is usesless for this usecase, so activerecord-shard_for offers its own callback method.
+
+```ruby
+class AccessToken < ActiveRecord::Base
+  include ActiveRecord::ShardFor::Model
+  use_cluster :access_token
+  def_distkey :token
+
+  validates :token, presence: true
+
+  def self.generate_token
+    SecureRandom.uuid
+  end
+
+  before_put do |attributes|
+    unless attributes[:token] || attributes['token']
+      attributes[:token] = generate_token
+    end
+  end
+end
+
+access_token = AccessToken.put!
+access_token.token #=> a generated token
+```
+
+## Sharding with Replication
+
+activerecord-shard_for also supports replication.
+
+In case you have 2 shards in cluster and each shard have read replica.
+
+- db-user-101 --replicated--> db-user-102
+- db-user-201 --replicated--> db-user-202
+
+Your database connection configuration might be like this:
+
+```yaml
+# database.yml
+production_user_001:
+  adapter: mysql2
+  username: user_writable
+  host: db-user-101
+production_user_002:
+  adapter: mysql2
+  username: user_writable
+  host: db-user-201
+production_user_readonly_001:
+  adapter: mysql2
+  username: user_readonly
+  host: db-user-102
+production_user_readonly_002:
+  adapter: mysql2
+  username: user_writable
+  host: db-user-202
+```
+
+Your initializer for activerecord-shard_for might be like this:
+
+```ruby
+ActiveRecord::ShardFor.configure do |config|
+  config.define_cluster(:user) do |cluster|
+    cluster.register(0, :production_user_001)
+    cluster.register(1, :production_user_002)
+  end
+
+  config.define_cluster(:user_readonly) do |cluster|
+    # give same key of master
+    cluster.register(0, :production_user_readonly_001)
+    cluster.register(1, :production_user_readonly_002)
+  end
+end
+```
+
+You can split read/write by defining AR model class for each connection:
+
+```ruby
+class User < ActiveRecord::Base
+  include ActiveRecord::ShardFor::Model
+  use_cluster :user
+  def_distkey :email
+end
+
+class UserReadonly < ActiveRecord::Base
+  self.table_name = 'users'
+
+  include ActiveRecord::ShardFor::Model
+  use_cluster :user_readonly
+  def_distkey :email
+end
+
+User.put!(name: 'Alice', email: 'alice@example.com')
+UserReadonly.get('alice@example.com')
+```
+
+If you want to switch specific shard to another shard in another cluster, define mapping between each model:
+
+```ruby
+class User < ActiveRecord::Base
+  include ActiveRecord::ShardFor::Model
+  use_cluster :user, :hash_modulo
+  def_distkey :email
+
+  replicates_with slave: :UserReadonly
+end
+
+class UserReadonly < ActiveRecord::Base
+  self.table_name = 'users'
+
+  include ActiveRecord::ShardFor::Model
+  use_cluster :user_readonly, :hash_modulo
+  def_distkey :email
+
+  replicates_with master: :User
+end
+```
+
+You can switch to another model which have connection to the shard by calling .switch:
+
+```ruby
+UserReadonly.all_shards do |readonly|
+  target_ids = readonly.where(age: 0).pluck(:id)
+  readonly.switch(:master) do |writable|
+    writable.where(id: target_ids).delete_all
+  end
+end
+```
+
+## Plugin of cluster router
+
+If you need to advanced cluster routing, implement router class and register this.
+
+Reference a interface to [HashModuloRouter](https://github.com/yuemori/activerecord-shard_for/blob/master/lib/activerecord/shard_for/hash_modulo_router.rb) and [ConnectionRouter](https://github.com/yuemori/activerecord-shard_for/blob/master/lib/activerecord/shard_for/connection_router.rb).
+
+Example, simple modulo router:
+
+```ruby
+class SimpleModuloRouter < ActiveRecord::ShardFor::ConnectionRouter
+  def route(key)
+    key.to_i % connection_count
+  end
+end
+```
+
+Your initializer for activerecord-shard_for might be like this:
+
+```ruby
+ActiveRecord::ShardFor.configure do |config|
+  config.register_cluster_router(:modulo, SimpleModuloRouter)
+end
+```
+
+And specify router in your AR model.
+
+```ruby
+class User < ActiveRecord::Base
+  include ActiveRecord::ShardFor::Model
+  use_cluster :user, :modulo
+  def_distkey :id
+
+  def self.generate_unique_id
+    # Implement to generate unique id
+  end
+
+  before_put do |attributes|
+    attributes[:id] = generate_unique_id unless attributes[:id]
+  end
+end
+```
+
+## Contributing with ActiveRecord::ShardFor
+
+Contributors are welcome! This is what you need to setup your Octopus development environment:
+
+```sh
+$ git clone https://github.com/yuemori/activerecord-shard_for
+$ cd activerecord-shard_for
+$ bundle install
+$ bundle exec rake appraisal:install
+$ bundle exec rake spec
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+