rails-pg-extras-web 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c38b308833f95b44ec69458f762fdff8ddd7ae5414b628ca0619c4d6b8c17871
+  data.tar.gz: '0607678d4a6fae56d1af5024cf7bc40d4b40cad3258e97a2b87b2c7f546c79bc'
+SHA512:
+  metadata.gz: caa689489549961d3563b840444d617caed45821a9ea952215b97ddec72b00150cf15c7b6ebc3fcda038a629aa4c593d23917ed1765d09fd38b372c1635dc28e
+  data.tar.gz: c4813eeed8770cf98d518ed5690b564f1b24615f3c992286cc2fc0cde452a35bf42ba1cf950a2d7b8d8ebe796ea25551ceaac3616c79e3a3091fb94dc37c23c5

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 defkode
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,33 @@
+# RailsPgExtrasWeb
+Web UI for rails-pg-extras-web
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails-pg-extras-web', github: 'defkode/rails-pg-extras-web'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Update config/routes.rb
+
+```ruby
+mount RailsPgExtrasWeb::Engine, at: 'pg_extras'
+```
+
+Authorization in production enviroment via HTTP Basic. Please set PG_EXTRAS_USER, PG_EXTRAS_PASSWORD environment variables.
+
+Heroku example
+
+```bash
+heroku config:set PG_EXTRAS_USER=admin PG_EXTRAS_PASSWORD=secret
+```
+
+
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'RailsPgExtrasWeb'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/controllers/rails_pg_extras_web/application_controller.rb

@@ -0,0 +1,36 @@
+require "rails-pg-extras"
+
+module RailsPgExtrasWeb
+  class ApplicationController < ActionController::Base
+    layout "rails_pg_extras_web/application"
+
+    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_PASS']
+    end
+
+    protect_from_forgery with: :exception
+
+    helper_method :pg_stats_statements_enabled?
+
+    private
+
+    def load_queries
+      @all_queries = {}
+
+      ::RailsPGExtras::QUERIES.each do |query_name|
+        @all_queries[query_name] = {
+          disabled: query_disabled?(query_name),
+          command:  query_name == :kill_all
+        }
+      end
+    end
+
+    def query_disabled?(query_name)
+      query_name.in?([:calls, :outliers]) && !pg_stats_statements_enabled?
+    end
+
+    def pg_stats_statements_enabled?
+      ActiveRecord::Base.connection.extensions.include?("pg_stat_statements")
+    end
+  end
+end

data/app/controllers/rails_pg_extras_web/queries_controller.rb

@@ -0,0 +1,19 @@
+module RailsPgExtrasWeb
+  class QueriesController < ApplicationController
+    before_action :load_queries
+
+    def index; end
+
+    def run
+      if @query_name = params[:query_name].presence
+        begin
+          @result = ActiveRecord::Base.connection.execute RubyPGExtras.sql_for(query_name: @query_name)
+        rescue ActiveRecord::StatementInvalid => e
+          @error = e.message
+        end
+      else
+        redirect_to root_path
+      end
+    end
+  end
+end

data/app/views/layouts/rails_pg_extras_web/application.html.erb

@@ -0,0 +1,21 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>PG::Extras</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+</head>
+<body onload="document.forms.queries.query_name.focus()">
+  <%= form_with url: run_query_url, id: "queries" do |f| %>
+    <%= f.select :query_name, options_for_select(@all_queries.except(:kill_all, :mandelbrot), params[:query_name]),
+      prompt: "--- select query ---"
+    %>
+
+    <button type="submit">Run</button>
+  <% end %>
+
+  <div style='margin-top: 20px'>
+    <%= yield %>
+  </div>
+</body>
+</html>

data/app/views/rails_pg_extras_web/queries/index.html.erb

@@ -0,0 +1,10 @@
+<% unless pg_stats_statements_enabled? %>
+  <span style='color: red'>
+    WARNING: <b><u>outliers</u></b>, <b><u>calls</u></b> require extension: <b>pg_stat_statements</b>
+  </span>
+
+  <h4>Rails</h4>
+  <pre style='background-color: #e2e2e2; padding: 10px'>ActiveRecord::Base.connection.enable_extension "pg_stat_statements"</pre>
+  <h4>SQL</h4>
+  <pre style='background-color: #e2e2e2; padding: 10px'>CREATE EXTENSION pg_stat_statements</pre>
+<% end %>

data/app/views/rails_pg_extras_web/queries/run.html.erb

@@ -0,0 +1,59 @@
+<% if @error %>
+  <span style='color: red'><%= @error %></span>
+<% else %>
+  <% if @result && @result.any? %>
+    <table>
+      <caption><%= RubyPGExtras.description_for(query_name: @query_name) %></caption>
+      <thead>
+        <tr>
+          <% @result[0].keys.each do |header| %>
+            <th><%= header %></th>
+          <% end %>
+        </tr>
+      </thead>
+      <tbody>
+        <% @result.values.each do |row| %>
+          <tr>
+            <% row.each do |column| %>
+              <td><%= column %></td>
+            <% end %>
+          </tr>
+        <% end %>
+      </tbody>
+    </table>
+
+    <pre>run_at: <%= Time.now.utc %></pre>
+  <% else %>
+   <pre>No results</pre>
+  <% end %>
+<% end %>
+
+<style media="screen">
+  table {
+    font-family: monospace;
+    border-collapse: collapse;
+    width: 100%;
+  }
+
+  table th {
+    background-color: #c9c9;
+  }
+
+  table th, table td {
+    text-align: left;
+    border: 1px solid #c9c9;
+    padding: 3px;
+  }
+
+  table td {
+    overflow: hidden;
+    text-overflow: ellipsis;
+    white-space: nowrap;
+  }
+
+  table caption {
+    padding: 5px;
+    font-size: 15px;
+    font-weight: bold;
+  }
+</style>

data/config/routes.rb

@@ -0,0 +1,5 @@
+RailsPgExtrasWeb::Engine.routes.draw do
+  root to: "queries#index"
+
+  post "/queries/run", as: :run_query
+end

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

@@ -0,0 +1,5 @@
+require "rails_pg_extras_web/engine"
+
+module RailsPgExtrasWeb
+  # Your code goes here...
+end

data/lib/rails_pg_extras_web/engine.rb

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

data/lib/rails_pg_extras_web/version.rb

@@ -0,0 +1,3 @@
+module RailsPgExtrasWeb
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: rails-pg-extras-web
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tomasz Mazur
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-01-10 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: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: 
+email:
+- tomasz.mazur@hey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- 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/index.html.erb
+- app/views/rails_pg_extras_web/queries/run.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: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Web UI for rails-pg-extras
+test_files: []