pgtk 0.30.5 → 0.30.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5007602ed1eb8c77a95905969c85974f1f89250469008aa6cd92bf52d070a60e
-  data.tar.gz: e50a291add3ea16c4a3ac6cedb223ae0247e262adba559b7edea39f788708ccc
+  metadata.gz: af5dbb83c87c7ade9b9ec80e1c5d63d6c079e3e6d75963c9b20ba3306d151c2d
+  data.tar.gz: 9dfb51f191636813b50a067b484b44d1bbcfd28a810e437d6ac4e3539d2b208f
 SHA512:
-  metadata.gz: d2345f24e3fe662dc6d1f9fca7fc01505b9ab892cbfe8bb527ac8b743f34bdfac28bd0568a3b41d1ec869796fbec24987f9bf17245c99db30f140abad53514a0
-  data.tar.gz: eb61998f1a3af79cb76a6adb1d88bf88a525660c1681e7871c083d0ddbaf60e2d0e9eda42e34bc9cff80c9ab141a7831919eda04a2808e82a886f447cdaced94
+  metadata.gz: a47bb2c8234ff77dfc0dead336bc0010be2bc2e356fd10df8b37e103b9fa72484558ebe4db1e2e389c9186608bd6362690eb5e78ff354df2fe154a778318052c
+  data.tar.gz: '08edebfc99f2225668a613ccec7f79773e1969edd73d69cf7b22ef47838c157164380488f73b90274f86834069b7f3da2fb6abf9ac3dd4e5d50a0bc0786ad1b9'

data/Gemfile

@@ -15,6 +15,7 @@ gem 'qbash', '~>0.0', require: false
 gem 'rack', '~>3.2', require: false
 gem 'rake', '~>13.2', require: false
 gem 'rubocop', '~>1.73', require: false
+gem 'rubocop-elegant', '~>0.0', require: false
 gem 'rubocop-minitest', '~>0.38', require: false
 gem 'rubocop-performance', '~>1.25', require: false
 gem 'rubocop-rake', '~>0.7', require: false

data/Gemfile.lock

@@ -35,7 +35,7 @@ GEM
       tago (~> 0.1)
     ellipsized (0.3.0)
     joined (0.4.0)
-    json (2.19.2)
+    json (2.19.3)
     language_server-protocol (3.17.0.5)
     lint_roller (1.1.0)
     logger (1.7.0)
@@ -52,15 +52,15 @@ GEM
       minitest (>= 5.0, < 7)
       ruby-progressbar
     minitest-stub-const (0.6)
-    nokogiri (1.19.1-arm64-darwin)
+    nokogiri (1.19.2-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.19.1-x64-mingw-ucrt)
+    nokogiri (1.19.2-x64-mingw-ucrt)
       racc (~> 1.4)
-    nokogiri (1.19.1-x86_64-linux-gnu)
+    nokogiri (1.19.2-x86_64-linux-gnu)
       racc (~> 1.4)
     os (1.1.4)
-    parallel (1.27.0)
-    parser (3.3.10.1)
+    parallel (2.0.1)
+    parser (3.3.11.1)
       ast (~> 2.4.1)
       racc
     pg (1.6.3-arm64-darwin)
@@ -76,25 +76,28 @@ GEM
     rack (3.2.6)
     rainbow (3.1.1)
     rake (13.3.1)
-    random-port (0.7.6)
+    random-port (0.8.2)
       tago (~> 0.0)
-    regexp_parser (2.11.3)
+    regexp_parser (2.12.0)
     rexml (3.4.4)
-    rubocop (1.84.1)
+    rubocop (1.86.1)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)
-      parallel (~> 1.10)
+      parallel (>= 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 2.9.3, < 3.0)
       rubocop-ast (>= 1.49.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 4.0)
-    rubocop-ast (1.49.0)
+    rubocop-ast (1.49.1)
       parser (>= 3.3.7.2)
       prism (~> 1.7)
-    rubocop-minitest (0.38.2)
+    rubocop-elegant (0.0.14)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.75)
+    rubocop-minitest (0.39.1)
       lint_roller (~> 1.1)
       rubocop (>= 1.75.0, < 2.0)
       rubocop-ast (>= 1.38.0, < 2.0)
@@ -130,7 +133,7 @@ GEM
       nokogiri (~> 1.10)
       rainbow (~> 3.0)
       slop (~> 4.4)
-    yard (0.9.38)
+    yard (0.9.39)
 
 PLATFORMS
   arm64-darwin-22
@@ -150,6 +153,7 @@ DEPENDENCIES
   rack (~> 3.2)
   rake (~> 13.2)
   rubocop (~> 1.73)
+  rubocop-elegant (~> 0.0)
   rubocop-minitest (~> 0.38)
   rubocop-performance (~> 1.25)
   rubocop-rake (~> 0.7)

data/Rakefile

@@ -5,9 +5,9 @@
 
 require 'os'
 require 'qbash'
-require 'rubygems'
 require 'rake'
 require 'rake/clean'
+require 'rubygems'
 
 def name
   @name ||= File.basename(Dir['*.gemspec'].first, '.*')
@@ -53,7 +53,7 @@ end
 
 require 'xcop/rake_task'
 desc 'Validate all XML/XSL/XSD/HTML files for formatting'
-Xcop::RakeTask.new :xcop do |task|
+Xcop::RakeTask.new(:xcop) do |task|
   task.includes = ['**/*.xml', '**/*.xsl', '**/*.xsd', '**/*.html']
   task.excludes = ['target/**/*', 'coverage/**/*', 'vendor/**/*', 'doc/**/*']
 end

data/lib/pgtk/impatient.rb

@@ -107,15 +107,15 @@ class Pgtk::Impatient
         @pool.exec(sql, *args)
       end
     rescue Timeout::Error => e
-      raise e unless e.message == token
-      raise TooSlow, [
+      raise(e) unless e.message == token
+      raise(TooSlow, [
         'SQL query',
         ("with #{args.count} argument#{'s' if args.count > 1}" unless args.empty?),
         'was terminated after',
         start.ago,
         'of waiting:',
         sql.ellipsized(50).inspect
-      ].compact.join(' ')
+      ].compact.join(' '))
     end
   end
 
@@ -125,8 +125,8 @@ class Pgtk::Impatient
   # @return [Object] Result of the block
   def transaction
     @pool.transaction do |t|
-      t.exec("SET LOCAL statement_timeout = #{(@timeout * 1000).to_i}")
-      yield Pgtk::Impatient.new(t, @timeout)
+      t.exec("SET LOCAL statement_timeout = #{Integer((@timeout * 1000).to_s, 10)}")
+      yield(Pgtk::Impatient.new(t, @timeout))
     end
   end
 end

data/lib/pgtk/liquibase_task.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
+require 'English'
 # SPDX-FileCopyrightText: Copyright (c) 2019-2026 Yegor Bugayenko
 # SPDX-License-Identifier: MIT
 
 require 'donce'
-require 'English'
 require 'loog'
 require 'os'
 require 'qbash'
@@ -19,41 +19,7 @@ require_relative '../pgtk'
 # Copyright:: Copyright (c) 2019-2026 Yegor Bugayenko
 # License:: MIT
 class Pgtk::LiquibaseTask < Rake::TaskLib
-  # Task name
-  # @return [Symbol]
-  attr_accessor :name
-
-  # Path to Liquibase master XML file
-  # @return [String]
-  attr_accessor :master
-
-  # Path to YAML file with PostgreSQL connection details
-  # @return [String, Array<String>]
-  attr_accessor :yaml
-
-  # Path to PG entire SQL schema file, which will be dumped and overwritten after all migrations
-  # @return [String]
-  attr_accessor :schema
-
-  # Whether to suppress output
-  # @return [Boolean]
-  attr_accessor :quiet
-
-  # Liquibase version to use
-  # @return [String]
-  attr_accessor :liquibase_version
-
-  # PostgreSQL JDBC driver version to use
-  # @return [String]
-  attr_accessor :postgresql_version
-
-  # Liquibase contexts to apply
-  # @return [String]
-  attr_accessor :contexts
-
-  # Use docker (set to either :never, :always, or :maybe)
-  # @return [Symbol]
-  attr_accessor :docker
+  attr_accessor :name, :master, :yaml, :schema, :quiet, :liquibase, :postgresql, :contexts, :docker
 
   # Initialize a new Liquibase task.
   #
@@ -65,11 +31,11 @@ class Pgtk::LiquibaseTask < Rake::TaskLib
     @name = args.shift || :liquibase
     @quiet = false
     @contexts = ''
-    @liquibase_version = '3.2.2'
-    @postgresql_version = '42.7.0'
-    desc 'Deploy Liquibase changes to the running PostgreSQL server' unless ::Rake.application.last_description
+    @liquibase = '3.2.2'
+    @postgresql = '42.7.0'
+    desc('Deploy Liquibase changes to the running PostgreSQL server') unless ::Rake.application.last_description
     task(name, *args) do |_, task_args|
-      RakeFileUtils.send(:verbose, true) do
+      RakeFileUtils.verbose(true) do
         yield(*[self, task_args].slice(0, task_block.arity)) if block_given?
         run
       end
@@ -79,34 +45,48 @@ class Pgtk::LiquibaseTask < Rake::TaskLib
   private
 
   def run
-    raise "Option 'master' is mandatory" unless @master
-    raise "Option 'yaml' is mandatory" unless @yaml
-    yml = @yaml
-    unless yml.is_a?(Hash)
-      yml = YAML.load_file(
-        if @yaml.is_a?(Array)
-          @yaml.drop_while { |f| !File.exist?(f) }.first
-        else
-          @yaml
-        end
-      )
-    end
-    raise "YAML configuration is missing the 'pgsql' section" unless yml['pgsql']
+    raise(ArgumentError, "Option 'master' is mandatory") unless @master
+    raise(ArgumentError, "Option 'yaml' is mandatory") unless @yaml
+    yml = config
     @master = File.expand_path(@master)
+    validate(yml)
+    migrate(yml)
+    dump(yml) if @schema
+  end
+
+  def config
+    yml = @yaml
+    return yml if yml.is_a?(Hash)
+    YAML.load_file(
+      if @yaml.is_a?(Array)
+        @yaml.drop_while { |f| !File.exist?(f) }.first
+      else
+        @yaml
+      end
+    )
+  end
+
+  def validate(yml)
+    raise(ArgumentError, "YAML configuration is missing the 'pgsql' section") unless yml['pgsql']
     unless File.exist?(@master)
-      raise \
+      raise(
+        ArgumentError,
         "Liquibase master is absent at '#{@master}'. " \
         'More about this file you can find in Liquibase documentation: ' \
         'https://docs.liquibase.com/concepts/changelogs/xml-format.html'
+      )
     end
+    raise(ArgumentError, "The 'url' is not set in the config (YAML)") if yml['pgsql']['url'].nil?
+    raise(ArgumentError, "The 'user' is not set in the config (YAML)") if yml['pgsql']['user'].nil?
+    raise(ArgumentError, "The 'password' is not set in the config (YAML)") if yml['pgsql']['password'].nil?
+  end
+
+  def migrate(yml)
     pom = File.expand_path(File.join(__dir__, '../../resources/pom.xml'))
-    old = @liquibase_version.match?(/^[1-3]\..+$/)
+    old = @liquibase.match?(/^[1-3]\..+$/)
     url = yml['pgsql']['url']
-    raise "The 'url' is not set in the config (YAML)" if url.nil?
     username = yml['pgsql']['user']
-    raise "The 'user' is not set in the config (YAML)" if username.nil?
     password = yml['pgsql']['password']
-    raise "The 'password' is not set in the config (YAML)" if password.nil?
     Dir.chdir(File.dirname(@master)) do
       qbash(
         'mvn', 'verify',
@@ -117,9 +97,9 @@ class Pgtk::LiquibaseTask < Rake::TaskLib
         '--file',
         Shellwords.escape(pom),
         '--define',
-        "liquibase.version=#{@liquibase_version}",
+        "liquibase.version=#{@liquibase}",
         '--define',
-        "postgresql.version=#{@postgresql_version}",
+        "postgresql.version=#{@postgresql}",
         '--define',
         Shellwords.escape("liquibase.searchPath=#{File.dirname(@master)}"),
         '--define',
@@ -136,49 +116,59 @@ class Pgtk::LiquibaseTask < Rake::TaskLib
         stderr: Loog::REGULAR
       )
     end
-    return unless @schema
+  end
+
+  def dump(yml)
     @schema = File.expand_path(@schema)
-    dump = qbash('pg_dump -V', accept: nil, both: true)
-    local = dump[1].zero?
+    local = qbash('pg_dump -V', accept: nil, both: true)[1].zero?
     docker = qbash('docker -v', accept: nil, both: true)[1].zero?
-    raise 'Cannot generate schema, install either pg_dump or Docker' unless local || docker
-    raise 'You set docker to :always, but Docker is not installed' if @docker == :always && !docker
+    raise(IOError, 'Cannot generate schema, install either pg_dump or Docker') unless local || docker
+    raise(ArgumentError, 'You set docker to :always, but Docker is not installed') if @docker == :always && !docker
+    password = yml['pgsql']['password']
     host = yml.dig('pgsql', 'host')
     Dir.chdir(File.dirname(@schema)) do
       out =
         if (local && @docker != :always) || @docker == :never
-          qbash(
-            'pg_dump',
-            '-h', Shellwords.escape(host),
-            '-p', Shellwords.escape(yml.dig('pgsql', 'port').to_s),
-            '-U', Shellwords.escape(yml.dig('pgsql', 'user')),
-            '-d', Shellwords.escape(yml.dig('pgsql', 'dbname')),
-            '-n', 'public',
-            '--schema-only',
-            env: { 'PGPASSWORD' => password },
-            stdout: @quiet ? Loog::NULL : Loog::REGULAR,
-            stderr: Loog::REGULAR
-          )
+          pgdump(yml, host, password)
         else
           host = donce_host if OS.mac? && ['localhost', '127.0.0.1'].include?(host)
-          donce(
-            image: 'postgres:18.1',
-            args: OS.mac? ? '' : '--network=host',
-            env: { 'PGPASSWORD' => password },
-            command: [
-              'pg_dump',
-              '-h', host,
-              '-p', yml.dig('pgsql', 'port').to_s,
-              '-U', yml.dig('pgsql', 'user'),
-              '-d', yml.dig('pgsql', 'dbname'),
-              '-n', 'public',
-              '--schema-only'
-            ].shelljoin,
-            stdout: @quiet ? Loog::NULL : Loog::REGULAR,
-            stderr: Loog::REGULAR
-          )
+          dockerdump(yml, host, password)
         end
       File.write(@schema, out)
     end
   end
+
+  def pgdump(yml, host, password)
+    qbash(
+      'pg_dump',
+      '-h', Shellwords.escape(host),
+      '-p', Shellwords.escape(yml.dig('pgsql', 'port').to_s),
+      '-U', Shellwords.escape(yml.dig('pgsql', 'user')),
+      '-d', Shellwords.escape(yml.dig('pgsql', 'dbname')),
+      '-n', 'public',
+      '--schema-only',
+      env: { 'PGPASSWORD' => password },
+      stdout: @quiet ? Loog::NULL : Loog::REGULAR,
+      stderr: Loog::REGULAR
+    )
+  end
+
+  def dockerdump(yml, host, password)
+    donce(
+      image: 'postgres:18.1',
+      args: OS.mac? ? '' : '--network=host',
+      env: { 'PGPASSWORD' => password },
+      command: [
+        'pg_dump',
+        '-h', host,
+        '-p', yml.dig('pgsql', 'port').to_s,
+        '-U', yml.dig('pgsql', 'user'),
+        '-d', yml.dig('pgsql', 'dbname'),
+        '-n', 'public',
+        '--schema-only'
+      ].shelljoin,
+      stdout: @quiet ? Loog::NULL : Loog::REGULAR,
+      stderr: Loog::REGULAR
+    )
+  end
 end

data/lib/pgtk/liquicheck_task.rb

@@ -12,26 +12,16 @@ require_relative '../pgtk'
 # Copyright:: Copyright (c) 2019-2026 Yegor Bugayenko
 # License:: MIT
 class Pgtk::LiquicheckTask < Rake::TaskLib
-  # Task name
-  # @return [Symbol]
-  attr_accessor :name
-
-  # Base directory where Liquibase XML files will be stored
-  # @return [String]
-  attr_accessor :dir
-
-  # Migration XML files pattern
-  # @return [String]
-  attr_accessor :pattern
+  attr_accessor :name, :dir, :pattern
 
   def initialize(*args, &task_block)
     super()
     @name = args.shift || :liquicheck
     @dir = 'liquibase'
     @pattern = '*/*.xml'
-    desc 'Check the quality of Liquibase XML files' unless ::Rake.application.last_description
+    desc('Check the quality of Liquibase XML files') unless ::Rake.application.last_description
     task(name, *args) do |_, task_args|
-      RakeFileUtils.send(:verbose, true) do
+      RakeFileUtils.verbose(true) do
         yield(*[self, task_args].slice(0, task_block.arity)) if block_given?
         run
       end
@@ -41,54 +31,62 @@ class Pgtk::LiquicheckTask < Rake::TaskLib
   private
 
   def run
-    raise "Option 'dir' is mandatory" if !@dir || @dir.empty?
-    raise "Option 'pattern' is mandatory" if !@pattern || @pattern.empty?
+    raise(ArgumentError, "Option 'dir' is mandatory") if !@dir || @dir.empty?
+    raise(ArgumentError, "Option 'pattern' is mandatory") if !@pattern || @pattern.empty?
     errors = {}
     Dir[File.join(File.expand_path(File.join(Dir.pwd, @dir)), @pattern)].each do |file|
-      doc = Nokogiri::XML(File.open(file))
-      doc.remove_namespaces!
-      path = doc.at_xpath('databaseChangeLog')&.attr('logicalFilePath')&.to_s
-      on(errors, file) do
-        must_have(path, 'logicalFilePath is empty')
-        must_equal(
-          path,
-          File.basename(file),
-          "logicalFilePath #{path.inspect} does not equal the xml file name #{File.basename(file).inspect}"
-        )
-      end
-      doc.xpath('databaseChangeLog/changeSet').each do |node|
-        id = node.attr('id')&.to_s
-        author = node.attr('author')&.to_s
-        context = node.attr('context')&.to_s
-        on(errors, file) do
-          must_have(id, 'ID is empty')
-          must_match(id, /[-a-z]+/, "ID #{id.inspect} has not suffix in #{context} context") if context
-        end
-        on(errors, file) do
-          must_have(author, 'author is empty')
-          must_match(
-            author,
-            /\A[-_ A-Za-z0-9]+\z/,
-            "author #{author.inspect} has illegal symbols"
-          )
-        end
-        on(errors, file) do
-          must_have(id, 'ID is empty')
-          must_have(path, 'logicalFilePath is empty')
-          must_match(
-            path.gsub(/[-_.a-z]/, ''),
-            /\A#{id.gsub(/[-a-z]/, '')}\z/,
-            "ID #{id.inspect} is not the beginning of a logicalFilePath #{path.inspect}"
-          )
-        end
-      end
+      inspect(errors, file)
+    end
+    report(errors)
+  end
+
+  def inspect(errors, file)
+    doc = Nokogiri::XML(File.open(file))
+    doc.remove_namespaces!
+    path = doc.at_xpath('databaseChangeLog')&.attr('logicalFilePath')&.to_s
+    on(errors, file) do
+      demand(path, 'logicalFilePath is empty')
+      equate(
+        path,
+        File.basename(file),
+        "logicalFilePath #{path.inspect} does not equal the xml file name #{File.basename(file).inspect}"
+      )
+    end
+    doc.xpath('databaseChangeLog/changeSet').each do |node|
+      verify(errors, file, node, path)
     end
+  end
+
+  def verify(errors, file, node, path)
+    id = node.attr('id')&.to_s
+    author = node.attr('author')&.to_s
+    context = node.attr('context')&.to_s
+    on(errors, file) do
+      demand(id, 'ID is empty')
+      confirm(id, /[-a-z]+/, "ID #{id.inspect} has not suffix in #{context} context") if context
+    end
+    on(errors, file) do
+      demand(author, 'author is empty')
+      confirm(author, /\A[-_ A-Za-z0-9]+\z/, "author #{author.inspect} has illegal symbols")
+    end
+    on(errors, file) do
+      demand(id, 'ID is empty')
+      demand(path, 'logicalFilePath is empty')
+      confirm(
+        path.gsub(/[-_.a-z]/, ''),
+        /\A#{id.gsub(/[-a-z]/, '')}\z/,
+        "ID #{id.inspect} is not the beginning of a logicalFilePath #{path.inspect}"
+      )
+    end
+  end
+
+  def report(errors)
     return if errors.empty?
-    puts 'There are such errors in the Liquibase XML files.'
+    puts('There are such errors in the Liquibase XML files.')
     errors.each do |f, e|
-      puts "In file '#{f}':"
+      puts("In file '#{f}':")
       e.uniq.each do |msg|
-        puts "  * #{msg}"
+        puts("  * #{msg}")
       end
       puts
     end
@@ -101,20 +99,19 @@ class Pgtk::LiquicheckTask < Rake::TaskLib
     (errors[file] ||= []) << e.message
   end
 
-  def must_have(prop, msg)
-    (raise MustError, msg) if prop.nil? || prop.empty?
+  def demand(prop, msg)
+    raise(MustError, msg) if prop.nil? || prop.empty?
   end
 
-  def must_equal(lprop, rprop, msg)
-    (raise MustError, msg) if lprop != rprop
+  def equate(lprop, rprop, msg)
+    raise(MustError, msg) if lprop != rprop
   end
 
-  def must_match(prop, regex, msg)
-    (raise MustError, msg) unless prop.match?(regex)
+  def confirm(prop, regex, msg)
+    raise(MustError, msg) unless prop.match?(regex)
   end
 
   class MustError < StandardError
-    # empty by design
   end
   private_constant :MustError
 end