active_record_simple_execute 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a104f89547cb18fd208b3cd22043bfd185cb81109522fc90f9176ff92d341858
-  data.tar.gz: 6aa1b61f1acbabcbebc3deb7190b4fd24a1755774a9c005cc84645511b069e9e
+  metadata.gz: a2bdba6b0063a89fdb67b412435ac5f1216e9d91bae6409dbc6508e4800fc1a4
+  data.tar.gz: bc6be6a5ce0e62d0f16f3e02f8367de49729c79e9c68e7408ea2e384861bfeca
 SHA512:
-  metadata.gz: da04345171c9cd13bee15de0f766ce34ffc8c8e356949a7bd8ae35a027feae5019c09b857ea441cc8a88fff1a66fe92b4c779b4c7a8a922316eea385afda2e69
-  data.tar.gz: 5f5e6f73d5e51b377e04e5a62bb06173004f33d1a4c3fac0c88f0296b0bb25ed8a23f2b5ecaa1b05df4589b86ce9562911e6935c66fe8b9d15fb21d55d5ee4a5
+  metadata.gz: 385b6d4fbe5a37e64d6f701aa91020f94a283e8445dd40726ac9974d7089705e5f1d56ad7c87b871ab6d46ad5d3ea41815e8854223d90d2228ab0033fb96e049
+  data.tar.gz: 8a9967b9f13f356f529a8dd479abe16d06afc02d66c04ae7fec694ed93518fe1e58789504e5acf9685201742a3138cd7cdfeba34ffb21fadf5b53b81f3199e1c

data/CHANGELOG.md

@@ -1,9 +1,12 @@
 CHANGELOG
 ---------
 
-- Unreleased - [View Diff](https://github.com/westonganger/active_record_simple_execute/compare/v1.0.0...master)
+- Unreleased - [View Diff](https://github.com/westonganger/active_record_simple_execute/compare/v1.1.0...master)
   * Nothing yet
 
+- v1.1.0 - Nov 27, 2024 - [View Diff](https://github.com/westonganger/active_record_simple_execute/compare/v1.0.0...v1.1.0)
+  * [#9](https://github.com/westonganger/active_record_simple_execute/pull/9) - Automatically switch between `select_all` and `exec_query` based on if query is read or write, update readme examples with new knowledge around `Arel.sql` vs `sanitize_sql_array`
+
 - v1.0.0 - Oct 17, 2024 - [View Diff](https://github.com/westonganger/active_record_simple_execute/compare/v0.9.1...v1.0.0)
   * [#8](https://github.com/westonganger/active_record_simple_execute/pull/8) - Allow usage with different Active Record database connections
   * [#7](https://github.com/westonganger/active_record_simple_execute/pull/7) - Drop support for Rails 5.1 and below

data/README.md

@@ -6,6 +6,8 @@
 
 Sanitize and Execute your raw SQL queries in ActiveRecord and Rails with a much more intuitive and shortened syntax.
 
+This gem is in response to a lack of proper documentation of best practices within Rails - I've [created a documentation PR](https://github.com/rails/rails/pull/53719) to resolve this but until this this is merged this gem seems necessary for the eco-system.
+
 # Installation
 
 ```ruby
@@ -29,7 +31,7 @@ records = ActiveRecord::Base.connection.simple_execute(sql_str, company_id: @com
 # ActiveRecord::Base.simple_execute(...)
 ```
 
-### Using original ActiveRecord `exec_query` method
+### Using original ActiveRecord `select_all` or `exec_query` method
 ```ruby
 sql_str = <<~SQL.squish
   SELECT *
@@ -37,16 +39,24 @@ sql_str = <<~SQL.squish
   WHERE orders.company_id = :company_id AND orders.updated_by_user_id = :user_id
 SQL
 
-sanitized_sql = ActiveRecord::Base.sanitize_sql_array([sql_str, company_id: @company.id, user_id: @user.id])
+### FOR READ OPERATIONS
+sanitized_sql = Arel.sql(sql_str, company_id: @company.id, user_id: @user.id)
+result = ActiveRecord::Base.connection.select_all(sanitized_sql)
 
-result = ActiveRecord::Base.connection.exec_query(sanitized_sql)
+### OR FOR WRITE OPERATIONS (you probably shouldnt be doing this anyways)
+### (while exec_query is capable of read & write operations, recommended only for write operations as it affects the query cache)
+sanitized_sql = ActiveRecord::Base.sanitize_sql_array([sql_str, {company_id: @company.id, user_id: @user.id}]) # Must use sanitize_sql_array, since Arel.sql is not yet compatible with `exec_query`
+result = ActiveRecord::Base.connection.exec_query(sanitized_sql) # recommended only for write operations as it affects the query cache
 
-records = result.to_a
+records = result.to_a # convert the ActiveRecord::Result object into an array of hashes
 
 return records
 ```
 
 ### Using original ActiveRecord `execute` method
+
+It should be noted that it is recommended to avoid all usage of `execute` and to instead use `select_all` or `exec_query` which returns generic ActiveRecord::Result objects
+
 ```ruby
 sql_str = <<~SQL.squish
   SELECT *
@@ -54,11 +64,10 @@ sql_str = <<~SQL.squish
   WHERE orders.company_id = :company_id AND orders.updated_by_user_id = :user_id
 SQL
 
-sanitized_sql = ActiveRecord::Base.sanitize_sql_array([sql_str, company_id: @company.id, user_id: @user.id])
+# Must use sanitize_sql_array, since Arel.sql is not yet compatible with `execute`
+sanitized_sql = ActiveRecord::Base.sanitize_sql_array([sql_str, {company_id: @company.id, user_id: @user.id}])
 
 result = ActiveRecord::Base.connection.execute(sanitized_sql)
-# OR
-result = ActiveRecord::Base.connection.exec_query(sanitized_sql)
 
 if defined?(PG::Result) && result.is_a?(PG::Result)
   records = result.to_a

data/lib/active_record_simple_execute/version.rb

@@ -1,3 +1,3 @@
 module ActiveRecordSimpleExecute
-  VERSION = "1.0.0".freeze
+ VERSION = "1.1.0".freeze
 end

data/lib/active_record_simple_execute.rb

@@ -6,9 +6,21 @@ ActiveSupport.on_load(:active_record) do
 
   ActiveRecord::ConnectionAdapters::DatabaseStatements.module_eval do
     def simple_execute(sql_str, **sql_vars)
-      sanitized_sql = ActiveRecord::Base.sanitize_sql_array([sql_str, **sql_vars])
-
-      query_result = exec_query(sanitized_sql)
+      readonly = sql_str.strip.downcase.start_with?("select ")
+
+      if readonly
+        if Rails::VERSION::STRING.to_f >= 7.1
+          sanitized_sql = Arel.sql(sql_str, **sql_vars)
+        else
+          sanitized_sql = ActiveRecord::Base.sanitize_sql_array([sql_str, **sql_vars])
+        end
+        query_result = select_all(sanitized_sql)
+      else
+        # Must use sanitize_sql_array, since Arel.sql is not yet compatible with `exec_query` or `execute`, https://github.com/rails/rails/pull/53740
+
+        sanitized_sql = ActiveRecord::Base.sanitize_sql_array([sql_str, **sql_vars])
+        query_result = exec_query(sanitized_sql)
+      end
 
       records = query_result.to_a
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_record_simple_execute
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Weston Ganger
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-17 00:00:00.000000000 Z
+date: 2024-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord