From 748b2f9cb1ff05a8aab068e2fa802e9f12163e30 Mon Sep 17 00:00:00 2001
From: Kasper Timm Hansen <kaspth@gmail.com>
Date: Tue, 3 Nov 2015 23:02:00 +0100
Subject: Add enabled flag to the public file server.

As discussed in https://github.com/rails/rails/pull/19135#issuecomment-153385986.

Replaces `serve_static_files` to unify the static options under the `public_file_server` wing.

Deprecates `serve_static_files` accessors, but make them use the newer config internally.
---
 railties/lib/rails/application/configuration.rb    | 25 ++++++++++++++++++++--
 .../rails/application/default_middleware_stack.rb  |  2 +-
 2 files changed, 24 insertions(+), 3 deletions(-)

(limited to 'railties/lib/rails/application')

diff --git a/railties/lib/rails/application/configuration.rb b/railties/lib/rails/application/configuration.rb
index ee9c87b5cf..7ac010b903 100644
--- a/railties/lib/rails/application/configuration.rb
+++ b/railties/lib/rails/application/configuration.rb
@@ -3,6 +3,9 @@ require 'active_support/file_update_checker'
 require 'rails/engine/configuration'
 require 'rails/source_annotation_extractor'
 
+require 'active_support/deprecation'
+require 'active_support/core_ext/string/strip' # for strip_heredoc
+
 module Rails
   class Application
     class Configuration < ::Rails::Engine::Configuration
@@ -11,7 +14,7 @@ module Rails
                     :eager_load, :exceptions_app, :file_watcher, :filter_parameters,
                     :force_ssl, :helpers_paths, :logger, :log_formatter, :log_tags,
                     :railties_order, :relative_url_root, :secret_key_base, :secret_token,
-                    :serve_static_files, :ssl_options, :static_index, :public_file_server,
+                    :ssl_options, :static_index, :public_file_server,
                     :session_options, :time_zone, :reload_classes_only_on_change,
                     :beginning_of_week, :filter_redirect, :x
 
@@ -26,9 +29,9 @@ module Rails
         @filter_parameters             = []
         @filter_redirect               = []
         @helpers_paths                 = []
-        @serve_static_files            = true
         @static_index                  = "index"
         @public_file_server            = ActiveSupport::OrderedOptions.new
+        @public_file_server.enabled    = true
         @force_ssl                     = false
         @ssl_options                   = {}
         @session_store                 = :cookie_store
@@ -60,6 +63,24 @@ module Rails
         @static_cache_control = value
       end
 
+      def serve_static_files
+        ActiveSupport::Deprecation.warn <<-eow.strip_heredoc
+          `serve_static_files` is deprecated and will be removed in Rails 5.1.
+          Please use `public_file_server.enabled` instead.
+        eow
+
+        @public_file_server.enabled
+      end
+
+      def serve_static_files=(value)
+        ActiveSupport::Deprecation.warn <<-eow.strip_heredoc
+          `serve_static_files` is deprecated and will be removed in Rails 5.1.
+          Please use `public_file_server.enabled = #{value}` instead.
+        eow
+
+        @public_file_server.enabled = value
+      end
+
       def encoding=(value)
         @encoding = value
         silence_warnings do
diff --git a/railties/lib/rails/application/default_middleware_stack.rb b/railties/lib/rails/application/default_middleware_stack.rb
index 387d92db73..b0d481c21a 100644
--- a/railties/lib/rails/application/default_middleware_stack.rb
+++ b/railties/lib/rails/application/default_middleware_stack.rb
@@ -17,7 +17,7 @@ module Rails
 
           middleware.use ::Rack::Sendfile, config.action_dispatch.x_sendfile_header
 
-          if config.serve_static_files
+          if config.public_file_server.enabled
             headers = config.public_file_server.headers || {}
             headers['Cache-Control'.freeze] = config.static_cache_control if config.static_cache_control
 
-- 
cgit v1.2.3