activerecord-enhancedsqlite3-adapter 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 822503d22973552ab533017c76ee5e40c8687e2283c2b97f17013967a4d981ee
-  data.tar.gz: 99b0f6b59a9e3b5fb49624a0d9258056d0027c34c7cfe430d58fda8af601fa13
+  metadata.gz: 5a033cc5a2b9a6a98882029d495ce9432e617a38ec45692a2126d509f3a403c0
+  data.tar.gz: a0a2be9bbe710c2a410638cd4c5d1967bd53ca643f3fe0f9d8708375eaf9770e
 SHA512:
-  metadata.gz: e7c2b49a47f755752a71b7aa7c0e5dbeadb1fd64473c4bf56ff93f104d2c6a5f86ee1273b7f57fb20fcb3e0fdc380662f97c8f462b9a7096c2a7f57f25826141
-  data.tar.gz: b93e48d2dd251aa60495afac78364c2cbb2552d52fa8ca16bb2868468b4b0c10c1807a4ebd571a458cebb48330e96b471a955859ab5af96a04203a46e4e96718
+  metadata.gz: 73d8b3e7d72a198c3b3d8b4e3ebb05a21c23f264089b061a73c418175ad7265410852aa2bf15e963faf4139cddf9e43cba16d80a2efbf855db9bc9feaaa26bd9
+  data.tar.gz: 641c7e7278de2753d17b0c969e432c3cc41945be9d62bc639646b96a1bb20000dbe1980b545344c6eb31276f84e051c997de65a1f4bab299fcb8aa4cf71dc763

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+## [0.9.0] - 2026-10-13
+
+- On Rails 8 and later, leave the SQLite3 adapter untouched and print a deprecation warning, since Rails ships these enhancements itself; `isolate_connection_pools` still works, and on Rails 8.0 `extensions:` are still loaded ([#24](https://github.com/fractaledmind/activerecord-enhancedsqlite3-adapter/issues/24))
+- Test against Rails 7.1, 7.2, 8.0 and 8.1 in CI
+
 ## [0.8.0] - 2024-05-05
 
 - Load `sqlpkg` extensions if listed and present ([@fractaledmind](https://github.com/fractaledmind/activerecord-enhancedsqlite3-adapter/pull/17))

data/README.md

@@ -1,5 +1,22 @@
 # ActiveRecord Enhanced SQLite3 Adapter
 
+> [!IMPORTANT]
+> **You do not need this gem on Rails 8 or later.** Rails 8 ships everything below except isolated connection pools:
+>
+> | This gem | Rails |
+> |---|---|
+> | Generated columns, deferred foreign keys, `INSERT … RETURNING` | built in since 7.1 / 7.2 |
+> | `IMMEDIATE` transactions and a non-blocking busy timeout | built in since 7.2 |
+> | `pragmas:` in `config/database.yml` | built in since 8.0 |
+> | `extensions:` in `config/database.yml` | built in since 8.1 |
+>
+> From version 0.9.0, on Rails 8 the gem leaves the SQLite3 adapter untouched and prints a deprecation warning at boot. Remove it from your Gemfile. Two exceptions:
+>
+> * On Rails 8.0 the gem still loads `extensions:`, which Rails itself reads only from 8.1. Keep the gem until you upgrade if you use them.
+> * `isolate_connection_pools` still works on Rails 8, but it is experimental and will not be developed further.
+>
+> On Rails 7.1 and 7.2 the gem works as before.
+
 Enhance ActiveRecord's 7.1 SQLite3 adapter. Adds support for:
 
 * generated columns,

data/gemfiles/rails_7_1.gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec path: ".."
+
+gem "activerecord", "~> 7.1.0"
+gem "railties", "~> 7.1.0"
+gem "sqlite3", ">= 2.1"
+
+gem "rake", "~> 13.0"
+gem "minitest", "~> 5.0"
+gem "standard", "~> 1.30.0"

data/gemfiles/rails_7_2.gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec path: ".."
+
+gem "activerecord", "~> 7.2.0"
+gem "railties", "~> 7.2.0"
+gem "sqlite3", ">= 2.1"
+
+gem "rake", "~> 13.0"
+gem "minitest", "~> 5.0"
+gem "standard", "~> 1.30.0"

data/gemfiles/rails_8_0.gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec path: ".."
+
+gem "activerecord", "~> 8.0.0"
+gem "railties", "~> 8.0.0"
+gem "sqlite3", ">= 2.1"
+
+gem "rake", "~> 13.0"
+gem "minitest", "~> 5.0"
+gem "standard", "~> 1.30.0"

data/gemfiles/rails_8_1.gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec path: ".."
+
+gem "activerecord", "~> 8.1.0"
+gem "railties", "~> 8.1.0"
+gem "sqlite3", ">= 2.1"
+
+gem "rake", "~> 13.0"
+gem "minitest", "~> 5.0"
+gem "standard", "~> 1.30.0"

data/lib/activerecord-enhancedsqlite3-adapter.rb

@@ -11,5 +11,43 @@ module EnhancedSQLite3
     def isolate_connection_pools?
       @isolate_connection_pools ||= @@isolate_connection_pools || false
     end
+
+    # Rails 8 ships every enhancement except isolated connection pools and
+    # (until 8.1) `extensions:`, and this gem's adapter would replace Rails'
+    # own connection configuration.
+    def superseded?
+      ActiveRecord::VERSION::MAJOR >= 8
+    end
+
+    def reads_extensions_config?
+      ActiveRecord.version >= Gem::Version.new("8.1")
+    end
+
+    def deprecator
+      @deprecator ||= ActiveSupport::Deprecation.new("1.0", "activerecord-enhancedsqlite3-adapter")
+    end
+
+    def warn_if_superseded
+      return unless superseded?
+
+      remedy = if reads_extensions_config?
+        "Remove it from your Gemfile; Rails reads `pragmas:` and `extensions:` from config/database.yml itself."
+      else
+        "Rails reads `pragmas:` from config/database.yml itself; the gem only still loads `extensions:`, " \
+          "which Rails reads itself from 8.1. Remove the gem if you do not use them."
+      end
+      deprecator.warn(
+        "activerecord-enhancedsqlite3-adapter is not needed on Rails #{ActiveRecord::VERSION::STRING}. " \
+        "#{remedy} Only `isolate_connection_pools` is still unique to the gem."
+      )
+    end
+
+    def adapter_patches
+      patches = []
+      patches << Adapter unless superseded?
+      patches << ExtensionLoading unless reads_extensions_config?
+      patches << IsolatedConnectionPools if !superseded? || isolate_connection_pools?
+      patches
+    end
   end
 end

data/lib/enhanced_sqlite3/adapter.rb

@@ -44,30 +44,12 @@ module EnhancedSQLite3
       configure_busy_handler_timeout
       check_version
       configure_pragmas
-      configure_extensions
 
       EnhancedSQLite3::SupportsVirtualColumns.apply! unless try(:supports_virtual_columns?)
       EnhancedSQLite3::SupportsDeferrableConstraints.apply! unless try(:supports_deferrable_constraints?)
       EnhancedSQLite3::SupportsInsertReturning.apply! unless try(:supports_insert_returning?)
     end
 
-    # Patch the #transaction method to ensure that all transactions are sent to the writing role database connection pool.
-    def transaction(...)
-      ActiveRecord::Base.connected_to(role: ActiveRecord.writing_role, prevent_writes: false) do
-        super(...)
-      end
-    end
-
-    # Patch the #log method to ensure that all log messages are tagged with the database connection name.
-    def log(...)
-      db_connection_name = ActiveRecord::Base.connection_db_config.name
-      if Rails.logger.formatter.current_tags.include? db_connection_name
-        super
-      else
-        Rails.logger.tagged(db_connection_name) { super }
-      end
-    end
-
     private
 
     def configure_busy_handler_timeout
@@ -122,30 +104,5 @@ module EnhancedSQLite3
         execute("PRAGMA #{key} = #{value}", "SCHEMA")
       end
     end
-
-    def configure_extensions
-      @raw_connection.enable_load_extension(true)
-      @config.fetch(:extensions, []).each do |extension_name|
-        if extension_name.include?("/")
-          raise LoadError unless Dir.exist?(".sqlpkg/#{extension_name}")
-          Dir.glob(".sqlpkg/#{extension_name}/*.{dll,so,dylib}") do |extension_path|
-            @raw_connection.load_extension(extension_path)
-          end
-        else
-          require extension_name
-          extension_classname = extension_name.camelize
-          extension_class = extension_classname.constantize
-          extension_class.load(@raw_connection)
-        end
-      rescue LoadError
-        Dir.glob(".sqlpkg/**/*.{dll,so,dylib}") do |extension_path|
-          @raw_connection.load_extension(extension_path)
-        end
-        Rails.logger.error("Failed to find the SQLite extension gem: #{extension_name}. Skipping...")
-      rescue NameError
-        Rails.logger.error("Failed to find the SQLite extension class: #{extension_classname}. Skipping...")
-      end
-      @raw_connection.enable_load_extension(false)
-    end
   end
 end

data/lib/enhanced_sqlite3/extension_loading.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module EnhancedSQLite3
+  # Loads the `extensions:` listed in database.yml, which Rails reads itself from 8.1.
+  module ExtensionLoading
+    def configure_connection
+      super
+      configure_extensions
+    end
+
+    private
+
+    def configure_extensions
+      return if @config.fetch(:extensions, []).empty?
+
+      @raw_connection.enable_load_extension(true)
+      @config.fetch(:extensions, []).each do |extension_name|
+        if extension_name.include?("/")
+          raise LoadError unless Dir.exist?(".sqlpkg/#{extension_name}")
+          Dir.glob(".sqlpkg/#{extension_name}/*.{dll,so,dylib}") do |extension_path|
+            @raw_connection.load_extension(extension_path)
+          end
+        else
+          require extension_name
+          extension_classname = extension_name.camelize
+          extension_class = extension_classname.constantize
+          extension_class.load(@raw_connection)
+        end
+      rescue LoadError
+        Dir.glob(".sqlpkg/**/*.{dll,so,dylib}") do |extension_path|
+          @raw_connection.load_extension(extension_path)
+        end
+        Rails.logger.error("Failed to find the SQLite extension gem: #{extension_name}. Skipping...")
+      rescue NameError
+        Rails.logger.error("Failed to find the SQLite extension class: #{extension_classname}. Skipping...")
+      end
+      @raw_connection.enable_load_extension(false)
+    end
+  end
+end

data/lib/enhanced_sqlite3/isolated_connection_pools.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module EnhancedSQLite3
+  module IsolatedConnectionPools
+    # Patch the #transaction method to ensure that all transactions are sent to the writing role database connection pool.
+    def transaction(...)
+      ActiveRecord::Base.connected_to(role: ActiveRecord.writing_role, prevent_writes: false) do
+        super(...)
+      end
+    end
+
+    # Patch the #log method to ensure that all log messages are tagged with the database connection name.
+    def log(...)
+      db_connection_name = ActiveRecord::Base.connection_db_config.name
+      if Rails.logger.formatter.current_tags.include? db_connection_name
+        super
+      else
+        Rails.logger.tagged(db_connection_name) { super }
+      end
+    end
+  end
+end

data/lib/enhanced_sqlite3/railtie.rb

@@ -2,6 +2,8 @@
 
 require "rails/railtie"
 require "enhanced_sqlite3/adapter"
+require "enhanced_sqlite3/extension_loading"
+require "enhanced_sqlite3/isolated_connection_pools"
 require "enhanced_sqlite3/resolver"
 
 module EnhancedSQLite3
@@ -14,11 +16,16 @@ module EnhancedSQLite3
       end
     end
 
+    initializer "enhanced_sqlite3.deprecator" do |app|
+      app.deprecators[:enhanced_sqlite3] = EnhancedSQLite3.deprecator
+      EnhancedSQLite3.warn_if_superseded
+    end
+
     # Enhance the SQLite3 ActiveRecord adapter with optimized defaults
     initializer "enhanced_sqlite3.enhance_active_record_sqlite3adapter" do |app|
       ActiveSupport.on_load(:active_record_sqlite3adapter) do
         # self refers to `SQLite3Adapter` here
-        prepend EnhancedSQLite3::Adapter
+        EnhancedSQLite3.adapter_patches.each { |patch| prepend patch }
       end
     end
 

data/lib/enhanced_sqlite3/version.rb

@@ -1,3 +1,3 @@
 module EnhancedSQLite3
-  VERSION = "0.8.0"
+  VERSION = "0.9.0"
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-enhancedsqlite3-adapter
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Stephen Margheim
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-05 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -108,8 +107,14 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- gemfiles/rails_7_1.gemfile
+- gemfiles/rails_7_2.gemfile
+- gemfiles/rails_8_0.gemfile
+- gemfiles/rails_8_1.gemfile
 - lib/activerecord-enhancedsqlite3-adapter.rb
 - lib/enhanced_sqlite3/adapter.rb
+- lib/enhanced_sqlite3/extension_loading.rb
+- lib/enhanced_sqlite3/isolated_connection_pools.rb
 - lib/enhanced_sqlite3/railtie.rb
 - lib/enhanced_sqlite3/resolver.rb
 - lib/enhanced_sqlite3/supports_deferrable_constraints.rb
@@ -124,7 +129,6 @@ metadata:
   homepage_uri: https://github.com/fractaledmind/activerecord-enhancedsqlite3-adapter
   source_code_uri: https://github.com/fractaledmind/activerecord-enhancedsqlite3-adapter
   changelog_uri: https://github.com/fractaledmind/activerecord-enhancedsqlite3-adapter/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -139,8 +143,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.1
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
 summary: ActiveRecord adapter for SQLite that enhances the default.
 test_files: []