rails-pg-extras 4.1.0 → 4.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6ae59243330e4542bce1091be0c9569e358136526ea8e3905f51926bc7e301a
-  data.tar.gz: 3981ba3942d85a69bc808665df427fa4401754861707bc93176adc1ad03b49cf
+  metadata.gz: b60a814cc2ebe5c32cb7ad76cec4d2a0a69c3adb2808c96ec7bc32d257af04b2
+  data.tar.gz: 52d5e8786eb51f79b757b378110f0aa40bff85940222131ee689efa19429d927
 SHA512:
-  metadata.gz: bffcc20a98ee3e0b7e127ef96f268500cf49fd3e30a009cf1d1ffbe88246524763f8b4c76df389969febf4d78d5b3c6bc51edacd18a2d5581b4ea86e314aa6a9
-  data.tar.gz: 100bef0be5f9a22e90c81a37f75288e8833e9e7dccfccbaf88d0b0bb6870f49d083e5322e4705ae4961a2b8d085496e85a7e5253c2d57396c229194591cf62d7
+  metadata.gz: 9dd97240083d2b648f08d4b74dee3575cc58166ae3730044d24360c05d6537e14df2777c20a10253696012c2554502748467d68b61d4f62701d95b95452f5cd5
+  data.tar.gz: f2dc275df8cd32227f7b3c4b8d2d0f4b39fe3e4d86130a5d04197eeb579c057a8e7672a49dd3b62b7a0dc4ce43cc2c369b95dd1fb4522bfed3ae8d81823a9d18

data/README.md

@@ -29,7 +29,7 @@ Alternative versions:
 In your Gemfile
 
 ```ruby
-gem "rails-pg-extras", require: "rails_pg_extras"
+gem "rails-pg-extras"
 ```
 
 `calls` and `outliers` queries require [pg_stat_statements](https://www.postgresql.org/docs/current/pgstatstatements.html) extension.
@@ -121,6 +121,17 @@ You can enable UI using a Rails engine by adding the following code in `config/r
 
 You can enable HTTP basic auth by specifying `RAILS_PG_EXTRAS_USER` and `RAILS_PG_EXTRAS_PASSWORD` variables.
 
+You can configure available web actions in `config/initializers/rails_pg_extras.rb`:
+
+```ruby
+RailsPgExtras.configure do |config|
+  # Rails-pg-extras does not enable all the web actions by default. You can check all available actions via `RailsPgExtras::Web::ACTIONS`.
+  # For example, you may want to enable the dangerous `kill_all` action.
+
+  config.enabled_web_actions = %i[kill_all pg_stat_statements_reset enable_extensions]
+end
+```
+
 ## Available methods
 
 ### `table_info`

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

@@ -1,5 +1,7 @@
 module RailsPgExtras::Web
   class ActionsController < RailsPgExtras::Web::ApplicationController
+    before_action :validate_action!
+
     def kill_all
       run(:kill_all)
     end
@@ -14,6 +16,12 @@ module RailsPgExtras::Web
 
     private
 
+    def validate_action!
+      unless RailsPgExtras::Web.action_enabled?(action_name)
+        render plain: "Action '#{action_name}' is not enabled!", status: :forbidden
+      end
+    end
+
     def run(action)
       begin
         RailsPgExtras.run_query(query_name: action, in_format: :raw)

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

@@ -1,4 +1,4 @@
-require "rails_pg_extras"
+require "rails-pg-extras"
 require "rails_pg_extras/version"
 
 module RailsPgExtras::Web

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

@@ -5,9 +5,11 @@
   <% 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' %>
+<% if RailsPgExtras::Web.action_enabled?(:enable_extensions) %>
+  <%= 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' %>
+<% end %>
 

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

@@ -5,17 +5,21 @@
 
 <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'
-%>
+<% if RailsPgExtras::Web.action_enabled?(:kill_all) %>
+  <%= 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'
+  %>
+<% end %>
 
-<%= 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'
-%>
+<% if RailsPgExtras::Web.action_enabled?(:pg_stat_statements_reset) %>
+  <%= 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'
+  %>
+<% end %>

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

@@ -1,14 +1,13 @@
 # frozen_string_literal: true
 
 require 'terminal-table'
-require 'ruby_pg_extras'
+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
@@ -96,4 +95,6 @@ module RailsPgExtras
   end
 end
 
+require 'rails_pg_extras/web'
+require 'rails_pg_extras/configuration'
 require 'rails_pg_extras/railtie' if defined?(Rails)

data/lib/rails_pg_extras/configuration.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "rails_pg_extras/web"
+
+module RailsPgExtras
+  class Configuration
+    DEFAULT_CONFIG = { enabled_web_actions: Web::ACTIONS - [:kill_all] }
+
+    attr_reader :enabled_web_actions
+
+    def initialize(attrs)
+      self.enabled_web_actions = attrs[:enabled_web_actions]
+    end
+
+    def enabled_web_actions=(*actions)
+      @enabled_web_actions = actions.flatten.map(&:to_sym)
+    end
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new(Configuration::DEFAULT_CONFIG)
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

data/lib/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
@@ -8,7 +8,7 @@ namespace :pg_extras do
       ActiveRecord::Base.establish_connection(ENV['DATABASE_URL'])
     else
       db_config_file = File.read('config/database.yml')
-      db_config = YAML::load(ERB.new(db_config_file).result)
+      db_config = YAML::load(ERB.new(db_config_file).result, aliases: true)
       ActiveRecord::Base.establish_connection(db_config[Rails.env])
     end
   end

data/lib/rails_pg_extras/version.rb

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

data/lib/rails_pg_extras/web/engine.rb

@@ -3,5 +3,7 @@ require 'rails'
 module RailsPgExtras::Web
   class Engine < ::Rails::Engine
     isolate_namespace RailsPgExtras::Web
+
+    config.middleware.use ActionDispatch::Flash
   end
 end

data/lib/rails_pg_extras/web.rb

@@ -2,5 +2,10 @@ require "rails_pg_extras/web/engine"
 
 module RailsPgExtras
   module Web
+    ACTIONS = %i[kill_all pg_stat_statements_reset enable_extensions].freeze
+
+    def self.action_enabled?(action_name)
+      RailsPgExtras.configuration.enabled_web_actions.include?(action_name.to_sym)
+    end
   end
 end

data/spec/smoke_spec.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'spec_helper'
-require 'rails_pg_extras'
+require 'rails-pg-extras'
 
 describe RailsPgExtras do
   RailsPgExtras::QUERIES.each do |query_name|

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"]
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-pg-extras
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 4.4.1
 platform: ruby
 authors:
 - pawurb
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-12 00:00:00.000000000 Z
+date: 2022-03-16 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: 4.1.0
+        version: 4.4.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: 4.4.1
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -93,7 +93,8 @@ files:
 - 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.rb
+- lib/rails_pg_extras/configuration.rb
 - lib/rails_pg_extras/diagnose_data.rb
 - lib/rails_pg_extras/diagnose_print.rb
 - lib/rails_pg_extras/index_info.rb