pg_spec_helper 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8b0b5b3c3620c2ddbf235b94c07c33e9c4242ba5221c5d92997c0504ec550448
+  data.tar.gz: e71a455e469526f1bfe9ef599e4dd37a3dea1e49d0fd18c11ac4cf11035c4a6d
+SHA512:
+  metadata.gz: e433948e243dfdce36e6d6bdd894a18b1bcd9e30b3f622bd4ea2788af1366525c8384c33fff2eeb426548727c85c74c6ce42ce5e3e9006102fd018cbbf068bda
+  data.tar.gz: bdbbbb5df25c8456ec9c09aed3b5f9eae6eb869cd8c2b0395a031613beb744477a7f59cc47474b10b35daed5b6fda9a11111fcd71fd5e18d3f188cce0c26c475

data/CHANGELOG.md

@@ -0,0 +1,20 @@
+# Changelog
+
+## 1.0.0 (2023-07-08)
+
+
+### Features
+
+* basic first version, extracted from dynamic_migrations gem ([4d4ed01](https://github.com/craigulliott/pg_spec_helper/commit/4d4ed016d1a19394d0db7c39a01c153670a3edfe))
+
+## 1.0.0 (2023-07-05)
+
+
+### Features
+
+* added table and column comments and column metadata ([84d798a](https://github.com/craigulliott/pg_spec_helper/commit/84d798aae35c259545f73dbbd7d076d8ceaa8739))
+* basic representation of schema either configured or loaded from a real database ([7fc9ebb](https://github.com/craigulliott/pg_spec_helper/commit/7fc9ebbe5a8e5faa4e6017deec9bc66f7ba15f16))
+* recursively load and builds a representation of current database schema, and find differences between configured and loaded representations of the database structure ([978e122](https://github.com/craigulliott/pg_spec_helper/commit/978e12279760709f1511dc7c6d9fe7ff57b54f3e))
+* renaming the current version of constraints to validations, because its a more descriptive name, especially when considering we are going to expose multiple types of postgres constraint ([2f17af6](https://github.com/craigulliott/pg_spec_helper/commit/2f17af665028ed6f49d8bdd9b7ff6a52339206db))
+* support for table constraints and added caches for database structure and constraints ([f68bbb2](https://github.com/craigulliott/pg_spec_helper/commit/f68bbb20a25fab149ed4b3b9c591fde1a6ff628e))
+* table keys and indexes and a more robust database configured/loaded comparison class ([b4a0925](https://github.com/craigulliott/pg_spec_helper/commit/b4a092535e4e59d0fb9b97efc3d210289346b454))

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at craigulliott@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Craig Ulliott
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,67 @@
+# PGSpecHelper
+
+Monitor and generate database migrations based on difference between current schema and configuration.
+
+[![Gem Version](https://badge.fury.io/rb/pg_spec_helper.svg)](https://badge.fury.io/rb/pg_spec_helper)
+[![Specs](https://github.com/craigulliott/pg_spec_helper/actions/workflows/specs.yml/badge.svg)](https://github.com/craigulliott/pg_spec_helper/actions/workflows/specs.yml)
+[![Types](https://github.com/craigulliott/pg_spec_helper/actions/workflows/types.yml/badge.svg)](https://github.com/craigulliott/pg_spec_helper/actions/workflows/types.yml)
+[![Coding Style](https://github.com/craigulliott/pg_spec_helper/actions/workflows/linter.yml/badge.svg)](https://github.com/craigulliott/pg_spec_helper/actions/workflows/linter.yml)
+
+## Key Features
+
+* Create tables, columns, constraints, indexes and primary/foreign keys
+* Resets your database after each spec, only if the spec made changes
+
+
+## Installation
+
+Install the gem by executing:
+
+    $ gem install pg_spec_helper
+
+Create your new platform:
+
+    $ pg_spec_helper create my_platform_name
+
+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"
+``
+
+## Getting Started
+
+Todo
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+We use [Conventional Commit Messages](https://gist.github.com/qoomon/5dfcdf8eec66a051ecd85625518cfd13).
+
+Code should be linted and formatted according to [Ruby Standard](https://github.com/standardrb/standard).
+
+Publishing is automated via github actions and Googles [Release Please](https://github.com/google-github-actions/release-please-action) github action
+
+We prefer using squash-merges when merging pull requests because it helps keep a linear git history and allows more fine grained control of commit messages which get sent to release-please and ultimately show up in the changelog.
+
+Type checking is enabled for this project. You can find the corresponding `rbs` files in the sig folder.
+
+Install types for the packages used in development (such as `rspec`) by running
+
+    $ rbs collection install
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/craigulliott/pg_spec_helper. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/craigulliott/pg_spec_helper/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+This software is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the PGSpecHelper project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/craigulliott/pg_spec_helper/blob/master/CODE_OF_CONDUCT.md).

data/lib/pg_spec_helper/columns.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+class PGSpecHelper
+  module Columns
+    def create_column schema_name, table_name, column_name, type
+      # validate the type exists
+      PGSpecHelper::Postgres::DataTypes.validate_type_exists! type
+      # note the `type` is safe from sql_injection due to the validation above
+      connection.exec(<<-SQL)
+        ALTER TABLE #{connection.quote_ident schema_name.to_s}.#{connection.quote_ident table_name.to_s}
+          ADD COLUMN #{connection.quote_ident column_name.to_s} #{type}
+      SQL
+      # refresh the cached representation of the database structure
+      refresh_structure_cache_materialized_view
+      # note that the database has been reset and there are no changes
+      @has_changes = true
+    end
+  end
+end

data/lib/pg_spec_helper/configuration.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+class PGSpecHelper
+  module Configuration
+    class MissingConfigurationError < StandardError
+    end
+
+    class ConfigurationNotLoadedError < StandardError
+    end
+
+    class MissingRequiredNameError < StandardError
+    end
+
+    class MissingRequiredDatabaseTypeError < StandardError
+    end
+
+    def load_configuration_for database_type, name
+      @name = name.to_s
+      @database_type = database_type.to_s
+
+      raise MissingRequiredNameError unless @name
+      raise MissingRequiredDatabaseTypeError unless @database_type
+
+      configuration = load_configuration_file
+
+      if configuration[@database_type].nil?
+        raise MissingConfigurationError, "no database configuration found for #{name} in database.yaml"
+      end
+
+      if configuration[@database_type][@name].nil?
+        raise MissingConfigurationError, "no configuration found for #{database_type}.#{name} in database.yaml"
+      end
+
+      @configuration = configuration[@database_type][@name]
+    end
+
+    def optional_configuration_value key
+      @configuration[key.to_s]
+    end
+
+    def require_configuration_value key
+      raise ConfigurationNotLoadedError unless @configuration
+
+      @configuration[key.to_s] || raise(MissingConfigurationError, "no #{key} found for configuration #{@database_type}.#{@name}")
+    end
+
+    def load_configuration_file
+      YAML.load_file("config/database.yaml")
+    end
+  end
+end

data/lib/pg_spec_helper/connection.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+class PGSpecHelper
+  module Connection
+    class ConnectionFailedError < StandardError
+    end
+
+    def connection
+      unless @connection
+        @connection = PG.connect(
+          host: @host,
+          port: @port,
+          user: @username,
+          password: @password,
+          dbname: @database,
+          sslmode: "prefer"
+        )
+        # after initial connect, we refresh the cached representation of
+        # the database structure and constaints
+        refresh_structure_cache_materialized_view
+        refresh_validation_cache_materialized_view
+      end
+      @connection
+    end
+  end
+end

data/lib/pg_spec_helper/foreign_key_cache.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+class PGSpecHelper
+  module ForeignKeyCache
+    # whenever schema changes are made from within the test suite we need to
+    # rebuild the materialized views that hold a cached representation of the
+    # database foreign keys
+    def refresh_keys_and_unique_constraints_cache_materialized_view
+      # the first time we detect the presence of the marerialized view, we no longer need to
+      # check for it
+      @keys_and_unique_constraints_cache_exists ||= keys_and_unique_constraints_cache_exists?
+      if @keys_and_unique_constraints_cache_exists
+        connection.exec(<<~SQL)
+          REFRESH MATERIALIZED VIEW public.pg_spec_helper_keys_and_unique_constraints_cache;
+        SQL
+      end
+    end
+
+    def keys_and_unique_constraints_cache_exists?
+      exists = connection.exec(<<~SQL)
+        SELECT TRUE AS exists FROM pg_matviews WHERE schemaname = 'public' AND matviewname = 'pg_spec_helper_keys_and_unique_constraints_cache';
+      SQL
+      exists.count > 0
+    end
+  end
+end

data/lib/pg_spec_helper/foreign_keys.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+class PGSpecHelper
+  module ForeignKeys
+    def create_foreign_key schema_name, table_name, column_names, foreign_schema_name, foreign_table_name, foreign_column_names, foreign_key_name
+      column_names_sql = column_names.map { |n| connection.quote_ident n.to_s }.join(", ")
+      foreign_column_names_sql = column_names.map { |n| connection.quote_ident n.to_s }.join(", ")
+      # add the foreign key
+      connection.exec(<<-SQL)
+        ALTER TABLE #{connection.quote_ident schema_name.to_s}.#{connection.quote_ident table_name.to_s}
+          ADD CONSTRAINT #{connection.quote_ident foreign_key_name.to_s}
+          FOREIGN KEY (#{column_names_sql})
+            REFERENCES #{connection.quote_ident foreign_schema_name.to_s}.#{connection.quote_ident foreign_table_name.to_s} (#{foreign_column_names_sql})
+      SQL
+      # refresh the cached representation of the database foreign keys
+      refresh_keys_and_unique_constraints_cache_materialized_view
+      # note that the database has been reset and there are no changes
+      @has_changes = true
+    end
+  end
+end

data/lib/pg_spec_helper/index_cache.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+class PGSpecHelper
+  module IndexCache
+    # whenever schema changes are made from within the test suite we need to
+    # rebuild the materialized views that hold a cached representation of the
+    # database indexes
+    def refresh_index_cache_materialized_view
+      # the first time we detect the presence of the marerialized view, we no longer need to
+      # check for it
+      @index_cache_exists ||= index_cache_exists?
+      if @index_cache_exists
+        connection.exec(<<~SQL)
+          REFRESH MATERIALIZED VIEW public.pg_spec_helper_index_cache;
+        SQL
+      end
+    end
+
+    def index_cache_exists?
+      exists = connection.exec(<<~SQL)
+        SELECT TRUE AS exists FROM pg_matviews WHERE schemaname = 'public' AND matviewname = 'pg_spec_helper_index_cache';
+      SQL
+      exists.count > 0
+    end
+  end
+end

data/lib/pg_spec_helper/indexes.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+class PGSpecHelper
+  module Indexes
+    def create_index schema_name, table_name, column_names, index_name, type, deferrable, initially_deferred
+      connection.exec(<<-SQL)
+        CREATE INDEX #{connection.quote_ident index_name.to_s}
+          ON #{connection.quote_ident schema_name.to_s}.#{connection.quote_ident table_name.to_s} (b, c)
+      SQL
+      # refresh the cached representation of the database indexes
+      refresh_index_cache_materialized_view
+      # note that the database has been reset and there are no changes
+      @has_changes = true
+    end
+  end
+end

data/lib/pg_spec_helper/primary_keys.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+class PGSpecHelper
+  module PrimaryKeys
+    # add a primary_key to the provided table which covers the provided columns
+    def add_primary_key schema_name, table_name, column_names
+      column_names_sql = column_names.map { |n| connection.quote_ident n.to_s }.join(", ")
+      # add the primary_key
+      connection.exec(<<-SQL)
+        ALTER TABLE #{connection.quote_ident schema_name.to_s}.#{connection.quote_ident table_name.to_s}
+          ADD PRIMARY KEY (#{column_names_sql})
+      SQL
+      # refresh the cached representation of the database primary_key keys
+      refresh_keys_and_unique_constraints_cache_materialized_view
+      # note that the database has been reset and there are no changes
+      @has_changes = true
+    end
+  end
+end

data/lib/pg_spec_helper/schemas.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+class PGSpecHelper
+  module Schemas
+    # We assert there are no schemas before we run the test suite because it
+    # requires starting with an empty database.
+    #
+    # We could clear it automatically here, but don't want to risk deleting data
+    # in case the configuration is wrong and this is connected to an unexpected
+    # database.
+    def assert_database_empty!
+      public_schema_exists = false
+      get_schema_names.each do |schema_name|
+        if schema_name == "public"
+          public_schema_exists = true
+          next
+        end
+        next if schema_name.start_with? "pg_"
+        next if schema_name == "postgis"
+        next if schema_name == "information_schema"
+        raise "Expected no schemas to exist, but found `#{schema_name}` in `#{@database}` on `#{@host}`. Your test suite might have failed to complete the last time it was run. Please delete all schemas. If you are certain this is pointed at the correct database, then you can set DYNAMIC_MIGRATIONS_CLEAR_DB_ON_STARTUP=true on your console and execute these specs again to automatically clear the database."
+      end
+      # assert that the public schema exists
+      raise "Public schema does not exist" unless public_schema_exists
+      # assert the public schema has no tables
+      raise "Public scheama is not empty" unless get_table_names(:public).empty?
+    end
+
+    def create_schema schema_name
+      connection.exec(<<-SQL)
+        CREATE SCHEMA #{connection.quote_ident schema_name.to_s};
+      SQL
+      # refresh the cached representation of the database structure
+      refresh_structure_cache_materialized_view
+      # note that the structure has changed, so that the database can be reset between tests
+      @has_changes = true
+    end
+
+    def get_schema_names
+      results = connection.exec(<<-SQL)
+        SELECT schema_name
+          FROM information_schema.schemata;
+      SQL
+      schema_names = results.map { |row| row["schema_name"] }
+      schema_names.sort
+    end
+
+    def delete_all_schemas cascade: false
+      get_schema_names.each do |schema_name|
+        next if schema_name.start_with? "pg_"
+        next if schema_name == "postgis"
+        next if schema_name == "public"
+        next if schema_name == "information_schema"
+        connection.exec(<<-SQL)
+          DROP SCHEMA #{connection.quote_ident schema_name.to_s} #{cascade ? "CASCADE" : ""};
+        SQL
+      end
+      # refresh the cached representation of the database structure
+      # as removing objects can affect them
+      refresh_structure_cache_materialized_view
+      refresh_validation_cache_materialized_view
+      refresh_keys_and_unique_constraints_cache_materialized_view
+      # note that the database has been reset and there are no changes
+      @has_changes = true
+    end
+  end
+end

data/lib/pg_spec_helper/structure_cache.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+class PGSpecHelper
+  module StructureCache
+    # whenever schema changes are made from within the test suite we need to
+    # rebuild the materialized views that hold a cached representation of the
+    # database structure
+    def refresh_structure_cache_materialized_view
+      # the first time we detect the presence of the marerialized view, we no longer need to
+      # check for it
+      @structure_cache_exists ||= structure_cache_exists?
+      if @structure_cache_exists
+        connection.exec(<<~SQL)
+          REFRESH MATERIALIZED VIEW public.pg_spec_helper_structure_cache;
+        SQL
+      end
+    end
+
+    def structure_cache_exists?
+      exists = connection.exec(<<~SQL)
+        SELECT TRUE AS exists FROM pg_matviews WHERE schemaname = 'public' AND matviewname = 'pg_spec_helper_structure_cache';
+      SQL
+      exists.count > 0
+    end
+  end
+end

data/lib/pg_spec_helper/tables.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+class PGSpecHelper
+  module Tables
+    def create_table schema_name, table_name
+      connection.exec(<<-SQL)
+        CREATE TABLE #{connection.quote_ident schema_name.to_s}.#{connection.quote_ident table_name.to_s}(
+          -- tables are created empty, and have columns added to them later
+        );
+      SQL
+      # refresh the cached representation of the database structure
+      refresh_structure_cache_materialized_view
+      # note that the structure has changed, so that the database can be reset between tests
+      @has_changes = true
+    end
+
+    def get_table_names schema_name
+      rows = connection.exec_params(<<-SQL, [schema_name.to_s])
+        SELECT table_name FROM information_schema.tables
+          WHERE table_schema = $1
+      SQL
+      rows.map { |row| row["table_name"] }
+    end
+
+    def delete_tables schema_name
+      get_table_names(schema_name).each do |table_name|
+        connection.exec(<<-SQL)
+          DROP TABLE #{connection.quote_ident schema_name.to_s}.#{connection.quote_ident table_name.to_s} CASCASE
+        SQL
+      end
+    end
+  end
+end

data/lib/pg_spec_helper/unique_constraints.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+class PGSpecHelper
+  module UniqueConstraints
+    # add a unique constraint to the provided table and columns
+    def add_unique_constraint schema_name, table_name, column_names, constraint_key_name
+      column_names_sql = column_names.map { |n| connection.quote_ident n.to_s }.join(", ")
+      # add the constraint key
+      connection.exec(<<-SQL)
+        ALTER TABLE #{connection.quote_ident schema_name.to_s}.#{connection.quote_ident table_name.to_s}
+          ADD CONSTRAINT #{connection.quote_ident constraint_key_name.to_s}
+          UNIQUE (#{column_names_sql})
+      SQL
+      # refresh the cached representation of the database constraint keys
+      refresh_keys_and_unique_constraints_cache_materialized_view
+      # note that the database has been reset and there are no changes
+      @has_changes = true
+    end
+  end
+end

data/lib/pg_spec_helper/validation_cache.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+class PGSpecHelper
+  module ValidationCache
+    # whenever schema changes are made from within the test suite we need to
+    # rebuild the materialized views that hold a cached representation of the
+    # database structure
+    def refresh_validation_cache_materialized_view
+      # the first time we detect the presence of the marerialized view, we no longer need to
+      # check for it
+      @validations_cache_exists ||= validations_cache_exists?
+      if @validations_cache_exists
+        connection.exec(<<~SQL)
+          REFRESH MATERIALIZED VIEW public.pg_spec_helper_validations_cache;
+        SQL
+      end
+    end
+
+    def validations_cache_exists?
+      exists = connection.exec(<<~SQL)
+        SELECT TRUE AS exists FROM pg_matviews WHERE schemaname = 'public' AND matviewname = 'pg_spec_helper_validations_cache';
+      SQL
+      exists.count > 0
+    end
+  end
+end

data/lib/pg_spec_helper/validations.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+class PGSpecHelper
+  module Validations
+    def create_validation schema_name, table_name, validation_name, check_clause
+      # todo the check_clause is vulnerable to sql injection (although this is very low risk because
+      #      it is only ever provided by the test suite, and is never provided by the user)
+      connection.exec(<<-SQL)
+        ALTER TABLE #{connection.quote_ident schema_name.to_s}.#{connection.quote_ident table_name.to_s}
+          ADD CONSTRAINT #{connection.quote_ident validation_name.to_s} CHECK (#{check_clause})
+      SQL
+      # refresh the cached representation of the database structure
+      refresh_validation_cache_materialized_view
+      # note that the database has been reset and there are no changes
+      @has_changes = true
+    end
+  end
+end

data/lib/pg_spec_helper/version.rb

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

data/lib/pg_spec_helper.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require "yaml"
+require "pg"
+
+require "pg_spec_helper/version"
+
+require "pg_spec_helper/configuration"
+require "pg_spec_helper/connection"
+require "pg_spec_helper/schemas"
+require "pg_spec_helper/tables"
+require "pg_spec_helper/columns"
+require "pg_spec_helper/validations"
+require "pg_spec_helper/foreign_keys"
+require "pg_spec_helper/unique_constraints"
+require "pg_spec_helper/primary_keys"
+require "pg_spec_helper/indexes"
+require "pg_spec_helper/validation_cache"
+require "pg_spec_helper/structure_cache"
+require "pg_spec_helper/foreign_key_cache"
+require "pg_spec_helper/index_cache"
+
+class PGSpecHelper
+  include Configuration
+  include Connection
+  include Schemas
+  include Tables
+  include Columns
+  include Validations
+  include ForeignKeys
+  include UniqueConstraints
+  include PrimaryKeys
+  include Indexes
+  include ValidationCache
+  include StructureCache
+  include ForeignKeyCache
+  include IndexCache
+
+  attr_reader :database, :username, :password, :host, :port
+
+  def initialize name
+    load_configuration_for :postgres, name
+
+    @database = require_configuration_value(:database).to_sym
+    @host = require_configuration_value :host
+    @port = require_configuration_value :port
+    @username = require_configuration_value :username
+    @password = optional_configuration_value :password
+
+    # will be set to true if any changes are made to the database structure
+    # this is used to determine if the structure needs to be reset between tests
+    @has_changes = false
+  end
+
+  def has_changes?
+    @has_changes
+  end
+
+  def reset! force = false
+    if force || @has_changes
+      delete_all_schemas cascade: true
+      # note that the database has been reset and there are no changes
+      @has_changes = false
+    end
+  end
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: pg_spec_helper
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Craig Ulliott
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-07-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: yaml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description: Helper class for setting up and easily tearing down PostgreSQL database
+  objects within a testing environment
+email:
+- craigulliott@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- lib/pg_spec_helper.rb
+- lib/pg_spec_helper/columns.rb
+- lib/pg_spec_helper/configuration.rb
+- lib/pg_spec_helper/connection.rb
+- lib/pg_spec_helper/foreign_key_cache.rb
+- lib/pg_spec_helper/foreign_keys.rb
+- lib/pg_spec_helper/index_cache.rb
+- lib/pg_spec_helper/indexes.rb
+- lib/pg_spec_helper/primary_keys.rb
+- lib/pg_spec_helper/schemas.rb
+- lib/pg_spec_helper/structure_cache.rb
+- lib/pg_spec_helper/tables.rb
+- lib/pg_spec_helper/unique_constraints.rb
+- lib/pg_spec_helper/validation_cache.rb
+- lib/pg_spec_helper/validations.rb
+- lib/pg_spec_helper/version.rb
+homepage: 
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/craigulliott/pg_spec_helper/
+  changelog_uri: https://github.com/craigulliott/pg_spec_helper/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key: 
+specification_version: 4
+summary: Helper class for working with PostgreSQL in a testing environment
+test_files: []