aboutsummaryrefslogtreecommitdiffstats
path: root/src/rlx_cmd_args.erl
diff options
context:
space:
mode:
Diffstat (limited to 'src/rlx_cmd_args.erl')
-rw-r--r--src/rlx_cmd_args.erl281
1 files changed, 281 insertions, 0 deletions
diff --git a/src/rlx_cmd_args.erl b/src/rlx_cmd_args.erl
new file mode 100644
index 0000000..fee4449
--- /dev/null
+++ b/src/rlx_cmd_args.erl
@@ -0,0 +1,281 @@
+%% -*- erlang-indent-level: 4; indent-tabs-mode: nil; fill-column: 80 -*-
+%%% Copyright 2012 Erlware, LLC. All Rights Reserved.
+%%%
+%%% This file is provided to you 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.
+%%%---------------------------------------------------------------------------
+%%% @author Eric Merritt <[email protected]>
+%%% @copyright (C) 2012 Erlware, LLC.
+%%%
+%%% @doc Trivial utility file to help handle common tasks
+-module(rcl_cmd_args).
+
+-export([args2state/2,
+ format_error/1]).
+
+-include_lib("relcool/include/relcool.hrl").
+
+%%============================================================================
+%% API
+%%============================================================================
+-spec args2state([getopt:option()], [string()]) ->
+ {ok, {rcl_state:t(), [string()]}} |
+ relcool:error().
+args2state(Opts, Target)
+ when erlang:length(Target) == 0; erlang:length(Target) == 1 ->
+ RelName = proplists:get_value(relname, Opts, undefined),
+ RelVsn = proplists:get_value(relvsn, Opts, undefined),
+ case convert_target(Target) of
+ {ok, AtomizedTarget} ->
+ case create_log(Opts, [{relname, RelName},
+ {relvsn, RelVsn}]) of
+ Error = {error, _} ->
+ Error;
+ {ok, CommandLineConfig} ->
+ handle_config(Opts, AtomizedTarget, CommandLineConfig)
+ end;
+ Error ->
+ Error
+ end;
+args2state(_Opts, Targets) ->
+ ?RCL_ERROR({invalid_targets, Targets}).
+
+-spec format_error(Reason::term()) -> iolist().
+format_error({invalid_targets, Targets}) ->
+ io_lib:format("One config must be specified! not ~p~n", [Targets]);
+format_error({invalid_option_arg, Arg}) ->
+ case Arg of
+ {goals, Goal} ->
+ io_lib:format("Invalid Goal argument -g ~p~n", [Goal]);
+ {relname, RelName} ->
+ io_lib:format("Invalid Release Name argument -n ~p~n", [RelName]);
+ {relvsn, RelVsn} ->
+ io_lib:format("Invalid Release Version argument -n ~p~n", [RelVsn]);
+ {output_dir, Outdir} ->
+ io_lib:format("Invalid Output Directory argument -n ~p~n", [Outdir]);
+ {lib_dir, LibDir} ->
+ io_lib:format("Invalid Library Directory argument -n ~p~n", [LibDir]);
+ {log_level, LogLevel} ->
+ io_lib:format("Invalid Library Directory argument -n ~p~n", [LogLevel])
+ end;
+format_error({invalid_config_file, Config}) ->
+ io_lib:format("Invalid configuration file specified: ~s", [Config]);
+format_error({invalid_caller, Caller}) ->
+ io_lib:format("Invalid caller specified: ~s", [Caller]);
+format_error({failed_to_parse, Spec}) ->
+ io_lib:format("Unable to parse spec ~s", [Spec]);
+format_error({failed_to_parse_override, QA}) ->
+ io_lib:format("Failed to parse app override ~s", [QA]);
+format_error({not_directory, Dir}) ->
+ io_lib:format("Library directory does not exist: ~s", [Dir]);
+format_error({invalid_log_level, LogLevel}) ->
+ io_lib:format("Invalid log level specified -V ~p, log level must be in the"
+ " range 0..2", [LogLevel]);
+format_error({invalid_target, Target}) ->
+ io_lib:format("Invalid action specified: ~s", [Target]).
+
+%%%===================================================================
+%%% Internal Functions
+%%%===================================================================
+-spec handle_config([getopt:option()], atom(), proplists:proplist()) ->
+ {ok, {rcl_state:t(), [string()]}} |
+ relcool:error().
+handle_config(Opts, Target, CommandLineConfig) ->
+ case validate_config(proplists:get_value(config, Opts, [])) of
+ Error = {error, _} ->
+ Error;
+ {ok, Config} ->
+ {ok, rcl_state:new([{config, Config} | CommandLineConfig], Target)}
+ end.
+
+-spec convert_target([string()]) -> {ok, release | relup} | relcool:error().
+convert_target([]) ->
+ {ok, release};
+convert_target(["release"]) ->
+ {ok, release};
+convert_target(["relup"]) ->
+ {ok, relup};
+convert_target(Target) ->
+ ?RCL_ERROR({invalid_target, Target}).
+
+-spec validate_config(file:filename() | undefined) ->
+ {ok, file:filename() | undefined} | relcool:error().
+validate_config(undefined) ->
+ {ok, undefined};
+validate_config("") ->
+ {ok, undefined};
+validate_config(Config) ->
+ case filelib:is_regular(Config) of
+ true ->
+ {ok, filename:absname(Config)};
+ false ->
+ ?RCL_ERROR({invalid_config_file, Config})
+ end.
+
+-spec create_log([getopt:option()], rcl_state:cmd_args()) ->
+ {ok, rcl_state:cmd_args()} | relcool:error().
+create_log(Opts, Acc) ->
+ LogLevel = proplists:get_value(log_level, Opts, 0),
+ if
+ LogLevel >= 0, LogLevel =< 2 ->
+ create_goals(Opts, [{log, rcl_log:new(LogLevel)} | Acc]);
+ true ->
+ ?RCL_ERROR({invalid_log_level, LogLevel})
+ end.
+
+-spec create_goals([getopt:option()], rcl_state:cmd_args()) ->
+ {ok, rcl_state:cmd_args()} | relcool:error().
+create_goals(Opts, Acc) ->
+ Goals = proplists:get_value(goals, Opts, []) ++
+ proplists:get_all_values(goal, Opts),
+ case convert_goals(Goals, []) of
+ Error={error, _} ->
+ Error;
+ {ok, Specs} ->
+ create_overrides(Opts, [{goals, Specs} | Acc])
+ end.
+
+-spec create_overrides([getopt:option()], rcl_state:cmd_args()) ->
+ {ok, rcl_state:cmd_args()} | relcool:error().
+create_overrides(Opts, Acc) ->
+ Overrides = proplists:get_all_values(override, Opts) ++
+ proplists:get_value(overrides, Opts, []),
+ case convert_overrides(Overrides, []) of
+ {ok, Overrides} ->
+ create_output_dir(Opts, [{overrides, Overrides} | Acc]);
+ Error ->
+ Error
+ end.
+
+-spec convert_overrides([{atom(), string() | binary()} |
+ string() | binary()], [{atom(), string() | binary()}]) ->
+ {ok, [string() | binary()]} | relcool:error().
+convert_overrides([], Acc) ->
+ {ok, Acc};
+convert_overrides([QA = {OverrideApp, _} | Rest], Acc)
+ when erlang:is_atom(OverrideApp) ->
+ convert_overrides(Rest, [QA | Acc]);
+convert_overrides([Override | Rest], Acc)
+ when erlang:is_list(Override); erlang:is_binary(Override) ->
+ case re:split(Override, ":") of
+ [AppName, AppDir] ->
+ convert_overrides(Rest, [{erlang:iolist_to_binary(AppName), AppDir} | Acc]);
+ _ ->
+ ?RCL_ERROR({failed_to_parse_override, Override})
+ end;
+convert_overrides([QA | _], _) ->
+ ?RCL_ERROR({failed_to_parse_override, QA}).
+
+-spec convert_goals([string()], [rcl_depsolver:constraint()]) ->
+ {ok,[rcl_depsolver:constraint()]} |
+ relcool:error().
+convert_goals([], Specs) ->
+ %% Reverse the specs because order matters to rcl_depsolver
+ {ok, lists:reverse(Specs)};
+convert_goals([RawSpec | Rest], Acc) ->
+ parse_goal(RawSpec, Rest, Acc).
+
+-spec parse_goal(string() | binary() | rcl_depsolver:constraint(),
+ [string() | binary() | rcl_depsolver:constraint()],
+ rcl_depsolver:constraints()) ->
+ {ok, rcl_depsolver:constraints()} | relcool:error().
+parse_goal(Spec, Rest, Acc)
+ when erlang:is_atom(Spec) ->
+ convert_goals(Rest, [Spec | Acc]);
+parse_goal(Spec, Rest, Acc)
+ when erlang:is_tuple(Spec) ->
+ convert_goals(Rest, [Spec | Acc]);
+parse_goal(RawSpec, Rest, Acc) ->
+ case rcl_goal:parse(RawSpec) of
+ {ok, Spec} ->
+ convert_goals(Rest, [Spec | Acc]);
+ {fail, _} ->
+ ?RCL_ERROR({failed_to_parse, RawSpec})
+ end.
+
+-spec create_output_dir([getopt:option()], rcl_state:cmd_args()) ->
+ {ok, rcl_state:cmd_args()} | relcool:error().
+create_output_dir(Opts, Acc) ->
+ OutputDir = proplists:get_value(output_dir, Opts, "./_rel"),
+ create_lib_dirs(Opts, [{output_dir, filename:absname(OutputDir)} | Acc]).
+
+-spec create_lib_dirs([getopt:option()], rcl_state:cmd_args()) ->
+ {ok, rcl_state:cmd_args()} | relcool:error().
+create_lib_dirs(Opts, Acc) ->
+ Dirs = proplists:get_all_values(lib_dir, Opts) ++
+ proplists:get_value(lib_dirs, Opts, []),
+ case check_lib_dirs(Dirs) of
+ Error = {error, _} ->
+ Error;
+ ok ->
+ create_root_dir(Opts, [{lib_dirs, [filename:absname(Dir) || Dir <- Dirs]} | Acc])
+ end.
+
+-spec create_root_dir([getopt:option()], rcl_state:cmd_args()) ->
+ {ok, rcl_state:cmd_args()} | relcool:error().
+create_root_dir(Opts, Acc) ->
+ Dir = proplists:get_value(root_dir, Opts, undefined),
+ case Dir of
+ undefined ->
+ {ok, Cwd} = file:get_cwd(),
+ create_disable_default_libs(Opts, [{root_dir, Cwd} | Acc]);
+ _ ->
+ create_disable_default_libs(Opts, [{root_dir, Dir} | Acc])
+ end.
+
+-spec create_disable_default_libs([getopt:option()], rcl_state:cmd_args()) ->
+ {ok, rcl_state:cmd_args()} | relcool:error().
+create_disable_default_libs(Opts, Acc) ->
+ Def = proplists:get_value(disable_default_libs, Opts, false),
+ create_upfrom(Opts, [{disable_default_libs, Def} | Acc]).
+
+-spec create_upfrom([getopt:option()], rcl:cmd_args()) ->
+ {ok, rcl_state:cmd_args()} | relcool:error().
+create_upfrom(Opts, Acc) ->
+ case proplists:get_value(upfrom, Opts, undefined) of
+ undefined ->
+ create_caller(Opts, Acc);
+ UpFrom ->
+ create_caller(Opts, [{upfrom, UpFrom} | Acc])
+ end.
+
+-spec create_caller([getopt:option()], rcl_state:cmd_args()) ->
+ {ok, rcl_state:cmd_args()} | relcool:error().
+create_caller(Opts, Acc) ->
+ case proplists:get_value(caller, Opts, api) of
+ "command_line" ->
+ {ok, [{caller, command_line} | Acc]};
+ "commandline" ->
+ {ok, [{caller, command_line} | Acc]};
+ "api" ->
+ {ok, [{caller, api} | Acc]};
+ api ->
+ {ok, [{caller, api} | Acc]};
+ commandline ->
+ {ok, [{caller, command_line} | Acc]};
+ command_line ->
+ {ok, [{caller, command_line} | Acc]};
+ Caller ->
+ ?RCL_ERROR({invalid_caller, Caller})
+ end.
+-spec check_lib_dirs([string()]) -> ok | relcool:error().
+check_lib_dirs([]) ->
+ ok;
+check_lib_dirs([Dir | Rest]) ->
+ case filelib:is_dir(Dir) of
+ false ->
+ ?RCL_ERROR({not_directory, Dir});
+ true ->
+ check_lib_dirs(Rest)
+ end.