ruby-pg-extras 5.3.1 → 5.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79aedbc5d3b30aadde2362bceebac04fe7bc3d3a27e8fc47f1f6b6c0ae287616
-  data.tar.gz: ceea8978021edc90088a012a1fec34c0502da15f5ce60356074d741bcbc82682
+  metadata.gz: 809377163a6ca42ea4b8b0087e1d4ede8cfe326d0ee10a85a32df4d6f0e447f5
+  data.tar.gz: 295812fd83c470552c330bcf520749ebfcd6574270c7f2ee7d58d74c0877b968
 SHA512:
-  metadata.gz: 6cd117553f43c9b211cb07e313f2b83932992a38e5217bdee70dd9d3688e441919bc0dd5a3db32cd7dc20a5c35dddd7b61e34a26ba403f690f3a9d3531a16eb4
-  data.tar.gz: 484c04040d0d1579ce01e9874fd7f7df4dbc6209f3e262e55fc6b77246072c1315962e223f915b5311fe08a89268f7ac0193a04e50179307001ac37e5690f0e4
+  metadata.gz: bf48947fd5d74c8e7052cfcf9383521366887e22b7206cc4f830c91cbc17fa75db07279240d6a611febc0b7af6a9f03b9db7431b4a3b21cb80c416becaa13e2f
+  data.tar.gz: 1aa0b28a52a83e76f31a5101af38fa006f07ab2180980d3d149206925eba96ca76a7589cf194e534f621e32513fe7c313d45137933824a6600b86bb42295849d

data/.github/workflows/ci.yml

@@ -12,43 +12,52 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby-version: ['3.2', '3.1', '3.0', '2.7', '2.6']
+        ruby-version: ['3.3', '3.2', '3.1', '3.0', '2.7', '2.6']
     steps:
-      - uses: actions/checkout@v3
-      - name: Run PostgreSQL 11
+      - uses: actions/checkout@v4
+      - name: Run PostgreSQL 12
         run: |
           docker run --env POSTGRES_USER=postgres \
             --env POSTGRES_DB=ruby-pg-extras-test \
             --env POSTGRES_PASSWORD=secret \
-            -d -p 5432:5432 postgres:11.18-alpine \
+            -d -p 5432:5432 postgres:12.20-alpine \
             postgres -c shared_preload_libraries=pg_stat_statements
-      - name: Run PostgreSQL 12
+      - name: Run PostgreSQL 13
         run: |
           docker run --env POSTGRES_USER=postgres \
             --env POSTGRES_DB=ruby-pg-extras-test \
             --env POSTGRES_PASSWORD=secret \
-            -d -p 5433:5432 postgres:12.13-alpine \
+            -d -p 5433:5432 postgres:13.16-alpine \
             postgres -c shared_preload_libraries=pg_stat_statements
-      - name: Run PostgreSQL 13
+      - name: Run PostgreSQL 14
         run: |
           docker run --env POSTGRES_USER=postgres \
             --env POSTGRES_DB=ruby-pg-extras-test \
             --env POSTGRES_PASSWORD=secret \
-            -d -p 5434:5432 postgres:13.9-alpine \
+            -d -p 5434:5432 postgres:14.13-alpine \
             postgres -c shared_preload_libraries=pg_stat_statements
-      - name: Run PostgreSQL 14
+      - name: Run PostgreSQL 15
         run: |
           docker run --env POSTGRES_USER=postgres \
             --env POSTGRES_DB=ruby-pg-extras-test \
             --env POSTGRES_PASSWORD=secret \
-            -d -p 5435:5432 postgres:14.6-alpine \
+            -d -p 5435:5432 postgres:15.8-alpine \
             postgres -c shared_preload_libraries=pg_stat_statements
-      - name: Run PostgreSQL 15
+          sleep 15
+      - name: Run PostgreSQL 16
+        run: |
+          docker run --env POSTGRES_USER=postgres \
+            --env POSTGRES_DB=ruby-pg-extras-test \
+            --env POSTGRES_PASSWORD=secret \
+            -d -p 5436:5432 postgres:16.4-alpine \
+            postgres -c shared_preload_libraries=pg_stat_statements
+          sleep 15
+      - name: Run PostgreSQL 17
         run: |
           docker run --env POSTGRES_USER=postgres \
             --env POSTGRES_DB=ruby-pg-extras-test \
             --env POSTGRES_PASSWORD=secret \
-            -d -p 5436:5432 postgres:15.1-alpine \
+            -d -p 5437:5432 postgres:17.0-alpine \
             postgres -c shared_preload_libraries=pg_stat_statements
           sleep 15
       - name: Set up Ruby ${{ matrix.ruby-version }}
@@ -57,72 +66,65 @@ jobs:
           ruby-version: ${{ matrix.ruby-version }}
       - name: Setup dependencies
         run: |
-          gem update --system
-          gem install bundler
+          gem install bundler -v 2.4.22
           sudo apt-get update --allow-releaseinfo-change
           sudo apt install postgresql-client
           sudo apt install libpq-dev
           bundle config set --local path 'vendor/bundle'
           bundle install
           sleep 10
-      - name: Run tests for PG 11
+      - name: Run tests for PG 12
         env:
-          PG_VERSION: 11
+          PG_VERSION: 12
           POSTGRES_HOST: localhost
           POSTGRES_USER: postgres
           POSTGRES_DB: ruby-pg-extras-test
           POSTGRES_PASSWORD: secret
-          DATABASE_URL: postgresql://postgres:secret@localhost:5432/ruby-pg-extras-test
         run: |
           bundle exec rspec spec/
-      - name: Run tests for PG 11
+      - name: Run tests for PG 13
         env:
-          PG_VERSION: 11
+          PG_VERSION: 13
           POSTGRES_HOST: localhost
           POSTGRES_USER: postgres
           POSTGRES_DB: ruby-pg-extras-test
           POSTGRES_PASSWORD: secret
-          DATABASE_URL: postgresql://postgres:secret@localhost:5432/ruby-pg-extras-test
         run: |
           bundle exec rspec spec/
-      - name: Run tests for PG 12
+      - name: Run tests for PG 14
         env:
-          PG_VERSION: 12
+          PG_VERSION: 14
           POSTGRES_HOST: localhost
           POSTGRES_USER: postgres
           POSTGRES_DB: ruby-pg-extras-test
           POSTGRES_PASSWORD: secret
-          DATABASE_URL: postgresql://postgres:secret@localhost:5433/ruby-pg-extras-test
         run: |
           bundle exec rspec spec/
-      - name: Run tests for PG 13
+      - name: Run tests for PG 15
         env:
-          PG_VERSION: 13
+          PG_VERSION: 15
           POSTGRES_HOST: localhost
           POSTGRES_USER: postgres
           POSTGRES_DB: ruby-pg-extras-test
           POSTGRES_PASSWORD: secret
-          DATABASE_URL: postgresql://postgres:secret@localhost:5434/ruby-pg-extras-test
         run: |
           bundle exec rspec spec/
-      - name: Run tests for PG 14
+      - name: Run tests for PG 16
         env:
-          PG_VERSION: 14
+          PG_VERSION: 16
           POSTGRES_HOST: localhost
           POSTGRES_USER: postgres
           POSTGRES_DB: ruby-pg-extras-test
           POSTGRES_PASSWORD: secret
-          DATABASE_URL: postgresql://postgres:secret@localhost:5435/ruby-pg-extras-test
         run: |
           bundle exec rspec spec/
-      - name: Run tests for PG 15
+      - name: Run tests for PG 17
         env:
-          PG_VERSION: 15
+          PG_VERSION: 17
           POSTGRES_HOST: localhost
           POSTGRES_USER: postgres
           POSTGRES_DB: ruby-pg-extras-test
           POSTGRES_PASSWORD: secret
-          DATABASE_URL: postgresql://postgres:secret@localhost:5436/ruby-pg-extras-test
         run: |
           bundle exec rspec spec/
 

data/Gemfile

@@ -1,3 +1,3 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 gemspec

data/README.md

@@ -10,6 +10,8 @@ Alternative versions:
 
 - [Ruby on Rails](https://github.com/pawurb/rails-pg-extras)
 
+- [Rust](https://github.com/pawurb/rust-pg-extras)
+
 - [NodeJS](https://github.com/pawurb/node-postgres-extras)
 
 - [Elixir](https://github.com/pawurb/ecto_psql_extras)
@@ -98,6 +100,8 @@ RubyPgExtras.long_running_queries(args: { threshold: "200 milliseconds" })
 
 ```
 
+You can customize the default `public` schema by setting `ENV['PG_EXTRAS_SCHEMA']` value.
+
 ## Diagnose report
 
 The simplest way to start using pg-extras is to execute a `diagnose` method. It runs a set of checks and prints out a report highlighting areas that may require additional investigation:
@@ -437,7 +441,7 @@ This command displays the total size of each table and materialized view in the
 
 ```ruby
 
-RubyPgExtras.unused_indexes(args: { max_scans: 20 })
+RubyPgExtras.unused_indexes(args: { max_scans: 50 })
 
           table      |                       index                | index_size | index_scans
 ---------------------+--------------------------------------------+------------+-------------

data/Rakefile

@@ -1,9 +1,9 @@
 require "bundler/gem_tasks"
-require 'rspec/core/rake_task'
+require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-desc 'Test all PG versions'
+desc "Test all PG versions"
 task :test_all do
-  system("PG_VERSION=11 bundle exec rspec spec/ && PG_VERSION=12 bundle exec rspec spec/ && PG_VERSION=13 bundle exec rspec spec/ && PG_VERSION=14 bundle exec rspec spec/")
+  system("PG_VERSION=12 bundle exec rspec spec/ && PG_VERSION=13 bundle exec rspec spec/ && PG_VERSION=14 bundle exec rspec spec/ && PG_VERSION=15 bundle exec rspec spec/ && PG_VERSION=16 bundle exec rspec spec/ && PG_VERSION=17 bundle exec rspec spec/")
 end

data/docker-compose.yml.sample

@@ -1,8 +1,6 @@
-version: '3'
-
 services:
-  postgres11:
-    image: postgres:11.16-alpine
+  postgres12:
+    image: postgres:12.20-alpine
     command: postgres -c shared_preload_libraries=pg_stat_statements
     environment:
       POSTGRES_USER: postgres
@@ -10,8 +8,8 @@ services:
       POSTGRES_PASSWORD: secret
     ports:
       - '5432:5432'
-  postgres12:
-    image: postgres:12.11-alpine
+  postgres13:
+    image: postgres:13.16-alpine
     command: postgres -c shared_preload_libraries=pg_stat_statements
     environment:
       POSTGRES_USER: postgres
@@ -19,8 +17,8 @@ services:
       POSTGRES_PASSWORD: secret
     ports:
       - '5433:5432'
-  postgres13:
-    image: postgres:13.7-alpine
+  postgres14:
+    image: postgres:14.13-alpine
     command: postgres -c shared_preload_libraries=pg_stat_statements
     environment:
       POSTGRES_USER: postgres
@@ -28,8 +26,8 @@ services:
       POSTGRES_PASSWORD: secret
     ports:
       - '5434:5432'
-  postgres14:
-    image: postgres:14.3-alpine
+  postgres15:
+    image: postgres:15.8-alpine
     command: postgres -c shared_preload_libraries=pg_stat_statements
     environment:
       POSTGRES_USER: postgres
@@ -37,3 +35,22 @@ services:
       POSTGRES_PASSWORD: secret
     ports:
       - '5435:5432'
+  postgres16:
+    image: postgres:16.4-alpine
+    command: postgres -c shared_preload_libraries=pg_stat_statements
+    environment:
+      POSTGRES_USER: postgres
+      POSTGRES_DB: ruby-pg-extras-test
+      POSTGRES_PASSWORD: secret
+    ports:
+      - '5436:5432'
+  postgres17:
+    image: postgres:17.0-alpine
+    command: postgres -c shared_preload_libraries=pg_stat_statements
+    environment:
+      POSTGRES_USER: postgres
+      POSTGRES_DB: ruby-pg-extras-test
+      POSTGRES_PASSWORD: secret
+    ports:
+      - '5437:5432'
+

data/lib/ruby-pg-extras.rb

@@ -1,19 +1,20 @@
 # frozen_string_literal: true
 
-require 'terminal-table'
-require 'uri'
-require 'pg'
-require 'ruby_pg_extras/size_parser'
-require 'ruby_pg_extras/diagnose_data'
-require 'ruby_pg_extras/diagnose_print'
-require 'ruby_pg_extras/index_info'
-require 'ruby_pg_extras/index_info_print'
-require 'ruby_pg_extras/table_info'
-require 'ruby_pg_extras/table_info_print'
+require "terminal-table"
+require "uri"
+require "pg"
+require "ruby_pg_extras/size_parser"
+require "ruby_pg_extras/diagnose_data"
+require "ruby_pg_extras/diagnose_print"
+require "ruby_pg_extras/index_info"
+require "ruby_pg_extras/index_info_print"
+require "ruby_pg_extras/table_info"
+require "ruby_pg_extras/table_info_print"
 
 module RubyPgExtras
   @@database_url = nil
   NEW_PG_STAT_STATEMENTS = "1.8"
+  PG_STAT_STATEMENTS_17 = "1.11"
 
   QUERIES = %i(
     add_extensions bloat blocking cache_hit db_settings
@@ -27,16 +28,18 @@ module RubyPgExtras
     buffercache_usage ssl_used connections
   )
 
-  DEFAULT_SCHEMA = ENV["PG_EXTRAS_SCHEMA"] || 'public'
+  DEFAULT_SCHEMA = ENV["PG_EXTRAS_SCHEMA"] || "public"
 
   DEFAULT_ARGS = Hash.new({}).merge({
     calls: { limit: 10 },
     calls_legacy: { limit: 10 },
+    calls_17: { limit: 10 },
     long_running_queries: { threshold: "500 milliseconds" },
     locks: { limit: 20 },
     blocking: { limit: 20 },
     outliers: { limit: 10 },
     outliers_legacy: { limit: 10 },
+    outliers_17: { limit: 10 },
     buffercache_stats: { limit: 10 },
     buffercache_usage: { limit: 20 },
     unused_indexes: { max_scans: 50, schema: DEFAULT_SCHEMA },
@@ -50,7 +53,7 @@ module RubyPgExtras
     table_index_scans: { schema: DEFAULT_SCHEMA },
     records_rank: { schema: DEFAULT_SCHEMA },
     tables: { schema: DEFAULT_SCHEMA },
-    kill_pid: { pid: 0 }
+    kill_pid: { pid: 0 },
   })
 
   QUERIES.each do |query_name|
@@ -58,7 +61,7 @@ module RubyPgExtras
       run_query(
         query_name: query_name,
         in_format: options.fetch(:in_format, :display_table),
-        args: options.fetch(:args, {})
+        args: options.fetch(:args, {}),
       )
     end
   end
@@ -70,21 +73,23 @@ module RubyPgExtras
       if pg_stat_statements_ver != nil
         if Gem::Version.new(pg_stat_statements_ver) < Gem::Version.new(NEW_PG_STAT_STATEMENTS)
           query_name = "#{query_name}_legacy".to_sym
+        elsif Gem::Version.new(pg_stat_statements_ver) >= Gem::Version.new(PG_STAT_STATEMENTS_17)
+          query_name = "#{query_name}_17".to_sym
         end
       end
     end
 
     sql = if (custom_args = DEFAULT_ARGS[query_name].merge(args)) != {}
-      sql_for(query_name: query_name) % custom_args
-    else
-      sql_for(query_name: query_name)
-    end
+        sql_for(query_name: query_name) % custom_args
+      else
+        sql_for(query_name: query_name)
+      end
     result = connection.exec(sql)
 
     display_result(
       result,
       title: description_for(query_name: query_name),
-      in_format: in_format
+      in_format: in_format,
     )
   end
 
@@ -140,15 +145,15 @@ module RubyPgExtras
       result
     when :display_table
       headings = if result.count > 0
-        result[0].keys
-      else
-        ["No results"]
-      end
+          result[0].keys
+        else
+          ["No results"]
+        end
 
       puts Terminal::Table.new(
         title: title,
         headings: headings,
-        rows: result.values
+        rows: result.values,
       )
     else
       raise "Invalid in_format option"

data/lib/ruby_pg_extras/diagnose_data.rb

@@ -22,7 +22,7 @@ module RubyPgExtras
         :unused_indexes,
         :null_indexes,
         :bloat,
-        :duplicate_indexes
+        :duplicate_indexes,
       ].yield_self do |checks|
         extensions_data = query_module.extensions(in_format: :hash)
 
@@ -66,12 +66,12 @@ module RubyPgExtras
       if table_cache_hit_ratio > min_expected
         {
           ok: true,
-          message: "Table cache hit ratio is correct: #{table_cache_hit_ratio}."
+          message: "Table cache hit ratio is correct: #{table_cache_hit_ratio}.",
         }
       else
         {
           ok: false,
-          message: "Table hit ratio is too low: #{table_cache_hit_ratio}."
+          message: "Table hit ratio is too low: #{table_cache_hit_ratio}.",
         }
       end
     end
@@ -87,12 +87,12 @@ module RubyPgExtras
       if index_cache_hit_ratio > min_expected
         {
           ok: true,
-          message: "Index hit ratio is correct: #{index_cache_hit_ratio}."
+          message: "Index hit ratio is correct: #{index_cache_hit_ratio}.",
         }
       else
         {
           ok: false,
-          message: "Index hit ratio is too low: #{index_cache_hit_ratio}."
+          message: "Index hit ratio is too low: #{index_cache_hit_ratio}.",
         }
       end
     end
@@ -103,12 +103,12 @@ module RubyPgExtras
       if ssl_connection
         {
           ok: true,
-          message: "Database client is using a secure SSL connection."
+          message: "Database client is using a secure SSL connection.",
         }
       else
         {
           ok: false,
-          message: "Database client is using an unencrypted connection."
+          message: "Database client is using an unencrypted connection.",
         }
       end
     end
@@ -116,7 +116,7 @@ module RubyPgExtras
     def unused_indexes
       indexes = query_module.unused_indexes(
         in_format: :hash,
-        args: { min_scans: PG_EXTRAS_UNUSED_INDEXES_MAX_SCANS }
+        args: { min_scans: PG_EXTRAS_UNUSED_INDEXES_MAX_SCANS },
       ).select do |i|
         SizeParser.to_i(i.fetch("index_size").strip) >= PG_EXTRAS_UNUSED_INDEXES_MIN_SIZE_BYTES
       end
@@ -124,15 +124,15 @@ module RubyPgExtras
       if indexes.count == 0
         {
           ok: true,
-          message: "No unused indexes detected."
+          message: "No unused indexes detected.",
         }
       else
         print_indexes = indexes.map do |i|
-          "'#{i.fetch('index')}' on '#{i.fetch('table')}' size #{i.fetch('index_size')}"
+          "'#{i.fetch("index")}' on '#{i.fetch("table")}' size #{i.fetch("index_size")}"
         end.join(",\n")
         {
           ok: false,
-          message: "Unused indexes detected:\n#{print_indexes}"
+          message: "Unused indexes detected:\n#{print_indexes}",
         }
       end
     end
@@ -140,7 +140,7 @@ module RubyPgExtras
     def null_indexes
       indexes = query_module.null_indexes(
         in_format: :hash,
-        args: { min_relation_size_mb: PG_EXTRAS_NULL_INDEXES_MIN_SIZE_MB }
+        args: { min_relation_size_mb: PG_EXTRAS_NULL_INDEXES_MIN_SIZE_MB },
       ).select do |i|
         i.fetch("null_frac").gsub("%", "").to_f >= PG_EXTRAS_NULL_MIN_NULL_FRAC_PERCENT
       end
@@ -148,15 +148,15 @@ module RubyPgExtras
       if indexes.count == 0
         {
           ok: true,
-          message: "No null indexes detected."
+          message: "No null indexes detected.",
         }
       else
         print_indexes = indexes.map do |i|
-          "'#{i.fetch('index')}' size #{i.fetch('index_size')} null values fraction #{i.fetch('null_frac')}"
+          "'#{i.fetch("index")}' size #{i.fetch("index_size")} null values fraction #{i.fetch("null_frac")}"
         end.join(",\n")
         {
           ok: false,
-          message: "Null indexes detected:\n#{print_indexes}"
+          message: "Null indexes detected:\n#{print_indexes}",
         }
       end
     end
@@ -169,16 +169,16 @@ module RubyPgExtras
       if bloat_data.count == 0
         {
           ok: true,
-          message: "No bloat detected."
+          message: "No bloat detected.",
         }
       else
         print_bloat = bloat_data.map do |b|
-          "'#{b.fetch('object_name')}' bloat #{b.fetch('bloat')} waste #{b.fetch('waste')}"
+          "'#{b.fetch("object_name")}' bloat #{b.fetch("bloat")} waste #{b.fetch("waste")}"
         end.join(",\n")
 
         {
           ok: false,
-          message: "Bloat detected:\n#{print_bloat}"
+          message: "Bloat detected:\n#{print_bloat}",
         }
       end
     end
@@ -189,16 +189,16 @@ module RubyPgExtras
       if indexes.count == 0
         {
           ok: true,
-          message: "No duplicate indexes detected."
+          message: "No duplicate indexes detected.",
         }
       else
         print_indexes = indexes.map do |i|
-          "'#{i.fetch('idx1')}' of size #{i.fetch('size')} is identical to '#{i.fetch('idx2')}'"
+          "'#{i.fetch("idx1")}' of size #{i.fetch("size")} is identical to '#{i.fetch("idx2")}'"
         end.join(",\n")
 
         {
           ok: false,
-          message: "Duplicate indexes detected:\n#{print_indexes}"
+          message: "Duplicate indexes detected:\n#{print_indexes}",
         }
       end
     end
@@ -211,16 +211,16 @@ module RubyPgExtras
       if queries.count == 0
         {
           ok: true,
-          message: "No queries using significant execution ratio detected."
+          message: "No queries using significant execution ratio detected.",
         }
       else
         print_queries = queries.map do |q|
-          "'#{q.fetch('query').slice(0, 30)}...' called #{q.fetch('ncalls')} times, using #{q.fetch('prop_exec_time')} of total exec time."
+          "'#{q.fetch("query").slice(0, 30)}...' called #{q.fetch("ncalls")} times, using #{q.fetch("prop_exec_time")} of total exec time."
         end.join(",\n")
 
         {
           ok: false,
-          message: "Queries using significant execution ratio detected:\n#{print_queries}"
+          message: "Queries using significant execution ratio detected:\n#{print_queries}",
         }
       end
     end

data/lib/ruby_pg_extras/diagnose_print.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'terminal-table'
+require "terminal-table"
 
 module RubyPgExtras
   class DiagnosePrint
@@ -17,13 +17,13 @@ module RubyPgExtras
 
         [
           colorize("[#{symbol}] - #{el.fetch(:check_name)}", color),
-          colorize(el.fetch(:message), color)
+          colorize(el.fetch(:message), color),
         ]
       end
 
       puts Terminal::Table.new(
         title: title,
-        rows: rows
+        rows: rows,
       )
     end
 

data/lib/ruby_pg_extras/index_info.rb

@@ -19,16 +19,16 @@ module RubyPgExtras
         {
           index_name: index_name,
           table_name: index_data.fetch("tablename"),
-          columns: index_data.fetch("columns").split(',').map(&:strip),
+          columns: index_data.fetch("columns").split(",").map(&:strip),
           index_size: index_size_data.find do |el|
             el.fetch("name") == index_name
           end.fetch("size", "N/A"),
-          index_scans:  index_scans_data.find do |el|
+          index_scans: index_scans_data.find do |el|
             el.fetch("index") == index_name
           end.fetch("index_scans", "N/A"),
           null_frac: null_indexes_data.find do |el|
             el.fetch("index") == index_name
-          end&.fetch("null_frac", "N/A")&.strip || "0.00%"
+          end&.fetch("null_frac", "N/A")&.strip || "0.00%",
         }
       end
     end
@@ -40,7 +40,7 @@ module RubyPgExtras
     def null_indexes_data
       @_null_indexes_data ||= query_module.null_indexes(
         in_format: :hash,
-        args: { min_relation_size_mb: 0 }
+        args: { min_relation_size_mb: 0 },
       )
     end
 

data/lib/ruby_pg_extras/index_info_print.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'terminal-table'
+require "terminal-table"
 
 module RubyPgExtras
   class IndexInfoPrint
@@ -13,10 +13,10 @@ module RubyPgExtras
         [
           el.fetch(:index_name),
           el.fetch(:table_name),
-          el.fetch(:columns).join(', '),
+          el.fetch(:columns).join(", "),
           el.fetch(:index_size),
           el.fetch(:index_scans),
-          el.fetch(:null_frac)
+          el.fetch(:null_frac),
         ]
       end
 
@@ -27,10 +27,10 @@ module RubyPgExtras
           "Columns",
           "Index size",
           "Index scans",
-          "Null frac"
+          "Null frac",
         ],
         title: title,
-        rows: rows
+        rows: rows,
       )
     end
 

data/lib/ruby_pg_extras/queries/all_locks.sql

@@ -4,6 +4,8 @@ SELECT
   pg_stat_activity.pid,
   pg_class.relname,
   pg_locks.transactionid,
+  pg_locks.locktype,
+  pg_locks.database,
   pg_locks.granted,
   pg_locks.mode,
   pg_stat_activity.query AS query_snippet,

data/lib/ruby_pg_extras/queries/calls_17.sql

@@ -0,0 +1,9 @@
+/* Queries that have highest frequency of execution */
+
+SELECT query AS qry,
+interval '1 millisecond' * total_exec_time AS exec_time,
+to_char((total_exec_time/sum(total_exec_time) OVER()) * 100, 'FM90D0') || '%%'  AS prop_exec_time,
+to_char(calls, 'FM999G999G990') AS ncalls,
+interval '1 millisecond' * (shared_blk_read_time + shared_blk_write_time) AS sync_io_time
+FROM pg_stat_statements WHERE userid = (SELECT usesysid FROM pg_user WHERE usename = current_user LIMIT 1)
+ORDER BY calls DESC LIMIT %{limit};

data/lib/ruby_pg_extras/queries/locks.sql

@@ -4,6 +4,8 @@ SELECT
   pg_stat_activity.pid,
   pg_class.relname,
   pg_locks.transactionid,
+  pg_locks.locktype,
+  pg_locks.database,
   pg_locks.granted,
   pg_locks.mode,
   pg_stat_activity.query AS query_snippet,

data/lib/ruby_pg_extras/queries/outliers_17.sql

@@ -0,0 +1,10 @@
+/* Queries that have longest execution time in aggregate */
+
+SELECT interval '1 millisecond' * total_exec_time AS total_exec_time,
+to_char((total_exec_time/sum(total_exec_time) OVER()) * 100, 'FM90D0') || '%%'  AS prop_exec_time,
+to_char(calls, 'FM999G999G999G990') AS ncalls,
+interval '1 millisecond' * (shared_blk_read_time + shared_blk_write_time) AS sync_io_time,
+query AS query
+FROM pg_stat_statements WHERE userid = (SELECT usesysid FROM pg_user WHERE usename = current_user LIMIT 1)
+ORDER BY total_exec_time DESC
+LIMIT %{limit};

data/lib/ruby_pg_extras/size_parser.rb

@@ -10,7 +10,7 @@ module RubyPgExtras
     end
 
     def self.regexp_for_units(units)
-      /\A(-?\d+)\s?(#{units.join('|')})\z/i
+      /\A(-?\d+)\s?(#{units.join("|")})\z/i
     end
 
     SI_UNITS = %w[bytes kB MB GB TB PB EB ZB YB].map(&:downcase).freeze
@@ -32,7 +32,7 @@ module RubyPgExtras
       return nil unless match_data
 
       exponent = units.index(match_data[2].downcase).to_i
-      match_data[1].to_i * multiplier**exponent
+      match_data[1].to_i * multiplier ** exponent
     end
 
     DIGITS_ONLY_REGEXP = /\A(-?\d+)\z/.freeze

data/lib/ruby_pg_extras/table_info.rb

@@ -35,7 +35,7 @@ module RubyPgExtras
           end.fetch("count", "N/A"),
           indexes_scans: table_index_scans_data.find do |el|
             el.fetch("name") == table_name
-          end.fetch("count", "N/A")
+          end.fetch("count", "N/A"),
         }
       end
     end

data/lib/ruby_pg_extras/table_info_print.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'terminal-table'
+require "terminal-table"
 
 module RubyPgExtras
   class TableInfoPrint
@@ -17,7 +17,7 @@ module RubyPgExtras
           el.fetch(:indexes_cache_hit),
           el.fetch(:estimated_rows),
           el.fetch(:sequential_scans),
-          el.fetch(:indexes_scans)
+          el.fetch(:indexes_scans),
         ]
       end
 
@@ -29,10 +29,10 @@ module RubyPgExtras
           "Indexes cache hit",
           "Estimated rows",
           "Sequential scans",
-          "Indexes scans"
+          "Indexes scans",
         ],
         title: title,
-        rows: rows
+        rows: rows,
       )
     end
 

data/lib/ruby_pg_extras/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RubyPgExtras
-  VERSION = "5.3.1"
+  VERSION = "5.4.1"
 end

data/ruby-pg-extras.gemspec

@@ -1,24 +1,25 @@
 # -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'ruby_pg_extras/version'
+require "ruby_pg_extras/version"
 
 Gem::Specification.new do |s|
-  s.name          = "ruby-pg-extras"
-  s.version       = RubyPgExtras::VERSION
-  s.authors       = ["pawurb"]
-  s.email         = ["contact@pawelurbanek.com"]
-  s.summary       = %q{ Ruby PostgreSQL performance database insights }
-  s.description   = %q{ Ruby port of Heroku PG Extras. The goal of this project is to provide a powerful insights into PostgreSQL database for Ruby on Rails apps that are not using the default Heroku PostgreSQL plugin. }
-  s.homepage      = "http://github.com/pawurb/ruby-pg-extras"
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = s.files.grep(%r{^(spec)/})
+  s.name = "ruby-pg-extras"
+  s.version = RubyPgExtras::VERSION
+  s.authors = ["pawurb"]
+  s.email = ["contact@pawelurbanek.com"]
+  s.summary = %q{ Ruby PostgreSQL performance database insights }
+  s.description = %q{ Ruby port of Heroku PG Extras. The goal of this project is to provide a powerful insights into PostgreSQL database for Ruby on Rails apps that are not using the default Heroku PostgreSQL plugin. }
+  s.homepage = "http://github.com/pawurb/ruby-pg-extras"
+  s.files = `git ls-files`.split("\n")
+  s.test_files = s.files.grep(%r{^(spec)/})
   s.require_paths = ["lib"]
-  s.license       = "MIT"
+  s.license = "MIT"
   s.add_dependency "pg"
   s.add_dependency "terminal-table"
   s.add_development_dependency "rake"
   s.add_development_dependency "rspec"
+  s.add_development_dependency "rufo"
 
   if s.respond_to?(:metadata=)
     s.metadata = { "rubygems_mfa_required" => "true" }

data/spec/diagnose_data_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
+require "spec_helper"
 
 describe RubyPgExtras::DiagnoseData do
   subject(:result) do
@@ -14,7 +14,7 @@ describe RubyPgExtras::DiagnoseData do
           [
             { "table" => "public.plans", "index" => "index_plans_on_payer_id", "index_size" => "16 MB", "index_scans" => 0 },
             { "table" => "public.feedbacks", "index" => "index_feedbacks_on_target_id", "index_size" => "111180 bytes", "index_scans" => 1 },
-            { "table" => "public.channels", "index" => "index_channels_on_slack_id", "index_size" => "56 MB", "index_scans" => 7}
+            { "table" => "public.channels", "index" => "index_channels_on_slack_id", "index_size" => "56 MB", "index_scans" => 7 },
           ]
         }
 
@@ -22,7 +22,7 @@ describe RubyPgExtras::DiagnoseData do
           [
             { "oid" => 123, "index" => "index_plans_on_payer_id", "index_size" => "16 MB", "unique" => true, "null_frac" => "00.00%", "expected_saving" => "0 kb" },
             { "oid" => 321, "index" => "index_feedbacks_on_target_id", "index_size" => "80 kB", "unique" => true, "null_frac" => "97.00%", "expected_saving" => "77 kb" },
-            { "oid" => 231, "index" => "index_channels_on_slack_id", "index_size" => "56 MB", "unique" => true, "null_frac" => "49.99%", "expected_saving" => "28 MB" }
+            { "oid" => 231, "index" => "index_channels_on_slack_id", "index_size" => "56 MB", "unique" => true, "null_frac" => "49.99%", "expected_saving" => "28 MB" },
           ]
         }
 
@@ -30,19 +30,19 @@ describe RubyPgExtras::DiagnoseData do
           [
             { "type" => "table", "schemaname" => "public", "object_name" => "bloated_table_1", "bloat" => 8, "waste" => "0 kb" },
             { "type" => "table", "schemaname" => "public", "object_name" => "bloated_table_2", "bloat" => 8, "waste" => "77 kb" },
-            { "type" => "schemaname", "public" => "index_channels_on_slack_id", "object_name" => "bloated_index", "bloat" => 11, "waste" => "28 MB" }
+            { "type" => "schemaname", "public" => "index_channels_on_slack_id", "object_name" => "bloated_index", "bloat" => 11, "waste" => "28 MB" },
           ]
         }
 
         expect(RubyPgExtras).to receive(:duplicate_indexes) {
           [
-            { "size" => "128 kb", "idx1" => "users_pkey", "idx2" => "index_users_id" }
+            { "size" => "128 kb", "idx1" => "users_pkey", "idx2" => "index_users_id" },
           ]
         }
 
         expect(RubyPgExtras).to receive(:outliers) {
           [
-            { "query" => "SELECT * FROM users WHERE users.age > 20 AND users.height > 160", "exec_time" => "154:39:26.431466", "prop_exec_time" => "72.2%", "ncalls" => "34,211,877", "sync_io_time" => "00:34:19.784318" }
+            { "query" => "SELECT * FROM users WHERE users.age > 20 AND users.height > 160", "exec_time" => "154:39:26.431466", "prop_exec_time" => "72.2%", "ncalls" => "34,211,877", "sync_io_time" => "00:34:19.784318" },
           ]
         }
       end

data/spec/diagnose_print_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
+require "spec_helper"
 
 describe RubyPgExtras::DiagnosePrint do
   subject(:print_result) do
@@ -12,18 +12,18 @@ describe RubyPgExtras::DiagnosePrint do
       {
         :check_name => :table_cache_hit,
         :ok => false,
-        :message => "Table hit ratio too low: 0.906977."
+        :message => "Table hit ratio too low: 0.906977.",
       },
       {
         :check_name => :index_cache_hit,
         :ok => false,
-        :message => "Index hit ratio is too low: 0.818182."
+        :message => "Index hit ratio is too low: 0.818182.",
       },
       {
         :check_name => :ssl_used,
         :ok => true,
-        :message => "Database client is using a secure SSL connection."
-      }
+        :message => "Database client is using a secure SSL connection.",
+      },
     ]
   end
 

data/spec/index_info_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
+require "spec_helper"
 
 describe RubyPgExtras::IndexInfo do
   subject(:result) do
@@ -13,27 +13,27 @@ describe RubyPgExtras::IndexInfo do
         expect(RubyPgExtras).to receive(:indexes) {
           [
             { "schemaname" => "public", "indexname" => "index_users_on_api_auth_token", "tablename" => "users", "columns" => "api_auth_token, column2" },
-            {"schemaname" => "public", "indexname" => "index_teams_on_slack_id", "tablename" => "teams", "columns" => "slack_id" },
+            { "schemaname" => "public", "indexname" => "index_teams_on_slack_id", "tablename" => "teams", "columns" => "slack_id" },
           ]
         }
 
         expect(RubyPgExtras).to receive(:index_size) {
           [
             { "name" => "index_users_on_api_auth_token", "size" => "1744 kB" },
-            {"name" => "index_teams_on_slack_id", "size" => "500 kB"},
+            { "name" => "index_teams_on_slack_id", "size" => "500 kB" },
           ]
         }
 
         expect(RubyPgExtras).to receive(:null_indexes) {
           [
-            { "oid" => 16803, "index" => "index_users_on_api_auth_token", "index_size" => "1744 kB", "unique"=>true, "indexed_column" => "api_auth_token", "null_frac" => "25.00%", "expected_saving" => "300 kB" }
+            { "oid" => 16803, "index" => "index_users_on_api_auth_token", "index_size" => "1744 kB", "unique" => true, "indexed_column" => "api_auth_token", "null_frac" => "25.00%", "expected_saving" => "300 kB" },
           ]
         }
 
         expect(RubyPgExtras).to receive(:index_scans) {
           [
-            { "schemaname" => "public", "table" => "users", "index" => "index_users_on_api_auth_token", "index_size" => "1744 kB", "index_scans"=> 0 },
-            { "schemaname" => "public", "table" => "teams", "index" => "index_teams_on_slack_id", "index_size" => "500 kB", "index_scans"=> 0 }
+            { "schemaname" => "public", "table" => "users", "index" => "index_users_on_api_auth_token", "index_size" => "1744 kB", "index_scans" => 0 },
+            { "schemaname" => "public", "table" => "teams", "index" => "index_teams_on_slack_id", "index_size" => "500 kB", "index_scans" => 0 },
           ]
         }
       end

data/spec/size_parser_spec.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
+require "spec_helper"
 
 describe RubyPgExtras::SizeParser do
   subject(:result) { described_class.to_i(arg) }
 
-  describe 'SI Units' do
+  describe "SI Units" do
     let(:arg) { "#{num_units} #{unit}" }
 
     context "when the argument is a number followed by 'bytes', with possible case variations" do
@@ -72,7 +72,7 @@ describe RubyPgExtras::SizeParser do
     end
   end
 
-  describe 'Binary Units' do
+  describe "Binary Units" do
     let(:arg) { "#{num_units} #{unit}" }
 
     context "when the argument is a number followed by 'bytes', with possible case variations" do
@@ -139,28 +139,28 @@ describe RubyPgExtras::SizeParser do
     end
   end
 
-  context 'when the argument has only digits' do
-    let(:arg) { '654245' }
+  context "when the argument has only digits" do
+    let(:arg) { "654245" }
 
     it { is_expected.to eq(arg.to_i) }
   end
 
-  describe 'errors' do
-    it 'raises an error when the argument has an invalid prefix' do
+  describe "errors" do
+    it "raises an error when the argument has an invalid prefix" do
       expect do
-        described_class.to_i('123 qb')
+        described_class.to_i("123 qb")
       end.to raise_error ArgumentError
     end
 
-    it 'raises an error when the argument does not have a unit in bytes' do
+    it "raises an error when the argument does not have a unit in bytes" do
       expect do
-        described_class.to_i('123 mL')
+        described_class.to_i("123 mL")
       end.to raise_error ArgumentError
     end
 
-    it 'when the argument cannot be parsed an number of units' do
+    it "when the argument cannot be parsed an number of units" do
       expect do
-        described_class.to_i('1c3 MB')
+        described_class.to_i("1c3 MB")
       end.to raise_error ArgumentError
     end
   end

data/spec/smoke_spec.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
+require "spec_helper"
 
 describe RubyPgExtras do
   RubyPgExtras::QUERIES.each do |query_name|
     it "#{query_name} description can be read" do
       expect do
         RubyPgExtras.description_for(
-          query_name: query_name
+          query_name: query_name,
         )
       end.not_to raise_error
     end
@@ -18,7 +18,7 @@ describe RubyPgExtras do
       expect do
         RubyPgExtras.run_query(
           query_name: query_name,
-          in_format: :hash
+          in_format: :hash,
         )
       end.not_to raise_error
     end

data/spec/spec_helper.rb

@@ -1,22 +1,26 @@
 # frozen_string_literal: true
 
-require 'rubygems'
-require 'bundler/setup'
-require_relative '../lib/ruby-pg-extras'
+require "rubygems"
+require "bundler/setup"
+require_relative "../lib/ruby-pg-extras"
 
 pg_version = ENV["PG_VERSION"]
 
-port = if pg_version == "11"
-  "5432"
-elsif pg_version == "12"
-  "5433"
-elsif pg_version == "13"
-  "5434"
-elsif pg_version == "14"
-  "5435"
-else
-  "5432"
-end
+port = if pg_version == "12"
+    "5432"
+  elsif pg_version == "13"
+    "5433"
+  elsif pg_version == "14"
+    "5434"
+  elsif pg_version == "15"
+    "5435"
+  elsif pg_version == "16"
+    "5436"
+  elsif pg_version == "17"
+    "5437"
+  else
+    "5432"
+  end
 
 ENV["DATABASE_URL"] ||= "postgresql://postgres:secret@localhost:#{port}/ruby-pg-extras-test"
 

data/spec/table_info_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
+require "spec_helper"
 
 describe RubyPgExtras::TableInfo do
   subject(:result) do
@@ -13,14 +13,14 @@ describe RubyPgExtras::TableInfo do
         expect(RubyPgExtras).to receive(:tables) {
           [
             { "schemaname" => "public", "tablename" => "users" },
-            { "schemaname" => "public", "tablename" => "teams" }
+            { "schemaname" => "public", "tablename" => "teams" },
           ]
         }
 
         expect(RubyPgExtras).to receive(:table_size) {
           [
             { "name" => "teams", "size" => "25 MB" },
-            {"name" => "users", "size" => "250 MB"},
+            { "name" => "users", "size" => "250 MB" },
           ]
         }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-pg-extras
 version: !ruby/object:Gem::Version
-  version: 5.3.1
+  version: 5.4.1
 platform: ruby
 authors:
 - pawurb
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-14 00:00:00.000000000 Z
+date: 2024-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rufo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: " Ruby port of Heroku PG Extras. The goal of this project is to provide
   a powerful insights into PostgreSQL database for Ruby on Rails apps that are not
   using the default Heroku PostgreSQL plugin. "
@@ -95,6 +109,7 @@ files:
 - lib/ruby_pg_extras/queries/buffercache_usage.sql
 - lib/ruby_pg_extras/queries/cache_hit.sql
 - lib/ruby_pg_extras/queries/calls.sql
+- lib/ruby_pg_extras/queries/calls_17.sql
 - lib/ruby_pg_extras/queries/calls_legacy.sql
 - lib/ruby_pg_extras/queries/connections.sql
 - lib/ruby_pg_extras/queries/db_settings.sql
@@ -112,6 +127,7 @@ files:
 - lib/ruby_pg_extras/queries/mandelbrot.sql
 - lib/ruby_pg_extras/queries/null_indexes.sql
 - lib/ruby_pg_extras/queries/outliers.sql
+- lib/ruby_pg_extras/queries/outliers_17.sql
 - lib/ruby_pg_extras/queries/outliers_legacy.sql
 - lib/ruby_pg_extras/queries/pg_stat_statements_reset.sql
 - lib/ruby_pg_extras/queries/records_rank.sql
@@ -159,7 +175,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.4
 signing_key:
 specification_version: 4
 summary: Ruby PostgreSQL performance database insights