From ee9ad07748b823f4e2d951b1c5bba8310ff09bb4 Mon Sep 17 00:00:00 2001 From: Guilherme Andrade Date: Thu, 15 Aug 2019 20:31:42 +0100 Subject: Allow for API callers to define arbitrary overlay variables --- src/rlx_cmd_args.erl | 3 +++ src/rlx_prv_overlay.erl | 3 ++- src/rlx_state.erl | 8 ++++++++ 3 files changed, 13 insertions(+), 1 deletion(-) (limited to 'src') diff --git a/src/rlx_cmd_args.erl b/src/rlx_cmd_args.erl index 4f5e9da..1dc10c1 100644 --- a/src/rlx_cmd_args.erl +++ b/src/rlx_cmd_args.erl @@ -298,6 +298,9 @@ create(add_providers, Opts) -> create(providers, Opts) -> Providers = proplists:get_value(providers, Opts, []), {providers, Providers}; +create(api_caller_overlays, Opts) -> + ApiCallerOverlays = proplists:get_value(api_caller_overlays, Opts, []), + {api_caller_overlays, ApiCallerOverlays}; create(_, _) -> []. diff --git a/src/rlx_prv_overlay.erl b/src/rlx_prv_overlay.erl index 75608b3..5ba3f75 100644 --- a/src/rlx_prv_overlay.erl +++ b/src/rlx_prv_overlay.erl @@ -273,7 +273,8 @@ generate_state_vars(State) -> erlang:atom_to_list(Name1); {Name1, Vsn1} -> erlang:atom_to_list(Name1) ++ "-" ++ Vsn1 - end}]. + end} + | rlx_state:api_caller_overlays(State)]. -spec do_overlay(rlx_state:t(), list(), proplists:proplist()) -> {ok, rlx_state:t()} | relx:error(). diff --git a/src/rlx_state.erl b/src/rlx_state.erl index cab55f6..a4b21fa 100644 --- a/src/rlx_state.erl +++ b/src/rlx_state.erl @@ -44,6 +44,7 @@ goals/2, config_file/1, config_file/2, + api_caller_overlays/1, cli_args/1, cli_args/2, providers/1, @@ -104,6 +105,7 @@ output_dir :: file:name(), lib_dirs=[] :: [file:name()], config_file=[] :: file:filename() | undefined, + api_caller_overlays=[] :: [{atom(),string()}], cli_args=[] :: proplists:proplist(), goals=[] :: [rlx_depsolver:raw_constraint()], providers=[] :: [providers:t()], @@ -160,8 +162,10 @@ new(Config, CommandLineConfig, Targets) Log = proplists:get_value( log, CommandLineConfig, ec_cmd_log:new(error, Caller, rlx_util:intensity())), + ApiCallerOverlays = proplists:get_value(api_caller_overlays, CommandLineConfig, []), State0 = #state_t{log=Log, config_file=Config, + api_caller_overlays=ApiCallerOverlays, cli_args=CommandLineConfig, actions=Targets, caller=Caller, @@ -270,6 +274,10 @@ config_file(#state_t{config_file=ConfigFiles}) -> config_file(State, ConfigFiles) -> State#state_t{config_file=ConfigFiles}. +-spec api_caller_overlays(t()) -> [{atom(),string()}]. +api_caller_overlays(#state_t{api_caller_overlays = ApiCallerOverlays}) -> + ApiCallerOverlays. + -spec cli_args(t()) -> proplists:proplist(). cli_args(#state_t{cli_args=CliArgs}) -> CliArgs. -- cgit v1.2.3 From 6c808ea3f2711a7f1d0bf519f2ad0cd630eadd28 Mon Sep 17 00:00:00 2001 From: Guilherme Andrade Date: Sat, 17 Aug 2019 14:48:22 +0100 Subject: Fix type specifications of API caller overlays --- src/rlx_state.erl | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'src') diff --git a/src/rlx_state.erl b/src/rlx_state.erl index a4b21fa..9f9d835 100644 --- a/src/rlx_state.erl +++ b/src/rlx_state.erl @@ -105,7 +105,7 @@ output_dir :: file:name(), lib_dirs=[] :: [file:name()], config_file=[] :: file:filename() | undefined, - api_caller_overlays=[] :: [{atom(),string()}], + api_caller_overlays=[] :: [{atom(),term()}], cli_args=[] :: proplists:proplist(), goals=[] :: [rlx_depsolver:raw_constraint()], providers=[] :: [providers:t()], @@ -274,7 +274,7 @@ config_file(#state_t{config_file=ConfigFiles}) -> config_file(State, ConfigFiles) -> State#state_t{config_file=ConfigFiles}. --spec api_caller_overlays(t()) -> [{atom(),string()}]. +-spec api_caller_overlays(t()) -> [{atom(),term()}]. api_caller_overlays(#state_t{api_caller_overlays = ApiCallerOverlays}) -> ApiCallerOverlays. -- cgit v1.2.3 From 460645219de1fea56e2d6885ec1ce355232c63e4 Mon Sep 17 00:00:00 2001 From: Guilherme Andrade Date: Sat, 17 Aug 2019 14:49:29 +0100 Subject: Keep expected overlay behaviour - make API overlays the lesser authority --- src/rlx_prv_overlay.erl | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) (limited to 'src') diff --git a/src/rlx_prv_overlay.erl b/src/rlx_prv_overlay.erl index 5ba3f75..ec8a97f 100644 --- a/src/rlx_prv_overlay.erl +++ b/src/rlx_prv_overlay.erl @@ -152,10 +152,15 @@ get_overlay_vars_from_file(State, OverlayVars) -> -spec read_overlay_vars(rlx_state:t(), proplists:proplist(), [file:name()]) -> proplists:proplist() | relx:error(). read_overlay_vars(State, OverlayVars, FileNames) -> + ApiCallerVars = rlx_state:api_caller_overlays(State), Terms = merge_overlay_vars(State, FileNames), - case render_overlay_vars(OverlayVars, Terms, []) of + case render_overlay_vars(OverlayVars ++ ApiCallerVars, Terms, []) of {ok, NewTerms} -> - OverlayVars ++ NewTerms; + % We place `ApiCallerVars' at the end on purpose; their + % definitions should be overwrittenable by both internal + % and rendered vars, as not to change behaviour in + % setups preceding the support for API caller overlays. + OverlayVars ++ NewTerms ++ ApiCallerVars; Error -> Error end. @@ -273,8 +278,7 @@ generate_state_vars(State) -> erlang:atom_to_list(Name1); {Name1, Vsn1} -> erlang:atom_to_list(Name1) ++ "-" ++ Vsn1 - end} - | rlx_state:api_caller_overlays(State)]. + end}]. -spec do_overlay(rlx_state:t(), list(), proplists:proplist()) -> {ok, rlx_state:t()} | relx:error(). -- cgit v1.2.3