rails-pg-extras 4.0.0 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a182232adb71ba714ab127505aa21e410291536a6f6992fed863e6beba4d11d6
-  data.tar.gz: c219ee40b92eed9f873dc7a6fbe8e0cd80dd13e70cdd7048827b639d9dbd2f6f
+  metadata.gz: a246db60fafffa7ad4ea212b8357332d4172a58963c7f919a27ecbe75bf8e1ec
+  data.tar.gz: c2c5eab77af273048b3cd55a20ea675e78a78d19c6192eefdb87018278756660
 SHA512:
-  metadata.gz: 82e1cd92bf47fb1588d49bb59fbf10ad5cd24c5878b5fec4025db301707936e6196f8af2ed27d384a5259349be5a6dbfdfc678b1e08ad029a37cc0de178d96ba
-  data.tar.gz: 2d7189e0a3953323e5872ad817f015d3f023c90832fe9cf76d42485956f2868089bc9ae00532c377d54dc7f1f764832093cf19778d0f3be02f053eb9d19b9ad1
+  metadata.gz: b3a8c40da52f09d8f2a8f77f05561e39d069b43a86986029e907bec04933868e64211554a7d342156a902a31357119cef76ec6e33bb2d5c71d4847a6a7be0d56
+  data.tar.gz: e660e4dad9b7a0b95f796e648521210d302edc16aff16e582f1c548cb408b7ab4a17ef00e4c016ae4fcfbfeae3e7c0a1bd261793af43c4383bb09abdcc71b361

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:
 
@@ -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 < ApplicationController
+  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

@@ -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/controllers/rails_pg_extras/web/queries_controller.rb

@@ -1,5 +1,5 @@
 module RailsPgExtras::Web
-  class QueriesController < ApplicationController
+  class QueriesController < RailsPgExtras::Web::ApplicationController
     before_action :load_queries
     helper_method :unavailable_extensions
 

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/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

@@ -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.0"
+  VERSION = "4.2.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/lib/rails_pg_extras.rb

@@ -2,6 +2,7 @@
 
 require 'terminal-table'
 require 'ruby_pg_extras'
+require 'rails_pg_extras/configuration'
 require 'rails_pg_extras/diagnose_data'
 require 'rails_pg_extras/diagnose_print'
 require 'rails_pg_extras/index_info'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-pg-extras
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.2.0
 platform: ruby
 authors:
 - pawurb
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-09 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.0
+        version: 4.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 4.2.0
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +94,7 @@ files:
 - config/routes.rb
 - docker-compose.yml.sample
 - 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