just-bashit 0.2.0__py3-none-any.whl

just_bashit/__init__.py

@@ -0,0 +1,3 @@
+from importlib.metadata import version as _v
+
+__version__ = _v("just-bashit")

just_bashit/_launcher.py

@@ -0,0 +1,23 @@
+"""Thin shims that exec bundled bash scripts as console_scripts entry points."""
+import os
+import sys
+from pathlib import Path
+
+_BIN = Path(__file__).parent
+
+
+def _exec(script: str) -> None:
+    path = _BIN / script
+    os.execvp("bash", ["bash", str(path)] + sys.argv[1:])
+
+
+def jb() -> None:
+    _exec("just-runit")
+
+
+def jbx() -> None:
+    _exec("just-runit")
+
+
+def jb_inspect() -> None:
+    _exec("inspect.sh")

just_bashit/datetime.sh

@@ -0,0 +1,115 @@
+#!/bin/bash
+# ############################################################################
+# LIBRARY: datetime.sh                                                       #
+# PACKAGE: just-bashit version 0.2.0                                         #
+# ############################################################################
+
+# Enforce sourcing of the script by taking advantage of the fact that return
+# only works if sourced and errors otherwise.
+(return 0 2>/dev/null) || (echo "This file must be sourced." && exit)
+
+iso-8601-basic() {
+
+	# Initialize all referenced variables
+	local HELP
+	local DATE='now'
+	local OPTARG=""
+	local OPTIND=0
+	local DIGITS=0
+	local FRACTION=""
+	local TIMESTAMP=""
+	local MSEC_DIGITS=3
+	local USEC_DIGITS=6
+	local NANO_DIGITS=9
+
+	# Create the help
+	read -r -d '' HELP <<-'EOF' || true
+		Usage: iso-8601-basic [-d DATE] [-m|u|n]
+
+		  Basic-Format ISO 8601 Timestamp.
+
+		Options:
+		  -h       Show this message and exit.
+		  -d DATE  UTC date and time to use instead of the default 'now'.
+		  -m       Show milliseconds (default is seconds).
+		  -u       Show microseconds (default is seconds).
+		  -n       Show nanoseconds (default is seconds).
+
+		Path and file-name-friendly characters only are generated:
+
+		  YYYYMMDDThhmmss[.fff[fff]]Z
+
+		Where
+
+		  - YYYY is the 4 digit year.
+		  - MM is the two digit month.
+		  - DD is the two digit day.
+		  - hh is the two digit hour.
+		  - mm is the two digit minute.
+		  - ss is the two digit second.
+		  - .fff is the 3 digit millisecond.
+		  - .ffffff is the 6 digit microsecond.
+		  - .fffffffff is the 9 digit nanosecond.
+	EOF
+
+	# Specify options. Add ':' to start and after options that take arguments.
+	while getopts ":hd:mun" option; do
+
+		# Parse options.
+		case $option in
+
+		# h for help.
+		h)
+			echo "${HELP}"
+			return 0
+			;;
+
+		# Unrecognized options set $option to '?'.
+		\?)
+			echo "Invalid option: -${OPTARG}"
+			echo "${HELP}"
+			return 0
+			;;
+
+		# Option taking a parameter stored for later processing.
+		d)
+			DATE="${OPTARG}"
+			;;
+
+		# Option processed immediately
+		m)
+			DIGITS="${MSEC_DIGITS}"
+			;;
+
+		# Option processed immediately
+		u)
+			DIGITS="${USEC_DIGITS}"
+			;;
+
+		# Option processed immediately
+		n)
+			DIGITS="${NANO_DIGITS}"
+			;;
+
+		esac
+
+	done
+
+	# Remove options from the input list $@ so the first remaining argument is $1.
+	shift "$((OPTIND - 1))"
+
+	# Compute the full precision timestamp
+	# Use gdate (GNU date) on macOS where system date is BSD date.
+	local _date_cmd
+	_date_cmd=$(command -v gdate 2>/dev/null || command -v date)
+	TIMESTAMP=$("${_date_cmd}" --utc --date="${DATE}" +"%Y%m%dT%H%M%S.%N")
+
+	# Separate and truncate the seconds if needed
+	FRACTION="${TIMESTAMP##*.}"
+	if ((DIGITS)); then
+		echo "${TIMESTAMP%%.*}.${FRACTION:0:DIGITS}Z"
+	else
+		echo "${TIMESTAMP%%.*}Z"
+	fi
+
+}

just_bashit/environment.sh

@@ -0,0 +1,204 @@
+#!/bin/bash
+# ############################################################################
+# LIBRARY: environment.sh                                                    #
+# PACKAGE: just-bashit version 0.2.0                                         #
+# ############################################################################
+
+# Enforce sourcing of the script by taking advantage of the fact that return
+# only works if sourced and errors otherwise.
+(return 0 2>/dev/null) || (echo "This file must be sourced." && exit)
+
+set-bashrc() {
+
+	# Initialize all referenced variables
+	local HELP
+	local OPTARG=""
+	local OPTIND=0
+	local BASHRC="${HOME}/.bashrc"
+
+	# Create the help
+	read -r -d '' HELP <<-'EOF' || true
+		Usage: set-bashrc [OPTIONS] KEY_OR_ENTRY [VALUE] ...
+
+		  Write a line to ~/.bashrc ONLY if not already present.
+
+		Options:
+		  -h        Show this message and exit.
+
+		Arguments:
+		  KEY_OR_ENTRY  Line to write verbatim if given alone, otherwise interpreted
+		                as a KEY given VALUE is provided to complete the pair. In the
+		                latter case the line written is "export KEY=VALUE".
+		  VALUE         The value associated with the provided KEY.
+
+		Note that this function WILL NOT write the same line repeatedly. If the line
+		already exists, no write is performed.
+	EOF
+
+	# Specify options. Add ':' to start and after options that take arguments.
+	while getopts ":h" option; do
+
+		# Parse options.
+		case $option in
+
+		# h for help.
+		h)
+			echo "${HELP}"
+			return 0
+			;;
+
+		# Unrecognized options set $option to '?'.
+		\?)
+			echo "Invalid option: -${OPTARG}"
+			echo "${HELP}"
+			return 0
+			;;
+
+		esac
+
+	done
+
+	# Remove options from the input list $@ so the first remaining argument is $1.
+	shift "$((OPTIND - 1))"
+	local BASHRC_KEY_OR_ENTRY=${1:-}
+	local BASHRC_VALUE=${2:-}
+
+	# For two inputs assume key-value pair.
+	if [ -n "${BASHRC_VALUE}" ]; then
+		local BASHRC_ENTRY="export ${BASHRC_KEY_OR_ENTRY}=${BASHRC_VALUE}"
+
+	# If only one input, use as is.
+	elif [ -n "${BASHRC_KEY_OR_ENTRY}" ]; then
+		local BASHRC_ENTRY="${BASHRC_KEY_OR_ENTRY}"
+
+	# Print some help if they didn't provide anything.
+	else
+		echo "Not enough arguments."
+		echo "${HELP}"
+
+	fi
+
+	# Check permissions and create if necessary.
+	touch "${BASHRC}"
+
+	# Ensure the file ends with a trailing newline as it should. Get the last
+	# character in the file with 'tail', pipe it to 'read' which produces an
+	# error if a file doesn't end with a newline, and if so, trigger an echo
+	# which produces a newline appending it to the file.
+	tail -c1 "${BASHRC}" | read -r _ || echo "" >>"${BASHRC}"
+
+	# Add entry if not already present using grep options
+	# ---------------------------------------------------
+	# -q: Quiet; do not write anything to standard output. Exit immediately
+	#     with 0 status if any match is found, even if an error was detected.
+	# -x: Select only those matches that exactly match the whole line.
+	# -F: Interpret patterns as fixed strings, not regular expressions.
+	grep -qxF "${BASHRC_ENTRY}" "${BASHRC}" || echo "${BASHRC_ENTRY}" >>"${BASHRC}"
+
+}
+
+unset-bashrc() {
+
+	# Initialize all referenced variables
+	local HELP
+	local OPTARG=""
+	local OPTIND=0
+	local BASHRC="${HOME}/.bashrc"
+
+	read -r -d '' HELP <<-'EOF' || true
+		Usage: unset-bashrc [OPTIONS] KEY_OR_ENTRY [VALUE] ...
+
+		  Remove requested line from ~/.bashrc if present.
+
+		Options:
+		  -h        Show this message and exit.
+
+		Arguments:
+		  KEY_OR_ENTRY  Line to remove verbatim if given alone, otherwise interpreted
+		                as a KEY, given VALUE is provided to complete the pair. In the
+		                latter case the line searched for is "export KEY=VALUE".
+		  VALUE         The value associated with the provided KEY.
+
+		Note that this function is a no-op if the given line is not found.
+	EOF
+
+	# Specify options. Add ':' to start and after options that take arguments.
+	while getopts ":h" option; do
+
+		# Parse options.
+		case $option in
+
+		# h for help.
+		h)
+			echo "${HELP}"
+			return 0
+			;;
+
+		# Unrecognized options set $option to '?'.
+		\?)
+			echo "Invalid option: -${OPTARG}"
+			echo "${HELP}"
+			return 0
+			;;
+
+		esac
+
+	done
+
+	# Remove options from the input list $@ so the first remaining argument is $1.
+	shift "$((OPTIND - 1))"
+
+	# For two inputs assume key-value pair.
+	local BASHRC_VALUE=${2:-}
+	local BASHRC_KEY_OR_ENTRY=${1:-}
+	if [ -n "${BASHRC_VALUE}" ]; then
+		local BASHRC_ENTRY="export ${BASHRC_KEY_OR_ENTRY}=${BASHRC_VALUE}"
+
+	# If only one input, use as is.
+	elif [ -n "${BASHRC_KEY_OR_ENTRY}" ]; then
+		local BASHRC_ENTRY="${BASHRC_KEY_OR_ENTRY}"
+
+	# Print some help if they didn't provide anything.
+	else
+		echo "Not enough arguments."
+		echo "${HELP}"
+
+	fi
+
+	# Check permissions and create if necessary.
+	touch "${BASHRC}"
+
+	# Remove entry if present using built in editor
+	# ---------------------------------------------
+	# Delete the exact line in-place; -i'' works on both GNU and BSD sed.
+	# shellcheck disable=SC2016
+	sed -i'' "/^$(printf '%s' "${BASHRC_ENTRY}" | sed 's/[[\.*^$()+?{}|]/\\&/g')$/d" "${BASHRC}"
+
+}
+
+check-command-exists() {
+
+	# Assume we are running under -u so initialize any referenced variables
+	local ARG1=${1:-}
+
+	# Forget getopts, manually parse for handful of inputs
+	case "${ARG1}" in
+	-h)
+
+		# Prefer help to commenst since it's user-oriented and runtime-available.
+		echo 'Usage: check-command-exists [-h]'
+		echo
+		echo '  Does just that. Exits with 0 if true 1 if false.'
+		echo
+		echo 'Options:'
+		echo '  -h     Show this message and exit.'
+		return 0
+		;;
+
+	*)
+		command -v "${ARG1}" >/dev/null 2>&1
+		;;
+
+	esac
+
+}

just_bashit/file.sh

@@ -0,0 +1,257 @@
+#!/bin/bash
+# ############################################################################
+# LIBRARY: file.sh                                                           #
+# PACKAGE: just-bashit version 0.2.0                                         #
+# ############################################################################
+
+# Enforce sourcing of the script by taking advantage of the fact that return
+# only works if sourced and errors otherwise.
+(return 0 2>/dev/null) || (echo "This file must be sourced." && exit)
+
+add-line() {
+
+	# Initialize all referenced variables
+	local HELP
+	local BLANK=1
+	local OPTARG=""
+	local OPTIND=0
+
+	# Create the help
+	read -r -d '' HELP <<-'EOF' || true
+		Usage: add-line [OPTIONS] [ENTRY] FILEPATH ...
+
+		  Write ENTRY to FILEPATH only if not already present or if
+		          one argument is given, in which case the argument is taken as
+		          FILEPATH and a blank line is written.
+
+		Options:
+		  -h        Show this message and exit.
+		          -x        Don't write blank lines.
+
+		Arguments:
+		  ENTRY     Line to write verbatim.
+		  FILEPATH  Path to file for writing.
+
+		Note that this function WILL NOT write the same line repeatedly. Except
+		        for the blankline case, if the line already exists, no write is performed.
+	EOF
+
+	# Specify options. Add ':' to start and after options that take arguments.
+	while getopts ":hx" option; do
+
+		# Parse options.
+		case $option in
+
+		# h for help.
+		h)
+			echo "${HELP}"
+			return 0
+			;;
+
+		# Dont write blank lines.
+		x)
+			local BLANK=0
+			;;
+
+		# Unrecognized options set $option to '?'.
+		\?)
+			echo "Invalid option: -${OPTARG}"
+			echo "${HELP}"
+			return 0
+			;;
+
+		esac
+
+	done
+
+	# Remove options from the input list $@ so the first remaining argument is $1.
+	shift "$((OPTIND - 1))"
+	local ENTRY=${1:-}
+	local FILEPATH=${2:-}
+
+	# For two inputs assume standard operation; if one, treat it as FILEPATH.
+	if [ -z "${FILEPATH}" ] && [ -n "${ENTRY}" ]; then
+		FILEPATH="${ENTRY}"
+		ENTRY=""
+
+	# Print some help if they didn't provide anything.
+	else
+		echo "Not enough arguments."
+		echo "${HELP}"
+
+	fi
+
+	# Check permissions and create if necessary.
+	touch "${FILEPATH}"
+
+	if ((BLANK)) && [[ -z ${ENTRY} ]]; then
+		echo "" >>"${FILEPATH}"
+	else
+		# Add entry if not already present using grep options
+		# ---------------------------------------------------
+		# -q: Quiet; do not write anything to standard output. Exit immediately
+		#     with 0 status if any match is found, even if an error was detected.
+		# -x: Select only those matches that exactly match the whole line.
+		# -F: Interpret patterns as fixed strings, not regular expressions.
+		grep -qxF "${ENTRY}" "${FILEPATH}" || echo "${ENTRY}" >>"${FILEPATH}"
+
+		# Ensure the file ends with a trailing newline as it should. Get the last
+		# character in the file with 'tail', pipe it to 'read' which produces an
+		# error if a file doesn't end with a newline, and if so, trigger an echo
+		# which produces a newline appending it to the file.
+		tail -c1 "${FILEPATH}" | read -r _ || echo "" >>"${FILEPATH}"
+	fi
+}
+
+remove-line() {
+
+	# Initialize all referenced variables
+	local HELP
+	local BLANK=1
+	local OPTARG=""
+	local OPTIND=0
+
+	read -r -d '' HELP <<-'EOF' || true
+		Usage: remove-line [OPTIONS] [ENTRY] FILEPATH ...
+
+		  Remove ENTRY from FILEPATH if present.
+
+		Options:
+		  -h        Show this message and exit.
+		          -x        Don't remove blank lines.
+
+		Arguments:
+		  ENTRY     Line to remove verbatim.
+		  FILEPATH  Path to file for line removal.
+
+		Note that this function is a no-op if the given line is not found.
+	EOF
+
+	# Specify options. Add ':' to start and after options that take arguments.
+	while getopts ":hx" option; do
+
+		# Parse options.
+		case $option in
+
+		# h for help.
+		h)
+			echo "${HELP}"
+			return 0
+			;;
+
+		# Dont remove blank lines.
+		x)
+			local BLANK=0
+			;;
+
+		# Unrecognized options set $option to '?'.
+		\?)
+			echo "Invalid option: -${OPTARG}"
+			echo "${HELP}"
+			return 0
+			;;
+
+		esac
+
+	done
+
+	# Remove options from the input list $@ so the first remaining argument is $1.
+	shift "$((OPTIND - 1))"
+	local ENTRY=${1:-}
+	local FILEPATH=${2:-}
+
+	# For two inputs assume standard operation; if one, treat it as FILEPATH.
+	if [ -z "${FILEPATH}" ]; then
+		if [ -n "${ENTRY}" ]; then
+			if ((BLANK)); then
+				FILEPATH="${ENTRY}"
+				ENTRY=""
+			else
+				return 0
+			fi
+		else
+			echo "Not enough arguments."
+			echo "${HELP}"
+		fi
+	fi
+
+	# Check permissions and create if necessary.
+	touch "${FILEPATH}"
+
+	# Remove entry if present using built in editor
+	# ---------------------------------------------
+	# Delete the exact line in-place; -i'' works on both GNU and BSD sed.
+	# shellcheck disable=SC2016
+	sed -i'' "/^$(printf '%s' "${ENTRY}" | sed 's/[[\.*^$()+?{}|]/\\&/g')$/d" "${FILEPATH}"
+
+}
+
+add-contents() {
+
+	# Initialize all referenced variables
+	local HELP
+	local BLANK=1
+	local OPTARG=""
+	local OPTIND=0
+
+	# Create the help
+	read -r -d '' HELP <<-'EOF' || true
+		Usage: add-contents [OPTIONS] FROMPATH TOPATH ...
+
+		  Write each line of FROMPATH to TOPATH only if not 
+		  already present in TOPATH.
+
+		Options:
+		  -h        Show this message and exit.
+		          -x        Don't write blank lines.
+
+		Arguments:
+		  FROMPATH  Path to file for reading lines.
+		  TOPATH    Path to file for writing lines.
+
+	EOF
+
+	# Specify options. Add ':' to start and after options that take arguments.
+	while getopts ":hx" option; do
+
+		# Parse options.
+		case $option in
+
+		# h for help.
+		h)
+			echo "${HELP}"
+			return 0
+			;;
+
+		# Dont write blank lines.
+		x)
+			local BLANK=0
+			;;
+
+		# Unrecognized options set $option to '?'.
+		\?)
+			echo "Invalid option: -${OPTARG}"
+			echo "${HELP}"
+			return 0
+			;;
+
+		esac
+
+	done
+
+	# Remove options from the input list $@ so the first remaining argument is $1.
+	shift "$((OPTIND - 1))"
+	local FROMPATH=${1:-}
+	local TOPATH=${2:-}
+
+	# Read FROMPATH file line by line
+	while IFS= read -r line; do
+		# Write to TOPATH
+		if ((BLANK)); then
+			add-line "${line}" "${TOPATH}"
+		else
+			add-line -x "${line}" "${TOPATH}"
+		fi
+	done <"$FROMPATH"
+
+}