sequel-annotate 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42122bfc730bb5345c90160c5a17b0861c3a5a8308dfc6a008c1fccc0b73fe3e
-  data.tar.gz: 7bbb33c84261d97a66c17b942c19fc0b432d4029b8e384f148ec79ddf96c196e
+  metadata.gz: 1af766f00a25bee67411ffb02da42718bfca2a4f6da4054470916559f03af2fd
+  data.tar.gz: 798ae4e7a20c53d3114358aff783ce97f2ad43f4ee66044b1df3f6ebcafa5b33
 SHA512:
-  metadata.gz: 4ee1e34b6317be4e57f113a33e47c83190157ee3cbbae9cfd209c8806895aacc5e44604bbf2f0cfcbee1114a8822ed0c36a9ccdad628cb66daab58873d9020b8
-  data.tar.gz: d27e5074fb1c7642993647185605d0d714482d1f9ce5bc9e7b58817872f69674d0e803fa68210d0d73b2c176a479a44224a3678c602b1681116acae8dbf16d8c
+  metadata.gz: a1bb2645eaf30455d1a55eaf79cd50d7410544d5de75db501ba5d62523d2de8b0d12464291b887fd7c0b7a34adf3622231c6ca81e2ad70f23ae1a923773ccfd8
+  data.tar.gz: b57d33307b4295bf3a120d162ea1850cf008092ca21e16127e2cf07874d49dc35df18b44b57512aaea9ac6255ce694ba3cdd3004a3dde90282fc7c6b69b39fe3

data/CHANGELOG

@@ -1,3 +1,7 @@
+=== 1.7.0 (2021-05-20)
+
+* Add support for table comments on PostgreSQL (TSMMark) (#21)
+
 === 1.6.0 (2020-10-05)
 
 * Add support for :namespace=>true option to attempt to automatically determine namespace (adam12) (#20)

data/Rakefile

@@ -17,6 +17,17 @@ end
 
 task :default => :spec
 
+desc "Run specs in CI"
+task :spec_ci do
+  ENV['SEQUEL_ANNOTATE_SPEC_CI'] = '1'
+  if defined?(RUBY_ENGINE) && RUBY_ENGINE == 'jruby'
+    ENV['SEQUEL_ANNOTATE_SPEC_POSTGRES_URL'] = "jdbc:postgresql://localhost/?user=postgres"
+  else
+    ENV['SEQUEL_ANNOTATE_SPEC_POSTGRES_URL'] = "postgres://localhost/?user=postgres"
+  end
+  Rake::Task['spec'].invoke
+end
+
 ### RDoc
 
 RDOC_DEFAULT_OPTS = ["--quiet", "--line-numbers", "--inline-source", '--title', 'sequel-annotate: Annotate Sequel models with schema information']

data/lib/sequel/annotate.rb

@@ -147,6 +147,7 @@ module Sequel
     # Use the standard columns schema output, but use PostgreSQL specific
     # code for additional schema information.
     def _schema_comment_postgres(output, options = {})
+      _table_comment_postgres(output, options)
       schema_comment_columns(output, options)
       oid = model.db.send(:regclass_oid, model.table_name)
 
@@ -204,7 +205,7 @@ SQL
 
       unless options[:references] == false
         rows = model.db.fetch(<<SQL, :oid=>oid).all
-SELECT conname, conrelid::pg_catalog.regclass,
+SELECT conname, conrelid::pg_catalog.regclass::text,
   pg_catalog.pg_get_constraintdef(c.oid, true) as condef
 FROM pg_catalog.pg_constraint c
 WHERE c.confrelid = :oid AND c.contype = 'f' ORDER BY 2, 1;
@@ -244,6 +245,18 @@ WHERE d.objoid = :oid AND COALESCE(d.description, '') != '';
 SQL
     end
 
+    def _table_comment_postgres(output, options = {})
+      return if options[:comments] == false
+
+      if table_comment = model.db.fetch(<<SQL, :oid=>model.db.send(:regclass_oid, model.table_name)).single_value
+SELECT obj_description(CAST(:oid AS regclass), 'pg_class') AS "comment" LIMIT 1;
+SQL
+        text = align([["Comment: #{table_comment}"]])
+        text[0][1] = ''
+        output.concat(text)
+      end
+    end
+
     # The standard column schema information to output.
     def schema_comment_columns(output, options = {})
       if cpk = model.primary_key.is_a?(Array)

data/spec/sequel-annotate_spec.rb

@@ -7,7 +7,9 @@ gem 'minitest'
 require 'minitest/global_expectations/autorun'
 
 DB = Sequel.connect(ENV['SEQUEL_ANNOTATE_SPEC_POSTGRES_URL'] || 'postgres:///sequel_annotate_test?user=sequel_annotate&password=sequel_annotate')
-raise "test database name doesn't end with test" unless DB.get{current_database.function} =~ /test\z/
+unless ENV['SEQUEL_ANNOTATE_SPEC_CI'] == '1' || DB.get{current_database.function} =~ /test\z/
+  raise "test database name doesn't end with test"
+end
 if defined?(JRUBY_VERSION)
   SDB = Sequel.connect('jdbc:sqlite::memory:')
 else
@@ -83,6 +85,7 @@ DB.create_table :comment_tests do
 end
 
 DB.run "COMMENT ON COLUMN comment_tests.name IS 'name column comment'"
+DB.run "COMMENT ON TABLE comment_tests IS 'comment_tests table comment'"
 
 Minitest.after_run do
   DB.drop_table(:items, :manufacturers, :categories, :domain_tests, :comment_tests)
@@ -301,6 +304,7 @@ OUTPUT
 
     Sequel::Annotate.new(CommentTest).schema_comment.must_equal(fix_pg_comment((<<OUTPUT).chomp))
 # Table: comment_tests
+# Comment: comment_tests table comment
 # Columns:
 #  id   | integer | PRIMARY KEY GENERATED BY DEFAULT AS IDENTITY |
 #  name | text    |                                              | name column comment

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sequel-annotate
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Jeremy Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-05 00:00:00.000000000 Z
+date: 2021-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sequel
@@ -171,7 +171,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.15
 signing_key: 
 specification_version: 4
 summary: Annotate Sequel models with schema information