quote-sql 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e308b3aef586983a61155c9ba3be6c39c2397fa5fbae069ab45522e51681caa
-  data.tar.gz: 6a3945e1a4cfc16fed91c46216d1a10c5a69e85a6b3a0df10db45a9f162c07eb
+  metadata.gz: cfe070af9a81f751ed10ef8ace30bf5e44a3efb54cff04f2eb5cc137b7fbc0f1
+  data.tar.gz: 8c8ec59ca80a8c72ceee6567da4beb5f79c96a63e16d945694fed26ea695feca
 SHA512:
-  metadata.gz: 3ce751f52d51a6b7b989062673f9c849b5a8b44e5e4227f0f453290d41b20856b45f0d0bbddd6cea6f5256405b313d82367a27fdd2381dd2b37f27c3ac3442e6
-  data.tar.gz: 2656c2cbacc7375fd22f2148d4a929fbba1822c97b61467bdf5794c7bcf78b75d5ba4a9bfb90a6f01b282479bad95c77d354ca2211a6f3561a6eaa60e9d90db4
+  metadata.gz: 03d69b9b3256cd22762844dc98c31ce2223c673079488d7175078dd82406d8031673368871a2a920ecda17ea68beb79c87f3208d56b1e770c4ba15583fafc648
+  data.tar.gz: b6d9f335cdcaf0e597f3118090451059220ebd9e540eda483f546301ad148bfebc35150a73a72c6dc54a39f537e8aa9b854970a975218226a26af3ed6add75c0

data/README.md

@@ -26,7 +26,7 @@ Best Martin
 `QuoteSql.new("SELECT %field").quote(field: "abc").to_sql`
   => SELECT 'abc'
 
-`QuoteSql.new("SELECT %field__text").quote(field__text: 9).to_sql`
+`QuoteSql.new("SELECT %field::TEXT").quote(field: 9).to_sql`
 => SELECT 9::TEXT
 
 ### Rails models
@@ -58,11 +58,8 @@ Values are be ordered in sequence of columns. Missing value entries are substitu
       ON CONFLICT ("id") DO NOTHING
       
 ### Columns from a list
-`QuoteSql.new("SELECT %columns").quote(columns: [:a, "b.c", d: {e: field}]).to_sql`
-  => SELECT "a","b"."c",jsonb_build_object('e', field) AS d 
-
-`QuoteSql.new("SELECT %columns").quote(columns: [:a, "b.c", d: {e: field, nil: false}]).to_sql`
-  => SELECT "a","b"."c",jsonb_strip_nulls(jsonb_build_object('e', 1)) AS d
+`QuoteSql.new("SELECT %columns FROM %table").quote(table: "foo", columns: [:a, "b", "foo.c", {d: :e}]).to_sql`
+  => SELECT "foo"."a","b"."foo"."c", "foo"."e" AS d
 
 ## Executing
 ### Getting the results
@@ -72,6 +69,7 @@ Values are be ordered in sequence of columns. Missing value entries are substitu
 ### Binds
 You can use binds ($1, $2, ...) in the SQL and add arguments to the result call
   `QuoteSql.new('SELECT $1 AS a').result(1)`  
+    => [{:a=>1}]
 
 #### using JSON
 
@@ -111,10 +109,8 @@ All can be preceded by additional letters and underscore e.g. `%foo_bar_column`
 A database typecast is added to fields ending with double underscore and a valid db data type
 with optional array dimension
 
-- `%field__jsonb` => adds a `::JSONB` typecast to the field
-- `%number_to__text` => adds a `::TEXT` typecast to the field
-- `%array__text1` => adds a `::TEXT[]` (TO BE IMPLEMENTED)
-- `%array__text2` => adds a `::TEXT[][]` (TO BE IMPLEMENTED)
+- `%field::jsonb` => treats the field as jsonb when casted
+- `%array::text[]` => treats an array like a text array, default is JSONB
 
 ### Quoting
 - Any value of the standard mixins are quoted with these exceptions

data/lib/quote_sql/formater.rb

@@ -1,3 +1,4 @@
+require 'niceql'
 class QuoteSql
   module Formater
     PG_FORMAT_BIN = `which pg_format`.chomp.presence
@@ -9,15 +10,14 @@ class QuoteSql
 
     def to_formatted_sql
       sql = respond_to?(:to_sql) ? to_sql : to_s
-      Niceql::Prettifier.prettify_sql(sql)
+      Niceql::Prettifier.prettify_sql(sql.gsub(/(?<=[^%])%(?=\S)/, "%%"))
 
       # IO.popen(PG_FORMAT_BIN, "r+", err: "/dev/null") do |f|
       #   f.write(sql)
       #   f.close_write
       #   f.read
       # end
-    rescue
-      sql
+
     end
 
     alias to_sqf to_formatted_sql

data/lib/quote_sql/quoter.rb

@@ -1,12 +1,12 @@
 class QuoteSql
   class Quoter
-    def initialize(qsql, key, quotable)
+    def initialize(qsql, key, cast, quotable)
       @qsql = qsql
-      @key, @quotable = key, quotable
+      @key, @cast, @quotable = key, cast, quotable
       @name = key.sub(/_[^_]+$/, '') if key["_"]
     end
 
-    attr_reader :key, :quotable, :name
+    attr_reader :key, :quotable, :name, :cast
 
     def quotes
       @qsql.quotes
@@ -227,42 +227,65 @@ class QuoteSql
       end
     end
 
-    def cast
-      if m = key.to_s[CASTS]
-        m[2..].sub(CASTS) { _1.tr("_", " ") }
-      end
-    end
-
-    def json?
-      !!key[/(^|_)(jsonb?)$/]
+    def json?(cast = self.cast)
+      cast.to_s[/jsonb?$/i]
     end
 
-    private def _quote(item = @quotable, cast = self.cast)
-      rv = QuoteSql.quote(item)
-      if cast
-        rv << "::#{cast.upcase}"
-        rv << "[]" * rv.depth if rv[/^ARRAY/]
-      end
-      Raw.sql rv
+    private def _quote(item = @quotable)
+      Raw.sql QuoteSql.quote(item)
     end
 
     private def _quote_column_name(name)
       Raw.sql name.scan(/(?:^|")?([^."]+)/).map { QuoteSql.quote_column_name _1 }.join(".")
     end
 
-    def quote(item = @quotable)
-      case item.class.to_s
-      when "Arel::Nodes::SqlLiteral", "QuoteSql::Raw"
-        return Raw.sql(item)
-      when "Array"
-        return _quote(item.to_json) if json?
-        _quote(item)
-      when "Hash"
-        _quote(item.to_json, :jsonb)
-      else
-        return Raw.sql item.to_sql if item.respond_to? :to_sql
-        _quote(item)
+    private def _quote_array(items)
+      rv = items.map do |i|
+        if i.is_a?(Array)
+          _quote_array(i)
+        elsif self.cast[/jsonb?/i]
+          _quote(i.to_json)
+        else
+          quote(i)
+        end
       end
+      "[#{rv.join(",")}]"
+    end
+
+    def quote_hash(item)
+      item.compact! if item.delete(nil) == false
+      case self.cast
+      when /hstore/i
+        _quote(item.map { "#{_1}=>#{_2.nil? ? 'NULL' : _2}"}.join(","))
+      when NilClass,""
+        "#{_quote(item.to_json)}::JSONB"
+      when /jsonb?/i
+        _quote(item.to_json)
+      end
+    end
+
+    def quote(item = @quotable, cast = nil)
+      Raw.sql case item.class.to_s
+              when "Arel::Nodes::SqlLiteral", "QuoteSql::Raw"
+                item
+              when "Array"
+                if json? or self.cast.blank?
+                  rv = _quote(item.to_json)
+                  self.cast.present? ? rv : "#{rv}::JSONB"
+                else
+                  "ARRAY#{_quote_array(item)}"
+                end
+              when "Hash"
+                quote_hash(item)
+              else
+                if item.respond_to? :to_sql
+                  item.to_sql
+                elsif json?
+                  _quote(item.to_json)
+                else
+                  _quote(item)
+                end
+              end
     end
 
     def column_names(item = @quotable)

data/lib/quote_sql/test.rb

@@ -1,5 +1,6 @@
 class QuoteSql::Test
   private
+
   def test_columns
     expected <<~SQL
       SELECT x, "a", "b", "c", "d"
@@ -124,29 +125,59 @@ class QuoteSql::Test
     expected <<~SQL
       SELECT * FROM json_to_recordset('[{"a":1,"b":"foo"},{"a":"2"}]') as "x" ("a" int, "b" text)
     SQL
-    "SELECT * FROM %x_json".quote_sql(x_casts: {a: "int", b: "text"}, x_json: [{ a: 1, b: 'foo'}, {a: '2', c: 'bar'}])
+    "SELECT * FROM %x_json".quote_sql(x_casts: { a: "int", b: "text" }, x_json: [{ a: 1, b: 'foo' }, { a: '2', c: 'bar' }])
   end
 
   def test_json_insert
     expected <<~SQL
-        INSERT INTO users (name, color) SELECT * from json_to_recordset('[{"name":"auge","color":"#611333"}]') AS "x"("name" text,"color" text)
+      INSERT INTO users (name, color) SELECT * from json_to_recordset('[{"name":"auge","color":"#611333"}]') AS "x"("name" text,"color" text)
     SQL
-    x_json = {"first_name"=>nil, "last_name"=>nil, "stripe_id"=>nil, "credits"=>nil, "avatar"=>nil, "name"=>"auge", "color"=>"#611333", "founder"=>nil, "language"=>nil, "country"=>nil, "data"=>{}, "created_at"=>"2020-11-19T09:30:18.670Z", "updated_at"=>"2020-11-19T09:40:00.063Z"}
-    "INSERT INTO users (name, color) SELECT * from %x_json".quote_sql(x_casts: {name: "text", color: "text"}, x_json:)
+    x_json = { "first_name" => nil, "last_name" => nil, "stripe_id" => nil, "credits" => nil, "avatar" => nil, "name" => "auge", "color" => "#611333", "founder" => nil, "language" => nil, "country" => nil, "data" => {}, "created_at" => "2020-11-19T09:30:18.670Z", "updated_at" => "2020-11-19T09:40:00.063Z" }
+    "INSERT INTO users (name, color) SELECT * from %x_json".quote_sql(x_casts: { name: "text", color: "text" }, x_json:)
   end
 
   def test_from_json_bind
     expected <<~SQL
-        Select * From json_to_recordset($1) AS "x"("a" int,"b" text,"c" boolean)
+      Select * From json_to_recordset($1) AS "x"("a" int,"b" text,"c" boolean)
     SQL
-    QuoteSQL("Select * From %x_json", x_json: 1, x_casts: {a: "int", b: "text", c: "boolean"})
+    QuoteSQL("Select * From %x_json", x_json: 1, x_casts: { a: "int", b: "text", c: "boolean" })
   end
 
   def test_insert_json_bind
     expected <<~SQL
-         INSERT INTO table ("a","b","c") Select * From json_to_recordset($1) AS "x"("a" int,"b" text,"c" boolean)  
+      INSERT INTO table ("a","b","c") Select * From json_to_recordset($1) AS "x"("a" int,"b" text,"c" boolean)  
+    SQL
+    QuoteSQL("INSERT INTO table (%x_columns) Select * From %x_json", x_json: 1, x_casts: { a: "int", b: "text", c: "boolean" })
+  end
+
+  def test_cast_values
+    expected <<~SQL
+      SELECT 
+         'abc'::TEXT, 
+         '"abc"'::JSON, 
+         '["cde",null,"fgh"]'::JSONB,
+         ARRAY['cde', NULL, 'fgh']::TEXT[],  
+         ARRAY['"cde"', 'null', '"fgh"']::JSON[],
+         '{"foo":"bar","go":1,"strip_null":null}'::JSONB not_compact,
+         '{"foo":"bar","go":1}'::JSON compact,
+         'foo=>bar,go=>1,strip_null=>NULL'::HSTORE,
+        ARRAY[[1,2,3],[1,2,3]]::INT[][]
+    SQL
+    array1 = array2 = array3 = ["cde", nil, "fgh"]
+    array4 = [[1,2,3], [1,2,3]]
+    hash = { foo: "bar", "go": 1, strip_null: nil }
+    QuoteSQL(<<~SQL, field1: 'abc', array1:, array2:, array3:, array4:, hash: ,not_compact: hash, compact: hash.merge(nil => false))
+      SELECT 
+        %field1::TEXT, 
+        %field1::JSON,
+        %array1,
+        %array2::TEXT[],
+        %array3::JSON[], 
+        %not_compact not_compact,
+        %compact::JSON compact,
+        %hash::HSTORE,
+        %array4::INT[][]
     SQL
-    QuoteSQL("INSERT INTO table (%x_columns) Select * From %x_json", x_json: 1, x_casts: {a: "int", b: "text", c: "boolean"})
   end
 
   # def test_q3
@@ -172,7 +203,6 @@ class QuoteSql::Test
   #     )
   # end
 
-
   public
 
   def all
@@ -193,10 +223,12 @@ class QuoteSql::Test
       tables = @test.tables.to_h { [[_1, "table"].compact.join("_"), _2] }
       columns = @test.instance_variable_get(:@columns).to_h { [[_1, "columns"].compact.join("_"), _2] }
       rv += [
-        "QuoteSql.new(\"#{@test.original}\").quote(#{{**tables, **columns, **@test.quotes }.inspect}).to_sql", "🎯 #{expected}", "✅ #{sql}"]
+        "QuoteSql.new(\"#{@test.original}\").quote(#{{ **tables, **columns, **@test.quotes }.inspect}).to_sql", "🎯 #{expected}", "✅ #{sql}"]
       @success << rv if @success
     else
       rv += [@test.inspect, "🎯 #{expected}", "❌ #{sql}"]
+      rv << sql.gsub(/\s+/, "")&.downcase&.strip
+      rv << expected&.gsub(/\s+/, "")&.downcase&.strip
       @fail << rv if @fail
     end
   rescue => exc
@@ -228,4 +260,111 @@ class QuoteSql::Test
     end
   end
 
-end
+  def datatype
+    errors = {}
+    success = []
+    spaces = ->(*) { " " * (rand(4) + 1) }
+
+    DATATYPES.each_line(chomp: true) do |line|
+
+      l = line.gsub(/\s+/, &spaces).gsub(/(?<=\()\d+|\d+(?=\))/) { "#{spaces.call}#{rand(10) + 1}#{spaces.call}" }.gsub(/\(/) { "#{spaces.call}(" }
+
+      m = "jgj hsgjhsgfjh ag %field::#{l} asldfalskjdfl".match(QuoteSql::CASTS)
+      if m.present? and l == m[1]
+          success << line
+        else
+          errors[line] = m&.to_a
+      end
+      line = line + "[]"*(rand(3) + 1)
+      m = "jgj hsgjhsgfjh ag %field::#{line} asldfalskjdfl".match(QuoteSql::CASTS)
+      if m.present? and line == m[1] + m[2]
+        success << line
+      else
+        errors[line] = m&.to_a
+      end
+    end
+    puts success.sort.inspect
+    ap errors
+  end
+
+  DATATYPES = <<-DATATYPES
+bigint
+int8
+bigserial
+serial8
+bit
+bit (1)
+bit varying
+varbit
+bit varying (2)
+varbit (2)
+boolean
+bool
+box
+bytea
+character
+char
+character (1)
+char (1)
+character varying
+varchar
+character varying (1)
+varchar (1)
+cidr
+circle
+date
+double precision
+float8
+inet
+integer
+int
+int4
+interval
+interval (1)
+json
+jsonb
+line
+lseg
+macaddr
+macaddr8
+money
+numeric
+numeric(10,3)
+decimal
+decimal(10,3)
+path
+pg_lsn
+pg_snapshot
+point
+polygon
+real
+float4
+smallint
+int2
+smallserial
+serial
+serial2
+serial4
+text
+time
+time(1)
+time without time zone
+time(1) without time zone
+time with time zone
+time(2) with time zone
+timetz
+timestamp
+timestamp(1)
+timestamp without time zone
+timestamp(1) without time zone
+timestamp with time zone
+timestamp(1) with time zone
+timestamptz
+tsquery
+tsvector
+txid_snapshot
+uuid
+xml
+  DATATYPES
+
+end

data/lib/quote_sql/version.rb

@@ -1,3 +1,3 @@
 class QuoteSql
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/lib/quote_sql.rb

@@ -3,25 +3,30 @@ Dir.glob(__FILE__.sub(/\.rb$/, "/*.rb")).each { require(_1) unless _1[/(deprecat
 # Tool to build and run SQL queries easier
 class QuoteSql
 
+
   DATA_TYPES_RE = %w(
-(?:small|big)(?:int|serial)
-bit bool(?:ean)? box bytea cidr circle date
+(?>character\\s+varying|bit\\s+varying|character|varbit|varchar|char|bit|interval)(?>\\s*\\(\\s*\\d+\\s*\\))?
+(?>numeric|decimal)(?>\\s*\\(\\s*\\d+\\s*,\\s*\\d+\\s*\\))?
+timestamptz timetz
+time(?>stamp)?(?>\\s*\\(\\s*\\d+\\s*\\))?(?>\\s+with(?>out)?\\s+time\\s+zone)?
+integer
+(?>small|big)(?>int|serial)
+bool(?>ean)? box bytea cidr circle date
 (?:date|int[48]|num|ts(?:tz)?)(?:multi)?range
 macaddr8?
-jsonb?
-ts(?:query|vector)
-float[48] (?:int|serial)[248]?
-double_precision  inet
-integer  line lseg   money   path pg_lsn
-pg_snapshot point polygon real  text timestamptz timetz
-txid_snapshot uuid xml
-(bit_varying|varbit|character|char|character varying|varchar)(_\\(\\d+\\))?
-(numeric|decimal)(_\\(\d+_\d+\\))?
-interval(_(YEAR|MONTH|DAY|HOUR|MINUTE|SECOND|YEAR_TO_MONTH|DAY_TO_HOUR|DAY_TO_MINUTE|DAY_TO_SECOND|HOUR_TO_MINUTE|HOUR_TO_SECOND|MINUTE_TO_SECOND))?(_\\(\d+\\))?
-time(stamp)?(_\\(\d+\\))?(_with(out)?_time_zone)?
+ts(?>query|vector)
+float[48]
+(?:int|serial)[248]?
+double\\s+precision
+jsonb json
+ inet
+line lseg   money   path
+pg_lsn pg_snapshot txid_snapshot
+point polygon real text
+uuid xml hstore
     ).join("|")
 
-  CASTS = Regexp.new("__(#{DATA_TYPES_RE})$", "i")
+  CASTS = Regexp.new("::(#{DATA_TYPES_RE})((?:\\s*\\[\\s*\\d?\\s*\\])*)", "i")
 
   def self.conn
     raise ArgumentError, "You need to define a database connection function"
@@ -152,11 +157,8 @@ time(stamp)?(_\\(\d+\\))?(_with(out)?_time_zone)?
   def key_matches
     @sql.scan(MIXIN_RE).map do |full, *key|
       key = key.compact[0]
-      if m = key.match(/^(.+)#{CASTS}/i)
-        _, key, cast = m.to_a
-      end
       has_quote = @quotes.key?(key.to_sym) || key.match?(/(table|columns)$/)
-      [full, key, cast, has_quote]
+      [full, key, has_quote]
     end
   end
 
@@ -166,27 +168,28 @@ time(stamp)?(_\\(\d+\\))?(_with(out)?_time_zone)?
     loop do
       s = StringScanner.new(@sql)
       sql = ""
-      key_matches.each do |key_match, key, cast, has_quote|
-        s.scan_until(/(.*?)#{key_match}([a-z0-9_]*)/im)
-        matched, pre, post = s.matched, s[1], s[2]
-        if m = key.match(/^bind(\d+)?/im)
-          if m[1].present?
-            bind_num = m[1].to_i
-            @binds[bind_num - 1] ||= cast
-            raise "bind #{bind_num} already set to #{@binds[bind_num - 1]}" unless @binds[bind_num - 1] == cast
-          else
-            @binds << cast
-            bind_num = @binds.length
-          end
-
-          matched = "#{pre}$#{bind_num}#{"::#{cast}" if cast.present?}#{post}"
-        elsif has_quote
-          quoted = quoter(key)
+      key_matches.each do |key_match, key, has_quote|
+        s.scan_until(/(.*?)#{key_match}(#{CASTS}?)/im)
+        matched, pre, cast = s.matched, s[1], s[2]
+        # if m = key.match(/^bind(\d+)?/im)
+        #   if m[1].present?
+        #     bind_num = m[1].to_i
+        #     @binds[bind_num - 1] ||= cast
+        #     raise "bind #{bind_num} already set to #{@binds[bind_num - 1]}" unless @binds[bind_num - 1] == cast
+        #   else
+        #     @binds << cast
+        #     bind_num = @binds.length
+        #   end
+        #
+        #   matched = "#{pre}$#{bind_num}#{"::#{cast}" if cast.present?}#{post}"
+        # els
+         if has_quote
+          quoted = quoter(key, cast)
           unresolved.delete key
           if (i = quoted.scan MIXIN_RE).present?
             unresolved += i.map(&:last)
           end
-          matched = "#{pre}#{quoted}#{post}"
+          matched = "#{pre}#{quoted}#{cast}"
         end
       rescue TypeError
       ensure
@@ -200,8 +203,8 @@ time(stamp)?(_\\(\d+\\))?(_with(out)?_time_zone)?
     self
   end
 
-  def quoter(key)
-    quoter = @resolved[key.to_sym] = Quoter.new(self, key, @quotes[key.to_sym])
+  def quoter(key, cast)
+    quoter = @resolved[key.to_sym] = Quoter.new(self, key, cast, @quotes[key.to_sym])
     quoter.to_sql
   rescue TypeError => exc
     @resolved[key.to_sym] = exc
@@ -224,8 +227,11 @@ time(stamp)?(_\\(\d+\\))?(_with(out)?_time_zone)?
 
   def self.test(which = :all)
     require __dir__ + "/quote_sql/test.rb"
-    if which == :all
+    case which
+    when :all
       Test.new.all
+    when :datatype
+      Test.new.datatype
     else
       Test.new.run(which)
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quote-sql
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Martin Kufner
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-27 00:00:00.000000000 Z
+date: 2024-02-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: niceql