pg_examiner 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 --- 
 SHA1: 
-  metadata.gz: 3febec877bf8581fc25e2d473161b5c49a7342a0
-  data.tar.gz: cc1fb74e5cec4fa2423f57fb9c39c75e1446f31a
+  metadata.gz: d356dc864a178282a0215872ebada1d1632bde1f
+  data.tar.gz: dd10dd54b238c784dd2a64860fc4ea2bb603fd9b
 SHA512: 
-  metadata.gz: 57219283bfba79a7768afb659f7b0c245d3eecf7277454570d9e3a70c92c9e3f34626a07732566ab33eed49dd0b58650a66da335449a62eda31cea94e38a8e5e
-  data.tar.gz: bbe34e55e39676b49dcbdc68f7f434ebd70c4186f11f67ac909b89de05fef68386dc5a0987e20f0885153aad236394f729873cc1860314653c65066c10f9004d
+  metadata.gz: 86f551bd4b3f744071d176bc78bfe0b8a67468dacbed61af64fb10ec822f1ecd24357d960b609dd1936852e87f64802ef3da0c7c95573924260e12d1d96b7c6f
+  data.tar.gz: 027020de63882cdc3040dc84e7f48426503a0f6ca36a7071dd7322453087dce450d6f0eefe722ef838c289ee3bbfb4b885ec7b17870b50fc6d680e23f73f95ad

data/README.md

@@ -1,6 +1,25 @@
 # PGExaminer
 
-TODO: Write a gem description
+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 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.
+
+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.
 
 ## Installation
 
@@ -18,7 +37,20 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+``` ruby
+  # Need a PG::Connection object. See your ORM's documentation for how to get one.
+
+  # To make sure migrations work right:
+  state1 = PGExaminer.examine(connection)
+  # Migrate up then down.
+  state2 = PGExaminer.examine(connection)
+  state1 == state2 # => true or false
+
+  # To make sure schema1 and schema2 have the same contents:
+  state1 = PGExaminer.examine(connection, :schema1)
+  state2 = PGExaminer.examine(connection, :schema2)
+  state1 == state2 # => true or false
+```
 
 ## Contributing
 

data/TODO.txt

@@ -65,21 +65,11 @@ inhrelid
 inhparent
 inhseqno
 
-pg_language (http://www.postgresql.org/docs/9.3/static/catalog-pg-language.html)
-lanname
-
 pg_proc (http://www.postgresql.org/docs/9.3/static/catalog-pg-proc.html)
-proname
-pronamespace
-procost
-prorows?
-provariadic
 proisagg
 proiswindow
 proleakproof?
-proisstrict
 proretset
-provolatile
 pronargs
 pronargdefaults
 prorettype
@@ -90,9 +80,6 @@ proargnames
 nodeToString(proargdefaults)
 
 pg_trigger (http://www.postgresql.org/docs/9.3/static/catalog-pg-trigger.html)
-tgrelid
-tgname
-tgfoid
 tgtype
 tgisinternal
 tgconstrrelid

data/lib/pg_examiner.rb

@@ -3,8 +3,14 @@ require 'pg_examiner/version'
 
 module PGExaminer
   class << self
-    def examine(connection)
-      Result.new(connection)
+    def examine(connection, schema = nil)
+      result = Result.new(connection)
+
+      if schema
+        result.schemas.find { |s| s.name == schema.to_s }
+      else
+        result
+      end
     end
   end
 end

data/lib/pg_examiner/result.rb

@@ -41,10 +41,14 @@ module PGExaminer
     end
 
     def ==(other)
+      # We want to be able to compare the contents of two schemas to each
+      # other, so compare names at the top level instead of schema-to-schema.
+
       other.is_a?(Result) &&
-        schemas    == other.schemas &&
-        extensions == other.extensions &&
-        languages  == other.languages
+        schemas.map(&:name) == other.schemas.map(&:name) &&
+        schemas             == other.schemas &&
+        extensions          == other.extensions &&
+        languages           == other.languages
     end
 
     def inspect

data/lib/pg_examiner/result/schema.rb

@@ -1,7 +1,7 @@
 module PGExaminer
   class Result
     class Schema < Base
-      COMPARISON_COLUMNS = %w(name)
+      COMPARISON_COLUMNS = %w()
 
       def tables
         @tables ||= result.pg_class.select do |c|

data/lib/pg_examiner/version.rb

@@ -1,3 +1,3 @@
 module PGExaminer
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/spec/schema_spec.rb

@@ -20,4 +20,24 @@ describe PGExaminer do
     result.schemas.length.should == 2
     result.schemas.map(&:name).should == %w(my_schema public)
   end
+
+  it "should be able to compare the contents of different schemas" do
+    a = examine <<-SQL, :schema1
+      CREATE SCHEMA schema1;
+      CREATE TABLE schema1.test_table (
+        a integer,
+        b integer
+      );
+    SQL
+
+    b = examine <<-SQL, :schema2
+      CREATE SCHEMA schema2;
+      CREATE TABLE schema2.test_table (
+        a integer,
+        b integer
+      );
+    SQL
+
+    a.should == b
+  end
 end

data/spec/spec_helper.rb

@@ -11,10 +11,10 @@ CONNECTION = PG::Connection.open :host     => uri.host,
                                  :dbname   => uri.path[1..-1]
 
 RSpec.configure do |config|
-  def examine(sql)
+  def examine(sql, schema = nil)
     execute "BEGIN"
     execute(sql)
-    PGExaminer.examine(CONNECTION)
+    PGExaminer.examine(CONNECTION, schema)
   ensure
     execute "ROLLBACK"
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: pg_examiner
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Chris Hanks