ruby-pg-extras 4.4.4 → 4.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ebce0b7bd6c80956895062aafe69e19d0c3763f63133111c5aeefa884bf82e0f
-  data.tar.gz: 48ae616bb871befed1dc781f7860118fc4cbb6a15f0df7b2b393b6478aebd286
+  metadata.gz: 250bb1e08a0937724fc2cf90c16d26670218a1c23884fd69f33f7379bb550a20
+  data.tar.gz: 12e69c803e3bd48287445bd46451255b3a0074fb3c1d4a0d373bb2d64a98e900
 SHA512:
-  metadata.gz: 99367200be303ca90cbc95535059c37b6ad88e2ac1022d43d8713096e82dae50417159541f1a67be405aca92675a3455b88f68eed73368ac96261dccaae6ba01
-  data.tar.gz: 97f7b56efd06e58067c22c1c540cbeb49c032622b3693183f2d8f66b82f68499eda3db88bf873181bb05554ffaccbd2630cc2d4d4d9334e8eea916b586344923
+  metadata.gz: b68d9e6c988df34cb7e3236ce4c12a7dbfdef23139dbc61cfe6364e21f95b55f0ca11c6f2657e1d350cf16fbb641a72f91228a12569b785061ee4e0d65737e45
+  data.tar.gz: d31f3679f3ffd66bc9a39e9868985a260807a32af5335e722ccba5f5df515c80d451b957544fcaa7e016e2bbbebe09992cd89a7046cb033639a48eb95bb43fbe

data/.circleci/config.yml

@@ -2,30 +2,37 @@ version: 2
 jobs:
   test:
     docker:
-      - image: circleci/ruby:2.6.5
+      - image: cimg/ruby:2.6
         environment:
           DATABASE_URL: postgresql://postgres:secret@localhost:5432/ruby-pg-extras-test
-      - image: circleci/postgres:11.5
+      - image: cimg/postgres:11.15
         command: postgres -c shared_preload_libraries=pg_stat_statements
         name: postgres11
         environment:
           POSTGRES_USER: postgres
           POSTGRES_DB: ruby-pg-extras-test
           POSTGRES_PASSWORD: secret
-      - image: circleci/postgres:12.7
+      - image: cimg/postgres:12.10
         command: postgres -c shared_preload_libraries=pg_stat_statements
         name: postgres12
         environment:
           POSTGRES_USER: postgres
           POSTGRES_DB: ruby-pg-extras-test
           POSTGRES_PASSWORD: secret
-      - image: circleci/postgres:13.3
+      - image: cimg/postgres:13.6
         command: postgres -c shared_preload_libraries=pg_stat_statements
         name: postgres13
         environment:
           POSTGRES_USER: postgres
           POSTGRES_DB: ruby-pg-extras-test
           POSTGRES_PASSWORD: secret
+      - image: cimg/postgres:14.2
+        command: postgres -c shared_preload_libraries=pg_stat_statements
+        name: postgres14
+        environment:
+          POSTGRES_USER: postgres
+          POSTGRES_DB: ruby-pg-extras-test
+          POSTGRES_PASSWORD: secret
     parallelism: 1
     steps:
       - checkout
@@ -51,6 +58,11 @@ jobs:
           environment:
             DATABASE_URL: postgresql://postgres:secret@postgres13:5432/ruby-pg-extras-test
           command: bundle exec rspec spec/
+      - run:
+          name: Run specs for PG 14
+          environment:
+            DATABASE_URL: postgresql://postgres:secret@postgres14:5432/ruby-pg-extras-test
+          command: bundle exec rspec spec/
 workflows:
   version: 2
   test:

data/Rakefile

@@ -5,5 +5,5 @@ RSpec::Core::RakeTask.new(:spec)
 
 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/")
+  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/")
 end

data/docker-compose.yml.sample

@@ -2,7 +2,7 @@ version: '3'
 
 services:
   postgres11:
-    image: postgres:11.5-alpine
+    image: postgres:11.16-alpine
     command: postgres -c shared_preload_libraries=pg_stat_statements
     environment:
       POSTGRES_USER: postgres
@@ -11,7 +11,7 @@ services:
     ports:
       - '5432:5432'
   postgres12:
-    image: postgres:12.7-alpine
+    image: postgres:12.11-alpine
     command: postgres -c shared_preload_libraries=pg_stat_statements
     environment:
       POSTGRES_USER: postgres
@@ -20,7 +20,7 @@ services:
     ports:
       - '5433:5432'
   postgres13:
-    image: postgres:13.3-alpine
+    image: postgres:13.7-alpine
     command: postgres -c shared_preload_libraries=pg_stat_statements
     environment:
       POSTGRES_USER: postgres
@@ -28,3 +28,12 @@ services:
       POSTGRES_PASSWORD: secret
     ports:
       - '5434:5432'
+  postgres14:
+    image: postgres:14.3-alpine
+    command: postgres -c shared_preload_libraries=pg_stat_statements
+    environment:
+      POSTGRES_USER: postgres
+      POSTGRES_DB: ruby-pg-extras-test
+      POSTGRES_PASSWORD: secret
+    ports:
+      - '5435:5432'

data/lib/ruby-pg-extras.rb

@@ -3,6 +3,7 @@
 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'
@@ -34,8 +35,17 @@ module RubyPgExtras
     outliers_legacy: { limit: 10 },
     buffercache_stats: { limit: 10 },
     buffercache_usage: { limit: 20 },
-    unused_indexes: { max_scans: 50 },
-    null_indexes: { min_relation_size_mb: 10 }
+    unused_indexes: { max_scans: 50, schema: "public" },
+    null_indexes: { min_relation_size_mb: 10 },
+    index_usage: { schema: "public" },
+    index_cache_hit: { schema: "public" },
+    table_cache_hit: { schema: "public" },
+    index_scans: { schema: "public" },
+    cache_hit: { schema: "public" },
+    seq_scans: { schema: "public" },
+    table_index_scans: { schema: "public" },
+    records_rank: { schema: "public" },
+    tables: { schema: "public" }
   })
 
   QUERIES.each do |query_name|

data/lib/ruby_pg_extras/diagnose_data.rb

@@ -1,13 +1,11 @@
 # frozen_string_literal: true
 
-require 'filesize'
-
 module RubyPgExtras
   class DiagnoseData
     PG_EXTRAS_TABLE_CACHE_HIT_MIN_EXPECTED = "0.985"
     PG_EXTRAS_INDEX_CACHE_HIT_MIN_EXPECTED = "0.985"
     PG_EXTRAS_UNUSED_INDEXES_MAX_SCANS = 20
-    PG_EXTRAS_UNUSED_INDEXES_MIN_SIZE_BYTES = Filesize.from("1 MB").to_i # 1000000 bytes
+    PG_EXTRAS_UNUSED_INDEXES_MIN_SIZE_BYTES = SizeParser.to_i("1 MB") # 1000000 bytes
     PG_EXTRAS_NULL_INDEXES_MIN_SIZE_MB = 1 # 1 MB
     PG_EXTRAS_NULL_MIN_NULL_FRAC_PERCENT = 50 # 50%
     PG_EXTRAS_BLOAT_MIN_VALUE = 10
@@ -118,7 +116,7 @@ module RubyPgExtras
         in_format: :hash,
         args: { min_scans: PG_EXTRAS_UNUSED_INDEXES_MAX_SCANS }
       ).select do |i|
-        Filesize.from(i.fetch("index_size").sub("bytes", "").strip).to_i >= PG_EXTRAS_UNUSED_INDEXES_MIN_SIZE_BYTES
+        SizeParser.to_i(i.fetch("index_size").strip) >= PG_EXTRAS_UNUSED_INDEXES_MIN_SIZE_BYTES
       end
 
       if indexes.count == 0

data/lib/ruby_pg_extras/queries/cache_hit.sql

@@ -4,8 +4,10 @@ SELECT
   'index hit rate' AS name,
   (sum(idx_blks_hit)) / nullif(sum(idx_blks_hit + idx_blks_read),0) AS ratio
 FROM pg_statio_user_indexes
+WHERE schemaname = '%{schema}'
 UNION ALL
 SELECT
  'table hit rate' AS name,
   sum(heap_blks_hit) / nullif(sum(heap_blks_hit) + sum(heap_blks_read),0) AS ratio
-FROM pg_statio_user_tables;
+FROM pg_statio_user_tables
+WHERE schemaname = '%{schema}';

data/lib/ruby_pg_extras/queries/index_cache_hit.sql

@@ -11,5 +11,7 @@ SELECT
   END ratio
 FROM
   pg_statio_user_tables
+WHERE
+  schemaname = '%{schema}'
 ORDER BY
   idx_blks_hit / (idx_blks_hit + idx_blks_read + 1)::float DESC;

data/lib/ruby_pg_extras/queries/index_scans.sql

@@ -8,5 +8,6 @@ SELECT
   idx_scan as index_scans
 FROM pg_stat_user_indexes ui
 JOIN pg_index i ON ui.indexrelid = i.indexrelid
+WHERE schemaname = '%{schema}'
 ORDER BY pg_relation_size(i.indexrelid) / nullif(idx_scan, 0) DESC NULLS FIRST,
 pg_relation_size(i.indexrelid) DESC;

data/lib/ruby_pg_extras/queries/index_usage.sql

@@ -1,4 +1,4 @@
-/* Index hit rate (effective databases are at 99% and up) */
+/* Index hit rate (effective databases are at 99 percent and up) */
 
 SELECT relname,
    CASE idx_scan
@@ -8,5 +8,7 @@ SELECT relname,
    n_live_tup rows_in_table
  FROM
    pg_stat_user_tables
+ WHERE
+   schemaname = '%{schema}'
  ORDER BY
    n_live_tup DESC;

data/lib/ruby_pg_extras/queries/records_rank.sql

@@ -5,5 +5,7 @@ SELECT
   n_live_tup AS estimated_count
 FROM
   pg_stat_user_tables
+WHERE
+  schemaname = '%{schema}'
 ORDER BY
   n_live_tup DESC;

data/lib/ruby_pg_extras/queries/seq_scans.sql

@@ -4,4 +4,6 @@ SELECT relname AS name,
        seq_scan as count
 FROM
   pg_stat_user_tables
+WHERE
+  schemaname = '%{schema}'
 ORDER BY seq_scan DESC;

data/lib/ruby_pg_extras/queries/table_cache_hit.sql

@@ -11,5 +11,7 @@ SELECT
   END ratio
 FROM
   pg_statio_user_tables
+WHERE
+  schemaname = '%{schema}'
 ORDER BY
   heap_blks_hit / (heap_blks_hit + heap_blks_read + 1)::float DESC;

data/lib/ruby_pg_extras/queries/table_index_scans.sql

@@ -4,4 +4,6 @@ SELECT relname AS name,
        idx_scan as count
 FROM
   pg_stat_user_tables
+WHERE
+  schemaname = '%{schema}'
 ORDER BY idx_scan DESC;

data/lib/ruby_pg_extras/queries/tables.sql

@@ -1,3 +1,3 @@
 /* List all the tables. */
 
-select relname as tablename, schemaname from pg_statio_user_tables;
+select relname as tablename, schemaname from pg_statio_user_tables where schemaname = '%{schema}';

data/lib/ruby_pg_extras/queries/unused_indexes.sql

@@ -12,5 +12,6 @@ SELECT
 FROM pg_stat_user_indexes ui
 JOIN pg_index i ON ui.indexrelid = i.indexrelid
 WHERE NOT indisunique AND idx_scan < %{max_scans} AND pg_relation_size(relid) > 5 * 8192
+AND schemaname = '%{schema}'
 ORDER BY pg_relation_size(i.indexrelid) / nullif(idx_scan, 0) DESC NULLS FIRST,
 pg_relation_size(i.indexrelid) DESC;

data/lib/ruby_pg_extras/size_parser.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module RubyPgExtras
+  class SizeParser
+    def self.to_i(arg)
+      value = to_i_si(arg) || to_i_binary(arg) || to_i_digits(arg)
+      raise ArgumentError, "Unparseable size: #{arg}" if value.nil?
+
+      value
+    end
+
+    def self.regexp_for_units(units)
+      /\A(-?\d+)\s?(#{units.join('|')})\z/i
+    end
+
+    SI_UNITS = %w[bytes kB MB GB TB PB EB ZB YB].map(&:downcase).freeze
+    SI_REGEXP = regexp_for_units(SI_UNITS)
+
+    def self.to_i_si(arg)
+      to_i_for_units(arg, SI_REGEXP, SI_UNITS, 1000)
+    end
+
+    BINARY_UNITS = %w[bytes KiB MiB GiB TiB PiB EiB ZiB YiB].map(&:downcase).freeze
+    BINARY_REGEXP = regexp_for_units(BINARY_UNITS)
+
+    def self.to_i_binary(arg)
+      to_i_for_units(arg, BINARY_REGEXP, BINARY_UNITS, 1024)
+    end
+
+    def self.to_i_for_units(arg, regexp, units, multiplier)
+      match_data = regexp.match(arg)
+      return nil unless match_data
+
+      exponent = units.index(match_data[2].downcase).to_i
+      match_data[1].to_i * multiplier**exponent
+    end
+
+    DIGITS_ONLY_REGEXP = /\A(-?\d+)\z/.freeze
+    def self.to_i_digits(arg)
+      DIGITS_ONLY_REGEXP.match?(arg) ? arg.to_i : nil
+    end
+  end
+end

data/lib/ruby_pg_extras/version.rb

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

data/ruby-pg-extras.gemspec

@@ -16,7 +16,6 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   s.license       = "MIT"
   s.add_dependency "pg"
-  s.add_dependency "filesize"
   s.add_dependency "terminal-table"
   s.add_development_dependency "rake"
   s.add_development_dependency "rspec"

data/spec/size_parser_spec.rb

@@ -0,0 +1,167 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe RubyPgExtras::SizeParser do
+  subject(:result) { described_class.to_i(arg) }
+
+  describe 'SI Units' do
+    let(:arg) { "#{num_units} #{unit}" }
+
+    context "when the argument is a number followed by 'bytes', with possible case variations" do
+      let(:num_units) { rand(1000) }
+      let(:unit) { %w[bytes BYTES Bytes].sample }
+
+      it { is_expected.to eq(num_units) }
+    end
+
+    context "when the argument is a number followed by 'kB', with possible case variations" do
+      let(:num_units) { rand(1000) }
+      let(:unit) { %w[kB kb KB].sample }
+
+      it { is_expected.to eq(num_units * 1000) }
+    end
+
+    context "when the argument is a number followed by 'MB', with possible case variations" do
+      let(:num_units) { rand(1000) }
+      let(:unit) { %w[MB Mb mb].sample }
+
+      it { is_expected.to eq(num_units * 1000 * 1000) }
+    end
+
+    context "when the argument is a number followed by 'GB', with possible case variations" do
+      let(:num_units) { rand(1000) }
+      let(:unit) { %w[GB Gb gb].sample }
+
+      it { is_expected.to eq(num_units * 1000 * 1000 * 1000) }
+    end
+
+    context "when the argument is a number followed by 'TB', with possible case variations" do
+      let(:num_units) { rand(1000) }
+      let(:unit) { %w[TB Tb tb].sample }
+
+      it { is_expected.to eq(num_units * 1000 * 1000 * 1000 * 1000) }
+    end
+
+    context "when the argument is a number followed by 'PB', with possible case variations" do
+      let(:num_units) { rand(1000) }
+      let(:unit) { %w[PB Pb pb].sample }
+
+      it { is_expected.to eq(num_units * 1000 * 1000 * 1000 * 1000 * 1000) }
+    end
+
+    context "when the argument is a number followed by 'EB', with possible case variations" do
+      let(:num_units) { rand(1000) }
+      let(:unit) { %w[EB Eb eb].sample }
+
+      it { is_expected.to eq(num_units * 1000 * 1000 * 1000 * 1000 * 1000 * 1000) }
+    end
+
+    context "when the argument is a number followed by 'ZB', with possible case variations" do
+      let(:num_units) { 912 }
+      let(:unit) { %w[ZB Zb zb].sample }
+
+      it { is_expected.to eq(num_units * 1000 * 1000 * 1000 * 1000 * 1000 * 1000 * 1000) }
+    end
+
+    context "when the argument is a number followed by 'YB', with possible case variations" do
+      let(:num_units) { 912 }
+      let(:unit) { %w[YB Yb yb].sample }
+
+      it { is_expected.to eq(num_units * 1000 * 1000 * 1000 * 1000 * 1000 * 1000 * 1000 * 1000) }
+    end
+  end
+
+  describe 'Binary Units' do
+    let(:arg) { "#{num_units} #{unit}" }
+
+    context "when the argument is a number followed by 'bytes', with possible case variations" do
+      let(:num_units) { rand(1000) }
+      let(:unit) { %w[bytes BYTES Bytes].sample }
+
+      it { is_expected.to eq(num_units) }
+    end
+
+    context "when the argument is a number followed by 'kiB', with possible case variations" do
+      let(:num_units) { rand(1000) }
+      let(:unit) { %w[kiB kib KiB].sample }
+
+      it { is_expected.to eq(num_units * 1024) }
+    end
+
+    context "when the argument is a number followed by 'MiB', with possible case variations" do
+      let(:num_units) { rand(1000) }
+      let(:unit) { %w[MiB Mib mib].sample }
+
+      it { is_expected.to eq(num_units * 1024 * 1024) }
+    end
+
+    context "when the argument is a number followed by 'GiB', with possible case variations" do
+      let(:num_units) { rand(1000) }
+      let(:unit) { %w[GiB Gib gib].sample }
+
+      it { is_expected.to eq(num_units * 1024 * 1024 * 1024) }
+    end
+
+    context "when the argument is a number followed by 'TiB', with possible case variations" do
+      let(:num_units) { rand(1000) }
+      let(:unit) { %w[TiB Tib tib].sample }
+
+      it { is_expected.to eq(num_units * 1024 * 1024 * 1024 * 1024) }
+    end
+
+    context "when the argument is a number followed by 'PiB', with possible case variations" do
+      let(:num_units) { rand(1000) }
+      let(:unit) { %w[PiB Pib pib].sample }
+
+      it { is_expected.to eq(num_units * 1024 * 1024 * 1024 * 1024 * 1024) }
+    end
+
+    context "when the argument is a number followed by 'EiB', with possible case variations" do
+      let(:num_units) { rand(1000) }
+      let(:unit) { %w[EiB Eib eib].sample }
+
+      it { is_expected.to eq(num_units * 1024 * 1024 * 1024 * 1024 * 1024 * 1024) }
+    end
+
+    context "when the argument is a number followed by 'ZB', with possible case variations" do
+      let(:num_units) { 912 }
+      let(:unit) { %w[ZiB Zib zib].sample }
+
+      it { is_expected.to eq(num_units * 1024 * 1024 * 1024 * 1024 * 1024 * 1024 * 1024) }
+    end
+
+    context "when the argument is a number followed by 'YB', with possible case variations" do
+      let(:num_units) { 912 }
+      let(:unit) { %w[YiB Yib yib].sample }
+
+      it { is_expected.to eq(num_units * 1024 * 1024 * 1024 * 1024 * 1024 * 1024 * 1024 * 1024) }
+    end
+  end
+
+  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
+      expect do
+        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
+      expect do
+        described_class.to_i('123 mL')
+      end.to raise_error ArgumentError
+    end
+
+    it 'when the argument cannot be parsed an number of units' do
+      expect do
+        described_class.to_i('1c3 MB')
+      end.to raise_error ArgumentError
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -12,6 +12,8 @@ elsif pg_version == "12"
   "5433"
 elsif pg_version == "13"
   "5434"
+elsif pg_version == "14"
+  "5435"
 else
   "5432"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-pg-extras
 version: !ruby/object:Gem::Version
-  version: 4.4.4
+  version: 4.6.0
 platform: ruby
 authors:
 - pawurb
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-24 00:00:00.000000000 Z
+date: 2022-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
@@ -24,20 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: filesize
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: terminal-table
   requirement: !ruby/object:Gem::Requirement
@@ -138,6 +124,7 @@ files:
 - lib/ruby_pg_extras/queries/total_table_size.sql
 - lib/ruby_pg_extras/queries/unused_indexes.sql
 - lib/ruby_pg_extras/queries/vacuum_stats.sql
+- lib/ruby_pg_extras/size_parser.rb
 - lib/ruby_pg_extras/table_info.rb
 - lib/ruby_pg_extras/table_info_print.rb
 - lib/ruby_pg_extras/version.rb
@@ -146,6 +133,7 @@ files:
 - spec/diagnose_data_spec.rb
 - spec/diagnose_print_spec.rb
 - spec/index_info_spec.rb
+- spec/size_parser_spec.rb
 - spec/smoke_spec.rb
 - spec/spec_helper.rb
 - spec/table_info_spec.rb
@@ -177,6 +165,7 @@ test_files:
 - spec/diagnose_data_spec.rb
 - spec/diagnose_print_spec.rb
 - spec/index_info_spec.rb
+- spec/size_parser_spec.rb
 - spec/smoke_spec.rb
 - spec/spec_helper.rb
 - spec/table_info_spec.rb