migration_comments 0.1.3 → 0.2.0

data/.gitignore

@@ -1,6 +1,6 @@
-*.gem
-.bundle
-Gemfile.lock
-pkg/*
-.idea/*
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.idea/*
 test/db/migration_comments_test

data/MIT-LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2012 Pinny Markowitz
+
+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

@@ -1,81 +1,84 @@
-= MigrationComments
-
-Comments for your migrations
-
-Tested on:
-
-Ruby 1.8.7 using Rails 3.x.
-Ruby 1.8.6 using Rails 2.3.x.
-
-== Why?
-
-Migrations are wonderful.  They handle all your schema changes, and in a pinch they can bring
-any database up to speed.  However, database schemas can change rapidly while a project is
-maturing, and it can be difficult to know (or remember) the purpose for each table and field.
-As such, they deserve to be commented.  These comments should be available for display wherever
-those fields are found.
-
-== Solution!
-
-Using MigrationComments, you can simply add comments during your migrations.  Or if you already
-have existing data structures, just add the comments afterwards in a separate migration.  And of
-course you can always modify and delete these comments in later migrations.
-
-So where are these comments used?  Firstly, they will be included in your schema.rb dump which
-is where your IDE (e.g. RubyMine) should be learning about your model structure.  This means that
-they'll be available at any point in your project.  Additionally, if you are using the 'annotate'
-gem, these comments will be added to the annotations that are generated within your model.rb
-file.
-
-== Examples
-
-To add a comment to an existing structure...
-
-  def self.up
-    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...
-
-  def self.up
-    change_table :table_name do |t|
-      t.comment "A table comment"
-      t.change_comment :column_name, "A column comment"
-    end
-  end
-
-Creating a new table?
-
-  def self.up
-    create_table :table_name, :comment => "A table comment" do |t|
-      t.string :column_name, :comment => "A column comment"
-    end
-  end
-
-You can also remove comments...
-
-  def self.up
-    remove_table_comment :table_name
-    remove_column_comment :table_name, :column_name
-  end
-
-Or you can combine these commands while modifying a table...
-
-  def self.up
-    change_table :existing_table do |t|
-      t.comment nil                                       # remove an existing table comment
-      t.string :new_column, :comment => "a new column"    # add a new column with a comment
-      t.change_comment :existing_column, nil              # remove a comment on an existing column
-      t.integer :another_existing_column, :comment => nil # remove a comment on an existing column while modifying the column type
-      t.boolean :column_with_comment                      # modify an existing column without altering the comment
-    end
-  end
-
-
-== Requirements
-
-You must be using a supported DBMS (currently PostgreSQL, MySQL, and SQLite).
-
-If this isn't an option for you, check out the 'schema_comments' gem:
-  https://github.com/akm/schema_comments
+= MigrationComments
+
+Comments for your migrations
+
+Tested on:
+
+* Ruby 1.8.7/1.9.x using Rails 3.x
+* Ruby 1.8.6/1.8.7 using Rails 2.3.x.
+
+== Why?
+
+Migrations are wonderful.  They handle all your schema changes, and in a pinch they can bring
+any database up to speed.  However, database schemas can change rapidly while a project is
+maturing, and it can be difficult to know (or remember) the purpose for each table and field.
+As such, they deserve to be commented.  These comments should be available for display wherever
+those fields are found.
+
+== Solution!
+
+Using MigrationComments, you can simply add comments during your migrations.  Or if you already
+have existing data structures, just add the comments afterwards in a separate migration.  And of
+course you can always modify and delete these comments in later migrations.
+
+So where are these comments used?  Firstly, they will be included in your schema.rb dump which
+is where your IDE (e.g. RubyMine) should be learning about your model structure.  This means that
+they'll be available at any point in your project.  Additionally, if you are using the 'annotate'
+gem, these comments will be added to the annotations that are generated within your model.rb
+file.
+
+== Examples
+
+To add a comment to an existing structure...
+
+  def self.up
+    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...
+
+  def self.up
+    change_table :table_name do |t|
+      t.comment "A table comment"
+      t.change_comment :column_name, "A column comment"
+    end
+  end
+
+Creating a new table?
+
+  def self.up
+    create_table :table_name, :comment => "A table comment" do |t|
+      t.string :column_name, :comment => "A column comment"
+    end
+  end
+
+You can also remove comments...
+
+  def self.up
+    remove_table_comment :table_name
+    remove_column_comment :table_name, :column_name
+  end
+
+Or you can combine these commands while modifying a table...
+
+  def self.up
+    change_table :existing_table do |t|
+      t.comment nil                                       # remove an existing table comment
+      t.string :new_column, :comment => "a new column"    # add a new column with a comment
+      t.change_comment :existing_column, nil              # remove a comment on an existing column
+      t.integer :another_existing_column, :comment => nil # remove a comment on an existing column while modifying the column type
+      t.boolean :column_with_comment                      # modify an existing column without altering the comment
+    end
+  end
+
+
+== Requirements
+
+You must be using a supported DBMS (currently PostgreSQL, MySQL, and SQLite).
+
+If this isn't an option for you, check out the 'schema_comments' gem at https://github.com/akm/schema_comments
+
+== Licensing
+
+See MIT-LICENSE file for details.

data/lib/migration_comments.rb

@@ -1,60 +1,60 @@
-require "migration_comments/version"
-
-require 'migration_comments/active_record/schema_dumper'
-require 'migration_comments/active_record/connection_adapters/comment_definition'
-require 'migration_comments/active_record/connection_adapters/column_definition'
-require 'migration_comments/active_record/connection_adapters/column'
-require 'migration_comments/active_record/connection_adapters/table'
-require 'migration_comments/active_record/connection_adapters/table_definition'
-require 'migration_comments/active_record/connection_adapters/abstract_adapter'
-require 'migration_comments/active_record/connection_adapters/mysql_adapter'
-require 'migration_comments/active_record/connection_adapters/mysql2_adapter'
-require 'migration_comments/active_record/connection_adapters/postgresql_adapter'
-require 'migration_comments/active_record/connection_adapters/sqlite_adapter'
-
-module MigrationComments
-  def self.setup
-    base_names = %w(SchemaDumper) +
-      %w(ColumnDefinition Column Table TableDefinition AbstractAdapter).map{|name| "ConnectionAdapters::#{name}"}
-
-    base_names.each do |base_name|
-      ar_class = "ActiveRecord::#{base_name}".constantize
-      mc_class = "MigrationComments::ActiveRecord::#{base_name}".constantize
-      unless ar_class.ancestors.include?(mc_class)
-        ar_class.__send__(:include, mc_class)
-      end
-    end
-
-    %w(PostgreSQL Mysql Mysql2 SQLite).each do |adapter|
-      begin
-        require("active_record/connection_adapters/#{adapter.downcase}_adapter")
-        adapter_class = ('ActiveRecord::ConnectionAdapters::' << "#{adapter}Adapter").constantize
-        mc_class = ('MigrationComments::ActiveRecord::ConnectionAdapters::' << "#{adapter}Adapter").constantize
-        adapter_class.module_eval do
-          adapter_class.__send__(:include, mc_class)
-        end
-      rescue Exception => ex
-      end
-    end
-
-    # annotations are not required for this gem, but if they exist they should be updated
-    begin
-      begin # first try to load from the 'annotate' gem
-        require 'annotate/annotate_models'
-      rescue Exception => ex
-        # continue as it may be already accessible through a plugin
-      end
-      gem_class = AnnotateModels
-      # don't require this until after the original AnnotateModels loads to avoid namespace confusion
-      require 'migration_comments/annotate_models'
-      mc_class = MigrationComments::AnnotateModels
-      unless gem_class.ancestors.include?(mc_class)
-        gem_class.__send__(:include, mc_class)
-      end
-    rescue Exception => ex
-      # if we got here, don't bother installing comments into annotations
-    end
-  end
-end
-
+require "migration_comments/version"
+
+require 'migration_comments/active_record/schema_dumper'
+require 'migration_comments/active_record/connection_adapters/comment_definition'
+require 'migration_comments/active_record/connection_adapters/column_definition'
+require 'migration_comments/active_record/connection_adapters/column'
+require 'migration_comments/active_record/connection_adapters/table'
+require 'migration_comments/active_record/connection_adapters/table_definition'
+require 'migration_comments/active_record/connection_adapters/abstract_adapter'
+require 'migration_comments/active_record/connection_adapters/mysql_adapter'
+require 'migration_comments/active_record/connection_adapters/mysql2_adapter'
+require 'migration_comments/active_record/connection_adapters/postgresql_adapter'
+require 'migration_comments/active_record/connection_adapters/sqlite_adapter'
+
+module MigrationComments
+  def self.setup
+    base_names = %w(SchemaDumper) +
+      %w(ColumnDefinition Column Table TableDefinition AbstractAdapter).map{|name| "ConnectionAdapters::#{name}"}
+
+    base_names.each do |base_name|
+      ar_class = "ActiveRecord::#{base_name}".constantize
+      mc_class = "MigrationComments::ActiveRecord::#{base_name}".constantize
+      unless ar_class.ancestors.include?(mc_class)
+        ar_class.__send__(:include, mc_class)
+      end
+    end
+
+    %w(PostgreSQL Mysql Mysql2 SQLite).each do |adapter|
+      begin
+        require("active_record/connection_adapters/#{adapter.downcase}_adapter")
+        adapter_class = ('ActiveRecord::ConnectionAdapters::' << "#{adapter}Adapter").constantize
+        mc_class = ('MigrationComments::ActiveRecord::ConnectionAdapters::' << "#{adapter}Adapter").constantize
+        adapter_class.module_eval do
+          adapter_class.__send__(:include, mc_class)
+        end
+      rescue Exception => ex
+      end
+    end
+
+    # annotations are not required for this gem, but if they exist they should be updated
+    begin
+      begin # first try to load from the 'annotate' gem
+        require 'annotate/annotate_models'
+      rescue Exception => ex
+        # continue as it may be already accessible through a plugin
+      end
+      gem_class = AnnotateModels
+      # don't require this until after the original AnnotateModels loads to avoid namespace confusion
+      require 'migration_comments/annotate_models'
+      mc_class = MigrationComments::AnnotateModels
+      unless gem_class.ancestors.include?(mc_class)
+        gem_class.__send__(:include, mc_class)
+      end
+    rescue Exception => ex
+      # if we got here, don't bother installing comments into annotations
+    end
+  end
+end
+
 MigrationComments.setup

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

@@ -1,44 +1,44 @@
-module MigrationComments::ActiveRecord::ConnectionAdapters
-  module AbstractAdapter
-    def set_table_comment(table_name, comment_text)
-    end
-
-    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
-
-    def comments_supported?
-      false
-    end
-
-    # Remove a comment on a table (if set)
-    def remove_table_comment(table_name)
-      set_table_comment(table_name, nil)
-    end
-
-    # Remove a comment on a column (if set)
-    def remove_column_comment(table_name, column_name)
-      set_column_comment(table_name, column_name, nil)
-    end
-
-    def retrieve_table_comment(table_name)
-      nil
-    end
-
-    def retrieve_column_comments(table_name, *column_names)
-      {}
-    end
-
-    def retrieve_column_comment(table_name, column_name)
-      retrieve_column_comments(table_name, column_name)[column_name]
-    end
-  end
-end
+module MigrationComments::ActiveRecord::ConnectionAdapters
+  module AbstractAdapter
+    def set_table_comment(table_name, comment_text)
+    end
+
+    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
+
+    def comments_supported?
+      false
+    end
+
+    # Remove a comment on a table (if set)
+    def remove_table_comment(table_name)
+      set_table_comment(table_name, nil)
+    end
+
+    # Remove a comment on a column (if set)
+    def remove_column_comment(table_name, column_name)
+      set_column_comment(table_name, column_name, nil)
+    end
+
+    def retrieve_table_comment(table_name)
+      nil
+    end
+
+    def retrieve_column_comments(table_name, *column_names)
+      {}
+    end
+
+    def retrieve_column_comment(table_name, column_name)
+      retrieve_column_comments(table_name, column_name)[column_name]
+    end
+  end
+end

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

@@ -1,9 +1,9 @@
-module MigrationComments::ActiveRecord::ConnectionAdapters
-  module Column
-    def self.included(base)
-      base.class_eval do
-        attr_accessor :comment
-      end
-    end
-  end
+module MigrationComments::ActiveRecord::ConnectionAdapters
+  module Column
+    def self.included(base)
+      base.class_eval do
+        attr_accessor :comment
+      end
+    end
+  end
 end

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

@@ -1,5 +1,5 @@
-module MigrationComments::ActiveRecord::ConnectionAdapters
-  module ColumnDefinition
-    attr_accessor :comment
-  end
+module MigrationComments::ActiveRecord::ConnectionAdapters
+  module ColumnDefinition
+    attr_accessor :comment
+  end
 end

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

@@ -1,22 +1,22 @@
-module MigrationComments::ActiveRecord::ConnectionAdapters
-  class CommentDefinition < Struct.new(:adapter, :table, :column_name, :comment_text)
-    def to_dump
-      table_comment? ?
-          "set_table_comment :#{table_name}, %{#{comment_text}}" :
-          "set_column_comment :#{table_name}, :#{column_name}, %{#{comment_text}}"
-    end
-
-    def to_sql
-      adapter.comment_sql(self)
-    end
-    alias to_s :to_sql
-
-    def table_comment?
-      column_name.blank?
-    end
-
-    def table_name
-      table.respond_to?(:name) ? table.name : table
-    end
-  end
+module MigrationComments::ActiveRecord::ConnectionAdapters
+  class CommentDefinition < Struct.new(:adapter, :table, :column_name, :comment_text)
+    def to_dump
+      table_comment? ?
+          "set_table_comment :#{table_name}, %{#{comment_text}}" :
+          "set_column_comment :#{table_name}, :#{column_name}, %{#{comment_text}}"
+    end
+
+    def to_sql
+      adapter.comment_sql(self)
+    end
+    alias to_s :to_sql
+
+    def table_comment?
+      column_name.blank?
+    end
+
+    def table_name
+      table.respond_to?(:name) ? table.name : table
+    end
+  end
 end