Move credentials to settings.yml

Author: adrien1018

app/models/user.rb

@@ -38,7 +38,7 @@ class User < ApplicationRecord
   # Include default devise modules. Others available are:
   # :confirmable, :lockable, :timeoutable and :omniauthable
   devise :database_authenticatable, :registerable, :rememberable, :trackable, :validatable
-  devise :recoverable if Rails.application.credentials.mail_settings
+  devise :recoverable if Rails.configuration.x.settings.dig(:mail_settings) || Rails.application.credentials.mail_settings
 
   mount_uploader :avatar, AvatarUploader
   validates :avatar,

config/application.rb

@@ -12,7 +12,11 @@ class Application < Rails::Application
     config.load_defaults 7.0
     config.time_zone = "Taipei"
     config.site_name = "TIOJ INFOR Online Judge"
-    config.x.settings = config_for(:settings)
+    begin
+      config.x.settings = config_for(:settings)
+    rescue RuntimeError
+      config.x.settings = {}
+    end
     ActsAsTaggableOn.strict_case_match = true
 
     # Settings in config/environments/* take precedence over those specified here.

config/environments/development.rb

@@ -41,10 +41,10 @@
 
   config.action_mailer.perform_caching = false
 
-  if Rails.application.credentials.mail_settings
-    config.action_mailer.default_url_options = Rails.application.credentials.mail_settings.url_options
+  if Rails.configuration.x.settings.dig(:mail_settings) || Rails.application.credentials.mail_settings
+    config.action_mailer.default_url_options = Rails.configuration.x.settings.dig(:mail_settings, :url_options) || Rails.application.credentials.mail_settings.url_options
     config.action_mailer.delivery_method = :smtp
-    config.action_mailer.smtp_settings = Rails.application.credentials.mail_settings.smtp_settings
+    config.action_mailer.smtp_settings = Rails.configuration.x.settings.dig(:mail_settings, :smtp_settings) || Rails.application.credentials.mail_settings.smtp_settings
   end
 
   # Print deprecation notices to the Rails logger.

config/environments/production.rb

@@ -74,10 +74,10 @@
 
   config.action_mailer.perform_caching = false
 
-  if Rails.application.credentials.mail_settings
-    config.action_mailer.default_url_options = Rails.application.credentials.mail_settings.url_options
+  if Rails.configuration.x.settings.dig(:mail_settings) || Rails.application.credentials.mail_settings
+    config.action_mailer.default_url_options = Rails.configuration.x.settings.dig(:mail_settings, :url_options) || Rails.application.credentials.mail_settings.url_options
     config.action_mailer.delivery_method = :smtp
-    config.action_mailer.smtp_settings = Rails.application.credentials.mail_settings.smtp_settings
+    config.action_mailer.smtp_settings = Rails.configuration.x.settings.dig(:mail_settings, :smtp_settings) || Rails.application.credentials.mail_settings.smtp_settings
   end
 
   # Ignore bad email addresses and do not raise email delivery errors.

config/environments/test.rb

@@ -38,10 +38,10 @@
 
   config.action_mailer.perform_caching = false
 
-  if Rails.application.credentials.mail_settings
-    config.action_mailer.default_url_options = Rails.application.credentials.mail_settings.url_options
+  if Rails.configuration.x.settings.dig(:mail_settings) || Rails.application.credentials.mail_settings
+    config.action_mailer.default_url_options = Rails.configuration.x.settings.dig(:mail_settings, :url_options) || Rails.application.credentials.mail_settings.url_options
     config.action_mailer.delivery_method = :smtp
-    config.action_mailer.smtp_settings = Rails.application.credentials.mail_settings.smtp_settings
+    config.action_mailer.smtp_settings = Rails.configuration.x.settings.dig(:mail_settings, :smtp_settings) || Rails.application.credentials.mail_settings.smtp_settings
   end
 
   # Tell Action Mailer not to deliver emails to the real world.

config/initializers/devise.rb

@@ -10,7 +10,7 @@
   # Configure the e-mail address which will be shown in Devise::Mailer,
   # note that it will be overwritten if you use your own mailer class
   # with default "from" parameter.
-  config.mailer_sender = Rails.application.credentials.mail_settings&.sender || ""
+  config.mailer_sender = Rails.configuration.x.settings.dig(:mail_settings, :sender) || Rails.application.credentials.mail_settings&.sender || ""
 
   # Configure the class responsible to send e-mails.
   # config.mailer = 'Devise::Mailer'

config/initializers/sentry.rb

@@ -1,15 +1,17 @@
-if Rails.application.credentials.sentry_dsn
+Rails.logger.fatal Rails.configuration.x.settings
+if Rails.configuration.x.settings.dig(:sentry_dsn) || Rails.application.credentials.sentry_dsn
   Sentry.init do |config|
-    config.dsn = Rails.application.credentials.sentry_dsn
+    config.dsn = Rails.configuration.x.settings.dig(:sentry_dsn) || Rails.application.credentials.sentry_dsn
     config.breadcrumbs_logger = [:active_support_logger, :http_logger]
     config.traces_sampler = lambda do |sampling_context|
       unless sampling_context[:parent_sampled].nil?
         next sampling_context[:parent_sampled]
       end
+      sample_rate = Rails.configuration.x.settings.dig(:sentry_sample_rate)
       if sampling_context[:transaction_context][:op] == 'rails.action_cable'
-        Rails.configuration.x.settings.sentry_sample_rate[:cable]
+        sample_rate&.dig(:cable) == nil ? 0.02 : sample_rate[:cable]
       else
-        Rails.configuration.x.settings.sentry_sample_rate[:normal]
+        sample_rate&.dig(:normal) == nil ? 0.02 : sample_rate[:normal]
       end
     end
   end

config/settings.yml.example

@@ -1,4 +1,18 @@
 shared:
+  # Password recovery settings
+  mail_settings:
+    smtp_settings: # SMTP server settings; it will be passed to config.action_mailer.smtp_settings
+      address: smtp.example.com
+      port: 587
+      user_name: [email protected]
+      password: some_password
+      enable_starttls_auto: true
+    url_options:
+      host: https://tioj.example.com # the URL of the website, used to generate the link in the email
+    sender: tioj.example.com # email sender
+
+  # Sentry settings
+  sentry_dsn: https://[email protected]/xxxx # copy from your sentry project
   sentry_sample_rate:
     normal: 0.002
     cable: 0.001