activerecord-database_comments 0.0.6

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+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.rdoc

@@ -0,0 +1,3 @@
+= CommentableColumn
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,27 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'CommentableColumn'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+

data/lib/active_record/database_comments/adapters/mysql_adapter.rb

@@ -0,0 +1,95 @@
+# encoding: utf-8
+module ActiveRecord
+  module DatabaseComments
+    
+    module Adapters
+    
+      module MysqlColumn
+        
+        extend ActiveSupport::Concern
+        
+        included do
+          attr_reader :comment
+          alias_method_chain :initialize,  :comment
+        end
+        
+        def initialize_with_comment(name, default, sql_type = nil, null = true, collation = nil, comment = nil)
+          initialize_without_comment(name, default, sql_type, null, collation)
+          @comment = comment if comment.present?
+        end
+        
+      end
+    
+      module MysqlAdapter
+        
+        extend ActiveSupport::Concern
+        
+        included do
+          alias_method_chain :add_column_options!,  :comment
+          alias_method_chain :columns,              :comment
+          alias_method_chain :new_column,           :comment
+          # alias_method_chain :create_table,         :mysql_options
+          
+          # Incluir patch a self::Column:
+          "#{self.name}::Column".constantize.send :include, ActiveRecord::DatabaseComments::Adapters::MysqlColumn
+        end
+  
+=begin
+        def create_table_with_mysql_options(table_name, options = {}) #:nodoc:
+          create_table_without_mysql_options(table_name, options.reverse_merge(options: options[:mysql_options] ? options[:mysql_options] : "ENGINE=InnoDB"))
+        end
+=end
+        def new_column_with_comment(field, default, type, null, collation, comment) # :nodoc:
+          "#{self.class.name}::Column".constantize.new(field, default, type, null, collation, comment)
+        end
+        
+        def table_options(table_name)
+          sql = "SHOW TABLE STATUS "
+          sql << "IN #{quote_table_name(current_database)} "
+          sql << "LIKE #{quote(table_name)}"
+          ohmy = execute_and_free(sql, 'SCHEMA') do |result|
+            each_hash(result).map do |field|
+              "ENGINE=#{field[:Engine]} COLLATE=#{field[:Collation]} COMMENT='#{field[:Comment]}'"
+            end
+          end
+          ohmy.first
+        end
+        
+        # Returns an array of +Column+ objects for the table specified by +table_name+.
+        def columns_with_comment(table_name, name = nil)#:nodoc:
+          sql = "SHOW FULL FIELDS FROM #{quote_table_name(table_name)}"
+          execute_and_free(sql, 'SCHEMA') do |result|
+            each_hash(result).map do |field|
+              new_column_with_comment(field[:Field], field[:Default], field[:Type], field[:Null] == "YES", field[:Collation], field[:Comment])
+            end
+          end
+        end
+        
+        protected
+        
+        def add_column_sql_with_unsigned(table_name, column_name, type, options = {})
+          is_unsigned_valid = (((options.has_key? :unsigned) && (options[:unsigned] == true)) && (['integer', 'decimal', 'float', 'boolean'].include? type.to_s))
+          add_column_sql = "ADD #{quote_column_name(column_name)} #{type_to_sql(type, options[:limit], options[:precision], options[:scale], is_unsigned_valid)}"
+          add_column_options!(add_column_sql, options)
+          add_column_position!(add_column_sql, options)
+          add_column_sql
+        end
+        
+        def type_to_sql_with_unsigned(type, limit = nil, precision = nil, scale = nil, unsigned = false)
+          sql = type_to_sql_without_unsigned(type, limit, precision, scale)
+          sql << ' UNSIGNED' if unsigned && (['integer', 'decimal', 'float', 'boolean'].include? type.to_s)
+          sql
+        end
+        
+        def add_column_options_with_comment!(sql, options = {})
+          add_column_options_without_comment!(sql, options)
+          sql << " COMMENT '#{options[:comment]}'" if options[:comment]
+          sql
+        end
+        
+      end
+    
+    end
+    
+  end
+end

data/lib/active_record/database_comments/definitions/column.rb

@@ -0,0 +1,34 @@
+# encoding: utf-8
+module ActiveRecord
+  module DatabaseComments
+    module Definitions
+      
+      module Column
+        
+        extend ActiveSupport::Concern
+    
+        included do
+          attr_accessor :comment
+          alias_method_chain :to_sql, :comments
+        end
+    
+        # Override de #to_sql
+        def to_sql_with_comments
+          
+          column_sql = "#{base.quote_column_name(name)} #{sql_type}"
+          column_options = {}
+          column_options[:null] = null unless null.nil?
+          column_options[:default] = default unless default.nil?
+          
+          # Cambio: column_options[:comment]
+          column_options[:comment] = comment unless comment.nil?
+          
+          add_column_options!(column_sql, column_options) unless type.to_sym == :primary_key
+          column_sql
+        end
+        
+      end
+      
+    end
+  end
+end

data/lib/active_record/database_comments/definitions/table.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+module ActiveRecord
+  module DatabaseComments
+    module Definitions
+  
+      module Table
+        
+        extend ActiveSupport::Concern
+        
+        included do
+          alias_method_chain :column, :comment
+        end
+      
+        def column_with_comment(name, type, options = {})
+          ret_column = column_without_comment(name, type, options)
+          ret_column[name].comment = options[:comment]
+          ret_column
+        end
+        
+      end
+      
+    end
+  end
+end

data/lib/active_record/database_comments/railtie.rb

@@ -0,0 +1,38 @@
+# encoding: utf-8
+module ActiveRecord
+  module DatabaseComments
+    
+    class Railtie < ::Rails::Railtie #:nodoc:
+    
+      initializer 'active_record.extended_support.database_comments' do |app|
+        
+        ActiveSupport.on_load(:active_record) do
+        
+          # Patches para permitir definir columnas con COMMENTS en MySQL:
+          # Agregar el módulo para soportar definiciones de columnas unsigned: 
+          require 'active_record/database_comments/definitions/column'
+          ActiveRecord::ConnectionAdapters::ColumnDefinition.send :include, ActiveRecord::DatabaseComments::Definitions::Column
+          
+          # Agregar el módulo para soportar definiciones de tablas con comentarios en columnas y tabla:
+          require 'active_record/database_comments/definitions/table'
+          ActiveRecord::ConnectionAdapters::TableDefinition.send  :include, ActiveRecord::DatabaseComments::Definitions::Table
+          
+          # Agregar el módulo a los adapters de BD:
+          require 'active_record/database_comments/adapters/mysql_adapter' 
+          [
+            "ActiveRecord::ConnectionAdapters::MysqlAdapter",
+            "ActiveRecord::ConnectionAdapters::Mysql2Adapter",
+            "ActiveRecord::ConnectionAdapters::Mysql2SpatialAdapter", # Adapter para rgeo-mysql
+            "ArJdbc::MySQL"                                           # Adapter para jRuby JDBC
+          ].each do |mysql_adapter_class|
+            adapter_class = mysql_adapter_class.safe_constantize
+            adapter_class.send :include, ActiveRecord::DatabaseComments::Adapters::MysqlAdapter if adapter_class.present?
+          end
+          
+        end
+      end
+      
+    end
+    
+  end
+end

data/lib/activerecord-database_comments.rb

@@ -0,0 +1,2 @@
+# encoding: utf-8
+require 'active_record/database_comments/railtie' if defined?(Rails::Railtie)

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-database_comments
+version: !ruby/object:Gem::Version
+  version: 0.0.6
+  prerelease: 
+platform: ruby
+authors:
+- Roberto Quintanilla
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-08 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.12
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.12
+- !ruby/object:Gem::Dependency
+  name: activerecord-database_schema
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Allows to add column and table comments to ActiveRecord migrations.
+email:
+- roberto.quintanilla@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/active_record/database_comments/adapters/mysql_adapter.rb
+- lib/active_record/database_comments/definitions/column.rb
+- lib/active_record/database_comments/definitions/table.rb
+- lib/active_record/database_comments/railtie.rb
+- lib/activerecord-database_comments.rb
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+homepage: https://github.com/vovimayhem
+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.25
+signing_key: 
+specification_version: 3
+summary: Allows to add column and table comments to ActiveRecord migrations.
+test_files: []