pkg/shelf Include default bodies for 'Not Found' and 'Forbidden' Response

pkg/shelf/lib/src/response.dart

 // Copyright (c) 2014, the Dart project authors.  Please see the AUTHORS file
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
 library shelf.response;
 
 import 'dart:async';
 import 'dart:convert';
 
 import 'package:http_parser/http_parser.dart';
@@ skipping 126 matching lines @@
   Response.notModified({Map<String, String> headers,
     Map<String, Object> context})
       : this(304, headers: _addHeader(
             headers, 'date', formatHttpDate(new DateTime.now())),
             context: context);
 
   /// Constructs a 403 Forbidden response.
   ///
   /// This indicates that the server is refusing to fulfill the request.
   ///
-  /// [body] is the response body. It may be either a [String], a
-  /// [Stream<List<int>>], or `null` to indicate no body. If it's a [String],
-  /// [encoding] is used to encode it to a [Stream<List<int>>]. It defaults to
-  /// UTF-8.
+  /// [body] is the response body. It may be either a [String] or a
+  /// [Stream<List<int>>].

[nweiz, 2014/09/23 00:09:38]

This should still include "or `null`".

[kevmoo, 2014/09/23 05:00:04]

Done.

+  /// If it's a [String], [encoding] is used to encode it to a
+  /// [Stream<List<int>>]. The default encoding is UTF-8.
+  /// If it's `null` or not passed, a default error message is used.

[nweiz, 2014/09/23 00:09:38]

Nit: keep this text nicely line-wrapped.

[kevmoo, 2014/09/23 05:00:04]

Done.

   ///
   /// If [encoding] is passed, the "encoding" field of the Content-Type header
   /// in [headers] will be set appropriately. If there is no existing
   /// Content-Type header, it will be set to "application/octet-stream".
   Response.forbidden(body, {Map<String, String> headers,
       Encoding encoding, Map<String, Object> context})
-      : this(403, body: body, headers: headers,
+      : this(403,
+          headers: body == null ? _adjustErrorHeaders(headers) : headers,
+          body: body == null ? 'Forbidden' : body,
           context: context);
 
   /// Constructs a 404 Not Found response.
   ///
   /// This indicates that the server didn't find any resource matching the
   /// requested URI.
   ///
-  /// [body] is the response body. It may be either a [String], a
-  /// [Stream<List<int>>], or `null` to indicate no body. If it's a [String],
-  /// [encoding] is used to encode it to a [Stream<List<int>>]. It defaults to
-  /// UTF-8.
+  /// [body] is the response body. It may be either a [String] or a
+  /// [Stream<List<int>>].
+  /// If it's a [String], [encoding] is used to encode it to a
+  /// [Stream<List<int>>]. The default encoding is UTF-8.
+  /// If it's `null` or not passed, a default error message is used.
   ///
   /// If [encoding] is passed, the "encoding" field of the Content-Type header
   /// in [headers] will be set appropriately. If there is no existing
   /// Content-Type header, it will be set to "application/octet-stream".
   Response.notFound(body, {Map<String, String> headers, Encoding encoding,
     Map<String, Object> context})
-      : this(404, body: body, headers: headers,
+      : this(404,
+          headers: body == null ? _adjustErrorHeaders(headers) : headers,
+          body: body == null ? 'Not Found' : body,
           context: context);
 
   /// Constructs a 500 Internal Server Error response.
   ///
   /// This indicates that the server had an internal error that prevented it
   /// from fulfilling the request.
   ///
-  /// [body] is the response body. It may be either a [String], a
-  /// [Stream<List<int>>], or `null` to indicate no body. If it's `null` or not
-  /// passed, a default error message is used. If it's a [String], [encoding] is
-  /// used to encode it to a [Stream<List<int>>]. It defaults to UTF-8.
+  /// [body] is the response body. It may be either a [String] or a
+  /// [Stream<List<int>>].
+  /// If it's a [String], [encoding] is used to encode it to a
+  /// [Stream<List<int>>]. The default encoding is UTF-8.
+  /// If it's `null` or not passed, a default error message is used.
   ///
   /// If [encoding] is passed, the "encoding" field of the Content-Type header
   /// in [headers] will be set appropriately. If there is no existing
   /// Content-Type header, it will be set to "application/octet-stream".
   Response.internalServerError({body, Map<String, String> headers,
       Encoding encoding, Map<String, Object> context})
       : this(500,
-            headers: body == null ? _adjust500Headers(headers) : headers,
+            headers: body == null ? _adjustErrorHeaders(headers) : headers,
             body: body == null ? 'Internal Server Error' : body,
             context: context);
 
   /// Constructs an HTTP response with the given [statusCode].
   ///
   /// [statusCode] must be greater than or equal to 100.
   ///
   /// [body] is the response body. It may be either a [String], a
-  /// [Stream<List<int>>], or `null` to indicate no body. If it's `null` or not
-  /// passed, a default error message is used. If it's a [String], [encoding] is
-  /// used to encode it to a [Stream<List<int>>]. It defaults to UTF-8.
+  /// [Stream<List<int>>], or `null` to indicate no body.
+  /// If it's a [String], [encoding] is used to encode it to a
+  /// [Stream<List<int>>]. The default encoding is UTF-8.
   ///
   /// If [encoding] is passed, the "encoding" field of the Content-Type header
   /// in [headers] will be set appropriately. If there is no existing
   /// Content-Type header, it will be set to "application/octet-stream".
   Response(this.statusCode, {body, Map<String, String> headers,
       Encoding encoding, Map<String, Object> context})
       : super(_bodyToStream(body, encoding),
           headers: _adjustHeaders(headers, encoding),
           context: context) {
     if (statusCode < 100) {
@@ skipping 60 matching lines @@
     String value) {
   headers = headers == null ? {} : new Map.from(headers);
   headers[name] = value;
   return headers;
 }
 
 /// Adds content-type information to [headers].
 ///
 /// Returns a new map without modifying [headers]. This is used to add
 /// content-type information when creating a 500 response with a default body.
-Map<String, String> _adjust500Headers(Map<String, String> headers) {
+Map<String, String> _adjustErrorHeaders(Map<String, String> headers) {
   if (headers == null || headers['content-type'] == null) {
     return _addHeader(headers, 'content-type', 'text/plain');
   }
 
   var contentType = new MediaType.parse(headers['content-type'])
       .change(mimeType: 'text/plain');
   return _addHeader(headers, 'content-type', contentType.toString());
 }
 
 /// Converts [location], which may be a [String] or a [Uri], to a [String].
 ///
 /// Throws an [ArgumentError] if [location] isn't a [String] or a [Uri].
 String _locationToString(location) {
   if (location is String) return location;
   if (location is Uri) return location.toString();
 
   throw new ArgumentError('Response location must be a String or Uri, was '
       '"$location".');
 }