pg_comment 0.0.5 → 0.1.0

data/README.rdoc

@@ -6,9 +6,17 @@ Obviously, only the PostgreSQL adapter is supported.
 
 == Warning
 
-This is still experimental.  If it blows up your Rails app, I will gladly welcome your bug reports.
+This is still somewhat experimental.  It has to date been tested with:
 
-This has only been tested on Ruby 1.9.2 and JRuby 1.6.4.
+* Ruby
+  - 1.8.7 REE
+  - 1.9.2 YARV
+  - JRuby 1.6.4
+* Rails
+  - 3.0.10
+  - 3.1
+
+All bug reports are welcome.
 
 == Installation
 
@@ -18,12 +26,13 @@ Assuming you're using RubyGems:
 
 == Usage
 
-PgComment adds four methods to migrations:
+PgComment adds five methods to migrations:
 
 * set_table_comment(table_name, comment)
 * remove_table_comment(table_name)
 * set_column_comment(table_name, column_name, comment)
 * remove_column_comment(table_name, column_name, comment)
+* set_column_comments(table_name, comments)
 
 Set a comment on the given table.
 
@@ -41,6 +50,11 @@ Removes any comment from the given column of a given table.
 
     remove_column_comment :phone_numbers, :npa
 
+Set comments on multiple columns in the table.
+
+    set_column_comments :phone_numbers, :npa => 'Numbering Plan Area Code - Allowed ranges: [2-9] for first digit, [0-9] for second and third digit.',
+                                        :nxx => 'Central Office Number'
+
 PgComment also adds extra methods to change_table.
 
 Set comments:
@@ -50,6 +64,11 @@ Set comments:
         t.set_column_comment :npa, 'Numbering Plan Area Code - Allowed ranges: [2-9] for first digit, [0-9] for second and third digit.'
     end
 
+    change_table :phone_numbers do |t|
+        t.set_column_comments :npa => 'Numbering Plan Area Code - Allowed ranges: [2-9] for first digit, [0-9] for second and third digit.',
+                              :nxx => 'Central Office Number'
+    end
+
 Remove comments:
 
     change_table :phone_numbers do |t|

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

@@ -38,6 +38,16 @@ module PgComment
         @base.set_column_comment(@table_name, column_name, comment)
       end
 
+      # Sets comments on multiple columns.  'comments' is a hash of column_name => comment pairs.
+      #
+      # ===== Example
+      # ====== Setting comments on the columns of the phone_numbers table
+      #  t.set_column_comments :npa => 'Numbering Plan Area Code - Allowed ranges: [2-9] for first digit, [0-9] for second and third digit.',
+      #                        :nxx => 'Central Office Number'
+      def set_column_comments(comments)
+        @base.set_column_comments(@table_name, comments)
+      end
+
       # Removes any comment for a given column
       #
       # ===== Example

data/lib/pg_comment/connection_adapters/abstract/schema_statements.rb

@@ -32,6 +32,16 @@ module PgComment
         # Does nothing
       end
 
+      # Sets comments on multiple columns.  'comments' is a hash of column_name => comment pairs.
+      #
+      # ===== Example
+      # ====== Setting comments on the columns of the phone_numbers table
+      #  set_column_comments :phone_numbers, :npa => 'Numbering Plan Area Code - Allowed ranges: [2-9] for first digit, [0-9] for second and third digit.',
+      #                                      :nxx => 'Central Office Number'
+      def set_column_comments(table_name, comments)
+
+      end
+
       # Removes any comment from the given table.
       #
       # ===== Example

data/lib/pg_comment/connection_adapters/postgresql_adapter.rb

@@ -15,6 +15,12 @@ module PgComment
         execute sql
       end
 
+      def set_column_comments(table_name, comments)
+        comments.each_pair do |column_name, comment|
+          set_column_comment table_name, column_name, comment
+        end
+      end
+
       def remove_table_comment(table_name)
         sql = "COMMENT ON TABLE #{quote_table_name(table_name)} IS NULL;"
         execute sql

data/lib/pg_comment/version.rb

@@ -1,3 +1,3 @@
 module PgComment
-  VERSION = "0.0.5"
+  VERSION = "0.1.0"
 end

data/test/postgre_sql_adapter_test.rb

@@ -30,27 +30,53 @@ class PostgreSQLAdapterTest < Test::Unit::TestCase
     include PgComment::ConnectionAdapters::PostgreSQLAdapter
   end
 
+  def setup
+    @adapter = Adapter.new
+  end
+
+  def test_table_comments_sql
+    expected = [ "COMMENT ON TABLE my_table IS $$table comment$$;",
+                 "COMMENT ON TABLE my_table IS NULL;" ]
+    @adapter.set_table_comment :my_table, 'table comment'
+    @adapter.remove_table_comment :my_table
+    assert_equal expected, @adapter.buffer
+  end
+
+  def test_column_comment_sql
+    expected = [ "COMMENT ON COLUMN my_table.my_column IS $$column comment$$;",
+                 "COMMENT ON COLUMN my_table.my_column IS NULL;" ]
+    @adapter.set_column_comment :my_table, :my_column, 'column comment'
+    @adapter.remove_column_comment :my_table, :my_column
+    assert_equal expected, @adapter.buffer
+  end
+
+  def test_column_comments_sql
+    expected = [ "COMMENT ON COLUMN my_table.column1 IS $$column comment 1$$;",
+                 "COMMENT ON COLUMN my_table.column2 IS $$column comment 2$$;" ]
+
+    @adapter.set_column_comments :my_table, :column1 => 'column comment 1', :column2 => 'column comment 2'
+    assert_equal expected, @adapter.buffer
+  end
+
   def test_sql_generation
     expected = [ "COMMENT ON TABLE my_table IS $$table comment$$;",
                  "COMMENT ON COLUMN my_table.my_column IS $$column comment$$;",
                  "COMMENT ON TABLE my_table IS NULL;",
                  "COMMENT ON COLUMN my_table.my_column IS NULL;" ]
 
-    a = Adapter.new
-    a.set_table_comment :my_table, 'table comment'
-    a.set_column_comment :my_table, :my_column, 'column comment'
-    a.remove_table_comment :my_table
-    a.remove_column_comment :my_table, :my_column
-    assert_equal expected, a.buffer
+    @adapter.set_table_comment :my_table, 'table comment'
+    @adapter.set_column_comment :my_table, :my_column, 'column comment'
+    @adapter.remove_table_comment :my_table
+    @adapter.remove_column_comment :my_table, :my_column
+    assert_equal expected, @adapter.buffer
   end
 
   def test_comments
-    a = Adapter.new
     expected = [ { 'column_name' => nil, 'comment' => 'table comment' },
                  { 'column_name' => 'column1', 'comment' => 'column comment 1' },
                  { 'column_name' => 'column2', 'comment' => 'column comment 2' } ]
-    a.select_results = expected
-    results = a.comments( nil )
+    @adapter.select_results = expected
+    results = @adapter.comments( nil )
     assert_not_nil results
     assert_equal 3, results.size, "Should have three comment rows."
     results.each_with_index do |comment_row, index|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pg_comment
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-29 00:00:00.000000000Z
+date: 2011-10-07 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &20302260 !ruby/object:Gem::Requirement
+  requirement: &7406540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *20302260
+  version_requirements: *7406540
 - !ruby/object:Gem::Dependency
   name: test-unit
-  requirement: &20301640 !ruby/object:Gem::Requirement
+  requirement: &7405880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *20301640
+  version_requirements: *7405880
 description: Extends Rails migrations to support setting column and table comments.  Pulls
   out comments into schema.rb
 email: