sql_runner 0.3.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89e2f8d25ad8e55c06aae24d62af47733867213d933cfcf7649f17c917d6e019
-  data.tar.gz: 51ec63734cb7665e87e5a31c3c2ec02c943d6773d5ecfdd1a2d2762a761ac207
+  metadata.gz: 3224a627fbfdb75b22aff61e35fce3def752d203da72e6cfc89a80c539cfd413
+  data.tar.gz: 0b6102814d498c2fbf53b1b642f3d03b639af95514d5d1d9854d579deb79aee4
 SHA512:
-  metadata.gz: 5e3f6c4efa3b0ebaa7fb53016fe35f4a1948d228491b52e0b7648e31298d29bb96fc267416d93f11973da6c2008ef80d199c07ea62ba2861649a002a110d0f33
-  data.tar.gz: c62db307f7c62a358fd2c0113ace57b221cb800987290034d2b7c7c09aaef20454efdae92411c164a78ed2ab2560020a4cbf059a8b74fb9db945f454abfd196a
+  metadata.gz: 6a622ef1f472136f5298a3fa4c37ba3b46f3265e7538c126ad2718e950db0e24fcfd65b49dad8eee47cf7fa699ca0623cc970cebbaabc89f327092ef5998b910
+  data.tar.gz: 126036d892682c63236f01dec9152fdf8cbc66e58846e04ca2e4767a408409e1f154cf57104d8cc59b78f03310f359293856e987d1271ab4efdbd72867f97dc1

data/.github/workflows/test.yml

@@ -0,0 +1,81 @@
+---
+name: ruby-tests
+
+on:
+  pull_request_target:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+    inputs: {}
+
+jobs:
+  build:
+    name: Tests with Ruby ${{ matrix.ruby }} and ${{ matrix.gemfile }}
+    runs-on: "ubuntu-latest"
+    if: |
+      github.actor == 'dependabot[bot]' && github.event_name == 'pull_request_target' ||
+      github.actor != 'dependabot[bot]'
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ["3.0", "3.1", "3.2"]
+        gemfile:
+          - Gemfile
+
+    services:
+      postgres:
+        image: postgres
+        env:
+          POSTGRES_DB: test
+          POSTGRES_HOST_AUTH_METHOD: trust
+        options: >-
+          --health-cmd pg_isready --health-interval 10s --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 5432:5432
+      mysql:
+        image: mysql:8.0
+        env:
+          MYSQL_ROOT_PASSWORD: test
+          MYSQL_PASSWORD: test
+          MYSQL_DATABASE: test
+          MYSQL_USER: test
+        ports:
+          - 3306:3306
+        options:
+          --health-cmd="mysqladmin ping" --health-interval=10s
+          --health-timeout=5s --health-retries=3
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: actions/cache@v3
+        with:
+          path: vendor/bundle
+          key: >
+            ${{ runner.os }}-${{ matrix.ruby }}-gems-${{
+            hashFiles(matrix.gemfile) }}
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - name: Install gem dependencies
+        env:
+          BUNDLE_GEMFILE: ${{ matrix.gemfile }}
+        run: |
+          gem install bundler
+          bundle config path vendor/bundle
+          bundle update --jobs 4 --retry 3
+
+      - name: Run Tests
+        env:
+          PGHOST: localhost
+          PGUSER: postgres
+          PG_DATABASE_URL: "postgres://127.0.0.1/test?application_name=sql_runner"
+          MYSQL_DATABASE_URL: "mysql2://test:test@127.0.0.1/test?application_name=sql_runner"
+          BUNDLE_GEMFILE: ${{ matrix.gemfile }}
+        run: |
+          bundle exec rake

data/.gitignore

@@ -8,3 +8,4 @@ Gemfile.lock
 /spec/reports/
 /tmp/
 /examples/**/*.html
+*.db

data/.rubocop.yml

@@ -3,7 +3,8 @@ inherit_gem:
   rubocop-fnando: .rubocop.yml
 
 AllCops:
-  TargetRubyVersion: 2.6
+  NewCops: enable
+  TargetRubyVersion: 3.0
 
 Metrics/MethodLength:
   Enabled: false

data/CODE_OF_CONDUCT.md

@@ -12,19 +12,19 @@ body size, race, ethnicity, age, religion, or nationality.
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery
-* Personal attacks
-* Trolling or insulting/derogatory comments
-* Public or private harassment
-* Publishing other's private information, such as physical or electronic
+- The use of sexualized language or imagery
+- Personal attacks
+- Trolling or insulting/derogatory comments
+- Public or private harassment
+- Publishing other's private information, such as physical or electronic
   addresses, without explicit permission
-* Other unethical or unprofessional conduct
+- Other unethical or unprofessional conduct
 
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
+Project maintainers have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, or to ban temporarily or permanently any
+contributor for other behaviors that they deem inappropriate, threatening,
+offensive, or harmful.
 
 By adopting this Code of Conduct, project maintainers commit themselves to
 fairly and consistently applying these principles to every aspect of managing
@@ -46,4 +46,4 @@ version 1.3.0, available at
 [http://contributor-covenant.org/version/1/3/0/][version]
 
 [homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/3/0/
+[version]: http://contributor-covenant.org/version/1/3/0/

data/README.md

@@ -1,8 +1,5 @@
 # SQLRunner
 
-[![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)
 
@@ -48,7 +45,7 @@ Run SQL files:
 SQLRunner.root_dir = "#{__dir__}/sql"
 
 class GetMembers < SQLRunner::Query
-  # by default will use root_dir/get_members.sql
+  # by default will use root_dir/get_members.{sql,psql}
 end
 ```
 
@@ -72,7 +69,7 @@ Specify other options:
 
 ```ruby
 class GetMembers < SQLRunner::Query
-  query_name "users" #=> will load root_dir/users.sql
+  query_name "users" #=> will load root_dir/users.{psql,sql}
   root_dir "/some/path"
 end
 ```

data/lib/sql_runner/adapters/active_record.rb

@@ -27,6 +27,18 @@ module SQLRunner
         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|
@@ -37,8 +49,12 @@ module SQLRunner
                         PostgreSQL.new(connection)
                       when "Mysql2::Client"
                         MySQL.new(connection)
+                      when "SQLite3::Database"
+                        SQLite.new(connection)
                       else
-                        raise UnsupportedDatabase
+                        raise UnsupportedDatabase,
+                              "#{connection.class.name} is not yet supported " \
+                              "by the SQLRunner's ActiveRecord adapter"
                       end
 
             yield(adapter)

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

@@ -11,6 +11,7 @@ module SQLRunner
   module Adapters
     require "sql_runner/adapters/postgresql"
     require "sql_runner/adapters/mysql"
+    require "sql_runner/adapters/sqlite"
     require "sql_runner/adapters/active_record"
 
     def self.register(name, adapter)

data/lib/sql_runner/query.rb

@@ -37,7 +37,14 @@ module SQLRunner
 
     def self.query(*value)
       @query = value.first if value.any?
-      @query || (@query = File.read(File.join(root_dir, "#{query_name}.sql")))
+      @query || (@query = File.read(find_query_file))
+    end
+
+    def self.find_query_file
+      [
+        File.join(root_dir, "#{query_name}.psql"),
+        File.join(root_dir, "#{query_name}.sql")
+      ].find {|file| File.file?(file) }
     end
 
     def self.connection_pool

data/lib/sql_runner/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SQLRunner
-  VERSION = "0.3.0"
+  VERSION = "0.4.1"
 end

data/lib/sql_runner.rb

@@ -22,6 +22,8 @@ module SQLRunner
   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

data/sql_runner.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.version       = SQLRunner::VERSION
   spec.authors       = ["Nando Vieira"]
   spec.email         = ["me@fnando.com"]
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.0.0")
   spec.metadata = {"rubygems_mfa_required" => "true"}
 
   spec.summary = <<~TEXT.tr("\n", " ")
@@ -39,4 +39,5 @@ Gem::Specification.new do |spec|
   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.3.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Nando Vieira
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-28 00:00:00.000000000 Z
+date: 2023-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool
@@ -178,6 +178,20 @@ 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'
 description: SQLRunner allows you to load your queries out of SQL files, without using
   ORMs.
 email:
@@ -187,9 +201,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/FUNDING.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -211,6 +225,7 @@ files:
 - 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
@@ -233,14 +248,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.0.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.1
 signing_key:
 specification_version: 4
 summary: SQLRunner allows you to load your queries out of SQL files, without using

data/.travis.yml

@@ -1,29 +0,0 @@
----
-language: ruby
-cache: bundler
-sudo: false
-rvm:
-  - 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
-  - mysql -e 'CREATE DATABASE IF NOT EXISTS test;'
-notifications:
-  email: false
-env:
-  global:
-    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=