migration_comments 0.1.3 → 0.2.0

data/lib/migration_comments/active_record/connection_adapters/table.rb

@@ -1,12 +1,12 @@
-module MigrationComments::ActiveRecord::ConnectionAdapters
-  module Table
-    def change_comment(column_name, comment_text)
-      @base.set_column_comment(@table_name, column_name, comment_text)
-    end
-
-    def change_table_comment(comment_text)
-      @base.set_table_comment(@table_name, comment_text)
-    end
-    alias comment :change_table_comment
-  end
+module MigrationComments::ActiveRecord::ConnectionAdapters
+  module Table
+    def change_comment(column_name, comment_text)
+      @base.set_column_comment(@table_name, column_name, comment_text)
+    end
+
+    def change_table_comment(comment_text)
+      @base.set_table_comment(@table_name, comment_text)
+    end
+    alias comment :change_table_comment
+  end
 end

data/lib/migration_comments/active_record/connection_adapters/table_definition.rb

@@ -1,30 +1,32 @@
-module MigrationComments::ActiveRecord::ConnectionAdapters
-  module TableDefinition
-
-    attr_accessor :table_comment
-    def self.included(base)
-      base.class_eval do
-        alias_method_chain :column, :migration_comments
-      end
-    end
-
-    def comment(text)
-      @table_comment = CommentDefinition.new(@base, nil, nil, text)
-      self
-    end
-
-    def column_with_migration_comments(name, type, options = {})
-      column_without_migration_comments(name, type, options)
-      col = self[name]
-      col.comment = CommentDefinition.new(@base, nil, name, options[:comment])
-      self
-    end
-
-    def collect_comments(table_name)
-      comments = []
-      comments << @table_comment << @columns.map(&:comment)
-      comments.flatten!.compact!
-      comments.each{|comment| comment.table = table_name}
-    end
-  end
+module MigrationComments::ActiveRecord::ConnectionAdapters
+  module TableDefinition
+
+    attr_accessor :table_comment
+    def self.included(base)
+      base.class_eval do
+        alias_method_chain :column, :migration_comments
+      end
+    end
+
+    def comment(text)
+      @table_comment = CommentDefinition.new(@base, nil, nil, text)
+      self
+    end
+
+    def column_with_migration_comments(name, type, options = {})
+      column_without_migration_comments(name, type, options)
+      if options.has_key?(:comment)
+        col = self[name]
+        col.comment = CommentDefinition.new(@base, nil, name, options[:comment])
+      end
+      self
+    end
+
+    def collect_comments(table_name)
+      comments = []
+      comments << @table_comment << @columns.map(&:comment)
+      comments.flatten!.compact!
+      comments.each{|comment| comment.table = table_name}
+    end
+  end
 end

data/lib/migration_comments/active_record/schema_dumper.rb

@@ -1,54 +1,54 @@
-module MigrationComments::ActiveRecord
-  module SchemaDumper
-    def self.included(base)
-      base.class_eval do
-        alias_method_chain :table, :migration_comments
-      end
-    end
-
-    def table_with_migration_comments(table, stream)
-      tbl_stream = StringIO.new
-      table_without_migration_comments(table, tbl_stream)
-      tbl_stream.rewind
-      commented_stream = append_comments(table, tbl_stream)
-      tbl_stream.close
-      stream.print commented_stream.read
-    end
-
-    def append_comments(table, stream)
-      table_name = table.inspect.gsub('"', '')
-      table_comment = @connection.retrieve_table_comment(table_name)
-      column_comments = @connection.retrieve_column_comments(table_name)
-      comment_stream = StringIO.new
-      lines = []
-      table_line = 0
-      col_names = {}
-      while (line = stream.gets)
-        content = line.chomp
-        if content =~ /create_table\s/
-          table_line = lines.size
-        elsif content =~ /t\.\w+\s+"(\w+)"/
-          col_names[lines.size] = $1.to_sym
-        end
-        lines << content
-      end
-      len = col_names.keys.map{|index| lines[index]}.map(&:length).max + 2
-      lines.each_with_index do |line, index|
-        if table_line == index && table_comment.present?
-          block_init = " do |t|"
-          line.chomp!(block_init) << ", " << render_comment(table_comment) << block_init
-        elsif col_names[index]
-          comment = column_comments[col_names[index]]
-          line << ',' << ' ' * (len - line.length) << render_comment(comment) unless comment.blank?
-        end
-        comment_stream.puts line
-      end
-      comment_stream.rewind
-      comment_stream
-    end
-
-    def render_comment(comment)
-      ":comment => \"#{comment}\""
-    end
-  end
+module MigrationComments::ActiveRecord
+  module SchemaDumper
+    def self.included(base)
+      base.class_eval do
+        alias_method_chain :table, :migration_comments
+      end
+    end
+
+    def table_with_migration_comments(table, stream)
+      tbl_stream = StringIO.new
+      table_without_migration_comments(table, tbl_stream)
+      tbl_stream.rewind
+      commented_stream = append_comments(table, tbl_stream)
+      tbl_stream.close
+      stream.print commented_stream.read
+    end
+
+    def append_comments(table, stream)
+      table_name = table.inspect.gsub('"', '')
+      table_comment = @connection.retrieve_table_comment(table_name)
+      column_comments = @connection.retrieve_column_comments(table_name)
+      comment_stream = StringIO.new
+      lines = []
+      table_line = 0
+      col_names = {}
+      while (line = stream.gets)
+        content = line.chomp
+        if content =~ /create_table\s/
+          table_line = lines.size
+        elsif content =~ /t\.\w+\s+"(\w+)"/
+          col_names[lines.size] = $1.to_sym
+        end
+        lines << content
+      end
+      len = col_names.keys.map{|index| lines[index]}.map(&:length).max + 2
+      lines.each_with_index do |line, index|
+        if table_line == index && table_comment.present?
+          block_init = " do |t|"
+          line.chomp!(block_init) << ", " << render_comment(table_comment) << block_init
+        elsif col_names[index]
+          comment = column_comments[col_names[index]]
+          line << ',' << ' ' * (len - line.length) << render_comment(comment) unless comment.blank?
+        end
+        comment_stream.puts line
+      end
+      comment_stream.rewind
+      comment_stream
+    end
+
+    def render_comment(comment)
+      ":comment => \"#{comment}\""
+    end
+  end
 end

data/lib/migration_comments/annotate_models.rb

@@ -1,40 +1,40 @@
-module MigrationComments
-  module AnnotateModels
-    def self.included(base)
-      base.class_eval do
-        class << self
-          include ClassMethods
-          alias_method_chain :get_schema_info, :migration_comments
-        end
-      end
-    end
-
-    module ClassMethods
-      def get_schema_info_with_migration_comments(*args)
-        info = get_schema_info_without_migration_comments(*args)
-        klass = args[0]
-        commented_info(klass, info)
-      end
-
-      def commented_info(klass, info)
-        table_name = klass.table_name
-        adapter = klass.connection
-        table_comment = adapter.retrieve_table_comment(table_name)
-        column_comments = adapter.retrieve_column_comments(table_name)
-        lines = []
-        info.each_line{|l| lines << l.chomp}
-        column_regex = /^#\s+(\w+)\s+:\w+/
-        len = lines.select{|l| l =~ column_regex}.map{|l| l.length}.max
-        lines.each do |line|
-          if line =~ /# Table name: |# table \+\w+\+ /
-            line << " # #{table_comment}" if table_comment
-          elsif line =~ column_regex
-            comment = column_comments[$1.to_sym]
-            line << " " * (len - line.length) << " # #{comment}" if comment
-          end
-        end
-        lines.join($/) + $/
-      end
-    end
-  end
+module MigrationComments
+  module AnnotateModels
+    def self.included(base)
+      base.class_eval do
+        class << self
+          include ClassMethods
+          alias_method_chain :get_schema_info, :migration_comments
+        end
+      end
+    end
+
+    module ClassMethods
+      def get_schema_info_with_migration_comments(*args)
+        info = get_schema_info_without_migration_comments(*args)
+        klass = args[0]
+        commented_info(klass, info)
+      end
+
+      def commented_info(klass, info)
+        table_name = klass.table_name
+        adapter = klass.connection
+        table_comment = adapter.retrieve_table_comment(table_name)
+        column_comments = adapter.retrieve_column_comments(table_name)
+        lines = []
+        info.each_line{|l| lines << l.chomp}
+        column_regex = /^#\s+(\w+)\s+:\w+/
+        len = lines.select{|l| l =~ column_regex}.map{|l| l.length}.max
+        lines.each do |line|
+          if line =~ /# Table name: |# table \+\w+\+ /
+            line << " # #{table_comment}" if table_comment
+          elsif line =~ column_regex
+            comment = column_comments[$1.to_sym]
+            line << " " * (len - line.length) << " # #{comment}" if comment
+          end
+        end
+        lines.join($/) + $/
+      end
+    end
+  end
 end

data/lib/migration_comments/version.rb

@@ -1,3 +1,3 @@
-module MigrationComments
-  VERSION = "0.1.3"
-end
+module MigrationComments
+  VERSION = "0.2.0"
+end

data/migration_comments.gemspec

@@ -1,34 +1,34 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "migration_comments/version"
-
-Gem::Specification.new do |s|
-  s.name        = "migration_comments"
-  s.version     = MigrationComments::VERSION
-  s.authors     = ["Pinny"]
-  s.email       = ["pinny@medwiztech.com"]
-  s.homepage    = "https://github.com/pinnymz/migration_comments"
-  s.summary     = %q{Comments for your migrations}
-  s.description = %q{Add schema comments in your migrations, see them in model annotations and db/schema.rb dump}
-
-  s.rubyforge_project = "migration_comments"
-
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
-
-  s.add_runtime_dependency 'rails', '>= 2.3.2'
-
-  # for development, we are testing against the 'annotate' gem
-  # however, the comments should work with the original 'annotate_models' plugin as well at:
-  #  http://repo.pragprog.com/svn/Public/plugins/annotate_models
-  # provided the environment is not loaded until _after_ the AnnotateModels module is declared
-  s.add_development_dependency 'annotate'
-
-  s.add_development_dependency 'pg' # replace with other adapter as needed
-  # s.add_development_dependency 'postgres-pr'
-  # s.add_development_dependency 'mysql'
-  # s.add_development_dependency 'mysql2'
-  # s.add_development_dependency 'sqlite3'
-end
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "migration_comments/version"
+
+Gem::Specification.new do |s|
+  s.name        = "migration_comments"
+  s.version     = MigrationComments::VERSION
+  s.authors     = ["Pinny"]
+  s.email       = ["pinny@medwiztech.com"]
+  s.homepage    = "https://github.com/pinnymz/migration_comments"
+  s.summary     = %q{Comments for your migrations}
+  s.description = %q{Add schema comments in your migrations, see them in model annotations and db/schema.rb dump}
+
+  s.rubyforge_project = "migration_comments"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency 'rails', '>= 2.3.2'
+
+  # for development, we are testing against the 'annotate' gem
+  # however, the comments should work with the original 'annotate_models' plugin as well at:
+  #  http://repo.pragprog.com/svn/Public/plugins/annotate_models
+  # provided the environment is not loaded until _after_ the AnnotateModels module is declared
+  s.add_development_dependency 'annotate', '~> 2.5.0'
+
+  s.add_development_dependency 'pg' # replace with other adapter as needed
+  # s.add_development_dependency 'postgres-pr'
+  # s.add_development_dependency 'mysql'
+  # s.add_development_dependency 'mysql2'
+  # s.add_development_dependency 'sqlite3'
+end

data/test/add_comments_test.rb

@@ -1,135 +1,135 @@
-require 'test_helper'
-
-class AddCommentsTest < Test::Unit::TestCase
-  include TestHelper
-
-  def test_adding_a_table_comment
-    comment_text = "a comment on the sample table"
-    result = nil
-    ActiveRecord::Schema.define do
-      set_table_comment :sample, comment_text
-      result = retrieve_table_comment :sample
-    end
-    assert_equal comment_text, result
-  end
-
-  def test_adding_a_column_comment
-    comment_text = "a comment on the sample table in the column field"
-    result_field1 = nil
-    result_field2 = nil
-    ActiveRecord::Schema.define do
-      set_column_comment :sample, :field1, comment_text
-      result_field1 = retrieve_column_comment :sample, :field1
-      result_field2 = retrieve_column_comment :sample, :field2
-    end
-    assert_equal comment_text, result_field1
-    assert_nil result_field2
-  end
-
-  def test_creating_a_table_with_table_and_column_comments
-    table_comment = "a table comment"
-    column_comment = "a column comment"
-    result_table_comment = nil
-    result_column_comments = nil
-    ActiveRecord::Schema.define do
-      begin
-        create_table :sample2, :comment => table_comment do |t|
-          t.integer :field1, :comment => column_comment
-          t.string :field2
-        end
-        result_table_comment = retrieve_table_comment :sample2
-        result_column_comments = retrieve_column_comments :sample2
-      ensure
-        drop_table :sample2
-      end
-    end
-    assert_equal table_comment, result_table_comment
-    assert_equal column_comment, result_column_comments[:field1]
-    assert_nil result_column_comments[:field2]
-  end
-
-  def test_changing_a_table_with_new_comments
-    table_comment = "a table comment"
-    column_comment1 = "a column comment"
-    column_comment2 = "another column comment"
-    result_table_comment = nil
-    result_column_comments = nil
-    ActiveRecord::Schema.define do
-      change_table :sample do |t|
-        t.comment table_comment
-        t.change :field1, :string, :comment => column_comment1
-        t.change :field2, :integer
-        t.boolean :field3, :comment => column_comment2
-      end
-      result_table_comment = retrieve_table_comment :sample
-      result_column_comments = retrieve_column_comments :sample
-    end
-    assert_equal table_comment, result_table_comment
-    assert_equal column_comment1, result_column_comments[:field1]
-    assert_equal column_comment2, result_column_comments[:field3]
-    assert_nil result_column_comments[:field2]
-  end
-
-  def test_partially_modifying_comments_from_a_table
-    table_comment = "a table comment"
-    column_comment1 = "a column comment"
-    column_comment2 = "another column comment"
-    column_comment3 = "yet a third column comment"
-    modified_comment = "modified comment"
-    result_table_comment = nil
-    result_column_comments = nil
-    ActiveRecord::Schema.define do
-      change_table :sample do |t|
-        t.comment table_comment
-        t.change :field1, :string, :comment => column_comment1
-        t.change :field2, :integer, :comment => column_comment2
-        t.boolean :field3, :comment => column_comment3
-      end
-      change_table :sample do |t|
-        t.comment nil
-        t.change :field1, :string
-        t.change :field2, :integer, :comment => modified_comment
-        t.change :field3, :boolean, :comment => nil
-      end
-      result_table_comment = retrieve_table_comment :sample
-      result_column_comments = retrieve_column_comments :sample
-    end
-    assert_nil result_table_comment
-    assert_equal column_comment1, result_column_comments[:field1]
-    assert_equal modified_comment, result_column_comments[:field2]
-    assert_nil result_column_comments[:field3]
-  end
-
-  def test_removing_comments_from_a_table
-    comment_text = "a comment on the sample table"
-    result = nil
-    ActiveRecord::Schema.define do
-      set_table_comment :sample, comment_text
-      remove_table_comment :sample
-      result = retrieve_table_comment :sample
-    end
-    assert_nil result
-  end
-
-  def test_removing_comments_from_a_column
-    comment_text = "a comment on field1 of sample table"
-    result = nil
-    ActiveRecord::Schema.define do
-      set_column_comment :sample, :field1, comment_text
-      remove_column_comment :sample, :field1
-      result = retrieve_column_comment :sample, :field1
-    end
-    assert_nil result
-  end
-
-  def test_comment_text_is_escaped_properly
-    comment_text = "a \"comment\" \\ that ' needs; escaping''"
-    result = nil
-    ActiveRecord::Schema.define do
-      set_table_comment :sample, comment_text
-      result = retrieve_table_comment :sample
-    end
-    assert_equal comment_text, result
-  end
-
-end
+require './test_helper'
+
+class AddCommentsTest < Test::Unit::TestCase
+  include TestHelper
+
+  def test_adding_a_table_comment
+    comment_text = "a comment on the sample table"
+    result = nil
+    ActiveRecord::Schema.define do
+      set_table_comment :sample, comment_text
+      result = retrieve_table_comment :sample
+    end
+    assert_equal comment_text, result
+  end
+
+  def test_adding_a_column_comment
+    comment_text = "a comment on the sample table in the column field"
+    result_field1 = nil
+    result_field2 = nil
+    ActiveRecord::Schema.define do
+      set_column_comment :sample, :field1, comment_text
+      result_field1 = retrieve_column_comment :sample, :field1
+      result_field2 = retrieve_column_comment :sample, :field2
+    end
+    assert_equal comment_text, result_field1
+    assert_nil result_field2
+  end
+
+  def test_creating_a_table_with_table_and_column_comments
+    table_comment = "a table comment"
+    column_comment = "a column comment"
+    result_table_comment = nil
+    result_column_comments = nil
+    ActiveRecord::Schema.define do
+      begin
+        create_table :sample2, :comment => table_comment do |t|
+          t.integer :field1, :comment => column_comment
+          t.string :field2
+        end
+        result_table_comment = retrieve_table_comment :sample2
+        result_column_comments = retrieve_column_comments :sample2
+      ensure
+        drop_table :sample2
+      end
+    end
+    assert_equal table_comment, result_table_comment
+    assert_equal column_comment, result_column_comments[:field1]
+    assert_nil result_column_comments[:field2]
+  end
+
+  def test_changing_a_table_with_new_comments
+    table_comment = "a table comment"
+    column_comment1 = "a column comment"
+    column_comment2 = "another column comment"
+    result_table_comment = nil
+    result_column_comments = nil
+    ActiveRecord::Schema.define do
+      change_table :sample do |t|
+        t.comment table_comment
+        t.change :field1, :text, :comment => column_comment1
+        t.change :field2, :string
+        t.boolean :field3, :comment => column_comment2
+      end
+      result_table_comment = retrieve_table_comment :sample
+      result_column_comments = retrieve_column_comments :sample
+    end
+    assert_equal table_comment, result_table_comment
+    assert_equal column_comment1, result_column_comments[:field1]
+    assert_equal column_comment2, result_column_comments[:field3]
+    assert_nil result_column_comments[:field2]
+  end
+
+  def test_partially_modifying_comments_from_a_table
+    table_comment = "a table comment"
+    column_comment1 = "a column comment"
+    column_comment2 = "another column comment"
+    column_comment3 = "yet a third column comment"
+    modified_comment = "modified comment"
+    result_table_comment = nil
+    result_column_comments = nil
+    ActiveRecord::Schema.define do
+      change_table :sample do |t|
+        t.comment table_comment
+        t.change :field1, :string, :comment => column_comment1
+        t.change :field2, :integer, :comment => column_comment2
+        t.boolean :field3, :comment => column_comment3
+      end
+      change_table :sample do |t|
+        t.comment nil
+        t.change :field1, :text
+        t.change :field2, :string, :comment => modified_comment
+        t.change :field3, :boolean, :comment => nil
+      end
+      result_table_comment = retrieve_table_comment :sample
+      result_column_comments = retrieve_column_comments :sample
+    end
+    assert_nil result_table_comment
+    assert_equal column_comment1, result_column_comments[:field1]
+    assert_equal modified_comment, result_column_comments[:field2]
+    assert_nil result_column_comments[:field3]
+  end
+
+  def test_removing_comments_from_a_table
+    comment_text = "a comment on the sample table"
+    result = nil
+    ActiveRecord::Schema.define do
+      set_table_comment :sample, comment_text
+      remove_table_comment :sample
+      result = retrieve_table_comment :sample
+    end
+    assert_nil result
+  end
+
+  def test_removing_comments_from_a_column
+    comment_text = "a comment on field1 of sample table"
+    result = nil
+    ActiveRecord::Schema.define do
+      set_column_comment :sample, :field1, comment_text
+      remove_column_comment :sample, :field1
+      result = retrieve_column_comment :sample, :field1
+    end
+    assert_nil result
+  end
+
+  def test_comment_text_is_escaped_properly
+    comment_text = "a \"comment\" \\ that ' needs; escaping''"
+    result = nil
+    ActiveRecord::Schema.define do
+      set_table_comment :sample, comment_text
+      result = retrieve_table_comment :sample
+    end
+    assert_equal comment_text, result
+  end
+
+end