actionpack 7.1.3.4 → 7.2.0.beta1

Sign up to get free protection for your applications and to get access to all the features.

Potentially problematic release.


This version of actionpack might be problematic. Click here for more details.

Files changed (158) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +70 -541
  3. data/lib/abstract_controller/asset_paths.rb +2 -0
  4. data/lib/abstract_controller/base.rb +102 -98
  5. data/lib/abstract_controller/caching/fragments.rb +50 -53
  6. data/lib/abstract_controller/caching.rb +2 -0
  7. data/lib/abstract_controller/callbacks.rb +66 -64
  8. data/lib/abstract_controller/collector.rb +6 -6
  9. data/lib/abstract_controller/deprecator.rb +2 -0
  10. data/lib/abstract_controller/error.rb +2 -0
  11. data/lib/abstract_controller/helpers.rb +70 -85
  12. data/lib/abstract_controller/logger.rb +2 -0
  13. data/lib/abstract_controller/railties/routes_helpers.rb +2 -0
  14. data/lib/abstract_controller/rendering.rb +13 -12
  15. data/lib/abstract_controller/translation.rb +11 -10
  16. data/lib/abstract_controller/url_for.rb +8 -6
  17. data/lib/abstract_controller.rb +2 -0
  18. data/lib/action_controller/api/api_rendering.rb +2 -0
  19. data/lib/action_controller/api.rb +74 -72
  20. data/lib/action_controller/base.rb +155 -117
  21. data/lib/action_controller/caching.rb +15 -12
  22. data/lib/action_controller/deprecator.rb +2 -0
  23. data/lib/action_controller/form_builder.rb +20 -17
  24. data/lib/action_controller/log_subscriber.rb +3 -1
  25. data/lib/action_controller/metal/allow_browser.rb +119 -0
  26. data/lib/action_controller/metal/basic_implicit_render.rb +2 -0
  27. data/lib/action_controller/metal/conditional_get.rb +188 -174
  28. data/lib/action_controller/metal/content_security_policy.rb +25 -24
  29. data/lib/action_controller/metal/cookies.rb +4 -2
  30. data/lib/action_controller/metal/data_streaming.rb +64 -55
  31. data/lib/action_controller/metal/default_headers.rb +5 -3
  32. data/lib/action_controller/metal/etag_with_flash.rb +3 -1
  33. data/lib/action_controller/metal/etag_with_template_digest.rb +17 -15
  34. data/lib/action_controller/metal/exceptions.rb +11 -9
  35. data/lib/action_controller/metal/flash.rb +12 -10
  36. data/lib/action_controller/metal/head.rb +12 -10
  37. data/lib/action_controller/metal/helpers.rb +63 -55
  38. data/lib/action_controller/metal/http_authentication.rb +209 -201
  39. data/lib/action_controller/metal/implicit_render.rb +17 -15
  40. data/lib/action_controller/metal/instrumentation.rb +15 -12
  41. data/lib/action_controller/metal/live.rb +113 -107
  42. data/lib/action_controller/metal/logging.rb +6 -4
  43. data/lib/action_controller/metal/mime_responds.rb +151 -142
  44. data/lib/action_controller/metal/parameter_encoding.rb +34 -32
  45. data/lib/action_controller/metal/params_wrapper.rb +57 -59
  46. data/lib/action_controller/metal/permissions_policy.rb +13 -12
  47. data/lib/action_controller/metal/rate_limiting.rb +62 -0
  48. data/lib/action_controller/metal/redirecting.rb +108 -82
  49. data/lib/action_controller/metal/renderers.rb +50 -49
  50. data/lib/action_controller/metal/rendering.rb +103 -75
  51. data/lib/action_controller/metal/request_forgery_protection.rb +162 -133
  52. data/lib/action_controller/metal/rescue.rb +11 -9
  53. data/lib/action_controller/metal/streaming.rb +138 -136
  54. data/lib/action_controller/metal/strong_parameters.rb +525 -480
  55. data/lib/action_controller/metal/testing.rb +2 -0
  56. data/lib/action_controller/metal/url_for.rb +17 -15
  57. data/lib/action_controller/metal.rb +58 -57
  58. data/lib/action_controller/railtie.rb +3 -0
  59. data/lib/action_controller/railties/helpers.rb +2 -0
  60. data/lib/action_controller/renderer.rb +42 -36
  61. data/lib/action_controller/template_assertions.rb +4 -2
  62. data/lib/action_controller/test_case.rb +146 -126
  63. data/lib/action_controller.rb +10 -3
  64. data/lib/action_dispatch/constants.rb +2 -0
  65. data/lib/action_dispatch/deprecator.rb +2 -0
  66. data/lib/action_dispatch/http/cache.rb +27 -26
  67. data/lib/action_dispatch/http/content_disposition.rb +2 -0
  68. data/lib/action_dispatch/http/content_security_policy.rb +44 -38
  69. data/lib/action_dispatch/http/filter_parameters.rb +9 -5
  70. data/lib/action_dispatch/http/filter_redirect.rb +15 -1
  71. data/lib/action_dispatch/http/headers.rb +22 -22
  72. data/lib/action_dispatch/http/mime_negotiation.rb +30 -41
  73. data/lib/action_dispatch/http/mime_type.rb +29 -22
  74. data/lib/action_dispatch/http/mime_types.rb +2 -0
  75. data/lib/action_dispatch/http/parameters.rb +11 -9
  76. data/lib/action_dispatch/http/permissions_policy.rb +27 -37
  77. data/lib/action_dispatch/http/rack_cache.rb +2 -0
  78. data/lib/action_dispatch/http/request.rb +71 -71
  79. data/lib/action_dispatch/http/response.rb +61 -61
  80. data/lib/action_dispatch/http/upload.rb +18 -16
  81. data/lib/action_dispatch/http/url.rb +75 -73
  82. data/lib/action_dispatch/journey/formatter.rb +13 -6
  83. data/lib/action_dispatch/journey/gtg/builder.rb +4 -3
  84. data/lib/action_dispatch/journey/gtg/simulator.rb +2 -0
  85. data/lib/action_dispatch/journey/gtg/transition_table.rb +10 -8
  86. data/lib/action_dispatch/journey/nfa/dot.rb +2 -0
  87. data/lib/action_dispatch/journey/nodes/node.rb +6 -5
  88. data/lib/action_dispatch/journey/parser.rb +4 -3
  89. data/lib/action_dispatch/journey/parser_extras.rb +2 -0
  90. data/lib/action_dispatch/journey/path/pattern.rb +4 -1
  91. data/lib/action_dispatch/journey/route.rb +9 -7
  92. data/lib/action_dispatch/journey/router/utils.rb +16 -15
  93. data/lib/action_dispatch/journey/router.rb +4 -2
  94. data/lib/action_dispatch/journey/routes.rb +4 -2
  95. data/lib/action_dispatch/journey/scanner.rb +4 -2
  96. data/lib/action_dispatch/journey/visitors.rb +2 -0
  97. data/lib/action_dispatch/journey.rb +2 -0
  98. data/lib/action_dispatch/log_subscriber.rb +2 -0
  99. data/lib/action_dispatch/middleware/actionable_exceptions.rb +2 -0
  100. data/lib/action_dispatch/middleware/assume_ssl.rb +8 -5
  101. data/lib/action_dispatch/middleware/callbacks.rb +3 -1
  102. data/lib/action_dispatch/middleware/cookies.rb +119 -104
  103. data/lib/action_dispatch/middleware/debug_exceptions.rb +13 -5
  104. data/lib/action_dispatch/middleware/debug_locks.rb +15 -13
  105. data/lib/action_dispatch/middleware/debug_view.rb +2 -0
  106. data/lib/action_dispatch/middleware/exception_wrapper.rb +6 -11
  107. data/lib/action_dispatch/middleware/executor.rb +8 -0
  108. data/lib/action_dispatch/middleware/flash.rb +63 -51
  109. data/lib/action_dispatch/middleware/host_authorization.rb +17 -15
  110. data/lib/action_dispatch/middleware/public_exceptions.rb +8 -6
  111. data/lib/action_dispatch/middleware/reloader.rb +5 -3
  112. data/lib/action_dispatch/middleware/remote_ip.rb +77 -72
  113. data/lib/action_dispatch/middleware/request_id.rb +14 -9
  114. data/lib/action_dispatch/middleware/server_timing.rb +4 -2
  115. data/lib/action_dispatch/middleware/session/abstract_store.rb +2 -0
  116. data/lib/action_dispatch/middleware/session/cache_store.rb +13 -8
  117. data/lib/action_dispatch/middleware/session/cookie_store.rb +27 -26
  118. data/lib/action_dispatch/middleware/session/mem_cache_store.rb +7 -3
  119. data/lib/action_dispatch/middleware/show_exceptions.rb +31 -21
  120. data/lib/action_dispatch/middleware/ssl.rb +43 -40
  121. data/lib/action_dispatch/middleware/stack.rb +11 -10
  122. data/lib/action_dispatch/middleware/static.rb +33 -31
  123. data/lib/action_dispatch/middleware/templates/rescues/_source.html.erb +1 -1
  124. data/lib/action_dispatch/middleware/templates/rescues/missing_exact_template.html.erb +1 -1
  125. data/lib/action_dispatch/middleware/templates/routes/_table.html.erb +1 -1
  126. data/lib/action_dispatch/railtie.rb +2 -4
  127. data/lib/action_dispatch/request/session.rb +23 -21
  128. data/lib/action_dispatch/request/utils.rb +2 -0
  129. data/lib/action_dispatch/routing/endpoint.rb +2 -0
  130. data/lib/action_dispatch/routing/inspector.rb +5 -3
  131. data/lib/action_dispatch/routing/mapper.rb +670 -635
  132. data/lib/action_dispatch/routing/polymorphic_routes.rb +69 -62
  133. data/lib/action_dispatch/routing/redirection.rb +37 -32
  134. data/lib/action_dispatch/routing/route_set.rb +59 -45
  135. data/lib/action_dispatch/routing/routes_proxy.rb +6 -4
  136. data/lib/action_dispatch/routing/url_for.rb +130 -125
  137. data/lib/action_dispatch/routing.rb +150 -148
  138. data/lib/action_dispatch/system_test_case.rb +91 -81
  139. data/lib/action_dispatch/system_testing/browser.rb +10 -3
  140. data/lib/action_dispatch/system_testing/driver.rb +3 -1
  141. data/lib/action_dispatch/system_testing/server.rb +2 -0
  142. data/lib/action_dispatch/system_testing/test_helpers/screenshot_helper.rb +32 -21
  143. data/lib/action_dispatch/system_testing/test_helpers/setup_and_teardown.rb +2 -0
  144. data/lib/action_dispatch/testing/assertion_response.rb +8 -6
  145. data/lib/action_dispatch/testing/assertions/response.rb +26 -23
  146. data/lib/action_dispatch/testing/assertions/routing.rb +153 -84
  147. data/lib/action_dispatch/testing/assertions.rb +2 -0
  148. data/lib/action_dispatch/testing/integration.rb +223 -222
  149. data/lib/action_dispatch/testing/request_encoder.rb +2 -0
  150. data/lib/action_dispatch/testing/test_helpers/page_dump_helper.rb +35 -0
  151. data/lib/action_dispatch/testing/test_process.rb +12 -8
  152. data/lib/action_dispatch/testing/test_request.rb +3 -1
  153. data/lib/action_dispatch/testing/test_response.rb +27 -26
  154. data/lib/action_dispatch.rb +22 -28
  155. data/lib/action_pack/gem_version.rb +6 -4
  156. data/lib/action_pack/version.rb +3 -1
  157. data/lib/action_pack.rb +17 -16
  158. metadata +30 -13
@@ -1,31 +1,33 @@
1
1
  # frozen_string_literal: true
2
2
 
3
+ # :markup: markdown
4
+
3
5
  require "active_support/core_ext/object/deep_dup"
4
6
 
5
7
  module ActionDispatch # :nodoc:
6
- # = Action Dispatch \PermissionsPolicy
8
+ # # Action Dispatch PermissionsPolicy
7
9
  #
8
10
  # Configures the HTTP
9
- # {Feature-Policy}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Feature-Policy]
10
- # response header to specify which browser features the current document and
11
- # its iframes can use.
11
+ # [Feature-Policy](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Feature-Policy)
12
+ # response header to specify which browser features the current
13
+ # document and its iframes can use.
12
14
  #
13
15
  # Example global policy:
14
16
  #
15
- # Rails.application.config.permissions_policy do |policy|
16
- # policy.camera :none
17
- # policy.gyroscope :none
18
- # policy.microphone :none
19
- # policy.usb :none
20
- # policy.fullscreen :self
21
- # policy.payment :self, "https://secure.example.com"
22
- # end
17
+ # Rails.application.config.permissions_policy do |policy|
18
+ # policy.camera :none
19
+ # policy.gyroscope :none
20
+ # policy.microphone :none
21
+ # policy.usb :none
22
+ # policy.fullscreen :self
23
+ # policy.payment :self, "https://secure.example.com"
24
+ # end
23
25
  #
24
- # The Feature-Policy header has been renamed to Permissions-Policy.
25
- # The Permissions-Policy requires a different implementation and isn't
26
- # yet supported by all browsers. To avoid having to rename this
27
- # middleware in the future we use the new name for the middleware but
28
- # keep the old header name and implementation for now.
26
+ # The Feature-Policy header has been renamed to Permissions-Policy. The
27
+ # Permissions-Policy requires a different implementation and isn't yet supported
28
+ # by all browsers. To avoid having to rename this middleware in the future we
29
+ # use the new name for the middleware but keep the old header name and
30
+ # implementation for now.
29
31
  class PermissionsPolicy
30
32
  class Middleware
31
33
  def initialize(app)
@@ -35,6 +37,7 @@ module ActionDispatch # :nodoc:
35
37
  def call(env)
36
38
  _, headers, _ = response = @app.call(env)
37
39
 
40
+ return response unless html_response?(headers)
38
41
  return response if policy_present?(headers)
39
42
 
40
43
  request = ActionDispatch::Request.new(env)
@@ -51,6 +54,12 @@ module ActionDispatch # :nodoc:
51
54
  end
52
55
 
53
56
  private
57
+ def html_response?(headers)
58
+ if content_type = headers[Rack::CONTENT_TYPE]
59
+ content_type.include?("html")
60
+ end
61
+ end
62
+
54
63
  def policy_present?(headers)
55
64
  headers[ActionDispatch::Constants::FEATURE_POLICY]
56
65
  end
@@ -89,7 +98,7 @@ module ActionDispatch # :nodoc:
89
98
  geolocation: "geolocation",
90
99
  gyroscope: "gyroscope",
91
100
  hid: "hid",
92
- idle_detection: "idle_detection",
101
+ idle_detection: "idle-detection",
93
102
  magnetometer: "magnetometer",
94
103
  microphone: "microphone",
95
104
  midi: "midi",
@@ -125,25 +134,6 @@ module ActionDispatch # :nodoc:
125
134
  end
126
135
  end
127
136
 
128
- %w[speaker vibrate vr].each do |directive|
129
- define_method(directive) do |*sources|
130
- ActionDispatch.deprecator.warn(<<~MSG)
131
- The `#{directive}` permissions policy directive is deprecated
132
- and will be removed in Rails 7.2.
133
-
134
- There is no browser support for this directive, and no plan
135
- for browser support in the future. You can just remove this
136
- directive from your application.
137
- MSG
138
-
139
- if sources.first
140
- @directives[directive] = apply_mappings(sources)
141
- else
142
- @directives.delete(directive)
143
- end
144
- end
145
- end
146
-
147
137
  def build(context = nil)
148
138
  build_directives(context).compact.join("; ")
149
139
  end
@@ -2,6 +2,8 @@
2
2
 
3
3
  # :enddoc:
4
4
 
5
+ # :markup: markdown
6
+
5
7
  require "rack/cache"
6
8
  require "rack/cache/context"
7
9
  require "active_support/cache"
@@ -1,5 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
 
3
+ # :markup: markdown
4
+
3
5
  require "stringio"
4
6
 
5
7
  require "active_support/inflector"
@@ -102,26 +104,26 @@ module ActionDispatch
102
104
 
103
105
  # Returns true if the request has a header matching the given key parameter.
104
106
  #
105
- # request.key? :ip_spoofing_check # => true
107
+ # request.key? :ip_spoofing_check # => true
106
108
  def key?(key)
107
109
  has_header? key
108
110
  end
109
111
 
110
- # HTTP methods from {RFC 2616: Hypertext Transfer Protocol -- HTTP/1.1}[https://www.ietf.org/rfc/rfc2616.txt]
112
+ # HTTP methods from [RFC 2616: Hypertext Transfer Protocol -- HTTP/1.1](https://www.ietf.org/rfc/rfc2616.txt)
111
113
  RFC2616 = %w(OPTIONS GET HEAD POST PUT DELETE TRACE CONNECT)
112
- # HTTP methods from {RFC 2518: HTTP Extensions for Distributed Authoring -- WEBDAV}[https://www.ietf.org/rfc/rfc2518.txt]
114
+ # HTTP methods from [RFC 2518: HTTP Extensions for Distributed Authoring -- WEBDAV](https://www.ietf.org/rfc/rfc2518.txt)
113
115
  RFC2518 = %w(PROPFIND PROPPATCH MKCOL COPY MOVE LOCK UNLOCK)
114
- # HTTP methods from {RFC 3253: Versioning Extensions to WebDAV}[https://www.ietf.org/rfc/rfc3253.txt]
116
+ # HTTP methods from [RFC 3253: Versioning Extensions to WebDAV](https://www.ietf.org/rfc/rfc3253.txt)
115
117
  RFC3253 = %w(VERSION-CONTROL REPORT CHECKOUT CHECKIN UNCHECKOUT MKWORKSPACE UPDATE LABEL MERGE BASELINE-CONTROL MKACTIVITY)
116
- # HTTP methods from {RFC 3648: WebDAV Ordered Collections Protocol}[https://www.ietf.org/rfc/rfc3648.txt]
118
+ # HTTP methods from [RFC 3648: WebDAV Ordered Collections Protocol](https://www.ietf.org/rfc/rfc3648.txt)
117
119
  RFC3648 = %w(ORDERPATCH)
118
- # HTTP methods from {RFC 3744: WebDAV Access Control Protocol}[https://www.ietf.org/rfc/rfc3744.txt]
120
+ # HTTP methods from [RFC 3744: WebDAV Access Control Protocol](https://www.ietf.org/rfc/rfc3744.txt)
119
121
  RFC3744 = %w(ACL)
120
- # HTTP methods from {RFC 5323: WebDAV SEARCH}[https://www.ietf.org/rfc/rfc5323.txt]
122
+ # HTTP methods from [RFC 5323: WebDAV SEARCH](https://www.ietf.org/rfc/rfc5323.txt)
121
123
  RFC5323 = %w(SEARCH)
122
- # HTTP methods from {RFC 4791: Calendaring Extensions to WebDAV}[https://www.ietf.org/rfc/rfc4791.txt]
124
+ # HTTP methods from [RFC 4791: Calendaring Extensions to WebDAV](https://www.ietf.org/rfc/rfc4791.txt)
123
125
  RFC4791 = %w(MKCALENDAR)
124
- # HTTP methods from {RFC 5789: PATCH Method for HTTP}[https://www.ietf.org/rfc/rfc5789.txt]
126
+ # HTTP methods from [RFC 5789: PATCH Method for HTTP](https://www.ietf.org/rfc/rfc5789.txt)
125
127
  RFC5789 = %w(PATCH)
126
128
 
127
129
  HTTP_METHODS = RFC2616 + RFC2518 + RFC3253 + RFC3648 + RFC3744 + RFC5323 + RFC4791 + RFC5789
@@ -135,20 +137,19 @@ module ActionDispatch
135
137
 
136
138
  alias raw_request_method request_method # :nodoc:
137
139
 
138
- # Returns the HTTP \method that the application should see.
139
- # In the case where the \method was overridden by a middleware
140
- # (for instance, if a HEAD request was converted to a GET,
141
- # or if a _method parameter was used to determine the \method
142
- # the application should use), this \method returns the overridden
143
- # value, not the original.
140
+ # Returns the HTTP method that the application should see. In the case where the
141
+ # method was overridden by a middleware (for instance, if a HEAD request was
142
+ # converted to a GET, or if a _method parameter was used to determine the method
143
+ # the application should use), this method returns the overridden value, not the
144
+ # original.
144
145
  def request_method
145
146
  @request_method ||= check_method(super)
146
147
  end
147
148
 
148
- # Returns the URI pattern of the matched route for the request,
149
- # using the same format as `bin/rails routes`:
149
+ # Returns the URI pattern of the matched route for the request, using the same
150
+ # format as `bin/rails routes`:
150
151
  #
151
- # request.route_uri_pattern # => "/:controller(/:action(/:id))(.:format)"
152
+ # request.route_uri_pattern # => "/:controller(/:action(/:id))(.:format)"
152
153
  def route_uri_pattern
153
154
  get_header("action_dispatch.route_uri_pattern")
154
155
  end
@@ -196,12 +197,11 @@ module ActionDispatch
196
197
  HTTP_METHOD_LOOKUP[request_method]
197
198
  end
198
199
 
199
- # Returns the original value of the environment's REQUEST_METHOD,
200
- # even if it was overridden by middleware. See #request_method for
201
- # more information.
200
+ # Returns the original value of the environment's REQUEST_METHOD, even if it was
201
+ # overridden by middleware. See #request_method for more information.
202
202
  #
203
- # For debugging purposes, when called with arguments this method will
204
- # fall back to Object#method
203
+ # For debugging purposes, when called with arguments this method will fall back
204
+ # to Object#method
205
205
  def method(*args)
206
206
  if args.empty?
207
207
  @method ||= check_method(
@@ -221,62 +221,61 @@ module ActionDispatch
221
221
 
222
222
  # Provides access to the request's HTTP headers, for example:
223
223
  #
224
- # request.headers["Content-Type"] # => "text/plain"
224
+ # request.headers["Content-Type"] # => "text/plain"
225
225
  def headers
226
226
  @headers ||= Http::Headers.new(self)
227
227
  end
228
228
 
229
- # Early Hints is an HTTP/2 status code that indicates hints to help a client start
230
- # making preparations for processing the final response.
229
+ # Early Hints is an HTTP/2 status code that indicates hints to help a client
230
+ # start making preparations for processing the final response.
231
231
  #
232
- # If the env contains +rack.early_hints+ then the server accepts HTTP2 push for Link headers.
232
+ # If the env contains `rack.early_hints` then the server accepts HTTP2 push for
233
+ # Link headers.
233
234
  #
234
- # The +send_early_hints+ method accepts a hash of links as follows:
235
+ # The `send_early_hints` method accepts a hash of links as follows:
235
236
  #
236
- # send_early_hints("Link" => "</style.css>; rel=preload; as=style\n</script.js>; rel=preload")
237
+ # send_early_hints("Link" => "</style.css>; rel=preload; as=style\n</script.js>; rel=preload")
237
238
  #
238
- # If you are using +javascript_include_tag+ or +stylesheet_link_tag+ the
239
- # Early Hints headers are included by default if supported.
239
+ # If you are using `javascript_include_tag` or `stylesheet_link_tag` the Early
240
+ # Hints headers are included by default if supported.
240
241
  def send_early_hints(links)
241
- return unless env["rack.early_hints"]
242
-
243
- env["rack.early_hints"].call(links)
242
+ env["rack.early_hints"]&.call(links)
244
243
  end
245
244
 
246
- # Returns a +String+ with the last requested path including their params.
245
+ # Returns a `String` with the last requested path including their params.
247
246
  #
248
- # # get '/foo'
249
- # request.original_fullpath # => '/foo'
247
+ # # get '/foo'
248
+ # request.original_fullpath # => '/foo'
250
249
  #
251
- # # get '/foo?bar'
252
- # request.original_fullpath # => '/foo?bar'
250
+ # # get '/foo?bar'
251
+ # request.original_fullpath # => '/foo?bar'
253
252
  def original_fullpath
254
253
  @original_fullpath ||= (get_header("ORIGINAL_FULLPATH") || fullpath)
255
254
  end
256
255
 
257
- # Returns the +String+ full path including params of the last URL requested.
256
+ # Returns the `String` full path including params of the last URL requested.
258
257
  #
259
- # # get "/articles"
260
- # request.fullpath # => "/articles"
258
+ # # get "/articles"
259
+ # request.fullpath # => "/articles"
261
260
  #
262
- # # get "/articles?page=2"
263
- # request.fullpath # => "/articles?page=2"
261
+ # # get "/articles?page=2"
262
+ # request.fullpath # => "/articles?page=2"
264
263
  def fullpath
265
264
  @fullpath ||= super
266
265
  end
267
266
 
268
- # Returns the original request URL as a +String+.
267
+ # Returns the original request URL as a `String`.
269
268
  #
270
- # # get "/articles?page=2"
271
- # request.original_url # => "http://www.example.com/articles?page=2"
269
+ # # get "/articles?page=2"
270
+ # request.original_url # => "http://www.example.com/articles?page=2"
272
271
  def original_url
273
272
  base_url + original_fullpath
274
273
  end
275
274
 
276
- # The +String+ MIME type of the request.
275
+ # The `String` MIME type of the request.
277
276
  #
278
- # # get "/articles"
279
- # request.media_type # => "application/x-www-form-urlencoded"
277
+ # # get "/articles"
278
+ # request.media_type # => "application/x-www-form-urlencoded"
280
279
  def media_type
281
280
  content_mime_type&.to_s
282
281
  end
@@ -287,7 +286,7 @@ module ActionDispatch
287
286
  super.to_i
288
287
  end
289
288
 
290
- # Returns true if the +X-Requested-With+ header contains "XMLHttpRequest"
289
+ # Returns true if the `X-Requested-With` header contains "XMLHttpRequest"
291
290
  # (case-insensitive), which may need to be manually added depending on the
292
291
  # choice of JavaScript libraries and frameworks.
293
292
  def xml_http_request?
@@ -295,13 +294,13 @@ module ActionDispatch
295
294
  end
296
295
  alias :xhr? :xml_http_request?
297
296
 
298
- # Returns the IP address of client as a +String+.
297
+ # Returns the IP address of client as a `String`.
299
298
  def ip
300
299
  @ip ||= super
301
300
  end
302
301
 
303
- # Returns the IP address of client as a +String+,
304
- # usually set by the RemoteIp middleware.
302
+ # Returns the IP address of client as a `String`, usually set by the RemoteIp
303
+ # middleware.
305
304
  def remote_ip
306
305
  @remote_ip ||= (get_header("action_dispatch.remote_ip") || ip).to_s
307
306
  end
@@ -313,12 +312,14 @@ module ActionDispatch
313
312
 
314
313
  ACTION_DISPATCH_REQUEST_ID = "action_dispatch.request_id" # :nodoc:
315
314
 
316
- # Returns the unique request id, which is based on either the +X-Request-Id+ header that can
317
- # be generated by a firewall, load balancer, or web server, or by the RequestId middleware
318
- # (which sets the +action_dispatch.request_id+ environment variable).
315
+ # Returns the unique request id, which is based on either the `X-Request-Id`
316
+ # header that can be generated by a firewall, load balancer, or web server, or
317
+ # by the RequestId middleware (which sets the `action_dispatch.request_id`
318
+ # environment variable).
319
319
  #
320
- # This unique ID is useful for tracing a request from end-to-end as part of logging or debugging.
321
- # This relies on the Rack variable set by the ActionDispatch::RequestId middleware.
320
+ # This unique ID is useful for tracing a request from end-to-end as part of
321
+ # logging or debugging. This relies on the Rack variable set by the
322
+ # ActionDispatch::RequestId middleware.
322
323
  def request_id
323
324
  get_header ACTION_DISPATCH_REQUEST_ID
324
325
  end
@@ -334,8 +335,8 @@ module ActionDispatch
334
335
  (get_header("SERVER_SOFTWARE") && /^([a-zA-Z]+)/ =~ get_header("SERVER_SOFTWARE")) ? $1.downcase : nil
335
336
  end
336
337
 
337
- # Read the request \body. This is useful for web services that need to
338
- # work with raw requests directly.
338
+ # Read the request body. This is useful for web services that need to work with
339
+ # raw requests directly.
339
340
  def raw_post
340
341
  unless has_header? "RAW_POST_DATA"
341
342
  set_header("RAW_POST_DATA", read_body_stream)
@@ -355,14 +356,13 @@ module ActionDispatch
355
356
  end
356
357
  end
357
358
 
358
- # Determine whether the request body contains form-data by checking
359
- # the request +Content-Type+ for one of the media-types:
360
- # +application/x-www-form-urlencoded+ or +multipart/form-data+. The
361
- # list of form-data media types can be modified through the
362
- # +FORM_DATA_MEDIA_TYPES+ array.
359
+ # Determine whether the request body contains form-data by checking the request
360
+ # `Content-Type` for one of the media-types: `application/x-www-form-urlencoded`
361
+ # or `multipart/form-data`. The list of form-data media types can be modified
362
+ # through the `FORM_DATA_MEDIA_TYPES` array.
363
363
  #
364
- # A request body is not assumed to contain form-data when no
365
- # +Content-Type+ header is provided and the request_method is POST.
364
+ # A request body is not assumed to contain form-data when no `Content-Type`
365
+ # header is provided and the request_method is POST.
366
366
  def form_data?
367
367
  FORM_DATA_MEDIA_TYPES.include?(media_type)
368
368
  end
@@ -415,8 +415,8 @@ module ActionDispatch
415
415
  end
416
416
  alias :request_parameters :POST
417
417
 
418
- # Returns the authorization header regardless of whether it was specified directly or through one of the
419
- # proxy alternatives.
418
+ # Returns the authorization header regardless of whether it was specified
419
+ # directly or through one of the proxy alternatives.
420
420
  def authorization
421
421
  get_header("HTTP_AUTHORIZATION") ||
422
422
  get_header("X-HTTP_AUTHORIZATION") ||
@@ -456,7 +456,7 @@ module ActionDispatch
456
456
  private
457
457
  def check_method(name)
458
458
  if name
459
- HTTP_METHOD_LOOKUP[name] || raise(ActionController::UnknownHttpMethod, "#{name}, accepted HTTP methods are #{HTTP_METHODS[0...-1].join(', ')}, and #{HTTP_METHODS[-1]}")
459
+ HTTP_METHOD_LOOKUP[name] || raise(ActionController::UnknownHttpMethod, "#{name}, accepted HTTP methods are #{HTTP_METHODS.to_sentence(locale: false)}")
460
460
  end
461
461
 
462
462
  name
@@ -1,38 +1,40 @@
1
1
  # frozen_string_literal: true
2
2
 
3
+ # :markup: markdown
4
+
3
5
  require "active_support/core_ext/module/attribute_accessors"
4
6
  require "action_dispatch/http/filter_redirect"
5
7
  require "action_dispatch/http/cache"
6
8
  require "monitor"
7
9
 
8
10
  module ActionDispatch # :nodoc:
9
- # = Action Dispatch \Response
11
+ # # Action Dispatch Response
10
12
  #
11
13
  # Represents an HTTP response generated by a controller action. Use it to
12
14
  # retrieve the current state of the response, or customize the response. It can
13
- # either represent a real HTTP response (i.e. one that is meant to be sent
14
- # back to the web browser) or a TestResponse (i.e. one that is generated
15
- # from integration tests).
15
+ # either represent a real HTTP response (i.e. one that is meant to be sent back
16
+ # to the web browser) or a TestResponse (i.e. one that is generated from
17
+ # integration tests).
16
18
  #
17
- # The \Response object for the current request is exposed on controllers as
18
- # ActionController::Metal#response. ActionController::Metal also provides a
19
- # few additional methods that delegate to attributes of the \Response such as
19
+ # The Response object for the current request is exposed on controllers as
20
+ # ActionController::Metal#response. ActionController::Metal also provides a few
21
+ # additional methods that delegate to attributes of the Response such as
20
22
  # ActionController::Metal#headers.
21
23
  #
22
- # Integration tests will likely also want to inspect responses in
23
- # more detail. Methods such as Integration::RequestHelpers#get
24
- # and Integration::RequestHelpers#post return instances of
25
- # TestResponse (which inherits from \Response) for this purpose.
24
+ # Integration tests will likely also want to inspect responses in more detail.
25
+ # Methods such as Integration::RequestHelpers#get and
26
+ # Integration::RequestHelpers#post return instances of TestResponse (which
27
+ # inherits from Response) for this purpose.
26
28
  #
27
29
  # For example, the following demo integration test prints the body of the
28
30
  # controller response to the console:
29
31
  #
30
- # class DemoControllerTest < ActionDispatch::IntegrationTest
31
- # def test_print_root_path_to_console
32
- # get('/')
33
- # puts response.body
34
- # end
35
- # end
32
+ # class DemoControllerTest < ActionDispatch::IntegrationTest
33
+ # def test_print_root_path_to_console
34
+ # get('/')
35
+ # puts response.body
36
+ # end
37
+ # end
36
38
  class Response
37
39
  begin
38
40
  # For `Rack::Headers` (Rack 3+):
@@ -55,17 +57,17 @@ module ActionDispatch # :nodoc:
55
57
 
56
58
  # The headers for the response.
57
59
  #
58
- # header["Content-Type"] # => "text/plain"
59
- # header["Content-Type"] = "application/json"
60
- # header["Content-Type"] # => "application/json"
60
+ # header["Content-Type"] # => "text/plain"
61
+ # header["Content-Type"] = "application/json"
62
+ # header["Content-Type"] # => "application/json"
61
63
  #
62
- # Also aliased as +headers+.
64
+ # Also aliased as `headers`.
63
65
  #
64
- # headers["Content-Type"] # => "text/plain"
65
- # headers["Content-Type"] = "application/json"
66
- # headers["Content-Type"] # => "application/json"
66
+ # headers["Content-Type"] # => "text/plain"
67
+ # headers["Content-Type"] = "application/json"
68
+ # headers["Content-Type"] # => "application/json"
67
69
  #
68
- # Also aliased as +header+ for compatibility.
70
+ # Also aliased as `header` for compatibility.
69
71
  attr_reader :headers
70
72
 
71
73
  alias_method :header, :headers
@@ -234,13 +236,13 @@ module ActionDispatch # :nodoc:
234
236
  @status = Rack::Utils.status_code(status)
235
237
  end
236
238
 
237
- # Sets the HTTP response's content MIME type. For example, in the controller
238
- # you could write this:
239
+ # Sets the HTTP response's content MIME type. For example, in the controller you
240
+ # could write this:
239
241
  #
240
- # response.content_type = "text/plain"
242
+ # response.content_type = "text/plain"
241
243
  #
242
- # If a character set has been defined for this response (see charset=) then
243
- # the character set information will also be included in the content type
244
+ # If a character set has been defined for this response (see charset=) then the
245
+ # character set information will also be included in the content type
244
246
  # information.
245
247
  def content_type=(content_type)
246
248
  return unless content_type
@@ -267,11 +269,11 @@ module ActionDispatch # :nodoc:
267
269
  end
268
270
  end
269
271
 
270
- # Sets the HTTP character set. In case of +nil+ parameter
271
- # it sets the charset to +default_charset+.
272
+ # Sets the HTTP character set. In case of `nil` parameter it sets the charset to
273
+ # `default_charset`.
272
274
  #
273
- # response.charset = 'utf-16' # => 'utf-16'
274
- # response.charset = nil # => 'utf-8'
275
+ # response.charset = 'utf-16' # => 'utf-16'
276
+ # response.charset = nil # => 'utf-8'
275
277
  def charset=(charset)
276
278
  content_type = parsed_content_type_header.mime_type
277
279
  if false == charset
@@ -281,8 +283,8 @@ module ActionDispatch # :nodoc:
281
283
  end
282
284
  end
283
285
 
284
- # The charset of the response. HTML wants to know the encoding of the
285
- # content you're giving them, so we need to send that along.
286
+ # The charset of the response. HTML wants to know the encoding of the content
287
+ # you're giving them, so we need to send that along.
286
288
  def charset
287
289
  header_info = parsed_content_type_header
288
290
  header_info.charset || self.class.default_charset
@@ -293,26 +295,26 @@ module ActionDispatch # :nodoc:
293
295
  @status
294
296
  end
295
297
 
296
- # Returns a string to ensure compatibility with +Net::HTTPResponse+.
298
+ # Returns a string to ensure compatibility with `Net::HTTPResponse`.
297
299
  def code
298
300
  @status.to_s
299
301
  end
300
302
 
301
303
  # Returns the corresponding message for the current HTTP status code:
302
304
  #
303
- # response.status = 200
304
- # response.message # => "OK"
305
+ # response.status = 200
306
+ # response.message # => "OK"
305
307
  #
306
- # response.status = 404
307
- # response.message # => "Not Found"
308
+ # response.status = 404
309
+ # response.message # => "Not Found"
308
310
  #
309
311
  def message
310
312
  Rack::Utils::HTTP_STATUS_CODES[@status]
311
313
  end
312
314
  alias_method :status_message, :message
313
315
 
314
- # Returns the content of the response as a string. This contains the contents
315
- # of any calls to <tt>render</tt>.
316
+ # Returns the content of the response as a string. This contains the contents of
317
+ # any calls to `render`.
316
318
  def body
317
319
  @stream.body
318
320
  end
@@ -332,9 +334,9 @@ module ActionDispatch # :nodoc:
332
334
  end
333
335
  end
334
336
 
335
- # Avoid having to pass an open file handle as the response body.
336
- # Rack::Sendfile will usually intercept the response and uses
337
- # the path directly, so there is no reason to open the file.
337
+ # Avoid having to pass an open file handle as the response body. Rack::Sendfile
338
+ # will usually intercept the response and uses the path directly, so there is no
339
+ # reason to open the file.
338
340
  class FileBody # :nodoc:
339
341
  attr_reader :to_path
340
342
 
@@ -356,7 +358,7 @@ module ActionDispatch # :nodoc:
356
358
  end
357
359
  end
358
360
 
359
- # Send the file stored at +path+ as the response body.
361
+ # Send the file stored at `path` as the response body.
360
362
  def send_file(path)
361
363
  commit!
362
364
  @stream = FileBody.new(path)
@@ -383,17 +385,16 @@ module ActionDispatch # :nodoc:
383
385
  if stream.respond_to?(:abort)
384
386
  stream.abort
385
387
  elsif stream.respond_to?(:close)
386
- # `stream.close` should really be reserved for a close from the
387
- # other direction, but we must fall back to it for
388
- # compatibility.
388
+ # `stream.close` should really be reserved for a close from the other direction,
389
+ # but we must fall back to it for compatibility.
389
390
  stream.close
390
391
  end
391
392
  end
392
393
 
393
- # Turns the Response into a Rack-compatible array of the status, headers,
394
- # and body. Allows explicit splatting:
394
+ # Turns the Response into a Rack-compatible array of the status, headers, and
395
+ # body. Allows explicit splatting:
395
396
  #
396
- # status, headers, body = *response
397
+ # status, headers, body = *response
397
398
  def to_a
398
399
  commit!
399
400
  rack_response @status, @headers.to_hash
@@ -402,7 +403,7 @@ module ActionDispatch # :nodoc:
402
403
 
403
404
  # Returns the response cookies, converted to a Hash of (name => value) pairs
404
405
  #
405
- # assert_equal 'AuthorOfNewPage', r.cookies['author']
406
+ # assert_equal 'AuthorOfNewPage', r.cookies['author']
406
407
  def cookies
407
408
  cookies = {}
408
409
  if header = get_header(SET_COOKIE)
@@ -456,11 +457,10 @@ module ActionDispatch # :nodoc:
456
457
  end
457
458
 
458
459
  def before_sending
459
- # Normally we've already committed by now, but it's possible
460
- # (e.g., if the controller action tries to read back its own
461
- # response) to get here before that. In that case, we must force
462
- # an "early" commit: we're about to freeze the headers, so this is
463
- # our last chance.
460
+ # Normally we've already committed by now, but it's possible (e.g., if the
461
+ # controller action tries to read back its own response) to get here before
462
+ # that. In that case, we must force an "early" commit: we're about to freeze the
463
+ # headers, so this is our last chance.
464
464
  commit! unless committed?
465
465
 
466
466
  @request.commit_cookie_jar! unless committed?
@@ -488,8 +488,8 @@ module ActionDispatch # :nodoc:
488
488
  end
489
489
 
490
490
  def close
491
- # Rack "close" maps to Response#abort, and *not* Response#close
492
- # (which is used when the controller's finished writing)
491
+ # Rack "close" maps to Response#abort, and **not** Response#close (which is used
492
+ # when the controller's finished writing)
493
493
  @response.abort
494
494
  end
495
495