pg_spec_helper 1.1.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 682ffdd64498aa86215c2af590284dfb04be55dcfaf1b70bfe5f5f88a5475d2c
-  data.tar.gz: 7fdd1581c726301dd48c23d9b386f78823177418e581ad76f042cea87d4583e1
+  metadata.gz: c1285cbc5b11e282ca1e564530c3b031bf0d8455a48d7f7e2b6af112216e0287
+  data.tar.gz: 9c63189e6193d584bae3e84081c50a3dc151e4b717044eee56da6b18e78da48c
 SHA512:
-  metadata.gz: f977a9357f41a826585e15a9946d3769cbd33ecd9f592368cdc8b80276a243474a6cabb7d3ccdb170baf0565e62b1d5c2144ed75a4b5159620de7f65cdfc245c
-  data.tar.gz: c880c669479515f49910e7855ca8f90ad6f4a24cc5d48859bc9203fae22852ecdd9345622249f61ee6fcd6f859402ac3ce73d94372e0542b60ee8d847e4e7ba0
+  metadata.gz: f150ef8957731ef55129548b3f8ccc3ff95bf211d57b2b01850df80cba4d080d72323095ee0f1648f8189fcf9487a6d9c418e53565047f8509942a05c71f4039
+  data.tar.gz: 77ad4f5fde90f10bf13eae8390a157adb281ee1e910992b4531604dd8cdef71e72286c38caf887814b051aab74e5d6cd81d4dc0b5e96070bc0c5a245cb3fba2f

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [1.3.0](https://github.com/craigulliott/pg_spec_helper/compare/v1.2.0...v1.3.0) (2023-07-10)
+
+
+### Features
+
+* Dont delete the public schema, just remove all the tables instead. This is useful if you have materialized views in the public schema ([9f69160](https://github.com/craigulliott/pg_spec_helper/commit/9f691602bc851fbeea0d01a0f8e9a7555f154e35))
+
+## [1.2.0](https://github.com/craigulliott/pg_spec_helper/compare/v1.1.0...v1.2.0) (2023-07-10)
+
+
+### Features
+
+* refresh materialized views automatically based on changes to structure ([e9a8ce0](https://github.com/craigulliott/pg_spec_helper/commit/e9a8ce011578018b2374612e6d6ce8765e49d4db))
+
 ## [1.1.0](https://github.com/craigulliott/pg_spec_helper/compare/v1.0.0...v1.1.0) (2023-07-10)
 
 

data/README.md

@@ -25,30 +25,36 @@ This gem is concerned with the **structure** of your database, not the data/reco
 
 * Easily create basic tables, columns, constraints, indexes and primary/foreign keys for your specs
 * Provides convenient methods for testing the presence of various database objects
-* Resets your database after each spec, only if the spec made changes
-* Ignores `information_schema` and any schemas or tables beginning with `pg_`
+* Resets your database after each spec, but only if the spec made changes
+* Ignores `information_schema` and any schemas or tables with names beginning with `pg_`
 * Configurable to ignore other schemas (such as `postgis`)
-* Automatically resets and recreates the `public` schema
+* Deletes tables from within the `public` schema, but does not delete the actual schema during cleanup.
 * Can track and refresh materialized views
 * Easily access the `PG::Connection` object via `pg_spec_helper.connection` to execute your own SQL
 
 ## Installation
 
-Install the gem by executing:
+Add the gem to your Gemfile:
 
-    $ gem install pg_spec_helper
+```ruby
+gem "pg_spec_helper"
+```
+
+Or to your `*.gemspec`
+
+```ruby
+spec.add_development_dependency "pg_spec_helper"
+```
 
-Create your new platform:
+And run bundle install
 
-    $ pg_spec_helper create my_platform_name
+    $ bundle install
 
 Note, this gem depends on the postgres gem `pg`, which depends on the `libpq` package. On Apple Silicon you can run the following commands before installation to prepare your system.
 
-```
-# required for pg gem on apple silicon
-brew install libpq
-export PATH="/opt/homebrew/opt/libpq/bin:$PATH"
-```
+    # required for pg gem on apple silicon
+    $ brew install libpq
+    $ export PATH="/opt/homebrew/opt/libpq/bin:$PATH"
 
 ## Getting Started
 
@@ -105,7 +111,7 @@ The configuration above will assert that your database is completely empty befor
 
 If rspec crashed or exited prematurely on the last execution of your test suite, then you can tell pg_spec_helper to forcefully clear your database.
 
-`DYNAMIC_MIGRATIONS_CLEAR_DB_ON_STARTUP=true bundle exec rspec`
+    $ DYNAMIC_MIGRATIONS_CLEAR_DB_ON_STARTUP=true bundle exec rspec
 
 #### An example test which requires some specific structure
 
@@ -113,7 +119,7 @@ If rspec crashed or exited prematurely on the last execution of your test suite,
 RSpec.describe PGSpecHelper do
   let(:pg_spec_helper) { RSpec.configuration.pg_spec_helper }
 
-  describe 'where the table `my_schema`.`my_table` exists in the database' do
+  describe 'where the table my_schema.my_table exists and has a single column which is also the primary key' do
     before(:each) do
       pg_spec_helper.create_schema :my_schema
       pg_spec_helper.create_table :my_schema, :my_table
@@ -122,7 +128,7 @@ RSpec.describe PGSpecHelper do
     end
 
     it "test something which required that table to exist" do
-      expect().to_not raise_error
+      expect{}.to_not raise_error
     end
   end
 end

data/lib/pg_spec_helper/materialized_views.rb

@@ -32,6 +32,22 @@ class PGSpecHelper
 
     private
 
+    # given a trackable method name, refreshes any materialized
+    # views which are configured to be refreshed after that method
+    def refresh_materialized_views_by_method method_name
+      assert_trackable_method_name! method_name
+      # check each materialized view to see if it should be refreshed
+      @materialized_views&.each do |schema_name, views|
+        views.each do |materialized_view_name, view|
+          # if the materialized view exists and the method name is in the list of
+          # this materialized view's refresh_after methods, then refresh the view
+          if view[:refresh_after].include?(method_name) && materialized_view_exists?(schema_name, materialized_view_name)
+            refresh_materialized_view schema_name, materialized_view_name
+          end
+        end
+      end
+    end
+
     # return true if the materialized view exists, otherwise false
     def materialized_view_exists? schema_name, materialized_view_name
       # assert this materialized view is being tracked

data/lib/pg_spec_helper/reset.rb

@@ -3,7 +3,9 @@ class PGSpecHelper
     # reset the database to its original state
     def reset! force = false
       if force || has_changes?
-        delete_all_schemas cascade: true
+        delete_all_schemas
+        # refresh all materialized views
+        refresh_all_materialized_views
         # reset the tracking of changes
         @methods_used = {}
       end

data/lib/pg_spec_helper/schemas.rb

@@ -25,19 +25,19 @@ class PGSpecHelper
     end
 
     # delete all schemas in the database
-    def delete_all_schemas cascade: false
-      # delete all schemas
-      get_schema_names.each do |schema_name|
+    def delete_all_schemas
+      # delete all schemas except public
+      get_schema_names.reject { |schema_name| schema_name == :public }.each do |schema_name|
         connection.exec(<<-SQL)
           -- temporarily set the client_min_messages to WARNING to
           -- suppress the NOTICE messages about cascading deletes
           SET client_min_messages TO WARNING;
-          DROP SCHEMA #{connection.quote_ident schema_name.to_s} #{cascade ? "CASCADE" : ""};
+          DROP SCHEMA #{connection.quote_ident schema_name.to_s} CASCADE;
           SET client_min_messages TO NOTICE;
         SQL
       end
-      # recreate the default `public` schema
-      create_schema :public
+      # delete all the tables from within the public schema
+      delete_tables :public
     end
 
     def schema_exists? schema_name

data/lib/pg_spec_helper/track_changes.rb

@@ -10,8 +10,15 @@ class PGSpecHelper
     # reset! between tests
     TRACKED_METHOD_CALLS = [
       :create_schema,
+      :delete_all_schemas,
       :create_table,
-      :create_column
+      :delete_tables,
+      :create_column,
+      :create_foreign_key,
+      :create_index,
+      :create_primary_key,
+      :create_unique_constraint,
+      :create_validation
     ]
 
     # returns true if any changes have been made to the database structure
@@ -61,6 +68,8 @@ class PGSpecHelper
           track_change method_name
           # call the original method
           original_method.bind_call(self, *args)
+          # do any materialized views need to be refreshed?
+          refresh_materialized_views_by_method method_name
         end
       end
     end

data/lib/pg_spec_helper/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class PGSpecHelper
-  VERSION = "1.1.0"
+  VERSION = "1.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pg_spec_helper
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Craig Ulliott