pg_conn 0.10.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7708b08a6ef0fcc12d0241ef9a084fe8adcfee342e03933f0f48ec313b9c48b5
-  data.tar.gz: 716d8e6de64dacab36db01303a47480e0d603a31a8fd24025441ca3a5c8adc2e
+  metadata.gz: '006583d902e2254d449d5275be8e91412f2d272ae6ce8de927a1f0bec87e1f05'
+  data.tar.gz: 4a983af740d9032ff6856fffea989510d3c00452dea075312b1c2c9c9857eaef
 SHA512:
-  metadata.gz: 12f8f90e3853a0882f93bccde0ea1ce564068612d5d876d26c159625eea4b541bd391b81fe10cbda24b96458129e7caf3c52fe0471d81efc210c151708224887
-  data.tar.gz: 5fd5a73696fbb9daa9dbc873daee9cf580974ab17bca8fc62743967160f2757e5aaafbb8ece7f8d8e32d122e5d0b3e7b6848a834b5bc16ee65099975ff7337dc
+  metadata.gz: c1ba88b850bb8abd1d0073b4be090033d1fbaabd51177f62476c511ab8dbf73867e657bd1daf8952d784253adb2d168109dba4dcc47105c4038bba03025cb533
+  data.tar.gz: 8402eb677b0c1b24dbea124c48862e25dd39430585a0b44969383c78548c256267ca2c06d6755ea77e6e591b4209e74c5eb5e99f97af864c474aa17afcd1f37c

data/TODO

@@ -1,4 +1,20 @@
 TODO
+  o Create aliases
+
+      tuple   ->  array
+      tuples      arrays
+      field
+      fields              # aka. 'column'
+      record      hash
+      records     hashes
+                  struct  # exists
+                  structs
+
+
+  o Make rdbms, role, schema, and session methods part of a PgModel file that
+    monkey patch PgConn objects to include a #model method that returns the 
+    top-level rdbms object
+
   o #group method
 
     group(query, column: nil)
@@ -59,6 +75,7 @@ TODO
   o Allow a :type argument to all query methods that can be used to specify the
     composition of anonymous record types
 
+  + Quote methods (value, identier, ... -> Postgres string)
 
 REFACTOR
   #!/usr/bin/env ruby

data/lib/pg_conn/version.rb

@@ -1,3 +1,3 @@
 module PgConn
-  VERSION = "0.10.0"
+  VERSION = "0.12.0"
 end

data/lib/pg_conn.rb

@@ -226,12 +226,42 @@ module PgConn
       end
     end
 
+    # Quote value as an identifier. Value should be a non-nil string
+    def quote_identifier(s) = @pg_connection.escape_identifier(s)
+
+    # Quote the value as a string. Emit 'null' if value is nil
+    #
+    # The value can be of any type but is converted to a string using #to_s
+    # before quoting. This works by default for the regular types Integer,
+    # true/false, Time/Date/DateTime, and arrays. Other types may require
+    # special handling
+    def quote_literal(value) 
+      case value
+        when String; @pg_connection.escape_literal(value)
+        when Integer, Float; value.to_s
+        when true, false; value.to_s
+        when nil; 'null'
+        when Date, DateTime; "'#{value}'"
+        when Time; "'#{value.strftime("%FT%T%:z")}'"
+        when Array; "array[#{value.map { |elem| quote_literal(elem) }.join(', ')}]"
+      else
+        @pg_connection.escape_literal(value.to_s)
+      end
+    end
+
+    # Quote array as a parenthesis-enclosed list of identifiers
+    def quote_identifier_list(values) = "(#{values.map { quote_identifier(_1) }.join(', ')})"
+
+    # Quote array as a parenthesis-enclosed list of literals
+    def quote_literal_list(values) = "(#{values.map { quote_literal(_1) }.join(', ')})"
+
     # :call-seq:
     #   exist?(query)
     #   exist?(table, id)
     #   eists?(table, where_clause)
     #
-    # Return true iff the query returns exactly one value
+    # Return true iff the query returns exactly one value. Use '!empty?' to
+    # check if the query returns one or more records
     def exist?(*args)
       arg1, arg2 = *args
       query = 
@@ -273,8 +303,9 @@ module PgConn
 
     # Return a single value. It is an error if the query doesn't return a
     # single record with a single column. If :transaction is true, the query
-    # will be executed in a transaction and be committed it :commit is true
-    # (the default). This can be used in 'insert ... returning ...' statements
+    # will be executed in a transaction and also be committed if :commit is
+    # true (this is the default). It can be used to execute 'insert' statements
+    # with a 'returning' clause
     def value(query) #, transaction: false, commit: true)
       r = pg_exec(query)
       check_1c(r)
@@ -421,8 +452,11 @@ module PgConn
       h
     end
 
+    # TODO: #group - same as table but partitions a table on the given keys
+    #       returning a map from key to array of records
+
     # TODO: An #array method that returns a map from id to tuple. Hmm... almost
-    # the same as #map
+    #       the same as #map
 
     # Return a hash from the record id column to an OpenStruct representation
     # of the record. If the :key_column option is defined it will be used

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pg_conn
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Claus Rasmussen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-08 00:00:00.000000000 Z
+date: 2024-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg