container: rename lib_ledger to lib_hledger
As said before; `lib_ledger` was meant to be a general abstraction to any underlying CLI ledger. But, between C++ `ledger` and Ledger Hardware Wallet, this abstraction has become too confusing and counterproductive. Since `hledger` will be the underlying implementation for the forseeable future, all doubt should now be removed.
This commit is contained in:
198
container/src/finance/lib/internal/lib_hledger.bash
Normal file
198
container/src/finance/lib/internal/lib_hledger.bash
Normal file
@@ -0,0 +1,198 @@
|
||||
#!/usr/bin/env bash
|
||||
|
||||
# docker-finance | modern accounting for the power-user
|
||||
#
|
||||
# Copyright (C) 2021-2024 Aaron Fiore (Founder, Evergreen Crypto LLC)
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation, either version 3 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# This program is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
#
|
||||
# "Libraries"
|
||||
#
|
||||
|
||||
[ -z "$DOCKER_FINANCE_CONTAINER_REPO" ] && exit 1
|
||||
source "${DOCKER_FINANCE_CONTAINER_REPO}/src/finance/lib/internal/lib_utils.bash" || exit 1
|
||||
|
||||
#
|
||||
# Facade
|
||||
#
|
||||
|
||||
function lib_ledger::ledger-import()
|
||||
{
|
||||
lib_ledger::__ledger "$@"
|
||||
lib_ledger::__ledger-import "$@"
|
||||
lib_utils::catch $?
|
||||
}
|
||||
|
||||
function lib_ledger::ledger-cli()
|
||||
{
|
||||
lib_ledger::__ledger "$@"
|
||||
lib_ledger::__ledger-cli "$@"
|
||||
lib_utils::catch $?
|
||||
}
|
||||
|
||||
function lib_ledger::ledger-ui()
|
||||
{
|
||||
lib_ledger::__ledger "$@"
|
||||
lib_ledger::__ledger-ui "$@"
|
||||
lib_utils::catch $?
|
||||
}
|
||||
|
||||
function lib_ledger::ledger-vui()
|
||||
{
|
||||
lib_ledger::__ledger "$@"
|
||||
lib_ledger::__ledger-vui "$@"
|
||||
lib_utils::catch $?
|
||||
}
|
||||
|
||||
function lib_ledger::ledger-web()
|
||||
{
|
||||
lib_ledger::__ledger "$@"
|
||||
lib_ledger::__ledger-web "$@"
|
||||
lib_utils::catch $?
|
||||
}
|
||||
|
||||
#
|
||||
# Implementation
|
||||
#
|
||||
|
||||
# Constructor
|
||||
function lib_ledger::__ledger()
|
||||
{
|
||||
# Base arguments to hledger before end-user added
|
||||
[ -z "$global_child_profile_journal" ] && lib_utils::die_fatal
|
||||
declare -g global_base_args=("-f" "$global_child_profile_journal")
|
||||
|
||||
#
|
||||
# Apply features to given hledger version.
|
||||
#
|
||||
# CLI version formats:
|
||||
#
|
||||
# hledger 1.34, linux-x86_64
|
||||
# hledger 1.34.99-gcf0c7c2ef-20240702, linux-x86_64
|
||||
#
|
||||
|
||||
# TODO: remove now that 1.40 is guaranteed minimum
|
||||
# 1.34.99 and above
|
||||
hledger --version \
|
||||
| gawk '{ if ($2 !~ /^1.3(4.99|([5-9][\.[0-99]?))/) { exit 1 } }' FS=' '
|
||||
|
||||
if [ $? -eq 0 ]; then
|
||||
# --conf is supported
|
||||
[ -z "$global_conf_hledger" ] && lib_utils::die_fatal
|
||||
global_base_args+=("--conf" "$global_conf_hledger")
|
||||
fi
|
||||
|
||||
lib_utils::print_debug "${global_base_args[*]}" "$@"
|
||||
}
|
||||
|
||||
function lib_ledger::__parse_ledger-import()
|
||||
{
|
||||
[ -z "$global_usage" ] && lib_utils::die_fatal
|
||||
[ -z "$global_arg_delim_1" ] && lib_utils::die_fatal
|
||||
[ -z "$global_arg_delim_2" ] && lib_utils::die_fatal
|
||||
|
||||
local -r _arg="$1"
|
||||
local -r _usage="
|
||||
\e[32mDescription:\e[0m
|
||||
|
||||
Import all accounts' CSV data to produce viable journals (see README for setup)
|
||||
|
||||
\e[32mUsage:\e[0m
|
||||
|
||||
$ $global_usage [year${global_arg_delim_2}<year>]
|
||||
|
||||
\e[32mArguments:\e[0m
|
||||
|
||||
Import year:
|
||||
|
||||
year${global_arg_delim_2}<all|year>
|
||||
|
||||
\e[32mExamples:\e[0m
|
||||
|
||||
\e[37;2m# Import all years since 2020\e[0m
|
||||
$ $global_usage year${global_arg_delim_2}2020
|
||||
"
|
||||
|
||||
if [ "$#" -gt 1 ]; then
|
||||
lib_utils::die_usage "$_usage"
|
||||
fi
|
||||
|
||||
if [ ! -z "$_arg" ]; then
|
||||
if [[ ! "$_arg" =~ ^year[s]?${global_arg_delim_2} ]]; then
|
||||
lib_utils::die_usage "$_usage"
|
||||
fi
|
||||
|
||||
local _key="${_arg%${global_arg_delim_2}*}"
|
||||
local _len="$((${#_key} + 1))"
|
||||
if [[ "$_key" =~ ^year[s]?$ ]]; then
|
||||
local _arg_year="${_arg:${_len}}"
|
||||
if [ -z "$_arg_year" ]; then
|
||||
lib_utils::die_usage "$_usage"
|
||||
fi
|
||||
fi
|
||||
fi
|
||||
|
||||
# Arg: year
|
||||
# TODO: implement range
|
||||
if [ ! -z "$_arg_year" ]; then
|
||||
# TODO: 20th century support
|
||||
[[ ! "$_arg_year" =~ ^20[0-9][0-9]$ ]] \
|
||||
&& lib_utils::die_usage "$_usage" \
|
||||
|| declare -gr global_arg_year="$_arg_year"
|
||||
else
|
||||
global_arg_year="$(date +%Y)"
|
||||
declare -gr global_arg_year
|
||||
fi
|
||||
}
|
||||
|
||||
function lib_ledger::__ledger-import()
|
||||
{
|
||||
lib_ledger::__parse_ledger-import "$@"
|
||||
|
||||
time hledger-flow import \
|
||||
"$(dirname $global_child_profile_journal)" \
|
||||
--start-year "$global_arg_year"
|
||||
}
|
||||
|
||||
function lib_ledger::__ledger-cli()
|
||||
{
|
||||
[ -z "${global_base_args[*]}" ] && lib_utils::die_fatal
|
||||
|
||||
hledger "${global_base_args[@]}" "$@"
|
||||
}
|
||||
|
||||
function lib_ledger::__ledger-ui()
|
||||
{
|
||||
[ -z "${global_base_args[*]}" ] && lib_utils::die_fatal
|
||||
|
||||
hledger-ui "${global_base_args[@]}" "$@"
|
||||
}
|
||||
|
||||
function lib_ledger::__ledger-vui()
|
||||
{
|
||||
[ -z "${global_base_args[*]}" ] && lib_utils::die_fatal
|
||||
|
||||
hledger "${global_base_args[@]}" print -O csv "$@" \
|
||||
| visidata --motd-url file:///dev/null --filetype csv
|
||||
}
|
||||
|
||||
function lib_ledger::__ledger-web()
|
||||
{
|
||||
[ -z "${global_base_args[*]}" ] && lib_utils::die_fatal
|
||||
|
||||
hledger-web "${global_base_args[@]}" "$@"
|
||||
}
|
||||
|
||||
# vim: sw=2 sts=2 si ai et
|
||||
Reference in New Issue
Block a user