pg_spec_helper 1.8.3 → 1.8.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0273accb1b779e4bc7110b9ddb01642f49c4417dfe6a3460d2f17d4ce8534ba4
-  data.tar.gz: e5524ec22aa600611f4703e3a34bde74d6303bc829a2d708f486628dc125e0dd
+  metadata.gz: 80425037527e477dc7bbb76dbeba05d0a9339f6cf829ee1f9d17338c99bb3e95
+  data.tar.gz: b7a29ce7a34962211ce7100330754b9d10dc53c0910efd5d987c776b9ca9e819
 SHA512:
-  metadata.gz: c8e3bdf16a61937ec635969008f29bacac74ee58d5bff2995b3279bd9eeb7e3d702ac8b8b7b1489ca29a7018dd30c5d76fdad23634177e2b35d248da6422bb9f
-  data.tar.gz: 3586365ba81191a108877387224d71634b93db0712b89ac43746de5716a027cca1c24fd3c647950b6ab09475b62f028d7c6fe198440b9a95671632a38e635dcd
+  metadata.gz: a47cc3dc6c0744df722e420af888ffb552b6df4aeb44caeef0e8d5c6a8f25e4ec2218ac6f537caca7d23d891e09631aa8951b57934b5bea070a8535b21d22807
+  data.tar.gz: d255fd2adaffd140017ff8c8a8961e1251782b6bee1773ebaee283e86be75a5acbd70c5df5aa87a9f236266b34f9cffc331e07e0581958c62d4918e1f47d83f0

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [1.8.5](https://github.com/craigulliott/pg_spec_helper/compare/v1.8.4...v1.8.5) (2023-08-19)
+
+
+### Bug Fixes
+
+* removing the sanitization of sql data (it is useless in this gem, and gets in the way of testing some things, which defeats the point of this gem) ([fe6af3b](https://github.com/craigulliott/pg_spec_helper/commit/fe6af3bd4443b140a3136d43f1da61315de4d761))
+
+## [1.8.4](https://github.com/craigulliott/pg_spec_helper/compare/v1.8.3...v1.8.4) (2023-08-18)
+
+
+### Bug Fixes
+
+* function definitions no longer presume/add their own BEGIN and END, which now allows providing custom SQL such as DEFINE statements ([2ec7d00](https://github.com/craigulliott/pg_spec_helper/commit/2ec7d00bd2ad539860384981586b0bcee98d56a7))
+
 ## [1.8.3](https://github.com/craigulliott/pg_spec_helper/compare/v1.8.2...v1.8.3) (2023-08-06)
 
 

data/lib/pg_spec_helper/columns.rb

@@ -10,7 +10,7 @@ class PGSpecHelper
       # 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} #{null ? "" : "NOT NULL"}
+          ADD COLUMN #{connection.quote_ident column_name.to_s} #{type} #{null ? "" : "NOT NULL"}
       SQL
     end
 

data/lib/pg_spec_helper/foreign_keys.rb

@@ -4,14 +4,14 @@ class PGSpecHelper
   module ForeignKeys
     # Create a foreign key
     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| sanitize_name n }.join(", ")
-      foreign_column_names_sql = foreign_column_names.map { |n| sanitize_name n }.join(", ")
+      column_names_sql = column_names.join(", ")
+      foreign_column_names_sql = foreign_column_names.join(", ")
       # add the foreign key
       connection.exec(<<~SQL)
-        ALTER TABLE #{sanitize_name schema_name}.#{sanitize_name table_name}
-          ADD CONSTRAINT #{sanitize_name foreign_key_name}
+        ALTER TABLE #{schema_name}.#{table_name}
+          ADD CONSTRAINT #{foreign_key_name}
           FOREIGN KEY (#{column_names_sql})
-            REFERENCES #{sanitize_name foreign_schema_name}.#{sanitize_name foreign_table_name} (#{foreign_column_names_sql})
+            REFERENCES #{foreign_schema_name}.#{foreign_table_name} (#{foreign_column_names_sql})
       SQL
     end
 

data/lib/pg_spec_helper/functions.rb

@@ -6,9 +6,7 @@ class PGSpecHelper
     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.strip};
-        RETURN NEW;
-        END$$;
+        $$#{function_definition.strip}$$;
       SQL
     end
 

data/lib/pg_spec_helper/indexes.rb

@@ -4,7 +4,7 @@ class PGSpecHelper
   module Indexes
     # 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(", ")
+      column_names_sql = column_names.join(", ")
       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})

data/lib/pg_spec_helper/materialized_views.rb

@@ -71,7 +71,7 @@ class PGSpecHelper
       # time the materialized view is found to exist, at which point the method
       # will always return true
       @materialized_views[schema_name.to_sym][materialized_view_name.to_sym][:exists] ||= connection.exec(<<~SQL).count > 0
-        SELECT TRUE AS exists FROM pg_matviews WHERE schemaname = '#{sanitize_name schema_name}' AND matviewname = '#{sanitize_name materialized_view_name}';
+        SELECT TRUE AS exists FROM pg_matviews WHERE schemaname = '#{schema_name}' AND matviewname = '#{materialized_view_name}';
       SQL
     end
 

data/lib/pg_spec_helper/primary_keys.rb

@@ -7,8 +7,8 @@ class PGSpecHelper
       column_names_sql = column_names.map { |n| connection.quote_ident n.to_s }.join(", ")
       # add the primary_key
       connection.exec(<<~SQL)
-        ALTER TABLE #{sanitize_name schema_name.to_s}.#{sanitize_name table_name.to_s}
-          ADD CONSTRAINT #{sanitize_name primary_key_name}
+        ALTER TABLE #{schema_name}.#{table_name}
+          ADD CONSTRAINT #{primary_key_name}
           PRIMARY KEY (#{column_names_sql})
       SQL
     end

data/lib/pg_spec_helper/schemas.rb

@@ -11,7 +11,7 @@ class PGSpecHelper
 
     # return a list of the schema names in the database
     def get_schema_names
-      ignored_schemas_sql = ignored_schemas.map { |n| sanitize_name n }.join("', '")
+      ignored_schemas_sql = ignored_schemas.join("', '")
       # return a list of the schema names from the database
       results = connection.exec(<<~SQL)
         SELECT schema_name

data/lib/pg_spec_helper/tables.rb

@@ -5,7 +5,7 @@ class PGSpecHelper
     # create a new table in the provided schema
     def create_table schema_name, table_name
       connection.exec(<<~SQL)
-        CREATE TABLE #{sanitize_name schema_name.to_s}.#{sanitize_name table_name.to_s}(
+        CREATE TABLE #{schema_name}.#{table_name}(
           -- tables are created empty, and have columns added to them later
         );
       SQL
@@ -30,7 +30,7 @@ class PGSpecHelper
           -- temporarily set the client_min_messages to WARNING to
           -- suppress the NOTICE messages about cascading deletes
           SET client_min_messages TO WARNING;
-          DROP TABLE #{sanitize_name schema_name.to_s}.#{sanitize_name table_name.to_s} CASCADE;
+          DROP TABLE #{schema_name}.#{table_name} CASCADE;
           SET client_min_messages TO NOTICE;
         SQL
       end

data/lib/pg_spec_helper/version.rb

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

data/lib/pg_spec_helper.rb

@@ -6,7 +6,6 @@ require "pg"
 require "pg_spec_helper/version"
 
 require "pg_spec_helper/connection"
-require "pg_spec_helper/sanitize"
 require "pg_spec_helper/ignored_schemas"
 require "pg_spec_helper/schemas"
 require "pg_spec_helper/tables"
@@ -31,7 +30,6 @@ class PGSpecHelper
   end
 
   include Connection
-  include Sanitize
   include IgnoredSchemas
   include Schemas
   include Tables

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pg_spec_helper
 version: !ruby/object:Gem::Version
-  version: 1.8.3
+  version: 1.8.5
 platform: ruby
 authors:
 - Craig Ulliott
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-06 00:00:00.000000000 Z
+date: 2023-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
@@ -62,7 +62,6 @@ files:
 - 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

data/lib/pg_spec_helper/sanitize.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-class PGSpecHelper
-  module Sanitize
-    class UnsafePostgresNameError < StandardError
-    end
-
-    # returns a sanitized version of the provided name, raises an error
-    # if it is not valid
-    #
-    # this is probably unnessesary due to this gem being used within a test
-    # suite and not a production application, but it is here for completeness
-    # and an abundance of caution
-    def sanitize_name name
-      # ensure the name is a string
-      name = name.to_s
-      # ensure the name is not empty
-      raise UnsafePostgresNameError, "name cannot be empty" if name.empty?
-      # ensure the name does not contain invalid characters
-      raise UnsafePostgresNameError, "name contains invalid characters" unless /\A[a-zA-Z0-9_-]+\z/.match?(name)
-      # return the name
-      name
-    end
-  end
-end