From 1376c5a617be5c25655d0d7cb63e3beaa5a6e026 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Wed, 17 Apr 2024 14:20:39 +0200 Subject: Merging upstream version 1.70.0+dfsg1. Signed-off-by: Daniel Baumann --- vendor/askama/.cargo-checksum.json | 2 +- vendor/askama/Cargo.toml | 121 +++++-- vendor/askama/README.md | 96 ++++++ vendor/askama/src/error.rs | 95 ++++++ vendor/askama/src/filters/json.rs | 44 +++ vendor/askama/src/filters/mod.rs | 640 +++++++++++++++++++++++++++++++++++++ vendor/askama/src/filters/yaml.rs | 34 ++ vendor/askama/src/helpers.rs | 48 +++ vendor/askama/src/lib.rs | 133 ++++---- 9 files changed, 1127 insertions(+), 86 deletions(-) create mode 100644 vendor/askama/README.md create mode 100644 vendor/askama/src/error.rs create mode 100644 vendor/askama/src/filters/json.rs create mode 100644 vendor/askama/src/filters/mod.rs create mode 100644 vendor/askama/src/filters/yaml.rs create mode 100644 vendor/askama/src/helpers.rs (limited to 'vendor/askama') diff --git a/vendor/askama/.cargo-checksum.json b/vendor/askama/.cargo-checksum.json index 2126993e5..889c53336 100644 --- a/vendor/askama/.cargo-checksum.json +++ b/vendor/askama/.cargo-checksum.json @@ -1 +1 @@ -{"files":{"Cargo.toml":"e4bd647e429604df4b8f7119bce243cc7cb7fdf96a39345358a49980361582e4","LICENSE-APACHE":"87cb0d734c723c083e51c825930ff42bce28596b52dee15567f6b28f19c195e3","LICENSE-MIT":"df20e0180764bf5bd76f74d47bc9e8c0069a666401629c390003a1d5eba99c92","src/lib.rs":"679e0dff35d70f90df065e9bdfdc6754dc358b579130dcbf729fba5a31bdfc86"},"package":"4d8f355701c672c2ba3d718acbd213f740beea577cc4eae66accdffe15be1882"} \ No newline at end of file +{"files":{"Cargo.toml":"fbab611fc3ba2204942300a534b4f030460f33b0606fa50b9ad08ea567ba81e8","LICENSE-APACHE":"87cb0d734c723c083e51c825930ff42bce28596b52dee15567f6b28f19c195e3","LICENSE-MIT":"df20e0180764bf5bd76f74d47bc9e8c0069a666401629c390003a1d5eba99c92","README.md":"6a4430cf614ff9d36ba01463a8f94085ed4b0889fd719793fa914568247acce2","src/error.rs":"1e3f8020092469090f314f60685c077347e730a88222dfdaa38aaf2396507532","src/filters/json.rs":"dccd0a3f1017da9f6cd9650bd39eb1670f4a9833d2f0968614cd8cd65d18a9dd","src/filters/mod.rs":"903d09599e62f56657b00b2aa577c9d2f963348dd12a1029e90e68549f78b1db","src/filters/yaml.rs":"4e641bedbe3666b334836fb6603fe7f718f7e90d8e33419acca624f50a580c3f","src/helpers.rs":"76e0422acd4ccba7b1735d6ab7622a93f6ec5a2fa89531111d877266784d5334","src/lib.rs":"3a6e4d0b3aadc7c391cbe59416504a719406303726122779281a3af1a7ad76a4"},"package":"47cbc3cf73fa8d9833727bbee4835ba5c421a0d65b72daf9a7b5d0e0f9cfb57e"} \ No newline at end of file diff --git a/vendor/askama/Cargo.toml b/vendor/askama/Cargo.toml index bb6ad7aed..15129d2dd 100644 --- a/vendor/askama/Cargo.toml +++ b/vendor/askama/Cargo.toml @@ -10,52 +10,117 @@ # See Cargo.toml.orig for the original contents. [package] -edition = "2018" +edition = "2021" +rust-version = "1.58" name = "askama" -version = "0.11.0" +version = "0.12.0" description = "Type-safe, compiled Jinja-like templates for Rust" homepage = "https://github.com/djc/askama" documentation = "https://docs.rs/askama" -readme = "../README.md" -keywords = ["markup", "template", "jinja2", "html"] +readme = "README.md" +keywords = [ + "markup", + "template", + "jinja2", + "html", +] categories = ["template-engine"] license = "MIT OR Apache-2.0" repository = "https://github.com/djc/askama" +resolver = "1" + [package.metadata.docs.rs] -features = ["config", "humansize", "num-traits", "serde-json", "serde-yaml"] +features = [ + "config", + "humansize", + "num-traits", + "serde-json", + "serde-yaml", +] + [dependencies.askama_derive] -version = "0.11.0" +version = "0.12.0" [dependencies.askama_escape] -version = "0.10" +version = "0.10.3" -[dependencies.askama_shared] -version = "0.12.0" +[dependencies.comrak] +version = "0.16" +optional = true default-features = false -[dependencies.mime] -version = "0.3" +[dependencies.dep_humansize] +version = "2" optional = true +package = "humansize" -[dependencies.mime_guess] -version = "2" +[dependencies.dep_num_traits] +version = "0.2.6" +optional = true +package = "num-traits" + +[dependencies.percent-encoding] +version = "2.1.0" +optional = true + +[dependencies.serde] +version = "1.0" +features = ["derive"] +optional = true + +[dependencies.serde_json] +version = "1.0" +optional = true + +[dependencies.serde_yaml] +version = "0.9" optional = true [features] -config = ["askama_derive/config", "askama_shared/config"] -default = ["config", "humansize", "num-traits", "urlencode"] -humansize = ["askama_shared/humansize"] -num-traits = ["askama_shared/num-traits"] -serde-json = ["askama_shared/json"] -serde-yaml = ["askama_shared/yaml"] -urlencode = ["askama_shared/percent-encoding"] -with-actix-web = ["askama_derive/actix-web"] -with-axum = ["askama_derive/axum"] -with-gotham = ["askama_derive/gotham"] -with-iron = ["askama_derive/iron"] -with-mendes = ["askama_derive/mendes"] -with-rocket = ["askama_derive/rocket"] -with-tide = ["askama_derive/tide"] -with-warp = ["askama_derive/warp"] +config = ["askama_derive/config"] +default = [ + "config", + "humansize", + "num-traits", + "urlencode", +] +humansize = [ + "askama_derive/humansize", + "dep_humansize", +] +markdown = [ + "askama_derive/markdown", + "comrak", +] +mime = [] +mime_guess = [] +num-traits = [ + "askama_derive/num-traits", + "dep_num_traits", +] +serde-json = [ + "askama_derive/serde-json", + "askama_escape/json", + "serde", + "serde_json", +] +serde-yaml = [ + "askama_derive/serde-yaml", + "serde", + "serde_yaml", +] +urlencode = [ + "askama_derive/urlencode", + "percent-encoding", +] +with-actix-web = ["askama_derive/with-actix-web"] +with-axum = ["askama_derive/with-axum"] +with-gotham = ["askama_derive/with-gotham"] +with-hyper = ["askama_derive/with-hyper"] +with-mendes = ["askama_derive/with-mendes"] +with-rocket = ["askama_derive/with-rocket"] +with-tide = ["askama_derive/with-tide"] +with-warp = ["askama_derive/with-warp"] + [badges.maintenance] status = "actively-developed" diff --git a/vendor/askama/README.md b/vendor/askama/README.md new file mode 100644 index 000000000..9055004f0 --- /dev/null +++ b/vendor/askama/README.md @@ -0,0 +1,96 @@ +# Askama + +[![Documentation](https://docs.rs/askama/badge.svg)](https://docs.rs/askama/) +[![Latest version](https://img.shields.io/crates/v/askama.svg)](https://crates.io/crates/askama) +[![Build Status](https://github.com/djc/askama/workflows/CI/badge.svg)](https://github.com/djc/askama/actions?query=workflow%3ACI) +[![Chat](https://badges.gitter.im/gitterHQ/gitter.svg)](https://gitter.im/djc/askama) + +Askama implements a template rendering engine based on [Jinja](https://jinja.palletsprojects.com/). +It generates 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, or read [the book][docs]. + +**"Pretty exciting. I would love to use this already."** -- +[Armin Ronacher][mitsuhiko], creator of Jinja + +All feedback welcome. Feel free to file bugs, requests for documentation and +any other feedback to the [issue tracker][issues] or [tweet me][twitter]. + +Askama was created by and is maintained by Dirkjan Ochtman. If you are in a +position to support ongoing maintenance and further development or use it +in a for-profit context, please consider supporting my open source work on +[Patreon][patreon]. + +### Feature highlights + +* Construct templates using a familiar, easy-to-use syntax +* Benefit from the safety provided by Rust's type system +* Template code is compiled into your crate for [optimal performance][benchmarks] +* Optional built-in support for Actix, Axum, Gotham, Mendes, Rocket, tide, and warp web frameworks +* Debugging features to assist you in template development +* Templates must be valid UTF-8 and produce UTF-8 when rendered +* IDE support available in [JetBrains products](https://plugins.jetbrains.com/plugin/16591-askama-template-support) +* Works on stable Rust + +### Supported in templates + +* Template inheritance +* Loops, if/else statements and include support +* Macro support +* Variables (no mutability allowed) +* Some built-in filters, and the ability to use your own +* Whitespace suppressing with '-' markers +* Opt-out HTML escaping +* Syntax customization + +[docs]: https://djc.github.io/askama/ +[fafhrd91]: https://github.com/fafhrd91 +[mitsuhiko]: http://lucumr.pocoo.org/ +[issues]: https://github.com/djc/askama/issues +[twitter]: https://twitter.com/djco/ +[patreon]: https://www.patreon.com/dochtman +[benchmarks]: https://github.com/djc/template-benchmarks-rs + + +How to get started +------------------ + +First, add the following to your crate's `Cargo.toml`: + +```toml +# in section [dependencies] +askama = "0.11.2" + +``` + +Now create a directory called `templates` in your crate root. +In it, create a file called `hello.html`, containing the following: + +``` +Hello, {{ name }}! +``` + +In any Rust file inside your crate, add the following: + +```rust +use askama::Template; // bring trait in scope + +#[derive(Template)] // this will generate the code... +#[template(path = "hello.html")] // using the template in this path, relative + // to the `templates` dir in the crate root +struct HelloTemplate<'a> { // the name of the struct can be anything + name: &'a str, // the field name should match the variable name + // in your template +} + +fn main() { + let hello = HelloTemplate { name: "world" }; // instantiate your struct + println!("{}", hello.render().unwrap()); // then render it. +} +``` + +You should now be able to compile and run this code. + +Review the [test cases] for more examples. + +[test cases]: https://github.com/djc/askama/tree/main/testing diff --git a/vendor/askama/src/error.rs b/vendor/askama/src/error.rs new file mode 100644 index 000000000..406b1485a --- /dev/null +++ b/vendor/askama/src/error.rs @@ -0,0 +1,95 @@ +use std::fmt::{self, Display}; + +pub type Result = ::std::result::Result; + +/// askama error type +/// +/// # Feature Interaction +/// +/// If the feature `serde_json` is enabled an +/// additional error variant `Json` is added. +/// +/// # Why not `failure`/`error-chain`? +/// +/// Error from `error-chain` are not `Sync` which +/// can lead to problems e.g. when this is used +/// by a crate which use `failure`. Implementing +/// `Fail` on the other hand prevents the implementation +/// of `std::error::Error` until specialization lands +/// on stable. While errors impl. `Fail` can be +/// converted to a type impl. `std::error::Error` +/// using a adapter the benefits `failure` would +/// bring to this crate are small, which is why +/// `std::error::Error` was used. +/// +#[non_exhaustive] +#[derive(Debug)] +pub enum Error { + /// formatting error + Fmt(fmt::Error), + + /// an error raised by using `?` in a template + Custom(Box), + + /// json conversion error + #[cfg(feature = "serde_json")] + Json(::serde_json::Error), + + /// yaml conversion error + #[cfg(feature = "serde_yaml")] + Yaml(::serde_yaml::Error), +} + +impl std::error::Error for Error { + fn source(&self) -> Option<&(dyn std::error::Error + 'static)> { + match *self { + Error::Fmt(ref err) => Some(err), + Error::Custom(ref err) => Some(err.as_ref()), + #[cfg(feature = "serde_json")] + Error::Json(ref err) => Some(err), + #[cfg(feature = "serde_yaml")] + Error::Yaml(ref err) => Some(err), + } + } +} + +impl Display for Error { + fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result { + match self { + Error::Fmt(err) => write!(formatter, "formatting error: {err}"), + Error::Custom(err) => write!(formatter, "{err}"), + #[cfg(feature = "serde_json")] + Error::Json(err) => write!(formatter, "json conversion error: {err}"), + #[cfg(feature = "serde_yaml")] + Error::Yaml(err) => write!(formatter, "yaml conversion error: {}", err), + } + } +} + +impl From for Error { + fn from(err: fmt::Error) -> Self { + Error::Fmt(err) + } +} + +#[cfg(feature = "serde_json")] +impl From<::serde_json::Error> for Error { + fn from(err: ::serde_json::Error) -> Self { + Error::Json(err) + } +} + +#[cfg(feature = "serde_yaml")] +impl From<::serde_yaml::Error> for Error { + fn from(err: ::serde_yaml::Error) -> Self { + Error::Yaml(err) + } +} + +#[cfg(test)] +mod tests { + use super::Error; + + trait AssertSendSyncStatic: Send + Sync + 'static {} + impl AssertSendSyncStatic for Error {} +} diff --git a/vendor/askama/src/filters/json.rs b/vendor/askama/src/filters/json.rs new file mode 100644 index 000000000..809be91b0 --- /dev/null +++ b/vendor/askama/src/filters/json.rs @@ -0,0 +1,44 @@ +use crate::error::{Error, Result}; +use askama_escape::JsonEscapeBuffer; +use serde::Serialize; +use serde_json::to_writer_pretty; + +/// Serialize to JSON (requires `json` feature) +/// +/// The generated string does not contain ampersands `&`, chevrons `< >`, or apostrophes `'`. +/// To use it in a ` +/// ``` +/// +/// To use it in HTML attributes, you can either use it in quotation marks `"{{data|json}}"` as is, +/// or in apostrophes with the (optional) safe filter `'{{data|json|safe}}'`. +/// In HTML texts the output of e.g. `
{{data|json|safe}}
` is safe, too. +pub fn json(s: S) -> Result { + let mut writer = JsonEscapeBuffer::new(); + to_writer_pretty(&mut writer, &s).map_err(Error::from)?; + Ok(writer.finish()) +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn test_json() { + assert_eq!(json(true).unwrap(), "true"); + assert_eq!(json("foo").unwrap(), r#""foo""#); + assert_eq!(json(true).unwrap(), "true"); + assert_eq!(json("foo").unwrap(), r#""foo""#); + assert_eq!( + json(vec!["foo", "bar"]).unwrap(), + r#"[ + "foo", + "bar" +]"# + ); + } +} diff --git a/vendor/askama/src/filters/mod.rs b/vendor/askama/src/filters/mod.rs new file mode 100644 index 000000000..f76a463c5 --- /dev/null +++ b/vendor/askama/src/filters/mod.rs @@ -0,0 +1,640 @@ +//! Module for built-in filter functions +//! +//! Contains all the built-in filter functions for use in templates. +//! You can define your own filters, as well. +//! For more information, read the [book](https://djc.github.io/askama/filters.html). +#![allow(clippy::trivially_copy_pass_by_ref)] + +use std::fmt::{self, Write}; + +#[cfg(feature = "serde-json")] +mod json; +#[cfg(feature = "serde-json")] +pub use self::json::json; + +#[cfg(feature = "serde-yaml")] +mod yaml; +#[cfg(feature = "serde-yaml")] +pub use self::yaml::yaml; + +#[allow(unused_imports)] +use crate::error::Error::Fmt; +use askama_escape::{Escaper, MarkupDisplay}; +#[cfg(feature = "humansize")] +use dep_humansize::{format_size_i, ToF64, DECIMAL}; +#[cfg(feature = "num-traits")] +use dep_num_traits::{cast::NumCast, Signed}; +#[cfg(feature = "percent-encoding")] +use percent_encoding::{utf8_percent_encode, AsciiSet, NON_ALPHANUMERIC}; + +use super::Result; + +#[cfg(feature = "percent-encoding")] +// Urlencode char encoding set. Only the characters in the unreserved set don't +// have any special purpose in any part of a URI and can be safely left +// unencoded as specified in https://tools.ietf.org/html/rfc3986.html#section-2.3 +const URLENCODE_STRICT_SET: &AsciiSet = &NON_ALPHANUMERIC + .remove(b'_') + .remove(b'.') + .remove(b'-') + .remove(b'~'); + +#[cfg(feature = "percent-encoding")] +// Same as URLENCODE_STRICT_SET, but preserves forward slashes for encoding paths +const URLENCODE_SET: &AsciiSet = &URLENCODE_STRICT_SET.remove(b'/'); + +/// Marks a string (or other `Display` type) as safe +/// +/// Use this is you want to allow markup in an expression, or if you know +/// that the expression's contents don't need to be escaped. +/// +/// Askama will automatically insert the first (`Escaper`) argument, +/// so this filter only takes a single argument of any type that implements +/// `Display`. +pub fn safe(e: E, v: T) -> Result> +where + E: Escaper, + T: fmt::Display, +{ + Ok(MarkupDisplay::new_safe(v, e)) +} + +/// Escapes strings according to the escape mode. +/// +/// Askama will automatically insert the first (`Escaper`) argument, +/// so this filter only takes a single argument of any type that implements +/// `Display`. +/// +/// It is possible to optionally specify an escaper other than the default for +/// the template's extension, like `{{ val|escape("txt") }}`. +pub fn escape(e: E, v: T) -> Result> +where + E: Escaper, + T: fmt::Display, +{ + Ok(MarkupDisplay::new_unsafe(v, e)) +} + +#[cfg(feature = "humansize")] +/// Returns adequate string representation (in KB, ..) of number of bytes +pub fn filesizeformat(b: &(impl ToF64 + Copy)) -> Result { + Ok(format_size_i(*b, DECIMAL)) +} + +#[cfg(feature = "percent-encoding")] +/// Percent-encodes the argument for safe use in URI; does not encode `/`. +/// +/// This should be safe for all parts of URI (paths segments, query keys, query +/// values). In the rare case that the server can't deal with forward slashes in +/// the query string, use [`urlencode_strict`], which encodes them as well. +/// +/// Encodes all characters except ASCII letters, digits, and `_.-~/`. In other +/// words, encodes all characters which are not in the unreserved set, +/// as specified by [RFC3986](https://tools.ietf.org/html/rfc3986#section-2.3), +/// with the exception of `/`. +/// +/// ```none,ignore +/// Station +/// Page +/// ``` +/// +/// To encode `/` as well, see [`urlencode_strict`](./fn.urlencode_strict.html). +/// +/// [`urlencode_strict`]: ./fn.urlencode_strict.html +pub fn urlencode(s: T) -> Result { + let s = s.to_string(); + Ok(utf8_percent_encode(&s, URLENCODE_SET).to_string()) +} + +#[cfg(feature = "percent-encoding")] +/// Percent-encodes the argument for safe use in URI; encodes `/`. +/// +/// Use this filter for encoding query keys and values in the rare case that +/// the server can't process them unencoded. +/// +/// Encodes all characters except ASCII letters, digits, and `_.-~`. In other +/// words, encodes all characters which are not in the unreserved set, +/// as specified by [RFC3986](https://tools.ietf.org/html/rfc3986#section-2.3). +/// +/// ```none,ignore +/// Page +/// ``` +/// +/// If you want to preserve `/`, see [`urlencode`](./fn.urlencode.html). +pub fn urlencode_strict(s: T) -> Result { + let s = s.to_string(); + Ok(utf8_percent_encode(&s, URLENCODE_STRICT_SET).to_string()) +} + +/// Formats arguments according to the specified format +/// +/// The *second* argument to this filter must be a string literal (as in normal +/// Rust). The two arguments are passed through to the `format!()` +/// [macro](https://doc.rust-lang.org/stable/std/macro.format.html) by +/// the Askama code generator, but the order is swapped to support filter +/// composition. +/// +/// ```ignore +/// {{ value | fmt("{:?}") }} +/// ``` +/// +/// Compare with [format](./fn.format.html). +pub fn fmt() {} + +/// Formats arguments according to the specified format +/// +/// The first argument to this filter must be a string literal (as in normal +/// Rust). All arguments are passed through to the `format!()` +/// [macro](https://doc.rust-lang.org/stable/std/macro.format.html) by +/// the Askama code generator. +/// +/// ```ignore +/// {{ "{:?}{:?}" | format(value, other_value) }} +/// ``` +/// +/// Compare with [fmt](./fn.fmt.html). +pub fn format() {} + +/// Replaces line breaks in plain text with appropriate HTML +/// +/// A single newline becomes an HTML line break `
` and a new line +/// followed by a blank line becomes a paragraph break `

`. +pub fn linebreaks(s: T) -> Result { + let s = s.to_string(); + let linebroken = s.replace("\n\n", "

").replace('\n', "
"); + + Ok(format!("

{linebroken}

")) +} + +/// Converts all newlines in a piece of plain text to HTML line breaks +pub fn linebreaksbr(s: T) -> Result { + let s = s.to_string(); + Ok(s.replace('\n', "
")) +} + +/// Replaces only paragraph breaks in plain text with appropriate HTML +/// +/// A new line followed by a blank line becomes a paragraph break `

`. +/// Paragraph tags only wrap content; empty paragraphs are removed. +/// No `
` tags are added. +pub fn paragraphbreaks(s: T) -> Result { + let s = s.to_string(); + let linebroken = s.replace("\n\n", "

").replace("

", ""); + + Ok(format!("

{linebroken}

")) +} + +/// Converts to lowercase +pub fn lower(s: T) -> Result { + let s = s.to_string(); + Ok(s.to_lowercase()) +} + +/// Alias for the `lower()` filter +pub fn lowercase(s: T) -> Result { + lower(s) +} + +/// Converts to uppercase +pub fn upper(s: T) -> Result { + let s = s.to_string(); + Ok(s.to_uppercase()) +} + +/// Alias for the `upper()` filter +pub fn uppercase(s: T) -> Result { + upper(s) +} + +/// Strip leading and trailing whitespace +pub fn trim(s: T) -> Result { + let s = s.to_string(); + Ok(s.trim().to_owned()) +} + +/// Limit string length, appends '...' if truncated +pub fn truncate(s: T, len: usize) -> Result { + let mut s = s.to_string(); + if s.len() > len { + let mut real_len = len; + while !s.is_char_boundary(real_len) { + real_len += 1; + } + s.truncate(real_len); + s.push_str("..."); + } + Ok(s) +} + +/// Indent lines with `width` spaces +pub fn indent(s: T, width: usize) -> Result { + let s = s.to_string(); + + let mut indented = String::new(); + + for (i, c) in s.char_indices() { + indented.push(c); + + if c == '\n' && i < s.len() - 1 { + for _ in 0..width { + indented.push(' '); + } + } + } + + Ok(indented) +} + +#[cfg(feature = "num-traits")] +/// Casts number to f64 +pub fn into_f64(number: T) -> Result +where + T: NumCast, +{ + number.to_f64().ok_or(Fmt(fmt::Error)) +} + +#[cfg(feature = "num-traits")] +/// Casts number to isize +pub fn into_isize(number: T) -> Result +where + T: NumCast, +{ + number.to_isize().ok_or(Fmt(fmt::Error)) +} + +/// Joins iterable into a string separated by provided argument +pub fn join(input: I, separator: S) -> Result +where + T: fmt::Display, + I: Iterator, + S: AsRef, +{ + let separator: &str = separator.as_ref(); + + let mut rv = String::new(); + + for (num, item) in input.enumerate() { + if num > 0 { + rv.push_str(separator); + } + + write!(rv, "{item}")?; + } + + Ok(rv) +} + +#[cfg(feature = "num-traits")] +/// Absolute value +pub fn abs(number: T) -> Result +where + T: Signed, +{ + Ok(number.abs()) +} + +/// Capitalize a value. The first character will be uppercase, all others lowercase. +pub fn capitalize(s: T) -> Result { + let s = s.to_string(); + match s.chars().next() { + Some(c) => { + let mut replacement: String = c.to_uppercase().collect(); + replacement.push_str(&s[c.len_utf8()..].to_lowercase()); + Ok(replacement) + } + _ => Ok(s), + } +} + +/// Centers the value in a field of a given width +pub fn center(src: &dyn fmt::Display, dst_len: usize) -> Result { + let src = src.to_string(); + let len = src.len(); + + if dst_len <= len { + Ok(src) + } else { + let diff = dst_len - len; + let mid = diff / 2; + let r = diff % 2; + let mut buf = String::with_capacity(dst_len); + + for _ in 0..mid { + buf.push(' '); + } + + buf.push_str(&src); + + for _ in 0..mid + r { + buf.push(' '); + } + + Ok(buf) + } +} + +/// Count the words in that string +pub fn wordcount(s: T) -> Result { + let s = s.to_string(); + + Ok(s.split_whitespace().count()) +} + +#[cfg(feature = "markdown")] +pub fn markdown( + e: E, + s: S, + options: Option<&comrak::ComrakOptions>, +) -> Result> +where + E: Escaper, + S: AsRef, +{ + use comrak::{ + markdown_to_html, ComrakExtensionOptions, ComrakOptions, ComrakParseOptions, + ComrakRenderOptions, ListStyleType, + }; + + const DEFAULT_OPTIONS: ComrakOptions = ComrakOptions { + extension: ComrakExtensionOptions { + strikethrough: true, + tagfilter: true, + table: true, + autolink: true, + // default: + tasklist: false, + superscript: false, + header_ids: None, + footnotes: false, + description_lists: false, + front_matter_delimiter: None, + }, + parse: ComrakParseOptions { + // default: + smart: false, + default_info_string: None, + relaxed_tasklist_matching: false, + }, + render: ComrakRenderOptions { + unsafe_: false, + escape: true, + // default: + hardbreaks: false, + github_pre_lang: false, + width: 0, + list_style: ListStyleType::Dash, + }, + }; + + let s = markdown_to_html(s.as_ref(), options.unwrap_or(&DEFAULT_OPTIONS)); + Ok(MarkupDisplay::new_safe(s, e)) +} + +#[cfg(test)] +mod tests { + use super::*; + #[cfg(feature = "num-traits")] + use std::f64::INFINITY; + + #[cfg(feature = "humansize")] + #[test] + fn test_filesizeformat() { + assert_eq!(filesizeformat(&0).unwrap(), "0 B"); + assert_eq!(filesizeformat(&999u64).unwrap(), "999 B"); + assert_eq!(filesizeformat(&1000i32).unwrap(), "1 kB"); + assert_eq!(filesizeformat(&1023).unwrap(), "1.02 kB"); + assert_eq!(filesizeformat(&1024usize).unwrap(), "1.02 kB"); + } + + #[cfg(feature = "percent-encoding")] + #[test] + fn test_urlencoding() { + // Unreserved (https://tools.ietf.org/html/rfc3986.html#section-2.3) + // alpha / digit + assert_eq!(urlencode("AZaz09").unwrap(), "AZaz09"); + assert_eq!(urlencode_strict("AZaz09").unwrap(), "AZaz09"); + // other + assert_eq!(urlencode("_.-~").unwrap(), "_.-~"); + assert_eq!(urlencode_strict("_.-~").unwrap(), "_.-~"); + + // Reserved (https://tools.ietf.org/html/rfc3986.html#section-2.2) + // gen-delims + assert_eq!(urlencode(":/?#[]@").unwrap(), "%3A/%3F%23%5B%5D%40"); + assert_eq!( + urlencode_strict(":/?#[]@").unwrap(), + "%3A%2F%3F%23%5B%5D%40" + ); + // sub-delims + assert_eq!( + urlencode("!$&'()*+,;=").unwrap(), + "%21%24%26%27%28%29%2A%2B%2C%3B%3D" + ); + assert_eq!( + urlencode_strict("!$&'()*+,;=").unwrap(), + "%21%24%26%27%28%29%2A%2B%2C%3B%3D" + ); + + // Other + assert_eq!( + urlencode("žŠďŤňĚáÉóŮ").unwrap(), + "%C5%BE%C5%A0%C4%8F%C5%A4%C5%88%C4%9A%C3%A1%C3%89%C3%B3%C5%AE" + ); + assert_eq!( + urlencode_strict("žŠďŤňĚáÉóŮ").unwrap(), + "%C5%BE%C5%A0%C4%8F%C5%A4%C5%88%C4%9A%C3%A1%C3%89%C3%B3%C5%AE" + ); + + // Ferris + assert_eq!(urlencode("🦀").unwrap(), "%F0%9F%A6%80"); + assert_eq!(urlencode_strict("🦀").unwrap(), "%F0%9F%A6%80"); + } + + #[test] + fn test_linebreaks() { + assert_eq!( + linebreaks("Foo\nBar Baz").unwrap(), + "

Foo
Bar Baz

" + ); + assert_eq!( + linebreaks("Foo\nBar\n\nBaz").unwrap(), + "

Foo
Bar

Baz

" + ); + } + + #[test] + fn test_linebreaksbr() { + assert_eq!(linebreaksbr("Foo\nBar").unwrap(), "Foo
Bar"); + assert_eq!( + linebreaksbr("Foo\nBar\n\nBaz").unwrap(), + "Foo
Bar

Baz" + ); + } + + #[test] + fn test_paragraphbreaks() { + assert_eq!( + paragraphbreaks("Foo\nBar Baz").unwrap(), + "

Foo\nBar Baz

" + ); + assert_eq!( + paragraphbreaks("Foo\nBar\n\nBaz").unwrap(), + "

Foo\nBar

Baz

" + ); + assert_eq!( + paragraphbreaks("Foo\n\n\n\n\nBar\n\nBaz").unwrap(), + "

Foo

\nBar

Baz

" + ); + } + + #[test] + fn test_lower() { + assert_eq!(lower("Foo").unwrap(), "foo"); + assert_eq!(lower("FOO").unwrap(), "foo"); + assert_eq!(lower("FooBar").unwrap(), "foobar"); + assert_eq!(lower("foo").unwrap(), "foo"); + } + + #[test] + fn test_upper() { + assert_eq!(upper("Foo").unwrap(), "FOO"); + assert_eq!(upper("FOO").unwrap(), "FOO"); + assert_eq!(upper("FooBar").unwrap(), "FOOBAR"); + assert_eq!(upper("foo").unwrap(), "FOO"); + } + + #[test] + fn test_trim() { + assert_eq!(trim(" Hello\tworld\t").unwrap(), "Hello\tworld"); + } + + #[test] + fn test_truncate() { + assert_eq!(truncate("hello", 2).unwrap(), "he..."); + let a = String::from("您好"); + assert_eq!(a.len(), 6); + assert_eq!(String::from("您").len(), 3); + assert_eq!(truncate("您好", 1).unwrap(), "您..."); + assert_eq!(truncate("您好", 2).unwrap(), "您..."); + assert_eq!(truncate("您好", 3).unwrap(), "您..."); + assert_eq!(truncate("您好", 4).unwrap(), "您好..."); + assert_eq!(truncate("您好", 6).unwrap(), "您好"); + assert_eq!(truncate("您好", 7).unwrap(), "您好"); + let s = String::from("🤚a🤚"); + assert_eq!(s.len(), 9); + assert_eq!(String::from("🤚").len(), 4); + assert_eq!(truncate("🤚a🤚", 1).unwrap(), "🤚..."); + assert_eq!(truncate("🤚a🤚", 2).unwrap(), "🤚..."); + assert_eq!(truncate("🤚a🤚", 3).unwrap(), "🤚..."); + assert_eq!(truncate("🤚a🤚", 4).unwrap(), "🤚..."); + assert_eq!(truncate("🤚a🤚", 5).unwrap(), "🤚a..."); + assert_eq!(truncate("🤚a🤚", 6).unwrap(), "🤚a🤚..."); + assert_eq!(truncate("🤚a🤚", 9).unwrap(), "🤚a🤚"); + assert_eq!(truncate("🤚a🤚", 10).unwrap(), "🤚a🤚"); + } + + #[test] + fn test_indent() { + assert_eq!(indent("hello", 2).unwrap(), "hello"); + assert_eq!(indent("hello\n", 2).unwrap(), "hello\n"); + assert_eq!(indent("hello\nfoo", 2).unwrap(), "hello\n foo"); + assert_eq!( + indent("hello\nfoo\n bar", 4).unwrap(), + "hello\n foo\n bar" + ); + } + + #[cfg(feature = "num-traits")] + #[test] + #[allow(clippy::float_cmp)] + fn test_into_f64() { + assert_eq!(into_f64(1).unwrap(), 1.0_f64); + assert_eq!(into_f64(1.9).unwrap(), 1.9_f64); + assert_eq!(into_f64(-1.9).unwrap(), -1.9_f64); + assert_eq!(into_f64(INFINITY as f32).unwrap(), INFINITY); + assert_eq!(into_f64(-INFINITY as f32).unwrap(), -INFINITY); + } + + #[cfg(feature = "num-traits")] + #[test] + fn test_into_isize() { + assert_eq!(into_isize(1).unwrap(), 1_isize); + assert_eq!(into_isize(1.9).unwrap(), 1_isize); + assert_eq!(into_isize(-1.9).unwrap(), -1_isize); + assert_eq!(into_isize(1.5_f64).unwrap(), 1_isize); + assert_eq!(into_isize(-1.5_f64).unwrap(), -1_isize); + match into_isize(INFINITY) { + Err(Fmt(fmt::Error)) => {} + _ => panic!("Should return error of type Err(Fmt(fmt::Error))"), + }; + } + + #[allow(clippy::needless_borrow)] + #[test] + fn test_join() { + assert_eq!( + join((&["hello", "world"]).iter(), ", ").unwrap(), + "hello, world" + ); + assert_eq!(join((&["hello"]).iter(), ", ").unwrap(), "hello"); + + let empty: &[&str] = &[]; + assert_eq!(join(empty.iter(), ", ").unwrap(), ""); + + let input: Vec = vec!["foo".into(), "bar".into(), "bazz".into()]; + assert_eq!(join(input.iter(), ":").unwrap(), "foo:bar:bazz"); + + let input: &[String] = &["foo".into(), "bar".into()]; + assert_eq!(join(input.iter(), ":").unwrap(), "foo:bar"); + + let real: String = "blah".into(); + let input: Vec<&str> = vec![&real]; + assert_eq!(join(input.iter(), ";").unwrap(), "blah"); + + assert_eq!( + join((&&&&&["foo", "bar"]).iter(), ", ").unwrap(), + "foo, bar" + ); + } + + #[cfg(feature = "num-traits")] + #[test] + #[allow(clippy::float_cmp)] + fn test_abs() { + assert_eq!(abs(1).unwrap(), 1); + assert_eq!(abs(-1).unwrap(), 1); + assert_eq!(abs(1.0).unwrap(), 1.0); + assert_eq!(abs(-1.0).unwrap(), 1.0); + assert_eq!(abs(1.0_f64).unwrap(), 1.0_f64); + assert_eq!(abs(-1.0_f64).unwrap(), 1.0_f64); + } + + #[test] + fn test_capitalize() { + assert_eq!(capitalize("foo").unwrap(), "Foo".to_string()); + assert_eq!(capitalize("f").unwrap(), "F".to_string()); + assert_eq!(capitalize("fO").unwrap(), "Fo".to_string()); + assert_eq!(capitalize("").unwrap(), "".to_string()); + assert_eq!(capitalize("FoO").unwrap(), "Foo".to_string()); + assert_eq!(capitalize("foO BAR").unwrap(), "Foo bar".to_string()); + assert_eq!(capitalize("äØÄÅÖ").unwrap(), "Äøäåö".to_string()); + assert_eq!(capitalize("ß").unwrap(), "SS".to_string()); + assert_eq!(capitalize("ßß").unwrap(), "SSß".to_string()); + } + + #[test] + fn test_center() { + assert_eq!(center(&"f", 3).unwrap(), " f ".to_string()); + assert_eq!(center(&"f", 4).unwrap(), " f ".to_string()); + assert_eq!(center(&"foo", 1).unwrap(), "foo".to_string()); + assert_eq!(center(&"foo bar", 8).unwrap(), "foo bar ".to_string()); + } + + #[test] + fn test_wordcount() { + assert_eq!(wordcount("").unwrap(), 0); + assert_eq!(wordcount(" \n\t").unwrap(), 0); + assert_eq!(wordcount("foo").unwrap(), 1); + assert_eq!(wordcount("foo bar").unwrap(), 2); + } +} diff --git a/vendor/askama/src/filters/yaml.rs b/vendor/askama/src/filters/yaml.rs new file mode 100644 index 000000000..9f4c8021c --- /dev/null +++ b/vendor/askama/src/filters/yaml.rs @@ -0,0 +1,34 @@ +use crate::error::{Error, Result}; +use askama_escape::{Escaper, MarkupDisplay}; +use serde::Serialize; + +/// Serialize to YAML (requires `serde_yaml` feature) +/// +/// ## Errors +/// +/// This will panic if `S`'s implementation of `Serialize` decides to fail, +/// or if `T` contains a map with non-string keys. +pub fn yaml(e: E, s: S) -> Result> { + match serde_yaml::to_string(&s) { + Ok(s) => Ok(MarkupDisplay::new_safe(s, e)), + Err(e) => Err(Error::from(e)), + } +} + +#[cfg(test)] +mod tests { + use super::*; + use askama_escape::Html; + + #[test] + fn test_yaml() { + assert_eq!(yaml(Html, true).unwrap().to_string(), "true\n"); + assert_eq!(yaml(Html, "foo").unwrap().to_string(), "foo\n"); + assert_eq!(yaml(Html, true).unwrap().to_string(), "true\n"); + assert_eq!(yaml(Html, "foo").unwrap().to_string(), "foo\n"); + assert_eq!( + yaml(Html, &vec!["foo", "bar"]).unwrap().to_string(), + "- foo\n- bar\n" + ); + } +} diff --git a/vendor/askama/src/helpers.rs b/vendor/askama/src/helpers.rs new file mode 100644 index 000000000..79a1ada20 --- /dev/null +++ b/vendor/askama/src/helpers.rs @@ -0,0 +1,48 @@ +use std::iter::{Enumerate, Peekable}; + +pub struct TemplateLoop +where + I: Iterator, +{ + iter: Peekable>, +} + +impl TemplateLoop +where + I: Iterator, +{ + #[inline] + pub fn new(iter: I) -> Self { + TemplateLoop { + iter: iter.enumerate().peekable(), + } + } +} + +impl Iterator for TemplateLoop +where + I: Iterator, +{ + type Item = (::Item, LoopItem); + + #[inline] + fn next(&mut self) -> Option<(::Item, LoopItem)> { + self.iter.next().map(|(index, item)| { + ( + item, + LoopItem { + index, + first: index == 0, + last: self.iter.peek().is_none(), + }, + ) + }) + } +} + +#[derive(Copy, Clone)] +pub struct LoopItem { + pub index: usize, + pub first: bool, + pub last: bool, +} diff --git a/vendor/askama/src/lib.rs b/vendor/askama/src/lib.rs index 185e8cc76..17085b5d6 100644 --- a/vendor/askama/src/lib.rs +++ b/vendor/askama/src/lib.rs @@ -59,23 +59,27 @@ //! in the configuration file. The default syntax , "default", is the one //! provided by Askama. -#![allow(unused_imports)] +#![forbid(unsafe_code)] #![deny(elided_lifetimes_in_paths)] +#![deny(unreachable_pub)] -#[macro_use] -extern crate askama_derive; -pub use askama_shared as shared; +mod error; +pub mod filters; +pub mod helpers; -use std::fs::{self, DirEntry}; -use std::io; -use std::path::Path; +use std::fmt; -pub use askama_escape::{Html, Text}; +pub use askama_derive::Template; +pub use askama_escape::{Html, MarkupDisplay, Text}; + +#[doc(hidden)] +pub use crate as shared; +pub use crate::error::{Error, Result}; /// Main `Template` trait; implementations are generally derived /// /// If you need an object-safe template, use [`DynTemplate`]. -pub trait Template { +pub trait Template: fmt::Display { /// Helper method which allocates a new `String` and renders into it fn render(&self) -> Result { let mut buf = String::with_capacity(Self::SIZE_HINT); @@ -83,14 +87,23 @@ pub trait Template { Ok(buf) } - /// Renders the template to the given `writer` buffer + /// Renders the template to the given `writer` fmt buffer fn render_into(&self, writer: &mut (impl std::fmt::Write + ?Sized)) -> Result<()>; + /// Renders the template to the given `writer` io buffer + #[inline] + fn write_into(&self, writer: &mut (impl std::io::Write + ?Sized)) -> std::io::Result<()> { + writer.write_fmt(format_args!("{self}")) + } + /// The template's extension, if provided const EXTENSION: Option<&'static str>; /// Provides a conservative estimate of the expanded length of the rendered template const SIZE_HINT: usize; + + /// The MIME type (Content-Type) of the data that gets rendered by this Template + const MIME_TYPE: &'static str; } /// Object-safe wrapper trait around [`Template`] implementers @@ -100,14 +113,20 @@ pub trait DynTemplate { /// Helper method which allocates a new `String` and renders into it fn dyn_render(&self) -> Result; - /// Renders the template to the given `writer` buffer + /// Renders the template to the given `writer` fmt buffer fn dyn_render_into(&self, writer: &mut dyn std::fmt::Write) -> Result<()>; + /// Renders the template to the given `writer` io buffer + fn dyn_write_into(&self, writer: &mut dyn std::io::Write) -> std::io::Result<()>; + /// Helper function to inspect the template's extension fn extension(&self) -> Option<&'static str>; /// Provides a conservative estimate of the expanded length of the rendered template fn size_hint(&self) -> usize; + + /// The MIME type (Content-Type) of the data that gets rendered by this Template + fn mime_type(&self) -> &'static str; } impl DynTemplate for T { @@ -119,6 +138,11 @@ impl DynTemplate for T { ::render_into(self, writer) } + #[inline] + fn dyn_write_into(&self, writer: &mut dyn std::io::Write) -> std::io::Result<()> { + writer.write_fmt(format_args!("{self}")) + } + fn extension(&self) -> Option<&'static str> { Self::EXTENSION } @@ -126,75 +150,70 @@ impl DynTemplate for T { fn size_hint(&self) -> usize { Self::SIZE_HINT } -} -pub use crate::shared::filters; -pub use crate::shared::helpers; -pub use crate::shared::{read_config_file, Error, MarkupDisplay, Result}; -pub use askama_derive::*; - -pub mod mime { - #[cfg(all(feature = "mime_guess", feature = "mime"))] - pub fn extension_to_mime_type(ext: &str) -> mime_guess::Mime { - let basic_type = mime_guess::from_ext(ext).first_or_octet_stream(); - for (simple, utf_8) in &TEXT_TYPES { - if &basic_type == simple { - return utf_8.clone(); - } - } - basic_type + fn mime_type(&self) -> &'static str { + Self::MIME_TYPE } - - #[cfg(all(feature = "mime_guess", feature = "mime"))] - const TEXT_TYPES: [(mime_guess::Mime, mime_guess::Mime); 6] = [ - (mime::TEXT_PLAIN, mime::TEXT_PLAIN_UTF_8), - (mime::TEXT_HTML, mime::TEXT_HTML_UTF_8), - (mime::TEXT_CSS, mime::TEXT_CSS_UTF_8), - (mime::TEXT_CSV, mime::TEXT_CSV_UTF_8), - ( - mime::TEXT_TAB_SEPARATED_VALUES, - mime::TEXT_TAB_SEPARATED_VALUES_UTF_8, - ), - ( - mime::APPLICATION_JAVASCRIPT, - mime::APPLICATION_JAVASCRIPT_UTF_8, - ), - ]; } -/// Old build script helper to rebuild crates if contained templates have changed -/// -/// This function is now deprecated and does nothing. -#[deprecated( - since = "0.8.1", - note = "file-level dependency tracking is handled automatically without build script" -)] -pub fn rerun_if_templates_changed() {} +impl fmt::Display for dyn DynTemplate { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + self.dyn_render_into(f).map_err(|_| ::std::fmt::Error {}) + } +} #[cfg(test)] mod tests { - use super::{DynTemplate, Template}; + use std::fmt; + + use super::*; + use crate::{DynTemplate, Template}; #[test] fn dyn_template() { struct Test; impl Template for Test { - fn render_into( - &self, - writer: &mut (impl std::fmt::Write + ?Sized), - ) -> askama_shared::Result<()> { + fn render_into(&self, writer: &mut (impl std::fmt::Write + ?Sized)) -> Result<()> { Ok(writer.write_str("test")?) } const EXTENSION: Option<&'static str> = Some("txt"); const SIZE_HINT: usize = 4; + + const MIME_TYPE: &'static str = "text/plain; charset=utf-8"; + } + + impl fmt::Display for Test { + #[inline] + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + self.render_into(f).map_err(|_| fmt::Error {}) + } } fn render(t: &dyn DynTemplate) -> String { t.dyn_render().unwrap() } - assert_eq!(render(&Test), "test"); + let test = &Test as &dyn DynTemplate; + + assert_eq!(render(test), "test"); + + assert_eq!(test.to_string(), "test"); + + assert_eq!(format!("{test}"), "test"); + + let mut vec = Vec::new(); + test.dyn_write_into(&mut vec).unwrap(); + assert_eq!(vec, vec![b't', b'e', b's', b't']); } } + +/// Old build script helper to rebuild crates if contained templates have changed +/// +/// This function is now deprecated and does nothing. +#[deprecated( + since = "0.8.1", + note = "file-level dependency tracking is handled automatically without build script" +)] +pub fn rerun_if_templates_changed() {} -- cgit v1.2.3