just-bashit 0.2.0__py3-none-any.whl

just_bashit/format.sh

@@ -0,0 +1,223 @@
+#!/bin/bash
+# ############################################################################
+# LIBRARY: format.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)
+
+trim-from() {
+
+	read -r -d '' HELP <<-'EOF' || true
+		Usage: trim-from [-hrfe] [m MARKER] STRING
+
+		  Trim STRING from MARKER (first occurence, inclusive) to end.
+
+		Options:
+		  -h         Show this message and exit.
+		  -m MARKER  Character(s) to trim from. Default is '.'.
+		  -r         Reverse trim. Trim from MARKER to beginning.
+		  -g         Greedy. Trim from last occurence of marker.
+		  -k         Keep MARKER instead of including in trim.
+
+		Arguments:
+		  STRING     The text to trim.
+
+		Examples:
+		  trim-from 12.45            # gives 12
+		  trim-from -r 12.45         # gives 45
+		  trim-from 12.4.45          # gives 12.4
+		  trim-from -g 12.4.45       # gives 12
+		  trim-from -kg 12.4.45      # gives 12.
+		  trim-from -m MA "HEYMA!"   # gives HEY
+		  trim-from -rm MA "HEYMA!"  # gives !
+	EOF
+
+	# Initialize all referenced variables
+	local OPTARG=""
+	local OPTIND=0
+	local -i GREEDY=0
+	local -i REVERSE=0
+	local -i KEEP=0
+	local MARKER='.'
+	local RESULT=""
+
+	# Specify options. Add ':' to start and after options that take arguments.
+	while getopts ":hrgkm:" option; do
+
+		# Parse options.
+		case $option in
+
+		# h for help.
+		h)
+			echo "${HELP}"
+			return 0
+			;;
+
+		# Unrecognized options sets $option to '?'.
+		\?)
+			echo "Invalid option: -${OPTARG}"
+			echo "${HELP}"
+			return 0
+			;;
+
+		r)
+			REVERSE=1
+			;;
+
+		g)
+			GREEDY=1
+			;;
+
+		k)
+			KEEP=1
+			;;
+
+		m)
+			MARKER="${OPTARG}"
+			;;
+
+		esac
+
+	done
+
+	# Remove options from the input list $@ so the first remaining argument is $1.
+	shift "$((OPTIND - 1))"
+
+	# Build the string operator
+	local STRING=${1:-}
+	if ((REVERSE)); then
+
+		if ((GREEDY)); then
+			RESULT="${STRING##*"${MARKER}"}"
+		else
+			RESULT="${STRING#*"${MARKER}"}"
+		fi
+
+		((KEEP)) && RESULT="${MARKER}${RESULT}"
+
+	else
+
+		if ((GREEDY)); then
+			RESULT="${STRING%%"${MARKER}"*}"
+		else
+			RESULT="${STRING%"${MARKER}"*}"
+		fi
+
+		((KEEP)) && RESULT+="${MARKER}"
+
+	fi
+
+	printf %s "${RESULT}"
+
+}
+
+color-echo() {
+
+	read -r -d '' HELP <<-'EOF' || true
+		Usage: color-echo [OPTIONS] STRING
+
+		  Colorize text (default white) and "echo" (printf + trailing newline).
+
+		Options:
+		  -h        Show this message and exit.
+		  -c COLOR  One of [black|red|green|yellow|blue|magenta|cyan|white].
+		  -b        Bright or bold version of the requested color.
+
+		Arguments:
+		  STRING    The text to colorize and print.
+	EOF
+
+	# Initialize all referenced variables
+	local BOLD=1
+	local OPTARG=""
+	local OPTIND=0
+	local BEGIN="\033["
+	local RESET="\033[0m"
+	local DEBUG=0
+	local ATTRIBUTE=0
+	local FOREGROUND=37
+
+	# Specify options. Add ':' to start and after options that take arguments.
+	while getopts ":hbdc:" 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
+			;;
+
+		b)
+			ATTRIBUTE="${BOLD}"
+			;;
+
+		d)
+			DEBUG=1
+			;;
+
+		c)
+			# ${var,,} requires bash 4+; tr works on bash 3.2 (macOS default).
+			local _color_lc
+			_color_lc="$(printf '%s' "${OPTARG}" | tr '[:upper:]' '[:lower:]')"
+			case "${_color_lc}" in
+
+			black)
+				FOREGROUND=30
+				;;
+			red)
+				FOREGROUND=31
+				;;
+			green)
+				FOREGROUND=32
+				;;
+			yellow)
+				FOREGROUND=33
+				;;
+			blue)
+				FOREGROUND=34
+				;;
+			magenta)
+				FOREGROUND=35
+				;;
+			cyan)
+				FOREGROUND=36
+				;;
+			white)
+				FOREGROUND=37
+				;;
+			*)
+				echo "Error: invalid color ${OPTARG}" 1>&2
+				return 1
+				;;
+
+			esac
+			;;
+
+		esac
+
+	done
+
+	# Remove options from the input list $@ so the first remaining argument is $1.
+	shift "$((OPTIND - 1))"
+
+	# Print the formatted result
+	local TEXTFIELD=${*:-""}
+	local FORMATTED_TEXT="${BEGIN}${ATTRIBUTE};${FOREGROUND}m${TEXTFIELD}${RESET}"
+	if ((DEBUG)); then
+		printf %q "${FORMATTED_TEXT}\\n"
+	else
+		printf %b "${FORMATTED_TEXT}\\n"
+	fi
+}

just_bashit/function-template.sh

@@ -0,0 +1,139 @@
+#!/bin/bash
+# ############################################################################
+# LIBRARY: function-template.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)
+
+full-on-template() {
+
+	##########################################################################
+	# This is a 'full-on' template. Take only what you need. A lot of useful #
+	# functions don't need this complexity. Take a look at the minimalist    #
+	# template that immediately follows this one.                            #
+	##########################################################################
+
+	# Use 'heredoc' for help to make formatting easier: WYSIWYG
+	# Use two spaces for indent of section content as well as minimum space
+	# between option/argument names and descriptions, lining them all up.
+	local HELP
+	IFS= read -r -d '' HELP <<-'EOF'
+		Usage: full-on-template [OPTIONS] [-p PARAM] [ARGS] ...
+
+		  Function Title and Short Summary.
+
+		Options:
+		  -h        Show this message and exit.
+		  -p PARAM  Option that accepts an argument stored in $OPTARG.
+		  -v        Show the version and exit.
+
+		Arguments:
+		  MYCMD     Some command or other stored in $1
+		  MYVAR     Some variable or other stored in $2
+	EOF
+
+	# Initialize all referenced variables
+	local PARAM=""
+	local OPTARG=""
+	local OPTIND=0 # Particularly important when sourcing
+
+	# Specify options. Add ':' to start and after options that take arguments.
+	while getopts ":hp:v" 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.
+		p)
+			PARAM="${OPTARG}"
+			;;
+
+		# Option processed immediately
+		v)
+			echo "X.Y.Z"
+			return 0
+			;;
+
+		esac
+
+	done
+
+	# Remove options from the input list $@ so the first remaining argument is $1.
+	shift "$((OPTIND - 1))"
+
+	# Make sure all referenced arguments are initialized AFTER getopts processing
+	local MYCMD=${1:-} # Conditional assignment to $1 if exists or empty string
+
+	# Process option -p where PARAM could be a command, filename, etc...
+	if [ -n "${PARAM}" ]; then
+		echo "Option -p specified with argument: ${PARAM}"
+		# Do something with PARAM ...
+		return 0
+	fi
+
+	# Process arguments individually
+	# Some command
+	somecmd() { echo "Executing cmd()"; }
+	if [ "${MYCMD}" == 'SOMECMD' ]; then
+		somecmd
+		return 0
+	fi
+
+	# Process all arguments in a loop
+	for arg in "${@}"; do
+		echo "Processing argument: ${arg} from \$@ in a loop"
+		# Do something with the argument
+	done
+
+}
+
+minimalist-template() {
+
+	# Assume we are running under -u so initialize any referenced variables
+	ARG1=${1:-}
+
+	# Define a sub-command or action to use
+	something-cool() { echo "Doing something cool with ${ARG1}"; }
+
+	# 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: minimalist-template [OPTIONS] [-p PARAM] [ARGS] ...'
+		echo
+		echo '  Summarize what cool thing this function does.'
+		echo
+		echo 'Options:'
+		echo '  -h     Show this message and exit.'
+		echo
+		echo 'Arguments:'
+		# shellcheck disable=SC2016
+		echo '  MYVAR  Some variable or other stored in $1'
+		return 0
+		;;
+
+	*)
+
+		something-cool "${ARG1}"
+		;;
+
+	esac
+
+}

just_bashit/get-jb.sh

@@ -0,0 +1,177 @@
+#!/usr/bin/env bash
+# ############################################################################
+# SCRIPT: get-jb.sh                                                          #
+# PACKAGE: just-bashit version 0.2.0                                         #
+# ############################################################################
+# Installs just-runit (just-buildit / jb / jbx) to ~/.local/bin.            #
+#                                                                             #
+# Must be sourced so PATH exports reach the calling shell:                   #
+#   . <(curl -sSL https://just-buildit.github.io/get-jb.sh)                 #
+#                                                                             #
+# To force reinstall even when already current:                              #
+#   JB_REINSTALL=1 . <(curl -sSL https://just-buildit.github.io/get-jb.sh)
+# ############################################################################
+
+# Wrapped in a function so locals don't leak and we can clean up afterward.
+_jb_install() {
+
+	local INSTALL_DIR="${HOME}/.local/bin"
+	local RAW_BASE
+	RAW_BASE="https://raw.githubusercontent.com/just-buildit/just-bashit/main/src"
+	local RUNIT_URL="${RAW_BASE}/just-runit"
+	local BASHRC="${HOME}/.bashrc"
+
+	local BOLD="\033[1m"
+	local GREEN="\033[1;32m"
+	local CYAN="\033[1;36m"
+	local YELLOW="\033[1;33m"
+	local RESET="\033[0m"
+
+	_jb_say() { printf "${CYAN}  ->  ${RESET}${BOLD}%s${RESET}\n" "$*"; }
+	_jb_ok() { printf "${GREEN}  ok  ${RESET}%s\n" "$*"; }
+	_jb_warn() { printf "${YELLOW}  !!  ${RESET}%s\n" "$*"; }
+
+	# -- disclaimer ------------------------------------------------------------
+
+	printf '%b' "${YELLOW}${BOLD}"
+	printf '  +----------------------------------------------------------+\n'
+	printf '  |  This script is provided AS IS, without warranty of any  |\n'
+	printf '  |  kind. Review the source before running:                 |\n'
+	printf '  |  https://just-buildit.github.io/get-jb.sh                |\n'
+	printf '  |                                                          |\n'
+	printf '  |  The tool it installs fetches and executes arbitrary     |\n'
+	printf '  |  code from URLs you provide. It performs no review,      |\n'
+	printf '  |  scanning, or sandboxing. You are solely responsible     |\n'
+	printf '  |  for what you choose to run.                             |\n'
+	printf '  |                                                          |\n'
+	printf '  |  Use at your own risk.                                   |\n'
+	printf '  +----------------------------------------------------------+\n'
+	printf '%b\n' "${RESET}"
+
+	# -- install dir -----------------------------------------------------------
+
+	_jb_say "install dir: ${INSTALL_DIR}"
+	mkdir -p "${INSTALL_DIR}"
+
+	# -- version-aware download -----------------------------------------------
+
+	local tmp_runit
+	tmp_runit=$(mktemp /tmp/just-runit.XXXXXX)
+	# shellcheck disable=SC2064
+	trap "rm -f '${tmp_runit}'" RETURN
+
+	_jb_say "fetching jb from ${RUNIT_URL}"
+	if ! curl -sSL --proto '=https' --tlsv1.2 -o "${tmp_runit}" "${RUNIT_URL}"; then
+		printf "\033[1;31m  !!  \033[0mfailed to download jb\n" >&2
+		return 1
+	fi
+
+	local new_ver
+	new_ver=$(grep '^_VERSION=' "${tmp_runit}" | cut -d'"' -f2)
+	new_ver="${new_ver:-unknown}"
+
+	local installed="${INSTALL_DIR}/just-runit"
+	if [[ -x ${installed} ]]; then
+		local cur_ver
+		cur_ver=$(grep '^_VERSION=' "${installed}" | cut -d'"' -f2)
+		cur_ver="${cur_ver:-unknown}"
+
+		if [[ ${cur_ver} == "${new_ver}" && ${JB_REINSTALL:-0} != "1" ]]; then
+			_jb_ok "already at v${cur_ver} — set JB_REINSTALL=1 to force reinstall"
+		else
+			if [[ ${cur_ver} != "${new_ver}" ]]; then
+				_jb_say "upgrading v${cur_ver} -> v${new_ver}"
+			else
+				_jb_say "reinstalling v${new_ver}"
+			fi
+			cp "${tmp_runit}" "${installed}"
+			chmod +x "${installed}"
+			_jb_ok "jb v${new_ver} installed"
+		fi
+	else
+		_jb_say "installing v${new_ver}"
+		cp "${tmp_runit}" "${installed}"
+		chmod +x "${installed}"
+		_jb_ok "jb v${new_ver} installed"
+	fi
+
+	# -- remove stale aliases from prior naming schemes -----------------------
+
+	local stale
+	for stale in jr jx; do
+		local stale_path="${INSTALL_DIR}/${stale}"
+		if [[ -L ${stale_path} && "$(readlink -f "${stale_path}")" == "$(readlink -f "${INSTALL_DIR}/just-runit")" ]]; then
+			rm -f "${stale_path}"
+			_jb_warn "removed stale alias: ${stale}"
+		fi
+	done
+
+	# -- just-buildit symlink (always created — canonical long name) -----------
+
+	ln -sf just-runit "${INSTALL_DIR}/just-buildit"
+	_jb_ok "just-buildit -> just-runit"
+
+	# -- jb symlink (short alias — skipped if jb is already someone else's) ---
+
+	local _jb_cmd
+	_jb_cmd="$(command -v jb 2>/dev/null || true)"
+	local _JB_NAME="jb"
+	if [[ -n ${_jb_cmd} && "$(readlink -f "${_jb_cmd}")" != "$(readlink -f "${INSTALL_DIR}/just-runit")" ]]; then
+		_jb_warn "'jb' is already in use (${_jb_cmd}) — skipping short alias"
+		_jb_warn "use 'just-buildit' instead (always available)"
+		_JB_NAME="just-buildit"
+	else
+		ln -sf just-runit "${INSTALL_DIR}/jb"
+		_jb_ok "jb -> just-runit"
+	fi
+
+	# -- jbx symlink (runner shorthand, always created) -----------------------
+
+	ln -sf just-runit "${INSTALL_DIR}/jbx"
+	_jb_ok "jbx -> just-runit"
+
+	# -- PATH ------------------------------------------------------------------
+
+	if [[ ":${PATH}:" != *":${INSTALL_DIR}:"* ]]; then
+		_jb_say "adding ${INSTALL_DIR} to PATH (current shell)"
+		export PATH="${INSTALL_DIR}:${PATH}"
+
+		# shellcheck disable=SC2016
+		local entry='export PATH="${HOME}/.local/bin:${PATH}"'
+		if ! grep -qF '.local/bin' "${BASHRC}" 2>/dev/null; then
+			_jb_say "persisting PATH to ${BASHRC}"
+			printf '\n%s\n' "${entry}" >>"${BASHRC}"
+			_jb_ok "added to ${BASHRC}"
+		else
+			_jb_warn "${BASHRC} already references .local/bin — skipped"
+		fi
+	else
+		_jb_ok "${INSTALL_DIR} already in PATH"
+	fi
+
+	# -- uv (enables Python PEP 723 dep resolution) ---------------------------
+
+	if command -v uv >/dev/null 2>&1; then
+		_jb_ok "uv found — Python PEP 723 support ready"
+	else
+		_jb_say "installing uv (Python PEP 723 support)"
+		"${INSTALL_DIR}/just-runit" https://astral.sh/uv/install.sh
+		if command -v uv >/dev/null 2>&1; then
+			_jb_ok "uv installed"
+		else
+			_jb_warn "uv installed — open a new shell if 'uv' isn't found"
+		fi
+	fi
+
+	# -- confirm ---------------------------------------------------------------
+
+	printf '\n%b\n\n' "${GREEN}${BOLD}  just-buildit is ready.${RESET}"
+	printf '  %b%s -h%b                           show help\n' \
+		"${BOLD}" "${_JB_NAME}" "${RESET}"
+	printf '  %b%s run just-bashit:datetime iso-8601-basic%b  quick test\n\n' \
+		"${BOLD}" "${_JB_NAME}" "${RESET}"
+
+}
+
+_jb_install "$@"
+unset -f _jb_install _jb_say _jb_ok _jb_warn