mixed_gauge 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b0f38717b364867534a54530bbd6a5279086a46e
+  data.tar.gz: ea86038064d74083b87d1d631bfc3b7769b71bfc
+SHA512:
+  metadata.gz: e499016ee06b4683e9b71b48b315a758d296812fe87cffb62d02ffa9590687b7d4280ed6ea853fbf10de630588f148a7993717ecc7ec56ecb2c3c9977956e57d
+  data.tar.gz: 8e516f5b4f727b24bfeaebd3aa707ee60826d5b33af930508cec651e10bf95fc6241a872a752d582d8370abe8b03f17a3e2e35b1409fc37efa311a8f266576c6

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.1

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Taiki Ono
+
+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,97 @@
+# MixedGauge
+An ActiveRecord extension for database sharding.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mixed_gauge'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mixed_gauge
+
+## 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
+```
+
+Configure slots (virtual node for cluster) then assign slots to real node.
+
+```ruby
+MixedGauge.configure do |config|
+  config.define_cluster(:user) do |cluster|
+    # When slots per node * max nodes per cluster = (2 ** 10) * (2 ** 10)
+    cluster.define_slots(1..1048576)
+    cluster.register(1..262144, :production_user_001)
+    cluster.register(262145..524288, :production_user_002)
+    cluster.register(524289..786432, :production_user_003)
+    cluster.register(786433..1048576, :production_user_004)
+  end
+end
+```
+
+Include `MixedGauge::Model` to your model class, specify cluster name for the
+model, specify distkey which determine nodes to store.
+
+```ruby
+class User < ActiveRecord::Base
+  include MixedGauge::Model
+  use_cluster :user
+  distkey :email
+end
+```
+
+Use `.get` to retrive single model class which is connected to proper
+database node. Use `.put!` to create new record to proper database node.
+`.all_shards` enables you to all model class which is connected to all
+database nodes in the cluster.
+
+```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.where(name: 'alice') }
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/mixed_gauge/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mixed_gauge"
+
+# 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/mixed_gauge.rb

@@ -0,0 +1,21 @@
+require 'active_record'
+
+require 'mixed_gauge/version'
+require 'mixed_gauge/cluster_config'
+require 'mixed_gauge/config'
+require 'mixed_gauge/routing'
+require 'mixed_gauge/sub_model_repository'
+require 'mixed_gauge/model'
+
+module MixedGauge
+  class << self
+    # @return [MixedGauge::Config]
+    def config
+      @config ||= Config.new
+    end
+
+    def configure(&block)
+      config.instance_eval(&block)
+    end
+  end
+end

data/lib/mixed_gauge/cluster_config.rb

@@ -0,0 +1,47 @@
+module MixedGauge
+  # Mapping of slot -> connection_name.
+  class ClusterConfig
+    attr_reader :name
+
+    # @param [Symbol] name
+    def initialize(name)
+      @name = name
+      @connection_registry = {}
+    end
+
+    # @param [Range] slots
+    # @return [nil]
+    def define_slots(slots)
+      @slots = slots
+      nil
+    end
+
+    # @param [Range] slots
+    # @param [Symbol] connection connection name
+    # @return [nil]
+    def register(slots, connection)
+      @connection_registry[slots] = connection
+      nil
+    end
+
+    def validate_config!
+      # TODO
+    end
+
+    # @return [Integer]
+    def slot_count
+      @slots.count
+    end
+
+    # @param [Integer] slot
+    # @return [Symbol] registered connection name
+    def fetch(slot)
+      @connection_registry.find {|slot_range, name| slot_range.cover?(slot) }[1]
+    end
+
+    # @return [Array<Symbol>] An array of connection name
+    def connections
+      @connection_registry.values
+    end
+  end
+end

data/lib/mixed_gauge/config.rb

@@ -0,0 +1,26 @@
+module MixedGauge
+  class Config
+    def initialize
+      @cluster_configs = {}
+    end
+
+    # @param [Symbol] cluster_name
+    # @return [nil]
+    # @example
+    #   config.define_cluster(:user) do |c|
+    #     c.define_slots(1..1024)
+    #   end
+    def define_cluster(cluster_name, &block)
+      cluster_config = ClusterConfig.new(cluster_name)
+      cluster_config.instance_eval(&block)
+      @cluster_configs[cluster_name] = cluster_config
+      nil
+    end
+
+    # @param [Symbol] cluster_name
+    # @return [MixedGauge::ClusterConfig]
+    def fetch_cluster_config(cluster_name)
+      @cluster_configs.fetch(cluster_name)
+    end
+  end
+end

data/lib/mixed_gauge/errors.rb

@@ -0,0 +1,8 @@
+module MixedGauge
+  class Error < ::StandardError
+  end
+
+  # Raised when try to put new record without distkey attribute.
+  class MissingDistkeyAttribute < Error
+  end
+end

data/lib/mixed_gauge/model.rb

@@ -0,0 +1,69 @@
+require 'active_support/concern'
+
+module MixedGauge
+  # @example
+  #   class User < ActiveRecord::Base
+  #     include MixedGauge::Model
+  #     use_cluster :user
+  #     distkey :email
+  #   end
+  #
+  #   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.where(name: 'alice') }
+  module Model
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :cluster_routing, instance_writer: false
+      class_attribute :sub_model_repository, instance_writer: false
+    end
+
+    module ClassMethods
+      # @param [Symbol] A cluster name which is set by MixedGauge.configure
+      def use_cluster(name)
+        config = MixedGauge.config.fetch_cluster_config(name)
+        self.cluster_routing = MixedGauge::Routing.new(config)
+        self.sub_model_repository = MixedGauge::SubModelRepository.new(config, self)
+        self.abstract_class = true
+      end
+
+      # @param [Symbol] column
+      def distkey(column)
+        self.distkey = column.to_sym
+      end
+
+      # @param [Object] key 
+      # @return [ActiveRecord::Base] A auto-generated sub model of included model
+      def get(key)
+        shard_for(key.to_s).find_by(distkey => key)
+      end
+
+      # @param [Hash] attributes
+      # @return [ActiveRecord::Base] A sub class instance of included model
+      def put!(attributes)
+        if key = attributes[distkey] || attributes[distkey.to_s]
+          shard_for(key).create!(attributes)
+        else
+          raise MixedGauge::MissingDistkeyAttribute
+        end
+      end
+
+      # @param [Object] key A value of distkey
+      # @return [Class] A sub model for this distkey value
+      def shard_for(key)
+        connection_name = cluster_routing.route(key.to_s)
+        sub_model_repository.fetch(connection_name)
+      end
+
+      # @return [Array<Class>] An array of sub models
+      def all_shards
+        sub_model_repository.all
+      end
+    end
+  end
+end

data/lib/mixed_gauge/routing.rb

@@ -0,0 +1,23 @@
+require 'digest/md5'
+
+module MixedGauge
+  class Routing
+    # @param [ClusterConfig] cluster_config
+    def initialize(cluster_config)
+      @cluster_config = cluster_config
+    end
+
+    # @param [String] dist_key
+    # @return [String] connection name
+    def route(key)
+      slot = hash_f(key) % @cluster_config.slot_count
+      @cluster_config.fetch(slot)
+    end
+
+    # @param [String] key
+    # @return [Integer]
+    def hash_f(key)
+      Digest::MD5.hexdigest(key).to_i(16)
+    end
+  end
+end

data/lib/mixed_gauge/sub_model_repository.rb

@@ -0,0 +1,53 @@
+module MixedGauge
+  class SubModelRepository
+    attr_reader :base_class
+
+    # @param [ClusterConfig] cluster_config
+    # @param [Class] base_class A AR Model
+    def initialize(cluster_config, base_class)
+      @base_class = base_class
+
+      sub_models = cluster_config.connections.map do |connection_name|
+        [connection_name, generate_sub_model(connection_name)]
+      end
+      @sub_models = Hash[sub_models]
+    end
+
+    # @param [Symbol] connection_name
+    # @return [Class] A sub model of given base class
+    def fetch(connection_name)
+      @sub_models.fetch(connection_name)
+    end
+
+    # @return [Array<Class>]
+    def all
+      @sub_models.values
+    end
+
+    private
+
+    # @param [Symbol] connection_name
+    # @return [Class] A generated sub class of given AR model
+    def generate_sub_model(connection_name)
+      base_class_name = @base_class.name
+      class_name = generate_class_name(connection_name)
+
+      sub_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
+      sub_model.class_eval { establish_connection(connection_name) }
+      sub_model
+    end
+
+    # @param [Symbol] name
+    # @return [String]
+    def generate_class_name(name)
+      "GeneratedModel#{name.to_s.gsub('-', '_').classify}"
+    end
+  end
+end

data/lib/mixed_gauge/version.rb

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

data/mixed_gauge.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mixed_gauge/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'mixed_gauge'
+  spec.version       = MixedGauge::VERSION
+  spec.authors       = ['Taiki Ono']
+  spec.email         = ['taiks.4559@gmail.com']
+
+  spec.summary       = %q{An ActiveRecord extension for database sharding.}
+  spec.description   = %q{Offers simple key-value action, node management with hash slots, allow to use some AR::B actions.}
+  spec.homepage      = 'https://github.com/taiki45/mixed_gauge'
+  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 'activesupport', '>= 4.0.0'
+  spec.add_dependency 'activerecord', '>= 4.0.0'
+  spec.add_development_dependency 'bundler', '~> 1.9'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3'
+  spec.add_development_dependency 'sqlite3'
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: mixed_gauge
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Taiki Ono
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-05-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: 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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: Offers simple key-value action, node management with hash slots, allow
+  to use some AR::B actions.
+email:
+- taiks.4559@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/mixed_gauge.rb
+- lib/mixed_gauge/cluster_config.rb
+- lib/mixed_gauge/config.rb
+- lib/mixed_gauge/errors.rb
+- lib/mixed_gauge/model.rb
+- lib/mixed_gauge/routing.rb
+- lib/mixed_gauge/sub_model_repository.rb
+- lib/mixed_gauge/version.rb
+- mixed_gauge.gemspec
+homepage: https://github.com/taiki45/mixed_gauge
+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.2.2
+signing_key: 
+specification_version: 4
+summary: An ActiveRecord extension for database sharding.
+test_files: []
+has_rdoc: