jekyll-plantuml 1.4.0 → 1.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2697b42a31945ffb30c6daaffbd25fad42fac637ded85a28d880a901498eae00
-  data.tar.gz: f707a12ea2d90e5b128afc2b98f9d482fcf44041cfc4d0b1671d3a63e71d5ddb
+  metadata.gz: 51daf562588034598bf5b90637effc7597bfc2dba215ccaad8e0c9f9aa2dd285
+  data.tar.gz: 72a2fa53f9024c0dfc1a8170d0bf8cb8d3f0b556d67e35623a01ae2204d24112
 SHA512:
-  metadata.gz: 251252e096489b6522e3d2b0d1a6d72eaacae391dbb4a25191a387ae309ff9a462d19b718bcc6c9c58edd336e65882f992d47b78302ffd93b34f33b39b3b7792
-  data.tar.gz: fa076635bda7053181e182622159ec0274878f41d7c562caec73512f7e46afc0e854da25ca142efc862bbe4df991db475af4ab9198ba0eb30e8d30e29c177b65
+  metadata.gz: 68f2e0c80212045b46d6e975e72ab6c17340084f60f952ed20f296e7c54b2f625e994016f70ddfabfe3c7f083f8d0d3858ac7036ea3c9fdfe0470cc200cc9141
+  data.tar.gz: 26a44da82ea8780bccdd2f1134423ffd6fc7c2b75b1968c668f755d4b35f5ea16801ee6760975388c0342376bdeaee66fcca72fc5bf75881acf6fab4aedd185f

data/.github/workflows/codecov.yml

@@ -0,0 +1,22 @@
+---
+name: codecov
+on:
+  push:
+    branches:
+      - master
+jobs:
+  codecov:
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7
+      - run: sudo apt-get -y install plantuml
+      - run: bundle update
+      - run: bundle exec rake
+      - uses: codecov/codecov-action@v4.0.0-beta.3
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          file: coverage/.resultset.json
+          fail_ci_if_error: true

data/.github/workflows/pdd.yml

@@ -2,10 +2,14 @@
 name: pdd
 on:
   push:
+    branches:
+      - master
   pull_request:
+    branches:
+      - master
 jobs:
   pdd:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     steps:
-      - uses: actions/checkout@v3
-      - uses: g4s8/pdd-action@master
+      - uses: actions/checkout@v4
+      - uses: volodya-lombrozo/pdd-action@master

data/.github/workflows/rake.yml

@@ -12,13 +12,14 @@ jobs:
     name: test
     strategy:
       matrix:
-        os: [ubuntu-20.04, macos-12]
+        os: [ubuntu-20.04]
         ruby: [2.7, 3.2]
     runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
+      - run: sudo apt-get -y install plantuml
       - run: bundle update
       - run: bundle exec rake

data/.github/workflows/xcop.yml

@@ -5,7 +5,7 @@ on:
   pull_request:
 jobs:
   xcop:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: g4s8/xcop-action@master

data/.gitignore

@@ -2,3 +2,4 @@ Gemfile.lock
 *.gem
 .bundle/
 .DS_Store
+coverage/

data/.rubocop.yml

@@ -13,3 +13,9 @@ Metrics/MethodLength:
   Enabled: false
 Metrics/AbcSize:
   Max: 30
+Naming/FileName:
+  Enabled: false
+Style/ClassAndModuleChildren:
+  Enabled: false
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false

data/.rultor.yml

@@ -1,11 +1,13 @@
 docker:
-  image: yegor256/rultor-image:1.20.0
+  image: yegor256/rultor-image:1.22.0
 assets:
   rubygems.yml: yegor256/home#assets/rubygems.yml
 install: |
   pdd -f /dev/null
-  sudo bundle install --no-color "--gemfile=$(pwd)/Gemfile"
+  bundle install --no-color
+  sudo apt-get -y install plantuml
 release:
+  pre: false
   script: |-
     bundle exec rake
     rm -rf *.gem

data/Gemfile

@@ -3,6 +3,8 @@
 source 'https://rubygems.org'
 gemspec
 
-gem 'rake', '13.0.6', require: false
-gem 'rubocop', '1.51.0', require: false
-gem 'rubocop-rspec', '2.22.0', require: false
+gem 'minitest', '5.22.0', require: false
+gem 'rake', '13.1.0', require: false
+gem 'rubocop', '1.60.2', require: false
+gem 'rubocop-rspec', '2.26.1', require: false
+gem 'simplecov', '0.22.0', require: false

data/LICENSE.txt

@@ -1,6 +1,6 @@
 (The MIT License)
 
-Copyright (c) 2014-2023 Yegor Bugayenko
+Copyright (c) 2014-2024 Yegor Bugayenko
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the 'Software'), to deal

data/README.md

@@ -1,10 +1,14 @@
+[![DevOps By Rultor.com](http://www.rultor.com/b/yegor256/jekyll-plantuml)](http://www.rultor.com/p/yegor256/jekyll-plantuml)
+[![We recommend RubyMine](https://www.elegantobjects.org/rubymine.svg)](https://www.jetbrains.com/ruby/)
+
 [![rake](https://github.com/yegor256/jekyll-plantuml/actions/workflows/rake.yml/badge.svg)](https://github.com/yegor256/jekyll-plantuml/actions/workflows/rake.yml)
 [![Gem Version](https://badge.fury.io/rb/jekyll-plantuml.svg)](http://badge.fury.io/rb/jekyll-plantuml)
+[![Test Coverage](https://img.shields.io/codecov/c/github/yegor256/jekyll-plantuml.svg)](https://codecov.io/github/yegor256/jekyll-plantuml?branch=master)
 
 Install it first:
 
 ```
-gem install jekyll-plantuml
+$ gem install jekyll-plantuml
 ```
 
 With Jekyll 2, simply add the gem to your `_config.yml` gems list:
@@ -18,7 +22,7 @@ create a plugin file within your Jekyll project's `_plugins` directory:
 
 ```ruby
 # _plugins/plantuml-plugin.rb
-require "jekyll_plantuml"
+require "jekyll-plantuml"
 ```
 
 Highly recommend to use Bundler. If you're using it, add this line
@@ -28,26 +32,33 @@ to your `Gemfile`:
 gem "jekyll-plantuml"
 ```
 
+The plugin is compatible with 
+[Jekyll 3.9.3](https://jekyllrb.com/news/2023/01/29/jekyll-3-9-3-released/) and 
+[Jekyll 4.3.2](https://jekyllrb.com/news/2023/01/20/jekyll-4-3-2-released/). 
+You can find our integration tests, which prove the compatibility, 
+[here](https://github.com/yegor256/jekyll-plantuml/tree/master/test-jekylls).
+
 ## Install plantuml.jar
 
 Then, make sure [PlantUML](http://plantuml.sourceforge.net/download.html)
 is installed on your build machine, and can
 be executed with a simple `plantuml` command.
 
-For Linux user, you could create a `/usr/bin/plantuml` with contents:
+On Ubuntu, just `apt-get install -y plantuml` should work.
+However, if it doesn't, you can create a `/usr/bin/plantuml` with the
+following content:
 
 ```
 #!/bin/bash
-
 java -jar /home/user/Downloads/plantuml.jar "$1" "$2"
 ```
 
-Remember to change the path to `plantuml.jar` file.
+Remember to change the path to the `plantuml.jar` file.
 
-Then set executable permission.
+Then, set the executable permission of the file:
 
 ```
-chmod +x /usr/bin/plantuml
+$ chmod +x /usr/bin/plantuml
 ```
 
 ## Test
@@ -64,3 +75,16 @@ Now, check [this blog post](http://www.yegor256.com/2014/06/01/aop-aspectj-java-
 the UML sequence diagram in it is auto-generated using exactly this plugin.
 The sources of the blog are available in [GitHub](https://github.com/yegor256/blog).
 
+## How to contribute
+
+Read [these guidelines](https://www.yegor256.com/2014/04/15/github-guidelines.html).
+Make sure you build is green before you contribute
+your pull request. You will need to have [Ruby](https://www.ruby-lang.org/en/) 2.3+ and
+[Bundler](https://bundler.io/) installed. Then:
+
+```
+$ bundle update
+$ bundle exec rake
+```
+
+If it's clean and you don't see any error messages, submit your pull request.

data/Rakefile

@@ -2,7 +2,7 @@
 
 # (The MIT License)
 #
-# Copyright (c) 2014-2023 Yegor Bugayenko
+# Copyright (c) 2014-2024 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -35,7 +35,21 @@ def version
   Gem::Specification.load(Dir['*.gemspec'].first).version
 end
 
-task default: %i[clean rubocop copyright]
+task default: %i[clean test jekylls rubocop copyright]
+
+require 'rake/testtask'
+desc 'Run all unit tests'
+Rake::TestTask.new(:test) do |test|
+  Rake::Cleaner.cleanup_files(['coverage'])
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.warning = true
+  test.verbose = false
+end
+
+task :jekylls do
+  sh 'cd test-jekylls; make'
+end
 
 require 'rdoc/task'
 desc 'Build RDoc documentation'

data/lib/{jekyll_plantuml.rb → jekyll-plantuml.rb}

@@ -2,7 +2,7 @@
 
 # (The MIT License)
 #
-# Copyright (c) 2014-2023 Yegor Bugayenko
+# Copyright (c) 2014-2024 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -22,45 +22,43 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
+require 'jekyll'
+require 'liquid'
 require 'digest'
 require 'fileutils'
 
 # Jekyll main module.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
-# Copyright:: Copyright (c) 2014-2023 Yegor Bugayenko
+# Copyright:: Copyright (c) 2014-2024 Yegor Bugayenko
 # License:: MIT
-module Jekyll
-  # The main class
-  class PlantumlBlock < Liquid::Block
-    def initialize(tag_name, markup, tokens)
-      super
-      @html = (markup or '').strip
-    end
+class Jekyll::PlantumlBlock < Liquid::Block
+  def initialize(tag_name, markup, tokens)
+    super
+    @html = (markup or '').strip
+  end
 
-    def render(context)
-      site = context.registers[:site]
-      name = Digest::MD5.hexdigest(super)
-      unless File.exist?(File.join(site.dest, "uml/#{name}.svg"))
-        uml = File.join(site.source, "uml/#{name}.uml")
-        svg = File.join(site.source, "uml/#{name}.svg")
-        if File.exist?(svg)
-          puts "File #{svg} already exists (#{File.size(svg)} bytes)"
-        else
-          FileUtils.mkdir_p(File.dirname(uml))
-          File.open(uml, 'w') do |f|
-            f.write("@startuml\n")
-            f.write(super)
-            f.write("\n@enduml")
-          end
-          system("plantuml -tsvg #{uml}") or raise "PlantUML error: #{super}"
-          site.static_files << Jekyll::StaticFile.new(
-            site, site.source, 'uml', "#{name}.svg"
-          )
-          puts "File #{svg} created (#{File.size(svg)} bytes)"
+  def render(context)
+    site = context.registers[:site]
+    body = super.to_s
+    name = Digest::MD5.hexdigest(body)
+    unless File.exist?(File.join(site.dest, "uml/#{name}.svg"))
+      uml = File.join(site.source, "uml/#{name}.uml")
+      svg = File.join(site.source, "uml/#{name}.svg")
+      if File.exist?(svg)
+        puts "File #{svg} already exists (#{File.size(svg)} bytes)"
+      else
+        FileUtils.mkdir_p(File.dirname(uml))
+        File.write(uml, ["@startuml\n", body, "\n@enduml"].join)
+        unless system("plantuml -tsvg #{uml} 2>&1")
+          raise "PlantUML failed to compile the following snippet (see logs above):\n#{body}\n"
         end
+        site.static_files << Jekyll::StaticFile.new(
+          site, site.source, 'uml', "#{name}.svg"
+        )
+        puts "\nFile #{svg} created (#{File.size(svg)} bytes)"
       end
-      "<p><object data='#{site.baseurl}/uml/#{name}.svg' type='image/svg+xml' #{@html} class='plantuml'></object></p>"
     end
+    "<p><object data='#{site.baseurl}/uml/#{name}.svg' type='image/svg+xml' #{@html} class='plantuml'></object></p>"
   end
 end
 

data/lib/version.rb

@@ -2,7 +2,7 @@
 
 # (The MIT License)
 #
-# Copyright (c) 2014-2023 Yegor Bugayenko
+# Copyright (c) 2014-2024 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -23,5 +23,5 @@
 # SOFTWARE.
 
 module PlantUML
-  VERSION = '1.4.0'
+  VERSION = '1.4.2'
 end

data/renovate.json

@@ -2,5 +2,9 @@
   "$schema": "https://docs.renovatebot.com/renovate-schema.json",
   "extends": [
     "config:base"
+  ],
+  "ignorePaths": [
+    "jekyll-tests/jekyll-3/Gemfile",
+    "jekyll-tests/jekyll-4/Gemfile"
   ]
 }

data/test/test__helper.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2014-2024 Yegor Bugayenko
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the 'Software'), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+$stdout.sync = true
+
+require 'simplecov'
+SimpleCov.start

data/test/test_plantuml.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# (The MIT License)
+#
+# Copyright (c) 2014-2024 Yegor Bugayenko
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the 'Software'), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+require 'liquid'
+require 'tmpdir'
+require 'minitest/autorun'
+require_relative 'test__helper'
+require_relative '../lib/jekyll-plantuml'
+
+# PlantumlBlock test.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2023-2024 Yegor Bugayenko
+# License:: MIT
+class PlantumlBlockTest < Minitest::Test
+  def test_failure
+    Dir.mktmpdir 'test' do |dir|
+      template = Liquid::Template.parse('{% plantuml %}[A] -> [B]{% endplantuml %}')
+      config = {
+        'destination' => File.join(dir, 'dest'),
+        'source' => File.join(dir, 'source')
+      }
+      context = Liquid::Context.new({}, {}, { site: Jekyll::Site.new(Jekyll.configuration(config)) })
+      block = template.root.nodelist.first
+      output = block.render(context)
+      assert(output.start_with?('<p><object'))
+    end
+  end
+end

data/test-jekylls/.gitignore

@@ -0,0 +1,2 @@
+_site/
+uml/

data/test-jekylls/Makefile

@@ -0,0 +1,13 @@
+.ONESHELL:
+.SHELLFLAGS: -e -o pipefail -c
+.PHONY: clean sa env lint
+
+SHELL = bash
+
+TESTS = $(wildcard */)
+all:
+	for t in ${TESTS}; do
+		cd $${t}
+		bundle install
+		bundle exec jekyll build
+	done

data/test-jekylls/jekyll-3/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'jekyll', '4.3.3'
+gem 'jekyll-plantuml', path: '../..'
+gem 'kramdown', '2.4.0'
+gem 'kramdown-parser-gfm', '1.1.0'
+gem 'liquid', '4.0.4'

data/test-jekylls/jekyll-3/_config.yml

@@ -0,0 +1,6 @@
+title: simple
+markdown: kramdown
+encoding: utf-8
+timezone: Europe/Moscow
+plugins:
+  - jekyll-plantuml

data/test-jekylls/jekyll-3/_layouts/default.html

@@ -0,0 +1,9 @@
+---
+layout: default
+---
+<!DOCTYPE html>
+<html>
+  <body>
+    {{ content }}
+  </body>
+</html>

data/test-jekylls/jekyll-3/_posts/2023/06/2023-06-02-test.md

@@ -0,0 +1,11 @@
+---
+layout: default
+date: 2023-06-02
+title: "Test"
+---
+
+This is just a test:
+
+{% plantuml %}
+[First] - [Second]
+{% endplantuml %}

data/test-jekylls/jekyll-4/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'jekyll', '4.3.3'
+gem 'jekyll-plantuml', path: '../..'
+gem 'kramdown', '2.4.0'
+gem 'liquid', '4.0.4'

data/test-jekylls/jekyll-4/_config.yml

@@ -0,0 +1,6 @@
+title: simple
+markdown: kramdown
+encoding: utf-8
+timezone: Europe/Moscow
+plugins:
+  - jekyll-plantuml

data/test-jekylls/jekyll-4/_layouts/default.html

@@ -0,0 +1,9 @@
+---
+layout: default
+---
+<!DOCTYPE html>
+<html>
+  <body>
+    {{ content }}
+  </body>
+</html>

data/test-jekylls/jekyll-4/_posts/2023/06/2023-06-02-test.md

@@ -0,0 +1,17 @@
+---
+layout: default
+date: 2023-06-02
+title: "Test"
+---
+
+This is just a test:
+
+{% plantuml %}
+[First] - [Second]
+{% endplantuml %}
+
+This is another test:
+
+```plantuml
+[First] - [Second]
+```

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-plantuml
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.4.2
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-02 00:00:00.000000000 Z
+date: 2024-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -33,6 +33,7 @@ extra_rdoc_files:
 - LICENSE.txt
 files:
 - ".0pdd.yml"
+- ".github/workflows/codecov.yml"
 - ".github/workflows/pdd.yml"
 - ".github/workflows/rake.yml"
 - ".github/workflows/xcop.yml"
@@ -40,15 +41,26 @@ files:
 - ".pdd"
 - ".rubocop.yml"
 - ".rultor.yml"
-- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - jekyll-plantuml.gemspec
-- lib/jekyll_plantuml.rb
+- lib/jekyll-plantuml.rb
 - lib/version.rb
 - renovate.json
+- test-jekylls/.gitignore
+- test-jekylls/Makefile
+- test-jekylls/jekyll-3/Gemfile
+- test-jekylls/jekyll-3/_config.yml
+- test-jekylls/jekyll-3/_layouts/default.html
+- test-jekylls/jekyll-3/_posts/2023/06/2023-06-02-test.md
+- test-jekylls/jekyll-4/Gemfile
+- test-jekylls/jekyll-4/_config.yml
+- test-jekylls/jekyll-4/_layouts/default.html
+- test-jekylls/jekyll-4/_posts/2023/06/2023-06-02-test.md
+- test/test__helper.rb
+- test/test_plantuml.rb
 homepage: https://github.com/yegor256/jekyll-plantuml
 licenses:
 - MIT
@@ -70,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
 summary: Jekyll PlantUML Automation

data/.travis.yml

@@ -1,12 +0,0 @@
-language: ruby
-rvm:
-  - 2.2.2
-cache: bundler
-branches:
-  only:
-    - master
-install:
-  - travis_retry bundle install
-script:
-  - rake
-