pg_comment 0.1.1 → 0.1.2

data/.gitignore

@@ -3,3 +3,5 @@
 Gemfile.lock
 pkg/*
 .idea
+.rvmrc
+coverage/*

data/Gemfile

@@ -2,3 +2,7 @@ source "http://rubygems.org"
 
 # Specify your gem's dependencies in pg_comment.gemspec
 gemspec
+
+group :test do
+  gem 'simplecov', :require => false
+end

data/README.markdown

@@ -0,0 +1,100 @@
+# PgComment
+
+https://github.com/albertosaurus/pg_comment
+
+In any PostgreSQL database where the Rails app is not the only consumer, it is very helpful to have comments
+on the various elements of the schema.  PgComment extends the migrations DSL with methods to set and remove
+comments on columns and tables.  It also dumps those comments into your schema.rb.
+
+Obviously, only the PostgreSQL adapter is supported.  All bug reports are welcome.
+
+## NOTE:
+
+I'm deprecating this in favor of PgPower: https://github.com/TMXCredit/pg_power  It uses this db comment code,
+plus gives all sorts of other goodies like schemas and partial indexes.  Since it uses this very code to
+support database comments, the comment syntax is 100% compatible.
+
+## Requirements
+
+* Ruby 1.8.7, Ruby 1.9.2, Ruby 1.9.3, JRuby 1.6+
+* ActiveRecord 3.0, 3.1, 3.2
+
+## Installation
+
+Add the following to the Gemfile of your Rails app:
+
+    gem 'pg_comment'
+
+then run
+
+    bundle install
+
+Alternatively you can manually install from RubyGems:
+
+    gem install pg_comment
+
+## Usage
+
+PgComment adds five methods to the migrations DSL:
+
+* `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)`
+* `remove_column_comments(table_name, *comments)`
+
+## Examples
+
+```ruby
+# Set a comment on the given table.
+set_table_comment :phone_numbers, 'This table stores phone numbers that conform to the North American Numbering Plan.'
+
+# Sets a comment on a given column of a given table.
+set_column_comment :phone_numbers, :npa, 'Numbering Plan Area Code - Allowed ranges: [2-9] for first digit, [0-9] for second and third digit.'
+
+# Removes any comment from the given table.
+remove_table_comment :phone_numbers
+
+# 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'
+
+# Remove comments from multiple columns in the table.
+remove_column_comments :phone_numbers, :npa, :nxx
+```
+
+PgComment also adds extra methods to change_table.
+
+```ruby
+# Set comments:
+change_table :phone_numbers do |t|
+  t.set_table_comment 'This table stores phone numbers that conform to the North American Numbering Plan.'
+  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|
+  t.remove_table_comment
+  t.remove_column_comment :npa
+end
+
+change_table :phone_numbers do |t|
+  t.remove_column_comments :npa, :nxx
+end
+```
+
+## License
+
+Copyright (c) 2011-2013 Arthur Shagall, Mindflight, Inc.
+
+Released under the MIT License.  See LICENSE for details.

data/lib/pg_comment/version.rb

@@ -1,3 +1,3 @@
 module PgComment
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/pg_comment.gemspec

@@ -18,6 +18,6 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_dependency('activerecord', '>= 3.0.0')
+  s.add_dependency('activerecord', '~> 3.0')
   s.add_development_dependency("test-unit")
 end

data/test/postgre_sql_adapter_test.rb

@@ -1,7 +1,4 @@
-require 'rubygems'
-gem 'test-unit'
-require 'test/unit'
-require 'pg_comment/connection_adapters/postgresql_adapter'
+require 'test_helper'
 
 class PostgreSQLAdapterTest < Test::Unit::TestCase
   class Adapter
@@ -87,4 +84,8 @@ class PostgreSQLAdapterTest < Test::Unit::TestCase
     end
   end
 
+  def test_supports_comments
+    assert_true @adapter.supports_comments?
+  end
+
 end

data/test/schema_dumper_test.rb

@@ -1,9 +1,4 @@
-require 'fake_connection'
-require 'rubygems'
-gem 'test-unit'
-require 'test/unit'
-require 'active_record'
-require 'pg_comment/schema_dumper'
+require 'test_helper'
 
 class SchemaDumperTest < Test::Unit::TestCase
   class SchemaDumpContainer

data/test/test_helper.rb

@@ -0,0 +1,16 @@
+#require 'rubygems'
+gem 'test-unit'
+
+if require 'simplecov'
+  SimpleCov.start do
+    add_filter 'test/'
+  end
+end
+
+require 'test/unit'
+require 'active_record'
+
+
+require 'pg_comment/connection_adapters/postgresql_adapter'
+require 'fake_connection'
+require 'pg_comment/schema_dumper'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pg_comment
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,22 +9,27 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-07 00:00:00.000000000Z
+date: 2013-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &7923860 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *7923860
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: test-unit
-  requirement: &7922760 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +37,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *7922760
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Extends Rails migrations to support setting column and table comments.  Pulls
   out comments into schema.rb
 email:
@@ -44,7 +54,7 @@ files:
 - .gitignore
 - Gemfile
 - LICENSE
-- README.rdoc
+- README.markdown
 - Rakefile
 - lib/pg_comment.rb
 - lib/pg_comment/connection_adapters/abstract/schema_definitions.rb
@@ -58,6 +68,7 @@ files:
 - test/fake_connection.rb
 - test/postgre_sql_adapter_test.rb
 - test/schema_dumper_test.rb
+- test/test_helper.rb
 homepage: https://github.com/albertosaurus/pg_comment
 licenses: []
 post_install_message: 
@@ -78,7 +89,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: pg_comment
-rubygems_version: 1.8.10
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Postgres Comments for Rails

data/README.rdoc

@@ -1,83 +0,0 @@
-= PgComment
-
-In any PostgreSQL database where the Rails app is not the only consumer, it is very helpful to have comments on the various database entities.  PgComment adds methods to migrations to set and remove comments on columns and tables.
-
-Obviously, only the PostgreSQL adapter is supported.
-
-== Warning
-
-This is still somewhat experimental.  It has to date been tested with:
-
-* 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
-
-Assuming you're using RubyGems:
-
-    gem install pg_comment
-
-== Usage
-
-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.
-
-    set_table_comment :phone_numbers, 'This table stores phone numbers that conform to the North American Numbering Plan.'
-
-Sets a comment on a given column of a given table.
-
-    set_column_comment :phone_numbers, :npa, 'Numbering Plan Area Code - Allowed ranges: [2-9] for first digit, [0-9] for second and third digit.'
-
-Removes any comment from the given table.
-
-    remove_table_comment :phone_numbers
-
-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:
-
-    change_table :phone_numbers do |t|
-        t.set_table_comment 'This table stores phone numbers that conform to the North American Numbering Plan.'
-        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|
-        t.remove_table_comment
-        t.remove_column_comment :npa
-    end
-
-== License
-
-Copyright (c) 2011 Arthur Shagall
-
-Released under the MIT License.  See LICENSE for details.