pg_spec_helper 1.8.4 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8732b097aad7c3e1dec96adb1ed3b4e18785751fef23248383780e19980fc4d1
-  data.tar.gz: e33a899e37af66b3b91fd49fbeb948ba64e2e5e1d921201d75094f5de4810282
+  metadata.gz: 111948cb669c62fe5e30ff56765ec20856dc53493a87a16304087068dfae8e2e
+  data.tar.gz: 56df8e6b579bb74df75be7e5b8e5a62b2db35ef737d084f92706982e5e39a032
 SHA512:
-  metadata.gz: d4b0f4cbdce40c653211937809b9a0aa0dcc9650bbc278938ed1edaa0616cf0257f5e057784cf8940bd3bb749def9dfaa51dc33b1977b182fc4ea56c349881c7
-  data.tar.gz: aa85da46f45732fb0b33b028d5348064f65cde89f42383adcb4bcea12b1af3a5066c837de8bf98690c4c0d2901d9a5e6eb42ef9a3e74af5c949e00e7495ac984
+  metadata.gz: a03eb171d281e9689c2e4bc1928845a3014e4a1f411f2c6419150bf617ce3fab4d4a6c9e9de8daa1ce885a65daa9e82310bcc92b9b61152eea1b8d1afa6f260a
+  data.tar.gz: e2749f90e7d1dab240f19548de538095d378a62b1b98ae6c69be64866a07fa267175ead068be77fbd15f1f70af514a4a7fa63974e9c8aec1bf8b3962dd8c06cd

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [1.9.0](https://github.com/craigulliott/pg_spec_helper/compare/v1.8.5...v1.9.0) (2023-08-21)
+
+
+### Features
+
+* added support for enums and extensions ([b22f662](https://github.com/craigulliott/pg_spec_helper/commit/b22f662cad22c1220ac6f4bc029ca534348a4bea))
+
+## [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)
 
 

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+class PGSpecHelper
+  module Enums
+    # Create an enum
+    def create_enum schema_name, enum_name, values
+      connection.exec(<<~SQL)
+        CREATE TYPE #{schema_name}.#{enum_name} as ENUM ('#{values.join("','")}')
+      SQL
+    end
+
+    # Drop an enum
+    def drop_enum schema_name, enum_name
+      connection.exec(<<~SQL)
+        DROP TYPE #{schema_name}.#{enum_name}
+      SQL
+    end
+
+    # get a list of enum names for the provided schema
+    def get_enum_names schema_name
+      rows = connection.exec_params(<<~SQL, [schema_name.to_s])
+        SELECT
+          t.typname AS enum_name
+        FROM pg_type t
+          JOIN pg_catalog.pg_namespace n ON n.oid = t.typnamespace
+        WHERE n.nspname = $1 AND t.typname[0] != '_'
+        GROUP BY t.typname
+      SQL
+      rows.map { |row| row["enum_name"].to_sym }
+    end
+  end
+end

data/lib/pg_spec_helper/extensions.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+class PGSpecHelper
+  module Extensions
+    # Create an extension
+    def create_extension extension_name
+      connection.exec(<<~SQL)
+        CREATE EXTENSION "#{extension_name}"
+      SQL
+    end
+
+    # Drop an extension
+    def drop_extension extension_name
+      connection.exec(<<~SQL)
+        DROP EXTENSION "#{extension_name}"
+      SQL
+    end
+
+    # get a list of extension names for the provided table
+    def get_extension_names
+      rows = connection.exec_params(<<~SQL)
+        SELECT
+          extname AS name
+        FROM pg_extension
+      SQL
+      rows.map { |row| row["name"].to_sym }
+    end
+  end
+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/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.4"
+  VERSION = "1.9.0"
 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"
@@ -18,6 +17,8 @@ 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/enums"
+require "pg_spec_helper/extensions"
 require "pg_spec_helper/models"
 require "pg_spec_helper/materialized_views"
 require "pg_spec_helper/reset"
@@ -31,7 +32,6 @@ class PGSpecHelper
   end
 
   include Connection
-  include Sanitize
   include IgnoredSchemas
   include Schemas
   include Tables
@@ -43,6 +43,8 @@ class PGSpecHelper
   include Indexes
   include Triggers
   include Functions
+  include Extensions
+  include Enums
   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.8.4
+  version: 1.9.0
 platform: ruby
 authors:
 - Craig Ulliott
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-18 00:00:00.000000000 Z
+date: 2023-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
@@ -54,6 +54,8 @@ files:
 - lib/pg_spec_helper/columns.rb
 - lib/pg_spec_helper/connection.rb
 - lib/pg_spec_helper/empty_database.rb
+- lib/pg_spec_helper/enums.rb
+- lib/pg_spec_helper/extensions.rb
 - lib/pg_spec_helper/foreign_keys.rb
 - lib/pg_spec_helper/functions.rb
 - lib/pg_spec_helper/ignored_schemas.rb
@@ -62,7 +64,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