mysql2 0.4.4 → 0.5.0

data/lib/mysql2/error.rb

@@ -1,32 +1,65 @@
-# encoding: UTF-8
-
 module Mysql2
   class Error < StandardError
     ENCODE_OPTS = {
-      :undef => :replace,
-      :invalid => :replace,
-      :replace => '?'.freeze,
+      undef: :replace,
+      invalid: :replace,
+      replace: '?'.freeze,
+    }.freeze
+
+    ConnectionError = Class.new(Error)
+    TimeoutError = Class.new(Error)
+
+    CODES = {
+      1205 => TimeoutError, # ER_LOCK_WAIT_TIMEOUT
+
+      1044 => ConnectionError, # ER_DBACCESS_DENIED_ERROR
+      1045 => ConnectionError, # ER_ACCESS_DENIED_ERROR
+      1152 => ConnectionError, # ER_ABORTING_CONNECTION
+      1153 => ConnectionError, # ER_NET_PACKET_TOO_LARGE
+      1154 => ConnectionError, # ER_NET_READ_ERROR_FROM_PIPE
+      1155 => ConnectionError, # ER_NET_FCNTL_ERROR
+      1156 => ConnectionError, # ER_NET_PACKETS_OUT_OF_ORDER
+      1157 => ConnectionError, # ER_NET_UNCOMPRESS_ERROR
+      1158 => ConnectionError, # ER_NET_READ_ERROR
+      1159 => ConnectionError, # ER_NET_READ_INTERRUPTED
+      1160 => ConnectionError, # ER_NET_ERROR_ON_WRITE
+      1161 => ConnectionError, # ER_NET_WRITE_INTERRUPTED
+
+      2001 => ConnectionError, # CR_SOCKET_CREATE_ERROR
+      2002 => ConnectionError, # CR_CONNECTION_ERROR
+      2003 => ConnectionError, # CR_CONN_HOST_ERROR
+      2004 => ConnectionError, # CR_IPSOCK_ERROR
+      2005 => ConnectionError, # CR_UNKNOWN_HOST
+      2006 => ConnectionError, # CR_SERVER_GONE_ERROR
+      2007 => ConnectionError, # CR_VERSION_ERROR
+      2009 => ConnectionError, # CR_WRONG_HOST_INFO
+      2012 => ConnectionError, # CR_SERVER_HANDSHAKE_ERR
+      2013 => ConnectionError, # CR_SERVER_LOST
+      2020 => ConnectionError, # CR_NET_PACKET_TOO_LARGE
+      2026 => ConnectionError, # CR_SSL_CONNECTION_ERROR
+      2027 => ConnectionError, # CR_MALFORMED_PACKET
+      2047 => ConnectionError, # CR_CONN_UNKNOW_PROTOCOL
+      2048 => ConnectionError, # CR_INVALID_CONN_HANDLE
+      2049 => ConnectionError, # CR_UNUSED_1
     }.freeze
 
     attr_reader :error_number, :sql_state
 
     # Mysql gem compatibility
-    alias_method :errno, :error_number
-    alias_method :error, :message
+    alias errno error_number
+    alias error message
 
-    def initialize(msg)
-      @server_version ||= nil
+    def initialize(msg, server_version = nil, error_number = nil, sql_state = nil)
+      @server_version = server_version
+      @error_number = error_number
+      @sql_state = sql_state ? sql_state.encode(ENCODE_OPTS) : nil
 
       super(clean_message(msg))
     end
 
     def self.new_with_args(msg, server_version, error_number, sql_state)
-      err = allocate
-      err.instance_variable_set('@server_version', server_version)
-      err.instance_variable_set('@error_number', error_number)
-      err.instance_variable_set('@sql_state', sql_state.respond_to?(:encode) ? sql_state.encode(ENCODE_OPTS) : sql_state)
-      err.send(:initialize, msg)
-      err
+      error_class = CODES.fetch(error_number, self)
+      error_class.new(msg, server_version, error_number, sql_state)
     end
 
     private
@@ -55,12 +88,8 @@ module Mysql2
     # encoding, we'll assume UTF-8 and clean the string of anything that's not a
     # valid UTF-8 character.
     #
-    # Except for if we're on 1.8, where we'll do nothing ;)
-    #
-    # Returns a valid UTF-8 string in Ruby 1.9+, the original string on Ruby 1.8
+    # Returns a valid UTF-8 string.
     def clean_message(message)
-      return message unless message.respond_to?(:encode)
-
       if @server_version && @server_version > 50500
         message.encode(ENCODE_OPTS)
       else

data/lib/mysql2/result.rb

@@ -1,5 +1,7 @@
 module Mysql2
   class Result
+    attr_reader :server_flags
+
     include Enumerable
   end
 end

data/lib/mysql2/statement.rb

@@ -2,15 +2,9 @@ module Mysql2
   class Statement
     include Enumerable
 
-    if Thread.respond_to?(:handle_interrupt)
-      def execute(*args)
-        Thread.handle_interrupt(::Mysql2::Util::TimeoutError => :never) do
-          _execute(*args)
-        end
-      end
-    else
-      def execute(*args)
-        _execute(*args)
+    def execute(*args, **kwargs)
+      Thread.handle_interrupt(::Mysql2::Util::TIMEOUT_ERROR_CLASS => :never) do
+        _execute(*args, **kwargs)
       end
     end
   end

data/lib/mysql2/version.rb

@@ -1,3 +1,3 @@
 module Mysql2
-  VERSION = "0.4.4"
+  VERSION = "0.5.0".freeze
 end

data/lib/mysql2.rb

@@ -1,7 +1,5 @@
-# encoding: UTF-8
 require 'date'
 require 'bigdecimal'
-require 'rational' unless RUBY_VERSION >= '1.9.2'
 
 # Load libmysql.dll before requiring mysql2/mysql2.so
 # This gives a chance to be flexible about the load path
@@ -13,16 +11,20 @@ if RUBY_PLATFORM =~ /mswin|mingw/
     ENV['RUBY_MYSQL2_LIBMYSQL_DLL']
   elsif File.exist?(File.expand_path('../vendor/libmysql.dll', File.dirname(__FILE__)))
     # Use vendor/libmysql.dll if it exists, convert slashes for Win32 LoadLibrary
-    File.expand_path('../vendor/libmysql.dll', File.dirname(__FILE__)).tr('/', '\\')
+    File.expand_path('../vendor/libmysql.dll', File.dirname(__FILE__))
+  elsif defined?(RubyInstaller)
+    # RubyInstaller-2.4+ native build doesn't need DLL preloading
   else
     # This will use default / system library paths
     'libmysql.dll'
   end
 
-  require 'Win32API'
-  LoadLibrary = Win32API.new('Kernel32', 'LoadLibrary', ['P'], 'I')
-  if 0 == LoadLibrary.call(dll_path)
-    abort "Failed to load libmysql.dll from #{dll_path}"
+  if dll_path
+    require 'Win32API'
+    LoadLibrary = Win32API.new('Kernel32', 'LoadLibrary', ['P'], 'I')
+    if LoadLibrary.call(dll_path).zero?
+      abort "Failed to load libmysql.dll from #{dll_path}"
+    end
   end
 end
 
@@ -71,14 +73,11 @@ module Mysql2
     # Timeout::ExitException was removed in Ruby 2.3.0, 2.2.3, and 2.1.8,
     # but is present in earlier 2.1.x and 2.2.x, so we provide a shim.
     #
-    if Thread.respond_to?(:handle_interrupt)
-      require 'timeout'
-      # rubocop:disable Style/ConstantName
-      TimeoutError = if defined?(::Timeout::ExitException)
-        ::Timeout::ExitException
-      else
-        ::Timeout::Error
-      end
+    require 'timeout'
+    TIMEOUT_ERROR_CLASS = if defined?(::Timeout::ExitException)
+      ::Timeout::ExitException
+    else
+      ::Timeout::Error
     end
   end
 end

data/spec/configuration.yml.example

@@ -9,9 +9,3 @@ user:
   username: LOCALUSERNAME
   password:
   database: mysql2_test
-
-numericuser:
-  host: localhost
-  username: LOCALUSERNAME
-  password:
-  database: 12345

data/spec/em/em_spec.rb

@@ -1,4 +1,3 @@
-# encoding: UTF-8
 require 'spec_helper'
 begin
   require 'eventmachine'
@@ -49,13 +48,13 @@ begin
     end
 
     it "should not swallow exceptions raised in callbacks" do
-      expect {
+      expect do
         EM.run do
           client = Mysql2::EM::Client.new DatabaseCredentials['root']
           defer = client.query "SELECT sleep(0.1) as first_query"
           defer.callback do
             client.close
-            fail 'some error'
+            raise 'some error'
           end
           defer.errback do
             # This _shouldn't_ be run, but it needed to prevent the specs from
@@ -63,13 +62,14 @@ begin
             EM.stop_event_loop
           end
         end
-      }.to raise_error('some error')
+      end.to raise_error('some error')
     end
 
     context 'when an exception is raised by the client' do
       let(:client) { Mysql2::EM::Client.new DatabaseCredentials['root'] }
       let(:error) { StandardError.new('some error') }
       before { allow(client).to receive(:async_result).and_raise(error) }
+      after { client.close }
 
       it "should swallow exceptions raised in by the client" do
         errors = []
@@ -122,9 +122,9 @@ begin
         end
         EM.add_timer(0.1) do
           expect(callbacks_run).to eq([:callback])
-          expect {
+          expect do
             client.close
-          }.not_to raise_error
+          end.not_to raise_error
           EM.stop_event_loop
         end
       end