Support 'include' and 'inheritance' #7

tandiljuan · 2021-08-22T20:23:08Z

These changes add support for:

chevdor · 2021-08-23T08:28:02Z

Very nice, thanks @tandiljuan !
I will test is shortly but here is already a "thank you!" and a few comments.

Would you mind adding a short word/example about the new feature in the readme ?

This is done in the adoc file. The readme.md is generated with just md.

I find --patha little vague.
What do you think about renaming --path to --include or --include-path ?

chevdor · 2021-08-23T09:00:49Z

It will be time I add benchmarks :)

I tested the following:

time ./target/release/tera --template data/polkadot-metadata/metdata.tera data/polkadot-metadata/v13.json

and (where tera is the latest release:

time tera --template data/polkadot-metadata/metdata.tera data/polkadot-metadata/v13.json

With the latest release, on my machine, the run takes around 9ms.
With your PR, I get to 70~75ms which is significantly more which makes me think that it may not be optimum for big templates/data to enable your include/path feature by default.

I think it might be better to keep this new --path or --include flag fully opt-in and not have anything more done if --path or --include is not passed by the user.

tandiljuan · 2021-08-23T10:57:35Z

Hi @chevdor !

All the suggestions seems good to me.

I'll work on them ASAP (probably in the weekend) and I'll let you know once I have the update ready.

Kind regards.

chevdor · 2021-08-23T11:00:42Z

Sure, no stress but I am looking forward to have this merged in. It was also on my list so very nice that you did it.
I also welcome the (althought not related :)) changes to the release profile.

tandiljuan · 2021-09-03T02:18:48Z

Hi @chevdor ! I did the requested updates. Could you please check if everything is okay? Thanks!

chevdor · 2021-09-03T07:24:39Z

Not sure I will manage today but I'll see if I can squeeze it in. Thanks a lot for your time on this!

chevdor · 2021-09-03T07:26:48Z

Short comment, I will you squeezed more features in. In general, it would be best to split them in different PRs so interesting features are not blocked by say.. some docker grumbles. Leave it as it is for now and I will check it as it is. Just keep in mind that I may ask you to split :)

chevdor · 2021-09-03T07:28:10Z

Dockerfile

@@ -0,0 +1,46 @@
+FROM rust:1.54.0-slim-buster as tera


totally a non issue but the builder image stage in multistage images is usually called builder.

chevdor

Awesome work !

Considering the number of comments I made regarding Docker, I think it may be better to split this PR and move the Docker part to another PR so we can already merge the first one.

So regarding the --include part of the PR, I think it would be great adding a simple example under data/include for instance. That makes manual testing easier, helps to add cli tests later, and I can also pull the example into the doc.

Feel free to include the example to the .adoc yourself if you fancy playing with asciidoc includes but I would ask you to do so only if you can run just md yourself to update the markdown. Otherwise, leave it and I will take care of it later.

As far as the example is concerned, we can keep it dead simple with:

./data/include/hello.txt:

Hello {{ USER }}, this is the Hello template.
{% include "world.txt" %}

./data/include/world.txt:

This is the world template.

and documenting the call as:

tera -t ./data/include/hello.txt --include --env-only

chevdor · 2021-09-03T07:30:00Z

README_src.adoc

+
+=== Build container image
+
+    docker build --rm --tag 'tera/cli' .


What does --rm do in that context ?

Remove intermediate containers after a successful build. The default is true.
But, taking in mind the default is true, we can remove it.

chevdor · 2021-09-03T07:31:00Z

README_src.adoc

+Parse a template
+
+    docker run --interactive --tty --rm \
+        --volume="$(pwd):/opt" \


Why mounting this volume ?
It does not seem to be used after.

It's needed to mounts the templates into the container and be able to parse them.

chevdor · 2021-09-03T07:49:10Z

README_src.adoc

@@ -56,6 +56,25 @@ The **tera** engine allows way more than the simple replacements shown above. Yo

    cargo install --git https://github.com/chevdor/tera-cli

+== Execute from container


Suggested change

== Execute from container

== Execute as Docker container

chevdor · 2021-09-03T07:51:37Z

Dockerfile

+# Install dependencies
+# ******************************************************************************
+RUN set -eux \
+    && DEBIAN_FRONTEND=noninteractive apt-get update \


I would rather suggest we add:

ARG DEBIAN_FRONTEND=noninteractive

before this RUN and remove all the DEBIAN_FRONTEND=noninteractive from the RUN. That will avoid a lot of repetition.

chevdor · 2021-09-03T07:54:44Z

README_src.adoc

+
+=== Build container image
+
+    docker build --rm --tag 'tera/cli' .


Suggested change

docker build --rm --tag 'tera/cli' .

docker build --tag tera-cli .

We do not own the tera docker user so let's avoid it. People can then run:

docker tag tera-cli tandiljuan/tera-cli

and push it if they want.

chevdor · 2021-09-03T07:54:58Z

README_src.adoc

+
+    docker build --rm --tag 'tera/cli' .
+
+=== Execute `tera` from container


Suggested change

=== Execute `tera` from container

=== Execute `tera` from the Docker container

chevdor · 2021-09-03T07:55:42Z

README_src.adoc

+
+Check tera help
+
+    docker run --interactive --tty --rm tera/cli --help


Suggested change

docker run --interactive --tty --rm tera/cli --help

docker run -it --rm tera-cli --help

I personally like to use long options in documentation to make them more descriptive. But If you prefer the short version, there is no problem.

chevdor · 2021-09-03T07:56:25Z

README_src.adoc

+    docker run --interactive --tty --rm \
+        --volume="$(pwd):/opt" \
+        --env=FOO=BAR \
+        tera/cli --template templates/env-debug.txt --env-only --env-key env


Suggested change

tera/cli --template templates/env-debug.txt --env-only --env-key env

tera-cli --template templates/env-debug.txt --env-only --env-key env

chevdor · 2021-09-03T08:02:05Z

README_src.adoc

@@ -99,6 +118,10 @@ By default, your ENV variables will be loaded at the root of the context data. F

 While the syntax is a little more verbose, paired with `--fail-on-collision`, this option allows ensuring that nothing happens in your back.

+=== External files


I could not push to your branch so you will have to update the mardown. This is just about running a single command.

The easiest if you have the tools is to run just md.

Alternatively, you may simply apply the following patch (assuming you do not modify the .adoc further):

diff --git a/README.md b/README.md index fb0caea..e580470 100644 --- a/README.md +++ b/README.md @@ -75,6 +75,25 @@ The **tera** engine allows way more than the simple replacements shown above. Yo cargo install --git https://github.com/chevdor/tera-cli +## Execute from container + +### Build container image + + docker build --rm --tag 'tera/cli' . + +### Execute `tera` from container + +Check tera help + + docker run --interactive --tty --rm tera/cli --help + +Parse a template + + docker run --interactive --tty --rm \ + --volume="$(pwd):/opt" \ + --env=FOO=BAR \ + tera/cli --template templates/env-debug.txt --env-only --env-key env + ## What can I do with that anyway ? Well… if you have **data** and you want to format them, this tool will likely be a great companion. @@ -125,6 +144,10 @@ By default, your ENV variables will be loaded at the root of the context data. F While the syntax is a little more verbose, paired with `--fail-on-collision`, this option allows ensuring that nothing happens in your back. +### External files + +Using the `--include` flag, the command will scan recursively for files that could be [included](https://tera.netlify.app/docs/#include), used as [macros](https://tera.netlify.app/docs/#macros) or for [inheritance](https://tera.netlify.app/docs/#inheritance). By default, it will scan the folder where the main template is located, unless the `--include-path` option is given. + ### Output By default,

chevdor · 2021-09-03T08:23:56Z

Here is a simple inheritance sample:

./data/inheritance/base.txt:

This is a BASE template.
The default greetings shows "Gretings !" but we can improve that with inheritance!
{% block greetings %}
Greetings !
{% endblock head %}

./data/inheritance/child.txt:

{% extends "base.txt" %}

The following block will replace our greetings in the base.
{% block greetings %}
May the force be with you ✨ {{ USER }} ✨
{% endblock greetings %}

And the call:

tera -t ./data/inheritance/child.txt --include --env-only

chevdor · 2021-09-03T08:27:08Z

src/opts.rs

@@ -11,6 +11,15 @@ pub struct Opts {
 	#[clap(short, long)]
 	pub template: PathBuf,

+	/// This flag tells the command to parse all templates found in the same
+	/// path where the given template is located.
+	#[clap(short, long)]


I am thinking the following may help:

Suggested change

#[clap(short, long)]

#[clap(short, long, alias="inherit")]

what do you think ?

That would make the inheritance example look like:

tera -t ./data/inheritance/child.txt --inherit --env-only

tandiljuan · 2021-09-03T14:17:40Z

Hi @chevdor ! I'm going to close this pull request and split it in two new pull requests with the suggested changes.

chevdor · 2021-09-03T14:43:49Z

ok, thanks for the extra efforts :)
If you make them into branches and allow access, I can take care of the .adoc conversions for instance and directly push to your branch.

tandiljuan added 4 commits September 2, 2021 22:52

Flag to parse everything in the same path as the template

ed0c007

Logic for 'include' flag

27d2cc6

Option to define a different include path

93ab8b7

Logic for include-path option

1be5a39

tandiljuan force-pushed the master branch from 2371755 to 3950dc8 Compare September 3, 2021 02:04

tandiljuan added 4 commits September 2, 2021 23:16

Document new --include flag and --include-path option

5989b50

Define 'release' profile

cf47b0d

Dockerfile to build tera-cli image

153cdfa

Document how to build tera cli container

b54c9e3

tandiljuan force-pushed the master branch from 3950dc8 to b54c9e3 Compare September 3, 2021 02:17

chevdor reviewed Sep 3, 2021

View reviewed changes

chevdor requested changes Sep 3, 2021

View reviewed changes

chevdor reviewed Sep 3, 2021

View reviewed changes

tandiljuan closed this Sep 3, 2021

This was referenced Sep 5, 2021

Feature: dockerfile #8

Merged

Feature: include #9

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support 'include' and 'inheritance' #7

Support 'include' and 'inheritance' #7

tandiljuan commented Aug 22, 2021

chevdor commented Aug 23, 2021

chevdor commented Aug 23, 2021

tandiljuan commented Aug 23, 2021

chevdor commented Aug 23, 2021

tandiljuan commented Sep 3, 2021 •

edited

Loading

chevdor commented Sep 3, 2021

chevdor commented Sep 3, 2021

chevdor Sep 3, 2021

chevdor left a comment

chevdor Sep 3, 2021

tandiljuan Sep 4, 2021

chevdor Sep 3, 2021

tandiljuan Sep 4, 2021

chevdor Sep 3, 2021

chevdor Sep 3, 2021

chevdor Sep 3, 2021

chevdor Sep 3, 2021

chevdor Sep 3, 2021

tandiljuan Sep 4, 2021

chevdor Sep 3, 2021

chevdor Sep 3, 2021

chevdor commented Sep 3, 2021

chevdor Sep 3, 2021

tandiljuan commented Sep 3, 2021

chevdor commented Sep 3, 2021 •

edited

Loading


		=== Build container image

		docker build --rm --tag 'tera/cli' .

		@@ -56,6 +56,25 @@ The tera engine allows way more than the simple replacements shown above. Yo

		cargo install --git https://github.com/chevdor/tera-cli

		== Execute from container

	docker build --rm --tag 'tera/cli' .
	docker build --tag tera-cli .


		docker build --rm --tag 'tera/cli' .

		=== Execute `tera` from container

	=== Execute `tera` from container
	=== Execute `tera` from the Docker container


		Check tera help

		docker run --interactive --tty --rm tera/cli --help

	docker run --interactive --tty --rm tera/cli --help
	docker run -it --rm tera-cli --help

	tera/cli --template templates/env-debug.txt --env-only --env-key env
	tera-cli --template templates/env-debug.txt --env-only --env-key env

		@@ -99,6 +118,10 @@ By default, your ENV variables will be loaded at the root of the context data. F

		While the syntax is a little more verbose, paired with `--fail-on-collision`, this option allows ensuring that nothing happens in your back.

		=== External files

Support 'include' and 'inheritance' #7

Support 'include' and 'inheritance' #7

Conversation

tandiljuan commented Aug 22, 2021

chevdor commented Aug 23, 2021

chevdor commented Aug 23, 2021

tandiljuan commented Aug 23, 2021

chevdor commented Aug 23, 2021

tandiljuan commented Sep 3, 2021 • edited Loading

chevdor commented Sep 3, 2021

chevdor commented Sep 3, 2021

Choose a reason for hiding this comment

chevdor left a 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

chevdor commented Sep 3, 2021

Choose a reason for hiding this comment

tandiljuan commented Sep 3, 2021

chevdor commented Sep 3, 2021 • edited Loading

tandiljuan commented Sep 3, 2021 •

edited

Loading

chevdor commented Sep 3, 2021 •

edited

Loading