kramdown-plantuml 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df85b61ecd8a5b15d5288e03f95f70064926f71f144d245dfe693ea36e190d7b
-  data.tar.gz: 88de76e1cf968e5365b1af85bc0266b3de41ff58c131583771b7d63b61f93544
+  metadata.gz: 71464ee363c4a9b9859ffd72421d6840d1f26018a0fdc20eaae4fa4f17011f26
+  data.tar.gz: f4cde15688ebcc236bfd2e3f5458c8d62722b8ff4fdac2767682f32643839013
 SHA512:
-  metadata.gz: 3f13d2f50b9cfeb43e221654345a2d882eb1c310611f1f7f4f2ebac94214d17aa7d95e1b6bd8133419fdf722a72f1bf87249ac91bc239650f32a371520a42845
-  data.tar.gz: 4b3d5fd4af58e295265e7af2577d0ee9993b98258f95f6919ae1f648e5e8a7e5b31b648b94736c027ac338ee59b545717cc72d78d0f5da77669abd311215668e
+  metadata.gz: ed9a469ba9ec78c8d498fab3cb412220466d76344aadceea56d89634f8f2b25523bc10566a023ecdd7e3a8fa7373a0c49d2677e5ceb6058206e913ffd5cb3a7b
+  data.tar.gz: 5d969b52c7cf030910cc6ffe6d0c85c7492487c421de35a40e9f6ca965bf35420761ca4be1540eba53eecb339154a94e212815525bd18529d96e3236b9949efb

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/bundle-install.sh

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -o errexit # Abort if any command fails
+
+gem install bundler
+bundle config path vendor/bundle
+bundle install --jobs 4 --retry 3

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,103 @@
+#!/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
+            shift 2
+        elif [[ $1 = "-t" || $1 = "--token" ]]; then
+            token=$2
+            shift 2
+        elif [[ $1 = "-o" || $1 = "--owner" ]]; then
+            owner=$2
+            shift 2
+        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,140 @@
+#!/usr/bin/env bash
+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
+            shift 2
+        elif [[ $1 = "-v" || $1 = "--version" ]]; then
+            version=$2
+            shift 2
+        elif [[ $1 = "-t" || $1 = "--token" ]]; then
+            token=$2
+            shift 2
+        elif [[ $1 = "-w" || $1 = "--workdir" ]]; then
+            workdir=$2
+            shift 2
+        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 ]; then
+        set -o xtrace
+        set +o verbose
+    fi
+}
+
+test_gem() {
+    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 ]]; then
+        cat Gemfile
+    fi
+
+    bundle install
+    bundle exec jekyll build
+
+    file="$workdir/_site/index.html"
+
+    file_contains "$file" "class=\"plantuml\""
+    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 ]]; then
+            cat "$file"
+        fi
+
+        return 1
+    fi
+}
+
+main() {
+    parse_args "$@"
+    enable_expanded_output
+    test_gem
+}
+
+main "$@"

data/.github/scripts/variables.sh

@@ -0,0 +1,70 @@
+#!/bin/bash
+set -o errexit # Abort if any command fails
+me=$(basename "$0")
+
+help_message="\
+Usage: echo $me <version>
+Generates variables based on the provided environment variable GITHUB_CONTEXT
+and <version> argument.
+GITHUB_CONTEXT: An environment variable containing a JSON string of the GitHub
+                context object. Typically generated with \${{ toJson(github) }}.
+     <version>: The version number corresponding to the current Git commit."
+
+initialize() {
+    github_context_json="$GITHUB_CONTEXT"
+    version="$1"
+
+    if [[ -z "$github_context_json" ]]; then
+        echo "Missing or empty GITHUB_CONTEXT environment variable." >&2
+        echo "$help_message"
+        exit 1
+    fi
+
+    if [[ -z "$version" ]]; then
+        echo "No version specified." >&2
+        echo "$help_message"
+        exit 1
+    fi
+
+    sha=$(echo "$github_context_json" | jq --raw-output .sha)
+    ref=$(echo "$github_context_json" | jq --raw-output .ref)
+
+    if [[ -z "$sha" ]]; then
+        echo "No 'sha' found in the GitHub context." >&2
+        echo "$help_message"
+        exit 1
+    fi
+
+    if [[ -z "$ref" ]]; then
+        echo "No 'ref' found in the GitHub context." >&2
+        echo "$help_message"
+        exit 1
+    fi
+}
+
+generate_variables() {
+    # Replace + in the version number with a dot.
+    version="${version/+/.}"
+
+    if [[ "$ref" == refs/tags/* ]]; then
+        # Override GitVersion's version on tags, just to be sure.
+        version="${ref#refs/tags/}"
+    fi
+
+    # Convert the version number to all-lowercase because GPR only supports lowercase version numbers.
+    version=$(echo "$version" | tr '[:upper:]' '[:lower:]')
+
+    echo "Ref: $ref"
+    echo "Sha: $sha"
+    echo "Version: $version"
+    echo "::set-output name=ref::$ref"
+    echo "::set-output name=sha::$sha"
+    echo "::set-output name=version::$version"
+}
+
+main() {
+    initialize "$@"
+    generate_variables
+}
+
+main "$@"

data/.github/workflows/no-java.yml

@@ -11,15 +11,13 @@ jobs:
     name: No Java
     runs-on: ubuntu-latest
     container:
-      image: ruby:2.7.0-alpine3.11
+      image: ruby:2.7.2
 
     steps:
     - uses: actions/checkout@v2
 
     - name: Bundle install
-      run: |
-        find .
-        bundle install --jobs 4 --retry 3
+      run: bundle install --jobs 4 --retry 3
 
     - name: Test with Rake
       run: bundle exec rspec --tag no_java

data/.github/workflows/no-plantuml.yml

@@ -10,17 +10,17 @@ jobs:
   test:
     name: No PlantUML
     runs-on: ubuntu-latest
-    container:
-      image: ruby:2.7.0-alpine3.11
 
     steps:
     - uses: actions/checkout@v2
 
+    - name: Set up Ruby 2.7
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.7.x
+
     - name: Bundle install
       run: bundle install --jobs 4 --retry 3
 
-    - name: Remove plantuml.1.2020.5.jar
-      run:  rm bin/plantuml.1.2020.5.jar
-
     - name: Test with Rake
       run: bundle exec rspec --tag no_plantuml