pgtk 0.29.0 → 0.29.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d009986ef367b868cc530dde2ba4984390fd9489fc61e39a0ea280494e57b327
-  data.tar.gz: bae12eef5b8477fd361ffb2167ffadd823f65f488fa15cf7828f216fa496a87e
+  metadata.gz: 9058b06e680aa6404b1c6f9dc3bdd1f908ac24bc60068e413f979ffa92b7bc07
+  data.tar.gz: 59e67475bb42279e43ef93cda5930a89edf2e0f4006fd3601a6b5f48f1c32692
 SHA512:
-  metadata.gz: a28a8ba102a0f7b19341ac639c2860ae92048c672781e89ce195768f418fdfaf2fc4e2d56e723a270e1af954a8482a141acad4644290bd1e0677cc6d2829d0b0
-  data.tar.gz: 9a75b7c6631915d6e9e066da596ed630dd73ebb1df0ca343510adc3b7dbc749b70b1be42fa5d96227c8fdd0ca7397a826da4026526cb0ee9b1c7fa0923090141
+  metadata.gz: 9e827f631278939888b20c21ff7bd7961db5017f845ca4864144334044b44cb96d4814518c93b55f04a41897fcf52fa90c9e37a2058f1e18d5f555eda553c8b8
+  data.tar.gz: d97fa97e0981a3164aa721f56e28c991fc11661ae83b67f0dbabd651cdb0eaceb15f650fe4d27ad5781fe61b95d04895f820be328a0b39c6f7ba7ee6b02b4abb

data/Gemfile

@@ -6,8 +6,10 @@
 source 'https://rubygems.org'
 gemspec
 
-gem 'minitest', '~>5.25', require: false
+gem 'minitest', '~>6.0', require: false
+gem 'minitest-mock', '~>5.27', require: false
 gem 'minitest-reporters', '~>1.7', require: false
+gem 'minitest-stub-const', '~>0.6', require: false
 gem 'rack', '~>3.1', require: false
 gem 'rake', '~>13.2', require: false
 gem 'rubocop', '~>1.73', require: false

data/Gemfile.lock

@@ -11,6 +11,7 @@ PATH
       qbash (~> 0.4)
       random-port (~> 0.7)
       tago (~> 0.1)
+      waitutil (~> 0.2)
 
 GEM
   remote: https://rubygems.org/
@@ -19,25 +20,28 @@ GEM
     ast (2.4.3)
     backtrace (0.4.1)
     builder (3.3.0)
-    concurrent-ruby (1.3.5)
+    concurrent-ruby (1.3.6)
     differ (0.1.2)
     docile (1.4.1)
-    elapsed (0.2.0)
+    elapsed (0.2.1)
       loog (~> 0.6)
       tago (~> 0.1)
     joined (0.4.0)
-    json (2.16.0)
+    json (2.18.0)
     language_server-protocol (3.17.0.5)
     lint_roller (1.1.0)
     logger (1.7.0)
     loog (0.6.1)
       logger (~> 1.0)
-    minitest (5.26.2)
+    minitest (6.0.0)
+      prism (~> 1.5)
+    minitest-mock (5.27.0)
     minitest-reporters (1.7.1)
       ansi
       builder
       minitest (>= 5.0)
       ruby-progressbar
+    minitest-stub-const (0.6)
     nokogiri (1.18.10-arm64-darwin)
       racc (~> 1.4)
     nokogiri (1.18.10-x64-mingw-ucrt)
@@ -51,7 +55,7 @@ GEM
     pg (1.6.2-arm64-darwin)
     pg (1.6.2-x64-mingw-ucrt)
     pg (1.6.2-x86_64-linux)
-    prism (1.6.0)
+    prism (1.7.0)
     qbash (0.4.8)
       backtrace (> 0)
       elapsed (> 0)
@@ -65,7 +69,7 @@ GEM
       tago (~> 0.0)
     regexp_parser (2.11.3)
     rexml (3.4.4)
-    rubocop (1.81.7)
+    rubocop (1.82.0)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)
@@ -73,7 +77,7 @@ GEM
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 2.9.3, < 3.0)
-      rubocop-ast (>= 1.47.1, < 2.0)
+      rubocop-ast (>= 1.48.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 4.0)
     rubocop-ast (1.48.0)
@@ -101,14 +105,15 @@ GEM
     simplecov-html (0.13.2)
     simplecov_json_formatter (0.1.4)
     slop (4.10.1)
-    tago (0.4.0)
+    tago (0.6.0)
     threads (0.5.0)
       backtrace (~> 0)
       concurrent-ruby (~> 1.0)
-    timeout (0.5.0)
+    timeout (0.6.0)
     unicode-display_width (3.2.0)
       unicode-emoji (~> 4.1)
-    unicode-emoji (4.1.0)
+    unicode-emoji (4.2.0)
+    waitutil (0.2.1)
     xcop (0.8.0)
       differ (~> 0.1.2)
       nokogiri (~> 1.10)
@@ -124,8 +129,10 @@ PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
-  minitest (~> 5.25)
+  minitest (~> 6.0)
+  minitest-mock (~> 5.27)
   minitest-reporters (~> 1.7)
+  minitest-stub-const (~> 0.6)
   pgtk!
   rack (~> 3.1)
   rake (~> 13.2)

data/lib/pgtk/pgsql_task.rb

@@ -10,8 +10,10 @@ require 'rake'
 require 'rake/tasklib'
 require 'random-port'
 require 'shellwords'
+require 'securerandom'
 require 'tempfile'
 require 'yaml'
+require 'waitutil'
 require_relative '../pgtk'
 
 # Pgsql rake task.
@@ -59,6 +61,10 @@ class Pgtk::PgsqlTask < Rake::TaskLib
   # @return [Hash]
   attr_accessor :config
 
+  # Use force docker
+  # @return [Boolean]
+  attr_accessor :force_docker
+
   # Initialize a new PostgreSQL server task.
   #
   # @param [Array] args Task arguments
@@ -85,12 +91,85 @@ class Pgtk::PgsqlTask < Rake::TaskLib
   private
 
   def run
+    local = qbash('postgres -V').start_with?('postgres') && qbash('initdb -V').start_with?('initdb')
+    docker = qbash('docker -v').start_with?('Docker')
+    raise 'You must have PostgreSQL or Docker installed locally' unless local && docker
+    raise 'You cannot force Docker to run, because it is not installed locally' if @force_docker && !docker
     raise "Option 'dir' is mandatory" unless @dir
     raise "Option 'yaml' is mandatory" unless @yaml
     home = File.expand_path(@dir)
     FileUtils.rm_rf(home) if @fresh_start
     raise "Directory/file #{home} is present, use fresh_start=true" if File.exist?(home)
     stdout = @quiet ? nil : $stdout
+    port = @port
+    if port.nil?
+      port = RandomPort::Pool::SINGLETON.acquire
+      puts "Random TCP port #{port} is used for PostgreSQL server" unless @quiet
+    else
+      puts "Required TCP port #{port} is used for PostgreSQL server" unless @quiet
+    end
+    if local && !@force_docker
+      pid = run_local(home, stdout, port)
+      place = "in process ##{pid}"
+    else
+      container = run_docker(home, stdout, port)
+      place = "in container #{container}"
+    end
+    File.write(
+      @yaml,
+      {
+        'pgsql' => {
+          'host' => 'localhost',
+          'port' => port,
+          'dbname' => @dbname,
+          'user' => @user,
+          'password' => @password,
+          'url' => [
+            "jdbc:postgresql://localhost:#{port}/",
+            "#{CGI.escape(@dbname)}?user=#{CGI.escape(@user)}"
+          ].join
+        }
+      }.to_yaml
+    )
+    return if @quiet
+    puts "PostgreSQL has been started #{place}, port #{port}"
+    puts "YAML config saved to #{@yaml}"
+  end
+
+  def run_docker(home, stdout, port)
+    FileUtils.mkdir_p(home)
+    out =
+      qbash(
+        [
+          'docker',
+          'run',
+          '--name pgtk',
+          "--publish #{port}:5432",
+          "-e POSTGRES_USER=#{Shellwords.escape(@user)}",
+          "-e POSTGRES_PASSWORD=#{Shellwords.escape(@password)}",
+          "-e POSTGRES_DB=#{Shellwords.escape(@dbname)}",
+          '--detach',
+          '--rm',
+          'postgres:18.1',
+          @config.map { |k, v| "-c #{Shellwords.escape("#{k}=#{v}")}" }
+        ],
+        log: stdout
+      )
+    container = out.scan(/[a-f0-9]+\Z/).first
+    File.write(File.join(home, 'docker-container'), container)
+    at_exit do
+      qbash("docker stop #{container}")
+      puts "PostgreSQL docker container #{container.inspect} was stopped" unless @quiet
+    end
+    begin
+      WaitUtil.wait_for_service('PG in Docker', 'localhost', port, timeout_sec: 10, delay_sec: 0.1)
+    rescue WaitUtil::TimeoutError => e
+      raise "Failed to start PostgreSQL Docker container #{container.inspect}: #{e.message}"
+    end
+    container
+  end
+
+  def run_local(home, stdout, port)
     Tempfile.open do |pwfile|
       File.write(pwfile.path, @password)
       qbash(
@@ -107,13 +186,6 @@ class Pgtk::PgsqlTask < Rake::TaskLib
         log: stdout
       )
     end
-    port = @port
-    if port.nil?
-      port = RandomPort::Pool::SINGLETON.acquire
-      puts "Random TCP port #{port} is used for PostgreSQL server" unless @quiet
-    else
-      puts "Required TCP port #{port} is used for PostgreSQL server" unless @quiet
-    end
     cmd = [
       'postgres',
       '-k', Shellwords.escape(home),
@@ -131,19 +203,13 @@ class Pgtk::PgsqlTask < Rake::TaskLib
       qbash("kill -TERM #{pid}", log: stdout)
       puts "PostgreSQL killed in PID #{pid}" unless @quiet
     end
-    attempt = 0
     begin
-      TCPSocket.new('localhost', port)
-    rescue StandardError => e
-      sleep(0.1)
-      attempt += 1
-      if attempt > 50
-        puts "+ #{cmd}"
-        puts "stdout:\n#{File.read(File.join(home, 'stdout.txt'))}"
-        puts "stderr:\n#{File.read(File.join(home, 'stderr.txt'))}"
-        raise "Failed to start PostgreSQL database server on port #{port}: #{e.message}"
-      end
-      retry
+      WaitUtil.wait_for_service('PG in local', 'localhost', port, timeout_sec: 10, delay_sec: 0.1)
+    rescue WaitUtil::TimeoutError => e
+      puts "+ #{cmd}"
+      puts "stdout:\n#{File.read(File.join(home, 'stdout.txt'))}"
+      puts "stderr:\n#{File.read(File.join(home, 'stderr.txt'))}"
+      raise "Failed to start PostgreSQL database server on port #{port}: #{e.message}"
     end
     qbash(
       [
@@ -155,24 +221,6 @@ class Pgtk::PgsqlTask < Rake::TaskLib
       ],
       log: stdout
     )
-    File.write(
-      @yaml,
-      {
-        'pgsql' => {
-          'host' => 'localhost',
-          'port' => port,
-          'dbname' => @dbname,
-          'user' => @user,
-          'password' => @password,
-          'url' => [
-            "jdbc:postgresql://localhost:#{port}/",
-            "#{CGI.escape(@dbname)}?user=#{CGI.escape(@user)}"
-          ].join
-        }
-      }.to_yaml
-    )
-    return if @quiet
-    puts "PostgreSQL has been started in process ##{pid}, port #{port}"
-    puts "YAML config saved to #{@yaml}"
+    pid
   end
 end

data/lib/pgtk/version.rb

@@ -11,5 +11,5 @@ require_relative '../pgtk'
 # License:: MIT
 module Pgtk
   # Current version of the library.
-  VERSION = '0.29.0'
+  VERSION = '0.29.1'
 end

data/pgtk.gemspec

@@ -35,5 +35,6 @@ Gem::Specification.new do |s|
   s.add_dependency 'qbash', '~>0.4'
   s.add_dependency 'random-port', '~>0.7'
   s.add_dependency 'tago', '~>0.1'
+  s.add_dependency 'waitutil', '~> 0.2'
   s.metadata['rubygems_mfa_required'] = 'true'
 end

data/resources/pom.xml

@@ -30,6 +30,7 @@
         <configuration>
           <driver>org.postgresql.Driver</driver>
           <verbose>false</verbose>
+          <promptOnNonLocalDatabase>false</promptOnNonLocalDatabase>
         </configuration>
         <executions>
           <execution>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pgtk
 version: !ruby/object:Gem::Version
-  version: 0.29.0
+  version: 0.29.1
 platform: ruby
 authors:
 - Yegor Bugayenko
@@ -135,6 +135,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: waitutil
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
 description: This small Ruby gem helps you integrate PostgreSQL with your Ruby web
   app, through Liquibase. It also adds a simple connection pool and query processor,
   to make SQL manipulation simpler.