rails-pg-extras 1.6.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b44baf89a4349ef720b371a8a83a8397e0e848794b1bf248398cfd19c5f606d5
-  data.tar.gz: ebdabe9d275ed5ef7132ce604f894a42520226db0b1dc5d50acd092a0aed6dd4
+  metadata.gz: c107fe728b02513bceaa617c45f5cf5bc4048fb0376ec46a13a70ba86cff4cf9
+  data.tar.gz: 07fd71c6c2a1ff119b30845f32967d4d2c49d8ae0eccfbdaf52b228b5c907541
 SHA512:
-  metadata.gz: d0b9e1505835974df1959e620385461f7c5c92838efadd18abb57a5656d1b942d8f097f7c70389e815a96a5dcb239b67b16cee430188e0532ccef57eb2a6ff50
-  data.tar.gz: 269a9b8bb29c5114c43885d61f849b3ed73664cb7c5e9e772c85281cacebbce641b224fe0e246bda5a7ab5426210ee3a75a0ac0a36c6555abb64988d7b66b733
+  metadata.gz: d9de7a07381f8d203e60f98b750b0791e7be932dfaf8a621106bc69bbe44eb4ce5ca0893e4d8b22905913626f28bedc77da7fad282c4171ea51e3b424c359984
+  data.tar.gz: 99872d4b0efcddf6d4a0af106068fc2a83544053c13596c2532320ac746a3ca6174d7ff1fd8e3a8c2533b49acaeaac896bbf6def5bc1f5dc083e6956b9cf52f9

data/.circleci/config.yml

@@ -6,6 +6,7 @@ jobs:
         environment:
           DATABASE_URL: postgresql://postgres:secret@localhost:5432/rails-pg-extras-test
       - image: circleci/postgres:11.5
+        command: postgres -c shared_preload_libraries=pg_stat_statements -c pg_stat_statements.track=all -c max_connections=200
         environment:
           POSTGRES_USER: postgres
           POSTGRES_DB: rails-pg-extras-test

data/README.md

@@ -526,20 +526,20 @@ This commands kills all the currently active connections to the database. It can
 
 ### `buffercache_stats`
 
-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.
-
 ```ruby
 RailsPGExtras.buffercache_stats(args: { limit: 10 })
 ```
 
-### `buffercache_usage`
+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.
 
-This command calculates how many blocks from which table are currently cached.
+### `buffercache_usage`
 
 ```ruby
 RailsPGExtras.buffercache_usage(args: { limit: 20 })
 ```
 
+This command calculates how many blocks from which table are currently cached.
+
 ### `extensions`
 
 ```ruby

data/docker-compose.yml.sample

@@ -1,12 +1,30 @@
 version: '3'
 
 services:
-  postgres:
+  postgres11:
     image: postgres:11.5-alpine
+    command: postgres -c shared_preload_libraries=pg_stat_statements -c pg_stat_statements.track=all -c max_connections=200
     environment:
       POSTGRES_USER: postgres
       POSTGRES_DB: rails-pg-extras-test
       POSTGRES_PASSWORD: secret
     ports:
       - '5432:5432'
-
+  postgres12:
+    image: postgres:12.7-alpine
+    command: postgres -c shared_preload_libraries=pg_stat_statements -c pg_stat_statements.track=all -c max_connections=200
+    environment:
+      POSTGRES_USER: postgres
+      POSTGRES_DB: rails-pg-extras-test
+      POSTGRES_PASSWORD: secret
+    ports:
+      - '5433:5432'
+  postgres13:
+    image: postgres:13.3-alpine
+    command: postgres -c shared_preload_libraries=pg_stat_statements -c pg_stat_statements.track=all -c max_connections=200
+    environment:
+      POSTGRES_USER: postgres
+      POSTGRES_DB: rails-pg-extras-test
+      POSTGRES_PASSWORD: secret
+    ports:
+      - '5434:5432'

data/lib/rails-pg-extras.rb

@@ -6,6 +6,7 @@ require 'ruby-pg-extras'
 module RailsPGExtras
   QUERIES = RubyPGExtras::QUERIES
   DEFAULT_ARGS = RubyPGExtras::DEFAULT_ARGS
+  NEW_PG_STAT_STATEMENTS = RubyPGExtras::NEW_PG_STAT_STATEMENTS
 
   QUERIES.each do |query_name|
     define_singleton_method query_name do |options = {}|
@@ -18,6 +19,16 @@ module RailsPGExtras
   end
 
   def self.run_query(query_name:, in_format:, args: {})
+    if %i(calls outliers).include?(query_name)
+      pg_stat_statements_ver = RailsPGExtras.connection.execute("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)
+          query_name = "#{query_name}_legacy".to_sym
+        end
+      end
+    end
+
     sql = if (custom_args = DEFAULT_ARGS[query_name].merge(args)) != {}
       RubyPGExtras.sql_for(query_name: query_name) % custom_args
     else
@@ -36,8 +47,6 @@ module RailsPGExtras
   def self.connection
     ActiveRecord::Base.connection
   end
-
-  private_class_method :connection
 end
 
 require 'rails-pg-extras/railtie' if defined?(Rails)

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsPGExtras
-  VERSION = "1.6.0"
+  VERSION = "2.0.0"
 end

data/spec/smoke_spec.rb

@@ -3,9 +3,12 @@
 require 'spec_helper'
 
 describe RailsPGExtras do
-  PG_STATS_DEPENDENT_QUERIES = %i(calls outliers)
+  before(:all) do
+    RailsPGExtras.connection.execute("CREATE EXTENSION IF NOT EXISTS pg_buffercache;")
+    RubyPGExtras.connection.exec("CREATE EXTENSION IF NOT EXISTS pg_stat_statements;")
+  end
 
-  (RailsPGExtras::QUERIES - PG_STATS_DEPENDENT_QUERIES).each do |query_name|
+  RailsPGExtras::QUERIES.each do |query_name|
     it "#{query_name} query can be executed" do
       expect do
         RailsPGExtras.run_query(

data/spec/spec_helper.rb

@@ -5,7 +5,19 @@ require 'bundler/setup'
 require 'active_record'
 require_relative '../lib/rails-pg-extras'
 
-ENV["DATABASE_URL"] ||= "postgresql://postgres:secret@localhost:5432/rails-pg-extras-test"
+pg_version = ENV["PG_VERSION"]
+
+port = if pg_version == "11"
+  "5432"
+elsif pg_version == "12"
+  "5433"
+elsif pg_version == "13"
+  "5434"
+else
+  "5432"
+end
+
+ENV["DATABASE_URL"] ||= "postgresql://postgres:secret@localhost:#{port}/rails-pg-extras-test"
 
 RSpec.configure do |config|
   config.before :suite do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-pg-extras
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 2.0.0
 platform: ruby
 authors:
 - pawurb
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-05 00:00:00.000000000 Z
+date: 2021-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-pg-extras
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.6.0
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.6.0
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -108,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Rails PostgreSQL performance database insights