mixed_gauge 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: af67019109e77025f6dcc080900efb12622b9f7e
-  data.tar.gz: be1c25c01c401d06286e26e1075bbd29f5df5d6c
+  metadata.gz: 4dc2c3036f197760c0c28b3fe7f6dd28519a2076
+  data.tar.gz: f2098922ed048918a03ade6b860447bbe2eb519a
 SHA512:
-  metadata.gz: 70a434108a0fecee84f08f63d79a74a751c91396352dac7682be3031fbd80249a7dac288cdd2a137993411ff40b375697889d4c01a0409686bc4486421e88bf7
-  data.tar.gz: 0b415db64f93f88422fab59c290d504a65e546a2e4d49cb33bf75178f5f825a4e1fb4590ff199c25c6342407622412b700bfc01448c1d3f06400b8127d210028
+  metadata.gz: 7ff5439bd44a28a0a15f6ec630bdd3d3afb46fb3d3437c64b6e8a8acc98815fa78b983f4a1c7213a143a89196b646e93e9de395ad8e0d34e5c5150e26b73bbef
+  data.tar.gz: 7161650054c1a237bd7b9e12418afaef05d886b837cd60c88fa86d4b1c9d07df73bf30798c213e4b8fd958c24eafb5daa6155c6fe20ac9ab10da2f3f268fd6c0

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+/gemfiles/*.lock

data/.rspec

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

data/.travis.yml

@@ -1,5 +1,24 @@
 language: ruby
+sudo: false
+branches:
+  only:
+    - master
 rvm:
-  - '2.0'
-  - '2.1'
-  - '2.2'
+  - 2.0
+  - 2.1
+  - 2.2
+gemfile:
+  - gemfiles/ar_4.1.0.gemfile
+  - gemfiles/ar_4.1.7.gemfile
+  - gemfiles/ar_4.1.8.gemfile
+  - gemfiles/ar_4.2.gemfile
+  - gemfiles/rails_edge.gemfile
+matrix:
+  allow_failures:
+    - gemfile: gemfiles/rails_edge.gemfile
+  exclude:
+    # Rails 5 requires to run on Ruby 2.2.0 or newer.
+    - rvm: 2.0
+      gemfile: gemfiles/rails_edge.gemfile
+    - rvm: 2.1
+      gemfile: gemfiles/rails_edge.gemfile

data/Appraisals

@@ -0,0 +1,22 @@
+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 'rails-edge' do
+  gem 'activerecord', github: 'rails/rails'
+  gem 'arel', github: 'rails/arel'
+end
+
+# vim: set ft=ruby:

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# CHANGELOG for mixed_gauge
+
+## 0.1.3
+- Rake tasks to setup database cluster.
+
 ## 0.1.2
 - Enable to register before hook on `.put!`.
 - Enable to define arbitrary methods to model class.

data/README.md

@@ -1,7 +1,17 @@
 # MixedGauge
 [![Build Status](https://travis-ci.org/taiki45/mixed_gauge.svg?branch=master)](https://travis-ci.org/taiki45/mixed_gauge) [![Coverage Status](https://coveralls.io/repos/taiki45/mixed_gauge/badge.svg?branch=master)](https://coveralls.io/r/taiki45/mixed_gauge?branch=master) [![Code Climate](https://codeclimate.com/github/taiki45/mixed_gauge/badges/gpa.svg)](https://codeclimate.com/github/taiki45/mixed_gauge) [![Gem Version](https://badge.fury.io/rb/mixed_gauge.svg)](http://badge.fury.io/rb/mixed_gauge)
 
-An ActiveRecord extension for database sharding.
+A simple and robust ActiveRecord extension for database sharding.
+mixed_gauge offers shards management with hash slots, re-sharding support,
+KVS actions, some ActiveRecord::Base actions.
+
+## Concept
+Shard management is based on hash slots mechanism.
+
+TODO: more doc.
+
+## Why and When to use mixed_gauge
+TODO
 
 ## Usage
 

data/Rakefile

@@ -1,3 +1,6 @@
+require 'rubygems'
+require 'bundler/setup'
+
 require 'bundler/gem_tasks'
 
 begin

data/gemfiles/ar_4.1.0.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "4.1.0"
+
+gemspec :path => "../"

data/gemfiles/ar_4.1.7.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "4.1.7"
+
+gemspec :path => "../"

data/gemfiles/ar_4.1.8.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "4.1.8"
+
+gemspec :path => "../"

data/gemfiles/ar_4.2.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 4.2"
+
+gemspec :path => "../"

data/gemfiles/rails_edge.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", :github => "rails/rails"
+gem "arel", :github => "rails/arel"
+
+gemspec :path => "../"

data/lib/mixed_gauge.rb

@@ -20,3 +20,6 @@ module MixedGauge
     end
   end
 end
+
+require 'mixed_gauge/database_tasks'
+require 'mixed_gauge/railtie' if defined? Rails

data/lib/mixed_gauge/config.rb

@@ -2,7 +2,7 @@ module MixedGauge
   class Config
     DEFAULT_HASH_FUNCTION = -> (key) { Digest::MD5.hexdigest(key).to_i(16) }
 
-    attr_reader :hash_proc
+    attr_reader :hash_proc, :cluster_configs
 
     def initialize
       @cluster_configs = {}

data/lib/mixed_gauge/database_tasks.rb

@@ -0,0 +1,183 @@
+module MixedGauge
+  module DatabaseTasks
+    extend self
+
+    # @return [Boolean]
+    def ar5?
+      ActiveRecord::VERSION::MAJOR == 5
+    end
+
+    # @return [Boolean]
+    def ar4?
+      ActiveRecord::VERSION::MAJOR == 4
+    end
+
+    # @return [Boolean]
+    def ar42?
+      ar4? && ActiveRecord::VERSION::MINOR == 2
+    end
+
+    # @return [Boolean]
+    def ar41?
+      ar4? && ActiveRecord::VERSION::MINOR == 1
+    end
+
+    # @return [Boolean]
+    def ar417_above?
+      ar41? && ActiveRecord::VERSION::TINY > 7
+    end
+
+    # Show information of database sharding config.
+    def info
+      puts "All clusters registered to mixed_gauge"
+      puts
+      clusters.each do |cluster|
+        puts "= Cluster: #{cluster.name} ="
+        cluster.connections.each do |name|
+          puts "- #{name}"
+        end
+        puts
+      end
+    end
+
+    # @private
+    # @param [String] task_name
+    # @return [Rake::Task]
+    def to_rake_task(task_name)
+      Rake::Task[task_name]
+    end
+
+    # @private
+    # @return [Array<Symbol>]
+    def cluster_names
+      MixedGauge.config.cluster_configs.keys
+    end
+
+    # @private
+    # @return [Array<MixedGauge::ClusterConfig>]
+    def clusters
+      MixedGauge.config.cluster_configs.values
+    end
+
+    # @private
+    # @return [MixedGauge::ClusterConfig]
+    # @raise [KeyError]
+    def fetch_cluster_config(cluster_name)
+      MixedGauge.config.fetch_cluster_config(cluster_name)
+    end
+
+    # For mock-ablity
+    # @private
+    def exit_with_error
+      exit 1
+    end
+
+    module TasksForMultipleClusters
+      # @param [String] task_name
+      def invoke_task_for_all_clusters(task_name)
+        cluster_names.each do |cluster_name|
+          invoke_task(task_name, cluster_name)
+        end
+      end
+
+      # @private
+      # @param [String] name
+      # @param [Symbol] cluster_name
+      def invoke_task(name, cluster_name)
+        task_name = "mixed_gauge:#{name}"
+        to_rake_task(task_name).invoke(cluster_name.to_s)
+        to_rake_task(task_name).reenable
+      end
+    end
+    extend TasksForMultipleClusters
+
+    # Organize cluster config and handle error for invalid args, call single
+    # cluster task with each single connection config.
+    module TaskOrganizerForSingleClusterTask
+      # @param [Hash{Symbol => String}] args
+      def create_all_databases(args)
+        exec_task_for_all_databases('create', args)
+      end
+
+      # @param [Hash{Symbol => String}] args
+      def drop_all_databases(args)
+        exec_task_for_all_databases('drop', args)
+      end
+
+      # @param [Hash{Symbol => String}] args
+      def load_schema_all_databases(args)
+        exec_task_for_all_databases('load_schema', args)
+      end
+
+      private
+
+      # @param [String] task_name
+      # @param [Hash{Symbol => String}] args
+      def exec_task_for_all_databases(task_name, args)
+        cluster_name = cluster_name_or_error(task_name, args)
+        cluster = cluster_or_error(cluster_name)
+        cluster.connections.each do |connection_name|
+          __send__(task_name, connection_name.to_s)
+        end
+      end
+
+      # @param [String] name A task name
+      # @param [Hash{Symbol => String}] args
+      # @return [String]
+      def cluster_name_or_error(name, args)
+        unless cluster_name = args[:cluster_name]
+          $stderr.puts <<-MSG
+Missing cluster_name. Find cluster_name via `rake mixed_gauge:info` then call `rake "mixed_gauge:#{name}[$cluster_name]"`.
+          MSG
+          exit_with_error
+        end
+        cluster_name
+      end
+
+      # @param [String] cluster_name
+      # @return [MixedGauge::ClusterConfig]
+      def cluster_or_error(cluster_name)
+        fetch_cluster_config(cluster_name.to_sym)
+      rescue KeyError
+        $stderr.puts %!cluster name "#{cluster_name}" not found.!
+        exit_with_error
+      end
+    end
+    extend TaskOrganizerForSingleClusterTask
+
+    # Create, drop, load_schema for single connection config.
+    module TasksForSingleConnection
+      # @param [String] connection_name
+      def create(connection_name)
+        configuration = ActiveRecord::Base.configurations[connection_name]
+        ActiveRecord::Tasks::DatabaseTasks.create(configuration)
+        # Re-configure using configuration with database
+        ActiveRecord::Base.establish_connection(configuration)
+      end
+
+      # @param [String] connection_name
+      def drop(connection_name)
+        configuration = ActiveRecord::Base.configurations[connection_name]
+        ActiveRecord::Tasks::DatabaseTasks.drop(configuration)
+      end
+
+      # @param [String] connection_name
+      def load_schema(connection_name)
+        configuration = ActiveRecord::Base.configurations[connection_name]
+
+        case
+        when ar5?
+          ActiveRecord::Tasks::DatabaseTasks.load_schema(configuration, :ruby)
+        when ar42? || ar417_above?
+          ActiveRecord::Tasks::DatabaseTasks.load_schema_for(configuration, :ruby)
+        when ar41?
+          ActiveRecord::Base.establish_connection(configuration)
+          ActiveRecord::Tasks::DatabaseTasks.load_schema(:ruby)
+        else
+          raise "This version of ActiveRecord is not supported: v#{ActiveRecord::VERSION::STRING}"
+        end
+      end
+    end
+    extend TasksForSingleConnection
+  end
+end

data/lib/mixed_gauge/railtie.rb

@@ -0,0 +1,8 @@
+module MixedGauge
+  # Railtie of mixed_gauge
+  class Railtie < ::Rails::Railtie
+    rake_tasks do
+      load File.expand_path('../../tasks/mixed_gauge.rake', __FILE__)
+    end
+  end
+end

data/lib/mixed_gauge/version.rb

@@ -1,3 +1,3 @@
 module MixedGauge
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
 end

data/lib/tasks/mixed_gauge.rake

@@ -0,0 +1,40 @@
+namespace :mixed_gauge do
+  desc 'Show all defined clusters and their detail'
+  task info: %i(environment) do
+    MixedGauge::DatabaseTasks.info
+  end
+
+  desc 'Setup all databases in all clusters'
+  task setup: %i(create_all load_schema_all) do
+  end
+
+  desc 'Create all databases in all clusters'
+  task :create_all => :environment do
+    MixedGauge::DatabaseTasks.invoke_task_for_all_clusters('create')
+  end
+
+  desc 'Drop all databases in all clusters'
+  task :drop_all => :environment do
+    MixedGauge::DatabaseTasks.invoke_task_for_all_clusters('drop')
+  end
+
+  desc 'Load schema to all databases in all clusters'
+  task :load_schema_all => :environment do
+    MixedGauge::DatabaseTasks.invoke_task_for_all_clusters('load_schema')
+  end
+
+  desc 'Create all databases in specific cluster'
+  task :create, %i(cluster_name) => %i(environment) do |_, args|
+    MixedGauge::DatabaseTasks.create_all_databases(args)
+  end
+
+  desc 'Drop all databases in specific cluster'
+  task :drop, %i(cluster_name) => %i(environment) do |_, args|
+    MixedGauge::DatabaseTasks.drop_all_databases(args)
+  end
+
+  desc 'Load schema to all databases in specific cluster'
+  task :load_schema, %i(cluster_name) => %i(environment) do |_, args|
+    MixedGauge::DatabaseTasks.load_schema_all_databases(args)
+  end
+end

data/mixed_gauge.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   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.summary       = %{An ActiveRecord extension for database sharding including re-sharding support.}
+  spec.description   = %{#{spec.summary} Offers shards management with hash slots, re-sharding support, key-value action, some ActiveRecord::Base actions.}
   spec.homepage      = 'https://github.com/taiki45/mixed_gauge'
   spec.license       = 'MIT'
 
@@ -19,8 +19,8 @@ Gem::Specification.new do |spec|
   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_dependency 'activerecord', '>= 4.1.0'
+  spec.add_development_dependency 'appraisal'
   spec.add_development_dependency 'coveralls'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'pry-doc'

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: mixed_gauge
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Taiki Ono
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-05-27 00:00:00.000000000 Z
+date: 2015-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 4.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 4.1.0
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -150,8 +150,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Offers simple key-value action, node management with hash slots, allow
-  to use some AR::B actions.
+description: An ActiveRecord extension for database sharding including re-sharding
+  support. Offers shards management with hash slots, re-sharding support, key-value
+  action, some ActiveRecord::Base actions.
 email:
 - taiks.4559@gmail.com
 executables: []
@@ -162,6 +163,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- Appraisals
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -169,14 +171,22 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- gemfiles/ar_4.1.0.gemfile
+- gemfiles/ar_4.1.7.gemfile
+- gemfiles/ar_4.1.8.gemfile
+- gemfiles/ar_4.2.gemfile
+- gemfiles/rails_edge.gemfile
 - lib/mixed_gauge.rb
 - lib/mixed_gauge/cluster_config.rb
 - lib/mixed_gauge/config.rb
+- lib/mixed_gauge/database_tasks.rb
 - lib/mixed_gauge/errors.rb
 - lib/mixed_gauge/model.rb
+- lib/mixed_gauge/railtie.rb
 - lib/mixed_gauge/routing.rb
 - lib/mixed_gauge/sub_model_repository.rb
 - lib/mixed_gauge/version.rb
+- lib/tasks/mixed_gauge.rake
 - mixed_gauge.gemspec
 homepage: https://github.com/taiki45/mixed_gauge
 licenses:
@@ -201,6 +211,6 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: An ActiveRecord extension for database sharding.
+summary: An ActiveRecord extension for database sharding including re-sharding support.
 test_files: []
 has_rdoc: