activerecord-turntable 2.0.0.rc1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2d2ed24b4fc25e1ec4752797494ce5f7e01aba00
-  data.tar.gz: e9686336be4cac05c60c3d129d3b94c3d562674c
+  metadata.gz: 5ed732d4f5ce27c8ec309d715a01e33bc4e287f2
+  data.tar.gz: e026370254d526d21205b9a72cd0a05e8df5d355
 SHA512:
-  metadata.gz: 948dc1c9c05cedd33df32a763b79a587ec7e748ef03e96b8b763b7e991716b82f619c2bfbb4e4980136ae507c78dda9e06b733768613ecca2468ce8bd33042f3
-  data.tar.gz: 887ec36800641c5f632acdc83cc8abcb22f428ee196743e1d64b8b371d93e99fedc776d4c4151b91b57fc8586da80f91692f75c5249a354b076a90060e423f6e
+  metadata.gz: 77aa461ca4b2c0ce44589ffb756f8c49cfa263040b435235cfd9afd38d0469086c8a6e33ee2b1d82badbefbede00d640cdae145581f4cae9363eac271ee16cbc
+  data.tar.gz: f78bc87da3c3e41717f2a2cbd797a96fd7a07dc12daa274b7b8ff30c03055950f78c0b083b788d107e5744379acafea0cdde7d5f80e2cbe896d8b0c89db0fba5

data/CHANGELOG.md

@@ -1,4 +1,4 @@
-## activerecord-turntable 2.0.0 (not released yet) ##
+## activerecord-turntable 2.0.0 ##
 
 First release for ActiveRecord 4.x
 

data/lib/active_record/turntable/active_record_ext/abstract_adapter.rb

@@ -6,6 +6,7 @@ module ActiveRecord::Turntable
       included do
         protected
 
+        # @note override for logging current shard name
         def log(sql, name = "SQL", binds = [])
           @instrumenter.instrument(
                                    "sql.active_record",

data/lib/active_record/turntable/active_record_ext/activerecord_import_ext.rb

@@ -1,5 +1,6 @@
 module ActiveRecord::Turntable
   module ActiveRecordExt
+    # activerecord-import extension
     module ActiverecordImportExt
       extend ActiveSupport::Concern
 
@@ -9,6 +10,7 @@ module ActiveRecord::Turntable
 
       private
 
+      # @note override for sequencer injection
       def values_sql_for_columns_and_attributes_with_turntable(columns, array_of_attributes)
         connection_memo = connection
         array_of_attributes.map do |arr|

data/lib/active_record/turntable/active_record_ext/acts_as_archive_extension.rb

@@ -1,8 +1,9 @@
 begin
   require 'acts_as_archive'
-
+  # acts_as_archive extension
   class ActsAsArchive
     class << self
+      # @note use the same shard which `from` shard using
       def move_with_turntable(config, where, merge_options={})
         if [config[:to], config[:from]].all? { |k| k.try(:turntable_enabled?) }
           current_shard = config[:from].connection.current_shard.name.to_sym

data/lib/active_record/turntable/active_record_ext/association.rb

@@ -20,6 +20,7 @@ module ActiveRecord::Turntable
 
         private
 
+        # @note Override to add sharding condition for singular association
         if ActiveRecord::Turntable.rails41_later?
           def find_target_with_turntable
             current_scope = scope
@@ -50,6 +51,7 @@ module ActiveRecord::Turntable
 
         private
 
+        # @note Override to add sharding condition for collection association
         def find_target_with_turntable
           records =
             if options[:finder_sql]

data/lib/active_record/turntable/active_record_ext/association_preloader.rb

@@ -9,6 +9,7 @@ module ActiveRecord::Turntable
         alias_method_chain :records_for, :turntable
       end
 
+      # @note Override to add sharding condition on preload
       def records_for_with_turntable(ids)
         returning_scope = records_for_without_turntable(ids)
         if should_use_shard_key?

data/lib/active_record/turntable/active_record_ext/connection_handler_extension.rb

@@ -9,6 +9,7 @@ module ActiveRecord::Turntable
 
       private
 
+      # @note Override not to establish_connection destroy existing connection pool proxy object
       def pool_for_with_turntable(owner)
         owner_to_pool.fetch(owner.name) {
           if ancestor_pool = pool_from_any_process_for(owner)

data/lib/active_record/turntable/active_record_ext/locking_optimistic.rb

@@ -1,6 +1,6 @@
 module ActiveRecord::Turntable::ActiveRecordExt
   module LockingOptimistic
-
+    # @note Override to add sharding condition on optimistic locking
     ::ActiveRecord::Locking::Optimistic.class_eval do
 
       ar_version = ActiveRecord::VERSION::STRING

data/lib/active_record/turntable/active_record_ext/log_subscriber.rb

@@ -11,6 +11,7 @@ module ActiveRecord::Turntable
 
       protected
 
+      # @note Override to add shard name logging
       def sql_with_turntable(event)
         self.class.runtime += event.duration
         return unless logger.debug?

data/lib/active_record/turntable/active_record_ext/persistence.rb

@@ -1,6 +1,7 @@
 module ActiveRecord::Turntable::ActiveRecordExt
   module Persistence
     ::ActiveRecord::Persistence.class_eval do
+      # @note Override to add sharding scope on reloading
       def reload(options = nil)
         clear_aggregation_cache
         clear_association_cache
@@ -26,6 +27,7 @@ module ActiveRecord::Turntable::ActiveRecordExt
         self
       end
 
+      # @note Override to add sharding scope on `touch`
       def touch(name = nil)
         raise ActiveRecordError, "can not touch on a new record object" unless persisted?
 
@@ -58,6 +60,7 @@ module ActiveRecord::Turntable::ActiveRecordExt
 
       private
 
+      # @note Override to add sharding scope on destroying
       def relation_for_destroy
         pk         = self.class.primary_key
         column     = self.class.columns_hash[pk]
@@ -74,6 +77,8 @@ module ActiveRecord::Turntable::ActiveRecordExt
         relation
       end
 
+
+      # @note Override to add sharding scope on updating
       ar_version = ActiveRecord::VERSION::STRING
       if ar_version < "4.1"
         method_name = ar_version =~ /\A4\.0\.[0-5]\z/ ? "update_record" : "_update_record"

data/lib/active_record/turntable/active_record_ext/relation.rb

@@ -15,6 +15,7 @@ module ActiveRecord::Turntable
         end
       end
 
+      # @note Override to add sharding scope on updating
       def _update_record_with_turntable(values, id, id_was, turntable_scope = nil) # :nodoc:
         substitutes, binds = substitute_values values
         condition_scope = @klass.unscoped.where(@klass.arel_table[@klass.primary_key].eq(id_was || id))

data/lib/active_record/turntable/active_record_ext/schema_dumper.rb

@@ -10,6 +10,7 @@ module ActiveRecord::Turntable
 
       private
 
+      # @note Override to dump database sequencer method
       def table_with_turntable(table, stream)
         columns = @connection.columns(table)
         begin

data/lib/active_record/turntable/active_record_ext/transactions.rb

@@ -1,6 +1,7 @@
 module ActiveRecord::Turntable
   module ActiveRecordExt
     module Transactions
+      # @note Override to start transaction on current shard
       def with_transaction_returning_status
         if self.class.turntable_enabled?
           status = nil

data/lib/active_record/turntable/base.rb

@@ -16,6 +16,9 @@ module ActiveRecord::Turntable
     end
 
     module ClassMethods
+      # @param [Symbol] cluster_name cluster name for this class
+      # @param [Symbol] shard_key_name shard key attribute name
+      # @param [Hash] options
       def turntable(cluster_name, shard_key_name, options = {})
         class_attribute :turntable_shard_key,
                           :turntable_cluster, :turntable_cluster_name
@@ -34,6 +37,7 @@ module ActiveRecord::Turntable
         turntable_define_cluster_methods(cluster_name)
       end
 
+      #
       def force_transaction_all_shards!(options={}, &block)
         force_connect_all_shards!
         shards = turntable_connections.values
@@ -172,10 +176,12 @@ module ActiveRecord::Turntable
       self.class.shards_transaction(options, &block)
     end
 
+    # @return [ActiveRecord::Turntable::Shard] current shard for self
     def turntable_shard
       turntable_cluster.shard_for(self.send(turntable_shard_key))
     end
 
+    # @see ActiveRecord::Turntable::ConnectionProxy#with_shard
     def with_shard(shard)
       self.class.connection.with_shard(shard) { yield }
     end

data/lib/active_record/turntable/connection_proxy.rb

@@ -111,14 +111,22 @@ module ActiveRecord::Turntable
       current_shard_entry[object_id] = shard
     end
 
+    # @return connection of current shard
     def connection
       current_shard.connection
     end
 
+    # @return connection_pool of current shard
     def connection_pool
       current_shard.connection_pool
     end
 
+    # Fix connection to given shard in block
+    # @param [ActiveRecord::Base, Symbol, ActiveRecord::Turntable::Shard, Numeric, String] shard which you want to fix
+    # @param shard [ActiveRecord::Base] AR Object
+    # @param shard [Symbol] shard name symbol that defined in turntable.yml
+    # @param shard [ActiveRecord::Turntable::Shard] Shard object
+    # @param shard [String, Numeric] Raw sharding id
     def with_shard(shard)
       shard = cluster.to_shard(shard)
 
@@ -142,6 +150,8 @@ module ActiveRecord::Turntable
       end
     end
 
+    # Send queries to all shards in this cluster
+    # @param [Boolean] continue_on_error when a shard raises error, ignore exception and continue
     def with_all(continue_on_error = false)
       @cluster.shards.values.map do |shard|
         begin
@@ -157,6 +167,8 @@ module ActiveRecord::Turntable
       end
     end
 
+    # Send queries to master connection and all shards in this cluster
+    # @param [Boolean] continue_on_error when a shard raises error, ignore exception and continue
     def with_master_and_all(continue_on_error = false)
       ([@cluster.master] + @cluster.shards.values).map do |shard|
         begin

data/lib/active_record/turntable/version.rb

@@ -1,5 +1,5 @@
 module ActiveRecord
   module Turntable
-    VERSION = "2.0.0.rc1"
+    VERSION = "2.0.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-turntable
 version: !ruby/object:Gem::Version
-  version: 2.0.0.rc1
+  version: 2.0.0
 platform: ruby
 authors:
 - gussan
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-09 00:00:00.000000000 Z
+date: 2014-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -430,9 +430,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: activerecord-turntable
 rubygems_version: 2.2.2
@@ -480,3 +480,4 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/matchers/be_saved_to.rb
 - spec/support/turntable_helper.rb
+has_rdoc: