activerecord-sharding 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6161f4f763503556924e2678e30f8b8dd35877dd
-  data.tar.gz: 345928fff20f5bf81e6a85740822b125770ec2a8
+  metadata.gz: 74c9354eb637b74252c1ee7631037140ad0326ea
+  data.tar.gz: c6adaf64d167afd9dbf16a0e3982158181255a9e
 SHA512:
-  metadata.gz: 6044b78dcf067016e87bc738c927efd62a8f5406ed8952b3df9d8f032bda50e795af0d71eedbdce12bfd4d2cd177e46d60665f0907ff9e93742f195a23559556
-  data.tar.gz: 329ee41bf7df37ce0302fa8a9338ede775782871197f6f87f99ae589d28c326bae538ff39980f7a087ba31fec4484ab5622dce93c6fe0c1c7897d0e30cc3d6ef
+  metadata.gz: 5c74278a9bae13cf05ccbf4fda5abf98cebec86c90ad3489cb2f18ea3eb0c4e150a0725b8151003d95712a9f989b7812f6b8da007fe01ea78e9738f94c77c0b5
+  data.tar.gz: b0ed70dc49f1d1cb389ed6313991b1ac21013f7720211d62ff57e1e253a82c3fcdbaa6ebd0d938227c0d80d324ca6044532160abdac7f9ac2c1f569168c8accb

data/.rubocop.yml

@@ -27,6 +27,12 @@ Style/ModuleFunction:
 Style/StringLiterals:
   EnforcedStyle: double_quotes
 
+Style/IndentationConsistency:
+  EnforcedStyle: rails
+
+Style/SignalException:
+  EnforcedStyle: only_raise
+
 Style/HashSyntax:
   EnforcedStyle: ruby19_no_mixed_keys
   Exclude:
@@ -41,6 +47,9 @@ Metrics/LineLength:
 Lint/AssignmentInCondition:
   Enabled: false
 
+Lint/BlockAlignment:
+  Enabled: false
+
 Metrics/MethodLength:
   Max: 12
 

data/.travis.yml

@@ -1,9 +1,13 @@
 language: ruby
+install: bundle install --jobs=3 --retry=3
 rvm:
-  - 2.2.3
-  - 2.1.7
-  - 2.0.0-p647
-before_install: gem install bundler -v 1.10.6
+  - 2.2.4
+  - 2.1.8
+  - 2.0.0-p648
+gemfile:
+  - Gemfile
+  - ar41.gemfile
+  - ar416.gemfile
 services:
   - mysql
 script:

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Change Log
+
+## [v0.1.0](https://github.com/hirocaster/activerecord-sharding/tree/v0.1.0) (2015-08-27)
+**Merged pull requests:**
+
+- Refactor etc ... [\#7](https://github.com/hirocaster/activerecord-sharding/pull/7) ([hirocaster](https://github.com/hirocaster))
+- Refactor class repository [\#6](https://github.com/hirocaster/activerecord-sharding/pull/6) ([hirocaster](https://github.com/hirocaster))
+- Add codeclimate-test-reporter [\#5](https://github.com/hirocaster/activerecord-sharding/pull/5) ([hirocaster](https://github.com/hirocaster))
+- Change coding style [\#4](https://github.com/hirocaster/activerecord-sharding/pull/4) ([hirocaster](https://github.com/hirocaster))
+- Setup coveralls [\#3](https://github.com/hirocaster/activerecord-sharding/pull/3) ([hirocaster](https://github.com/hirocaster))
+- Setup travis ci [\#2](https://github.com/hirocaster/activerecord-sharding/pull/2) ([hirocaster](https://github.com/hirocaster))
+- Change namespace ActiveRecordSharding to ActiveRecord::Sharding [\#1](https://github.com/hirocaster/activerecord-sharding/pull/1) ([hirocaster](https://github.com/hirocaster))
+
+
+
+\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

data/Gemfile

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

data/README.md

@@ -1,6 +1,6 @@
 # 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)
+[![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=master&service=github)](https://coveralls.io/github/hirocaster/activerecord-sharding?branch=master) [![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.
 
@@ -54,7 +54,7 @@ user_002:
   host: localhost
 
 user_003:
-<<: *default
+  <<: *default
   database: user_003
   host: localhost
 ```
@@ -123,6 +123,16 @@ using `#put!` method.
 user = User.put! name: 'foobar'
 ```
 
+if transaction to shard database and nest other database transactions.
+
+```ruby
+User.put!(name: 'foobar') do |new_user| # transaction for user shard database
+  OTHER_MODEL.transaction do
+    OTHER_MODEL.create!(user_id: new_user.id)
+  end
+end
+```
+
 returns User new object.
 
 #### Select Query
@@ -136,6 +146,12 @@ User.shard_for(sharding_key).where(name: 'foorbar')
 
 `#sahrd_for` is returns User class.
 
+for all shards query
+
+```ruby
+User.all_shards.flat_map { |model| model.find_by(name: 'foorbar') }.compact
+```
+
 #### Association/Relation
 
 if use database association/relation in sharding databases.

data/activerecord-sharding.gemspec

@@ -20,12 +20,10 @@ Gem::Specification.new do |spec|
 
   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 "mysql2", "~> 0.3.18"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "pry-byebug"
   spec.add_development_dependency "awesome_print"

data/ar41.gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+gem "activerecord", ">= 4.1.0", "< 4.2.0"
+
+# Specify your gem's dependencies in active_record_sharding.gemspec
+gemspec

data/ar416.gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+gem "activerecord", ">= 4.1.0", "< 4.1.7"
+
+# Specify your gem's dependencies in active_record_sharding.gemspec
+gemspec

data/lib/active_record/sharding/abstract_repository.rb

@@ -22,7 +22,7 @@ module ActiveRecord
         end
 
         def generate_class_name(connection_name) # rubocop:disable Lint/UnusedMethodArgument
-          fail NotImplementedError, "#{self.class.name}.#{__method__} is an abstract method."
+          raise NotImplementedError, "#{self.class.name}.#{__method__} is an abstract method."
         end
     end
   end

data/lib/active_record/sharding/cluster_config.rb

@@ -21,7 +21,7 @@ module ActiveRecord
       end
 
       def validate_config!
-        fail "Nothing registerd connections." if registerd_connection_count == 0
+        raise "Nothing registerd connections." if registerd_connection_count == 0
       end
 
       def connections

data/lib/active_record/sharding/database_tasks.rb

@@ -118,30 +118,30 @@ module ActiveRecord
 
         private
 
-        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
+          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
-        end
 
-        def cluster_name_or_error(name, args)
-          unless cluster_name = args[:cluster_name]
-            $stderr.puts <<-MSG
+          def cluster_name_or_error(name, args)
+            unless cluster_name = args[:cluster_name]
+              $stderr.puts <<-MSG
 Missing cluster_name. Find cluster_name via `rake active_record:sharding:info` then call `rake "active_record:sharding:#{name}[$cluster_name]"`.
           MSG
-            exit
+              exit
+            end
+            cluster_name
           end
-          cluster_name
-        end
 
-        def cluster_or_error(cluster_name)
-          fetch_cluster_config cluster_name.to_sym
-        rescue KeyError
-          $stderr.puts %(cluster name "#{cluster_name}" not found.)
-          exit
-        end
+          def cluster_or_error(cluster_name)
+            fetch_cluster_config cluster_name.to_sym
+          rescue KeyError
+            $stderr.puts %(cluster name "#{cluster_name}" not found.)
+            exit
+          end
       end
       extend TaskOrganizerForSingleClusterTask
 
@@ -174,7 +174,7 @@ Missing cluster_name. Find cluster_name via `rake active_record:sharding:info` t
             ActiveRecord::Base.establish_connection configuration
             ActiveRecord::Tasks::DatabaseTasks.load_schema :ruby
           else
-            fail "This version of ActiveRecord is not supported: v#{ActiveRecord::VERSION::STRING}"
+            raise "This version of ActiveRecord is not supported: v#{ActiveRecord::VERSION::STRING}"
           end
         end
       end
@@ -197,36 +197,53 @@ Missing cluster_name. Find cluster_name via `rake active_record:sharding:info` t
 
         def insert_initial_record_sequencer_database(args)
           sequencer = sequencer_or_error "insert_initial_record", args
-          insert_initial_record_sql = "INSERT INTO #{sequencer.table_name} VALUES (0)"
-          execute sequencer.connection_name.to_s, insert_initial_record_sql
+          records_count = sequencer_records_count sequencer
+
+          if records_count == 0
+            insert_initial_record_sql = "INSERT INTO #{sequencer.table_name} VALUES (0)"
+            execute sequencer.connection_name.to_s, insert_initial_record_sql
+          else
+            puts "Exist sequencer record in #{sequencer.table_name} table."
+          end
         end
 
         private
 
-        def exec_task_for_sequencer_database(task_name, args)
-          sequencer = sequencer_or_error task_name, args
-          __send__ task_name, sequencer.connection_name.to_s
-        end
+          def sequencer_records_count(sequencer)
+            count_sql = "SELECT COUNT(*) FROM #{sequencer.table_name}"
+            count_result = execute sequencer.connection_name.to_s, count_sql
 
-        def sequencer_or_error(task_name, args)
-          sequencer_name = sequencer_name_or_error task_name, args
-          fetch_sequencer_config sequencer_name.to_sym
-        rescue KeyError
-          $stderr.puts %(sequencer name "#{sequencer_name}" not found.)
-          exit
-        end
+            if count_result
+              count_result.first.first.to_i
+            else
+              0
+            end
+          end
 
-        def sequencer_name_or_error(task_name, args)
-          unless sequencer_name = args[:sequencer_name]
-            # rubocop:disable Metrics/LineLength
-            $stderr.puts <<-MSG
+          def exec_task_for_sequencer_database(task_name, args)
+            sequencer = sequencer_or_error task_name, args
+            __send__ task_name, sequencer.connection_name.to_s
+          end
+
+          def sequencer_or_error(task_name, args)
+            sequencer_name = sequencer_name_or_error task_name, args
+            fetch_sequencer_config sequencer_name.to_sym
+          rescue KeyError
+            $stderr.puts %(sequencer name "#{sequencer_name}" not found.)
+            exit
+          end
+
+          def sequencer_name_or_error(task_name, args)
+            unless sequencer_name = args[:sequencer_name]
+              # rubocop:disable Metrics/LineLength
+              $stderr.puts <<-MSG
 Missing sequencer_name. Find sequencer_name via `rake active_record:sharding:info` then call `rake "active_record:sharding:sequencer#{task_name}[$sequencer_name]"`.
           MSG
-            exit
-            # rubocop:enable Metrics/LineLength
+              exit
+              # rubocop:enable Metrics/LineLength
+            end
+            sequencer_name
           end
-          sequencer_name
-        end
       end
       extend TasksForSingleSequencerTask
     end # module DatabaseTasks

data/lib/active_record/sharding/errors.rb

@@ -5,5 +5,8 @@ module ActiveRecord
 
     class MissingShardingKeyAttribute < Error
     end
+
+    class MissingPrimaryKey < Error
+    end
   end
 end

data/lib/active_record/sharding/model.rb

@@ -5,7 +5,9 @@ module ActiveRecord
     module Model
       extend ActiveSupport::Concern
 
-      included do
+      included do |base|
+        base.before_create :validate_id!
+
         class_attribute :cluster_router, instance_writer: false
         class_attribute :shard_repository, instance_writer: false
         class_attribute :sharding_key, instance_writer: false
@@ -30,14 +32,21 @@ module ActiveRecord
         end
 
         def put!(attributes)
-          fail "`sharding_key` is not defined. Use `define_sharding_key`." unless sharding_key
+          raise "`sharding_key` is not defined. Use `define_sharding_key`." unless sharding_key
 
           @before_put_callback.call(attributes) if @before_put_callback
 
           if key = attributes[sharding_key] || attributes[sharding_key.to_s]
-            shard_for(key).create!(attributes)
+            if block_given?
+              shard_for(key).transaction do
+                object = shard_for(key).create!(attributes)
+                yield(object)
+              end
+            else
+              shard_for(key).create!(attributes)
+            end
           else
-            fail ActiveRecord::Sharding::MissingShardingKeyAttribute
+            raise ActiveRecord::Sharding::MissingShardingKeyAttribute
           end
         end
 
@@ -54,6 +63,12 @@ module ActiveRecord
           instance_eval(&block)
         end
       end
+
+      private
+
+        def validate_id!
+          raise ActiveRecord::Sharding::MissingPrimaryKey if attributes[self.class.primary_key].nil?
+        end
     end
   end
 end

data/lib/active_record/sharding/sequencer.rb

@@ -3,6 +3,13 @@ require "active_support/concern"
 module ActiveRecord
   module Sharding
     module Sequencer
+
+      class Error < ActiveRecord::Sharding::Error
+      end
+
+      class NegativeNumberOffsetError < Error
+      end
+
       extend ActiveSupport::Concern
 
       included do
@@ -23,14 +30,16 @@ module ActiveRecord
           execute_sql "id"
         end
 
-        def next_sequence_id
-          execute_sql "id +1"
+        def next_sequence_id(offset = 1)
+          raise NegativeNumberOffsetError if offset < 1
+          execute_sql "id +#{offset}"
         end
 
         def execute_sql(last_insert_id_args)
-          connection = sequencer_repository.fetch(sequencer_name).connection
-          connection.execute "UPDATE `#{sequencer_config.table_name}` SET id = LAST_INSERT_ID(#{last_insert_id_args})"
-          res = connection.execute "SELECT LAST_INSERT_ID()"
+          sequencer_klass = sequencer_repository.fetch(sequencer_name)
+          connection = sequencer_klass.connection
+          connection.execute "UPDATE `#{sequencer_config.table_name}` SET id = LAST_INSERT_ID(#{last_insert_id_args})", sequencer_klass.name
+          res = connection.execute "SELECT LAST_INSERT_ID()", sequencer_klass.name
           new_id = res.first.first.to_i
           new_id
         end

data/lib/active_record/sharding/sequencer_config.rb

@@ -18,8 +18,8 @@ module ActiveRecord
       end
 
       def validate_config!
-        fail "Nothing connection. Please call register_connection" if @connection_name.blank?
-        fail "Nothing table_name. Please call register_table_name" if @table_name.blank?
+        raise "Nothing connection. Please call register_connection" if @connection_name.blank?
+        raise "Nothing table_name. Please call register_table_name" if @table_name.blank?
       end
     end
   end

data/lib/active_record/sharding/sequencer_repository.rb

@@ -14,9 +14,9 @@ module ActiveRecord
 
       private
 
-      def generate_class_name(connection_name)
-        "SequencerFor#{connection_name.to_s.tr('-', '_').classify}"
-      end
+        def generate_class_name(connection_name)
+          "SequencerFor#{connection_name.to_s.tr('-', '_').classify}"
+        end
     end
   end
 end

data/lib/active_record/sharding/shard_repository.rb

@@ -23,9 +23,9 @@ module ActiveRecord
 
       private
 
-      def generate_class_name(connection_name)
-        "ShardFor#{connection_name.to_s.tr('-', '_').classify}"
-      end
+        def generate_class_name(connection_name)
+          "ShardFor#{connection_name.to_s.tr('-', '_').classify}"
+        end
     end
   end
 end

data/lib/active_record/sharding/version.rb

@@ -1,5 +1,5 @@
 module ActiveRecord
   module Sharding
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/spec/active_record/sharding/model_spec.rb

@@ -42,6 +42,21 @@ describe ActiveRecord::Sharding::Model do
       expect(alice.class.name).to match(/User::ShardFor/)
     end
 
+    context "in transaction" do
+      it "when rollback" do
+        before_record_count = model.all_shards.map(&:count).reduce(:+)
+
+        model.put!(name: "Bob") do |bob|
+          expect(bob.persisted?).to be true
+          raise ActiveRecord::Rollback
+        end
+
+        after_record_count = model.all_shards.map(&:count).reduce(:+)
+
+        expect(after_record_count).to eq before_record_count
+      end
+    end
+
     context 'next call #put!' do
       let(:bob) { model.put! name: "Bob" }
       let(:alice_connect_db) { alice.class.connection.pool.spec.config[:database] }
@@ -87,4 +102,42 @@ describe ActiveRecord::Sharding::Model do
       expect(record.name).to eq("foo")
     end
   end
+
+  describe "Irregular use case" do
+    context "Not write before_put block" do
+      let!(:model) do
+        Class.new(ActiveRecord::Base) do
+          def self.name
+            "User"
+          end
+
+          def self.sequence_id
+            @sequence_id ||= 0
+          end
+
+          class << self
+            attr_writer :sequence_id
+          end
+
+          def self.next_sequence_id
+            self.sequence_id += 1
+          end
+
+          include ActiveRecord::Sharding::Model
+          use_sharding :user, :modulo
+          define_sharding_key :id
+
+          define_parent_methods do
+            def find_from_all_by_name(name)
+              all_shards.map { |m| m.find_by(name: name) }.compact.first
+            end
+          end
+        end
+      end
+
+      it "Raise MissingPrimaryKey at #save" do
+        expect { model.shard_for(1).new.save }.to raise_error ActiveRecord::Sharding::MissingPrimaryKey
+      end
+    end
+  end
 end

data/spec/active_record/sharding/sequencer_spec.rb

@@ -12,20 +12,45 @@ describe ActiveRecord::Sharding::Model do
 
   describe '#current_sequence_id' do
     it "returns current sequence id" do
-      expect(model.current_sequence_id).to be_a_kind_of Fixnum
+      current_id = model.current_sequence_id
+      expect(current_id).to be_a_kind_of Fixnum
+      expect(model.current_sequence_id).to eq current_id
+    end
+
+    it "output class name to log" do
+      sequencer_klass = model.sequencer_repository.fetch(:user)
+      expect(sequencer_klass.connection).to receive(:execute).with(anything, "User::SequencerForTestUserSequencer").and_return([[0]]).twice
+      model.current_sequence_id
     end
   end
-  describe '#next_sequence_id' do
-    let(:current_id) { model.current_sequence_id }
-    let(:next_id) { model.next_sequence_id }
 
+  describe '#next_sequence_id' do
     it "returns next sequence id" do
-      expect(current_id + 1).to eq next_id
-      expect(next_id).to be_a_kind_of Fixnum
+      next_id = model.current_sequence_id + 1
+      expect(next_id).to eq model.next_sequence_id
+      expect(next_id).to eq model.current_sequence_id
     end
 
     it "next sequence id > current sequence id" do
-      expect(current_id).to be < next_id
+      expect(model.current_sequence_id).to be < model.next_sequence_id
+    end
+
+    context "when offset is selected" do
+      let(:offset) { 10 }
+
+      it "returns current_sequence_id with offset" do
+        next_id = model.current_sequence_id + offset
+        expect(next_id).to eq model.next_sequence_id(offset)
+        expect(next_id).to eq model.current_sequence_id
+      end
+
+      context "when negative number in offset args" do
+        let(:offset) { -5 }
+
+        it "raise error" do
+          expect { model.next_sequence_id offset }.to raise_error ActiveRecord::Sharding::Sequencer::NegativeNumberOffsetError
+        end
+      end
     end
   end
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-sharding
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - hirocaster
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-28 00:00:00.000000000 Z
+date: 2016-01-15 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: activerecord
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.1.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.1.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -70,16 +56,16 @@ dependencies:
   name: mysql2
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.3.18
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.3.18
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -180,10 +166,13 @@ files:
 - ".rubocop.yml"
 - ".ruby-version"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - README.md
 - Rakefile
 - activerecord-sharding.gemspec
+- ar41.gemfile
+- ar416.gemfile
 - bin/benchmark_sequencer.rb
 - bin/console
 - bin/setup