mini_sql 1.1.3 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d46350915a655a1692de9b775f879609f83ff068bf9b62be6498672b223ee03
-  data.tar.gz: 192596f2834a676f123afcfb969a32267b311fe20318527ae13b92dd95efc757
+  metadata.gz: bbfef3c29b94c4d0bdbb461b52419644f3b042236f58837a6247a84546034e26
+  data.tar.gz: 52b175f5f3c712f891f61fe47618584c4279e0bd9f4a0496fb545bd3574eb8ba
 SHA512:
-  metadata.gz: 9820695fc27ced3ce61b2a131201c6bb954eca9919cd49f29f2877ebccbbd33ef8e36b4a0284d0a04fde9ec92c1f33bbfe75780515cdec26bdf9493e676b631d
-  data.tar.gz: d2ba6adbdf07a1a3fb11192ad949c8f632035a357d792eb895350ee3af30f7977d6b8e64d5df59b1338e9349d213e4472099593c6296e39203fac7ee8147da7d
+  metadata.gz: 00a003b8bdc6bdf623ad10d3702b3851b0c5bdbc5c1d82c76aa40c5dd797ef11d4bcb153d85cf323d451403d87fb90d0b12c43da3df84a5c49aa84b1d8c8c570
+  data.tar.gz: 11fd1b56b47b9ef11d452e1c8eca322ec35ac054a78195fe30bfbeacd1858e67092cc96248f724cab0c9d4b795b0bcdd8e75a3c678bce8ba9787973f47f33439

data/.github/workflows/ci.yml

@@ -4,7 +4,7 @@ on:
   pull_request:
   push:
     branches:
-      - master
+      - main
 
 env:
   PGHOST: localhost
@@ -34,12 +34,14 @@ jobs:
           - 3306:3306
         options: --health-cmd="mysqladmin ping" --health-interval=10s --health-timeout=5s --health-retries=3
     strategy:
+      fail-fast: false
       matrix:
-        ruby: ["2.7", "2.6", "2.5"]
+        ruby: ["3.1", "3.0", "2.7"]
         experimental: [false]
         include:
           - ruby: ruby-head
             experimental: true
+    continue-on-error: ${{matrix.experimental}}
     steps:
       - uses: actions/checkout@v2
       - uses: ruby/setup-ruby@v1
@@ -64,3 +66,18 @@ jobs:
         run: bundle exec rake test
       - name: Rubocop
         run: bundle exec rubocop
+
+  publish:
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+    needs: build
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Release Gem
+        uses: discourse/publish-rubygems-action@v2
+        env:
+          RUBYGEMS_API_KEY: ${{ secrets.RUBYGEMS_API_KEY }}
+          GIT_EMAIL: team@discourse.org
+          GIT_NAME: discoursebot

data/.rubocop.yml

@@ -3,6 +3,8 @@ inherit_gem:
 inherit_mode:
   merge:
     - Exclude
+Security/MarshalLoad:
+  Enabled: false
 AllCops:
   Exclude:
     - 'bench/**/*'

data/CHANGELOG

@@ -1,3 +1,18 @@
+2022-03-07 - 1.4.0
+
+- PERF: Optimize multiple use param in prepared postgres sql
+
+2022-02-02 - 1.3.0
+
+- FEATURE: Add ActiveRecordPostgres connection
+  This is almost identical to the Postgres connection, but will acquire ActiveRecord's connection lock for each query
+
+2022-01-31 - 1.2.0
+
+- Ruby 2.6 is EOL support removed
+- FIX: when multiple params shared a prefix inline encoder may work in unexpected ways
+- FEATURE: add sql_literal for injecting sql in sql builder
+
 2021-03-22 - 1.1.3
 
 - DEV: reduce coupling of internal interfaces and allow or cleaner override of prepared connections

data/README.md

@@ -77,7 +77,46 @@ builder.query.each do |t|
 end
 ```
 
-The builder allows for `order_by`, `where`, `select`, `set`, `limit`, `join`, `left_join` and `offset`.
+The builder predefined next _SQL Literals_
+
+| Method | SQL Literal |
+| ------ | ----------- |
+|`select`    |`/*select*/`|
+|`where`     |`/*where*/`|
+|`where2`    |`/*where2*/`|
+|`join`      |`/*join*/`|
+|`left_join` |`/*left_join*/`|
+|`group_by`  |`/*group_by*/`|
+|`order_by`  |`/*order_by*/`|
+|`limit`     |`/*limit*/`|
+|`offset`    |`/*offset*/`|
+|`set`       |`/*set*/`|
+
+### Custom SQL Literals
+Use `sql_literal` for injecting custom sql into Builder
+
+```ruby
+user_builder = conn
+  .build("select date_trunc('day', created_at) day, count(*) from user_topics /*where*/")
+  .where('type = ?', input_type)
+  .group_by("date_trunc('day', created_at)")
+
+guest_builder = conn
+  .build("select date_trunc('day', created_at) day, count(*) from guest_topics /*where*/")
+  .where('state = ?', input_state)
+  .group_by("date_trunc('day', created_at)")
+
+conn
+  .build(<<~SQL)
+     with as (/*user*/) u, (/*guest*/) as g
+     select COALESCE(g.day, u.day), g.count, u.count
+     from u
+     /*custom_join*/
+  SQL
+  .sql_literal(user: user_builder, guest: guest_builder) # builder
+  .sql_literal(custom_join: "#{input_cond ? 'FULL' : 'LEFT'} JOIN g on g.day = u.day") # or string
+  .query
+```
 
 ## Is it fast?
 Yes, it is very fast. See benchmarks in [the bench directory](https://github.com/discourse/mini_sql/tree/master/bench).
@@ -202,6 +241,17 @@ builder.where("id IN (?)", ids)
 builder.prepared(ids.size == 1).query # most frequent query
 ```
 
+## Active Record Postgres
+
+When using alongside ActiveRecord, passing in the ActiveRecord connection rather than the raw Postgres connection will allow mini_sql to lock the connection, thereby preventing concurrent use in other threads.
+
+```ruby
+ar_conn = ActiveRecord::Base.connection
+conn = MiniSql::Connection.get(ar_conn)
+
+conn.query("select * from topics")
+```
+
 ## I want more features!
 
 MiniSql is designed to be very minimal. Even though the query builder and type materializer give you a lot of mileage, it is not intended to be a fully fledged ORM. If you are looking for an ORM I recommend investigating ActiveRecord or Sequel which provide significantly more features.

data/lib/mini_sql/active_record_postgres/connection.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module MiniSql
+  module ActiveRecordPostgres
+    class Connection < ::MiniSql::Postgres::Connection
+      attr_reader :active_record_connection
+
+      # Initialize a new MiniSql::Postgres::Connection object
+      #
+      # @param active_record_adapter [ActiveRecord::ConnectionAdapters::PostgresqlAdapter]
+      # @param deserializer_cache [MiniSql::DeserializerCache] a cache of field names to deserializer, can be nil
+      # @param type_map [PG::TypeMap] a type mapper for all results returned, can be nil
+      def initialize(active_record_adapter, args = nil)
+        @active_record_connection = active_record_adapter
+        super(nil, args)
+      end
+
+      def raw_connection
+        active_record_connection.raw_connection
+      end
+
+      # These two methods do not use `run`, so we need to apply
+      # the lock separately:
+      def query_each(sql, *params)
+        with_lock { super }
+      end
+      def query_each_hash(sql, *params)
+        with_lock { super }
+      end
+
+      private
+
+      def with_lock
+        active_record_connection.lock.synchronize { yield }
+      end
+
+      def run(sql, params)
+        with_lock { super }
+      end
+    end
+  end
+end

data/lib/mini_sql/builder.rb

@@ -11,32 +11,46 @@ class MiniSql::Builder
     @is_prepared = false
   end
 
-  [:set, :where2, :where, :order_by, :left_join, :join, :select, :group_by].each do |k|
-    define_method k do |sql_part, *args|
-      if Hash === args[0]
-        @args.merge!(args[0])
-      else # convert simple params to hash
-        args.each do |v|
-          # for compatability with AR param encoded we keep a non _
-          # prefix (must be [a-z])
-          param = "mq_auto_#{@count_variables += 1}"
-          sql_part = sql_part.sub('?', ":#{param}")
-          @args[param.to_sym] = v
+  literals1 =
+    [:set, :where2, :where, :order_by, :left_join, :join, :select, :group_by].each do |k|
+      define_method k do |sql_part, *args|
+        if Hash === args[0]
+          @args.merge!(args[0])
+        else # convert simple params to hash
+          args.each do |v|
+            # for compatability with AR param encoded we keep a non _
+            # prefix (must be [a-z])
+            param = "mq_auto_#{@count_variables += 1}"
+            sql_part = sql_part.sub('?', ":#{param}")
+            @args[param.to_sym] = v
+          end
         end
+
+        @sections[k] ||= []
+        @sections[k] << sql_part
+        self
       end
+    end
 
-      @sections[k] ||= []
-      @sections[k] << sql_part
-      self
+  literals2 =
+    [:limit, :offset].each do |k|
+      define_method k do |value|
+        @args["mq_auto_#{k}".to_sym] = value
+        @sections[k] = true
+        self
+      end
     end
-  end
 
-  [:limit, :offset].each do |k|
-    define_method k do |value|
-      @args["mq_auto_#{k}".to_sym] = value
-      @sections[k] = true
-      self
+  PREDEFINED_SQL_LITERALS = (literals1 | literals2).to_set
+
+  def sql_literal(literals)
+    literals.each do |name, part_sql|
+      if PREDEFINED_SQL_LITERALS.include?(name)
+        raise "/*#{name}*/ is predefined, use method `.#{name}` instead `sql_literal`"
+      end
+      @sections[name] = part_sql.is_a?(::MiniSql::Builder) ? part_sql.to_sql : part_sql
     end
+    self
   end
 
   [:query, :query_single, :query_hash, :query_array, :exec].each do |m|
@@ -93,9 +107,13 @@ class MiniSql::Builder
         joined = (+"GROUP BY ") << v.join(" , ")
       when :set
         joined = (+"SET ") << v.join(" , ")
+      else # for sql_literal
+        joined = v
       end
 
-      sql.sub!("/*#{k}*/", joined)
+      unless sql.sub!("/*#{k}*/", joined)
+        raise "The section for the /*#{k}*/ clause was not found!"
+      end
     end
 
     sql

data/lib/mini_sql/connection.rb

@@ -6,6 +6,8 @@ module MiniSql
     def self.get(raw_connection, options = {})
       if (defined? ::PG::Connection) && (PG::Connection === raw_connection)
         Postgres::Connection.new(raw_connection, options)
+      elsif (defined? ActiveRecord::ConnectionAdapters::PostgreSQLAdapter) && (ActiveRecord::ConnectionAdapters::PostgreSQLAdapter === raw_connection)
+        ActiveRecordPostgres::Connection.new(raw_connection, options)
       elsif (defined? ::ArJdbc)
         Postgres::Connection.new(raw_connection, options)
       elsif (defined? ::SQLite3::Database) && (SQLite3::Database === raw_connection)

data/lib/mini_sql/inline_param_encoder.rb

@@ -20,7 +20,11 @@ module MiniSql
     def encode_hash(sql, hash)
       sql = sql.dup
 
-      hash.each do |k, v|
+      # longest key first for gsub to work
+      # in an expected way
+      hash.sort do |(k, _), (k1, _)|
+        k1.to_s.length <=> k.to_s.length
+      end.each do |k, v|
         sql.gsub!(":#{k}") do
           # ignore ::int and stuff like that
           # $` is previous to match
@@ -58,10 +62,7 @@ module MiniSql
       when false      then "false"
       when nil        then "NULL"
       when []         then "NULL"
-      when Array
-        value.map do |v|
-          quote_val(v)
-        end.join(', ')
+      when Array      then value.map { |v| quote_val(v) }.join(', ')
       else raise TypeError, "can't quote #{value.class.name}"
       end
     end

data/lib/mini_sql/postgres/prepared_binds.rb

@@ -6,6 +6,33 @@ module MiniSql
   module Postgres
     class PreparedBinds < ::MiniSql::Abstract::PreparedBinds
 
+      def bind_hash(sql, hash)
+        sql = sql.dup
+        binds = []
+        bind_names = []
+        i = 0
+
+        hash.each do |k, v|
+          bind_outputs =
+            array_wrap(v).map { |vv|
+              binds << vv
+              bind_names << [BindName.new(k)]
+              bind_output(i += 1)
+            }.join(', ')
+
+          sql.gsub!(":#{k}") do
+            # ignore ::int and stuff like that
+            # $` is previous to match
+            if $` && $`[-1] != ":"
+              bind_outputs
+            else
+              ":#{k}"
+            end
+          end
+        end
+        [sql, binds, bind_names]
+      end
+
       def bind_output(i)
         "$#{i}"
       end

data/lib/mini_sql/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module MiniSql
-  VERSION = "1.1.3"
+  VERSION = "1.4.0"
 end

data/lib/mini_sql.rb

@@ -3,6 +3,9 @@
 # we need this for a coder
 require "bigdecimal"
 
+# used for builder
+require "set"
+
 require_relative "mini_sql/version"
 require_relative "mini_sql/connection"
 require_relative "mini_sql/deserializer_cache"
@@ -28,6 +31,10 @@ module MiniSql
       autoload :PreparedBinds,      "mini_sql/postgres/prepared_binds"
     end
 
+    module ActiveRecordPostgres
+      autoload :Connection, "mini_sql/active_record_postgres/connection"
+    end
+
     module Sqlite
       autoload :Connection,         "mini_sql/sqlite/connection"
       autoload :DeserializerCache,  "mini_sql/sqlite/deserializer_cache"

data/mini_sql.gemspec

@@ -35,12 +35,12 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "> 1.16"
   spec.add_development_dependency "rake", "> 10"
   spec.add_development_dependency "minitest", "~> 5.0"
-  spec.add_development_dependency "guard", "~> 2.14"
+  spec.add_development_dependency "guard", "~> 2.18"
   spec.add_development_dependency "guard-minitest", "~> 2.4"
-  spec.add_development_dependency "activesupport", "~> 5.2"
-  spec.add_development_dependency 'rubocop', '~> 1.4.0'
-  spec.add_development_dependency 'rubocop-discourse', '~> 2.4.1'
-  spec.add_development_dependency 'm', '~> 1.5.1'
+  spec.add_development_dependency "activesupport", "~> 7.0"
+  spec.add_development_dependency 'rubocop', '~> 1.25.0'
+  spec.add_development_dependency 'rubocop-discourse', '~> 2.5.0'
+  spec.add_development_dependency 'm', '~> 1.6.0'
 
   if RUBY_ENGINE == 'jruby'
     spec.add_development_dependency "activerecord-jdbcpostgresql-adapter", "~> 52.2"
@@ -48,5 +48,6 @@ Gem::Specification.new do |spec|
     spec.add_development_dependency "pg", "> 1"
     spec.add_development_dependency "mysql2"
     spec.add_development_dependency "sqlite3", "~> 1.3"
+    spec.add_development_dependency "activerecord", "~> 7.0.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mini_sql
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.4.0
 platform: ruby
 authors:
 - Sam Saffron
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-23 00:00:00.000000000 Z
+date: 2022-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '2.18'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '2.18'
 - !ruby/object:Gem::Dependency
   name: guard-minitest
   requirement: !ruby/object:Gem::Requirement
@@ -86,56 +86,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '7.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: 1.25.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: 1.25.0
 - !ruby/object:Gem::Dependency
   name: rubocop-discourse
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.1
+        version: 2.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.1
+        version: 2.5.0
 - !ruby/object:Gem::Dependency
   name: m
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.1
+        version: 1.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.1
+        version: 1.6.0
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
@@ -178,6 +178,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.0.0
 description: A fast, safe, simple direct SQL executor for PG
 email:
 - sam.saffron@gmail.com
@@ -210,6 +224,7 @@ files:
 - lib/mini_sql.rb
 - lib/mini_sql/abstract/prepared_binds.rb
 - lib/mini_sql/abstract/prepared_cache.rb
+- lib/mini_sql/active_record_postgres/connection.rb
 - lib/mini_sql/builder.rb
 - lib/mini_sql/connection.rb
 - lib/mini_sql/decoratable.rb
@@ -244,7 +259,7 @@ metadata:
   bug_tracker_uri: https://github.com/discourse/mini_sql/issues
   source_code_uri: https://github.com/discourse/mini_sql
   changelog_uri: https://github.com/discourse/mini_sql/blob/master/CHANGELOG
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -259,8 +274,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.2
-signing_key:
+rubygems_version: 3.1.6
+signing_key: 
 specification_version: 4
 summary: A fast, safe, simple direct SQL executor
 test_files: []