Merge pull request #13 from infopark/v2.5.1-fix_undeclared_my_bool

V2.5.1 - fix undeclared my bool, mysql2 ">= 0.5.5" compatibility

Author: tococorocko

.travis.yml

@@ -1,5 +1,10 @@
 language: ruby
 rvm:
+  - "3.1.2"
+  - "3.0.4"
   - "2.7.5"
   - "2.6.9"
-
+jobs:
+  include:
+  - name: Specs
+    env: TASK='bundle exec rake'

CHANGELOG.md

@@ -1,6 +1,14 @@
 All notable changes to this project will be documented in this file.
 
 This gem lives here https://github.com/infopark/mysql_blob_streaming.
+
+## v2.5.1 - 2023-05-10
+
+### Reason to make changes
+
+- Checking mysql.h for my_bool to retain compatibility with older mysql versions
+- mysql2 '>= 0.5.5' compatiblity
+
 ## v2.5.0 - 2022-05-03
 
 ### Reason to make changes
@@ -21,7 +29,6 @@ This gem lives here https://github.com/infopark/mysql_blob_streaming.
     typedef bool my_bool;
   #endif
 
-
 ## v2.4.0 - 2021-03-23
 
 ### Reason to make changes

Gemfile

@@ -4,6 +4,8 @@ source 'https://rubygems.org'
 gemspec
 
 # Dependencies for test environment
-gem "rake"
-gem "test-unit"
-gem "activerecord", "~> 5.2"
+group :test do
+  gem 'activerecord', '~> 6.0'
+  gem 'rake'
+  gem 'test-unit'
+end

ext/mysql_blob_streaming/extconf.rb

@@ -11,6 +11,18 @@
 find_header('errmsg.h', *additional_mysql_include_dirs)
 find_library('mysqlclient', nil, *additional_mysql_lib_dirs)
 
+if have_header('mysql.h')
+  prefix = nil
+elsif have_header('mysql/mysql.h')
+  prefix = 'mysql'
+else
+  asplode 'mysql.h'
+end
+mysql_h = [prefix, 'mysql.h'].compact.join('/')
+# my_bool is replaced by C99 bool in MySQL 8.0, but we want
+# to retain compatibility with the typedef in earlier MySQLs.
+have_type('my_bool', mysql_h)
+
 # --no-undefined forces us to link against libruby
 def remove_no_undefined(ldflags)
   ldflags.gsub("-Wl,--no-undefined", "")

ext/mysql_blob_streaming/mysql_blob_streaming.c

@@ -4,30 +4,35 @@
 #include <mysql.h>
 #include <errmsg.h>
 
-#if MYSQL_VERSION_ID >=80000 && MYSQL_VERSION_ID <80030
+/* MySQL 8.0 replaces my_bool with C99 bool. Earlier versions of MySQL had
+ * a typedef to char. Gem users reported failures on big endian systems when
+ * using C99 bool types with older MySQLs due to mismatched behavior.
+*/
+#ifndef HAVE_TYPE_MY_BOOL
   #include <stdbool.h>
   typedef bool my_bool;
 #endif
 
 typedef struct {
   VALUE encoding;
-  VALUE active_thread;
+  VALUE active_fiber; /* rb_fiber_current() or Qnil */
   long server_version;
   int reconnect_enabled;
-  int connect_timeout;
+  unsigned int connect_timeout;
   int active;
-  int connected;
+  int automatic_close;
   int initialized;
   int refcount;
-  int freed;
+  int closed;
   MYSQL *client;
 } mysql_client_wrapper;
 
+extern const rb_data_type_t rb_mysql_client_type;
 
 static MYSQL * mysql_connection(VALUE rb_mysql2_client)
 {
     mysql_client_wrapper *wrapper;
-    Data_Get_Struct(rb_mysql2_client, mysql_client_wrapper, wrapper);
+    TypedData_Get_Struct(rb_mysql2_client, mysql_client_wrapper, &rb_mysql_client_type, wrapper);
     return wrapper->client;
 }
 

lib/mysql_blob_streaming/version.rb

@@ -1,3 +1,3 @@
 class MysqlBlobStreaming
-  VERSION = "2.5.0"
+  VERSION = '2.5.1'
 end

mysql_blob_streaming.gemspec

@@ -13,8 +13,8 @@ Gem::Specification.new do |spec|
   EOF
   spec.license = 'MIT'
 
-  spec.add_dependency 'mysql2', ">= 0.4.4", "< 0.6.0"
-  spec.required_ruby_version = '>=2.0.0'
+  spec.add_dependency "mysql2", "~> 0.5", ">= 0.5.5"
+  spec.required_ruby_version = ">= 2.0.0"
 
   spec.files = Dir["lib/**/*.rb", "ext/**/*.{c,h,rb}", "README.markdown"]
   spec.extensions = ['ext/mysql_blob_streaming/extconf.rb']