mysql2 0.3.12b4 → 0.3.12b5

data/lib/mysql2.rb

@@ -5,8 +5,8 @@ require 'rational' unless RUBY_VERSION >= '1.9.2'
 
 require 'mysql2/version' unless defined? Mysql2::VERSION
 require 'mysql2/error'
-require 'mysql2/result'
 require 'mysql2/mysql2'
+require 'mysql2/result'
 require 'mysql2/client'
 
 # = Mysql2
@@ -37,5 +37,5 @@ module Mysql2::Util
     return nil unless hash
     Hash[hash.map { |k,v| [k.to_sym, v] }]
   end
-	
+
 end

data/lib/mysql2/client.rb

@@ -23,7 +23,14 @@ module Mysql2
       # Set MySQL connection options (each one is a call to mysql_options())
       [:reconnect, :connect_timeout, :local_infile, :read_timeout, :write_timeout].each do |key|
         next unless opts.key?(key)
-        send(:"#{key}=", opts[key])
+        case key
+        when :reconnect, :local_infile
+          send(:"#{key}=", !!opts[key])
+        when :connect_timeout, :read_timeout, :write_timeout
+          send(:"#{key}=", opts[key].to_i)
+        else
+          send(:"#{key}=", opts[key])
+        end
       end
 
       # force the encoding to utf8
@@ -34,7 +41,7 @@ module Mysql2
       if [:user,:pass,:hostname,:dbname,:db,:sock].any?{|k| @query_options.has_key?(k) }
         warn "============= WARNING FROM mysql2 ============="
         warn "The options :user, :pass, :hostname, :dbname, :db, and :sock will be deprecated at some point in the future."
-        warn "Instead, please use :username, :password, :host, 'localhost', :port, :database, :socket, :flags for the options."
+        warn "Instead, please use :username, :password, :host, :port, :database, :socket, :flags for the options."
         warn "============= END WARNING FROM mysql2 ========="
       end
 
@@ -53,214 +60,6 @@ module Mysql2
       @@default_query_options
     end
 
-    # NOTE: from ruby-mysql
-    if defined? Encoding
-      CHARSET_MAP = {
-        "armscii8" => nil,
-        "ascii"    => Encoding::US_ASCII,
-        "big5"     => Encoding::Big5,
-        "binary"   => Encoding::ASCII_8BIT,
-        "cp1250"   => Encoding::Windows_1250,
-        "cp1251"   => Encoding::Windows_1251,
-        "cp1256"   => Encoding::Windows_1256,
-        "cp1257"   => Encoding::Windows_1257,
-        "cp850"    => Encoding::CP850,
-        "cp852"    => Encoding::CP852,
-        "cp866"    => Encoding::IBM866,
-        "cp932"    => Encoding::Windows_31J,
-        "dec8"     => nil,
-        "eucjpms"  => Encoding::EucJP_ms,
-        "euckr"    => Encoding::EUC_KR,
-        "gb2312"   => Encoding::EUC_CN,
-        "gbk"      => Encoding::GBK,
-        "geostd8"  => nil,
-        "greek"    => Encoding::ISO_8859_7,
-        "hebrew"   => Encoding::ISO_8859_8,
-        "hp8"      => nil,
-        "keybcs2"  => nil,
-        "koi8r"    => Encoding::KOI8_R,
-        "koi8u"    => Encoding::KOI8_U,
-        "latin1"   => Encoding::ISO_8859_1,
-        "latin2"   => Encoding::ISO_8859_2,
-        "latin5"   => Encoding::ISO_8859_9,
-        "latin7"   => Encoding::ISO_8859_13,
-        "macce"    => Encoding::MacCentEuro,
-        "macroman" => Encoding::MacRoman,
-        "sjis"     => Encoding::SHIFT_JIS,
-        "swe7"     => nil,
-        "tis620"   => Encoding::TIS_620,
-        "ucs2"     => Encoding::UTF_16BE,
-        "ujis"     => Encoding::EucJP_ms,
-        "utf8"     => Encoding::UTF_8,
-        "utf8mb4"  => Encoding::UTF_8,
-      }
-
-      MYSQL_CHARSET_MAP = {
-        1 => {:name => "big5",      :collation => "big5_chinese_ci"},
-        2 => {:name => "latin2",    :collation => "latin2_czech_cs"},
-        3 => {:name => "dec8",      :collation => "dec8_swedish_ci"},
-        4 => {:name => "cp850",     :collation => "cp850_general_ci"},
-        5 => {:name => "latin1",    :collation => "latin1_german1_ci"},
-        6 => {:name => "hp8",       :collation => "hp8_english_ci"},
-        7 => {:name => "koi8r",     :collation => "koi8r_general_ci"},
-        8 => {:name => "latin1",    :collation => "latin1_swedish_ci"},
-        9 => {:name => "latin2",    :collation => "latin2_general_ci"},
-        10 => {:name => "swe7",     :collation => "swe7_swedish_ci"},
-        11 => {:name => "ascii",    :collation => "ascii_general_ci"},
-        12 => {:name => "ujis",     :collation => "ujis_japanese_ci"},
-        13 => {:name => "sjis",     :collation => "sjis_japanese_ci"},
-        14 => {:name => "cp1251",   :collation => "cp1251_bulgarian_ci"},
-        15 => {:name => "latin1",   :collation => "latin1_danish_ci"},
-        16 => {:name => "hebrew",   :collation => "hebrew_general_ci"},
-        17 => {:name => "filename", :collation => "filename"},
-        18 => {:name => "tis620",   :collation => "tis620_thai_ci"},
-        19 => {:name => "euckr",    :collation => "euckr_korean_ci"},
-        20 => {:name => "latin7",   :collation => "latin7_estonian_cs"},
-        21 => {:name => "latin2",   :collation => "latin2_hungarian_ci"},
-        22 => {:name => "koi8u",    :collation => "koi8u_general_ci"},
-        23 => {:name => "cp1251",   :collation => "cp1251_ukrainian_ci"},
-        24 => {:name => "gb2312",   :collation => "gb2312_chinese_ci"},
-        25 => {:name => "greek",    :collation => "greek_general_ci"},
-        26 => {:name => "cp1250",   :collation => "cp1250_general_ci"},
-        27 => {:name => "latin2",   :collation => "latin2_croatian_ci"},
-        28 => {:name => "gbk",      :collation => "gbk_chinese_ci"},
-        29 => {:name => "cp1257",   :collation => "cp1257_lithuanian_ci"},
-        30 => {:name => "latin5",   :collation => "latin5_turkish_ci"},
-        31 => {:name => "latin1",   :collation => "latin1_german2_ci"},
-        32 => {:name => "armscii8", :collation => "armscii8_general_ci"},
-        33 => {:name => "utf8",     :collation => "utf8_general_ci"},
-        34 => {:name => "cp1250",   :collation => "cp1250_czech_cs"},
-        35 => {:name => "ucs2",     :collation => "ucs2_general_ci"},
-        36 => {:name => "cp866",    :collation => "cp866_general_ci"},
-        37 => {:name => "keybcs2",  :collation => "keybcs2_general_ci"},
-        38 => {:name => "macce",    :collation => "macce_general_ci"},
-        39 => {:name => "macroman", :collation => "macroman_general_ci"},
-        40 => {:name => "cp852",    :collation => "cp852_general_ci"},
-        41 => {:name => "latin7",   :collation => "latin7_general_ci"},
-        42 => {:name => "latin7",   :collation => "latin7_general_cs"},
-        43 => {:name => "macce",    :collation => "macce_bin"},
-        44 => {:name => "cp1250",   :collation => "cp1250_croatian_ci"},
-        45 => {:name => "utf8mb4",  :collation => "utf8mb4_general_ci"},
-        46 => {:name => "utf8mb4",  :collation => "utf8mb4_bin"},
-        47 => {:name => "latin1",   :collation => "latin1_bin"},
-        48 => {:name => "latin1",   :collation => "latin1_general_ci"},
-        49 => {:name => "latin1",   :collation => "latin1_general_cs"},
-        50 => {:name => "cp1251",   :collation => "cp1251_bin"},
-        51 => {:name => "cp1251",   :collation => "cp1251_general_ci"},
-        52 => {:name => "cp1251",   :collation => "cp1251_general_cs"},
-        53 => {:name => "macroman", :collation => "macroman_bin"},
-        57 => {:name => "cp1256",   :collation => "cp1256_general_ci"},
-        58 => {:name => "cp1257",   :collation => "cp1257_bin"},
-        59 => {:name => "cp1257",   :collation => "cp1257_general_ci"},
-        63 => {:name => "binary",   :collation => "binary"},
-        64 => {:name => "armscii8", :collation => "armscii8_bin"},
-        65 => {:name => "ascii",    :collation => "ascii_bin"},
-        66 => {:name => "cp1250",   :collation => "cp1250_bin"},
-        67 => {:name => "cp1256",   :collation => "cp1256_bin"},
-        68 => {:name => "cp866",    :collation => "cp866_bin"},
-        69 => {:name => "dec8",     :collation => "dec8_bin"},
-        70 => {:name => "greek",    :collation => "greek_bin"},
-        71 => {:name => "hebrew",   :collation => "hebrew_bin"},
-        72 => {:name => "hp8",      :collation => "hp8_bin"},
-        73 => {:name => "keybcs2",  :collation => "keybcs2_bin"},
-        74 => {:name => "koi8r",    :collation => "koi8r_bin"},
-        75 => {:name => "koi8u",    :collation => "koi8u_bin"},
-        77 => {:name => "latin2",   :collation => "latin2_bin"},
-        78 => {:name => "latin5",   :collation => "latin5_bin"},
-        79 => {:name => "latin7",   :collation => "latin7_bin"},
-        80 => {:name => "cp850",    :collation => "cp850_bin"},
-        81 => {:name => "cp852",    :collation => "cp852_bin"},
-        82 => {:name => "swe7",     :collation => "swe7_bin"},
-        83 => {:name => "utf8",     :collation => "utf8_bin"},
-        84 => {:name => "big5",     :collation => "big5_bin"},
-        85 => {:name => "euckr",    :collation => "euckr_bin"},
-        86 => {:name => "gb2312",   :collation => "gb2312_bin"},
-        87 => {:name => "gbk",      :collation => "gbk_bin"},
-        88 => {:name => "sjis",     :collation => "sjis_bin"},
-        89 => {:name => "tis620",   :collation => "tis620_bin"},
-        90 => {:name => "ucs2",     :collation => "ucs2_bin"},
-        91 => {:name => "ujis",     :collation => "ujis_bin"},
-        92 => {:name => "geostd8",  :collation => "geostd8_general_ci"},
-        93 => {:name => "geostd8",  :collation => "geostd8_bin"},
-        94 => {:name => "latin1",   :collation => "latin1_spanish_ci"},
-        95 => {:name => "cp932",    :collation => "cp932_japanese_ci"},
-        96 => {:name => "cp932",    :collation => "cp932_bin"},
-        97 => {:name => "eucjpms",  :collation => "eucjpms_japanese_ci"},
-        98 => {:name => "eucjpms",  :collation => "eucjpms_bin"},
-        99 => {:name => "cp1250",   :collation => "cp1250_polish_ci"},
-        128 => {:name => "ucs2",    :collation => "ucs2_unicode_ci"},
-        129 => {:name => "ucs2",    :collation => "ucs2_icelandic_ci"},
-        130 => {:name => "ucs2",    :collation => "ucs2_latvian_ci"},
-        131 => {:name => "ucs2",    :collation => "ucs2_romanian_ci"},
-        132 => {:name => "ucs2",    :collation => "ucs2_slovenian_ci"},
-        133 => {:name => "ucs2",    :collation => "ucs2_polish_ci"},
-        134 => {:name => "ucs2",    :collation => "ucs2_estonian_ci"},
-        135 => {:name => "ucs2",    :collation => "ucs2_spanish_ci"},
-        136 => {:name => "ucs2",    :collation => "ucs2_swedish_ci"},
-        137 => {:name => "ucs2",    :collation => "ucs2_turkish_ci"},
-        138 => {:name => "ucs2",    :collation => "ucs2_czech_ci"},
-        139 => {:name => "ucs2",    :collation => "ucs2_danish_ci"},
-        140 => {:name => "ucs2",    :collation => "ucs2_lithuanian_ci"},
-        141 => {:name => "ucs2",    :collation => "ucs2_slovak_ci"},
-        142 => {:name => "ucs2",    :collation => "ucs2_spanish2_ci"},
-        143 => {:name => "ucs2",    :collation => "ucs2_roman_ci"},
-        144 => {:name => "ucs2",    :collation => "ucs2_persian_ci"},
-        145 => {:name => "ucs2",    :collation => "ucs2_esperanto_ci"},
-        146 => {:name => "ucs2",    :collation => "ucs2_hungarian_ci"},
-        192 => {:name => "utf8",    :collation => "utf8_unicode_ci"},
-        193 => {:name => "utf8",    :collation => "utf8_icelandic_ci"},
-        194 => {:name => "utf8",    :collation => "utf8_latvian_ci"},
-        195 => {:name => "utf8",    :collation => "utf8_romanian_ci"},
-        196 => {:name => "utf8",    :collation => "utf8_slovenian_ci"},
-        197 => {:name => "utf8",    :collation => "utf8_polish_ci"},
-        198 => {:name => "utf8",    :collation => "utf8_estonian_ci"},
-        199 => {:name => "utf8",    :collation => "utf8_spanish_ci"},
-        200 => {:name => "utf8",    :collation => "utf8_swedish_ci"},
-        201 => {:name => "utf8",    :collation => "utf8_turkish_ci"},
-        202 => {:name => "utf8",    :collation => "utf8_czech_ci"},
-        203 => {:name => "utf8",    :collation => "utf8_danish_ci"},
-        204 => {:name => "utf8",    :collation => "utf8_lithuanian_ci"},
-        205 => {:name => "utf8",    :collation => "utf8_slovak_ci"},
-        206 => {:name => "utf8",    :collation => "utf8_spanish2_ci"},
-        207 => {:name => "utf8",    :collation => "utf8_roman_ci"},
-        208 => {:name => "utf8",    :collation => "utf8_persian_ci"},
-        209 => {:name => "utf8",    :collation => "utf8_esperanto_ci"},
-        210 => {:name => "utf8",    :collation => "utf8_hungarian_ci"},
-        224 => {:name => "utf8mb4", :collation => "utf8mb4_unicode_ci"},
-        225 => {:name => "utf8mb4", :collation => "utf8mb4_icelandic_ci"},
-        226 => {:name => "utf8mb4", :collation => "utf8mb4_latvian_ci"},
-        227 => {:name => "utf8mb4", :collation => "utf8mb4_romanian_ci"},
-        228 => {:name => "utf8mb4", :collation => "utf8mb4_slovenian_ci"},
-        229 => {:name => "utf8mb4", :collation => "utf8mb4_polish_ci"},
-        230 => {:name => "utf8mb4", :collation => "utf8mb4_estonian_ci"},
-        231 => {:name => "utf8mb4", :collation => "utf8mb4_spanish_ci"},
-        232 => {:name => "utf8mb4", :collation => "utf8mb4_swedish_ci"},
-        233 => {:name => "utf8mb4", :collation => "utf8mb4_turkish_ci"},
-        234 => {:name => "utf8mb4", :collation => "utf8mb4_czech_ci"},
-        235 => {:name => "utf8mb4", :collation => "utf8mb4_danish_ci"},
-        236 => {:name => "utf8mb4", :collation => "utf8mb4_lithuanian_ci"},
-        237 => {:name => "utf8mb4", :collation => "utf8mb4_slovak_ci"},
-        238 => {:name => "utf8mb4", :collation => "utf8mb4_spanish2_ci"},
-        239 => {:name => "utf8mb4", :collation => "utf8mb4_roman_ci"},
-        240 => {:name => "utf8mb4", :collation => "utf8mb4_persian_ci"},
-        241 => {:name => "utf8mb4", :collation => "utf8mb4_esperanto_ci"},
-        242 => {:name => "utf8mb4", :collation => "utf8mb4_hungarian_ci"},
-        254 => {:name => "utf8",    :collation => "utf8_general_cs"}
-      }
-
-      def self.encoding_from_charset(charset)
-        CHARSET_MAP[charset.to_s.downcase]
-      end
-
-      def self.encoding_from_charset_code(code)
-        if mapping = MYSQL_CHARSET_MAP[code]
-          encoding_from_charset(mapping[:name])
-        else
-          nil
-        end
-      end
-    end
-
     private
       def self.local_offset
         ::Time.local(2010).utc_offset.to_r / 86400

data/lib/mysql2/version.rb

@@ -1,3 +1,3 @@
 module Mysql2
-  VERSION = "0.3.12b4"
+  VERSION = "0.3.12b5"
 end

data/spec/mysql2/client_spec.rb

@@ -6,12 +6,30 @@ describe Mysql2::Client do
     @client = Mysql2::Client.new DatabaseCredentials['root']
   end
 
+  it "should raise an exception upon connection failure" do
+    lambda {
+      # The odd local host IP address forces the mysql client library to
+      # use a TCP socket rather than a domain socket.
+      Mysql2::Client.new DatabaseCredentials['root'].merge('host' => '127.0.0.2', 'port' => 999999)
+    }.should raise_error(Mysql2::Error)
+  end
+
   if defined? Encoding
     it "should raise an exception on create for invalid encodings" do
       lambda {
         c = Mysql2::Client.new(:encoding => "fake")
       }.should raise_error(Mysql2::Error)
     end
+
+    it "should not raise an exception on create for a valid encoding" do
+      lambda {
+        c = Mysql2::Client.new(:encoding => "utf8")
+      }.should_not raise_error(Mysql2::Error)
+
+      lambda {
+        c = Mysql2::Client.new(:encoding => "big5")
+      }.should_not raise_error(Mysql2::Error)
+    end
   end
 
   it "should accept connect flags and pass them to #connect" do
@@ -85,6 +103,31 @@ describe Mysql2::Client do
     @client.should respond_to(:query)
   end
 
+  it "should respond to #warning_count" do
+    @client.should respond_to(:warning_count)
+  end
+
+  context "#warning_count" do
+    context "when no warnings" do
+      before(:each) do
+        @client.query('select 1')
+      end
+      it "should 0" do
+        @client.warning_count.should == 0
+      end
+    end
+    context "when has a warnings" do
+      before(:each) do
+        # "the statement produces extra information that can be viewed by issuing a SHOW WARNINGS"
+        # http://dev.mysql.com/doc/refman/5.0/en/explain-extended.html
+        @client.query("explain extended select 1")
+      end
+      it "should > 0" do
+        @client.warning_count.should > 0
+      end
+    end
+  end
+
   it "should expect connect_timeout to be a positive integer" do
     lambda {
       Mysql2::Client.new(:connect_timeout => -1)
@@ -126,9 +169,26 @@ describe Mysql2::Client do
       }.should raise_error(TypeError)
     end
 
-    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))
+    it "should not retain query options set on a query for subsequent queries, but should retain it in the result" do
+      result = @client.query "SELECT 1", :something => :else
+      @client.query_options[:something].should be_nil
+      result.instance_variable_get('@query_options').should eql(@client.query_options.merge(:something => :else))
+      @client.instance_variable_get('@current_query_options').should eql(@client.query_options.merge(:something => :else))
+
+      result = @client.query "SELECT 1"
+      result.instance_variable_get('@query_options').should eql(@client.query_options)
+      @client.instance_variable_get('@current_query_options').should eql(@client.query_options)
+    end
+
+    it "should allow changing query options for subsequent queries" do
+      @client.query_options.merge!(:something => :else)
+      result = @client.query "SELECT 1"
+      @client.query_options[:something].should eql(:else)
+      result.instance_variable_get('@query_options')[:something].should eql(:else)
+
+      # Clean up after this test
+      @client.query_options.delete(:something)
+      @client.query_options[:something].should be_nil
     end
 
     it "should return results as a hash by default" do
@@ -245,15 +305,47 @@ describe Mysql2::Client do
         }.should_not raise_error(Mysql2::Error)
       end
 
+      it "should handle Timeouts without leaving the connection hanging if reconnect is set to true after construction true" do
+        client = Mysql2::Client.new(DatabaseCredentials['root'])
+        begin
+          Timeout.timeout(1) do
+            client.query("SELECT sleep(2)")
+          end
+        rescue Timeout::Error
+        end
+
+        lambda {
+          client.query("SELECT 1")
+        }.should raise_error(Mysql2::Error)
+
+        client.reconnect = true
+
+        begin
+          Timeout.timeout(1) do
+            client.query("SELECT sleep(2)")
+          end
+        rescue Timeout::Error
+        end
+
+        lambda {
+          client.query("SELECT 1")
+        }.should_not raise_error(Mysql2::Error)
+
+      end
+
       it "threaded queries should be supported" do
         threads, results = [], {}
+        lock = Mutex.new
         connect = lambda{
           Mysql2::Client.new(DatabaseCredentials['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")
+              result = connect.call.query("SELECT sleep(0.5) as result")
+              lock.synchronize do
+                results[Thread.current.object_id] = result
+              end
             end
           }
         end
@@ -281,14 +373,6 @@ describe Mysql2::Client do
         result = @client.async_result
         result.class.should eql(Mysql2::Result)
       end
-
-      it "should not allow options to be set on an open connection" do
-        lambda {
-          @client.escape ""
-          @client.query("SELECT 1")
-          @client.options(0, 0)
-        }.should raise_error(Mysql2::Error)
-      end
     end
 
     context "Multiple results sets" do
@@ -313,6 +397,31 @@ describe Mysql2::Client do
 
         @multi_client.query( "select 3 as 'next'").first.should == { 'next' => 3 }
       end
+
+      it "will raise on query if there are outstanding results to read" do
+        @multi_client.query("SELECT 1; SELECT 2; SELECT 3")
+        lambda {
+          @multi_client.query("SELECT 4")
+        }.should raise_error(Mysql2::Error)
+      end
+
+      it "#abandon_results! should work" do
+        @multi_client.query("SELECT 1; SELECT 2; SELECT 3")
+        @multi_client.abandon_results!
+        lambda {
+          @multi_client.query("SELECT 4")
+        }.should_not raise_error(Mysql2::Error)
+      end
+
+      it "#more_results? should work" do
+        @multi_client.query( "select 1 as 'set_1'; select 2 as 'set_2'")
+        @multi_client.more_results?.should == true
+ 
+        @multi_client.next_result
+        @multi_client.store_result
+ 
+        @multi_client.more_results?.should == false
+      end
     end
   end
 
@@ -354,7 +463,7 @@ describe Mysql2::Client do
       }.should_not raise_error(SystemStackError)
     end
 
-    if RUBY_VERSION =~ /1.9/
+    unless RUBY_VERSION =~ /1.8/
       it "should carry over the original string's encoding" do
         str = "abc'def\"ghi\0jkl%mno"
         escaped = Mysql2::Client.escape(str)
@@ -571,7 +680,7 @@ describe Mysql2::Client do
     @client.ping.should eql(false)
   end
 
-  if RUBY_VERSION =~ /1.9/
+  unless RUBY_VERSION =~ /1.8/
     it "should respond to #encoding" do
       @client.should respond_to(:encoding)
     end