pg 1.3.4 → 1.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 474c4e35a7ad4b1699e8a9cba4962442e8a66899489db5f88aeccc41f3323ab2
-  data.tar.gz: 645b283b84bcd7676353ca62efde6bbd2b1a3feea7fc43ef1921882cce3ee032
+  metadata.gz: 0bb3782224d0c471417ceaa47d1355d5a06be2590fb3671fde73882346db0c5c
+  data.tar.gz: cd728b238d0b174f02a31c38afbd990177f81eec8516a1c953ee7bade1ddb4c6
 SHA512:
-  metadata.gz: 14595674eb04b991f007cf5e2b6a965574f9411ab352a26e3adc602eae72c0f03591d46c9d2e6bf25545cb19734877008868e95952f59a28ad5f1481ff7e0d15
-  data.tar.gz: 0d9c09338f69f695c751573b086d5feeafbd32781cfbd2b697ab36df898a210adf68e11e164165581fa9fdef39fea98d00b86fe7a08862b3d38709c87bfb1b0d
+  metadata.gz: d7b3ad8293281fb830274dc0e3d6e3c59c1dca85ea4f112f0aaf3a7629f61e315747f1e6ecad96e7a9528d42eeb3baafb819b7360d02acfc636ae7cb2d24ef42
+  data.tar.gz: f2476f2c7b1950346adf87c3675b838b9c57c909d6d787b50f4cf418ccb51296a02677faac7910378a665daa087f2aa552375f72ca42ba428e539cf07e80392c

data/History.rdoc

@@ -1,3 +1,22 @@
+== v1.3.5 [2022-03-31] Lars Kanis <lars@greiz-reinsdorf.de>
+
+Bugfixes:
+
+- Handle PGRES_COMMAND_OK in pgresult_stream_any. #447
+  Fixes usage when trying to stream the result of a procedure call that returns no results.
+
+Enhancements:
+
+- Rename BasicTypeRegistry#define_default_types to #register_default_types to use a more consistent terminology.
+  Keeping define_default_types for compatibility.
+- BasicTypeRegistry: return self instead of objects by accident.
+  This allows call chaining.
+- Add some April fun. #449
+
+Documentation:
+- Refine documentation of conn.socket_io and conn.connect_poll
+
+
 == v1.3.4 [2022-03-10] Lars Kanis <lars@greiz-reinsdorf.de>
 
 Bugfixes:

data/ext/extconf.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 require 'pp'
 require 'mkmf'
 
@@ -167,3 +169,32 @@ end
 create_header()
 create_makefile( "pg_ext" )
 
+
+def message!(important_message)
+	message important_message
+	if !$stdout.tty? && File.chardev?('/dev/tty')
+		File.open('/dev/tty', 'w') do |tty|
+			tty.print important_message
+		end
+	end
+rescue
+end
+
+if "2022-04-01" == Time.now.strftime("%Y-%m-%d")
+	message! <<-EOM
+===================================================================
+HEADS UP! Prepare for pg-1.4.2022 ! 🎉🎉🎉
+
+Now that psycopg3 has most of the features of ruby-pg, we plan to
+switch to using it as our foundation for the next pg release.
+It will run through pycall and requires a working python setup.
+This will minimize our development and maintenance efforts, since
+it allows us to use one and the same code base for both programming
+languages - ruby and python. 👏😃
+
+And we follow the recent merge of the Django and Rails teams! ❤️
+
+Stay up-to-date at https://github.com/ged/ruby-pg/issues/449
+===================================================================
+EOM
+end

data/ext/pg_connection.c

@@ -450,17 +450,18 @@ pgconn_s_encrypt_password(VALUE self, VALUE password, VALUE username)
  *   the asynchronous connection is ready
  *
  * Example:
- *   conn = PG::Connection.connect_start("dbname=mydatabase")
- *   socket = conn.socket_io
+ *   require "io/wait"
+ *
+ *   conn = PG::Connection.connect_start(dbname: 'mydatabase')
  *   status = conn.connect_poll
  *   while(status != PG::PGRES_POLLING_OK) do
  *     # do some work while waiting for the connection to complete
  *     if(status == PG::PGRES_POLLING_READING)
- *       if(not select([socket], [], [], 10.0))
+ *       unless conn.socket_io.wait_readable(10.0)
  *         raise "Asynchronous connection timed out!"
  *       end
  *     elsif(status == PG::PGRES_POLLING_WRITING)
- *       if(not select([], [socket], [], 10.0))
+ *       unless conn.socket_io.wait_writable(10.0)
  *         raise "Asynchronous connection timed out!"
  *       end
  *     end
@@ -818,13 +819,15 @@ pgconn_socket(VALUE self)
  * call-seq:
  *    conn.socket_io() -> IO
  *
- * Fetch a memorized IO object created from the Connection's underlying socket.
- * This object can be used for IO.select to wait for events while running
- * asynchronous API calls.
+ * Fetch an IO object created from the Connection's underlying socket.
+ * This object can be used per <tt>socket_io.wait_readable</tt>, <tt>socket_io.wait_writable</tt> or for <tt>IO.select</tt> to wait for events while running asynchronous API calls.
+ * <tt>IO#wait_*able</tt> is is <tt>Fiber.scheduler</tt> compatible in contrast to <tt>IO.select</tt>.
+ *
+ * The IO object can change while the connection is established, but is memorized afterwards.
+ * So be sure not to cache the IO object, but repeat calling <tt>conn.socket_io</tt> instead.
  *
- * Using this instead of #socket avoids the problem of the underlying connection
- * being closed by Ruby when an IO created using <tt>IO.for_fd(conn.socket)</tt>
- * goes out of scope. In contrast to #socket, it also works on Windows.
+ * Using this method also works on Windows in contrast to using #socket .
+ * It also avoids the problem of the underlying connection being closed by Ruby when an IO created using <tt>IO.for_fd(conn.socket)</tt> goes out of scope.
  */
 static VALUE
 pgconn_socket_io(VALUE self)

data/ext/pg_record_coder.c

@@ -344,10 +344,12 @@ record_isspace(char ch)
  *   oids = conn.exec( "SELECT (NULL::complex).*" )
  *   # Build a type map (PG::TypeMapByColumn) for decoding the "complex" type
  *   dtm = PG::BasicTypeMapForResults.new(conn).build_column_map( oids )
- *   # Register a record decoder for decoding our type "complex"
- *   PG::BasicTypeRegistry.register_coder(PG::TextDecoder::Record.new(type_map: dtm, name: "complex"))
- *   # Apply the basic type registry to all results retrieved from the server
- *   conn.type_map_for_results = PG::BasicTypeMapForResults.new(conn)
+ *   # Build a type map and populate with basic types
+ *   btr = PG::BasicTypeRegistry.new.register_default_types
+ *   # Register a new record decoder for decoding our type "complex"
+ *   btr.register_coder(PG::TextDecoder::Record.new(type_map: dtm, name: "complex"))
+ *   # Apply our basic type registry to all results retrieved from the server
+ *   conn.type_map_for_results = PG::BasicTypeMapForResults.new(conn, registry: btr)
  *   # Now queries decode the "complex" type (and many basic types) automatically
  *   conn.exec("SELECT * FROM my_table").to_a
  *   # => [{"v1"=>[2.0, 3.0], "v2"=>[4.0, 5.0]}, {"v1"=>[6.0, 7.0], "v2"=>[8.0, 9.0]}]

data/ext/pg_result.c

@@ -1457,6 +1457,7 @@ pgresult_stream_any(VALUE self, void (*yielder)(VALUE, int, int, void*), void* d
 
 		switch( PQresultStatus(pgresult) ){
 			case PGRES_TUPLES_OK:
+			case PGRES_COMMAND_OK:
 				if( ntuples == 0 )
 					return self;
 				rb_raise( rb_eInvalidResultStatus, "PG::Result is not in single row mode");

data/lib/pg/basic_type_registry.rb

@@ -22,7 +22,7 @@ require 'pg' unless defined?( PG )
 #   end
 #
 #   conn = PG.connect
-#   regi = PG::BasicTypeRegistry.new.define_default_types
+#   regi = PG::BasicTypeRegistry.new.register_default_types
 #   regi.register_type(0, 'inet', InetEncoder, InetDecoder)
 #   conn.type_map_for_results = PG::BasicTypeMapForResults.new(conn, registry: regi)
 class PG::BasicTypeRegistry
@@ -184,6 +184,7 @@ class PG::BasicTypeRegistry
 		name = coder.name || raise(ArgumentError, "name of #{coder.inspect} must be defined")
 		h[:encoder][name] = coder if coder.respond_to?(:encode)
 		h[:decoder][name] = coder if coder.respond_to?(:decode)
+		self
 	end
 
 	# Register the given +encoder_class+ and/or +decoder_class+ for casting a PostgreSQL type.
@@ -193,6 +194,7 @@ class PG::BasicTypeRegistry
 	def register_type(format, name, encoder_class, decoder_class)
 		register_coder(encoder_class.new(name: name, format: format)) if encoder_class
 		register_coder(decoder_class.new(name: name, format: format)) if decoder_class
+		self
 	end
 
 	# Alias the +old+ type to the +new+ type.
@@ -205,10 +207,11 @@ class PG::BasicTypeRegistry
 				@coders_by_name[format][ende].delete(new)
 			end
 		end
+		self
 	end
 
 	# Populate the registry with all builtin types of ruby-pg
-	def define_default_types
+	def register_default_types
 		register_type 0, 'int2', PG::TextEncoder::Integer, PG::TextDecoder::Integer
 		alias_type    0, 'int4', 'int2'
 		alias_type    0, 'int8', 'int2'
@@ -281,8 +284,10 @@ class PG::BasicTypeRegistry
 		self
 	end
 
+	alias define_default_types register_default_types
+
 	# @private
-	DEFAULT_TYPE_REGISTRY = PG::BasicTypeRegistry.new.define_default_types
+	DEFAULT_TYPE_REGISTRY = PG::BasicTypeRegistry.new.register_default_types
 
 	# Delegate class method calls to DEFAULT_TYPE_REGISTRY
 	class << self

data/lib/pg/version.rb

@@ -1,4 +1,4 @@
 module PG
 	# Library version
-	VERSION = '1.3.4'
+	VERSION = '1.3.5'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pg
 version: !ruby/object:Gem::Version
-  version: 1.3.4
+  version: 1.3.5
 platform: ruby
 authors:
 - Michael Granger
@@ -36,7 +36,7 @@ cert_chain:
   oL1mUdzB8KrZL4/WbG5YNX6UTtJbIOu9qEFbBAy4/jtIkJX+dlNoFwd4GXQW1YNO
   nA==
   -----END CERTIFICATE-----
-date: 2022-03-10 00:00:00.000000000 Z
+date: 2022-03-31 00:00:00.000000000 Z
 dependencies: []
 description: Pg is the Ruby interface to the PostgreSQL RDBMS. It works with PostgreSQL
   9.3 and later.