pg_spec_helper 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0448eb4ca85825f030ce96b4138d8bbf1ecce2dd51e6767a936591582034bd99'
-  data.tar.gz: bd24c7db5a5ad3c267dd4b26d7b753aaa547db79e662235d96bb027e5cc8e5e7
+  metadata.gz: 5c885ddde22232c3907a08da5411a55e09b1105a87afbac5aac0b2b443c63ee1
+  data.tar.gz: a8220ca48f1dea784d20e45ecc74dfd0f464c8524a55240715bb7154dc6f8879
 SHA512:
-  metadata.gz: 8ec24b586e7b1550c638b9c1387ef3ac60b244ab35c857f95ab75e661f725f2c2eefeb65326ca946c2f0c97593db15bb8e3e156831cbbe72631d3afc46f29215
-  data.tar.gz: b4b3982f19db7d7fc2ee038167eb8fea189a368d1ac6cb98916da60008635ba2293998216a057e451523b45855b6c0d8d8992ecda80b86c030f929fa306d12f1
+  metadata.gz: '08770ab6431e7b5d2f21b0443d88282400ea597d78b946fe5c68b4c4ff562ae7bd14e0ddb5db4c5353ec8954ee0472ce5e5a2858259186504469f0a6783d66df'
+  data.tar.gz: f811831ee0dc0381a3252556d28c1ac85f476707ab3ac6fd3c951c0c2ecb985ea7d18a1daf663d27ce533c06cab94e91d0963a200a88590bae5004a14d64b0d7

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [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/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/triggers.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+class PGSpecHelper
+  module Triggers
+    # create a trigger
+    class UnexpectedEventManipulationError < StandardError
+    end
+
+    class UnexpectedActionOrderError < StandardError
+    end
+
+    class UnexpectedActionStatementError < StandardError
+    end
+
+    class UnexpectedActionOrientationError < StandardError
+    end
+
+    class UnexpectedActionTimingError < 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 ExpectedStringError, action_condition
+      end
+
+      unless [:row, :statement].include? action_orientation
+        raise UnexpectedActionOrientationError, action_orientation
+      end
+
+      unless [:before, :after].include? action_timing
+        raise UnexpectedActionTimingError, action_timing
+      end
+
+      # BEFORE INSERT / AFTER INSERT / BEFORE UPDATE / AFTER UPDATE / BEFORE DELETE / AFTER DELETE
+      timing_sql = "#{action_timing} #{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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class PGSpecHelper
-  VERSION = "1.5.0"
+  VERSION = "1.6.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.6.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