rails-pg-extras-web 3.2.3 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5769767f9eb5b29c53a699d4763b2b4856108519115f35fa335045b8fe5cee7
-  data.tar.gz: 9c6d01369b03ff51fed482c81b47592d6d7d9e15a56c3f72ec439d106a5e679d
+  metadata.gz: 6bf29ec509433273d9fb2941cbb700e8b863ed5e1b4357066b8cf082070a1c4b
+  data.tar.gz: 3920070598fced77e2c0917ef9469741229b65a251e2b96664cbd490db34a4dd
 SHA512:
-  metadata.gz: 72bf45a137abf870cd3364d76a569d4702a6f5522670d8a1a1d5130c27ee9ea4d3aca4f738e761d0a12490e9d4d4697f9070369fe8ccfe5315cb8395923f1517
-  data.tar.gz: '000914f94a2e2daa9eac47e97ec71c8ea7fa2ec007bf2a73510572d4992c04b67651caa9c9a65d63f2324a12964771776e1fec69611131093535d2bdbf2adc0f'
+  metadata.gz: be18f1163abd8ac9309d9a454a12b7447abc980a9c198799a719bdcccdb3277849bd981cd4d0c0b73ca385f44f249a2e58185d39dd37162c106ba1ce312aab44
+  data.tar.gz: b2aa9a982e6f7db441985de42d60e5d86ad88d47c1e739b47c7187ea3ac19891c8fa1dc1e1770387483f2b606bdc009697a90bae9101d414d6edb0972a02cbe4

data/README.md

@@ -1,7 +1,11 @@
+# Important!
+RailsPgExtrasWeb is merged with [rails-pg-extras](https://github.com/pawurb/rails-pg-extras) since version **4.0.0**. Please used this gem instead.
+
+
 # RailsPgExtrasWeb
 Web UI for [rails-pg-extras](https://github.com/pawurb/rails-pg-extras)
 
-![WebUI](https://raw.githubusercontent.com/pawurb/rails-pg-extras/master/rails-pg-extras-web.png)
+![WebUI](https://github.com/pawurb/rails-pg-extras/raw/master/pg-extras-ui.png)
 
 ## Installation
 Add this line to your application's Gemfile:

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

@@ -1,5 +1,2 @@
-require "rails_pg_extras_web/engine"
-
-module RailsPgExtrasWeb
-  # Your code goes here...
-end
+require "rails_pg_extras_web/version"
+require "rails-pg-extras"

data/lib/rails_pg_extras_web/version.rb

@@ -1,3 +1,3 @@
 module RailsPgExtrasWeb
-  VERSION = '3.2.3'
+  VERSION = '4.0.0'
 end

metadata

@@ -1,44 +1,30 @@
 --- !ruby/object:Gem::Specification
 name: rails-pg-extras-web
 version: !ruby/object:Gem::Version
-  version: 3.2.3
+  version: 4.0.0
 platform: ruby
 authors:
 - Tomasz Mazur
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-18 00:00:00.000000000 Z
+date: 2022-03-18 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: pg
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: rails-pg-extras
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
-description:
+        version: 4.0.0
+description: 
 email:
 - tomasz.mazur@hey.com
 executables: []
@@ -48,25 +34,15 @@ files:
 - MIT-LICENSE
 - 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
 - lib/rails-pg-extras-web.rb
-- lib/rails_pg_extras_web/engine.rb
 - lib/rails_pg_extras_web/version.rb
 homepage: https://github.com/defkode/rails-pg-extras-web
 licenses:
 - MIT
-metadata: {}
-post_install_message:
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message: rails-pg-extras-web is deprecated. Please use rails-pg-extras
+  instead (>= 4.0.0)
 rdoc_options: []
 require_paths:
 - lib
@@ -81,8 +57,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
-signing_key:
+rubygems_version: 3.1.6
+signing_key: 
 specification_version: 4
 summary: Web UI for rails-pg-extras
 test_files: []

data/app/controllers/rails_pg_extras_web/actions_controller.rb

@@ -1,26 +0,0 @@
-module RailsPgExtrasWeb
-  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

@@ -1,20 +0,0 @@
-require "rails-pg-extras"
-require "rails-pg-extras/version"
-
-module RailsPgExtrasWeb
-  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['PG_EXTRAS_USER'].present? && ENV['PG_EXTRAS_PASSWORD'].present?
-      http_basic_authenticate_with name: ENV['PG_EXTRAS_USER'], password: ENV['PG_EXTRAS_PASSWORD']
-    end
-  end
-end

data/app/controllers/rails_pg_extras_web/queries_controller.rb

@@ -1,44 +0,0 @@
-module RailsPgExtrasWeb
-  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

@@ -1,26 +0,0 @@
-<!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

@@ -1,9 +0,0 @@
-  <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

@@ -1,21 +0,0 @@
-<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

@@ -1,13 +0,0 @@
-<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

@@ -1,21 +0,0 @@
-<%= 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

@@ -1,24 +0,0 @@
-<%= 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

@@ -1,11 +0,0 @@
-<%= 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

@@ -1,9 +0,0 @@
-RailsPgExtrasWeb::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_web/engine.rb

@@ -1,5 +0,0 @@
-module RailsPgExtrasWeb
-  class Engine < ::Rails::Engine
-    isolate_namespace RailsPgExtrasWeb
-  end
-end