sql_runner 0.1.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0fe73046f6047d45f926dcc2a2dfe481698d6c27
-  data.tar.gz: fdabc17b0da986f3e0f1676dbc35d1b74ca0510c
+SHA256:
+  metadata.gz: d8ae856dccc72baadf453eab3f66fc6b375757e81d042e309de58b80a3794c22
+  data.tar.gz: bc6cdefb9735e36c972e0ae23fc062e746c6ca44f981444fb604fd9e3db388d5
 SHA512:
-  metadata.gz: 539aa4ac64c12629feb865ffde679507bc00a0951353261c42fbd4fcf547228593d2bc0675cf792c94f065ff908c9b8eb1f8239f673f883ff07d2c4789fa73aa
-  data.tar.gz: 014fa997673cd75e241ca74e667d7f3fb31b7b40acb1a044c0f983272cd7543e8b61e31bbdebb092b362ae0771c73109776d491608981a47019bec73c28059ce
+  metadata.gz: 1651fa64b28884dc534d878114bfab992f7d592b30c4b86cb518c24bfb63685795b61bb792db072ce07f7ea9495310b73196d5763b4250f3ea6d2fe7346efb3f
+  data.tar.gz: b660ace92f4e0446c8f583505a4d2da82f4854b53cdce460202d83086dd968e5a2a89af8953c484a12dfa023e12dfaa4ac68c38bb9ddb4e78f3144e27bf703bf

data/.github/FUNDING.yml

@@ -0,0 +1,3 @@
+---
+github: [fnando]
+custom: ["https://www.paypal.me/nandovieira/🍕"]

data/.gitignore

@@ -1,6 +1,6 @@
 /.bundle/
 /.yardoc
-/Gemfile.lock
+Gemfile.lock
 /_yardoc/
 /coverage/
 /doc/
@@ -8,3 +8,4 @@
 /spec/reports/
 /tmp/
 /examples/**/*.html
+*.db

data/.rubocop.yml

@@ -0,0 +1,16 @@
+---
+inherit_gem:
+  rubocop-fnando: .rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.6
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Style/OpenStructUse:
+  Exclude:
+    - test/**/*.rb

data/.travis.yml

@@ -1,13 +1,29 @@
+---
 language: ruby
 cache: bundler
 sudo: false
 rvm:
-- 2.3.1
+  - 2.7.0
+services:
+  - mysql
+addons:
+  postgresql: "10"
+  apt:
+    packages:
+    - postgresql-10
+    - postgresql-client-10
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - "./cc-test-reporter before-build"
+after_script:
+  - "./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT"
 before_install:
-- gem install bundler
-- createdb test
+  - gem install bundler
+  - createdb test
+  - mysql -e 'CREATE DATABASE IF NOT EXISTS test;'
 notifications:
   email: false
 env:
   global:
-    secure: S5CYGmnmHV6FE/P0W2H7sEJwR3jGcuW97wIzNLBSDkl1Nvmc2NAw6WynoqOGSEVafmauVjX+w+gOkF2UgJImBYwDjwGmSVcKSPj1SWuuT648pq5mJjW4kyS/lKnA8PaiqS1nMVAbGHtZjH3cEG0w0oFPilDN7nsCCzm4kztkRWtZgHhGPc/UU0EYjsGkUVq3gsYFNm09dzMxzmg9U8jdOLUM354mxP2FKqBQ795/HkEXtb5mGSKnSBWB4jdk9enmBe/M6/Vvo9X98drz4GRVdHpvy5LvWPwYSvwKNprErPcIasLxONOUXTEzA45/RSJZBLUuGlrNu7f9tA9JNbrUaVRp+vnhRpue5nNYIowPUVOnjxfE/qgx3X4k5K26pbO6wKfhdDYRK6Qh85rYNuHpd0caiEoTJJlXQp6sTo/wKQI5p9BF4b3FRG1RtCoMbjLFrQin4l0JwILoAyGyTbk50XdQvwDDlFs1lGiGxe0AK0lxX6s5yqdykaXkx5qwTSuWZqFc+9+bAEy6TNzEqBuT+r1mxIfVep8bNxynDLRg26NibGAFHzMHuqgEM4mLeOUkKnBDv1LghRJ0fzhroINJHAj5KBp145r6iJSVR7xRjKJpQptpIZ3asi5Xl37sQb98+p+1Pg4Wwzn9Y8lEyx49lml7oppDvabcbOCTy0LFuuk=
+    secure: 4dDrl8nCItKPRKpoA2KJVWsDm3o7U0pIsdY8t19pJXbziteT3zw5pEmFh+/qWGB1VszzFFZzXcZCIoKv3NX/x24g+LU+qvL7vLYLyhUR8ZjR4rGzGkwBCgEYBWgVtqg9ncYTbYsdbAqryt6f+HvpFj8EFvGSjIWVqJyh59qHdwAVT+BUKjllEH+t5Dbjd2knIQw83af+0A5ljP2uMziNcuHD7MUBIKY1DfFnBYQ5YA50o/mZe8sG5h6bZU/sf0pdoa+z2xDIJOPO7qaCwANACetDtsfs1DN39DsubvlFLg0s2z0XCuYyWSsJQ4zhRipHgnqYn+Rmpql17t0WmhVPA1xvLyk0/4X8rjRcYyYHMM3ryga5bnrpvSiPsqG+JFNhDczpN394KGa7o+/jCuNA0MVFcCzsvW2AMkYpUbPtADY7/Tl4iUJWmFbl0nO1n1wh5dDJ7Wo7mdkPAmdV7hNmMUmHbPeh8mSjMnuS2gcMc11wDgmR56TEMu/B7LUM31og7L+JouEJAOWtzThtpdYLpqDQ3Xe1G5uMl1oZ0lNOqag5Bg+AQCAIGr1N4G2m8fI74M9lUQUfhu87L+zycYMHInOH+Czc+RamlkH3vLl9Fu6aOKoXA0+zh85sVDj3Er+X2NEHaoRe4PSkOHOBNYSkAUd36TYMt8J5MgAD0w7HqmY=

data/Gemfile

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 gemspec

data/README.md

@@ -1,12 +1,13 @@
 # SQLRunner
 
-[![Travis-CI](https://travis-ci.org/fnando/sql_runner.png)](https://travis-ci.org/fnando/sql_runner)
+[![Travis-CI](https://travis-ci.org/fnando/sql_runner.svg)](https://travis-ci.org/fnando/sql_runner)
 [![Code Climate](https://codeclimate.com/github/fnando/sql_runner/badges/gpa.svg)](https://codeclimate.com/github/fnando/sql_runner)
 [![Test Coverage](https://codeclimate.com/github/fnando/sql_runner/badges/coverage.svg)](https://codeclimate.com/github/fnando/sql_runner/coverage)
 [![Gem](https://img.shields.io/gem/v/sql_runner.svg)](https://rubygems.org/gems/sql_runner)
 [![Gem](https://img.shields.io/gem/dt/sql_runner.svg)](https://rubygems.org/gems/sql_runner)
 
-SQLRunner allows you to load your queries out of SQL files, without using ORMs. Available only for PostgreSQL.
+SQLRunner allows you to load your queries out of SQL files, without using ORMs.
+Available for PostgreSQL and MySQL.
 
 ## Installation
 
@@ -76,6 +77,22 @@ class GetMembers < SQLRunner::Query
 end
 ```
 
+You can use this with ActiveRecord as well. To make it work, all you need to do
+is establishing the connection using `activerecord:///`:
+
+```ruby
+require "active_record"
+
+# You probably won't need this if you're using Rails.
+ActiveRecord::Base.establish_connection("postgresql:///database")
+
+# Set the adapter to be based on ActiveRecord.
+SQLRunner.connect "activerecord:///"
+
+SQLRunner.execute "SELECT 1"
+#=> <PG:Result:0x008adf4d5495b0>
+```
+
 ### Plugins
 
 #### Load just one record
@@ -133,7 +150,9 @@ FindUsers.call
 
 ### Adding new plugins
 
-First you have to create a class/module that implements the `.activate(target, options)` class method. The following example overrides the `call(**bind_vars)` method by using `Module.prepend`.
+First you have to create a class/module that implements the
+`.activate(target, options)` class method. The following example overrides the
+`call(**bind_vars)` method by using `Module.prepend`.
 
 ```ruby
 module ReverseRecords
@@ -145,8 +164,11 @@ module ReverseRecords
     super(**bind_vars).to_a.reverse
   end
 end
+```
 
-# Register the plugin.
+#### Register the plugin.
+
+```ruby
 SQLRunner::Query.register_plugin :reverse, ReverseRecords
 
 class Users < SQLRunner::Query
@@ -157,11 +179,17 @@ end
 Users.call
 ```
 
-If you plugin can receive options, you can call it as `plugin reverse: options`, where `options` can be anything (e.g. `Hash`, `Array`, `Object`, etc).
+If your plugin can receive options, you can call it as
+`plugin reverse: options`, where `options` can be anything (e.g. `Hash`,
+`Array`, `Object`, etc).
 
 ## Benchmarks
 
-You won't gain too much performance by using this gem. These are the results against ActiveRecord using different wrapping libraries like [virtus](https://rubygems.org/gems/virtus) and [dry-types](https://rubygems.org/gems/dry-types).
+You won't gain too much performance by using this gem. The idea is making SQL
+easier to read by extracting complex stuff to their own files. These are the
+results against ActiveRecord using different wrapping libraries like
+[virtus](https://rubygems.org/gems/virtus) and
+[dry-types](https://rubygems.org/gems/dry-types).
 
 Loading just one record:
 
@@ -183,14 +211,24 @@ activerecord - find many            :     2731.5 i/s - 2.49x slower
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake test` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/fnando/sql_runner. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/fnando/sql_runner. This project is intended to be a safe,
+welcoming space for collaboration, and contributors are expected to adhere to
+the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the
+[MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,11 +1,16 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rake/testtask"
+require "rubocop/rake_task"
 
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
   t.libs << "lib"
-  t.test_files = FileList['test/**/*_test.rb']
+  t.test_files = FileList["test/**/*_test.rb"]
   t.warning = false
 end
 
-task :default => :test
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "bundler/setup"
 require "sql_runner"

data/examples/base.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+SQLRunner.execute <<~SQL
+  create table if not exists users (
+    id serial primary key not null,
+    name text not null,
+    email text not null
+  )
+SQL
+
+class Users < SQLRunner::Query
+end
+
+module NumericModel
+  def self.new(attrs)
+    attrs.values.first.to_i
+  end
+end
+
+class Numbers < SQLRunner::Query
+  plugin model: NumericModel
+  plugin :many
+
+  query <<-SQL
+    SELECT n FROM generate_series(1, 10) n
+  SQL
+end
+
+class User
+  include Virtus.model
+
+  attribute :id, String
+  attribute :name, String
+  attribute :email, Integer
+end
+
+class Customer < User
+end
+
+class FindUser < SQLRunner::Query
+  plugins :one
+  plugin model: User
+end
+
+class FindAllUsers < SQLRunner::Query
+  plugins :many
+  plugin model: User
+end
+
+class CreateUser < SQLRunner::Query
+  plugin :one
+  plugin model: User
+end
+
+class DeleteAllUsers < SQLRunner::Query
+  plugin :many
+  plugin model: User
+end
+
+class FindCustomer < SQLRunner::Query
+  query_name "find_user"
+  plugin :one
+  plugin model: Customer
+end
+
+result = SQLRunner.execute(
+  "select application_name from pg_stat_activity where pid = pg_backend_pid();"
+)
+p [:application_name, result.to_a]
+
+result = SQLRunner.execute <<~SQL, name: "john", age: 18
+  select
+    'hello'::text as message,
+    :name::text as name,
+    :age::integer as age,
+    :name::text as name2
+SQL
+p [:select, result.to_a]
+
+p [:delete_all_users, DeleteAllUsers.call]
+p [:create_user, CreateUser.call(name: "Nando Vieira", email: "me@fnando.com")]
+p [:create_user, CreateUser.call(name: "John Doe", email: "john@example.com")]
+p [:numbers, Numbers.call]
+p [:users, Users.call.to_a]
+p [:find_user, FindUser.call(email: "me@fnando.com")]
+p [:find_user, FindUser.call(email: "' OR 1=1 --me@fnando.com")]
+p [:find_user, FindUser.call!(email: "me@fnando.com")]
+p [:find_customer, FindCustomer.call!(email: "me@fnando.com")]
+
+begin
+  FindUser.call!(email: "invalid@email")
+rescue SQLRunner::RecordNotFound => error
+  p [:find_user, error]
+end
+
+SQLRunner.disconnect

data/examples/bench.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 $LOAD_PATH.push File.expand_path("#{__dir__}/../lib")
 require "sql_runner"
 require "virtus"
@@ -13,7 +15,9 @@ SQLRunner.pool = 25
 SQLRunner.timeout = 10
 SQLRunner.root_dir = "#{__dir__}/sql"
 
-ActiveRecord::Base.establish_connection("#{connection_string}&prepared_statements=false&pool=25")
+ActiveRecord::Base.establish_connection(
+  "#{connection_string}&prepared_statements=false&pool=25"
+)
 
 module Types
   include Dry::Types.module
@@ -77,10 +81,22 @@ class Users < SQLRunner::Query
 end
 
 Benchmark.ips do |x|
-  x.report("activerecord - find one            ") { User.find_by_email("me@fnando.com") }
-  x.report("  sql_runner - find one (dry-types)") { FindUserDry.call(email: "me@fnando.com") }
-  x.report("  sql_runner - find one (virtus)   ") { FindUserVirtus.call(email: "me@fnando.com") }
-  x.report("  sql_runner - find one (raw)      ") { FindUser.call(email: "me@fnando.com") }
+  x.report("activerecord - find one") do
+    User.find_by_email("me@fnando.com")
+  end
+
+  x.report("  sql_runner - find one (dry-types)") do
+    FindUserDry.call(email: "me@fnando.com")
+  end
+
+  x.report("  sql_runner - find one (virtus)") do
+    FindUserVirtus.call(email: "me@fnando.com")
+  end
+
+  x.report("  sql_runner - find one (raw)") do
+    FindUser.call(email: "me@fnando.com")
+  end
+
   x.compare!
 end
 

data/examples/profiling.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 $LOAD_PATH.push File.expand_path("#{__dir__}/../lib")
 require "sql_runner"
 require "ruby-prof"

data/examples/test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 $LOAD_PATH.push File.expand_path("#{__dir__}/../lib")
 require "sql_runner"
 require "virtus"
@@ -7,87 +9,4 @@ SQLRunner.pool = 25
 SQLRunner.timeout = 10
 SQLRunner.root_dir = "#{__dir__}/sql"
 
-result = SQLRunner.execute "select application_name from pg_stat_activity where pid = pg_backend_pid();"
-p result.to_a
-
-result = SQLRunner.execute <<-SQL, name: "john", age: 18
-select
-  'hello'::text as message,
-  :name::text as name,
-  :age::integer as age,
-  :name::text as name2
-SQL
-p result.to_a
-
-class Users < SQLRunner::Query
-end
-
-module NumericModel
-  def self.new(attrs)
-    attrs.values.first.to_i
-  end
-end
-
-class Numbers < SQLRunner::Query
-  plugin model: NumericModel
-  plugin :many
-
-  query <<-SQL
-    SELECT n FROM generate_series(1, 10) n
-  SQL
-end
-
-class User
-  include Virtus.model
-
-  attribute :id, String
-  attribute :name, String
-  attribute :email, Integer
-end
-
-class Customer < User
-end
-
-class FindUser < SQLRunner::Query
-  plugins :one
-  plugin model: User
-end
-
-class FindAllUsers < SQLRunner::Query
-  plugins :many
-  plugin model: User
-end
-
-class CreateUser < SQLRunner::Query
-  plugin :one
-  plugin model: User
-end
-
-class DeleteAllUsers < SQLRunner::Query
-  plugin :many
-  plugin model: User
-end
-
-class FindCustomer < SQLRunner::Query
-  query_name "find_user"
-  plugin model: Customer
-  plugins :one
-end
-
-p DeleteAllUsers.call
-p CreateUser.call(name: "Nando Vieira", email: "me@fnando.com")
-p CreateUser.call(name: "John Doe", email: "john@example.com")
-p Numbers.call
-p Users.call.to_a
-p FindUser.call(email: "me@fnando.com")
-p FindUser.call(email: "' OR 1=1 --me@fnando.com")
-p FindUser.call!(email: "me@fnando.com")
-p FindCustomer.call!(email: "me@fnando.com")
-
-begin
-  FindUser.call!(email: "me@fnando.coms")
-rescue SQLRunner::RecordNotFound => error
-  p error
-end
-
-SQLRunner.disconnect
+require_relative "base"

data/examples/test_active_record.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path("#{__dir__}/../lib")
+require "sql_runner"
+require "virtus"
+require "active_record"
+
+ActiveRecord::Base.establish_connection(
+  "postgres:///test?connect_timeout=2&application_name=myapp"
+)
+
+SQLRunner.connect "activerecord:///"
+SQLRunner.pool = 25
+SQLRunner.timeout = 10
+SQLRunner.root_dir = "#{__dir__}/sql"
+
+require_relative "base"

data/lib/sql_runner/adapters/active_record.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module SQLRunner
+  module Adapters
+    class ActiveRecord
+      class PostgreSQL < SQLRunner::Adapters::PostgreSQL
+        def initialize(connection) # rubocop:disable Lint/MissingSuper
+          @connection = connection
+        end
+
+        def connect(*)
+        end
+
+        def disconnect(*)
+        end
+      end
+
+      class MySQL < SQLRunner::Adapters::MySQL
+        def initialize(connection) # rubocop:disable Lint/MissingSuper
+          @connection = connection
+        end
+
+        def connect(*)
+        end
+
+        def disconnect(*)
+        end
+      end
+
+      class SQLite < SQLRunner::Adapters::SQLite
+        def initialize(connection) # rubocop:disable Lint/MissingSuper
+          @connection = connection
+        end
+
+        def connect(*)
+        end
+
+        def disconnect(*)
+        end
+      end
+
+      class ConnectionPool
+        def with
+          ::ActiveRecord::Base.connection_pool.with_connection do |connection|
+            connection = connection.instance_variable_get(:@connection)
+
+            adapter = case connection.class.name
+                      when "PG::Connection"
+                        PostgreSQL.new(connection)
+                      when "Mysql2::Client"
+                        MySQL.new(connection)
+                      when "SQLite3::Database"
+                        SQLite.new(connection)
+                      else
+                        raise UnsupportedDatabase,
+                              "#{connection.class.name} is not yet supported " \
+                              "by the SQLRunner's ActiveRecord adapter"
+                      end
+
+            yield(adapter)
+          end
+        end
+
+        def shutdown
+        end
+      end
+
+      def self.load
+        require "active_record"
+      rescue LoadError
+        raise MissingDependency, "make sure the `activerecord` gem is available"
+      end
+
+      def self.create_connection_pool(*)
+        ConnectionPool.new
+      end
+    end
+  end
+end

data/lib/sql_runner/adapters/mysql.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+module SQLRunner
+  module Adapters
+    class MySQL
+      InvalidPreparedStatement = Class.new(StandardError)
+
+      def self.load
+        require "mysql2"
+      rescue LoadError
+        raise MissingDependency, "make sure the `mysql2` gem is available"
+      end
+
+      def self.create_connection_pool(timeout:, size:, connection_string:)
+        ConnectionPool.new(timeout: timeout, size: size) do
+          new(connection_string)
+        end
+      end
+
+      def initialize(connection_string)
+        @connection_string = connection_string
+        @uri = URI.parse(@connection_string)
+        connect
+      end
+
+      def connect(started = Process.clock_gettime(Process::CLOCK_MONOTONIC))
+        @connection = Mysql2::Client.new(
+          host: @uri.host,
+          port: @uri.port,
+          username: @uri.user,
+          password: @uri.password,
+          database: @uri.path[1..-1]
+        )
+      rescue Mysql2::Error
+        ended = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+
+        raise unless ended - started < SQLRunner.timeout
+
+        sleep 0.1
+        connect(started)
+      end
+
+      def disconnect
+        @connection&.close && (@connection = nil)
+      end
+
+      def reconnect
+        disconnect
+        connect
+      end
+
+      def execute(query, **bind_vars)
+        bound_query, bindings, names = parse(query, bind_vars)
+        validate_bindings(query, bind_vars, names)
+
+        statement = @connection.prepare(bound_query)
+        statement.execute(
+          *bindings,
+          cast: true,
+          as: :hash,
+          cast_booleans: true
+        )
+      end
+
+      def active?
+        !@connection&.closed?
+      rescue Mysql2::Error
+        false
+      end
+
+      def to_s
+        %[#<#{self.class.name} #{format('0x00%x', (object_id << 1))}>]
+      end
+
+      def inspect
+        to_s
+      end
+
+      def parse(query, bind_vars)
+        bindings = []
+        names = []
+
+        parsed_query = query.gsub(/(:?):([a-zA-Z]\w*)/) do |match|
+          next match if Regexp.last_match(1) == ":" # skip type casting
+
+          name = match[1..-1]
+          sym_name = name.to_sym
+          names << sym_name
+          bindings << bind_vars[sym_name]
+
+          "?"
+        end
+
+        [parsed_query, bindings, names]
+      end
+
+      private def validate_bindings(query, bind_vars, names)
+        names.each do |name|
+          next if bind_vars.key?(name)
+
+          raise InvalidPreparedStatement,
+                "missing value for :#{name} in #{query}"
+        end
+      end
+    end
+  end
+end