activerecord_column_comment 0.0.2

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 ac
+
+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,62 @@
+# ActiverecordColumnComment
+
+このgemでRails3.2以降のmigrationにおいて、カラムのオプションから `comment` を指定できます。  
+普通カラムコメントは必要ないのですが(migrationファイルにrubyコメントで残せるし)、[mroonga](https://github.com/mroonga/mroonga)を使う場合、[パーサーの指定](http://mroonga.github.com/ja/docs/userguide/storage.html#how-to-specify-the-parser-for-full-text-search)がコメント経由なのでこのgemを作りました。
+
+mysqlでしか実際に動かしてみていません。migrationを使うテストの書き方が分からず書いていません。  
+fork, pull request歓迎です。
+
+This gem will let you add comments on column through options in your migration (rails >= 3.2.0).  
+Although comments on column are usually not necessary (you can always leave comments in your migration files, right?), I created this gem because I had to use [mroonga](https://github.com/mroonga/mroonga) and [specify parser](http://mroonga.github.com/docs/userguide/storage.html#how-to-specify-the-parser-for-full-text-search) on column.
+
+I only ran and saw results on mysql.  Since I didn't know how to write tests using migration, there are no specs/test.  
+forks, pull requests are very welcomed.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'activerecord_column_comment'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activerecord_column_comment
+
+## Usage
+
+
+```ruby
+class CreateExamples < ActiveRecord::Migration
+  def change
+    create_table :examples do |t|
+      t.string :name, comment: "put your comment here"
+      t.timestamps
+    end
+  end
+end
+```
+
+run `rake db:migrate`, open mysql console `rails dbconsole`, then do `show create table examples;` and you will get this
+
+    CREATE TABLE `examples` (
+      `id` int(11) NOT NULL AUTO_INCREMENT,
+      `name` varchar(255) COLLATE utf8_unicode_ci DEFAULT NULL COMMENT 'put your comment here',
+      `created_at` datetime NOT NULL,
+      `updated_at` datetime NOT NULL,
+      PRIMARY KEY (`id`)
+    ) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci 
+
+see more in examples folder
+
+
+## Contributing
+
+1. Fork it
+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_column_comment.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'activerecord_column_comment/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "activerecord_column_comment"
+  gem.version       = ActiverecordColumnComment::VERSION
+  gem.authors       = ["ac"]
+  gem.email         = ["ac@mba.local"]
+  gem.description   = %q{this will add an option to add column comment in sql statement on migration}
+  gem.summary       = %q{activerecord will have commentable columns}
+  gem.homepage      = "https://github.com/github0013/activerecord_column_comment"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'activerecord', '>= 3.2.0'
+end

data/examples/comment_on_change.rb

@@ -0,0 +1,13 @@
+class AddCommentToNameOnExamples < ActiveRecord::Migration
+  def up
+    change_table :examples do |t|
+      t.change :name, :string, comment: "change your comment here"
+    end
+  end
+
+  def down
+    change_table :examples do |t|
+      t.change :name, :string
+    end
+  end
+end

data/examples/comment_on_create.rb

@@ -0,0 +1,9 @@
+class CreateExample < ActiveRecord::Migration
+  def change
+    create_table :examples do |t|
+      t.string :name, :comment => "put your comment here"
+      
+      t.timestamps
+    end
+  end
+end

data/lib/activerecord/connection_adapters/abstract/schema_definitions.rb

@@ -0,0 +1,27 @@
+require "active_record/connection_adapters/abstract/schema_definitions"
+
+module ActiveRecord
+  module ConnectionAdapters
+    class ColumnDefinition
+      attr_accessor :comment
+      
+      def to_sql_with_comment
+        column_sql = to_sql_without_comment
+        return column_sql if comment.nil?
+        
+        "#{column_sql} COMMENT '#{base.quote_string(comment)}'"
+      end
+      alias_method_chain :to_sql, :comment
+    end
+    
+    class TableDefinition
+      def column_with_comment(name, type, options = {})
+        column_without_comment(name, type, options)
+        column = self[name]
+        column.comment = options.fetch(:comment){nil}
+        self
+      end
+      alias_method_chain :column, :comment
+    end
+  end
+end

data/lib/activerecord/connection_adapters/abstract_mysql_adapter.rb

@@ -0,0 +1,16 @@
+require "active_record/connection_adapters/abstract_mysql_adapter"
+  
+module ActiveRecord
+  module ConnectionAdapters
+    class AbstractMysqlAdapter
+      def change_column_sql_with_comment(table_name, column_name, type, options = {})
+        comment = options.fetch(:comment){ nil }
+        change_column_sql = change_column_sql_without_comment(table_name, column_name, type, options = {})
+        return change_column_sql if comment.nil?
+        
+        "#{change_column_sql} COMMENT '#{quote_string(comment)}'"
+      end
+      alias_method_chain :change_column_sql, :comment
+    end
+  end
+end

data/lib/activerecord/connection_adapters/postgresql_adapter.rb

@@ -0,0 +1,18 @@
+require "active_record/connection_adapters/postgresql_adapter"
+
+module ActiveRecord
+  module ConnectionAdapters
+    class PostgreSQLAdapter
+      def change_column_with_comment(table_name, column_name, type, options = {})
+        comment = options.fetch(:comment){ nil }
+        change_column_without_comment(table_name, column_name, type, options = {})
+        change_column_comment(table_name, column_name, comment) unless comment.nil?
+      end
+      alias_method_chain :change_column, :comment
+      
+      def change_column_comment(table_name, column_name, comment)
+        execute "COMMENT ON COLUMN #{quote_table_name(table_name)}.#{quote_column_name(column_name)} IS '#{quote_string(comment)}'"
+      end
+    end
+  end
+end

data/lib/activerecord_column_comment.rb

@@ -0,0 +1,3 @@
+require "activerecord/column_comment/version"
+require "activerecord/connection_adapters/abstract/schema_definitions"
+require "activerecord/connection_adapters/abstract_mysql_adapter"

data/lib/activerecord_column_comment/version.rb

@@ -0,0 +1,3 @@
+module ActiverecordColumnComment
+  VERSION = "0.0.2"
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: activerecord_column_comment
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- ac
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+description: this will add an option to add column comment in sql statement on migration
+email:
+- ac@mba.local
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- activerecord_column_comment.gemspec
+- examples/comment_on_change.rb
+- examples/comment_on_create.rb
+- lib/activerecord/connection_adapters/abstract/schema_definitions.rb
+- lib/activerecord/connection_adapters/abstract_mysql_adapter.rb
+- lib/activerecord/connection_adapters/postgresql_adapter.rb
+- lib/activerecord_column_comment.rb
+- lib/activerecord_column_comment/version.rb
+homepage: https://github.com/github0013/activerecord_column_comment
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: activerecord will have commentable columns
+test_files: []