Add several RuboCop checks

Author: tamird

.rubocop_todo.yml

@@ -1,21 +1,13 @@
 # This configuration was generated by `rubocop --auto-gen-config`
-# on 2015-03-12 18:00:35 -0700 using RuboCop version 0.29.1.
+# on 2015-03-12 18:28:12 -0700 using RuboCop version 0.29.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 1
-Lint/UselessAccessModifier:
-  Enabled: false
-
-# Offense count: 1
-Lint/Void:
-  Enabled: false
-
 # Offense count: 2
 Metrics/AbcSize:
-  Max: 64
+  Max: 66
 
 # Offense count: 1
 Metrics/BlockNesting:
@@ -30,7 +22,7 @@ Metrics/CyclomaticComplexity:
 Metrics/LineLength:
   Max: 232
 
-# Offense count: 4
+# Offense count: 5
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
   Max: 40
@@ -44,53 +36,21 @@ Metrics/PerceivedComplexity:
 Style/BlockDelimiters:
   Enabled: false
 
-# Offense count: 1
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-Style/ClassAndModuleChildren:
-  Enabled: false
-
-# Offense count: 1
-Style/ClassVars:
-  Enabled: false
-
-# Offense count: 9
+# Offense count: 10
 Style/Documentation:
   Enabled: false
 
-# Offense count: 1
-Style/DoubleNegation:
-  Enabled: false
-
 # Offense count: 9
 # Configuration parameters: AllowedVariables.
 Style/GlobalVars:
   Enabled: false
 
-# Offense count: 4
-# Configuration parameters: MaxLineLength.
-Style/IfUnlessModifier:
-  Enabled: false
-
-# Offense count: 1
-Style/MultilineBlockChain:
-  Enabled: false
-
-# Offense count: 13
+# Offense count: 12
 # Cop supports --auto-correct.
 Style/NumericLiterals:
   MinDigits: 20
 
-# Offense count: 549
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles.
 Style/StringLiterals:
   Enabled: false
-
-# Offense count: 2
-Style/UnlessElse:
-  Enabled: false
-
-# Offense count: 1
-# Configuration parameters: MaxLineLength.
-Style/WhileUntilModifier:
-  Enabled: false

benchmark/query_with_mysql_casting.rb

@@ -30,8 +30,8 @@ def mysql_cast(type, value)
   when Mysql::Field::TYPE_TIME, Mysql::Field::TYPE_DATETIME, Mysql::Field::TYPE_TIMESTAMP
     Time.parse(value)
   when Mysql::Field::TYPE_BLOB, Mysql::Field::TYPE_BIT, Mysql::Field::TYPE_STRING,
-      Mysql::Field::TYPE_VAR_STRING, Mysql::Field::TYPE_CHAR, Mysql::Field::TYPE_SET
-    Mysql::Field::TYPE_ENUM
+      Mysql::Field::TYPE_VAR_STRING, Mysql::Field::TYPE_CHAR, Mysql::Field::TYPE_SET,
+      Mysql::Field::TYPE_ENUM
     value
   else
     value

ext/mysql2/client.c

@@ -648,7 +648,7 @@ static VALUE rb_mysql_client_abandon_results(VALUE self) {
  *    client.query(sql, options = {})
  *
  * Query the database with +sql+, with optional +options+.  For the possible
- * options, see @@default_query_options on the Mysql2::Client class.
+ * options, see default_query_options on the Mysql2::Client class.
  */
 static VALUE rb_query(VALUE self, VALUE sql, VALUE current) {
 #ifndef _WIN32

ext/mysql2/extconf.rb

@@ -66,9 +66,7 @@ def asplode(lib)
   abort unless $CHILD_STATUS.success?
   libs = `#{mc} --libs_r`.chomp
   # MySQL 5.5 and above already have re-entrant code in libmysqlclient (no _r).
-  if ver >= 5.5 || libs.empty?
-    libs = `#{mc} --libs`.chomp
-  end
+  libs = `#{mc} --libs`.chomp if ver >= 5.5 || libs.empty?
   abort unless $CHILD_STATUS.success?
   $INCFLAGS += ' ' + includes
   $libs = libs + " " + $libs
@@ -104,10 +102,8 @@ def asplode(lib)
   -Wno-unused-function
   -Wno-declaration-after-statement
   -Wno-missing-field-initializers
-).select do |flag|
-  try_link('int main() {return 0;}', flag)
-end.each do |flag|
-  $CFLAGS << ' ' << flag
+).each do |flag|
+  $CFLAGS << ' ' << flag if try_link('int main() {return 0;}', flag)
 end
 
 if RUBY_PLATFORM =~ /mswin|mingw/

lib/mysql2.rb

@@ -10,7 +10,7 @@
   dll_path = if ENV['RUBY_MYSQL2_LIBMYSQL_DLL']
     # If this environment variable is set, it overrides any other paths
     # The user is advised to use backslashes not forward slashes
-    ENV['RUBY_MYSQL2_LIBMYSQL_DLL'].dup
+    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__)).gsub('/', '\\')
@@ -53,12 +53,14 @@ module Mysql2
 end
 
 # For holding utility methods
-module Mysql2::Util
-  #
-  # Rekey a string-keyed hash with equivalent symbols.
-  #
-  def self.key_hash_as_symbols(hash)
-    return nil unless hash
-    Hash[hash.map { |k, v| [k.to_sym, v] }]
+module Mysql2
+  module Util
+    #
+    # Rekey a string-keyed hash with equivalent symbols.
+    #
+    def self.key_hash_as_symbols(hash)
+      return nil unless hash
+      Hash[hash.map { |k, v| [k.to_sym, v] }]
+    end
   end
 end

lib/mysql2/client.rb

@@ -1,36 +1,40 @@
 module Mysql2
   class Client
     attr_reader :query_options, :read_timeout
-    @@default_query_options = {
-      :as => :hash,                   # the type of object you want each row back as; also supports :array (an array of values)
-      :async => false,                # don't wait for a result after sending the query, you'll have to monitor the socket yourself then eventually call Mysql2::Client#async_result
-      :cast_booleans => false,        # cast tinyint(1) fields as true/false in ruby
-      :symbolize_keys => false,       # return field names as symbols instead of strings
-      :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
-      :cache_rows => true,            # tells Mysql2 to use it's internal row cache for results
-      :connect_flags => REMEMBER_OPTIONS | LONG_PASSWORD | LONG_FLAG | TRANSACTIONS | PROTOCOL_41 | SECURE_CONNECTION,
-      :cast => true,
-      :default_file => nil,
-      :default_group => nil,
-    }
+
+    def self.default_query_options
+      @default_query_options ||= {
+        :as => :hash,                   # the type of object you want each row back as; also supports :array (an array of values)
+        :async => false,                # don't wait for a result after sending the query, you'll have to monitor the socket yourself then eventually call Mysql2::Client#async_result
+        :cast_booleans => false,        # cast tinyint(1) fields as true/false in ruby
+        :symbolize_keys => false,       # return field names as symbols instead of strings
+        :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
+        :cache_rows => true,            # tells Mysql2 to use it's internal row cache for results
+        :connect_flags => REMEMBER_OPTIONS | LONG_PASSWORD | LONG_FLAG | TRANSACTIONS | PROTOCOL_41 | SECURE_CONNECTION,
+        :cast => true,
+        :default_file => nil,
+        :default_group => nil,
+      }
+    end
 
     def initialize(opts = {})
       opts = Mysql2::Util.key_hash_as_symbols(opts)
       @read_timeout = nil
-      @query_options = @@default_query_options.dup
+      @query_options = self.class.default_query_options.dup
       @query_options.merge! opts
 
       initialize_ext
 
       # Set default connect_timeout to avoid unlimited retries from signal interruption
       opts[:connect_timeout] = 120 unless opts.key?(:connect_timeout)
 
+      # TODO: stricter validation rather than silent massaging
       [:reconnect, :connect_timeout, :local_infile, :read_timeout, :write_timeout, :default_file, :default_group, :secure_auth, :init_command].each do |key|
         next unless opts.key?(key)
         case key
         when :reconnect, :local_infile, :secure_auth
-          send(:"#{key}=", !!opts[key])
+          send(:"#{key}=", !!opts[key]) # rubocop:disable Style/DoubleNegation
         when :connect_timeout, :read_timeout, :write_timeout
           send(:"#{key}=", opts[key].to_i)
         else
@@ -75,10 +79,6 @@ def initialize(opts = {})
       connect user, pass, host, port, database, socket, flags
     end
 
-    def self.default_query_options
-      @@default_query_options
-    end
-
     if Thread.respond_to?(:handle_interrupt)
       require 'timeout'
 
@@ -105,10 +105,12 @@ def info
       self.class.info
     end
 
-    private
+    class << self
+      private
 
-    def self.local_offset
-      ::Time.local(2010).utc_offset.to_r / 86400
+      def local_offset
+        ::Time.local(2010).utc_offset.to_r / 86400
+      end
     end
   end
 end

lib/mysql2/em.rb

@@ -34,9 +34,8 @@ def unbind
       end
 
       def close(*args)
-        if @watch
-          @watch.detach if @watch.watching?
-        end
+        @watch.detach if @watch && @watch.watching?
+
         super(*args)
       end
 

spec/mysql2/client_spec.rb

@@ -574,9 +574,7 @@ def run_gc
 
       it "does not interfere with other statements" do
         @multi_client.query("SELECT 1 AS 'set_1'; SELECT 2 AS 'set_2'")
-        while  @multi_client.next_result
-          @multi_client.store_result
-        end
+        @multi_client.store_result while @multi_client.next_result
 
         expect(@multi_client.query("SELECT 3 AS 'next'").first).to eq('next' => 3)
       end

spec/mysql2/result_spec.rb

@@ -279,10 +279,10 @@
     end
 
     if 1.size == 4 # 32bit
-      unless RUBY_VERSION =~ /1.8/
-        klass = Time
+      klass = if RUBY_VERSION =~ /1.8/
+        DateTime
       else
-        klass = DateTime
+        Time
       end
 
       it "should return DateTime when timestamp is < 1901-12-13 20:45:52" do
@@ -297,27 +297,27 @@
         expect(r.first['test']).to be_an_instance_of(klass)
       end
     elsif 1.size == 8 # 64bit
-      unless RUBY_VERSION =~ /1.8/
-        it "should return Time when timestamp is < 1901-12-13 20:45:52" do
-          r = @client.query("SELECT CAST('1901-12-13 20:45:51' AS DATETIME) as test")
+      if RUBY_VERSION =~ /1.8/
+        it "should return Time when timestamp is > 0138-12-31 11:59:59" do
+          r = @client.query("SELECT CAST('0139-1-1 00:00:00' AS DATETIME) as test")
           expect(r.first['test']).to be_an_instance_of(Time)
         end
 
+        it "should return DateTime when timestamp is < 0139-1-1T00:00:00" do
+          r = @client.query("SELECT CAST('0138-12-31 11:59:59' AS DATETIME) as test")
+          expect(r.first['test']).to be_an_instance_of(DateTime)
+        end
+
         it "should return Time when timestamp is > 2038-01-19T03:14:07" do
           r = @client.query("SELECT CAST('2038-01-19 03:14:08' AS DATETIME) as test")
           expect(r.first['test']).to be_an_instance_of(Time)
         end
       else
-        it "should return Time when timestamp is > 0138-12-31 11:59:59" do
-          r = @client.query("SELECT CAST('0139-1-1 00:00:00' AS DATETIME) as test")
+        it "should return Time when timestamp is < 1901-12-13 20:45:52" do
+          r = @client.query("SELECT CAST('1901-12-13 20:45:51' AS DATETIME) as test")
           expect(r.first['test']).to be_an_instance_of(Time)
         end
 
-        it "should return DateTime when timestamp is < 0139-1-1T00:00:00" do
-          r = @client.query("SELECT CAST('0138-12-31 11:59:59' AS DATETIME) as test")
-          expect(r.first['test']).to be_an_instance_of(DateTime)
-        end
-
         it "should return Time when timestamp is > 2038-01-19T03:14:07" do
           r = @client.query("SELECT CAST('2038-01-19 03:14:08' AS DATETIME) as test")
           expect(r.first['test']).to be_an_instance_of(Time)

spec/mysql2/statement_spec.rb

@@ -366,10 +366,10 @@
     end
 
     if 1.size == 4 # 32bit
-      unless RUBY_VERSION =~ /1.8/
-        klass = Time
+      klass = if RUBY_VERSION =~ /1.8/
+        DateTime
       else
-        klass = DateTime
+        Time
       end
 
       it "should return DateTime when timestamp is < 1901-12-13 20:45:52" do
@@ -384,27 +384,27 @@
         expect(r.first['test']).to be_an_instance_of(klass)
       end
     elsif 1.size == 8 # 64bit
-      unless RUBY_VERSION =~ /1.8/
-        it "should return Time when timestamp is < 1901-12-13 20:45:52" do
-          r = @client.query("SELECT CAST('1901-12-13 20:45:51' AS DATETIME) as test")
+      if RUBY_VERSION =~ /1.8/
+        it "should return Time when timestamp is > 0138-12-31 11:59:59" do
+          r = @client.query("SELECT CAST('0139-1-1 00:00:00' AS DATETIME) as test")
           expect(r.first['test']).to be_an_instance_of(Time)
         end
 
+        it "should return DateTime when timestamp is < 0139-1-1T00:00:00" do
+          r = @client.query("SELECT CAST('0138-12-31 11:59:59' AS DATETIME) as test")
+          expect(r.first['test']).to be_an_instance_of(DateTime)
+        end
+
         it "should return Time when timestamp is > 2038-01-19T03:14:07" do
           r = @client.query("SELECT CAST('2038-01-19 03:14:08' AS DATETIME) as test")
           expect(r.first['test']).to be_an_instance_of(Time)
         end
       else
-        it "should return Time when timestamp is > 0138-12-31 11:59:59" do
-          r = @client.query("SELECT CAST('0139-1-1 00:00:00' AS DATETIME) as test")
+        it "should return Time when timestamp is < 1901-12-13 20:45:52" do
+          r = @client.query("SELECT CAST('1901-12-13 20:45:51' AS DATETIME) as test")
           expect(r.first['test']).to be_an_instance_of(Time)
         end
 
-        it "should return DateTime when timestamp is < 0139-1-1T00:00:00" do
-          r = @client.query("SELECT CAST('0138-12-31 11:59:59' AS DATETIME) as test")
-          expect(r.first['test']).to be_an_instance_of(DateTime)
-        end
-
         it "should return Time when timestamp is > 2038-01-19T03:14:07" do
           r = @client.query("SELECT CAST('2038-01-19 03:14:08' AS DATETIME) as test")
           expect(r.first['test']).to be_an_instance_of(Time)