Skip to content

Commit a343bf7

Browse files
shawncatzshawncatz
authored
Merge pull request revel#1138 from pedromorgan/viewargs
rename RenderArgs to ViewArgs
2 parents 2b85e8d + 0635cc3 commit a343bf7

File tree

7 files changed

+29
-29
lines changed

7 files changed

+29
-29
lines changed

‎controller.go

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ type Controller struct {
3636
Session Session // Session, stored in cookie, signed.
3737
Params *Params // Parameters from URL and form (including multipart).
3838
Args map[string]interface{} // Per-request scratch space.
39-
RenderArgs map[string]interface{} // Args passed to the template.
39+
ViewArgs map[string]interface{} // Variables passed to the template.
4040
Validation *Validation // Data validation helpers
4141
}
4242

@@ -47,7 +47,7 @@ func NewController(req *Request, resp *Response) *Controller {
4747
Response: resp,
4848
Params: new(Params),
4949
Args: map[string]interface{}{},
50-
RenderArgs: map[string]interface{}{
50+
ViewArgs: map[string]interface{}{
5151
"RunMode": RunMode,
5252
"DevMode": DevMode,
5353
},
@@ -69,7 +69,7 @@ func (c *Controller) SetCookie(cookie *http.Cookie) {
6969
func (c *Controller) RenderError(err error) Result {
7070
c.setStatusIfNil(http.StatusInternalServerError)
7171

72-
return ErrorResult{c.RenderArgs, err}
72+
return ErrorResult{c.ViewArgs, err}
7373
}
7474

7575
func (c *Controller) setStatusIfNil(status int) {
@@ -79,7 +79,7 @@ func (c *Controller) setStatusIfNil(status int) {
7979
}
8080

8181
// Render a template corresponding to the calling Controller method.
82-
// Arguments will be added to c.RenderArgs prior to rendering the template.
82+
// Arguments will be added to c.ViewArgs prior to rendering the template.
8383
// They are keyed on their local identifier.
8484
//
8585
// For example:
@@ -91,7 +91,7 @@ func (c *Controller) setStatusIfNil(status int) {
9191
//
9292
// This action will render views/Users/ShowUser.html, passing in an extra
9393
// key-value "user": (User).
94-
func (c *Controller) Render(extraRenderArgs ...interface{}) Result {
94+
func (c *Controller) Render(extraViewArgs ...interface{}) Result {
9595
c.setStatusIfNil(http.StatusOK)
9696

9797
// Get the calling function name.
@@ -100,15 +100,15 @@ func (c *Controller) Render(extraRenderArgs ...interface{}) Result {
100100
ERROR.Println("Failed to get Caller information")
101101
}
102102

103-
// Get the extra RenderArgs passed in.
103+
// Get the extra ViewArgs passed in.
104104
if renderArgNames, ok := c.MethodType.RenderArgNames[line]; ok {
105-
if len(renderArgNames) == len(extraRenderArgs) {
106-
for i, extraRenderArg := range extraRenderArgs {
107-
c.RenderArgs[renderArgNames[i]] = extraRenderArg
105+
if len(renderArgNames) == len(extraViewArgs) {
106+
for i, extraRenderArg := range extraViewArgs {
107+
c.ViewArgs[renderArgNames[i]] = extraRenderArg
108108
}
109109
} else {
110110
ERROR.Println(len(renderArgNames), "RenderArg names found for",
111-
len(extraRenderArgs), "extra RenderArgs")
111+
len(extraViewArgs), "extra ViewArgs")
112112
}
113113
} else {
114114
ERROR.Println("No RenderArg names found for Render call on line", line,
@@ -119,7 +119,7 @@ func (c *Controller) Render(extraRenderArgs ...interface{}) Result {
119119
}
120120

121121
// RenderTemplate method does less magical way to render a template.
122-
// Renders the given template, using the current RenderArgs.
122+
// Renders the given template, using the current ViewArgs.
123123
func (c *Controller) RenderTemplate(templatePath string) Result {
124124
c.setStatusIfNil(http.StatusOK)
125125

@@ -131,7 +131,7 @@ func (c *Controller) RenderTemplate(templatePath string) Result {
131131

132132
return &RenderTemplateResult{
133133
Template: template,
134-
RenderArgs: c.RenderArgs,
134+
ViewArgs: c.ViewArgs,
135135
}
136136
}
137137

‎flash.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ func (f Flash) Success(msg string, args ...interface{}) {
4545
// The name of the Flash cookie is set as CookiePrefix + "_FLASH".
4646
func FlashFilter(c *Controller, fc []Filter) {
4747
c.Flash = restoreFlash(c.Request.Request)
48-
c.RenderArgs["flash"] = c.Flash.Data
48+
c.ViewArgs["flash"] = c.Flash.Data
4949

5050
fc[0](c, fc[1:])
5151

‎i18n.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,7 @@ func I18nFilter(c *Controller, fc []Filter) {
190190
// Set the current locale controller argument (CurrentLocaleControllerArg) with the given locale.
191191
func setCurrentLocaleControllerArguments(c *Controller, locale string) {
192192
c.Request.Locale = locale
193-
c.RenderArgs[CurrentLocaleRenderArg] = locale
193+
c.ViewArgs[CurrentLocaleRenderArg] = locale
194194
}
195195

196196
// Determine whether the given request has valid Accept-Language value.

‎invoker_test.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ func BenchmarkSetAction(b *testing.B) {
104104
RegisterController((*Mixin2)(nil), []*MethodType{{Name: "Method"}})
105105
RegisterController((*Benchmark)(nil), []*MethodType{{Name: "Method"}})
106106
c := Controller{
107-
RenderArgs: make(map[string]interface{}),
107+
ViewArgs: make(map[string]interface{}),
108108
}
109109

110110
for i := 0; i < b.N; i++ {
@@ -118,7 +118,7 @@ func BenchmarkSetAction(b *testing.B) {
118118
func BenchmarkInvoker(b *testing.B) {
119119
startFakeBookingApp()
120120
c := Controller{
121-
RenderArgs: make(map[string]interface{}),
121+
ViewArgs: make(map[string]interface{}),
122122
}
123123
if err := c.SetAction("Hotels", "Show"); err != nil {
124124
b.Errorf("Failed to set action: %s", err)

‎results.go

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ type Result interface {
2929
// It renders the relevant error page (errors/CODE.format, e.g. errors/500.json).
3030
// If RunMode is "dev", this results in a friendly error page.
3131
type ErrorResult struct {
32-
RenderArgs map[string]interface{}
32+
ViewArgs map[string]interface{}
3333
Error error
3434
}
3535

@@ -82,16 +82,16 @@ func (r ErrorResult) Apply(req *Request, resp *Response) {
8282
panic("no error provided")
8383
}
8484

85-
if r.RenderArgs == nil {
86-
r.RenderArgs = make(map[string]interface{})
85+
if r.ViewArgs == nil {
86+
r.ViewArgs = make(map[string]interface{})
8787
}
88-
r.RenderArgs["RunMode"] = RunMode
89-
r.RenderArgs["Error"] = revelError
90-
r.RenderArgs["Router"] = MainRouter
88+
r.ViewArgs["RunMode"] = RunMode
89+
r.ViewArgs["Error"] = revelError
90+
r.ViewArgs["Router"] = MainRouter
9191

9292
// Render it.
9393
var b bytes.Buffer
94-
err = tmpl.Render(&b, r.RenderArgs)
94+
err = tmpl.Render(&b, r.ViewArgs)
9595

9696
// If there was an error, print it in plain text.
9797
if err != nil {
@@ -130,7 +130,7 @@ func (r PlaintextErrorResult) Apply(req *Request, resp *Response) {
130130
// a template be rendered.
131131
type RenderTemplateResult struct {
132132
Template Template
133-
RenderArgs map[string]interface{}
133+
ViewArgs map[string]interface{}
134134
}
135135

136136
func (r *RenderTemplateResult) Apply(req *Request, resp *Response) {
@@ -225,7 +225,7 @@ func (r *RenderTemplateResult) Apply(req *Request, resp *Response) {
225225
}
226226

227227
func (r *RenderTemplateResult) render(req *Request, resp *Response, wr io.Writer) {
228-
err := r.Template.Render(wr, r.RenderArgs)
228+
err := r.Template.Render(wr, r.ViewArgs)
229229
if err == nil {
230230
return
231231
}
@@ -249,7 +249,7 @@ func (r *RenderTemplateResult) render(req *Request, resp *Response, wr io.Writer
249249
}
250250
resp.Status = 500
251251
ERROR.Printf("Template Execution Error (in %s): %s", templateName, description)
252-
ErrorResult{r.RenderArgs, compileError}.Apply(req, resp)
252+
ErrorResult{r.ViewArgs, compileError}.Apply(req, resp)
253253
}
254254

255255
type RenderHTMLResult struct {

‎session.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ func SessionFilter(c *Controller, fc []Filter) {
151151
sessionWasEmpty := len(c.Session) == 0
152152

153153
// Make session vars available in templates as {{.session.xyz}}
154-
c.RenderArgs["session"] = c.Session
154+
c.ViewArgs["session"] = c.Session
155155

156156
fc[0](c, fc[1:])
157157

‎validation.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -194,8 +194,8 @@ func ValidationFilter(c *Controller, fc []Filter) {
194194

195195
fc[0](c, fc[1:])
196196

197-
// Add Validation errors to RenderArgs.
198-
c.RenderArgs["errors"] = c.Validation.ErrorMap()
197+
// Add Validation errors to ViewArgs.
198+
c.ViewArgs["errors"] = c.Validation.ErrorMap()
199199

200200
// Store the Validation errors
201201
var errorsValue string

0 commit comments

Comments
 (0)