rails-pg-extras 4.7.1 → 4.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72b8f131bed595bb673bf156b928606550291257e8aae9109fc6de77d1896fb6
-  data.tar.gz: 3d44cef92f9ca6fe8e656ee3b0aeeb47209c866f95668d5f6c06c0a22bacd8e3
+  metadata.gz: cefaae16c6d92e4b1bd9af3d7b1dea9d1d0eb0a25079abb0d84e231ecb66ff31
+  data.tar.gz: fae04146f9c957bbd1eb530712aed98ad9fbcc82dd6c9103b740cda5f8598c11
 SHA512:
-  metadata.gz: 46372ddaab387dfe89baaa342868fc7fff062235ada8baa9f6fc16e6f88edae5fb45140f370dae3f12ee39d70546a156e70c064405a7ef3db532557255592def
-  data.tar.gz: db200cafb3c1eec8749aaf4b73b48312f0072a0dbc043f7f200839f0b69ab0a1b9093338ce14b762df6f549a3d6cb5af866e03fcbb7994956599e7df506d4826
+  metadata.gz: 2485ffb0a15f39c3459f97a778ec13a407e3b5c5a7a9b54892502a475856cb46bad649c1f2abd99cf25fda038c0fed57d086583032433ccc9b70505ee1cade78
+  data.tar.gz: a169a25a29e1eaf614ef00d90ffb43025103edcda957b77fd1585fa19a5c9a4f7b96e9fb30270a2aaa391b7d90e6504a96af3396fd4c7a473011e87565b683be

data/README.md

@@ -119,7 +119,7 @@ You can enable UI using a Rails engine by adding the following code in `config/r
   mount RailsPgExtras::Web::Engine, at: 'pg_extras'
 ```
 
-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. Authentication is mandatory unless you specify `RAILS_PG_EXTRAS_PUBLIC_DASHBOARD=true` or setting `RailsPgExtras.configuration.public_dashboard` to `true`.
 
 You can configure available web actions in `config/initializers/rails_pg_extras.rb`:
 

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

@@ -3,6 +3,7 @@ require "rails_pg_extras/version"
 
 module RailsPgExtras::Web
   class ApplicationController < ActionController::Base
+    before_action :validate_credentials!
     layout "rails_pg_extras/web/application"
 
     REQUIRED_EXTENSIONS = {
@@ -14,7 +15,13 @@ module RailsPgExtras::Web
     ACTIONS = %i[kill_all pg_stat_statements_reset add_extensions]
 
     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']
+      http_basic_authenticate_with name: ENV.fetch('RAILS_PG_EXTRAS_USER'), password: ENV.fetch('RAILS_PG_EXTRAS_PASSWORD')
+    end
+
+    def validate_credentials!
+      if (ENV['RAILS_PG_EXTRAS_USER'].blank? || ENV['RAILS_PG_EXTRAS_PASSWORD'].blank?) && !RailsPgExtras.configuration.public_dashboard
+        raise "Missing credentials for rails-pg-extras dashboard! If you want to enable public dashboard please set RAILS_PG_EXTRAS_PUBLIC_DASHBOARD=true"
+      end
     end
   end
 end

data/lib/rails_pg_extras/configuration.rb

@@ -4,12 +4,14 @@ require "rails_pg_extras/web"
 
 module RailsPgExtras
   class Configuration
-    DEFAULT_CONFIG = { enabled_web_actions: Web::ACTIONS - [:kill_all] }
+    DEFAULT_CONFIG = { enabled_web_actions: Web::ACTIONS - [:kill_all], public_dashboard: ENV["RAILS_PG_EXTRAS_PUBLIC_DASHBOARD"] == "true" }
 
     attr_reader :enabled_web_actions
+    attr_accessor :public_dashboard
 
     def initialize(attrs)
       self.enabled_web_actions = attrs[:enabled_web_actions]
+      self.public_dashboard = attrs[:public_dashboard]
     end
 
     def enabled_web_actions=(*actions)

data/lib/rails_pg_extras/tasks/all.rake

@@ -3,35 +3,25 @@
 require 'rails-pg-extras'
 
 namespace :pg_extras do
-  task :establish_connection do
-    if ENV['DATABASE_URL'].present?
-      ActiveRecord::Base.establish_connection(ENV['DATABASE_URL'])
-    else
-      db_config_file = File.read('config/database.yml')
-      db_config = YAML.safe_load(ERB.new(db_config_file).result, aliases: true)
-      ActiveRecord::Base.establish_connection(db_config[Rails.env])
-    end
-  end
-
   RailsPgExtras::QUERIES.each do |query_name|
     desc RubyPgExtras.description_for(query_name: query_name)
-    task query_name.to_sym => :establish_connection do
+    task query_name.to_sym => :environment do
       RailsPgExtras.public_send(query_name)
     end
   end
 
   desc "Generate a PostgreSQL healthcheck report"
-  task diagnose: :establish_connection do
+  task diagnose: :environment do
     RailsPgExtras.diagnose
   end
 
   desc "Display tables metadata metrics"
-  task table_info: :establish_connection do
+  task table_info: :environment do
     RailsPgExtras.table_info
   end
 
   desc "Display indexes metadata metrics"
-  task index_info: :establish_connection do
+  task index_info: :environment do
     RailsPgExtras.index_info
   end
 end

data/lib/rails_pg_extras/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-pg-extras
 version: !ruby/object:Gem::Version
-  version: 4.7.1
+  version: 4.9.0
 platform: ruby
 authors:
 - pawurb
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-08 00:00:00.000000000 Z
+date: 2022-08-18 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.7.1
+        version: 4.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.7.1
+        version: 4.9.0
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement