rails-pg-extras 4.0.1 → 4.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 111d02ff1b373270351607d9adde9475dfde67e687583eb76ce8b51664e330f0
-  data.tar.gz: bd0a8c6dab34c2200ca97325487076dc1f6945f347b1b545db5f268990ab5e5a
+  metadata.gz: 0a0259a817155746ae3dda5a13fd1e6c8e0421dad029dd2c6100222379dad76f
+  data.tar.gz: 5ffdc7d923d458bab991439a65adf91ff3e752e8e90280c6e3faae57d36762a7
 SHA512:
-  metadata.gz: 115828ab093b55f55a688d6414750f5e0ef62caaed85a731b5dd2d19e88c142d910a6fa316073a0df825571c04a440b8a9a168d9a1ded6a3b9ae3e254571210f
-  data.tar.gz: 8b119ef84bf4e01a1b4b2cc51eba7cf63cdcb6cc8d9254aacd5a39813d18337e32f6b0b56b0f595afb847b33a90e2e9996a631a7094f3b5b75a13acc5bf2fd19
+  metadata.gz: a6a55fcb7e8cc126859f1f45f4ba38f9562f1bded1e4aa6287e3728926cc3eb598552d4cdcc311104e811b513f20a71f52d29964dd6f0137df68a2699e9ef7ab
+  data.tar.gz: 305dc8c57cace4845795b051afca373103765181a1121203d9963261a0be18b50d6335355a60988be745d16d19ecd9f30ac506f4cff15c5265c38cdca039316a

data/README.md

@@ -10,7 +10,7 @@ You can read this blog post for detailed step by step tutorial on how to [optimi
 
 Optionally you can enable a visual interface:
 
-![Web interface](https://github.com/pawurb/rails-pg-extras/raw/master/rails-pg-extras-web.png)
+![Web interface](https://github.com/pawurb/rails-pg-extras/raw/master/pg-extras-ui.png)
 
 Alternative versions:
 
@@ -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.
@@ -119,7 +119,18 @@ You can enable UI using a Rails engine by adding the following code in `config/r
   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.
+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
 

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
@@ -13,7 +13,7 @@ module RailsPgExtras::Web
 
     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?
+    if 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

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.0.1"
+  VERSION = "4.4.0"
 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.0.1
+  version: 4.4.0
 platform: ruby
 authors:
 - pawurb
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-10 00:00:00.000000000 Z
+date: 2022-03-12 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.0.1
+        version: 4.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.0.1
+        version: 4.4.0
 - !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
@@ -105,8 +106,8 @@ files:
 - lib/rails_pg_extras/version.rb
 - lib/rails_pg_extras/web.rb
 - lib/rails_pg_extras/web/engine.rb
+- pg-extras-ui.png
 - rails-pg-extras-diagnose.png
-- rails-pg-extras-web.png
 - rails-pg-extras.gemspec
 - spec/smoke_spec.rb
 - spec/spec_helper.rb