Merge branch 'master' into pr-dyn-compat

Author: Kijewski

.github/workflows/rust.yml

@@ -7,10 +7,6 @@ on:
   schedule:
     - cron: "32 4 * * 5"
 
-concurrency:
-  group: ${{ github.workflow }}-${{ github.ref }}
-  cancel-in-progress: true
-
 jobs:
   Test:
     strategy:
@@ -101,7 +97,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: dtolnay/rust-toolchain@master
         with:
-          toolchain: "1.71.1"
+          toolchain: "1.80.0"
       - run: cargo check --lib -p rinja --all-features
 
   Audit:
@@ -114,10 +110,16 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: taiki-e/install-action@v2
-        with:
-          tool: mdbook
-      - run: mdbook build book
+      - name: Generate "book/theme/index.hbs" as "skeleton" of the generated pages.
+        run: ./update-theme.py
+        working-directory: book
+      - name: Install mdbook
+        run: |
+          mkdir -p $HOME/bin
+          curl --location --silent --show-error --fail https://github.com/cargo-bins/cargo-quickinstall/releases/download/mdbook-0.4.40/mdbook-0.4.40-x86_64-unknown-linux-gnu.tar.gz | tar -xzvvf - -C $HOME/bin
+      - name: Convert the book to HTML
+        run: $HOME/bin/mdbook build
+        working-directory: book
 
   DevSkim:
     name: DevSkim
@@ -175,11 +177,42 @@ jobs:
           components: rust-src
       - run: curl --location --silent --show-error --fail https://github.com/cargo-bins/cargo-quickinstall/releases/download/cargo-fuzz-0.12.0/cargo-fuzz-0.12.0-x86_64-unknown-linux-gnu.tar.gz | tar -xzvvf - -C $HOME/.cargo/bin
       - uses: Swatinem/rust-cache@v2
-      - run: cargo fuzz run ${{ matrix.fuzz_target }} --jobs 4 -- -max_total_time=90
+      - run: cargo fuzz run ${{ matrix.fuzz_target }} --jobs 4 -- -max_total_time=120
         working-directory: fuzzing
         env:
           RUSTFLAGS: '-Ctarget-feature=-crt-static'
 
+  Cluster-Fuzz:
+    runs-on: ubuntu-latest
+    permissions:
+      security-events: write
+    steps:
+      - name: Build Fuzzers
+        id: build
+        uses: google/oss-fuzz/infra/cifuzz/actions/build_fuzzers@master
+        with:
+          oss-fuzz-project-name: rinja
+          language: rust
+      - name: Run Fuzzers
+        uses: google/oss-fuzz/infra/cifuzz/actions/run_fuzzers@master
+        with:
+          oss-fuzz-project-name: rinja
+          language: rust
+          fuzz-seconds: 600
+          output-sarif: true
+      - name: Upload Crash
+        uses: actions/upload-artifact@v4
+        if: failure() && steps.build.outcome == 'success'
+        with:
+          name: artifacts
+          path: ./out/artifacts
+      - name: Upload Sarif
+        if: always() && steps.build.outcome == 'success'
+        uses: github/codeql-action/upload-sarif@v3
+        with:
+          sarif_file: cifuzz-sarif/results.sarif
+          checkout_path: cifuzz-sarif
+
   Typos:
     runs-on: ubuntu-latest
     steps:

README.md

@@ -8,7 +8,9 @@
 **Rinja** implements a template rendering engine based on [Jinja](https://jinja.palletsprojects.com/),
 and generates type-safe Rust code from your templates at compile time
 based on a user-defined `struct` to hold the template's context.
-See below for an example. It is a fork of [Askama](https://crates.io/crates/askama).
+See below for an example. It is a fork of [Askama](https://crates.io/crates/askama), please have a look at our
+[blog post](https://blog.guillaume-gomez.fr/articles/2024-07-31+docs.rs+switching+jinja+template+framework+from+tera+to+rinja)
+highlighting differences between the two crates.
 
 All feedback welcome! Feel free to file bugs, requests for documentation and
 any other feedback to the [issue tracker][issues].

book/book.toml

@@ -11,3 +11,5 @@ edition = "2021"
 [output.html]
 git-repository-url = "https://github.com/rinja-rs/rinja/tree/master/book"
 edit-url-template = "https://github.com/rinja-rs/rinja/tree/master/book/{path}"
+additional-css = ["theme/pagetoc.css"]
+additional-js = ["theme/pagetoc.js"]

book/src/configuration.md

@@ -108,6 +108,8 @@ The following keys can currently be used to customize template syntax:
 Values must be at least two characters long.
 If a key is omitted, the value from the default syntax is used.
 
+## Escapers
+
 Here is an example of a custom escaper:
 
 ```toml
@@ -118,10 +120,35 @@ extensions = ["tex"]
 
 An escaper block consists of the attributes `path` and `extensions`. `path`
 contains a Rust identifier that must be in scope for templates using this
-escaper. `extensions` defines a list of file extensions that will trigger
+escaper. This type must implement the [`Escaper`]
+trait.
+
+`extensions` defines a list of file extensions that will trigger
 the use of that escaper. Extensions are matched in order, starting with the
 first escaper configured and ending with the default escapers for HTML
 (extensions `html`, `htm`, `xml`, `j2`, `jinja`, `jinja2`) and plain text
 (no escaping; `md`, `yml`, `none`, `txt`, and the empty string). Note that
 this means you can also define other escapers that match different extensions
 to the same escaper.
+
+You can then use templates with this extension or use the
+[`escape`](https://docs.rs/rinja/latest/rinja/filters/fn.escape.html) filter with
+the name of your extension in your template:
+
+```jinja
+{{ some_string|escape("tex") }}
+```
+
+As an example, we want `.js` files to be treated like "txt" files. To do so:
+
+```toml
+[[escaper]]
+path = "rinja::filters::Text"
+extensions = ["js"]
+```
+
+[`Text`](https://docs.rs/rinja/latest/rinja/filters/struct.Text.html) implements the
+[`Escaper`] trait so since we don't need want any escaping on our `.js` files, we use
+it.
+
+[`Escaper`]: https://docs.rs/rinja/latest/rinja/filters/trait.Escaper.html