migration_comments 0.1.2 → 0.1.3

data/README.rdoc

@@ -32,11 +32,8 @@ file.
 To add a comment to an existing structure...
 
   def self.up
-    add_table_comment :table_name, "A table comment"
-    comment_table :table_name, "A table comment"                      # does the same thing
-
-    add_column_comment :table_name, :column_name, "A column comment"
-    comment_column  :table_name, :column_name, "A column comment"     # does the same thing
+    set_table_comment :table_name, "A table comment"
+    set_column_comment :table_name, :column_name, "A column comment"
   end
 
 Or you can use the change_table macro...

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

@@ -1,16 +1,19 @@
 module MigrationComments::ActiveRecord::ConnectionAdapters
   module AbstractAdapter
-    def add_table_comment(table_name, comment_text)
-      # SQL standard doesn't support schema commenting
-      raise "Table comments are not supported"
+    def set_table_comment(table_name, comment_text)
     end
-    alias comment_table :add_table_comment
 
-    def add_column_comment(table_name, column_name, comment_text)
-      # SQL standard doesn't support schema commenting
-      raise "Column comments are not supported"
+    def set_column_comment(table_name, column_name, comment_text)
+    end
+
+    def add_table_comment(*args)
+      puts "'add_table_comment' is deprecated, and will be removed in future releases. Use 'set_table_comment' instead."
+      set_table_comment(*args)
+    end
+    def add_column_comment(*args)
+      puts "'add_column_comment' is deprecated, and will be removed in future releases. Use 'set_column_comment' instead."
+      set_column_comment(*args)
     end
-    alias comment_column :add_column_comment
 
     def comments_supported?
       false
@@ -18,12 +21,12 @@ module MigrationComments::ActiveRecord::ConnectionAdapters
 
     # Remove a comment on a table (if set)
     def remove_table_comment(table_name)
-      add_table_comment(table_name, nil)
+      set_table_comment(table_name, nil)
     end
 
     # Remove a comment on a column (if set)
     def remove_column_comment(table_name, column_name)
-      add_column_comment(table_name, column_name, nil)
+      set_column_comment(table_name, column_name, nil)
     end
 
     def retrieve_table_comment(table_name)

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

@@ -2,8 +2,8 @@ module MigrationComments::ActiveRecord::ConnectionAdapters
   class CommentDefinition < Struct.new(:adapter, :table, :column_name, :comment_text)
     def to_dump
       table_comment? ?
-          "add_table_comment :#{table_name}, %{#{comment_text}}" :
-          "add_column_comment :#{table_name}, :#{column_name}, %{#{comment_text}}"
+          "set_table_comment :#{table_name}, %{#{comment_text}}" :
+          "set_column_comment :#{table_name}, :#{column_name}, %{#{comment_text}}"
     end
 
     def to_sql

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

@@ -8,11 +8,11 @@ module MigrationComments::ActiveRecord::ConnectionAdapters
       end
     end
 
-    def add_table_comment(table_name, comment_text)
+    def set_table_comment(table_name, comment_text)
       execute "ALTER TABLE #{table_name} COMMENT #{escaped_comment(comment_text)}"
     end
 
-    def add_column_comment(table_name, column_name, comment_text)
+    def set_column_comment(table_name, column_name, comment_text)
       column = column_for(table_name, column_name)
       change_column table_name, column_name, column.sql_type, :comment => comment_text
     end
@@ -58,9 +58,9 @@ module MigrationComments::ActiveRecord::ConnectionAdapters
 
     def execute_comment(comment_definition)
       if comment_definition.table_comment?
-        add_table_comment comment_definition.table_name, comment_definition.comment_text
+        set_table_comment comment_definition.table_name, comment_definition.comment_text
       else
-        add_column_comment comment_definition.table_name, comment_definition.column_name, comment_definition.comment_text
+        set_column_comment comment_definition.table_name, comment_definition.column_name, comment_definition.comment_text
       end
     end
 

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

@@ -13,12 +13,12 @@ module MigrationComments::ActiveRecord::ConnectionAdapters
     end
 
     # Set a comment on a table
-    def add_table_comment(table_name, comment_text)
+    def set_table_comment(table_name, comment_text)
       execute CommentDefinition.new(self, table_name, nil, comment_text).to_sql
     end
 
     # Set a comment on a column
-    def add_column_comment(table_name, column_name, comment_text)
+    def set_column_comment(table_name, column_name, comment_text)
       execute CommentDefinition.new(self, table_name, column_name, comment_text).to_sql
     end
 
@@ -49,14 +49,14 @@ module MigrationComments::ActiveRecord::ConnectionAdapters
     def add_column_with_migration_comments(table_name, column_name, type, options = {})
       add_column_without_migration_comments(table_name, column_name, type, options)
       if options[:comment]
-        add_column_comment(table_name, column_name, options[:comment])
+        set_column_comment(table_name, column_name, options[:comment])
       end
     end
 
     def change_column_with_migration_comments(table_name, column_name, type, options = {})
       change_column_without_migration_comments(table_name, column_name, type, options)
       if options.keys.include?(:comment)
-        add_column_comment(table_name, column_name, options[:comment])
+        set_column_comment(table_name, column_name, options[:comment])
       end
     end
 

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

@@ -8,11 +8,11 @@ module MigrationComments::ActiveRecord::ConnectionAdapters
       end
     end
 
-    def add_table_comment(table_name, comment_text)
+    def set_table_comment(table_name, comment_text)
       alter_table(table_name, :comment => comment_text)
     end
 
-    def add_column_comment(table_name, column_name, comment_text)
+    def set_column_comment(table_name, column_name, comment_text)
       column = column_for(table_name, column_name)
       change_column table_name, column_name, column.sql_type, :comment => comment_text
     end

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

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

data/lib/migration_comments/version.rb

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

data/test/add_comments_test.rb

@@ -7,7 +7,7 @@ class AddCommentsTest < Test::Unit::TestCase
     comment_text = "a comment on the sample table"
     result = nil
     ActiveRecord::Schema.define do
-      add_table_comment :sample, comment_text
+      set_table_comment :sample, comment_text
       result = retrieve_table_comment :sample
     end
     assert_equal comment_text, result
@@ -18,7 +18,7 @@ class AddCommentsTest < Test::Unit::TestCase
     result_field1 = nil
     result_field2 = nil
     ActiveRecord::Schema.define do
-      add_column_comment :sample, :field1, comment_text
+      set_column_comment :sample, :field1, comment_text
       result_field1 = retrieve_column_comment :sample, :field1
       result_field2 = retrieve_column_comment :sample, :field2
     end
@@ -104,7 +104,7 @@ class AddCommentsTest < Test::Unit::TestCase
     comment_text = "a comment on the sample table"
     result = nil
     ActiveRecord::Schema.define do
-      add_table_comment :sample, comment_text
+      set_table_comment :sample, comment_text
       remove_table_comment :sample
       result = retrieve_table_comment :sample
     end
@@ -115,7 +115,7 @@ class AddCommentsTest < Test::Unit::TestCase
     comment_text = "a comment on field1 of sample table"
     result = nil
     ActiveRecord::Schema.define do
-      add_column_comment :sample, :field1, comment_text
+      set_column_comment :sample, :field1, comment_text
       remove_column_comment :sample, :field1
       result = retrieve_column_comment :sample, :field1
     end
@@ -126,7 +126,7 @@ class AddCommentsTest < Test::Unit::TestCase
     comment_text = "a \"comment\" \\ that ' needs; escaping''"
     result = nil
     ActiveRecord::Schema.define do
-      add_table_comment :sample, comment_text
+      set_table_comment :sample, comment_text
       result = retrieve_table_comment :sample
     end
     assert_equal comment_text, result

data/test/annotate_models_test.rb

@@ -16,8 +16,8 @@ class AnnotateModelsTest < Test::Unit::TestCase
     ActiveRecord::Schema.define do
       db_type = :mysql if connection.is_a?(ActiveRecord::ConnectionAdapters::MysqlAdapter) rescue false
 
-      add_table_comment :sample, "a table comment"
-      add_column_comment :sample, :field1, "a \"comment\" \\ that ' needs; escaping''"
+      set_table_comment :sample, "a table comment"
+      set_column_comment :sample, :field1, "a \"comment\" \\ that ' needs; escaping''"
       add_column :sample, :field3, :string, :null => false, :default => '', :comment => "third column comment"
     end
 

data/test/schema_dumper_test.rb

@@ -8,8 +8,8 @@ class SchemaDumperTest < Test::Unit::TestCase
     ActiveRecord::Schema.define do
       db_type = :sqlite if connection.is_a?(ActiveRecord::ConnectionAdapters::SQLiteAdapter) rescue false
 
-      add_table_comment :sample, "a table comment"
-      add_column_comment :sample, :field1, "a \"comment\" \\ that ' needs; escaping''"
+      set_table_comment :sample, "a table comment"
+      set_column_comment :sample, :field1, "a \"comment\" \\ that ' needs; escaping''"
       add_column :sample, :field3, :string, :null => false, :default => "", :comment => "third column comment"
     end
     dest = StringIO.new

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: migration_comments
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 29
   prerelease: 
   segments: 
   - 0
   - 1
-  - 2
-  version: 0.1.2
+  - 3
+  version: 0.1.3
 platform: ruby
 authors: 
 - Pinny