kramdown-plantuml 1.0.5 → 1.1.1

data/.github/scripts/variables.sh

@@ -43,8 +43,10 @@ initialize() {
 }
 
 generate_variables() {
-    # Replace + in the version number with a dot.
-    version="${version/+/.}"
+    # Replace '+'' in the version number with '.'.
+    version="${version//+/.}"
+    # Replace '-' in the version number with '.'.
+    version="${version//-/.}"
 
     if [[ "$ref" == refs/tags/* ]]; then
         # Override GitVersion's version on tags, just to be sure.

data/.github/workflows/amend.yml

@@ -0,0 +1,19 @@
+name: amend
+
+on:
+  issue_comment:
+    types: [created]
+
+jobs:
+  amend:
+    if: github.event.issue.pull_request != '' && contains(github.event.comment.body, '/amend')
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          persist-credentials: false
+      - name: amend
+        env:
+          GITHUB_TOKEN: ${{ secrets.PUBLIC_REPO_TOKEN }}
+          GITHUB_CONTEXT: ${{ toJSON(github) }}
+        run: .github/scripts/amend.sh --user payex-dev --verbose

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

@@ -8,7 +8,6 @@ on:
 
 jobs:
   test:
-    name: No Java
     runs-on: ubuntu-latest
     container:
       image: ruby:2.7.2
@@ -19,5 +18,5 @@ jobs:
     - name: Bundle install
       run: bundle install --jobs 4 --retry 3
 
-    - name: Test with Rake
+    - name: RSpec
       run: bundle exec rspec --tag no_java

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

@@ -8,19 +8,16 @@ on:
 
 jobs:
   test:
-    name: No PlantUML
     runs-on: ubuntu-latest
 
     steps:
     - uses: actions/checkout@v2
 
     - name: Set up Ruby 2.7
-      uses: actions/setup-ruby@v1
+      uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.7.x
+        ruby-version: 2.7
+        bundler-cache: true
 
-    - name: Bundle install
-      run: bundle install --jobs 4 --retry 3
-
-    - name: Test with Rake
+    - name: RSpec
       run: bundle exec rspec --tag no_plantuml

data/.github/workflows/ruby.yml

@@ -1,10 +1,6 @@
 name: Ruby Gem
 
-on:
-  push:
-    branches: ['*']
-    tags: ['*']
-  pull_request:
+on: [push, pull_request, pull_request_target]
 
 jobs:
   version:
@@ -19,19 +15,19 @@ jobs:
         fetch-depth: 0
 
     - name: Setup GitVersion
-      uses: gittools/actions/gitversion/setup@v0.9.4
+      uses: gittools/actions/gitversion/setup@v0.9.10
       with:
-        versionSpec: '5.3.x'
+        versionSpec: '5.x.x'
 
     - name: Execute GitVersion
       id: gitversion
-      uses: gittools/actions/gitversion/execute@v0.9.4
+      uses: gittools/actions/gitversion/execute@v0.9.10
 
     - name: Create variables
       id: variables
       env:
         GITHUB_CONTEXT: ${{ toJson(github) }}
-      run: ./.github/scripts/variables.sh ${{ steps.gitversion.outputs.legacySemVerPadded }}
+      run: ./.github/scripts/variables.sh ${{ steps.gitversion.outputs.fullSemVer }}
 
   plantuml:
     needs: version
@@ -41,12 +37,13 @@ jobs:
     - uses: actions/checkout@v2
 
     - name: Setup Java
-      uses: actions/setup-java@v1
+      uses: actions/setup-java@v2
       with:
+        distribution: adopt
         java-version: 14
 
     - name: Cache Maven dependencies
-      uses: actions/cache@v2
+      uses: actions/cache@v2.1.6
       with:
         path: ~/.m2/repository
         key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
@@ -82,30 +79,26 @@ jobs:
     - name: Version stamp
       run: sed -i -e 's/0.0.1.dev/${{ needs.version.outputs.version }}/g' ${{ github.workspace }}/lib/kramdown-plantuml/version.rb
 
-    - name: Set up Ruby 2.7
-      uses: actions/setup-ruby@v1
+    - name: Setup Ruby 2.7
+      uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.7.x
+        ruby-version: 2.7
+        bundler-cache: true
 
     - name: Setup Graphviz
       uses: kamiazya/setup-graphviz@v1
 
-    - name: Cache Ruby gems
-      uses: actions/cache@v1
-      with:
-        path: vendor/bundle
-        key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
-        restore-keys: ${{ runner.os }}-gems-
-
-    - name: Bundle install
-      run: .github/scripts/bundle-install.sh
-
     - name: rubocop
       run: bundle exec rubocop --fail-level warning --display-only-fail-level-offenses
 
     - name: Test with Rake
       run: bundle exec rake
 
+    - name: RSPec (debug)
+      env:
+        DEBUG: 1
+      run: bundle exec rspec --tag debug
+
     - name: Codecov upload
       run: bundle exec rake codecov:upload || echo 'Codecov upload failed'
 
@@ -113,7 +106,7 @@ jobs:
       id: gem
       run: .github/scripts/build-gem.sh
 
-    - name: Upload artifact
+    - name: Upload gem
       uses: actions/upload-artifact@v2-preview
       with:
         name: ${{ steps.gem.outputs.name }}
@@ -128,27 +121,44 @@ jobs:
   publish-dev:
     needs: [version, gem]
     runs-on: ubuntu-latest
+    if: |
+        (github.event_name == 'pull_request_target' && github.actor == 'dependabot[bot]') ||
+        (github.event_name != 'pull_request_target' && github.actor != 'dependabot[bot]')
 
     steps:
     - uses: actions/checkout@v2
+      if: ${{ github.event_name != 'pull_request_target' }}
+
+    - uses: actions/checkout@v2
+      if: ${{ github.event_name == 'pull_request_target' }}
+      with:
+        ref: ${{ github.event.pull_request.head.sha }}
 
     - uses: actions/download-artifact@v2
       with:
         name: ${{ needs.gem.outputs.name }}
 
     - name: Set up Ruby 2.7
-      uses: actions/setup-ruby@v1
+      uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.7.x
+        ruby-version: 2.7
+        bundler-cache: true
 
     - name: Setup Graphviz
       uses: kamiazya/setup-graphviz@v1
 
     - name: Publish to GPR
-      run: .github/scripts/publish-gem.sh --gem ${{ needs.gem.outputs.name }} --token ${{ secrets.GITHUB_TOKEN }} --owner SwedbankPay --verbose
+      run: .github/scripts/publish-gem.sh --gem ${{ needs.gem.outputs.name }} --token "${{ secrets.GPR_TOKEN }}" --owner SwedbankPay --verbose
 
     - name: Test gem
-      run: .github/scripts/test-gem.sh --workdir "${{ github.workspace }}/spec/fixture" --version ${{ needs.version.outputs.version }} --token "${{ secrets.GITHUB_TOKEN }}" --verbose
+      run: .github/scripts/test-gem.sh --workdir "${{ github.workspace }}/spec/fixture" --version ${{ needs.version.outputs.version }} --token "${{ secrets.GPR_TOKEN }}" --verbose
+
+    - name: Upload Jekyll site
+      uses: actions/upload-artifact@v2-preview
+      if: always()
+      with:
+        name: site
+        path: ${{ github.workspace }}/spec/fixture/_site
 
   publish-prod:
     needs: [version, gem]

data/.github/workflows/shell.yml

@@ -1,10 +1,6 @@
 name: Shell
 
-on:
-  push:
-    branches: ['*']
-    tags: ['*']
-  pull_request:
+on: [push, pull_request]
 
 jobs:
   shellcheck:

data/.gitignore

@@ -13,3 +13,7 @@ Gemfile.lock
 /bin/
 .jekyll-cache
 _site
+.classpath
+.project
+.settings
+.vscode

data/.rubocop.yml

@@ -1,4 +1,5 @@
 AllCops:
+  TargetRubyVersion: 2.5
   NewCops: enable
   Exclude:
     - "Rakefile"

data/GitVersion.yml

@@ -0,0 +1,5 @@
+mode: ContinuousDeployment
+
+branches:
+  main:
+    mode: ContinuousDelivery

data/README.md

@@ -1,11 +1,12 @@
 # Kramdown::PlantUml
 
 [![Gem Version][gem-badge]][gem-url]
-![Build][build-badge]
-![No Java][no-java-build-badge]
-![No PlantUML][no-plantuml-badge]
+[![Ruby Gem][ruby-badge]][ruby-workflow]
+[![No Java][no-java-badge]][no-java-workflow]
+[![No PlantUML][no-plantuml-badge]][no-plantuml-workflow]
+[![Shell][shell-badge]][shell-workflow]
+[![Codecov][codecov-badge]][codecov]
 [![License][license-badge]][license]
-[![Dependabot Status][dependabot-badge]][dependabot]
 [![CLA assistant][cla-badge]][cla]
 [![Contributor Covenant][coc-badge]][coc]
 
@@ -42,6 +43,17 @@ Which in place will be rendered as the following:
 
 ![Rendered SVG Diagram][diagram-svg]
 
+If you configure theming (described below), the generated HTML will contain the
+name of the configured theme:
+
+```html
+<div class="plantuml theme-spacelab">
+  <svg>
+    <!-- Snip converted SVG code -->
+  </svg>
+</div>
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -73,16 +85,49 @@ Then, `bundle exec jekyll build` or `bundle exec jekyll serve` will execute
 `kramdown-plantuml`, converting code fenced PlantUML diagrams to beautiful
 SVG.
 
-## Development
+## Requirements
+
+`kramdown-plantuml` is dependent on the Java application [PlantUML], which in
+turn is dependent on [Graphviz]. This means that both Java and Graphviz need to
+be installed for `kramdown-plantuml` to work.
+
+## Configuration
+
+`kramdown-plantuml` can be configured either directly in the `options` Hash
+provided through Kramdown or by `_config.yml` provided through Jekyll.
+
+### Theming
+
+In order to [theme] all PlantUML diagrams fed through `kramdown-plantuml`, you
+can configure a global theme with the `plantuml.theme.name` and
+`plantuml.theme.directory` properties. Only `name` is required and will allow
+any of the built-in themes to be used.
+
+The theme is simply inserted into each PlantUML diagram with the `!theme`
+declaration, so this can be centralized in configuration instead of duplicating
+it across all diagrams.
+
+Here's an example of how to configure `kramdown-plantuml` to use the `spacelab`
+theme in Jekyll's `_config.yml`:
+
+```yaml
+kramdown:
+  plantuml:
+    theme:
+      name: spacelab
+```
 
-After checking out the repo, run `bin/setup` to install dependencies. You can
-also run `bin/console` for an interactive prompt that will allow you to
-experiment.
+If you have custom, local themes you'd like to use, you need to provide the
+`directory` in which they are placed alongside the `name` of the theme you'd
+like to use:
 
-To install this gem onto your local machine, run `bundle exec rake install`. To
-release a new version, update the version number in `version.rb`, and then run
-`bundle exec rake release`, which will create a git tag for the version, push
-git commits and tags, and push the `.gem` file to [rubygems.org][gems].
+```yaml
+kramdown:
+  plantuml:
+    theme:
+      name: my-custom-theme
+      directory: path/to/themes
+```
 
 ## Contributing
 
@@ -91,30 +136,73 @@ intended to be a safe, welcoming space for collaboration, and contributors are
 expected to adhere to the [code of conduct][coc] and sign the
 [contributor's license agreement][cla].
 
+### Development
+
+In order to do development on `kramdown-plantuml`, [clone] or [fork]
+this repository, perform the changes you want and submit a [pull request][pr].
+
+The easiest way to develop and test `kramdown-plantuml` is to add it as a
+[Jekyll][jekyll] plugin installed from a local path in your `Gemfile`:
+
+```ruby
+gem 'kramdown-plantuml', path: 'path/to/kramdown-plantuml'
+```
+
+Every time you perform a change to `kramdown-plantuml`, you can then, within
+the directory of your Jekyll site, do a `bundle install` to bring the changes
+in and then start Jekyll up again afterwards with `bundle exec jekyll serve`.
+
+#### Tests
+
+A few tests are exercised with GitHub Actions every time code is pushed to the
+repository on GitHub. You can execute these tests locally by first installing
+all dependencies as such:
+
+```shell
+bundle install # Installs required Ruby Gems
+bundle exec rake maven:install # Installs the PlantUML .jar file
+```
+
+And then to execute the tests you run the following:
+
+```shell
+bundle exec rake
+```
+
 ## License
 
 The code within this repository is available as open source under the terms of
 the [Apache 2.0 License][license] and the [contributor's license
 agreement][cla].
 
-[build-badge]:          https://github.com/SwedbankPay/kramdown-plantuml/workflows/Ruby%20Gem/badge.svg?branch=master
 [cla-badge]:            https://cla-assistant.io/readme/badge/SwedbankPay/kramdown-plantuml
 [cla]:                  https://cla-assistant.io/SwedbankPay/kramdown-plantuml
+[clone]:                https://docs.github.com/en/free-pro-team@latest/github/creating-cloning-and-archiving-repositories/cloning-a-repository
 [coc-badge]:            https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg
 [coc]:                  ./CODE_OF_CONDUCT.md
-[dependabot-badge]:     https://api.dependabot.com/badges/status?host=github&repo=SwedbankPay/kramdown-plantuml
-[dependabot]:           https://dependabot.com
-[diagram-svg]:          ./spec/diagram.svg
+[codecov-badge]:        https://codecov.io/gh/SwedbankPay/kramdown-plantuml/branch/main/graph/badge.svg?token=U3QJLVG3HY
+[codecov]:              https://codecov.io/gh/SwedbankPay/kramdown-plantuml/
+[diagram-svg]:          ./spec/examples/diagram.svg
 [fenced]:               https://www.markdownguide.org/extended-syntax/#syntax-highlighting
+[fork]:                 https://docs.github.com/en/free-pro-team@latest/github/getting-started-with-github/fork-a-repo
 [gem-badge]:            https://badge.fury.io/rb/kramdown-plantuml.svg
 [gem-url]:              https://rubygems.org/gems/kramdown-plantuml
 [gems]:                 https://rubygems.org
 [github]:               https://github.com/SwedbankPay/kramdown-plantuml/
+[graphviz]:             https://graphviz.org/
 [jekyll]:               https://jekyllrb.com/
 [kramdown]:             https://kramdown.gettalong.org/
 [license-badge]:        https://img.shields.io/github/license/SwedbankPay/kramdown-plantuml
 [license]:              https://opensource.org/licenses/Apache-2.0
-[no-java-build-badge]:  https://github.com/SwedbankPay/kramdown-plantuml/workflows/No%20Java/badge.svg?branch=master
-[no-plantuml-badge]:    https://github.com/SwedbankPay/kramdown-plantuml/workflows/No%20PlantUML/badge.svg?branch=master
+[no-java-badge]:        https://github.com/SwedbankPay/kramdown-plantuml/actions/workflows/no-java.yml/badge.svg
+[no-java-workflow]:     https://github.com/SwedbankPay/kramdown-plantuml/actions/workflows/no-java.yml
+[no-plantuml-badge]:    https://github.com/SwedbankPay/kramdown-plantuml/actions/workflows/no-plantuml.yml/badge.svg
+[no-plantuml-workflow]: https://github.com/SwedbankPay/kramdown-plantuml/actions/workflows/no-plantuml.yml
 [plantuml]:             https://plantuml.com/
+[pr]:                   https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/about-pull-requests
+[ruby-badge]:           https://github.com/SwedbankPay/kramdown-plantuml/actions/workflows/ruby.yml/badge.svg
+[ruby-workflow]:        https://github.com/SwedbankPay/kramdown-plantuml/actions/workflows/ruby.yml
+[shell-badge]:          https://github.com/SwedbankPay/kramdown-plantuml/actions/workflows/shell.yml/badge.svg
+[shell-workflow]:       https://github.com/SwedbankPay/kramdown-plantuml/actions/workflows/shell.yml
 [svg]:                  https://developer.mozilla.org/en-US/docs/Web/SVG
+[theme]:                https://plantuml.com/theme

data/Rakefile

@@ -6,7 +6,24 @@ require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec) do |t|
   t.pattern = Dir.glob('spec/**/*_spec.rb')
-  t.rspec_opts = '--format documentation --tag ~no_plantuml --tag ~no_java'
+  t.rspec_opts = '--format documentation --tag ~no_plantuml --tag ~no_java --tag ~debug'
+end
+
+namespace :maven do
+  task :install do
+    require 'fileutils'
+
+    system 'mvn install'
+    bin_dir = File.join __dir__, 'bin'
+    target_file = File.join bin_dir, 'plantuml.jar'
+    repo_dir = File.expand_path '~/.m2/repository'
+    jar_glob = File.join repo_dir, '/**/plantuml*.jar'
+    first_jar = Dir[jar_glob].first
+    jar_file = File.expand_path first_jar
+
+    FileUtils.mkdir_p bin_dir
+    FileUtils.move(jar_file, target_file)
+  end
 end
 
 namespace :codecov do