activerecord-mysql-comment 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 66410bee5613edcf7002198f103386edd8626c4c
+  data.tar.gz: 4598b131bfc608b50b848237ab98e9ccacd368e4
+SHA512:
+  metadata.gz: 541dc8a54f913d0b4a713da35220cab3ee62bb042b991f23a3c59d34fd63e4c094bf0b7ea820f04f38cf812b0354329218da8f4609c59a924c2c9659131d5317
+  data.tar.gz: 873831e35c5eeb2a8d17ac0734955ae9736dd204c80eb770cff6dada2a96cc9023011c2fa26044a86de5ac2e6faba635a74c028cc73088c062e40c5cb6539d6d

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+debug.log

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1
+  - 2.2
+  - ruby-head
+env:
+  - "AR_VERSION=4.0.13"
+  - "AR_VERSION=4.1.9"
+  - "AR_VERSION=4.2.0"
+before_install:
+  - mysql -e "create database activerecord_unittest;"

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem "activerecord", "~> #{ENV['AR_VERSION']}" if ENV['AR_VERSION']
+
+# Specify your gem's dependencies in activerecord-mysql-comment.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Naoya Murakami
+
+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,75 @@
+# ActiveRecord::Mysql::Comment
+
+[![Build Status](https://travis-ci.org/naoa/activerecord-mysql-comment.png?branch=master)](https://travis-ci.org/naoa/activerecord-mysql-comment)
+
+Adds column comment and index comment to migrations for ActiveRecord MySQL adapters
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activerecord-mysql-comment'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activerecord-mysql-comment
+
+## Usage
+
+```ruby
+bundle exec rails g migration CreatePosts
+```
+
+```ruby
+class CreatePosts < ActiveRecord::Migration
+  def change
+    create_table :posts, options: 'ENGINE=Mroonga COMMENT="default_tokenizer=TokenMecab"' do |t|
+      t.string :title
+      t.text   :content, comment: 'flags "COLUMN_SCALAR|COMPRESS_ZLIB"'
+      t.timestamps
+    end
+    add_index :posts, :content, type: 'fulltext', comment: 'parser "TokenBigram", normalizer "NormalizerAuto"'
+  end
+end
+```
+
+```ruby
+bundle exec rake db:migrate
+```
+
+```ruby
+  create_table "posts", force: :cascade, options: "ENGINE=Mroonga DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci COMMENT='default_tokenizer=TokenMecab'" do |t|
+    t.string   "title",      limit: 255
+    t.text     "content",    limit: 65535, comment: "flags \"COLUMN_SCALAR|COMPRESS_ZLIB\""
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  add_index "posts", ["content"], name: "index_posts_on_content", type: :fulltext, comment: "parser \"TokenBigram\", normalizer \"NormalizerAuto\""
+```
+
+## Note
+
+* Table options need [activerecord-mysql-awesome](https://github.com/kamipo/activerecord-mysql-awesome). If you use ``rake db:reset``, you should install it.
+
+* If you use [activerecord-mysql-awesome](https://github.com/kamipo/activerecord-mysql-awesome), please loading it before load activerecord-mysql-comment.
+
+## Contributing
+
+1. Fork it ( https://github.com/naoa/activerecord-mysql-comment/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 a new Pull Request
+
+## Thanks
+
+* [@kamipo](https://github.com/kamipo)
+
+This library is made by referring to [activerecord-mysql-awesome](https://github.com/kamipo/activerecord-mysql-awesome).

data/Rakefile

@@ -0,0 +1,62 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+require File.expand_path(File.dirname(__FILE__)) + "/test/config"
+require File.expand_path(File.dirname(__FILE__)) + "/test/support/config"
+
+desc 'Run mysql2 tests by default'
+task :default => :test
+
+desc 'Run mysql2 tests'
+task :test => :test_mysql2
+
+desc 'Build MySQL test databases'
+namespace :db do
+  task :create => ['db:mysql:build']
+  task :drop => ['db:mysql:drop']
+end
+
+%w( mysql mysql2 ).each do |adapter|
+  namespace :test do
+    Rake::TestTask.new(adapter => "#{adapter}:env") { |t|
+      t.libs << 'test'
+      t.test_files = Dir.glob( "test/cases/**/*_test.rb" ).sort
+
+      t.warning = true
+      t.verbose = true
+    }
+  end
+
+  namespace adapter do
+    task :test => "test_#{adapter}"
+
+    # Set the connection environment for the adapter
+    task(:env) { ENV['ARCONN'] = adapter }
+  end
+
+  # Make sure the adapter test evaluates the env setting task
+  task "test_#{adapter}" => ["#{adapter}:env", "test:#{adapter}"]
+end
+
+namespace :db do
+  namespace :mysql do
+    desc 'Build the MySQL test databases'
+    task :build do
+      config = ARTest.config['connections']['mysql']
+      %x( mysql --user=#{config['arunit']['username']} --password=#{config['arunit']['password']} -e "create DATABASE #{config['arunit']['database']} DEFAULT CHARACTER SET utf8" )
+    end
+
+    desc 'Drop the MySQL test databases'
+    task :drop do
+      config = ARTest.config['connections']['mysql']
+      %x( mysqladmin --user=#{config['arunit']['username']} --password=#{config['arunit']['password']} -f drop #{config['arunit']['database']} )
+    end
+
+    desc 'Rebuild the MySQL test databases'
+    task :rebuild => [:drop, :build]
+  end
+end
+
+task :build_mysql_databases => 'db:mysql:build'
+task :drop_mysql_databases => 'db:mysql:drop'
+task :rebuild_mysql_databases => 'db:mysql:rebuild'

data/activerecord-mysql-comment.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'activerecord/mysql/comment/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "activerecord-mysql-comment"
+  spec.version       = ActiveRecord::Mysql::Comment::VERSION
+  spec.authors       = ["Naoya Murakami"]
+  spec.email         = ["naoya@createfield.com"]
+  spec.summary       = %q{Adds column comment and index comment to migrations for ActiveRecord MySQL adapters}
+  spec.description   = %q{Adds column comment and index comment to migrations for ActiveRecord MySQL adapters}
+  spec.homepage      = "https://github.com/naoa/activerecord-mysql-comment"
+  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.required_ruby_version = '>= 2.0.0'
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_runtime_dependency "activesupport", "~> 4.0"
+  spec.add_runtime_dependency "activerecord", "~> 4.0"
+  spec.add_runtime_dependency "mysql2"
+end

data/lib/activerecord-mysql-comment.rb

@@ -0,0 +1 @@
+require 'activerecord/mysql/comment'

data/lib/activerecord-mysql-comment/active_record/connection_adapters/abstract/schema_dumper.rb

@@ -0,0 +1,11 @@
+require 'active_record/connection_adapters/abstract/schema_dumper'
+
+module ActiveRecord
+  module ConnectionAdapters # :nodoc:
+    module ColumnDumper
+      def options_for_column_spec(table_name)
+        { table_name: table_name }
+      end
+    end
+  end
+end

data/lib/activerecord-mysql-comment/active_record/connection_adapters/abstract_mysql_adapter.rb

@@ -0,0 +1,100 @@
+require 'active_record/connection_adapters/abstract_mysql_adapter'
+
+module ActiveRecord
+  module Mysql
+    module Comment
+      module SchemaStatements
+        def add_index_options(table_name, column_name, options = {})
+          if options.key?(:comment)
+            comment = options[:comment]
+            options.delete(:comment)
+          end
+
+          index_name, index_type, index_columns, index_options, algorithm, using = super
+
+          if comment.present?
+            if index_options
+              index_options << " COMMENT '#{comment}'"
+            else
+              index_options = " COMMENT '#{comment}'"
+            end
+          end
+
+          [index_name, index_type, index_columns, index_options, algorithm, using]
+        end
+      end
+
+      class ChangeColumnDefinition < Struct.new(:column, :name) #:nodoc:
+      end
+
+      class ColumnDefinition < ActiveRecord::ConnectionAdapters::ColumnDefinition
+        attr_accessor :auto_increment, :unsigned, :charset, :collation, :comment
+      end
+
+      class TableDefinition < ActiveRecord::ConnectionAdapters::TableDefinition
+        def initialize(types, name, temporary, options, as = nil)
+          super(types, name, temporary, options)
+          @as = as
+        end
+
+        def new_column_definition(name, type, options) # :nodoc:
+          column = super
+          column.comment = options[:comment]
+          column
+        end
+
+        private
+        def create_column_definition(name, type)
+          ColumnDefinition.new(name, type)
+        end
+      end
+
+      module SchemaCreation
+
+        private
+        def column_options(o)
+          column_options = super
+          column_options[:comment] = o.comment
+          column_options
+        end
+
+        def add_column_options!(sql, options)
+          if options[:comment]
+            sql << " COMMENT '#{options[:comment]}'"
+          end
+          super
+        end
+      end
+
+      public
+      def prepare_column_options(column, options) # :nodoc:
+        spec = super
+        comment = select_one("SHOW FULL COLUMNS FROM #{options[:table_name]} WHERE Field = '#{column.name}'")["Comment"]
+        if comment.present?
+          spec[:comment] = comment.inspect
+        end
+        spec
+      end
+
+      def migration_keys
+        super | [:comment]
+      end
+
+      private
+      def create_table_definition(name, temporary = false, options = nil, as = nil) # :nodoc:
+        TableDefinition.new(native_database_types, name, temporary, options, as)
+      end
+    end
+  end
+
+  module ConnectionAdapters
+    class AbstractMysqlAdapter < AbstractAdapter
+      prepend Mysql::Comment
+      prepend Mysql::Comment::SchemaStatements
+      
+      class SchemaCreation < AbstractAdapter::SchemaCreation
+        prepend Mysql::Comment::SchemaCreation
+      end
+    end
+  end
+end

data/lib/activerecord-mysql-comment/active_record/schema_dumper.rb

@@ -0,0 +1,49 @@
+require 'active_record/schema_dumper'
+
+module ActiveRecord
+  module Mysql
+    module Comment
+      module SchemaDumper
+        private
+        def table(table, stream)
+          @types = @types.merge(@connection.options_for_column_spec(table))
+          super(table, stream)
+        ensure
+          @types = @connection.native_database_types
+        end
+
+        def indexes(table, stream)
+          buf = StringIO.new
+          super(table, buf)
+          buf = buf.string
+          output = add_index_comment(table, buf)
+          stream.print output
+          stream
+        end
+
+        def add_index_comment(table, buf)
+          output = ""
+          buf.each_line do |line|
+            output << line
+            if matched = line.match(/name: \"(?<name>.*)\", /)
+              index_name = matched[:name]
+            end
+            if index_name.present?
+              comment = @connection.select_one("SHOW INDEX FROM #{table} WHERE Key_name = '#{index_name}';")["Index_comment"]
+              if comment.present?
+                output = output.chop
+                output << ", comment: #{comment.inspect}\n"
+              end
+            end
+          end
+          output
+        end
+
+      end
+    end
+  end
+
+  class SchemaDumper #:nodoc:
+    prepend Mysql::Comment::SchemaDumper
+  end
+end

data/lib/activerecord/mysql/comment.rb

@@ -0,0 +1,15 @@
+require 'active_support'
+
+begin
+  require 'rails'
+rescue LoadError
+  # nothing to do! yay!
+end
+
+if defined? Rails
+  require 'activerecord/mysql/comment/railtie'
+else
+  ActiveSupport.on_load :active_record do
+    require 'activerecord/mysql/comment/base'
+  end
+end

data/lib/activerecord/mysql/comment/base.rb

@@ -0,0 +1,7 @@
+if ActiveRecord::VERSION::MAJOR == 4
+  require 'activerecord-mysql-comment/active_record/schema_dumper'
+  require 'activerecord-mysql-comment/active_record/connection_adapters/abstract/schema_dumper'
+  require 'activerecord-mysql-comment/active_record/connection_adapters/abstract_mysql_adapter'
+else
+  raise "activerecord-mysql-comment supports activerecord ~> 4.x"
+end

data/lib/activerecord/mysql/comment/railtie.rb

@@ -0,0 +1,13 @@
+module ActiveRecord
+  module Mysql
+    module Comment
+      class Railtie < Rails::Railtie
+        initializer 'activerecord-mysql-comment' do
+          ActiveSupport.on_load :active_record do
+            require 'activerecord/mysql/comment/base'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/activerecord/mysql/comment/version.rb

@@ -0,0 +1,7 @@
+module ActiveRecord
+  module Mysql
+    module Comment
+      VERSION = "0.0.1"
+    end
+  end
+end

data/test/.gitignore

@@ -0,0 +1 @@
+/config.yml

data/test/cases/column_comment_test.rb

@@ -0,0 +1,46 @@
+require 'cases/helper'
+require 'support/schema_dumping_helper'
+
+class ColumnCommentTest < ActiveRecord::TestCase
+  include SchemaDumpingHelper
+
+  class ColumnComment < ActiveRecord::Base
+  end
+
+  setup do
+    @connection = ActiveRecord::Base.connection
+    @connection.create_table("column_comments", force: true) do |t|
+      t.string "string_non_comment"
+      t.string "string_comment", comment: 'string_hoge'
+      t.text "text_comment", comment: 'text_hoge'
+    end
+  end
+
+  teardown do
+    @connection.drop_table "column_comments"
+  end
+
+  def test_add_column
+    @connection.add_column 'column_comments', 'title', :string, comment: 'string_hoge'
+    comment = @connection.select_one("SHOW FULL COLUMNS FROM column_comments WHERE Field = 'title'")["Comment"]
+    assert_equal 'string_hoge', comment
+  end
+
+  def test_change_column
+    @connection.add_column 'column_comments', 'description', :string, comment: 'string_comment'
+    @connection.change_column 'column_comments', 'description', :text, comment: 'text_comment'
+
+    comment = @connection.select_one("SHOW FULL COLUMNS FROM column_comments WHERE Field = 'description'")["Comment"]
+
+    if ActiveRecord::VERSION::STRING >= "4.1.0"
+      assert_equal 'text_comment', comment
+    end
+  end
+
+  def test_schema_dump_column_collation
+    schema = dump_table_schema "column_comments"
+    assert_match %r{t.string\s+"string_non_comment"(?:,\s+limit: 255)?$}, schema
+    assert_match %r{t.string\s+"string_comment",(?:\s+limit: 255,)?\s+comment: "string_hoge"$}, schema
+    assert_match %r{t.text\s+"text_comment",(?:\s+limit: 65535,)?\s+comment: "text_hoge"$}, schema
+  end
+end

data/test/cases/helper.rb

@@ -0,0 +1,51 @@
+require 'bundler'
+Bundler.setup
+
+require 'activerecord-mysql-comment'
+require 'config'
+
+require 'active_support/testing/autorun'
+require 'stringio'
+
+require 'active_record'
+require 'cases/test_case'
+require 'active_support/dependencies'
+require 'active_support/logger'
+require 'active_support/core_ext/string/strip'
+
+require 'support/config'
+require 'support/connection'
+
+# TODO: Move all these random hacks into the ARTest namespace and into the support/ dir
+
+Thread.abort_on_exception = true
+
+# Show backtraces for deprecated behavior for quicker cleanup.
+ActiveSupport::Deprecation.debug = true
+
+# Enable raise errors in after_commit and after_rollback.
+ActiveRecord::Base.tap do |klass|
+  klass.raise_in_transactional_callbacks = true if klass.respond_to?(:raise_in_transactional_callbacks=)
+end
+
+# Connect to the database
+ARTest.connect
+
+def current_adapter?(*types)
+  types.any? do |type|
+    ActiveRecord::ConnectionAdapters.const_defined?(type) &&
+      ActiveRecord::Base.connection.is_a?(ActiveRecord::ConnectionAdapters.const_get(type))
+  end
+end
+
+def mysql_56?
+  current_adapter?(:Mysql2Adapter) &&
+    ActiveRecord::Base.connection.send(:version).join(".") >= "5.6.0"
+end
+
+# FIXME: we have tests that depend on run order, we should fix that and
+# remove this method call.
+require 'active_support/test_case'
+ActiveSupport::TestCase.tap do |klass|
+  klass.test_order = :sorted if klass.respond_to?(:test_order=)
+end

data/test/cases/index_comment_test.rb

@@ -0,0 +1,31 @@
+require 'cases/helper'
+require 'support/schema_dumping_helper'
+
+class IndexCommentTest < ActiveRecord::TestCase
+  include SchemaDumpingHelper
+
+  class IndexComment < ActiveRecord::Base
+  end
+
+  setup do
+    @connection = ActiveRecord::Base.connection
+    @connection.create_table("index_comments", force: true) do |t|
+      t.string "string"
+      t.text "text"
+    end
+    @connection.add_index :index_comments, :string, comment: 'no_named_index_comment'
+    @connection.add_index :index_comments, :string, name: 'named_column', comment: 'named_index_comment'
+    @connection.add_index :index_comments, :string, name: 'no_index_comment'
+  end
+
+  teardown do
+    @connection.drop_table "index_comments"
+  end
+
+  def test_schema_dump_index_comment
+    schema = dump_table_schema "index_comments"
+    assert_match %r{add_index\s+"index_comments",\s+\[\"string\"\],\s+name:\s+\"index_index_comments_on_string\",\s+using:\s+:btree,\s+comment:\s+\"no_named_index_comment\"$}, schema
+    assert_match %r{add_index\s+"index_comments",\s+\[\"string\"\],\s+name:\s+\"named_column\",\s+using:\s+:btree,\s+comment:\s+\"named_index_comment\"$}, schema
+    assert_match %r{add_index\s+"index_comments",\s+\[\"string\"\],\s+name:\s+\"no_index_comment\",\s+using:\s+:btree$}, schema
+  end
+end

data/test/cases/test_case.rb

@@ -0,0 +1,123 @@
+require 'active_support/test_case'
+
+module ActiveRecord
+  # = Active Record Test Case
+  #
+  # Defines some test assertions to test against SQL queries.
+  class TestCase < ActiveSupport::TestCase #:nodoc:
+    def teardown
+      SQLCounter.clear_log
+    end
+
+    def assert_date_from_db(expected, actual, message = nil)
+      assert_equal expected.to_s, actual.to_s, message
+    end
+
+    def capture(stream)
+      stream = stream.to_s
+      captured_stream = Tempfile.new(stream)
+      stream_io = eval("$#{stream}")
+      origin_stream = stream_io.dup
+      stream_io.reopen(captured_stream)
+
+      yield
+
+      stream_io.rewind
+      return captured_stream.read
+    ensure
+      captured_stream.close
+      captured_stream.unlink
+      stream_io.reopen(origin_stream)
+    end
+
+    def capture_sql
+      SQLCounter.clear_log
+      yield
+      SQLCounter.log_all.dup
+    end
+
+    def assert_sql(*patterns_to_match)
+      capture_sql { yield }
+    ensure
+      failed_patterns = []
+      patterns_to_match.each do |pattern|
+        failed_patterns << pattern unless SQLCounter.log_all.any?{ |sql| pattern === sql }
+      end
+      assert failed_patterns.empty?, "Query pattern(s) #{failed_patterns.map(&:inspect).join(', ')} not found.#{SQLCounter.log.size == 0 ? '' : "\nQueries:\n#{SQLCounter.log.join("\n")}"}"
+    end
+
+    def assert_queries(num = 1, options = {})
+      ignore_none = options.fetch(:ignore_none) { num == :any }
+      SQLCounter.clear_log
+      x = yield
+      the_log = ignore_none ? SQLCounter.log_all : SQLCounter.log
+      if num == :any
+        assert_operator the_log.size, :>=, 1, "1 or more queries expected, but none were executed."
+      else
+        mesg = "#{the_log.size} instead of #{num} queries were executed.#{the_log.size == 0 ? '' : "\nQueries:\n#{the_log.join("\n")}"}"
+        assert_equal num, the_log.size, mesg
+      end
+      x
+    end
+
+    def assert_no_queries(options = {}, &block)
+      options.reverse_merge! ignore_none: true
+      assert_queries(0, options, &block)
+    end
+
+    def assert_column(model, column_name, msg=nil)
+      assert has_column?(model, column_name), msg
+    end
+
+    def assert_no_column(model, column_name, msg=nil)
+      assert_not has_column?(model, column_name), msg
+    end
+
+    def has_column?(model, column_name)
+      model.reset_column_information
+      model.column_names.include?(column_name.to_s)
+    end
+  end
+
+  class SQLCounter
+    class << self
+      attr_accessor :ignored_sql, :log, :log_all
+      def clear_log; self.log = []; self.log_all = []; end
+    end
+
+    self.clear_log
+
+    self.ignored_sql = [/^PRAGMA/, /^SELECT currval/, /^SELECT CAST/, /^SELECT @@IDENTITY/, /^SELECT @@ROWCOUNT/, /^SAVEPOINT/, /^ROLLBACK TO SAVEPOINT/, /^RELEASE SAVEPOINT/, /^SHOW max_identifier_length/, /^BEGIN/, /^COMMIT/]
+
+    # FIXME: this needs to be refactored so specific database can add their own
+    # ignored SQL, or better yet, use a different notification for the queries
+    # instead examining the SQL content.
+    oracle_ignored     = [/^select .*nextval/i, /^SAVEPOINT/, /^ROLLBACK TO/, /^\s*select .* from all_triggers/im, /^\s*select .* from all_constraints/im, /^\s*select .* from all_tab_cols/im]
+    mysql_ignored      = [/^SHOW TABLES/i, /^SHOW FULL FIELDS/, /^SHOW CREATE TABLE /i, /^SHOW VARIABLES /]
+    postgresql_ignored = [/^\s*select\b.*\bfrom\b.*pg_namespace\b/im, /^\s*select tablename\b.*from pg_tables\b/im, /^\s*select\b.*\battname\b.*\bfrom\b.*\bpg_attribute\b/im, /^SHOW search_path/i]
+    sqlite3_ignored =    [/^\s*SELECT name\b.*\bFROM sqlite_master/im]
+
+    [oracle_ignored, mysql_ignored, postgresql_ignored, sqlite3_ignored].each do |db_ignored_sql|
+      ignored_sql.concat db_ignored_sql
+    end
+
+    attr_reader :ignore
+
+    def initialize(ignore = Regexp.union(self.class.ignored_sql))
+      @ignore = ignore
+    end
+
+    def call(name, start, finish, message_id, values)
+      sql = values[:sql]
+
+      # FIXME: this seems bad. we should probably have a better way to indicate
+      # the query was cached
+      return if 'CACHE' == values[:name]
+
+      self.class.log_all << sql
+      self.class.log << sql unless ignore =~ sql
+    end
+  end
+
+  ActiveSupport::Notifications.subscribe('sql.active_record', SQLCounter.new)
+end

data/test/config.example.yml

@@ -0,0 +1,20 @@
+default_connection: 'mysql2'
+
+connections:
+  mysql:
+    arunit:
+      username: rails
+      encoding: utf8
+      collation: utf8_unicode_ci
+    arunit2:
+      username: rails
+      encoding: utf8
+
+  mysql2:
+    arunit:
+      username: rails
+      encoding: utf8
+      collation: utf8_unicode_ci
+    arunit2:
+      username: rails
+      encoding: utf8

data/test/config.rb

@@ -0,0 +1,5 @@
+TEST_ROOT       = File.expand_path(File.dirname(__FILE__))
+ASSETS_ROOT     = TEST_ROOT + "/assets"
+FIXTURES_ROOT   = TEST_ROOT + "/fixtures"
+MIGRATIONS_ROOT = TEST_ROOT + "/migrations"
+SCHEMA_ROOT     = TEST_ROOT + "/schema"

data/test/support/config.rb

@@ -0,0 +1,43 @@
+require 'yaml'
+require 'erb'
+require 'fileutils'
+require 'pathname'
+
+module ARTest
+  class << self
+    def config
+      @config ||= read_config
+    end
+
+    private
+
+    def config_file
+      Pathname.new(ENV['ARCONFIG'] || TEST_ROOT + '/config.yml')
+    end
+
+    def read_config
+      unless config_file.exist?
+        FileUtils.cp TEST_ROOT + '/config.example.yml', config_file
+      end
+
+      erb = ERB.new(config_file.read)
+      expand_config(YAML.parse(erb.result(binding)).transform)
+    end
+
+    def expand_config(config)
+      config['connections'].each do |adapter, connection|
+        dbs = [['arunit', 'activerecord_unittest'], ['arunit2', 'activerecord_unittest2']]
+        dbs.each do |name, dbname|
+          unless connection[name].is_a?(Hash)
+            connection[name] = { 'database' => connection[name] }
+          end
+
+          connection[name]['database'] ||= dbname
+          connection[name]['adapter']  ||= adapter
+        end
+      end
+
+      config
+    end
+  end
+end

data/test/support/connection.rb

@@ -0,0 +1,18 @@
+require 'active_support/logger'
+
+module ARTest
+  def self.connection_name
+    ENV['ARCONN'] || config['default_connection']
+  end
+
+  def self.connection_config
+    config['connections'][connection_name]
+  end
+
+  def self.connect
+    puts "Using #{connection_name}"
+    ActiveRecord::Base.logger = ActiveSupport::Logger.new("debug.log", 0, 100 * 1024 * 1024)
+    ActiveRecord::Base.configurations = connection_config
+    ActiveRecord::Base.establish_connection :arunit
+  end
+end

data/test/support/connection_helper.rb

@@ -0,0 +1,8 @@
+module ConnectionHelper
+  def run_without_connection
+    original_connection = ActiveRecord::Base.remove_connection
+    yield original_connection
+  ensure
+    ActiveRecord::Base.establish_connection(original_connection)
+  end
+end

data/test/support/schema_dumping_helper.rb

@@ -0,0 +1,20 @@
+module SchemaDumpingHelper
+  def dump_table_schema(table, connection = ActiveRecord::Base.connection)
+    old_ignore_tables = ActiveRecord::SchemaDumper.ignore_tables
+    ActiveRecord::SchemaDumper.ignore_tables = connection.tables - [table]
+    stream = StringIO.new
+    ActiveRecord::SchemaDumper.dump(ActiveRecord::Base.connection, stream)
+    stream.string
+  ensure
+    ActiveRecord::SchemaDumper.ignore_tables = old_ignore_tables
+  end
+
+  def dump_all_table_schema(ignore_tables)
+    old_ignore_tables, ActiveRecord::SchemaDumper.ignore_tables = ActiveRecord::SchemaDumper.ignore_tables, ignore_tables
+    stream = StringIO.new
+    ActiveRecord::SchemaDumper.dump(ActiveRecord::Base.connection, stream)
+    stream.string
+  ensure
+    ActiveRecord::SchemaDumper.ignore_tables = old_ignore_tables
+  end
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-mysql-comment
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Naoya Murakami
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  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'
+description: Adds column comment and index comment to migrations for ActiveRecord
+  MySQL adapters
+email:
+- naoya@createfield.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- activerecord-mysql-comment.gemspec
+- lib/activerecord-mysql-comment.rb
+- lib/activerecord-mysql-comment/active_record/connection_adapters/abstract/schema_dumper.rb
+- lib/activerecord-mysql-comment/active_record/connection_adapters/abstract_mysql_adapter.rb
+- lib/activerecord-mysql-comment/active_record/schema_dumper.rb
+- lib/activerecord/mysql/comment.rb
+- lib/activerecord/mysql/comment/base.rb
+- lib/activerecord/mysql/comment/railtie.rb
+- lib/activerecord/mysql/comment/version.rb
+- test/.gitignore
+- test/cases/column_comment_test.rb
+- test/cases/helper.rb
+- test/cases/index_comment_test.rb
+- test/cases/test_case.rb
+- test/config.example.yml
+- test/config.rb
+- test/support/config.rb
+- test/support/connection.rb
+- test/support/connection_helper.rb
+- test/support/schema_dumping_helper.rb
+homepage: https://github.com/naoa/activerecord-mysql-comment
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Adds column comment and index comment to migrations for ActiveRecord MySQL
+  adapters
+test_files:
+- test/.gitignore
+- test/cases/column_comment_test.rb
+- test/cases/helper.rb
+- test/cases/index_comment_test.rb
+- test/cases/test_case.rb
+- test/config.example.yml
+- test/config.rb
+- test/support/config.rb
+- test/support/connection.rb
+- test/support/connection_helper.rb
+- test/support/schema_dumping_helper.rb