pg_power 1.4.0 → 1.5.0

data/lib/pg_power/connection_adapters/abstract_adapter/comment_methods.rb

@@ -33,6 +33,15 @@ module PgPower::ConnectionAdapters::AbstractAdapter::CommentMethods
 
   end
 
+  # Sets the comment on the given index
+  #
+  # ===== Example
+  # ====== Setting comment on the index_pets_on_breed_id index
+  #  set_index_comment 'index_pets_on_breed_id', 'Index on breed_id'
+  def set_index_comment(index_name, comment)
+
+  end
+
   # Removes any comment from the given table.
   #
   # ===== Example
@@ -59,4 +68,13 @@ module PgPower::ConnectionAdapters::AbstractAdapter::CommentMethods
   def remove_column_comments(table_name, *column_names)
 
   end
+
+  # Removes the comment from the given index
+  #
+  # ===== Example
+  # ====== Removing comment from the index_pets_on_breed_id index
+  #  remove_index_comment :index_pets_on_breed_id
+  def remove_index_comment(index_name)
+
+  end
 end

data/lib/pg_power/connection_adapters/postgresql_adapter/comment_methods.rb

@@ -31,6 +31,14 @@ module PgPower::ConnectionAdapters::PostgreSQLAdapter::CommentMethods
     end
   end
 
+  # Sets the given comment on the given index
+  # @param [String, Symbol] index_name The name of the index
+  # @param [String, Symbol] comment The comment to set on the index
+  def set_index_comment(index_name, comment)
+    sql = "COMMENT ON INDEX #{quote_string(index_name)} IS $$#{comment}$$;"
+    execute sql
+  end
+
   # Executes SQL to remove comment on passed table.
   # @param [String, Symbol] table_name
   def remove_table_comment(table_name)
@@ -53,6 +61,13 @@ module PgPower::ConnectionAdapters::PostgreSQLAdapter::CommentMethods
     end
   end
 
+  # Removes any comment from the given index
+  # @param [String, Symbol] index_name The name of the index
+  def remove_index_comment(index_name)
+    sql = "COMMENT ON INDEX #{quote_string(index_name)} IS NULL;"
+    execute sql
+  end
+
   # Fetches all comments related to passed table.
   # I returns table comment and column comments as well.
   # ===Example
@@ -61,7 +76,7 @@ module PgPower::ConnectionAdapters::PostgreSQLAdapter::CommentMethods
   #                           ["email", "Comment on email column"]]
   def comments(table_name)
     relation_name, schema_name = table_name.split(".", 2).reverse
-    schema_name ||= "public" 
+    schema_name ||= :public
 
     com = select_all <<-SQL
       SELECT a.attname AS column_name, d.description AS comment
@@ -76,4 +91,24 @@ module PgPower::ConnectionAdapters::PostgreSQLAdapter::CommentMethods
       [ row['column_name'], row['comment'] ]
     end
   end
+
+  # Fetches index comments
+  # returns an Array of Arrays, each element representing a single index with comment as
+  #  [ 'schema_name', 'index_name', 'comment' ]
+  def index_comments
+    query =  <<-SQL
+      SELECT c.relname AS index_name, d.description AS comment, pg_namespace.nspname AS schema_name
+      FROM pg_description d
+      JOIN pg_class c ON c.oid = d.objoid
+      JOIN pg_namespace ON c.relnamespace = pg_namespace.oid
+      WHERE c.relkind = 'i'
+      ORDER BY schema_name, index_name
+    SQL
+
+    com = select_all(query)
+
+    com.map do |row|
+      [ row['schema_name'], row['index_name'], row['comment'] ]
+    end
+  end
 end

data/lib/pg_power/migration/command_recorder/comment_methods.rb

@@ -8,7 +8,7 @@ module  PgPower::Migration::CommandRecorder::CommentMethods
 
   # :nodoc:
   def remove_table_comment(*args)
-    record(:remove_table_comments, args)
+    record(:remove_table_comment, args)
   end
 
   # :nodoc:
@@ -31,6 +31,16 @@ module  PgPower::Migration::CommandRecorder::CommentMethods
     record(:remove_column_comments, args)
   end
 
+  # :nodoc:
+  def set_index_comment(*args)
+    record(:set_index_comment, args)
+  end
+
+  # :nodoc:
+  def remove_index_comment(*args)
+    record(:remove_index_comment, args)
+  end
+
   # :nodoc:
   def invert_set_table_comment(args)
     table_name = args.first
@@ -49,4 +59,10 @@ module  PgPower::Migration::CommandRecorder::CommentMethods
     i_args = [args[0]] + args[1].collect{|name, value| name  }
     [:remove_column_comments, i_args]
   end
+
+  # :nodoc:
+  def invert_set_index_comment(args)
+    index_name = args.first
+    [:remove_index_comment, [index_name]]
+  end
 end

data/lib/pg_power/schema_dumper/comment_methods.rb

@@ -8,9 +8,21 @@ module PgPower::SchemaDumper::CommentMethods
     table_names = @connection.tables.sort
     table_names += get_non_public_schema_table_names.sort
 
+    # Dump table and column comments
     table_names.each do |table_name|
       dump_comments(table_name, stream)
     end
+
+    # Now dump index comments
+    unless (index_comments = @connection.index_comments).empty?
+      index_comments.each do |row|
+        schema_name = row[0]
+        index_name = schema_name == 'public' ? "'#{row[1]}'" : "'#{schema_name}.#{row[1]}'"
+        comment = format_comment(row[2])
+        stream.puts "  set_index_comment #{index_name}, '#{comment}'"
+      end
+      stream.puts
+    end
   end
 
   # Finds all comments related to passed table and writes appropriated
@@ -19,7 +31,7 @@ module PgPower::SchemaDumper::CommentMethods
     unless (comments = @connection.comments(table_name)).empty?
       comment_statements = comments.map do |row|
         column_name = row[0]
-        comment = row[1].gsub(/'/, "\\\\'")
+        comment = format_comment(row[1])
         if column_name
           "  set_column_comment '#{table_name}', '#{column_name}', '#{comment}'"
         else
@@ -33,4 +45,10 @@ module PgPower::SchemaDumper::CommentMethods
     end
   end
   private :dump_comments
+
+  # Escape out single quotes from comments
+  def format_comment(comment)
+    comment.gsub(/'/, "\\\\'")
+  end
+  private :format_comment
 end

data/lib/pg_power/version.rb

@@ -1,4 +1,4 @@
 module PgPower
   # Version of pg_power gem.
-  VERSION = "1.4.0"
+  VERSION = "1.5.0"
 end

metadata

@@ -1,10 +1,15 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: pg_power
-version: !ruby/object:Gem::Version
-  version: 1.4.0
+version: !ruby/object:Gem::Version 
+  hash: 3
   prerelease: 
+  segments: 
+  - 1
+  - 5
+  - 0
+  version: 1.5.0
 platform: ruby
-authors:
+authors: 
 - Potapov Sergey
 - Arthur Shagall
 - Artem Ignatyev
@@ -12,129 +17,132 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-01 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: pg
-  requirement: !ruby/object:Gem::Requirement
+
+date: 2013-05-14 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id001
+  name: pg
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id002
   name: rspec-rails
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rails
-  requirement: !ruby/object:Gem::Requirement
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '3.1'
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 3
+        - 1
+        version: "3.1"
+  version_requirements: *id003
+  name: rails
+  prerelease: false
   type: :runtime
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id004
+  name: rcov
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '3.1'
-- !ruby/object:Gem::Dependency
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id005
   name: yard
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id006
   name: metrical
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id007
   name: jeweler
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: ruby-debug19
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
   type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+- !ruby/object:Gem::Dependency 
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-description: ActiveRecord extensions for PostgreSQL. Provides useful tools for schema,
-  foreign_key, index, comment and extensios manipulations in migrations.
-email:
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id008
+  name: ruby-debug
+  prerelease: false
+  type: :development
+description: ActiveRecord extensions for PostgreSQL. Provides useful tools for schema, foreign_key, index, comment and extensios manipulations in migrations.
+email: 
 - rubygems@tmxcredit.com
 executables: []
+
 extensions: []
-extra_rdoc_files:
+
+extra_rdoc_files: 
 - README.markdown
-files:
+files: 
 - README.markdown
 - lib/core_ext/active_record/connection_adapters/abstract/schema_statements.rb
 - lib/core_ext/active_record/connection_adapters/postgresql_adapter.rb
@@ -178,29 +186,36 @@ files:
 - lib/tasks/pg_power_tasks.rake
 homepage: https://github.com/TMXCredit/pg_power
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-      segments:
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
       - 0
-      hash: 509296341304110115
-required_rubygems_version: !ruby/object:Gem::Requirement
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: ActiveRecord extensions for PostgreSQL.
 test_files: []
+