Restructure folders (#411)

2025-06-28 18:00:37 +02:00 · 2021-02-25 21:57:58 -03:00
parent 9db98162b2
commit c3407627d0
334 changed files with 127 additions and 120 deletions
--- a/template_engines/yarte/Cargo.toml
+++ b/template_engines/yarte/Cargo.toml
@ -0,0 +1,21 @@
+[package]
+name = "template_yarte"
+version = "0.0.1"
+authors = ["Juan Aguilar Santillana <mhpoin@gmail.com>"]
+publish = false
+edition = "2018"
+
+[dependencies]
+actix-web = "3"
+env_logger = "0.8"
+# TODO: remove fixed feature. Is a bug.
+yarte = { version = "0.12", features = ["bytes-buf", "html-min", "fixed"] }
+derive_more = "0.99"
+
+[build-dependencies.yarte_helpers]
+version = "0.12"
+default-features = false
+features = ["config"]
+
+[dev-dependencies]
+actix-rt = "1"
--- a/template_engines/yarte/README.md
+++ b/template_engines/yarte/README.md
@ -0,0 +1,10 @@
+# yarte
+
+Minimal example of using template [yarte](https://github.com/botika/yarte) that displays a form.
+
+```bash
+cargo test
+
+cargo run
+```
+> open `localhost:8080`
--- a/template_engines/yarte/build.rs
+++ b/template_engines/yarte/build.rs
@ -0,0 +1,3 @@
+fn main() {
+    yarte_helpers::recompile::when_changed();
+}
--- a/template_engines/yarte/src/main.rs
+++ b/template_engines/yarte/src/main.rs
@ -0,0 +1,126 @@
+use std::collections::HashMap;
+
+use actix_web::{
+    get, middleware::Logger, web, App, Error, HttpResponse, HttpServer, ResponseError,
+};
+use derive_more::Display;
+use yarte::ywrite_min;
+
+#[derive(Debug, Display)]
+struct MyErr(pub &'static str);
+
+impl ResponseError for MyErr {}
+
+#[get("/")]
+async fn index(
+    query: web::Query<HashMap<String, String>>,
+) -> Result<HttpResponse, Error> {
+    let mut body = web::BytesMut::with_capacity(512);
+    // `ywrite_min` is work in progress check your templates before put in production
+    // or use `ywrite_html`
+    ywrite_min!(body, "{{> index }}");
+
+    Ok(HttpResponse::Ok()
+        .content_type("text/html; charset=utf-8")
+        .body(body))
+}
+
+#[actix_web::main]
+async fn main() -> std::io::Result<()> {
+    std::env::set_var("RUST_LOG", "actix_web=info");
+    env_logger::init();
+
+    // start http server
+    HttpServer::new(move || App::new().wrap(Logger::default()).service(index))
+        .bind("127.0.0.1:8080")?
+        .run()
+        .await
+}
+
+#[cfg(test)]
+mod test {
+    use actix_web::{http, test as atest, web::Bytes};
+
+    use super::*;
+
+    #[actix_rt::test]
+    async fn test() {
+        let mut app = atest::init_service(App::new().service(index)).await;
+
+        let req = atest::TestRequest::with_uri("/").to_request();
+        let resp = atest::call_service(&mut app, req).await;
+
+        assert!(resp.status().is_success());
+
+        assert_eq!(
+            resp.headers().get(http::header::CONTENT_TYPE).unwrap(),
+            "text/html; charset=utf-8"
+        );
+
+        let bytes = atest::read_body(resp).await;
+        assert_eq!(
+            bytes,
+            Bytes::from_static(
+                "<!DOCTYPE html><html><head><meta charset=\"utf-8\"><title>Actix \
+                 web</title></head><body><h1 id=\"welcome\" \
+                 class=\"welcome\">Welcome!</h1><div><h3>What is your name?</h3><form>Name: \
+                 <input type=\"text\" name=\"name\"><br>Last name: <input type=\"text\" \
+                 name=\"lastname\"><br><p><input type=\"submit\"></p></form></div></body></html>"
+                    .as_ref()
+            )
+        );
+
+        let req = atest::TestRequest::with_uri("/?name=foo&lastname=bar").to_request();
+        let resp = atest::call_service(&mut app, req).await;
+
+        assert!(resp.status().is_success());
+
+        assert_eq!(
+            resp.headers().get(http::header::CONTENT_TYPE).unwrap(),
+            "text/html; charset=utf-8"
+        );
+
+        let bytes = atest::read_body(resp).await;
+        assert_eq!(
+            bytes,
+            Bytes::from_static(
+                "<!DOCTYPE html><html><head><meta charset=\"utf-8\"><title>Actix \
+                 web</title></head><body><h1>Hi, foo bar!</h1><p id=\"hi\" \
+                 class=\"welcome\">Welcome</p></body></html>"
+                    .as_ref()
+            )
+        );
+
+        let req = atest::TestRequest::with_uri("/?name=foo").to_request();
+        let resp = atest::call_service(&mut app, req).await;
+
+        assert!(resp.status().is_server_error());
+
+        let bytes = atest::read_body(resp).await;
+
+        assert_eq!(bytes, Bytes::from_static("Bad query".as_ref()));
+
+        let req = atest::TestRequest::with_uri("/?lastname=bar").to_request();
+        let resp = atest::call_service(&mut app, req).await;
+
+        assert!(resp.status().is_success());
+
+        assert_eq!(
+            resp.headers().get(http::header::CONTENT_TYPE).unwrap(),
+            "text/html; charset=utf-8"
+        );
+
+        let bytes = atest::read_body(resp).await;
+        assert_eq!(
+            bytes,
+            Bytes::from_static(
+                "<!DOCTYPE html><html><head><meta charset=\"utf-8\"><title>Actix \
+                 web</title></head><body><h1 id=\"welcome\" \
+                 class=\"welcome\">Welcome!</h1><div><h3>What is your name?</h3><form>Name: \
+                 <input type=\"text\" name=\"name\"><br>Last name: <input type=\"text\" \
+                 name=\"lastname\"><br><p><input type=\"submit\"></p></form></div></body></html>"
+                    .as_ref()
+            )
+        );
+    }
+}
--- a/template_engines/yarte/templates/base.hbs
+++ b/template_engines/yarte/templates/base.hbs
@ -0,0 +1,8 @@
+{{! Simple example !}}
+{{> doc/t }}
+<html>
+{{> doc/head }}
+<body>
+{{> @partial-block }}
+</body>
+</html>
--- a/template_engines/yarte/templates/deep/more/card/form.hbs
+++ b/template_engines/yarte/templates/deep/more/card/form.hbs
@ -0,0 +1,16 @@
+{{!
+    Form: What is your name?
+!}}
+{{> ../deep/welcome id = "welcome", tag = "h1", tail = '!' ~}}
+<div>
+    <h3>What is your name?</h3>
+    <form>
+        {{! Input name !}}
+        Name: <input type="text" name="name" /><br/>
+        {{! Input last name !}}
+        Last name: <input type="text" name="lastname"/><br/>
+        <p>
+            <input type="submit">
+        </p>
+    </form>
+</div>
--- a/template_engines/yarte/templates/deep/more/card/hi.hbs
+++ b/template_engines/yarte/templates/deep/more/card/hi.hbs
@ -0,0 +1,8 @@
+{{!
+    Hi message:
+    args:
+        - lastname
+        - name
+!}}
+<h1>Hi, {{ name }} {{ lastname }}!</h1>
+{{~> alias/welcome id = "hi", tag = 'p', tail = "" }}
--- a/template_engines/yarte/templates/deep/more/deep/welcome.hbs
+++ b/template_engines/yarte/templates/deep/more/deep/welcome.hbs
@ -0,0 +1,11 @@
+{{!
+    Welcome card:
+    args:
+        - tag
+        - id
+        - tail
+!}}
+{{#unless tag.is_match(r"^p|(h[1-6])$") && !id.is_empty() }}
+   {{$ "Need static args: tag: str /^h[1-6]$/, id: str" }}
+{{/unless }}
+<{{ tag }} id="{{ id }}" class="welcome">Welcome{{ tail }}</{{ tag }}>
--- a/template_engines/yarte/templates/deep/more/doc/head.hbs
+++ b/template_engines/yarte/templates/deep/more/doc/head.hbs
@ -0,0 +1,7 @@
+{{# unless title.is_str() && !title.is_empty() }}
+    {{$ "Need static args: title: str" }}
+{{/unless}}
+<head>
+    <meta charset="utf-8"/>
+    <title>{{ title }}</title>
+</head>
--- a/template_engines/yarte/templates/deep/more/doc/t.hbs
+++ b/template_engines/yarte/templates/deep/more/doc/t.hbs
@ -0,0 +1 @@
+<!DOCTYPE html>
--- a/template_engines/yarte/templates/index.hbs
+++ b/template_engines/yarte/templates/index.hbs
@ -0,0 +1,8 @@
+{{#> base title = "Actix web" }}
+    {{~#if let Some(name) = query.get("name") }}
+        {{ let lastname = query.get("lastname").ok_or(MyErr("Bad query"))? }}
+        {{> card/hi ~}}
+    {{ else ~}}
+        {{> card/form ~}}
+    {{/if ~}}
+{{/base }}
--- a/template_engines/yarte/yarte.toml
+++ b/template_engines/yarte/yarte.toml
@ -0,0 +1,9 @@
+# root dir of templates
+[main]
+dir = "templates"
+
+# Alias for partials. In call, change the start of partial path with one of this, if exist.
+[partials]
+alias = "./deep/more/deep"
+doc = "./deep/more/doc"
+card = "./deep/more/card"