mini_sql 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ce3e8b5fee8c39506de8439826252434ddce6249287bb3a74c411a41a5e5726
-  data.tar.gz: cbab24b31bbf55e39cb824224e694e117b42c30e20189f64ffd2163cab3e12b6
+  metadata.gz: fc8d066cc7257d5601c5b75139172b58bb4ad7adc0b992d1ed9aa239fa8a9c55
+  data.tar.gz: 68b1a4714bb682c5cf49db9a2d6c70834dbce349cb04db949cb50c1cac73cd76
 SHA512:
-  metadata.gz: f01c57922c3ead43474e02585c365b914880ef6924f7acce041e2ee0e984217eadf4aa25f81a0c0c79ee2b9de7235311a2d7155be1a512f2f545d6fbe81ab6e5
-  data.tar.gz: 47de031da6a0efaeded3981fa2eadefd4a5261cbef73f2fcfb998dd1e671c6c19015a2b97ef70d7311d847558934f8ec8fe6678f2d665cc8ad6dffe6d10a879d
+  metadata.gz: dc1ca8c2a28d0693bf691592d57b8cdc103461707823c1e113e54c17c067ccf2e35bc7666880f2d939701c68bf28588757dc48553222e411b67da2279aaa2384
+  data.tar.gz: 67419648795ff1999fe7ddef8dbf42e4e91dbb86eb27fa2d824ee8f1576647ef08b7b73570320870911633528ff9dfebbd9ed2fda16550f97defba6476ea418f

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,21 @@
+2022-31-01 - 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
+
+2021-03-22 - 1.1.2
+
+- FEATURE: improve compatability with clients overriding raw_connection
+
+2021-03-22 - 1.1.1
+
+- FIX: compatability with ActiveRecord param encoder
+
 2021-03-22 - 1.1.0
 
 - FEATURE: added new APIs to support prepared statements

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).

data/lib/mini_sql/builder.rb

@@ -11,30 +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|
-          param = "_m_#{@count_variables += 1}"
-          sql_part = sql_part.sub('?', ":#{param}")
-          @args[param] = 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["_m_#{k}"] = 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|
@@ -82,18 +98,22 @@ class MiniSql::Builder
       when :left_join
         joined = v.map { |item| (+"LEFT JOIN ") << item }.join("\n")
       when :limit
-        joined = (+"LIMIT :_m_limit")
+        joined = (+"LIMIT :mq_auto_limit")
       when :offset
-        joined = (+"OFFSET :_m_offset")
+        joined = (+"OFFSET :mq_auto_offset")
       when :order_by
         joined = (+"ORDER BY ") << v.join(" , ")
       when :group_by
         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/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/mysql/connection.rb

@@ -9,12 +9,14 @@ module MiniSql
         @raw_connection = raw_connection
         @param_encoder = (args && args[:param_encoder]) || InlineParamEncoder.new(self)
         @deserializer_cache = (args && args[:deserializer_cache]) || DeserializerCache.new
-
-        @prepared = PreparedConnection.new(self, @deserializer_cache)
       end
 
       def prepared(condition = true)
-        condition ? @prepared : self
+        if condition
+          @prepared ||= PreparedConnection.new(self)
+        else
+          self
+        end
       end
 
       def query_single(sql, *params)
@@ -37,12 +39,12 @@ module MiniSql
 
       def query(sql, *params)
         result = run(sql, :array, params)
-        @deserializer_cache.materialize(result)
+        deserializer_cache.materialize(result)
       end
 
       def query_decorator(decorator, sql, *params)
         result = run(sql, :array, params)
-        @deserializer_cache.materialize(result, decorator)
+        deserializer_cache.materialize(result, decorator)
       end
 
       def escape_string(str)

data/lib/mini_sql/mysql/prepared_connection.rb

@@ -6,10 +6,9 @@ module MiniSql
 
       attr_reader :unprepared
 
-      def initialize(unprepared_connection, deserializer_cache)
+      def initialize(unprepared_connection)
         @unprepared         = unprepared_connection
         @raw_connection     = unprepared_connection.raw_connection
-        @deserializer_cache = deserializer_cache
         @param_encoder      = unprepared_connection.param_encoder
 
         @prepared_cache     = PreparedCache.new(@raw_connection)
@@ -24,6 +23,10 @@ module MiniSql
         condition ? self : @unprepared
       end
 
+      def deserializer_cache
+        @unprepared.deserializer_cache
+      end
+
       private def run(sql, as, params)
         prepared_sql, binds, _bind_names = @param_binder.bind(sql, *params)
         statement = @prepared_cache.prepare_statement(prepared_sql)

data/lib/mini_sql/postgres/connection.rb

@@ -3,7 +3,7 @@
 module MiniSql
   module Postgres
     class Connection < MiniSql::Connection
-      attr_reader :raw_connection, :type_map, :param_encoder
+      attr_reader :raw_connection, :param_encoder, :deserializer_cache
 
       def self.default_deserializer_cache
         @deserializer_cache ||= DeserializerCache.new
@@ -40,8 +40,6 @@ module MiniSql
         @deserializer_cache = (args && args[:deserializer_cache]) || self.class.default_deserializer_cache
         @param_encoder = (args && args[:param_encoder]) || InlineParamEncoder.new(self)
         @type_map = args && args[:type_map]
-
-        @prepared = PreparedConnection.new(self, @deserializer_cache)
       end
 
       def type_map
@@ -49,7 +47,11 @@ module MiniSql
       end
 
       def prepared(condition = true)
-        condition ? @prepared : self
+        if condition
+          @prepared ||= PreparedConnection.new(self)
+        else
+          self
+        end
       end
 
       # Returns a flat array containing all results.
@@ -96,7 +98,7 @@ module MiniSql
       def query(sql, *params)
         result = run(sql, params)
         result.type_map = type_map
-        @deserializer_cache.materialize(result)
+        deserializer_cache.materialize(result)
       ensure
         result.clear if result
       end
@@ -119,7 +121,7 @@ module MiniSql
           if result.ntuples == 0
             # skip, this happens at the end when we get totals
           else
-            materializer ||= @deserializer_cache.materializer(result)
+            materializer ||= deserializer_cache.materializer(result)
             result.type_map = type_map
             i = 0
             # technically we should only get 1 row here
@@ -170,7 +172,7 @@ module MiniSql
       def query_decorator(decorator, sql, *params)
         result = run(sql, params)
         result.type_map = type_map
-        @deserializer_cache.materialize(result, decorator)
+        deserializer_cache.materialize(result, decorator)
       ensure
         result.clear if result
       end

data/lib/mini_sql/postgres/prepared_connection.rb

@@ -6,10 +6,9 @@ module MiniSql
 
       attr_reader :unprepared
 
-      def initialize(unprepared_connection, deserializer_cache)
+      def initialize(unprepared_connection)
         @unprepared         = unprepared_connection
         @raw_connection     = unprepared_connection.raw_connection
-        @deserializer_cache = deserializer_cache
         @type_map           = unprepared_connection.type_map
         @param_encoder      = unprepared_connection.param_encoder
 
@@ -25,6 +24,10 @@ module MiniSql
         condition ? self : @unprepared
       end
 
+      def deserializer_cache
+        @unprepared.deserializer_cache
+      end
+
       private def run(sql, params)
         prepared_sql, binds, _bind_names = @param_binder.bind(sql, *params)
         prepare_statement_key = @prepared_cache.prepare_statement(prepared_sql)

data/lib/mini_sql/sqlite/connection.rb

@@ -9,12 +9,14 @@ module MiniSql
         @raw_connection = raw_connection
         @param_encoder = (args && args[:param_encoder]) || InlineParamEncoder.new(self)
         @deserializer_cache = (args && args[:deserializer_cache]) || DeserializerCache.new
-
-        @prepared = PreparedConnection.new(self, @deserializer_cache)
       end
 
       def prepared(condition = true)
-        condition ? @prepared : self
+        if condition
+          @prepared ||= PreparedConnection.new(self)
+        else
+          self
+        end
       end
 
       def query_single(sql, *params)

data/lib/mini_sql/sqlite/prepared_connection.rb

@@ -6,10 +6,9 @@ module MiniSql
 
       attr_reader :unprepared
 
-      def initialize(unprepared_connection, deserializer_cache)
+      def initialize(unprepared_connection)
         @unprepared         = unprepared_connection
         @raw_connection     = unprepared_connection.raw_connection
-        @deserializer_cache = deserializer_cache
         @param_encoder      = unprepared_connection.param_encoder
 
         @prepared_cache     = PreparedCache.new(@raw_connection)
@@ -24,6 +23,10 @@ module MiniSql
         condition ? self : @unprepared
       end
 
+      def deserializer_cache
+        @unprepared.deserializer_cache
+      end
+
       private def run(sql, params)
         prepared_sql, binds, _bind_names = @param_binder.bind(sql, params)
         statement = @prepared_cache.prepare_statement(prepared_sql)

data/lib/mini_sql/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module MiniSql
-  VERSION = "1.1.0"
+  VERSION = "1.2.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"

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 '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"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mini_sql
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Sam Saffron
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-22 00:00:00.000000000 Z
+date: 2022-02-02 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
@@ -100,42 +100,42 @@ dependencies:
     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
@@ -244,7 +244,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 +259,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: []