activerecord-pedantmysql2-adapter 1.0.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 37c3b963b0b4bb1c8128ec4b745fce6915796f65
-  data.tar.gz: d26e7b34382ec8108830e5145f5a4376c413a9c4
+SHA256:
+  metadata.gz: 0cdc8bc77345e0ed3428828757da42af2180846edbb81327efbad5a0ab28a48e
+  data.tar.gz: 6e90b36c37754b0accdaac56ff69d125b61262f7d79be7884fa79afd835dc010
 SHA512:
-  metadata.gz: a61634eb872f51c607c5dc2f50904fac8057522b88e94809f1094a068e704642b71868ef7d86b5c990b3a39212a4781b19ae34f1bb81daba96a70c7a45c9e800
-  data.tar.gz: 543e8afda7636bc01fdd9a72aeb588365bf9b2cbd68fbd5377fdbb4b45c872fcdf9c9c3d7c6003fcfbeae045850a1080362aae0430466e105805175c8b1b4b8d
+  metadata.gz: 20edfa621dd97dbd80a2b3a5cc3f31711a85074228a5a848b4bc9c987ace3e5d92ad979995560b220526e572aea9f6c3e586e89825e8386fbab6bb4d68578a72
+  data.tar.gz: 79fa48c21ae537ef22c88692c59ea5eaa6332953bc68f3666134373043b1eeb4d1e1e86160b4a7cb6442a0bf757cd9af206026da145460c9c9058ab75b417ec2

data/.travis.yml

@@ -1,15 +1,24 @@
+services:
+  - mysql
+
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.2
+  - '2.5'
+  - '2.6'
+  - '2.7'
 
 gemfile:
-  - Gemfile.activerecord32
-  - Gemfile.activerecord40
-  - Gemfile.activerecord41
-  - Gemfile.activerecord42
+  - gemfiles/Gemfile.activerecord52
+  - gemfiles/Gemfile.activerecord60
+  - gemfiles/Gemfile.activerecord-edge
+
+matrix:
+  exclude:
+    - rvm: '2.5'
+      gemfile: gemfiles/Gemfile.activerecord-edge
+    - rvm: '2.6'
+      gemfile: gemfiles/Gemfile.activerecord-edge
 
 before_script:
-  - mysql -e 'create database pedant_mysql2_test;'
+  - mysql -u root -h 127.0.0.1 -e 'create database pedant_mysql2_test;'
 
 sudo: false

data/README.md

@@ -26,6 +26,9 @@ Finally in your `database.yml`:
 
     adapter: pedant_mysql2
 
+Or if you're using `DATABASE_URL` or the url key in `database.yml`, you can use the `pedant-mysql2` URL scheme:
+
+    url: pedant-mysql2://host/database
 
 ## Usage
 
@@ -40,12 +43,16 @@ You can report them to your exception tracker:
 or totally silence them:
 
 ```ruby
-  PedantMysql2.on_warning = lambda { |*| }
+  PedantMysql2.silence_warnings!
 ```
 
-Or whatever else behaviour you want (logging).
+and to restore it to raising warnings as errors:
+
+```ruby
+  PedantMysql2.raise_warnings!
+```
 
-You can easilly whitelist some types of warnings:
+You can easily whitelist some types of warnings:
 
 ```ruby
 PedantMysql2.ignore(/Some warning I don't care about/i)
@@ -59,6 +66,15 @@ warnings = PedantMysql2.capture_warnings do
 end
  ```
 
+## Thread-safe
+
+This gem is tested to be thread safe with a couple known exceptions.
+
+`PedantMysql2.ignore` is not thread safe and should only be called during initialization of your app. Changing this within a thread while another is updating it could be problematic.
+`PedantMysql2.on_warning=` is not thread safe, this should also be called only during initialization.
+
+If you find any other parts that are not thread-safe, please create an issue or PR.
+
 ## Development
 
 Setting up the development environment is very straightforward. In order to keep the test

data/activerecord-pedantmysql2-adapter.gemspec

@@ -13,14 +13,18 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/Shopify/activerecord-pedantmysql2-adapter'
   spec.license       = 'MIT'
 
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.required_ruby_version = '>= 2.2.2'
+
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'activerecord', '>= 3.2'
+  spec.add_dependency 'activerecord', '>= 5.0'
   spec.add_dependency 'mysql2', '>= 0.3.12'
-  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec', '>= 3.0'
   spec.add_development_dependency 'rspec-its'

data/gemfiles/Gemfile.activerecord-edge

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+gemspec path: '..'
+
+gem 'activerecord', github: 'rails/rails', branch: 'master'

data/gemfiles/Gemfile.activerecord52

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+gemspec path: '..'
+
+gem 'activerecord', '~> 5.2.0'
+gem 'mysql2'

data/gemfiles/Gemfile.activerecord60

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+gemspec path: '..'
+
+gem 'activerecord', '~> 6.0.0'
+gem 'mysql2'

data/lib/active_record/connection_adapters/pedant_mysql2_adapter.rb

@@ -2,23 +2,44 @@ require 'active_record/connection_adapters/mysql2_adapter'
 
 module ActiveRecord
   module ConnectionHandling
-    def pedant_mysql2_connection(config)
-      config = config.symbolize_keys
-
-      config[:username] = 'root' if config[:username].nil?
-
-      if Mysql2::Client.const_defined? :FOUND_ROWS
-        config[:flags] = Mysql2::Client::FOUND_ROWS
+    if ConnectionAdapters::Mysql2Adapter.respond_to?(:new_client)
+      def pedant_mysql2_connection(config)
+        config = config.symbolize_keys
+        config[:flags] ||= 0
+
+        if config[:flags].kind_of? Array
+          config[:flags].push "FOUND_ROWS"
+        else
+          config[:flags] |= Mysql2::Client::FOUND_ROWS
+        end
+
+        ConnectionAdapters::PedantMysql2Adapter.new(
+          ConnectionAdapters::Mysql2Adapter.new_client(config),
+          logger,
+          nil,
+          config,
+        )
       end
-
-      client = Mysql2::Client.new(config)
-      options = [config[:host], config[:username], config[:password], config[:database], config[:port], config[:socket], 0]
-      ActiveRecord::ConnectionAdapters::PedantMysql2Adapter.new(client, logger, options, config)
-    rescue Mysql2::Error => error
-      if error.message.include?("Unknown database") && defined?(ActiveRecord::NoDatabaseError)
-        raise ActiveRecord::NoDatabaseError.new(error.message)
-      else
-        raise
+    else
+      def pedant_mysql2_connection(config)
+        config = config.symbolize_keys
+
+        config[:username] = 'root' if config[:username].nil?
+
+        if Mysql2::Client.const_defined? :FOUND_ROWS
+          config[:flags] = Mysql2::Client::FOUND_ROWS
+        end
+
+        client = Mysql2::Client.new(config)
+
+        options = [config[:host], config[:username], config[:password], config[:database], config[:port], config[:socket], 0]
+        ActiveRecord::ConnectionAdapters::PedantMysql2Adapter.new(client, logger, options, config)
+      rescue Mysql2::Error => error
+        if error.message.include?("Unknown database") && defined?(ActiveRecord::NoDatabaseError)
+          raise ActiveRecord::NoDatabaseError.new(error.message)
+        else
+          raise
+        end
       end
     end
   end
@@ -37,9 +58,6 @@ class MysqlWarning < StandardError
 end
 
 class ActiveRecord::ConnectionAdapters::PedantMysql2Adapter < ActiveRecord::ConnectionAdapters::Mysql2Adapter
-
-  alias_method :original_execute, :execute
-
   def execute(sql, name = nil)
     value = super
     log_warnings(sql)
@@ -47,10 +65,9 @@ class ActiveRecord::ConnectionAdapters::PedantMysql2Adapter < ActiveRecord::Conn
   end
 
   def exec_delete(sql, name, binds)
-    original_execute to_sql(sql, binds), name
-    affected_rows = @connection.affected_rows
-    log_warnings(sql)
-    affected_rows
+    @affected_rows_before_logging = nil
+    value = super
+    @affected_rows_before_logging || value
   end
 
   alias :exec_update :exec_delete
@@ -60,10 +77,12 @@ class ActiveRecord::ConnectionAdapters::PedantMysql2Adapter < ActiveRecord::Conn
   def log_warnings(sql)
     return unless @connection.warning_count > 0
 
+    @affected_rows_before_logging = @connection.affected_rows
     result = @connection.query('SHOW WARNINGS')
+
     result.each do |level, code, message|
       warning = MysqlWarning.new(message, code, level, sql)
-      ::PedantMysql2.on_warning.call(warning) unless PedantMysql2.ignored?(warning)
+      ::PedantMysql2.warn(warning)
     end
   end
 end

data/lib/pedant_mysql2.rb

@@ -1,34 +1,42 @@
 module PedantMysql2
   class << self
-    attr_accessor :on_warning
-
     def capture_warnings
-      previous_callback = on_warning
-      previous_warnings = Thread.current[:mysql_warnings]
-      Thread.current[:mysql_warnings] = []
-      self.on_warning = lambda { |warning| Thread.current[:mysql_warnings] << warning }
+      warnings = backup_warnings
+      setup_capture
       yield
-      warnings = Thread.current[:mysql_warnings]
-      warnings
+      captured_warnings
     ensure
-      Thread.current[:mysql_warnings] = previous_warnings
-      self.on_warning = previous_callback
+      restore_warnings(warnings)
     end
 
     def raise_warnings!
-      self.on_warning = lambda{ |warning| raise warning }
+      self.on_warning = nil
     end
 
     def silence_warnings!
-      self.on_warning = nil
+      self.on_warning = lambda{ |warning| }
     end
 
     def ignore(*matchers)
       self.whitelist.concat(matchers.flatten)
     end
 
-    def ignored?(warning)
-      on_warning.nil? || whitelist.any? { |matcher| matcher =~ warning.message }
+    def warn(warning)
+      return if ignored?(warning)
+
+      if on_warning
+        on_warning.call(warning)
+      else
+        raise warning
+      end
+    end
+
+    def on_warning
+      Thread.current[:__pedant_mysql2_on_warning] || @_on_warning
+    end
+
+    def on_warning=(new_proc)
+      @_on_warning = new_proc
     end
 
     protected
@@ -37,8 +45,33 @@ module PedantMysql2
       @whitelist ||= []
     end
 
-  end
+    def ignored?(warning)
+      whitelist.any? { |matcher| warning.message.match?(matcher) } || drop_table_warning(warning)
+    end
 
-  raise_warnings!
+    def drop_table_warning(warning)
+      warning.query.match?(/\ADROP TABLE IF EXISTS/) || warning.message.match?(/\AUnknown table/)
+    end
+
+    def setup_capture
+      Thread.current[:__pedant_mysql2_warnings] = []
+      self.thread_on_warning = lambda { |warning| Thread.current[:__pedant_mysql2_warnings] << warning }
+    end
 
+    def captured_warnings
+      Thread.current[:__pedant_mysql2_warnings]
+    end
+
+    def backup_warnings
+      [captured_warnings, Thread.current[:__pedant_mysql2_on_warning]]
+    end
+
+    def restore_warnings(warnings)
+      Thread.current[:__pedant_mysql2_warnings], self.thread_on_warning = *warnings
+    end
+
+    def thread_on_warning=(new_proc)
+      Thread.current[:__pedant_mysql2_on_warning] = new_proc
+    end
+  end
 end

data/lib/pedant_mysql2/version.rb

@@ -1,3 +1,3 @@
 module PedantMysql2
-  VERSION = '1.0.1'
+  VERSION = '1.2.0'
 end

data/spec/adapter_spec.rb

@@ -7,6 +7,7 @@ describe PedantMysql2 do
   before :each do
     PedantMysql2.raise_warnings!
     PedantMysql2.instance_variable_set(:@whitelist, nil)
+    PedantMysql2.ignore(/They will be merged with strict mode in a future release/)
     connection.execute('SET SESSION binlog_format = "STATEMENT"')
     if connection.execute('SHOW TABLES LIKE "comment"').size == 0
       connection.execute('CREATE TABLE comment (id int)')
@@ -19,39 +20,76 @@ describe PedantMysql2 do
     PedantMysql2.on_warning = @original_callback
   end
 
+  def execute_with_warning(query = 'SELECT 1 + "foo"')
+    ActiveRecord::Base.connection.execute(query)
+  end
+
+  def wait_for(thread)
+    sleep 0.1 until thread.stop?
+  end
+
+  # Used by the thread-safe testing
+  def method_missing(method_name,*args)
+    if PedantMysql2.respond_to?(method_name, true)
+      PedantMysql2.send(method_name,*args)
+    else
+      super
+    end
+  end
+
   it 'raises warnings by default' do
     expect {
-      connection.execute('SELECT 1 + "foo"')
+      execute_with_warning
     }.to raise_error(MysqlWarning, "Truncated incorrect DOUBLE value: 'foo'")
   end
 
+  it 'does not raise when warning warns about unexisting table' do
+    expect {
+      execute_with_warning('DROP TABLE IF EXISTS `example_table`')
+    }.to_not raise_error
+  end
+
   it 'can have a whitelist of warnings' do
     PedantMysql2.ignore(/Truncated incorrect DOUBLE value/i)
     expect {
-      connection.execute('SELECT 1 + "foo"')
+      execute_with_warning
     }.to_not raise_error
   end
 
   it 'do not change the returned value' do
     PedantMysql2.silence_warnings!
-    result = connection.execute('SELECT 1 + "foo"')
+    result = execute_with_warning
     expect(result.to_a).to be == [[1.0]]
   end
 
-  it 'do not change the returned value of exec_update' do
-    result = connection.update('UPDATE comment SET id = 1 LIMIT 1')
+  it 'does not change the returned value of exec_update' do
+    connection.execute('INSERT INTO comment VALUES (17)')
+    result = connection.update('UPDATE comment SET id = 1 ORDER BY id LIMIT 1')
+    expect(result).to be == 1
+  end
+
+  it 'does not change the returned value of exec_update when there is warnings' do
+    PedantMysql2.silence_warnings!
+    result = connection.update('UPDATE comment SET id = 1 WHERE id > (42+"foo") ORDER BY id LIMIT 1')
     expect(result).to be_zero
   end
 
-  it 'do not change the returned value of exec_delete' do
-    result = connection.delete('DELETE FROM comment LIMIT 1')
+  it 'does not change the returned value of exec_delete' do
+    connection.execute('INSERT INTO comment VALUES (17)')
+    result = connection.delete('DELETE FROM comment ORDER BY id LIMIT 1')
+    expect(result).to be == 1
+  end
+
+  it 'does not change the returned value of exec_delete when there is warnings' do
+    PedantMysql2.silence_warnings!
+    result = connection.delete('DELETE FROM comment WHERE id > (42+"foo") ORDER BY id LIMIT 1')
     expect(result).to be_zero
   end
 
   it 'can easily be raised' do
     PedantMysql2.on_warning = lambda { |warning| raise warning }
     expect {
-      connection.execute('SELECT 1 + "foo"')
+      execute_with_warning
     }.to raise_error(MysqlWarning)
   end
 
@@ -59,22 +97,64 @@ describe PedantMysql2 do
     warnings = nil
     expect {
       warnings = PedantMysql2.capture_warnings do
-        connection.execute('SELECT 1 + "foo"')
+        execute_with_warning
       end
     }.to_not raise_error
-    
+
     expect(warnings.size).to be == 1
     expect(warnings.first).to be_a MysqlWarning
     expect(warnings.first.message).to be == "Truncated incorrect DOUBLE value: 'foo'"
   end
 
   it 'restores the old value that was stored in the thread_local capture_warnings' do
-    Thread.current[:mysql_warnings] = 'abracadabra'
-    PedantMysql2.capture_warnings do
-      expect(Thread.current[:mysql_warnings]).to be_an Array
-      connection.execute('SELECT 1 + "foo"')
+    warnings1 = nil
+    warnings2 = nil
+
+    warnings1 = PedantMysql2.capture_warnings do
+      execute_with_warning
+      warnings2 = PedantMysql2.capture_warnings do
+        execute_with_warning
+        execute_with_warning
+      end
+    end
+
+    expect(warnings1.size).to be == 1
+    expect(warnings2.size).to be == 2
+    expect(warnings2).to_not include(warnings1)
+  end
+
+  it 'should be thread-safe to capture_warnings (when class instance variables were used this did not pass)' do
+    thread = Thread.new do
+      warnings = backup_warnings
+      Thread.stop
+      setup_capture
+      Thread.stop
+      execute_with_warning
+      expect(captured_warnings.size).to be == 1
+      restore_warnings(warnings)
     end
-    expect(Thread.current[:mysql_warnings]).to be == 'abracadabra'
+
+    wait_for(thread)
+    warnings = backup_warnings
+    thread.run
+    wait_for(thread)
+    setup_capture
+    execute_with_warning
+    expect(captured_warnings.size).to be == 1
+    restore_warnings(warnings)
+    thread.run
+    thread.join
+  end
+
+  it 'should inherit on_warning from parent thread' do
+    PedantMysql2.silence_warnings!
+    thread = Thread.new do
+      expect {
+        execute_with_warning
+      }.to_not raise_error
+    end
+
+    thread.join
   end
 
   describe MysqlWarning do
@@ -82,7 +162,7 @@ describe PedantMysql2 do
     subject do
       begin
         PedantMysql2.on_warning = lambda { |warning| raise warning }
-        connection.execute('SELECT 1 + "foo"')
+        execute_with_warning
       rescue MysqlWarning => exception
         exception
       end

data/spec/support/database.rb

@@ -1,10 +1,9 @@
-ActiveRecord::Base.configurations = {
-  'test' => {
-    adapter: 'pedant_mysql2',
-    database: 'pedant_mysql2_test',
-    username: 'travis',
-    encoding: 'utf8',
-    strict: false,
-  },
-}
-ActiveRecord::Base.establish_connection(:test)
+ActiveRecord::Base.establish_connection(
+  'adapter' => 'pedant_mysql2',
+  'database' => 'pedant_mysql2_test',
+  'username' => 'root',
+  'encoding' => 'utf8',
+  'host' => 'localhost',
+  'strict' => false,
+  'pool' => 5,
+)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-pedantmysql2-adapter
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Jean Boussier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-19 00:00:00.000000000 Z
+date: 2020-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: mysql2
   requirement: !ruby/object:Gem::Requirement
@@ -42,16 +42,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -120,19 +120,17 @@ files:
 - ".rspec"
 - ".travis.yml"
 - Gemfile
-- Gemfile.activerecord32
-- Gemfile.activerecord40
-- Gemfile.activerecord41
-- Gemfile.activerecord42
 - LICENSE.txt
 - README.md
 - Rakefile
 - activerecord-pedantmysql2-adapter.gemspec
+- gemfiles/Gemfile.activerecord-edge
+- gemfiles/Gemfile.activerecord52
+- gemfiles/Gemfile.activerecord60
 - lib/active_record/connection_adapters/pedant_mysql2_adapter.rb
 - lib/activerecord-pedantmysql2-adapter.rb
 - lib/pedant_mysql2.rb
 - lib/pedant_mysql2/version.rb
-- shipit.rubygems.yml
 - spec/adapter_spec.rb
 - spec/connection_spec.rb
 - spec/spec_helper.rb
@@ -140,7 +138,8 @@ files:
 homepage: https://github.com/Shopify/activerecord-pedantmysql2-adapter
 licenses:
 - MIT
-metadata: {}
+metadata:
+  allowed_push_host: https://rubygems.org
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -149,15 +148,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.2.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: ActiveRecord adapter for MySQL that report warnings.

data/Gemfile.activerecord32

@@ -1,4 +0,0 @@
-source 'https://rubygems.org'
-gemspec
-
-gem 'activerecord', '~> 3.2.0'

data/Gemfile.activerecord40

@@ -1,4 +0,0 @@
-source 'https://rubygems.org'
-gemspec
-
-gem 'activerecord', '~> 4.0.0'

data/Gemfile.activerecord41

@@ -1,4 +0,0 @@
-source 'https://rubygems.org'
-gemspec
-
-gem 'activerecord', '~> 4.1.0'

data/Gemfile.activerecord42

@@ -1,4 +0,0 @@
-source 'https://rubygems.org'
-gemspec
-
-gem 'activerecord', '~> 4.2.0.rc1'

data/shipit.rubygems.yml

@@ -1,2 +0,0 @@
-fetch:
-  - fetch-gem-version activerecord-pedantmysql2-adapter Shopify/activerecord-pedantmysql2-adapter