From 1079f927a27db9d194c8e25eb3a188396fdf8eab Mon Sep 17 00:00:00 2001
From: Paul Buetow <git@mx.buetow.org>
Date: Mon, 17 May 2021 21:02:55 +0100
Subject: refactor code

---
 packages/assert.source.sh   |  30 +++++++++
 packages/atomfeed.source.sh | 118 +++++++++++++++++++++++++++++++++++
 packages/gemfeed.source.sh  |  51 ++++++++++++++++
 packages/generate.source.sh | 128 ++++++++++++++++++++++++++++++++++++++
 packages/html.source.sh     | 145 ++++++++++++++++++++++++++++++++++++++++++++
 packages/log.source.sh      |  26 ++++++++
 packages/md.source.sh       |  55 +++++++++++++++++
 7 files changed, 553 insertions(+)
 create mode 100644 packages/assert.source.sh
 create mode 100644 packages/atomfeed.source.sh
 create mode 100644 packages/gemfeed.source.sh
 create mode 100644 packages/generate.source.sh
 create mode 100644 packages/html.source.sh
 create mode 100644 packages/log.source.sh
 create mode 100644 packages/md.source.sh

(limited to 'packages')

diff --git a/packages/assert.source.sh b/packages/assert.source.sh
new file mode 100644
index 00000000..551d1623
--- /dev/null
+++ b/packages/assert.source.sh
@@ -0,0 +1,30 @@
+assert::equals () {
+    local -r result="$1"; shift
+    local -r expected="$1"; shift
+    local -r callee=${FUNCNAME[1]}
+
+    if [[ "$result" != "$expected" ]]; then
+        cat <<ERROR | log::pipe ERROR
+In $callee expected
+    '$expected'
+But got
+    '$result'
+ERROR
+        exit 2
+    fi
+
+    log VERBOSE "Result in $callee as expected: '$expected'"
+}
+
+assert::not_empty () {
+    local -r name="$1"; shift
+    local -r content="$1"; shift
+    local -r callee=${FUNCNAME[1]}
+
+    if [ -z "$content" ]; then
+        log ERROR "In $callee expected '$name' not to be empty!"
+        exit 2
+    fi
+
+    log VERBOSE "Result in $callee as expected not empty"
+}
diff --git a/packages/atomfeed.source.sh b/packages/atomfeed.source.sh
new file mode 100644
index 00000000..feb074a8
--- /dev/null
+++ b/packages/atomfeed.source.sh
@@ -0,0 +1,118 @@
+atomfeed::meta () {
+    local -r gmi_file_path="$1"; shift
+    local -r meta_file=$($SED 's|gemtext|meta|; s|.gmi$|.meta|;' <<< "$gmi_file_path")
+
+    log VERBOSE "Generating meta info for post $gmi_file_path"
+
+    local is_draft=no
+    if grep -E -q '\.draft\.meta$' <<< "$meta_file"; then
+        is_draft=yes
+    fi
+
+    local -r meta_dir=$(dirname "$meta_file")
+    test ! -d "$meta_dir" && mkdir -p "$meta_dir"
+
+    if [ ! -f "$meta_file" ]; then
+        # Extract first heading as post title.
+        local title=$($SED -n '/^# / { s/# //; p; q; }' "$gmi_file_path" | tr '"' "'")
+        # Extract first paragraph from Gemtext
+        local summary=$($SED -n '/^[A-Z]/ { p; q; }' "$gmi_file_path" | tr '"' "'")
+        # Extract the date from the file name.
+        local filename_date=$(basename "$gmi_file_path" | cut -d- -f1,2,3)
+        local date=$($DATE --iso-8601=seconds --date "$filename_date $($DATE +%H:%M:%S)")
+
+        cat <<META | tee "$meta_file"
+local meta_date="$date"
+local meta_author="$AUTHOR"
+local meta_email="$EMAIL"
+local meta_title="$title"
+local meta_summary="$summary. .....to read on please visit my site."
+META
+        test $is_draft == no && git add "$meta_file"
+        return
+    fi
+
+    cat "$meta_file"
+    test $is_draft == yes && rm "$meta_file"
+}
+
+atomfeed::content () {
+    local -r gmi_file_path="$1"; shift
+    log VERBOSE "Retrieving feed content from $gmi_file_path"
+
+    # sed: Remove all before the first header
+    # sed: Make HTML links absolute, Atom relative URLs feature seems a mess
+    # across different Atom clients.
+    html::fromgmi < <($SED '/Go back to the main site/d' "$gmi_file_path") |
+    $SED "
+        s|href=\"\./|href=\"https://$DOMAIN/gemfeed/|g;
+        s|src=\"\./|src=\"https://$DOMAIN/gemfeed/|g;
+    "
+}
+
+atomfeed::generate () {
+    local -r gemfeed_dir="$CONTENT_DIR/gemtext/gemfeed"
+    local -r atom_file="$gemfeed_dir/atom.xml"
+    local -r now=$($DATE --iso-8601=seconds)
+    log INFO "Generating Atom feed to $atom_file"
+
+    assert::not_empty now "$now"
+
+    cat <<ATOMHEADER > "$atom_file.tmp"
+<?xml version="1.0" encoding="utf-8"?>
+<feed xmlns="http://www.w3.org/2005/Atom">
+    <updated>$now</updated>
+    <title>$DOMAIN feed</title>
+    <subtitle>$SUBTITLE</subtitle>
+    <link href="gemini://$DOMAIN/gemfeed/atom.xml" rel="self" />
+    <link href="gemini://$DOMAIN/" />
+    <id>gemini://$DOMAIN/</id>
+ATOMHEADER
+
+    while read -r gmi_file; do
+        # Load cached meta information about the post.
+        source <(atomfeed::meta "$gemfeed_dir/$gmi_file")
+        # Get HTML content for the feed
+        local content="$(atomfeed::content "$gemfeed_dir/$gmi_file")"
+
+        assert::not_empty meta_title "$meta_title"
+        assert::not_empty meta_date "$meta_date"
+        assert::not_empty meta_author "$meta_author"
+        assert::not_empty meta_email "$meta_email"
+        assert::not_empty meta_summary "$meta_summary"
+        assert::not_empty content "$content"
+
+        cat <<ATOMENTRY >> "$atom_file.tmp"
+    <entry>
+        <title>$meta_title</title>
+        <link href="gemini://$DOMAIN/gemfeed/$gmi_file" />
+        <id>gemini://$DOMAIN/gemfeed/$gmi_file</id>
+        <updated>$meta_date</updated>
+        <author>
+            <name>$meta_author</name>
+            <email>$meta_email</email>
+        </author>
+        <summary>$meta_summary</summary>
+        <content type="xhtml">
+            <div xmlns="http://www.w3.org/1999/xhtml">
+                $content
+            </div>
+        </content>
+    </entry>
+ATOMENTRY
+    done < <(gemfeed::get_posts | head -n $ATOM_MAX_ENTRIES)
+
+    cat <<ATOMFOOTER >> "$atom_file.tmp"
+</feed>
+ATOMFOOTER
+
+    # Delete the 3rd line of the atom feeds (global feed update timestamp)
+    if ! diff -u <($SED 3d "$atom_file") <($SED 3d "$atom_file.tmp"); then
+        log INFO 'Feed got something new!'
+        mv "$atom_file.tmp" "$atom_file"
+        test "$ADD_GIT" == yes && git add "$atom_file"
+    else
+        log INFO 'Nothing really new in the feed'
+        rm "$atom_file.tmp"
+    fi
+}
diff --git a/packages/gemfeed.source.sh b/packages/gemfeed.source.sh
new file mode 100644
index 00000000..c68c5070
--- /dev/null
+++ b/packages/gemfeed.source.sh
@@ -0,0 +1,51 @@
+# Filters out blog posts from other files in the gemfeed dir.
+gemfeed::get_posts () {
+    local -r gemfeed_dir="$CONTENT_DIR/gemtext/gemfeed"
+    local -r gmi_pattern='^[0-9]{4}-[0-9]{2}-[0-9]{2}-.*\.gmi$'
+    local -r draft_pattern='\.draft\.gmi$'
+
+    ls "$gemfeed_dir" | grep -E "$gmi_pattern" | grep -E -v "$draft_pattern" | sort -r
+}
+
+# Adds the links from gemfeed/index.gmi to the main index site.
+gemfeed::updatemainindex () {
+    local -r index_gmi="$CONTENT_DIR/gemtext/index.gmi"
+    local -r gemfeed_dir="$CONTENT_DIR/gemtext/gemfeed"
+
+    log VERBOSE "Updating $index_gmi with posts from $gemfeed_dir"
+
+    # Remove old gemfeeds from main index
+    $SED '/^=> .\/gemfeed\/[0-9].* - .*/d;' "$index_gmi" > "$index_gmi.tmp"
+    # Add current gemfeeds to main index
+    $SED -n '/^=> / { s| ./| ./gemfeed/|; p; }' "$gemfeed_dir/index.gmi" >> "$index_gmi.tmp"
+
+    mv "$index_gmi.tmp" "$index_gmi"
+    test "$ADD_GIT" == yes && git add "$index_gmi"
+}
+
+# This generates a index.gmi in the ./gemfeed subdir.
+gemfeed::generate () {
+    local -r gemfeed_dir="$CONTENT_DIR/gemtext/gemfeed"
+    log INFO "Generating Gemfeed index for $gemfeed_dir"
+
+cat <<GEMFEED > "$gemfeed_dir/index.gmi.tmp"
+# $DOMAIN's Gemfeed
+
+## $SUBTITLE
+
+GEMFEED
+
+    gemfeed::get_posts | while read -r gmi_file; do
+        # Extract first heading as post title.
+        local title=$($SED -n '/^# / { s/# //; p; q; }' "$gemfeed_dir/$gmi_file" | tr '"' "'")
+        # Extract the date from the file name.
+        local filename_date=$(basename "$gemfeed_dir/$gmi_file" | cut -d- -f1,2,3)
+
+        echo "=> ./$gmi_file $filename_date - $title" >> "$gemfeed_dir/index.gmi.tmp"
+    done
+
+    mv "$gemfeed_dir/index.gmi.tmp" "$gemfeed_dir/index.gmi"
+    test "$ADD_GIT" == yes && git add "$gemfeed_dir/index.gmi"
+
+    gemfeed::updatemainindex
+}
diff --git a/packages/generate.source.sh b/packages/generate.source.sh
new file mode 100644
index 00000000..0f07af56
--- /dev/null
+++ b/packages/generate.source.sh
@@ -0,0 +1,128 @@
+generate::make_link () {
+    local -r what="$1"; shift
+    local -r line="${1/=> }"; shift
+    local link
+    local descr
+
+    while read -r token; do
+        if [ -z "$link" ]; then
+            link="$token"
+        elif [ -z "$descr" ]; then
+            descr="$token"
+        else
+            descr="$descr $token"
+        fi
+    done < <(echo "$line" | tr ' ' '\n')
+
+    if grep -E -q "$IMAGE_PATTERN" <<< "$link"; then
+        if [[ "$what" == md ]]; then
+            md::make_img "$link" "$descr"
+        else
+            html::make_img "$link" "$(html::special "$descr")"
+        fi
+        return
+    fi
+
+    if [[ "$what" == md ]]; then
+        md::make_link "$link" "$descr"
+    else
+        html::make_link "$link" "$(html::special "$descr")"
+    fi
+}
+
+generate::fromgmi_ () {
+    local -r src="$1"; shift
+    local -r format="$1"; shift
+    local dest=${src/gemtext/$format}
+    dest=${dest/.gmi/.$format}
+    local dest_dir=$(dirname "$dest")
+
+    test ! -d "$dest_dir" && mkdir -p "$dest_dir"
+    if [[ "$format" == html ]]; then
+        cat header.html.part > "$dest.tmp"
+        html::fromgmi < "$src" >> "$dest.tmp"
+        cat footer.html.part >> "$dest.tmp"
+    elif [[ "$format" == md ]]; then
+        md::fromgmi < "$src" >> "$dest.tmp"
+    fi
+
+    mv "$dest.tmp" "$dest"
+    test "$ADD_GIT" == yes && git add "$dest"
+}
+
+generate::fromgmi_add_docs () {
+    local -r src="$1"; shift
+    local -r format="$1"; shift
+    local -r dest=${src/gemtext/$format}
+    local -r dest_dir=$(dirname "$dest")
+
+    test ! -d "$dest_dir" && mkdir -p "$dest_dir"
+    cp "$src" "$dest"
+    test "$ADD_GIT" == yes && git add "$dest"
+}
+
+generate::convert_gmi_atom_to_html_atom () {
+    local -r format="$1"; shift
+    test "$format" != html && return
+
+    log INFO 'Converting Gemtext Atom feed to HTML Atom feed'
+
+    $SED 's|.gmi|.html|g; s|gemini://|https://|g' \
+        < $CONTENT_DIR/gemtext/gemfeed/atom.xml \
+        > $CONTENT_DIR/html/gemfeed/atom.xml
+
+    test "$ADD_GIT" == yes && git add "$CONTENT_DIR/html/gemfeed/atom.xml"
+}
+
+generate::fromgmi_cleanup () {
+    local -r src="$1"; shift
+    local -r format="$1"; shift
+    local dest=${src/.$format/.gmi}
+    dest=${dest/$format/gemtext}
+
+    test ! -f "$dest" && test "$ADD_GIT" == yes && git rm "$src"
+}
+
+generate::fromgmi () {
+    local -i num_gmi_files=0
+    local -i num_doc_files=0
+
+    log INFO "Generating $* from Gemtext"
+
+    while read -r src; do
+        (( num_gmi_files++ ))
+        for format in "$@"; do
+            generate::fromgmi_ "$src" "$format"
+        done
+    done < <(find "$CONTENT_DIR/gemtext" -type f -name \*.gmi)
+
+    log INFO "Converted $num_gmi_files Gemtext files"
+
+    # Add non-.gmi files to html dir.
+    log VERBOSE "Adding other docs to $*"
+
+    while read -r src; do
+        (( num_doc_files++ ))
+        for format in "$@"; do
+            generate::fromgmi_add_docs "$src" "$format"
+        done
+    done < <(find "$CONTENT_DIR/gemtext" -type f | grep -E -v '(.gmi|atom.xml|.tmp)$')
+
+    log INFO "Added $num_doc_files other documents to each of $*"
+
+    # Add atom feed for HTML
+    for format in "$@"; do
+        generate::convert_gmi_atom_to_html_atom "$format"
+    done
+
+    # Remove obsolete files from ./html/
+    for format in "$@"; do
+        find "$CONTENT_DIR/$format" -type f | while read -r src; do
+            generate::fromgmi_cleanup "$src" "$format"
+        done
+    done
+
+    for format in "$@"; do
+        log INFO "$format can be found in $CONTENT_DIR/$format now"
+    done
+}
diff --git a/packages/html.source.sh b/packages/html.source.sh
new file mode 100644
index 00000000..d8d2fc66
--- /dev/null
+++ b/packages/html.source.sh
@@ -0,0 +1,145 @@
+html::special () {
+    $SED '
+        s|\&|\&amp;|g;
+        s|<|\&lt;|g;
+        s|>|\&gt;|g;
+    ' <<< "$@"
+}
+
+html::make_paragraph () {
+    local -r text="$1"; shift
+    test -n "$text" && echo "<p>$(html::special "$text")</p>"
+}
+
+html::make_heading () {
+    local -r text=$($SED -E 's/^#+ //' <<< "$1"); shift
+    local -r level="$1"; shift
+    echo "<h${level}>$(html::special "$text")</h${level}>"
+}
+
+html::make_quote () {
+    local -r quote="${1/> }"
+    echo "<p class=\"quote\"><i>$(html::special "$quote")</i></p>"
+}
+
+html::make_img () {
+    local link="$1"; shift
+    local descr="$1"; shift
+
+    if [ -z "$descr" ]; then
+        echo -n "<a href=\"$link\"><img src=\"$link\" /></a>"
+    else
+        echo -n "<i>$descr:</i>"
+        echo -n "<a href=\"$link\"><img alt=\"$descr\" title=\"$descr\" src=\"$link\" /></a>"
+    fi
+
+    echo "<br />"
+}
+
+html::make_link () {
+    local link="$1"; shift
+    local descr="$1"; shift
+
+    grep -F -q '://' <<< "$link" || link=${link/.gmi/.html}
+    test -z "$descr" && descr="$link"
+    echo "<a class=\"textlink\" href=\"$link\">$descr</a><br />"
+}
+
+html::fromgmi () {
+    local is_list=no
+    local is_plain=no
+
+    while IFS='' read -r line; do
+        if [[ "$is_list" == yes ]]; then
+            if [[ "$line" == '* '* ]]; then
+                echo "<li>$(html::special "${line/\* /}")</li>"
+            else
+                is_list=no
+                echo "</ul>"
+            fi
+            continue
+
+        elif [[ "$is_plain" == yes ]]; then
+            if [[ "$line" == '```'* ]]; then
+                echo "</pre>"
+                is_plain=no
+            else
+                html::special "$line"
+            fi
+            continue
+        fi
+
+        case "$line" in
+            '* '*)
+                is_list=yes
+                echo "<ul>"
+                echo "<li>${line/\* /}</li>"
+                ;;
+            '```'*)
+                is_plain=yes
+                echo "<pre>"
+                ;;
+            '# '*)
+                html::make_heading "$line" 1
+                ;;
+            '## '*)
+                html::make_heading "$line" 2
+                ;;
+            '### '*)
+                html::make_heading "$line" 3
+                ;;
+            '> '*)
+                html::make_quote "$line"
+                ;;
+            '=> '*)
+                generate::make_link html "$line"
+                ;;
+            *)
+                html::make_paragraph "$line"
+                ;;
+        esac
+    done
+}
+
+html::test () {
+    local line='Hello world! This is a paragraph.'
+    assert::equals "$(html::make_paragraph "$line")" '<p>Hello world! This is a paragraph.</p>'
+
+    line=''
+    assert::equals "$(html::make_paragraph "$line")" ''
+
+    line='Foo &<>& Bar!'
+    assert::equals "$(html::make_paragraph "$line")" '<p>Foo &amp;&lt;&gt;&amp; Bar!</p>'
+
+    line='# Header 1'
+    assert::equals "$(html::make_heading "$line" 1)" '<h1>Header 1</h1>'
+
+    line='## Header 2'
+    assert::equals "$(html::make_heading "$line" 2)" '<h2>Header 2</h2>'
+
+    line='### Header 3'
+    assert::equals "$(html::make_heading "$line" 3)" '<h3>Header 3</h3>'
+
+    line='> This is a quote'
+    assert::equals "$(html::make_quote "$line")" '<p class="quote"><i>This is a quote</i></p>'
+
+    line='=> https://example.org'
+    assert::equals "$(generate::make_link html "$line")" \
+        '<a class="textlink" href="https://example.org">https://example.org</a><br />'
+
+    line='=> index.gmi'
+    assert::equals "$(generate::make_link html "$line")" \
+        '<a class="textlink" href="index.html">index.html</a><br />'
+
+    line='=> http://example.org Description of the link'
+    assert::equals "$(generate::make_link html "$line")" \
+        '<a class="textlink" href="http://example.org">Description of the link</a><br />'
+
+    line='=> http://example.org/image.png'
+    assert::equals "$(generate::make_link html "$line")" \
+        '<a href="http://example.org/image.png"><img src="http://example.org/image.png" /></a><br />'
+
+    line='=> http://example.org/image.png Image description'
+    assert::equals "$(generate::make_link html "$line")" \
+        '<i>Image description:</i><a href="http://example.org/image.png"><img alt="Image description" title="Image description" src="http://example.org/image.png" /></a><br />'
+}
diff --git a/packages/log.source.sh b/packages/log.source.sh
new file mode 100644
index 00000000..55d693ec
--- /dev/null
+++ b/packages/log.source.sh
@@ -0,0 +1,26 @@
+log () {
+    local -r level="$1"; shift
+
+    for message in "$@"; do
+        echo "$message"
+    done | log::_pipe "$level"
+}
+
+log::pipe () {
+    log::_pipe "$1"
+}
+
+log::_pipe () {
+    local -r level="$1"; shift
+
+    if [[ "$level" == VERBOSE && -z "$LOG_VERBOSE" ]]; then
+        return
+    fi
+
+    local -r callee=${FUNCNAME[2]}
+    local -r stamp=$($DATE +%Y%m%d-%H%M%S)
+
+    while read -r line; do
+        echo "$level|$stamp|$callee|$line" >&2
+    done
+}
diff --git a/packages/md.source.sh b/packages/md.source.sh
new file mode 100644
index 00000000..197bdcf7
--- /dev/null
+++ b/packages/md.source.sh
@@ -0,0 +1,55 @@
+md::make_img () {
+    local link="$1"; shift
+    local descr="$1"; shift
+
+    if [ -z "$descr" ]; then
+        echo "[![$link]($link)]($link)  "
+    else
+        echo "[![$descr]($link \"$descr\")]($link)  "
+    fi
+}
+
+md::make_link () {
+    local link="$1"; shift
+    local descr="$1"; shift
+
+    grep -F -q '://' <<< "$link" || link=${link/.gmi/.md}
+    test -z "$descr" && descr="$link"
+
+    echo "[$descr]($link)  "
+}
+
+md::test () {
+    local line='=> https://example.org'
+    assert::equals "$(generate::make_link md "$line")" \
+        '[https://example.org](https://example.org)  '
+
+    line='=> index.md'
+    assert::equals "$(generate::make_link md "$line")" \
+        '[index.md](index.md)  '
+
+    line='=> http://example.org Description of the link'
+    assert::equals "$(generate::make_link md "$line")" \
+        '[Description of the link](http://example.org)  '
+
+    line='=> http://example.org/image.png'
+    assert::equals "$(generate::make_link md "$line")" \
+        '[![http://example.org/image.png](http://example.org/image.png)](http://example.org/image.png)  '
+
+    line='=> http://example.org/image.png Image description'
+    assert::equals "$(generate::make_link md "$line")" \
+        '[![Image description](http://example.org/image.png "Image description")](http://example.org/image.png)  '
+}
+
+md::fromgmi () {
+    while IFS='' read -r line; do
+        case "$line" in
+            '=> '*)
+                generate::make_link md "$line"
+                ;;
+            *)
+                echo "$line"
+                ;;
+        esac
+    done
+}
-- 
cgit v1.2.3