Replace NewTemplateResponse and NewJSONResponse with JSONResp and Tem…

…plateResp
google · Oct 14, 2020 · 01d472f · 01d472f
1 parent b9de362
commit 01d472f
Show file tree

Hide file tree

Showing 7 changed files with 19 additions and 19 deletions.
diff --git a/safehttp/default_dispatcher_test.go b/safehttp/default_dispatcher_test.go
@@ -51,7 +51,7 @@ func TestDefaultDispatcherValidResponse(t *testing.T) {
 						Parse("<h1>{{ . }}</h1>")))
 				var data interface{}
 				data = "This is an actual heading, though."
-				return d.Write(w, safehttp.NewTemplateResponse(t, data, nil))
+				return d.Write(w, safehttp.TemplateResp(t, data, nil))
 			},
 			wantBody: "<h1>This is an actual heading, though.</h1>",
 		},
@@ -69,7 +69,7 @@ func TestDefaultDispatcherValidResponse(t *testing.T) {
 				fm := map[string]interface{}{
 					"Token": func() string { return "Token-secret" },
 				}
-				return d.Write(w, safehttp.NewTemplateResponse(t, data, fm))
+				return d.Write(w, safehttp.TemplateResp(t, data, fm))
 			},
 			wantBody: `<form><input type="hidden" name="token" value="Token-secret">Content</form>`,
 		},
@@ -87,7 +87,7 @@ func TestDefaultDispatcherValidResponse(t *testing.T) {
 				fm := map[string]interface{}{
 					"Nonce": func() string { return "Nonce-secret" },
 				}
-				return d.Write(w, safehttp.NewTemplateResponse(t, data, fm))
+				return d.Write(w, safehttp.TemplateResp(t, data, fm))
 			},
 			wantBody: `<script nonce="Nonce-secret" type="application/javascript">alert("script")</script><h1>Content</h1>`,
 		},
@@ -98,7 +98,7 @@ func TestDefaultDispatcherValidResponse(t *testing.T) {
 				data := struct {
 					Field string `json:"field"`
 				}{Field: "myField"}
-				return d.Write(w, safehttp.NewJSONResponse(data))
+				return d.Write(w, safehttp.JSONResp(data))
 			},
 			wantBody: ")]}',\n{\"field\":\"myField\"}\n",
 		},
@@ -144,15 +144,15 @@ func TestDefaultDispatcherInvalidResponse(t *testing.T) {
 						Parse("<h1>{{ . }}</h1>")))
 				var data interface{}
 				data = "This is an actual heading, though."
-				return d.Write(w, safehttp.NewTemplateResponse(t, data, nil))
+				return d.Write(w, safehttp.TemplateResp(t, data, nil))
 			},
 			want: "",
 		},
 		{
 			name: "Invalid JSON Response",
 			write: func(w http.ResponseWriter) error {
 				d := &safehttp.DefaultDispatcher{}
-				return d.Write(w, safehttp.NewJSONResponse(math.Inf(1)))
+				return d.Write(w, safehttp.JSONResp(math.Inf(1)))
 			},
 			want: ")]}',\n",
 		},

diff --git a/safehttp/response.go b/safehttp/response.go
@@ -52,20 +52,20 @@ type TemplateResponse struct {
 // ResponseWriter.NoContent.
 type NoContentResponse struct{}
 
-// NewJSONResponse creates a JSON response from a data object. This should be a
+// JSONResp creates a JSONResponse from a data object. This should be a
 // valid JSON object that can be serialised and written to the
 // http.ResponseWriter using a JSON encoder.
-func NewJSONResponse(data interface{}) JSONResponse {
+func JSONResp(data interface{}) JSONResponse {
 	return JSONResponse{Data: data}
 }
 
-// NewTemplateResponse creates a TemplateResponse from a Template, its data and
+// TemplateResp creates a TemplateResponse from a Template, its data and
 // the name to function mappings. These will be pre-processed and then written
 // to the http.ResponseWriter, if deemed safe. If the funcMap is non-nil, its
 // elements will override the existing name to function mappings in the
 // template. An attempt to define a new name to function mapping that is not
 // already in the template will result in a panic.
-func NewTemplateResponse(t Template, data interface{}, funcMap map[string]interface{}) TemplateResponse {
+func TemplateResp(t Template, data interface{}, funcMap map[string]interface{}) TemplateResponse {
 	return TemplateResponse{
 		Template: &t,
 		Data:     &data,

diff --git a/safehttp/response_writer_test.go b/safehttp/response_writer_test.go
@@ -118,13 +118,13 @@ func TestResponseWriterUnsafeResponse(t *testing.T) {
 		{
 			name: "Invalid JSON Response",
 			write: func(w *safehttp.ResponseWriter) {
-				w.Write(safehttp.NewJSONResponse(math.Inf(1)))
+				w.Write(safehttp.JSONResp(math.Inf(1)))
 			},
 		},
 		{
 			name: "Unsafe Template Response",
 			write: func(w *safehttp.ResponseWriter) {
-				w.Write(safehttp.NewTemplateResponse(template.
+				w.Write(safehttp.TemplateResp(template.
 					Must(template.New("name").
 						Parse("<h1>{{ . }}</h1>")), "This is an actual heading, though.", nil))
 			},

diff --git a/tests/integration/csp/csp_test.go b/tests/integration/csp/csp_test.go
@@ -44,7 +44,7 @@ func TestServeMuxInstallCSP(t *testing.T) {
 		nonce, err = csp.Nonce(r.Context())
 		t := template.Must(template.New("name").Funcs(fns).Parse(`<script nonce="{{CSPNonce}}" type="application/javascript">alert("script")</script><h1>{{.}}</h1>`))
 
-		return w.Write(safehttp.NewTemplateResponse(t, "Content", fns))
+		return w.Write(safehttp.TemplateResp(t, "Content", fns))
 	})
 	mb.Handle("/bar", safehttp.MethodGet, handler)
 

diff --git a/tests/integration/mux/mux_test.go b/tests/integration/mux/mux_test.go
@@ -48,7 +48,7 @@ func TestMuxDefaultDispatcher(t *testing.T) {
 		{
 			name: "Safe HTML Template Response",
 			handler: safehttp.HandlerFunc(func(w *safehttp.ResponseWriter, r *safehttp.IncomingRequest) safehttp.Result {
-				return w.Write(safehttp.NewTemplateResponse(safetemplate.
+				return w.Write(safehttp.TemplateResp(safetemplate.
 					Must(safetemplate.New("name").
 						Parse("<h1>{{ . }}</h1>")), "This is an actual heading, though.", nil))
 			}),
@@ -63,7 +63,7 @@ func TestMuxDefaultDispatcher(t *testing.T) {
 				data := struct {
 					Field string `json:"field"`
 				}{Field: "myField"}
-				return w.Write(safehttp.NewJSONResponse(data))
+				return w.Write(safehttp.JSONResp(data))
 			}),
 			wantHeaders: map[string][]string{
 				"Content-Type": {"application/json; charset=utf-8"},
@@ -110,15 +110,15 @@ func TestMuxDefaultDispatcherUnsafeResponses(t *testing.T) {
 		{
 			name: "Unsafe Template Response",
 			handler: safehttp.HandlerFunc(func(w *safehttp.ResponseWriter, r *safehttp.IncomingRequest) safehttp.Result {
-				return w.Write(safehttp.NewTemplateResponse(template.
+				return w.Write(safehttp.TemplateResp(template.
 					Must(template.New("name").
 						Parse("<h1>{{ . }}</h1>")), "This is an actual heading, though.", nil))
 			}),
 		},
 		{
 			name: "Invalid JSON Response",
 			handler: safehttp.HandlerFunc(func(w *safehttp.ResponseWriter, r *safehttp.IncomingRequest) safehttp.Result {
-				return w.Write(safehttp.NewJSONResponse(math.Inf(1)))
+				return w.Write(safehttp.JSONResp(math.Inf(1)))
 			}),
 		},
 	}

diff --git a/tests/integration/safehtml/safehtml_test.go b/tests/integration/safehtml/safehtml_test.go
@@ -49,7 +49,7 @@ func TestHandleRequestWrite(t *testing.T) {
 func TestHandleRequestWriteTemplate(t *testing.T) {
 	mb := &safehttp.ServeMuxConfig{}
 	mb.Handle("/", safehttp.MethodGet, safehttp.HandlerFunc(func(rw *safehttp.ResponseWriter, ir *safehttp.IncomingRequest) safehttp.Result {
-		return rw.Write(safehttp.NewTemplateResponse(template.Must(template.New("name").Parse("<h1>{{ . }}</h1>")), "This is an actual heading, though.", nil))
+		return rw.Write(safehttp.TemplateResp(template.Must(template.New("name").Parse("<h1>{{ . }}</h1>")), "This is an actual heading, though.", nil))
 	}))
 
 	req := httptest.NewRequest(safehttp.MethodGet, "http://foo.com/", nil)

diff --git a/tests/integration/xsrf/xsrf_test.go b/tests/integration/xsrf/xsrf_test.go
@@ -43,7 +43,7 @@ func TestServeMuxInstallXSRF(t *testing.T) {
 		token, err = xsrf.Token(r)
 		t := template.Must(template.New("name").Funcs(fns).Parse(`<form><input type="hidden" name="token" value="{{XSRFToken}}">{{.}}</form>`))
 
-		return w.Write(safehttp.NewTemplateResponse(t, "Content", fns))
+		return w.Write(safehttp.TemplateResp(t, "Content", fns))
 	})
 	mb.Handle("/bar", safehttp.MethodGet, handler)