pg_spec_helper 1.5.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0448eb4ca85825f030ce96b4138d8bbf1ecce2dd51e6767a936591582034bd99'
-  data.tar.gz: bd24c7db5a5ad3c267dd4b26d7b753aaa547db79e662235d96bb027e5cc8e5e7
+  metadata.gz: f2030740ae096125c106b944c0984652488f3b48f811aa5c4a4caa9f972099d6
+  data.tar.gz: b3e24f7888d0302b98b69aa7b6c2b52db6d4d3708c9cb060c30d5b41d0ab9bb8
 SHA512:
-  metadata.gz: 8ec24b586e7b1550c638b9c1387ef3ac60b244ab35c857f95ab75e661f725f2c2eefeb65326ca946c2f0c97593db15bb8e3e156831cbbe72631d3afc46f29215
-  data.tar.gz: b4b3982f19db7d7fc2ee038167eb8fea189a368d1ac6cb98916da60008635ba2293998216a057e451523b45855b6c0d8d8992ecda80b86c030f929fa306d12f1
+  metadata.gz: 3d72899156ddd1196b5e1984c6ec3efb12eb1ea1372efe6975d44f9fb4181c948f65ab6b6b63e0b3cf2dc19743c4c7a14b1bb3057e94a2f424be13b2c3684472
+  data.tar.gz: c679e87bfd3fcdd08cec7516bf0388d02b159c4641ec023e08d1f1bd1e187726d74182d14f0a8ba15ca718e12ca7de967c0223a8c17fcc991413a9be6b9aa12f

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [1.7.0](https://github.com/craigulliott/pg_spec_helper/compare/v1.6.0...v1.7.0) (2023-08-06)
+
+
+### Features
+
+* adding support for "instead of" in triggers ([488b4ab](https://github.com/craigulliott/pg_spec_helper/commit/488b4ab5fb458db2c7e2f60395b12dcfa9559459))
+
+## [1.6.0](https://github.com/craigulliott/pg_spec_helper/compare/v1.5.0...v1.6.0) (2023-08-06)
+
+
+### Features
+
+* added support for triggers and functions ([f89bf5e](https://github.com/craigulliott/pg_spec_helper/commit/f89bf5e3afa6fc411e9d1f16cb62db74fc8dc987))
+
 ## [1.5.0](https://github.com/craigulliott/pg_spec_helper/compare/v1.4.0...v1.5.0) (2023-08-01)
 
 

data/lib/pg_spec_helper/columns.rb

@@ -8,7 +8,7 @@ class PGSpecHelper
     # create a column for the provided table
     def create_column schema_name, table_name, column_name, type, null = true
       # note the `type` is safe from sql_injection due to the validation above
-      connection.exec(<<-SQL)
+      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} #{sanitize_name type} #{null ? "" : "NOT NULL"}
       SQL
@@ -16,7 +16,7 @@ class PGSpecHelper
 
     # return an array of column names for the provided table
     def get_column_names schema_name, table_name
-      rows = connection.exec_params(<<-SQL, [schema_name.to_s, table_name.to_s])
+      rows = connection.exec_params(<<~SQL, [schema_name.to_s, table_name.to_s])
         SELECT column_name
         FROM information_schema.columns
         WHERE table_schema = $1
@@ -28,7 +28,7 @@ class PGSpecHelper
 
     # return an array of column names for the provided table
     def is_column_nullable schema_name, table_name, column_name
-      rows = connection.exec_params(<<-SQL, [schema_name.to_s, table_name.to_s, column_name.to_s])
+      rows = connection.exec_params(<<~SQL, [schema_name.to_s, table_name.to_s, column_name.to_s])
         SELECT is_nullable
         FROM information_schema.columns
         WHERE table_schema = $1

data/lib/pg_spec_helper/foreign_keys.rb

@@ -7,7 +7,7 @@ class PGSpecHelper
       column_names_sql = column_names.map { |n| sanitize_name n }.join(", ")
       foreign_column_names_sql = foreign_column_names.map { |n| sanitize_name n }.join(", ")
       # add the foreign key
-      connection.exec(<<-SQL)
+      connection.exec(<<~SQL)
         ALTER TABLE #{sanitize_name schema_name}.#{sanitize_name table_name}
           ADD CONSTRAINT #{sanitize_name foreign_key_name}
           FOREIGN KEY (#{column_names_sql})
@@ -17,7 +17,7 @@ class PGSpecHelper
 
     # returns a list of foreign keys for the provided table
     def get_foreign_key_names schema_name, table_name
-      rows = connection.exec_params(<<-SQL, [schema_name.to_s, table_name.to_s])
+      rows = connection.exec_params(<<~SQL, [schema_name.to_s, table_name.to_s])
         SELECT constraint_name
         FROM information_schema.table_constraints
         WHERE table_schema = $1

data/lib/pg_spec_helper/functions.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+class PGSpecHelper
+  module Functions
+    # create a function
+    def create_function schema_name, function_name, function_definition
+      connection.exec <<~SQL
+        CREATE FUNCTION #{schema_name}.#{function_name}() returns trigger language plpgsql AS $$
+        BEGIN
+          #{function_definition};
+          RETURN NEW;
+        END $$;
+      SQL
+    end
+
+    # return a list of function names for the provided schema
+    def get_function_names schema_name
+      # get the function names
+      rows = connection.exec(<<~SQL, [schema_name.to_s])
+        SELECT
+          routine_name
+        FROM
+          information_schema.routines
+        WHERE
+          routine_schema = $1
+      SQL
+      rows.map { |r| r["routine_name"].to_sym }
+    end
+  end
+end

data/lib/pg_spec_helper/indexes.rb

@@ -5,7 +5,7 @@ class PGSpecHelper
     # Create an index
     def create_index schema_name, table_name, column_names, index_name
       column_names_sql = column_names.map { |n| sanitize_name n }.join(", ")
-      connection.exec(<<-SQL)
+      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} (#{column_names_sql})
       SQL
@@ -13,7 +13,7 @@ class PGSpecHelper
 
     # get a list of index names for the provided table
     def get_index_names schema_name, table_name
-      rows = connection.exec_params(<<-SQL, [schema_name.to_s, table_name.to_s])
+      rows = connection.exec_params(<<~SQL, [schema_name.to_s, table_name.to_s])
         SELECT indexname
         FROM pg_indexes
         WHERE schemaname = $1

data/lib/pg_spec_helper/primary_keys.rb

@@ -6,7 +6,7 @@ class PGSpecHelper
     def create_primary_key schema_name, table_name, column_names, primary_key_name
       column_names_sql = column_names.map { |n| connection.quote_ident n.to_s }.join(", ")
       # add the primary_key
-      connection.exec(<<-SQL)
+      connection.exec(<<~SQL)
         ALTER TABLE #{sanitize_name schema_name.to_s}.#{sanitize_name table_name.to_s}
           ADD CONSTRAINT #{sanitize_name primary_key_name}
           PRIMARY KEY (#{column_names_sql})
@@ -16,7 +16,7 @@ class PGSpecHelper
     # get the primary_key name for the provided table
     def get_primary_key_name schema_name, table_name
       # get the primary_key name
-      rows = connection.exec(<<-SQL, [schema_name.to_s, table_name.to_s])
+      rows = connection.exec(<<~SQL, [schema_name.to_s, table_name.to_s])
         SELECT
           constraint_name
         FROM

data/lib/pg_spec_helper/schemas.rb

@@ -4,7 +4,7 @@ class PGSpecHelper
   module Schemas
     # create a new schema in the database
     def create_schema schema_name
-      connection.exec(<<-SQL)
+      connection.exec(<<~SQL)
         CREATE SCHEMA #{connection.quote_ident schema_name.to_s};
       SQL
     end
@@ -13,7 +13,7 @@ class PGSpecHelper
     def get_schema_names
       ignored_schemas_sql = ignored_schemas.map { |n| sanitize_name n }.join("', '")
       # return a list of the schema names from the database
-      results = connection.exec(<<-SQL)
+      results = connection.exec(<<~SQL)
         SELECT schema_name
           FROM information_schema.schemata
         WHERE
@@ -28,7 +28,7 @@ class PGSpecHelper
     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)
+        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;

data/lib/pg_spec_helper/tables.rb

@@ -4,7 +4,7 @@ class PGSpecHelper
   module Tables
     # create a new table in the provided schema
     def create_table schema_name, table_name
-      connection.exec(<<-SQL)
+      connection.exec(<<~SQL)
         CREATE TABLE #{sanitize_name schema_name.to_s}.#{sanitize_name table_name.to_s}(
           -- tables are created empty, and have columns added to them later
         );
@@ -13,7 +13,7 @@ class PGSpecHelper
 
     # return an array of table names for the provided schema
     def get_table_names schema_name
-      rows = connection.exec_params(<<-SQL, [schema_name.to_s])
+      rows = connection.exec_params(<<~SQL, [schema_name.to_s])
         SELECT table_name FROM information_schema.tables
           WHERE
             table_schema = $1
@@ -26,7 +26,7 @@ class PGSpecHelper
     # delete all tables in the provided schema
     def delete_tables schema_name
       get_table_names(schema_name).each do |table_name|
-        connection.exec(<<-SQL)
+        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;

data/lib/pg_spec_helper/triggers.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+class PGSpecHelper
+  module Triggers
+    # create a trigger
+    class UnexpectedEventManipulationError < StandardError
+    end
+
+    class UnexpectedActionOrientationError < StandardError
+    end
+
+    class UnexpectedActionTimingError < StandardError
+    end
+
+    class UnexpectedConditionsError < StandardError
+    end
+
+    # create a postgres trigger
+    def create_trigger schema_name, table_name, name, action_timing:, event_manipulation:, action_orientation:, routine_schema:, routine_name:, action_condition: nil, action_reference_old_table: nil, action_reference_new_table: nil
+      unless [:insert, :delete, :update].include? event_manipulation
+        raise UnexpectedEventManipulationError, event_manipulation
+      end
+
+      unless action_condition.nil? || action_condition.is_a?(String)
+        raise UnexpectedConditionsError, "expected String but got `#{action_condition}`"
+      end
+
+      unless [:row, :statement].include? action_orientation
+        raise UnexpectedActionOrientationError, action_orientation
+      end
+
+      unless [:before, :after, :instead_of].include? action_timing
+        raise UnexpectedActionTimingError, action_timing
+      end
+
+      # "INSTEAD OF/BEFORE/AFTER" "INSERT/UPDATE/DELETE"
+      timing_sql = "#{action_timing.to_s.sub("_", " ")} #{event_manipulation}".upcase
+
+      condition_sql = action_condition.nil? ? "" : "WHEN (#{action_condition})"
+
+      temp_tables = []
+      unless action_reference_old_table.nil?
+        temp_tables << "OLD TABLE AS #{action_reference_old_table}"
+      end
+      unless action_reference_new_table.nil?
+        temp_tables << "NEW TABLE AS #{action_reference_new_table}"
+      end
+      temp_tables_sql = temp_tables.any? ? "REFERENCING #{temp_tables.join(" ")}" : ""
+
+      connection.exec <<~SQL
+        -- trigger names only need to be unique for this table
+        CREATE TRIGGER #{name}
+          #{timing_sql} ON #{schema_name}.#{table_name} #{temp_tables_sql}
+            FOR EACH #{action_orientation}
+              #{condition_sql}
+              EXECUTE PROCEDURE #{routine_schema}.#{routine_name}();
+      SQL
+    end
+
+    # return a list of trigger names for the provided table
+    def get_trigger_names schema_name, table_name
+      # get the trigger names
+      rows = connection.exec(<<~SQL, [schema_name.to_s, table_name.to_s])
+        SELECT
+        trigger_name
+        FROM
+          information_schema.triggers
+        WHERE
+          event_object_schema = $1
+          AND event_object_table = $2
+      SQL
+      rows.map { |r| r["trigger_name"].to_sym }
+    end
+  end
+end

data/lib/pg_spec_helper/unique_constraints.rb

@@ -6,7 +6,7 @@ class PGSpecHelper
     def create_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)
+      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})
@@ -16,7 +16,7 @@ class PGSpecHelper
     # get a list of unique constraints for the provided table
     def get_unique_constraint_names schema_name, table_name
       # get the unique constraint names
-      rows = connection.exec(<<-SQL, [schema_name.to_s, table_name.to_s])
+      rows = connection.exec(<<~SQL, [schema_name.to_s, table_name.to_s])
         SELECT
           constraint_name
         FROM

data/lib/pg_spec_helper/validations.rb

@@ -6,7 +6,7 @@ class PGSpecHelper
     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)
+      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
@@ -15,7 +15,7 @@ class PGSpecHelper
     # return a list of validation names for the provided table
     def get_validation_names schema_name, table_name
       # get the validation names
-      rows = connection.exec(<<-SQL, [schema_name.to_s, table_name.to_s])
+      rows = connection.exec(<<~SQL, [schema_name.to_s, table_name.to_s])
         SELECT
           constraint_name
         FROM

data/lib/pg_spec_helper/version.rb

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

data/lib/pg_spec_helper.rb

@@ -16,6 +16,8 @@ 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/triggers"
+require "pg_spec_helper/functions"
 require "pg_spec_helper/models"
 require "pg_spec_helper/materialized_views"
 require "pg_spec_helper/reset"
@@ -39,6 +41,8 @@ class PGSpecHelper
   include UniqueConstraints
   include PrimaryKeys
   include Indexes
+  include Triggers
+  include Functions
   include Models
   include MaterializedViews
   include Reset

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pg_spec_helper
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Craig Ulliott
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-01 00:00:00.000000000 Z
+date: 2023-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
@@ -55,6 +55,7 @@ files:
 - lib/pg_spec_helper/connection.rb
 - lib/pg_spec_helper/empty_database.rb
 - lib/pg_spec_helper/foreign_keys.rb
+- lib/pg_spec_helper/functions.rb
 - lib/pg_spec_helper/ignored_schemas.rb
 - lib/pg_spec_helper/indexes.rb
 - lib/pg_spec_helper/materialized_views.rb
@@ -66,6 +67,7 @@ files:
 - lib/pg_spec_helper/table_executer.rb
 - lib/pg_spec_helper/tables.rb
 - lib/pg_spec_helper/track_changes.rb
+- lib/pg_spec_helper/triggers.rb
 - lib/pg_spec_helper/unique_constraints.rb
 - lib/pg_spec_helper/validations.rb
 - lib/pg_spec_helper/version.rb