potluck-postgres 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6484b446d1c719baef9d5aec6fc545d305107581c62335c33e9b30098f050ff7
-  data.tar.gz: a9b09e742ea51367296b898ca20c331830203eace33489e28e7820d3fe914cab
+  metadata.gz: d3589dd2164df71a6b980010ec03dc41416932e611f9b4b4ec1af4eb6d242015
+  data.tar.gz: 77616c26926b0ef95615f775f06fae452e875c752fbe1f4d3acf26f46e059dd9
 SHA512:
-  metadata.gz: 9f1433d0ac8702cb655ce8e7dcdea53c1a196e27e6cce9619b7f79405028e6693565bcfda69d6ade2940950661fbc6b84fdb293aeb25a9462b8ae905550e122f
-  data.tar.gz: 4e7f3c780602ba4c62021b0611d9adf44b0dadb049c3ee448c20280141e78588ceff79b2876034af53c584a97349a902ab79df30f0b41fd1b1102c923b00d136
+  metadata.gz: 69805ee76d46065bb43d7b9d986221616c5ea58448acebcfbdc239556d54a254ba02e5824563d4cf9114fed2e939b41117574c2d5eaf6cd4bb528d354d704adc
+  data.tar.gz: 9400d94168b212a455450a52a5b8160899b619cb8ad549b20f84b3446cbc72b23b25fed6699e2a13db2d5f31e16e68a4bf79b4748f1f709fef35f3027653b9d8

data/VERSION

@@ -1 +1 @@
-0.0.7
+0.0.8

data/lib/potluck/postgres/version.rb

@@ -2,6 +2,6 @@
 
 module Potluck
   class Postgres < Service
-    VERSION = '0.0.7'
+    VERSION = '0.0.8'
   end
 end

data/lib/potluck/postgres.rb

@@ -5,18 +5,14 @@ require('sequel')
 require_relative('postgres/version')
 
 module Potluck
-  ##
-  # Error class used to wrap errors encountered while connecting to or setting up a database.
-  #
+  # Public: 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).
+    # Public: Create a new instance.
     #
+    # message       - String error message.
+    # wrapped_error - Original Exception that was rescued and is being wrapped by this one.
     def initialize(message, wrapped_error = nil)
       super(message)
 
@@ -24,46 +20,91 @@ module Potluck
     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.
-  #
+  # Public: A Ruby interface for controlling and connecting to Postgres. Uses the Sequel gem 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
+    ROLE_NOT_FOUND_REGEX = /role .* does not exist/
+    DATABASE_NOT_FOUND_REGEX = /database .* does not exist/
 
     STARTING_UP_STRING = 'the database system is starting up'
-    STARTING_UP_TIMEOUT = 30
+    STARTING_UP_TRIES = 30
 
     CONNECTION_REFUSED_STRING = 'connection refused'
-    CONNECTION_REFUSED_TIMEOUT = 3
+    CONNECTION_REFUSED_TRIES = 3
 
     attr_reader(:database)
 
-    ##
-    # Creates a new instance.
+    # Public: Get the content of the launchctl plist file.
     #
-    # * +config+ - Configuration hash to pass to <tt>Sequel.connect</tt>.
-    # * +args+ - Arguments to pass to Potluck::Service.new (optional).
+    # Returns the String content.
+    def self.plist
+      dir = postgres_dir
+
+      super(
+        <<~XML
+          <key>EnvironmentVariables</key>
+          <dict>
+            <key>LC_ALL</key>
+            <string>C</string>
+          </dict>
+          <key>ProgramArguments</key>
+          <array>
+            <string>#{Potluck.config.homebrew_prefix}/opt/#{dir}/bin/postgres</string>
+            <string>-D</string>
+            <string>#{Potluck.config.homebrew_prefix}/var/#{dir}</string>
+          </array>
+          <key>WorkingDirectory</key>
+          <string>#{Potluck.config.homebrew_prefix}</string>
+          <key>StandardOutPath</key>
+          <string>#{Potluck.config.homebrew_prefix}/var/log/#{dir}.log</string>
+          <key>StandardErrorPath</key>
+          <string>#{Potluck.config.homebrew_prefix}/var/log/#{dir}.log</string>
+        XML
+      )
+    end
+
+    # Public: Get the directory of the latest Homebrew-installed Postgres version.
     #
-    def initialize(config, **args)
-      super(**args)
+    # Returns the String path.
+    # Raises PostgresError if no Homebrew Postgres installation is found.
+    def self.postgres_dir
+      versions = Dir[File.join(Potluck.config.homebrew_prefix, 'opt', 'postgresql@*')].sort_by do |path|
+        path.split('@').last.to_f
+      end
+
+      if versions.empty?
+        raise(PostgresError, 'No Postgres installation found (try running `brew install postgresql@X`)')
+      end
+
+      File.basename(versions.last)
+    end
+
+    # Public: Create a new instance.
+    #
+    # config - Configuration Hash to pass to Sequel.connect.
+    # kwargs - Hash of keyword arguments to pass to Service.new.
+    def initialize(config, **kwargs)
+      super(**kwargs)
 
       @config = config
     end
 
-    ##
-    # Disconnects and stops the Postgres process.
+    # Public: Disconnect and stop the Postgres process.
     #
+    # Returns nothing.
     def stop
       disconnect
       super
     end
 
-    ##
-    # Connects to the configured Postgres database.
+    # Public: Connect to the configured Postgres database.
     #
+    # Returns nothing.
+    # Raises Sequel::DatabaseConnectionError if connecting fails.
+    # Raises PostgresError if role creation was attempted and failed.
+    # Raises PostgresError if database creation was attempted and failed.
+    # Raises PostgresError if permission grant was attempted and failed.
     def connect
       role_created = false
       database_created = false
@@ -87,14 +128,12 @@ module Potluck
           database_created = true
           create_database
           retry
-        elsif message.include?(STARTING_UP_STRING) && tries < STARTING_UP_TIMEOUT
+        elsif message.include?(STARTING_UP_STRING) && tries < STARTING_UP_TRIES
           sleep(1)
           retry
-        elsif message.include?(CONNECTION_REFUSED_STRING) && tries < CONNECTION_REFUSED_TIMEOUT
+        elsif message.include?(CONNECTION_REFUSED_STRING) && tries < CONNECTION_REFUSED_TRIES
           sleep(1)
           retry
-        elsif message.include?(CONNECTION_REFUSED_STRING)
-          raise(PostgresError.new(e.message.strip, e))
         else
           raise
         end
@@ -106,22 +145,27 @@ module Potluck
       grant_permissions if role_created && !database_created
     end
 
-    ##
-    # Disconnects from the database if a connection was made.
+    # Public: Disconnect from the database if a connection was made.
     #
+    # Returns nothing.
     def disconnect
       @database&.disconnect
     end
 
-    ##
-    # Runs database migrations by way of Sequel's migration extension. Migration files must use the
-    # timestamp naming strategy as opposed to integers.
+    # Deprecated: Run 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).
+    # dir   - String directory where migration files are located.
+    # steps - Integer number of steps forward or backward to migrate from the current migration (if omitted,
+    #         will migrate forward to latest migration).
     #
+    # Returns nothing.
     def migrate(dir, steps = nil)
+      location = caller_locations(1, 1).first
+
+      warn("#{location.path}:#{location.lineno}: #{self.class.name}#migrate is deprecated and will be " \
+        "removed soon. Please use Sequel's migration extension directly instead.")
+
       return unless File.directory?(dir)
 
       Sequel.extension(:migration)
@@ -155,67 +199,34 @@ module Potluck
       @logger.level = original_level if original_level
     end
 
-    ##
-    # Content of the launchctl plist file.
-    #
-    def self.plist
-      versions = Dir["#{HOMEBREW_PREFIX}/opt/postgresql@*"].sort_by { |path| path.split('@').last.to_f }
-      version =
-        if versions.empty?
-          raise(PostgresError, "No Postgres installation found (try running `brew install postgresql@X`)")
-        else
-          File.basename(versions.last)
-        end
-
-      super(
-        <<~EOS
-          <key>EnvironmentVariables</key>
-          <dict>
-            <key>LC_ALL</key>
-            <string>C</string>
-          </dict>
-          <key>ProgramArguments</key>
-          <array>
-            <string>#{HOMEBREW_PREFIX}/opt/#{version}/bin/postgres</string>
-            <string>-D</string>
-            <string>#{HOMEBREW_PREFIX}/var/#{version}</string>
-          </array>
-          <key>WorkingDirectory</key>
-          <string>#{HOMEBREW_PREFIX}</string>
-          <key>StandardOutPath</key>
-          <string>#{HOMEBREW_PREFIX}/var/log/#{version}.log</string>
-          <key>StandardErrorPath</key>
-          <string>#{HOMEBREW_PREFIX}/var/log/#{version}.log</string>
-        EOS
-      )
-    end
-
     private
 
-    ##
-    # Attempts to connect to the 'postgres' database as the system user with no password and create the
-    # configured role. Useful in development.
+    # Internal: Attempt to connect to the 'postgres' database as the system user with no password and create
+    # the configured role. Useful in development environments.
     #
+    # Returns nothing.
+    # Raises PostgresError if the role could not be created.
     def create_role
       tmp_config = admin_database_config
       tmp_config[:database] = 'postgres'
 
       begin
         Sequel.connect(tmp_config, logger: @logger) do |database|
-          database.execute("CREATE ROLE \"#{@config[:username]}\" WITH LOGIN CREATEDB REPLICATION"\
+          database.execute("CREATE ROLE \"#{@config[:username]}\" WITH LOGIN CREATEDB REPLICATION" \
             "#{" PASSWORD '#{@config[:password]}'" if @config[:password]}")
         end
       rescue => e
-        raise(PostgresError.new("Failed to create database role #{@config[:username].inspect} by "\
-          "connecting to database #{tmp_config[:database].inspect} as role "\
+        raise(PostgresError.new("Failed to create database role #{@config[:username].inspect} by " \
+          "connecting to database #{tmp_config[:database].inspect} as role " \
           "#{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.
+    # Internal: Attempt to connect to the 'postgres' database with the configured user and password and
+    # create the configured database. Useful in development environments.
     #
+    # Returns nothing.
+    # Raises PostgresError if the database could not be created.
     def create_database
       tmp_config = @config.dup
       tmp_config[:database] = 'postgres'
@@ -225,15 +236,17 @@ module Potluck
           database.execute("CREATE DATABASE \"#{@config[:database]}\"")
         end
       rescue => e
-        raise(PostgresError.new("Failed to create database #{@config[:database].inspect} by connecting to "\
-          "database #{tmp_config[:database].inspect} as role #{tmp_config[:username].inspect}. "\
+        raise(PostgresError.new("Failed to create database #{@config[:database].inspect} by connecting " \
+          "to database #{tmp_config[:database].inspect} as role #{tmp_config[:username].inspect}. " \
           'Please create the database manually.', e))
       end
     end
 
-    ##
-    # Grants appropriate permissions for the configured database role.
+    # Internal: Grant appropriate permissions for the configured database role. Useful in development
+    # environments.
     #
+    # Returns nothing.
+    # Raises PostgresError if permissions could not be granted.
     def grant_permissions
       tmp_config = admin_database_config
 
@@ -241,23 +254,24 @@ module Potluck
         Sequel.connect(tmp_config, logger: @logger) do |db|
           db.execute("GRANT ALL PRIVILEGES ON ALL TABLES IN SCHEMA public TO \"#{@config[:username]}\"")
           db.execute("GRANT ALL PRIVILEGES ON ALL SEQUENCES IN SCHEMA public TO \"#{@config[:username]}\"")
-          db.execute("ALTER DEFAULT PRIVILEGES FOR ROLE \"#{@config[:username]}\" IN SCHEMA public GRANT "\
+          db.execute("ALTER DEFAULT PRIVILEGES FOR ROLE \"#{@config[:username]}\" IN SCHEMA public GRANT " \
             "ALL PRIVILEGES ON TABLES TO \"#{@config[:username]}\"")
         end
       rescue => e
-        raise(PostgresError.new("Failed to grant database permissions for role "\
-          "#{@config[:username].inspect} by connecting as role #{tmp_config[:username].inspect}. Please "\
+        raise(PostgresError.new('Failed to grant database permissions for role ' \
+          "#{@config[:username].inspect} by connecting as role #{tmp_config[:username].inspect}. Please " \
           'grant appropriate permissions manually.', e))
       end
     end
 
-    ##
-    # Returns a configuration hash for connecting to Postgres to perform administrative tasks (i.e. role and
-    # database creation). Uses the system user as the username and no password.
+    # Internal: Return a configuration hash for connecting to Postgres to perform administrative tasks
+    # (role and database creation). Uses the system user as the username and no password. Useful in
+    # development environments
     #
+    # Returns the configuration Hash.
     def admin_database_config
       config = @config.dup
-      config[:username] = ENV['USER']
+      config[:username] = ENV.fetch('USER')
       config[:password] = nil
 
       config

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: potluck-postgres
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Nate Pickens
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-07 00:00:00.000000000 Z
+date: 2025-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: potluck
@@ -16,14 +15,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.0.7
+        version: 0.0.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.0.7
+        version: 0.0.8
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
@@ -70,26 +69,33 @@ dependencies:
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.11.2
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.0.0
+        version: '5.24'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.11.2
-    - - "<"
+        version: '5.24'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.0.0
+        version: '1.7'
 description: An extension to the Potluck gem that provides some basic utilities for
   setting up and connecting to Postgres databases, as well as control over the Postgres
   process.
-email:
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -103,10 +109,9 @@ homepage: https://github.com/npickens/potluck/tree/master/potluck-postgres
 licenses:
 - MIT
 metadata:
-  allowed_push_host: https://rubygems.org
-  homepage_uri: https://github.com/npickens/potluck/tree/master/potluck-postgres
-  source_code_uri: https://github.com/npickens/potluck/tree/master/potluck-postgres
-post_install_message:
+  bug_tracker_uri: https://github.com/npickens/potluck/issues
+  documentation_uri: https://github.com/npickens/potluck/blob/0.0.8/potluck-postgres/README.md
+  source_code_uri: https://github.com/npickens/potluck/tree/0.0.8/potluck-postgres
 rdoc_options: []
 require_paths:
 - lib
@@ -114,15 +119,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.8
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.6.6
 specification_version: 4
 summary: A Ruby manager for Postgres.
 test_files: []