Gabarit - a template engine manager for Erlang/OTP.
This is a side project to help Erlang developers to generate document using templating systems like bbmustache. The goal is to offer an easy way to deal with the compilation part of each template files. At this time, support only a small subset of all requirement.
This commit is contained in:
20
.gitignore
vendored
Normal file
20
.gitignore
vendored
Normal file
@@ -0,0 +1,20 @@
|
||||
.rebar3
|
||||
_build
|
||||
_checkouts
|
||||
_vendor
|
||||
.eunit
|
||||
*.o
|
||||
*.beam
|
||||
*.plt
|
||||
*.swp
|
||||
*.swo
|
||||
.erlang.cookie
|
||||
ebin
|
||||
log
|
||||
erl_crash.dump
|
||||
.rebar
|
||||
logs
|
||||
.idea
|
||||
*.iml
|
||||
rebar3.crashdump
|
||||
*~
|
||||
2
.tool-versions
Normal file
2
.tool-versions
Normal file
@@ -0,0 +1,2 @@
|
||||
rebar 3.22.0
|
||||
erlang 26.0.2
|
||||
186
LICENSE.md
Normal file
186
LICENSE.md
Normal file
@@ -0,0 +1,186 @@
|
||||
# Apache License
|
||||
Version 2.0, January 2004
|
||||
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
## 1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction, and
|
||||
distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by the copyright
|
||||
owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all other entities
|
||||
that control, are controlled by, or are under common control with that entity.
|
||||
For the purposes of this definition, "control" means (i) the power, direct or
|
||||
indirect, to cause the direction or management of such entity, whether by
|
||||
contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity exercising
|
||||
permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications, including
|
||||
but not limited to software source code, documentation source, and configuration
|
||||
files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical transformation or
|
||||
translation of a Source form, including but not limited to compiled object code,
|
||||
generated documentation, and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or Object form, made
|
||||
available under the License, as indicated by a copyright notice that is included
|
||||
in or attached to the work (an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object form, that
|
||||
is based on (or derived from) the Work and for which the editorial revisions,
|
||||
annotations, elaborations, or other modifications represent, as a whole, an
|
||||
original work of authorship. For the purposes of this License, Derivative Works
|
||||
shall not include works that remain separable from, or merely link (or bind by
|
||||
name) to the interfaces of, the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including the original version
|
||||
of the Work and any modifications or additions to that Work or Derivative Works
|
||||
thereof, that is intentionally submitted to Licensor for inclusion in the Work
|
||||
by the copyright owner or by an individual or Legal Entity authorized to submit
|
||||
on behalf of the copyright owner. For the purposes of this definition,
|
||||
"submitted" means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems, and
|
||||
issue tracking systems that are managed by, or on behalf of, the Licensor for
|
||||
the purpose of discussing and improving the Work, but excluding communication
|
||||
that is conspicuously marked or otherwise designated in writing by the copyright
|
||||
owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity on behalf
|
||||
of whom a Contribution has been received by Licensor and subsequently
|
||||
incorporated within the Work.
|
||||
|
||||
## 2. Grant of Copyright License.
|
||||
|
||||
Subject to the terms and conditions of this License, each Contributor hereby
|
||||
grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
|
||||
irrevocable copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the Work and such
|
||||
Derivative Works in Source or Object form.
|
||||
|
||||
## 3. Grant of Patent License.
|
||||
|
||||
Subject to the terms and conditions of this License, each Contributor hereby
|
||||
grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
|
||||
irrevocable (except as stated in this section) patent license to make, have
|
||||
made, use, offer to sell, sell, import, and otherwise transfer the Work, where
|
||||
such license applies only to those patent claims licensable by such Contributor
|
||||
that are necessarily infringed by their Contribution(s) alone or by combination
|
||||
of their Contribution(s) with the Work to which such Contribution(s) was
|
||||
submitted. If You institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work or a
|
||||
Contribution incorporated within the Work constitutes direct or contributory
|
||||
patent infringement, then any patent licenses granted to You under this License
|
||||
for that Work shall terminate as of the date such litigation is filed.
|
||||
|
||||
## 4. Redistribution.
|
||||
|
||||
You may reproduce and distribute copies of the Work or Derivative Works thereof
|
||||
in any medium, with or without modifications, and in Source or Object form,
|
||||
provided that You meet the following conditions:
|
||||
|
||||
1. You must give any other recipients of the Work or Derivative Works a copy of
|
||||
this License; and
|
||||
|
||||
2. You must cause any modified files to carry prominent notices stating that
|
||||
You changed the files; and
|
||||
|
||||
3. You must retain, in the Source form of any Derivative Works that You
|
||||
distribute, all copyright, patent, trademark, and attribution notices from
|
||||
the Source form of the Work, excluding those notices that do not pertain to
|
||||
any part of the Derivative Works; and
|
||||
|
||||
4. If the Work includes a "NOTICE" text file as part of its distribution, then
|
||||
any Derivative Works that You distribute must include a readable copy of the
|
||||
attribution notices contained within such NOTICE file, excluding those
|
||||
notices that do not pertain to any part of the Derivative Works, in at least
|
||||
one of the following places: within a NOTICE text file distributed as part
|
||||
of the Derivative Works; within the Source form or documentation, if
|
||||
provided along with the Derivative Works; or, within a display generated by
|
||||
the Derivative Works, if and wherever such third-party notices normally
|
||||
appear. The contents of the NOTICE file are for informational purposes only
|
||||
and do not modify the License. You may add Your own attribution notices
|
||||
within Derivative Works that You distribute, alongside or as an addendum to
|
||||
the NOTICE text from the Work, provided that such additional attribution
|
||||
notices cannot be construed as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and may provide
|
||||
additional or different license terms and conditions for use, reproduction, or
|
||||
distribution of Your modifications, or for any such Derivative Works as a whole,
|
||||
provided Your use, reproduction, and distribution of the Work otherwise complies
|
||||
with the conditions stated in this License.
|
||||
|
||||
## 5. Submission of Contributions.
|
||||
|
||||
Unless You explicitly state otherwise, any Contribution intentionally submitted
|
||||
for inclusion in the Work by You to the Licensor shall be under the terms and
|
||||
conditions of this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify the terms of
|
||||
any separate license agreement you may have executed with Licensor regarding
|
||||
such Contributions.
|
||||
|
||||
## 6. Trademarks.
|
||||
|
||||
This License does not grant permission to use the trade names, trademarks,
|
||||
service marks, or product names of the Licensor, except as required for
|
||||
reasonable and customary use in describing the origin of the Work and
|
||||
reproducing the content of the NOTICE file.
|
||||
|
||||
## 7. Disclaimer of Warranty.
|
||||
|
||||
Unless required by applicable law or agreed to in writing, Licensor provides the
|
||||
Work (and each Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied,
|
||||
including, without limitation, any warranties or conditions of TITLE, NON-
|
||||
INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are
|
||||
solely responsible for determining the appropriateness of using or
|
||||
redistributing the Work and assume any risks associated with Your exercise of
|
||||
permissions under this License.
|
||||
|
||||
## 8. Limitation of Liability.
|
||||
|
||||
In no event and under no legal theory, whether in tort (including negligence),
|
||||
contract, or otherwise, unless required by applicable law (such as deliberate
|
||||
and grossly negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special, incidental,
|
||||
or consequential damages of any character arising as a result of this License or
|
||||
out of the use or inability to use the Work (including but not limited to
|
||||
damages for loss of goodwill, work stoppage, computer failure or malfunction, or
|
||||
any and all other commercial damages or losses), even if such Contributor has
|
||||
been advised of the possibility of such damages.
|
||||
|
||||
## 9. Accepting Warranty or Additional Liability.
|
||||
|
||||
While redistributing the Work or Derivative Works thereof, You may choose to
|
||||
offer, and charge a fee for, acceptance of support, warranty, indemnity, or
|
||||
other liability obligations and/or rights consistent with this License. However,
|
||||
in accepting such obligations, You may act only on Your own behalf and on Your
|
||||
sole responsibility, not on behalf of any other Contributor, and only if You
|
||||
agree to indemnify, defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason of your
|
||||
accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
Copyright 2023, Mathieu Kerjouan <contact@steepath.eu>.
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
157
README.md
Normal file
157
README.md
Normal file
@@ -0,0 +1,157 @@
|
||||
# gabarit
|
||||
|
||||
Gabarit, a template engine manager for Erlang/OTP.
|
||||
|
||||
Gabarit was created to offer an easy way to deal with template engines
|
||||
from the Erlang community but also to deal with multi-template engines
|
||||
running on the same cluster.
|
||||
|
||||
Gabarit uses bbmustache template engine as default template engine. If
|
||||
another template is being used, gabarit will not automatically fetch
|
||||
required dependencies, you will be in charge to add them manually.
|
||||
|
||||
Gabarit compiles an erlang module including file or directory
|
||||
templates using merl.
|
||||
|
||||
## Features
|
||||
|
||||
- [ ] templates versionned during compilation
|
||||
- [ ] templates compiled with timestamp
|
||||
- [ ] hardcoded templates limits
|
||||
- [ ] templates compilation limit during runtime
|
||||
- [ ] automatic or dynamic reload
|
||||
- [ ] flexible rendering template service
|
||||
- [ ] rollback template based on version
|
||||
- [ ] export feature
|
||||
- [ ] template edition facility (text editor integration)
|
||||
- [ ] project manager support
|
||||
- [ ] rebar3 plugin
|
||||
- [ ] erlang.mk plugin
|
||||
- [ ] distributed feature and replication:
|
||||
- [ ] cluster template synchronization
|
||||
- [ ] template signature
|
||||
- [ ] callback module for:
|
||||
- [ ] bbmustache (default)
|
||||
- [ ] beard
|
||||
- [ ] dactyl
|
||||
- [ ] EEx (from elixir)
|
||||
- [ ] elk
|
||||
- [ ] erlydtl
|
||||
- [ ] etcher
|
||||
- [ ] jaderl
|
||||
- [ ] roni
|
||||
- [ ] sgte
|
||||
- [ ] swirl
|
||||
- [ ] templaterl
|
||||
- [ ] walrus
|
||||
|
||||
## Build
|
||||
|
||||
```sh
|
||||
rebar3 compile
|
||||
```
|
||||
|
||||
## Test
|
||||
|
||||
```sh
|
||||
rebar3 ct
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
All templates are by default stored in `priv/gabarit` directory, if
|
||||
you add a new template outside of this directory, you will need to
|
||||
load it manually.
|
||||
|
||||
```sh
|
||||
mkdir priv/gabarit
|
||||
|
||||
# unique template
|
||||
touch priv/templates/template.html
|
||||
echo "<html>{{placeholder}}</html>" >> /tmp/templates/template.html
|
||||
|
||||
# multi-templates
|
||||
mkdir priv/templates/templates
|
||||
echo "<html>{{placeholder}}</html>" >> priv/templates/templates/index.html
|
||||
echo "<html>{{placeholder}}</html>" >> priv/templates/templates/index2.html
|
||||
```
|
||||
|
||||
```erlang
|
||||
{ok, 'gabarit@/template.html' = Module} = gabarit:new("template.html").
|
||||
%
|
||||
{ok, Content} = Module:template().
|
||||
|
||||
% template printing
|
||||
ok = Module:format(#{}).
|
||||
ok = Module:format(#{}, []).
|
||||
|
||||
% rendering
|
||||
{ok, Template} = Module:render(#{ "placeholder" => "test" }).
|
||||
{ok, Template} = Module:render(#{ "placeholder" => "test" }, []).
|
||||
```
|
||||
|
||||
Template directory support, recursive support enabled by default.
|
||||
|
||||
```erlang
|
||||
{ok, ['gabarit@/templates/index.html'
|
||||
,'gabarit@/templates/index2.html'
|
||||
] = Module} = gabarit:new("templates", [{recursive, true}]).
|
||||
```
|
||||
|
||||
Function lists.
|
||||
|
||||
```erlang
|
||||
% create a new template based on path
|
||||
gabarit:new("path").
|
||||
|
||||
% export all compiled templates
|
||||
% {ok, [{{TemplateName, Version, Timestamp}, {Filename, Source, Binary}}]}.
|
||||
gabarit:export().
|
||||
|
||||
% create a new template based on path with
|
||||
% custom template engine. If the file or the
|
||||
% directory exists, it will create a new module
|
||||
% called: 'gabarit@/path'.
|
||||
gabarit:new("path", [{engine, bbmustach}]).
|
||||
|
||||
% equivalent to
|
||||
gabarit:new("path", [{'render/2', {bbmustache, render}}
|
||||
,{'render/3', {bbmustache, render}}
|
||||
]).
|
||||
|
||||
% create a template from data-structure. it will generate a
|
||||
% new module called: 'gabarit$name'.
|
||||
gabarit:new_template("name", "template {{content}}.", []).
|
||||
|
||||
% list available templates
|
||||
gabarit:get().
|
||||
|
||||
% set a new template engine for one template
|
||||
gabarit:set(Template, 'render/2', {bbmustache, render}).
|
||||
|
||||
% compile and load all templates
|
||||
gabarit:reload().
|
||||
|
||||
% compile and load one template
|
||||
gabarit:reload("path").
|
||||
|
||||
% check the limits
|
||||
gabarit:limits().
|
||||
gabarit:limit(Limit).
|
||||
|
||||
% wrapper around 'gabarit@/path':format(#{}, []).
|
||||
gabarit:format("path", #{}, []).
|
||||
|
||||
% wrapper around 'gabarit@/path':render(#{}, []).
|
||||
gabarit:render("path", #{}, []).
|
||||
|
||||
% edit or create a new template by opening
|
||||
% a text editor
|
||||
gabarit:edit("path").
|
||||
```
|
||||
|
||||
## Limitations
|
||||
|
||||
Erlang modules are compiled using atoms, atoms are limited and not
|
||||
garbage collected. That means it could crash a production system if
|
||||
you want to dynamically
|
||||
112
priv/gabarit/gabarit_template.erl
Normal file
112
priv/gabarit/gabarit_template.erl
Normal file
@@ -0,0 +1,112 @@
|
||||
%%%===================================================================
|
||||
%%% @author Mathieu Kerjouan
|
||||
%%% @doc
|
||||
%%% @end
|
||||
%%%===================================================================
|
||||
-module('@module_name').
|
||||
-export([id/0, version/0, created_at/0, updated_at/0]).
|
||||
-export([path/0, path/1, template/0]).
|
||||
-export([format_opts/0, format/1, format/2]).
|
||||
-export([render_opts/0, render/1, render/2]).
|
||||
-include_lib("syntax_tools/include/merl.hrl").
|
||||
|
||||
% special attributes
|
||||
-vsn('@vsn').
|
||||
-gabarit('@module_version').
|
||||
-created_at('@created_at').
|
||||
-updated_at('@updated_at').
|
||||
|
||||
%%--------------------------------------------------------------------
|
||||
%% @doc Returns the special attributes.
|
||||
%% @end
|
||||
%%--------------------------------------------------------------------
|
||||
id() -> '@module_name'.
|
||||
version() -> '@module_version'.
|
||||
created_at() -> '@created_at'.
|
||||
updated_at() -> '@updated_at'.
|
||||
|
||||
%%--------------------------------------------------------------------
|
||||
%% @doc
|
||||
%% @end
|
||||
%%--------------------------------------------------------------------
|
||||
-spec path() -> string().
|
||||
path() -> path(relative).
|
||||
|
||||
-spec path(atom) -> string().
|
||||
path(relative) -> '@relative_path';
|
||||
path(absolute) -> '@absolute_path'.
|
||||
|
||||
%%--------------------------------------------------------------------
|
||||
%% @doc
|
||||
%% @end
|
||||
%%--------------------------------------------------------------------
|
||||
% -spec reload() -> {ok, atom()}.
|
||||
% reload() -> gabarit:reload('@module_name').
|
||||
|
||||
%%--------------------------------------------------------------------
|
||||
%% @doc Returns the raw template.
|
||||
%% @end
|
||||
%%--------------------------------------------------------------------
|
||||
-spec template() -> binary().
|
||||
template() -> '@template'.
|
||||
|
||||
%%--------------------------------------------------------------------
|
||||
%% @doc Returns the default format_opts used.
|
||||
%% @end
|
||||
%%--------------------------------------------------------------------
|
||||
-spec format_opts() -> list().
|
||||
format_opts() -> '@format_opts'.
|
||||
|
||||
%%--------------------------------------------------------------------
|
||||
%% @doc Render the template and print it to stdout.
|
||||
%% @end
|
||||
%%--------------------------------------------------------------------
|
||||
-spec format(Context) -> Return when
|
||||
Context :: term(),
|
||||
Return :: ok.
|
||||
format(Context) ->
|
||||
Opts = format_opts(),
|
||||
format(Context, Opts).
|
||||
|
||||
%%--------------------------------------------------------------------
|
||||
%% @doc Render the template and print it to stdout.
|
||||
%% @end
|
||||
%%--------------------------------------------------------------------
|
||||
-spec format(Context, Opts) -> Return when
|
||||
Context :: term(),
|
||||
Opts :: term(),
|
||||
Return :: ok.
|
||||
format(Context, Opts) ->
|
||||
Rendering = render(Context, Opts),
|
||||
io:format("~s", [Rendering]).
|
||||
|
||||
%%--------------------------------------------------------------------
|
||||
%% @doc Returns the default render_opts used.
|
||||
%% @end
|
||||
%%--------------------------------------------------------------------
|
||||
-spec render_opts() -> list().
|
||||
render_opts() -> '@render_opts'.
|
||||
|
||||
%%--------------------------------------------------------------------
|
||||
%% @doc Render the template and return it.
|
||||
%% @end
|
||||
%%--------------------------------------------------------------------
|
||||
-spec render(Context) -> Return when
|
||||
Context :: term(),
|
||||
Return :: any().
|
||||
render(Context) ->
|
||||
Opts = render_opts(),
|
||||
render(Context, Opts).
|
||||
|
||||
%%--------------------------------------------------------------------
|
||||
%% @doc Render the template and return it.
|
||||
%% @end
|
||||
%%--------------------------------------------------------------------
|
||||
-spec render(Context, Opts) -> Return when
|
||||
Context :: term(),
|
||||
Opts :: term(),
|
||||
Return :: any().
|
||||
render(Context, Opts) ->
|
||||
Template = template(),
|
||||
erlang:apply('@callback_module', '@callback_function', [Template, Context, Opts]).
|
||||
|
||||
5
priv/templates/index.html
Normal file
5
priv/templates/index.html
Normal file
@@ -0,0 +1,5 @@
|
||||
<html>
|
||||
<body>
|
||||
{{test}}
|
||||
</body>
|
||||
</html>
|
||||
0
priv/templates/index2.html
Normal file
0
priv/templates/index2.html
Normal file
0
priv/templates/test/index.html
Normal file
0
priv/templates/test/index.html
Normal file
7
rebar.config
Normal file
7
rebar.config
Normal file
@@ -0,0 +1,7 @@
|
||||
{erl_opts, [debug_info]}.
|
||||
{deps, [bbmustache]}.
|
||||
|
||||
{shell, [
|
||||
% {config, "config/sys.config"},
|
||||
{apps, [gabarit]}
|
||||
]}.
|
||||
8
rebar.lock
Normal file
8
rebar.lock
Normal file
@@ -0,0 +1,8 @@
|
||||
{"1.2.0",
|
||||
[{<<"bbmustache">>,{pkg,<<"bbmustache">>,<<"1.12.2">>},0}]}.
|
||||
[
|
||||
{pkg_hash,[
|
||||
{<<"bbmustache">>, <<"0CABDCE0DB9FE6D3318131174B9F2B351328A4C0AFBEB3E6E99BB0E02E9B621D">>}]},
|
||||
{pkg_hash_ext,[
|
||||
{<<"bbmustache">>, <<"688B33A4D5CC2D51F575ADF0B3683FC40A38314A2F150906EDCFC77F5B577B3B">>}]}
|
||||
].
|
||||
14
src/gabarit.app.src
Normal file
14
src/gabarit.app.src
Normal file
@@ -0,0 +1,14 @@
|
||||
{application, gabarit,
|
||||
[{description, "A template engine and templates manager"},
|
||||
{vsn, "0.1.0"},
|
||||
{registered, [gabarit, gabarit_sup]},
|
||||
{mod, {gabarit_app, []}},
|
||||
{applications,
|
||||
[kernel,
|
||||
stdlib
|
||||
]},
|
||||
{env,[]},
|
||||
{modules, []},
|
||||
{licenses, ["MIT"]},
|
||||
{links, ["https://github.com/erlang-punch/gabarit"]}
|
||||
]}.
|
||||
1
src/gabarit.erl
Normal file
1
src/gabarit.erl
Normal file
@@ -0,0 +1 @@
|
||||
-module(gabarit).
|
||||
18
src/gabarit_app.erl
Normal file
18
src/gabarit_app.erl
Normal file
@@ -0,0 +1,18 @@
|
||||
%%%-------------------------------------------------------------------
|
||||
%% @doc gabarit public API
|
||||
%% @end
|
||||
%%%-------------------------------------------------------------------
|
||||
|
||||
-module(gabarit_app).
|
||||
|
||||
-behaviour(application).
|
||||
|
||||
-export([start/2, stop/1]).
|
||||
|
||||
start(_StartType, _StartArgs) ->
|
||||
gabarit_sup:start_link().
|
||||
|
||||
stop(_State) ->
|
||||
ok.
|
||||
|
||||
%% internal functions
|
||||
274
src/gabarit_compiler.erl
Normal file
274
src/gabarit_compiler.erl
Normal file
@@ -0,0 +1,274 @@
|
||||
%%%===================================================================
|
||||
%%% @doc
|
||||
%%% @end
|
||||
%%%===================================================================
|
||||
-module(gabarit_compiler).
|
||||
-compile(export_all).
|
||||
-export([path/0, tree/0, tree/1]).
|
||||
-define(DEFAULT_PATH, "priv/templates").
|
||||
-define(DEFAULT_MERL_TEMPLATE, "priv/gabarit/gabarit_template.erl").
|
||||
|
||||
%%--------------------------------------------------------------------
|
||||
%%
|
||||
%%--------------------------------------------------------------------
|
||||
compile(#{ name := Identifier } = Struct) ->
|
||||
ModuleName = create_module_name("gabarit@", Identifier),
|
||||
merl_compile_and_load(Struct#{ module_name => ModuleName }).
|
||||
|
||||
%%--------------------------------------------------------------------
|
||||
%%
|
||||
%%--------------------------------------------------------------------
|
||||
find_and_compile() ->
|
||||
Tree = tree(),
|
||||
lists:map(fun compile/1, Tree).
|
||||
|
||||
%%--------------------------------------------------------------------
|
||||
%%
|
||||
%%--------------------------------------------------------------------
|
||||
map_compile(Struct) ->
|
||||
case compile(Struct) of
|
||||
{ok, Compiled} -> Struct#{ module => Compiled };
|
||||
Error -> Struct#{ module => Error }
|
||||
end.
|
||||
|
||||
%%--------------------------------------------------------------------
|
||||
%%
|
||||
%%--------------------------------------------------------------------
|
||||
create_module_name(Prefix, Identifier) ->
|
||||
ModuleName = string:concat(Prefix, Identifier),
|
||||
try
|
||||
erlang:list_to_existing_atom(ModuleName)
|
||||
catch
|
||||
_:_ -> erlang:list_to_atom(ModuleName)
|
||||
end.
|
||||
|
||||
%%--------------------------------------------------------------------
|
||||
%% @doc list the current path used to load the templates.
|
||||
%% @end
|
||||
%%--------------------------------------------------------------------
|
||||
path() ->
|
||||
application:get_env(awesome, templates_path, ?DEFAULT_PATH).
|
||||
|
||||
%%--------------------------------------------------------------------
|
||||
%% @doc list all templates in default templates path.
|
||||
%% @end
|
||||
%%--------------------------------------------------------------------
|
||||
tree() ->
|
||||
Tree = tree(path()),
|
||||
lists:foldl(fun tree_filter/2, [], Tree).
|
||||
|
||||
%%--------------------------------------------------------------------
|
||||
%% @doc
|
||||
%% @end
|
||||
%%--------------------------------------------------------------------
|
||||
tree(Path) -> tree(Path, []).
|
||||
|
||||
%%--------------------------------------------------------------------
|
||||
%% @hidden
|
||||
%% @doc
|
||||
%% @end
|
||||
%%--------------------------------------------------------------------
|
||||
tree(Path, Buffer) ->
|
||||
case file:list_dir(Path) of
|
||||
{ok, Files} ->
|
||||
tree(Path, Files, Buffer);
|
||||
{error, Error} ->
|
||||
throw({error, Error})
|
||||
end.
|
||||
|
||||
%%--------------------------------------------------------------------
|
||||
%% @hidden
|
||||
%% @doc
|
||||
%% @end
|
||||
%%--------------------------------------------------------------------
|
||||
tree(_, [], Buffer) -> Buffer;
|
||||
tree(Path, [File|Files], Buffer) ->
|
||||
FilePath = filename:join([Path, File]),
|
||||
case filelib:is_dir(FilePath) of
|
||||
true -> tree(FilePath, Buffer);
|
||||
false -> tree(Path, Files, [{Path, FilePath}|Buffer])
|
||||
end.
|
||||
|
||||
%%--------------------------------------------------------------------
|
||||
%% @hidden
|
||||
%% @doc paths filtering.
|
||||
%% @end
|
||||
%%--------------------------------------------------------------------
|
||||
tree_filter({Key, Value}, Acc) ->
|
||||
Origin = filename:split(Key),
|
||||
Root = filename:split(path()),
|
||||
Filename = lists:last(filename:split(Value)),
|
||||
AbsolutePath = filename:absname(Value),
|
||||
Subtract = lists:subtract(Origin, Root),
|
||||
Identifier = case Subtract of
|
||||
[] -> filename:join(["/", Filename]);
|
||||
_ -> filename:join(["/", Subtract, Filename])
|
||||
end,
|
||||
{ok, Content} = file:read_file(AbsolutePath),
|
||||
[#{ name => Identifier
|
||||
, filename => Filename
|
||||
, absolute_path => AbsolutePath
|
||||
, relative_path => Key
|
||||
, template => Content
|
||||
}|Acc].
|
||||
|
||||
%%--------------------------------------------------------------------
|
||||
%% @hidden
|
||||
%% @doc
|
||||
%% @end
|
||||
%%--------------------------------------------------------------------
|
||||
merl_template() ->
|
||||
merl_template(?DEFAULT_MERL_TEMPLATE).
|
||||
|
||||
%%--------------------------------------------------------------------
|
||||
%% @hidden
|
||||
%% @doc
|
||||
%% @end
|
||||
%%--------------------------------------------------------------------
|
||||
merl_template(TemplateFile) ->
|
||||
case file:read_file(TemplateFile) of
|
||||
{ok, Content} ->
|
||||
Content;
|
||||
Elsewise -> throw(Elsewise)
|
||||
end.
|
||||
|
||||
%%--------------------------------------------------------------------
|
||||
%% @hidden
|
||||
%% @doc
|
||||
%% @end
|
||||
%%--------------------------------------------------------------------
|
||||
merl_compile_and_load(Opts) ->
|
||||
Template = merl_template(),
|
||||
case merl_qquote(Template, Opts) of
|
||||
{ok, AST} ->
|
||||
merl:compile_and_load(AST);
|
||||
Error -> Error
|
||||
end.
|
||||
|
||||
%%--------------------------------------------------------------------
|
||||
%%
|
||||
%%--------------------------------------------------------------------
|
||||
merl_qquote(Template, Opts) ->
|
||||
Quote = merl:qquote(Template, []),
|
||||
merl_subst_module_name(Quote, Opts).
|
||||
|
||||
%%--------------------------------------------------------------------
|
||||
%% @hidden
|
||||
%% @doc
|
||||
%% @end
|
||||
%%--------------------------------------------------------------------
|
||||
merl_subst_module_name(Template, #{ module_name := ModuleName } = Opts) ->
|
||||
Term = merl:term(ModuleName),
|
||||
Result = merl:subst(Template, [{module_name, Term}]),
|
||||
merl_subst_module_version(Result, Opts).
|
||||
|
||||
%%--------------------------------------------------------------------
|
||||
%% @hidden
|
||||
%% @doc
|
||||
%% @end
|
||||
%%--------------------------------------------------------------------
|
||||
merl_subst_module_version(Template, #{ module_name := ModuleName } = Opts) ->
|
||||
Version = case erlang:module_loaded(ModuleName) of
|
||||
true ->
|
||||
LoadedVersion = ModuleName:version(),
|
||||
maps:get(module_version, Opts, LoadedVersion);
|
||||
false -> 0
|
||||
end,
|
||||
Term = merl:term(Version+1),
|
||||
Result = merl:subst(Template, [{module_version, Term}]),
|
||||
merl_subst_path(Result, Opts).
|
||||
|
||||
%%--------------------------------------------------------------------
|
||||
%% @hidden
|
||||
%% @doc
|
||||
%% @end
|
||||
%%--------------------------------------------------------------------
|
||||
merl_subst_path(Template, #{ relative_path := RelativePath
|
||||
, absolute_path := AbsolutePath } = Opts) ->
|
||||
Result = merl:subst(Template, [{relative_path, merl:term(RelativePath)}
|
||||
,{absolute_path, merl:term(AbsolutePath)}]),
|
||||
merl_subst_vsn(Result, Opts).
|
||||
|
||||
%%--------------------------------------------------------------------
|
||||
%% @hidden
|
||||
%% @doc
|
||||
%% @end
|
||||
%%--------------------------------------------------------------------
|
||||
merl_subst_vsn(Template, Opts) ->
|
||||
Version = maps:get(vsn, Opts, undefined),
|
||||
Term = merl:term(Version),
|
||||
Result = merl:subst(Template, [{vsn, Term}]),
|
||||
merl_subst_created_at(Result, Opts).
|
||||
|
||||
%%--------------------------------------------------------------------
|
||||
%% @hidden
|
||||
%% @doc
|
||||
%% @end
|
||||
%%--------------------------------------------------------------------
|
||||
merl_subst_created_at(Template, #{ module_name := ModuleName } = Opts) ->
|
||||
CreatedAt = case erlang:module_loaded(ModuleName) of
|
||||
true ->
|
||||
Original = ModuleName:created_at(),
|
||||
maps:get(created_at, Opts, Original);
|
||||
false ->
|
||||
erlang:system_time()
|
||||
end,
|
||||
Term = merl:term(CreatedAt),
|
||||
Result = merl:subst(Template, [{created_at, Term}]),
|
||||
merl_subst_updated_at(Result, Opts).
|
||||
|
||||
%%--------------------------------------------------------------------
|
||||
%% @hidden
|
||||
%% @doc
|
||||
%% @end
|
||||
%%--------------------------------------------------------------------
|
||||
merl_subst_updated_at(Template, Opts) ->
|
||||
UpdatedAt = maps:get(updated_at, Opts, erlang:system_time()),
|
||||
Term = merl:term(UpdatedAt),
|
||||
Result = merl:subst(Template, [{updated_at, Term}]),
|
||||
merl_subst_format_opts(Result, Opts).
|
||||
|
||||
%%--------------------------------------------------------------------
|
||||
%% @hidden
|
||||
%% @doc
|
||||
%% @end
|
||||
%%--------------------------------------------------------------------
|
||||
merl_subst_format_opts(Template, Opts) ->
|
||||
FormatOpts = maps:get(updated_at, Opts, []),
|
||||
Term = merl:term(FormatOpts),
|
||||
Result = merl:subst(Template, [{format_opts, Term}]),
|
||||
merl_subst_render_opts(Result, Opts).
|
||||
|
||||
%%--------------------------------------------------------------------
|
||||
%% @hidden
|
||||
%% @doc
|
||||
%% @end
|
||||
%%--------------------------------------------------------------------
|
||||
merl_subst_render_opts(Template, Opts) ->
|
||||
RenderOpts = maps:get(render_opts, Opts, []),
|
||||
Term = merl:term(RenderOpts),
|
||||
Result = merl:subst(Template, [{render_opts, Term}]),
|
||||
merl_subst_callback(Result, Opts).
|
||||
|
||||
%%--------------------------------------------------------------------
|
||||
%% @hidden
|
||||
%% @doc
|
||||
%% @end
|
||||
%%--------------------------------------------------------------------
|
||||
merl_subst_callback(Template, Opts) ->
|
||||
CallbackModule = maps:get(callback_module, Opts, bbmustache),
|
||||
CallbackFunction = maps:get(callback_function, Opts, render),
|
||||
Result = merl:subst(Template, [{callback_module, merl:term(CallbackModule)}
|
||||
,{callback_function, merl:term(CallbackFunction)}
|
||||
]),
|
||||
merl_subst_template(Result, Opts).
|
||||
|
||||
%%--------------------------------------------------------------------
|
||||
%% @hidden
|
||||
%% @doc
|
||||
%% @end
|
||||
%%--------------------------------------------------------------------
|
||||
merl_subst_template(Template, Opts) ->
|
||||
Content = maps:get(template, Opts, <<>>),
|
||||
Term = merl:term(Content),
|
||||
{ok, merl:subst(Template, [{template, Term}])}.
|
||||
35
src/gabarit_sup.erl
Normal file
35
src/gabarit_sup.erl
Normal file
@@ -0,0 +1,35 @@
|
||||
%%%-------------------------------------------------------------------
|
||||
%% @doc gabarit top level supervisor.
|
||||
%% @end
|
||||
%%%-------------------------------------------------------------------
|
||||
|
||||
-module(gabarit_sup).
|
||||
|
||||
-behaviour(supervisor).
|
||||
|
||||
-export([start_link/0]).
|
||||
|
||||
-export([init/1]).
|
||||
|
||||
-define(SERVER, ?MODULE).
|
||||
|
||||
start_link() ->
|
||||
supervisor:start_link({local, ?SERVER}, ?MODULE, []).
|
||||
|
||||
%% sup_flags() = #{strategy => strategy(), % optional
|
||||
%% intensity => non_neg_integer(), % optional
|
||||
%% period => pos_integer()} % optional
|
||||
%% child_spec() = #{id => child_id(), % mandatory
|
||||
%% start => mfargs(), % mandatory
|
||||
%% restart => restart(), % optional
|
||||
%% shutdown => shutdown(), % optional
|
||||
%% type => worker(), % optional
|
||||
%% modules => modules()} % optional
|
||||
init([]) ->
|
||||
SupFlags = #{strategy => one_for_all,
|
||||
intensity => 0,
|
||||
period => 1},
|
||||
ChildSpecs = [],
|
||||
{ok, {SupFlags, ChildSpecs}}.
|
||||
|
||||
%% internal functions
|
||||
1
src/gabarit_support.erl
Normal file
1
src/gabarit_support.erl
Normal file
@@ -0,0 +1 @@
|
||||
-module(gabarit_support).
|
||||
Reference in New Issue
Block a user