ruby-pg-extras 3.3.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24b2658f1f03b3d3251ec09c992a3622b30793ef64caf92f51baaa8558c792f9
-  data.tar.gz: d9b716c71c8bb2cf230b61132b91df5537f543857a0dbf4d37679b9805e2d1ed
+  metadata.gz: 99083fee8c980277b64f38107fe5e28c8ebea8168ad0fb46698cd83c841b24ab
+  data.tar.gz: 95908adf2a33a6d03f5fe5539f6b0542c92a944c273a7ea838005190261e4e34
 SHA512:
-  metadata.gz: 8a4478c18db57ce31dd34faa8c998aef38bd18b85c758312656e2d24604cd89f12e6978b754aac9045b1273705f71813e51401a930dadc50ad3c3c081dd5df83
-  data.tar.gz: 0e3ad8983b6ce98b0dad4db84b444040b2060e268395ec67d322a2d8fee8043f3996da03f7a20b90945180e939078bafeae7d30a2d45fec8d42a19ce5ebb05b7
+  metadata.gz: ce3910f036782e3773b098f2530d132d1591e3227d1d6129cf51e8a48cf49bc3512c14280adc32cb1ab1c0d840fd42cc6848682a0c8dd0fe77c6fff31bb5e196
+  data.tar.gz: f847fcb57cac754824999afc9ceb8492be333893a9eaa2e09a29ef61ea0b2dbffd50f2712f1b7adfc609cc44cca51817584a9615e9240cc23e74cf9e0b9c7012

data/README.md

@@ -23,7 +23,7 @@ Alternative versions:
 In your Gemfile
 
 ```ruby
-gem "ruby-pg-extras"
+gem "ruby-pg-extras", require: "ruby_pg_extras"
 ```
 
 `calls` and `outliers` queries require [pg_stat_statements](https://www.postgresql.org/docs/current/pgstatstatements.html) extension.
@@ -31,7 +31,7 @@ gem "ruby-pg-extras"
 You can check if it is enabled in your database by running:
 
 ```ruby
-RubyPGExtras.extensions
+RubyPgExtras.extensions
 ```
 You should see the similar line in the output:
 
@@ -42,7 +42,7 @@ You should see the similar line in the output:
 `ssl_used` requires `sslinfo` extension, and `buffercache_usage`/`buffercache_usage` queries need `pg_buffercache`. You can enable them all by running:
 
 ```ruby
-RubyPGExtras.add_extensions
+RubyPgExtras.add_extensions
 ```
 
 ## Usage
@@ -56,13 +56,13 @@ ENV["DATABASE_URL"] = "postgresql://postgres:secret@localhost:5432/database_name
 Alternatively you can set it using the module class method:
 
 ```ruby
-RubyPGExtras.database_url = "postgresql://postgres:secret@localhost:5432/database_name"
+RubyPgExtras.database_url = "postgresql://postgres:secret@localhost:5432/database_name"
 ```
 
 You can run queries using a simple Ruby API:
 
 ```ruby
-RubyPGExtras.cache_hit
+RubyPgExtras.cache_hit
 ```
 ```bash
 +----------------+------------------------+
@@ -78,15 +78,15 @@ RubyPGExtras.cache_hit
 By default the ASCII table is displayed, to change to format you need to specify the `in_format` parameter (`[:display_table, :hash, :array, :raw]` options are available):
 
 ```ruby
-RubyPGExtras.cache_hit(in_format: :hash) =>
+RubyPgExtras.cache_hit(in_format: :hash) =>
 
  [{"name"=>"index hit rate", "ratio"=>"0.97796610169491525424"}, {"name"=>"table hit rate", "ratio"=>"0.96724294813466787989"}]
 
-RubyPGExtras.cache_hit(in_format: :array) =>
+RubyPgExtras.cache_hit(in_format: :array) =>
 
  [["index hit rate", "0.97796610169491525424"], ["table hit rate", "0.96724294813466787989"]]
 
-RubyPGExtras.cache_hit(in_format: :raw) =>
+RubyPgExtras.cache_hit(in_format: :raw) =>
 
  #<PG::Result:0x00007f75777f7328 status=PGRES_TUPLES_OK ntuples=2 nfields=2 cmd_tuples=2>
 ```
@@ -94,7 +94,7 @@ RubyPGExtras.cache_hit(in_format: :raw) =>
 Some methods accept an optional `args` param allowing you to customize queries:
 
 ```ruby
-RubyPGExtras.long_running_queries(args: { threshold: "200 milliseconds" })
+RubyPgExtras.long_running_queries(args: { threshold: "200 milliseconds" })
 
 ```
 
@@ -103,7 +103,7 @@ RubyPGExtras.long_running_queries(args: { threshold: "200 milliseconds" })
 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:
 
 ```ruby
-RubyPGExtras.diagnose
+RubyPgExtras.diagnose
 ```
 
 ![Diagnose report](https://github.com/pawurb/ruby-pg-extras/raw/master/ruby-pg-extras-diagnose.png)
@@ -117,7 +117,7 @@ Keep reading to learn about methods that `diagnose` uses under the hood.
 This method displays metadata metrics for all or a selected table. You can use it to check the table's size, its cache hit metrics, and whether it is correctly indexed. Many sequential scans or no index scans are potential indicators of misconfigured indexes. This method aggregates data provided by other methods in an easy to analyze summary format.
 
 ```ruby
-RubyPGExtras.table_info(args: { table_name: "users" })
+RubyPgExtras.table_info(args: { table_name: "users" })
 
 | Table name | Table size | Table cache hit   | Indexes cache hit  | Estimated rows | Sequential scans | Indexes scans |
 +------------+------------+-------------------+--------------------+----------------+------------------+---------------+
@@ -131,7 +131,7 @@ This method returns summary info about database indexes. You can check index siz
 
 ```ruby
 
-RubyPGExtras.index_info(args: { table_name: "users" })
+RubyPgExtras.index_info(args: { table_name: "users" })
 
 | Index name                    | Table name | Columns        | Index size | Index scans | Null frac |
 +-------------------------------+------------+----------------+------------+-------------+-----------+
@@ -148,7 +148,7 @@ RubyPGExtras.index_info(args: { table_name: "users" })
 
 ```ruby
 
-RubyPGExtras.cache_hit
+RubyPgExtras.cache_hit
 
       name      |         ratio
 ----------------+------------------------
@@ -165,7 +165,7 @@ This command provides information on the efficiency of the buffer cache, for bot
 
 ```ruby
 
-RubyPGExtras.index_cache_hit
+RubyPgExtras.index_cache_hit
 
 | name                  | buffer_hits | block_reads | total_read | ratio             |
 +-----------------------+-------------+-------------+------------+-------------------+
@@ -183,7 +183,7 @@ The same as `cache_hit` with each table's indexes cache hit info displayed separ
 
 ```ruby
 
-RubyPGExtras.table_cache_hit
+RubyPgExtras.table_cache_hit
 
 | name                  | buffer_hits | block_reads | total_read | ratio             |
 +-----------------------+-------------+-------------+------------+-------------------+
@@ -201,7 +201,7 @@ The same as `cache_hit` with each table's cache hit info displayed seperately.
 
 ```ruby
 
-RubyPGExtras.db_settings
+RubyPgExtras.db_settings
 
              name             | setting | unit |
 ------------------------------+---------+------+
@@ -221,7 +221,7 @@ This method displays values for selected PostgreSQL settings. You can compare th
 
 ```ruby
 
-RubyPGExtras.ssl_used
+RubyPgExtras.ssl_used
 
 | ssl_is_used                     |
 +---------------------------------+
@@ -235,7 +235,7 @@ Returns boolean indicating if an encrypted SSL is currently used. Connecting to
 
 ```ruby
 
-RubyPGExtras.index_usage
+RubyPgExtras.index_usage
 
        relname       | percent_of_times_index_used | rows_in_table
 ---------------------+-----------------------------+---------------
@@ -253,7 +253,7 @@ This command provides information on the efficiency of indexes, represented as w
 
 ```ruby
 
-RubyPGExtras.locks
+RubyPgExtras.locks
 
  procpid | relname | transactionid | granted |     query_snippet     | mode             |       age
 ---------+---------+---------------+---------+-----------------------+-------------------------------------
@@ -274,7 +274,7 @@ This command displays queries that have taken out an exclusive lock on a relatio
 
 ```ruby
 
-RubyPGExtras.all_locks
+RubyPgExtras.all_locks
 
 ```
 
@@ -284,7 +284,7 @@ This command displays all the current locks, regardless of their type.
 
 ```ruby
 
-RubyPGExtras.outliers(args: { limit: 20 })
+RubyPgExtras.outliers(args: { limit: 20 })
 
                    query                 |    exec_time     | prop_exec_time |   ncalls    | sync_io_time
 -----------------------------------------+------------------+----------------+-------------+--------------
@@ -308,7 +308,7 @@ Typically, an efficient query will have an appropriate ratio of calls to total e
 
 ```ruby
 
-RubyPGExtras.calls(args: { limit: 10 })
+RubyPgExtras.calls(args: { limit: 10 })
 
                    qry                   |    exec_time     | prop_exec_time |   ncalls    | sync_io_time
 -----------------------------------------+------------------+----------------+-------------+--------------
@@ -330,7 +330,7 @@ This command is much like `pg:outliers`, but ordered by the number of times a st
 
 ```ruby
 
-RubyPGExtras.blocking
+RubyPgExtras.blocking
 
  blocked_pid |    blocking_statement    | blocking_duration | blocking_pid |                                        blocked_statement                           | blocked_duration
 -------------+--------------------------+-------------------+--------------+------------------------------------------------------------------------------------+------------------
@@ -346,7 +346,7 @@ This command displays statements that are currently holding locks that other sta
 
 ```ruby
 
-RubyPGExtras.total_index_size
+RubyPgExtras.total_index_size
 
   size
 -------
@@ -360,7 +360,7 @@ This command displays the total size of all indexes on the database, in MB. It i
 
 ```ruby
 
-RubyPGExtras.index_size
+RubyPgExtras.index_size
 
                              name                              |  size
 ---------------------------------------------------------------+---------
@@ -383,7 +383,7 @@ This command displays the size of each each index in the database, in MB. It is
 
 ```ruby
 
-RubyPGExtras.table_size
+RubyPgExtras.table_size
 
                              name                              |  size
 ---------------------------------------------------------------+---------
@@ -401,7 +401,7 @@ This command displays the size of each table and materialized view in the databa
 
 ```ruby
 
-RubyPGExtras.table_indexes_size
+RubyPgExtras.table_indexes_size
 
                              table                             | indexes_size
 ---------------------------------------------------------------+--------------
@@ -419,7 +419,7 @@ This command displays the total size of indexes for each table and materialized
 
 ```ruby
 
-RubyPGExtras.total_table_size
+RubyPgExtras.total_table_size
 
                              name                              |  size
 ---------------------------------------------------------------+---------
@@ -437,7 +437,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: 20 })
 
           table      |                       index                | index_size | index_scans
 ---------------------+--------------------------------------------+------------+-------------
@@ -455,7 +455,7 @@ This command displays indexes that have < 50 scans recorded against them, and ar
 
 ```ruby
 
-RubyPGExtras.duplicate_indexes
+RubyPgExtras.duplicate_indexes
 
 | size       |  idx1        |  idx2          |  idx3    |  idx4     |
 +------------+--------------+----------------+----------+-----------+
@@ -468,7 +468,7 @@ This command displays multiple indexes that have the same set of columns, same o
 
 ```ruby
 
-RubyPGExtras.null_indexes(args: { min_relation_size_mb: 10 })
+RubyPgExtras.null_indexes(args: { min_relation_size_mb: 10 })
 
    oid   |         index      | index_size | unique | indexed_column | null_frac | expected_saving
 ---------+--------------------+------------+--------+----------------+-----------+-----------------
@@ -486,7 +486,7 @@ This command displays indexes that contain `NULL` values. A high ratio of `NULL`
 
 ```ruby
 
-RubyPGExtras.seq_scans
+RubyPgExtras.seq_scans
 
 
                name                |  count
@@ -510,7 +510,7 @@ This command displays the number of sequential scans recorded against all tables
 
 ```ruby
 
-RubyPGExtras.long_running_queries(args: { threshold: "200 milliseconds" })
+RubyPgExtras.long_running_queries(args: { threshold: "200 milliseconds" })
 
 
   pid  |    duration     |                                      query
@@ -527,7 +527,7 @@ This command displays currently running queries, that have been running for long
 
 ```ruby
 
-RubyPGExtras.records_rank
+RubyPgExtras.records_rank
 
                name                | estimated_count
 -----------------------------------+-----------------
@@ -546,7 +546,7 @@ This command displays an estimated count of rows per table, descending by estima
 
 ```ruby
 
-RubyPGExtras.bloat
+RubyPgExtras.bloat
 
 
  type  | schemaname |           object_name         | bloat |   waste
@@ -567,7 +567,7 @@ This command displays an estimation of table "bloat" – space allocated to a re
 
 ```ruby
 
-RubyPGExtras.vacuum_stats
+RubyPgExtras.vacuum_stats
 
  schema |         table         | last_vacuum | last_autovacuum  |    rowcount    | dead_rowcount  | autovacuum_threshold | expect_autovacuum
 --------+-----------------------+-------------+------------------+----------------+----------------+----------------------+-------------------
@@ -585,7 +585,7 @@ This command displays statistics related to vacuum operations for each table, in
 
 ```ruby
 
-RubyPGExtras.kill_all
+RubyPgExtras.kill_all
 
 ```
 
@@ -594,7 +594,7 @@ This commands kills all the currently active connections to the database. It can
 ### `pg_stat_statements_reset`
 
 ```ruby
-RubyPGExtras.pg_stat_statements_reset
+RubyPgExtras.pg_stat_statements_reset
 ```
 
 This command discards all statistics gathered so far by pg_stat_statements.
@@ -602,7 +602,7 @@ This command discards all statistics gathered so far by pg_stat_statements.
 ### `buffercache_stats`
 
 ```ruby
-RubyPGExtras.buffercache_stats(args: { limit: 10 })
+RubyPgExtras.buffercache_stats(args: { limit: 10 })
 ```
 
 This command shows the relations buffered in database share buffer, ordered by percentage taken. It also shows that how much of the whole relation is buffered.
@@ -610,7 +610,7 @@ This command shows the relations buffered in database share buffer, ordered by p
 ### `buffercache_usage`
 
 ```ruby
-RubyPGExtras.buffercache_usage(args: { limit: 20 })
+RubyPgExtras.buffercache_usage(args: { limit: 20 })
 ```
 
 This command calculates how many blocks from which table are currently cached.
@@ -619,7 +619,7 @@ This command calculates how many blocks from which table are currently cached.
 
 ```ruby
 
-RubyPGExtras.extensions
+RubyPgExtras.extensions
 
 ```
 
@@ -629,7 +629,7 @@ This command lists all the currently installed and available PostgreSQL extensio
 
 ```ruby
 
-RubyPGExtras.mandelbrot
+RubyPgExtras.mandelbrot
 
 ```
 

data/lib/{ruby-pg-extras → ruby_pg_extras}/diagnose_data.rb

@@ -2,7 +2,7 @@
 
 require 'filesize'
 
-module RubyPGExtras
+module RubyPgExtras
   class DiagnoseData
     PG_EXTRAS_TABLE_CACHE_HIT_MIN_EXPECTED = "0.985"
     PG_EXTRAS_INDEX_CACHE_HIT_MIN_EXPECTED = "0.985"
@@ -52,7 +52,7 @@ module RubyPGExtras
     private
 
     def query_module
-      RubyPGExtras
+      RubyPgExtras
     end
 
     def table_cache_hit

data/lib/{ruby-pg-extras → ruby_pg_extras}/diagnose_print.rb

@@ -2,7 +2,7 @@
 
 require 'terminal-table'
 
-module RubyPGExtras
+module RubyPgExtras
   class DiagnosePrint
     def self.call(data)
       new.call(data)

data/lib/{ruby-pg-extras → ruby_pg_extras}/index_info.rb

@@ -1,4 +1,4 @@
-module RubyPGExtras
+module RubyPgExtras
   class IndexInfo
     def self.call(table_name = nil)
       new.call(table_name)
@@ -55,7 +55,7 @@ module RubyPGExtras
     private
 
     def query_module
-      RubyPGExtras
+      RubyPgExtras
     end
   end
 end

data/lib/{ruby-pg-extras → ruby_pg_extras}/index_info_print.rb

@@ -2,7 +2,7 @@
 
 require 'terminal-table'
 
-module RubyPGExtras
+module RubyPgExtras
   class IndexInfoPrint
     def self.call(data)
       new.call(data)

data/lib/{ruby-pg-extras → ruby_pg_extras}/table_info.rb

@@ -1,4 +1,4 @@
-module RubyPGExtras
+module RubyPgExtras
   class TableInfo
     def self.call(table_name = nil)
       new.call(table_name)
@@ -71,7 +71,7 @@ module RubyPGExtras
     end
 
     def query_module
-      RubyPGExtras
+      RubyPgExtras
     end
   end
 end

data/lib/{ruby-pg-extras → ruby_pg_extras}/table_info_print.rb

@@ -2,7 +2,7 @@
 
 require 'terminal-table'
 
-module RubyPGExtras
+module RubyPgExtras
   class TableInfoPrint
     def self.call(data)
       new.call(data)

data/lib/ruby_pg_extras/version.rb

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

data/lib/{ruby-pg-extras.rb → ruby_pg_extras.rb}

@@ -3,14 +3,14 @@
 require 'terminal-table'
 require 'uri'
 require 'pg'
-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
+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"
 
@@ -50,7 +50,7 @@ module RubyPGExtras
 
   def self.run_query(query_name:, in_format:, args: {})
     if %i(calls outliers).include?(query_name)
-      pg_stat_statements_ver = RubyPGExtras.connection.exec("select installed_version from pg_available_extensions where name='pg_stat_statements'")
+      pg_stat_statements_ver = RubyPgExtras.connection.exec("select installed_version from pg_available_extensions where name='pg_stat_statements'")
         .to_a[0].fetch("installed_version", nil)
       if pg_stat_statements_ver != nil
         if Gem::Version.new(pg_stat_statements_ver) < Gem::Version.new(NEW_PG_STAT_STATEMENTS)
@@ -74,10 +74,10 @@ module RubyPGExtras
   end
 
   def self.diagnose(in_format: :display_table)
-    data = RubyPGExtras::DiagnoseData.call
+    data = RubyPgExtras::DiagnoseData.call
 
     if in_format == :display_table
-      RubyPGExtras::DiagnosePrint.call(data)
+      RubyPgExtras::DiagnosePrint.call(data)
     elsif in_format == :hash
       data
     elsif in_format == :array
@@ -88,10 +88,10 @@ module RubyPGExtras
   end
 
   def self.index_info(args: {}, in_format: :display_table)
-    data = RubyPGExtras::IndexInfo.call(args[:table_name])
+    data = RubyPgExtras::IndexInfo.call(args[:table_name])
 
     if in_format == :display_table
-      RubyPGExtras::IndexInfoPrint.call(data)
+      RubyPgExtras::IndexInfoPrint.call(data)
     elsif in_format == :hash
       data
     elsif in_format == :array
@@ -102,10 +102,10 @@ module RubyPGExtras
   end
 
   def self.table_info(args: {}, in_format: :display_table)
-    data = RubyPGExtras::TableInfo.call(args[:table_name])
+    data = RubyPgExtras::TableInfo.call(args[:table_name])
 
     if in_format == :display_table
-      RubyPGExtras::TableInfoPrint.call(data)
+      RubyPgExtras::TableInfoPrint.call(data)
     elsif in_format == :hash
       data
     elsif in_format == :array
@@ -155,7 +155,7 @@ module RubyPGExtras
   end
 
   def self.sql_path_for(query_name:)
-    File.join(File.dirname(__FILE__), "/ruby-pg-extras/queries/#{query_name}.sql")
+    File.join(File.dirname(__FILE__), "/ruby_pg_extras/queries/#{query_name}.sql")
   end
 
   def self.connection

data/ruby-pg-extras.gemspec

@@ -1,11 +1,11 @@
 # -*- encoding: utf-8 -*-
 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.version       = RubyPgExtras::VERSION
   s.authors       = ["pawurb"]
   s.email         = ["contact@pawelurbanek.com"]
   s.summary       = %q{ Ruby PostgreSQL performance database insights }

data/spec/diagnose_data_spec.rb

@@ -2,15 +2,15 @@
 
 require 'spec_helper'
 
-describe RubyPGExtras::DiagnoseData do
+describe RubyPgExtras::DiagnoseData do
   subject(:result) do
-    RubyPGExtras::DiagnoseData.call
+    RubyPgExtras::DiagnoseData.call
   end
 
   describe "call" do
     context "stubbed cases" do
       before do
-        expect(RubyPGExtras).to receive(:unused_indexes) {
+        expect(RubyPgExtras).to receive(:unused_indexes) {
           [
             { "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 },
@@ -18,7 +18,7 @@ describe RubyPGExtras::DiagnoseData do
           ]
         }
 
-        expect(RubyPGExtras).to receive(:null_indexes) {
+        expect(RubyPgExtras).to receive(:null_indexes) {
           [
             { "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" },
@@ -26,7 +26,7 @@ describe RubyPGExtras::DiagnoseData do
           ]
         }
 
-        expect(RubyPGExtras).to receive(:bloat) {
+        expect(RubyPgExtras).to receive(:bloat) {
           [
             { "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" },
@@ -34,13 +34,13 @@ describe RubyPGExtras::DiagnoseData do
           ]
         }
 
-        expect(RubyPGExtras).to receive(:duplicate_indexes) {
+        expect(RubyPgExtras).to receive(:duplicate_indexes) {
           [
             { "size" => "128 kb", "idx1" => "users_pkey", "idx2" => "index_users_id" }
           ]
         }
 
-        expect(RubyPGExtras).to receive(:outliers) {
+        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" }
           ]
@@ -49,7 +49,7 @@ describe RubyPGExtras::DiagnoseData do
 
       it "works" do
         expect {
-          RubyPGExtras::DiagnosePrint.call(result)
+          RubyPgExtras::DiagnosePrint.call(result)
         }.not_to raise_error
       end
     end
@@ -57,7 +57,7 @@ describe RubyPGExtras::DiagnoseData do
     context "real database data" do
       it "works" do
         expect {
-          RubyPGExtras::DiagnosePrint.call(result)
+          RubyPgExtras::DiagnosePrint.call(result)
         }.not_to raise_error
       end
     end

data/spec/diagnose_print_spec.rb

@@ -2,9 +2,9 @@
 
 require 'spec_helper'
 
-describe RubyPGExtras::DiagnosePrint do
+describe RubyPgExtras::DiagnosePrint do
   subject(:print_result) do
-    RubyPGExtras::DiagnosePrint.call(data)
+    RubyPgExtras::DiagnosePrint.call(data)
   end
 
   let(:data) do

data/spec/index_info_spec.rb

@@ -2,35 +2,35 @@
 
 require 'spec_helper'
 
-describe RubyPGExtras::IndexInfo do
+describe RubyPgExtras::IndexInfo do
   subject(:result) do
-    RubyPGExtras::IndexInfo.call
+    RubyPgExtras::IndexInfo.call
   end
 
   describe "call" do
     context "stubbed cases" do
       before do
-        expect(RubyPGExtras).to receive(:indexes) {
+        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" },
           ]
         }
 
-        expect(RubyPGExtras).to receive(:index_size) {
+        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"},
           ]
         }
 
-        expect(RubyPGExtras).to receive(:null_indexes) {
+        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" }
           ]
         }
 
-        expect(RubyPGExtras).to receive(:index_scans) {
+        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 }
@@ -40,7 +40,7 @@ describe RubyPGExtras::IndexInfo do
 
       it "works" do
         expect {
-          RubyPGExtras::IndexInfoPrint.call(result)
+          RubyPgExtras::IndexInfoPrint.call(result)
         }.not_to raise_error
       end
     end
@@ -48,7 +48,7 @@ describe RubyPGExtras::IndexInfo do
     context "real data" do
       it "works" do
         expect {
-          RubyPGExtras::IndexInfoPrint.call(result)
+          RubyPgExtras::IndexInfoPrint.call(result)
         }.not_to raise_error
       end
     end

data/spec/smoke_spec.rb

@@ -2,21 +2,21 @@
 
 require 'spec_helper'
 
-describe RubyPGExtras do
-  RubyPGExtras::QUERIES.each do |query_name|
+describe RubyPgExtras do
+  RubyPgExtras::QUERIES.each do |query_name|
     it "#{query_name} description can be read" do
       expect do
-        RubyPGExtras.description_for(
+        RubyPgExtras.description_for(
           query_name: query_name
         )
       end.not_to raise_error
     end
   end
 
-  RubyPGExtras::QUERIES.each do |query_name|
+  RubyPgExtras::QUERIES.each do |query_name|
     it "#{query_name} query can be executed" do
       expect do
-        RubyPGExtras.run_query(
+        RubyPgExtras.run_query(
           query_name: query_name,
           in_format: :hash
         )
@@ -26,9 +26,9 @@ describe RubyPGExtras do
 
   describe "#database_url=" do
     it "setting custom database URL works" do
-      RubyPGExtras.database_url = ENV.fetch("DATABASE_URL")
+      RubyPgExtras.database_url = ENV.fetch("DATABASE_URL")
       expect do
-        RubyPGExtras.bloat(in_format: :hash)
+        RubyPgExtras.bloat(in_format: :hash)
       end.not_to raise_error
     end
   end

data/spec/spec_helper.rb

@@ -2,7 +2,7 @@
 
 require 'rubygems'
 require 'bundler/setup'
-require_relative '../lib/ruby-pg-extras'
+require_relative '../lib/ruby_pg_extras'
 
 pg_version = ENV["PG_VERSION"]
 
@@ -20,8 +20,8 @@ ENV["DATABASE_URL"] ||= "postgresql://postgres:secret@localhost:#{port}/ruby-pg-
 
 RSpec.configure do |config|
   config.before(:suite) do
-    RubyPGExtras.connection.exec("CREATE EXTENSION IF NOT EXISTS pg_stat_statements;")
-    RubyPGExtras.connection.exec("CREATE EXTENSION IF NOT EXISTS pg_buffercache;")
-    RubyPGExtras.connection.exec("CREATE EXTENSION IF NOT EXISTS sslinfo;")
+    RubyPgExtras.connection.exec("CREATE EXTENSION IF NOT EXISTS pg_stat_statements;")
+    RubyPgExtras.connection.exec("CREATE EXTENSION IF NOT EXISTS pg_buffercache;")
+    RubyPgExtras.connection.exec("CREATE EXTENSION IF NOT EXISTS sslinfo;")
   end
 end

data/spec/table_info_spec.rb

@@ -2,57 +2,57 @@
 
 require 'spec_helper'
 
-describe RubyPGExtras::TableInfo do
+describe RubyPgExtras::TableInfo do
   subject(:result) do
-    RubyPGExtras::TableInfo.call
+    RubyPgExtras::TableInfo.call
   end
 
   describe "call" do
     context "stubbed cases" do
       before do
-        expect(RubyPGExtras).to receive(:tables) {
+        expect(RubyPgExtras).to receive(:tables) {
           [
             { "schemaname" => "public", "tablename" => "users" },
             { "schemaname" => "public", "tablename" => "teams" }
           ]
         }
 
-        expect(RubyPGExtras).to receive(:table_size) {
+        expect(RubyPgExtras).to receive(:table_size) {
           [
             { "name" => "teams", "size" => "25 MB" },
             {"name" => "users", "size" => "250 MB"},
           ]
         }
 
-        expect(RubyPGExtras).to receive(:index_cache_hit) {
+        expect(RubyPgExtras).to receive(:index_cache_hit) {
           [
             { "name" => "teams", "ratio" => "0.98" },
             { "name" => "users", "ratio" => "0.999" },
           ]
         }
 
-        expect(RubyPGExtras).to receive(:table_cache_hit) {
+        expect(RubyPgExtras).to receive(:table_cache_hit) {
           [
             { "name" => "teams", "ratio" => "0.88" },
             { "name" => "users", "ratio" => "0.899" },
           ]
         }
 
-        expect(RubyPGExtras).to receive(:records_rank) {
+        expect(RubyPgExtras).to receive(:records_rank) {
           [
             { "name" => "teams", "estimated_count" => "358" },
             { "name" => "users", "estimated_count" => "8973" },
           ]
         }
 
-        expect(RubyPGExtras).to receive(:seq_scans) {
+        expect(RubyPgExtras).to receive(:seq_scans) {
           [
             { "name" => "teams", "count" => "0" },
             { "name" => "users", "count" => "409328" },
           ]
         }
 
-        expect(RubyPGExtras).to receive(:table_index_scans) {
+        expect(RubyPgExtras).to receive(:table_index_scans) {
           [
             { "name" => "teams", "count" => "8579" },
             { "name" => "users", "count" => "0" },
@@ -62,7 +62,7 @@ describe RubyPGExtras::TableInfo do
 
       it "works" do
         expect {
-          RubyPGExtras::TableInfoPrint.call(result)
+          RubyPgExtras::TableInfoPrint.call(result)
         }.not_to raise_error
       end
     end
@@ -70,7 +70,7 @@ describe RubyPGExtras::TableInfo do
     context "real data" do
       it "works" do
         expect {
-          RubyPGExtras::TableInfoPrint.call(result)
+          RubyPgExtras::TableInfoPrint.call(result)
         }.not_to raise_error
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-pg-extras
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 4.0.0
 platform: ruby
 authors:
 - pawurb
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-22 00:00:00.000000000 Z
+date: 2022-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
@@ -96,51 +96,51 @@ files:
 - README.md
 - Rakefile
 - docker-compose.yml.sample
-- lib/ruby-pg-extras.rb
-- lib/ruby-pg-extras/diagnose_data.rb
-- lib/ruby-pg-extras/diagnose_print.rb
-- lib/ruby-pg-extras/index_info.rb
-- lib/ruby-pg-extras/index_info_print.rb
-- lib/ruby-pg-extras/queries/add_extensions.sql
-- lib/ruby-pg-extras/queries/all_locks.sql
-- lib/ruby-pg-extras/queries/bloat.sql
-- lib/ruby-pg-extras/queries/blocking.sql
-- lib/ruby-pg-extras/queries/buffercache_stats.sql
-- 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_legacy.sql
-- lib/ruby-pg-extras/queries/db_settings.sql
-- lib/ruby-pg-extras/queries/duplicate_indexes.sql
-- lib/ruby-pg-extras/queries/extensions.sql
-- lib/ruby-pg-extras/queries/index_cache_hit.sql
-- lib/ruby-pg-extras/queries/index_scans.sql
-- lib/ruby-pg-extras/queries/index_size.sql
-- lib/ruby-pg-extras/queries/index_usage.sql
-- lib/ruby-pg-extras/queries/indexes.sql
-- lib/ruby-pg-extras/queries/kill_all.sql
-- lib/ruby-pg-extras/queries/locks.sql
-- lib/ruby-pg-extras/queries/long_running_queries.sql
-- 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_legacy.sql
-- lib/ruby-pg-extras/queries/pg_stat_statements_reset.sql
-- lib/ruby-pg-extras/queries/records_rank.sql
-- lib/ruby-pg-extras/queries/seq_scans.sql
-- lib/ruby-pg-extras/queries/ssl_used.sql
-- lib/ruby-pg-extras/queries/table_cache_hit.sql
-- lib/ruby-pg-extras/queries/table_index_scans.sql
-- lib/ruby-pg-extras/queries/table_indexes_size.sql
-- lib/ruby-pg-extras/queries/table_size.sql
-- lib/ruby-pg-extras/queries/tables.sql
-- lib/ruby-pg-extras/queries/total_index_size.sql
-- 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/table_info.rb
-- lib/ruby-pg-extras/table_info_print.rb
-- lib/ruby-pg-extras/version.rb
+- lib/ruby_pg_extras.rb
+- lib/ruby_pg_extras/diagnose_data.rb
+- lib/ruby_pg_extras/diagnose_print.rb
+- lib/ruby_pg_extras/index_info.rb
+- lib/ruby_pg_extras/index_info_print.rb
+- lib/ruby_pg_extras/queries/add_extensions.sql
+- lib/ruby_pg_extras/queries/all_locks.sql
+- lib/ruby_pg_extras/queries/bloat.sql
+- lib/ruby_pg_extras/queries/blocking.sql
+- lib/ruby_pg_extras/queries/buffercache_stats.sql
+- 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_legacy.sql
+- lib/ruby_pg_extras/queries/db_settings.sql
+- lib/ruby_pg_extras/queries/duplicate_indexes.sql
+- lib/ruby_pg_extras/queries/extensions.sql
+- lib/ruby_pg_extras/queries/index_cache_hit.sql
+- lib/ruby_pg_extras/queries/index_scans.sql
+- lib/ruby_pg_extras/queries/index_size.sql
+- lib/ruby_pg_extras/queries/index_usage.sql
+- lib/ruby_pg_extras/queries/indexes.sql
+- lib/ruby_pg_extras/queries/kill_all.sql
+- lib/ruby_pg_extras/queries/locks.sql
+- lib/ruby_pg_extras/queries/long_running_queries.sql
+- 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_legacy.sql
+- lib/ruby_pg_extras/queries/pg_stat_statements_reset.sql
+- lib/ruby_pg_extras/queries/records_rank.sql
+- lib/ruby_pg_extras/queries/seq_scans.sql
+- lib/ruby_pg_extras/queries/ssl_used.sql
+- lib/ruby_pg_extras/queries/table_cache_hit.sql
+- lib/ruby_pg_extras/queries/table_index_scans.sql
+- lib/ruby_pg_extras/queries/table_indexes_size.sql
+- lib/ruby_pg_extras/queries/table_size.sql
+- lib/ruby_pg_extras/queries/tables.sql
+- lib/ruby_pg_extras/queries/total_index_size.sql
+- 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/table_info.rb
+- lib/ruby_pg_extras/table_info_print.rb
+- lib/ruby_pg_extras/version.rb
 - ruby-pg-extras-diagnose.png
 - ruby-pg-extras.gemspec
 - spec/diagnose_data_spec.rb

data/lib/ruby-pg-extras/version.rb

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-module RubyPGExtras
-  VERSION = "3.3.0"
-end