potluck-postgres 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2077db990cc6b953fe7034b0d0289a8442173a9734db26281cc37497a1887559
-  data.tar.gz: 33ea6d44e01545a3c4002e8743243aac70f72c0b642e45584ecc7aabcda29fd4
+  metadata.gz: 667d6b357e4b021bba60a415b90f8623d9b72683ed3b5869ce87f2e43e033325
+  data.tar.gz: 656fd69e5541b414c9e67f750daabaf072c94fbf1237042424a3a5848cfedfa8
 SHA512:
-  metadata.gz: 2a1ba7770728c55170bc6342ecc4b5f1a83e60524f0b434bcc2c7837dc43a7630ad30e24663fbda02ae73eef7e80ab40196b0e8585c95aeb60752cd660da84f1
-  data.tar.gz: c325a86a0c061e29ccd4430ffc57dc284817722dc410bfb07ae0ab5bf8fea3b679eda1494eb4c784e4c0acea262cdc572140d83f14f6b3bc6c0033cd5848261b
+  metadata.gz: 03b852e0ce06ed33d0c7010779eb5bd6d1804e0151df4814a3ad218a50ffcaa27daebf47e7b7288ac7755c75ef4c11b003a82516f6a383e724dbbcdc4269759c
+  data.tar.gz: c3cfc79e9c846ca36e2da1015871cac23928bca1291bb7ee7c05ec8b459c71c4918bf057f70516da5dec9a6ab6942a4fc9d1428af970ab79bbfb20936039f5d9

data/lib/potluck/postgres.rb

@@ -4,6 +4,30 @@ require('potluck')
 require('sequel')
 
 module Potluck
+  ##
+  # Error class used to wrap errors encountered while connecting to or setting up a database.
+  #
+  class PostgresError < ServiceError
+    attr_reader(:wrapped_error)
+
+    ##
+    # Creates a new instance.
+    #
+    # * +message+ - Error message.
+    # * +wrapped_error+ - Original error that was rescued and is being wrapped by this one (optional).
+    #
+    def initialize(message, wrapped_error = nil)
+      super(message)
+
+      @wrapped_error = wrapped_error
+    end
+  end
+
+  ##
+  # A Ruby interface for controlling and connecting to Postgres. Uses
+  # [Sequel](https://github.com/jeremyevans/sequel) to connect and perform automatic role and database
+  # creation, as well as for utility methods such as database schema migration.
+  #
   class Postgres < Service
     ROLE_NOT_FOUND_REGEX = /role .* does not exist/.freeze
     DATABASE_NOT_FOUND_REGEX = /database .* does not exist/.freeze
@@ -16,12 +40,29 @@ module Potluck
 
     attr_reader(:database)
 
+    ##
+    # Creates a new instance.
+    #
+    # * +config+ - Configuration hash to pass to <tt>Sequel.connect</tt>.
+    # * +args+ - Arguments to pass to Potluck::Service.new (optional).
+    #
     def initialize(config, **args)
       super(**args)
 
       @config = config
     end
 
+    ##
+    # Disconnects and stops the Postgres process.
+    #
+    def stop
+      disconnect
+      super
+    end
+
+    ##
+    # Connects to the configured Postgres database.
+    #
     def connect
       (tries ||= 0) && (tries += 1)
       @database = Sequel.connect(@config, logger: @logger)
@@ -47,49 +88,27 @@ module Potluck
         sleep(1)
         retry
       elsif message.include?(CONNECTION_REFUSED_STRING)
-        abort("#{e.class}: #{e.message.strip}")
+        raise(PostgresError.new(e.message.strip, e))
       else
-        abort("#{e.class}: #{e.message.strip}\n  #{e.backtrace.join("\n  ")}")
+        raise
       end
     end
 
+    ##
+    # Disconnects from the database if a connection was made.
+    #
     def disconnect
       @database&.disconnect
     end
 
-    def create_database_role
-      tmp_config = @config.dup
-      tmp_config[:database] = 'postgres'
-      tmp_config[:username] = ENV['USER']
-      tmp_config[:password] = nil
-
-      begin
-        Sequel.connect(tmp_config, logger: @logger) do |database|
-          database.execute("CREATE ROLE #{@config[:username]} WITH LOGIN CREATEDB REPLICATION PASSWORD "\
-            "'#{@config[:password]}'")
-        end
-      rescue => e
-        @logger.error("#{e.class}: #{e.message.strip}\n  #{e.backtrace.join("\n  ")}\n")
-        abort("Could not create role '#{@config[:username]}'. Make sure database user '#{ENV['USER']}' "\
-          'has permission to do so, or create it manually.')
-      end
-    end
-
-    def create_database
-      tmp_config = @config.dup
-      tmp_config[:database] = 'postgres'
-
-      begin
-        Sequel.connect(tmp_config, logger: @logger) do |database|
-          database.execute("CREATE DATABASE #{@config[:database]}")
-        end
-      rescue => e
-        @logger.error("#{e.class}: #{e.message.strip}\n  #{e.backtrace.join("\n  ")}\n")
-        abort("Could not create database '#{@config[:database]}'. Make sure database user "\
-          "'#{@config[:username]}' has permission to do so, or create it manually.")
-      end
-    end
-
+    ##
+    # Runs database migrations by way of Sequel's migration extension. Migration files must use the
+    # timestamp naming strategy as opposed to integers.
+    #
+    # * +dir+ - Directory where migration files are located.
+    # * +steps+ - Number of steps forward or backward to migrate from the current migration, otherwise will
+    #   migrate to latest (optional).
+    #
     def migrate(dir, steps = nil)
       return unless File.directory?(dir)
 
@@ -97,7 +116,7 @@ module Potluck
 
       # Suppress Sequel schema migration table queries.
       original_level = @logger.level
-      @logger.level = Logger::WARN
+      @logger.level = Logger::WARN if @logger.level == Logger::INFO
 
       args = [Sequel::Model.db, dir, {allow_missing_migration_files: true}]
       migrator = Sequel::TimestampMigrator.new(*args)
@@ -120,10 +139,55 @@ module Potluck
       migrator = Sequel::TimestampMigrator.new(*args)
       @logger.level = original_level
       migrator.run
+    ensure
+      @logger.level = original_level if original_level
     end
 
     private
 
+    ##
+    # Attempts to connect to the 'postgres' database as the system user with no password and create the
+    # configured role. Useful in development.
+    #
+    def create_database_role
+      tmp_config = @config.dup
+      tmp_config[:database] = 'postgres'
+      tmp_config[:username] = ENV['USER']
+      tmp_config[:password] = nil
+
+      begin
+        Sequel.connect(tmp_config, logger: @logger) do |database|
+          database.execute("CREATE ROLE #{@config[:username]} WITH LOGIN CREATEDB REPLICATION PASSWORD "\
+            "'#{@config[:password]}'")
+        end
+      rescue => e
+        raise(PostgresError.new("Database role #{@config[:username].inspect} could not be created using "\
+          "system user #{tmp_config[:username].inspect}. Please create the role manually.", e))
+      end
+    end
+
+    ##
+    # Attempts to connect to the 'postgres' database with the configured user and password and create the
+    # configured database. Useful in development.
+    #
+    def create_database
+      tmp_config = @config.dup
+      tmp_config[:database] = 'postgres'
+
+      begin
+        Sequel.connect(tmp_config, logger: @logger) do |database|
+          database.execute("CREATE DATABASE #{@config[:database]}")
+        end
+      rescue => e
+        raise(PostgresError.new("Database #{@config[:database].inspect} could not be created by "\
+          "connecting to system database #{tmp_config[:database].inspect}. Please create the database "\
+          'manually.', e))
+      end
+    end
+
+    ##
+    # Content of the launchctl plist file.
+    #
     def self.plist
       super(
         <<~EOS

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: potluck-postgres
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Nate Pickens
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-28 00:00:00.000000000 Z
+date: 2021-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: potluck
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.0.4
+        version: 0.0.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.0.4
+        version: 0.0.5
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement