active_record_simple_execute 0.9.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16dfd3763ff0e3d1608b6d8273f2383095e46eefb1e1b24f53a71045a0774a14
-  data.tar.gz: 4a794790debf2e983e0b3eceebb672d4425afe73eff8087bab7434ea71ed925e
+  metadata.gz: a104f89547cb18fd208b3cd22043bfd185cb81109522fc90f9176ff92d341858
+  data.tar.gz: 6aa1b61f1acbabcbebc3deb7190b4fd24a1755774a9c005cc84645511b069e9e
 SHA512:
-  metadata.gz: 337341b7d8e9b7cd2e2dd1dc37f36ddf90eaf07032dee701eb3bbd458b9c136d597986bcb05a9906d7fdda62531704f1922be4f30f66b88bee09cc1bd50c771d
-  data.tar.gz: 85f87510db2c678cfd15536eced074212f82d2f0a592905aebb4b9aa02d5dada717a9d6cc0e9208cc76b8565987ea51bf6acf0fc6acd0f86617f47aa3a0ee3e4
+  metadata.gz: da04345171c9cd13bee15de0f766ce34ffc8c8e356949a7bd8ae35a027feae5019c09b857ea441cc8a88fff1a66fe92b4c779b4c7a8a922316eea385afda2e69
+  data.tar.gz: 5f5e6f73d5e51b377e04e5a62bb06173004f33d1a4c3fac0c88f0296b0bb25ed8a23f2b5ecaa1b05df4589b86ce9562911e6935c66fe8b9d15fb21d55d5ee4a5

data/CHANGELOG.md

@@ -1,8 +1,16 @@
 CHANGELOG
 ---------
 
-- Unreleased - [View Diff](https://github.com/westonganger/active_record_simple_execute/compare/v0.9.0...master)
+- Unreleased - [View Diff](https://github.com/westonganger/active_record_simple_execute/compare/v1.0.0...master)
   * Nothing yet
 
+- 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,83 +1,103 @@
 # 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://rubygems.org/gems/active_record_simple_execute' target='_blank'><img height='21' style='border:0px;height:21px;' src='https://ruby-gem-downloads-badge.herokuapp.com/active_record_simple_execute?label=rubygems&type=total&total_label=downloads&color=brightgreen' border='0' alt='RubyGems Downloads' /></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.
 
+# Installation
+
+```ruby
+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
+  WHERE orders.company_id = :company_id AND orders.updated_by_user_id = :user_id
+SQL
+
+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 `exec_query` method
 ```ruby
-records = ActiveRecord::Base.simple_execute(sql_str, company_id: @company.id, @user.id)
+sql_str = <<~SQL.squish
+  SELECT *
+  FROM orders
+  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])
+
+result = ActiveRecord::Base.connection.exec_query(sanitized_sql)
+
+records = result.to_a
+
+return records
 ```
 
-**Using Plain ActiveRecord Syntax**
+### Using original ActiveRecord `execute` method
 ```ruby
-### 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, **sql_vars])
+sql_str = <<~SQL.squish
+  SELECT *
+  FROM orders
+  WHERE orders.company_id = :company_id AND orders.updated_by_user_id = :user_id
+SQL
 
-results = ActiveRecord::Base.connection.execute(sanitized_sql)
+sanitized_sql = ActiveRecord::Base.sanitize_sql_array([sql_str, company_id: @company.id, user_id: @user.id])
 
-if defined?(PG::Result) && results.is_a?(PG::Result)
-  records = results.to_a
-elsif defined?(Mysql2::Result) && results.is_a?(Mysql2::Result)
+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
+
+  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
 ```
 
-# Installation
+# Testing
 
-```ruby
-gem 'active_record_simple_execute'
 ```
-
-# Usage
-
-```ruby
-### Example with plain SQL String
-sql = <<~SQL.squish
-  SELECT * 
-  FROM orders 
-  WHERE orders.foo = 'bar'
-SQL
-
-results = ActiveRecord::Base.simple_execute(sql_str)
-
-### Example with ActiveRecord SQL Variables
-
-sql = <<~SQL.squish
-  SELECT * 
-  FROM orders 
-  WHERE orders.company_id = :company_id AND orders.updated_by_user_id = :user_id
-SQL
-
-results = ActiveRecord::Base.simple_execute(sql_str, company_id: @company.id, @user.id)
+bundle exec rake test
 ```
 
-# Contributing
-
-We test multiple versions of `Rails` using the `appraisal` gem. Please use the following steps to test using `appraisal`.
+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.0".freeze
-
+  VERSION = "1.0.0".freeze
 end

data/lib/active_record_simple_execute.rb

@@ -1,34 +1,25 @@
 require "active_record_simple_execute/version"
 
-require "active_record"
+require "active_support/lazy_load_hooks"
 
-ActiveRecord::Base.class_eval do
+ActiveSupport.on_load(:active_record) 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])
+  ActiveRecord::ConnectionAdapters::DatabaseStatements.module_eval do
+    def simple_execute(sql_str, **sql_vars)
+      sanitized_sql = ActiveRecord::Base.sanitize_sql_array([sql_str, **sql_vars])
 
-    results = ActiveRecord::Base.connection.execute(sanitized_sql)
+      query_result = exec_query(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 = []
+      records = query_result.to_a
 
-      results.each do |row|
-        h = {}
-
-        results.fields.each_with_index do |field,i|
-          h[field] = row[i]
-        end
-
-        records << h
-      end
-    else
-      records = results
+      return records
     end
+  end
 
-    return records
+  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.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Weston Ganger
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-20 00:00:00.000000000 Z
+date: 2024-10-17 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
@@ -136,44 +94,13 @@ files:
 - Rakefile
 - lib/active_record_simple_execute.rb
 - lib/active_record_simple_execute/version.rb
-- test/dummy_app/Rakefile
-- test/dummy_app/app/assets/config/manifest.js
-- test/dummy_app/app/assets/javascripts/application.js
-- test/dummy_app/app/assets/stylesheets/application.css
-- test/dummy_app/app/controllers/application_controller.rb
-- test/dummy_app/app/models/application_record.rb
-- test/dummy_app/app/models/post.rb
-- test/dummy_app/app/views/layouts/application.html.erb
-- test/dummy_app/config.ru
-- test/dummy_app/config/application.rb
-- test/dummy_app/config/boot.rb
-- test/dummy_app/config/database.yml
-- test/dummy_app/config/environment.rb
-- test/dummy_app/config/environments/development.rb
-- test/dummy_app/config/environments/production.rb
-- test/dummy_app/config/environments/test.rb
-- test/dummy_app/config/initializers/backtrace_silencers.rb
-- test/dummy_app/config/initializers/inflections.rb
-- test/dummy_app/config/initializers/mime_types.rb
-- test/dummy_app/config/initializers/secret_token.rb
-- test/dummy_app/config/initializers/session_store.rb
-- test/dummy_app/config/initializers/wrap_parameters.rb
-- test/dummy_app/config/locales/en.yml
-- test/dummy_app/config/routes.rb
-- test/dummy_app/config/secrets.yml
-- test/dummy_app/db/migrate/20210128155312_set_up_test_tables.rb
-- test/dummy_app/db/test
-- test/dummy_app/db/test.sqlite3
-- test/dummy_app/log/test.log
-- test/test_helper.rb
-- test/unit/active_record_simple_execute_test.rb
 homepage: https://github.com/westonganger/active_record_simple_execute
 licenses:
 - MIT
 metadata:
   source_code_uri: https://github.com/westonganger/active_record_simple_execute
   changelog_uri: https://github.com/westonganger/active_record_simple_execute/blob/master/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -181,47 +108,16 @@ 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.1.4
-signing_key: 
+rubygems_version: 3.4.22
+signing_key:
 specification_version: 4
 summary: Sanitize and Execute your raw SQL queries in ActiveRecord and Rails with
   a much more intuitive and shortened syntax.
-test_files:
-- test/unit/active_record_simple_execute_test.rb
-- test/test_helper.rb
-- test/dummy_app/app/models/application_record.rb
-- test/dummy_app/app/models/post.rb
-- test/dummy_app/app/controllers/application_controller.rb
-- test/dummy_app/app/views/layouts/application.html.erb
-- test/dummy_app/app/assets/config/manifest.js
-- test/dummy_app/app/assets/javascripts/application.js
-- test/dummy_app/app/assets/stylesheets/application.css
-- test/dummy_app/config/secrets.yml
-- test/dummy_app/config/routes.rb
-- test/dummy_app/config/locales/en.yml
-- test/dummy_app/config/environments/production.rb
-- test/dummy_app/config/environments/development.rb
-- test/dummy_app/config/environments/test.rb
-- test/dummy_app/config/environment.rb
-- test/dummy_app/config/application.rb
-- test/dummy_app/config/database.yml
-- test/dummy_app/config/boot.rb
-- test/dummy_app/config/initializers/backtrace_silencers.rb
-- test/dummy_app/config/initializers/mime_types.rb
-- test/dummy_app/config/initializers/session_store.rb
-- test/dummy_app/config/initializers/wrap_parameters.rb
-- test/dummy_app/config/initializers/secret_token.rb
-- test/dummy_app/config/initializers/inflections.rb
-- test/dummy_app/config.ru
-- test/dummy_app/Rakefile
-- test/dummy_app/db/test
-- test/dummy_app/db/test.sqlite3
-- test/dummy_app/db/migrate/20210128155312_set_up_test_tables.rb
-- test/dummy_app/log/test.log
+test_files: []

data/test/dummy_app/Rakefile

@@ -1,7 +0,0 @@
-#!/usr/bin/env rake
-# Add your own tasks in files placed in lib/tasks ending in .rake,
-# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
-
-require File.expand_path('../config/application', __FILE__)
-
-Dummy::Application.load_tasks

data/test/dummy_app/app/assets/config/manifest.js

@@ -1,3 +0,0 @@
-//= link_tree ../images
-//= link_directory ../javascripts .js
-//= link_directory ../stylesheets .css .scss

data/test/dummy_app/app/assets/stylesheets/application.css

@@ -1,3 +0,0 @@
-/*
- *= require_self
-*/

data/test/dummy_app/app/controllers/application_controller.rb

@@ -1,3 +0,0 @@
-class ApplicationController < ActionController::Base
-  protect_from_forgery
-end

data/test/dummy_app/app/models/application_record.rb

@@ -1,3 +0,0 @@
-class ApplicationRecord < ActiveRecord::Base
-  self.abstract_class = true
-end

data/test/dummy_app/app/models/post.rb

@@ -1,3 +0,0 @@
-class Post < ApplicationRecord
-
-end

data/test/dummy_app/app/views/layouts/application.html.erb

@@ -1,14 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-  <title>Dummy App</title>
-  <%= stylesheet_link_tag    "application" %>
-  <%= javascript_include_tag "application" %>
-  <%= csrf_meta_tags %>
-</head>
-<body>
-
-<%= yield %>
-
-</body>
-</html>

data/test/dummy_app/config/application.rb

@@ -1,70 +0,0 @@
-require File.expand_path('../boot', __FILE__)
-
-begin
-  require 'warning'
-  Warning.ignore(
-    %r{mail/parsers/address_lists_parser}, ### Hide mail gem warnings
-  )
-rescue LoadError
-  # Do nothing
-end
-
-require 'rails/all'
-
-Bundler.require
-
-module Dummy
-  class Application < Rails::Application
-    # Settings in config/environments/* take precedence over those specified here.
-    # Application configuration should go into files in config/initializers
-    # -- all .rb files in that directory are automatically loaded.
-
-    # Custom directories with classes and modules you want to be autoloadable.
-    # config.autoload_paths += %W(#{config.root}/extras)
-
-    # Only load the plugins named here, in the order given (default is alphabetical).
-    # :all can be used as a placeholder for all plugins not explicitly named.
-    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
-
-    # Activate observers that should always be running.
-    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
-
-    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
-    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
-    # config.time_zone = 'Central Time (US & Canada)'
-
-    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
-    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
-    # config.i18n.default_locale = :de
-
-    # Configure the default encoding used in templates for Ruby 1.9.
-    config.encoding = "utf-8"
-
-    # Configure sensitive parameters which will be filtered from the log file.
-    config.filter_parameters += [:password]
-
-    # Enable the asset pipeline
-    config.assets.enabled = true
-
-    config.assets.quiet = true
-
-    # Version of your assets, change this if you want to expire all your assets
-    config.assets.version = '1.0'
-
-    config.generators.test_framework = false
-    config.generators.helper = false
-    config.generators.stylesheets = false
-    config.generators.javascripts = false
-
-    config.after_initialize do
-      ActiveRecord::Migration.migrate(Rails.root.join("db/migrate/*").to_s)
-    end
-
-    if ActiveRecord.respond_to?(:gem_version)
-      gem_version = ActiveRecord.gem_version
-      if gem_version.to_s.start_with?("5.2.")
-        config.active_record.sqlite3.represent_boolean_as_integer = true
-      end
-    end
-  end
-end

data/test/dummy_app/config/boot.rb

@@ -1,10 +0,0 @@
-require 'rubygems'
-gemfile = File.expand_path('../../../../Gemfile', __FILE__)
-
-if File.exist?(gemfile)
-  ENV['BUNDLE_GEMFILE'] = gemfile
-  require 'bundler'
-  Bundler.setup
-end
-
-$:.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy_app/config/database.yml

@@ -1,20 +0,0 @@
-default: &default
-<% if defined?(SQLite3) %>
-  adapter: sqlite3
-  database: db/test.sqlite3
-
-<% elsif defined?(Mysql2) %>
-  adapter: mysql2
-  database: active_record_simple_execute_test
-
-<% elsif defined?(PG) %>
-  adapter: postgresql
-  database: active_record_simple_execute_test
-
-<% end %>
-
-development:
-  <<: *default
-
-test:
-  <<: *default

data/test/dummy_app/config/environment.rb

@@ -1,5 +0,0 @@
-# Load the rails application
-require File.expand_path('../application', __FILE__)
-
-# Initialize the rails application
-Dummy::Application.initialize!

data/test/dummy_app/config/environments/development.rb

@@ -1,30 +0,0 @@
-Dummy::Application.configure do
-  # Settings specified here will take precedence over those in config/application.rb
-
-  # In the development environment your application's code is reloaded on
-  # every request.  This slows down response time but is perfect for development
-  # since you don't have to restart the web server when you make code changes.
-  config.cache_classes = false
-
-  # Log error messages when you accidentally call methods on nil.
-  config.whiny_nils = true
-
-  # Show full error reports and disable caching
-  config.consider_all_requests_local       = true
-  config.action_controller.perform_caching = false
-
-  # Don't care if the mailer can't send
-  config.action_mailer.raise_delivery_errors = false
-
-  # Print deprecation notices to the Rails logger
-  config.active_support.deprecation = :log
-
-  # Only use best-standards-support built into browsers
-  config.action_dispatch.best_standards_support = :builtin
-
-  # Do not compress assets
-  config.assets.compress = false
-
-  # Expands the lines which load the assets
-  config.assets.debug = true
-end