sequel-activerecord_connection 1.2.9 → 1.2.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9cd2f9d2df2e116227a94f6a005a5f7470178e4ecfc22218fe0a3dc456a2ecd2
-  data.tar.gz: 64e96f773827d185768d6190468a350162c3e7e4923a5f5dc565d50ec8064f79
+  metadata.gz: 9b0b564099dd7cf0627c98960d7ca34a0fb1682aaa1f5262ee03de9a9bf2ad8a
+  data.tar.gz: 90b84910bae08b57fcc4e3f29deafe07e1e5fb620ae662960c0058a462bc81b2
 SHA512:
-  metadata.gz: 58862596df481839c1668ce4f3062f56255dc5115a2aa8bfb08499c10b76eac0859b51485f639c5fa16459cff170c2531b7c86c0e38efe9d5dfe6bc94a6a2891
-  data.tar.gz: 1aa33eb5cd5eb85be84252bd3ddd02ec537e7bf89481882604fc691d72d055d4bd85e6ad97562c44b39c90beabb661ba04ba1a311775b707aa71984f23dc8e25
+  metadata.gz: 58fd8e6e50e2dc25dba484c1deee60c1f20681761431c4654a3da092572f2cbfb768eb992a7d7e7eb6f03a77691289e3dd5366796c03ecfdefdbf88412bbfa29
+  data.tar.gz: c92338695de7971f16dd4adf3b518bb00f294a033df519fb1b7077c05a3d080cda443c3ac6d245214d2a07d53c7a00c12dbb914de4cda6e8bb74547c6da6541d

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 1.2.11 (2023-01-09)
+
+* Raise explicit exception in case of mismatch between Active Record and Sequel adapter (@janko)
+
+## 1.2.10 (2022-12-13)
+
+* Fix incorrect PG type mapping when using prepared statements in Sequel (@janko)
+
 ## 1.2.9 (2022-03-15)
 
 * Remove `sequel_pg` and `pg` runtime dependencies introduced in the previous version (@janko)
@@ -8,7 +16,7 @@
 
 ## 1.2.7 (2022-01-20)
 
-* Require Sequel 3.38+ (@janko)
+* Require Sequel 5.38+ (@janko)
 
 ## 1.2.6 (2021-12-26)
 

data/README.md

@@ -9,10 +9,10 @@ or if you just want to use Sequel for more complex queries, and you want to
 avoid creating new database connections.
 
 It works on ActiveRecord 4.2+ and fully supports PostgresSQL, MySQL and SQLite
-adapters, both native and JDBC (JRuby). There is attempted suppport for [Oracle
-enhanced] and [SQL Server] Active Record adapters (`oracle` and `tinytds` in
-Sequel). Other adapters might work too, but their integration hasn't been
-tested.
+adapters, both native and JDBC (JRuby). The [SQL Server] external adapter is
+supported as well (`tinytds` in Sequel), and there is attempted support for
+[Oracle enhanced] (`oracle` and in Sequel). Other adapters might work too, but
+their integration hasn't been tested.
 
 ## Why reuse the database connection?
 
@@ -38,35 +38,36 @@ background to share the same database connection, which is something Sequel
 wasn't designed for. Reusing Active Record's connection means (dis)connecting
 and sharing between threads is all handled automatically.
 
-## Installation
+## Framework Agnostic
 
-Add this line to your application's Gemfile:
+The only hard dependencies are:
 
-```rb
-gem "sequel-activerecord_connection", "~> 1.0"
-```
+* [ActiveRecord](https://github.com/rails/rails/tree/main/activerecord)
+* [Sequel](https://github.com/jeremyevans/sequel)
+* [after_commit_everywhere](https://github.com/Envek/after_commit_everywhere)
 
-And then execute:
+...which means you can use it with any Rack / Ruby based framework: 
+Rails / Roda / Sinatra etc. or even without a framework.
 
-```sh
-$ bundle install
-```
+## Installation
 
-Or install it yourself as:
+Add the gem to your project:
 
 ```sh
-$ gem install sequel-activerecord_connection
+$ bundle add sequel-activerecord_connection
 ```
 
 ## Usage
 
 Assuming you've configured your ActiveRecord connection, you can initialize the
-appropriate Sequel adapter and load the `activerecord_connection` extension:
+appropriate Sequel adapter and load the `activerecord_connection` extension: e.g.
 
 ```rb
-require "sequel"
+# Place in relevant initializer
+# e.g. Rails: config/initializers/sequel.rb
 
-DB = Sequel.postgres(extensions: :activerecord_connection)
+require "sequel"
+DB = Sequel.postgres(extensions: :activerecord_connection) # postgres
 ```
 
 Now any Sequel operations that you make will internaly be done using the
@@ -216,6 +217,35 @@ end
 DB.activerecord_model = MyModel
 ```
 
+### Normalizing SQL logs
+
+Active Record injects values into queries using bound variables, and displays
+them at the end of SQL logs:
+
+```sql
+SELECT accounts.* FROM accounts WHERE accounts.email = $1 LIMIT $2  [["email", "user@example.com"], ["LIMIT", 1]]
+```
+
+Sequel interpolates values into its queries, so by default its SQL logs include
+them inline:
+
+```sql
+SELECT accounts.* FROM accounts WHERE accounts.email = 'user@example.com' LIMIT 1
+```
+
+If you want to normalize logs to group similar queries, or you want to protect
+sensitive data from being stored in the logs, you can use the
+[sql_log_normalizer] extension to remove literal strings and numbers from
+logged SQL queries:
+
+```rb
+DB = Sequel.postgres(extensions: :activerecord_connection)
+DB.extension :sql_log_normalizer
+```
+```sql
+SELECT accounts.* FROM accounts WHERE accounts.email = ? LIMIT ?
+```
+
 ## Tests
 
 You'll first want to run the rake tasks for setting up databases and users:
@@ -238,6 +268,10 @@ $ rake db_teardown_postgres
 $ rake db_teardown_mysql
 ```
 
+## Support
+
+Please feel free to raise a new disucssion in [Github issues](https://github.com/janko/sequel-activerecord_connection/discussions), or search amongst the existing questions there.
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
@@ -252,3 +286,4 @@ Everyone interacting in this project's codebases, issue trackers, chat rooms and
 [sequel transaction hooks]: http://sequel.jeremyevans.net/rdoc/files/doc/transactions_rdoc.html#label-Transaction+Hooks
 [Oracle enhanced]: https://github.com/rsim/oracle-enhanced
 [SQL Server]: https://github.com/rails-sqlserver/activerecord-sqlserver-adapter
+[sql_log_normalizer]: https://sequel.jeremyevans.net/rdoc-plugins/files/lib/sequel/extensions/sql_log_normalizer_rb.html

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

@@ -27,6 +27,10 @@ module Sequel
           conn.query_options.replace(conn.remove_instance_variable(:@sequel_default_query_options))
         end
       end
+
+      def activerecord_connection_class
+        ::Mysql2::Client
+      end
     end
   end
 end

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

@@ -31,6 +31,18 @@ module Sequel
         raise
       end
 
+      private
+
+      def _execute(conn, *)
+        Utils.set_value(conn, :type_map_for_results, PG::TypeMapAllStrings.new) do
+          super
+        end
+      end
+
+      def activerecord_connection_class
+        ::PG::Connection
+      end
+
       # Copy-pasted from Sequel::Postgres::Adapter.
       module ConnectionMethods
         # The underlying exception classes to reraise as disconnect errors
@@ -87,9 +99,7 @@ module Sequel
         # Return the PG::Result containing the query results.
         def execute_query(sql, args)
           @db.log_connection_yield(sql, self, args) do
-            Utils.set_value(self, :type_map_for_results, PG::TypeMapAllStrings.new) do
-              args ? async_exec_params(sql, args) : async_exec(sql)
-            end
+            args ? async_exec_params(sql, args) : async_exec(sql)
           end
         end
       end

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

@@ -28,6 +28,10 @@ module Sequel
           end
         end
       end
+
+      def activerecord_connection_class
+        ::SQLite3::Database
+      end
     end
   end
 end

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

@@ -14,6 +14,12 @@ module Sequel
           end
         end
       end
+
+      private
+
+      def activerecord_connection_class
+        ::TinyTds::Client
+      end
     end
   end
 end

data/lib/sequel/extensions/activerecord_connection.rb

@@ -35,7 +35,13 @@ module Sequel
     # Avoid calling Sequel's connection pool, instead use Active Record's.
     def synchronize(*)
       activerecord_lock do
-        yield activerecord_connection.raw_connection
+        conn = activerecord_connection.raw_connection
+
+        if activerecord_connection_class && !conn.is_a?(activerecord_connection_class)
+          fail Error, "expected Active Record connection to be a #{activerecord_connection_class}, got #{conn.class}"
+        end
+
+        yield conn
       end
     end
 
@@ -151,6 +157,10 @@ module Sequel
       activerecord_model.connection
     end
 
+    def activerecord_connection_class
+      # defines in adapter modules
+    end
+
     def activerecord_log(sql, &block)
       ActiveSupport::Notifications.instrument(
         "sql.active_record",

data/sequel-activerecord_connection.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "sequel-activerecord_connection"
-  spec.version       = "1.2.9"
+  spec.version       = "1.2.11"
   spec.authors       = ["Janko Marohnić"]
   spec.email         = ["janko.marohnic@gmail.com"]
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sequel-activerecord_connection
 version: !ruby/object:Gem::Version
-  version: 1.2.9
+  version: 1.2.11
 platform: ruby
 authors:
 - Janko Marohnić
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-15 00:00:00.000000000 Z
+date: 2023-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sequel
@@ -138,7 +138,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.4.1
 signing_key:
 specification_version: 4
 summary: Allows Sequel to use ActiveRecord connection for database interaction.