mysql2 0.1.9 → 0.2.0

data/lib/mysql2/client.rb

@@ -1,6 +1,18 @@
 module Mysql2
   class Client
-    def initialize opts = {}
+    attr_reader :query_options
+    @@default_query_options = {
+      :as => :hash,
+      :async => false,
+      :cast_booleans => false,
+      :symbolize_keys => false,
+      :database_timezone => :local, # timezone Mysql2 will assume datetime objects are stored in
+      :application_timezone => nil  # timezone Mysql2 will convert to before handing the object back to the caller
+    }
+
+    def initialize(opts = {})
+      @query_options = @@default_query_options.dup
+
       init_connection
 
       [:reconnect, :connect_timeout].each do |key|
@@ -22,6 +34,10 @@ module Mysql2
       connect user, pass, host, port, database, socket
     end
 
+    def self.default_query_options
+      @@default_query_options
+    end
+
     # NOTE: from ruby-mysql
     if defined? Encoding
       CHARSET_MAP = {

data/mysql2.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mysql2}
-  s.version = "0.1.9"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Brian Lopez"]
-  s.date = %q{2010-07-17}
+  s.date = %q{2010-08-16}
   s.email = %q{seniorlopez@gmail.com}
   s.extensions = ["ext/mysql2/extconf.rb"]
   s.extra_rdoc_files = [
@@ -23,19 +23,23 @@ Gem::Specification.new do |s|
      "Rakefile",
      "VERSION",
      "benchmark/active_record.rb",
+     "benchmark/allocations.rb",
      "benchmark/escape.rb",
      "benchmark/query_with_mysql_casting.rb",
      "benchmark/query_without_mysql_casting.rb",
      "benchmark/sequel.rb",
      "benchmark/setup_db.rb",
+     "benchmark/thread_alone.rb",
      "examples/eventmachine.rb",
+     "examples/threaded.rb",
+     "ext/mysql2/client.c",
+     "ext/mysql2/client.h",
      "ext/mysql2/extconf.rb",
      "ext/mysql2/mysql2_ext.c",
      "ext/mysql2/mysql2_ext.h",
      "ext/mysql2/result.c",
      "ext/mysql2/result.h",
      "lib/active_record/connection_adapters/em_mysql2_adapter.rb",
-     "lib/active_record/connection_adapters/mysql2_adapter.rb",
      "lib/active_record/fiber_patches.rb",
      "lib/arel/engines/sql/compilers/mysql2_compiler.rb",
      "lib/mysql2.rb",
@@ -43,16 +47,17 @@ Gem::Specification.new do |s|
      "lib/mysql2/em.rb",
      "lib/mysql2/error.rb",
      "lib/mysql2/result.rb",
-     "lib/sequel/adapters/mysql2.rb",
      "mysql2.gemspec",
-     "spec/active_record/active_record_spec.rb",
      "spec/em/em_spec.rb",
      "spec/mysql2/client_spec.rb",
      "spec/mysql2/error_spec.rb",
      "spec/mysql2/result_spec.rb",
      "spec/rcov.opts",
      "spec/spec.opts",
-     "spec/spec_helper.rb"
+     "spec/spec_helper.rb",
+     "tasks/benchmarks.rake",
+     "tasks/compile.rake",
+     "tasks/vendor_mysql.rake"
   ]
   s.homepage = %q{http://github.com/brianmario/mysql2}
   s.rdoc_options = ["--charset=UTF-8"]
@@ -60,13 +65,13 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{A simple, fast Mysql library for Ruby, binding to libmysql}
   s.test_files = [
-    "spec/active_record/active_record_spec.rb",
-     "spec/em/em_spec.rb",
+    "spec/em/em_spec.rb",
      "spec/mysql2/client_spec.rb",
      "spec/mysql2/error_spec.rb",
      "spec/mysql2/result_spec.rb",
      "spec/spec_helper.rb",
-     "examples/eventmachine.rb"
+     "examples/eventmachine.rb",
+     "examples/threaded.rb"
   ]
 
   if s.respond_to? :specification_version then

data/spec/mysql2/client_spec.rb

@@ -14,6 +14,10 @@ describe Mysql2::Client do
     end
   end
 
+  it "should have a global default_query_options hash" do
+    Mysql2::Client.should respond_to(:default_query_options)
+  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
@@ -38,26 +42,46 @@ describe Mysql2::Client do
   end
 
   it "should respond to #close" do
-    @client.should respond_to :close
+    @client.should respond_to(:close)
   end
 
   it "should be able to close properly" do
     @client.close.should be_nil
   end
 
-  it "should raise an exception when closed twice" do
-    @client.close.should be_nil
-    lambda {
-      @client.close
-    }.should raise_error(Mysql2::Error)
+  it "should respond to #query" do
+    @client.should respond_to(:query)
   end
 
-  it "should respond to #query" do
-    @client.should respond_to :query
+  context "#query" do
+    it "should accept an options hash that inherits from Mysql2::Client.default_query_options" do
+      @client.query "SELECT 1", :something => :else
+      @client.query_options.should eql(@client.query_options.merge(:something => :else))
+    end
+
+    it "should return results as a hash by default" do
+      @client.query("SELECT 1").first.class.should eql(Hash)
+    end
+
+    it "should be able to return results as an array" do
+      @client.query("SELECT 1", :as => :array).first.class.should eql(Array)
+      @client.query("SELECT 1").each(:as => :array)
+    end
+
+    it "should be able to return results with symbolized keys" do
+      @client.query("SELECT 1", :symbolize_keys => true).first.keys[0].class.should eql(Symbol)
+    end
+
+    it "should not allow another query to be sent without fetching a result first" do
+      @client.query("SELECT 1", :async => true)
+      lambda {
+        @client.query("SELECT 1")
+      }.should raise_error(Mysql2::Error)
+    end
   end
 
   it "should respond to #escape" do
-    @client.should respond_to :escape
+    @client.should respond_to(:escape)
   end
 
   it "#escape should return a new SQL-escape version of the passed string" do
@@ -70,7 +94,7 @@ describe Mysql2::Client do
   end
 
   it "should respond to #info" do
-    @client.should respond_to :info
+    @client.should respond_to(:info)
   end
 
   it "#info should return a hash containing the client version ID and String" do
@@ -102,7 +126,7 @@ describe Mysql2::Client do
   end
 
   it "should respond to #server_info" do
-    @client.should respond_to :server_info
+    @client.should respond_to(:server_info)
   end
 
   it "#server_info should return a hash containing the client version ID and String" do
@@ -134,7 +158,7 @@ describe Mysql2::Client do
   end
 
   it "should respond to #socket" do
-    @client.should respond_to :socket
+    @client.should respond_to(:socket)
   end
 
   it "#socket should return a Fixnum (file descriptor from C)" do
@@ -152,6 +176,20 @@ describe Mysql2::Client do
     }.should_not raise_error(Mysql2::Error)
   end
 
+  it "threaded queries should be supported" do
+    threads, results = [], {}
+    connect = lambda{ Mysql2::Client.new(:host => "localhost", :username => "root") }
+    Timeout.timeout(0.7) do
+      5.times {
+        threads << Thread.new do
+          results[Thread.current.object_id] = connect.call.query("SELECT sleep(0.5) as result")
+        end
+      }
+    end
+    threads.each{|t| t.join }
+    results.keys.sort.should eql(threads.map{|t| t.object_id }.sort)
+  end
+
   it "evented async queries should be supported" do
     # should immediately return nil
     @client.query("SELECT sleep(0.1)", :async => true).should eql(nil)

data/spec/mysql2/result_spec.rb

@@ -2,7 +2,7 @@
 require 'spec_helper'
 
 describe Mysql2::Result do
-  before(:all) do
+  before(:each) do
     @client = Mysql2::Client.new :host => "localhost", :username => "root"
   end
 
@@ -15,7 +15,7 @@ describe Mysql2::Result do
   end
 
   it "should respond to #each" do
-    @result.should respond_to :each
+    @result.should respond_to(:each)
   end
 
   it "should raise a Mysql2::Error exception upon a bad query" do
@@ -37,18 +37,23 @@ describe Mysql2::Result do
 
     it "should yield rows as hash's with symbol keys if :symbolize_keys was set to true" do
       @result.each(:symbolize_keys => true) do |row|
-        row.class.should eql(Hash)
         row.keys.first.class.should eql(Symbol)
       end
     end
 
+    it "should be able to return results as an array" do
+      @result.each(:as => :array) do |row|
+        row.class.should eql(Array)
+      end
+    end
+
     it "should cache previously yielded results" do
       @result.first.should eql(@result.first)
     end
   end
 
   context "#fields" do
-    before(:all) do
+    before(:each) do
       @client.query "USE test"
       @test_result = @client.query("SELECT * FROM mysql2_test ORDER BY id DESC LIMIT 1")
     end
@@ -64,67 +69,11 @@ describe Mysql2::Result do
   end
 
   context "row data type mapping" do
-    before(:all) do
+    before(:each) do
       @client.query "USE test"
-      @client.query %[
-        CREATE TABLE IF NOT EXISTS mysql2_test (
-          id MEDIUMINT NOT NULL AUTO_INCREMENT,
-          null_test VARCHAR(10),
-          bit_test BIT(64),
-          tiny_int_test TINYINT,
-          small_int_test SMALLINT,
-          medium_int_test MEDIUMINT,
-          int_test INT,
-          big_int_test BIGINT,
-          float_test FLOAT(10,3),
-          double_test DOUBLE(10,3),
-          decimal_test DECIMAL(10,3),
-          date_test DATE,
-          date_time_test DATETIME,
-          timestamp_test TIMESTAMP,
-          time_test TIME,
-          year_test YEAR(4),
-          char_test CHAR(10),
-          varchar_test VARCHAR(10),
-          binary_test BINARY(10),
-          varbinary_test VARBINARY(10),
-          tiny_blob_test TINYBLOB,
-          tiny_text_test TINYTEXT,
-          blob_test BLOB,
-          text_test TEXT,
-          medium_blob_test MEDIUMBLOB,
-          medium_text_test MEDIUMTEXT,
-          long_blob_test LONGBLOB,
-          long_text_test LONGTEXT,
-          enum_test ENUM('val1', 'val2'),
-          set_test SET('val1', 'val2'),
-          PRIMARY KEY (id)
-        )
-      ]
-      @client.query %[
-        INSERT INTO mysql2_test (
-          null_test, bit_test, tiny_int_test, small_int_test, medium_int_test, int_test, big_int_test,
-          float_test, double_test, decimal_test, date_test, date_time_test, timestamp_test, time_test,
-          year_test, char_test, varchar_test, binary_test, varbinary_test, tiny_blob_test,
-          tiny_text_test, blob_test, text_test, medium_blob_test, medium_text_test,
-          long_blob_test, long_text_test, enum_test, set_test
-        )
-
-        VALUES (
-          NULL, b'101', 1, 10, 10, 10, 10,
-          10.3, 10.3, 10.3, '2010-4-4', '2010-4-4 11:44:00', '2010-4-4 11:44:00', '11:44:00',
-          2009, "test", "test", "test", "test", "test",
-          "test", "test", "test", "test", "test",
-          "test", "test", 'val1', 'val1,val2'
-        )
-      ]
       @test_result = @client.query("SELECT * FROM mysql2_test ORDER BY id DESC LIMIT 1").first
     end
 
-    after(:all) do
-      @client.query("DELETE FROM mysql2_test WHERE id=#{@test_result['id']}")
-    end
-
     it "should return nil for a NULL value" do
       @test_result['null_test'].class.should eql(NilClass)
       @test_result['null_test'].should eql(nil)
@@ -140,6 +89,20 @@ describe Mysql2::Result do
       @test_result['tiny_int_test'].should eql(1)
     end
 
+    it "should return TrueClass or FalseClass for a TINYINT value if :cast_booleans is enabled" do
+      @client.query 'INSERT INTO mysql2_test (bool_cast_test) VALUES (1)'
+      id1 = @client.last_id
+      @client.query 'INSERT INTO mysql2_test (bool_cast_test) VALUES (0)'
+      id2 = @client.last_id
+
+      result1 = @client.query 'SELECT bool_cast_test FROM mysql2_test WHERE bool_cast_test = 1 LIMIT 1', :cast_booleans => true
+      result2 = @client.query 'SELECT bool_cast_test FROM mysql2_test WHERE bool_cast_test = 0 LIMIT 1', :cast_booleans => true
+      result1.first['bool_cast_test'].should be_true
+      result2.first['bool_cast_test'].should be_false
+
+      @client.query "DELETE from mysql2_test WHERE id IN(#{id1},#{id2})"
+    end
+
     it "should return Fixnum for a SMALLINT value" do
       [Fixnum, Bignum].should include(@test_result['small_int_test'].class)
       @test_result['small_int_test'].should eql(10)
@@ -192,11 +155,7 @@ describe Mysql2::Result do
 
     it "should return Time for a TIME value" do
       @test_result['time_test'].class.should eql(Time)
-      if RUBY_VERSION >= "1.9.2"
-        @test_result['time_test'].strftime("%F %T").should eql('0000-01-01 11:44:00')
-      else
-        @test_result['time_test'].strftime("%F %T").should eql('2000-01-01 11:44:00')
-      end
+      @test_result['time_test'].strftime("%F %T").should eql('2000-01-01 11:44:00')
     end
 
     it "should return Date for a DATE value" do

data/spec/spec_helper.rb

@@ -3,3 +3,65 @@ $LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/..')
 $LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
 
 require 'mysql2'
+require 'timeout'
+
+Spec::Runner.configure do |config|
+  config.before(:all) do
+    client = Mysql2::Client.new :database => 'test'
+    client.query %[
+      CREATE TABLE IF NOT EXISTS mysql2_test (
+        id MEDIUMINT NOT NULL AUTO_INCREMENT,
+        null_test VARCHAR(10),
+        bit_test BIT(64),
+        tiny_int_test TINYINT,
+        bool_cast_test TINYINT(1),
+        small_int_test SMALLINT,
+        medium_int_test MEDIUMINT,
+        int_test INT,
+        big_int_test BIGINT,
+        float_test FLOAT(10,3),
+        float_zero_test FLOAT(10,3),
+        double_test DOUBLE(10,3),
+        decimal_test DECIMAL(10,3),
+        decimal_zero_test DECIMAL(10,3),
+        date_test DATE,
+        date_time_test DATETIME,
+        timestamp_test TIMESTAMP,
+        time_test TIME,
+        year_test YEAR(4),
+        char_test CHAR(10),
+        varchar_test VARCHAR(10),
+        binary_test BINARY(10),
+        varbinary_test VARBINARY(10),
+        tiny_blob_test TINYBLOB,
+        tiny_text_test TINYTEXT,
+        blob_test BLOB,
+        text_test TEXT,
+        medium_blob_test MEDIUMBLOB,
+        medium_text_test MEDIUMTEXT,
+        long_blob_test LONGBLOB,
+        long_text_test LONGTEXT,
+        enum_test ENUM('val1', 'val2'),
+        set_test SET('val1', 'val2'),
+        PRIMARY KEY (id)
+      )
+    ]
+    client.query %[
+      INSERT INTO mysql2_test (
+        null_test, bit_test, tiny_int_test, bool_cast_test, small_int_test, medium_int_test, int_test, big_int_test,
+        float_test, float_zero_test, double_test, decimal_test, decimal_zero_test, date_test, date_time_test, timestamp_test, time_test,
+        year_test, char_test, varchar_test, binary_test, varbinary_test, tiny_blob_test,
+        tiny_text_test, blob_test, text_test, medium_blob_test, medium_text_test,
+        long_blob_test, long_text_test, enum_test, set_test
+      )
+
+      VALUES (
+        NULL, b'101', 1, 1, 10, 10, 10, 10,
+        10.3, 0, 10.3, 10.3, 0, '2010-4-4', '2010-4-4 11:44:00', '2010-4-4 11:44:00', '11:44:00',
+        2009, "test", "test", "test", "test", "test",
+        "test", "test", "test", "test", "test",
+        "test", "test", 'val1', 'val1,val2'
+      )
+    ]
+  end
+end

data/tasks/benchmarks.rake

@@ -0,0 +1,8 @@
+namespace :bench do
+  [ :active_record, :escape, :query_with_mysql_casting,
+    :query_without_mysql_casting, :sequel, :allocations,
+    :thread_alone].each do |feature|
+      desc "Run #{feature} benchmarks"
+      task(feature){ ruby "benchmark/#{feature}.rb" }
+  end
+end

data/tasks/compile.rake

@@ -0,0 +1,19 @@
+gem 'rake-compiler', '~> 0.7.1'
+require "rake/extensiontask"
+
+MYSQL_VERSION = "5.1.49"
+MYSQL_MIRROR  = ENV['MYSQL_MIRROR'] || "http://mysql.localhost.net.ar"
+
+Rake::ExtensionTask.new("mysql2", JEWELER.gemspec) do |ext|
+  # reference where the vendored MySQL got extracted
+  mysql_lib = File.expand_path(File.join(File.dirname(__FILE__), '..', 'vendor', "mysql-#{MYSQL_VERSION}-win32"))
+
+  # automatically add build options to avoid need of manual input
+  if RUBY_PLATFORM =~ /mswin|mingw/ then
+    ext.config_options << "--with-mysql-include=#{mysql_lib}/include"
+    ext.config_options << "--with-mysql-lib=#{mysql_lib}/lib/opt"
+  end
+
+  ext.lib_dir = File.join 'lib', 'mysql2'
+end
+Rake::Task[:spec].prerequisites << :compile