activerecord-sharding 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6161f4f763503556924e2678e30f8b8dd35877dd
+  data.tar.gz: 345928fff20f5bf81e6a85740822b125770ec2a8
+SHA512:
+  metadata.gz: 6044b78dcf067016e87bc738c927efd62a8f5406ed8952b3df9d8f032bda50e795af0d71eedbdce12bfd4d2cd177e46d60665f0907ff9e93742f195a23559556
+  data.tar.gz: 329ee41bf7df37ce0302fa8a9338ede775782871197f6f87f99ae589d28c326bae538ff39980f7a087ba31fec4484ab5622dce93c6fe0c1c7897d0e30cc3d6ef

data/.gitignore

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

data/.hound.yml

@@ -0,0 +1,2 @@
+ruby:
+  config_file: .rubocop.yml

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,50 @@
+AllCops:
+  Exclude:
+    - "vendor/**/*"
+  DisplayCopNames: true
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/BracesAroundHashParameters:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/ExtraSpacing:
+  Enabled: false
+
+Style/GuardClause:
+  MinBodyLength: 5
+
+Style/MethodDefParentheses:
+  EnforcedStyle: require_parentheses
+
+Style/ModuleFunction:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/HashSyntax:
+  EnforcedStyle: ruby19_no_mixed_keys
+  Exclude:
+    - "**/*.rake"
+    - "Rakefile"
+
+Metrics/LineLength:
+  Max: 160
+  Exclude:
+    - "db/migrate/*.rb"
+
+Lint/AssignmentInCondition:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 12
+
+FileName:
+  Exclude:
+    - 'lib/activerecord-sharding.rb'
+    - 'spec/tasks/activerecord-sharding_spec.rb'

data/.ruby-version

@@ -0,0 +1 @@
+2.2.3

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 2.2.3
+  - 2.1.7
+  - 2.0.0-p647
+before_install: gem install bundler -v 1.10.6
+services:
+  - mysql
+script:
+  - bundle exec rake spec

data/Gemfile

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

data/README.md

@@ -0,0 +1,184 @@
+# ActiveRecord::Sharding
+
+[![Build Status](https://travis-ci.org/hirocaster/activerecord-sharding.svg)](https://travis-ci.org/hirocaster/activerecord-sharding) [![Coverage Status](https://coveralls.io/repos/hirocaster/activerecord-sharding/badge.svg?branch=coveralls&service=github)](https://coveralls.io/github/hirocaster/activerecord-sharding?branch=coveralls) [![Code Climate](https://codeclimate.com/github/hirocaster/activerecord-sharding/badges/gpa.svg)](https://codeclimate.com/github/hirocaster/activerecord-sharding) [![Dependency Status](https://gemnasium.com/hirocaster/activerecord-sharding.svg)](https://gemnasium.com/hirocaster/activerecord-sharding)
+
+Simple Database Sharding in ActiveRecord.
+
+ActiveRecord object distributed multiple databases by modulo.
+Modulo target is id, generated by sequencer database.
+
+## Support database
+
+- MySQL
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'activerecord-sharding'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activerecord-sharding
+
+## Usage
+
+Add database connections to your application's config/database.yml:
+
+```yaml
+default: &default
+  adapter: mysql2
+  encoding: utf8
+  pool: 5
+  username: root
+  password:
+  host: localhost
+
+user_sequencer:
+  <<: *default
+  database: user_001
+  host: localhost
+
+user_001:
+  <<: *default
+  database: user_001
+  host: localhost
+
+user_002:
+  <<: *default
+  database: user_002
+  host: localhost
+
+user_003:
+<<: *default
+  database: user_003
+  host: localhost
+```
+
+Add this example  your application's config/initializers/active_record_sharding.rb:
+
+```ruby
+ActiveRecord::Sharding.configure do |config|
+  config.define_sequencer(:user) do |sequencer|
+    sequencer.register_connection(:user_sequencer)
+    sequencer.register_table_name('user_id')
+  end
+
+  config.define_cluster(:user) do |cluster|
+    cluster.register_connection(:user_001)
+    cluster.register_connection(:user_002)
+    cluster.register_connection(:user_003)
+  end
+end
+```
+
+- define user cluster config
+- define user sequencer config
+
+### Model
+
+app/model/user.rb
+
+```ruby
+class User < ActiveRecord::Base
+  include ActiveRecord::Sharding::Model
+  use_sharding :user, :modulo # shard name, algorithm
+  define_sharding_key :id
+
+  include ActiveRecord::Sharding::Sequencer
+  use_sequencer :user
+
+  before_put do |attributes|
+    attributes[:id] = next_sequence_id unless attributes[:id]
+  end
+end
+```
+
+
+### Create sequencer databases
+
+```ruby
+$ rake active_record:sharding:sequencer:setup
+```
+
+### Create cluster dtabases
+
+```ruby
+$ rake active_record:sharding:setup
+```
+
+and, migrations all cluster databases.
+
+### in applications
+
+#### Create
+
+using `#put!` method.
+
+```ruby
+user = User.put! name: 'foobar'
+```
+
+returns User new object.
+
+#### Select Query
+
+```ruby
+sharding_key = user.id
+User.shard_for(sharding_key).where(name: 'foorbar')
+```
+
+`sharding_key` is your define_syarding_key.(example is User Object id)
+
+`#sahrd_for` is returns User class.
+
+#### Association/Relation
+
+if use database association/relation in sharding databases.
+
+Please, don't use ActiveRecord standard associations/relation features(has_may, has_one, belongs_to... etc).because, it using `ActiveRecord::Base.connection`(not sharding databases conneciton).
+
+Please, manually add association/relation methods.
+
+Bad sample
+
+```
+class User < ActiveRecord::Base
+  has_many :items # connect to not sharding databases(default database)
+
+  include ActiveRecord::Sharding::Model
+  use_sharding :user, :modulo
+  define_sharding_key :id
+  # (snip)
+end
+```
+
+Manually add method
+
+```
+class User < ActiveRecord::Base
+  def items
+    return [] unless id
+    Item.shard_for(id).where(user_id: id).all
+  end
+
+  include ActiveRecord::Sharding::Model
+  use_sharding :user, :modulo
+  define_sharding_key :id
+  # (snip)
+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/hirocaster/activerecord-sharding.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/activerecord-sharding.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "active_record/sharding/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "activerecord-sharding"
+  spec.version       = ActiveRecord::Sharding::VERSION
+  spec.authors       = ["hirocaster"]
+  spec.email         = ["hohtsuka@gmail.com"]
+  spec.summary       = "Sharding library for ActiveRecord(MySQL)"
+  spec.description   = "Sharding library for ActiveRecord(MySQL)"
+  spec.homepage      = "https://github.com/hirocaster/activerecord-sharding"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 2.0"
+
+  spec.add_dependency "activerecord", ">= 4.1.0"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "mysql2"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "awesome_print"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "codeclimate-test-reporter"
+end

data/bin/benchmark_sequencer.rb

@@ -0,0 +1,71 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "active_record_sharding"
+
+require_relative "../spec/models"
+
+require "benchmark"
+require "pry"
+
+GENERATE_ID_COUNT = 100_000
+
+def before_benchmark
+  setup_database_env
+
+  back, $stdout = $stdout, StringIO.new
+  setup_shard_cluster_databases
+  setup_sequence_database
+  $stdout = back
+
+  ActiveRecord::Base.establish_connection(:test)
+
+  unless User.current_sequence_id == 0
+    puts "Fail: Start sequence id is not zero."
+    exit
+  end
+end
+
+def setup_database_env
+  ActiveRecord::Tasks::DatabaseTasks.db_dir = File.expand_path "../../spec", __FILE__
+  ActiveRecord::Tasks::DatabaseTasks.root   = File.expand_path "../..", __FILE__
+  ActiveRecord::Tasks::DatabaseTasks.env    = "test"
+end
+
+def setup_shard_cluster_databases
+  args = { cluster_name: "user" }
+  ActiveRecordSharding::DatabaseTasks.drop_all_databases args
+  ActiveRecordSharding::DatabaseTasks.create_all_databases args
+  ActiveRecordSharding::DatabaseTasks.load_schema_all_databases args
+end
+
+def setup_sequence_database
+  sequencer_args = { sequencer_name: "user" }
+  ActiveRecordSharding::DatabaseTasks.drop_sequencer_database sequencer_args
+  ActiveRecordSharding::DatabaseTasks.create_sequencer_database sequencer_args
+  ActiveRecordSharding::DatabaseTasks.create_table_sequencer_database sequencer_args
+  ActiveRecordSharding::DatabaseTasks.insert_initial_record_sequencer_database sequencer_args
+end
+
+def after_benchmark
+  if User.current_sequence_id != GENERATE_ID_COUNT
+    puts "Fail: End sequence id is not #{GENERATE_ID_COUNT}."
+  end
+
+  ActiveRecordSharding::DatabaseTasks.drop_all_databases cluster_name: "user"
+
+  sequencer_args = { sequencer_name: "user" }
+  ActiveRecordSharding::DatabaseTasks.drop_sequencer_database sequencer_args
+end
+
+before_benchmark
+
+puts "===== Benchmark sequence id (#{GENERATE_ID_COUNT}) ====="
+puts Benchmark::CAPTION
+puts Benchmark.measure {
+       100_000.times do
+         User.next_sequence_id
+       end
+     }
+
+after_benchmark

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "activerecord-sharding"
+
+# 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.
+
+require "pry"
+Pry.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/active_record/sharding/abstract_repository.rb

@@ -0,0 +1,29 @@
+module ActiveRecord
+  module Sharding
+    class AbstractRepository
+      private
+
+        def generate_model_for_shard(connection_name)
+          base_class_name = @base_class.name
+          class_name = generate_class_name connection_name
+
+          model = Class.new(base_class) do
+            self.table_name = base_class.table_name
+
+            module_eval <<-RUBY, __FILE__, __LINE__ + 1
+                  def self.name
+                    "#{base_class_name}::#{class_name}"
+                  end
+                RUBY
+          end
+
+          model.class_eval { establish_connection(connection_name) }
+          model
+        end
+
+        def generate_class_name(connection_name) # rubocop:disable Lint/UnusedMethodArgument
+          fail NotImplementedError, "#{self.class.name}.#{__method__} is an abstract method."
+        end
+    end
+  end
+end