pg_conn 0.25.0 → 0.26.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb9303d38e0364b374379d8d0549d461decf393d1a20c5a97da42b1c0b0d7e17
-  data.tar.gz: 53512feaaff24b3b6e8b7366a0c860dac0d38f8880698570cfa16cffbb7a46b2
+  metadata.gz: 6dc75936f3c9bd5db772a2f8a80aa8e8bb25cbd1ae2181492766a7ed6ab9104a
+  data.tar.gz: 8ac094777a20c074f4a018b4bb0ea53efff219eb2401e18bf9c5887721fbb1fe
 SHA512:
-  metadata.gz: b9efb0689c559425bee8bebb5d984c72222e8bd2377803cc8c1415d5b253ada2f0913dc70b17ef12c0f9677b26e1db60accb5bdb66de41220f7001a2628c013c
-  data.tar.gz: fcd4f4e04157e2cdf10226f1a4545ab8fd66ce960cf14c732e0eceda9450e3c94b211277da303e8338aff7fbfbb3eb09bcd6b5946e979aa383f5f3b803ac86d7
+  metadata.gz: 8651be5de05b08d991cc257dab9cc060c4dfe22f8c22b2489f7e9ecc3654d51c55ad8494287b1cb829dc92a50cf60eb777b8814bcc23b348143caf9339729a8c
+  data.tar.gz: 8c11d1e8cb3ceb859438e9ccb98fe38de9ed9126c449c58972cef97d9fb3108c87ea2a18899aea9d500eaa249625d0a1a783176e3fd4e8bc7ebe035cec31f67b

data/TODO

@@ -1,4 +1,9 @@
 TODO
+  o Add a <fetch>! method
+      value? 0 or 1
+      value 1
+      values 0 or n
+      values! 1 or more
 
   o Instrumentation of connection object
 

data/lib/pg_conn/version.rb

@@ -1,3 +1,3 @@
 module PgConn
-  VERSION = "0.25.0"
+  VERSION = "0.26.1"
 end

data/lib/pg_conn.rb

@@ -269,8 +269,8 @@ module PgConn
     #
     # The :elem_type option can be a postgres type name (String or Symbol) or
     # an array of type names. It is used as the required explicit element
-    # type when the argument is an empty array. The element types shoud be in
-    # the same order as the array arguments. Nested arrays is not supported
+    # type when the argument is an empty array. It is not needed if the array
+    # is guaranteed to be non-empty. Nested arrays are not supported
     #
     def quote_value(value, elem_type: nil)
       case value
@@ -294,19 +294,42 @@ module PgConn
 
     # Quote values and concatenate them using ',' as separator
     def quote_values(values, elem_type: nil)
-      elem_types = Array(elem_type)
-      values.map { |value|
+      values.map { |value| quote_value(value, elem_type: elem_type) }.join(", ")
+    end
+
+   # Quote an array of values as a tuple. The element types should be in the
+   # same order as the array arguments. #quote_tuples is same as #quote_values
+   # except the values may have different types (this makes no difference
+   # except in the case when the tuple may contain empty array(s))
+   def quote_tuple(tuple, elem_types: nil)
+      elem_types = Array(elem_types)
+      tuple.map { |value|
         elem_type = value.is_a?(Array) ? elem_types&.shift : nil
         quote_value(value, elem_type: elem_type)
       }.join(", ")
     end
 
-    # Quote an array of values as a tuple. Just an alias for #quote_values
-    def quote_tuple(tuple, elem_type: nil) = quote_values(tuple, elem_type: elem_type)
-
     # Quote an array of tuples
-    def quote_tuples(tuples, elem_type: nil)
-      tuples.map { |tuple| "(#{quote_values(tuple, elem_type: elem_type)})" }.join(", ")
+    def quote_tuples(tuples, elem_types: nil)
+      tuples.map { |tuple| "(#{quote_tuple(tuple, elem_types: elem_types)})" }.join(", ")
+    end
+
+    # 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
+    #
+    # Note that the fields are retrived from the database so this method is not
+    # as fast as the other quote-methods. It is however very convenient when
+    # you're testing and need a composite type because record-quoting can
+    # easily become unwieldly
+    def quote_record(data, schema_name = nil, type, elem_types: nil)
+      quote_record_impl(data, schema_name, type, elem_types: elem_types, array: false)
+    end
+
+    # Quote an array of records. The type is the record type, not the type of
+    # the enclosing array
+    def quote_records(data, schema_name = nil, type, elem_types: nil)
+      quote_record_impl(data, schema_name, type, elem_types: elem_types, array: true)
     end
 
     # :call-seq:
@@ -651,7 +674,7 @@ module PgConn
 
       # Find method and normalize data
       if data.is_a?(Array) # Array of tuples
-        method = :values
+        method = :values # The pg_conn method when multiple records are inserted
         if data.empty?
           return []
         elsif data.first.is_a?(Array) # Tuple (array) element. Requires the 'fields' argument
@@ -664,7 +687,7 @@ module PgConn
           raise ArgumentError
         end
       elsif data.is_a?(Hash)
-        method = :value
+        method = :value # The pg_conn method when only one record is inserted
         fields ||= data.keys
         tuples = [fields.map { |field| data[field] }]
       else
@@ -937,6 +960,42 @@ module PgConn
       end
     end
 
+    # Common implementation for #quote_record and #quote_records that avoids
+    # query the database multiple times while not duplication the code. the
+    # :array flag controls the mode
+    def quote_record_impl(datas, schema_name = nil, type, elem_types: nil, array: nil)
+      pg_type = [schema_name, type].compact.join('.')
+      fields = self.values(%(
+        select attname
+        from pg_attribute
+        where
+          attrelid = '#{pg_type}'::regclass
+          and attnum > 0
+          and not attisdropped
+        order by attnum
+      )).map(&:to_sym)
+
+      datas = [datas] if !array
+
+      literals = datas.map { |data|
+        values =
+            case data
+              when Hash; fields.map { |f| data[f] }
+              when OpenStruct; fields.map { |f| data.send(f) }
+              when Array; data
+            else
+              raise Error, "Illegal value #{data.inspect}"
+            end
+        "(#{quote_tuple(values, elem_types: elem_types)})::#{pg_type}"
+      }
+
+      if array
+        "array[#{literals.join(', ')}]::#{pg_type}[]"
+      else
+        literals.first
+      end
+    end
+
     # :call-seq:
     #   pg_exec(string)
     #   pg_exec(array)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pg_conn
 version: !ruby/object:Gem::Version
-  version: 0.25.0
+  version: 0.26.1
 platform: ruby
 authors:
 - Claus Rasmussen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-14 00:00:00.000000000 Z
+date: 2024-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg