View Source MishkaInstaller.Installer.LibraryHandler (Mishka installer v0.1.1)
This module provides programmers with a public APIs and helpers that allow them to construct their own custom functions.
It also includes aids and tools that allow them to work with the library while it is running.
MishkaInstaller.Installer.Installer is also referred to as action and aggregator functions,
which is something that should be taken into consideration.
If you are unsure about the responsibilities of each function,
it is recommended that you utilise the MishkaInstaller.Installer.Installer module and its functions,
which consist of a collection of predefined strategies.
Security considerations
It is important to remember that all of the functionalities contained within this section must be implemented at the high access level, and they should not directly take any input from the user. Ensure that you include the required safety measures.
Use cases information
Especially when you want to work with a library that depends on a large number of other libraries or vice versa, each of the functions of this file has its own requirements that must be taken into consideration.
Summary
Functions
Helper function to load an application and all its dependencies.
Helper function that executes system and script commands.
This particular function executes the necessary instructions in order to download the dependencies, compile the dependencies, and compile the project itself.
Helper function to get download path and extract runtime libraries.
A helper function to extract downloaded libraries from hex.pm, github and custom url.
Helper function to transfer files to the deployment path.
Helper function to transfer and replace built libs to the project _build dir.
By means of this helper function, identify the paths of dependencies to the Erlang VM.
Helper function to read Erlang .app file in Elixir.
Helper function to unload an application.
Types
@type app() :: MishkaInstaller.Installer.Installer.t() | map()
@type compile_time_type() :: :cmd | :port | :mix
@type io_device() :: :file.io_device()
@type posix() :: :file.posix()
@type runtime_type() :: :add | :force_update | :uninstall
Functions
@spec application_ensure(atom()) :: :ok | error_return()
Helper function to load an application and all its dependencies.
Security considerations
It is important to remember that all of the functionalities contained within this section must be implemented at the high access level, and they should not directly take any input from the user. Ensure that you include the required safety measures.
Example:
application_ensure(:mishka_developer_tools)@spec command_execution(:cmd | :port, String.t(), String.t()) :: :ok | error_return()
Helper function that executes system and script commands.
Ref:
Security considerations
It is important to remember that all of the functionalities contained within this section must be implemented at the high access level, and they should not directly take any input from the user. Ensure that you include the required safety measures.
Example:
command_execution(:cmd, "deps.get")
command_execution(:port, "deps.get")@spec do_compile(app()) :: :ok | error_return()
This particular function executes the necessary instructions in order to download the dependencies, compile the dependencies, and compile the project itself.
Security considerations
It is important to remember that all of the functionalities contained within this section must be implemented at the high access level, and they should not directly take any input from the user. Ensure that you include the required safety measures.
alias MishkaInstaller.Installer.{Installer, LibraryHandler}
do_compile(%Installer{app: "some_name", path: "some_name", type: :hex})During the subsequent releases, we will make an effort to incorporate the script mode.
- Based on: https://elixirforum.com/t/12114/14
@spec extensions_path() :: Path.t()
Helper function to get download path and extract runtime libraries.
Example:
extensions_path()@spec extract(:tar, binary(), String.t()) :: :ok | error_return()
A helper function to extract downloaded libraries from hex.pm, github and custom url.
Security considerations
It is important to remember that all of the functionalities contained within this section must be implemented at the high access level, and they should not directly take any input from the user. Ensure that you include the required safety measures.
Example:
extract(:tar, a_path, "app_name-version")@spec move(MishkaInstaller.Installer.Installer.t(), binary() | Path.t()) :: okey_return() | error_return()
Helper function to transfer files to the deployment path.
Security considerations
It is important to remember that all of the functionalities contained within this section must be implemented at the high access level, and they should not directly take any input from the user. Ensure that you include the required safety measures.
Example:
move(app, "archived_file_binary")@spec move_and_replace_build_files(MishkaInstaller.Installer.Installer.t()) :: okey_return() | error_return()
Helper function to transfer and replace built libs to the project _build dir.
Security considerations
It is important to remember that all of the functionalities contained within this section must be implemented at the high access level, and they should not directly take any input from the user. Ensure that you include the required safety measures.
Example:
alias MishkaInstaller.Installer.{Installer, LibraryHandler}
move_and_replace_build_files(%Installer{app: "some_name", path: "some_name", type: :hex})@spec prepend_compiled_apps([tuple()]) :: :ok | error_return()
By means of this helper function, identify the paths of dependencies to the Erlang VM.
For more information see Code.prepend_path/1.
Security considerations
It is important to remember that all of the functionalities contained within this section must be implemented at the high access level, and they should not directly take any input from the user. Ensure that you include the required safety measures.
Example:
files_list = [
decimal: "/_build/dev/lib/decimal/ebin",
ecto: "/_build/dev/lib/ecto/ebin",
uniq: "/_build/dev/lib/uniq/ebin"
]
prepend_compiled_apps(files_list)@spec read_app(atom(), Path.t()) :: {:ok, any()} | error_return()
Helper function to read Erlang .app file in Elixir.
Reads the given app from path in an optimized format and returns its contents.
Security considerations
It is important to remember that all of the functionalities contained within this section must be implemented at the high access level, and they should not directly take any input from the user. Ensure that you include the required safety measures.
Example:
read_app(:mishka_developer_tools, app_bin_path)@spec unload(atom()) :: :ok | error_return()
Helper function to unload an application.
Security considerations
It is important to remember that all of the functionalities contained within this section must be implemented at the high access level, and they should not directly take any input from the user. Ensure that you include the required safety measures.
Example:
unload(:mishka_developer_tools)