Merge branch 'master' of github.com:ged/ruby-pg

Author: larskanis

.github/workflows/binary-gems.yml

@@ -171,3 +171,26 @@ jobs:
           docker run --rm --privileged multiarch/qemu-user-static --reset -p yes
           docker build --rm --platform ${{matrix.image_platform}} --build-arg from_image=${{matrix.from_image}} -t ruby-test -f spec/env/Dockerfile.${{matrix.dockerfile}} .
           docker run --rm -t --network=host -v `pwd`:/build ruby-test
+
+  job_binary_yugabyte:
+    name: yugabyte (${{matrix.gem_platform}}
+    needs: rcd_build
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - gem_platform: x86_64-linux
+
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Download gem-${{ matrix.gem_platform }}
+        uses: actions/download-artifact@v4
+        with:
+          name: binary-gem-${{ matrix.gem_platform }}
+      - name: Build image and Run tests
+        run: |
+          sudo apt-get install -y docker-compose
+          cp -v  pg-*.gem   misc/yugabyte/
+          cd misc/yugabyte
+          docker-compose up --abort-on-container-exit  --exit-code-from pg

Gemfile

@@ -13,7 +13,7 @@ end
 group :test do
   gem "bundler", ">= 1.16", "< 3.0"
   gem "rake-compiler", "~> 1.0"
-  gem "rake-compiler-dock", "~> 1.5"
+  gem "rake-compiler-dock", "~> 1.8.0"
   gem "rspec", "~> 3.5"
   # "bigdecimal" is a gem on ruby-3.4+ and it's optional for ruby-pg.
   # Specs should succeed without it, but 4 examples are then excluded.

Rakefile

@@ -47,7 +47,7 @@ CrossLibraries = [
 	['x64-mingw-ucrt', 'mingw64', 'x86_64-w64-mingw32'],
 	['x86-mingw32', 'mingw', 'i686-w64-mingw32'],
 	['x64-mingw32', 'mingw64', 'x86_64-w64-mingw32'],
-	['x86_64-linux', 'linux-x86_64', 'x86_64-redhat-linux-gnu'],
+	['x86_64-linux', 'linux-x86_64', 'x86_64-linux-gnu'],
 ].map do |platform, openssl_config, toolchain|
 	CrossLibrary.new platform, openssl_config, toolchain
 end
@@ -100,13 +100,12 @@ CrossLibraries.each do |xlib|
 	desc "Build fat binary gem for platform #{platform}"
 	task "gem:native:#{platform}" => ['gem:native:prepare'] do
 		RakeCompilerDock.sh <<-EOT, platform: platform
-			#{ "sudo yum install -y perl-IPC-Cmd bison flex &&" if platform =~ /linux/ }
 			#{ # remove nm on Linux to suppress PostgreSQL's check for exit which raises thread_exit as a false positive:
-				"sudo mv `which nm` `which nm`.bak && sudo mv `which nm` `which nm`.bak &&" if platform =~ /linux/ }
-			#{ "sudo apt-get update && sudo apt-get install -y bison flex &&" if platform =~ /mingw/ }
+				"sudo mv `which nm` `which nm`.bak &&" if platform =~ /linux/ }
+			sudo apt-get update && sudo apt-get install -y bison flex &&
 			(cp build/gem/gem-*.pem ~/.gem/ || true) &&
 			bundle install --local &&
-			rake native:#{platform} pkg/#{$gem_spec.full_name}-#{platform}.gem MAKEOPTS=-j`nproc` RUBY_CC_VERSION=3.3.0:3.2.0:3.1.0:3.0.0:2.7.0
+			rake native:#{platform} pkg/#{$gem_spec.full_name}-#{platform}.gem MAKEOPTS=-j`nproc` RUBY_CC_VERSION=3.4.1:3.3.5:3.2.6:3.1.6:3.0.7:2.7.8
 		EOT
 	end
 	desc "Build the native binary gems"

ext/extconf.rb

@@ -96,6 +96,9 @@ def work_path
 			# See https://github.com/cockroachdb/cockroach/issues/49734
 			recipe.configure_options << "CFLAGS=-fcommon#{" -fPIC" if RUBY_PLATFORM =~ /linux/}"
 			recipe.configure_options << "--without-keyutils"
+			recipe.configure_options << "krb5_cv_attr_constructor_destructor=yes"
+			recipe.configure_options << "ac_cv_func_regcomp=yes"
+			recipe.configure_options << "ac_cv_printf_positional=yes"
 			recipe.host = toolchain
 			recipe.cook_and_activate
 		end
@@ -111,6 +114,8 @@ def configure_defaults
 					*(RUBY_PLATFORM=~/linux/ ? ['--with-gssapi'] : []),
 					'--without-zlib',
 					'--without-icu',
+					'--without-readline',
+					'ac_cv_search_gss_store_cred_into=',
 				]
 			end
 			def compile
@@ -135,6 +140,8 @@ def install
 			File.join(postgresql_recipe.port_path, "lib/libpq-ruby-pg.so.1")
 	# Avoid dependency to external libgcc.dll on x86-mingw32
 	$LDFLAGS << " -static-libgcc"
+	# Avoid: "libpq.so: undefined reference to `dlopen'" in cross-ruby-2.7.8
+	$LDFLAGS << " -Wl,--no-as-needed"
 	# Find libpq in the ports directory coming from lib/3.3
 	# It is shared between all compiled ruby versions.
 	$LDFLAGS << " '-Wl,-rpath=$$ORIGIN/../../ports/#{gem_platform}/lib'"

ext/pg.h

@@ -206,6 +206,7 @@ typedef struct {
 	t_pg_coder comp;
 	t_pg_coder *elem;
 	int needs_quotation;
+	int dimensions;
 	char delimiter;
 } t_pg_composite_coder;
 

ext/pg_binary_encoder.c

@@ -320,6 +320,9 @@ pg_bin_enc_date(t_pg_coder *this, VALUE value, char *out, VALUE *intermediate, i
  * This encoder expects an Array of values or sub-arrays as input.
  * Other values are passed through as byte string without interpretation.
  *
+ * It is possible to enforce a number of dimensions to be encoded by #dimensions= .
+ * Deeper nested arrays are then passed to the elements encoder and less nested arrays raise an ArgumentError.
+ *
  * The accessors needs_quotation and delimiter are ignored for binary encoding.
  *
  */
@@ -346,7 +349,8 @@ pg_bin_enc_array(t_pg_coder *conv, VALUE value, char *out, VALUE *intermediate,
 				dim_sizes[ndim-1] = RARRAY_LENINT(el1);
 				nitems *= dim_sizes[ndim-1];
 				el2 = rb_ary_entry(el1, 0);
-				if (TYPE(el2) == T_ARRAY) {
+				if ( (this->dimensions < 0 || ndim < this->dimensions) &&
+						TYPE(el2) == T_ARRAY) {
 					ndim++;
 					if (ndim > MAXDIM)
 						rb_raise( rb_eArgError, "unsupported number of array dimensions: >%d", ndim );
@@ -356,6 +360,9 @@ pg_bin_enc_array(t_pg_coder *conv, VALUE value, char *out, VALUE *intermediate,
 				el1 = el2;
 			}
 		}
+		if( this->dimensions >= 0 && (ndim==0 ? 1 : ndim) != this->dimensions ){
+			rb_raise(rb_eArgError, "less array dimensions to encode (%d) than expected (%d)", ndim, this->dimensions);
+		}
 
 		if(out){
 			/* Second encoder pass -> write data to `out` */

ext/pg_coder.c

@@ -135,6 +135,7 @@ pg_composite_encoder_allocate( VALUE klass )
 	this->elem = NULL;
 	this->needs_quotation = 1;
 	this->delimiter = ',';
+	this->dimensions = -1;
 	rb_iv_set( self, "@elements_type", Qnil );
 	return self;
 }
@@ -157,6 +158,7 @@ pg_composite_decoder_allocate( VALUE klass )
 	this->elem = NULL;
 	this->needs_quotation = 1;
 	this->delimiter = ',';
+	this->dimensions = -1;
 	rb_iv_set( self, "@elements_type", Qnil );
 	return self;
 }
@@ -421,6 +423,49 @@ pg_coder_delimiter_get(VALUE self)
 	return rb_str_new(&this->delimiter, 1);
 }
 
+/*
+ * call-seq:
+ *    coder.dimensions = Integer
+ *    coder.dimensions = nil
+ *
+ * Set number of array dimensions to be encoded.
+ *
+ * This property ensures, that this number of dimensions is always encoded.
+ * If less dimensions than this number are in the given value, an ArgumentError is raised.
+ * If more dimensions than this number are in the value, the Array value is passed to the next encoder.
+ *
+ * Setting dimensions is especially useful, when a Record shall be encoded into an Array, since the Array encoder can not distinguish if the array shall be encoded as a higher dimension or as a record otherwise.
+ *
+ * The default is +nil+.
+ *
+ * See #dimensions
+ */
+static VALUE
+pg_coder_dimensions_set(VALUE self, VALUE dimensions)
+{
+	t_pg_composite_coder *this = RTYPEDDATA_DATA(self);
+	rb_check_frozen(self);
+	if(!NIL_P(dimensions) && NUM2INT(dimensions) < 0)
+		rb_raise( rb_eArgError, "dimensions must be nil or >= 0");
+	this->dimensions = NIL_P(dimensions) ? -1 : NUM2INT(dimensions);
+	return dimensions;
+}
+
+/*
+ * call-seq:
+ *    coder.dimensions -> Integer | nil
+ *
+ * Get number of enforced array dimensions or +nil+ if not set.
+ *
+ * See #dimensions=
+ */
+static VALUE
+pg_coder_dimensions_get(VALUE self)
+{
+	t_pg_composite_coder *this = RTYPEDDATA_DATA(self);
+	return this->dimensions < 0 ? Qnil : INT2NUM(this->dimensions);
+}
+
 /*
  * call-seq:
  *    coder.elements_type = coder
@@ -602,6 +647,8 @@ init_pg_coder(void)
 	 *
 	 * This is the base class for all type cast classes of PostgreSQL types,
 	 * that are made up of some sub type.
+	 *
+	 * See PG::TextEncoder::Array, PG::TextDecoder::Array, PG::BinaryEncoder::Array, PG::BinaryDecoder::Array, etc.
 	 */
 	rb_cPG_CompositeCoder = rb_define_class_under( rb_mPG, "CompositeCoder", rb_cPG_Coder );
 	rb_define_method( rb_cPG_CompositeCoder, "elements_type=", pg_coder_elements_type_set, 1 );
@@ -610,6 +657,8 @@ init_pg_coder(void)
 	rb_define_method( rb_cPG_CompositeCoder, "needs_quotation?", pg_coder_needs_quotation_get, 0 );
 	rb_define_method( rb_cPG_CompositeCoder, "delimiter=", pg_coder_delimiter_set, 1 );
 	rb_define_method( rb_cPG_CompositeCoder, "delimiter", pg_coder_delimiter_get, 0 );
+	rb_define_method( rb_cPG_CompositeCoder, "dimensions=", pg_coder_dimensions_set, 1 );
+	rb_define_method( rb_cPG_CompositeCoder, "dimensions", pg_coder_dimensions_get, 0 );
 
 	/* Document-class: PG::CompositeEncoder < PG::CompositeCoder */
 	rb_cPG_CompositeEncoder = rb_define_class_under( rb_mPG, "CompositeEncoder", rb_cPG_CompositeCoder );

ext/pg_text_encoder.c

@@ -537,14 +537,18 @@ quote_string(t_pg_coder *this, VALUE value, VALUE string, char *current_out, int
 }
 
 static char *
-write_array(t_pg_composite_coder *this, VALUE value, char *current_out, VALUE string, int quote, int enc_idx)
+write_array(t_pg_composite_coder *this, VALUE value, char *current_out, VALUE string, int quote, int enc_idx, int dimension)
 {
 	int i;
 
 	/* size of "{}" */
 	current_out = pg_rb_str_ensure_capa( string, 2, current_out, NULL );
 	*current_out++ = '{';
 
+	if( RARRAY_LEN(value) == 0 && this->dimensions >= 0 && dimension != this->dimensions ){
+		rb_raise(rb_eArgError, "less array dimensions to encode (%d) than expected (%d)", dimension, this->dimensions);
+	}
+
 	for( i=0; i<RARRAY_LEN(value); i++){
 		VALUE entry = rb_ary_entry(value, i);
 
@@ -554,17 +558,26 @@ write_array(t_pg_composite_coder *this, VALUE value, char *current_out, VALUE st
 		}
 
 		switch(TYPE(entry)){
-			case T_ARRAY:
-				current_out = write_array(this, entry, current_out, string, quote, enc_idx);
-			break;
 			case T_NIL:
+				if( this->dimensions >= 0 && dimension != this->dimensions ){
+					rb_raise(rb_eArgError, "less array dimensions to encode (%d) than expected (%d)", dimension, this->dimensions);
+				}
 				current_out = pg_rb_str_ensure_capa( string, 4, current_out, NULL );
 				*current_out++ = 'N';
 				*current_out++ = 'U';
 				*current_out++ = 'L';
 				*current_out++ = 'L';
 				break;
+			case T_ARRAY:
+				if( this->dimensions < 0 || dimension < this->dimensions ){
+					current_out = write_array(this, entry, current_out, string, quote, enc_idx, dimension+1);
+					break;
+				}
+				/* Number of dimensions reached -> handle array as normal value */
 			default:
+				if( this->dimensions >= 0 && dimension != this->dimensions ){
+					rb_raise(rb_eArgError, "less array dimensions to encode (%d) than expected (%d)", dimension, this->dimensions);
+				}
 				current_out = quote_string( this->elem, entry, string, current_out, quote, quote_array_buffer, this, enc_idx );
 		}
 	}
@@ -596,7 +609,7 @@ pg_text_enc_array(t_pg_coder *conv, VALUE value, char *out, VALUE *intermediate,
 		VALUE out_str = rb_str_new(NULL, 0);
 		PG_ENCODING_SET_NOCHECK(out_str, enc_idx);
 
-		end_ptr = write_array(this, value, RSTRING_PTR(out_str), out_str, this->needs_quotation, enc_idx);
+		end_ptr = write_array(this, value, RSTRING_PTR(out_str), out_str, this->needs_quotation, enc_idx, 1);
 
 		rb_str_set_len( out_str, end_ptr - RSTRING_PTR(out_str) );
 		*intermediate = out_str;

ext/pg_type_map_by_column.c

@@ -54,6 +54,7 @@ pg_tmbc_fit_to_query( VALUE self, VALUE params )
 	t_tmbc *this = RTYPEDDATA_DATA( self );
 	t_typemap *default_tm;
 
+	Check_Type(params, T_ARRAY);
 	nfields = (int)RARRAY_LEN( params );
 	if ( this->nfields != nfields ) {
 		rb_raise( rb_eArgError, "number of result fields (%d) does not match number of mapped columns (%d)",

lib/pg/coder.rb

@@ -76,12 +76,13 @@ def to_h
 				elements_type: elements_type,
 				needs_quotation: needs_quotation?,
 				delimiter: delimiter,
+				dimensions: dimensions,
 			}
 		end
 
 		def inspect
 			str = super
-			str[-1,0] = " elements_type=#{elements_type.inspect} #{needs_quotation? ? 'needs' : 'no'} quotation"
+			str[-1,0] = " elements_type=#{elements_type.inspect} #{needs_quotation? ? 'needs' : 'no'} quotation#{dimensions && " #{dimensions} dimensions"}"
 			str
 		end
 	end