rails-pg-extras 3.3.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61f4e9aafcd3569e22233099b2d2935c4d8ca9aebcfb17fef2f8cabfade79155
-  data.tar.gz: 33728bde4e8af5e78a0f144b25e84a84f2f7ab8d0ebb87872c59628aaee3812d
+  metadata.gz: a182232adb71ba714ab127505aa21e410291536a6f6992fed863e6beba4d11d6
+  data.tar.gz: c219ee40b92eed9f873dc7a6fbe8e0cd80dd13e70cdd7048827b639d9dbd2f6f
 SHA512:
-  metadata.gz: bb505ba7f877771aa4588402c6bb659aed3ab20674217208cba61e70a4181f9eac16fff99c9e28fab58441d828cec23fca40814aec45fedcf780b03b2e93e258
-  data.tar.gz: caac36a574f9e22d5e5b9a73a6fd11bac2fe3f66a37d63def69dc5c0c77d121010d32c15ad62eed8159a2a55b00b1fef8b2d7689dc6847932312b122018a6e90
+  metadata.gz: 82e1cd92bf47fb1588d49bb59fbf10ad5cd24c5878b5fec4025db301707936e6196f8af2ed27d384a5259349be5a6dbfdfc678b1e08ad029a37cc0de178d96ba
+  data.tar.gz: 2d7189e0a3953323e5872ad817f015d3f023c90832fe9cf76d42485956f2868089bc9ae00532c377d54dc7f1f764832093cf19778d0f3be02f053eb9d19b9ad1

data/README.md

@@ -8,7 +8,7 @@ You can read this blog post for detailed step by step tutorial on how to [optimi
 
 **Shameless plug:** rails-pg-extras is one of the tools that I use when conducting Rails performance audits. [Check out my offer](https://pawelurbanek.com/#rails-performance-tuning) if you need help with fine-tuning your app.
 
-Use [rails-pg-extras-web](https://github.com/defkode/rails-pg-extras-web) if you want to see SQL metrics in the UI instead of a command line interface.
+Optionally you can enable a visual interface:
 
 ![Web interface](https://github.com/pawurb/rails-pg-extras/raw/master/rails-pg-extras-web.png)
 
@@ -29,7 +29,7 @@ Alternative versions:
 In your Gemfile
 
 ```ruby
-gem "rails-pg-extras"
+gem "rails-pg-extras", require: "rails_pg_extras"
 ```
 
 `calls` and `outliers` queries require [pg_stat_statements](https://www.postgresql.org/docs/current/pgstatstatements.html) extension.
@@ -37,7 +37,7 @@ gem "rails-pg-extras"
 You can check if it is enabled in your database by running:
 
 ```ruby
-RailsPGExtras.extensions
+RailsPgExtras.extensions
 ```
 You should see the similar line in the output:
 
@@ -48,7 +48,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
-RailsPGExtras.add_extensions
+RailsPgExtras.add_extensions
 ```
 
 ## Usage
@@ -60,7 +60,7 @@ rake pg_extras:cache_hit
 ```
 
 ```ruby
-RailsPGExtras.cache_hit
+RailsPgExtras.cache_hit
 ```
 ```bash
 +----------------+------------------------+
@@ -77,15 +77,15 @@ RailsPGExtras.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
-RailsPGExtras.cache_hit(in_format: :hash) =>
+RailsPgExtras.cache_hit(in_format: :hash) =>
 
  [{"name"=>"index hit rate", "ratio"=>"0.97796610169491525424"}, {"name"=>"table hit rate", "ratio"=>"0.96724294813466787989"}]
 
-RailsPGExtras.cache_hit(in_format: :array) =>
+RailsPgExtras.cache_hit(in_format: :array) =>
 
  [["index hit rate", "0.97796610169491525424"], ["table hit rate", "0.96724294813466787989"]]
 
-RailsPGExtras.cache_hit(in_format: :raw) =>
+RailsPgExtras.cache_hit(in_format: :raw) =>
 
  #<PG::Result:0x00007f75777f7328 status=PGRES_TUPLES_OK ntuples=2 nfields=2 cmd_tuples=2>
 ```
@@ -93,7 +93,7 @@ RailsPGExtras.cache_hit(in_format: :raw) =>
 Some methods accept an optional `args` param allowing you to customize queries:
 
 ```ruby
-RailsPGExtras.long_running_queries(args: { threshold: "200 milliseconds" })
+RailsPgExtras.long_running_queries(args: { threshold: "200 milliseconds" })
 
 ```
 
@@ -102,7 +102,7 @@ RailsPGExtras.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
-RailsPGExtras.diagnose
+RailsPgExtras.diagnose
 
 $ rake pg_extras:diagnose
 ```
@@ -111,6 +111,16 @@ $ rake pg_extras:diagnose
 
 Keep reading to learn about methods that `diagnose` uses under the hood.
 
+## Visual interface
+
+You can enable UI using a Rails engine by adding the following code in `config/routes.rb`:
+
+```ruby
+  mount RailsPgExtras::Web::Engine, at: 'pg_extras'
+```
+
+On production environment you can enable HTTP basic auth by specifying `RAILS_PG_EXTRAS_USER` and `RAILS_PG_EXTRAS_PASSWORD` variables.
+
 ## Available methods
 
 ### `table_info`
@@ -118,7 +128,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
-RailsPGExtras.table_info(args: { table_name: "users" })
+RailsPgExtras.table_info(args: { table_name: "users" })
 
 | Table name | Table size | Table cache hit   | Indexes cache hit  | Estimated rows | Sequential scans | Indexes scans |
 +------------+------------+-------------------+--------------------+----------------+------------------+---------------+
@@ -132,7 +142,7 @@ This method returns summary info about database indexes. You can check index siz
 
 ```ruby
 
-RailsPGExtras.index_info(args: { table_name: "users" })
+RailsPgExtras.index_info(args: { table_name: "users" })
 
 | Index name                    | Table name | Columns        | Index size | Index scans | Null frac |
 +-------------------------------+------------+----------------+------------+-------------+-----------+
@@ -148,7 +158,7 @@ RailsPGExtras.index_info(args: { table_name: "users" })
 ### `cache_hit`
 
 ```ruby
-RailsPGExtras.cache_hit
+RailsPgExtras.cache_hit
 
 $ rake pg_extras:cache_hit
 
@@ -167,7 +177,7 @@ This command provides information on the efficiency of the buffer cache, for bot
 
 ```ruby
 
-RailsPGExtras.index_cache_hit
+RailsPgExtras.index_cache_hit
 
 $ rake pg_extras:index_cache_hit
 
@@ -187,7 +197,7 @@ The same as `cache_hit` with each table's indexes cache hit info displayed separ
 
 ```ruby
 
-RailsPGExtras.table_cache_hit
+RailsPgExtras.table_cache_hit
 
 $ rake pg_extras:table_cache_hit
 
@@ -207,7 +217,7 @@ The same as `cache_hit` with each table's cache hit info displayed seperately.
 
 ```ruby
 
-RailsPGExtras.db_settings
+RailsPgExtras.db_settings
 
 $ rake pg_extras:db_settings
 
@@ -229,7 +239,7 @@ This method displays values for selected PostgreSQL settings. You can compare th
 
 ```ruby
 
-RailsPGExtras.ssl_used
+RailsPgExtras.ssl_used
 
 | ssl_is_used                     |
 +---------------------------------+
@@ -242,7 +252,7 @@ Returns boolean indicating if an encrypted SSL is currently used. Connecting to
 ### `index_usage`
 
 ```ruby
-RailsPGExtras.index_usage
+RailsPgExtras.index_usage
 
 $ rake pg_extras:index_usage
 
@@ -261,7 +271,7 @@ This command provides information on the efficiency of indexes, represented as w
 ### `locks`
 
 ```ruby
-RailsPGExtras.locks
+RailsPgExtras.locks
 
 $ rake pg_extras:locks
 
@@ -283,7 +293,7 @@ This command displays queries that have taken out an exclusive lock on a relatio
 ### `all_locks`
 
 ```ruby
-RailsPGExtras.all_locks
+RailsPgExtras.all_locks
 
 $ rake pg_extras:all_locks
 ```
@@ -293,7 +303,7 @@ This command displays all the current locks, regardless of their type.
 ### `outliers`
 
 ```ruby
-RailsPGExtras.outliers(args: { limit: 20 })
+RailsPgExtras.outliers(args: { limit: 20 })
 
 $ rake pg_extras:outliers
 
@@ -317,7 +327,7 @@ Typically, an efficient query will have an appropriate ratio of calls to total e
 ### `calls`
 
 ```ruby
-RailsPGExtras.calls(args: { limit: 10 })
+RailsPgExtras.calls(args: { limit: 10 })
 
 $ rake pg_extras:calls
 
@@ -338,7 +348,7 @@ This command is much like `pg:outliers`, but ordered by the number of times a st
 ### `blocking`
 
 ```ruby
-RailsPGExtras.blocking
+RailsPgExtras.blocking
 
 $ rake pg_extras:blocking
 
@@ -355,7 +365,7 @@ This command displays statements that are currently holding locks that other sta
 ### `total_index_size`
 
 ```ruby
-RailsPGExtras.total_index_size
+RailsPgExtras.total_index_size
 
 $ rake pg_extras:total_index_size
 
@@ -370,7 +380,7 @@ This command displays the total size of all indexes on the database, in MB. It i
 ### `index_size`
 
 ```ruby
-RailsPGExtras.index_size
+RailsPgExtras.index_size
 
 $ rake pg_extras:index_size
                              name                              |  size
@@ -393,7 +403,7 @@ This command displays the size of each each index in the database, in MB. It is
 ### `table_size`
 
 ```ruby
-RailsPGExtras.table_size
+RailsPgExtras.table_size
 
 $ rake pg_extras:table_size
 
@@ -412,7 +422,7 @@ This command displays the size of each table and materialized view in the databa
 ### `table_indexes_size`
 
 ```ruby
-RailsPGExtras.table_indexes_size
+RailsPgExtras.table_indexes_size
 
 $ rake pg_extras:table_indexes_size
 
@@ -431,7 +441,7 @@ This command displays the total size of indexes for each table and materialized
 ### `total_table_size`
 
 ```ruby
-RailsPGExtras.total_table_size
+RailsPgExtras.total_table_size
 
 $ rake pg_extras:total_table_size
 
@@ -450,7 +460,7 @@ This command displays the total size of each table and materialized view in the
 ### `unused_indexes`
 
 ```ruby
-RailsPGExtras.unused_indexes(args: { max_scans: 20 })
+RailsPgExtras.unused_indexes(args: { max_scans: 20 })
 
 $ rake pg_extras:unused_indexes
 
@@ -470,7 +480,7 @@ This command displays indexes that have < 50 scans recorded against them, and ar
 
 ```ruby
 
-RailsPGExtras.duplicate_indexes
+RailsPgExtras.duplicate_indexes
 
 | size       |  idx1        |  idx2          |  idx3    |  idx4     |
 +------------+--------------+----------------+----------+-----------+
@@ -483,7 +493,7 @@ This command displays multiple indexes that have the same set of columns, same o
 
 ```ruby
 
-RailsPGExtras.null_indexes(args: { min_relation_size_mb: 10 })
+RailsPgExtras.null_indexes(args: { min_relation_size_mb: 10 })
 
 $ rake pg_extras:null_indexes
 
@@ -502,7 +512,7 @@ This command displays indexes that contain `NULL` values. A high ratio of `NULL`
 ### `seq_scans`
 
 ```ruby
-RailsPGExtras.seq_scans
+RailsPgExtras.seq_scans
 
 $ rake pg_extras:seq_scans
 
@@ -526,7 +536,7 @@ This command displays the number of sequential scans recorded against all tables
 ### `long_running_queries`
 
 ```ruby
-RailsPGExtras.long_running_queries(args: { threshold: "200 milliseconds" })
+RailsPgExtras.long_running_queries(args: { threshold: "200 milliseconds" })
 
 $ rake pg_extras:long_running_queries
 
@@ -543,7 +553,7 @@ This command displays currently running queries, that have been running for long
 ### `records_rank`
 
 ```ruby
-RailsPGExtras.records_rank
+RailsPgExtras.records_rank
 
 $ rake pg_extras:records_rank
 
@@ -563,7 +573,7 @@ This command displays an estimated count of rows per table, descending by estima
 ### `bloat`
 
 ```ruby
-RailsPGExtras.bloat
+RailsPgExtras.bloat
 
 $ rake pg_extras:bloat
 
@@ -584,7 +594,7 @@ This command displays an estimation of table "bloat" – space allocated to a re
 ### `vacuum_stats`
 
 ```ruby
-RailsPGExtras.vacuum_stats
+RailsPgExtras.vacuum_stats
 
 $ rake pg_extras:vacuum_stats
 
@@ -603,7 +613,7 @@ This command displays statistics related to vacuum operations for each table, in
 
 ```ruby
 
-RailsPGExtras.kill_all
+RailsPgExtras.kill_all
 
 ```
 
@@ -612,7 +622,7 @@ This commands kills all the currently active connections to the database. It can
 ### `pg_stat_statements_reset`
 
 ```ruby
-RailsPGExtras.pg_stat_statements_reset
+RailsPgExtras.pg_stat_statements_reset
 ```
 
 This command discards all statistics gathered so far by pg_stat_statements.
@@ -620,7 +630,7 @@ This command discards all statistics gathered so far by pg_stat_statements.
 ### `buffercache_stats`
 
 ```ruby
-RailsPGExtras.buffercache_stats(args: { limit: 10 })
+RailsPgExtras.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.
@@ -628,7 +638,7 @@ This command shows the relations buffered in database share buffer, ordered by p
 ### `buffercache_usage`
 
 ```ruby
-RailsPGExtras.buffercache_usage(args: { limit: 20 })
+RailsPgExtras.buffercache_usage(args: { limit: 20 })
 ```
 
 This command calculates how many blocks from which table are currently cached.
@@ -637,7 +647,7 @@ This command calculates how many blocks from which table are currently cached.
 
 ```ruby
 
-RailsPGExtras.extensions
+RailsPgExtras.extensions
 
 $ rake pg_extras:extensions
 
@@ -651,7 +661,7 @@ This command lists all the currently installed and available PostgreSQL extensio
 ### mandelbrot
 
 ```ruby
-RailsPGExtras.mandelbrot
+RailsPgExtras.mandelbrot
 
 $ rake pg_extras:mandelbrot
 ```

data/app/controllers/rails_pg_extras/web/actions_controller.rb

@@ -0,0 +1,26 @@
+module RailsPgExtras::Web
+  class ActionsController < ApplicationController
+    def kill_all
+      run(:kill_all)
+    end
+
+    def pg_stat_statements_reset
+      run(:pg_stat_statements_reset)
+    end
+
+    def add_extensions
+      run(:add_extensions)
+    end
+
+    private
+
+    def run(action)
+      begin
+        RailsPgExtras.run_query(query_name: action, in_format: :raw)
+        redirect_to root_path, notice: "Successfully ran #{action}"
+      rescue ActiveRecord::StatementInvalid => e
+        redirect_to root_path, alert: "Error: #{e.message}"
+      end
+    end
+  end
+end

data/app/controllers/rails_pg_extras/web/application_controller.rb

@@ -0,0 +1,20 @@
+require "rails_pg_extras"
+require "rails_pg_extras/version"
+
+module RailsPgExtras::Web
+  class ApplicationController < ActionController::Base
+    layout "rails_pg_extras/web/application"
+
+    REQUIRED_EXTENSIONS = {
+      pg_stat_statements: %i[calls outliers pg_stat_statements_reset],
+      pg_buffercache: %i[buffercache_stats buffercache_usage],
+      sslinfo: %i[ssl_used]
+    }
+
+    ACTIONS = %i[kill_all pg_stat_statements_reset add_extensions]
+
+    if Rails.env.production? && ENV['RAILS_PG_EXTRAS_USER'].present? && ENV['RAILS_PG_EXTRAS_PASSWORD'].present?
+      http_basic_authenticate_with name: ENV['RAILS_PG_EXTRAS_USER'], password: ENV['RAILS_PG_EXTRAS_PASSWORD']
+    end
+  end
+end

data/app/controllers/rails_pg_extras/web/queries_controller.rb

@@ -0,0 +1,44 @@
+module RailsPgExtras::Web
+  class QueriesController < ApplicationController
+    before_action :load_queries
+    helper_method :unavailable_extensions
+
+    def index
+      if params[:query_name].present?
+        @query_name = params[:query_name].to_sym.presence_in(@all_queries.keys)
+        return unless @query_name
+
+        begin
+          @result = RailsPgExtras.run_query(query_name: @query_name.to_sym, in_format: :raw)
+        rescue ActiveRecord::StatementInvalid => e
+          @error = e.message
+        end
+
+        render :show
+      end
+    end
+
+    private
+
+    def load_queries
+      @all_queries = (RailsPgExtras::QUERIES - ACTIONS).inject({}) do |memo, query_name|
+        unless query_name.in? %i[mandelbrot]
+          memo[query_name] = { disabled: query_disabled?(query_name) }
+        end
+
+        memo
+      end
+    end
+
+    def query_disabled?(query_name)
+      unavailable_extensions.values.flatten.include?(query_name)
+    end
+
+    def unavailable_extensions
+      return @unavailable_extensions if defined?(@unavailable_extensions)
+
+      enabled_extensions = ActiveRecord::Base.connection.extensions
+      @unavailable_extensions = REQUIRED_EXTENSIONS.delete_if { |ext| ext.to_s.in?(enabled_extensions)  }
+    end
+  end
+end

data/app/views/layouts/rails_pg_extras/web/application.html.erb

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title><%= content_for :title %> |  v<%= RailsPgExtras::VERSION %></title>
+    <%= javascript_include_tag "https://unpkg.com/@rails/ujs" %>
+    <link href="https://unpkg.com/tailwindcss@^2/dist/tailwind.min.css" rel="stylesheet">
+    <%= csrf_meta_tags %>
+  </head>
+  <body class="p-5 text-xs">
+    <% if flash[:notice] %>
+      <div class="bg-green-100 border-l-4 border-green-500 text-green-700 p-4 mb-4" role="alert">
+        <p class="font-bold">Notice</p>
+        <p><%= flash[:notice] %></p>
+      </div>
+    <% end %>
+
+    <% if flash[:alert] %>
+      <div class="bg-red-100 border-l-4 border-red-500 text-red-700 p-4 mb-4" role="alert">
+        <p class="font-bold">Alert</p>
+        <p><%= flash[:alert] %></p>
+      </div>
+    <% end %>
+
+    <%= yield %>
+  </body>
+</html>

data/app/views/rails_pg_extras/web/queries/_diagnose.html.erb

@@ -0,0 +1,9 @@
+  <h1 class="font-bold text-xl my-5">Diagnose</h1>
+  <table class="w-full font-mono border-collapse border my-5">
+    <% RailsPgExtras.diagnose(in_format: :hash).each do |diagnosis| %>
+      <tr class="<%= diagnosis[:ok] ? 'bg-green-300' : 'bg-red-300' %>">
+        <td class='p-1 border font-bold'><%= diagnosis[:check_name] %></td>
+        <td class='p-1 border'><%= diagnosis[:message] %></td>
+      </tr>
+    <% end %>
+  </table>

data/app/views/rails_pg_extras/web/queries/_result.html.erb

@@ -0,0 +1,21 @@
+<h1 class="font-bold text-xl my-5"><%= title %></h1>
+
+<table class="w-full font-mono border-collapse border my-5">
+  <thead>
+    <tr class="bg-gray-300">
+      <% headers.each do |header| %>
+      <th class="p-2 border text-left"><%= header %></th>
+      <% end %>
+    </tr>
+  </thead>
+  <tbody>
+  <% rows.each.with_index do |row, i| %>
+    <tr class="hover:bg-gray-400 hover:text-white <%= i.even? ? "bg-gray-100" : "bg-gray-200" %>">
+    <% row.each do |column| %>
+      <td class="p-1 border"><%= column %></td>
+    <% end %>
+    </tr>
+  <% end %>
+  </tbody>
+</table>
+<span class="italic">run_at: <%= Time.now.utc %></span>

data/app/views/rails_pg_extras/web/queries/_unavailable_extensions_warning.html.erb

@@ -0,0 +1,13 @@
+<div class="text-red-500 p-3 font-mono my-5">
+  <% unavailable_extensions.each do |extension, queries| %>
+    WARNING: Queries <%= queries.map { |q| "<b><u>#{q}</u></b>" }.join(", ").html_safe %> require extension: <b><%= extension %></b>
+    <br>
+  <% end %>
+ </div>
+
+<%= link_to "Enable extensions", add_extensions_action_path,
+  method: "post",
+  data: {
+    confirm: "This command will enable following extensions: #{unavailable_extensions.keys.join(', ')}. Do you want to proceeed?"
+  }, class: 'border p-3 bg-green-500 text-white hover:bg-green-600 font-bold rounded' %>
+

data/app/views/rails_pg_extras/web/queries/index.html.erb

@@ -0,0 +1,21 @@
+<%= content_for :title, "pg_extras" %>
+<%= render "rails_pg_extras/web/shared/queries_selector" %>
+<%= render "unavailable_extensions_warning" if unavailable_extensions.any? %>
+<%= render "diagnose" %>
+
+<h1 class="font-bold text-xl my-5">Actions</h1>
+
+<%= link_to "kill_all",  kill_all_action_path,
+  method: "post",
+  data: {
+    confirm: "This commands kills all the currently active connections to the database. Do you want to proceed?"
+  }, 
+  class: 'border p-3 bg-red-500 text-white hover:bg-red-600 font-bold rounded'
+%>
+
+<%= link_to "pg_stat_statements_reset", pg_stat_statements_reset_action_path,
+  method: "post",
+  data: {
+    confirm: "This command discards all statistics gathered so far by pg_stat_statements. Do you want to proceed?"
+  }, class: 'border p-3 bg-blue-500 text-white hover:bg-blue-600 font-bold rounded'
+%>

data/app/views/rails_pg_extras/web/queries/show.html.erb

@@ -0,0 +1,24 @@
+<%= content_for :title, params[:query_name].presence || "pg_extras" %>
+<%= render "rails_pg_extras/web/shared/queries_selector" %>
+
+<% if @error %>
+  <div class="text-red-500 p-3 font-mono my-5"><%= @error %></div>
+<% else %>
+  <% if @result&.any? %>
+    <%= render "result",
+      title: RubyPgExtras.description_for(query_name: @query_name),
+      headers: @result[0].keys,
+      rows: @result.values
+    %>
+  <% else %>
+   <div class="font-mono p-3 bg-gray-100 mt-3">No results</div>
+  <% end %>
+<% end %>
+
+<style>
+@media print {
+  form {
+    display: none
+  }
+}
+</style>

data/app/views/rails_pg_extras/web/shared/_queries_selector.html.erb

@@ -0,0 +1,11 @@
+<%= form_with url: queries_path, id: "queries", method: :get do |f| %>
+  <%= f.select :query_name, options_for_select(@all_queries, params[:query_name]),
+    {prompt: "--- select query ---"},
+    {class: "border p-2 font-bold", autofocus: true}
+  %>
+<% end %>
+<script>
+  document.getElementById('queries').addEventListener('change', (e) => {
+    e.target.form.submit()
+  })
+</script>

data/config/routes.rb

@@ -0,0 +1,9 @@
+RailsPgExtras::Web::Engine.routes.draw do
+  resources :queries, only: [:index]
+
+  post "/actions/kill_all" => "actions#kill_all", as: :kill_all_action
+  post "/actions/pg_stat_statements_reset" => "actions#pg_stat_statements_reset", as: :pg_stat_statements_reset_action
+  post "/actions/add_extensions" => "actions#add_extensions", as: :add_extensions_action
+
+  root to: "queries#index"
+end

data/lib/rails_pg_extras/diagnose_data.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module RailsPgExtras
+  class DiagnoseData < ::RubyPgExtras::DiagnoseData
+
+    private
+
+    def query_module
+      RailsPgExtras
+    end
+  end
+end

data/lib/{rails-pg-extras → rails_pg_extras}/diagnose_print.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-module RailsPGExtras
-  class DiagnosePrint < RubyPGExtras::DiagnosePrint
+module RailsPgExtras
+  class DiagnosePrint < ::RubyPgExtras::DiagnosePrint
 
     private
 

data/lib/rails_pg_extras/index_info.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RailsPgExtras
+  class IndexInfo < RubyPgExtras::IndexInfo
+    private
+
+    def query_module
+      RailsPgExtras
+    end
+  end
+end

data/lib/rails_pg_extras/index_info_print.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module RailsPgExtras
+  class IndexInfoPrint < RubyPgExtras::IndexInfoPrint
+  end
+end

data/lib/rails_pg_extras/railtie.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class RailsPgExtras::Railtie < Rails::Railtie
+  rake_tasks do
+    load 'rails_pg_extras/tasks/all.rake'
+  end
+end

data/lib/rails_pg_extras/table_info.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RailsPgExtras
+  class TableInfo < RubyPgExtras::TableInfo
+    private
+
+    def query_module
+      RailsPgExtras
+    end
+  end
+end

data/lib/rails_pg_extras/table_info_print.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module RailsPgExtras
+  class TableInfoPrint < RubyPgExtras::TableInfoPrint
+  end
+end

data/lib/{rails-pg-extras → rails_pg_extras}/tasks/all.rake

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'rails-pg-extras'
+require 'rails_pg_extras'
 
 namespace :pg_extras do
   task :establish_connection do
@@ -13,25 +13,25 @@ namespace :pg_extras do
     end
   end
 
-  RailsPGExtras::QUERIES.each do |query_name|
-    desc RubyPGExtras.description_for(query_name: query_name)
+  RailsPgExtras::QUERIES.each do |query_name|
+    desc RubyPgExtras.description_for(query_name: query_name)
     task query_name.to_sym => :establish_connection do
-      RailsPGExtras.public_send(query_name)
+      RailsPgExtras.public_send(query_name)
     end
   end
 
   desc "Generate a PostgreSQL healthcheck report"
   task diagnose: :establish_connection do
-    RailsPGExtras.diagnose
+    RailsPgExtras.diagnose
   end
 
   desc "Display tables metadata metrics"
   task table_info: :establish_connection do
-    RailsPGExtras.table_info
+    RailsPgExtras.table_info
   end
 
   desc "Display indexes metadata metrics"
   task index_info: :establish_connection do
-    RailsPGExtras.index_info
+    RailsPgExtras.index_info
   end
 end

data/lib/rails_pg_extras/version.rb

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

data/lib/rails_pg_extras/web/engine.rb

@@ -0,0 +1,7 @@
+require 'rails'
+
+module RailsPgExtras::Web
+  class Engine < ::Rails::Engine
+    isolate_namespace RailsPgExtras::Web
+  end
+end

data/lib/rails_pg_extras/web.rb

@@ -0,0 +1,6 @@
+require "rails_pg_extras/web/engine"
+
+module RailsPgExtras
+  module Web
+  end
+end

data/lib/{rails-pg-extras.rb → rails_pg_extras.rb}

@@ -1,18 +1,19 @@
 # frozen_string_literal: true
 
 require 'terminal-table'
-require 'ruby-pg-extras'
-require 'rails-pg-extras/diagnose_data'
-require 'rails-pg-extras/diagnose_print'
-require 'rails-pg-extras/index_info'
-require 'rails-pg-extras/index_info_print'
-require 'rails-pg-extras/table_info'
-require 'rails-pg-extras/table_info_print'
+require 'ruby_pg_extras'
+require 'rails_pg_extras/diagnose_data'
+require 'rails_pg_extras/diagnose_print'
+require 'rails_pg_extras/index_info'
+require 'rails_pg_extras/index_info_print'
+require 'rails_pg_extras/table_info'
+require 'rails_pg_extras/table_info_print'
+require 'rails_pg_extras/web'
 
-module RailsPGExtras
-  QUERIES = RubyPGExtras::QUERIES
-  DEFAULT_ARGS = RubyPGExtras::DEFAULT_ARGS
-  NEW_PG_STAT_STATEMENTS = RubyPGExtras::NEW_PG_STAT_STATEMENTS
+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 = {}|
@@ -26,7 +27,7 @@ module RailsPGExtras
 
   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'")
+      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)
@@ -36,25 +37,25 @@ module RailsPGExtras
     end
 
     sql = if (custom_args = DEFAULT_ARGS[query_name].merge(args)) != {}
-      RubyPGExtras.sql_for(query_name: query_name) % custom_args
+      RubyPgExtras.sql_for(query_name: query_name) % custom_args
     else
-      RubyPGExtras.sql_for(query_name: query_name)
+      RubyPgExtras.sql_for(query_name: query_name)
     end
 
     result = connection.execute(sql)
 
-    RubyPGExtras.display_result(
+    RubyPgExtras.display_result(
       result,
-      title: RubyPGExtras.description_for(query_name: query_name),
+      title: RubyPgExtras.description_for(query_name: query_name),
       in_format: in_format
     )
   end
 
   def self.diagnose(in_format: :display_table)
-    data = RailsPGExtras::DiagnoseData.call
+    data = RailsPgExtras::DiagnoseData.call
 
     if in_format == :display_table
-      RailsPGExtras::DiagnosePrint.call(data)
+      RailsPgExtras::DiagnosePrint.call(data)
     elsif in_format == :hash
       data
     else
@@ -63,10 +64,10 @@ module RailsPGExtras
   end
 
   def self.index_info(args: {}, in_format: :display_table)
-    data = RailsPGExtras::IndexInfo.call(args[:table_name])
+    data = RailsPgExtras::IndexInfo.call(args[:table_name])
 
     if in_format == :display_table
-      RailsPGExtras::IndexInfoPrint.call(data)
+      RailsPgExtras::IndexInfoPrint.call(data)
     elsif in_format == :hash
       data
     elsif in_format == :array
@@ -77,10 +78,10 @@ module RailsPGExtras
   end
 
   def self.table_info(args: {}, in_format: :display_table)
-    data = RailsPGExtras::TableInfo.call(args[:table_name])
+    data = RailsPgExtras::TableInfo.call(args[:table_name])
 
     if in_format == :display_table
-      RailsPGExtras::TableInfoPrint.call(data)
+      RailsPgExtras::TableInfoPrint.call(data)
     elsif in_format == :hash
       data
     elsif in_format == :array
@@ -95,4 +96,4 @@ module RailsPGExtras
   end
 end
 
-require 'rails-pg-extras/railtie' if defined?(Rails)
+require 'rails_pg_extras/railtie' if defined?(Rails)

data/rails-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 'rails-pg-extras/version'
+require 'rails_pg_extras/version'
 
 Gem::Specification.new do |s|
   s.name          = "rails-pg-extras"
-  s.version       = RailsPGExtras::VERSION
+  s.version       = RailsPgExtras::VERSION
   s.authors       = ["pawurb"]
   s.email         = ["contact@pawelurbanek.com"]
   s.summary       = %q{ Rails PostgreSQL performance database insights }
@@ -15,8 +15,8 @@ Gem::Specification.new do |s|
   s.test_files    = s.files.grep(%r{^(spec)/})
   s.require_paths = ["lib"]
   s.license       = "MIT"
-  s.add_dependency "ruby-pg-extras", RailsPGExtras::VERSION
-  s.add_dependency "activerecord"
+  s.add_dependency "ruby-pg-extras", RailsPgExtras::VERSION
+  s.add_dependency "rails"
   s.add_development_dependency "rake"
   s.add_development_dependency "rspec"
 

data/spec/smoke_spec.rb

@@ -1,12 +1,13 @@
 # frozen_string_literal: true
 
 require 'spec_helper'
+require 'rails_pg_extras'
 
-describe RailsPGExtras do
-  RailsPGExtras::QUERIES.each do |query_name|
+describe RailsPgExtras do
+  RailsPgExtras::QUERIES.each do |query_name|
     it "#{query_name} query can be executed" do
       expect do
-        RailsPGExtras.run_query(
+        RailsPgExtras.run_query(
           query_name: query_name,
           in_format: :hash
         )
@@ -16,15 +17,15 @@ describe RailsPGExtras do
 
   it "runs the custom methods" do
     expect do
-      RailsPGExtras.diagnose(in_format: :hash)
+      RailsPgExtras.diagnose(in_format: :hash)
     end.not_to raise_error
 
     expect do
-      RailsPGExtras.index_info(in_format: :hash)
+      RailsPgExtras.index_info(in_format: :hash)
     end.not_to raise_error
 
     expect do
-      RailsPGExtras.table_info(in_format: :hash)
+      RailsPgExtras.table_info(in_format: :hash)
     end.not_to raise_error
   end
 end

data/spec/spec_helper.rb

@@ -3,7 +3,7 @@
 require 'rubygems'
 require 'bundler/setup'
 require 'active_record'
-require_relative '../lib/rails-pg-extras'
+require_relative '../lib/rails_pg_extras'
 
 pg_version = ENV["PG_VERSION"]
 
@@ -24,9 +24,9 @@ RSpec.configure do |config|
     ActiveRecord::Base.establish_connection(
       ENV.fetch("DATABASE_URL")
     )
-    RailsPGExtras.connection.execute("CREATE EXTENSION IF NOT EXISTS pg_stat_statements;")
-    RailsPGExtras.connection.execute("CREATE EXTENSION IF NOT EXISTS pg_buffercache;")
-    RailsPGExtras.connection.execute("CREATE EXTENSION IF NOT EXISTS sslinfo;")
+    RailsPgExtras.connection.execute("CREATE EXTENSION IF NOT EXISTS pg_stat_statements;")
+    RailsPgExtras.connection.execute("CREATE EXTENSION IF NOT EXISTS pg_buffercache;")
+    RailsPgExtras.connection.execute("CREATE EXTENSION IF NOT EXISTS sslinfo;")
   end
 
   config.after :suite do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-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: ruby-pg-extras
@@ -16,16 +16,16 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.3.0
+        version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.3.0
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,17 +81,30 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- app/controllers/rails_pg_extras/web/actions_controller.rb
+- app/controllers/rails_pg_extras/web/application_controller.rb
+- app/controllers/rails_pg_extras/web/queries_controller.rb
+- app/views/layouts/rails_pg_extras/web/application.html.erb
+- app/views/rails_pg_extras/web/queries/_diagnose.html.erb
+- app/views/rails_pg_extras/web/queries/_result.html.erb
+- app/views/rails_pg_extras/web/queries/_unavailable_extensions_warning.html.erb
+- app/views/rails_pg_extras/web/queries/index.html.erb
+- app/views/rails_pg_extras/web/queries/show.html.erb
+- app/views/rails_pg_extras/web/shared/_queries_selector.html.erb
+- config/routes.rb
 - docker-compose.yml.sample
-- lib/rails-pg-extras.rb
-- lib/rails-pg-extras/diagnose_data.rb
-- lib/rails-pg-extras/diagnose_print.rb
-- lib/rails-pg-extras/index_info.rb
-- lib/rails-pg-extras/index_info_print.rb
-- lib/rails-pg-extras/railtie.rb
-- lib/rails-pg-extras/table_info.rb
-- lib/rails-pg-extras/table_info_print.rb
-- lib/rails-pg-extras/tasks/all.rake
-- lib/rails-pg-extras/version.rb
+- lib/rails_pg_extras.rb
+- lib/rails_pg_extras/diagnose_data.rb
+- lib/rails_pg_extras/diagnose_print.rb
+- lib/rails_pg_extras/index_info.rb
+- lib/rails_pg_extras/index_info_print.rb
+- lib/rails_pg_extras/railtie.rb
+- lib/rails_pg_extras/table_info.rb
+- lib/rails_pg_extras/table_info_print.rb
+- lib/rails_pg_extras/tasks/all.rake
+- lib/rails_pg_extras/version.rb
+- lib/rails_pg_extras/web.rb
+- lib/rails_pg_extras/web/engine.rb
 - rails-pg-extras-diagnose.png
 - rails-pg-extras-web.png
 - rails-pg-extras.gemspec

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

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-module RailsPGExtras
-  class DiagnoseData < RubyPGExtras::DiagnoseData
-
-    private
-
-    def query_module
-      RailsPGExtras
-    end
-  end
-end

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

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-module RailsPGExtras
-  class IndexInfo < RubyPGExtras::IndexInfo
-    private
-
-    def query_module
-      RailsPGExtras
-    end
-  end
-end

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

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-module RailsPGExtras
-  class IndexInfoPrint < RubyPGExtras::IndexInfoPrint
-  end
-end

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

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-class RailsPGExtras::Railtie < Rails::Railtie
-  rake_tasks do
-    load 'rails-pg-extras/tasks/all.rake'
-  end
-end

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

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-module RailsPGExtras
-  class TableInfo < RubyPGExtras::TableInfo
-    private
-
-    def query_module
-      RailsPGExtras
-    end
-  end
-end

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

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-module RailsPGExtras
-  class TableInfoPrint < RubyPGExtras::TableInfoPrint
-  end
-end

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

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