sql_runner 0.1.0 → 0.4.0

data/lib/sql_runner/adapters/postgresql.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SQLRunner
   module Adapters
     class PostgreSQL
@@ -6,7 +8,13 @@ module SQLRunner
       def self.load
         require "pg"
       rescue LoadError
-        fail MissingDependency, "make sure the pg gem is available"
+        raise MissingDependency, "make sure the `pg` 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)
@@ -19,16 +27,14 @@ module SQLRunner
       rescue PG::ConnectionBad
         ended = Process.clock_gettime(Process::CLOCK_MONOTONIC)
 
-        if ended - started < SQLRunner.timeout
-          sleep 0.1
-          connect(started)
-        else
-          raise
-        end
+        raise unless ended - started < SQLRunner.timeout
+
+        sleep 0.1
+        connect(started)
       end
 
       def disconnect
-        @connection && @connection.close && (@connection = nil)
+        @connection&.close && (@connection = nil)
       end
 
       def reconnect
@@ -36,14 +42,10 @@ module SQLRunner
         connect
       end
 
-      def connection
-        @connection
-      end
-
       def execute(query, **bind_vars)
-        query, bindings = parse(query)
+        bound_query, bindings = parse(query)
         args = extract_args(query, bindings, bind_vars)
-        @connection.exec_params(query, args)
+        @connection.exec_params(bound_query, args)
       rescue PG::ConnectionBad
         reconnect
         execute(query, **bind_vars)
@@ -56,7 +58,7 @@ module SQLRunner
       end
 
       def to_s
-        %[#<#{self.class.name} #{"0x00%x" % (object_id << 1)}>]
+        %[#<#{self.class.name} #{format('0x00%x', (object_id << 1))}>]
       end
 
       def inspect
@@ -68,12 +70,13 @@ module SQLRunner
         count = 0
 
         parsed_query = query.gsub(/(:?):([a-zA-Z]\w*)/) do |match|
-          next match if $1 == ":" # skip type casting
+          # skip type casting
+          next match if Regexp.last_match(1) == ":"
 
           name = match[1..-1]
           sym_name = name.to_sym
 
-          if (!index = bindings[sym_name])
+          unless (index = bindings[sym_name])
             index = (count += 1)
             bindings[sym_name] = index
           end
@@ -86,7 +89,10 @@ module SQLRunner
 
       private def extract_args(query, bindings, bind_vars)
         bindings.each_with_object([]) do |(name, position), buffer|
-          buffer[position - 1] = bind_vars.fetch(name) { fail InvalidPreparedStatement, "missing value for :#{name} in #{query}" }
+          buffer[position - 1] = bind_vars.fetch(name) do
+            raise InvalidPreparedStatement,
+                  "missing value for :#{name} in #{query}"
+          end
         end
       end
     end

data/lib/sql_runner/adapters/sqlite.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module SQLRunner
+  module Adapters
+    class SQLite
+      InvalidPreparedStatement = Class.new(StandardError)
+
+      def self.load
+        require "sqlite3"
+      rescue LoadError
+        raise MissingDependency, "make sure the `sqlite3` 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(connection_string)
+        connect
+      end
+
+      def connect
+        @connection = SQLite3::Database.new(
+          @uri.hostname || @uri.opaque,
+          results_as_hash: true
+        )
+      end
+
+      def disconnect
+        @connection&.close && (@connection = nil)
+      end
+
+      def reconnect
+        disconnect
+        connect
+      end
+
+      def execute(query, **bind_vars)
+        _, _, names = parse(query, bind_vars)
+        validate_bindings(query, bind_vars, names)
+
+        @connection.execute(query, **bind_vars)
+      end
+
+      def active?
+        !@connection&.closed?
+      rescue SQLite3::Exception
+        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

data/lib/sql_runner/adapters.rb

@@ -1,20 +1,29 @@
+# frozen_string_literal: true
+
 module SQLRunner
   UnsupportedDatabase = Class.new(StandardError)
-  MissingDependency   = Class.new(StandardError)
+  MissingDependency = Class.new(StandardError)
+
+  def self.adapter_registry
+    @adapter_registry ||= {}
+  end
 
   module Adapters
     require "sql_runner/adapters/postgresql"
-
-    ADAPTERS = {}
+    require "sql_runner/adapters/mysql"
+    require "sql_runner/adapters/sqlite"
+    require "sql_runner/adapters/active_record"
 
     def self.register(name, adapter)
-      ADAPTERS[name] = adapter
+      SQLRunner.adapter_registry[name] = adapter
     end
 
     def self.find(name)
-      ADAPTERS
-        .fetch(name) { fail UnsupportedDatabase, "#{name} is not supported by SQLRunner" }
-        .tap {|adapter| adapter.load }
+      adapter = SQLRunner.adapter_registry.fetch(name) do
+        raise UnsupportedDatabase, "#{name} is not supported by SQLRunner"
+      end
+
+      adapter.tap(&:load)
     end
   end
 end

data/lib/sql_runner/configuration.rb

@@ -1,7 +1,7 @@
+# frozen_string_literal: true
+
 module SQLRunner
   module Configuration
-    attr_accessor :root_dir
-    attr_accessor :timeout
-    attr_accessor :pool
+    attr_accessor :root_dir, :timeout, :pool
   end
 end

data/lib/sql_runner/connection.rb

@@ -1,12 +1,16 @@
+# frozen_string_literal: true
+
 module SQLRunner
   module Connection
     def self.call(connection_string)
       uri = URI.parse(connection_string)
       adapter = Adapters.find(uri.scheme)
 
-      ConnectionPool.new(timeout: SQLRunner.timeout, size: SQLRunner.pool) do
-        adapter.new(connection_string)
-      end
+      adapter.create_connection_pool(
+        timeout: SQLRunner.timeout,
+        size: SQLRunner.pool,
+        connection_string: connection_string
+      )
     end
 
     def with_connection(&block)
@@ -18,7 +22,7 @@ module SQLRunner
     end
 
     def disconnect
-      connection_pool && connection_pool.shutdown {|conn| conn.disconnect } && (@connection_pool = nil)
+      connection_pool&.shutdown(&:disconnect) && (@connection_pool = nil)
     end
 
     def connection_pool

data/lib/sql_runner/query/many.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SQLRunner
   class Query
     module Many

data/lib/sql_runner/query/model.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SQLRunner
   class Query
     module Model
@@ -13,7 +15,7 @@ module SQLRunner
       def call(**bind_vars)
         result = super(**bind_vars)
         return unless result
-        return model.new(result) if result.kind_of?(Hash)
+        return model.new(result) if result.is_a?(Hash)
 
         result.to_a.map do |attrs|
           model.new(attrs)

data/lib/sql_runner/query/one.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SQLRunner
   class Query
     module One
@@ -11,7 +13,14 @@ module SQLRunner
       end
 
       def call!(**bind_vars)
-        call(**bind_vars) or fail SQLRunner::RecordNotFound, "#{name}: record was not found with #{bind_vars.inspect} arguments"
+        result = call(**bind_vars)
+
+        return result if result
+
+        raise(
+          SQLRunner::RecordNotFound,
+          "#{name}: record was not found with #{bind_vars.inspect} arguments"
+        )
       end
     end
   end

data/lib/sql_runner/query.rb

@@ -1,12 +1,23 @@
+# frozen_string_literal: true
+
 module SQLRunner
-  RecordNotFound     = Class.new(StandardError)
-  PluginNotFound     = Class.new(StandardError)
+  RecordNotFound = Class.new(StandardError)
+  PluginNotFound = Class.new(StandardError)
   InvalidPluginOrder = Class.new(StandardError)
+  NotImplemented = Class.new(StandardError)
+
+  def self.plugin_registry
+    @plugin_registry ||= {}
+  end
 
   class Query
     extend Runner
 
-    PLUGINS = {}
+    def self.inherited(subclass)
+      super
+      subclass.instance_variable_set(:@connection_pool, @connection_pool)
+      subclass.instance_variable_set(:@root_dir, @root_dir)
+    end
 
     def self.query_name(*values)
       @query_name = values.first if values.any?
@@ -14,9 +25,13 @@ module SQLRunner
     end
 
     def self.query_name_from_class
+      replacer = proc do
+        "#{Regexp.last_match(1)}_#{Regexp.last_match(2).downcase}"
+      end
+
       name
         .gsub("::", "/")
-        .gsub(/([a-z0-9])([A-Z])/) { "#{$1}_#{$2.downcase}" }
+        .gsub(/([a-z0-9])([A-Z])/, &replacer)
         .downcase
     end
 
@@ -39,24 +54,27 @@ module SQLRunner
     end
 
     def self.register_plugin(name, mod)
-      PLUGINS[name] = mod
+      SQLRunner.plugin_registry[name] = mod
     end
 
     def self.plugin(*names)
-      plugins *names
+      plugins(*names)
     end
 
     def self.plugins(*names)
       names = prepare_plugins_with_options(names)
 
       names.each do |name, options|
-        plugin = PLUGINS.fetch(name) { fail PluginNotFound, "#{name.inspect} wasn't found" }
+        plugin = SQLRunner.plugin_registry.fetch(name) do
+          raise PluginNotFound, "#{name.inspect} wasn't found"
+        end
+
         plugin.activate(self, options)
       end
     end
 
     def self.prepare_plugins_with_options(plugins)
-      return plugins unless plugins.last.kind_of?(Hash)
+      return plugins unless plugins.last.is_a?(Hash)
 
       plugins_with_options = plugins.pop
 

data/lib/sql_runner/runner.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module SQLRunner
   module Runner
     include Connection
 
     def execute(query, **bind_vars)
-      with_connection do |conn|
-        conn.execute(query, **bind_vars)
+      with_connection do |connection|
+        connection.execute(query, **bind_vars)
       end
     end
   end

data/lib/sql_runner/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SQLRunner
-  VERSION = "0.1.0"
+  VERSION = "0.4.0"
 end

data/lib/sql_runner.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "uri"
 require "connection_pool"
 
@@ -15,13 +17,18 @@ module SQLRunner
   extend Configuration
   extend Runner
 
+  Adapters.register("activerecord", Adapters::ActiveRecord)
   Adapters.register("postgres", Adapters::PostgreSQL)
   Adapters.register("postgresql", Adapters::PostgreSQL)
+  Adapters.register("mysql", Adapters::MySQL)
+  Adapters.register("mysql2", Adapters::MySQL)
+  Adapters.register("sqlite", Adapters::SQLite)
+  Adapters.register("sqlite3", Adapters::SQLite)
 
   Query.register_plugin :one, Query::One
   Query.register_plugin :many, Query::Many
   Query.register_plugin :model, Query::Model
 
-  self.timeout = ENV.fetch("SQL_CONNECTION_TIMEOUT", 5)
-  self.pool    = ENV.fetch("SQL_CONNECTION_POOL", 5)
+  self.timeout = Integer(ENV.fetch("SQL_CONNECTION_TIMEOUT", 5))
+  self.pool = Integer(ENV.fetch("SQL_CONNECTION_POOL", 5))
 end

data/sql_runner.gemspec

@@ -1,28 +1,43 @@
+# frozen_string_literal: true
+
 require "./lib/sql_runner/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "sql_runner"
   spec.version       = SQLRunner::VERSION
   spec.authors       = ["Nando Vieira"]
-  spec.email         = ["fnando.vieira@gmail.com"]
+  spec.email         = ["me@fnando.com"]
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
+  spec.metadata = {"rubygems_mfa_required" => "true"}
+
+  spec.summary = <<~TEXT.tr("\n", " ")
+    SQLRunner allows you to load your queries out of SQL files, without using
+    ORMs.
+  TEXT
 
-  spec.summary       = "SQLRunner allows you to load your queries out of SQL files, without using ORMs. Available only for PostgreSQL."
   spec.description   = spec.summary
   spec.homepage      = "https://github.com/fnando/sql_runner"
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.files         = `git ls-files -z`
+                       .split("\x0")
+                       .reject {|f| f.match(%r{^(test|spec|features)/}) }
   spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.executables   = spec.files.grep(%r{^exe/}) {|f| File.basename(f) }
   spec.require_paths = ["lib"]
 
   spec.add_dependency "connection_pool"
 
+  spec.add_development_dependency "activerecord"
   spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake"
   spec.add_development_dependency "minitest-utils"
-  spec.add_development_dependency "pry-meta"
-  spec.add_development_dependency "pg"
   spec.add_development_dependency "mocha"
-  spec.add_development_dependency "codeclimate-test-reporter"
+  spec.add_development_dependency "mysql2"
+  spec.add_development_dependency "pg"
+  spec.add_development_dependency "pry-meta"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "rubocop-fnando"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "sqlite3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sql_runner
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Nando Vieira
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2016-06-07 00:00:00.000000000 Z
+date: 2022-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry-meta
+  name: mocha
+  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: mysql2
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +109,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: mocha
+  name: pry-meta
+  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: rake
+  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: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +151,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
+  name: rubocop-fnando
+  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: simplecov
+  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: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -123,14 +193,16 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: SQLRunner allows you to load your queries out of SQL files, without using
-  ORMs. Available only for PostgreSQL.
+  ORMs.
 email:
-- fnando.vieira@gmail.com
+- me@fnando.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/FUNDING.yml"
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -139,6 +211,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- examples/base.rb
 - examples/bench.rb
 - examples/profiling.rb
 - examples/sql/create_user.sql
@@ -146,9 +219,13 @@ files:
 - examples/sql/find_user.sql
 - examples/sql/users.sql
 - examples/test.rb
+- examples/test_active_record.rb
 - lib/sql_runner.rb
 - lib/sql_runner/adapters.rb
+- lib/sql_runner/adapters/active_record.rb
+- lib/sql_runner/adapters/mysql.rb
 - lib/sql_runner/adapters/postgresql.rb
+- lib/sql_runner/adapters/sqlite.rb
 - lib/sql_runner/configuration.rb
 - lib/sql_runner/connection.rb
 - lib/sql_runner/query.rb
@@ -161,8 +238,9 @@ files:
 homepage: https://github.com/fnando/sql_runner
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -170,17 +248,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: SQLRunner allows you to load your queries out of SQL files, without using
-  ORMs. Available only for PostgreSQL.
+  ORMs.
 test_files: []