%% -*- erlang-indent-level: 4;indent-tabs-mode: nil -*- %% ex: ts=4 sw=4 et %% ------------------------------------------------------------------- %% %% rebar: Erlang Build Tools %% %% Copyright (c) 2009 Dave Smith (dizzyd@dizzyd.com), %% Bryan Fink (bryan@basho.com) %% %% Permission is hereby granted, free of charge, to any person obtaining a copy %% of this software and associated documentation files (the "Software"), to deal %% in the Software without restriction, including without limitation the rights %% to use, copy, modify, merge, publish, distribute, sublicense, and/or sell %% copies of the Software, and to permit persons to whom the Software is %% furnished to do so, subject to the following conditions: %% %% The above copyright notice and this permission notice shall be included in %% all copies or substantial portions of the Software. %% %% THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR %% IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, %% FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE %% AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER %% LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, %% OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN %% THE SOFTWARE. %% ------------------------------------------------------------------- %% The rebar_erlydtl_compiler module is a plugin for rebar that compiles %% ErlyDTL templates. By default, it compiles all templates/*.dtl %% to ebin/*_dtl.beam. %% %% Configuration options should be placed in rebar.config under %% 'erlydtl_opts'. It can be a list of name-value tuples or a list of %% lists of name-value tuples if you have multiple template directories %% that need to have different settings (see example below). %% %% Available options include: %% %% doc_root: where to find templates to compile %% "templates" by default %% %% out_dir: where to put compiled template beam files %% "ebin" by default %% %% source_ext: the file extension the template sources have %% ".dtl" by default %% %% module_ext: characters to append to the template's module name %% "_dtl" by default %% %% recursive: boolean that determines if doc_root(s) need to be %% scanned recursively for matching template file names %% (default: true). %% For example, if you had: %% /t_src/ %% base.html %% foo.html %% %% And you wanted them compiled to: %% /priv/ %% base.beam %% foo.beam %% %% You would add to your rebar.config: %% {erlydtl_opts, [ %% {doc_root, "t_src"}, %% {out_dir, "priv"}, %% {source_ext, ".html"}, %% {module_ext, ""} %% ]}. %% %% The default settings are the equivalent of: %% {erlydtl_opts, [ %% {doc_root, "templates"}, %% {out_dir, "ebin"}, %% {source_ext, ".dtl"}, %% {module_ext, "_dtl"} %% ]}. %% %% The following example will compile the following templates: %% "src/*.dtl" files into "ebin/*_dtl.beam" and %% "templates/*.html" into "ebin/*.beam". Note that any tuple option %% (such as 'out_dir') in the outer list is added to each inner list: %% {erlydtl_opts, [ %% {out_dir, "ebin"}, %% {recursive, false}, %% [ %% {doc_root, "src"}, {module_ext, "_dtl"} %% ], %% [ %% {doc_root, "templates"}, {module_ext, ""}, {source_ext, ".html"} %% ] %% ]}. -module(rebar_prv_erlydtl_compiler). -behaviour(provider). -export([init/1, do/1, format_error/1]). -include("rebar.hrl"). -include_lib("providers/include/providers.hrl"). -define(PROVIDER, compile). -define(DEPS, [{default, compile}]). %% =================================================================== %% Public API %% =================================================================== -spec init(rebar_state:t()) -> {ok, rebar_state:t()}. init(State) -> State1 = rebar_state:add_provider(State, providers:create([{name, ?PROVIDER}, {module, ?MODULE}, {namespace, erlydtl}, {bare, false}, {deps, ?DEPS}, {example, "rebar3 erlydtl compile"}, {short_desc, "Compile erlydtl templates."}, {desc, ""}, {opts, []}])), {ok, State1}. do(State) -> ?INFO("Running erlydtl...", []), DtlOpts = proplists:unfold(rebar_state:get(State, erlydtl_opts, [])), %% We need a project app to store the results under in _build %% If there is more than 1 project app, check for an app config %% if that doesn't exist, error out. App1 = case rebar_state:project_apps(State) of [App] -> App; Apps -> case option(app, DtlOpts) of undefined -> ?PRV_ERROR(no_main_app); Name -> rebar_app_utils:find(Name, Apps) end end, Dir = rebar_app_info:dir(App1), OutDir = rebar_app_info:ebin_dir(App1), rebar_base_compiler:run(State, [], filename:join(Dir, option(doc_root, DtlOpts)), option(source_ext, DtlOpts), OutDir, option(module_ext, DtlOpts) ++ ".beam", fun(S, T, C) -> compile_dtl(C, S, T, DtlOpts, Dir, OutDir) end, [{check_last_mod, false}, {recursive, option(recursive, DtlOpts)}]), {ok, State}. -spec format_error(any()) -> iolist(). format_error(no_main_app) -> "Erlydtl Error: Multiple project apps found and no {app, atom()} option found in erlydtl_opts."; format_error(Reason) -> io_lib:format("~p", [Reason]). %% =================================================================== %% Internal functions %% =================================================================== option(Opt, DtlOpts) -> proplists:get_value(Opt, DtlOpts, default(Opt)). default(app) -> undefined; default(doc_root) -> "priv/templates"; default(source_ext) -> ".dtl"; default(module_ext) -> "_dtl"; default(custom_tags_dir) -> ""; default(compiler_options) -> [return]; default(recursive) -> true. compile_dtl(State, Source, Target, DtlOpts, Dir, OutDir) -> case needs_compile(Source, Target, DtlOpts) of true -> do_compile(State, Source, Target, DtlOpts, Dir, OutDir); false -> skipped end. do_compile(State, Source, Target, DtlOpts, Dir, OutDir) -> CompilerOptions = option(compiler_options, DtlOpts), Sorted = proplists:unfold( lists:sort( [{out_dir, OutDir}, {doc_root, filename:join(Dir, option(doc_root, DtlOpts))}, {custom_tags_dir, option(custom_tags_dir, DtlOpts)}, {compiler_options, CompilerOptions}])), %% ensure that doc_root and out_dir are defined, %% using defaults if necessary Opts = lists:ukeymerge(1, DtlOpts, Sorted), ?DEBUG("Compiling \"~s\" -> \"~s\" with options:~n ~s", [Source, Target, io_lib:format("~p", [Opts])]), case erlydtl:compile_file(ec_cnv:to_list(Source), list_to_atom(module_name(Target)), Opts) of {ok, _Mod} -> ok; {ok, _Mod, Ws} -> rebar_base_compiler:ok_tuple(State, Source, Ws); error -> rebar_base_compiler:error_tuple(State, Source, [], [], Opts); {error, Es, Ws} -> rebar_base_compiler:error_tuple(State, Source, Es, Ws, Opts) end. module_name(Target) -> filename:rootname(filename:basename(Target), ".beam"). needs_compile(Source, Target, DtlOpts) -> LM = filelib:last_modified(Target), LM < filelib:last_modified(Source) orelse lists:any(fun(D) -> LM < filelib:last_modified(D) end, referenced_dtls(Source, DtlOpts)). referenced_dtls(Source, DtlOpts) -> DtlOpts1 = lists:keyreplace(doc_root, 1, DtlOpts, {doc_root, filename:dirname(Source)}), Set = referenced_dtls1([Source], DtlOpts1, sets:add_element(Source, sets:new())), sets:to_list(sets:del_element(Source, Set)). referenced_dtls1(Step, DtlOpts, Seen) -> ExtMatch = re:replace(option(source_ext, DtlOpts), "\.", "\\\\\\\\.", [{return, list}]), ShOpts = [{use_stdout, false}, return_on_error], AllRefs = lists:append( [begin Cmd = lists:flatten(["grep -o [^\\\"]*\\", ExtMatch, "[^\\\"]* ", F]), case rebar_utils:sh(Cmd, ShOpts) of {ok, Res} -> string:tokens(Res, "\n"); {error, _} -> "" end end || F <- Step]), DocRoot = option(doc_root, DtlOpts), WithPaths = [ filename:join([DocRoot, F]) || F <- AllRefs ], ?DEBUG("All deps: ~p\n", [WithPaths]), Existing = [F || F <- WithPaths, filelib:is_regular(F)], New = sets:subtract(sets:from_list(Existing), Seen), case sets:size(New) of 0 -> Seen; _ -> referenced_dtls1(sets:to_list(New), DtlOpts, sets:union(New, Seen)) end.