switchman 1.16.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70787591a2f55963ba4b74b816cb11428d1d764e87d3635309d98b423ed842e1
-  data.tar.gz: 5516037d6c39f1215eac8764512d97125dbeaf2cb64aeed234f5a4d55ce18650
+  metadata.gz: 7cec081d77daa09b754a98ce7bc335198b2dfbdbcd093df492a43803ff7a2742
+  data.tar.gz: d93576725471024b24c4622d33e0eff9c1b61498b6c037e624d9b6ff8c78a442
 SHA512:
-  metadata.gz: bad00cb3a194c18f792c214caa3f47f90ac53b7186ea458775b9562e1bf2b8fa898e6317ca4514722ce3a9e8652061101e15f657556f2c95344c6ecd5284bb34
-  data.tar.gz: '0697c43ffd9934ddfb9d0640295024e1035297ac7f14e9a3018a80f0170e427904924d4efa42892a5cf2f223aa75490c9ccd0da500c7040c4c53da4b04f8d9a7'
+  metadata.gz: 6d4c7b1e82460fbdfda1659fc09379583c5e63ecc21d412466563a62c42679db864f8f09c2eaa2bed17b53216c64d18c42caabec76291f25e00bfc1e6a2499a1
+  data.tar.gz: e52baf68ce2301dfa26abffd423e9855c875232871539fea59ae88ffd8f3b355299cb4c0bb60e32bf90555e7e935d2f73954ec01919cab16993bee73b39e56b6

data/app/models/switchman/shard.rb

@@ -38,7 +38,10 @@ module Switchman
       end
 
       def default(reload_deprecated = false, reload: false, with_fallback: false)
-        reload = reload_deprecated if reload_deprecated
+        if reload_deprecated
+          reload = reload_deprecated
+          ActiveSupport::Deprecation.warn("positional reload parameter to Switchman::Shard.default is deprecated; use `reload: true`")
+        end
         if !@default || reload
           # Have to create a dummy object so that several key methods still work
           # (it's easier to do this in one place here, and just assume that sharding
@@ -351,8 +354,8 @@ module Switchman
           # prune the prior connection unless it happened to be the same
           if previous_shard && shard != previous_shard && !previous_shard.database_server.shareable?
             previous_shard.activate do
-              ::Shackles.activated_environments.each do |env|
-                ::Shackles.activate(env) do
+              ::GuardRail.activated_environments.each do |env|
+                ::GuardRail.activate(env) do
                   if ::ActiveRecord::Base.connected? && ::ActiveRecord::Base.connection.open_transactions == 0
                     ::ActiveRecord::Base.connection_pool.current_pool.disconnect!
                   end
@@ -659,7 +662,7 @@ module Switchman
         case adapter
           when 'mysql', 'mysql2'
             self.activate do
-              ::Shackles.activate(:deploy) do
+              ::GuardRail.activate(:deploy) do
                 drop_statement ||= "DROP DATABASE #{self.name}"
                 Array(drop_statement).each do |stmt|
                   ::ActiveRecord::Base.connection.execute(stmt)
@@ -668,7 +671,7 @@ module Switchman
             end
           when 'postgresql'
             self.activate do
-              ::Shackles.activate(:deploy) do
+              ::GuardRail.activate(:deploy) do
                 # Shut up, Postgres!
                 conn = ::ActiveRecord::Base.connection
                 old_proc = conn.raw_connection.set_notice_processor {}

data/db/migrate/20130328224244_create_default_shard.rb

@@ -3,7 +3,7 @@ class CreateDefaultShard < ActiveRecord::Migration[4.2]
     unless Switchman::Shard.default.is_a?(Switchman::Shard)
       Switchman::Shard.reset_column_information
       Switchman::Shard.create!(:default => true)
-      Switchman::Shard.default(true)
+      Switchman::Shard.default(reload: true)
     end
   end
 end

data/lib/switchman.rb

@@ -1,4 +1,4 @@
-require "shackles"
+require "guard_rail"
 require "switchman/open4"
 require "switchman/engine"
 

data/lib/switchman/active_record/abstract_adapter.rb

@@ -4,8 +4,8 @@ module Switchman
   module ActiveRecord
     module AbstractAdapter
       module ForeignKeyCheck
-        def add_column(table, name, type, options = {})
-          Engine.foreign_key_check(name, type, options)
+        def add_column(table, name, type, limit: nil, **)
+          Engine.foreign_key_check(name, type, limit: limit)
           super
         end
       end

data/lib/switchman/active_record/base.rb

@@ -31,20 +31,20 @@ module Switchman
           @integral_id
         end
 
-        def transaction(*args)
+        def transaction(**)
           if self != ::ActiveRecord::Base && current_scope
             current_scope.activate do
               db = Shard.current(shard_category).database_server
-              if ::Shackles.environment != db.shackles_environment
-                db.unshackle { super }
+              if ::GuardRail.environment != db.guard_rail_environment
+                db.unguard { super }
               else
                 super
               end
             end
           else
             db = Shard.current(shard_category).database_server
-            if ::Shackles.environment != db.shackles_environment
-              db.unshackle { super }
+            if ::GuardRail.environment != db.guard_rail_environment
+              db.unguard { super }
             else
               super
             end
@@ -105,12 +105,12 @@ module Switchman
         end
       end
 
-      def save(*args)
+      def save(*, **)
         @shard_set_in_stone = true
         (self.class.current_scope || self.class.default_scoped).shard(shard, :implicit).scoping { super }
       end
 
-      def save!(*args)
+      def save!(*, **)
         @shard_set_in_stone = true
         (self.class.current_scope || self.class.default_scoped).shard(shard, :implicit).scoping { super }
       end
@@ -157,8 +157,8 @@ module Switchman
 
       def update_columns(*)
         db = Shard.current(self.class.shard_category).database_server
-        if ::Shackles.environment != db.shackles_environment
-          return db.unshackle { super }
+        if ::GuardRail.environment != db.guard_rail_environment
+          return db.unguard { super }
         else
           super
         end

data/lib/switchman/active_record/connection_handler.rb

@@ -55,7 +55,7 @@ module Switchman
           Shard.default.remove_instance_variable(:@name) if Shard.default.instance_variable_defined?(:@name)
         end
 
-        @shard_connection_pools ||= { [:master, Shard.default.database_server.shareable? ? ::Rails.env : Shard.default] => pool}
+        @shard_connection_pools ||= { [:primary, Shard.default.database_server.shareable? ? ::Rails.env : Shard.default] => pool}
 
         category = pool.spec.name.to_sym
         proxy = ConnectionPoolProxy.new(category,
@@ -64,13 +64,13 @@ module Switchman
         owner_to_pool[pool.spec.name] = proxy
 
         if first_time
-          if Shard.default.database_server.config[:prefer_slave]
-            Shard.default.database_server.shackle!
+          if Shard.default.database_server.config[:prefer_secondary]
+            Shard.default.database_server.guard!
           end
 
-          if Shard.default.is_a?(DefaultShard) && Shard.default.database_server.config[:slave]
-            Shard.default.database_server.shackle!
-            Shard.default(true)
+          if Shard.default.is_a?(DefaultShard) && Shard.default.database_server.config[:secondary]
+            Shard.default.database_server.guard!
+            Shard.default(reload: true)
           end
         end
 

data/lib/switchman/active_record/postgresql_adapter.rb

@@ -192,7 +192,7 @@ module Switchman
         end
       end
 
-      def add_index_options(_table_name, _column_name, _options = {})
+      def add_index_options(_table_name, _column_name, **)
         index_name, index_type, index_columns, index_options, algorithm, using = super
         algorithm = nil if DatabaseServer.creating_new_shard && algorithm == "CONCURRENTLY"
         [index_name, index_type, index_columns, index_options, algorithm, using]

data/lib/switchman/active_record/relation.rb

@@ -5,7 +5,7 @@ module Switchman
         klass::SINGLE_VALUE_METHODS.concat [ :shard, :shard_source ]
       end
 
-      def initialize(*args)
+      def initialize(*, **)
         super
         self.shard_value = Shard.current(klass ? klass.shard_category : :primary) unless shard_value
         self.shard_source_value = :implicit unless shard_source_value
@@ -17,7 +17,7 @@ module Switchman
         result
       end
 
-      def merge(*args)
+      def merge(*)
         relation = super
         if relation.shard_value != self.shard_value && relation.shard_source_value == :implicit
           relation.shard_value = self.shard_value
@@ -26,15 +26,15 @@ module Switchman
         relation
       end
 
-      def new(*args, &block)
+      def new(*, &block)
         primary_shard.activate(klass.shard_category) { super }
       end
 
-      def create(*args, &block)
+      def create(*, &block)
         primary_shard.activate(klass.shard_category) { super }
       end
 
-      def create!(*args, &block)
+      def create!(*, &block)
         primary_shard.activate(klass.shard_category) { super }
       end
 

data/lib/switchman/active_record/statement_cache.rb

@@ -2,7 +2,7 @@ module Switchman
   module ActiveRecord
     module StatementCache
       module ClassMethods
-        def create(connection, block = Proc.new)
+        def create(connection, &block)
           relation = block.call ::ActiveRecord::StatementCache::Params.new
 
           if ::Rails.version >= "5.2"

data/lib/switchman/active_record/table_definition.rb

@@ -1,8 +1,8 @@
 module Switchman
   module ActiveRecord
     module TableDefinition
-      def column(name, type, options = {})
-        Engine.foreign_key_check(name, type, options)
+      def column(name, type, limit: nil, **)
+        Engine.foreign_key_check(name, type, limit: limit)
         super
       end
     end

data/lib/switchman/connection_pool_proxy.rb

@@ -37,13 +37,13 @@ module Switchman
       Shard.current(@category)
     end
 
-    def active_shackles_environment
-      ::Rails.env.test? ? :master : active_shard.database_server.shackles_environment
+    def active_guard_rail_environment
+      ::Rails.env.test? ? :primary : active_shard.database_server.guard_rail_environment
     end
 
     def current_pool
       current_active_shard = active_shard
-      pool = self.default_pool if current_active_shard.database_server == Shard.default.database_server && active_shackles_environment == :master && (current_active_shard.default? || current_active_shard.database_server.shareable?)
+      pool = self.default_pool if current_active_shard.database_server == Shard.default.database_server && active_guard_rail_environment == :primary && (current_active_shard.default? || current_active_shard.database_server.shareable?)
       pool = @connection_pools[pool_key] ||= create_pool unless pool
       pool.shard = current_active_shard
       pool
@@ -60,8 +60,8 @@ module Switchman
         connection.instance_variable_set(:@schema_cache, @schema_cache) unless ::Rails.version >= '6'
         connection
       rescue ConnectionError
-        raise if active_shard.database_server == Shard.default.database_server && active_shackles_environment == :master
-        configs = active_shard.database_server.config(active_shackles_environment)
+        raise if active_shard.database_server == Shard.default.database_server && active_guard_rail_environment == :primary
+        configs = active_shard.database_server.config(active_guard_rail_environment)
         raise unless configs.is_a?(Array)
         configs.each_with_index do |config, idx|
           pool = create_pool(config.dup)
@@ -120,7 +120,7 @@ module Switchman
     end
 
     def pool_key
-      [active_shackles_environment,
+      [active_guard_rail_environment,
         active_shard.database_server.shareable? ? active_shard.database_server.pool_key : active_shard]
     end
 
@@ -128,7 +128,7 @@ module Switchman
       shard = active_shard
       unless config
         if shard != Shard.default
-          config = shard.database_server.config(active_shackles_environment)
+          config = shard.database_server.config(active_guard_rail_environment)
           config = config.first if config.is_a?(Array)
           config = config.dup
         else
@@ -138,10 +138,10 @@ module Switchman
           # different models could be using different configs on the default
           # shard, and database server wouldn't know about that
           config = default_pool.spec.instance_variable_get(:@config)
-          if config[active_shackles_environment].is_a?(Hash)
-            config = config.merge(config[active_shackles_environment])
-          elsif config[active_shackles_environment].is_a?(Array)
-            config = config.merge(config[active_shackles_environment].first)
+          if config[active_guard_rail_environment].is_a?(Hash)
+            config = config.merge(config[active_guard_rail_environment])
+          elsif config[active_guard_rail_environment].is_a?(Array)
+            config = config.merge(config[active_guard_rail_environment].first)
           else
             config = config.dup
           end

data/lib/switchman/database_server.rb

@@ -69,12 +69,12 @@ module Switchman
       @fake
     end
 
-    def config(environment = :master)
+    def config(environment = :primary)
       @configs[environment] ||= begin
         if @config[environment].is_a?(Array)
           @config[environment].map do |config|
             config = @config.merge((config || {}).symbolize_keys)
-            # make sure Shackles doesn't get any brilliant ideas about choosing the first possible server
+            # make sure GuardRail doesn't get any brilliant ideas about choosing the first possible server
             config.delete(environment)
             config
           end
@@ -86,33 +86,33 @@ module Switchman
       end
     end
 
-    def shackles_environment
-      @shackles_environment || ::Shackles.environment
+    def guard_rail_environment
+      @guard_rail_environment || ::GuardRail.environment
     end
 
     # locks this db to a specific environment, except for
     # when doing writes (then it falls back to the current
-    # value of Shackles.environment)
-    def shackle!(environment = :slave)
-      @shackles_environment = environment
+    # value of GuardRail.environment)
+    def guard!(environment = :secondary)
+      @guard_rail_environment = environment
     end
 
-    def unshackle!
-      @shackles_environment = nil
+    def unguard!
+      @guard_rail_environment = nil
     end
 
-    def unshackle
-      old_env = @shackles_environment
-      unshackle!
+    def unguard
+      old_env = @guard_rail_environment
+      unguard!
       yield
     ensure
-      shackle!(old_env)
+      guard!(old_env)
     end
 
     def shareable?
       @shareable_environment_key ||= []
-      environment = shackles_environment
-      explicit_user = ::Shackles.global_config[:username]
+      environment = guard_rail_environment
+      explicit_user = ::GuardRail.global_config[:username]
       return @shareable if @shareable_environment_key == [environment, explicit_user]
       @shareable_environment_key = [environment, explicit_user]
       if explicit_user
@@ -190,7 +190,7 @@ module Switchman
         begin
           self.class.creating_new_shard = true
           shard.activate(*Shard.categories) do
-            ::Shackles.activate(:deploy) do
+            ::GuardRail.activate(:deploy) do
               begin
                 if create_statement
                   if (::ActiveRecord::Base.connection.select_value("SELECT 1 FROM pg_namespace WHERE nspname=#{::ActiveRecord::Base.connection.quote(name)}"))

data/lib/switchman/engine.rb

@@ -87,7 +87,7 @@ module Switchman
         require "switchman/arel"
         require "switchman/call_super"
         require "switchman/rails"
-        require "switchman/shackles/relation"
+        require "switchman/guard_rail/relation"
         require_dependency "switchman/shard"
         require "switchman/standard_error"
 
@@ -133,7 +133,7 @@ module Switchman
         ::ActiveRecord::Relation.prepend(ActiveRecord::Calculations)
         ::ActiveRecord::Relation.include(ActiveRecord::FinderMethods)
         ::ActiveRecord::Relation.include(ActiveRecord::QueryMethods)
-        ::ActiveRecord::Relation.prepend(Shackles::Relation)
+        ::ActiveRecord::Relation.prepend(GuardRail::Relation)
         ::ActiveRecord::Relation.prepend(ActiveRecord::Relation)
         ::ActiveRecord::Relation.include(ActiveRecord::SpawnMethods)
         ::ActiveRecord::Relation.include(CallSuper)
@@ -150,8 +150,8 @@ module Switchman
       end
     end
 
-    def self.foreign_key_check(name, type, options)
-      if name.to_s =~ /_id\z/ && type.to_s == 'integer' && options[:limit].to_i < 8
+    def self.foreign_key_check(name, type, limit: nil)
+      if name.to_s =~ /_id\z/ && type.to_s == 'integer' && limit.to_i < 8
         puts "WARNING: All foreign keys need to be 8-byte integers. #{name} looks like a foreign key. If so, please add the option: `:limit => 8`"
       end
     end
@@ -185,15 +185,15 @@ module Switchman
       end
     end
 
-    initializer 'switchman.extend_shackles', :before => "switchman.extend_ar" do
+    initializer 'switchman.extend_guard_rail', :before => "switchman.extend_ar" do
       ::ActiveSupport.on_load(:active_record) do
-        require "switchman/shackles"
+        require "switchman/guard_rail"
 
-        ::Shackles.singleton_class.prepend(Shackles::ClassMethods)
+        ::GuardRail.singleton_class.prepend(GuardRail::ClassMethods)
       end
     end
 
-    initializer 'switchman.extend_controller', :after => "shackles.extend_ar" do
+    initializer 'switchman.extend_controller', :after => "guard_rail.extend_ar" do
       ::ActiveSupport.on_load(:action_controller) do
         require "switchman/action_controller/caching"
 

data/lib/switchman/{shackles.rb → guard_rail.rb}

@@ -1,17 +1,17 @@
 module Switchman
-  module Shackles
+  module GuardRail
     module ClassMethods
       def self.prepended(klass)
         klass.send(:remove_method, :ensure_handler)
       end
 
       # drops the save_handler and ensure_handler calls from the vanilla
-      # Shackles' implementation.
+      # GuardRail' implementation.
       def activate!(environment)
-        environment ||= :master
+        environment ||= :primary
         activated_environments << environment
         old_environment = self.environment
-        Thread.current[:shackles_environment] = environment
+        Thread.current[:guard_rail_environment] = environment
         old_environment
       end
 

data/lib/switchman/{shackles → guard_rail}/relation.rb

@@ -1,11 +1,11 @@
 module Switchman
-  module Shackles
+  module GuardRail
     module Relation
       def exec_queries(*args)
         if self.lock_value
           db = Shard.current(shard_category).database_server
-          if ::Shackles.environment != db.shackles_environment
-            return db.unshackle { super }
+          if ::GuardRail.environment != db.guard_rail_environment
+            return db.unguard { super }
           end
         end
         super
@@ -15,8 +15,8 @@ module Switchman
         class_eval <<-RUBY, __FILE__, __LINE__ + 1
           def #{method}(*args)
             db = Shard.current(shard_category).database_server
-            if ::Shackles.environment != db.shackles_environment
-              db.unshackle { super }
+            if ::GuardRail.environment != db.guard_rail_environment
+              db.unguard { super }
             else
               super
             end

data/lib/switchman/r_spec_helper.rb

@@ -65,7 +65,7 @@ module Switchman
             (@@shard3.drop_database if @@shard3) rescue nil
             @@shard1 = @@shard2 = @@shard3 = nil
             Shard.delete_all
-            Shard.default(true)
+            Shard.default(reload: true)
             next
           end
         end
@@ -73,7 +73,7 @@ module Switchman
         # in the db before then
         Shard.delete_all
         Switchman.cache.delete("default_shard")
-        Shard.default(true)
+        Shard.default(reload: true)
         puts "Done!"
 
         at_exit do
@@ -102,7 +102,7 @@ module Switchman
         dup.id = @@default_shard.id
         dup.save!
         Switchman.cache.delete("default_shard")
-        Shard.default(true)
+        Shard.default(reload: true)
         dup = @@shard1.dup
         dup.id = @@shard1.id
         dup.save!
@@ -122,7 +122,7 @@ module Switchman
         raise "Sharding did not set up correctly" if @@sharding_failed
         Shard.clear_cache
         if use_transactional_tests
-          Shard.default(true)
+          Shard.default(reload: true)
           @shard1 = Shard.find(@shard1.id)
           @shard2 = Shard.find(@shard2.id)
           shards = [@shard2]
@@ -151,7 +151,7 @@ module Switchman
       klass.after(:all) do
         Shard.connection.update("TRUNCATE #{Shard.quoted_table_name} CASCADE")
         Switchman.cache.delete("default_shard")
-        Shard.default(true)
+        Shard.default(reload: true)
       end
     end
   end

data/lib/switchman/sharded_instrumenter.rb

@@ -14,7 +14,7 @@ module Switchman
         payload[:shard] = {
           database_server_id: shard.database_server.id,
           id: shard.id,
-          env: shard.database_server.shackles_environment
+          env: shard.database_server.guard_rail_environment
         }
       end
       super name, payload

data/lib/switchman/test_helper.rb

@@ -3,8 +3,8 @@ module Switchman
     class << self
       def recreate_persistent_test_shards(dont_create: false)
         # recreate the default shard (it got buhleted)
-        ::Shackles.activate(:deploy) { Switchman.cache.clear }
-        if Shard.default(true).is_a?(DefaultShard)
+        ::GuardRail.activate(:deploy) { Switchman.cache.clear }
+        if Shard.default(reload: true).is_a?(DefaultShard)
           begin
             Shard.create!(default: true)
           rescue
@@ -12,7 +12,7 @@ module Switchman
             # database doesn't exist yet, presumably cause we're creating it right now
             return [nil, nil]
           end
-          Shard.default(true)
+          Shard.default(reload: true)
         end
 
         # can't auto-create a new shard on the default shard's db server if the

data/lib/switchman/version.rb

@@ -1,3 +1,3 @@
 module Switchman
-  VERSION = "1.16.0"
+  VERSION = "2.0.0"
 end

data/lib/tasks/switchman.rake

@@ -64,8 +64,8 @@ module Switchman
           TestHelper.recreate_persistent_test_shards(dont_create: true)
         end
 
-        ::Shackles.activate(:deploy) do
-          Shard.default.database_server.unshackle do
+        ::GuardRail.activate(:deploy) do
+          Shard.default.database_server.unguard do
             begin
               categories = categories.call if categories.respond_to?(:call)
               Shard.with_each_shard(scope, categories, options) do
@@ -83,7 +83,7 @@ module Switchman
       
                   ::ActiveRecord::Base.configurations = new_configs
                 end
-                shard.database_server.unshackle do
+                shard.database_server.unguard do
                   old_actions.each { |action| action.call(*task_args) }
                 end
                 nil

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: switchman
 version: !ruby/object:Gem::Version
-  version: 1.16.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Cody Cutrer
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-15 00:00:00.000000000 Z
+date: 2020-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -53,19 +53,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '6.1'
 - !ruby/object:Gem::Dependency
-  name: shackles
+  name: guardrail
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.2
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.2
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: open4
   requirement: !ruby/object:Gem::Requirement
@@ -228,12 +228,12 @@ files:
 - lib/switchman/engine.rb
 - lib/switchman/environment.rb
 - lib/switchman/errors.rb
+- lib/switchman/guard_rail.rb
+- lib/switchman/guard_rail/relation.rb
 - lib/switchman/open4.rb
 - lib/switchman/r_spec_helper.rb
 - lib/switchman/rails.rb
 - lib/switchman/schema_cache.rb
-- lib/switchman/shackles.rb
-- lib/switchman/shackles/relation.rb
 - lib/switchman/sharded_instrumenter.rb
 - lib/switchman/standard_error.rb
 - lib/switchman/test_helper.rb
@@ -251,15 +251,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key:
 specification_version: 4
-summary: Rails 4 sharding magic
+summary: Rails sharding magic
 test_files: []