pg_conn 0.40.0 → 0.41.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f946804765203fcdb2c40e704831e488e2a47c1975ce371217faa528c533141c
-  data.tar.gz: fa08dce1b7e10162aaa5e2cd20e0ada630f95a794462528a73969c6bd5ad484c
+  metadata.gz: 3fb72128df77cad4c2a3e5992f2d72a727af4b57fc898b8c2f7102ebd8df7ebd
+  data.tar.gz: ced62377173f5c33d428bec72c321a934947b5f4a24cac8467ad0c0955131a32
 SHA512:
-  metadata.gz: 41262613001be5709f861d125af4287a82968ce60878dca3c885a34033d0ef78786b76a774738123fbd97ffdaaad5821cf480899cc56772f3691757c831de8a7
-  data.tar.gz: de131f33563c6ec6e52c03d4537dd3ab730506534e84a0aae1aefaefc763a05fd45376713a4ee2d91177967c2def949c566bf137376f6c61496f0e7f691ad97f
+  metadata.gz: 0becdbeef4a4feb64c550e03d167143f59dda2a6eb986119eababab944cb22fefd36b13fd6fe2a4ea2866c8297bf2000f8683a3a86a47753a3cd462f214e007f
+  data.tar.gz: 829f2be06bfe9a278544b5c909841c418e3b248e8287dad640f43c28039f2dfc3ad028052f435c20248187774ddbbcbdd1d6df412b6b1f52fd481d5b5bfa2ce8

data/lib/pg_conn/version.rb

@@ -1,3 +1,3 @@
 module PgConn
-  VERSION = "0.40.0"
+  VERSION = "0.41.0"
 end

data/lib/pg_conn.rb

@@ -209,7 +209,31 @@ module PgConn
     def debug?() !debug.nil? end
     def debug=(value) set_option(:debug, value) end
 
-    DEFAULT_OPTIONS = { silent: false, warning: true, notice: false, info: false, debug: false }
+    # 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 }
 
     # 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
@@ -912,22 +936,25 @@ module PgConn
     # 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, and :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, :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
     #
     def with(**options, &block)
       search_path = options.delete(:search_path)
       username = options.delete(:username)
+      logging = options.delete(:log) || false
       commit = options.delete(:commit)
 
       saved_options = @options.dup
       saved_search_path = self.search_path if search_path
+      saved_logger = self.log if logging
 
       begin
         set_options(options)
         self.search_path = search_path if search_path
+        self.log = logging
 
         inner = lambda {
           if !commit.nil?
@@ -945,6 +972,7 @@ module PgConn
           inner.call
         end
       ensure
+        self.log = saved_logger if logging
         self.search_path = saved_search_path if search_path
         set_options(saved_options)
       end
@@ -1320,12 +1348,16 @@ module PgConn
       # Assign default
       value = @default_options[option] if value.nil?
 
+      # Set new value. Can be true, false, or a Proc object. The :log option
+      # also allows an IO og StringIO object
+      @options[option] = value
+
+      # Exit early if log
+      return if option == :log
+
       # Find current message level
       old_level = DEFAULT_PRODUCER.keys.find { |level| @producers[level] } || :error
 
-      # Set new value. Can be true, false, or a Proc object
-      @options[option] = value
-
       # Set producer
       case option
         when :silent
@@ -1404,17 +1436,17 @@ module PgConn
           saved_silent = self.silent
           self.silent = silent
 
-          last_stmt = nil # To make the current SQL statement visible to the rescue clause. FIXME Not used?
+          last_stmt = nil # To make the last (failed) SQL statement visible to the rescue clause. FIXME Not used?
           if arg.is_a?(String)
             return nil if arg == ""
             last_stmt = arg
-            @pg_connection.exec(last_stmt)
+            @pg_connection.exec(log arg)
           else
             stmts = arg.flatten.compact
             return nil if stmts.empty?
 #           stmts.unshift("set on_error_exit stop")
             last_stmt = stmts.last
-            @pg_connection.exec(stmts.join(";\n"))
+            @pg_connection.exec(log stmts.join(";\n"))
           end
         rescue PG::Error => ex
           if @error.nil?

metadata

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