pg_conn 0.21.0 → 0.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f293ad25581975cbd57dc5973d072043d6b5cf13093a21bd354720b39c91c12
-  data.tar.gz: 1ad472d136a9b626717f90058cb220eaaf4c87bced2f8802c8cab68b69bf187a
+  metadata.gz: d7de75668042e3abdc5b983e0b9a3f6c909ff69aeed2f22c632d1c693f3baac0
+  data.tar.gz: 90cecbdd79e6478d7f6bd1bc3ae042917bc2683771c89de61aab6c05fa2e5279
 SHA512:
-  metadata.gz: 7720aef7f128e0b8e3c47fdd2acb752b1d44af9625653eae0552a2ac619e3c29ae2cad25789f0f0806fe4576104a64210cf5a5d7e7c7fa66817b8538a556bd35
-  data.tar.gz: 61425eaeabb6b6e0872f6ed49064f8650361ecd8be684b7db2322a6a346265e253489e49be37688c9ef74171733d2c8f19a12d38105a188ba263cf5ea48c9593
+  metadata.gz: 76b775138260668bf75e5bc31e220561f665dffc901349a9ec875e7ec594dee2750e0d979bde80e9045e38e44a3894fe55c2be37faefbe7f35173812cea2a22a
+  data.tar.gz: f0e2e9169cd734814cce4e8b73f7ec017cf3fd9a2622290c4acbf06620ddb3b943957ab5dab527ee0e29a9d71ad4efb511f4f219543ca86301d9fd5c4f5838ad

data/TODO

@@ -1,5 +1,6 @@
 TODO
-  o "use 'drop ... cascade' everywhere
+  o Use :elem_type everywhere
+  o Use 'drop ... cascade' everywhere
   o db.context(schema: app_portal, transaction: true) { ... }
     db.context(set: app_portal, transaction: true) { ... }
     db.context(add: app_portal, transaction: true) { ... }

data/lib/pg_conn/rdbms_methods.rb

@@ -21,7 +21,7 @@ module PgConn
     end
 
     # Create a new database
-    def create(database, owner: ENV['USER'], template: "template1") 
+    def create(database, owner: ENV['USER'], template: "template1")
       owner_clause = owner ? "owner = \"#{owner}\"" : nil
       template_clause = template ? "template = \"#{template}\"" : nil
       stmt = ["create database \"#{database}\"", owner_clause, template_clause].compact.join(" ")
@@ -80,7 +80,7 @@ module PgConn
       local = !database.nil?
       begin
         conn = local ? PgConn.new(database) : self.conn
-        schemas = 
+        schemas =
             conn
               .values("select nspname from pg_namespace where nspowner != 10 or nspname = 'public'")
               .select { |schema| !exclude.include?(schema) }
@@ -90,7 +90,7 @@ module PgConn
         # FIXME FIXME FIXME SECURITY Why grant 'create' to public?
         conn.exec %(
             create schema public authorization postgres;
-            grant usage, create on schema public to public 
+            grant usage, create on schema public to public
         ) if public
       ensure
         conn&.terminate if local

data/lib/pg_conn/role_methods.rb

@@ -18,7 +18,7 @@ module PgConn
           else
             nil
           end
-      can_login_clause = 
+      can_login_clause =
           case can_login
             when true; "rolcanlogin"
             when false; "not rolcanlogin"
@@ -62,7 +62,7 @@ module PgConn
     # counldn't be deleted
     #
     # Note that cascade only works if connected to the database where the
-    # privileges exist. 
+    # privileges exist.
     #
     # TODO The :silent option is used in tests - fix it somehow!
     def drop(*rolenames, cascade: false, fail: true, silent: false)
@@ -86,7 +86,7 @@ module PgConn
       superuser_clause = superuser.nil? ? nil : "rolsuper = #{superuser}"
       can_login_clause = can_login.nil? ? nil : "rolcanlogin = #{can_login}"
       query = [
-          "select rolname from pg_roles where true", 
+          "select rolname from pg_roles where true",
           database_clause, superuser_clause, can_login_clause
       ].compact.join(" and ")
       conn.values(query)

data/lib/pg_conn/schema_methods.rb

@@ -49,8 +49,8 @@ module PgConn
     # Empty all tables in the given schema
     def clean!(schema, exclude: [])
       conn.session.triggers(false) {
-        self.list_tables(schema, exclude: exclude).each { |table| 
-          conn.exec "delete from #{schema}.#{table}" 
+        self.list_tables(schema, exclude: exclude).each { |table|
+          conn.exec "delete from #{schema}.#{table}"
         }
       }
     end
@@ -125,8 +125,8 @@ module PgConn
     end
 
     # Return name of the table's sequence (if any)
-    def sequence(schema, table) 
-      conn.value "select pg_get_serial_sequence('#{schema}.#{table}', 'id')" 
+    def sequence(schema, table)
+      conn.value "select pg_get_serial_sequence('#{schema}.#{table}', 'id')"
     end
 
     # Get the current serial value for the table. Returns nil if the serial has
@@ -168,7 +168,7 @@ module PgConn
       kind_sql_list = "'" + (kind.nil? ? %w(r f v m) : Array(kind).flatten).join("', '") + "'"
       %(
           select  1
-          from    pg_class 
+          from    pg_class
           where   relnamespace::regnamespace::text = '#{schema}'
           and     relname = '#{relation}'
           and     relkind in (#{kind_sql_list})
@@ -183,7 +183,7 @@ module PgConn
       exclude_expr = exclude.empty? ? "true = true" : "not relname in (#{exclude_list})"
       %(
           select  relname
-          from    pg_class 
+          from    pg_class
           where   relnamespace::regnamespace::text = '#{schema}'
           and     #{kind_expr}
           and     #{exclude_expr}
@@ -211,7 +211,7 @@ module PgConn
             join    pg_attribute a on a.attrelid = c.oid
             where   relnamespace::regnamespace::text = '#{schema}'
             and     a.attnum > 0
-          ), 
+          ),
           relation_clause
       ].compact.join(" and ")
     end

data/lib/pg_conn/version.rb

@@ -1,3 +1,3 @@
 module PgConn
-  VERSION = "0.21.0"
+  VERSION = "0.23.0"
 end

data/lib/pg_conn.rb

@@ -239,12 +239,16 @@ module PgConn
       end
     end
 
-    # Quote value as an identifier. Value should be a non-nil string or a symbol
+    # Quote argument as an identifier. The argument should be a non-nil string
+    # or a symbol
     def quote_identifier(s)
       s = s.to_s if s.is_a?(Symbol)
       @pg_connection.escape_identifier(s)
     end
 
+    # Quote identifiers and concatenate them using ',' as separator
+    def quote_identifiers(idents) = idents.map { |ident| quote_identifier(ident) }.join(", ")
+
     # Quote the value as a string. Emit 'null' if value is nil
     #
     # The value can be of any type but is converted to a string using #to_s
@@ -255,7 +259,13 @@ module PgConn
     # Note that a tuple value (an array) must be quoted using #quote_tuple
     # because #quote_value would quote the tuple as an array instead of a list
     # of values
-    def quote_value(value)
+    #
+    # The :elem_type option can be a postgres type name (String or Symbol) or
+    # an array of type names. They are used as the required explicit element
+    # type when the argument is an empty array. The element types shoud be in
+    # the same order as the array arguments. Nested arrays is not supported
+    #
+    def quote_value(value, elem_type: nil)
       case value
         when String; @pg_connection.escape_literal(value)
         when Integer, Float; value.to_s
@@ -263,23 +273,34 @@ module PgConn
         when nil; 'null'
         when Date, DateTime; "'#{value}'"
         when Time; "'#{value.strftime("%FT%T%:z")}'"
-        when Array; "array[#{value.map { |elem| quote_value(elem) }.join(', ')}]"
+        when Array
+          if value.empty?
+            elem_type or raise Error, "Empty array without elem_type"
+            "array[]::#{elem_type}[]"
+          else
+            "array[#{value.map { |elem| quote_value(elem) }.join(', ')}]"
+          end
       else
         @pg_connection.escape_literal(value.to_s)
       end
     end
 
-    # Quote an array of values as a tuple. Just an alias for #quote_values
-    def quote_tuple(tuple) = quote_values(tuple)
-
-    # Quote identifiers and concatenate them using ',' as separator
-    def quote_identifiers(idents) = idents.map { |ident| quote_identifier(ident) }.join(", ")
-
     # Quote values and concatenate them using ',' as separator
-    def quote_values(values) = values.map { |value| quote_value(value) }.join(", ")
+    def quote_values(values, elem_type: nil)
+      elem_types = Array(elem_type)
+      values.map { |value|
+        elem_type = value.is_a?(Array) ? elem_types&.shift : nil
+        quote_value(value, elem_type: elem_type)
+      }.join(", ")
+    end
+
+    # Quote an array of values as a tuple. Just an alias for #quote_values
+    def quote_tuple(tuple, elem_type: nil) = quote_values(tuple, elem_type: elem_type)
 
     # Quote an array of tuples
-    def quote_tuples(tuples) = tuples.map { |tuple| "(#{quote_values(tuple)})" }.join(", ")
+    def quote_tuples(tuples, elem_type: nil)
+      tuples.map { |tuple| "(#{quote_values(tuple, elem_type: elem_type)})" }.join(", ")
+    end
 
     # :call-seq:
     #   exist?(query)
@@ -515,8 +536,9 @@ module PgConn
 
     # Returns a hash from the first field to a tuple of the remaining fields.
     # If there is only one remaining field then that value is used instead of a
-    # tuple of that value. The optional +key+ argument sets the mapping field
-    def map(query, key = nil) # TODO Swap arguments
+    # tuple. The optional +key+ argument sets the mapping field and the
+    # +symbol+ option convert key to Symbol objects when true
+    def map(query, key = nil, symbol: false) # TODO Swap arguments
       r = pg_exec(query)
       begin
         key = (key || r.fname(0)).to_s
@@ -528,13 +550,18 @@ module PgConn
       h = {}
       r.each_row { |row|
         key_value = row.delete_at(key_index)
+        key_value = key_value.to_sym if symbol
         !h.key?(key_value) or raise Error, "Duplicate key: #{key_value}"
         h[key_value] = (one ? row.first : row)
       }
       h
     end
 
-    def multimap(query, key = nil)
+    # Like #map but values of duplicate keys are concatenated. It acts as a
+    # group-by on the key and array_agg on the remaining values. The value is
+    # an array of tuples if the query has more than one value field and an
+    # array of values if there is only one value field
+    def multimap(query, key = nil, symbol: false)
       r = pg_exec(query)
       begin
         key = (key || r.fname(0)).to_s
@@ -546,6 +573,7 @@ module PgConn
       h = {}
       r.each_row { |row|
         key_value = row.delete_at(key_index)
+        key_value = key_value.to_sym if symbol
         (h[key_value] ||= []) << (one ? row.first : row)
       }
       h
@@ -557,10 +585,11 @@ module PgConn
     # values if the result contained only one column (like #value or #values),
     # a tuple if the record has multiple columns (like #tuple), and an array of
     # of tuples if the result contained more than one record with multiple
-    # columns (like #tuples)
+    # columns (like #tuples). If the :proc option is true the "function" is
+    # assumed to be a procedure
     #
-    def call(name, *args, proc: false) # :proc may interfere with hashes
-      args_seq = quote_values(args)
+    def call(name, *args, elem_type: nil, proc: false) # :proc may interfere with hashes
+      args_seq = quote_values(args, elem_type: elem_type)
       if proc
         pg_exec "call #{name}(#{args_seq})"
         return nil
@@ -582,7 +611,7 @@ module PgConn
       end
     end
 
-    # :call-seq*
+    # :call-seq:
     #   insert(table, record|records)
     #   insert(table, fields, record|records|tuples)
     #   insert(schema, table, record|records)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pg_conn
 version: !ruby/object:Gem::Version
-  version: 0.21.0
+  version: 0.23.0
 platform: ruby
 authors:
 - Claus Rasmussen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-07 00:00:00.000000000 Z
+date: 2024-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg