sequel_pg 1.15.0 → 1.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 41aa757cb6f4ca6f56ca26044517a47a68731dd7d51335451f6da2e5b5b34d6f
-  data.tar.gz: ec43d49fd7b4b8821ecbb813f6244aaf46f69866e84b94df96a3c52ef3a6fd41
+  metadata.gz: b418a08f23a346ec6f261855e3f20ad8c9ec97f9879a7120c43f1d48867bdd43
+  data.tar.gz: 3b15798070ba32128256dd3ec84f16b2c63a110849655be5964a08d5a481de8d
 SHA512:
-  metadata.gz: 2a2578bec8fed224dcd3c1263cb86a4729cf11318f80d6cdb03366ae7dae6e68995447db06a1105d1ecda50222d2ff6258079fb7395d3f262094e1e05502fd48
-  data.tar.gz: 26a470d0e7d8290cade76b07cecd972be840c838492607a5649c0fd803de2ca7ea2e34b0c77fddcaff734a2a875b1f26ce8d5b03ec0fe0ab887ae3045ffa10e0
+  metadata.gz: 273c435b2e9ffbe8ab104c32ad702215d1ef3671acf855c8be2f482d13f38fb971041e0310db492079d2187b11562e7578d6b22b6db4de82d2d7dcccb3457ae4
+  data.tar.gz: 49245e46280716939482f9865b6bede5a4a4615fb5326982103b7e9fc4d0778fb8421771aa1a858dd5a3aa4ff90e89f222cd913319c61714995f9507ba277c40

data/CHANGELOG

@@ -1,3 +1,17 @@
+=== 1.17.0 (2022-10-05)
+
+* Do not use pgresult_stream_any when using pg <1.4.4, to avoid double free in certain cases (larskanis) (#50)
+
+* Support new pgresult_stream_any API in pg 1.4.4 (larskanis) (#50)
+
+=== 1.16.0 (2022-08-16)
+
+* Fix memory leak when using streaming with pg 1.3.4+ (jeremyevans) (#48)
+
+* Modify LDFLAGS when building on MacOS arm64 to allow undefined functions (maxsz) (#46)
+
+* Adjust many internal C types to fix compilation warnings (jeremyevans)
+
 === 1.15.0 (2022-03-16)
 
 * Avoid deprecation warning in the pg_streaming extension on pg 1.3+ when streaming a query with bound parameters (jeremyevans)

data/README.rdoc

@@ -77,9 +77,16 @@ variables to specify the shared library and header directories.
 
 == Running the specs
 
-sequel_pg doesn't ship with it's own specs.  It's designed to
-replace a part of Sequel, so it just uses Sequel's specs.
-Specifically, the spec_postgres rake task from Sequel.
+sequel_pg is designed to replace a part of Sequel, so it shold be tested
+using Sequel's specs (the spec_postgres rake task).  There is a spec_cov
+task that assumes you have Sequel checked out at ../sequel, and uses a
+small spec suite for parts of sequel_pg not covered by Sequel's specs.
+It sets the SEQUEL_PG_STREAM environment variable when running Sequel's
+specs, make sure that spec/spec_config.rb in Sequel is set to connect
+to PostgreSQL and use the following additional settings:
+
+  DB.extension(:pg_streaming)
+  DB.stream_all_queries = true
 
 == Reporting issues/bugs
 

data/Rakefile

@@ -1,7 +1,6 @@
-require "rake"
 require "rake/clean"
 
-CLEAN.include %w'**.rbc rdoc'
+CLEAN.include %w'**.rbc rdoc coverage'
 
 desc "Do a full cleaning"
 task :distclean do
@@ -19,3 +18,25 @@ begin
   Rake::ExtensionTask.new('sequel_pg')
 rescue LoadError
 end
+
+# This assumes you have sequel checked out in ../sequel, and that
+# spec_postgres is setup to run Sequel's PostgreSQL specs.
+desc "Run tests with coverage"
+task :spec_cov=>:compile do
+  ENV['RUBYLIB'] = "#{__dir__}/lib:#{ENV['RUBYLIB']}"
+  ENV['RUBYOPT'] = "-r #{__dir__}/spec/coverage_helper.rb #{ENV['RUBYOPT']}"
+  ENV['SIMPLECOV_COMMAND_NAME'] = "sequel_pg"
+  sh %'#{FileUtils::RUBY} -I ../sequel/lib spec/sequel_pg_spec.rb'
+
+  ENV['RUBYOPT'] = "-I lib -r sequel -r sequel/extensions/pg_array #{ENV['RUBYOPT']}"
+  ENV['SEQUEL_PG_STREAM'] = "1"
+  ENV['SIMPLECOV_COMMAND_NAME'] = "sequel"
+  sh %'cd ../sequel && #{FileUtils::RUBY} spec/adapter_spec.rb postgres'
+end
+
+desc "Run CI tests"
+task :spec_ci=>:compile do
+  ENV['SEQUEL_PG_SPEC_URL'] = ENV['SEQUEL_POSTGRES_URL'] = "postgres://localhost/?user=postgres&password=postgres"
+  sh %'#{FileUtils::RUBY} -I lib -I sequel/lib spec/sequel_pg_spec.rb'
+  sh %'cd sequel && #{FileUtils::RUBY} -I lib -I ../lib spec/adapter_spec.rb postgres'
+end

data/ext/sequel_pg/extconf.rb

@@ -2,6 +2,7 @@ require 'mkmf'
 $CFLAGS << " -O0 -g" if ENV['DEBUG']
 $CFLAGS << " -Drb_tainted_str_new=rb_str_new -DNO_TAINT" if RUBY_VERSION >= '2.7'
 $CFLAGS << " -Wall " unless RUBY_PLATFORM =~ /solaris/
+$LDFLAGS += " -Wl,-U,_pg_get_pgconn -Wl,-U,_pg_get_result_enc_idx -Wl,-U,_pgresult_get -Wl,-U,_pgresult_stream_any " if RUBY_PLATFORM =~ /arm64-darwin/
 dir_config('pg', ENV["POSTGRES_INCLUDE"] || (IO.popen("pg_config --includedir").readline.chomp rescue nil),
                  ENV["POSTGRES_LIB"]     || (IO.popen("pg_config --libdir").readline.chomp rescue nil))
 

data/ext/sequel_pg/sequel_pg.c

@@ -1,4 +1,4 @@
-#define SEQUEL_PG_VERSION_INTEGER 11500
+#define SEQUEL_PG_VERSION_INTEGER 11700
 
 #include <string.h>
 #include <stdio.h>
@@ -70,7 +70,7 @@
 PGconn* pg_get_pgconn(VALUE);
 PGresult* pgresult_get(VALUE);
 int pg_get_result_enc_idx(VALUE);
-VALUE pgresult_stream_any(VALUE self, void (*yielder)(VALUE, int, int, void*), void* data);
+VALUE pgresult_stream_any(VALUE self, int (*yielder)(VALUE, int, int, void*), void* data);
 
 static int spg_use_ipaddr_alloc;
 static int spg_use_pg_get_result_enc_idx;
@@ -199,10 +199,10 @@ static int enc_get_index(VALUE val) {
   } while(0)
 
 static VALUE
-pg_text_dec_integer(char *val, int len)
+pg_text_dec_integer(char *val, size_t len)
 {
   long i;
-  int max_len;
+  size_t max_len;
 
   if( sizeof(i) >= 8 && FIXNUM_MAX >= 1000000000000000000LL ){
     /* 64 bit system can safely handle all numbers up to 18 digits as Fixnum */
@@ -257,7 +257,7 @@ pg_text_dec_integer(char *val, int len)
 
 static VALUE spg__array_col_value(char *v, size_t length, VALUE converter, int enc_index, int oid, VALUE db);
 
-static VALUE read_array(int *index, char *c_pg_array_string, int array_string_length, VALUE buf, VALUE converter, int enc_index, int oid, VALUE db) {
+static VALUE read_array(int *index, char *c_pg_array_string, long array_string_length, VALUE buf, VALUE converter, int enc_index, int oid, VALUE db) {
   int word_index = 0;
   char *word = RSTRING_PTR(buf);
 
@@ -353,7 +353,7 @@ static VALUE read_array(int *index, char *c_pg_array_string, int array_string_le
   return array;
 }
 
-static VALUE check_pg_array(int* index, char *c_pg_array_string, int array_string_length) {
+static VALUE check_pg_array(int* index, char *c_pg_array_string, long array_string_length) {
   if (array_string_length == 0) {
     rb_raise(rb_eArgError, "unexpected PostgreSQL array format, empty");
   } else if (array_string_length == 2 && c_pg_array_string[0] == '{' && c_pg_array_string[0] == '}') {
@@ -384,7 +384,7 @@ static VALUE parse_pg_array(VALUE self, VALUE pg_array_string, VALUE converter)
   /* convert to c-string, create additional ruby string buffer of
    * the same length, as that will be the worst case. */
   char *c_pg_array_string = StringValueCStr(pg_array_string);
-  int array_string_length = RSTRING_LEN(pg_array_string);
+  long array_string_length = RSTRING_LEN(pg_array_string);
   int index = 1;
   VALUE ary;
 
@@ -1012,12 +1012,12 @@ static int spg_timestamp_info_bitmask(VALUE self) {
   return tz;
 }
 
-static VALUE spg__col_value(VALUE self, PGresult *res, long i, long j, VALUE* colconvert, int enc_index) {
+static VALUE spg__col_value(VALUE self, PGresult *res, int i, int j, VALUE* colconvert, int enc_index) {
   char *v;
   VALUE rv;
   int ftype = PQftype(res, j);
   VALUE array_type;
-  VALUE scalar_oid;
+  int scalar_oid;
   struct spg_blob_initialization bi;
 
   if(PQgetisnull(res, i, j)) {
@@ -1251,20 +1251,20 @@ static VALUE spg__col_value(VALUE self, PGresult *res, long i, long j, VALUE* co
   return rv;
 }
 
-static VALUE spg__col_values(VALUE self, VALUE v, VALUE *colsyms, long nfields, PGresult *res, long i, VALUE *colconvert, int enc_index) {
+static VALUE spg__col_values(VALUE self, VALUE v, VALUE *colsyms, long nfields, PGresult *res, int i, VALUE *colconvert, int enc_index) {
   long j;
   VALUE cur;
   long len = RARRAY_LEN(v);
   VALUE a = rb_ary_new2(len);
   for (j=0; j<len; j++) {
     cur = rb_ary_entry(v, j);
-    rb_ary_store(a, j, cur == Qnil ? Qnil : spg__col_value(self, res, i, NUM2LONG(cur), colconvert, enc_index));
+    rb_ary_store(a, j, cur == Qnil ? Qnil : spg__col_value(self, res, i, NUM2INT(cur), colconvert, enc_index));
   }
   return a;
 }
 
-static long spg__field_id(VALUE v, VALUE *colsyms, long nfields) {
-  long j;
+static int spg__field_id(VALUE v, VALUE *colsyms, long nfields) {
+  int j;
   for (j=0; j<nfields; j++) {
     if (colsyms[j] == v) {
       return j;
@@ -1275,7 +1275,7 @@ static long spg__field_id(VALUE v, VALUE *colsyms, long nfields) {
 
 static VALUE spg__field_ids(VALUE v, VALUE *colsyms, long nfields) {
   long i;
-  long j;
+  int j;
   VALUE cur;
   long len = RARRAY_LEN(v);
   VALUE pg_columns = rb_ary_new2(len);
@@ -1288,9 +1288,9 @@ static VALUE spg__field_ids(VALUE v, VALUE *colsyms, long nfields) {
 }
 
 static void spg_set_column_info(VALUE self, PGresult *res, VALUE *colsyms, VALUE *colconvert, int enc_index) {
-  long i;
-  long j;
-  long nfields;
+  int i;
+  int j;
+  int nfields;
   int timestamp_info = 0;
   int time_info = 0;
   VALUE conv_procs = 0;
@@ -1380,10 +1380,10 @@ static void spg_set_column_info(VALUE self, PGresult *res, VALUE *colsyms, VALUE
 }
 
 static VALUE spg_yield_hash_rows_internal(VALUE self, PGresult *res, int enc_index, VALUE* colsyms, VALUE* colconvert) {
-  long ntuples;
-  long nfields;
-  long i;
-  long j;
+  int ntuples;
+  int nfields;
+  int i;
+  int j;
   VALUE h;
   VALUE opts;
   VALUE pg_type;
@@ -1483,7 +1483,7 @@ static VALUE spg_yield_hash_rows_internal(VALUE self, PGresult *res, int enc_ind
     case SPG_YIELD_KV_HASH_GROUPS:
       /* Hash with single key and single value */
       {
-        VALUE k, v;
+        int k, v;
         h = rb_hash_new();
         k = spg__field_id(rb_ary_entry(pg_value, 0), colsyms, nfields);
         v = spg__field_id(rb_ary_entry(pg_value, 1), colsyms, nfields);
@@ -1511,7 +1511,8 @@ static VALUE spg_yield_hash_rows_internal(VALUE self, PGresult *res, int enc_ind
     case SPG_YIELD_MKV_HASH_GROUPS:
       /* Hash with array of keys and single value */
       {
-        VALUE k, v;
+        VALUE k;
+        int v;
         h = rb_hash_new();
         k = spg__field_ids(rb_ary_entry(pg_value, 0), colsyms, nfields);
         v = spg__field_id(rb_ary_entry(pg_value, 1), colsyms, nfields);
@@ -1539,7 +1540,8 @@ static VALUE spg_yield_hash_rows_internal(VALUE self, PGresult *res, int enc_ind
     case SPG_YIELD_KMV_HASH_GROUPS:
       /* Hash with single keys and array of values */
       {
-        VALUE k, v;
+        VALUE v;
+        int k;
         h = rb_hash_new();
         k = spg__field_id(rb_ary_entry(pg_value, 0), colsyms, nfields);
         v = spg__field_ids(rb_ary_entry(pg_value, 1), colsyms, nfields);
@@ -1621,7 +1623,7 @@ def_spg_yield_hash_rows(1664)
 
 static VALUE spg_yield_hash_rows(VALUE self, VALUE rres, VALUE ignore) {
   PGresult *res;
-  long nfields;
+  int nfields;
   int enc_index;
 
   if (!RTEST(rres)) {
@@ -1636,7 +1638,7 @@ static VALUE spg_yield_hash_rows(VALUE self, VALUE rres, VALUE ignore) {
   else if (nfields <= 64) return spg_yield_hash_rows_64(self, res, enc_index);
   else if (nfields <= 256) return spg_yield_hash_rows_256(self, res, enc_index);
   else if (nfields <= 1664) return spg_yield_hash_rows_1664(self, res, enc_index);
-  else rb_raise(rb_eRangeError, "more than 1664 columns in query (%ld columns detected)", nfields);
+  else rb_raise(rb_eRangeError, "more than 1664 columns in query (%d columns detected)", nfields);
 
   /* UNREACHABLE */
   return self;
@@ -1670,7 +1672,7 @@ struct spg__yield_each_row_stream_data {
   char type;
 };
 
-static void spg__yield_each_row_stream(VALUE rres, int ntuples, int nfields, void *rdata) {
+static int spg__yield_each_row_stream(VALUE rres, int ntuples, int nfields, void *rdata) {
   struct spg__yield_each_row_stream_data* data = (struct spg__yield_each_row_stream_data *)rdata;
   VALUE h = rb_hash_new();
   VALUE self = data->self;
@@ -1678,7 +1680,7 @@ static void spg__yield_each_row_stream(VALUE rres, int ntuples, int nfields, voi
   VALUE *colconvert= data->colconvert;
   PGresult *res = pgresult_get(rres);
   int enc_index = data->enc_index;
-  long j;
+  int j;
 
   for(j=0; j<nfields; j++) {
     rb_hash_aset(h, colsyms[j], spg__col_value(self, res, 0, j, colconvert , enc_index));
@@ -1691,11 +1693,12 @@ static void spg__yield_each_row_stream(VALUE rres, int ntuples, int nfields, voi
   } else {
     rb_yield(h);
   }
+  return 1; /* clear the result */
 }
 
 static VALUE spg__yield_each_row_internal(VALUE self, VALUE rconn, VALUE rres, PGresult *res, int enc_index, VALUE *colsyms, VALUE *colconvert) {
-  long nfields;
-  long j;
+  int nfields;
+  int j;
   VALUE h;
   VALUE opts;
   VALUE pg_type;
@@ -1776,7 +1779,7 @@ static VALUE spg__yield_each_row(VALUE self) {
   VALUE rres;
   VALUE rconn;
   int enc_index;
-  long nfields;
+  int nfields;
 
   rconn = rb_ary_entry(self, 1);
   self = rb_ary_entry(self, 0);
@@ -1797,7 +1800,7 @@ static VALUE spg__yield_each_row(VALUE self) {
   else if (nfields <= 1664) return spg__yield_each_row_1664(self, rconn, rres, res, enc_index);
   else {
     rb_funcall(rres, spg_id_clear, 0);
-    rb_raise(rb_eRangeError, "more than 1664 columns in query (%ld columns detected)", nfields);
+    rb_raise(rb_eRangeError, "more than 1664 columns in query (%d columns detected)", nfields);
   }
 
   /* UNREACHABLE */
@@ -1865,7 +1868,7 @@ void Init_sequel_pg(void) {
       if (FIX2INT(RARRAY_AREF(c, 1)) >= 2) {
         spg_use_pg_get_result_enc_idx = 1;
       }
-      if (FIX2INT(RARRAY_AREF(c, 1)) > 3 || (FIX2INT(RARRAY_AREF(c, 1)) == 3 && FIX2INT(RARRAY_AREF(c, 2)) >= 4)) {
+      if (FIX2INT(RARRAY_AREF(c, 1)) > 4 || (FIX2INT(RARRAY_AREF(c, 1)) == 4 && FIX2INT(RARRAY_AREF(c, 2)) >= 4)) {
         spg_use_pg_stream_any = 1;
       }
     }

data/lib/sequel/extensions/pg_streaming.rb

@@ -1,9 +1,11 @@
+# :nocov:
 unless Sequel::Postgres.respond_to?(:supports_streaming?)
   raise LoadError, "either sequel_pg not loaded, or an old version of sequel_pg loaded"
 end
 unless Sequel::Postgres.supports_streaming?
   raise LoadError, "streaming is not supported by the version of libpq in use"
 end
+# :nocov:
 
 # Database methods necessary to support streaming.  You should load this extension
 # into your database object:
@@ -73,11 +75,13 @@ module Sequel::Postgres::Streaming
 
     private
 
+    # :nocov:
     unless Sequel::Postgres::Adapter.method_defined?(:send_query_params)
       def send_query_params(*args)
         send_query(*args)
       end
     end
+    # :nocov:
 
     if Sequel::Database.instance_methods.map(&:to_s).include?('log_connection_yield')
       # If using single row mode, send the query instead of executing it.
@@ -93,6 +97,7 @@ module Sequel::Postgres::Streaming
         end
       end
     else
+      # :nocov:
       def execute_query(sql, args)
         if @single_row_mode
           @single_row_mode = false
@@ -104,6 +109,7 @@ module Sequel::Postgres::Streaming
           super
         end
       end
+      # :nocov:
     end
   end
 

data/lib/sequel_pg/sequel_pg.rb

@@ -53,11 +53,13 @@ class Sequel::Postgres::Dataset
     end
   end
 
+  # :nocov:
   unless Sequel::Dataset.method_defined?(:as_hash)
     # Handle previous versions of Sequel that use to_hash instead of as_hash
     alias to_hash as_hash
     remove_method :as_hash
   end
+  # :nocov:
 
   # In the case where both arguments given, use an optimized version.
   def to_hash_groups(key_column, value_column = nil, opts = Sequel::OPTS)
@@ -120,8 +122,10 @@ if defined?(Sequel::Postgres::PGArray)
   # pg_array extension previously loaded
 
   class Sequel::Postgres::PGArray::Creator
+    # :nocov:
     # Avoid method redefined verbose warning
     alias call call if method_defined?(:call)
+    # :nocov:
 
     # Override Creator to use sequel_pg's C-based parser instead of the pure ruby parser.
     def call(string)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sequel_pg
 version: !ruby/object:Gem::Version
-  version: 1.15.0
+  version: 1.17.0
 platform: ruby
 authors:
 - Jeremy Evans
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-16 00:00:00.000000000 Z
+date: 2022-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
@@ -77,9 +77,9 @@ metadata:
   bug_tracker_uri: https://github.com/jeremyevans/sequel_pg/issues
   changelog_uri: https://github.com/jeremyevans/sequel_pg/blob/master/CHANGELOG
   documentation_uri: https://github.com/jeremyevans/sequel_pg/blob/master/README.rdoc
-  mailing_list_uri: https://groups.google.com/forum/#!forum/sequel-talk
+  mailing_list_uri: https://github.com/jeremyevans/sequel_pg/discussions
   source_code_uri: https://github.com/jeremyevans/sequel_pg
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--quiet"
 - "--line-numbers"
@@ -102,7 +102,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.3.7
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Faster SELECTs when using Sequel with pg
 test_files: []