rack 2.2.19 → 3.0.0.beta1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


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

Files changed (85) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +134 -154
  3. data/CONTRIBUTING.md +53 -47
  4. data/MIT-LICENSE +1 -1
  5. data/README.md +287 -0
  6. data/Rakefile +40 -7
  7. data/SPEC.rdoc +166 -125
  8. data/contrib/LICENSE.md +7 -0
  9. data/contrib/logo.webp +0 -0
  10. data/lib/rack/auth/abstract/handler.rb +3 -1
  11. data/lib/rack/auth/abstract/request.rb +3 -1
  12. data/lib/rack/auth/basic.rb +2 -1
  13. data/lib/rack/auth/digest/md5.rb +1 -131
  14. data/lib/rack/auth/digest/nonce.rb +1 -53
  15. data/lib/rack/auth/digest/params.rb +1 -54
  16. data/lib/rack/auth/digest/request.rb +1 -43
  17. data/lib/rack/auth/digest.rb +256 -0
  18. data/lib/rack/body_proxy.rb +3 -1
  19. data/lib/rack/builder.rb +60 -42
  20. data/lib/rack/cascade.rb +2 -0
  21. data/lib/rack/chunked.rb +16 -13
  22. data/lib/rack/common_logger.rb +24 -20
  23. data/lib/rack/conditional_get.rb +18 -15
  24. data/lib/rack/constants.rb +62 -0
  25. data/lib/rack/content_length.rb +12 -16
  26. data/lib/rack/content_type.rb +8 -5
  27. data/lib/rack/deflater.rb +40 -26
  28. data/lib/rack/directory.rb +9 -3
  29. data/lib/rack/etag.rb +14 -23
  30. data/lib/rack/events.rb +4 -0
  31. data/lib/rack/file.rb +2 -0
  32. data/lib/rack/files.rb +15 -17
  33. data/lib/rack/head.rb +9 -8
  34. data/lib/rack/headers.rb +154 -0
  35. data/lib/rack/lint.rb +740 -649
  36. data/lib/rack/lock.rb +2 -5
  37. data/lib/rack/logger.rb +2 -0
  38. data/lib/rack/media_type.rb +7 -17
  39. data/lib/rack/method_override.rb +5 -1
  40. data/lib/rack/mime.rb +8 -0
  41. data/lib/rack/mock.rb +1 -300
  42. data/lib/rack/mock_request.rb +166 -0
  43. data/lib/rack/mock_response.rb +124 -0
  44. data/lib/rack/multipart/generator.rb +7 -5
  45. data/lib/rack/multipart/parser.rb +121 -139
  46. data/lib/rack/multipart/uploaded_file.rb +4 -0
  47. data/lib/rack/multipart.rb +20 -40
  48. data/lib/rack/null_logger.rb +9 -0
  49. data/lib/rack/query_parser.rb +78 -89
  50. data/lib/rack/recursive.rb +2 -0
  51. data/lib/rack/reloader.rb +0 -2
  52. data/lib/rack/request.rb +189 -91
  53. data/lib/rack/response.rb +131 -61
  54. data/lib/rack/rewindable_input.rb +24 -5
  55. data/lib/rack/runtime.rb +7 -6
  56. data/lib/rack/sendfile.rb +31 -26
  57. data/lib/rack/show_exceptions.rb +15 -2
  58. data/lib/rack/show_status.rb +17 -7
  59. data/lib/rack/static.rb +9 -10
  60. data/lib/rack/tempfile_reaper.rb +15 -4
  61. data/lib/rack/urlmap.rb +4 -2
  62. data/lib/rack/utils.rb +212 -202
  63. data/lib/rack/version.rb +9 -4
  64. data/lib/rack.rb +5 -76
  65. data/rack.gemspec +6 -6
  66. metadata +22 -31
  67. data/README.rdoc +0 -355
  68. data/bin/rackup +0 -5
  69. data/contrib/rack.png +0 -0
  70. data/contrib/rack.svg +0 -150
  71. data/contrib/rack_logo.svg +0 -164
  72. data/lib/rack/core_ext/regexp.rb +0 -14
  73. data/lib/rack/handler/cgi.rb +0 -59
  74. data/lib/rack/handler/fastcgi.rb +0 -100
  75. data/lib/rack/handler/lsws.rb +0 -61
  76. data/lib/rack/handler/scgi.rb +0 -71
  77. data/lib/rack/handler/thin.rb +0 -34
  78. data/lib/rack/handler/webrick.rb +0 -129
  79. data/lib/rack/handler.rb +0 -104
  80. data/lib/rack/lobster.rb +0 -70
  81. data/lib/rack/server.rb +0 -466
  82. data/lib/rack/session/abstract/id.rb +0 -523
  83. data/lib/rack/session/cookie.rb +0 -203
  84. data/lib/rack/session/memcache.rb +0 -10
  85. data/lib/rack/session/pool.rb +0 -90
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 9820e6a4dc433010b3485104b374fc20188e1d673474b420b47fdccbf7bf3273
4
- data.tar.gz: 4f77be4b3508523430c3aad81bfe70d0649941697f9c2dde9aafe7a11deef845
3
+ metadata.gz: c00d25e61799cf92d1dd7c93c509d0e537a13e57cc5f1c9eacae3b8ed1213058
4
+ data.tar.gz: 6a869c95cf9265c132964d442a2a5a9cd90d509141e2367734ba1a8e4c76e52a
5
5
  SHA512:
6
- metadata.gz: d5774f686721d535e104f96b7e50b1245593ce5e12df78a8ec401ccfb24e3787726b5417c5c82b1f9f0da0b4278a5e6b663b2df176fc0c16926eda3016cde10d
7
- data.tar.gz: 2f5017277afb7baea14f73d015801a220c416202b6da76fd3c30bddb6bf6bd3abdefa1f0064097d6bcaaa0e60351b701cf4c82f0ff5da0d18e7ddfa0b924863e
6
+ metadata.gz: a6c73233201ddc9a409768b85486a3cc3f87da09daa274e5a73ddbb96b18aaad5ab73d956b8971cd2d2ac1518b42af9ebdb05bd6d5254136f62f28f691ff653a
7
+ data.tar.gz: fe51a0a1cca6a31083abf4670e09c292c234409c45adc12ef1a27d35902edcd2d135cbdb94f0b76290e8b02fea865d6690fbc10cc037a58046e15346f923a2d7
data/CHANGELOG.md CHANGED
@@ -2,102 +2,77 @@
2
2
 
3
3
  All notable changes to this project will be documented in this file. For info on how to format all future additions to this file please reference [Keep A Changelog](https://keepachangelog.com/en/1.0.0/).
4
4
 
5
- ## [2.2.19] - 2025-10-07
5
+ ## [3.0.0.beta1] - 2022-08-08
6
6
 
7
7
  ### Security
8
8
 
9
- - [CVE-2025-61772](https://github.com/advisories/GHSA-wpv5-97wm-hp9c) Multipart parser buffers unbounded per-part headers, enabling DoS (memory exhaustion)
10
- - [CVE-2025-61771](https://github.com/advisories/GHSA-w9pc-fmgc-vxvw) Multipart parser buffers large non‑file fields entirely in memory, enabling DoS (memory exhaustion)
11
- - [CVE-2025-61770](https://github.com/advisories/GHSA-p543-xpfm-54cp) Unbounded multipart preamble buffering enables DoS (memory exhaustion)
9
+ - Do not use semicolon as GET parameter separator. ([#1733](https://github.com/rack/rack/pull/1733), [@jeremyevans])
12
10
 
13
- ## [2.2.18] - 2025-09-25
14
-
15
- ### Security
16
-
17
- - [CVE-2025-59830](https://github.com/rack/rack/security/advisories/GHSA-625h-95r8-8xpm) Unbounded parameter parsing in `Rack::QueryParser` can lead to memory exhaustion via semicolon-separated parameters.
18
-
19
- ## [2.2.17] - 2025-06-03
20
-
21
- - Backport `Rack::MediaType#params` now handles parameters without values. ([#2263](https://github.com/rack/rack/pull/2263), [@AllyMarthaJ](https://github.com/AllyMarthaJ))
22
-
23
- ## [2.2.16] - 2025-05-22
24
-
25
- - Fix incorrect backport of optional `CGI::Cookie` support. ([#2335](https://github.com/rack/rack/pull/2335), [@jeremyevans])
26
-
27
- ## [2.2.15] - 2025-05-18
28
-
29
- - Optional support for `CGI::Cookie` if not available. ([#2327](https://github.com/rack/rack/pull/2327), [#2333](https://github.com/rack/rack/pull/2333), [@earlopain])
30
-
31
- ## [2.2.14] - 2025-05-06
32
-
33
- ### Security
34
-
35
- - [CVE-2025-32441](https://github.com/rack/rack/security/advisories/GHSA-vpfw-47h7-xj4g) Rack session can be restored after deletion.
36
- - [CVE-2025-46727](https://github.com/rack/rack/security/advisories/GHSA-gjh7-p2fx-99vx) Unbounded parameter parsing in `Rack::QueryParser` can lead to memory exhaustion.
37
-
38
- ## [2.2.13] - 2025-03-11
39
-
40
- ### Security
41
-
42
- - [CVE-2025-27610](https://github.com/rack/rack/security/advisories/GHSA-7wqh-767x-r66v) Local file inclusion in `Rack::Static`.
43
-
44
- ## [2.2.12] - 2025-03-04
45
-
46
- ### Security
47
-
48
- - [CVE-2025-27111](https://github.com/rack/rack/security/advisories/GHSA-8cgq-6mh2-7j6v) Possible Log Injection in `Rack::Sendfile`.
49
-
50
- ## [2.2.11] - 2025-02-12
51
-
52
- ### Security
53
-
54
- - [CVE-2025-25184](https://github.com/rack/rack/security/advisories/GHSA-7g2v-jj9q-g3rg) Possible Log Injection in `Rack::CommonLogger`.
55
-
56
- ## [2.2.10] - 2024-10-14
57
-
58
- - Fix compatibility issues with Ruby v3.4.0. ([#2248](https://github.com/rack/rack/pull/2248), [@byroot](https://github.com/byroot))
59
-
60
- ## [2.2.9] - 2023-03-21
61
-
62
- - Return empty when parsing a multi-part POST with only one end delimiter. ([#2104](https://github.com/rack/rack/pull/2104), [@alpaca-tc])
63
-
64
- ## [2.2.8] - 2023-07-31
65
-
66
- - Regenerate SPEC ([#2102](https://github.com/rack/rack/pull/2102), [@skipkayhil](https://github.com/skipkayhil))
67
- - Limit file extension length of multipart tempfiles ([#2015](https://github.com/rack/rack/pull/2015), [@dentarg](https://github.com/dentarg))
68
- - Fix "undefined method DelegateClass for Rack::Session::Cookie:Class" ([#2092](https://github.com/rack/rack/pull/2092), [@onigra](https://github.com/onigra) [@dchandekstark](https://github.com/dchandekstark))
69
-
70
- ## [2.2.7] - 2023-03-13
71
-
72
- - Correct the year number in the changelog ([#2015](https://github.com/rack/rack/pull/2015), [@kimulab](https://github.com/kimulab))
73
- - Support underscore in host names for Rack 2.2 (Fixes [#2070](https://github.com/rack/rack/issues/2070)) ([#2015](https://github.com/rack/rack/pull/2071), [@jeremyevans](https://github.com/jeremyevans))
74
-
75
- ## [2.2.6.4] - 2023-03-13
76
-
77
- - [CVE-2023-27539] Avoid ReDoS in header parsing
78
-
79
- ## [2.2.6.3] - 2023-03-02
80
-
81
- - [CVE-2023-27530] Introduce multipart_total_part_limit to limit total parts
11
+ ### SPEC Changes
82
12
 
83
- ## [2.2.6.2] - 2023-01-17
13
+ - Response array must now be non-frozen.
14
+ - Response `status` must now be an integer greater than or equal to 100.
15
+ - Response `headers` must now be an unfrozen hash.
16
+ - Response header keys can no longer include uppercase characters.
17
+ - Response header values can be an `Array` to handle multiple values (and no longer supports `\n` encoded headers).
18
+ - Response body can now respond to `#call` (streaming body) instead of `#each` (enumerable body), for the equivalent of response hijacking in previous versions.
19
+ - Middleware must no longer call `#each` on the body, but they can call `#to_ary` on the body if it responds to `#to_ary`.
20
+ - `rack.input` is no longer required to be rewindable.
21
+ - `rack.multithread`/`rack.multiprocess`/`rack.run_once`/`rack.version` are no longer required environment keys.
22
+ - `SERVER_PROTOCOL` is now a required key, matching the HTTP protocol used in the request.
23
+ - `rack.hijack?` (partial hijack) and `rack.hijack` (full hijack) are now independently optional.
24
+ - `rack.hijack_io` has been removed completely.
84
25
 
85
- - [CVE-2022-44570] Fix ReDoS in Rack::Utils.get_byte_ranges
26
+ ### Removed
86
27
 
87
- ## [2.2.6.1] - 2023-01-17
28
+ - Remove `rack.multithread`/`rack.multiprocess`/`rack.run_once`. These variables generally come too late to be useful. ([#1720](https://github.com/rack/rack/pull/1720), [@ioquatix], [@jeremyevans]))
29
+ - Remove deprecated Rack::Request::SCHEME_WHITELIST. ([@jeremyevans])
30
+ - Remove internal cookie deletion using pattern matching, there are very few practical cases where it would be useful and browsers handle it correctly without us doing anything special. ([#1844](https://github.com/rack/rack/pull/1844), [@ioquatix])
31
+ - Remove `rack.version` as it comes too late to be useful. ([#1938](https://github.com/rack/rack/pull/1938), [@ioquatix])
32
+ - Extract `rackup` command, `Rack::Server`, `Rack::Handler` and related code into a separate gem. ([#1937](https://github.com/rack/rack/pull/1937), [@ioquatix])
88
33
 
89
- - [CVE-2022-44571] Fix ReDoS vulnerability in multipart parser
90
- - [CVE-2022-44572] Forbid control characters in attributes (also ReDoS)
34
+ ### Added
91
35
 
92
- ## [2.2.6] - 2023-01-17
36
+ - `Rack::Headers` added to support lower-case header keys. ([@jeremyevans])
37
+ - `Rack::Utils#set_cookie_header` now supports `escape_key: false` to avoid key escaping. ([@jeremyevans])
38
+ - `Rack::RewindableInput` supports size. ([@ahorek](https://github.com/ahorek))
39
+ - `Rack::RewindableInput::Middleware` added for making `rack.input` rewindable. ([@jeremyevans])
40
+ - The RFC 7239 Forwarded header is now supported and considered by default when looking for information on forwarding, falling back to the X-Forwarded-* headers. `Rack::Request.forwarded_priority` accessor has been added for configuring the priority of which header to check. ([#1423](https://github.com/rack/rack/issues/1423), [@jeremyevans])
41
+ - Allow response headers to contain array of values. ([#1598](https://github.com/rack/rack/issues/1598), [@ioquatix])
42
+ - Support callable body for explicit streaming support and clarify streaming response body behaviour. ([#1745](https://github.com/rack/rack/pull/1745), [@ioquatix], [#1748](https://github.com/rack/rack/pull/1748), [@wjordan])
43
+ - Allow `Rack::Builder#run` to take a block instead of an argument. ([#1942](https://github.com/rack/rack/pull/1942), [@ioquatix])
93
44
 
94
- - Extend `Rack::MethodOverride` to handle `QueryParser::ParamsTooDeepError` error. ([#2011](https://github.com/rack/rack/pull/2011), [@byroot](https://github.com/byroot))
45
+ ### Changed
95
46
 
96
- ## [2.2.5] - 2022-12-27
47
+ - BREAKING CHANGE: Require `status` to be an Integer. ([#1662](https://github.com/rack/rack/pull/1662), [@olleolleolle](https://github.com/olleolleolle))
48
+ - BREAKING CHANGE: Query parsing now treats parameters without `=` as having the empty string value instead of nil value, to conform to the URL spec. ([#1696](https://github.com/rack/rack/issues/1696), [@jeremyevans])
49
+ - Relax validations around `Rack::Request#host` and `Rack::Request#hostname`. ([#1606](https://github.com/rack/rack/issues/1606), [@pvande](https://github.com/pvande))
50
+ - Removed antiquated handlers: FCGI, LSWS, SCGI, Thin. ([#1658](https://github.com/rack/rack/pull/1658), [@ioquatix])
51
+ - Removed options from `Rack::Builder.parse_file` and `Rack::Builder.load_file`. ([#1663](https://github.com/rack/rack/pull/1663), [@ioquatix])
52
+ - `Rack::HTTP_VERSION` has been removed and the `HTTP_VERSION` env setting is no longer set in the CGI and Webrick handlers. ([#970](https://github.com/rack/rack/issues/970), [@jeremyevans])
53
+ - `Rack::Request#[]` and `#[]=` now warn even in non-verbose mode. ([#1277](https://github.com/rack/rack/issues/1277), [@jeremyevans])
54
+ - Decrease default allowed parameter recursion level from 100 to 32. ([#1640](https://github.com/rack/rack/issues/1640), [@jeremyevans])
55
+ - Attempting to parse a multipart response with an empty body now raises Rack::Multipart::EmptyContentError. ([#1603](https://github.com/rack/rack/issues/1603), [@jeremyevans])
56
+ - `Rack::Utils.secure_compare` uses OpenSSL's faster implementation if available. ([#1711](https://github.com/rack/rack/pull/1711), [@bdewater](https://github.com/bdewater))
57
+ - `Rack::Request#POST` now caches an empty hash if input content type is not parseable. ([#749](https://github.com/rack/rack/pull/749), [@jeremyevans])
58
+ - BREAKING CHANGE: Updated `trusted_proxy?` to match full 127.0.0.0/8 network. ([#1781](https://github.com/rack/rack/pull/1781), [@snbloch](https://github.com/snbloch))
59
+ - Explicitly deprecate `Rack::File` which was an alias for `Rack::Files`. ([#1811](https://github.com/rack/rack/pull/1720), [@ioquatix]).
60
+ - Moved `Rack::Session` into [separate gem](https://github.com/rack/rack-session). ([#1805](https://github.com/rack/rack/pull/1805), [@ioquatix])
61
+ - `rackup -D` option to daemonizes no longer changes the working directory to the root. ([#1813](https://github.com/rack/rack/pull/1813), [@jeremyevans])
62
+ - The `x-forwarded-proto` header is now considered before the `x-forwarded-scheme` header for determining the forwarded protocol. `Rack::Request.x_forwarded_proto_priority` accessor has been added for configuring the priority of which header to check. ([#1809](https://github.com/rack/rack/issues/1809), [@jeremyevans])
63
+ - `Rack::Request.forwarded_authority` (and methods that call it, such as `host`) now returns the last authority in the forwarded header, instead of the first, as earlier forwarded authorities can be forged by clients. This restores the Rack 2.1 behavior. ([#1829](https://github.com/rack/rack/issues/1809), [@jeremyevans])
64
+ - Use lower case cookie attributes when creating cookies, and fold cookie attributes to lower case when reading cookies (specifically impacting `secure` and `httponly` attributes). ([#1849](https://github.com/rack/rack/pull/1849), [@ioquatix])
65
+ - The response array must now be mutable (non-frozen) so middleware can modify it without allocating a new Array,therefore reducing object allocations. ([#1887](https://github.com/rack/rack/pull/1887), [#1927](https://github.com/rack/rack/pull/1927), [@amatsuda], [@ioquatix])
66
+ - `rack.hijack?` (partial hijack) and `rack.hijack` (full hijack) are now independently optional. `rack.hijack_io` is no longer required/specified. ([#1939](https://github.com/rack/rack/pull/1939), [@ioquatix])
97
67
 
98
68
  ### Fixed
99
69
 
100
- - `Rack::URLMap` uses non-deprecated form of `Regexp.new`. ([#1998](https://github.com/rack/rack/pull/1998), [@weizheheng](https://github.com/weizheheng))
70
+ - Make Rack::MockResponse handle non-hash headers. ([#1629](https://github.com/rack/rack/issues/1629), [@jeremyevans])
71
+ - TempfileReaper now deletes temp files if application raises an exception. ([#1679](https://github.com/rack/rack/issues/1679), [@jeremyevans])
72
+ - Handle cookies with values that end in '=' ([#1645](https://github.com/rack/rack/pull/1645), [@lukaso](https://github.com/lukaso))
73
+ - Make `Rack::NullLogger` respond to `#fatal!` [@jeremyevans])
74
+ - Fix multipart filename generation for filenames that contain spaces. Encode spaces as "%20" instead of "+" which will be decoded properly by the multipart parser. ([#1736](https://github.com/rack/rack/pull/1645), [@muirdm](https://github.com/muirdm))
75
+ - `Rack::Request#scheme` returns `ws` or `wss` when one of the `X-Forwarded-Scheme` / `X-Forwarded-Proto` headers is set to `ws` or `wss`, respectively. ([#1730](https://github.com/rack/rack/issues/1730), [@erwanst](https://github.com/erwanst))
101
76
 
102
77
  ## [2.2.4] - 2022-06-30
103
78
 
@@ -106,23 +81,21 @@ All notable changes to this project will be documented in this file. For info on
106
81
 
107
82
  ## [2.2.3.1] - 2022-05-27
108
83
 
109
- ### Security
110
-
111
84
  - [CVE-2022-30123] Fix shell escaping issue in Common Logger
112
85
  - [CVE-2022-30122] Restrict parsing of broken MIME attachments
113
86
 
114
- ## [2.2.3] - 2020-02-11
87
+ ## [2.2.3] - 2020-06-15
115
88
 
116
89
  ### Security
117
90
 
118
- - [CVE-2020-8184] Only decode cookie values
91
+ - [[CVE-2020-8184](https://nvd.nist.gov/vuln/detail/CVE-2020-8184)] Do not allow percent-encoded cookie name to override existing cookie names. BREAKING CHANGE: Accessing cookie names that require URL encoding with decoded name no longer works. ([@fletchto99](https://github.com/fletchto99))
119
92
 
120
93
  ## [2.2.2] - 2020-02-11
121
94
 
122
95
  ### Fixed
123
96
 
124
- - Fix incorrect `Rack::Request#host` value. ([#1591](https://github.com/rack/rack/pull/1591), [@ioquatix](https://github.com/ioquatix))
125
- - Revert `Rack::Handler::Thin` implementation. ([#1583](https://github.com/rack/rack/pull/1583), [@jeremyevans](https://github.com/jeremyevans))
97
+ - Fix incorrect `Rack::Request#host` value. ([#1591](https://github.com/rack/rack/pull/1591), [@ioquatix])
98
+ - Revert `Rack::Handler::Thin` implementation. ([#1583](https://github.com/rack/rack/pull/1583), [@jeremyevans])
126
99
  - Double assignment is still needed to prevent an "unused variable" warning. ([#1589](https://github.com/rack/rack/pull/1589), [@kamipo](https://github.com/kamipo))
127
100
  - Fix to handle same_site option for session pool. ([#1587](https://github.com/rack/rack/pull/1587), [@kamipo](https://github.com/kamipo))
128
101
 
@@ -130,105 +103,111 @@ All notable changes to this project will be documented in this file. For info on
130
103
 
131
104
  ### Fixed
132
105
 
133
- - Rework `Rack::Request#ip` to handle empty `forwarded_for`. ([#1577](https://github.com/rack/rack/pull/1577), [@ioquatix](https://github.com/ioquatix))
106
+ - Rework `Rack::Request#ip` to handle empty `forwarded_for`. ([#1577](https://github.com/rack/rack/pull/1577), [@ioquatix])
134
107
 
135
108
  ## [2.2.0] - 2020-02-08
136
109
 
137
110
  ### SPEC Changes
138
111
 
139
- - `rack.session` request environment entry must respond to `to_hash` and return unfrozen Hash. ([@jeremyevans](https://github.com/jeremyevans))
140
- - Request environment cannot be frozen. ([@jeremyevans](https://github.com/jeremyevans))
141
- - CGI values in the request environment with non-ASCII characters must use ASCII-8BIT encoding. ([@jeremyevans](https://github.com/jeremyevans))
142
- - Improve SPEC/lint relating to SERVER_NAME, SERVER_PORT and HTTP_HOST. ([#1561](https://github.com/rack/rack/pull/1561), [@ioquatix](https://github.com/ioquatix))
112
+ - `rack.session` request environment entry must respond to `to_hash` and return unfrozen Hash. ([@jeremyevans])
113
+ - Request environment cannot be frozen. ([@jeremyevans])
114
+ - CGI values in the request environment with non-ASCII characters must use ASCII-8BIT encoding. ([@jeremyevans])
115
+ - Improve SPEC/lint relating to SERVER_NAME, SERVER_PORT and HTTP_HOST. ([#1561](https://github.com/rack/rack/pull/1561), [@ioquatix])
143
116
 
144
117
  ### Added
145
118
 
146
- - `rackup` supports multiple `-r` options and will require all arguments. ([@jeremyevans](https://github.com/jeremyevans))
119
+ - `rackup` supports multiple `-r` options and will require all arguments. ([@jeremyevans])
147
120
  - `Server` supports an array of paths to require for the `:require` option. ([@khotta](https://github.com/khotta))
148
121
  - `Files` supports multipart range requests. ([@fatkodima](https://github.com/fatkodima))
149
- - `Multipart::UploadedFile` supports an IO-like object instead of using the filesystem, using `:filename` and `:io` options. ([@jeremyevans](https://github.com/jeremyevans))
150
- - `Multipart::UploadedFile` supports keyword arguments `:path`, `:content_type`, and `:binary` in addition to positional arguments. ([@jeremyevans](https://github.com/jeremyevans))
151
- - `Static` supports a `:cascade` option for calling the app if there is no matching file. ([@jeremyevans](https://github.com/jeremyevans))
152
- - `Session::Abstract::SessionHash#dig`. ([@jeremyevans](https://github.com/jeremyevans))
153
- - `Response.[]` and `MockResponse.[]` for creating instances using status, headers, and body. ([@ioquatix](https://github.com/ioquatix))
154
- - Convenient cache and content type methods for `Rack::Response`. ([#1555](https://github.com/rack/rack/pull/1555), [@ioquatix](https://github.com/ioquatix))
122
+ - `Multipart::UploadedFile` supports an IO-like object instead of using the filesystem, using `:filename` and `:io` options. ([@jeremyevans])
123
+ - `Multipart::UploadedFile` supports keyword arguments `:path`, `:content_type`, and `:binary` in addition to positional arguments. ([@jeremyevans])
124
+ - `Static` supports a `:cascade` option for calling the app if there is no matching file. ([@jeremyevans])
125
+ - `Session::Abstract::SessionHash#dig`. ([@jeremyevans])
126
+ - `Response.[]` and `MockResponse.[]` for creating instances using status, headers, and body. ([@ioquatix])
127
+ - Convenient cache and content type methods for `Rack::Response`. ([#1555](https://github.com/rack/rack/pull/1555), [@ioquatix])
155
128
 
156
129
  ### Changed
157
130
 
158
- - `Request#params` no longer rescues EOFError. ([@jeremyevans](https://github.com/jeremyevans))
159
- - `Directory` uses a streaming approach, significantly improving time to first byte for large directories. ([@jeremyevans](https://github.com/jeremyevans))
160
- - `Directory` no longer includes a Parent directory link in the root directory index. ([@jeremyevans](https://github.com/jeremyevans))
161
- - `QueryParser#parse_nested_query` uses original backtrace when reraising exception with new class. ([@jeremyevans](https://github.com/jeremyevans))
162
- - `ConditionalGet` follows RFC 7232 precedence if both If-None-Match and If-Modified-Since headers are provided. ([@jeremyevans](https://github.com/jeremyevans))
131
+ - `Request#params` no longer rescues EOFError. ([@jeremyevans])
132
+ - `Directory` uses a streaming approach, significantly improving time to first byte for large directories. ([@jeremyevans])
133
+ - `Directory` no longer includes a Parent directory link in the root directory index. ([@jeremyevans])
134
+ - `QueryParser#parse_nested_query` uses original backtrace when reraising exception with new class. ([@jeremyevans])
135
+ - `ConditionalGet` follows RFC 7232 precedence if both If-None-Match and If-Modified-Since headers are provided. ([@jeremyevans])
163
136
  - `.ru` files supports the `frozen-string-literal` magic comment. ([@eregon](https://github.com/eregon))
164
- - Rely on autoload to load constants instead of requiring internal files, make sure to require 'rack' and not just 'rack/...'. ([@jeremyevans](https://github.com/jeremyevans))
165
- - `Etag` will continue sending ETag even if the response should not be cached. ([@henm](https://github.com/henm))
137
+ - Rely on autoload to load constants instead of requiring internal files, make sure to require 'rack' and not just 'rack/...'. ([@jeremyevans])
138
+ - BREAKING CHANGE: `Etag` will continue sending ETag even if the response should not be cached. Streaming no longer works without a workaround, see [#1619](https://github.com/rack/rack/issues/1619#issuecomment-848460528). ([@henm](https://github.com/henm))
166
139
  - `Request#host_with_port` no longer includes a colon for a missing or empty port. ([@AlexWayfer](https://github.com/AlexWayfer))
167
- - All handlers uses keywords arguments instead of an options hash argument. ([@ioquatix](https://github.com/ioquatix))
168
- - `Files` handling of range requests no longer return a body that supports `to_path`, to ensure range requests are handled correctly. ([@jeremyevans](https://github.com/jeremyevans))
169
- - `Multipart::Generator` only includes `Content-Length` for files with paths, and `Content-Disposition` `filename` if the `UploadedFile` instance has one. ([@jeremyevans](https://github.com/jeremyevans))
170
- - `Request#ssl?` is true for the `wss` scheme (secure websockets). ([@jeremyevans](https://github.com/jeremyevans))
171
- - `Rack::HeaderHash` is memoized by default. ([#1549](https://github.com/rack/rack/pull/1549), [@ioquatix](https://github.com/ioquatix))
140
+ - All handlers uses keywords arguments instead of an options hash argument. ([@ioquatix])
141
+ - `Files` handling of range requests no longer return a body that supports `to_path`, to ensure range requests are handled correctly. ([@jeremyevans])
142
+ - `Multipart::Generator` only includes `Content-Length` for files with paths, and `Content-Disposition` `filename` if the `UploadedFile` instance has one. ([@jeremyevans])
143
+ - `Request#ssl?` is true for the `wss` scheme (secure websockets). ([@jeremyevans])
144
+ - `Rack::HeaderHash` is memoized by default. ([#1549](https://github.com/rack/rack/pull/1549), [@ioquatix])
172
145
  - `Rack::Directory` allow directory traversal inside root directory. ([#1417](https://github.com/rack/rack/pull/1417), [@ThomasSevestre](https://github.com/ThomasSevestre))
173
- - Sort encodings by server preference. ([#1184](https://github.com/rack/rack/pull/1184), [@ioquatix](https://github.com/ioquatix), [@wjordan](https://github.com/wjordan))
174
- - Rework host/hostname/authority implementation in `Rack::Request`. `#host` and `#host_with_port` have been changed to correctly return IPv6 addresses formatted with square brackets, as defined by [RFC3986](https://tools.ietf.org/html/rfc3986#section-3.2.2). ([#1561](https://github.com/rack/rack/pull/1561), [@ioquatix](https://github.com/ioquatix))
175
- - `Rack::Builder` parsing options on first `#\` line is deprecated. ([#1574](https://github.com/rack/rack/pull/1574), [@ioquatix](https://github.com/ioquatix))
146
+ - Sort encodings by server preference. ([#1184](https://github.com/rack/rack/pull/1184), [@ioquatix], [@wjordan](https://github.com/wjordan))
147
+ - Rework host/hostname/authority implementation in `Rack::Request`. `#host` and `#host_with_port` have been changed to correctly return IPv6 addresses formatted with square brackets, as defined by [RFC3986](https://tools.ietf.org/html/rfc3986#section-3.2.2). ([#1561](https://github.com/rack/rack/pull/1561), [@ioquatix])
148
+ - `Rack::Builder` parsing options on first `#\` line is deprecated. ([#1574](https://github.com/rack/rack/pull/1574), [@ioquatix])
176
149
 
177
150
  ### Removed
178
151
 
179
- - `Directory#path` as it was not used and always returned nil. ([@jeremyevans](https://github.com/jeremyevans))
180
- - `BodyProxy#each` as it was only needed to work around a bug in Ruby <1.9.3. ([@jeremyevans](https://github.com/jeremyevans))
152
+ - `Directory#path` as it was not used and always returned nil. ([@jeremyevans])
153
+ - `BodyProxy#each` as it was only needed to work around a bug in Ruby <1.9.3. ([@jeremyevans])
181
154
  - `URLMap::INFINITY` and `URLMap::NEGATIVE_INFINITY`, in favor of `Float::INFINITY`. ([@ch1c0t](https://github.com/ch1c0t))
182
155
  - Deprecation of `Rack::File`. It will be deprecated again in rack 2.2 or 3.0. ([@rafaelfranca](https://github.com/rafaelfranca))
183
- - Support for Ruby 2.2 as it is well past EOL. ([@ioquatix](https://github.com/ioquatix))
184
- - Remove `Rack::Files#response_body` as the implementation was broken. ([#1153](https://github.com/rack/rack/pull/1153), [@ioquatix](https://github.com/ioquatix))
185
- - Remove `SERVER_ADDR` which was never part of the original SPEC. ([#1573](https://github.com/rack/rack/pull/1573), [@ioquatix](https://github.com/ioquatix))
156
+ - Support for Ruby 2.2 as it is well past EOL. ([@ioquatix])
157
+ - Remove `Rack::Files#response_body` as the implementation was broken. ([#1153](https://github.com/rack/rack/pull/1153), [@ioquatix])
158
+ - Remove `SERVER_ADDR` which was never part of the original SPEC. ([#1573](https://github.com/rack/rack/pull/1573), [@ioquatix])
186
159
 
187
160
  ### Fixed
188
161
 
189
- - `Directory` correctly handles root paths containing glob metacharacters. ([@jeremyevans](https://github.com/jeremyevans))
190
- - `Cascade` uses a new response object for each call if initialized with no apps. ([@jeremyevans](https://github.com/jeremyevans))
191
- - `BodyProxy` correctly delegates keyword arguments to the body object on Ruby 2.7+. ([@jeremyevans](https://github.com/jeremyevans))
192
- - `BodyProxy#method` correctly handles methods delegated to the body object. ([@jeremyevans](https://github.com/jeremyevans))
162
+ - `Directory` correctly handles root paths containing glob metacharacters. ([@jeremyevans])
163
+ - `Cascade` uses a new response object for each call if initialized with no apps. ([@jeremyevans])
164
+ - `BodyProxy` correctly delegates keyword arguments to the body object on Ruby 2.7+. ([@jeremyevans])
165
+ - `BodyProxy#method` correctly handles methods delegated to the body object. ([@jeremyevans])
193
166
  - `Request#host` and `Request#host_with_port` handle IPv6 addresses correctly. ([@AlexWayfer](https://github.com/AlexWayfer))
194
- - `Lint` checks when response hijacking that `rack.hijack` is called with a valid object. ([@jeremyevans](https://github.com/jeremyevans))
195
- - `Response#write` correctly updates `Content-Length` if initialized with a body. ([@jeremyevans](https://github.com/jeremyevans))
167
+ - `Lint` checks when response hijacking that `rack.hijack` is called with a valid object. ([@jeremyevans])
168
+ - `Response#write` correctly updates `Content-Length` if initialized with a body. ([@jeremyevans])
196
169
  - `CommonLogger` includes `SCRIPT_NAME` when logging. ([@Erol](https://github.com/Erol))
197
- - `Utils.parse_nested_query` correctly handles empty queries, using an empty instance of the params class instead of a hash. ([@jeremyevans](https://github.com/jeremyevans))
170
+ - `Utils.parse_nested_query` correctly handles empty queries, using an empty instance of the params class instead of a hash. ([@jeremyevans])
198
171
  - `Directory` correctly escapes paths in links. ([@yous](https://github.com/yous))
199
- - `Request#delete_cookie` and related `Utils` methods handle `:domain` and `:path` options in same call. ([@jeremyevans](https://github.com/jeremyevans))
200
- - `Request#delete_cookie` and related `Utils` methods do an exact match on `:domain` and `:path` options. ([@jeremyevans](https://github.com/jeremyevans))
172
+ - `Request#delete_cookie` and related `Utils` methods handle `:domain` and `:path` options in same call. ([@jeremyevans])
173
+ - `Request#delete_cookie` and related `Utils` methods do an exact match on `:domain` and `:path` options. ([@jeremyevans])
201
174
  - `Static` no longer adds headers when a gzipped file request has a 304 response. ([@chooh](https://github.com/chooh))
202
- - `ContentLength` sets `Content-Length` response header even for bodies not responding to `to_ary`. ([@jeremyevans](https://github.com/jeremyevans))
203
- - Thin handler supports options passed directly to `Thin::Controllers::Controller`. ([@jeremyevans](https://github.com/jeremyevans))
204
- - WEBrick handler no longer ignores `:BindAddress` option. ([@jeremyevans](https://github.com/jeremyevans))
205
- - `ShowExceptions` handles invalid POST data. ([@jeremyevans](https://github.com/jeremyevans))
206
- - Basic authentication requires a password, even if the password is empty. ([@jeremyevans](https://github.com/jeremyevans))
207
- - `Lint` checks response is array with 3 elements, per SPEC. ([@jeremyevans](https://github.com/jeremyevans))
175
+ - `ContentLength` sets `Content-Length` response header even for bodies not responding to `to_ary`. ([@jeremyevans])
176
+ - Thin handler supports options passed directly to `Thin::Controllers::Controller`. ([@jeremyevans])
177
+ - WEBrick handler no longer ignores `:BindAddress` option. ([@jeremyevans])
178
+ - `ShowExceptions` handles invalid POST data. ([@jeremyevans])
179
+ - Basic authentication requires a password, even if the password is empty. ([@jeremyevans])
180
+ - `Lint` checks response is array with 3 elements, per SPEC. ([@jeremyevans])
208
181
  - Support for using `:SSLEnable` option when using WEBrick handler. (Gregor Melhorn)
209
- - Close response body after buffering it when buffering. ([@ioquatix](https://github.com/ioquatix))
182
+ - Close response body after buffering it when buffering. ([@ioquatix])
210
183
  - Only accept `;` as delimiter when parsing cookies. ([@mrageh](https://github.com/mrageh))
211
- - `Utils::HeaderHash#clear` clears the name mapping as well. ([@raxoft](https://github.com/raxoft))
212
- - Support for passing `nil` `Rack::Files.new`, which notably fixes Rails' current `ActiveStorage::FileServer` implementation. ([@ioquatix](https://github.com/ioquatix))
184
+ - `Utils::HeaderHash#clear` clears the name mapping as well. ([@raxoft](https://github.com/raxoft))
185
+ - Support for passing `nil` `Rack::Files.new`, which notably fixes Rails' current `ActiveStorage::FileServer` implementation. ([@ioquatix])
213
186
 
214
187
  ### Documentation
215
188
 
216
189
  - CHANGELOG updates. ([@aupajo](https://github.com/aupajo))
217
190
  - Added [CONTRIBUTING](CONTRIBUTING.md). ([@dblock](https://github.com/dblock))
218
191
 
192
+ ## [2.0.9] - 2020-02-08
193
+
194
+ - Handle case where session id key is requested but missing ([@jeremyevans])
195
+ - Restore support for code relying on `SessionId#to_s`. ([@jeremyevans])
196
+ - Add support for `SameSite=None` cookie value. ([@hennikul](https://github.com/hennikul))
197
+
219
198
  ## [2.1.2] - 2020-01-27
220
199
 
221
200
  - Fix multipart parser for some files to prevent denial of service ([@aiomaster](https://github.com/aiomaster))
222
201
  - Fix `Rack::Builder#use` with keyword arguments ([@kamipo](https://github.com/kamipo))
223
- - Skip deflating in Rack::Deflater if Content-Length is 0 ([@jeremyevans](https://github.com/jeremyevans))
202
+ - Skip deflating in Rack::Deflater if Content-Length is 0 ([@jeremyevans])
224
203
  - Remove `SessionHash#transform_keys`, no longer needed ([@pavel](https://github.com/pavel))
225
204
  - Add to_hash to wrap Hash and Session classes ([@oleh-demyanyuk](https://github.com/oleh-demyanyuk))
226
- - Handle case where session id key is requested but missing ([@jeremyevans](https://github.com/jeremyevans))
205
+ - Handle case where session id key is requested but missing ([@jeremyevans])
227
206
 
228
207
  ## [2.1.1] - 2020-01-12
229
208
 
230
- - Remove `Rack::Chunked` from `Rack::Server` default middleware. ([#1475](https://github.com/rack/rack/pull/1475), [@ioquatix](https://github.com/ioquatix))
231
- - Restore support for code relying on `SessionId#to_s`. ([@jeremyevans](https://github.com/jeremyevans))
209
+ - Remove `Rack::Chunked` from `Rack::Server` default middleware. ([#1475](https://github.com/rack/rack/pull/1475), [@ioquatix])
210
+ - Restore support for code relying on `SessionId#to_s`. ([@jeremyevans])
232
211
 
233
212
  ## [2.1.0] - 2020-01-10
234
213
 
@@ -245,13 +224,13 @@ All notable changes to this project will be documented in this file. For info on
245
224
  - Add boot-time profiling capabilities to `rackup`. ([@tenderlove](https://github.com/tenderlove))
246
225
  - Add multi mapping support for `X-Accel-Mappings` header. ([@yoshuki](https://github.com/yoshuki))
247
226
  - Add `sync: false` option to `Rack::Deflater`. (Eric Wong)
248
- - Add `Builder#freeze_app` to freeze application and all middleware instances. ([@jeremyevans](https://github.com/jeremyevans))
227
+ - Add `Builder#freeze_app` to freeze application and all middleware instances. ([@jeremyevans])
249
228
  - Add API to extract cookies from `Rack::MockResponse`. ([@petercline](https://github.com/petercline))
250
229
 
251
230
  ### Changed
252
231
 
253
- - Don't propagate nil values from middleware. ([@ioquatix](https://github.com/ioquatix))
254
- - Lazily initialize the response body and only buffer it if required. ([@ioquatix](https://github.com/ioquatix))
232
+ - Don't propagate nil values from middleware. ([@ioquatix])
233
+ - Lazily initialize the response body and only buffer it if required. ([@ioquatix])
255
234
  - Fix deflater zlib buffer errors on empty body part. ([@felixbuenemann](https://github.com/felixbuenemann))
256
235
  - Set `X-Accel-Redirect` to percent-encoded path. ([@diskkid](https://github.com/diskkid))
257
236
  - Remove unnecessary buffer growing when parsing multipart. ([@tainoe](https://github.com/tainoe))
@@ -264,15 +243,15 @@ All notable changes to this project will be documented in this file. For info on
264
243
  - Make `Utils.status_code` raise an error when the status symbol is invalid instead of `500`. ([@adambutler](https://github.com/adambutler))
265
244
  - Rename `Request::SCHEME_WHITELIST` to `Request::ALLOWED_SCHEMES`.
266
245
  - Make `Multipart::Parser.get_filename` accept files with `+` in their name. ([@lucaskanashiro](https://github.com/lucaskanashiro))
267
- - Add Falcon to the default handler fallbacks. ([@ioquatix](https://github.com/ioquatix))
246
+ - Add Falcon to the default handler fallbacks. ([@ioquatix])
268
247
  - Update codebase to avoid string mutations in preparation for `frozen_string_literals`. ([@pat](https://github.com/pat))
269
248
  - Change `MockRequest#env_for` to rely on the input optionally responding to `#size` instead of `#length`. ([@janko](https://github.com/janko))
270
- - Rename `Rack::File` -> `Rack::Files` and add deprecation notice. ([@postmodern](https://github.com/postmodern)).
271
- - Prefer Base64 “strict encoding” for Base64 cookies. ([@ioquatix](https://github.com/ioquatix))
249
+ - Rename `Rack::File` -> `Rack::Files` and add deprecation notice. ([@postmodern](https://github.com/postmodern))
250
+ - Prefer Base64 “strict encoding” for Base64 cookies. ([@ioquatix])
272
251
 
273
252
  ### Removed
274
253
 
275
- - Remove `to_ary` from Response ([@tenderlove](https://github.com/tenderlove))
254
+ - BREAKING CHANGE: Remove `to_ary` from Response ([@tenderlove](https://github.com/tenderlove))
276
255
  - Deprecate `Rack::Session::Memcache` in favor of `Rack::Session::Dalli` from dalli gem ([@fatkodima](https://github.com/fatkodima))
277
256
 
278
257
  ### Fixed
@@ -353,7 +332,7 @@ All notable changes to this project will be documented in this file. For info on
353
332
  ### Added
354
333
 
355
334
  - Allow `Session::Abstract::SessionHash#fetch` to accept a block with a default value. ([@yannvanhalewyn](https://github.com/yannvanhalewyn))
356
- - Add `Builder#freeze_app` to freeze application and all middleware. ([@jeremyevans](https://github.com/jeremyevans))
335
+ - Add `Builder#freeze_app` to freeze application and all middleware. ([@jeremyevans])
357
336
 
358
337
  ### Changed
359
338
 
@@ -365,9 +344,9 @@ All notable changes to this project will be documented in this file. For info on
365
344
  ### Fixed
366
345
 
367
346
  - Handle `NULL` bytes in multipart filenames. ([@casperisfine](https://github.com/casperisfine))
368
- - Remove warnings due to miscapitalized global. ([@ioquatix](https://github.com/ioquatix))
347
+ - Remove warnings due to miscapitalized global. ([@ioquatix])
369
348
  - Prevent exceptions caused by a race condition on multi-threaded servers. ([@sophiedeziel](https://github.com/sophiedeziel))
370
- - Add RDoc as an explicit depencency for `doc` group. ([@tonytonyjan](https://github.com/tonytonyjan))
349
+ - Add RDoc as an explicit dependency for `doc` group. ([@tonytonyjan](https://github.com/tonytonyjan))
371
350
  - Record errors originating from `Multipart::Parser` in the `MethodOverride` middleware instead of letting them bubble up. ([@carlzulauf](https://github.com/carlzulauf))
372
351
  - Remove remaining use of removed `Utils#bytesize` method from the `File` middleware. ([@brauliomartinezlm](https://github.com/brauliomartinezlm))
373
352
 
@@ -685,7 +664,7 @@ Items below this line are from the previously maintained HISTORY.md and NEWS.md
685
664
  - Moved Auth::OpenID to rack-contrib.
686
665
  - SPEC change that relaxes Lint slightly to allow subclasses of the
687
666
  required types
688
- - SPEC change to document rack.input binary mode in greator detail
667
+ - SPEC change to document rack.input binary mode in greater detail
689
668
  - SPEC define optional rack.logger specification
690
669
  - File servers support X-Cascade header
691
670
  - Imported Config middleware
@@ -806,4 +785,5 @@ Items below this line are from the previously maintained HISTORY.md and NEWS.md
806
785
 
807
786
  [@ioquatix]: https://github.com/ioquatix "Samuel Williams"
808
787
  [@jeremyevans]: https://github.com/jeremyevans "Jeremy Evans"
809
- [@earlopain]: https://github.com/earlopain "Earlopain"
788
+ [@amatsuda]: https://github.com/amatsuda "Akira Matsuda"
789
+ [@wjordan]: https://github.com/wjordan "Will Jordan"
data/CONTRIBUTING.md CHANGED
@@ -1,29 +1,33 @@
1
- Contributing to Rack
2
- =====================
1
+ # Contributing to Rack
3
2
 
4
- Rack is work of [hundreds of contributors](https://github.com/rack/rack/graphs/contributors). You're encouraged to submit [pull requests](https://github.com/rack/rack/pulls), [propose features and discuss issues](https://github.com/rack/rack/issues). When in doubt, post to the [rack-devel](http://groups.google.com/group/rack-devel) mailing list.
3
+ Rack is work of [hundreds of
4
+ contributors](https://github.com/rack/rack/graphs/contributors). You're
5
+ encouraged to submit [pull requests](https://github.com/rack/rack/pulls) and
6
+ [propose features and discuss issues](https://github.com/rack/rack/issues).
5
7
 
6
- #### Fork the Project
8
+ ## Fork the Project
7
9
 
8
- Fork the [project on Github](https://github.com/rack/rack) and check out your copy.
10
+ Fork the [project on GitHub](https://github.com/rack/rack) and check out your
11
+ copy.
9
12
 
10
13
  ```
11
- git clone https://github.com/contributor/rack.git
14
+ git clone https://github.com/(your-github-username)/rack.git
12
15
  cd rack
13
16
  git remote add upstream https://github.com/rack/rack.git
14
17
  ```
15
18
 
16
- #### Create a Topic Branch
19
+ ## Create a Topic Branch
17
20
 
18
- Make sure your fork is up-to-date and create a topic branch for your feature or bug fix.
21
+ Make sure your fork is up-to-date and create a topic branch for your feature or
22
+ bug fix.
19
23
 
20
24
  ```
21
- git checkout master
22
- git pull upstream master
25
+ git checkout main
26
+ git pull upstream main
23
27
  git checkout -b my-feature-branch
24
28
  ```
25
29
 
26
- #### Bundle Install and Quick Test
30
+ ## Bundle Install and Quick Test
27
31
 
28
32
  Ensure that you can build the project and run quick tests.
29
33
 
@@ -32,7 +36,7 @@ bundle install --without extra
32
36
  bundle exec rake test
33
37
  ```
34
38
 
35
- #### Running All Tests
39
+ ## Running All Tests
36
40
 
37
41
  Install all dependencies.
38
42
 
@@ -46,39 +50,33 @@ Run all tests.
46
50
  rake test
47
51
  ```
48
52
 
49
- The test suite has no dependencies outside of the core Ruby installation and bacon.
53
+ ## Write Tests
50
54
 
51
- Some tests will be skipped if a dependency is not found.
55
+ Try to write a test that reproduces the problem you're trying to fix or
56
+ describes a feature that you want to build.
52
57
 
53
- To run the test suite completely, you need:
58
+ We definitely appreciate pull requests that highlight or reproduce a problem,
59
+ even without a fix.
54
60
 
55
- * fcgi
56
- * dalli
57
- * thin
58
-
59
- To test Memcache sessions, you need memcached (will be run on port 11211) and dalli installed.
60
-
61
- #### Write Tests
62
-
63
- Try to write a test that reproduces the problem you're trying to fix or describes a feature that you want to build.
64
-
65
- We definitely appreciate pull requests that highlight or reproduce a problem, even without a fix.
66
-
67
- #### Write Code
61
+ ## Write Code
68
62
 
69
63
  Implement your feature or bug fix.
70
64
 
71
- Make sure that `bundle exec rake fulltest` completes without errors.
65
+ Make sure that all tests pass:
66
+
67
+ ```
68
+ bundle exec rake test
69
+ ```
72
70
 
73
- #### Write Documentation
71
+ ## Write Documentation
74
72
 
75
- Document any external behavior in the [README](README.rdoc).
73
+ Document any external behavior in the [README](README.md).
76
74
 
77
- #### Update Changelog
75
+ ## Update Changelog
78
76
 
79
77
  Add a line to [CHANGELOG](CHANGELOG.md).
80
78
 
81
- #### Commit Changes
79
+ ## Commit Changes
82
80
 
83
81
  Make sure git knows your name and email address:
84
82
 
@@ -87,34 +85,37 @@ git config --global user.name "Your Name"
87
85
  git config --global user.email "contributor@example.com"
88
86
  ```
89
87
 
90
- Writing good commit logs is important. A commit log should describe what changed and why.
88
+ Writing good commit logs is important. A commit log should describe what changed
89
+ and why.
91
90
 
92
91
  ```
93
92
  git add ...
94
93
  git commit
95
94
  ```
96
95
 
97
- #### Push
96
+ ## Push
98
97
 
99
98
  ```
100
99
  git push origin my-feature-branch
101
100
  ```
102
101
 
103
- #### Make a Pull Request
102
+ ## Make a Pull Request
104
103
 
105
- Go to https://github.com/contributor/rack and select your feature branch. Click the 'Pull Request' button and fill out the form. Pull requests are usually reviewed within a few days.
104
+ Go to your fork of rack on GitHub and select your feature branch. Click the
105
+ 'Pull Request' button and fill out the form. Pull requests are usually
106
+ reviewed within a few days.
106
107
 
107
- #### Rebase
108
+ ## Rebase
108
109
 
109
- If you've been working on a change for a while, rebase with upstream/master.
110
+ If you've been working on a change for a while, rebase with upstream/main.
110
111
 
111
112
  ```
112
113
  git fetch upstream
113
- git rebase upstream/master
114
+ git rebase upstream/main
114
115
  git push origin my-feature-branch -f
115
116
  ```
116
117
 
117
- #### Make Required Changes
118
+ ## Make Required Changes
118
119
 
119
120
  Amend your previous commit and force push the changes.
120
121
 
@@ -123,14 +124,19 @@ git commit --amend
123
124
  git push origin my-feature-branch -f
124
125
  ```
125
126
 
126
- #### Check on Your Pull Request
127
+ ## Check on Your Pull Request
127
128
 
128
- Go back to your pull request after a few minutes and see whether it passed muster with Travis-CI. Everything should look green, otherwise fix issues and amend your commit as described above.
129
+ Go back to your pull request after a few minutes and see whether it passed
130
+ tests with GitHub Actions. Everything should look green, otherwise fix issues and
131
+ amend your commit as described above.
129
132
 
130
- #### Be Patient
133
+ ## Be Patient
131
134
 
132
- It's likely that your change will not be merged and that the nitpicky maintainers will ask you to do more, or fix seemingly benign problems. Hang on there!
135
+ It's likely that your change will not be merged and that the nitpicky
136
+ maintainers will ask you to do more, or fix seemingly benign problems. Hang in
137
+ there!
133
138
 
134
- #### Thank You
139
+ ## Thank You
135
140
 
136
- Please do know that we really appreciate and value your time and work. We love you, really.
141
+ Please do know that we really appreciate and value your time and work. We love
142
+ you, really.