rails_multisite 4.0.1 → 5.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1b6e5b2d0e1ca292a9ab4b32619f7b090cc8f6cd7f7e961dd8d84b6d8eb5327
-  data.tar.gz: 24fb6fe44ef528dd8dbfdd1e79ef2b70d8c41f53d133a23ec457fea9743423fc
+  metadata.gz: 9b49ebb943b1cf7656cce41a93e6100b50159a5c7e389ef9629247b385b38c94
+  data.tar.gz: 93e51dcd1d7e91056e5643dc2b6220397e8c2672ed267aef342ebbb27efe15a1
 SHA512:
-  metadata.gz: 597ff3dce81db99a341eb8fd10a656bc789b6f6dcc540e580b53b9e7ea8a392c006255f37bd249731412e71b883497479cd18e168871c7ee8260df712dc48d71
-  data.tar.gz: a6dd8debbb37fba683da03fb7cf71a95c757a8ce2e9393ecbb211cfc64b407f7a78adc3bfcc357efb4049c9e60b733aa62ad6a704a7b3e31b875bef7f297ba6c
+  metadata.gz: 430d520b818f54f3b78eef444bc929542149c17852041ae42bd221d47188dacf927fead066ec49feae6c776d1ad2446c6ec27dae60a7d4e7e2758f407ec64921
+  data.tar.gz: adac4e78e18303464728db9b26f5124f4ebcf01ebf5081e8aa15d7a8103464b46ab0698facefe0d668e78e34600282cc74e53ba93a0de0ac1909b4db44d9e60d

data/lib/rails_multisite/connection_management/null_instance.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module RailsMultisite
+  class ConnectionManagement
+    class NullInstance
+      include Singleton
+
+      def clear_settings!
+      end
+
+      def config_filename
+      end
+
+      def default_connection_handler=(_connection_handler)
+      end
+
+      def establish_connection(_opts)
+      end
+
+      def reload
+      end
+
+      def all_dbs
+        [DEFAULT]
+      end
+
+      def connection_spec(_opts)
+        ConnectionSpecification.current
+      end
+
+      def current_db
+        DEFAULT
+      end
+
+      def each_connection(_opts = nil, &blk)
+        with_connection(&blk)
+      end
+
+      def has_db?(db)
+        db == DEFAULT
+      end
+
+      def host(env)
+        env["HTTP_HOST"]
+      end
+
+      def with_connection(db = DEFAULT, &blk)
+        connected = ActiveRecord::Base.connection_pool.connected?
+        result = blk.call(db)
+        unless connected
+          ActiveRecord::Base.connection_handler.clear_active_connections!
+        end
+        result
+      end
+
+      def with_hostname(hostname, &blk)
+        blk.call(hostname)
+      end
+    end
+  end
+end

data/lib/rails_multisite/connection_management.rb

@@ -1,173 +1,94 @@
 # frozen_string_literal: true
 
-if Rails.version >= '6.1'
-  require 'rails_multisite/connection_management/rails_61_compat'
+if Rails.version >= "6.1"
+  require "rails_multisite/connection_management/rails_61_compat"
 else
-  require 'rails_multisite/connection_management/rails_60_compat'
+  require "rails_multisite/connection_management/rails_60_compat"
 end
+require "rails_multisite/connection_management/null_instance"
 
 module RailsMultisite
   class ConnectionManagement
-    DEFAULT = 'default'
-
-    def self.default_config_filename
-      File.absolute_path(Rails.root.to_s + "/config/multisite.yml")
-    end
-
-    def self.clear_settings!
-      @instance&.db_spec_cache&.each do |key, spec|
-        @instance.connection_handlers.delete(self.handler_key(spec))
+    DEFAULT = "default"
+
+    cattr_accessor :connection_handlers, default: {}
+
+    attr_reader :config_filename, :db_spec_cache
+
+    class << self
+      attr_accessor :asset_hostnames
+
+      delegate :all_dbs,
+               :config_filename,
+               :connection_spec,
+               :current_db,
+               :default_connection_handler=,
+               :each_connection,
+               :establish_connection,
+               :has_db?,
+               :host,
+               :reload,
+               :with_connection,
+               :with_hostname,
+               to: :instance
+
+      def default_config_filename
+        File.absolute_path(Rails.root.to_s + "/config/multisite.yml")
       end
 
-      @instance = nil
-    end
-
-    def self.load_settings!
-      # no op only here backwards compat
-      STDERR.puts "RailsMultisite::ConnectionManagement.load_settings! is deprecated"
-    end
-
-    def self.instance
-      @instance
-    end
-
-    def self.config_filename=(config_filename)
-      if config_filename.nil?
+      def clear_settings!
+        instance.clear_settings!
         @instance = nil
-      else
-        @instance = new(config_filename)
-      end
-    end
-
-    def self.asset_hostnames
-      @asset_hostnames
-    end
-
-    def self.asset_hostnames=(h)
-      @asset_hostnames = h
-    end
-
-    def self.config_filename
-      @instance.config_filename
-    end
-
-    def self.reload
-      @instance.reload
-    end
-
-    def self.has_db?(db)
-      return true if db == DEFAULT
-      !!(@instance && @instance.has_db?(db))
-    end
-
-    def self.establish_connection(opts)
-      @instance.establish_connection(opts) if @instance
-    end
-
-    def self.with_hostname(hostname, &blk)
-      if @instance
-        @instance.with_hostname(hostname, &blk)
-      else
-        blk.call hostname
       end
-    end
 
-    def self.with_connection(db = DEFAULT, &blk)
-      if @instance
-        @instance.with_connection(db, &blk)
-      else
-        connected = ActiveRecord::Base.connection_pool.connected?
-        result = blk.call db
-        ActiveRecord::Base.clear_active_connections! unless connected
-        result
+      def load_settings!
+        # no op only here backwards compat
+        STDERR.puts "RailsMultisite::ConnectionManagement.load_settings! is deprecated"
       end
-    end
 
-    def self.each_connection(opts = nil, &blk)
-      if @instance
-        @instance.each_connection(opts, &blk)
-      else
-        with_connection(&blk)
+      def instance
+        @instance || NullInstance.instance
       end
-    end
 
-    def self.all_dbs
-      if @instance
-        @instance.all_dbs
-      else
-        [DEFAULT]
-      end
-    end
-
-    def self.current_db
-      if @instance
-        instance.current_db
-      else
-        DEFAULT
-      end
-    end
-
-    def self.current_hostname
-      current_db_hostnames.first
-    end
-
-    def self.current_db_hostnames
-      config = (@instance&.connection_spec(db: current_db) || ConnectionSpecification.current).config
-      config[:host_names].nil? ? [config[:host]] : config[:host_names]
-    end
-
-    def self.connection_spec(opts)
-      if @instance
-        @instance.connection_spec(opts)
-      else
-        ConnectionSpecification.current
+      def config_filename=(config_filename)
+        if config_filename.blank?
+          @instance = nil
+        else
+          @instance = new(config_filename)
+        end
       end
-    end
 
-    def self.host(env)
-      if @instance
-        @instance.host(env)
-      else
-        env["HTTP_HOST"]
+      def current_hostname
+        current_db_hostnames.first
       end
-    end
 
-    def self.handler_key(spec)
-      @handler_key_suffix ||= begin
-        if ActiveRecord::Base.respond_to?(:writing_role)
-          "_#{ActiveRecord::Base.writing_role}"
-        else
-          ""
-        end
+      def current_db_hostnames
+        config =
+          (
+            connection_spec(db: current_db) || ConnectionSpecification.current
+          ).config
+        config[:host_names] || [config[:host]]
       end
 
-      :"#{spec.name}#{@handler_key_suffix}"
-    end
-
-    def self.default_connection_handler=(connection_handler)
-      if @instance
-        unless connection_handler.is_a?(ActiveRecord::ConnectionAdapters::ConnectionHandler)
-          raise ArgumentError.new("Invalid connection handler")
-        end
+      def handler_key(spec)
+        @handler_key_suffix ||=
+          begin
+            if ActiveRecord.respond_to?(:writing_role)
+              "_#{ActiveRecord.writing_role}"
+            elsif ActiveRecord::Base.respond_to?(:writing_role)
+              "_#{ActiveRecord::Base.writing_role}"
+            else
+              ""
+            end
+          end
 
-        @instance.default_connection_handler = connection_handler
+        :"#{spec.name}#{@handler_key_suffix}"
       end
     end
 
-    attr_reader :config_filename, :db_spec_cache, :connection_handlers
-    attr_writer :default_connection_handler
-
     def initialize(config_filename)
       @config_filename = config_filename
 
-      @connection_handlers = begin
-        if ActiveRecord::Base.respond_to?(:connection_handlers)
-          ActiveRecord::Base.connection_handlers
-        else
-          {}
-        end
-      end
-
       @db_spec_cache = {}
       @default_spec = ConnectionSpecification.default
       @default_connection_handler = ActiveRecord::Base.connection_handler
@@ -178,12 +99,15 @@ module RailsMultisite
     end
 
     def load_config!
-      configs = YAML.safe_load(File.open(@config_filename))
+      configs = YAML.safe_load(File.open(config_filename))
 
-      no_prepared_statements = @default_spec.config[:prepared_statements] == false
+      no_prepared_statements =
+        @default_spec.config[:prepared_statements] == false
 
       configs.each do |k, v|
-        raise ArgumentError.new("Please do not name any db default!") if k == DEFAULT
+        if k == DEFAULT
+          raise ArgumentError.new("Please do not name any db default!")
+        end
         v[:db_key] = k
         v[:prepared_statements] = false if no_prepared_statements
       end
@@ -192,8 +116,8 @@ module RailsMultisite
       new_db_spec_cache = ConnectionSpecification.db_spec_cache(configs)
       new_db_spec_cache.each do |k, v|
         # If spec already existed, use the old version
-        if v&.to_hash == @db_spec_cache[k]&.to_hash
-          new_db_spec_cache[k] = @db_spec_cache[k]
+        if v&.to_hash == db_spec_cache[k]&.to_hash
+          new_db_spec_cache[k] = db_spec_cache[k]
         end
       end
 
@@ -211,25 +135,22 @@ module RailsMultisite
         new_host_spec_cache[host] = @default_spec
       end
 
-      removed_dbs = @db_spec_cache.keys - new_db_spec_cache.keys
-      removed_specs = @db_spec_cache.values_at(*removed_dbs)
+      removed_dbs = db_spec_cache.keys - new_db_spec_cache.keys
+      removed_specs = db_spec_cache.values_at(*removed_dbs)
 
       @host_spec_cache = new_host_spec_cache
       @db_spec_cache = new_db_spec_cache
 
       # Clean up connection handler cache.
-      removed_specs.each { |s| @connection_handlers.delete(handler_key(s)) }
+      removed_specs.each { |s| connection_handlers.delete(handler_key(s)) }
     end
 
     def reload
-      @reload_mutex.synchronize do
-        load_config!
-      end
+      @reload_mutex.synchronize { load_config! }
     end
 
     def has_db?(db)
-      return true if db == DEFAULT
-      @db_spec_cache[db]
+      db == DEFAULT || !!db_spec_cache[db]
     end
 
     def establish_connection(opts)
@@ -246,11 +167,11 @@ module RailsMultisite
       spec ||= @default_spec
       handler = nil
       if spec != @default_spec
-        handler = @connection_handlers[handler_key(spec)]
+        handler = connection_handlers[handler_key(spec)]
         unless handler
           handler = ActiveRecord::ConnectionAdapters::ConnectionHandler.new
-          handler_establish_connection(handler, spec)
-          @connection_handlers[handler_key(spec)] = handler
+          handler.establish_connection(spec.config)
+          connection_handlers[handler_key(spec)] = handler
         end
       else
         handler = @default_connection_handler
@@ -270,7 +191,9 @@ module RailsMultisite
         ActiveRecord::Base.connection_handler.clear_active_connections!
 
         establish_connection(host: old)
-        ActiveRecord::Base.connection_handler.clear_active_connections! unless connected
+        unless connected
+          ActiveRecord::Base.connection_handler.clear_active_connections!
+        end
       end
 
       rval
@@ -287,14 +210,15 @@ module RailsMultisite
         ActiveRecord::Base.connection_handler.clear_active_connections!
 
         establish_connection(db: old)
-        ActiveRecord::Base.connection_handler.clear_active_connections! unless connected
+        unless connected
+          ActiveRecord::Base.connection_handler.clear_active_connections!
+        end
       end
 
       rval
     end
 
     def each_connection(opts = nil, &blk)
-
       old = current_db
       connected = ActiveRecord::Base.connection_pool.connected?
 
@@ -309,30 +233,32 @@ module RailsMultisite
       errors = nil
 
       if queue
-        threads.times.map do
-          Thread.new do
-
-            while true
-              begin
-                db = queue.deq(true)
-              rescue ThreadError
-                db = nil
+        threads
+          .times
+          .map do
+            Thread.new do
+              while true
+                begin
+                  db = queue.deq(true)
+                rescue ThreadError
+                  db = nil
+                end
+
+                break unless db
+
+                establish_connection(db: db)
+                # no choice but to rescue, should probably log
+
+                begin
+                  blk.call(db)
+                rescue => e
+                  (errors ||= []) << e
+                end
+                ActiveRecord::Base.connection_handler.clear_active_connections!
               end
-
-              break unless db
-
-              establish_connection(db: db)
-              # no choice but to rescue, should probably log
-
-              begin
-                blk.call(db)
-              rescue => e
-                (errors ||= []) << e
-              end
-              ActiveRecord::Base.connection_handler.clear_active_connections!
             end
           end
-        end.map(&:join)
+          .map(&:join)
       else
         all_dbs.each do |db|
           establish_connection(db: db)
@@ -344,14 +270,15 @@ module RailsMultisite
       if errors && errors.length > 0
         raise StandardError, "Failed to run queries #{errors.inspect}"
       end
-
     ensure
       establish_connection(db: old)
-      ActiveRecord::Base.connection_handler.clear_active_connections! unless connected
+      unless connected
+        ActiveRecord::Base.connection_handler.clear_active_connections!
+      end
     end
 
     def all_dbs
-      [DEFAULT] + @db_spec_cache.keys.to_a
+      [DEFAULT] + db_spec_cache.keys.to_a
     end
 
     def current_db
@@ -370,9 +297,9 @@ module RailsMultisite
       request = Rack::Request.new(env)
 
       host =
-        if request['__ws'] && self.class.asset_hostnames&.include?(request.host)
+        if request["__ws"] && self.class.asset_hostnames&.include?(request.host)
           request.cookies.clear
-          request['__ws']
+          request["__ws"]
         else
           request.host
         end
@@ -381,22 +308,29 @@ module RailsMultisite
     end
 
     def connection_spec(opts)
-      if opts[:host]
-        @host_spec_cache[opts[:host]]
-      else
-        @db_spec_cache[opts[:db]]
+      opts[:host] ? @host_spec_cache[opts[:host]] : db_spec_cache[opts[:db]]
+    end
+
+    def clear_settings!
+      db_spec_cache.each do |key, spec|
+        connection_handlers.delete(handler_key(spec))
       end
     end
 
-    private
+    def default_connection_handler=(connection_handler)
+      unless connection_handler.is_a?(
+               ActiveRecord::ConnectionAdapters::ConnectionHandler
+             )
+        raise ArgumentError.new("Invalid connection handler")
+      end
 
-    def handler_establish_connection(handler, spec)
-      handler.establish_connection(spec.config)
+      @default_connection_handler = connection_handler
     end
 
+    private
+
     def handler_key(spec)
       self.class.handler_key(spec)
     end
-
   end
 end

data/lib/rails_multisite/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 #
 module RailsMultisite
-  VERSION = "4.0.1"
+  VERSION = "5.0.1"
 end

data/lib/tasks/generators.rake

@@ -3,7 +3,7 @@ desc "generate multisite config file (if missing)"
 task "multisite:generate:config" => :environment do
   filename = RailsMultisite::ConnectionManagement.config_filename
 
-  if File.exists?(filename)
+  if File.exist?(filename)
     puts "Config is already generated at #{RailsMultisite::ConnectionManagement::CONFIG_FILE}"
   else
     puts "Generated config file at #{RailsMultisite::ConnectionManagement::CONFIG_FILE}"

metadata

@@ -1,55 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: rails_multisite
 version: !ruby/object:Gem::Version
-  version: 4.0.1
+  version: 5.0.1
 platform: ruby
 authors:
 - Sam Saffron
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-13 00:00:00.000000000 Z
+date: 2024-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '6.0'
 description: Multi tenancy support for Rails
 email:
 - sam.saffron@gmail.com
@@ -61,6 +49,7 @@ files:
 - README.md
 - lib/rails_multisite.rb
 - lib/rails_multisite/connection_management.rb
+- lib/rails_multisite/connection_management/null_instance.rb
 - lib/rails_multisite/connection_management/rails_60_compat.rb
 - lib/rails_multisite/connection_management/rails_61_compat.rb
 - lib/rails_multisite/cookie_salt.rb
@@ -73,7 +62,7 @@ files:
 homepage: ''
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -81,15 +70,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.5.3
+signing_key:
 specification_version: 4
 summary: Multi tenancy support for Rails
 test_files: []