sequel-pg-comment 1.0.0

data/sequel-pg-comment.gemspec

@@ -0,0 +1,36 @@
+require 'git-version-bump'
+
+Gem::Specification.new do |s|
+	s.name = "sequel-pg-comment"
+
+	s.version = GVB.version
+	s.date    = GVB.date
+
+	s.platform = Gem::Platform::RUBY
+
+	s.homepage = "http://theshed.hezmatt.org/sequel-pg-comment"
+	s.summary = "Set comments on PgSQL objects from seuqel migrations"
+	s.authors = ["Matt Palmer"]
+
+	s.extra_rdoc_files = ["README.md"]
+	s.files = `git ls-files -z`.split("\0")
+
+	s.add_runtime_dependency "git-version-bump", "~> 0.10"
+	s.add_runtime_dependency "sequel"
+
+	s.add_development_dependency 'bundler'
+	s.add_development_dependency 'github-release'
+	s.add_development_dependency 'guard-spork'
+	s.add_development_dependency 'guard-rspec'
+	# Needed for guard
+	s.add_development_dependency 'rb-inotify', '~> 0.9'
+	if RUBY_VERSION =~ /^1\./
+		s.add_development_dependency 'pry-debugger'
+	else
+		s.add_development_dependency 'pry-byebug'
+	end
+	s.add_development_dependency 'rake', '~> 10.4', '>= 10.4.2'
+	s.add_development_dependency 'redcarpet'
+	s.add_development_dependency 'rspec', '~> 3.0'
+	s.add_development_dependency 'yard'
+end

data/spec/alter_table_comment_spec.rb

@@ -0,0 +1,124 @@
+require_relative 'spec_helper'
+require 'sequel'
+
+describe "schema modification" do
+	let(:db) do
+		Sequel.connect("mock://postgres").extension(:pg_comment)
+	end
+
+	it "sets a column comment on add_column" do
+		db.alter_table :foo do
+			add_column(:data, String, :comment => "Owhatanight")
+		end
+		expect(db.sqls.last).
+		  to eq("COMMENT ON COLUMN \"foo\".\"data\" IS 'Owhatanight'")
+	end
+
+	it "sets a column comment on add_primary_key" do
+		db.alter_table :foo do
+			add_primary_key :id, :comment => "Identify!"
+		end
+		expect(db.sqls.last).
+		  to eq("COMMENT ON COLUMN \"foo\".\"id\" IS 'Identify!'")
+	end
+
+	it "sets an index comment on composite add_primary_key" do
+		db.alter_table :foo do
+			add_primary_key [:name, :dob], :comment => "Uniquify!"
+		end
+		expect(db.sqls.last).
+		  to eq("COMMENT ON INDEX \"foo_pkey\" IS 'Uniquify!'")
+	end
+
+	it "sets a column comment on add_foreign_key" do
+		db.alter_table :foo do
+			add_foreign_key :bar_id, :bar, :comment => "Over there!"
+		end
+		expect(db.sqls.last).
+		  to eq("COMMENT ON COLUMN \"foo\".\"bar_id\" IS 'Over there!'")
+	end
+
+	it "sets a column comment on add_foreign_key with custom constraint name" do
+		db.alter_table :foo do
+			add_foreign_key :bar_id, :bar, :comment => "Over there!", :name => :fkr
+		end
+		expect(db.sqls.last).
+		  to eq("COMMENT ON COLUMN \"foo\".\"bar_id\" IS 'Over there!'")
+	end
+
+	it "sets a constraint comment on composite add_foreign_key" do
+		db.alter_table :foo do
+			add_foreign_key [:name, :dob], :bar, :comment => "Over there!"
+		end
+		expect(db.sqls.last).
+		  to eq("COMMENT ON CONSTRAINT \"foo_name_fkey\" ON \"foo\" IS 'Over there!'")
+	end
+
+	it "sets a constraint comment on composite add_foreign_key with custom constraint name" do
+		db.alter_table :foo do
+			add_foreign_key [:name, :dob], :bar, :comment => "Over there!", :name => :fkr
+		end
+		expect(db.sqls.last).
+		  to eq("COMMENT ON CONSTRAINT \"fkr\" ON \"foo\" IS 'Over there!'")
+	end
+
+	it "sets an index comment" do
+		db.alter_table :foo do
+			add_index :name, :comment => "Speedy!"
+		end
+		expect(db.sqls.last).
+		  to eq("COMMENT ON INDEX \"foo_name_index\" IS 'Speedy!'")
+	end
+
+	it "sets an index comment with custom name" do
+		db.alter_table :foo do
+			add_index :name, :name => :some_idx, :comment => "Speedify!"
+		end
+		expect(db.sqls.last).
+		  to eq("COMMENT ON INDEX \"some_idx\" IS 'Speedify!'")
+	end
+
+	it "sets an index comment on multi-column index" do
+		db.alter_table :foo do
+			add_index [:name, :dob], :comment => "Speedizer!"
+		end
+		expect(db.sqls.last).
+		  to eq("COMMENT ON INDEX \"foo_name_dob_index\" IS 'Speedizer!'")
+	end
+
+	it "sets an index comment on multi-column index with custom name" do
+		db.alter_table :foo do
+			add_index [:name, :dob], :name => :my_idx, :comment => "Digispeed!"
+		end
+		expect(db.sqls.last).
+		  to eq("COMMENT ON INDEX \"my_idx\" IS 'Digispeed!'")
+	end
+
+	it "sets a constraint comment" do
+		db.alter_table :foo do
+			add_constraint(:min_length, :comment => "Bigger is better!") do
+				char_length(name) > 2
+			end
+		end
+		expect(db.sqls.last).
+		  to eq("COMMENT ON CONSTRAINT \"min_length\" ON \"foo\" IS 'Bigger is better!'")
+	end
+
+	it "sets a unique constraint comment" do
+		db.alter_table :foo do
+			add_unique_constraint [:name, :dob], :comment => "Only one"
+		end
+		expect(db.sqls.last).
+		  to eq("COMMENT ON INDEX \"foo_name_dob_key\" IS 'Only one'")
+	end
+
+	it "sets a unique constraint comment with custom name" do
+		db.alter_table :foo do
+			add_unique_constraint [:name, :dob],
+			                      :comment => "Only one",
+			                      :name => :uniquify
+		end
+		expect(db.sqls.last).
+		  to eq("COMMENT ON INDEX \"uniquify\" IS 'Only one'")
+	end
+end

data/spec/comment_for_spec.rb

@@ -0,0 +1,34 @@
+require_relative 'spec_helper'
+require 'sequel'
+
+describe "#comment_for" do
+	let(:db) do
+		Sequel.connect("mock://postgres").extension(:pg_comment)
+	end
+
+	it "gets a table comment" do
+		db.comment_for(:foo)
+		expect(db.sqls).
+		  to eq(["SELECT obj_description('foo'::regclass, 'pg_class')"])
+	end
+
+	it "gets a column comment" do
+		db.comment_for(:foo__column)
+		expect(db.sqls).
+		  to eq(["SELECT col_description(c.oid, a.attnum) " +
+		          "FROM pg_class c " +
+		          "JOIN pg_attribute a ON (c.oid=a.attrelid) " +
+		          "WHERE c.relname='foo' AND a.attname='column'"
+		       ])
+	end
+
+	it "gets a column comment via the dataset" do
+		db[:foo].comment_for(:column)
+		expect(db.sqls).
+		  to eq(["SELECT col_description(c.oid, a.attnum) " +
+		          "FROM pg_class c " +
+		          "JOIN pg_attribute a ON (c.oid=a.attrelid) " +
+		          "WHERE c.relname='foo' AND a.attname='column'"
+		       ])
+	end
+end

data/spec/comment_on_spec.rb

@@ -0,0 +1,56 @@
+require_relative 'spec_helper'
+require 'sequel'
+
+describe "#comment_on" do
+	let(:db) do
+		Sequel.connect("mock://postgres").extension(:pg_comment)
+	end
+
+	it "sets a table comment" do
+		db.comment_on(:table, :foo, "Ohai!")
+		expect(db.sqls).
+		  to eq(["COMMENT ON TABLE \"foo\" IS 'Ohai!'"])
+	end
+
+	it "accepts a string as object type" do
+		db.comment_on("table", :foo, "Ohai!")
+		expect(db.sqls).
+		  to eq(["COMMENT ON TABLE \"foo\" IS 'Ohai!'"])
+	end
+
+	it "accepts a string as object name" do
+		db.comment_on(:table, "foo", "Ohai!")
+		expect(db.sqls).
+		  to eq(["COMMENT ON TABLE foo IS 'Ohai!'"])
+	end
+
+	it "sets an aggregate comment" do
+		db.comment_on(:aggregate, :foo, "Ohai!")
+		expect(db.sqls).
+		  to eq(["COMMENT ON AGGREGATE \"foo\" IS 'Ohai!'"])
+	end
+
+	it "escapes the comment" do
+		db.comment_on(:table, :foo, "O'hai!")
+		expect(db.sqls).
+		  to eq(["COMMENT ON TABLE \"foo\" IS 'O''hai!'"])
+	end
+
+	it "explodes if an invalid object type is given" do
+		expect do
+			db.comment_on(:foobooblee, :foo, "O'hai!")
+		end.to raise_error(ArgumentError, /invalid object type/i)
+	end
+
+	it "quotes the object name" do
+		db.comment_on(:table, :"foo bar", "Ohai!")
+		expect(db.sqls).
+		  to eq(["COMMENT ON TABLE \"foo bar\" IS 'Ohai!'"])
+	end
+
+	it "sets a column comment correctly" do
+		db.comment_on(:column, :foo__bar_id, "Ohai, column!")
+		expect(db.sqls).
+		  to eq(["COMMENT ON COLUMN \"foo\".\"bar_id\" IS 'Ohai, column!'"])
+	end
+end

data/spec/create_join_table_comment_spec.rb

@@ -0,0 +1,20 @@
+require_relative 'spec_helper'
+require 'sequel'
+
+describe "#create_join_table" do
+	let(:db) do
+		Sequel.connect("mock://postgres").extension(:pg_comment)
+	end
+
+	it "sets a table comment" do
+		db.create_join_table(
+		  {
+		    :category_id => :categories,
+		    :term_id => :terms
+		  },  
+		  :comment => "HABTM FTW!"
+		)
+		expect(db.sqls.last).
+		  to eq("COMMENT ON TABLE categories_terms IS 'HABTM FTW!'")
+	end
+end

data/spec/create_table_comment_spec.rb

@@ -0,0 +1,193 @@
+require_relative 'spec_helper'
+require 'sequel'
+
+describe "schema creation" do
+	let(:db) do
+		Sequel.connect("mock://postgres").extension(:pg_comment)
+	end
+
+	it "sets a table comment" do
+		db.create_table(:foo, :comment => "Ohai!") do
+			String :data
+		end
+
+		expect(db.sqls.last).
+		  to eq("COMMENT ON TABLE \"foo\" IS 'Ohai!'")
+	end
+
+	it "sets a column comment" do
+		db.create_table :foo do
+			String :data, :comment => "Owhatanight"
+		end
+
+		expect(db.sqls.last).
+		  to eq("COMMENT ON COLUMN \"foo\".\"data\" IS 'Owhatanight'")
+	end
+
+	it "sets a table comment on :as query" do
+		db.create_table(
+		  :older_items,
+		  :as => db[:items].where { updated_at < Date.today << 6 },
+		  :comment => "WTF?"
+		)
+		expect(db.sqls.last).
+		  to eq("COMMENT ON TABLE \"older_items\" IS 'WTF?'")
+	end
+
+	it "sets a primary key comment" do
+		db.create_table :foo do
+			primary_key :id, :comment => "I am unique"
+		end
+
+		expect(db.sqls.last).
+		  to eq("COMMENT ON COLUMN \"foo\".\"id\" IS 'I am unique'")
+	end
+
+	it "sets a primary key comment on a custom constraint name" do
+		db.create_table :foo do
+			primary_key :id,
+			            :comment => "I am unique",
+			            :name => :custom_pk
+		end
+
+		expect(db.sqls.last).
+		  to eq("COMMENT ON COLUMN \"foo\".\"id\" IS 'I am unique'")
+	end
+
+	it "sets a composite primary key comment" do
+		db.create_table :foo do
+			primary_key [:bar, :baz],
+			            :comment => "So many things"
+		end
+
+		expect(db.sqls.last).
+		  to eq("COMMENT ON INDEX \"foo_pkey\" IS 'So many things'")
+	end
+
+	it "sets a composite primary key comment with custom constraint name" do
+		db.create_table :foo do
+			primary_key [:bar, :baz],
+			            :comment => "So many things",
+			            :name => :custom_pk
+		end
+
+		expect(db.sqls.last).
+		  to eq("COMMENT ON INDEX \"custom_pk\" IS 'So many things'")
+	end
+
+	it "sets a foreign_key comment" do
+		db.create_table :foo do
+			foreign_key :bar_id, :bar, :comment => "Over there!"
+		end
+		
+		expect(db.sqls.last).
+		  to eq("COMMENT ON COLUMN \"foo\".\"bar_id\" IS 'Over there!'")
+	end
+
+	it "sets a composite foreign_key comment" do
+		db.create_table :foo do
+			foreign_key [:bar_name, :bar_dob], :bar, :comment => "Over there!"
+		end
+		
+		expect(db.sqls.last).
+		  to eq("COMMENT ON CONSTRAINT \"bar_bar_name_fkey\" ON \"foo\" IS 'Over there!'")
+	end
+
+	it "sets a composite foreign_key comment with custom name" do
+		db.create_table :foo do
+			foreign_key [:bar_name, :bar_dob],
+			            :bar,
+			            :comment => "Over there!",
+			            :name    => :fkr
+		end
+		
+		expect(db.sqls.last).
+		  to eq("COMMENT ON CONSTRAINT \"fkr\" ON \"foo\" IS 'Over there!'")
+	end
+
+	it "sets an index comment" do
+		db.create_table :foo do
+			Integer :id
+			index :id, :comment => "Makes it fast"
+		end
+
+		expect(db.sqls.last).
+		  to eq("COMMENT ON INDEX \"foo_id_index\" IS 'Makes it fast'")
+	end
+
+	it "sets an index comment on multiple columns" do
+		db.create_table :foo do
+			Integer :id
+			index [:name, :dob], :comment => "Makes it fast"
+		end
+
+		expect(db.sqls.last).
+		  to eq("COMMENT ON INDEX \"foo_name_dob_index\" IS 'Makes it fast'")
+	end
+
+	it "sets an index comment with custom index name" do
+		db.create_table :foo do
+			Integer :id
+			index :id, :comment => "Makes it fast", :name => :zoom
+		end
+
+		expect(db.sqls.last).
+		  to eq("COMMENT ON INDEX \"zoom\" IS 'Makes it fast'")
+	end
+
+	it "sets a unique index comment" do
+		db.create_table :foo do
+			Integer :id
+			unique :id, :comment => "There can be only one"
+		end
+
+		expect(db.sqls.last).
+		  to eq("COMMENT ON INDEX \"foo_id_key\" IS 'There can be only one'")
+	end
+
+	it "sets a unique index comment on multiple columns" do
+		db.create_table :foo do
+			String :name
+			Date   :dob
+			unique [:name, :dob], :comment => "Going solo"
+		end
+
+		expect(db.sqls.last).
+		  to eq("COMMENT ON INDEX \"foo_name_dob_key\" IS 'Going solo'")
+	end
+
+	it "sets a unique index comment with custom name" do
+		db.create_table :foo do
+			Integer :id
+			unique :id, :comment => "Going solo", :name => :zoom
+		end
+
+		expect(db.sqls.last).
+		  to eq("COMMENT ON INDEX \"zoom\" IS 'Going solo'")
+	end
+
+	it "sets a constraint comment" do
+		db.create_table :foo do
+			constraint :clamp, :num => 1..5, :comment => "Toight"
+		end
+
+		expect(db.sqls.last).
+		  to eq("COMMENT ON CONSTRAINT \"clamp\" ON \"foo\" IS 'Toight'")
+	end
+
+	it "blows up trying to an unnamed constraint comment" do
+		expect do
+			db.create_table :foo do
+				constraint nil, :num => 1..5, :comment => "Kaboom"
+			end
+		end.to raise_error(/not supported/i)
+	end
+
+	it "blows up trying to comment on a check" do
+		expect do
+			db.create_table :foo do
+				check(:comment => "Kaboom") { char_length(name) > 2 }
+			end
+		end.to raise_error(/not supported/i)
+	end
+end