mysql2 0.1.0 → 0.1.1

data/CHANGELOG.md

@@ -1,4 +1,11 @@
 # Changelog
 
+## 0.1.1 (April 6th, 2010)
+* added affected_rows method (mysql_affected_rows)
+* added last_id method (last_insert_id)
+* enable reconnect option by default
+* added initial async query support
+* updated extconf (thanks to the mysqlplus project) for easier gem building
+
 ## 0.1.0 (April 6th, 2010)
 * initial release

data/README.rdoc

@@ -1,4 +1,4 @@
-= Mysql2 - A modern, simple and very fast Mysql library for Ruby, binding to libmysql
+= Mysql2 - A modern, simple and very fast Mysql library for Ruby - binding to libmysql
 
 The Mysql2 gem is meant to serve the extremely common use-case of connecting, querying and iterating on results.
 Some database libraries out there serve as direct 1:1 mappings of the already complex C API's available.
@@ -14,7 +14,9 @@ Mysql2::Result - returned from issuing a #query on the connection. It includes E
 
 == Installing
 
-I plan to release the initial gem version within the next day or so. Just wanted to tweak extconf to help find the libmysql binary easier, and add the ssl options.
+  gem install mysql2
+
+You may have to specify --with-mysql-lib=/usr/local/lib/mysql or your path to libmysql (I'll do my best to not require that)
 
 == Usage
 

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/ext/extconf.rb

@@ -1,19 +1,80 @@
 # encoding: UTF-8
-
 require 'mkmf'
-dir_config('mysql')
 
-have_header('mysql/mysql.h')
+# borrowed from mysqlplus
+# http://github.com/oldmoe/mysqlplus/blob/master/ext/extconf.rb
+dirs = ENV['PATH'].split(':') + %w[
+  /opt
+  /opt/local
+  /opt/local/mysql
+  /opt/local/lib/mysql5
+  /usr
+  /usr/local
+  /usr/local/mysql
+  /usr/local/mysql-*
+  /usr/local/lib/mysql5
+].map{|dir| "#{dir}/bin" }
 
-$CFLAGS << ' -Wall -Wextra -funroll-loops'
-# $CFLAGS << ' -O0 -ggdb3'
+GLOB = "{#{dirs.join(',')}}/{mysql_config,mysql_config5}"
 
-if have_library('mysqlclient')
-  if RUBY_VERSION =~ /1.9/
-    $CFLAGS << ' -DRUBY_19_COMPATIBILITY'
+if /mswin32/ =~ RUBY_PLATFORM
+  inc, lib = dir_config('mysql')
+  exit 1 unless have_library("libmysql")
+elsif mc = (with_config('mysql-config') || Dir[GLOB].first) then
+  mc = Dir[GLOB].first if mc == true
+  cflags = `#{mc} --cflags`.chomp
+  exit 1 if $? != 0
+  libs = `#{mc} --libs`.chomp
+  exit 1 if $? != 0
+  $CPPFLAGS += ' ' + cflags
+  $libs = libs + " " + $libs
+else
+  inc, lib = dir_config('mysql', '/usr/local')
+  libs = ['m', 'z', 'socket', 'nsl', 'mygcc']
+  while not find_library('mysqlclient', 'mysql_query', lib, "#{lib}/mysql") do
+    exit 1 if libs.empty?
+    have_library(libs.shift)
   end
+end
+
+if have_header('mysql.h') then
+  src = "#include <errmsg.h>\n#include <mysqld_error.h>\n"
+elsif have_header('mysql/mysql.h') then
+  src = "#include <mysql/errmsg.h>\n#include <mysql/mysqld_error.h>\n"
+else
+  exit 1
+end
 
-  create_makefile('mysql2_ext')
+# make mysql constant
+File.open("conftest.c", "w") do |f|
+  f.puts src
+end
+if defined? cpp_command then
+  cpp = Config.expand(cpp_command(''))
 else
-  puts 'libmysql not found, maybe try manually specifying --with-mysql-lib to find it?'
-end
+  cpp = Config.expand sprintf(CPP, $CPPFLAGS, $CFLAGS, '')
+end
+if /mswin32/ =~ RUBY_PLATFORM && !/-E/.match(cpp)
+  cpp << " -E"
+end
+unless system "#{cpp} > confout" then
+  exit 1
+end
+File.unlink "conftest.c"
+
+error_syms = []
+IO.foreach('confout') do |l|
+  next unless l =~ /errmsg\.h|mysqld_error\.h/
+  fn = l.split(/\"/)[1]
+  IO.foreach(fn) do |m|
+    if m =~ /^#define\s+([CE]R_[0-9A-Z_]+)/ then
+      error_syms << $1
+    end
+  end
+end
+File.unlink 'confout'
+
+$CFLAGS << ' -Wall -Wextra -funroll-loops'
+# $CFLAGS << ' -O0 -ggdb3'
+
+create_makefile('mysql2_ext')

data/ext/mysql2_ext.c

@@ -14,7 +14,7 @@ static VALUE rb_mysql_client_new(int argc, VALUE * argv, VALUE klass) {
   char *ssl_client_key = NULL, *ssl_client_cert = NULL, *ssl_ca_cert = NULL,
        *ssl_ca_path = NULL, *ssl_cipher = NULL;
   unsigned int port = 3306, connect_timeout = 0;
-  my_bool reconnect = 0;
+  my_bool reconnect = 1;
 
   obj = Data_Make_Struct(klass, MYSQL, NULL, rb_mysql_client_free, client);
 
@@ -52,7 +52,7 @@ static VALUE rb_mysql_client_new(int argc, VALUE * argv, VALUE klass) {
     }
 
     if ((rb_reconnect = rb_hash_aref(opts, sym_reconnect)) != Qnil) {
-      reconnect = rb_reconnect == Qtrue ? 1 : 0;
+      reconnect = rb_reconnect == Qfalse ? 0 : 1;
     }
 
     if ((rb_connect_timeout = rb_hash_aref(opts, sym_connect_timeout)) != Qnil) {
@@ -125,7 +125,7 @@ static VALUE rb_mysql_client_new(int argc, VALUE * argv, VALUE klass) {
   return obj;
 }
 
-static VALUE rb_mysql_client_init(VALUE self, int argc, VALUE * argv) {
+static VALUE rb_mysql_client_init(int argc, VALUE * argv, VALUE self) {
   return self;
 }
 
@@ -136,11 +136,21 @@ void rb_mysql_client_free(void * client) {
   }
 }
 
-static VALUE rb_mysql_client_query(VALUE self, VALUE sql) {
+static VALUE rb_mysql_client_query(int argc, VALUE * argv, VALUE self) {
   MYSQL * client;
   MYSQL_RES * result;
   fd_set fdset;
   int fd, retval;
+  int async = 0;
+  VALUE sql, opts;
+  VALUE rb_async;
+
+  if (rb_scan_args(argc, argv, "11", &sql, &opts) == 2) {
+    if ((rb_async = rb_hash_aref(opts, sym_async)) != Qnil) {
+      async = rb_async == Qtrue ? 1 : 0;
+    }
+  }
+
   Check_Type(sql, T_STRING);
 
   GetMysql2Client(self, client);
@@ -149,37 +159,29 @@ static VALUE rb_mysql_client_query(VALUE self, VALUE sql) {
     return Qnil;
   }
 
-  // the below code is largely from do_mysql
-  // http://github.com/datamapper/do
-  fd = client->net.fd;
-  for(;;) {
-    FD_ZERO(&fdset);
-    FD_SET(fd, &fdset);
+  if (!async) {
+    // the below code is largely from do_mysql
+    // http://github.com/datamapper/do
+    fd = client->net.fd;
+    for(;;) {
+      FD_ZERO(&fdset);
+      FD_SET(fd, &fdset);
 
-    retval = rb_thread_select(fd + 1, &fdset, NULL, NULL, NULL);
+      retval = rb_thread_select(fd + 1, &fdset, NULL, NULL, NULL);
 
-    if (retval < 0) {
-        rb_sys_fail(0);
-    }
+      if (retval < 0) {
+          rb_sys_fail(0);
+      }
 
-    if (retval > 0) {
-        break;
+      if (retval > 0) {
+          break;
+      }
     }
-  }
-
-  if (mysql_read_query_result(client) != 0) {
-    rb_raise(cMysql2Error, "%s", mysql_error(client));
-    return Qnil;
-  }
 
-  result = mysql_store_result(client);
-  if (result == NULL) {
-    if (mysql_field_count(client) != 0) {
-      rb_raise(cMysql2Error, "%s", mysql_error(client));
-    }
+    return rb_mysql_client_async_result(self);
+  } else {
     return Qnil;
   }
-  return rb_mysql_result_to_obj(result);
 }
 
 static VALUE rb_mysql_client_escape(VALUE self, VALUE str) {
@@ -229,6 +231,41 @@ static VALUE rb_mysql_client_socket(VALUE self) {
   return INT2NUM(client->net.fd);
 }
 
+static VALUE rb_mysql_client_async_result(VALUE self) {
+  MYSQL * client;
+  MYSQL_RES * result;
+  GetMysql2Client(self, client);
+
+  if (mysql_read_query_result(client) != 0) {
+    rb_raise(cMysql2Error, "%s", mysql_error(client));
+    return Qnil;
+  }
+
+  result = mysql_store_result(client);
+  if (result == NULL) {
+    if (mysql_field_count(client) != 0) {
+      rb_raise(cMysql2Error, "%s", mysql_error(client));
+    }
+    return Qnil;
+  }
+
+  return rb_mysql_result_to_obj(result);
+}
+
+static VALUE rb_mysql_client_last_id(VALUE self) {
+  MYSQL * client;
+  GetMysql2Client(self, client);
+
+  return ULL2NUM(mysql_insert_id(client));
+}
+
+static VALUE rb_mysql_client_affected_rows(VALUE self) {
+  MYSQL * client;
+  GetMysql2Client(self, client);
+
+  return ULL2NUM(mysql_affected_rows(client));
+}
+
 /* Mysql2::Result */
 static VALUE rb_mysql_result_to_obj(MYSQL_RES * r) {
   VALUE obj;
@@ -420,11 +457,14 @@ void Init_mysql2_ext() {
   VALUE cMysql2Client = rb_define_class_under(mMysql2, "Client", rb_cObject);
   rb_define_singleton_method(cMysql2Client, "new", rb_mysql_client_new, -1);
   rb_define_method(cMysql2Client, "initialize", rb_mysql_client_init, -1);
-  rb_define_method(cMysql2Client, "query", rb_mysql_client_query, 1);
+  rb_define_method(cMysql2Client, "query", rb_mysql_client_query, -1);
   rb_define_method(cMysql2Client, "escape", rb_mysql_client_escape, 1);
   rb_define_method(cMysql2Client, "info", rb_mysql_client_info, 0);
   rb_define_method(cMysql2Client, "server_info", rb_mysql_client_server_info, 0);
   rb_define_method(cMysql2Client, "socket", rb_mysql_client_socket, 0);
+  rb_define_method(cMysql2Client, "async_result", rb_mysql_client_async_result, 0);
+  rb_define_method(cMysql2Client, "last_id", rb_mysql_client_last_id, 0);
+  rb_define_method(cMysql2Client, "affected_rows", rb_mysql_client_affected_rows, 0);
 
   cMysql2Error = rb_define_class_under(mMysql2, "Error", rb_eStandardError);
 
@@ -453,6 +493,7 @@ void Init_mysql2_ext() {
   sym_sslca = ID2SYM(rb_intern("sslca"));
   sym_sslcapath = ID2SYM(rb_intern("sslcapath"));
   sym_sslcipher = ID2SYM(rb_intern("sslcipher"));
+  sym_async = ID2SYM(rb_intern("async"));
 
 #ifdef HAVE_RUBY_ENCODING_H
   utf8Encoding = rb_enc_find_index("UTF-8");

data/ext/mysql2_ext.h

@@ -1,10 +1,17 @@
 #include <time.h>
 #include <ruby.h>
 
+#ifdef HAVE_MYSQL_H
+#include <mysql.h>
+#include <mysql_com.h>
+#include <errmsg.h>
+#include <mysqld_error.h>
+#else
 #include <mysql/mysql.h>
 #include <mysql/mysql_com.h>
 #include <mysql/errmsg.h>
 #include <mysql/mysqld_error.h>
+#endif
 
 #ifdef HAVE_RUBY_ENCODING_H
 #include <ruby/encoding.h>
@@ -21,20 +28,23 @@ VALUE cMysql2Error;
 #define GetMysql2Client(obj, sval) (sval = (MYSQL*)DATA_PTR(obj));
 static ID sym_socket, sym_host, sym_port, sym_username, sym_password,
           sym_database, sym_reconnect, sym_connect_timeout, sym_id, sym_version,
-          sym_sslkey, sym_sslcert, sym_sslca, sym_sslcapath, sym_sslcipher;
+          sym_sslkey, sym_sslcert, sym_sslca, sym_sslcapath, sym_sslcipher,
+          sym_symbolize_keys, sym_async;
 static VALUE rb_mysql_client_new(int argc, VALUE * argv, VALUE klass);
-static VALUE rb_mysql_client_init(VALUE self, int argc, VALUE * argv);
-static VALUE rb_mysql_client_query(VALUE self, VALUE query);
+static VALUE rb_mysql_client_init(int argc, VALUE * argv, VALUE self);
+static VALUE rb_mysql_client_query(int argc, VALUE * argv, VALUE self);
 static VALUE rb_mysql_client_escape(VALUE self, VALUE str);
 static VALUE rb_mysql_client_info(VALUE self);
 static VALUE rb_mysql_client_server_info(VALUE self);
 static VALUE rb_mysql_client_socket(VALUE self);
+static VALUE rb_mysql_client_async_result(VALUE self);
+static VALUE rb_mysql_client_last_id(VALUE self);
+static VALUE rb_mysql_client_affected_rows(VALUE self);
 void rb_mysql_client_free(void * client);
 
 /* Mysql2::Result */
 #define GetMysql2Result(obj, sval) (sval = (MYSQL_RES*)DATA_PTR(obj));
 VALUE cMysql2Result;
-static ID sym_symbolize_keys;
 static VALUE rb_mysql_result_to_obj(MYSQL_RES * res);
 static VALUE rb_mysql_result_fetch_row(int argc, VALUE * argv, VALUE self);
 static VALUE rb_mysql_result_each(int argc, VALUE * argv, VALUE self);

data/lib/mysql2.rb

@@ -3,7 +3,7 @@ require 'mysql2_ext'
 
 # = Mysql2
 #
-# A modern MySQL client library for Ruby, binding to libmysql
+# A modern, simple and very fast Mysql library for Ruby - binding to libmysql
 module Mysql2
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/mysql2.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mysql2}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Brian Lopez"]
-  s.date = %q{2010-04-06}
+  s.date = %q{2010-04-07}
   s.email = %q{seniorlopez@gmail.com}
   s.extensions = ["ext/extconf.rb"]
   s.extra_rdoc_files = [

data/spec/mysql2/client_spec.rb

@@ -6,6 +6,11 @@ describe Mysql2::Client do
     @client = Mysql2::Client.new
   end
 
+  after(:each) do
+    # forcefully clean up old connections
+    GC.start
+  end
+
   it "should be able to connect via SSL options" do
     pending("DON'T WORRY, THIS TEST PASSES :) - but is machine-specific. You need to have MySQL running with SSL configured and enabled. Then update the paths in this test to your needs and remove the pending state.")
     ssl_client = nil
@@ -90,4 +95,57 @@ describe Mysql2::Client do
       good_client = Mysql2::Client.new
     }.should_not raise_error(Mysql2::Error)
   end
+
+  it "evented async queries should be supported" do
+    # should immediately return nil
+    @client.query("SELECT sleep(0.1)", :async => true).should eql(nil)
+
+    io_wrapper = IO.for_fd(@client.socket)
+    loops = 0
+    loop do
+      if IO.select([io_wrapper], nil, nil, 0.05)
+        break
+      else
+        loops += 1
+      end
+    end
+
+    # make sure we waited some period of time
+    (loops >= 1).should be_true
+
+    result = @client.async_result
+    result.class.should eql(Mysql2::Result)
+  end
+
+  context 'write operations api' do
+    before(:each) do
+      @client.query "USE test"
+      @client.query "CREATE TABLE lastIdTest (`id` int(11) NOT NULL AUTO_INCREMENT, blah INT(11), PRIMARY KEY (`id`))"
+    end
+
+    after(:each) do
+      @client.query "DROP TABLE lastIdTest"
+    end
+
+    it "should respond to #last_id" do
+      @client.should respond_to(:last_id)
+    end
+
+    it "#last_id should return a Fixnum, the from the last INSERT/UPDATE" do
+      @client.last_id.should eql(0)
+      @client.query "INSERT INTO lastIdTest (blah) VALUES (1234)"
+      @client.last_id.should eql(1)
+    end
+
+    it "should respond to #last_id" do
+      @client.should respond_to(:last_id)
+    end
+
+    it "#last_id should return a Fixnum, the from the last INSERT/UPDATE" do
+      @client.query "INSERT INTO lastIdTest (blah) VALUES (1234)"
+      @client.affected_rows.should eql(1)
+      @client.query "UPDATE lastIdTest SET blah=4321 WHERE id=1"
+      @client.affected_rows.should eql(1)
+    end
+  end
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Brian Lopez
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-06 00:00:00 -07:00
+date: 2010-04-07 00:00:00 -07:00
 default_executable: 
 dependencies: []