pg_conn 0.19.0 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91bfceabfdba86eba789108cea2718e382fe6849b580ef3be3a428a8f08ab45e
-  data.tar.gz: 0014ae1ccc9c6cf95f63fce78d5a094b7068e711ed18d0edcdaafe35d47ef04b
+  metadata.gz: 6f293ad25581975cbd57dc5973d072043d6b5cf13093a21bd354720b39c91c12
+  data.tar.gz: 1ad472d136a9b626717f90058cb220eaaf4c87bced2f8802c8cab68b69bf187a
 SHA512:
-  metadata.gz: 6302b2051fd7a152b026ed7a412ad9025ae7fbdb6f260173c5731c123f367c7535a9522e2654ccc09950d14c9e3009c1daf6d52fa7fc3114c3b9f196e6db0570
-  data.tar.gz: c793534b923e08cc22121dc824c858003cb495e2453cb77cd7007672e242a62ff8819ab966f2f9d70a552f3a080da2627c1ec1211990eefcbe87bdcc1a5c06e8
+  metadata.gz: 7720aef7f128e0b8e3c47fdd2acb752b1d44af9625653eae0552a2ac619e3c29ae2cad25789f0f0806fe4576104a64210cf5a5d7e7c7fa66817b8538a556bd35
+  data.tar.gz: 61425eaeabb6b6e0872f6ed49064f8650361ecd8be684b7db2322a6a346265e253489e49be37688c9ef74171733d2c8f19a12d38105a188ba263cf5ea48c9593

data/TODO

@@ -1,4 +1,5 @@
 TODO
+  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/version.rb

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

data/lib/pg_conn.rb

@@ -64,9 +64,13 @@ module PgConn
     attr_reader :session
 
     # The transaction timestamp of the most recent SQL statement executed by
-    # #exec or #transaction block
+    # #exec or #transaction block. The timestamp is without time zone
     attr_reader :timestamp
 
+    # The transaction timestamp of the most recent SQL statement executed by
+    # #exec or #transaction block. The timestamp includes the current time zone
+    attr_reader :timestamptz
+
     # PG::Error object of the first failed statement in the transaction;
     # otherwise nil. It is cleared at the beginning of a transaction so be sure
     # to save it before you run any cleanup code that may initiate new
@@ -139,6 +143,7 @@ module PgConn
       if args.last.is_a?(Hash)
         @field_name_class = args.last.delete(:field_name_class) || Symbol
         @timestamp = args.last.delete(:timestamp)
+        @timestamptz = args.last.delete(:timestamptz)
         args.pop if args.last.empty?
       else
         @field_name_class = Symbol
@@ -185,7 +190,7 @@ module PgConn
         @pg_connection.set_notice_processor { |message| ; } # Intentionally a nop
 
         # Auto-convert to ruby types
-        type_map = PG::BasicTypeMapForResults.new(@pg_connection) 
+        type_map = PG::BasicTypeMapForResults.new(@pg_connection)
 
         # Use String as default type. Kills 'Warning: no type cast defined for
         # type "uuid" with oid 2950..' warnings
@@ -193,7 +198,7 @@ module PgConn
 
         # Timestamp decoder
         type_map.add_coder PG::TextDecoder::Timestamp.new( # Timestamp without time zone
-            oid: 1114, 
+            oid: 1114,
             flags: PG::Coder::TIMESTAMP_DB_UTC | PG::Coder::TIMESTAMP_APP_UTC)
 
         # Decode anonymous records but note that this is only useful to convert the
@@ -212,13 +217,12 @@ module PgConn
       @role = RoleMethods.new(self)
       @rdbms = RdbmsMethods.new(self)
       @session = SessionMethods.new(self)
-      @timestamp = nil
       @savepoints = nil # Stack of savepoint names. Nil if no transaction in progress
     end
 
     # Close the database connection. TODO: Rename 'close'
     def terminate()
-      @pg_connection.close if @pg_connection && !@pg_connection.finished? 
+      @pg_connection.close if @pg_connection && !@pg_connection.finished?
     end
 
     def self.new(*args, **opts, &block)
@@ -238,7 +242,7 @@ module PgConn
     # Quote value as an identifier. Value should be a non-nil string or a symbol
     def quote_identifier(s)
       s = s.to_s if s.is_a?(Symbol)
-      String@pg_connection.escape_identifier(s)
+      @pg_connection.escape_identifier(s)
     end
 
     # Quote the value as a string. Emit 'null' if value is nil
@@ -247,7 +251,11 @@ module PgConn
     # before quoting. This works by default for the regular types Integer,
     # true/false, Time/Date/DateTime, and arrays. Other types may require
     # special handling
-    def quote_value(value) 
+    #
+    # 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)
       case value
         when String; @pg_connection.escape_literal(value)
         when Integer, Float; value.to_s
@@ -255,28 +263,23 @@ module PgConn
         when nil; 'null'
         when Date, DateTime; "'#{value}'"
         when Time; "'#{value.strftime("%FT%T%:z")}'"
-        when Array; "array[#{value.map { |elem| quote_literal(elem) }.join(', ')}]"
+        when Array; "array[#{value.map { |elem| quote_value(elem) }.join(', ')}]"
       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 array as a comma-separated sequence of identifiers
-    def quote_identifier_seq(identifiers) = identifiers.map { quote_identifier(_1) }.join(', ')
-
-    # Quote array as a parenthesis-enclosed sequence of identifiers
-    def quote_identifier_list(identifiers) = "(#{quote_identifier_seq(identifiers)})"
-
-    # Quote array as a comma-separated sequence of values
-    def quote_value_seq(values) = values.map { quote_literal(_1) }.join(', ')
+    # Quote identifiers and concatenate them using ',' as separator
+    def quote_identifiers(idents) = idents.map { |ident| quote_identifier(ident) }.join(", ")
 
-    # Quote array as a parenthesis-enclosed list of value
-    def quote_value_list(values) = "(#{quote_value_seq(values)})"
+    # Quote values and concatenate them using ',' as separator
+    def quote_values(values) = values.map { |value| quote_value(value) }.join(", ")
 
-    # Old aliases. TODO Remove
-    def quote_literal(value) = quote_value(value)
-    def quote_literal_list(values) = quote_value_list(values)
+    # Quote an array of tuples
+    def quote_tuples(tuples) = tuples.map { |tuple| "(#{quote_values(tuple)})" }.join(", ")
 
     # :call-seq:
     #   exist?(query)
@@ -287,7 +290,7 @@ module PgConn
     # check if the query returns one or more records
     def exist?(*args)
       arg1, arg2 = *args
-      query = 
+      query =
           case arg2
             when Integer; "select from #{arg1} where id = #{arg2}"
             when String; "select from #{arg1} where #{arg2}"
@@ -301,7 +304,7 @@ module PgConn
     #   count(table, where_clause = nil)
     #
     # Return true if the table or the result of the query is empty
-    def empty?(arg, where_clause = nil) 
+    def empty?(arg, where_clause = nil)
       if arg =~ /\s/
         value "select count(*) from (#{arg} limit 1) as inner_query"
       elsif where_clause
@@ -324,6 +327,12 @@ module PgConn
       end
     end
 
+    # TODO
+    #   Query variants
+    #     (sql) - simple SQL statement
+    #     (schema = nil, table, id-or-where-clause = nil, field-or-fields)
+    #
+
     # Return a single value. It is an error if the query doesn't return a
     # single record with a single column. If :transaction is true, the query
     # will be executed in a transaction and also be committed if :commit is
@@ -551,23 +560,12 @@ module PgConn
     # columns (like #tuples)
     #
     def call(name, *args, proc: false) # :proc may interfere with hashes
-      args_sql = args.map { |arg| # TODO: Use pg's encoder
-        case arg
-          when NilClass; "null"
-          when String; "'#{arg}'"
-          when Integer; arg
-          when TrueClass, FalseClass; arg
-          when Array; "Array['#{arg.join("', '")}']" # Quick and dirty # FIXME
-          when Hash; raise NotImplementedError
-        else
-          raise ArgumentError, "Unrecognized value: #{arg.inspect}"
-        end
-      }.join(", ")
+      args_seq = quote_values(args)
       if proc
-        pg_exec "call #{name}(#{args_sql})"
+        pg_exec "call #{name}(#{args_seq})"
         return nil
       else
-        r = pg_exec "select * from #{name}(#{args_sql})"
+        r = pg_exec "select * from #{name}(#{args_seq})"
         if r.ntuples == 0
           raise Error, "No records returned"
         elsif r.ntuples == 1
@@ -611,15 +609,14 @@ module PgConn
       table = schema ? "#{schema}.#{table}" : table
 
       # Find method and normalize data
-      if data.is_a?(Array) 
+      if data.is_a?(Array) # Array of tuples
+        method = :values
         if data.empty?
           return []
-        elsif data.first.is_a?(Array)
-          method = :values
+        elsif data.first.is_a?(Array) # Tuple (array) element. Requires the 'fields' argument
           fields or raise ArgumentError
           tuples = data
-        elsif data.first.is_a?(Hash)
-          method = :values
+        elsif data.first.is_a?(Hash) # Hash element
           fields ||= data.first.keys
           tuples = data.map { |record| fields.map { |field| record[field] } }
         else
@@ -633,21 +630,23 @@ module PgConn
         raise ArgumentError
       end
 
-      # Build and execute SQL statement
-      columns = quote_identifier_list(fields)
-      values = tuples.map { |tuple| quote_literal_list(tuple) }.join(', ')
-      self.send method, %(insert into #{table} #{columns} values #{values} returning id)
+      # Execute SQL statement using either :value or :values depending on data arity
+      self.send method, %(
+        insert into #{table} (#{quote_identifiers(fields)})
+          values #{quote_tuples(tuples)}
+          returning id
+      )
     end
 
     # Update record(s)
     def update(schema = nil, table, expr, hash)
       table = [schema, table].compact.join(".")
-      assignments = hash.map { |k,v| "#{k} = #{quote_literal(v)}" }.join(", ")
-      constraint = 
+      assignments = hash.map { |k,v| "#{k} = #{quote_value(v)}" }.join(", ")
+      constraint =
           case expr
             when String; expr
-            when Integer; "id = #{quote_literal(expr)}"
-            when Array; "id in #{quote_literal_list(expr)}"
+            when Integer; "id = #{quote_value(expr)}"
+            when Array; "id in (#{quote_values(expr)})"
           else
             raise ArgumentError
           end
@@ -657,11 +656,11 @@ module PgConn
     # Delete record(s)
     def delete(schema = nil, table, expr)
       table = [schema, table].compact.join(".")
-      constraint = 
+      constraint =
           case expr
             when String; expr
-            when Integer; "id = #{quote_literal(expr)}"
-            when Array; "id in #{quote_literal_list(expr)}"
+            when Integer; "id = #{quote_value(expr)}"
+            when Array; "id in (#{quote_values(expr)})"
           else
             raise ArgumentError
           end
@@ -676,7 +675,7 @@ module PgConn
     # is not.
     #
     # #exec pass Postgres exceptions to the caller unless :fail is false in which case
-    # it returns nil. 
+    # it returns nil.
     #
     # Note that postgres crashes the whole transaction stack if any error is
     # met so if you're inside a transaction, the transaction will be in an
@@ -692,7 +691,7 @@ module PgConn
     # There is not a corresponding #execute? method because any failure rolls
     # back the whole transaction stack. TODO: Check which exceptions that
     # should be captured
-    def exec?(sql, commit: true, silent: true) 
+    def exec?(sql, commit: true, silent: true)
       begin
         exec(sql, commit: commit, fail: true, silent: silent)
       rescue PG::Error
@@ -727,7 +726,7 @@ module PgConn
     # back to the original user
     #
     # FIXME: The out-commented transaction block makes postspec fail for some reason
-    # TODO: Rename 'sudo' because it acts just like it. 
+    # TODO: Rename 'sudo' because it acts just like it.
     def su(username, &block)
       raise Error, "Missing block in call to PgConn::Connection#su" if !block_given?
       realuser = self.value "select current_user"
@@ -776,7 +775,14 @@ module PgConn
         @savepoints = []
         pg_exec("begin")
         @error = @err = nil
-        @timestamp = pg_exec("select current_timestamp").values[0][0] if @pg_connection
+        # FIXME This special-cases the situation where commands are logged to a
+        # file instead of being executed. Maybe remove logging (or execute always
+        # and log as a side-effect)
+        if @pg_connection
+            @timestamp, @timestamptz = @pg_connection.exec(
+                'select current_timestamp, current_timestamp::timestamp without time zone'
+            ).tuple_values(0)
+        end
       end
     end
 
@@ -913,7 +919,7 @@ module PgConn
             @error = ex
             @err = nil
           end
-          if !silent # FIXME Why do we handle this? 
+          if !silent # FIXME Why do we handle this?
             $stderr.puts arg
             $stderr.puts
             $stderr.puts ex.message
@@ -933,20 +939,20 @@ module PgConn
       end
     end
 
-    def check_1c(r) 
+    def check_1c(r)
       case r.nfields
         when 0; raise Error, "No columns returned"
-        when 1; 
+        when 1;
       else
-        raise Error, "More than one column returned" 
+        raise Error, "More than one column returned"
       end
     end
 
-    def check_1r(r) 
+    def check_1r(r)
       if r.ntuples == 0
         raise Error, "No records returned"
-      elsif r.ntuples > 1 
-        raise Error, "More than one record returned" 
+      elsif r.ntuples > 1
+        raise Error, "More than one record returned"
       end
     end
   end

metadata

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