active_record_simple_execute 0.9.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0eceac39c7160f6176c6951721ab2eea654c308e6de1a5feb4ca26fd21badb9
-  data.tar.gz: 1c134afe71506b1dea030060b44f659cd351ff1ca28bdbd95736b8e53a896a22
+  metadata.gz: a2bdba6b0063a89fdb67b412435ac5f1216e9d91bae6409dbc6508e4800fc1a4
+  data.tar.gz: bc6be6a5ce0e62d0f16f3e02f8367de49729c79e9c68e7408ea2e384861bfeca
 SHA512:
-  metadata.gz: 6671f5c3f4cc84226b19c9613384ece86803854b0e4c943e31146aa34b49901a3afcd81ea24ccbc3437362ef71e54cdc9d58ab75877560e1ab5059b6b2a9f6cc
-  data.tar.gz: 2fb5d735c43a0f25a57f51bfb5db6e8d946ae8a5e109f3b3776879f2f8ffe7b4ae2e37ca72d02baf2c8def971a9a30728a0f94bed26d97475484052a82d093b7
+  metadata.gz: 385b6d4fbe5a37e64d6f701aa91020f94a283e8445dd40726ac9974d7089705e5f1d56ad7c87b871ab6d46ad5d3ea41815e8854223d90d2228ab0033fb96e049
+  data.tar.gz: 8a9967b9f13f356f529a8dd479abe16d06afc02d66c04ae7fec694ed93518fe1e58789504e5acf9685201742a3138cd7cdfeba34ffb21fadf5b53b81f3199e1c

data/CHANGELOG.md

@@ -1,11 +1,19 @@
 CHANGELOG
 ---------
 
-- Unreleased - [View Diff](https://github.com/westonganger/active_record_simple_execute/compare/v0.9.1...master)
+- Unreleased - [View Diff](https://github.com/westonganger/active_record_simple_execute/compare/v1.1.0...master)
   * Nothing yet
 
-- v0.9.1 - [View Diff](https://github.com/westonganger/active_record_simple_execute/compare/v0.9.0...v0.9.1)
-  * [#1](https://github.com/westonganger/active_sort_order/pull/1) - Utilize active_record lazy loading
+- 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
+  * [#5](https://github.com/westonganger/active_record_simple_execute/pull/5) - Switch from using Active Record `execute` method to `exec_query` method for better memory management
+
+- v0.9.1 - Feb 13, 2023 - [View Diff](https://github.com/westonganger/active_record_simple_execute/compare/v0.9.0...v0.9.1)
+  * [#1](https://github.com/westonganger/active_record_simple_execute/pull/1) - Utilize active_record lazy loading
 
 - v0.9.0 - May 20, 2021 - [View Diff](https://github.com/westonganger/active_record_simple_execute/compare/1546ce4...v0.9.0)
   * Initial Release

data/README.md

@@ -1,72 +1,112 @@
 # ActiveRecord Simple Execute
 
 <a href="https://badge.fury.io/rb/active_record_simple_execute" target="_blank"><img height="21" style='border:0px;height:21px;' border='0' src="https://badge.fury.io/rb/active_record_simple_execute.svg" alt="Gem Version"></a>
-<a href='https://github.com/westonganger/active_record_simple_execute/actions' target='_blank'><img src="https://github.com/westonganger/active_record_simple_execute/workflows/Tests/badge.svg" style="max-width:100%;" height='21' style='border:0px;height:21px;' border='0' alt="CI Status"></a>
+<a href='https://github.com/westonganger/active_record_simple_execute/actions' target='_blank'><img src="https://github.com/westonganger/active_record_simple_execute/actions/workflows/test.yml/badge.svg?branch=master" style="max-width:100%;" height='21' style='border:0px;height:21px;' border='0' alt="CI Status"></a>
 <a href='https://rubygems.org/gems/active_record_simple_execute' target='_blank'><img height='21' style='border:0px;height:21px;' src='https://img.shields.io/gem/dt/active_record_simple_execute?color=brightgreen&label=Rubygems%20Downloads' border='0' alt='RubyGems Downloads' /></a>
 
 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
-gem 'active_record_simple_execute'
+gem "active_record_simple_execute"
 ```
 
 ## Comparison with Plain ActiveRecord
 
 As seen here using `simple_execute` is much easier to remember than all the hoops plain ActiveRecord makes you jump through.
 
-### Using Simple Execute
+### Using `simple_execute`
 ```ruby
 sql_str = <<~SQL.squish
   SELECT * FROM orders
-  FROM orders 
+  FROM orders
   WHERE orders.company_id = :company_id AND orders.updated_by_user_id = :user_id
 SQL
 
-records = ActiveRecord::Base.simple_execute(sql_str, company_id: @company.id, user_id: @user.id)
+records = ActiveRecord::Base.connection.simple_execute(sql_str, company_id: @company.id, user_id: @user.id)
+# OR use the convenience method excluding the connection portion
+# ActiveRecord::Base.simple_execute(...)
+```
+
+### Using original ActiveRecord `select_all` or `exec_query` method
+```ruby
+sql_str = <<~SQL.squish
+  SELECT *
+  FROM orders
+  WHERE orders.company_id = :company_id AND orders.updated_by_user_id = :user_id
+SQL
+
+### 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)
+
+### 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 # convert the ActiveRecord::Result object into an array of hashes
+
+return records
 ```
 
-### Using Plain ActiveRecord Syntax
+### 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 * 
-  FROM orders 
+  SELECT *
+  FROM orders
   WHERE orders.company_id = :company_id AND orders.updated_by_user_id = :user_id
 SQL
 
-### must use send because this method is private is Rails 5.1 only, Public in 5.0 and 5.2
-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}])
 
-results = ActiveRecord::Base.connection.execute(sanitized_sql)
+result = ActiveRecord::Base.connection.execute(sanitized_sql)
 
-if defined?(PG::Result) && results.is_a?(PG::Result)
-  records = results.to_a
-elsif defined?(Mysql2::Result) && results.is_a?(Mysql2::Result)
+if defined?(PG::Result) && result.is_a?(PG::Result)
+  records = result.to_a
+
+  result.clear # to prevent memory leak
+
+elsif defined?(Mysql2::Result) && result.is_a?(Mysql2::Result)
   records = []
 
-  results.each do |row|
+  result.each do |row|
     h = {}
 
-    results.fields.each_with_index do |field,i|
+    result.fields.each_with_index do |field,i|
       h[field] = row[i]
     end
 
     records << h
   end
+
 else
-  records = results
+  records = result
 end
 
 return records
 ```
 
-# Contributing
+# Testing
 
-We test multiple versions of `Rails` using the `appraisal` gem. Please use the following steps to test using `appraisal`.
+```
+bundle exec rake test
+```
+
+We can locally test different versions of Rails using `ENV['RAILS_VERSION']`
 
-1. `bundle exec appraisal install`
-2. `bundle exec appraisal rake test`
+```
+export RAILS_VERSION=7.0
+bundle install
+bundle exec rake test
+```
 
 For quicker feedback during gem development or debugging feel free to use the provided `rake console` task. It is defined within the [`Rakefile`](./Rakefile).
 

data/Rakefile

@@ -10,12 +10,3 @@ Rake::TestTask.new(:test) do |t|
 end
 
 task default: [:test]
-
-task :console do
-  require 'active_record_simple_execute'
-
-  require 'test/dummy_app/app/models/post'
-
-  require 'irb'
-  binding.irb
-end

data/lib/active_record_simple_execute/version.rb

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

data/lib/active_record_simple_execute.rb

@@ -4,33 +4,34 @@ require "active_support/lazy_load_hooks"
 
 ActiveSupport.on_load(:active_record) do
 
-  ActiveRecord::Base.class_eval do
-    def self.simple_execute(sql_str, **sql_vars)
-      ### must use send because this method is private is Rails 5.1 only, Public in 5.0 and 5.2
-      sanitized_sql = ActiveRecord::Base.send(:sanitize_sql_array, [sql_str, **sql_vars])
-
-      results = ActiveRecord::Base.connection.execute(sanitized_sql)
-
-      if defined?(PG::Result) && results.is_a?(PG::Result)
-        records = results.to_a
-      elsif defined?(Mysql2::Result) && results.is_a?(Mysql2::Result)
-        records = []
-
-        results.each do |row|
-          h = {}
-
-          results.fields.each_with_index do |field,i|
-            h[field] = row[i]
-          end
-
-          records << h
+  ActiveRecord::ConnectionAdapters::DatabaseStatements.module_eval do
+    def simple_execute(sql_str, **sql_vars)
+      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
-        records = results
+        # 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
+
       return records
     end
   end
 
+  ActiveRecord::Base.class_eval do
+    def self.simple_execute(sql_str, **sql_vars)
+      self.connection.simple_execute(sql_str, **sql_vars)
+    end
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_record_simple_execute
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Weston Ganger
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-14 00:00:00.000000000 Z
+date: 2024-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -66,48 +66,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: appraisal
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: warning
   requirement: !ruby/object:Gem::Requirement
@@ -150,14 +108,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.22
 signing_key:
 specification_version: 4
 summary: Sanitize and Execute your raw SQL queries in ActiveRecord and Rails with