sequel-activerecord_connection 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3007b81d8906ff8ddbac1e5e5adadbc555eddacf6dbd7ef92d9062a72d3a751
-  data.tar.gz: 9e1ee7db2f4ee482abe17ee893d9f222325ec95f24e6a3ada63b1f5c10f94634
+  metadata.gz: d4078a41f54331cbb97fc266abdbe24cf8c297be14bb7f92b3bf605bf9b549bd
+  data.tar.gz: af466cd9b062279a7781106136a05151f02339830469136cdf9b58d629397b98
 SHA512:
-  metadata.gz: d73aba0aa9bd41b9a66fab9d3da6db349bf0b2ae39fb3354243146485b5b647f00c55d89887d026752dc5b007fc2504f2d69a01e86f1f712d0494277cb8b4af1
-  data.tar.gz: cfbb41ff961d3c5b83d0ab21cb90706ff5a472e666dc469fbf1f9be4dd4b6d8407b5e93f89cdc6d2778e1fc3a6c0fd99a205e51a49851af129f0455efdb0a1fa
+  metadata.gz: e28881de46188d6dc143952a473e00254b0742c497e7888e8d334ff33b627d3d90d9174675809cc3248b15cfcc800908bc83dda5a8da3fee93c4048c44282424
+  data.tar.gz: 7c0a46d18a45e76ca4a7af11d467b957035dd4b62adbdcaf64d8e9cafe1bfb406fa40c3d4feadff10c823d2535cab978111203ade32ea519f991e828ed1df033

data/CHANGELOG.md

@@ -0,0 +1,37 @@
+## 0.3.0 (2020-07-24)
+
+* Fully support Sequel transaction API (all transaction options, transaction/savepoint hooks etc.) (@janko)
+
+## 0.2.6 (2020-07-19)
+
+* Return block result in `Sequel::Database#transaction` (@zabolotnov87, @janko)
+
+* Fix `Sequel::Model#save_changes` or `#save` with additional options not executing (@zabolotnov87, @janko)
+
+## 0.2.5 (2020-06-04)
+
+* Use `#current_timestamp_utc` for the JDBC SQLite adapter as well (@HoneyryderChuck)
+
+## 0.2.4 (2020-06-03)
+
+* Add JRuby support for ActiveRecord 6.0 and 5.2 (@HoneyryderChuck)
+
+* Use `#current_timestamp_utc` setting for SQLite adapter on Sequel >= 5.33 (@HoneyryderChuck)
+
+## 0.2.3 (2020-05-25)
+
+* Fix Ruby 2.7 kwargs warnings in `#transaction` (@HoneyryderChuck)
+
+## 0.2.2 (2020-05-02)
+
+* Add support for ActiveRecord 4.2 (@janko)
+
+## 0.2.1 (2020-05-02)
+
+* Add support for Active Record 5.0, 5.1 and 5.2 (@janko)
+
+* Allow Sequel 4.x (@janko)
+
+## 0.2.0 (2020-04-29)
+
+* Rename to `sequel-activerecord_connection` and make it a Sequel extension (@janko)

data/README.md

@@ -3,7 +3,7 @@
 This is an extension for [Sequel] that allows it to reuse an existing
 ActiveRecord connection for database interaction. It works on ActiveRecord 4.2
 or higher, and supports the built-in `postgresql`, `mysql2` and `sqlite3`
-adapters.
+adapters, as well as JDBC adapter for JRuby.
 
 This can be useful if you're using a library that uses Sequel for database
 interaction (e.g. [Rodauth]), but you want to avoid creating a separate
@@ -11,15 +11,15 @@ database connection. Or if you're transitioning from ActiveRecord to Sequel,
 and want the database connection to be shared.
 
 Note that this is a best-effort implementation, so some discrepancies are still
-possible. That being said, this implementation passes [Rodauth]'s test suite
-(for all adapters), which has fairly advanced Sequel usage.
+possible. That being said, this implementation passes Rodauth's test suite
+(for all adapters), which has some fairly advanced Sequel usage.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem "sequel-activerecord_connection"
+gem "sequel-activerecord_connection", "~> 0.3"
 ```
 
 And then execute:
@@ -80,65 +80,62 @@ DB = Sequel.postgres(test: false) # for "postgresql" adapter
 DB = Sequel.mysql2(test: false) # for "mysql2" adapter
 # or
 DB = Sequel.sqlite(test: false) # for "sqlite3" adapter
+# or
+DB = Sequel.jdbc(test: false) # for JDBC adapter
 ```
 
 ### Transactions
 
-The database extension overrides Sequel transactions to use ActiveRecord
-transcations, which allows using ActiveRecord inside Sequel transactions (and
-vice-versa), and have things like ActiveRecord's transactional callbacks still
-work correctly.
+This database extension keeps the transaction state of Sequel and ActiveRecord
+in sync, allowing you to use Sequel and ActiveRecord transactions
+interchangeably (including nesting them), and have things like ActiveRecord's
+and Sequel's transactional callbacks still work correctly.
 
 ```rb
-DB.transaction do
-  ActiveRecord::Base.transaction do
-    # this all works
-  end
+ActiveRecord::Base.transaction do
+  DB.in_transaction? #=> true
 end
 ```
 
-The following Sequel transaction options are currently supported:
-
-* `:savepoint`
-* `:auto_savepoint`
-* `:rollback`
+Sequel's transaction API is fully supported:
 
 ```rb
-ActiveRecord::Base.transaction do
-  DB.transaction(savepoint: true) do # will create a savepoint
-    DB.transaction do # will not create a savepoint
-      # ...
-    end
+DB.transaction(isolation: :serializable) do
+  DB.after_commit { ... } # call block after transaction commits
+  DB.transaction(savepoint: true) do # creates a savepoint
+    # ...
   end
 end
 ```
 
-The `#in_transaction?` method is supported as well:
+One caveat to keep in mind is that Sequel's transaction hooks
+(`after_commit`, `after_rollback`) will *not* run if ActiveRecord holds the
+outer transaction:
 
 ```rb
-ActiveRecord::Base.transaction do
-  DB.in_transaction? #=> true
+DB.transaction do
+  DB.after_commit { ... } # will get executed
 end
-```
 
-Other transaction-related Sequel methods (`#after_commit`, `#after_rollback`
-etc) are not supported, because ActiveRecord currently doesn't provide
-transactional callbacks on the connection level (only on the model level).
+ActiveRecord::Base.transaction do
+  DB.after_commit { ... } # won't get executed
+end
 
-### Exceptions
+ActiveRecord::Base.transaction do
+  DB.transaction do
+    DB.after_commit { ... } # won't get executed
+  end
+end
+```
 
-To ensure Sequel compatibility, any `ActiveRecord::StatementInvalid` exceptions
-will be translated into Sequel exceptions:
+Savepoint hooks should still work, though:
 
 ```rb
-DB[:posts].multi_insert [{ id: 1 }, { id: 1 }]
-#~> Sequel::UniqueConstraintViolation
-
-DB[:posts].insert(title: nil)
-#~> Sequel::NotNullConstraintViolation
-
-DB[:posts].insert(author_id: 123)
-#~> Sequel::ForeignKeyConstraintViolation
+ActiveRecord::Base.transaction do
+  DB.transaction(savepoint: true) do
+    DB.after_commit { ... } # will get executed after savepoint is released
+  end
+end
 ```
 
 ### Model

data/lib/sequel/extensions/activerecord_connection.rb

@@ -2,6 +2,13 @@ module Sequel
   module ActiveRecordConnection
     Error = Class.new(Sequel::Error)
 
+    TRANSACTION_ISOLATION_MAP = {
+      uncommitted:  :read_uncommitted,
+      committed:    :read_committed,
+      repeatable:   :repeatable_read,
+      serializable: :serializable,
+    }
+
     def self.extended(db)
       db.activerecord_model = ActiveRecord::Base
       db.timezone = ActiveRecord::Base.default_timezone
@@ -21,52 +28,65 @@ module Sequel
       raise Error, "creating a Sequel connection is not allowed"
     end
 
-    def transaction(savepoint: nil, rollback: nil, auto_savepoint: nil, server: nil, **options)
-      fail Error, "#{options} transaction options are currently not supported" unless options.empty?
-
-      if in_transaction?
-        requires_new = savepoint || Thread.current[:sequel_activerecord_auto_savepoint]
+    # Avoid calling Sequel's connection pool, instead use ActiveRecord.
+    def synchronize(*)
+      if ActiveRecord.version >= Gem::Version.new("5.1.0")
+        activerecord_connection.lock.synchronize do
+          yield activerecord_raw_connection
+        end
       else
-        requires_new = true
+        yield activerecord_raw_connection
       end
+    end
 
-      activerecord_model.transaction(requires_new: requires_new) do
-        begin
-          Thread.current[:sequel_activerecord_auto_savepoint] = true if auto_savepoint
-          yield
-        rescue Sequel::Rollback => exception
-          raise if rollback == :reraise
-          raise ActiveRecord::Rollback, exception.message, exception.backtrace
-        ensure
-          Thread.current[:sequel_activerecord_auto_savepoint] = nil if auto_savepoint
+    private
+
+    # Backfills any ActiveRecord transactions/savepoints that have been opened
+    # directly via ActiveRecord::Base.transaction. Sequel uses this information
+    # to know whether we're in a transaction, whether to create a savepoint,
+    # when to run transaction/savepoint hooks etc.
+    def _trans(conn)
+      Sequel.synchronize do
+        result = @transactions[conn]
+
+        if activerecord_connection.transaction_open?
+          result ||= { savepoints: [] }
+          while result[:savepoints].length < activerecord_connection.open_transactions
+            result[:savepoints].unshift({ activerecord: true })
+          end
         end
 
-        raise ActiveRecord::Rollback if rollback == :always
+        @transactions[conn] = result if result
+        result
       end
     end
 
-    def in_transaction?(*)
-      activerecord_connection.transaction_open?
+    # First delete any transactions/savepoints opened directly via
+    # ActiveRecord::Base.transaction, so that Sequel can detect when the last
+    # Sequel transaction has been closed and clear transaction information.
+    def transaction_finished?(conn)
+      _trans(conn)[:savepoints].shift while _trans(conn)[:savepoints].first[:activerecord]
+      super
     end
 
-    %i[after_commit after_rollback rollback_on_exit rollback_checker].each do |meth|
-      define_method(meth) do |*|
-        fail Error, "Database##{meth} is currently not supported"
-      end
+    def begin_transaction(conn, opts = {})
+      isolation = TRANSACTION_ISOLATION_MAP.fetch(opts[:isolation]) if opts[:isolation]
+
+      activerecord_connection.begin_transaction(isolation: isolation)
     end
 
-    # Avoid calling Sequel's connection pool, instead use ActiveRecord.
-    def synchronize(*)
-      if ActiveRecord.version >= Gem::Version.new("5.1.0")
-        activerecord_connection.lock.synchronize do
-          yield activerecord_raw_connection
-        end
-      else
-        yield activerecord_raw_connection
-      end
+    def commit_transaction(conn, opts = {})
+      activerecord_connection.commit_transaction
     end
 
-    private
+    def rollback_transaction(conn, opts = {})
+      activerecord_connection.rollback_transaction
+      activerecord_connection.transaction_manager.send(:after_failure_actions, activerecord_connection.current_transaction, $!) if activerecord_connection.transaction_manager.respond_to?(:after_failure_actions)
+    end
+
+    def savepoint_level(conn)
+      activerecord_connection.open_transactions
+    end
 
     def activerecord_raw_connection
       activerecord_connection.raw_connection

data/lib/sequel/extensions/activerecord_connection/jdbc.rb

@@ -0,0 +1,38 @@
+module Sequel
+  module ActiveRecordConnection
+    module Jdbc
+      def self.extended(db)
+        if db.timezone == :utc && db.respond_to?(:current_timestamp_utc)
+          db.current_timestamp_utc = true
+        end
+      end
+
+      def statement(conn)
+        stmt = activerecord_raw_connection.connection.createStatement
+        yield stmt
+      rescue ActiveRecord::StatementInvalid => exception
+        raise_error(exception.cause, classes: database_error_classes)
+      rescue *database_error_classes => e
+        raise_error(e, classes: database_error_classes)
+      ensure
+        stmt.close if stmt
+      end
+
+      def execute(sql, opts=OPTS)
+        activerecord_connection.send(:log, sql) do
+          super
+        end
+      rescue ActiveRecord::StatementInvalid => exception
+        raise_error(exception.cause, classes: database_error_classes)
+      end
+
+      def execute_dui(sql, opts=OPTS)
+        activerecord_connection.send(:log, sql) do
+          super
+        end
+      rescue ActiveRecord::StatementInvalid => exception
+        raise_error(exception.cause, classes: database_error_classes)
+      end
+    end
+  end
+end

data/lib/sequel/extensions/activerecord_connection/postgres.rb

@@ -9,11 +9,21 @@ module Sequel
         else
           result.cmd_tuples
         end
+      rescue ActiveRecord::PreparedStatementCacheExpired
+        raise # ActiveRecord's transaction manager needs to handle this exception
       rescue ActiveRecord::StatementInvalid => exception
         raise_error(exception.cause, classes: database_error_classes)
       ensure
         result.clear if result
       end
+
+      def transaction(options = {})
+        %i[deferrable read_only synchronous].each do |key|
+          fail Error, "#{key.inspect} transaction option is currently not supported" if options.key?(key)
+        end
+
+        super
+      end
     end
   end
 end

data/lib/sequel/extensions/activerecord_connection/sqlite.rb

@@ -1,6 +1,12 @@
 module Sequel
   module ActiveRecordConnection
     module Sqlite
+      def self.extended(db)
+        if db.timezone == :utc && db.respond_to?(:current_timestamp_utc)
+          db.current_timestamp_utc = true
+        end
+      end
+
       def execute_ddl(sql, opts=OPTS)
         execute(sql, opts)
       end

data/sequel-activerecord_connection.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "sequel-activerecord_connection"
-  spec.version       = "0.2.2"
+  spec.version       = "0.3.0"
   spec.authors       = ["Janko Marohnić"]
   spec.email         = ["janko.marohnic@gmail.com"]
 
@@ -14,9 +14,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency "sequel", ">= 4.0", "< 6"
   spec.add_dependency "activerecord", ">= 4.2", "< 7"
 
-  spec.add_development_dependency "pg",      "~> 1.0"
-  spec.add_development_dependency "mysql2",  "~> 0.5"
-  spec.add_development_dependency "sqlite3", "~> 1.3"
   spec.add_development_dependency "minitest"
 
   spec.files         = Dir["README.md", "LICENSE.txt", "CHANGELOG.md", "lib/**/*.rb", "*.gemspec"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sequel-activerecord_connection
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Janko Marohnić
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-02 00:00:00.000000000 Z
+date: 2020-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sequel
@@ -50,48 +50,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '7'
-- !ruby/object:Gem::Dependency
-  name: pg
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: mysql2
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.5'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -113,9 +71,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - LICENSE.txt
 - README.md
 - lib/sequel/extensions/activerecord_connection.rb
+- lib/sequel/extensions/activerecord_connection/jdbc.rb
 - lib/sequel/extensions/activerecord_connection/mysql2.rb
 - lib/sequel/extensions/activerecord_connection/postgres.rb
 - lib/sequel/extensions/activerecord_connection/sqlite.rb