pg_spec_helper 1.4.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68e7d2fca3250ae565d38d0709b1eb73d212b5e6af6c642702e6345123a55e3a
-  data.tar.gz: 9d2340c8d9f285e97ffce51942c359843067c663f0383e0e4a9f752382b91eff
+  metadata.gz: 5c885ddde22232c3907a08da5411a55e09b1105a87afbac5aac0b2b443c63ee1
+  data.tar.gz: a8220ca48f1dea784d20e45ecc74dfd0f464c8524a55240715bb7154dc6f8879
 SHA512:
-  metadata.gz: d124e944257073e9a37a1c39ef1a50ba64a86adc4f436312af1b69554a6b8ebdf36d0fedb375e89a9a521fc7e23f2c08f23bf80b15cdbe7c90c27e04542fc656
-  data.tar.gz: 3cb9e58e2bd59553f94cee19af7f991f14174e8ee51fc8160eb923ebe467e54543a03b9d0895a6f09dd58489763af2b0299dbee3c6e04e8063af28502c17f2f1
+  metadata.gz: '08770ab6431e7b5d2f21b0443d88282400ea597d78b946fe5c68b4c4ff562ae7bd14e0ddb5db4c5353ec8954ee0472ce5e5a2858259186504469f0a6783d66df'
+  data.tar.gz: f811831ee0dc0381a3252556d28c1ac85f476707ab3ac6fd3c951c0c2ecb985ea7d18a1daf663d27ce533c06cab94e91d0963a200a88590bae5004a14d64b0d7

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # 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)
+
+
+### Features
+
+* adding a new create_model method which yields a block to expose a DSL for easily working with the table structure ([dc28d5e](https://github.com/craigulliott/pg_spec_helper/commit/dc28d5ef599d8306564aa7c29d2220fb22ee6dd6))
+
 ## [1.4.0](https://github.com/craigulliott/pg_spec_helper/compare/v1.3.0...v1.4.0) (2023-07-10)
 
 

data/lib/pg_spec_helper/columns.rb

@@ -2,12 +2,15 @@
 
 class PGSpecHelper
   module Columns
+    class ColumnDoesNotExistError < StandardError
+    end
+
     # create a column for the provided table
-    def create_column schema_name, table_name, column_name, type
+    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)
         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}
+          ADD COLUMN #{connection.quote_ident column_name.to_s} #{sanitize_name type} #{null ? "" : "NOT NULL"}
       SQL
     end
 
@@ -22,5 +25,18 @@ class PGSpecHelper
       SQL
       rows.map { |row| row["column_name"].to_sym }
     end
+
+    # 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])
+        SELECT is_nullable
+        FROM information_schema.columns
+        WHERE table_schema = $1
+          AND table_name = $2
+          AND column_name = $3;
+      SQL
+      raise ColumnDoesNotExistError if rows.first.nil?
+      rows.first["is_nullable"] == "YES"
+    end
   end
 end

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/models.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+class PGSpecHelper
+  module Models
+    # create a new table in the provided schema with an auto incrementing id
+    # created_at and updated_at, optionally provide a block which will be
+    # yeilded This allows for syntax such as:
+    #
+    # create_model :users, :optional_schema_name do |t|
+    #   t.add_colmn string :name
+    # end
+    def create_model schema_name, table_name, &block
+      unless schema_exists? schema_name
+        create_schema schema_name
+      end
+      # create the table
+      create_table schema_name, table_name
+      # create the standard columns
+      create_column schema_name, table_name, :id, :serial
+      create_column schema_name, table_name, :created_at, :timestamp
+      create_column schema_name, table_name, :updated_at, :timestamp
+      # add the primary key
+      create_primary_key schema_name, table_name, [:id], :pk
+      # execute the optional block
+      if block
+        this = self
+        if this.is_a? PGSpecHelper
+          TableExecuter.new(this, schema_name, table_name, &block)
+        else
+          raise "Module should be added to PGSpecHelper"
+        end
+      end
+    end
+  end
+end

data/lib/pg_spec_helper/table_executer.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+class PGSpecHelper
+  class TableExecuter
+    def initialize pg_spec_helper, schema_name, table_name, &block
+      @pg_spec_helper = pg_spec_helper
+      @schema_name = schema_name
+      @table_name = table_name
+      instance_exec(&block)
+    end
+
+    def add_column column_name, type, null = true
+      @pg_spec_helper.create_column @schema_name, @table_name, column_name, type, null
+    end
+
+    def add_foreign_key column_names, foreign_schema_name, foreign_table_name, foreign_column_names, foreign_key_name
+      @pg_spec_helper.create_foreign_key @schema_name, @table_name, column_names, foreign_schema_name, foreign_table_name, foreign_column_names, foreign_key_name
+    end
+
+    def add_index column_names, index_name, unique = false
+      @pg_spec_helper.create_index @schema_name, @table_name, column_names, index_name
+    end
+
+    def add_primary_key column_names, primary_key_name
+      @pg_spec_helper.create_primary_key @schema_name, @table_name, column_names, primary_key_name
+    end
+
+    def add_unique_constraint column_names, constraint_key_name
+      @pg_spec_helper.create_unique_constraint @schema_name, @table_name, column_names, constraint_key_name
+    end
+
+    def add_validation validation_name, check_clause
+      @pg_spec_helper.create_validation @schema_name, @table_name, validation_name, check_clause
+    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.4.0"
+  VERSION = "1.6.0"
 end

data/lib/pg_spec_helper.rb

@@ -16,11 +16,16 @@ 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"
 require "pg_spec_helper/empty_database"
 require "pg_spec_helper/track_changes"
 
+require "pg_spec_helper/table_executer"
+
 class PGSpecHelper
   class MissingRequiredOptionError < StandardError
   end
@@ -36,6 +41,9 @@ class PGSpecHelper
   include UniqueConstraints
   include PrimaryKeys
   include Indexes
+  include Triggers
+  include Functions
+  include Models
   include MaterializedViews
   include Reset
   include EmptyDatabase

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pg_spec_helper
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Craig Ulliott
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-10 00:00:00.000000000 Z
+date: 2023-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
@@ -55,15 +55,19 @@ 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
+- lib/pg_spec_helper/models.rb
 - lib/pg_spec_helper/primary_keys.rb
 - lib/pg_spec_helper/reset.rb
 - lib/pg_spec_helper/sanitize.rb
 - lib/pg_spec_helper/schemas.rb
+- 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