add RenderWith

[mei-rune]

RenderWith will is not panic while render is fail.

[codecov-io]

Codecov Report

Merging #773 into develop will decrease coverage by 2.99%.
The diff coverage is 100%.

@@            Coverage Diff            @@
##           develop     #773    +/-   ##
=========================================
- Coverage    96.17%   93.18%    -3%     
=========================================
  Files           16       15     -1     
  Lines         1413     1291   -122     
=========================================
- Hits          1359     1203   -156     
- Misses          43       76    +33     
- Partials        11       12     +1

Impacted Files	Coverage Δ
context.go	86.69% <100%> (-9.58%)	⬇️
debug.go	58.82% <0%> (-41.18%)	⬇️
errors.go	97.18% <0%> (-2.82%)	⬇️
gin.go	87.91% <0%> (-2.73%)	⬇️
fs.go	100% <0%> (ø)	⬆️
logger.go	100% <0%> (ø)	⬆️
deprecated.go	0% <0%> (ø)	⬆️
tree.go	100% <0%> (ø)	⬆️
test_helpers.go

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6613cdb...56f1a06. Read the comment docs.

[appleboy]

Please provide testing code.

[robvdl]

I know this will break backwards compatibility so isn't likely to get renamed, but shouldn't RenderWith technicall be called Render as it returns an error, and Render then called MustRender (since it panics) and that seems to be the naming convention in Go for methods that panic.

But this is the next best thing, thanks, I really needed a render method that doesn't panic.

I also had an issue that the Instance method panics rather than return an error, which was a bit annoying when I was building a custom renderer a while back, issue #678 described that.

[mei-rune]

I add test code

[robvdl]

I know I am not one of the Gin contributors so I don't really have say in this, so merge it if you want, but...

I still stand by the fact that these methods are named incorrectly, Render should become MustRender since it's panics.

RenderWith is a terrible name as it indicates you are rendering with something being passed to it, possibly a context or something. I personally would actually call RenderWith just Render, and call Render MustRender.

I would do so in v2, breaking backwards compatibility for the greater good.

[appleboy]

@javierprovecho @tboerger What do you guys think about naming?

[themartorana]

Alternatively, #952 changes Context.Render (and Context.JSON) from a panic to returning an error. It's non-breaking, although recovery deferments will become useless. Arguments for never panic-ing are myriad - especially considering broken pipes are rarely the fault of the server.

[thinkerou]

@runner-mei please re-commit the pull request to master branch, thanks!

[thinkerou]

RenderWith is a terrible nam

@robvdl ShouldRender, how?

[mei-rune]

TryRender
or
ShouldRender

[thinkerou]

ref: ShouldBind, I like ShouldRender.

[robvdl]

@thinkerou because "render with" sounds like you are rendering with ... something ... like a context, the name name does not describe what it really does which is that it does a render but does panic on error.

I don't think you should use ShouldRender or ShouldBind either because the normal naming convention in Go is to use MustRender when something panics, and Render it if doesn't. It seems that pre-pending Must is the usual convention used.

I personally think it's much better to use the naming convention the Go community is already using rather than use something different.