pg_comment 0.1.2 → 0.2.0

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

@@ -0,0 +1,14 @@
+# Be sure to restart your server when you modify this file.
+#
+# This file contains settings for ActionController::ParamsWrapper which
+# is enabled by default.
+
+# Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array.
+ActiveSupport.on_load(:action_controller) do
+  wrap_parameters format: [:json]
+end
+
+# Disable root element in JSON by default.
+ActiveSupport.on_load(:active_record) do
+  self.include_root_in_json = false
+end

data/spec/dummy/config/locales/en.yml

@@ -0,0 +1,5 @@
+# Sample localization file for English. Add more files in this directory for other locales.
+# See https://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+
+en:
+  hello: "Hello world"

data/spec/dummy/config/routes.rb

@@ -0,0 +1,58 @@
+Dummy::Application.routes.draw do
+  # The priority is based upon order of creation:
+  # first created -> highest priority.
+
+  # Sample of regular route:
+  #   match 'products/:id' => 'catalog#view'
+  # Keep in mind you can assign values other than :controller and :action
+
+  # Sample of named route:
+  #   match 'products/:id/purchase' => 'catalog#purchase', :as => :purchase
+  # This route can be invoked with purchase_url(:id => product.id)
+
+  # Sample resource route (maps HTTP verbs to controller actions automatically):
+  #   resources :products
+
+  # Sample resource route with options:
+  #   resources :products do
+  #     member do
+  #       get 'short'
+  #       post 'toggle'
+  #     end
+  #
+  #     collection do
+  #       get 'sold'
+  #     end
+  #   end
+
+  # Sample resource route with sub-resources:
+  #   resources :products do
+  #     resources :comments, :sales
+  #     resource :seller
+  #   end
+
+  # Sample resource route with more complex sub-resources
+  #   resources :products do
+  #     resources :comments
+  #     resources :sales do
+  #       get 'recent', :on => :collection
+  #     end
+  #   end
+
+  # Sample resource route within a namespace:
+  #   namespace :admin do
+  #     # Directs /admin/products/* to Admin::ProductsController
+  #     # (app/controllers/admin/products_controller.rb)
+  #     resources :products
+  #   end
+
+  # You can have the root of your site routed with "root"
+  # just remember to delete public/index.html.
+  # root :to => 'welcome#index'
+
+  # See how all your routes lay out with "rake routes"
+
+  # This is a legacy wild controller route that's not recommended for RESTful applications.
+  # Note: This route will make all actions in every controller accessible via GET requests.
+  # match ':controller(/:action(/:id))(.:format)'
+end

data/spec/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Dummy::Application

data/spec/dummy/db/migrate/20130502030557_create_vegetables.rb

@@ -0,0 +1,23 @@
+class CreateVegetables < ActiveRecord::Migration
+  def change
+    create_table :vegetables do |t|
+      t.string :name
+      t.decimal :price
+      t.string :comment
+    end
+
+    set_table_comment :vegetables, 'Healthy'
+
+    set_column_comment :vegetables, :name, 'The name of the vegetable'
+
+    set_column_comments :vegetables, :price => 'vegetable cost', :comment => 'thoughts'
+
+    change_table :vegetables do |t|
+      t.set_table_comment 'Healthy and delicious'
+    end
+
+    add_index :vegetables, :name, :unique => true
+
+    set_index_comment :index_vegetables_on_name, "Comment on index"
+  end
+end

data/spec/dummy/db/schema.rb

@@ -0,0 +1,31 @@
+# encoding: UTF-8
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended to check this file into your version control system.
+
+ActiveRecord::Schema.define(:version => 20130502030557) do
+
+  create_table "vegetables", :force => true do |t|
+    t.string  "name"
+    t.decimal "price"
+    t.string  "comment"
+  end
+
+  add_index "vegetables", ["name"], :name => "index_vegetables_on_name", :unique => true
+
+  set_index_comment 'index_vegetables_on_name', 'Comment on index'
+  set_table_comment 'vegetables', 'Healthy and delicious'
+  set_column_comment 'vegetables', 'name', 'The name of the vegetable'
+  set_column_comment 'vegetables', 'price', 'vegetable cost'
+  set_column_comment 'vegetables', 'comment', 'thoughts'
+
+  set_index_comment 'index_vegetables_on_name', 'Comment on index'
+end

data/spec/dummy/public/404.html

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The page you were looking for doesn't exist (404)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+
+<body>
+  <!-- This file lives in public/404.html -->
+  <div class="dialog">
+    <h1>The page you were looking for doesn't exist.</h1>
+    <p>You may have mistyped the address or the page may have moved.</p>
+  </div>
+</body>
+</html>

data/spec/dummy/public/422.html

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The change you wanted was rejected (422)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+
+<body>
+  <!-- This file lives in public/422.html -->
+  <div class="dialog">
+    <h1>The change you wanted was rejected.</h1>
+    <p>Maybe you tried to change something you didn't have access to.</p>
+  </div>
+</body>
+</html>

data/spec/dummy/public/500.html

@@ -0,0 +1,25 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>We're sorry, but something went wrong (500)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+
+<body>
+  <!-- This file lives in public/500.html -->
+  <div class="dialog">
+    <h1>We're sorry, but something went wrong.</h1>
+  </div>
+</body>
+</html>

data/spec/dummy/script/rails

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require File.expand_path('../../config/boot',  __FILE__)
+require 'rails/commands'

data/spec/lib/pg_comment/connection_adapters/abstract/schema_definitions_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe PgComment::ConnectionAdapters::SchemaDefinitions do
+  class TableStub
+    include ::PgComment::ConnectionAdapters::Table
+
+    attr_reader :table_name, :base
+
+    def initialize
+      @table_name = :foo
+      @base = OpenStruct.new
+    end
+  end
+
+  let (:table_stub){ TableStub.new }
+
+  it '.set_table_comment' do
+    table_stub.base.should_receive(:set_table_comment).with(:foo, :bar)
+    table_stub.set_table_comment :bar
+  end
+
+  it '.remove_table_comment' do
+    table_stub.base.should_receive(:remove_table_comment).with(:foo)
+    table_stub.remove_table_comment
+  end
+
+  it '.set_column_comment' do
+    table_stub.base.should_receive(:set_column_comment).with(:foo, :bar, :baz)
+    table_stub.set_column_comment(:bar, :baz)
+  end
+
+  it '.set_column_comments' do
+    table_stub.base.should_receive(:set_column_comments).with(:foo, :bar)
+    table_stub.set_column_comments(:bar)
+  end
+
+  it '.remove_column_comment' do
+    table_stub.base.should_receive(:remove_column_comment).with(:foo, :bar)
+    table_stub.remove_column_comment(:bar)
+  end
+
+  it '.remove_column_comments' do
+    table_stub.base.should_receive(:remove_column_comments).with(:foo, :bar, :baz)
+    table_stub.remove_column_comments(:bar, :baz)
+  end
+end

data/spec/lib/pg_comment/connection_adapters/abstract/schema_statements_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe PgComment::ConnectionAdapters::AbstractAdapter do
+
+  class AbstractAdapterStub
+    include ::PgComment::ConnectionAdapters::AbstractAdapter
+  end
+
+  let(:adapter_stub){ AbstractAdapterStub.new }
+
+  it 'should not support comments by default' do
+    adapter_stub.supports_comments?.should be_false
+  end
+
+  it 'should define method stubs for comment methods' do
+    [ :set_table_comment,
+      :set_column_comment,
+      :set_column_comments,
+      :remove_table_comment,
+      :remove_column_comment,
+      :remove_column_comments,
+      :set_index_comment,
+      :remove_index_comment ].each { |method_name| adapter_stub.respond_to?(method_name).should be_true }
+  end
+end

data/spec/lib/pg_comment/connection_adapters/postgresql_adapter_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+describe PgComment::ConnectionAdapters::PostgreSQLAdapter do
+
+  class ConnectionStub
+    include ::PgComment::ConnectionAdapters::PostgreSQLAdapter
+
+    def quote_table_name(name)
+      "\"#{name}\""
+    end
+
+    alias_method :quote_column_name, :quote_table_name
+    alias_method :quote_string, :quote_table_name
+  end
+
+  let(:connection){ ConnectionStub.new }
+
+  it 'should support comments' do
+    connection.supports_comments?.should be_true
+  end
+
+  context 'comment methods' do
+    it '.set_table_comment' do
+      connection.should_receive(:execute).with("COMMENT ON TABLE \"foo\" IS $$bar$$;")
+      connection.set_table_comment :foo, :bar
+    end
+
+    it '.set_column_comment' do
+      connection.should_receive(:execute).with("COMMENT ON COLUMN \"foo\".\"bar\" IS $$baz$$;")
+      connection.set_column_comment :foo, :bar, :baz
+    end
+
+    it '.set_column_comments' do
+      connection.should_receive(:execute).with("COMMENT ON COLUMN \"foo\".\"bar\" IS $$baz$$;")
+      connection.set_column_comments :foo, :bar => :baz
+    end
+
+    it '.remove_table_comment' do
+      connection.should_receive(:execute).with("COMMENT ON TABLE \"foo\" IS NULL;")
+      connection.remove_table_comment :foo
+    end
+
+    it '.remove_column_comment' do
+      connection.should_receive(:execute).with("COMMENT ON COLUMN \"foo\".\"bar\" IS NULL;")
+      connection.remove_column_comment :foo, :bar
+    end
+
+    it '.remove_column_comments' do
+      connection.should_receive(:execute).with("COMMENT ON COLUMN \"foo\".\"bar\" IS NULL;")
+      connection.remove_column_comments :foo, :bar
+    end
+
+    it '.set_index_comment' do
+      connection.should_receive(:execute).with("COMMENT ON INDEX \"foo\" IS $$bar$$;")
+      connection.set_index_comment :foo, :bar
+    end
+
+    it '.remove_index_comment' do
+      connection.should_receive(:execute).with("COMMENT ON INDEX \"foo\" IS NULL;")
+      connection.remove_index_comment :foo
+    end
+  end
+end

data/spec/lib/pg_comment/migration/command_recorder_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe PgComment::Migration::CommandRecorder do
+  class CommandRecorderStub
+    include ::PgComment::Migration::CommandRecorder
+  end
+
+  let(:command_recorder_stub){ CommandRecorderStub.new }
+
+  [ :set_table_comment,
+    :remove_table_comment,
+    :set_column_comment,
+    :set_column_comments,
+    :remove_column_comment,
+    :remove_column_comments,
+    :set_index_comment,
+    :remove_index_comment ].each{ |method_name|
+
+    it ".#{method_name}" do
+      command_recorder_stub.should_receive(:record).with(method_name, [])
+      command_recorder_stub.send(method_name)
+    end
+  }
+
+  it '.invert_set_table_comment' do
+    command_recorder_stub.invert_set_table_comment([:foo, :bar]).should == [:remove_table_comment, [:foo]]
+  end
+
+  it '.invert_set_column_comment' do
+    command_recorder_stub.invert_set_column_comment([:foo, :bar, :baz]).should == [:remove_column_comment, [:foo, :bar]]
+  end
+
+  it '.invert_set_column_comments' do
+    command_recorder_stub.invert_set_column_comments([:foo, {:bar => :baz}]).should == [:remove_column_comments, [:foo, :bar]]
+  end
+
+  it '.invert_set_index_comment' do
+    command_recorder_stub.invert_set_index_comment([:foo, :bar]).should == [:remove_index_comment, [:foo]]
+  end
+end

data/spec/lib/pg_comment/schema_dumper_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe ActiveRecord::SchemaDumper do
+  before(:all) do
+    stream = StringIO.new
+    ActiveRecord::SchemaDumper.dump(ActiveRecord::Base.connection, stream)
+    @dump = stream.string
+  end
+
+  it 'dumps table comments' do
+    @dump.should =~ /set_table_comment 'vegetables', 'Healthy and delicious'/
+  end
+
+  it 'dumps column comments' do
+    @dump.should =~ /set_column_comment 'vegetables', 'name', 'The name of the vegetable'/
+    @dump.should =~ /set_column_comment 'vegetables', 'price', 'vegetable cost'/
+    @dump.should =~ /set_column_comment 'vegetables', 'comment', 'thoughts'/
+  end
+
+  it 'dumps index comments' do
+    @dump.should =~ /set_index_comment 'index_vegetables_on_name', 'Comment on index'/
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+ENV['RAILS_ENV'] = 'test'
+
+unless ENV['TRAVIS']
+  require 'simplecov'
+  SimpleCov.start do
+    add_filter 'spec/'
+  end
+end
+
+require File.expand_path("../dummy/config/environment.rb",  __FILE__)
+require 'rspec/rails'
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+  config.use_transactional_fixtures = true
+end

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: pg_comment
 version: !ruby/object:Gem::Version
-  version: 0.1.2
-  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors:
 - Arthur Shagall
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-24 00:00:00.000000000 Z
+date: 2013-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,15 +20,41 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: test-unit
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -38,7 +62,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -52,6 +75,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - Gemfile
 - LICENSE
 - README.markdown
@@ -65,32 +89,67 @@ files:
 - lib/pg_comment/schema_dumper.rb
 - lib/pg_comment/version.rb
 - pg_comment.gemspec
-- test/fake_connection.rb
-- test/postgre_sql_adapter_test.rb
-- test/schema_dumper_test.rb
-- test/test_helper.rb
+- spec/comments_spec.rb
+- spec/dummy/Rakefile
+- spec/dummy/app/assets/javascripts/application.js
+- spec/dummy/app/assets/stylesheets/application.css
+- spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/helpers/application_helper.rb
+- spec/dummy/app/mailers/.gitkeep
+- spec/dummy/app/models/.gitkeep
+- spec/dummy/app/views/layouts/application.html.erb
+- spec/dummy/config.ru
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/database.yml
+- spec/dummy/config/environment.rb
+- spec/dummy/config/environments/development.rb
+- spec/dummy/config/environments/production.rb
+- spec/dummy/config/environments/test.rb
+- spec/dummy/config/initializers/backtrace_silencers.rb
+- spec/dummy/config/initializers/inflections.rb
+- spec/dummy/config/initializers/mime_types.rb
+- spec/dummy/config/initializers/secret_token.rb
+- spec/dummy/config/initializers/session_store.rb
+- spec/dummy/config/initializers/wrap_parameters.rb
+- spec/dummy/config/locales/en.yml
+- spec/dummy/config/routes.rb
+- spec/dummy/db/migrate/20130502030557_create_vegetables.rb
+- spec/dummy/db/schema.rb
+- spec/dummy/lib/assets/.gitkeep
+- spec/dummy/log/.gitkeep
+- spec/dummy/public/404.html
+- spec/dummy/public/422.html
+- spec/dummy/public/500.html
+- spec/dummy/public/favicon.ico
+- spec/dummy/script/rails
+- spec/lib/pg_comment/connection_adapters/abstract/schema_definitions_spec.rb
+- spec/lib/pg_comment/connection_adapters/abstract/schema_statements_spec.rb
+- spec/lib/pg_comment/connection_adapters/postgresql_adapter_spec.rb
+- spec/lib/pg_comment/migration/command_recorder_spec.rb
+- spec/lib/pg_comment/schema_dumper_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/albertosaurus/pg_comment
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: pg_comment
-rubygems_version: 1.8.25
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Postgres Comments for Rails
 test_files: []

data/test/fake_connection.rb

@@ -1,9 +0,0 @@
-class FakeConnection
-  def initialize(args = {})
-    @comments = args[:comments]
-  end
-
-  def comments(table_name)
-    @comments
-  end
-end