forgejo/templates/repo/diff
wxiaoguang 5b89670a31
Use a general Eval function for expressions in templates. (#23927)
One of the proposals in #23328

This PR introduces a simple expression calculator
(templates/eval/eval.go), it can do basic expression calculations.

Many untested template helper functions like `Mul` `Add` can be replaced
by this new approach.

Then these `Add` / `Mul` / `percentage` / `Subtract` / `DiffStatsWidth`
could all use this `Eval`.

And it provides enhancements for Golang templates, and improves
readability.

Some examples:

----

* Before: `{{Add (Mul $glyph.Row 12) 12}}`
* After: `{{Eval $glyph.Row "*" 12 "+" 12}}`

----

* Before: `{{if lt (Add $i 1) (len $.Topics)}}`
* After: `{{if Eval $i "+" 1 "<" (len $.Topics)}}`

## FAQ

### Why not use an existing expression package?

We need a highly customized expression engine:

* do the calculation on the fly, without pre-compiling
* deal with int/int64/float64 types, to make the result could be used in
Golang template.
* make the syntax could be used in the Golang template directly
* do not introduce too much complex or strange syntax, we just need a
simple calculator.
* it needs to strictly follow Golang template's behavior, for example,
Golang template treats all non-zero values as truth, but many 3rd
packages don't do so.

### What's the benefit?

* Developers don't need to add more `Add`/`Mul`/`Sub`-like functions,
they were getting more and more.
Now, only one `Eval` is enough for all cases.
* The new code reads better than old `{{Add (Mul $glyph.Row 12) 12}}`,
the old one isn't familiar to most procedural programming developers
(eg, the Golang expression syntax).
* The `Eval` is fully covered by tests, many old `Add`/`Mul`-like
functions were never tested.

### The performance?

It doesn't use `reflect`, it doesn't need to parse or compile when used
in Golang template, the performance is as fast as native Go template.

### Is it too complex? Could it be unstable?

The expression calculator program is a common homework for computer
science students, and it's widely used as a teaching and practicing
purpose for developers. The algorithm is pretty well-known.

The behavior can be clearly defined, it is stable.
2023-04-07 21:25:49 +08:00
..
blob_excerpt.tmpl Fix code view (diff) broken layout (#23096) 2023-04-04 19:05:07 +08:00
box.tmpl Introduce GitHub markdown editor, keep EasyMDE as fallback (#23876) 2023-04-03 18:06:57 +08:00
comment_form.tmpl Introduce GitHub markdown editor, keep EasyMDE as fallback (#23876) 2023-04-03 18:06:57 +08:00
comment_form_datahandler.tmpl Make sure fmt catches all templates (#20979) 2022-08-31 23:58:54 +08:00
comments.tmpl Use data-tooltip-content for tippy tooltip (#23649) 2023-03-24 18:35:38 +08:00
compare.tmpl Refactor hiding-methods, remove jQuery show/hide, remove .hide class, remove inline style=display:none (#22950) 2023-02-19 12:06:14 +08:00
conversation.tmpl Refactor hiding-methods, remove jQuery show/hide, remove .hide class, remove inline style=display:none (#22950) 2023-02-19 12:06:14 +08:00
csv_diff.tmpl Fix CSV diff for added/deleted files (#21189) 2022-09-17 10:45:32 +08:00
escape_title.tmpl Switch Unicode Escaping to a VSCode-like system (#19990) 2022-08-13 19:32:34 +01:00
image_diff.tmpl Remove incorrect HTML self close tag (#23748) 2023-03-27 18:05:51 +02:00
new_comment.tmpl Do not reload page after adding comments in Pull Request reviews (#13877) 2021-01-08 23:49:55 +02:00
new_review.tmpl Introduce GitHub markdown editor, keep EasyMDE as fallback (#23876) 2023-04-03 18:06:57 +08:00
options_dropdown.tmpl Fix incorrect toggle buttons (#23676) 2023-03-26 20:06:11 +08:00
section_code.tmpl Switch Unicode Escaping to a VSCode-like system (#19990) 2022-08-13 19:32:34 +01:00
section_split.tmpl Fix code view (diff) broken layout (#23096) 2023-04-04 19:05:07 +08:00
section_unified.tmpl Fix code view (diff) broken layout (#23096) 2023-04-04 19:05:07 +08:00
stats.tmpl Use a general Eval function for expressions in templates. (#23927) 2023-04-07 21:25:49 +08:00
whitespace_dropdown.tmpl Fix incorrect toggle buttons (#23676) 2023-03-26 20:06:11 +08:00