sequel-annotate 1.3.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6bc04d174477ed481ef99f6d4173ed4ad691f55d4283c42cb971b8a32772bb41
-  data.tar.gz: d8bfaa715162f40446c079e91dfa32555e18200578dce2f1ad218580157c8ca3
+  metadata.gz: 00ae8faeab78d5bf3db91c08be72e190c23c5937aff9a134b0f60d8a8a28fd46
+  data.tar.gz: 3324fec486219f6324ff300046ee1f80608c84621f3eb159e5192a0e7f42bdbf
 SHA512:
-  metadata.gz: c45070f85dd3dd1acf89946a18463dd7f2245adb2881888b145c93b54dec5b294235adc603a1033ddb6ba2a611d198694d152950f8626a8f101a846c1977e8d8
-  data.tar.gz: 574cee166afd77a7a9353fbeb3ebd4bbbaf2afeb4055265f0371c67218676596594ee316758e4cda2641f7da51a923d271ecfab64c429baf65f583a2ac3301cc
+  metadata.gz: 898b3c06f2728c69570071f04b14b506925d87e794b63fdbe0882bc710e03fc76c6c824f0c01384f96e19b1ee59894766722fa4bb12c668068794d632c3651c7
+  data.tar.gz: 0ac394e89f13a0d8f005b90ff7263fe882ce67aca63f9d19b7327d0561eb7666df04cb6e4031a01ad6f318c87372b7d59ae9aba39b38e0ffed870036ad1ff035

data/CHANGELOG

@@ -1,3 +1,9 @@
+=== 1.4.0 (2018-11-15)
+
+* Support adding borders to the beginning and end of comments via :border option (kreynolds) (#9)
+
+* Support excluding indexes, constraints, and triggers from annotation via options (kreynolds) (#9)
+
 === 1.3.1 (2018-09-27)
 
 * Make sure all annotation lines are commented by handling newlines inside annotations (jeremyevans)

data/README.rdoc

@@ -83,6 +83,15 @@ Then you can use the +:namespace+ option to set the namespace to use:
 
   Sequel::Annotate.annotate(Dir['models/*.rb'], namespace: 'ModelNamespace')
 
+For PostgreSQL, you can optionally leave out indexes, foreign_keys, references,
+triggers, and constraints by passing in false as a parameter as follows:
+
+  Sequel::Annotate.annotate(Dir['models/*.rb'], foreign_keys: false, :indexes: false, constraints: false)
+
+The columns section can have a border on the top and bottom for easier visual distinction by setting the :border option to true
+
+  Sequel::Annotate.annotate(Dir['models/*.rb'], border: true)
+
 === Rake Task
 
 Here's an example rake task for sequel-annotate:

data/lib/sequel/annotate.rb

@@ -41,7 +41,7 @@ module Sequel
 
       if options[:position] == :before
         current = current.gsub(/\A#\sTable[^\n\r]+\r?\n(?:#[^\n\r]*\r?\n)*/m, '').lstrip
-        current = "#{schema_comment}#{$/}#{$/}#{current}"
+        current = "#{schema_comment(options)}#{$/}#{$/}#{current}"
       else
         if m = current.reverse.match(/#{"#{$/}# Table: ".reverse}/m)
           offset = current.length - m.end(0) + 1
@@ -52,7 +52,7 @@ module Sequel
             current = current[0...offset].rstrip
           end
         end
-        current += "#{$/}#{$/}#{schema_comment}"
+        current += "#{$/}#{$/}#{schema_comment(options)}"
       end
 
       if orig != current
@@ -67,17 +67,36 @@ module Sequel
     # key constraints in this table referencing other tables.
     # On PostgreSQL, also includes check constraints, triggers,
     # and foreign key constraints in other tables referencing this table.
-    def schema_comment
+    #
+    # Options:
+    # :border :: Include a border above and below the comment.
+    # :indexes :: Do not include indexes in annotation if set to +false+.
+    # :foreign_keys :: Do not include foreign key constraints in annotation if set to +false+.
+    #
+    # PostgreSQL-specific options:
+    # :constraints :: Do not include check constraints if set to +false+.
+    # :references :: Do not include foreign key constraints in other tables referencing
+    #                this table if set to +false+.
+    # :triggers :: Do not include triggers in annotation if set to +false+.
+    def schema_comment(options = {})
       output = []
       output << "# Table: #{model.table_name}"
 
       meth = :"_schema_comment_#{model.db.database_type}"
       if respond_to?(meth, true)
-        send(meth, output)
+        send(meth, output, options)
       else
         schema_comment_columns(output)
-        schema_comment_indexes(output)
-        schema_comment_foreign_keys(output)
+        schema_comment_indexes(output) unless options[:indexes] == false
+        schema_comment_foreign_keys(output) unless options[:foreign_keys] == false
+      end
+
+
+      # Add beginning and end to the table if specified
+      if options[:border]
+        border = "# #{'-' * (output.map(&:size).max - 2)}"
+        output.push(border)
+        output.insert(1, border)
       end
 
       output.join($/)
@@ -107,87 +126,97 @@ module Sequel
 
     # Use the standard columns schema output, but use PostgreSQL specific
     # code for additional schema information.
-    def _schema_comment_postgres(output)
-      schema_comment_columns(output)
+    def _schema_comment_postgres(output, options = {})
+      schema_comment_columns(output, options)
       oid = model.db.send(:regclass_oid, model.table_name)
 
       # These queries below are all based on the queries that psql
       # uses, captured using the -E option to psql.
 
-      rows = model.db.fetch(<<SQL, :oid=>oid).all
+      unless options[:indexes] == false
+        rows = model.db.fetch(<<SQL, :oid=>oid).all
 SELECT c2.relname, i.indisprimary, i.indisunique, pg_catalog.pg_get_indexdef(i.indexrelid, 0, true)
 FROM pg_catalog.pg_class c, pg_catalog.pg_class c2, pg_catalog.pg_index i
   LEFT JOIN pg_catalog.pg_constraint con ON (conrelid = i.indrelid AND conindid = i.indexrelid AND contype IN ('p','u','x'))
 WHERE c.oid = :oid AND c.oid = i.indrelid AND i.indexrelid = c2.oid AND indisvalid
 ORDER BY i.indisprimary DESC, i.indisunique DESC, c2.relname;
 SQL
-      unless rows.empty?
-        output << "# Indexes:"
-        rows = rows.map do |r|
-          [r[:relname], "#{"PRIMARY KEY " if r[:indisprimary]}#{"UNIQUE " if r[:indisunique] && !r[:indisprimary]}#{r[:pg_get_indexdef].match(/USING (.+)\z/m)[1]}"]
+        unless rows.empty?
+          output << "# Indexes:"
+          rows = rows.map do |r|
+            [r[:relname], "#{"PRIMARY KEY " if r[:indisprimary]}#{"UNIQUE " if r[:indisunique] && !r[:indisprimary]}#{r[:pg_get_indexdef].match(/USING (.+)\z/m)[1]}"]
+          end
+          output.concat(align(rows))
         end
-        output.concat(align(rows))
       end
 
-      rows = model.db.fetch(<<SQL, :oid=>oid).all
+      unless options[:constraints] == false
+        rows = model.db.fetch(<<SQL, :oid=>oid).all
 SELECT r.conname, pg_catalog.pg_get_constraintdef(r.oid, true)
 FROM pg_catalog.pg_constraint r
 WHERE r.conrelid = :oid AND r.contype = 'c'
 ORDER BY 1;
 SQL
-      unless rows.empty?
-        output << "# Check constraints:"
-        rows = rows.map do |r|
-          [r[:conname], r[:pg_get_constraintdef].match(/CHECK (.+)\z/m)[1]]
+        unless rows.empty?
+          output << "# Check constraints:"
+          rows = rows.map do |r|
+            [r[:conname], r[:pg_get_constraintdef].match(/CHECK (.+)\z/m)[1]]
+          end
+          output.concat(align(rows))
         end
-        output.concat(align(rows))
       end
 
-      rows = model.db.fetch(<<SQL, :oid=>oid).all
+      unless options[:foreign_keys] == false
+        rows = model.db.fetch(<<SQL, :oid=>oid).all
 SELECT conname,
   pg_catalog.pg_get_constraintdef(r.oid, true) as condef
 FROM pg_catalog.pg_constraint r
 WHERE r.conrelid = :oid AND r.contype = 'f' ORDER BY 1;
 SQL
-      unless rows.empty?
-        output << "# Foreign key constraints:"
-        rows = rows.map do |r|
-          [r[:conname], r[:condef].match(/FOREIGN KEY (.+)\z/m)[1]]
+        unless rows.empty?
+          output << "# Foreign key constraints:"
+          rows = rows.map do |r|
+            [r[:conname], r[:condef].match(/FOREIGN KEY (.+)\z/m)[1]]
+          end
+          output.concat(align(rows))
         end
-        output.concat(align(rows))
       end
 
-      rows = model.db.fetch(<<SQL, :oid=>oid).all
+      unless options[:references] == false
+        rows = model.db.fetch(<<SQL, :oid=>oid).all
 SELECT conname, conrelid::pg_catalog.regclass,
   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;
 SQL
-      unless rows.empty?
-        output << "# Referenced By:"
-        rows = rows.map do |r|
-          [r[:conrelid], r[:conname], r[:condef].match(/FOREIGN KEY (.+)\z/m)[1]]
+        unless rows.empty?
+          output << "# Referenced By:"
+          rows = rows.map do |r|
+            [r[:conrelid], r[:conname], r[:condef].match(/FOREIGN KEY (.+)\z/m)[1]]
+          end
+          output.concat(align(rows))
         end
-        output.concat(align(rows))
       end
 
-      rows = model.db.fetch(<<SQL, :oid=>oid).all
+      unless options[:triggers] == false
+        rows = model.db.fetch(<<SQL, :oid=>oid).all
 SELECT t.tgname, pg_catalog.pg_get_triggerdef(t.oid, true), t.tgenabled, t.tgisinternal
 FROM pg_catalog.pg_trigger t
 WHERE t.tgrelid = :oid AND (NOT t.tgisinternal OR (t.tgisinternal AND t.tgenabled = 'D'))
 ORDER BY 1;
 SQL
-      unless rows.empty?
-        output << "# Triggers:"
-        rows = rows.map do |r|
-          [r[:tgname], r[:pg_get_triggerdef].match(/((?:BEFORE|AFTER) .+)\z/m)[1]]
+        unless rows.empty?
+          output << "# Triggers:"
+          rows = rows.map do |r|
+            [r[:tgname], r[:pg_get_triggerdef].match(/((?:BEFORE|AFTER) .+)\z/m)[1]]
+          end
+          output.concat(align(rows))
         end
-        output.concat(align(rows))
       end
     end
 
     # The standard column schema information to output.
-    def schema_comment_columns(output)
+    def schema_comment_columns(output, options = {})
       if cpk = model.primary_key.is_a?(Array)
         output << "# Primary Key: (#{model.primary_key.join(', ')})"
       end

data/spec/sequel-annotate_spec.rb

@@ -107,6 +107,46 @@ describe Sequel::Annotate do
     Dir['spec/tmp/*.rb'].each{|f| File.delete(f)}
   end
 
+  it "#schema_info should not return sections we set to false" do
+    Sequel::Annotate.new(Item).schema_comment(:indexes => false, :constraints => false, :foreign_keys => false, :triggers => false).must_equal(fix_pg_comment((<<OUTPUT).chomp))
+# Table: items
+# Columns:
+#  id                    | integer               | PRIMARY KEY DEFAULT nextval('items_id_seq'::regclass)
+#  category_id           | integer               | NOT NULL
+#  manufacturer_name     | character varying(50) |
+#  manufacturer_location | text                  |
+#  in_stock              | boolean               | DEFAULT false
+#  name                  | text                  | DEFAULT 'John'::text
+#  price                 | double precision      | DEFAULT 0
+OUTPUT
+
+    Sequel::Annotate.new(Category).schema_comment(:references => false).must_equal(fix_pg_comment((<<OUTPUT).chomp))
+# Table: categories
+# Columns:
+#  id   | integer | PRIMARY KEY DEFAULT nextval('categories_id_seq'::regclass)
+#  name | text    | NOT NULL
+# Indexes:
+#  categories_pkey     | PRIMARY KEY btree (id)
+#  categories_name_key | UNIQUE btree (name)
+OUTPUT
+  end
+
+  it "#schema_info should return a border if we want one" do
+    Sequel::Annotate.new(Item).schema_comment(:border => true, :indexes => false, :constraints => false, :foreign_keys => false, :triggers => false).gsub(/----+/, '---').must_equal(fix_pg_comment((<<OUTPUT).chomp))
+# Table: items
+# ---
+# Columns:
+#  id                    | integer               | PRIMARY KEY DEFAULT nextval('items_id_seq'::regclass)
+#  category_id           | integer               | NOT NULL
+#  manufacturer_name     | character varying(50) |
+#  manufacturer_location | text                  |
+#  in_stock              | boolean               | DEFAULT false
+#  name                  | text                  | DEFAULT 'John'::text
+#  price                 | double precision      | DEFAULT 0
+# ---
+OUTPUT
+  end
+
   it "#schema_info should return the model schema comment" do
     Sequel::Annotate.new(Item).schema_comment.must_equal(fix_pg_comment((<<OUTPUT).chomp))
 # Table: items
@@ -238,5 +278,8 @@ OUTPUT
     FileUtils.cp('spec/namespaced/itm_unannotated.rb', 'spec/tmp/')
     Sequel::Annotate.annotate(["spec/tmp/itm_unannotated.rb"], :namespace=>'ModelNamespace')
     File.read("spec/tmp/itm_unannotated.rb").must_equal fix_pg_comment(File.read('spec/namespaced/itm_annotated.rb'))
+    Sequel::Annotate.annotate(["spec/tmp/itm_unannotated.rb"], :namespace=>'ModelNamespace', :border=>true)
+    Sequel::Annotate.annotate(["spec/tmp/itm_unannotated.rb"], :namespace=>'ModelNamespace')
+    File.read("spec/tmp/itm_unannotated.rb").must_equal fix_pg_comment(File.read('spec/namespaced/itm_annotated.rb'))
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sequel-annotate
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.0
 platform: ruby
 authors:
 - Jeremy Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-27 00:00:00.000000000 Z
+date: 2018-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sequel