pg_conn 0.39.0 → 0.41.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ace2859257bedbbdeb816bfb04d9d7e23d686942c328e0d521568b6f4fc57e90
-  data.tar.gz: b803feaaaa619668cf00f57d2c5ffd072f04a149e144eafb061b85d4bf4cfad4
+  metadata.gz: 3fb72128df77cad4c2a3e5992f2d72a727af4b57fc898b8c2f7102ebd8df7ebd
+  data.tar.gz: ced62377173f5c33d428bec72c321a934947b5f4a24cac8467ad0c0955131a32
 SHA512:
-  metadata.gz: b2b913861f23ed8db39f8d521571bb054c3ed9ca1526b800c5f4982f9b4a9f285cc60b17dc59194b2df7cc2147019faaef7b838a4e10d4e8659941adb6fddde9
-  data.tar.gz: aac27bc4b8e7881ded4fdfe350a98be3de919052b9b5fcbca0d6767573dd9592d4922e3b2da968860b146d451b05bb96937e7344941d58048a104c5b8bda9081
+  metadata.gz: 0becdbeef4a4feb64c550e03d167143f59dda2a6eb986119eababab944cb22fefd36b13fd6fe2a4ea2866c8297bf2000f8683a3a86a47753a3cd462f214e007f
+  data.tar.gz: 829f2be06bfe9a278544b5c909841c418e3b248e8287dad640f43c28039f2dfc3ad028052f435c20248187774ddbbcbdd1d6df412b6b1f52fd481d5b5bfa2ce8

data/TODO

@@ -96,7 +96,6 @@ TODO
   o Proper implementation of call of functions and procedures: Functions should
     be called through #value, #tuple etc. and procedures through #call.
     Proceduer output parameters needs handling too
-  o Implement search_path
   o Create an abstract PgConnBase and have PgStmts (writes statements to array)
     and PgConn (sends statements to server) classes derived from it
   o fix silent
@@ -119,6 +118,7 @@ TODO
   + Quote methods (value, identier, ... -> Postgres string)
   + Have a 'with' method that combines multiple brachet-methods:
       conn.with(schema: public, transation: true) { ... }
+  + Implement search_path
 
 
 REFACTOR

data/lib/pg_conn/version.rb

@@ -1,3 +1,3 @@
 module PgConn
-  VERSION = "0.39.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
@@ -465,6 +489,18 @@ module PgConn
       quote_record_impl(data, schema_name, type, array: true, **opts)
     end
 
+    # Return current search path. Note that a search path is part of
+    # the transaction
+    def search_path
+      self.value("show search_path").split(/,\s*/) - %w("$user" pg_temp)
+    end
+
+    # Set search path. It accepts a schema or an array of schema names
+    def search_path=(schemas)
+      schema_array = Array(schemas).flatten - %w("$user" pg_temp) + %w(pg_temp)
+      self.exec "set search_path to #{schema_array.join(', ')}"
+    end
+
     # :call-seq:
     #   exist?(query)
     #   exist?(table, id)
@@ -893,17 +929,51 @@ module PgConn
       exec %(delete from #{table} where #{constraint})
     end
 
-    # Execute block with global options and resets afterwards. Currently only
-    # :silent, :notice and :warning is supported. Very useful in RSpec tests
+    # 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
     #
-    # TODO: :error, :fail, :symbol, :schema, :search_path
+    # 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
     #
     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
-        saved_options = @options.dup
         set_options(options)
-        yield
+        self.search_path = search_path if search_path
+        self.log = logging
+
+        inner = lambda {
+          if !commit.nil?
+            self.transaction(commit: commit) {
+              block.yield
+            }
+          else
+            block.yield
+          end
+        }
+
+        if username
+          self.su(username, &inner)
+        else
+          inner.call
+        end
       ensure
+        self.log = saved_logger if logging
+        self.search_path = saved_search_path if search_path
         set_options(saved_options)
       end
     end
@@ -975,16 +1045,23 @@ module PgConn
     # Switch user to the given user and execute the statement before swithcing
     # back to the original user
     #
-    # FIXME: The out-commented transaction block makes postspec fail for some reason
+    # FIXME:
+    #   The out-commented transaction block makes postspec fail for some
+    #   reason. Note that user-switches lives within transactions
+    #
     # 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"
       result = nil
 #     transaction(commit: false) {
+      begin
         execute "set session authorization #{username}"
         result = yield
+      ensure
         execute "set session authorization #{realuser}"
+      end
 #     }
       result
     end
@@ -1087,7 +1164,7 @@ module PgConn
     # that the transaction timestamp is set to the start of the first
     # transaction even if transactions are nested
     #
-    # FIXME: There is some strange problem in rspec where an #insert handles
+    # FIXME: There is some strange problem in rspec where #insert handles
     # an exception correctly while #exec, #execute, and #transaction does not
     def transaction(commit: true, &block)
       if block_given?
@@ -1271,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
@@ -1355,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.39.0
+  version: 0.41.0
 platform: ruby
 authors:
 - Claus Rasmussen