activerecord-pedantmysql2-adapter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f3c87e06b817d9fe4abede31aef58d34fbbbbe1a
+  data.tar.gz: f1779845a2be79bc7e6f6f53ef4239250124553a
+SHA512:
+  metadata.gz: ef20bc6859df95afd6f07f6895ab43ce2c30ed13219aa733d94291054b50dd13d6fd08d73c7f9dfb7a86f8c2a837320638fc506a5b0088e3419497806a141829
+  data.tar.gz: 25b911c43b7cfe34659a8653ca30c1df72c7695140d9cf3f51a4842dc29e31d473c62d7c60ac4505863034c0bc4b2b9035a34be64a867d210487be2175a5de6b

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in activerecord-pedantmysql2-adapter.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jean Boussier
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,58 @@
+# Activerecord::PedantMysql2
+
+ActiveRecord adapter for MySQL that report warnings.
+
+The main usage is to progressively identify and fix MySQL warnings generated by legacy rails applications, and ultimately enable strict mode. 
+
+Alternatively it can be used to treat all MySQL warnings as errors.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'activerecord-pedantmysql2-adapter'
+
+And then execute:
+
+    $ bundle
+
+Finally in your `database.yml`:
+
+    adapter: pedant_mysql2
+
+
+## Usage
+
+By default it do nothing with the warnings, you have to define the behaviour yourself in an initializer.
+
+You can either raise on all errors:
+
+```ruby
+  PedantMysql2.on_warning = lambda { |warning| raise warning }
+```
+
+Or report them to your exception tracker:
+
+```ruby
+  PedantMysql2.on_warning = lambda { |warning| Airbrake.notify(warning) }
+```
+
+Or whatever else behaviour you want (logging).
+
+You can easilly whitelist some types of warnings:
+
+```ruby
+
+PedantMysql2.on_warning = lambda do |warning|
+  raise warning unless WARNINGS_WHITELIST.any? { |pattern| pattern =~ warning.message }
+end
+
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/activerecord-pedantmysql2-adapter/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/activerecord-pedantmysql2-adapter.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pedant_mysql2/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'activerecord-pedantmysql2-adapter'
+  spec.version       = PedantMysql2::VERSION
+  spec.authors       = ['Jean Boussier']
+  spec.email         = ['jean.boussier@gmail.com']
+  spec.summary       = %q{ActiveRecord adapter for MySQL that report warnings.}
+  spec.description   = %q{Gives a hook on MySQL warnings that allow you to either raise or log them.}
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  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'
+  spec.add_dependency 'mysql2', '>= 0.3.11'
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake'
+end

data/lib/active_record/connection_adapters/pedant_mysql2_adapter.rb

@@ -0,0 +1,60 @@
+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
+      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, error)
+      else
+        raise
+      end
+    end
+  end
+end
+
+class MysqlWarning < StandardError
+
+  attr_reader :code, :level, :query
+
+  def initialize(message, code, level, query)
+    super(message)
+    @code = code
+    @level = level
+    @query = query
+  end
+
+end
+
+class ActiveRecord::ConnectionAdapters::PedantMysql2Adapter < ActiveRecord::ConnectionAdapters::Mysql2Adapter
+
+  def execute(sql, name = nil)
+    value = super
+    log_warnings(sql)
+    value
+  end
+
+  private
+
+  def log_warnings(sql)
+    return unless @connection.warning_count > 0
+
+    result = @connection.query('SHOW WARNINGS')
+    result.each do |level, code, message|
+      warning = MysqlWarning.new(message, code, level, sql)
+      ::PedantMysql2.on_warning.call(warning)
+    end
+  end
+
+end

data/lib/activerecord-pedantmysql2-adapter.rb

@@ -0,0 +1,4 @@
+require 'active_record'
+require 'pedant_mysql2'
+require 'pedant_mysql2/version'
+require 'active_record/connection_adapters/pedant_mysql2_adapter'

data/lib/pedant_mysql2.rb

@@ -0,0 +1,6 @@
+module PedantMysql2
+  class << self
+    attr_accessor :on_warning
+  end
+  self.on_warning = lambda{ |*| }
+end

data/lib/pedant_mysql2/version.rb

@@ -0,0 +1,3 @@
+module PedantMysql2
+  VERSION = "0.0.1"
+end

data/spec/adapter_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe PedantMysql2 do
+
+  let(:connection) { ActiveRecord::Base.connection }
+
+  before :each do
+    @original_callback = PedantMysql2.on_warning
+  end
+
+  after :each do
+    PedantMysql2.on_warning = @original_callback
+  end
+
+  it 'just do nothing by default' do
+    expect {
+      connection.execute('SELECT 1 + "foo"')
+    }.to_not raise_error
+  end
+
+  it 'do not change the returned value' do
+    result = connection.execute('SELECT 1 + "foo"')
+    expect(result.to_a).to be == [[1.0]]
+  end
+
+  it 'can easily be raised' do
+    PedantMysql2.on_warning = lambda { |warning| raise warning }
+    expect {
+      connection.execute('SELECT 1 + "foo"')
+    }.to raise_error(MysqlWarning)
+  end
+
+  describe MysqlWarning do
+
+    subject do
+      begin
+        PedantMysql2.on_warning = lambda { |warning| raise warning }
+        connection.execute('SELECT 1 + "foo"')
+      rescue MysqlWarning => exception
+        exception
+      end
+    end
+
+    its(:message) { should be == "Truncated incorrect DOUBLE value: 'foo'" }
+
+    its(:code) { should be == 1292 }
+
+    its(:level) { should be == 'Warning' }
+
+    its(:query) { should be == 'SELECT 1 + "foo"' }
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'activerecord-pedantmysql2-adapter'
+
+Dir[File.expand_path(File.join(File.dirname(__FILE__), 'support', '**', '*.rb'))].each { |f| require f }
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = 'random'
+end

data/spec/support/database.rb

@@ -0,0 +1,12 @@
+ActiveRecord::Base.configurations = {
+  'test' => {
+    adapter: 'pedant_mysql2',
+    database: 'pedant_mysql2_test',
+    username: nil,
+    port: '13306',
+    host: '127.0.0.1',
+    encoding: 'utf8',
+    strict: false,
+  },
+}
+ActiveRecord::Base.establish_connection(:test)

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-pedantmysql2-adapter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jean Boussier
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.11
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.11
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Gives a hook on MySQL warnings that allow you to either raise or log
+  them.
+email:
+- jean.boussier@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- activerecord-pedantmysql2-adapter.gemspec
+- lib/active_record/connection_adapters/pedant_mysql2_adapter.rb
+- lib/activerecord-pedantmysql2-adapter.rb
+- lib/pedant_mysql2.rb
+- lib/pedant_mysql2/version.rb
+- spec/adapter_spec.rb
+- spec/spec_helper.rb
+- spec/support/database.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: ActiveRecord adapter for MySQL that report warnings.
+test_files:
+- spec/adapter_spec.rb
+- spec/spec_helper.rb
+- spec/support/database.rb