kramdown-plantuml 1.0.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64b799c8bdeb80c21cc6cfd1b2001dc25eb4d1f2042e1b3ce8110e94b949ada3
-  data.tar.gz: 48a5f89a75af22f1d970d4e8cdf3b57db69d66c53e14fedeb9d7c38cd5469578
+  metadata.gz: 488e793ad6c95b20619319fdec43866b7a96369321767eb415c441b2d8946c0c
+  data.tar.gz: 2f9b7957b2b7d09ebe2758d1fc3f3600c7464f2ccee53d5ea11f04bf25b0df33
 SHA512:
-  metadata.gz: 6f2ec902c2e1ca5ec8d3628b92434fe6b914e2831b50b4932768d68463baa9a4924d281be2707101a4cc5f5991f452094687a4e23c190bf6984fab080294815b
-  data.tar.gz: 64d2907a02c2744af63286585ab1d9ef246bdc2df595631d6e7a2207e906d57fea8b3bde13b5eedac0b0d6a03cc43d66b5965489281e7b70de4a3ecec4a2849c
+  metadata.gz: 4e4547033622f876ea2c63eb4af2f73433e57fa4cbe8bdd818bbcb5261f4bef829f50da55b9f5485023e5c040d7c260844f27fcf2a67f17858839aa4e9f0dab3
+  data.tar.gz: cd38086b669bf27b64ccae97f45005a23a508fdfd94647e40c2f8e9960a89edc0abd2781c74fb42493c1b1df7bd5c0aaee6c19acd63cf20394d594c077cc072d

data/.github/codecov.yml

@@ -0,0 +1,2 @@
+ignore:
+  - "spec"

data/.github/dependabot.yml

@@ -0,0 +1,23 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "03:00"
+    timezone: Europe/Oslo
+  open-pull-requests-limit: 99
+- package-ecosystem: maven
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "03:00"
+    timezone: Europe/Oslo
+  open-pull-requests-limit: 99
+- package-ecosystem: github-actions
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "03:00"
+    timezone: Europe/Oslo
+  open-pull-requests-limit: 99

data/.github/mergify.yml

@@ -0,0 +1,22 @@
+pull_request_rules:
+  - name: Automatic approve on dependabot PR
+    conditions:
+      - author~=^dependabot(|-preview)\[bot\]$
+    actions:
+      review:
+        type: APPROVE
+
+  - name: Automatic merge on approval
+    conditions:
+      - author~=^dependabot(|-preview)\[bot\]$
+    actions:
+      merge:
+        method: merge
+        strict: smart
+
+  - name: Thank contributor
+    conditions:
+      - merged
+    actions:
+      comment:
+        message: "Thank you @{{author}} for your contribution!"

data/.github/scripts/amend.sh

@@ -0,0 +1,176 @@
+#!/bin/bash
+set -o errexit # Abort if any command fails
+me=$(basename "$0")
+
+help_message="\
+Usage: echo $me --user <username>
+
+Checks out the pull request where an '/amend' comment is made and amends its
+latest commit with the credentials of the user who wrote the '/amend' comment.
+
+Arguments:
+  -u, --user      The user name to use when authenticating against the remote
+                  Git repository.
+  -h, --help      Displays this help screen.
+  -v, --verbose   Increase verbosity. Useful for debugging.
+
+Environment Variables:
+  GITHUB_CONTEXT: An environment variable containing a JSON string of the GitHub
+                  context object. Typically generated with \${{ toJson(github) }}.
+  GITHUB_TOKEN:   The personal access token to use to authenticate against the
+                  remote Git repository."
+
+parse_args() {
+    while : ; do
+        if [[ $1 = "-h" || $1 = "--help" ]]; then
+            echo "$help_message"
+            return 0
+        elif [[ $1 = "-v" || $1 = "--verbose" ]]; then
+            verbose=true
+            shift
+        elif [[ ( $1 = "-u" || $1 = "--user" ) && -n $2 ]]; then
+            auth_user=$2
+            shift 2
+        else
+            break
+        fi
+    done
+}
+
+parse_github_context() {
+    github_context_json="$GITHUB_CONTEXT"
+
+    if [[ -z "$github_context_json" ]]; then
+        echo "Missing or empty GITHUB_CONTEXT environment variable." >&2
+        echo "$help_message"
+        exit 1
+    fi
+
+    if [[ -z "$GITHUB_TOKEN" ]]; then
+        echo "Missing or empty GITHUB_TOKEN environment variable." >&2
+        echo "$help_message"
+        exit 1
+    fi
+
+    if [[ -z "$auth_user" ]]; then
+        echo "Missing or empty 'auth_user' argument." >&2
+        echo "$help_message"
+        exit 1
+    fi
+
+    sha=$(echo "$github_context_json" | jq --raw-output .sha)
+    pr_url=$(echo "$github_context_json" | jq --raw-output .event.issue.pull_request.html_url)
+    sender_login=$(echo "$github_context_json" | jq --raw-output .event.sender.login)
+    sender_url=$(echo "$github_context_json" | jq --raw-output .event.sender.url)
+    repo_url=$(echo "$github_context_json" | jq --raw-output .event.repository.html_url)
+    repo_clone_url=$(echo "$github_context_json" | jq --raw-output .event.repository.clone_url)
+    collaborators_url=$(echo "$github_context_json" | jq --raw-output .event.repository.collaborators_url)
+
+    if [[ -z "$sha" ]]; then
+        echo "No 'sha' found in the GitHub context." >&2
+        echo "$help_message"
+        exit 1
+    fi
+
+    if [[ -z "$pr_url" ]]; then
+        echo "No 'event.issue.pull_request.html_url' found in the GitHub context." >&2
+        echo "$help_message"
+        exit 1
+    fi
+
+    if [[ -z "$sender_login" ]]; then
+        echo "No 'event.sender.login' found in the GitHub context." >&2
+        echo "$help_message"
+        exit 1
+    fi
+
+    if [[ -z "$sender_url" ]]; then
+        echo "No 'event.sender.url' found in the GitHub context." >&2
+        echo "$help_message"
+        exit 1
+    fi
+
+    if [[ -z "$repo_url" ]]; then
+        echo "No 'event.repository.html_url' found in the GitHub context." >&2
+        echo "$help_message"
+        exit 1
+    fi
+
+    if [[ -z "$repo_clone_url" ]]; then
+        echo "No 'event.repository.clone_url' found in the GitHub context." >&2
+        echo "$help_message"
+        exit 1
+    fi
+
+    if [[ -z "$collaborators_url" ]]; then
+        echo "No 'event.repository.collaborators_url' found in the GitHub context." >&2
+        echo "$help_message"
+        exit 1
+    fi
+
+    user_json=$(gh api -X GET "$sender_url")
+
+    if [[ -z "$user_json" ]]; then
+        echo "The request for '$sender_url' failed." >&2
+        echo "$help_message"
+        exit 1
+    fi
+
+    name=$(echo "$user_json" | jq --raw-output .name)
+    email=$(echo "$user_json" | jq --raw-output .email)
+
+    if [[ -z "$name" ]]; then
+        echo "No 'name' found in '$sender_url'." >&2
+        echo "$help_message"
+        exit 1
+    fi
+
+    if [[ -z "$email" ]]; then
+        echo "No 'email' found in '$sender_url'." >&2
+        echo "$help_message"
+        exit 1
+    fi
+
+    # Replace the template part of the URL with the sender_login (collaborator).
+    # https://api.github.com/repos/asbjornu/test/collaborators{/collaborator}
+    collaborator_url="${collaborators_url/\{\/collaborator\}//$sender_login}"
+
+    # Add sender_login and password to the repository clone URL
+    authenticated_repo_url="${repo_clone_url/github\.com/$auth_user:$GITHUB_TOKEN@github.com}"
+}
+
+# echo expanded commands as they are executed (for debugging)
+enable_expanded_output() {
+    if [ $verbose ]; then
+        set -o xtrace
+        set +o verbose
+    fi
+}
+
+amend() {
+    gh pr checkout "$pr_url"
+    gh pr comment --body "The commit $sha is being amended."
+    git config --global user.name "$name"
+    git config --global user.email "$email"
+    git remote set-url origin "$authenticated_repo_url"
+    git commit --amend --no-edit
+    git push --force
+}
+
+main() {
+    parse_args "$@"
+    enable_expanded_output
+    parse_github_context
+
+    # If the request for </repos/{owner}/{repo}/collaborators/{sender_login}>
+    # fails (404 not found), `gh` should return 1 and thus fail the entire
+    # script. For more information, see:
+    # https://docs.github.com/en/rest/reference/repos#check-if-a-user-is-a-repository-collaborator
+    if gh api -X GET "$collaborator_url" > /dev/null; then
+        amend
+    else
+        echo "'$sender_login' does not have access to the repository <$repo_url>."
+    fi
+}
+
+main "$@"

data/.github/scripts/build-gem.sh

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -o errexit # Abort if any command fails
+
+gem_build_name=$(gem build kramdown-plantuml.gemspec | awk '/File/ {print $2}')
+echo "Gem filename: '${gem_build_name}'"
+echo "::set-output name=name::${gem_build_name}"

data/.github/scripts/inspect-gem.sh

@@ -0,0 +1,72 @@
+#!/usr/bin/env bash
+set -e # Abort if any command fails
+me=$(basename "$0")
+
+help_message="\
+Usage:
+  $me --gem <gem> [--verbose]
+  $me --help
+Arguments:
+  -g, --gem <gem>   The path to the Gem file to inspect.
+  -h, --help        Displays this help screen.
+  -v, --verbose     Increase verbosity. Useful for debugging."
+
+parse_args() {
+    while : ; do
+        if [[ $1 = "-h" || $1 = "--help" ]]; then
+            echo "$help_message"
+            return 0
+        elif [[ $1 = "-v" || $1 = "--verbose" ]]; then
+            verbose=true
+            shift
+        elif [[ $1 = "-g" || $1 = "--gem" ]]; then
+            gem=$2
+            shift 2
+        else
+            break
+        fi
+    done
+
+    if [[ -z "$gem" ]]; then
+        echo "Missing required argument: --gem <gem>."
+        echo "$help_message"
+        return 1
+    fi
+}
+
+# Echo expanded commands as they are executed (for debugging)
+enable_expanded_output() {
+    if [ $verbose ]; then
+        echo "Verbose mode enabled."
+        set -o xtrace
+        set +o verbose
+    fi
+}
+
+inspect_gem() {
+    gem unpack "$gem"
+    gem_dir="${gem%.*}"
+
+    if [ $verbose ]; then
+        echo "Files in '$gem_dir':"
+        find "$gem_dir"
+    fi
+
+    if [[ ! -d "$gem_dir/bin" ]]; then
+        echo "ERROR! 'bin' folder missing from '$gem'."
+        return 1
+    fi
+
+    if ! (find "$gem_dir" -iname "plantuml*.jar" | grep -q .); then
+        echo "ERROR! 'plantuml.jar' missing from '$gem'."
+        return 1
+    fi
+}
+
+main() {
+    parse_args "$@"
+    enable_expanded_output
+    inspect_gem
+}
+
+main "$@"

data/.github/scripts/publish-gem.sh

@@ -0,0 +1,121 @@
+#!/usr/bin/env bash
+set -e # Abort if any command fails
+
+me=$(basename "$0")
+
+help_message="\
+Usage:
+  $me --gem <gem-path> --token <token> [--owner <owner>] [--verbose]
+  $me --help
+Arguments:
+  -g, --gem <gem-path>      The path of the Gem to publish.
+  -t, --token <token>       The access token to use for publishing the gem to
+                            the specified registry.
+  -o, --owner <owner>       The owner to use when publishing to the GitHub
+                            Package Registry. If empty, will publish to
+                            RubyGems.org.
+  -h, --help                Displays this help screen.
+  -v, --verbose             Increase verbosity. Useful for debugging."
+
+parse_args() {
+    while : ; do
+        if [[ $1 = "-h" || $1 = "--help" ]]; then
+            echo "$help_message"
+            return 0
+        elif [[ $1 = "-v" || $1 = "--verbose" ]]; then
+            verbose=true
+            shift
+        elif [[ $1 = "-g" || $1 = "--gem" ]]; then
+            gem=${2// }
+
+            if [[ "$gem" = "--"* ]]; then
+                gem=""
+                shift 1
+            else
+                shift 2
+            fi
+        elif [[ $1 = "-t" || $1 = "--token" ]]; then
+            token=${2// }
+
+            if [[ "$token" = "--"* ]]; then
+                token=""
+                shift 1
+            else
+                shift 2
+            fi
+        elif [[ $1 = "-o" || $1 = "--owner" ]]; then
+            owner=${2// }
+
+            if [[ "$owner" = "--"* ]]; then
+                owner=""
+                shift 1
+            else
+                shift 2
+            fi
+        else
+            break
+        fi
+    done
+
+    if [[ -z "$gem" ]]; then
+        echo "Missing required argument: --gem <gem>."
+        echo "$help_message"
+        return 1
+    fi
+
+    if [[ -z "$token" ]]; then
+        echo "Missing required argument: --token <token>."
+        echo "$help_message"
+        return 1
+    fi
+}
+
+# Echo expanded commands as they are executed (for debugging)
+enable_expanded_output() {
+    if [ $verbose ]; then
+        set -o xtrace
+        set +o verbose
+    fi
+}
+
+publish_gem() {
+    gem_home="$HOME/.gem"
+    credentials_file="$gem_home/credentials"
+
+    if [[ -n "$owner" ]]; then
+        auth_header="github: Bearer"
+        host="https://rubygems.pkg.github.com/$owner"
+    else
+        auth_header="rubygems_api_key:"
+    fi
+
+    mkdir -p "$gem_home"
+    touch "$credentials_file"
+    chmod 0600 "$credentials_file"
+    printf -- "---\n:%s %s\n" "$auth_header" "$token" > "$credentials_file"
+
+    if [[ -n "$host" ]]; then
+        if ! result=$(gem push --KEY github --host "$host" "$gem"); then
+            echo "ERROR: gem push failed."
+
+            if [[ $result == *"has already been pushed"* ]]; then
+                echo "ERROR: $gem has already been pushed."
+                # Silently ignore 'already been pushed' Gem errors.
+                return 0
+            else
+                echo "$result"
+                return 1
+            fi
+        fi
+    else
+        gem push "$gem"
+    fi
+}
+
+main() {
+    parse_args "$@"
+    enable_expanded_output
+    publish_gem
+}
+
+main "$@"

data/.github/scripts/test-gem.sh

@@ -0,0 +1,170 @@
+#!/usr/bin/env bash
+# shellcheck disable=3000-SC4000
+
+set -o errexit # Abort if any command fails
+me=$(basename "$0")
+
+help_message="\
+Usage:
+  ${me} --workdir <workdir> [--gemdir <gemdir> | --version <version> --token <token>] [--verbose]
+  ${me} --help
+Arguments:
+  -w, --workdir <workdir>       The path to the working directory.
+  -g, --gemdir <gemdir>         The path to directory of the Gem file to test.
+  -v, --version <version>       The version of the Gem to test.
+  -t, --token <token>           The GitHub token to use for retrieving the gem
+                                from the GitHub Package Registry.
+  -h, --help                    Displays this help screen.
+  -v, --verbose                 Increase verbosity. Useful for debugging."
+
+parse_args() {
+    while : ; do
+        if [[ $1 = "-h" || $1 = "--help" ]]; then
+            echo "${help_message}"
+            return 0
+        elif [[ $1 = "-v" || $1 = "--verbose" ]]; then
+            verbose=true
+            shift
+        elif [[ $1 = "-g" || $1 = "--gemdir" ]]; then
+            gemdir=${2// }
+
+            if [[ "${gemdir}" = "--"* ]]; then
+                gemdir=""
+                shift 1
+            else
+                shift 2
+            fi
+        elif [[ $1 = "-v" || $1 = "--version" ]]; then
+            version=${2// }
+
+            if [[ "${version}" = "--"* ]]; then
+                version=""
+                shift 1
+            else
+                shift 2
+            fi
+        elif [[ $1 = "-t" || $1 = "--token" ]]; then
+            token=${2// }
+
+            if [[ "${token}" = "--"* ]]; then
+                token=""
+                shift 1
+            else
+                shift 2
+            fi
+        elif [[ $1 = "-w" || $1 = "--workdir" ]]; then
+            workdir=${2// }
+
+            if [[ "${workdir}" = "--"* ]]; then
+                workdir=""
+                shift 1
+            else
+                shift 2
+            fi
+        else
+            break
+        fi
+    done
+
+    if [[ -z "${workdir}" ]]; then
+        echo "Missing required argument: --workdir <workdir>."
+        echo "${help_message}"
+        return 1
+    fi
+
+    if [[ (-z "${gemdir}" && -z "${token}") || (-n "${gemdir}" && -n "${token}") ]]; then
+        echo "Missing or invalid required arguments: --gemdir <gem-path> or --token <token>."
+        echo "Either [--gemdir] or [--token] needs to be provided, but not both."
+        echo "${help_message}"
+        return 1
+    fi
+
+    if [[ (-n "${version}" && -z "${token}") || (-z "${version}" && -n "${token}") ]]; then
+        echo "Missing or invalid required arguments: --version <gem-path> and --token <token>."
+        echo "When either argument is present, both must be."
+        echo "${help_message}"
+        return 1
+    fi
+}
+
+# Echo expanded commands as they are executed (for debugging)
+enable_expanded_output() {
+    if [ "${verbose}" = true ]; then
+        set -o xtrace
+        set +o verbose
+        export VERBOSE=true
+    fi
+}
+
+test_gem() {
+    local jekyll_build_args=()
+
+    cd "${workdir}"
+
+    gem install bundler
+
+    if [[ -n "${token}" ]]; then
+        # A non-empty $token means we should install the Gem from GPR
+        repository="https://rubygems.pkg.github.com/swedbankpay"
+        bundle config "${repository}" "SwedbankPay:${token}"
+        printf "source '%s' do\n\tgem 'kramdown-plantuml', '%s'\nend" "${repository}" "${version}" >> Gemfile
+    else
+        echo "gem 'kramdown-plantuml', path: '${gemdir}'" >> Gemfile
+    fi
+
+    if [[ "${verbose}" = true ]]; then
+        cat Gemfile
+        jekyll_build_args+=(--verbose)
+    fi
+
+    bundle install
+    bundle exec jekyll build "${jekyll_build_args[@]}"
+
+    file="${workdir}/_site/index.html"
+
+    file_contains "${file}" "class=\"plantuml theme-spacelab\""
+    file_contains "${file}" "<svg"
+    file_contains "${file}" "<ellipse"
+    file_contains "${file}" "<polygon"
+    file_contains "${file}" "<path"
+}
+
+file_contains() {
+    file=$1
+    contents=$2
+
+    if [[ -z "${file}" ]]; then
+        echo "file_contains missing required argument <file>."
+        return 1
+    fi
+
+    if [[ -z "${contents}" ]]; then
+        echo "file_contains missing required argument <contents>."
+        return 1
+    fi
+
+    if [[ ! -f "${file}" ]]; then
+        echo "file_contains <file> not found: '${file}'."
+        return 1
+    fi
+
+    if grep --quiet --fixed-strings "${contents}" "${file}"; then
+        echo "Success! '${contents}' found in '${file}'."
+    else
+        echo "Failed! '${contents}' not found in '${file}'."
+
+        if [ "${verbose}" = true ]; then
+            cat "${file}"
+        fi
+
+        return 1
+    fi
+}
+
+main() {
+    parse_args "$@"
+    enable_expanded_output
+    test_gem
+}
+
+main "$@"