pg_conn 0.43.0 → 0.45.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9b707fbab740595f05ebe65cbd36f20e996875f568b1c26ad37b60cfb42cb65
-  data.tar.gz: e5984072e4e09eb9f7ac76915f00d29d08e1766e1ad8edef9b90d56fd61a7313
+  metadata.gz: 1068edc8dc81b7b2b04eecbf4ae901c7777cfbdeec63855baa3db16fee6d1a83
+  data.tar.gz: 694ed53ea67c15829d0c0788f76e7d45b00124acc158cb6aaa92205046a68c85
 SHA512:
-  metadata.gz: ed0c6002be578ca08f8a002b438c34eada70090bf362ea5fb9d642559101fc53827b42b2cf962e60803c02c011df5b6eef92bf5de5045faa18b47affc9a7a71c
-  data.tar.gz: d75913f57aac31fcb60c91f06958a746b20cd4559bd0feda169f12c48c173aa721423bacdfb883ed5612106f4e1320add1913d39e72d943abde483adb25a30df
+  metadata.gz: d7eadc60da62af57bf1b706cdc7ea8aa9361c20847e49cf16a9443dbda1434ae5ff185267c7e30e3c2a3da3cf35eaa3679e6d85bbdc8140325f40156bb94335b
+  data.tar.gz: 783af32e37c31aed616b6d9fa60780d484b966b3e8e345d194e96edf4f576a199a16177e080b5d915ec4cba6d4458d86c09ceb5df00f2f5f33938a6a815826c8

data/lib/pg_conn/version.rb

@@ -1,3 +1,3 @@
 module PgConn
-  VERSION = "0.43.0"
+  VERSION = "0.45.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
@@ -470,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
@@ -491,7 +498,7 @@ 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
+    # Return current search path. Note that the search path is part of
     # the transaction
     def search_path
       self.value("show search_path").split(/,\s*/) - %w("$user" pg_temp)
@@ -827,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)
     #
@@ -834,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
 
@@ -917,7 +931,7 @@ module PgConn
       exec %(update #{table} set #{assignments} where #{constraint})
     end
 
-    # Delete record(s)
+    # Delete record(s). See also #truncate
     def delete(schema = nil, table, expr)
       table = [schema, table].compact.join(".")
       constraint =
@@ -931,54 +945,21 @@ module PgConn
       exec %(delete from #{table} where #{constraint})
     end
 
-    # 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
-    #
-    # 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 (see #logger=), :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
+    # :call-seq:
+    #   truncate(qual_table_name...)
+    #   truncate(schema, table_name...)
     #
-    def with(**options, &block)
-      search_path = options.delete(:search_path)
-      username = options.delete(:username)
-      log = options.delete(:log)
-      commit = options.delete(:commit)
-
-      saved_options = @options.dup
-      saved_search_path = self.search_path if search_path
-      saved_logger = self.logger if log
-
-      begin
-        set_options(options)
-        self.search_path = search_path if search_path
-        self.logger = log if !log.nil?
-
-        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.logger = saved_logger if log
-        self.search_path = saved_search_path if search_path
-        set_options(saved_options)
+    # Empty a table using Sql 'truncate'. Arguments are flattened before processing
+    def truncate(*args)
+      args = args.flatten
+      if args.first =~ /\./
+        tables = args
+      else
+        schema = args.shift
+        !args.empty? or raise ArgumentError, "Table argument expected"
+        tables = args.map { |table| [schema, table].compact.join('.') }
       end
+      exec %(truncate #{quote_identifiers(tables)})
     end
 
     # Execute SQL statement(s) in a transaction and return the number of
@@ -1045,6 +1026,55 @@ module PgConn
       end
     end
 
+    # Execute block with the given set of global or local options and reset
+    # them afterwards
+    #
+    # 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, :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)
+      log = options.delete(:log)
+      commit = options.delete(:commit)
+
+      saved_options = @options.dup
+      saved_search_path = self.search_path if search_path
+      saved_logger = self.logger if log
+
+      begin
+        set_options(options)
+        self.search_path = search_path if search_path
+        self.logger = log if !log.nil?
+
+        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.logger = saved_logger if log
+        self.search_path = saved_search_path if search_path
+        set_options(saved_options)
+      end
+    end
+
     # Switch user to the given user and execute the statement before swithcing
     # back to the original user
     #

metadata

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