mirror/ioccc
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

rename .inventory.html -> inventory.html

Browse Source 
Due to GitHub not serving nor rendering HTML files whose filename
starts with "." (dot), we renamed `.inventory.html` to `inventory.html`.

Renamed: `tmp/gen_dot_winner.sh` -> `tmp/gen_winner_json.sh`
Fixed URL generation for GitHub links in `inventory.html`.

The manifest was updated accordingly.

The `tmp/README.md` file was updated accordingly.
This commit is contained in:
Landon Curt Noll committed 2023-11-06 02:23:30 -08:00
1 parent 8968dd92c4
commit e00d20111d
654 files changed
+15003 -8605
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

tmp/README.md
+3 -3
View File
@@ -372,9 +372,9 @@ rm -rf ../author ; ./gen_author_json.sh author_handle.txt author.csv author_win
```
### [gen_dot_winner.sh](gen_dot_winner.sh)
### [gen_winner_json.sh](gen_winner_json.sh)
Generate a `.winner.json` and `.inventory.html' for a given winner.
Generate a `.winner.json` and `inventory.html' for a given winner.
### [gen_path_list.found.sh](gen_path_list.found.sh)
@@ -578,7 +578,7 @@ Examples:
```sh
./run_all.sh -v 3 ./fake.gen_index.sh
./run_all.sh -v 1 ./gen_dot_winner.sh
./run_all.sh -v 1 ./gen_winner_json.sh
```
tmp/example.dot_winner.json
+1 -1
View File
@@ -122,7 +122,7 @@
"winners_text" : "download winning source"
},
{
"file_path" : ".inventory.html",
"file_path" : "inventory.html",
"winners_rank" : 900,
"created_by" : "winner2nventory",
"prog" : "orig",
tmp/gen_dot_winner.sh → tmp/gen_winner_json.sh
+46 -33
View File
@@ -1,6 +1,6 @@
#!/usr/bin/env bash
#
# gen_dot_winner.sh - generate .winner.json and .inventory.html for a winner
# gen_winner_json.sh - generate .winner.json and inventory.html for a winner
#
# XXX - This is a temporary utility that will be replaced when
# the .winner.json files are built
@@ -31,11 +31,11 @@
# setup
#
export VERSION="1.0.1 2023-11-06"
export VERSION="1.0.2 2023-11-06"
NAME=$(basename "$0"); export NAME
export DOT_WINNER_JSON_BASENAME=".winner.json"
export DOT_INVENTORY_MD_BASENAME=".inventory.md"
export DOT_INVENTORY_HTML_BASENAME=".inventory.html"
export INVENTORY_HTML_BASENAME="inventory.html"
export WINNER_JSON_FORMAT_VERSION="0.5 2023-11-04"
export NO_COMMENT="mandatory comment: because comments were removed from the original JSON spec"
export AUTHOR_WINS_CSV="author_wins.csv"
@@ -145,16 +145,16 @@ esac
export FULL_WINNER_PATH="$TOPDIR/$WINNER_PATH"
export WINNER_ID="${YEAR}_${WINNER}"
# form full DOT_INVENTORY_HTML_URL
# form full INVENTORY_HTML_URL
#
export URL_PATH="https://$DOMAIN$DOCPATH/$YEAR/$WINNER"
export DOT_INVENTORY_HTML_URL="$URL_PATH/$DOT_INVENTORY_HTML_BASENAME"
export INVENTORY_HTML_URL="$URL_PATH/$INVENTORY_HTML_BASENAME"
export GITHUB_URL_PATH="$GITHUB_REPO/$YEAR/$WINNER"
export GITHUB_URL="$GITHUB_URL_PATH/$DOT_INVENTORY_HTML_BASENAME"
export GITHUB_URL="$GITHUB_URL_PATH/$INVENTORY_HTML_BASENAME"
# form Nu Html Checker doc url string
#
VALIDATOR_ENCODED_URL=$(echo "$DOT_INVENTORY_HTML_URL" | sed -e 's;/;%2F;g' -e 's;:;%3A;')
VALIDATOR_ENCODED_URL=$(echo "$INVENTORY_HTML_URL" | sed -e 's;/;%2F;g' -e 's;:;%3A;')
export VALIDATOR_ENCODED_URL
# setup temporary files
@@ -162,9 +162,9 @@ export VALIDATOR_ENCODED_URL
export WINNER_JSON_PATH="$FULL_WINNER_PATH/$DOT_WINNER_JSON_BASENAME"
export TMP_DOT_WINNER_JSON="$FULL_WINNER_PATH/tmp.$$.$DOT_WINNER_JSON_BASENAME"
export TMP_DOT_INVENTORY_MD="$FULL_WINNER_PATH/tmp.$$.$DOT_INVENTORY_MD_BASENAME"
export DOT_INVENTORY_HTML_PATH="$FULL_WINNER_PATH/$DOT_INVENTORY_HTML_BASENAME"
export TMP_DOT_INVENTORY_HTML="$FULL_WINNER_PATH/tmp.$$.$DOT_INVENTORY_HTML_BASENAME"
trap 'rm -f $TMP_DOT_WINNER_JSON $TMP_DOT_INVENTORY_MD $TMP_DOT_INVENTORY_HTML' 0 1 2 3 15
export INVENTORY_HTML_PATH="$FULL_WINNER_PATH/$INVENTORY_HTML_BASENAME"
export TMP_INVENTORY_HTML="$FULL_WINNER_PATH/tmp.$$.$INVENTORY_HTML_BASENAME"
trap 'rm -f $TMP_DOT_WINNER_JSON $TMP_DOT_INVENTORY_MD $TMP_INVENTORY_HTML' 0 1 2 3 15
# print running info if verbose
#
@@ -191,15 +191,15 @@ if [[ $V_FLAG -ge 5 ]]; then
echo "$0: debug[5]: WINNER_PATH=$WINNER_PATH" 1>&2
echo "$0: debug[5]: URL_PATH=$URL_PATH" 1>&2
echo "$0: debug[5]: DOT_INVENTORY_MD_BASENAME=$DOT_INVENTORY_MD_BASENAME" 1>&2
echo "$0: debug[5]: DOT_INVENTORY_HTML_BASENAME=$DOT_INVENTORY_HTML_BASENAME" 1>&2
echo "$0: debug[5]: DOT_INVENTORY_HTML_URL=$DOT_INVENTORY_HTML_URL" 1>&2
echo "$0: debug[5]: INVENTORY_HTML_BASENAME=$INVENTORY_HTML_BASENAME" 1>&2
echo "$0: debug[5]: INVENTORY_HTML_URL=$INVENTORY_HTML_URL" 1>&2
echo "$0: debug[5]: VALIDATOR_ENCODED_URL=$VALIDATOR_ENCODED_URL" 1>&2
echo "$0: debug[5]: DOT_WINNER_JSON_BASENAME=$DOT_WINNER_JSON_BASENAME" 1>&2
echo "$0: debug[5]: WINNER_JSON_PATH=$WINNER_JSON_PATH" 1>&2
echo "$0: debug[5]: TMP_DOT_WINNER_JSON=$TMP_DOT_WINNER_JSON" 1>&2
echo "$0: debug[5]: DOT_INVENTORY_HTML_PATH=$DOT_INVENTORY_HTML_PATH" 1>&2
echo "$0: debug[5]: INVENTORY_HTML_PATH=$INVENTORY_HTML_PATH" 1>&2
echo "$0: debug[5]: TMP_DOT_INVENTORY_MD=$TMP_DOT_INVENTORY_MD" 1>&2
echo "$0: debug[5]: TMP_DOT_INVENTORY_HTML=$TMP_DOT_INVENTORY_HTML" 1>&2
echo "$0: debug[5]: TMP_INVENTORY_HTML=$TMP_INVENTORY_HTML" 1>&2
fi
# make is easier to process CSV files
@@ -654,16 +654,16 @@ if [[ $V_FLAG -ge 7 ]]; then
echo "$0: debug[7]: end of TMP_DOT_INVENTORY_MD above: $TMP_DOT_INVENTORY_MD" 1>&2
fi
# convert .inventory.md to .inventory.html
# convert .inventory.md to inventory.html
#
if [[ $V_FLAG -ge 5 ]]; then
echo "$0: debug[5]:" \
"$PANDOC" -f markdown -t html -o "$TMP_DOT_INVENTORY_HTML" \
"$PANDOC" -f markdown -t html -o "$TMP_INVENTORY_HTML" \
--fail-if-warnings=true --metadata title="File inventory of $YEAR/$WINNER" --standalone \
--metadata maxwidth="48em" \
"$TMP_DOT_INVENTORY_MD"
fi
"$PANDOC" -f markdown -t html -o "$TMP_DOT_INVENTORY_HTML" \
"$PANDOC" -f markdown -t html -o "$TMP_INVENTORY_HTML" \
--fail-if-warnings=true --metadata title="$YEAR/$WINNER Inventory" --standalone \
--metadata maxwidth="48em" \
"$TMP_DOT_INVENTORY_MD"
@@ -672,17 +672,30 @@ if [[ $status -ne 0 ]]; then
echo "$0: ERROR: pandoc: $PANDOC failed, exit code: $status" 1>&2
exit 51
fi
if [[ ! -s "$TMP_DOT_INVENTORY_HTML" ]]; then
echo "$0: ERROR: pandoc: $PANDOC produced an empty file: $TMP_DOT_INVENTORY_HTML" 1>&2
if [[ ! -s "$TMP_INVENTORY_HTML" ]]; then
echo "$0: ERROR: pandoc: $PANDOC produced an empty file: $TMP_INVENTORY_HTML" 1>&2
exit 52
fi
if [[ $V_FLAG -ge 7 ]]; then
echo "$0: debug[7]: start of DOT_INVENTORY_HTML_PATH below: $TMP_DOT_INVENTORY_HTML" 1>&2
cat "$TMP_DOT_INVENTORY_HTML" 1>&2
echo "$0: debug[7]: end of DOT_INVENTORY_HTML_PATH above: $TMP_DOT_INVENTORY_HTML" 1>&2
fi
rm -f "$TMP_DOT_INVENTORY_MD"
# inject DO NOT EDIT comments below the 1st DOCTYPE line in inventory.html
#
# XXX - We believe there is a way, via pandoc, to do this - XXX
# XXX - For now, we will use perl, but later lets use pandoc - XXX
#
HTML_DOCTYPE='<!DOCTYPE html>\n'
HTML_COM_1='<!-- -->\n'
HTML_COM_2='<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->\n'
HTML_COM_3='<!-- !!! DO NOT MODIFY THIS FILE - This file is generated by a tool !!! -->\n'
HTML_COM_4='<!-- file: created by: '"$NAME"' version: '"$VERSION"' -->\n'
HTML_COM="$HTML_COM_1$HTML_COM_2$HTML_COM_3$HTML_COM_3$HTML_COM_3$HTML_COM_2$HTML_COM_1$HTML_COM_4$HTML_COM_1"
perl -0777 -p -i -e "s/$HTML_DOCTYPE/$HTML_DOCTYPE$HTML_COM/" "$TMP_INVENTORY_HTML"
if [[ $V_FLAG -ge 7 ]]; then
echo "$0: debug[7]: start of INVENTORY_HTML_PATH below: $TMP_INVENTORY_HTML" 1>&2
cat "$TMP_INVENTORY_HTML" 1>&2
echo "$0: debug[7]: end of INVENTORY_HTML_PATH above: $TMP_INVENTORY_HTML" 1>&2
fi
# update .winner.json if needed
#
if ! cmp -s "$TMP_DOT_WINNER_JSON" "$WINNER_JSON_PATH"; then
@@ -715,24 +728,24 @@ else
fi
fi
# update .inventory.html if needed
# update inventory.html if needed
#
if ! cmp -s "$TMP_DOT_INVENTORY_HTML" "$DOT_INVENTORY_HTML_PATH"; then
if ! cmp -s "$TMP_INVENTORY_HTML" "$INVENTORY_HTML_PATH"; then
# replace index.html file
#
if [[ $V_FLAG -ge 1 ]]; then
echo "$0: debug[1]: updating $DOT_INVENTORY_HTML_PATH"
echo "$0: debug[1]: updating $INVENTORY_HTML_PATH"
fi
if [[ $V_FLAG -ge 3 ]]; then
mv -f -v "$TMP_DOT_INVENTORY_HTML" "$DOT_INVENTORY_HTML_PATH"
mv -f -v "$TMP_INVENTORY_HTML" "$INVENTORY_HTML_PATH"
status="$?"
else
mv -f "$TMP_DOT_INVENTORY_HTML" "$DOT_INVENTORY_HTML_PATH"
mv -f "$TMP_INVENTORY_HTML" "$INVENTORY_HTML_PATH"
status="$?"
fi
if [[ $status -ne 0 ]]; then
echo "$0: ERROR: mv -f -v $TMP_DOT_INVENTORY_HTML $DOT_INVENTORY_HTML_PATH failed, error: $status" 1>&2
echo "$0: ERROR: mv -f -v $TMP_INVENTORY_HTML $INVENTORY_HTML_PATH failed, error: $status" 1>&2
exit 102
fi
@@ -740,9 +753,9 @@ else
# index.html is OK, remove the tmp file
#
rm -f "$TMP_DOT_INVENTORY_HTML"
if [[ -e $TMP_DOT_INVENTORY_HTML ]]; then
echo "$0: ERROR: TMP_DOT_INVENTORY_HTML cannot be removed for cleanup: $TMP_DOT_INVENTORY_HTML" 1>&2
rm -f "$TMP_INVENTORY_HTML"
if [[ -e $TMP_INVENTORY_HTML ]]; then
echo "$0: ERROR: TMP_INVENTORY_HTML cannot be removed for cleanup: $TMP_INVENTORY_HTML" 1>&2
exit 103
fi
fi
tmp/manifest.csv
+321 -321
View File
File diff suppressed because it is too large. Load diff
tmp/manifest.numbers
BIN
View File
Binary file not shown.
tmp/path_list.built.txt
+321 -321
View File
File diff suppressed because it is too large. Load diff
tmp/path_list.found.txt
+321 -321
View File
File diff suppressed because it is too large. Load diff
tmp/path_list.manifest.txt
+321 -321
View File
File diff suppressed because it is too large. Load diff