pg_examiner 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 81a303d82801100e755a80fbf08ac0b6b9d0f254
-  data.tar.gz: 0dc95a111058c548e1281a1b0694d0d97d170537
+  metadata.gz: 5643afd2534a1e85ecb2508240f121250c781287
+  data.tar.gz: cc9c1a56805634ea8d72b0ab2225b3d48fae0c21
 SHA512:
-  metadata.gz: bcace5f639bc93c559f2ae2ab802f741a858c0a79d5071a3ba94d88b06cd26cc9f2ce3f4816d2ab6a4c3450408a706ae2b11c64821ba5fe39543be26a247c8dd
-  data.tar.gz: 0606ea636a20e128179ec6ee679ec0b6e9445a2cf4e5ca620095f3fc52a9f3a57dd7d4c44bf69d949f87c57f67555f8e2b5a010cad532c8e83ca5cebce02a65f
+  metadata.gz: 8b7898f913fef164ab2b0394efb15890a3bfcd3bd2c7f56cdc588a7ae1e8b18445c90eb0d548ea71c95b410b4b0041435bd864ca53b59a81d294c12d06658884
+  data.tar.gz: 651a2956ad12e1355875dee49a59cbaa75076ce6f087ff11fddcb316f74a753bdf9bfc35075fba7e8a9017069b763298dc2e8c329b2f3371ff0f92c69ea306f2

data/README.md

@@ -2,22 +2,21 @@
 
 A tool for comparing PG database structures. Use it to ensure that downward migrations precisely undo upward ones, or that different sets of migrations produce the same schema, or that different schemas in a multitenanted database all have the same structure.
 
-PGExaminer tries to be sensible about equivalency. For example, it will understand that two tables are equivalent if they have the same name, column names, column types, triggers, constraints, and indices. It won't care about the contents of the tables. It will care about the order the columns are in, but will ignore columns that have been dropped.
+PGExaminer tries to be sensible about equivalency. For example, it will understand that two tables are equivalent if they have the same name, column names/types, triggers, constraints, and indices. It won't care about the contents of the tables, or the order in which the columns were declared.
 
 PGExaminer is NOT exhaustive. It currently doesn't have tests for its understanding of:
 
-1. Aggregate functions
-2. Column TOAST settings
-3. Sequences
-4. Views
-5. User-defined types or enums
-6. Object COMMENTs
-7. Materialized views
-8. Constraint deferral states
-9. Exclusion constraints
-10. Inheritance structures
-11. User-defined objects in the system (pg_*) schemas or information_schema.
-12. ...Probably some other stuff.
+* Aggregate functions.
+* Column TOAST settings.
+* Sequences.
+* Views.
+* User-defined types or enums.
+* Object COMMENTs.
+* Materialized views.
+* Exclusion constraints.
+* Inheritance structures.
+* User-defined objects in the system (pg_*) schemas or information_schema.
+* ...Probably some other stuff.
 
 It may or may not understand these objects. If you're using one of these, or another Postgres feature that may be considered obscure, please test it out first. I'll be happy to add support for more objects if there's demand.
 

data/Rakefile

@@ -1,2 +1,7 @@
 require 'bundler/gem_tasks'
 
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new :default do |spec|
+  spec.pattern = './spec/**/*_spec.rb'
+end

data/lib/pg_examiner.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pg_examiner/result'
 require 'pg_examiner/version'
 

data/lib/pg_examiner/base.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module PGExaminer
   class Base
-    def diffable_lists
-      []
+    def diffable_attrs
+      {}
     end
 
-    def diffable_attrs
+    def diffable_lists
       []
     end
 
@@ -17,25 +19,25 @@ module PGExaminer
 
       r = {}
 
-      diffable_attrs.each do |attr|
-        this = @row.fetch(attr.to_s)
-        that = other.row.fetch(attr.to_s)
+      diffable_attrs.each do |attr, description|
+        this = @row.fetch(attr)
+        that = other.row.fetch(attr)
 
         unless this == that
-          r[attr] = {this => that}
+          r[description] = {this => that}
         end
       end
 
-      diffable_methods.each do |attr|
+      diffable_methods.each do |attr, description|
         this = send(attr)
         that = other.send(attr)
 
         unless this == that
-          r[attr] = {this => that}
+          r[description] = {this => that}
         end
       end
 
-      diffable_lists.each do |attr|
+      diffable_lists.each do |attr, description|
         these = send(attr)
         those = other.send(attr)
         these_names = these.map(&:name)
@@ -49,16 +51,16 @@ module PGExaminer
           end
 
           if result.any?
-            r[attr] = result
+            r[description] = result
           end
         else
           added   = those_names - these_names
           removed = these_names - those_names
 
           h = {}
-          h[:added]   = added   if added.any?
-          h[:removed] = removed if removed.any?
-          r[attr] = h
+          h['added']   = added   if added.any?
+          h['removed'] = removed if removed.any?
+          r[description] = h
         end
       end
 

data/lib/pg_examiner/result.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pg_examiner/base'
 
 module PGExaminer
@@ -20,7 +22,11 @@ module PGExaminer
     end
 
     def diffable_lists
-      [:schemas, :extensions, :languages]
+      {
+        "schemas"    => "schemas",
+        "extensions" => "extensions",
+        "languages"  => "languages",
+      }
     end
 
     def schemas
@@ -96,7 +102,7 @@ module PGExaminer
         SELECT oid, tgname AS name, tgrelid, tgtype, tgfoid
         FROM pg_trigger
         WHERE tgrelid IN (?)
-        AND tgconstrrelid = '0' -- Ignore foreign key triggers, which have unpredictable names.
+        AND NOT tgisinternal -- Ignore foreign key and unique index triggers, which have unpredictable names.
       SQL
 
       @pg_attrdef = execute <<-SQL
@@ -140,5 +146,6 @@ require 'pg_examiner/result/function'
 require 'pg_examiner/result/index'
 require 'pg_examiner/result/language'
 require 'pg_examiner/result/schema'
+require 'pg_examiner/result/sequence'
 require 'pg_examiner/result/table'
 require 'pg_examiner/result/trigger'

data/lib/pg_examiner/result/column.rb

@@ -1,12 +1,22 @@
+# frozen_string_literal: true
+
 module PGExaminer
   class Result
     class Column < Item
       def diffable_methods
-        [:type, :default]
+        {
+          "type"    => "type",
+          "default" => "default"
+        }
       end
 
       def diffable_attrs
-        [:name, :attndims, :attnotnull, :atttypmod]
+        {
+          'name'       => "name",
+          'attndims'   => "array dimensionality",
+          'attnotnull' => "column is marked not-null",
+          'atttypmod'  => "datatype information (atttypmod)",
+        }
       end
 
       def type

data/lib/pg_examiner/result/constraint.rb

@@ -1,8 +1,13 @@
+# frozen_string_literal: true
+
 module PGExaminer
   class Result
     class Constraint < Item
       def diffable_attrs
-        [:name, :definition]
+        {
+          "name"       => "name",
+          "definition" => "constraint definition",
+        }
       end
     end
   end

data/lib/pg_examiner/result/extension.rb

@@ -1,12 +1,19 @@
+# frozen_string_literal: true
+
 module PGExaminer
   class Result
     class Extension < Item
       def diffable_attrs
-        [:name, :extversion]
+        {
+          "name"       => "name",
+          "extversion" => "extension version",
+        }
       end
 
       def diffable_methods
-        [:schema_name]
+        {
+          "schema_name" => "schema name"
+        }
       end
 
       def schema

data/lib/pg_examiner/result/function.rb

@@ -1,12 +1,22 @@
+# frozen_string_literal: true
+
 module PGExaminer
   class Result
     class Function < Item
       def diffable_attrs
-        [:name, :proargmodes, :definition]
+        {
+          "name"        => "name",
+          "proargmodes" => "argument modes",
+          "definition"  => "function definition",
+        }
       end
 
       def diffable_methods
-        [:argument_types, :return_type, :language]
+        {
+          "argument_types" => "argument types",
+          "return_type"    => "return type",
+          "language"       => "language",
+        }
       end
 
       def argument_types

data/lib/pg_examiner/result/index.rb

@@ -1,12 +1,21 @@
+# frozen_string_literal: true
+
 module PGExaminer
   class Result
     class Index < Item
       def diffable_attrs
-        [:name, :filter, :indisunique, :indisprimary]
+        {
+          "name"         => "name",
+          "filter"       => "filter expression",
+          "indisunique"  => "index is unique",
+          "indisprimary" => "index is primary key",
+        }
       end
 
       def diffable_methods
-        [:expression]
+        {
+          "expression" => "expression"
+        }
       end
 
       def expression

data/lib/pg_examiner/result/item.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PGExaminer
   class Result
     class Item < Base

data/lib/pg_examiner/result/language.rb

@@ -1,8 +1,12 @@
+# frozen_string_literal: true
+
 module PGExaminer
   class Result
     class Language < Item
       def diffable_attrs
-        [:name]
+        {
+          "name" => "name"
+        }
       end
     end
   end

data/lib/pg_examiner/result/schema.rb

@@ -1,8 +1,14 @@
+# frozen_string_literal: true
+
 module PGExaminer
   class Result
     class Schema < Item
       def diffable_lists
-        [:tables, :functions]
+        {
+          "tables"    => "tables",
+          "sequences" => "sequences",
+          "functions" => "functions",
+        }
       end
 
       def tables
@@ -11,6 +17,12 @@ module PGExaminer
         end.map{|row| Table.new(result, row, self)}.sort_by(&:name)
       end
 
+      def sequences
+        @sequences ||= result.pg_class.select do |c|
+          c['relnamespace'] == oid && c['relkind'] == 'S'
+        end.map{|row| Sequence.new(result, row, self)}.sort_by(&:name)
+      end
+
       def functions
         @functions ||= result.pg_proc.select do |c|
           c['pronamespace'] == oid

data/lib/pg_examiner/result/sequence.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module PGExaminer
+  class Result
+    class Sequence < Item
+      def diffable_lists
+        {}
+      end
+
+      def diffable_attrs
+        {}
+      end
+    end
+  end
+end

data/lib/pg_examiner/result/table.rb

@@ -1,18 +1,29 @@
+# frozen_string_literal: true
+
 module PGExaminer
   class Result
     class Table < Item
       def diffable_lists
-        [:columns, :indexes, :constraints, :triggers]
+        {
+          "columns"     => "columns",
+          "indexes"     => "indexes",
+          "constraints" => "constraints",
+          "triggers"    => "triggers",
+        }
       end
 
       def diffable_attrs
-        [:name, :relpersistence, :reloptions]
+        {
+          "name"           => "name",
+          "relpersistence" => "table type (relpersistence)",
+          "reloptions"     => "table options",
+        }
       end
 
       def columns
         @columns ||= result.pg_attribute.select do |c|
           c['attrelid'] == oid
-        end.sort_by{|c| c['attnum'].to_i}.map { |row| Column.new(result, row, self) }
+        end.sort_by{|c| c['name']}.map { |row| Column.new(result, row, self) }
       end
 
       def indexes

data/lib/pg_examiner/result/trigger.rb

@@ -1,12 +1,19 @@
+# frozen_string_literal: true
+
 module PGExaminer
   class Result
     class Trigger < Item
       def diffable_attrs
-        [:name, :tgtype]
+        {
+          "name"   => "name",
+          "tgtype" => "trigger firing conditions (tgtype)",
+        }
       end
 
       def diffable_methods
-        [:function]
+        {
+          "function" => "function"
+        }
       end
 
       def function

data/lib/pg_examiner/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PGExaminer
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/pg_examiner.gemspec

@@ -18,7 +18,10 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'pg'
+
   spec.add_development_dependency 'bundler', '~> 1.6'
   spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'pry'
 end

data/spec/constraint_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe PGExaminer do
@@ -51,10 +53,10 @@ describe PGExaminer do
     a.should_not == f
     e.should_not == f
 
-    a.diff(d).should == {:schemas=>{"public"=>{:tables=>{"test_table"=>{:constraints=>{:added=>["con_two"], :removed=>["con"]}}}}}}
-    a.diff(e).should == {:schemas=>{"public"=>{:tables=>{"test_table"=>{:constraints=>{:added=>["test_table_a_check"], :removed=>["con"]}}}}}}
-    a.diff(f).should == {:schemas=>{"public"=>{:tables=>{"test_table"=>{:constraints=>{:removed=>["con"]}}}}}}
-    e.diff(f).should == {:schemas=>{"public"=>{:tables=>{"test_table"=>{:constraints=>{:removed=>["test_table_a_check"]}}}}}}
+    a.diff(d).should == {"schemas"=>{"public"=>{"tables"=>{"test_table"=>{"constraints"=>{"added"=>["con_two"], "removed"=>["con"]}}}}}}
+    a.diff(e).should == {"schemas"=>{"public"=>{"tables"=>{"test_table"=>{"constraints"=>{"added"=>["test_table_a_check"], "removed"=>["con"]}}}}}}
+    a.diff(f).should == {"schemas"=>{"public"=>{"tables"=>{"test_table"=>{"constraints"=>{"removed"=>["con"]}}}}}}
+    e.diff(f).should == {"schemas"=>{"public"=>{"tables"=>{"test_table"=>{"constraints"=>{"removed"=>["test_table_a_check"]}}}}}}
   end
 
   it "should consider foreign keys when differentiating between schemas" do
@@ -124,11 +126,11 @@ describe PGExaminer do
     b.should_not == e
     d.should_not == e
 
-    a.diff(c).should == {:schemas=>{"public"=>{:tables=>{"child"=>{:constraints=>{"child_parent_id_fkey"=>{:definition=>{"FOREIGN KEY (parent_id) REFERENCES parent(int1)"=>"FOREIGN KEY (parent_id) REFERENCES parent(int2)"}}}}}}}}
-    b.diff(c).should == {:schemas=>{"public"=>{:tables=>{"child"=>{:constraints=>{"child_parent_id_fkey"=>{:definition=>{"FOREIGN KEY (parent_id) REFERENCES parent(int1)"=>"FOREIGN KEY (parent_id) REFERENCES parent(int2)"}}}}}}}}
-    b.diff(d).should == {:schemas=>{"public"=>{:tables=>{"child"=>{:constraints=>{"child_parent_id_fkey"=>{:definition=>{"FOREIGN KEY (parent_id) REFERENCES parent(int1)"=>"FOREIGN KEY (parent_id) REFERENCES parent(int1) ON UPDATE CASCADE"}}}}}}}}
-    b.diff(e).should == {:schemas=>{"public"=>{:tables=>{"child"=>{:constraints=>{"child_parent_id_fkey"=>{:definition=>{"FOREIGN KEY (parent_id) REFERENCES parent(int1)"=>"FOREIGN KEY (parent_id) REFERENCES parent(int1) ON DELETE CASCADE"}}}}}}}}
-    d.diff(e).should == {:schemas=>{"public"=>{:tables=>{"child"=>{:constraints=>{"child_parent_id_fkey"=>{:definition=>{"FOREIGN KEY (parent_id) REFERENCES parent(int1) ON UPDATE CASCADE"=>"FOREIGN KEY (parent_id) REFERENCES parent(int1) ON DELETE CASCADE"}}}}}}}}
+    a.diff(c).should == {"schemas"=>{"public"=>{"tables"=>{"child"=>{"constraints"=>{"child_parent_id_fkey"=>{"constraint definition"=>{"FOREIGN KEY (parent_id) REFERENCES parent(int1)"=>"FOREIGN KEY (parent_id) REFERENCES parent(int2)"}}}}}}}}
+    b.diff(c).should == {"schemas"=>{"public"=>{"tables"=>{"child"=>{"constraints"=>{"child_parent_id_fkey"=>{"constraint definition"=>{"FOREIGN KEY (parent_id) REFERENCES parent(int1)"=>"FOREIGN KEY (parent_id) REFERENCES parent(int2)"}}}}}}}}
+    b.diff(d).should == {"schemas"=>{"public"=>{"tables"=>{"child"=>{"constraints"=>{"child_parent_id_fkey"=>{"constraint definition"=>{"FOREIGN KEY (parent_id) REFERENCES parent(int1)"=>"FOREIGN KEY (parent_id) REFERENCES parent(int1) ON UPDATE CASCADE"}}}}}}}}
+    b.diff(e).should == {"schemas"=>{"public"=>{"tables"=>{"child"=>{"constraints"=>{"child_parent_id_fkey"=>{"constraint definition"=>{"FOREIGN KEY (parent_id) REFERENCES parent(int1)"=>"FOREIGN KEY (parent_id) REFERENCES parent(int1) ON DELETE CASCADE"}}}}}}}}
+    d.diff(e).should == {"schemas"=>{"public"=>{"tables"=>{"child"=>{"constraints"=>{"child_parent_id_fkey"=>{"constraint definition"=>{"FOREIGN KEY (parent_id) REFERENCES parent(int1) ON UPDATE CASCADE"=>"FOREIGN KEY (parent_id) REFERENCES parent(int1) ON DELETE CASCADE"}}}}}}}}
   end
 
   it "should consider constraints when determining table equivalency" do
@@ -159,8 +161,8 @@ describe PGExaminer do
     a.should_not == c
     b.should == c
 
-    a.diff(b).should == {:schemas=>{"public"=>{:tables=>{"test_table"=>{:constraints=>{"con"=>{:definition=>{"CHECK ((a > 0)) NOT VALID"=>"CHECK ((a > 0))"}}}}}}}}
-    a.diff(c).should == {:schemas=>{"public"=>{:tables=>{"test_table"=>{:constraints=>{"con"=>{:definition=>{"CHECK ((a > 0)) NOT VALID"=>"CHECK ((a > 0))"}}}}}}}}
+    a.diff(b).should == {"schemas"=>{"public"=>{"tables"=>{"test_table"=>{"constraints"=>{"con"=>{"constraint definition"=>{"CHECK ((a > 0)) NOT VALID"=>"CHECK ((a > 0))"}}}}}}}}
+    a.diff(c).should == {"schemas"=>{"public"=>{"tables"=>{"test_table"=>{"constraints"=>{"con"=>{"constraint definition"=>{"CHECK ((a > 0)) NOT VALID"=>"CHECK ((a > 0))"}}}}}}}}
   end
 
   it "should consider the tables each constraint is on" do
@@ -187,6 +189,6 @@ describe PGExaminer do
     SQL
 
     a.should_not == b
-    a.diff(b).should == {:schemas=>{"public"=>{:tables=>{"test_table_1"=>{:constraints=>{:removed=>["con"]}}, "test_table_2"=>{:constraints=>{:added=>["con"]}}}}}}
+    a.diff(b).should == {"schemas"=>{"public"=>{"tables"=>{"test_table_1"=>{"constraints"=>{"removed"=>["con"]}}, "test_table_2"=>{"constraints"=>{"added"=>["con"]}}}}}}
   end
 end