activerecord-pedantmysql2-adapter 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 37c3b963b0b4bb1c8128ec4b745fce6915796f65
-  data.tar.gz: d26e7b34382ec8108830e5145f5a4376c413a9c4
+  metadata.gz: 3edf754b2a2095a7149077c7307326fb63e58851
+  data.tar.gz: e65305e4b6c3f8fb0c682cc890ee010b88405b93
 SHA512:
-  metadata.gz: a61634eb872f51c607c5dc2f50904fac8057522b88e94809f1094a068e704642b71868ef7d86b5c990b3a39212a4781b19ae34f1bb81daba96a70c7a45c9e800
-  data.tar.gz: 543e8afda7636bc01fdd9a72aeb588365bf9b2cbd68fbd5377fdbb4b45c872fcdf9c9c3d7c6003fcfbeae045850a1080362aae0430466e105805175c8b1b4b8d
+  metadata.gz: 0788ea3fa24672a2b31723dab2fc19cb2b768008515be1d978d19cffa7562d8c988a693770219a64f1380b77a434d22650fda77bb5ec25f3ff9dc0caa1b6f9c2
+  data.tar.gz: b2a18d31f2345eab76fc0f8373a721dd43b81b3c116ca120b9eb52c167330f674babd3d3820875b040fc814bb0f6af096401f4c2effc85a651186b2942406e16

data/README.md

@@ -40,10 +40,14 @@ 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:
 
@@ -59,6 +63,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/lib/active_record/connection_adapters/pedant_mysql2_adapter.rb

@@ -63,7 +63,7 @@ class ActiveRecord::ConnectionAdapters::PedantMysql2Adapter < ActiveRecord::Conn
     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,29 @@ module PedantMysql2
       @whitelist ||= []
     end
 
-  end
+    def ignored?(warning)
+      whitelist.any? { |matcher| matcher =~ warning.message }
+    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
 
-  raise_warnings!
+    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.1.0'
 end

data/spec/adapter_spec.rb

@@ -19,39 +19,56 @@ describe PedantMysql2 do
     PedantMysql2.on_warning = @original_callback
   end
 
+  def execute_with_warning
+    ActiveRecord::Base.connection.execute('SELECT 1 + "foo"')
+  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 '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')
+    result = connection.update('UPDATE comment SET id = 1 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')
+    result = connection.delete('DELETE FROM comment 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 +76,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(Thread.current[:mysql_warnings]).to be == 'abracadabra'
+
+    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
+
+    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 +141,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

@@ -5,6 +5,7 @@ ActiveRecord::Base.configurations = {
     username: 'travis',
     encoding: 'utf8',
     strict: false,
+    pool: 5,
   },
 }
 ActiveRecord::Base.establish_connection(:test)

metadata

@@ -1,14 +1,36 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-pedantmysql2-adapter
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Jean Boussier
 autorequire: 
 bindir: bin
-cert_chain: []
-date: 2014-12-19 00:00:00.000000000 Z
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDcDCCAligAwIBAgIBATANBgkqhkiG9w0BAQUFADA/MQ8wDQYDVQQDDAZhZG1p
+  bnMxFzAVBgoJkiaJk/IsZAEZFgdzaG9waWZ5MRMwEQYKCZImiZPyLGQBGRYDY29t
+  MB4XDTE0MDUxNTIwMzM0OFoXDTE1MDUxNTIwMzM0OFowPzEPMA0GA1UEAwwGYWRt
+  aW5zMRcwFQYKCZImiZPyLGQBGRYHc2hvcGlmeTETMBEGCgmSJomT8ixkARkWA2Nv
+  bTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAL0/81O3e1vh5smcwp2G
+  MpLQ6q0kejQLa65bPYPxdzWA1SYOKyGfw+yR9LdFzsuKpwWzKq6zX35lj1IckWS4
+  bNBEQzxmufUxU0XPM02haFB8fOfDJzdXsWte9Ge4IFwahwn68gpMqN+BvxL+KMYz
+  Iut9YmN44d4LZdsENEIO5vmybuG2vYDz7R56qB0PA+Q2P2CdhymsBad2DQs69FBo
+  uico9V6VMYYctL9lCYdzu9IXrOYNTt88suKIVzzAlHOKeN0Ng5qdztFoTR8sfxDr
+  Ydg3KHl5n47wlpgd8R0f/4b5gGxW+v9pyJCgQnLlRu7DedVSvv7+GMtj3g9r3nhJ
+  KqECAwEAAaN3MHUwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0OBBYEFI/o
+  maf34HXbUOQsdoLHacEKQgunMB0GA1UdEQQWMBSBEmFkbWluc0BzaG9waWZ5LmNv
+  bTAdBgNVHRIEFjAUgRJhZG1pbnNAc2hvcGlmeS5jb20wDQYJKoZIhvcNAQEFBQAD
+  ggEBADkK9aj5T0HPExsov4EoMWFnO+G7RQ28C30VAfKxnL2UxG6i4XMHVs6Xi94h
+  qXFw1ec9Y2eDUqaolT3bviOk9BB197+A8Vz/k7MC6ci2NE+yDDB7HAC8zU6LAx8Y
+  Iqvw7B/PSZ/pz4bUVFlTATif4mi1vO3lidRkdHRtM7UePSn2rUpOi0gtXBP3bLu5
+  YjHJN7wx5cugMEyroKITG5gL0Nxtu21qtOlHX4Hc4KdE2JqzCPOsS4zsZGhgwhPs
+  fl3hbtVFTqbOlwL9vy1fudXcolIE/ZTcxQ+er07ZFZdKCXayR9PPs64heamfn0fp
+  TConQSX2BnZdhIEYW+cKzEC/bLc=
+  -----END CERTIFICATE-----
+date: 2015-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord

metadata.gz.sig

@@ -0,0 +1,2 @@
+��9AB{ż��3�s΂a�\NC�DxHAh�8B������(��b��¢`���V�X�/AvD�3�������??��
+��g�Xl��Ags�?w�֓�*�����uɥX��px`����c6�M�6���ƞ#N��\S֋��x����Û=:l��D����]m����$-�W<����t��.:hoX�JҠlGur�c.�2_������qqD��b���"ЛSV��i�̜
$��W�Cd�O�Y�K�.��M}�Nw�e