pg_spec_helper 1.6.0 → 1.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c885ddde22232c3907a08da5411a55e09b1105a87afbac5aac0b2b443c63ee1
-  data.tar.gz: a8220ca48f1dea784d20e45ecc74dfd0f464c8524a55240715bb7154dc6f8879
+  metadata.gz: 17fc16c3791eb6ee55c8e8e80d2ac6c4c2e79fd8b126d114463c50d38bb38bd2
+  data.tar.gz: 1982015231eec0884fc3bd7f5eeeae18b401f02140fa9aaafaa874a78bd602fb
 SHA512:
-  metadata.gz: '08770ab6431e7b5d2f21b0443d88282400ea597d78b946fe5c68b4c4ff562ae7bd14e0ddb5db4c5353ec8954ee0472ce5e5a2858259186504469f0a6783d66df'
-  data.tar.gz: f811831ee0dc0381a3252556d28c1ac85f476707ab3ac6fd3c951c0c2ecb985ea7d18a1daf663d27ce533c06cab94e91d0963a200a88590bae5004a14d64b0d7
+  metadata.gz: 28de3b1fe55f219949ffb1703c24b20d5de0157a8c44ff4bb749e176053e0d01cdd7ae5f2e75996bd457bb8121c0dd61db0f8ed4a69d1962758b8e6ed376c162
+  data.tar.gz: 17b7496d0ce6bad41fdeeb7fed9edbc1c2ec9469a31788f3709ef902711a59e1dd7a6a07578b5af76c93262ff310ae6ef05f9741745f1db26d8b536d70e56f93

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [1.7.1](https://github.com/craigulliott/pg_spec_helper/compare/v1.7.0...v1.7.1) (2023-08-06)
+
+
+### Bug Fixes
+
+* adding missing error class ([1810743](https://github.com/craigulliott/pg_spec_helper/commit/181074326fbf63eb27760486b4f18e1ea11c86b9))
+
+## [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)
 
 

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

@@ -4,7 +4,7 @@ class PGSpecHelper
   module Functions
     # create a function
     def create_function schema_name, function_name, function_definition
-      connection.exec <<-SQL
+      connection.exec <<~SQL
         CREATE FUNCTION #{schema_name}.#{function_name}() returns trigger language plpgsql AS $$
         BEGIN
           #{function_definition};
@@ -16,7 +16,7 @@ class PGSpecHelper
     # 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])
+      rows = connection.exec(<<~SQL, [schema_name.to_s])
         SELECT
           routine_name
         FROM

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

@@ -6,18 +6,15 @@ class PGSpecHelper
     class UnexpectedEventManipulationError < StandardError
     end
 
-    class UnexpectedActionOrderError < StandardError
-    end
-
-    class UnexpectedActionStatementError < 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
@@ -25,19 +22,19 @@ class PGSpecHelper
       end
 
       unless action_condition.nil? || action_condition.is_a?(String)
-        raise ExpectedStringError, action_condition
+        raise UnexpectedConditionsError, "expected String but got `#{action_condition}`"
       end
 
       unless [:row, :statement].include? action_orientation
         raise UnexpectedActionOrientationError, action_orientation
       end
 
-      unless [:before, :after].include? action_timing
+      unless [:before, :after, :instead_of].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
+      # "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})"
 
@@ -50,7 +47,7 @@ class PGSpecHelper
       end
       temp_tables_sql = temp_tables.any? ? "REFERENCING #{temp_tables.join(" ")}" : ""
 
-      connection.exec <<-SQL
+      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}
@@ -63,7 +60,7 @@ class PGSpecHelper
     # 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])
+      rows = connection.exec(<<~SQL, [schema_name.to_s, table_name.to_s])
         SELECT
         trigger_name
         FROM

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.6.0"
+  VERSION = "1.7.1"
 end

metadata

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