package.sh

#!/usr/bin/env bash
#github-action genshdoc

# if already sourced, return
[[ -v _PACKAGE__LOADED ]] && return || _PACKAGE__LOADED=True

# @file package.sh
# @brief Load shell libraries packages as git repositories
# @description Allow loading of shell libraries packages provided in git repositories with a simple command as `package.load github.com/vargiuscuola/shdoc`.
#   
#   Use the command `module.doc <function_name>` to see the documentation for a function (see an [example](https://github.com/vargiuscuola/std-lib.bash#examples))
# @show-internal
shopt -s expand_aliases

# alias for printing an error message
alias errmsg='>&2 echo -e "\\e[1;31m[ERROR]\\e[0m \\e[0;33m${FUNCNAME[0]}()\\e[0m#"'

# @setting _PACKAGE__LIB_DIR string[/lib/sh in Linux or /c/linux-lib/sh in Windows] shell libraries base path
if [ -z "$_PACKAGE__LIB_DIR" ]; then
  # _PACKAGE__LIB_DIR is equal to the current path with the last 2 components removed (the current file + the std-lib directory)
  _PACKAGE__LIB_DIR="${BASH_SOURCE[0]%/*/${BASH_SOURCE[0]##*/}}"
  #[[ "$( uname -a  )" =~ ^MINGW ]] && _PACKAGE__LIB_DIR=/c/linux-lib/sh || _PACKAGE__LIB_DIR=/lib/sh
fi

# @description Return the library base path.
# @alias package.get-lib-dir_
# @noargs
# @return Library dir path
# @example
#   $ package.get-lib-dir_
#      return> /lib/sh
package_get-lib-dir_() {
  declare -g __="$_PACKAGE__LIB_DIR"
}
alias package.get-lib-dir_="package_get-lib-dir_"

# @description Return the path of the provided package
# @alias package.get-path_
# @arg $1 String Name of the package (in the form of a git repository url without scheme)
# @example
#   $ package_get-path_ github.com/vargiuscuola/std-lib.bash
#   # return __=/lib/sh/github.com/vargiuscuola/std-lib.bash
# @return Path of the provided package
package_get-path_() {
  (( $# != 1 )) && { errmsg "Wrong number of arguments: $# instead of 1" ; exit 1 ; }      # validate the number of arguments
  declare -g __="$_PACKAGE__LIB_DIR/$1"
}
alias package.get-path_="package_get-path_"


# @description Update a git package from the repository remote.
# @alias package.update
# @arg $1 String Git repository url without scheme (https is used)
# @exitcodes Standard
# @example
#   $ package.update github.com/vargiuscuola/std-lib.bash
package_update() {
  (( $# != 1 )) && { errmsg "Wrong number of arguments: $# instead of 1" ; exit 1 ; }      # validate the number of arguments
  local git_package lib_dir
  git_package="$1"
  lib_dir="$_PACKAGE__LIB_DIR/$git_package"

  [ ! -d "$lib_dir" ] && { errmsg "Package $git_package is not yet loaded" ; return 1 ; }

  ( cd "$lib_dir" &>/dev/null && git fetch --prune &>/dev/null ) || { errmsg "Cannot check updates from origin" ; return 1 ; }
  local local_commitid="$(cd "$lib_dir" && git rev-parse master)"
  local remote_commitid="$(cd "$lib_dir" && git rev-parse origin/master)"
  if [ "$local_commitid" = "$remote_commitid" ]; then
    echo "[OK] The repository was already updated"
  else
    echo "Updating git repository in $lib_dir..."
    ( cd "$lib_dir" &>/dev/null && git reset --hard "$remote_commitid" ) &&
      echo "[OK] Repository updated successfully" ||
      { errmsg "The git repository cannot be updated" ; return 1 ; }
  fi
  return 0
}
alias package.update="package_update"

# @description Check the consistency state of a package (through a `git fsck` command on the related git repository).
# @alias package.check
# @arg $1 String Git repository url without scheme (https is used)
# @exitcodes Standard
# @example
#   $ package.check github.com/vargiuscuola/std-lib.bash
package_check() {
  (( $# != 1 )) && { errmsg "Wrong number of arguments: $# instead of 1" ; exit 1 ; }      # validate the number of arguments
  local git_package lib_dir
  git_package="$1"
  lib_dir="$_PACKAGE__LIB_DIR/$git_package"

  [ ! -d "$lib_dir" ] && { errmsg "Package $git_package is not yet loaded" ; return 1 ; }

  ( cd "$lib_dir" &>/dev/null && git fsck &>/dev/null ) &&
    { echo "[OK] The repository is clean" ; return 0 ; } ||
    { errmsg "The git repository in $lib_dir is broken" ; return 1 ; }
}
alias package.check="package_check"

# @description Load required package, cloning the git repository hosting it.
# @alias package.load
# @arg $1 String Git repository url without scheme (https is used)
# @exitcodes Standard
# @stdout Informative messages
# @stderr Error messages
# @example
#   $ package.load github.com/vargiuscuola/std-lib.bash
package_load() {
  local is_update is_check git_package lib_dir
  (( $# != 1 )) && { errmsg "Wrong number of arguments: $# instead of 1" ; exit 1 ; }      # validate the number of arguments
  git_package="$1"
  lib_dir="$_PACKAGE__LIB_DIR/$git_package"

  [ -d "$lib_dir" ] && { echo "Package $git_package was already loaded" ; return 0 ; }
  
  local git_url="https://$git_package"
  echo "Cloning $git_url..."
  git clone --single-branch "$git_url" "$lib_dir" &>/dev/null && echo "[OK] $git_url cloned successfully" || { errmsg "Error cloning $git_url" ; return 1 ; }
  [ ! -d "$lib_dir" ] && { errmsg "Missing git repository in $lib_dir" ; return 1 ; }
  return 0
}
alias package.load="package_load"