Skip to content

Commit

Permalink
Rails8: update Rails config (#1252)
Browse files Browse the repository at this point in the history
  • Loading branch information
mockdeep authored Dec 4, 2024
1 parent 6d7d6db commit 849d60e
Show file tree
Hide file tree
Showing 18 changed files with 700 additions and 349 deletions.
2 changes: 2 additions & 0 deletions bin/dev
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
#!/usr/bin/env ruby
exec "./bin/rails", "server", *ARGV
8 changes: 8 additions & 0 deletions bin/rubocop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
#!/usr/bin/env ruby
require "rubygems"
require "bundler/setup"

# explicit rubocop config increases performance slightly while avoiding config confusion.
ARGV.unshift("--config", File.expand_path("../.rubocop.yml", __dir__))

load Gem.bin_path("rubocop", "rubocop")
17 changes: 9 additions & 8 deletions bin/setup
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,18 @@

require "fileutils"

# path to your application root.
APP_ROOT = File.expand_path("..", __dir__)

def system!(*args)
system(*args, exception: true)
end

FileUtils.chdir(APP_ROOT) do
# This script is a way to set up or update your development environment
# automatically. This script is idempotent, so that you can run it at any
# time and get an expectable outcome. Add necessary setup steps to this file.
FileUtils.chdir APP_ROOT do
# This script is a way to set up or update your development environment automatically.
# This script is idempotent, so that you can run it at any time and get an expectable outcome.
# Add necessary setup steps to this file.

puts "== Installing dependencies =="
system! "gem install bundler --conservative"
system("bundle check") || system!("bundle install")

# puts "\n== Copying sample files =="
Expand All @@ -30,6 +28,9 @@ FileUtils.chdir(APP_ROOT) do
puts "\n== Removing old logs and tempfiles =="
system! "bin/rails log:clear tmp:clear"

puts "\n== Restarting application server =="
system! "bin/rails restart"
unless ARGV.include?("--skip-server")
puts "\n== Starting development server =="
STDOUT.flush # flush the output before exec(2) so that it displays
exec "bin/dev"
end
end
5 changes: 5 additions & 0 deletions bin/thrust
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
#!/usr/bin/env ruby
require "rubygems"
require "bundler/setup"

load Gem.bin_path("thruster", "thrust")
2 changes: 1 addition & 1 deletion config/application.rb
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ module Stringer

class Stringer::Application < Rails::Application
# Initialize configuration defaults for originally generated Rails version.
config.load_defaults(7.1)
config.load_defaults(8.0)

# Please, add to the `ignore` list any other `lib` subdirectories that do
# not contain `.rb` files, or that should not be reloaded or eager loaded.
Expand Down
42 changes: 18 additions & 24 deletions config/environments/development.rb
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,7 @@
# Settings specified here will take precedence over those in
# config/application.rb.

# In the development environment your application's code is reloaded any time
# it changes. This slows down response time but is perfect for development
# since you don't have to restart the web server when you make code changes.
# Make code changes take effect immediately without server restart.
config.enable_reloading = true

# Do not eager load code on boot.
Expand All @@ -17,53 +15,49 @@
# Show full error reports.
config.consider_all_requests_local = true

# Enable server timing
# Enable server timing.
config.server_timing = true

# Enable/disable caching. By default caching is disabled.
# Run rails dev:cache to toggle caching.
# Enable/disable Action Controller caching. By default Action Controller
# caching is disabled. Run rails dev:cache to toggle Action Controller
# caching.
if Rails.root.join("tmp/caching-dev.txt").exist?
config.action_controller.perform_caching = true
config.action_controller.enable_fragment_cache_logging = true

config.cache_store = :memory_store
config.public_file_server.headers = {
"Cache-Control" => "public, max-age=#{2.days.to_i}"
}
config.public_file_server.headers =
{ "cache-control" => "public, max-age=#{2.days.to_i}" }
else
config.action_controller.perform_caching = false

config.cache_store = :null_store
end

# Change to :null_store to avoid any caching.
config.cache_store = :memory_store

# Print deprecation notices to the Rails logger.
config.active_support.deprecation = :log

# Raise exceptions for disallowed deprecations.
config.active_support.disallowed_deprecation = :raise

# Tell Active Support which deprecation messages to disallow.
config.active_support.disallowed_deprecation_warnings = []

# Raise an error on page load if there are pending migrations.
config.active_record.migration_error = :page_load

# Highlight code that triggered database queries in logs.
config.active_record.verbose_query_logs = true

# Append comments with runtime information tags to SQL queries in logs.
config.active_record.query_log_tags_enabled = true

# Highlight code that enqueued background job in logs.
config.active_job.verbose_enqueue_logs = true

# Suppress logger output for asset requests.
config.assets.quiet = true

# Raises error for missing translations.
# config.i18n.raise_on_missing_translations = true

# Annotate rendered view with file names.
# config.action_view.annotate_rendered_view_with_filenames = true
config.action_view.annotate_rendered_view_with_filenames = true

# Raise error when a before_action's only/except options reference missing
# actions
# actions.
config.action_controller.raise_on_missing_callback_actions = true

# Apply autocorrection by RuboCop to files generated by `bin/rails generate`.
# config.generators.apply_rubocop_autocorrect_after_generate!
end
79 changes: 34 additions & 45 deletions config/environments/production.rb
Original file line number Diff line number Diff line change
Expand Up @@ -9,85 +9,74 @@
# Code is not reloaded between requests.
config.enable_reloading = false

# Eager load code on boot. This eager loads most of Rails and
# your application in memory, allowing both threaded web servers
# and those relying on copy on write to perform better.
# Rake tasks automatically ignore this option for performance.
# Eager load code on boot for better performance and memory savings (ignored
# by Rake tasks).
config.eager_load = true

# Full error reports are disabled and caching is turned on.
config.consider_all_requests_local = false
config.action_controller.perform_caching = true

# Ensures that a master key has been made available in
# ENV["RAILS_MASTER_KEY"], config/master.key, or an environment key such as
# config/credentials/production.key. This key is used to decrypt credentials
# (and other encrypted files).
# config.require_master_key = true
# Full error reports are disabled.
config.consider_all_requests_local = false

# Enable static file serving from the `/public` folder (turn off if using
# NGINX/Apache for it).
config.public_file_server.enabled = true

# Compress CSS using a preprocessor.
# config.assets.css_compressor = :sass
# Turn on fragment caching in view templates.
config.action_controller.perform_caching = true

# Do not fallback to assets pipeline if a precompiled asset is missed.
config.assets.compile = false
# Cache assets for far-future expiry since they are all digest stamped.
config.public_file_server.headers = {
"cache-control" => "public, max-age=#{Integer(1.year, 10)}"
}

# Enable serving of images, stylesheets, and JavaScripts from an asset server.
# config.asset_host = "http://assets.example.com"

# Specifies the header that your server uses for sending files.
# config.action_dispatch.x_sendfile_header = "X-Sendfile" # for Apache
# config.action_dispatch.x_sendfile_header = "X-Accel-Redirect" # for NGINX

# Assume all access to the app is happening through a SSL-terminating reverse
# proxy. Can be used together with config.force_ssl for
# Strict-Transport-Security and secure cookies.
# config.assume_ssl = true
# proxy.
config.assume_ssl = true

# Force all access to the app over SSL, use Strict-Transport-Security, and
# use secure cookies.
config.force_ssl = true

# Log to STDOUT by default
logger = ActiveSupport::Logger.new($stdout)
logger.formatter = Logger::Formatter.new
config.logger = ActiveSupport::TaggedLogging.new(logger)
# Skip http-to-https redirect for the default health check endpoint.
# config.ssl_options =
# { redirect: { exclude: ->(request) { request.path == "/up" } } }

# Prepend all log lines with the following tags.
# Log to STDOUT with the current request id as a default log tag.
config.log_tags = [:request_id]
config.logger = ActiveSupport::TaggedLogging.logger($stdout)

# Info include generic and useful information about system operation, but
# avoids logging too much information to avoid inadvertent exposure of
# personally identifiable information (PII). If you want to log everything,
# set the level to "debug".
# Change to "debug" to log everything (including potentially
# personally-identifiable information!)
config.log_level = ENV.fetch("RAILS_LOG_LEVEL", "info")

# Use a different cache store in production.
# Prevent health checks from clogging up the logs.
config.silence_healthcheck_path = "/up"

# Don't log any deprecations.
config.active_support.report_deprecations = false

# Replace the default in-process memory cache store with a durable
# alternative.
# config.cache_store = :mem_cache_store

# Use a real queuing backend for Active Job (and separate queues per
# environment).
# config.active_job.queue_adapter = :resque
# config.active_job.queue_name_prefix = "stringer_production"
# Replace the default in-process and non-durable queuing backend for Active
# Job.
# config.active_job.queue_adapter = :resque

# Enable locale fallbacks for I18n (makes lookups for any locale fall back to
# the I18n.default_locale when a translation cannot be found).
config.i18n.fallbacks = true

# Don't log any deprecations.
config.active_support.report_deprecations = false

# Do not dump schema after migrations.
config.active_record.dump_schema_after_migration = false

# Only use :id for inspections in production.
config.active_record.attributes_for_inspect = [:id]

# Enable DNS rebinding protection and other `Host` header attacks.
# config.hosts = [
# "example.com", # Allow requests from example.com
# /.*\.example\.com/ # Allow requests from subdomains like `www.example.com`
# ]
#
# Skip DNS rebinding protection for the default health check endpoint.
# config.host_authorization =
# { exclude: ->(request) { request.path == "/up" } }
Expand Down
26 changes: 8 additions & 18 deletions config/environments/test.rb
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# frozen_string_literal: true

require "active_support/core_ext/integer/time"

# The test environment is used exclusively to run your application's
# test suite. You never need to work with it otherwise. Remember that
# your test database is "scratch space" for the test suite and is wiped
Expand All @@ -21,18 +19,16 @@
# code.
config.eager_load = ENV["CI"].present?

# Configure public file server for tests with Cache-Control for performance.
config.public_file_server.enabled = true
config.public_file_server.headers = {
"Cache-Control" => "public, max-age=#{1.hour.to_i}"
}
# Configure public file server for tests with cache-control for performance.
config.public_file_server.headers =
{ "cache-control" => "public, max-age=3600" }

# Show full error reports and disable caching.
config.consider_all_requests_local = true
config.action_controller.perform_caching = false
# Show full error reports.
config.consider_all_requests_local = true
config.cache_store = :null_store

# Raise exceptions instead of rendering exception templates.
# Render exception templates for rescuable exceptions and raise for other
# exceptions.
config.action_dispatch.show_exceptions = :rescuable

# Disable request forgery protection in test environment.
Expand All @@ -41,19 +37,13 @@
# Print deprecation notices to the stderr.
config.active_support.deprecation = :stderr

# Raise exceptions for disallowed deprecations.
config.active_support.disallowed_deprecation = :raise

# Tell Active Support which deprecation messages to disallow.
config.active_support.disallowed_deprecation_warnings = []

# Raises error for missing translations.
# config.i18n.raise_on_missing_translations = true

# Annotate rendered view with file names.
# config.action_view.annotate_rendered_view_with_filenames = true

# Raise error when a before_action's only/except options reference missing
# actions
# actions.
config.action_controller.raise_on_missing_callback_actions = true
end
5 changes: 0 additions & 5 deletions config/initializers/assets.rb
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,3 @@

# Add additional assets to the asset load path.
# Rails.application.config.assets.paths << Emoji.images_path

# Precompile additional assets.
# application.js, application.css, and all non-JS/CSS in the app/assets
# folder are already added.
# Rails.application.config.assets.precompile += %w( admin.js admin.css )
13 changes: 12 additions & 1 deletion config/initializers/filter_parameter_logging.rb
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,16 @@
# information. See the ActiveSupport::ParameterFilter documentation for
# supported notations and behaviors.
Rails.application.config.filter_parameters += [
:passw, :secret, :token, :_key, :crypt, :salt, :certificate, :otp, :ssn
:passw,
:email,
:secret,
:token,
:_key,
:crypt,
:salt,
:certificate,
:otp,
:ssn,
:cvv,
:cvc
]
Loading

0 comments on commit 849d60e

Please sign in to comment.