pg_comment 0.1.2 → 0.2.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NjI1NzkwMjU1OTMzZGJhOTZlMDdmNjUxZGVhNDM3OGMyMzg1ODQ4Mw==
+  data.tar.gz: !binary |-
+    MmNjZTE3M2ExY2Q4NzFmZTQ5NzQ3YTJjYTQ0MTBjZTRjMGZmMDNiOQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    MDFjYzM4OTk2YTRjMjQxYTkzOTE2OTk0ZWQwNjYyZjljOWU2MTYxMzM4YjE5
+    MWQ3NWM3YzY3ODgwY2ExYmYyYzBlMmFjNTMyOGEyZmVhMDVkMGJhNmFmNTUx
+    ZDc5YmU2MDk4ZWJiYzU4Mzc3MGQ1NmI3NTliMWI3NGM1ZDU2YjA=
+  data.tar.gz: !binary |-
+    ZmY2NDg4NTEyNzRiNTJjZTI1M2E1NDFhNGRiMGIyMzc4MGIwZDJkM2VmMDgx
+    YjI4Y2UyZWEzN2Y0NDM5YjdiYWRjODFjM2RmYjFkZDg2NjU2N2NkYTRmYTRh
+    MGZkNDM2YTBiZDRkMTJlOThjNTUyZjQ2NGQzYzc1YzU0MDRkMjE=

data/.gitignore

@@ -4,4 +4,8 @@ Gemfile.lock
 pkg/*
 .idea
 .rvmrc
-coverage/*
+coverage/*
+
+spec/dummy/db/*.sqlite3
+spec/dummy/log/*.log
+spec/dummy/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format nested

data/README.markdown

@@ -4,15 +4,10 @@ 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.
+comments on columns, tables and indexes.  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.
+Obviously, only the PostgreSQL adapter (ether 'pg' or 'activerecord-jdbcpostgresql-adapter')
+is supported.  All bug reports are welcome.
 
 ## Requirements
 
@@ -35,16 +30,18 @@ Alternatively you can manually install from RubyGems:
 
 ## Usage
 
-PgComment adds five methods to the migrations DSL:
+PgComment adds eight 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)`
+* `set_column_comments(table_name, column_comment_hash)`
+* `remove_column_comments(table_name, *column_names)`
+* `set_index_comment(index_name, comment)`
+* `remove_index_comment(index_name)`
 
-## Examples
+### Examples
 
 ```ruby
 # Set a comment on the given table.
@@ -66,9 +63,15 @@ set_column_comments :phone_numbers,
 
 # Remove comments from multiple columns in the table.
 remove_column_comments :phone_numbers, :npa, :nxx
+
+# Set a comment on an index
+set_index_comment :index_phone_numbers_on_npa, 'Unique index on area code'
+
+# Remove a comment from an index
+remove_index_comment :index_phone_numbers_on_npa
 ```
 
-PgComment also adds extra methods to change_table.
+PgComment also adds extra methods to `change_table`.
 
 ```ruby
 # Set comments:

data/Rakefile

@@ -1,8 +1,40 @@
 require "bundler/gem_tasks"
-require "rake/testtask"
 
-Rake::TestTask.new do |t|
-  t.libs << "test"
-  t.test_files = FileList['test/*test.rb']
-  t.verbose = true
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+desc 'Run specs'
+task 'spec' => ['db:drop', 'db:create', 'db:migrate', 'app:spec']
+task :default => :spec
+
+def gemspec
+  @gem_spec ||= eval( open( `ls *.gemspec`.strip ){|file| file.read } )
+end
+
+def gem_version
+  gemspec.version
+end
+
+def gem_version_tag
+  "v#{gem_version}"
+end
+
+def gem_name
+  gemspec.name
+end
+
+def gem_file_name
+  "#{gem_name}-#{gem_version}.gem"
+end
+
+namespace :git do
+  desc "Create git version tag #{gem_version}"
+  task :tag do
+    sh "git tag -a #{gem_version_tag} -m \"Version #{gem_version}\""
+  end
+
+  desc "Push git tag to GitHub"
+  task :push_tags do
+    sh 'git push --tags'
+  end
 end

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

@@ -69,6 +69,16 @@ module PgComment
 
       end
 
+      # Sets the comment on the given index
+      def set_index_comment(index_name, comment)
+
+      end
+
+      # Removes the comment from the given index
+      def remove_index_comment(index_name)
+
+      end
+
     end
   end
 end

data/lib/pg_comment/connection_adapters/postgresql_adapter.rb

@@ -36,6 +36,17 @@ module PgComment
           remove_column_comment table_name, column_name
         end
       end
+
+      def set_index_comment(index_name, comment)
+        sql = "COMMENT ON INDEX #{quote_string(index_name)} IS $$#{comment}$$;"
+        execute sql
+      end
+
+      def remove_index_comment(index_name)
+        sql = "COMMENT ON INDEX #{quote_string(index_name)} IS NULL;"
+        execute sql
+      end
+
 =begin
 --Fetch all comments
 SELECT c.relname as table_name, a.attname as column_name, d.description as comment
@@ -57,6 +68,19 @@ WHERE c.relkind = 'r' AND c.relname = '#{table_name}'
           [ row['column_name'], row['comment'] ]
         end
       end
+
+      def index_comments
+        com = select_all %{
+SELECT c.relname AS index_name, d.description AS comment
+FROM pg_description d
+JOIN pg_class c ON c.oid = d.objoid
+WHERE c.relkind = 'i'
+                   }
+        com.inject({}) do |hash, row|
+          hash[row['index_name']] = row['comment']
+          hash
+        end
+      end
     end
   end
 end

data/lib/pg_comment/migration/command_recorder.rb

@@ -6,7 +6,7 @@ module PgComment
       end
 
       def remove_table_comment(*args)
-        record(:remove_table_comments, args)
+        record(:remove_table_comment, args)
       end
 
       def set_column_comment(*args)
@@ -25,6 +25,14 @@ module PgComment
         record(:remove_column_comments, args)
       end
 
+      def set_index_comment(*args)
+        record(:set_index_comment, args)
+      end
+
+      def remove_index_comment(*args)
+        record(:remove_index_comment, args)
+      end
+
       def invert_set_table_comment(args)
         table_name = args.first
         [:remove_table_comment, [table_name]]
@@ -37,9 +45,14 @@ module PgComment
       end
 
       def invert_set_column_comments(args)
-        i_args = [args[0]] + args[1].collect{|name, value| name  }
+        i_args = [args[0]] + args[1].collect{|name, _| name  }
         [:remove_column_comments, i_args]
       end
+
+      def invert_set_index_comment(args)
+        index_name = args.first
+        [:remove_index_comment, [index_name]]
+      end
     end
   end
 end

data/lib/pg_comment/schema_dumper.rb

@@ -29,6 +29,12 @@ module PgComment
         stream.puts comment_statements.join("\n")
         stream.puts
       end
+
+      unless (index_comments = @connection.index_comments).empty?
+        index_comments.each_pair do |index_name, comment|
+          stream.puts "  set_index_comment '#{index_name}', '#{comment.gsub(/'/, "\\\\'")}'"
+        end
+      end
     end
     private :dump_comments
   end

data/lib/pg_comment/version.rb

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

data/pg_comment.gemspec

@@ -19,5 +19,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_dependency('activerecord', '~> 3.0')
-  s.add_development_dependency("test-unit")
+  s.add_development_dependency('rails', '~> 3.2')
+  s.add_development_dependency('pg')
+  s.add_development_dependency('rspec-rails')
 end

data/spec/comments_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe 'Comments' do
+
+  def connection
+    ActiveRecord::Base.connection
+  end
+
+  def get_table_comment(table_name)
+    connection.query(<<-SQL).flatten.first
+      SELECT pg_desc.description
+      FROM pg_catalog.pg_description pg_desc
+        INNER JOIN pg_catalog.pg_class pg_class ON pg_class.oid = pg_desc.objoid
+        INNER JOIN pg_namespace ON pg_class.relnamespace = pg_namespace.oid
+      WHERE pg_class.relname = '#{table_name}'
+        AND pg_desc.objsubid = 0  -- means table
+    SQL
+  end
+
+  def get_column_comment(table_name, column)
+    connection.query(<<-SQL).flatten.first
+      SELECT d.description
+      FROM pg_description d
+        JOIN pg_class c on c.oid = d.objoid
+        JOIN pg_attribute a ON c.oid = a.attrelid AND a.attnum = d.objsubid
+        JOIN pg_namespace ON c.relnamespace = pg_namespace.oid
+      WHERE c.relkind = 'r'
+        AND c.relname = '#{table_name}'
+        AND a.attname = '#{column}'
+    SQL
+  end
+
+  it 'should create table comments' do
+    get_table_comment('vegetables').should == 'Healthy and delicious'
+  end
+
+  it 'should create column comments' do
+    get_column_comment('vegetables', 'name').should == 'The name of the vegetable'
+    get_column_comment('vegetables', 'price').should == 'vegetable cost'
+    get_column_comment('vegetables', 'comment').should == 'thoughts'
+  end
+end

data/spec/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require_tree .

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application", :media => "all" %>
+  <%= javascript_include_tag "application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/config/application.rb

@@ -0,0 +1,60 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+if defined?(Bundler)
+  Bundler.require *Rails.groups(:assets => %w(development test))
+end
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+
+    # Enable escaping HTML in JSON.
+    config.active_support.escape_html_entities_in_json = true
+
+    # Use SQL instead of Active Record's schema dumper when creating the database.
+    # This is necessary if your schema can't be completely dumped by the schema dumper,
+    # like if you have constraints or database-specific column types
+    # config.active_record.schema_format = :sql
+
+    # Enforce whitelist mode for mass assignment.
+    # This will create an empty whitelist of attributes available for mass-assignment for all models
+    # in your app. As such, your models will need to explicitly whitelist or blacklist accessible
+    # parameters by using an attr_accessible or attr_protected declaration.
+    config.active_record.whitelist_attributes = true
+
+    # Enable the asset pipeline
+    config.assets.enabled = true
+
+    # Version of your assets, change this if you want to expire all your assets
+    config.assets.version = '1.0'
+  end
+end
+

data/spec/dummy/config/boot.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+
+if File.exist?(gemfile)
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+end
+
+$:.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/database.yml

@@ -0,0 +1,12 @@
+development: &default
+  adapter: postgresql
+  encoding: unicode
+  database: pg_comment_dummy_development
+  pool: 5
+  username: postgres
+  password: secret
+  host: localhost
+
+test:
+  <<: *default
+  database: pg_comment_dummy_test

data/spec/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application
+Dummy::Application.initialize!

data/spec/dummy/config/environments/development.rb

@@ -0,0 +1,37 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger
+  config.active_support.deprecation = :log
+
+  # Only use best-standards-support built into browsers
+  config.action_dispatch.best_standards_support = :builtin
+
+  # Raise exception on mass assignment protection for Active Record models
+  config.active_record.mass_assignment_sanitizer = :strict
+
+  # Log the query plan for queries taking more than this (works
+  # with SQLite, MySQL, and PostgreSQL)
+  config.active_record.auto_explain_threshold_in_seconds = 0.5
+
+  # Do not compress assets
+  config.assets.compress = false
+
+  # Expands the lines which load the assets
+  config.assets.debug = true
+end

data/spec/dummy/config/environments/production.rb

@@ -0,0 +1,67 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # Code is not reloaded between requests
+  config.cache_classes = true
+
+  # Full error reports are disabled and caching is turned on
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Disable Rails's static asset server (Apache or nginx will already do this)
+  config.serve_static_assets = false
+
+  # Compress JavaScripts and CSS
+  config.assets.compress = true
+
+  # Don't fallback to assets pipeline if a precompiled asset is missed
+  config.assets.compile = false
+
+  # Generate digests for assets URLs
+  config.assets.digest = true
+
+  # Defaults to nil and saved in location specified by config.assets.prefix
+  # config.assets.manifest = YOUR_PATH
+
+  # Specifies the header that your server uses for sending files
+  # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # See everything in the log (default is :info)
+  # config.log_level = :debug
+
+  # Prepend all log lines with the following tags
+  # config.log_tags = [ :subdomain, :uuid ]
+
+  # Use a different logger for distributed setups
+  # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new)
+
+  # Use a different cache store in production
+  # config.cache_store = :mem_cache_store
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Precompile additional assets (application.js, application.css, and all non-JS/CSS are already added)
+  # config.assets.precompile += %w( search.js )
+
+  # Disable delivery errors, bad email addresses will be ignored
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable threaded mode
+  # config.threadsafe!
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation can not be found)
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners
+  config.active_support.deprecation = :notify
+
+  # Log the query plan for queries taking more than this (works
+  # with SQLite, MySQL, and PostgreSQL)
+  # config.active_record.auto_explain_threshold_in_seconds = 0.5
+end

data/spec/dummy/config/environments/test.rb

@@ -0,0 +1,37 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # The test environment is used exclusively to run your application's
+  # test suite. You never need to work with it otherwise. Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs. Don't rely on the data there!
+  config.cache_classes = true
+
+  # Configure static asset server for tests with Cache-Control for performance
+  config.serve_static_assets = true
+  config.static_cache_control = "public, max-age=3600"
+
+  # Log error messages when you accidentally call methods on nil
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Raise exceptions instead of rendering exception templates
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment
+  config.action_controller.allow_forgery_protection    = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  config.action_mailer.delivery_method = :test
+
+  # Raise exception on mass assignment protection for Active Record models
+  config.active_record.mass_assignment_sanitizer = :strict
+
+  # Print deprecation notices to the stderr
+  config.active_support.deprecation = :stderr
+end

data/spec/dummy/config/initializers/backtrace_silencers.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
+# Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
+
+# You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
+# Rails.backtrace_cleaner.remove_silencers!

data/spec/dummy/config/initializers/inflections.rb

@@ -0,0 +1,15 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new inflection rules using the following format
+# (all these examples are active by default):
+# ActiveSupport::Inflector.inflections do |inflect|
+#   inflect.plural /^(ox)$/i, '\1en'
+#   inflect.singular /^(ox)en/i, '\1'
+#   inflect.irregular 'person', 'people'
+#   inflect.uncountable %w( fish sheep )
+# end
+#
+# These inflection rules are supported but not enabled by default:
+# ActiveSupport::Inflector.inflections do |inflect|
+#   inflect.acronym 'RESTful'
+# end

data/spec/dummy/config/initializers/mime_types.rb

@@ -0,0 +1,5 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new mime types for use in respond_to blocks:
+# Mime::Type.register "text/richtext", :rtf
+# Mime::Type.register_alias "text/html", :iphone

data/spec/dummy/config/initializers/secret_token.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# Your secret key for verifying the integrity of signed cookies.
+# If you change this key, all old signed cookies will become invalid!
+# Make sure the secret is at least 30 characters and all random,
+# no regular words or you'll be exposed to dictionary attacks.
+Dummy::Application.config.secret_token = '28f38793f7e09f0a5b2bff7679c626a0b3c6a4e299191e6b27d498b522ece7d7b9ddde67afbd912174098ec5ba13624f21f87676caea188bfe21a2326e2ba765'

data/spec/dummy/config/initializers/session_store.rb

@@ -0,0 +1,8 @@
+# Be sure to restart your server when you modify this file.
+
+Dummy::Application.config.session_store :cookie_store, key: '_dummy_session'
+
+# Use the database for sessions instead of the cookie-based default,
+# which shouldn't be used to store highly confidential information
+# (create the session table with "rails generate session_migration")
+# Dummy::Application.config.session_store :active_record_store