sequel-pg-comment 1.0.0

data/spec/create_view_comment_spec.rb

@@ -0,0 +1,18 @@
+require_relative 'spec_helper'
+require 'sequel'
+
+describe "#create_view" do
+	let(:db) do
+		Sequel.connect("mock://postgres").extension(:pg_comment)
+	end
+
+	it "sets a table comment" do
+		db.create_view(
+		  :gold_albums,
+		  db[:albums].where { copies_sold > 500_000 },
+		  :comment => "Rich!"
+		)
+		expect(db.sqls.last).
+		  to eq("COMMENT ON VIEW \"gold_albums\" IS 'Rich!'")
+	end
+end

data/spec/extension_spec.rb

@@ -0,0 +1,11 @@
+require_relative "spec_helper"
+require 'sequel'
+
+context "pg-comment extension" do
+	it "loads successfully" do
+		expect do
+			Sequel::Database.extension :pg_comment
+			Sequel::Database.connect "mock://postgres"
+		end.to_not raise_error
+	end
+end

data/spec/normalise_comment_spec.rb

@@ -0,0 +1,48 @@
+require_relative 'spec_helper'
+require 'sequel'
+require 'sequel/extensions/pg_comment'
+
+context "Sequel::Extension::PgComment.normalise_comment" do
+	def nc(s)
+		Sequel::Extension::PgComment.normalise_comment(s)
+	end
+
+	it "does nothing to a string with no leading whitespace" do
+		expect(nc("foo\nbar\nbaz")).to eq("foo\nbar\nbaz")
+	end
+
+	it "strips leading empty lines" do
+		expect(nc("\n\n\nfoo\nbar\nbaz")).to eq("foo\nbar\nbaz")
+	end
+
+	it "strips trailing empty lines" do
+		expect(nc("foo\nbar\nbaz\n\n\n")).to eq("foo\nbar\nbaz")
+	end
+
+	it "strips leading whitespace from all lines" do
+		expect(nc("  foo\n  bar\n  baz")).to eq("foo\nbar\nbaz")
+	end
+
+	it "correctly handles intermediate empty lines" do
+		expect(nc("  foo\n  bar\n\n  baz")).to eq("foo\nbar\n\nbaz")
+	end
+
+	it "ignores different leading whitespace" do
+		expect(nc("  foo\n  bar\n\t  baz")).to eq("foo\nbar\n\t  baz")
+	end
+
+	it "partially truncates extra-whitespaced lines" do
+		expect(nc("  foo\n  bar\n    baz")).to eq("foo\nbar\n  baz")
+	end
+
+	it "handles everything at once" do
+		expect(nc(<<-EOF)).to eq("foo\n\t  bar\n  baz")
+
+			foo
+				  bar
+			  baz
+
+
+		EOF
+	end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+require 'spork'
+
+Spork.prefork do
+	require 'bundler'
+	Bundler.setup(:default, :test)
+	require 'rspec/core'
+	require 'rspec/mocks'
+
+	require 'pry'
+
+	RSpec.configure do |config|
+		config.fail_fast = true
+#		config.full_backtrace = true
+
+		config.expect_with :rspec do |c|
+			c.syntax = :expect
+		end
+	end
+end
+
+Spork.each_run do
+	# Nothing to do here, specs will load the files they need
+end

data/spec/sql_generator_spec.rb

@@ -0,0 +1,96 @@
+require_relative 'spec_helper'
+
+require 'sequel'
+require 'sequel/extensions/pg_comment'
+
+describe "SqlGenerator" do
+	SqlGenerator = Sequel::Extension::PgComment::SqlGenerator
+	PrefixSqlGenerator = Sequel::Extension::PgComment::PrefixSqlGenerator
+
+	context "a simple type expressed as a string" do
+		let(:generator) { SqlGenerator.create("TABLE", :foo, "Ohai!") }
+
+		it "generates quoted SQL" do
+			expect(generator.generate).
+			  to eq("COMMENT ON TABLE \"foo\" IS 'Ohai!'")
+		end
+	end
+
+	context "a simple type expressed as a crazy-case string" do
+		let(:generator) { SqlGenerator.create("TaBlE", :foo, "Ohai!") }
+
+		it "generates quoted SQL" do
+			expect(generator.generate).
+			  to eq("COMMENT ON TABLE \"foo\" IS 'Ohai!'")
+		end
+	end
+
+	context "a simple type expressed as a symbol" do
+		let(:generator) { SqlGenerator.create(:table, :foo, "Ohai!") }
+
+		it "generates quoted SQL" do
+			expect(generator.generate).
+			  to eq("COMMENT ON TABLE \"foo\" IS 'Ohai!'")
+		end
+	end
+
+	context "a multi-word type expressed as a symbol" do
+		let(:generator) { SqlGenerator.create(:event_trigger, :foo, "Ohai!") }
+
+		it "generates correct SQL" do
+			expect(generator.generate).
+			  to eq("COMMENT ON EVENT TRIGGER \"foo\" IS 'Ohai!'")
+		end
+	end
+
+	context "with a string as the object name" do
+		let(:generator) { SqlGenerator.create(:table, "foo", "Ohai!") }
+
+		it "generates unquoted SQL" do
+			expect(generator.generate).
+			  to eq("COMMENT ON TABLE foo IS 'Ohai!'")
+		end
+	end
+		
+	it "escapes the comment" do
+		expect(SqlGenerator.create(:table, :foo, "O'hai!").generate).
+		  to eq("COMMENT ON TABLE \"foo\" IS 'O''hai!'")
+	end
+
+	it "explodes if an invalid object type is given" do
+		expect do
+			SqlGenerator.create(:foobooblee, :foo, "O'hai!")
+		end.to raise_error(ArgumentError, /unrecognised object type/i)
+	end
+
+	it "sets a column comment correctly" do
+		expect(SqlGenerator.create(:column, :foo__bar_id, "Ohai, column!").generate).
+		  to eq("COMMENT ON COLUMN \"foo\".\"bar_id\" IS 'Ohai, column!'")
+	end
+
+	it "sets a constraint comment correctly" do
+		g = SqlGenerator.create(:constraint, :foo__not_for_you, "Ohai, constraint!")
+		expect(g.generate).
+		  to eq("COMMENT ON CONSTRAINT \"not_for_you\" ON \"foo\" IS 'Ohai, constraint!'")
+	end
+
+	it "sets a rule comment correctly" do
+		g = SqlGenerator.create(:rule, :foo__not_for_you, "Ohai, rule!")
+		expect(g.generate).
+		  to eq("COMMENT ON RULE \"not_for_you\" ON \"foo\" IS 'Ohai, rule!'")
+	end
+
+	it "sets a trigger comment correctly" do
+		g = SqlGenerator.create(:trigger, :foo__spoing, "Ohai, trigger!")
+		expect(g.generate).
+		  to eq("COMMENT ON TRIGGER \"spoing\" ON \"foo\" IS 'Ohai, trigger!'")
+	end
+
+	it "sets a comment on a prefixed name correctly" do
+		g = PrefixSqlGenerator.new(:index, :_pkey, "Ohai, pkey!")
+		g.table_name = :foo
+
+		expect(g.generate).
+		  to eq("COMMENT ON INDEX \"foo_pkey\" IS 'Ohai, pkey!'")
+	end
+end

metadata

@@ -0,0 +1,242 @@
+--- !ruby/object:Gem::Specification
+name: sequel-pg-comment
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Matt Palmer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: git-version-bump
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: github-release
+  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: guard-spork
+  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: guard-rspec
+  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: rb-inotify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  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
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  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'
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- ".gitignore"
+- ".yardopts"
+- Gemfile
+- Guardfile
+- LICENCE
+- README.md
+- Rakefile
+- lib/sequel/extensions/pg_comment.rb
+- lib/sequel/extensions/pg_comment/alter_table_generator_methods.rb
+- lib/sequel/extensions/pg_comment/create_table_generator_methods.rb
+- lib/sequel/extensions/pg_comment/database_methods.rb
+- lib/sequel/extensions/pg_comment/dataset_methods.rb
+- lib/sequel/extensions/pg_comment/sql_generator.rb
+- sequel-pg-comment.gemspec
+- spec/alter_table_comment_spec.rb
+- spec/comment_for_spec.rb
+- spec/comment_on_spec.rb
+- spec/create_join_table_comment_spec.rb
+- spec/create_table_comment_spec.rb
+- spec/create_view_comment_spec.rb
+- spec/extension_spec.rb
+- spec/normalise_comment_spec.rb
+- spec/spec_helper.rb
+- spec/sql_generator_spec.rb
+homepage: http://theshed.hezmatt.org/sequel-pg-comment
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Set comments on PgSQL objects from seuqel migrations
+test_files: []
+has_rdoc: