active_record_simple_execute 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 16dfd3763ff0e3d1608b6d8273f2383095e46eefb1e1b24f53a71045a0774a14
+  data.tar.gz: 4a794790debf2e983e0b3eceebb672d4425afe73eff8087bab7434ea71ed925e
+SHA512:
+  metadata.gz: 337341b7d8e9b7cd2e2dd1dc37f36ddf90eaf07032dee701eb3bbd458b9c136d597986bcb05a9906d7fdda62531704f1922be4f30f66b88bee09cc1bd50c771d
+  data.tar.gz: 85f87510db2c678cfd15536eced074212f82d2f0a592905aebb4b9aa02d5dada717a9d6cc0e9208cc76b8565987ea51bf6acf0fc6acd0f86617f47aa3a0ee3e4

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+CHANGELOG
+---------
+
+- Unreleased - [View Diff](https://github.com/westonganger/active_record_simple_execute/compare/v0.9.0...master)
+  * Nothing yet
+
+- v0.9.0 - May 20, 2021 - [View Diff](https://github.com/westonganger/active_record_simple_execute/compare/1546ce4...v0.9.0)
+  * Initial Release

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Weston Ganger
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,86 @@
+# 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>
+
+Sanitize and Execute your raw SQL queries in ActiveRecord and Rails with a much more intuitive and shortened syntax.
+
+## 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**
+```ruby
+records = ActiveRecord::Base.simple_execute(sql_str, company_id: @company.id, @user.id)
+```
+
+**Using Plain ActiveRecord Syntax**
+```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])
+
+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
+  end
+else
+  records = results
+end
+
+return records
+```
+
+# Installation
+
+```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)
+```
+
+# Contributing
+
+We test multiple versions of `Rails` using the `appraisal` gem. Please use the following steps to test using `appraisal`.
+
+1. `bundle exec appraisal install`
+2. `bundle exec appraisal 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).
+
+# Credits
+
+Created & Maintained by [Weston Ganger](https://westonganger.com) - [@westonganger](https://github.com/westonganger)

data/Rakefile

@@ -0,0 +1,21 @@
+require_relative "lib/active_record_simple_execute/version"
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+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.rb

@@ -0,0 +1,34 @@
+require "active_record_simple_execute/version"
+
+require "active_record"
+
+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
+      end
+    else
+      records = results
+    end
+
+    return records
+  end
+
+end

data/lib/active_record_simple_execute/version.rb

@@ -0,0 +1,5 @@
+module ActiveRecordSimpleExecute
+
+  VERSION = "0.9.0".freeze
+
+end

data/test/dummy_app/Rakefile

@@ -0,0 +1,7 @@
+#!/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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,14 @@
+<!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.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Dummy::Application

data/test/dummy_app/config/application.rb

@@ -0,0 +1,70 @@
+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

@@ -0,0 +1,10 @@
+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

@@ -0,0 +1,20 @@
+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

@@ -0,0 +1,5 @@
+# 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

@@ -0,0 +1,30 @@
+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

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

@@ -0,0 +1,60 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # Code is not reloaded between requests
+  config.cache_classes = true
+
+  # Full error reports are disabled and caching is turned on
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Disable Rails's static asset server (Apache or nginx will already do this)
+  config.serve_static_files = false
+
+  # Compress JavaScripts and CSS
+  config.assets.compress = true
+
+  # Don't fallback to assets pipeline if a precompiled asset is missed
+  config.assets.compile = false
+
+  # Generate digests for assets URLs
+  config.assets.digest = true
+
+  # Defaults to Rails.root.join("public/assets")
+  # config.assets.manifest = YOUR_PATH
+
+  # Specifies the header that your server uses for sending files
+  # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # See everything in the log (default is :info)
+  # config.log_level = :debug
+
+  # Use a different logger for distributed setups
+  # config.logger = SyslogLogger.new
+
+  # Use a different cache store in production
+  # config.cache_store = :mem_cache_store
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Precompile additional assets (application.js, application.css, and all non-JS/CSS are already added)
+  # config.assets.precompile += %w( search.js )
+
+  # Disable delivery errors, bad email addresses will be ignored
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable threaded mode
+  # config.threadsafe!
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation can not be found)
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners
+  config.active_support.deprecation = :notify
+end