pg_conn 0.35.1 → 0.37.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c834402fcec956ffcb288fa201d7a6bade6b435002ae4758e1d86ea54f5a656
-  data.tar.gz: 20fafcbbe4c9f93ab426c6012e91f073e5224ab84d23948da894f4a64b5ef7c9
+  metadata.gz: 1edd50ec4e7e4f072a695cd044ab6d930dd14cdf763dd335ee0fbb65865e83c4
+  data.tar.gz: 3fe0cf2fe952999dceea4b6776155b7252d4e3f4aeeab7089348fc10ec9cfc5e
 SHA512:
-  metadata.gz: 1da57a0c7f8daffdaac879899d3bd7d9723a6512e038afda6996329717d9b0246f7b646161ee1f0a82e00d828a12b9328f212ef98b47132914e4c66dc9f1e888
-  data.tar.gz: 4fd13dd8b4130ebb417379dd3ec62a3476f7d721a7617d14ae2f5b88a0c1f13812dbd440931bc14c02c3db702f9ff181a8b4ab3116a08527293ae6b632c9cd0b
+  metadata.gz: a84b206b8c7b19813a3acbc63350289e6b072fc1ef8edb65901c99fe6f76fffe3c9ad9ab54d44105652902a8486e5904071e8f6712e73b7b9752019646a8bb8b
+  data.tar.gz: 6725ac8c9ef737db41770df819fefa88cb716ff189d714b139079475ee3255a59ec996e9d9c1e138b971b2b4908d6a91f08b9d7bc3731a7e46c32bd684f28000

data/TODO

@@ -1,11 +1,12 @@
 TODO
+  o Drop existing SQL output interface and instead implement a SQL logger
+
   o Add support for hstore (a hash)
 
   o Add a <fetch>! method. Require v2
       value?    0 or 1
       value     1
       values    0 or n
-      values?   0 or n
       values!   1 or more
 
   o Instrumentation of connection object
@@ -43,10 +44,6 @@ TODO
 
       server.call :sp_nic_update_comtext, str_id, str_comtext, site.current_user.id
 
-  o Have a 'with' method that combines multiple brachet-methods:
-
-      conn.with(schema: public, transation: true) { ... }
-
   o Create aliases
       tuple   ->  array
       tuples      arrays
@@ -120,6 +117,9 @@ TODO
     composition of anonymous record types
 
   + Quote methods (value, identier, ... -> Postgres string)
+  + Have a 'with' method that combines multiple brachet-methods:
+      conn.with(schema: public, transation: true) { ... }
+
 
 REFACTOR
   #!/usr/bin/env ruby

data/lib/pg_conn/schema_methods.rb

@@ -48,7 +48,7 @@ module PgConn
 
     # Empty all tables in the given schema
     def clean!(schema, exclude: [])
-      conn.session.triggers(false) {
+      conn.without_triggers {
         self.list_tables(schema, exclude: exclude).each { |table|
           conn.exec "delete from #{schema}.#{table}"
         }

data/lib/pg_conn/session_methods.rb

@@ -84,38 +84,6 @@ module PgConn
       end
     end
 
-    # Return true if session triggers are enabled. Triggers are enabled by
-    # default by Postgres
-    def triggers?() conn.value "select current_setting('session_replication_role') <> 'replica'" end
-
-    # Enable session triggers
-    def enable_triggers()
-      conn.execute "set session session_replication_role = DEFAULT"
-    end
-
-    # Disable session triggers
-    def disable_triggers()
-      conn.execute "set session session_replication_role = replica"
-    end
-
-    # Execute block with session triggers on or off
-    def triggers(on_off, &block)
-      begin
-        active = triggers?
-        if on_off && !active
-          enable_triggers
-        elsif !on_off && active
-          disable_triggers
-        end
-        yield
-      ensure
-        case active
-          when true; enable_triggers if !triggers?
-          when false; disable_triggers if triggers?
-        end
-      end
-    end
-
   private
     # Like #list but returns the PIDs of the users
     def pids(database, users)

data/lib/pg_conn/version.rb

@@ -1,3 +1,3 @@
 module PgConn
-  VERSION = "0.35.1"
+  VERSION = "0.37.0"
 end

data/lib/pg_conn.rb

@@ -40,13 +40,13 @@ module PgConn
   #
   def self.quote_identifier(s)
     s = s.to_s if s.is_a?(Symbol)
-    escape_identifier(s).gsub(/\./, '"."').sub(/"\*"/, "*")
+    Literal.new escape_identifier(s).gsub(/\./, '"."').sub(/"\*"/, "*")
   end
 
   # Quote identifiers and concatenate them using ',' as separator
-  def self.quote_identifiers(idents) = idents.map { |ident| quote_identifier(ident) }.join(", ")
+  def self.quote_identifiers(idents) = Literal.new idents.map { |ident| quote_identifier(ident) }.join(", ")
 
-  # Quote the value as a string. Emit 'null' if value is nil
+  # Quote the value as a string. Returns a Literal object
   #
   # The value can be of any type but is converted to a string using #to_s
   # before quoting. This works by default for the regular types Integer,
@@ -55,7 +55,7 @@ module PgConn
   #
   # Hashes are quoted as a literal JSON expression converted into the given
   # :json_type. If :json_type is nil, it is the application's responsibility to
-  # cast them to either 'json' or 'jsonb'
+  # cast the value to either 'json' or 'jsonb'
   #
   # Note that a tuple value (an array) must be quoted using #quote_tuple
   # because #quote_value would quote the tuple as an array value instead of a
@@ -67,30 +67,31 @@ module PgConn
   # is guaranteed to be non-empty. Nested arrays are not supported
   #
   def self.quote_value(value, elem_type: nil, json_type: nil)
-    case value
-      when Literal; value
-      when String; escape_literal(value)
-      when Integer, Float; value.to_s
-      when true, false; value.to_s
-      when nil; 'null'
-      when Date, DateTime; "'#{value}'"
-      when Time; "'#{value.strftime("%FT%T%:z")}'"
-      when Array
-        if value.empty?
-          elem_type or raise Error, "Empty array without elem_type"
-          "array[]::#{elem_type}[]"
+    Literal.new \
+        case value
+          when Literal; value
+          when String; escape_literal(value)
+          when Integer, Float; value.to_s
+          when true, false; value.to_s
+          when nil; 'null'
+          when Date, DateTime; "'#{value}'"
+          when Time; "'#{value.strftime("%FT%T%:z")}'"
+          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
+          when Hash; ["'#{value.to_json}'", json_type].compact.join('::')
         else
-          "array[#{value.map { |elem| quote_value(elem) }.join(', ')}]"
+          escape_literal(value.to_s)
         end
-      when Hash; ["'#{value.to_json}'", json_type].compact.join('::')
-    else
-      escape_literal(value.to_s)
-    end
   end
 
   # Quote values and concatenate them using ',' as separator
   def self.quote_values(values, **opts)
-    values.map { |value| quote_value(value, **opts) }.join(", ")
+    Literal.new values.map { |value| quote_value(value, **opts) }.join(", ")
   end
 
   # Quote an array of values as a tuple. The element types should be in the
@@ -101,7 +102,7 @@ module PgConn
   # Note that it is :elem_types (plural) and not :elem_type
   def self.quote_tuple(tuple, elem_types: nil, **opts)
     elem_types = Array(elem_types)
-    tuple.map { |value|
+    Literal.new tuple.map { |value|
       elem_type = value.is_a?(Array) ? elem_types&.shift : nil
       quote_value(value, **opts, elem_type: elem_type)
     }.join(", ")
@@ -109,7 +110,7 @@ module PgConn
 
   # Quote an array of tuples
   def self.quote_tuples(tuples, **opts)
-    tuples.map { |tuple| "(#{quote_tuple(tuple, **opts)})" }.join(", ")
+    Literal.new tuples.map { |tuple| "(#{quote_tuple(tuple, **opts)})" }.join(", ")
   end
 
   # Used to mark strings as literals that should not be quoted. This is the
@@ -132,7 +133,7 @@ module PgConn
 
     # Name of user
     def user() @pg_connection.user end
-    alias_method :username, :user # Obsolete FIXME Is it?
+    alias_method :username, :user # Obsolete FIXME Is it? No it is not!
 
     # Name of database
     def name() @pg_connection.db end
@@ -262,12 +263,13 @@ module PgConn
     # The possible keys of the connection hash are :host, :port, :dbname, :user,
     # and :password. The connection string can either be a space-separated list
     # of <key>=<value> pairs with the same keys as the hash, or a URI with the
-    # format 'postgres[ql]://[user[:password]@][host][:port][/name]
+    # format 'postgres[ql]://[user[:password]@][host][:port][/name]. TODO Also
+    # allow :database and :username
     #
     # If given an array argument, PgConn will not connect to the database and
     # instead write its commands to the array. In this case, methods extracting
     # values from the database (eg. #value) will return nil or raise an
-    # exception
+    # exception. TODO: Remove
     #
     # The last variant is used to establish a PgConn from an existing
     # connection. It doesn't change the connection settings and is not
@@ -429,8 +431,8 @@ module PgConn
       end
     end
 
-    # Mark argument as already being quoted. TODO: Make this the default in all
-    # quote methods
+    # Mark string argument as already being quoted. This is done automatically
+    # by all quote_* methods
     def literal(arg) Literal.new(arg) end
 
     # Connection member method variations of the PgConn quote class methods
@@ -784,6 +786,8 @@ module PgConn
     # There is no variant that takes a single tuple because it would then be
     # impossible to have array or hash field values
     def insert(*args, upsert: nil, **opts)
+      # Normalize arguments
+
       # Add options to args except the special :upsert option
       args << opts if !opts.empty?
 
@@ -1091,6 +1095,43 @@ module PgConn
       end
     end
 
+    # Return true if session triggers are enabled. Triggers are enabled by
+    # default by Postgres
+    def triggers?() self.value "select current_setting('session_replication_role') <> 'replica'" end
+
+    # Enable session triggers
+    def enable_triggers()
+      self.execute "set session session_replication_role = DEFAULT"
+    end
+
+    # Disable session triggers
+    def disable_triggers()
+      self.execute "set session session_replication_role = replica"
+    end
+
+    # Executes block without triggers
+    def without_triggers(&block)
+      triggers(false) { yield }
+    end
+
+    # Execute block with session triggers on or off
+    def triggers(on_off, &block)
+      begin
+        active = triggers?
+        if on_off && !active
+          enable_triggers
+        elsif !on_off && active
+          disable_triggers
+        end
+        yield
+      ensure
+        case active
+          when true; enable_triggers if !triggers?
+          when false; disable_triggers if triggers?
+        end
+      end
+    end
+
     def dump(*query)
       records = self.records(*query)
 
@@ -1155,17 +1196,16 @@ module PgConn
     end
 
     # Common implementation for #quote_record and #quote_records that avoids
-    # querying the database multiple times or duplication the code. The :array
-    # flag is true when called via #quote_records
+    # querying the database multiple times or duplication the code
     #
     # @data can be a Hash, Array, or OpenStruct. Hash keys must be symbols or
     # strings, they belong to the same namespace so :k and "k" refer to the
-    # same value
+    # same value. The :array flag is true when called via #quote_records
     #
     # Note that #quote_record_impl queries the database for information about
     # the type. TODO Cache this information?
-    def quote_record_impl(
-        datas, schema_name = nil, type, elem_types: nil, array: nil, **opts)
+    #
+    def quote_record_impl(datas, schema_name = nil, type, elem_types: nil, array: nil, **opts)
       datas = [datas] if !array
 
       pg_type = [schema_name, type].compact.join('.')
@@ -1192,10 +1232,9 @@ module PgConn
       }
 
       if array
-    #   papg_type(table, where_clause, fields...)
-        "array[#{literals.join(', ')}]::#{pg_type}[]"
+        Literal.new "array[#{literals.join(', ')}]::#{pg_type}[]"
       else
-        literals.first
+        Literal.new literals.first
       end
     end
 
@@ -1235,7 +1274,7 @@ module PgConn
     end
 
     STDOUT_PRODUCER = lambda { |msg| $stdout.puts msg }
-    STDERR_PRODUCER = lambda { |msg| $stderr.puts msg }
+    STDERR_PRODUCER = lambda { |msg| $stderr.puts msg; $stderr.flush }
     ERROR_PRODUCER = lambda { |msg, stmt| $stderr.puts stmt, nil, msg; $stderr.flush }
 
     # Map from message level to default producer. Note that we rely on the key

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pg_conn
 version: !ruby/object:Gem::Version
-  version: 0.35.1
+  version: 0.37.0
 platform: ruby
 authors:
 - Claus Rasmussen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-03-18 00:00:00.000000000 Z
+date: 2025-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg