docbrown/config/application.rb

require_relative "boot"

require "rails"
# Pick the frameworks you want:
require "active_model/railtie"
require "active_job/railtie"
require "active_record/railtie"
# require "active_storage/engine"
require "action_controller/railtie"
require "action_mailer/railtie"
# require "action_mailbox/engine"
# require "action_text/engine"
require "action_view/railtie"
# require "action_cable/engine"
require "sprockets/railtie"
# require "rails/test_unit/railtie"

# Require the gems listed in Gemfile, including any gems
# you've limited to :test, :development, or :production.
Bundler.require(*Rails.groups)

Dotenv::Railtie.load if Rails.env.test? || Rails.env.development?

module PracticalDeveloper
  class Application < Rails::Application
    # Initialize configuration defaults for originally generated Rails version.
    config.load_defaults 5.1 # NOTE: [Rails 6] we should at least work towards updating this to 5.2

    # [Rails 6] Zeitwerk is the new autoloader
    # As we don't have `load_defaults 6.0` yet, it has to be enabled manually
    # See <https://guides.rubyonrails.org/autoloading_and_reloading_constants.html>
    config.autoloader = :zeitwerk

    # Disable auto adding of default load paths to $LOAD_PATH
    # Setting this to false saves Ruby from checking these directories when
    # resolving require calls with relative paths, and saves Bootsnap work and
    # RAM, since it does not need to build an index for them.
    # see https://github.com/rails/rails/blob/6-0-stable/railties/CHANGELOG.md#rails-600rc2-july-22-2019
    config.add_autoload_paths_to_load_path = false

    # Settings in config/environments/* take precedence over those specified here.
    # Application configuration can go into files in config/initializers
    # -- all .rb files in that directory are automatically loaded after loading
    # the framework and any gems in your application.

    config.autoload_paths += Dir["#{config.root}/lib"]
    config.eager_load_paths += Dir["#{config.root}/lib"]

    # Middlewares folder is not otherwise autorequired.
    Dir["#{config.root}/app/middlewares/**/*.rb"].each do |file|
      require_dependency(file)
    end

    config.active_job.queue_adapter = :sidekiq

    config.middleware.use Rack::Deflater

    # Globally handle Pundit::NotAuthorizedError by serving 404
    config.action_dispatch.rescue_responses["Pundit::NotAuthorizedError"] = :not_found

    # Rails 5.1 introduced CSRF tokens that change per-form.
    # Unfortunately there isn't an easy way to use them and use view caching at the same time.
    # Therefore we disable "per_form_csrf_tokens" for the time being.
    config.action_controller.per_form_csrf_tokens = false

    config.middleware.use SetCookieDomain

    # NOTE: [Rails 6]
    # To improve security, Rails embeds the purpose and expiry metadata inside encrypted or signed cookies value.
    config.action_dispatch.use_cookies_with_metadata = false

    # After-initialize checker to add routes to reserved words
    config.after_initialize do
      # Add routes to reserved words
      Rails.application.reload_routes!
      top_routes = []
      Rails.application.routes.routes.each do |route|
        route = route.path.spec.to_s
        next if route.starts_with?("/:")

        route = route.split("/")[1]
        route = route.split("(")[0] if route&.include?("(")
        top_routes << route
      end
      ReservedWords.all = [ReservedWords::BASE_WORDS + top_routes].flatten.compact.uniq
    end
  end
end