Rename `rinja` into `askama` #353

GuillaumeGomez · 2025-02-15T22:36:52Z

Part of #335.

testing/tests/gen_ws_tests.py

@@ -87,7 +87,7 @@
            expected += after[0] * (not nws)
            expected += after[1]

-    # FIXME: Rinja does not include whitespace before eof
+    # FIXME: Askama does not include whitespace before eof


Kijewski · 2025-02-20T21:45:40Z

I think the soft-links to the config files are still broken. I guess the easiest solution is to recreate them all:

ln -fst . ../clippy.toml ../deny.toml ../LICENSE-APACHE ../LICENSE-MIT ../.rustfmt.toml ../tomlfmt.toml ../_typos.toml

GuillaumeGomez · 2025-02-20T21:57:24Z

I think I'll let you handle the fuzzing part. Normally everything else was done. :)

Kijewski · 2025-02-20T22:03:16Z

Oh, this is a chicken & egg problem I didn't think about. Can you please simply comment out the cluster-fuzz block in the CI? We can comment it back in after we updated the fuzzing config in oss-fuzz.

GuillaumeGomez · 2025-02-20T22:04:27Z

I was afraid of something like this. Commenting it out then.

Kijewski · 2025-02-20T22:11:10Z

This is great, thank you! I'll have a proper look tomorrow. (The bvg is on strike, so I'll have to get up early tomorrow to have a nice walk to work. :D)

GuillaumeGomez · 2025-02-20T22:19:21Z

Time to buy a bike! :D

On my side I'll be on a train back home tomorrow, so should not get to bed too late either. ^^'

Kijewski · 2025-02-21T12:59:37Z

README.md

 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)
+[blog post](https://blog.guillaume-gomez.fr/articles/2024-07-31+docs.rs+switching+jinja+template+framework+from+tera+to+askama)
 highlighting differences between the two crates.


Something like "Askama v0.13 the next iteration of rinja v0.3, itself a previous fork of Askama"?

Kijewski · 2025-02-21T13:01:24Z

askama/Cargo.toml

@@ -1,11 +1,11 @@
 [package]
-name = "rinja"
+name = "askama"
 version = "0.3.5"


Suggested change

version = "0.3.5"

version = "0.13.0"

I suggest to do that in another PR. We'll need to update the version before the release in any case.

Kijewski · 2025-02-21T13:01:41Z

askama/Cargo.toml

@@ -27,7 +27,7 @@ harness = false
 itoa = "1.0.11"

 # needed by feature "derive"
-rinja_derive = { version = "=0.3.5", path = "../rinja_derive", default-features = false, optional = true }
+askama_derive = { version = "=0.3.5", path = "../askama_derive", default-features = false, optional = true }


Suggested change

askama_derive = { version = "=0.3.5", path = "../askama_derive", default-features = false, optional = true }

askama_derive = { version = "=0.13.0", path = "../askama_derive", default-features = false, optional = true }

Kijewski · 2025-02-21T13:05:00Z

askama/src/lib.rs

 //! // can easily disable the auto-escaping with the `|safe` filter,
 //! // but a malicious user cannot insert e.g. HTML scripts this way.
 //! ```
 //!
-//! A Rinja template is a `struct` definition which provides the template
+//! A Askama template is a `struct` definition which provides the template


Suggested change

//! A Askama template is a `struct` definition which provides the template

//! An Askama template is a `struct` or `enum` definition which provides the template

Kijewski · 2025-02-21T13:06:06Z

askama_derive/src/config.rs

 static DEFAULT_SYNTAX_NAME: &str = "default";
 static DEFAULT_ESCAPERS: &[(&[&str], &str)] = &[
    (
        &[
-            "askama", "html", "htm", "j2", "jinja", "jinja2", "rinja", "svg", "xml",
+            "askama", "html", "htm", "j2", "jinja", "jinja2", "askama", "svg", "xml",


Suggested change

"askama", "html", "htm", "j2", "jinja", "jinja2", "askama", "svg", "xml",

"askama", "html", "htm", "j2", "jinja", "jinja2", "svg", "xml",

Kijewski · 2025-02-21T13:06:42Z

askama_derive/src/config.rs

@@ -651,13 +651,13 @@ mod tests {
                (str_set(&["js"]), "::my_filters::Js".into()),
                (
                    str_set(&[
-                        "askama", "html", "htm", "j2", "jinja", "jinja2", "rinja", "svg", "xml"
+                        "askama", "html", "htm", "j2", "jinja", "jinja2", "askama", "svg", "xml"


Suggested change

"askama", "html", "htm", "j2", "jinja", "jinja2", "askama", "svg", "xml"

"askama", "html", "htm", "j2", "jinja", "jinja2", "svg", "xml"

Kijewski · 2025-02-21T13:08:32Z

askama_derive/src/input.rs

@@ -1055,7 +1055,7 @@ const _: () = {
 };

 #[cfg(feature = "code-in-doc")]
-const JINJA_EXTENSIONS: &[&str] = &["askama", "j2", "jinja", "jinja2", "rinja"];
+const JINJA_EXTENSIONS: &[&str] = &["askama", "j2", "jinja", "jinja2", "askama"];


Suggested change

const JINJA_EXTENSIONS: &[&str] = &["askama", "j2", "jinja", "jinja2", "askama"];

const JINJA_EXTENSIONS: &[&str] = &["askama", "j2", "jinja", "jinja2"];

I'll actually keep rinja for memories. :)

Kijewski · 2025-02-21T13:10:17Z

askama_derive_standalone/Cargo.toml

 [package]
-name = "rinja_derive_standalone"
+name = "askama_derive_standalone"
 version = "0.3.5"


Suggested change

version = "0.3.5"

version = "0.13.0"

Kijewski · 2025-02-21T13:10:36Z

askama_derive_standalone/Cargo.toml

@@ -21,7 +20,7 @@ harness = false
 required-features = ["__standalone"]

 [dependencies]
-parser = { package = "rinja_parser", version = "=0.3.5", path = "../rinja_parser" }
+parser = { package = "askama_parser", version = "=0.3.5", path = "../askama_parser" }


Suggested change

parser = { package = "askama_parser", version = "=0.3.5", path = "../askama_parser" }

parser = { package = "askama_parser", version = "=0.13.0", path = "../askama_parser" }

Kijewski · 2025-02-21T13:11:00Z

askama_parser/Cargo.toml

@@ -1,12 +1,12 @@
 [package]
-name = "rinja_parser"
+name = "askama_parser"
 version = "0.3.5"


Suggested change

version = "0.3.5"

version = "0.13.0"

Kijewski · 2025-02-21T13:11:15Z

bench-build/Cargo.toml

@@ -1,18 +1,18 @@
 [package]
 name = "bench-build"
 version = "0.3.5"


Suggested change

version = "0.3.5"

version = "0.13.0"

Kijewski · 2025-02-21T13:11:40Z

bench-build/Cargo.toml

+askama = { path = "../askama", version = "0.3.5", default-features = false, features = ["std"] }
+askama_derive = { path = "../askama_derive", version = "0.3.5", features = ["std"] }


Suggested change

askama = { path = "../askama", version = "0.3.5", default-features = false, features = ["std"] }

askama_derive = { path = "../askama_derive", version = "0.3.5", features = ["std"] }

askama = { path = "../askama", version = "0.13.0", default-features = false, features = ["std"] }

askama_derive = { path = "../askama_derive", version = "0.13.0", features = ["std"] }

Kijewski · 2025-02-21T13:12:22Z

book/src/features.md

@@ -9,7 +9,7 @@ you have to opt-in to the feature [`"serde_json"`](#serde_json):

 ```toml
 [dependencies]
-rinja = { version = "0.3.5", features = ["serde_json"] }
+askama = { version = "0.3.5", features = ["serde_json"] }


Suggested change

askama = { version = "0.3.5", features = ["serde_json"] }

askama = { version = "0.13.0", features = ["serde_json"] }

Kijewski · 2025-02-21T13:12:46Z

book/src/features.md

@@ -18,7 +18,7 @@ for more information.
 ## Default features

 Any [semver-compatible](https://doc.rust-lang.org/cargo/reference/semver.html) upgrade
-(e.g. `rinja = "0.3.4"` to `rinja = "0.3.5"`) will keep the same list of default features.
+(e.g. `askama = "0.3.4"` to `askama = "0.3.5"`) will keep the same list of default features.


Suggested change

(e.g. `askama = "0.3.4"` to `askama = "0.3.5"`) will keep the same list of default features.

(e.g. `askama = "0.13.0"` to `askama = "0.13.1"`) will keep the same list of default features.

Kijewski · 2025-02-21T13:13:02Z

book/src/features.md

@@ -28,7 +28,7 @@ You can opt-out of using the feature flags by using

 ```toml
 [dependencies]
-rinja = { version = "0.3.5", default-features = false }
+askama = { version = "0.3.5", default-features = false }


Suggested change

askama = { version = "0.3.5", default-features = false }

askama = { version = "0.13.0", default-features = false }

Kijewski · 2025-02-21T13:14:02Z

book/src/introduction.md


 ## Getting Started

 First, add the following to your crate's `Cargo.toml`:

 ```toml
 # in [dependencies] section
-rinja = "0.3.5"
+askama = "0.3.5"


Suggested change

askama = "0.3.5"

askama = "0.13.0"

Kijewski · 2025-02-21T13:14:17Z

book/src/performance.md

@@ -2,21 +2,21 @@

 ## Rendering Performance

-When rendering a rinja template, you should prefer the methods
+When rendering a askama template, you should prefer the methods


Suggested change

When rendering a askama template, you should prefer the methods

When rendering an askama template, you should prefer the methods

Kijewski · 2025-02-21T13:16:44Z

book/src/upgrading.md

@@ -46,26 +46,26 @@ give you more in-dept explanations:
 * The feature `"serde-yaml"` was removed.
  Use e.g. [`yaml-rust2`](https://lib.rs/crates/yaml-rust2) directly.

-## From rinja v0.3 to askama v0.13
+## From askama v0.3 to askama v0.13


Please undo all changes in this file below this line.

Kijewski · 2025-02-21T13:17:23Z

examples/actix-web-app/src/main.rs

@@ -65,7 +65,7 @@ impl Responder for AppError {
    type Body = String;

    fn respond_to(self, req: &HttpRequest) -> HttpResponse<Self::Body> {
-        // The error handler uses a rinja template to display its content.
+        // The error handler uses a askama template to display its content.


Suggested change

// The error handler uses a askama template to display its content.

// The error handler uses an askama template to display its content.

Kijewski · 2025-02-21T13:17:46Z

examples/axum-app/Cargo.toml

 # and axum as your web-framework.
 [dependencies]
+askama = { version = "0.3.5", path = "../../askama" }


Suggested change

askama = { version = "0.3.5", path = "../../askama" }

askama = { version = "0.13.0", path = "../../askama" }

Kijewski · 2025-02-21T13:18:16Z

examples/axum-app/src/main.rs

 }

 /// This is your error handler
 impl IntoResponse for AppError {
    fn into_response(self) -> Response {
-        // It uses a rinja template to display its content.
+        // It uses a askama template to display its content.


Suggested change

// It uses a askama template to display its content.

// It uses an askama template to display its content.

Kijewski · 2025-02-21T13:18:39Z

examples/poem-app/Cargo.toml

 # and poem as your web-framework.
 [dependencies]
+askama = { version = "0.3.5", path = "../../askama" }


Suggested change

askama = { version = "0.3.5", path = "../../askama" }

askama = { version = "0.13.0", path = "../../askama" }

Kijewski · 2025-02-21T13:18:52Z

examples/poem-app/src/main.rs

@@ -71,7 +71,7 @@ impl ResponseError for AppError {
 /// This is your error handler
 impl IntoResponse for AppError {
    fn into_response(self) -> Response {
-        // It uses a rinja template to display its content.
+        // It uses a askama template to display its content.


Suggested change

// It uses a askama template to display its content.

// It uses an askama template to display its content.

Kijewski · 2025-02-21T13:19:50Z

examples/rocket-app/Cargo.toml

 # and rocket as your web-framework.
 [dependencies]
-rinja = { version = "0.3.5", path = "../../rinja" }
+askama = { version = "0.3.5", path = "../../askama" }


Suggested change

askama = { version = "0.3.5", path = "../../askama" }

askama = { version = "0.13.0", path = "../../askama" }

Kijewski · 2025-02-21T13:20:09Z

examples/rocket-app/src/main.rs

 }

 /// This is your error handler
 impl<'r> Responder<'r, 'static> for AppError {
    fn respond_to(self, request: &'r Request<'_>) -> Result<Response<'static>, Status> {
-        // It uses a rinja template to display its content.
+        // It uses a askama template to display its content.


Suggested change

// It uses a askama template to display its content.

// It uses a askama template to display its content.

Kijewski · 2025-02-21T13:20:21Z

examples/salvo-app/Cargo.toml

 # and salvo as your web-framework.
 [dependencies]
-rinja = { version = "0.3.5", path = "../../rinja" }
+askama = { version = "0.3.5", path = "../../askama" }


Suggested change

askama = { version = "0.3.5", path = "../../askama" }

askama = { version = "0.13.0", path = "../../askama" }

Kijewski · 2025-02-21T13:20:39Z

examples/salvo-app/src/main.rs

 }

 /// This is your error handler
 impl Scribe for AppError {
    fn render(self, res: &mut Response) {
-        // It uses a rinja template to display its content.
+        // It uses a askama template to display its content.


Suggested change

// It uses a askama template to display its content.

// It uses a askama template to display its content.

Kijewski · 2025-02-21T13:20:50Z

examples/warp-app/Cargo.toml

 # and actix-web as your web-framework.
 [dependencies]
+askama = { version = "0.3.5", path = "../../askama" }


Suggested change

askama = { version = "0.3.5", path = "../../askama" }

askama = { version = "0.13.0", path = "../../askama" }

Kijewski · 2025-02-21T13:21:03Z

examples/warp-app/src/main.rs

 }

 /// This is your error handler
 impl Reply for AppError {
    fn into_response(self) -> Response {
-        // It uses a rinja template to display its content.
+        // It uses a askama template to display its content.


Suggested change

// It uses a askama template to display its content.

// It uses a askama template to display its content.

Kijewski · 2025-02-21T13:21:39Z

testing-alloc/Cargo.toml

@@ -1,12 +1,12 @@
 [package]
-name = "rinja_testing-alloc"
+name = "askama_testing-alloc"
 version = "0.3.5"


Suggested change

version = "0.3.5"

version = "0.13.0"

Kijewski · 2025-02-21T13:21:50Z

testing-alloc/Cargo.toml

 edition = "2021"
 rust-version = "1.81"
 publish = false

 [dev-dependencies]
-rinja = { path = "../rinja", version = "0.3.5", default-features = false, features = ["alloc", "derive"] }
+askama = { path = "../askama", version = "0.3.5", default-features = false, features = ["alloc", "derive"] }


Suggested change

askama = { path = "../askama", version = "0.3.5", default-features = false, features = ["alloc", "derive"] }

askama = { path = "../askama", version = "0.13.0", default-features = false, features = ["alloc", "derive"] }

Kijewski · 2025-02-21T13:22:03Z

testing-no-std/Cargo.toml

@@ -1,12 +1,12 @@
 [package]
-name = "rinja_testing-no-std"
+name = "askama_testing-no-std"
 version = "0.3.5"


Suggested change

version = "0.3.5"

version = "0.13.0"

Kijewski · 2025-02-21T13:22:20Z

testing-no-std/Cargo.toml

 edition = "2021"
 rust-version = "1.81"
 publish = false

 [dev-dependencies]
-rinja = { path = "../rinja", version = "0.3.5", default-features = false, features = ["derive"] }
+askama = { path = "../askama", version = "0.3.5", default-features = false, features = ["derive"] }


Suggested change

askama = { path = "../askama", version = "0.3.5", default-features = false, features = ["derive"] }

askama = { path = "../askama", version = "0.13.0", default-features = false, features = ["derive"] }

Kijewski · 2025-02-21T13:26:24Z

I really should have made a commit instead of supplying suggestions in Github. :| Maybe hit "commit suggestion" a lot, then squash the commits manually? :)

Kijewski mentioned this pull request Feb 15, 2025

Next release #335

Open

14 tasks

Kijewski added this to the askama v0.13.0 milestone Feb 16, 2025

GuillaumeGomez force-pushed the rename branch 2 times, most recently from a8d2b84 to 5e028ca Compare February 20, 2025 21:24

GuillaumeGomez mentioned this pull request Feb 20, 2025

Rename rinja into askama rinja-rs/fuzzing-corpus#1

Merged

GuillaumeGomez force-pushed the rename branch from 5e028ca to e9f9fe0 Compare February 20, 2025 21:34

github-advanced-security bot found potential problems Feb 20, 2025

View reviewed changes

GuillaumeGomez force-pushed the rename branch 2 times, most recently from eb3d6a5 to 037e93e Compare February 20, 2025 21:45

GuillaumeGomez force-pushed the rename branch from 037e93e to 9513fd4 Compare February 20, 2025 21:52

Kijewski reviewed Feb 21, 2025

View reviewed changes

GuillaumeGomez force-pushed the rename branch from 588e081 to 20a899f Compare February 21, 2025 19:39

GuillaumeGomez added 2 commits February 21, 2025 20:47

Rename rinja into askama

ee4c27a

Comment out Cluster-Fuzz for now

690d908

GuillaumeGomez force-pushed the rename branch from 20a899f to 690d908 Compare February 21, 2025 19:47

	askama_derive = { version = "=0.3.5", path = "../askama_derive", default-features = false, optional = true }
	askama_derive = { version = "=0.13.0", path = "../askama_derive", default-features = false, optional = true }

	//! A Askama template is a `struct` definition which provides the template
	//! An Askama template is a `struct` or `enum` definition which provides the template

	"askama", "html", "htm", "j2", "jinja", "jinja2", "askama", "svg", "xml",
	"askama", "html", "htm", "j2", "jinja", "jinja2", "svg", "xml",

	const JINJA_EXTENSIONS: &[&str] = &["askama", "j2", "jinja", "jinja2", "askama"];
	const JINJA_EXTENSIONS: &[&str] = &["askama", "j2", "jinja", "jinja2"];

	parser = { package = "askama_parser", version = "=0.3.5", path = "../askama_parser" }
	parser = { package = "askama_parser", version = "=0.13.0", path = "../askama_parser" }

		askama = { path = "../askama", version = "0.3.5", default-features = false, features = ["std"] }
		askama_derive = { path = "../askama_derive", version = "0.3.5", features = ["std"] }

	askama = { version = "0.3.5", features = ["serde_json"] }
	askama = { version = "0.13.0", features = ["serde_json"] }

	(e.g. `askama = "0.3.4"` to `askama = "0.3.5"`) will keep the same list of default features.
	(e.g. `askama = "0.13.0"` to `askama = "0.13.1"`) will keep the same list of default features.

	askama = { version = "0.3.5", default-features = false }
	askama = { version = "0.13.0", default-features = false }

	When rendering a askama template, you should prefer the methods
	When rendering an askama template, you should prefer the methods

	// The error handler uses a askama template to display its content.
	// The error handler uses an askama template to display its content.

	askama = { version = "0.3.5", path = "../../askama" }
	askama = { version = "0.13.0", path = "../../askama" }

	// It uses a askama template to display its content.
	// It uses an askama template to display its content.

Rename rinja into askama #353

Are you sure you want to change the base?

Rename rinja into askama #353

Conversation

GuillaumeGomez commented Feb 15, 2025

Kijewski commented Feb 20, 2025

GuillaumeGomez commented Feb 20, 2025

Kijewski commented Feb 20, 2025

GuillaumeGomez commented Feb 20, 2025

Kijewski commented Feb 20, 2025

GuillaumeGomez commented Feb 20, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Kijewski Feb 21, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Kijewski commented Feb 21, 2025

Rename `rinja` into `askama` #353

Rename `rinja` into `askama` #353

Kijewski Feb 21, 2025 •

edited

Loading