rack 2.2.4 → 3.0.8
Sign up to get free protection for your applications and to get access to all the features.
Potentially problematic release.
This version of rack might be problematic. Click here for more details.
- checksums.yaml +4 -4
- data/CHANGELOG.md +223 -71
- data/CONTRIBUTING.md +53 -47
- data/MIT-LICENSE +1 -1
- data/README.md +309 -0
- data/SPEC.rdoc +183 -131
- data/lib/rack/auth/abstract/handler.rb +3 -1
- data/lib/rack/auth/abstract/request.rb +3 -1
- data/lib/rack/auth/basic.rb +0 -2
- data/lib/rack/auth/digest/md5.rb +1 -131
- data/lib/rack/auth/digest/nonce.rb +1 -54
- data/lib/rack/auth/digest/params.rb +1 -54
- data/lib/rack/auth/digest/request.rb +1 -43
- data/lib/rack/auth/digest.rb +256 -0
- data/lib/rack/body_proxy.rb +3 -1
- data/lib/rack/builder.rb +83 -63
- data/lib/rack/cascade.rb +2 -0
- data/lib/rack/chunked.rb +16 -13
- data/lib/rack/common_logger.rb +23 -18
- data/lib/rack/conditional_get.rb +18 -15
- data/lib/rack/constants.rb +64 -0
- data/lib/rack/content_length.rb +12 -16
- data/lib/rack/content_type.rb +8 -5
- data/lib/rack/deflater.rb +40 -26
- data/lib/rack/directory.rb +9 -3
- data/lib/rack/etag.rb +14 -23
- data/lib/rack/events.rb +4 -0
- data/lib/rack/file.rb +2 -0
- data/lib/rack/files.rb +15 -17
- data/lib/rack/head.rb +9 -8
- data/lib/rack/headers.rb +154 -0
- data/lib/rack/lint.rb +783 -682
- data/lib/rack/lock.rb +2 -5
- data/lib/rack/logger.rb +2 -0
- data/lib/rack/media_type.rb +1 -1
- data/lib/rack/method_override.rb +6 -2
- data/lib/rack/mime.rb +8 -0
- data/lib/rack/mock.rb +1 -271
- data/lib/rack/mock_request.rb +166 -0
- data/lib/rack/mock_response.rb +126 -0
- data/lib/rack/multipart/generator.rb +7 -5
- data/lib/rack/multipart/parser.rb +134 -65
- data/lib/rack/multipart/uploaded_file.rb +4 -0
- data/lib/rack/multipart.rb +20 -40
- data/lib/rack/null_logger.rb +9 -0
- data/lib/rack/query_parser.rb +78 -46
- data/lib/rack/recursive.rb +2 -0
- data/lib/rack/reloader.rb +0 -2
- data/lib/rack/request.rb +226 -108
- data/lib/rack/response.rb +136 -61
- data/lib/rack/rewindable_input.rb +24 -5
- data/lib/rack/runtime.rb +7 -6
- data/lib/rack/sendfile.rb +30 -25
- data/lib/rack/show_exceptions.rb +15 -2
- data/lib/rack/show_status.rb +17 -7
- data/lib/rack/static.rb +8 -8
- data/lib/rack/tempfile_reaper.rb +15 -4
- data/lib/rack/urlmap.rb +4 -2
- data/lib/rack/utils.rb +223 -185
- data/lib/rack/version.rb +9 -4
- data/lib/rack.rb +6 -76
- metadata +18 -38
- data/README.rdoc +0 -306
- data/Rakefile +0 -130
- data/bin/rackup +0 -5
- data/contrib/rack.png +0 -0
- data/contrib/rack.svg +0 -150
- data/contrib/rack_logo.svg +0 -164
- data/contrib/rdoc.css +0 -412
- data/example/lobster.ru +0 -6
- data/example/protectedlobster.rb +0 -16
- data/example/protectedlobster.ru +0 -10
- data/lib/rack/core_ext/regexp.rb +0 -14
- data/lib/rack/handler/cgi.rb +0 -59
- data/lib/rack/handler/fastcgi.rb +0 -100
- data/lib/rack/handler/lsws.rb +0 -61
- data/lib/rack/handler/scgi.rb +0 -71
- data/lib/rack/handler/thin.rb +0 -36
- data/lib/rack/handler/webrick.rb +0 -129
- data/lib/rack/handler.rb +0 -104
- data/lib/rack/lobster.rb +0 -70
- data/lib/rack/server.rb +0 -466
- data/lib/rack/session/abstract/id.rb +0 -523
- data/lib/rack/session/cookie.rb +0 -203
- data/lib/rack/session/memcache.rb +0 -10
- data/lib/rack/session/pool.rb +0 -85
- data/rack.gemspec +0 -46
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: e05c24e17dac3f2da82b5e26090a5bcc2dffec8955792b9df92bdc21bd4fdad2
|
4
|
+
data.tar.gz: 7af9d2217e9e092af82c3d6582f9b377a71e370279ecf8ee722ff142e79b9031
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 7280fd5a123ca1760f3b1d3c2ff1742bc7686fc5e8d3254d8a7cd8897fadf8f73f2887778a1b9a9cba05093ed98a9326528db5bebbe85f4961274f5ca4aab52c
|
7
|
+
data.tar.gz: 4f2bc0fe42ddcc8dbe92d8620ab0b1a40eb8215d668db085ef9fd4f30660c492e51da14a7a6d568c16674b3e1854f75e0dbd51258c9f3432f4ac6c8f4a43f14c
|
data/CHANGELOG.md
CHANGED
@@ -2,6 +2,148 @@
|
|
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
|
+
## [3.0.7] - 2023-03-16
|
6
|
+
|
7
|
+
- Make query parameters without `=` have `nil` values. ([#2059](https://github.com/rack/rack/pull/2059), [@jeremyevans])
|
8
|
+
|
9
|
+
## [3.0.6.1] - 2023-03-13
|
10
|
+
|
11
|
+
- [CVE-2023-27539] Avoid ReDoS in header parsing
|
12
|
+
|
13
|
+
## [3.0.6] - 2023-03-13
|
14
|
+
|
15
|
+
- Add `QueryParser#missing_value` for handling missing values + tests. ([#2052](https://github.com/rack/rack/pull/2052), [@ioquatix])
|
16
|
+
|
17
|
+
## [3.0.5] - 2023-03-13
|
18
|
+
|
19
|
+
- Split form/query parsing into two steps. ([#2038](https://github.com/rack/rack/pull/2038), [@matthewd](https://github.com/matthewd))
|
20
|
+
|
21
|
+
## [3.0.4.1] - 2023-03-02
|
22
|
+
|
23
|
+
- [CVE-2023-27530] Introduce multipart_total_part_limit to limit total parts
|
24
|
+
|
25
|
+
## [3.0.4.1] - 2023-01-17
|
26
|
+
|
27
|
+
- [CVE-2022-44571] Fix ReDoS vulnerability in multipart parser
|
28
|
+
- [CVE-2022-44570] Fix ReDoS in Rack::Utils.get_byte_ranges
|
29
|
+
- [CVE-2022-44572] Forbid control characters in attributes (also ReDoS)
|
30
|
+
|
31
|
+
## [3.0.4] - 2023-01-17
|
32
|
+
|
33
|
+
- `Rack::Request#POST` should consistently raise errors. Cache errors that occur when invoking `Rack::Request#POST` so they can be raised again later. ([#2010](https://github.com/rack/rack/pull/2010), [@ioquatix])
|
34
|
+
- Fix `Rack::Lint` error message for `HTTP_CONTENT_TYPE` and `HTTP_CONTENT_LENGTH`. ([#2007](https://github.com/rack/rack/pull/2007), [@byroot](https://github.com/byroot))
|
35
|
+
- Extend `Rack::MethodOverride` to handle `QueryParser::ParamsTooDeepError` error. ([#2006](https://github.com/rack/rack/pull/2006), [@byroot](https://github.com/byroot))
|
36
|
+
|
37
|
+
## [3.0.3] - 2022-12-27
|
38
|
+
|
39
|
+
### Fixed
|
40
|
+
|
41
|
+
- `Rack::URLMap` uses non-deprecated form of `Regexp.new`. ([#1998](https://github.com/rack/rack/pull/1998), [@weizheheng](https://github.com/weizheheng))
|
42
|
+
|
43
|
+
## [3.0.2] - 2022-12-05
|
44
|
+
|
45
|
+
### Fixed
|
46
|
+
|
47
|
+
- `Utils.build_nested_query` URL-encodes nested field names including the square brackets.
|
48
|
+
- Allow `Rack::Response` to pass through streaming bodies. ([#1993](https://github.com/rack/rack/pull/1993), [@ioquatix])
|
49
|
+
|
50
|
+
## [3.0.1] - 2022-11-18
|
51
|
+
|
52
|
+
### Fixed
|
53
|
+
|
54
|
+
- `MethodOverride` does not look for an override if a request does not include form/parseable data.
|
55
|
+
- `Rack::Lint::Wrapper` correctly handles `respond_to?` with `to_ary`, `each`, `call` and `to_path`, forwarding to the body. ([#1981](https://github.com/rack/rack/pull/1981), [@ioquatix])
|
56
|
+
|
57
|
+
## [3.0.0] - 2022-09-06
|
58
|
+
|
59
|
+
- No changes
|
60
|
+
|
61
|
+
## [3.0.0.rc1] - 2022-09-04
|
62
|
+
|
63
|
+
### SPEC Changes
|
64
|
+
|
65
|
+
- Stream argument must implement `<<` https://github.com/rack/rack/pull/1959
|
66
|
+
- `close` may be called on `rack.input` https://github.com/rack/rack/pull/1956
|
67
|
+
- `rack.response_finished` may be used for executing code after the response has been finished https://github.com/rack/rack/pull/1952
|
68
|
+
|
69
|
+
## [3.0.0.beta1] - 2022-08-08
|
70
|
+
|
71
|
+
### Security
|
72
|
+
|
73
|
+
- Do not use semicolon as GET parameter separator. ([#1733](https://github.com/rack/rack/pull/1733), [@jeremyevans])
|
74
|
+
|
75
|
+
### SPEC Changes
|
76
|
+
|
77
|
+
- Response array must now be non-frozen.
|
78
|
+
- Response `status` must now be an integer greater than or equal to 100.
|
79
|
+
- Response `headers` must now be an unfrozen hash.
|
80
|
+
- Response header keys can no longer include uppercase characters.
|
81
|
+
- Response header values can be an `Array` to handle multiple values (and no longer supports `\n` encoded headers).
|
82
|
+
- Response body can now respond to `#call` (streaming body) instead of `#each` (enumerable body), for the equivalent of response hijacking in previous versions.
|
83
|
+
- Middleware must no longer call `#each` on the body, but they can call `#to_ary` on the body if it responds to `#to_ary`.
|
84
|
+
- `rack.input` is no longer required to be rewindable.
|
85
|
+
- `rack.multithread`/`rack.multiprocess`/`rack.run_once`/`rack.version` are no longer required environment keys.
|
86
|
+
- `SERVER_PROTOCOL` is now a required environment key, matching the HTTP protocol used in the request.
|
87
|
+
- `rack.hijack?` (partial hijack) and `rack.hijack` (full hijack) are now independently optional.
|
88
|
+
- `rack.hijack_io` has been removed completely.
|
89
|
+
- `rack.response_finished` is an optional environment key which contains an array of callable objects that must accept `#call(env, status, headers, error)` and are invoked after the response is finished (either successfully or unsuccessfully).
|
90
|
+
- It is okay to call `#close` on `rack.input` to indicate that you no longer need or care about the input.
|
91
|
+
- The stream argument supplied to the streaming body and hijack must support `#<<` for writing output.
|
92
|
+
|
93
|
+
### Removed
|
94
|
+
|
95
|
+
- 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]))
|
96
|
+
- Remove deprecated Rack::Request::SCHEME_WHITELIST. ([@jeremyevans])
|
97
|
+
- 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])
|
98
|
+
- Remove `rack.version` as it comes too late to be useful. ([#1938](https://github.com/rack/rack/pull/1938), [@ioquatix])
|
99
|
+
- Extract `rackup` command, `Rack::Server`, `Rack::Handler` and related code into a separate gem. ([#1937](https://github.com/rack/rack/pull/1937), [@ioquatix])
|
100
|
+
|
101
|
+
### Added
|
102
|
+
|
103
|
+
- `Rack::Headers` added to support lower-case header keys. ([@jeremyevans])
|
104
|
+
- `Rack::Utils#set_cookie_header` now supports `escape_key: false` to avoid key escaping. ([@jeremyevans])
|
105
|
+
- `Rack::RewindableInput` supports size. ([@ahorek](https://github.com/ahorek))
|
106
|
+
- `Rack::RewindableInput::Middleware` added for making `rack.input` rewindable. ([@jeremyevans])
|
107
|
+
- 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])
|
108
|
+
- Allow response headers to contain array of values. ([#1598](https://github.com/rack/rack/issues/1598), [@ioquatix])
|
109
|
+
- 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])
|
110
|
+
- Allow `Rack::Builder#run` to take a block instead of an argument. ([#1942](https://github.com/rack/rack/pull/1942), [@ioquatix])
|
111
|
+
- Add `rack.response_finished` to `Rack::Lint`. ([#1802](https://github.com/rack/rack/pull/1802), [@BlakeWilliams], [#1952](https://github.com/rack/rack/pull/1952), [@ioquatix])
|
112
|
+
- The stream argument must implement `#<<`. ([#1959](https://github.com/rack/rack/pull/1959), [@ioquatix])
|
113
|
+
|
114
|
+
### Changed
|
115
|
+
|
116
|
+
- BREAKING CHANGE: Require `status` to be an Integer. ([#1662](https://github.com/rack/rack/pull/1662), [@olleolleolle](https://github.com/olleolleolle))
|
117
|
+
- 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])
|
118
|
+
- Relax validations around `Rack::Request#host` and `Rack::Request#hostname`. ([#1606](https://github.com/rack/rack/issues/1606), [@pvande](https://github.com/pvande))
|
119
|
+
- Removed antiquated handlers: FCGI, LSWS, SCGI, Thin. ([#1658](https://github.com/rack/rack/pull/1658), [@ioquatix])
|
120
|
+
- Removed options from `Rack::Builder.parse_file` and `Rack::Builder.load_file`. ([#1663](https://github.com/rack/rack/pull/1663), [@ioquatix])
|
121
|
+
- `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])
|
122
|
+
- `Rack::Request#[]` and `#[]=` now warn even in non-verbose mode. ([#1277](https://github.com/rack/rack/issues/1277), [@jeremyevans])
|
123
|
+
- Decrease default allowed parameter recursion level from 100 to 32. ([#1640](https://github.com/rack/rack/issues/1640), [@jeremyevans])
|
124
|
+
- Attempting to parse a multipart response with an empty body now raises Rack::Multipart::EmptyContentError. ([#1603](https://github.com/rack/rack/issues/1603), [@jeremyevans])
|
125
|
+
- `Rack::Utils.secure_compare` uses OpenSSL's faster implementation if available. ([#1711](https://github.com/rack/rack/pull/1711), [@bdewater](https://github.com/bdewater))
|
126
|
+
- `Rack::Request#POST` now caches an empty hash if input content type is not parseable. ([#749](https://github.com/rack/rack/pull/749), [@jeremyevans])
|
127
|
+
- 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))
|
128
|
+
- Explicitly deprecate `Rack::File` which was an alias for `Rack::Files`. ([#1811](https://github.com/rack/rack/pull/1720), [@ioquatix]).
|
129
|
+
- Moved `Rack::Session` into [separate gem](https://github.com/rack/rack-session). ([#1805](https://github.com/rack/rack/pull/1805), [@ioquatix])
|
130
|
+
- `rackup -D` option to daemonizes no longer changes the working directory to the root. ([#1813](https://github.com/rack/rack/pull/1813), [@jeremyevans])
|
131
|
+
- 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])
|
132
|
+
- `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])
|
133
|
+
- 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])
|
134
|
+
- 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])
|
135
|
+
- `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])
|
136
|
+
- Allow calling close on `rack.input`. ([#1956](https://github.com/rack/rack/pull/1956), [@ioquatix])
|
137
|
+
|
138
|
+
### Fixed
|
139
|
+
|
140
|
+
- Make Rack::MockResponse handle non-hash headers. ([#1629](https://github.com/rack/rack/issues/1629), [@jeremyevans])
|
141
|
+
- TempfileReaper now deletes temp files if application raises an exception. ([#1679](https://github.com/rack/rack/issues/1679), [@jeremyevans])
|
142
|
+
- Handle cookies with values that end in '=' ([#1645](https://github.com/rack/rack/pull/1645), [@lukaso](https://github.com/lukaso))
|
143
|
+
- Make `Rack::NullLogger` respond to `#fatal!` [@jeremyevans])
|
144
|
+
- 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))
|
145
|
+
- `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))
|
146
|
+
|
5
147
|
## [2.2.4] - 2022-06-30
|
6
148
|
|
7
149
|
- Better support for lower case headers in `Rack::ETag` middleware. ([#1919](https://github.com/rack/rack/pull/1919), [@ioquatix](https://github.com/ioquatix))
|
@@ -9,23 +151,21 @@ All notable changes to this project will be documented in this file. For info on
|
|
9
151
|
|
10
152
|
## [2.2.3.1] - 2022-05-27
|
11
153
|
|
12
|
-
### Security
|
13
|
-
|
14
154
|
- [CVE-2022-30123] Fix shell escaping issue in Common Logger
|
15
155
|
- [CVE-2022-30122] Restrict parsing of broken MIME attachments
|
16
156
|
|
17
|
-
## [2.2.3] - 2020-
|
157
|
+
## [2.2.3] - 2020-06-15
|
18
158
|
|
19
159
|
### Security
|
20
160
|
|
21
|
-
- [CVE-2020-8184]
|
161
|
+
- [[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))
|
22
162
|
|
23
163
|
## [2.2.2] - 2020-02-11
|
24
164
|
|
25
165
|
### Fixed
|
26
166
|
|
27
|
-
- Fix incorrect `Rack::Request#host` value. ([#1591](https://github.com/rack/rack/pull/1591), [@ioquatix]
|
28
|
-
- Revert `Rack::Handler::Thin` implementation. ([#1583](https://github.com/rack/rack/pull/1583), [@jeremyevans]
|
167
|
+
- Fix incorrect `Rack::Request#host` value. ([#1591](https://github.com/rack/rack/pull/1591), [@ioquatix])
|
168
|
+
- Revert `Rack::Handler::Thin` implementation. ([#1583](https://github.com/rack/rack/pull/1583), [@jeremyevans])
|
29
169
|
- Double assignment is still needed to prevent an "unused variable" warning. ([#1589](https://github.com/rack/rack/pull/1589), [@kamipo](https://github.com/kamipo))
|
30
170
|
- Fix to handle same_site option for session pool. ([#1587](https://github.com/rack/rack/pull/1587), [@kamipo](https://github.com/kamipo))
|
31
171
|
|
@@ -33,105 +173,111 @@ All notable changes to this project will be documented in this file. For info on
|
|
33
173
|
|
34
174
|
### Fixed
|
35
175
|
|
36
|
-
- Rework `Rack::Request#ip` to handle empty `forwarded_for`. ([#1577](https://github.com/rack/rack/pull/1577), [@ioquatix]
|
176
|
+
- Rework `Rack::Request#ip` to handle empty `forwarded_for`. ([#1577](https://github.com/rack/rack/pull/1577), [@ioquatix])
|
37
177
|
|
38
178
|
## [2.2.0] - 2020-02-08
|
39
179
|
|
40
180
|
### SPEC Changes
|
41
181
|
|
42
|
-
- `rack.session` request environment entry must respond to `to_hash` and return unfrozen Hash. ([@jeremyevans]
|
43
|
-
- Request environment cannot be frozen. ([@jeremyevans]
|
44
|
-
- CGI values in the request environment with non-ASCII characters must use ASCII-8BIT encoding. ([@jeremyevans]
|
45
|
-
- Improve SPEC/lint relating to SERVER_NAME, SERVER_PORT and HTTP_HOST. ([#1561](https://github.com/rack/rack/pull/1561), [@ioquatix]
|
182
|
+
- `rack.session` request environment entry must respond to `to_hash` and return unfrozen Hash. ([@jeremyevans])
|
183
|
+
- Request environment cannot be frozen. ([@jeremyevans])
|
184
|
+
- CGI values in the request environment with non-ASCII characters must use ASCII-8BIT encoding. ([@jeremyevans])
|
185
|
+
- Improve SPEC/lint relating to SERVER_NAME, SERVER_PORT and HTTP_HOST. ([#1561](https://github.com/rack/rack/pull/1561), [@ioquatix])
|
46
186
|
|
47
187
|
### Added
|
48
188
|
|
49
|
-
- `rackup` supports multiple `-r` options and will require all arguments. ([@jeremyevans]
|
189
|
+
- `rackup` supports multiple `-r` options and will require all arguments. ([@jeremyevans])
|
50
190
|
- `Server` supports an array of paths to require for the `:require` option. ([@khotta](https://github.com/khotta))
|
51
191
|
- `Files` supports multipart range requests. ([@fatkodima](https://github.com/fatkodima))
|
52
|
-
- `Multipart::UploadedFile` supports an IO-like object instead of using the filesystem, using `:filename` and `:io` options. ([@jeremyevans]
|
53
|
-
- `Multipart::UploadedFile` supports keyword arguments `:path`, `:content_type`, and `:binary` in addition to positional arguments. ([@jeremyevans]
|
54
|
-
- `Static` supports a `:cascade` option for calling the app if there is no matching file. ([@jeremyevans]
|
55
|
-
- `Session::Abstract::SessionHash#dig`. ([@jeremyevans]
|
56
|
-
- `Response.[]` and `MockResponse.[]` for creating instances using status, headers, and body. ([@ioquatix]
|
57
|
-
- Convenient cache and content type methods for `Rack::Response`. ([#1555](https://github.com/rack/rack/pull/1555), [@ioquatix]
|
192
|
+
- `Multipart::UploadedFile` supports an IO-like object instead of using the filesystem, using `:filename` and `:io` options. ([@jeremyevans])
|
193
|
+
- `Multipart::UploadedFile` supports keyword arguments `:path`, `:content_type`, and `:binary` in addition to positional arguments. ([@jeremyevans])
|
194
|
+
- `Static` supports a `:cascade` option for calling the app if there is no matching file. ([@jeremyevans])
|
195
|
+
- `Session::Abstract::SessionHash#dig`. ([@jeremyevans])
|
196
|
+
- `Response.[]` and `MockResponse.[]` for creating instances using status, headers, and body. ([@ioquatix])
|
197
|
+
- Convenient cache and content type methods for `Rack::Response`. ([#1555](https://github.com/rack/rack/pull/1555), [@ioquatix])
|
58
198
|
|
59
199
|
### Changed
|
60
200
|
|
61
|
-
- `Request#params` no longer rescues EOFError. ([@jeremyevans]
|
62
|
-
- `Directory` uses a streaming approach, significantly improving time to first byte for large directories. ([@jeremyevans]
|
63
|
-
- `Directory` no longer includes a Parent directory link in the root directory index. ([@jeremyevans]
|
64
|
-
- `QueryParser#parse_nested_query` uses original backtrace when reraising exception with new class. ([@jeremyevans]
|
65
|
-
- `ConditionalGet` follows RFC 7232 precedence if both If-None-Match and If-Modified-Since headers are provided. ([@jeremyevans]
|
201
|
+
- `Request#params` no longer rescues EOFError. ([@jeremyevans])
|
202
|
+
- `Directory` uses a streaming approach, significantly improving time to first byte for large directories. ([@jeremyevans])
|
203
|
+
- `Directory` no longer includes a Parent directory link in the root directory index. ([@jeremyevans])
|
204
|
+
- `QueryParser#parse_nested_query` uses original backtrace when reraising exception with new class. ([@jeremyevans])
|
205
|
+
- `ConditionalGet` follows RFC 7232 precedence if both If-None-Match and If-Modified-Since headers are provided. ([@jeremyevans])
|
66
206
|
- `.ru` files supports the `frozen-string-literal` magic comment. ([@eregon](https://github.com/eregon))
|
67
|
-
- Rely on autoload to load constants instead of requiring internal files, make sure to require 'rack' and not just 'rack/...'. ([@jeremyevans]
|
68
|
-
- `Etag` will continue sending ETag even if the response should not be cached. ([@henm](https://github.com/henm))
|
207
|
+
- Rely on autoload to load constants instead of requiring internal files, make sure to require 'rack' and not just 'rack/...'. ([@jeremyevans])
|
208
|
+
- 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))
|
69
209
|
- `Request#host_with_port` no longer includes a colon for a missing or empty port. ([@AlexWayfer](https://github.com/AlexWayfer))
|
70
|
-
- All handlers uses keywords arguments instead of an options hash argument. ([@ioquatix]
|
71
|
-
- `Files` handling of range requests no longer return a body that supports `to_path`, to ensure range requests are handled correctly. ([@jeremyevans]
|
72
|
-
- `Multipart::Generator` only includes `Content-Length` for files with paths, and `Content-Disposition` `filename` if the `UploadedFile` instance has one. ([@jeremyevans]
|
73
|
-
- `Request#ssl?` is true for the `wss` scheme (secure websockets). ([@jeremyevans]
|
74
|
-
- `Rack::HeaderHash` is memoized by default. ([#1549](https://github.com/rack/rack/pull/1549), [@ioquatix]
|
210
|
+
- All handlers uses keywords arguments instead of an options hash argument. ([@ioquatix])
|
211
|
+
- `Files` handling of range requests no longer return a body that supports `to_path`, to ensure range requests are handled correctly. ([@jeremyevans])
|
212
|
+
- `Multipart::Generator` only includes `Content-Length` for files with paths, and `Content-Disposition` `filename` if the `UploadedFile` instance has one. ([@jeremyevans])
|
213
|
+
- `Request#ssl?` is true for the `wss` scheme (secure websockets). ([@jeremyevans])
|
214
|
+
- `Rack::HeaderHash` is memoized by default. ([#1549](https://github.com/rack/rack/pull/1549), [@ioquatix])
|
75
215
|
- `Rack::Directory` allow directory traversal inside root directory. ([#1417](https://github.com/rack/rack/pull/1417), [@ThomasSevestre](https://github.com/ThomasSevestre))
|
76
|
-
- Sort encodings by server preference. ([#1184](https://github.com/rack/rack/pull/1184), [@ioquatix]
|
77
|
-
- 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]
|
78
|
-
- `Rack::Builder` parsing options on first `#\` line is deprecated. ([#1574](https://github.com/rack/rack/pull/1574), [@ioquatix]
|
216
|
+
- Sort encodings by server preference. ([#1184](https://github.com/rack/rack/pull/1184), [@ioquatix], [@wjordan](https://github.com/wjordan))
|
217
|
+
- 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])
|
218
|
+
- `Rack::Builder` parsing options on first `#\` line is deprecated. ([#1574](https://github.com/rack/rack/pull/1574), [@ioquatix])
|
79
219
|
|
80
220
|
### Removed
|
81
221
|
|
82
|
-
- `Directory#path` as it was not used and always returned nil. ([@jeremyevans]
|
83
|
-
- `BodyProxy#each` as it was only needed to work around a bug in Ruby <1.9.3. ([@jeremyevans]
|
222
|
+
- `Directory#path` as it was not used and always returned nil. ([@jeremyevans])
|
223
|
+
- `BodyProxy#each` as it was only needed to work around a bug in Ruby <1.9.3. ([@jeremyevans])
|
84
224
|
- `URLMap::INFINITY` and `URLMap::NEGATIVE_INFINITY`, in favor of `Float::INFINITY`. ([@ch1c0t](https://github.com/ch1c0t))
|
85
225
|
- Deprecation of `Rack::File`. It will be deprecated again in rack 2.2 or 3.0. ([@rafaelfranca](https://github.com/rafaelfranca))
|
86
|
-
- Support for Ruby 2.2 as it is well past EOL. ([@ioquatix]
|
87
|
-
- Remove `Rack::Files#response_body` as the implementation was broken. ([#1153](https://github.com/rack/rack/pull/1153), [@ioquatix]
|
88
|
-
- Remove `SERVER_ADDR` which was never part of the original SPEC. ([#1573](https://github.com/rack/rack/pull/1573), [@ioquatix]
|
226
|
+
- Support for Ruby 2.2 as it is well past EOL. ([@ioquatix])
|
227
|
+
- Remove `Rack::Files#response_body` as the implementation was broken. ([#1153](https://github.com/rack/rack/pull/1153), [@ioquatix])
|
228
|
+
- Remove `SERVER_ADDR` which was never part of the original SPEC. ([#1573](https://github.com/rack/rack/pull/1573), [@ioquatix])
|
89
229
|
|
90
230
|
### Fixed
|
91
231
|
|
92
|
-
- `Directory` correctly handles root paths containing glob metacharacters. ([@jeremyevans]
|
93
|
-
- `Cascade` uses a new response object for each call if initialized with no apps. ([@jeremyevans]
|
94
|
-
- `BodyProxy` correctly delegates keyword arguments to the body object on Ruby 2.7+. ([@jeremyevans]
|
95
|
-
- `BodyProxy#method` correctly handles methods delegated to the body object. ([@jeremyevans]
|
232
|
+
- `Directory` correctly handles root paths containing glob metacharacters. ([@jeremyevans])
|
233
|
+
- `Cascade` uses a new response object for each call if initialized with no apps. ([@jeremyevans])
|
234
|
+
- `BodyProxy` correctly delegates keyword arguments to the body object on Ruby 2.7+. ([@jeremyevans])
|
235
|
+
- `BodyProxy#method` correctly handles methods delegated to the body object. ([@jeremyevans])
|
96
236
|
- `Request#host` and `Request#host_with_port` handle IPv6 addresses correctly. ([@AlexWayfer](https://github.com/AlexWayfer))
|
97
|
-
- `Lint` checks when response hijacking that `rack.hijack` is called with a valid object. ([@jeremyevans]
|
98
|
-
- `Response#write` correctly updates `Content-Length` if initialized with a body. ([@jeremyevans]
|
237
|
+
- `Lint` checks when response hijacking that `rack.hijack` is called with a valid object. ([@jeremyevans])
|
238
|
+
- `Response#write` correctly updates `Content-Length` if initialized with a body. ([@jeremyevans])
|
99
239
|
- `CommonLogger` includes `SCRIPT_NAME` when logging. ([@Erol](https://github.com/Erol))
|
100
|
-
- `Utils.parse_nested_query` correctly handles empty queries, using an empty instance of the params class instead of a hash. ([@jeremyevans]
|
240
|
+
- `Utils.parse_nested_query` correctly handles empty queries, using an empty instance of the params class instead of a hash. ([@jeremyevans])
|
101
241
|
- `Directory` correctly escapes paths in links. ([@yous](https://github.com/yous))
|
102
|
-
- `Request#delete_cookie` and related `Utils` methods handle `:domain` and `:path` options in same call. ([@jeremyevans]
|
103
|
-
- `Request#delete_cookie` and related `Utils` methods do an exact match on `:domain` and `:path` options. ([@jeremyevans]
|
242
|
+
- `Request#delete_cookie` and related `Utils` methods handle `:domain` and `:path` options in same call. ([@jeremyevans])
|
243
|
+
- `Request#delete_cookie` and related `Utils` methods do an exact match on `:domain` and `:path` options. ([@jeremyevans])
|
104
244
|
- `Static` no longer adds headers when a gzipped file request has a 304 response. ([@chooh](https://github.com/chooh))
|
105
|
-
- `ContentLength` sets `Content-Length` response header even for bodies not responding to `to_ary`. ([@jeremyevans]
|
106
|
-
- Thin handler supports options passed directly to `Thin::Controllers::Controller`. ([@jeremyevans]
|
107
|
-
- WEBrick handler no longer ignores `:BindAddress` option. ([@jeremyevans]
|
108
|
-
- `ShowExceptions` handles invalid POST data. ([@jeremyevans]
|
109
|
-
- Basic authentication requires a password, even if the password is empty. ([@jeremyevans]
|
110
|
-
- `Lint` checks response is array with 3 elements, per SPEC. ([@jeremyevans]
|
245
|
+
- `ContentLength` sets `Content-Length` response header even for bodies not responding to `to_ary`. ([@jeremyevans])
|
246
|
+
- Thin handler supports options passed directly to `Thin::Controllers::Controller`. ([@jeremyevans])
|
247
|
+
- WEBrick handler no longer ignores `:BindAddress` option. ([@jeremyevans])
|
248
|
+
- `ShowExceptions` handles invalid POST data. ([@jeremyevans])
|
249
|
+
- Basic authentication requires a password, even if the password is empty. ([@jeremyevans])
|
250
|
+
- `Lint` checks response is array with 3 elements, per SPEC. ([@jeremyevans])
|
111
251
|
- Support for using `:SSLEnable` option when using WEBrick handler. (Gregor Melhorn)
|
112
|
-
- Close response body after buffering it when buffering. ([@ioquatix]
|
252
|
+
- Close response body after buffering it when buffering. ([@ioquatix])
|
113
253
|
- Only accept `;` as delimiter when parsing cookies. ([@mrageh](https://github.com/mrageh))
|
114
|
-
- `Utils::HeaderHash#clear` clears the name mapping as well. ([@raxoft](https://github.com/raxoft))
|
115
|
-
- Support for passing `nil` `Rack::Files.new`, which notably fixes Rails' current `ActiveStorage::FileServer` implementation. ([@ioquatix]
|
254
|
+
- `Utils::HeaderHash#clear` clears the name mapping as well. ([@raxoft](https://github.com/raxoft))
|
255
|
+
- Support for passing `nil` `Rack::Files.new`, which notably fixes Rails' current `ActiveStorage::FileServer` implementation. ([@ioquatix])
|
116
256
|
|
117
257
|
### Documentation
|
118
258
|
|
119
259
|
- CHANGELOG updates. ([@aupajo](https://github.com/aupajo))
|
120
260
|
- Added [CONTRIBUTING](CONTRIBUTING.md). ([@dblock](https://github.com/dblock))
|
121
261
|
|
262
|
+
## [2.0.9] - 2020-02-08
|
263
|
+
|
264
|
+
- Handle case where session id key is requested but missing ([@jeremyevans])
|
265
|
+
- Restore support for code relying on `SessionId#to_s`. ([@jeremyevans])
|
266
|
+
- Add support for `SameSite=None` cookie value. ([@hennikul](https://github.com/hennikul))
|
267
|
+
|
122
268
|
## [2.1.2] - 2020-01-27
|
123
269
|
|
124
270
|
- Fix multipart parser for some files to prevent denial of service ([@aiomaster](https://github.com/aiomaster))
|
125
271
|
- Fix `Rack::Builder#use` with keyword arguments ([@kamipo](https://github.com/kamipo))
|
126
|
-
- Skip deflating in Rack::Deflater if Content-Length is 0 ([@jeremyevans]
|
272
|
+
- Skip deflating in Rack::Deflater if Content-Length is 0 ([@jeremyevans])
|
127
273
|
- Remove `SessionHash#transform_keys`, no longer needed ([@pavel](https://github.com/pavel))
|
128
274
|
- Add to_hash to wrap Hash and Session classes ([@oleh-demyanyuk](https://github.com/oleh-demyanyuk))
|
129
|
-
- Handle case where session id key is requested but missing ([@jeremyevans]
|
275
|
+
- Handle case where session id key is requested but missing ([@jeremyevans])
|
130
276
|
|
131
277
|
## [2.1.1] - 2020-01-12
|
132
278
|
|
133
|
-
- Remove `Rack::Chunked` from `Rack::Server` default middleware. ([#1475](https://github.com/rack/rack/pull/1475), [@ioquatix]
|
134
|
-
- Restore support for code relying on `SessionId#to_s`. ([@jeremyevans]
|
279
|
+
- Remove `Rack::Chunked` from `Rack::Server` default middleware. ([#1475](https://github.com/rack/rack/pull/1475), [@ioquatix])
|
280
|
+
- Restore support for code relying on `SessionId#to_s`. ([@jeremyevans])
|
135
281
|
|
136
282
|
## [2.1.0] - 2020-01-10
|
137
283
|
|
@@ -148,13 +294,13 @@ All notable changes to this project will be documented in this file. For info on
|
|
148
294
|
- Add boot-time profiling capabilities to `rackup`. ([@tenderlove](https://github.com/tenderlove))
|
149
295
|
- Add multi mapping support for `X-Accel-Mappings` header. ([@yoshuki](https://github.com/yoshuki))
|
150
296
|
- Add `sync: false` option to `Rack::Deflater`. (Eric Wong)
|
151
|
-
- Add `Builder#freeze_app` to freeze application and all middleware instances. ([@jeremyevans]
|
297
|
+
- Add `Builder#freeze_app` to freeze application and all middleware instances. ([@jeremyevans])
|
152
298
|
- Add API to extract cookies from `Rack::MockResponse`. ([@petercline](https://github.com/petercline))
|
153
299
|
|
154
300
|
### Changed
|
155
301
|
|
156
|
-
- Don't propagate nil values from middleware. ([@ioquatix]
|
157
|
-
- Lazily initialize the response body and only buffer it if required. ([@ioquatix]
|
302
|
+
- Don't propagate nil values from middleware. ([@ioquatix])
|
303
|
+
- Lazily initialize the response body and only buffer it if required. ([@ioquatix])
|
158
304
|
- Fix deflater zlib buffer errors on empty body part. ([@felixbuenemann](https://github.com/felixbuenemann))
|
159
305
|
- Set `X-Accel-Redirect` to percent-encoded path. ([@diskkid](https://github.com/diskkid))
|
160
306
|
- Remove unnecessary buffer growing when parsing multipart. ([@tainoe](https://github.com/tainoe))
|
@@ -167,15 +313,15 @@ All notable changes to this project will be documented in this file. For info on
|
|
167
313
|
- Make `Utils.status_code` raise an error when the status symbol is invalid instead of `500`. ([@adambutler](https://github.com/adambutler))
|
168
314
|
- Rename `Request::SCHEME_WHITELIST` to `Request::ALLOWED_SCHEMES`.
|
169
315
|
- Make `Multipart::Parser.get_filename` accept files with `+` in their name. ([@lucaskanashiro](https://github.com/lucaskanashiro))
|
170
|
-
- Add Falcon to the default handler fallbacks. ([@ioquatix]
|
316
|
+
- Add Falcon to the default handler fallbacks. ([@ioquatix])
|
171
317
|
- Update codebase to avoid string mutations in preparation for `frozen_string_literals`. ([@pat](https://github.com/pat))
|
172
318
|
- Change `MockRequest#env_for` to rely on the input optionally responding to `#size` instead of `#length`. ([@janko](https://github.com/janko))
|
173
|
-
- Rename `Rack::File` -> `Rack::Files` and add deprecation notice. ([@postmodern](https://github.com/postmodern))
|
174
|
-
- Prefer Base64 “strict encoding” for Base64 cookies. ([@ioquatix]
|
319
|
+
- Rename `Rack::File` -> `Rack::Files` and add deprecation notice. ([@postmodern](https://github.com/postmodern))
|
320
|
+
- Prefer Base64 “strict encoding” for Base64 cookies. ([@ioquatix])
|
175
321
|
|
176
322
|
### Removed
|
177
323
|
|
178
|
-
- Remove `to_ary` from Response ([@tenderlove](https://github.com/tenderlove))
|
324
|
+
- BREAKING CHANGE: Remove `to_ary` from Response ([@tenderlove](https://github.com/tenderlove))
|
179
325
|
- Deprecate `Rack::Session::Memcache` in favor of `Rack::Session::Dalli` from dalli gem ([@fatkodima](https://github.com/fatkodima))
|
180
326
|
|
181
327
|
### Fixed
|
@@ -256,7 +402,7 @@ All notable changes to this project will be documented in this file. For info on
|
|
256
402
|
### Added
|
257
403
|
|
258
404
|
- Allow `Session::Abstract::SessionHash#fetch` to accept a block with a default value. ([@yannvanhalewyn](https://github.com/yannvanhalewyn))
|
259
|
-
- Add `Builder#freeze_app` to freeze application and all middleware. ([@jeremyevans]
|
405
|
+
- Add `Builder#freeze_app` to freeze application and all middleware. ([@jeremyevans])
|
260
406
|
|
261
407
|
### Changed
|
262
408
|
|
@@ -268,9 +414,9 @@ All notable changes to this project will be documented in this file. For info on
|
|
268
414
|
### Fixed
|
269
415
|
|
270
416
|
- Handle `NULL` bytes in multipart filenames. ([@casperisfine](https://github.com/casperisfine))
|
271
|
-
- Remove warnings due to miscapitalized global. ([@ioquatix]
|
417
|
+
- Remove warnings due to miscapitalized global. ([@ioquatix])
|
272
418
|
- Prevent exceptions caused by a race condition on multi-threaded servers. ([@sophiedeziel](https://github.com/sophiedeziel))
|
273
|
-
- Add RDoc as an explicit
|
419
|
+
- Add RDoc as an explicit dependency for `doc` group. ([@tonytonyjan](https://github.com/tonytonyjan))
|
274
420
|
- Record errors originating from `Multipart::Parser` in the `MethodOverride` middleware instead of letting them bubble up. ([@carlzulauf](https://github.com/carlzulauf))
|
275
421
|
- Remove remaining use of removed `Utils#bytesize` method from the `File` middleware. ([@brauliomartinezlm](https://github.com/brauliomartinezlm))
|
276
422
|
|
@@ -588,7 +734,7 @@ Items below this line are from the previously maintained HISTORY.md and NEWS.md
|
|
588
734
|
- Moved Auth::OpenID to rack-contrib.
|
589
735
|
- SPEC change that relaxes Lint slightly to allow subclasses of the
|
590
736
|
required types
|
591
|
-
- SPEC change to document rack.input binary mode in
|
737
|
+
- SPEC change to document rack.input binary mode in greater detail
|
592
738
|
- SPEC define optional rack.logger specification
|
593
739
|
- File servers support X-Cascade header
|
594
740
|
- Imported Config middleware
|
@@ -706,3 +852,9 @@ Items below this line are from the previously maintained HISTORY.md and NEWS.md
|
|
706
852
|
- Removed Rails adapter, was too alpha.
|
707
853
|
|
708
854
|
## [0.1] 2007-03-03
|
855
|
+
|
856
|
+
[@ioquatix]: https://github.com/ioquatix "Samuel Williams"
|
857
|
+
[@jeremyevans]: https://github.com/jeremyevans "Jeremy Evans"
|
858
|
+
[@amatsuda]: https://github.com/amatsuda "Akira Matsuda"
|
859
|
+
[@wjordan]: https://github.com/wjordan "Will Jordan"
|
860
|
+
[@BlakeWilliams]: https://github.com/BlakeWilliams "Blake Williams"
|
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
|
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
|
-
|
8
|
+
## Fork the Project
|
7
9
|
|
8
|
-
Fork the [project on
|
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/
|
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
|
-
|
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
|
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
|
22
|
-
git pull upstream
|
25
|
+
git checkout main
|
26
|
+
git pull upstream main
|
23
27
|
git checkout -b my-feature-branch
|
24
28
|
```
|
25
29
|
|
26
|
-
|
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
|
-
|
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
|
-
|
53
|
+
## Write Tests
|
50
54
|
|
51
|
-
|
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
|
-
|
58
|
+
We definitely appreciate pull requests that highlight or reproduce a problem,
|
59
|
+
even without a fix.
|
54
60
|
|
55
|
-
|
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
|
65
|
+
Make sure that all tests pass:
|
66
|
+
|
67
|
+
```
|
68
|
+
bundle exec rake test
|
69
|
+
```
|
72
70
|
|
73
|
-
|
71
|
+
## Write Documentation
|
74
72
|
|
75
|
-
Document any external behavior in the [README](README.
|
73
|
+
Document any external behavior in the [README](README.md).
|
76
74
|
|
77
|
-
|
75
|
+
## Update Changelog
|
78
76
|
|
79
77
|
Add a line to [CHANGELOG](CHANGELOG.md).
|
80
78
|
|
81
|
-
|
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
|
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
|
-
|
96
|
+
## Push
|
98
97
|
|
99
98
|
```
|
100
99
|
git push origin my-feature-branch
|
101
100
|
```
|
102
101
|
|
103
|
-
|
102
|
+
## Make a Pull Request
|
104
103
|
|
105
|
-
Go to
|
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
|
-
|
108
|
+
## Rebase
|
108
109
|
|
109
|
-
If you've been working on a change for a while, rebase with upstream/
|
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/
|
114
|
+
git rebase upstream/main
|
114
115
|
git push origin my-feature-branch -f
|
115
116
|
```
|
116
117
|
|
117
|
-
|
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
|
-
|
127
|
+
## Check on Your Pull Request
|
127
128
|
|
128
|
-
Go back to your pull request after a few minutes and see whether it passed
|
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
|
-
|
133
|
+
## Be Patient
|
131
134
|
|
132
|
-
It's likely that your change will not be merged and that the nitpicky
|
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
|
-
|
139
|
+
## Thank You
|
135
140
|
|
136
|
-
Please do know that we really appreciate and value your time and work. We love
|
141
|
+
Please do know that we really appreciate and value your time and work. We love
|
142
|
+
you, really.
|
data/MIT-LICENSE
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
The MIT License (MIT)
|
2
2
|
|
3
|
-
Copyright (C) 2007-
|
3
|
+
Copyright (C) 2007-2021 Leah Neukirchen <http://leahneukirchen.org/infopage.html>
|
4
4
|
|
5
5
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
6
|
of this software and associated documentation files (the "Software"), to
|