package jingoo
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=7e77a81fe67d416b5c243062d99e163d7f633751c242e39a1ec048064bcf4d9d
md5=8ac1c2236a2e61c9362fbe3da30717db
Description
Published: 28 Apr 2020
README
jingoo
About jingoo
Jingoo is OCaml template engine almost compatible with Jinja2(python template engine).
Install
manual
make
sudo make install
opam
opam install jingoo
Difference between Jinja2 and Jingoo
i18n features are not supported yet.
Cause of language difference between ocaml and python, some of built-in filters are different from original one, especially orders of arguments and supported optional arguments etc.
Single line comment is not supported. Because single '#' is used very much especially in html.
Usage
Simple usage
open Jingoo
(* output from direct string template *)
let result = Jg_template.from_string "{{ msg }}" ~models:[("msg", Jg_types.Tstr "hello, world!")]
(* or output from file template *)
let result2 = Jg_template.from_file "hello.jingoo" ~models:[("msg", Jg_types.Tstr "hello, world!")]
Custom filter example
Set your custom filter to filters
field of environment.
open Jingoo
let to_mail ?(kwargs=[]) ?(defaults=[]) value =
let id = Jg_runtime.string_of_tvalue value in
let domain = Jg_runtime.string_of_tvalue (Jg_runtime.jg_get_kvalue "domain" kwargs ~defaults) in
Jg_types.Tstr (id ^ "@" ^ domain)
let () =
let result = Jg_template.from_string "{{id | to_mail(domain='gmail.com')}}"
(* set your extension to 'filters' field of environment *)
~env:{Jg_types.std_env with
filters = [
(* CAUTION!: if jingoo <= 1.2.21, use 'Jg_runtime.func_arg1' instead of 'Jg_types.func_arg1_kw' *)
("to_mail", Jg_types.func_arg1_kw (to_mail ~defaults:[
("domain", Jg_types.Tstr "gmail.com");
]));
]
}
~models:[
("id", Jg_types.Tstr "foo")
] in
(* should output 'foo@gmail.com' *)
print_endline result
Dynlink filter example
Write your own filter(
my_ext.ml
for example) and add it byJg_stub.add
(namespace asmy_ext
and func_name asto_md5
for example).
open Jingoo
let to_md5 ?(kwargs=[]) ?(defaults=[]) value =
let seed = Jg_runtime.jg_get_kvalue "seed" kwargs ~defaults in
match value, seed with
| Jg_types.Tstr str, Jg_types.Tstr seed ->
Jg_types.Tstr (Digest.to_hex (Digest.string (str ^ seed)))
| _ -> Jg_types.Tnull
let () =
(* CAUTION!: if jingoo <= 1.2.21, use 'Jg_runtime.func_arg1' instead of 'Jg_types.func_arg1_kw' *)
Jg_stub.add_func ~namespace:"my_ext" ~func_name:"to_md5" (Jg_types.func_arg1_kw (to_md5 ~defaults:[
("seed", Jg_types.Tstr "");
]))
Compile it to
my_ext.cmxs
by-shared
option.
ocamlfind ocamlopt -shared -o my_ext.cmxs my_ext.ml
Set
my_ext.cmxs
toextensions
field of environment, and you can use your custom filtermy_ext.to_md5
.
open Jingoo
let result = Jg_template.from_string "{{msg | my_ext.to_md5(seed='aaa')}}"
(* set your extension to 'extensions' field *)
~env:{Jg_types.std_env with
extensions = [
"my_ext.cmxs";
]
}
~models:[
("msg", Jg_types.Tstr "foo");
] in
(* should output '3cb988a734183289506ab7738261c827' *)
print_endline result
Cheatsheet
See samples directory.
*.jingoo
is template example and *.expected
is expected string.
Documentation
http://tategakibunko.github.io/jingoo/
Playground
https://sagotch.github.io/try-jingoo/
License
MIT License
Dependencies (7)
Dev Dependencies (1)
-
ounit
with-test & >= "2.0.0"
Used by (2)
- opam-build-revdeps
-
spin
< "0.8.0"
Conflicts
None