pgtk 0.27.0 → 0.28.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51f0c148d2990a05c012d2da4494bd303f333e428b7c188f9d3efe9a7ff6e078
-  data.tar.gz: 33a5d9b992f0bc16d70cd922a5e15c054f0643e5b376eb039c62d5c129ddada2
+  metadata.gz: 15ef00bc464354f5067a8346303914924549a69127dd7d089511b432ceb61cb5
+  data.tar.gz: f0714a56d3d31bdc90f6a8b24bd871b4ac2256dabe32be94191afb92e2034f74
 SHA512:
-  metadata.gz: 19539334e9bf2f48f5a3a640ab79cb6c737d2e6e7d21d03524c0146cb264f58197adf77cb04fcb4262e5ecc4eab4906f9000e279307a8321d16b7d26806152c3
-  data.tar.gz: 1eab8e38e7d81f9f8dd02e68f8afbc8489a7379f9ee8f74cafb8f9cf3a105b7d11af67204baf9fbe0e8ee3af438f6391aef4a46fb9a96a16e708975a55dbf977
+  metadata.gz: 186a1581c002df615bef9ddecf615140ee0cfe4abd328f7ea841b891d09ffbb3f08ae058eb534abcb4c7002fd2b903d082e4b1d5a577b4f9d615a3b8ee8bd35d
+  data.tar.gz: efa556d86eea1b11834d8c19f3620abcc17d3567d3db0d9452d20c4cdd56ad59db13b38ecded753f86ca14f2d36fc95e7e2f67d43386246071ff3d65675bede0

data/Gemfile.lock

@@ -52,7 +52,7 @@ GEM
     pg (1.6.2-x64-mingw-ucrt)
     pg (1.6.2-x86_64-linux)
     prism (1.6.0)
-    qbash (0.4.7)
+    qbash (0.4.8)
       backtrace (> 0)
       elapsed (> 0)
       loog (> 0)
@@ -102,7 +102,7 @@ GEM
     simplecov_json_formatter (0.1.4)
     slop (4.10.1)
     tago (0.4.0)
-    threads (0.4.1)
+    threads (0.5.0)
       backtrace (~> 0)
       concurrent-ruby (~> 1.0)
     timeout (0.4.4)

data/README.md

@@ -228,8 +228,8 @@ stash = Pgtk::Stash.new(
   cap: 10_000,          # Maximum cached query results (default: 10,000)
   cap_interval: 60,     # Seconds between cache size enforcement (default: 60)
   refill_interval: 16,  # Seconds between stale query refilling (default: 16)
-  refill_delay: 0.5,    # Seconds to wait before refilling the cache (default: 0)
-  retire: 60,           # Maximum age in seconds to keep a query in cache (default: 15 min)
+  refill_delay: 0.5,    # Seconds to wait before refilling the cache
+  retire: 60,           # Maximum age in seconds to keep a query in cache
   retire_interval: 5.5, # How often to retire (default: 60)
   threads: 4,           # Worker threads for background refilling (default: 4)
   max_queue_length: 128 # Maximum refilling tasks in queue (default: 128)

data/lib/pgtk/liquicheck_task.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: Copyright (c) 2019-2025 Yegor Bugayenko
+# SPDX-License-Identifier: MIT
+
+require 'nokogiri'
+require 'rake/tasklib'
+require_relative '../pgtk'
+
+# Liquicheck rake task for check Liquibase XML files.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2019-2025 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
+
+  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
+    task(name, *args) do |_, task_args|
+      RakeFileUtils.send(:verbose, true) do
+        yield(*[self, task_args].slice(0, task_block.arity)) if block_given?
+        run
+      end
+    end
+  end
+
+  private
+
+  def run
+    raise "Option 'dir' is mandatory" if !@dir || @dir.empty?
+    raise "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
+    end
+    return if errors.empty?
+    puts 'There are such errors in the Liquibase XML files.'
+    errors.each do |f, e|
+      puts "In file '#{f}':"
+      e.uniq.each do |msg|
+        puts "  * #{msg}"
+      end
+      puts
+    end
+    exit(1)
+  end
+
+  def on(errors, file, &)
+    yield if block_given?
+  rescue MustError => e
+    (errors[file] ||= []) << e.message
+  end
+
+  def must_have(prop, msg)
+    (raise MustError, msg) if prop.nil? || prop.empty?
+  end
+
+  def must_equal(lprop, rprop, msg)
+    (raise MustError, msg) if lprop != rprop
+  end
+
+  def must_match(prop, regex, msg)
+    (raise MustError, msg) unless prop.match?(regex)
+  end
+
+  MustError = Class.new(StandardError)
+  private_constant :MustError
+end

data/lib/pgtk/stash.rb

@@ -116,67 +116,69 @@ class Pgtk::Stash
   #
   # @return [String] Multi-line text representation of the current cache state
   def dump
-    qq =
-      @stash[:queries].map do |q, kk|
-        {
-          q: q.dup, # the query
-          c: kk.values.count, # how many keys?
-          p: kk.values.sum { |vv| vv[:popularity] }, # total popularity of all keys
-          s: kk.values.count { |vv| vv[:stale] }, # how many stale keys?
-          u: kk.values.map { |vv| vv[:used] }.max || Time.now # when was it used
-        }
-      end
-    [
-      @pool.dump,
-      '',
+    @entrance.with_read_lock do
+      qq =
+        @stash[:queries].map do |q, kk|
+          {
+            q: q.dup, # the query
+            c: kk.values.count, # how many keys?
+            p: kk.values.sum { |vv| vv[:popularity] }, # total popularity of all keys
+            s: kk.values.count { |vv| vv[:stale] }, # how many stale keys?
+            u: kk.values.map { |vv| vv[:used] }.max || Time.now # when was it used
+          }
+        end
       [
-        'Pgtk::Stash (',
+        @pool.dump,
+        '',
         [
-          "threads=#{@threads}",
-          "max_queue_length=#{@max_queue_length}",
-          if @refill_interval
-            [
-              "refill_interval=#{@refill_interval}s",
-              "refill_delay=#{@refill_delay}s"
-            ]
-          else
-            'no refilling'
-          end,
-          if @cap_interval
-            [
-              "cap_interval=#{@cap_interval}s",
-              "cap=#{@cap}"
-            ]
-          else
-            'no capping'
-          end,
-          if @retire_interval
-            [
-              "retire_interval=#{@retire_interval}s",
-              "retire=#{@retire}"
-            ]
-          else
-            'no retirement'
-          end
-        ].flatten.join(', '),
-        '):'
-      ].join,
-      if @tpool
-        "  #{@tpool.queue_length} tasks in the thread pool"
-      else
-        '  Not launched yet'
-      end,
-      "  #{stash_size} queries cached (#{stash_size > @cap ? 'above' : 'below'} the cap)",
-      "  #{@stash[:tables].count} tables in cache",
-      "  #{qq.sum { |a| a[:s] }} stale queries in cache:",
-      qq.select { |a| a[:s].positive? }.sort_by { -_1[:p] }.take(8).map do |a|
-        "    #{a[:c]}/#{a[:p]}p/#{a[:s]}s/#{a[:u].ago}: #{a[:q]}"
-      end,
-      "  #{qq.count { |a| a[:s].zero? }} other queries in cache:",
-      qq.select { |a| a[:s].zero? }.sort_by { -_1[:p] }.take(16).map do |a|
-        "    #{a[:c]}/#{a[:p]}p/#{a[:s]}s/#{a[:u].ago}: #{a[:q]}"
-      end
-    ].join("\n")
+          'Pgtk::Stash (',
+          [
+            "threads=#{@threads}",
+            "max_queue_length=#{@max_queue_length}",
+            if @refill_interval
+              [
+                "refill_interval=#{@refill_interval}s",
+                "refill_delay=#{@refill_delay}s"
+              ]
+            else
+              'no refilling'
+            end,
+            if @cap_interval
+              [
+                "cap_interval=#{@cap_interval}s",
+                "cap=#{@cap}"
+              ]
+            else
+              'no capping'
+            end,
+            if @retire_interval
+              [
+                "retire_interval=#{@retire_interval}s",
+                "retire=#{@retire}"
+              ]
+            else
+              'no retirement'
+            end
+          ].flatten.join(', '),
+          '):'
+        ].join,
+        if @tpool
+          "  #{@tpool.queue_length} tasks in the thread pool"
+        else
+          '  Not launched yet'
+        end,
+        "  #{stash_size} queries cached (#{stash_size > @cap ? 'above' : 'below'} the cap)",
+        "  #{@stash[:tables].count} tables in cache",
+        "  #{qq.sum { |a| a[:s] }} stale queries in cache:",
+        qq.select { |a| a[:s].positive? }.sort_by { -_1[:p] }.take(8).map do |a|
+          "    #{a[:c]}/#{a[:p]}p/#{a[:s]}s/#{a[:u].ago}: #{a[:q]}"
+        end,
+        "  #{qq.count { |a| a[:s].zero? }} other queries in cache:",
+        qq.select { |a| a[:s].zero? }.sort_by { -_1[:p] }.take(16).map do |a|
+          "    #{a[:c]}/#{a[:p]}p/#{a[:s]}s/#{a[:u].ago}: #{a[:q]}"
+        end
+      ].join("\n")
+    end
   end
 
   # Execute a SQL query with optional caching.
@@ -258,7 +260,9 @@ class Pgtk::Stash
   #
   # @return [Integer] Total count of cached query results
   def stash_size
-    @stash[:queries].values.sum { |kk| kk.values.size }
+    @entrance.with_write_lock do
+      @stash[:queries].values.sum { |kk| kk.values.size }
+    end
   end
 
   # Launch background tasks for cache management.
@@ -298,12 +302,13 @@ class Pgtk::Stash
     end
     return unless @refill_interval
     Concurrent::TimerTask.execute(execution_interval: @refill_interval, executor: @tpool) do
-      @stash[:queries]
+      qq =
+        @stash[:queries]
         .map { |k, v| [k, v.values.sum { |vv| vv[:popularity] }, v.values.any? { |vv| vv[:stale] }] }
         .select { _1[2] }
         .sort_by { -_1[1] }
-        .each do |a|
-        q = a[0]
+        .map { |a| a[0] }
+      qq.each do |q|
         @stash[:queries][q].each_key do |k|
           next unless @stash[:queries][q][k][:stale]
           next if @stash[:queries][q][k][:stale] > Time.now - @refill_delay

data/lib/pgtk/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pgtk
 version: !ruby/object:Gem::Version
-  version: 0.27.0
+  version: 0.28.1
 platform: ruby
 authors:
 - Yegor Bugayenko
@@ -156,6 +156,7 @@ files:
 - lib/pgtk.rb
 - lib/pgtk/impatient.rb
 - lib/pgtk/liquibase_task.rb
+- lib/pgtk/liquicheck_task.rb
 - lib/pgtk/pgsql_task.rb
 - lib/pgtk/pool.rb
 - lib/pgtk/retry.rb