pg_conn 0.42.1 → 0.44.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1885ef3f2d7a35d098e8bf78136148634c7b2d828b33477235a3cd1e38765df6
-  data.tar.gz: 853369281c40c6c6fc60a80785f6166d27fcc500cf7f1e216e348adfed778c30
+  metadata.gz: 51ccb11b750c683d57a02f274b4479366eced6d46c8908fed1e47aca302ff367
+  data.tar.gz: ad97bab6ef9fb0e7f821088a58772252ba72c4c9b695703b6ccd3a32fb1f5f80
 SHA512:
-  metadata.gz: b839c16a46f84ae89f8bb941d08972f24edd3f3bf777d17197ad1cdaf5bc8e5ab368135e8222dac202a3b3d670c04c027e7a9afff00a0b851af8d899f93baef9
-  data.tar.gz: a9171073a19b5ed326eaf58a4d4fbcd4b61fad8bc1154e0c000e99b61c94b068ba8f70c14e773bd9eb455d0d7dd111a2bac02c4646c07b1bd01843d134338cb4
+  metadata.gz: 629d0d6afb690bc1ef2f3490d395f81cf5177f86803f5e6049621fec73bcef07ed4b4c644cbf8e834059c7219076f2c62b1ad3b36e7fa1db344a415c9073213c
+  data.tar.gz: 50cbacb421a2e4f4332c53737d0b9e8cf88e2b6555fe3c814d728d957f5d1477065f4a5089ff7c11ca77c33634aabf8440bd6aebccee8b92e7c509b7a18ba3ef

data/lib/pg_conn/version.rb

@@ -1,3 +1,3 @@
 module PgConn
-  VERSION = "0.42.1"
+  VERSION = "0.44.0"
 end

data/lib/pg_conn.rb

@@ -113,6 +113,10 @@ module PgConn
     Literal.new tuples.map { |tuple| "(#{quote_tuple(tuple, **opts)})" }.join(", ")
   end
 
+  # Quote array elements as a comma separated list of values and enclosed en
+  # parenthesis. Eg. [1, 2] => "(1, 2)"
+  def self.quote_list(array, **opts) = quote_tuples([array], **opts)
+
   # Used to mark strings as literals that should not be quoted. This is the
   # case for row and record values
   class Literal < String; end
@@ -161,6 +165,31 @@ module PgConn
     # #exec or #transaction block. The timestamp includes the current time zone
     attr_reader :timestamptz
 
+    # Write a Sql statement to the logger if defined. Return the given sql
+    def log(sql)
+      case @logger
+        when nil; # do nothing
+        when IO, StringIO; @logger.puts sql
+        when Proc; @logger.call sql
+      else
+        raise ArgumentError
+      end
+      sql # for convenience in #pg_exec
+    end
+
+    # Return true if logging
+    def log?() = @logger != false
+
+    # Control logging of SQL commands. It can be assigned true, false, nil, an
+    # unary Proc object, or a IO or StringIO object. True causes the message to
+    # be printed to standard error, false and nil ignores it
+    def logger=(logger) @logger = (logger == true ? $stdout : logger || nil) end
+
+    # Return current logger or nil if not logging. Note that the logger object
+    # is equal to $stdout if the logger is set to true and nil if it is set to
+    # false
+    def logger() = @logger
+
     # Controls error messages. It can be assigned true, false, nil, or a Proc
     # object that recieves the message. True causes the message to be printed
     # to standard error, false ignores it, and nil resets the state to the
@@ -209,31 +238,7 @@ module PgConn
     def debug?() !debug.nil? end
     def debug=(value) set_option(:debug, value) end
 
-    # Log SQL or return current logger if sql is nil
-    def log(sql = nil)
-      case sql and dst = @options[:log]
-        when false; # do nothing
-        when true; $stderr.puts sql
-        when Proc; dst.call sql
-        when IO; dst.puts sql
-        when StringIO; dst.puts sql
-        when nil; return @options[:log]
-      else
-        raise "Oops"
-      end
-      sql # for convenience in #pg_exec
-    end
-
-    # Return true if logging is enabled
-    def log?() @options[:log] != false end
-
-    # Control logging of SQL commands. It can be assigned true, false, nil, an
-    # unary Proc object, or a IO object. True causes the message to be printed
-    # to standard error, false ignores it, and nil resets the state to the
-    # default given when the connection was initialized. Default false
-    def log=(value) set_option(:log, value) end
-
-    DEFAULT_OPTIONS = { silent: false, warning: true, notice: false, info: false, debug: false, log: false }
+    DEFAULT_OPTIONS = { silent: false, warning: true, notice: false, info: false, debug: false }
 
     # TODO: Move error message handling into the same framework as notice and
     # warning but we have a name collision just below that would need to be
@@ -425,6 +430,7 @@ module PgConn
       @rdbms = RdbmsMethods.new(self)
       @session = SessionMethods.new(self)
       @savepoints = nil # Stack of savepoint names. Nil if no transaction in progress
+      @log = nil
     end
 
     # Reset connection but keep noise level (TODO: How about the other
@@ -468,6 +474,9 @@ module PgConn
     def quote_tuple(tuple, **opts) = PgConn.quote_tuple(tuple, json_type: self.default_json_type, **opts)
     def quote_tuples(tuples, **opts) = PgConn.quote_tuples(tuples, json_type: self.default_json_type, **opts)
 
+    # Quote an array as a list. Eg. ["1", 2] => ('1', 2)
+    def quote_list(values, **opts) = quote_tuples([values], **opts)
+
     # Quote a record and cast it into the given type, the type can also be a
     # table or view. 'data' is an array, hash, or struct representation of the
     # record
@@ -825,6 +834,7 @@ module PgConn
     # :call-seq:
     #   insert(table, record|records)
     #   insert(table, fields, record|records|tuples|values)
+    #
     #   insert(schema, table, record|records)
     #   insert(schema, table, fields, record|records|tuples|values)
     #
@@ -832,6 +842,12 @@ module PgConn
     #
     # There is no variant that takes a single tuple because it would then be
     # impossible to have array or hash field values
+    #
+    # TODO
+    #   insert(table, [fields], field-name-map, object|objects)
+    #   field-name-map:
+    #     { database-column-name: object-method-name } # calls method on orbejt
+    #
     def insert(*args, upsert: nil, **opts)
       # Normalize arguments
 
@@ -932,29 +948,29 @@ module PgConn
     # Execute block with the given set of global or local options and reset
     # them afterwards
     #
-    # The global options :silent, :notice and :warning are supported, they're
-    # very useful in RSpec tests
+    # Global options are :silent, :notice and :warning, they're very useful in
+    # RSpec tests
     #
     # Local options are :search_path that runs the block with the given
-    # schemas, :username that runs the block as the given user, :log that controls logging,
-    # SQL, :commit that runs the block in a transaction if true or false; true
-    # commits the transaction and false rolls it back. It is not run in a
-    # transaction if :commit is nil
-    #
+    # schemas, :username that runs the block as the given user, :commit that
+    # runs the block in a transaction if true or false; true commits the
+    # transaction and false rolls it back (very rarely useful). It is not run
+    # in a transaction if :commit is nil. :log controls logging like
+    # #logger= but nil (the default) is a nop
     def with(**options, &block)
       search_path = options.delete(:search_path)
       username = options.delete(:username)
-      logging = options.delete(:log) || false
+      log = options.delete(:log)
       commit = options.delete(:commit)
 
       saved_options = @options.dup
       saved_search_path = self.search_path if search_path
-      saved_logger = self.log if logging
+      saved_logger = self.logger if log
 
       begin
         set_options(options)
         self.search_path = search_path if search_path
-        self.log = logging
+        self.logger = log if !log.nil?
 
         inner = lambda {
           if !commit.nil?
@@ -972,7 +988,7 @@ module PgConn
           inner.call
         end
       ensure
-        self.log = saved_logger if logging
+        self.logger = saved_logger if log
         self.search_path = saved_search_path if search_path
         set_options(saved_options)
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pg_conn
 version: !ruby/object:Gem::Version
-  version: 0.42.1
+  version: 0.44.0
 platform: ruby
 authors:
 - Claus Rasmussen