jekyll-plantuml 1.3.4 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac2e323ded0c0a23181c76586e43737fed9acb33bb21ccb9161a76aaff7e3a9a
-  data.tar.gz: c14813b4d754e6cad429978a78ff7909d03af3e96efae5d49b86db1abd242ae4
+  metadata.gz: 86089f21384efec7b5247e76310cf6f216163302a8503dfb14c0398c6cc3b44c
+  data.tar.gz: a0720294a6a0a642117c736544d24f8a839c7adca81e6c2c222be47c9cf1b574
 SHA512:
-  metadata.gz: 1eecead38ad73e2a4aed1f6b7a4494f8f02aaac0fc2ec36154ff6690c4a3ca3d5246ebe6051d621cca7d2fab7260e94b7ca23051c912e045ed759cf32cae9731
-  data.tar.gz: f22bfe23cbdda69a558af0c07977dd1ce939a92847857c7a155210bf4153aef8576b55ec3f6cfc5dc96d35c0f48e95fa6477b598a06fbe23002c22c64c4a70ae
+  metadata.gz: 7c1411a7d223784a48c1f24fe9757cdf1454aac992333289e3d1352e546bd2ae0a1f5ba7deaf6a9a38fb16110fa6d6d29304792290a8a660bf64fff6e7ef71cb
+  data.tar.gz: 538a39cf5816c611381903cb4b3fd6df1375ff8a5777acea4e65e7e9d35d7502398e5990870c7121e53cd1612db0e7a4fa4bc0f997843f2967d173a0b89a2a32

data/.github/workflows/pdd.yml

@@ -0,0 +1,11 @@
+---
+name: pdd
+on:
+  push:
+  pull_request:
+jobs:
+  pdd:
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v3
+      - uses: g4s8/pdd-action@master

data/.github/workflows/rake.yml

@@ -0,0 +1,25 @@
+---
+name: rake
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+jobs:
+  test:
+    name: test
+    strategy:
+      matrix:
+        os: [ubuntu-20.04, macos-12]
+        ruby: [2.7, 3.2]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v3
+      - 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

@@ -0,0 +1,11 @@
+---
+name: xcop
+on:
+  push:
+  pull_request:
+jobs:
+  xcop:
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v3
+      - uses: g4s8/xcop-action@master

data/.rubocop.yml

@@ -0,0 +1,17 @@
+AllCops:
+  Exclude:
+    - 'bin/**/*'
+    - 'assets/**/*'
+  DisplayCopNames: true
+  TargetRubyVersion: 2.3
+  SuggestExtensions: false
+  NewCops: enable
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/AbcSize:
+  Max: 30
+Naming/FileName:
+  Enabled: false

data/.rultor.yml

@@ -1,12 +1,11 @@
+docker:
+  image: yegor256/rultor-image:1.20.0
 assets:
   rubygems.yml: yegor256/home#assets/rubygems.yml
-  s3cfg: yegor256/home#assets/s3cfg
 install: |
-  export GEM_HOME=~/.ruby
-  export GEM_PATH=$GEM_HOME:$GEM_PATH
-  sudo gem install pdd -v 0.20.5
-  bundle install
   pdd -f /dev/null
+  sudo bundle install --no-color "--gemfile=$(pwd)/Gemfile"
+  sudo apt-get -y install plantuml
 release:
   script: |-
     bundle exec rake
@@ -20,7 +19,3 @@ release:
 merge:
   script: |-
     bundle exec rake
-deploy:
-  script: |-
-    echo "There is nothing to deploy"
-    exit -1

data/Gemfile

@@ -1,2 +1,8 @@
+# frozen_string_literal: true
+
 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

data/LICENSE.txt

@@ -1,6 +1,6 @@
 (The MIT License)
 
-Copyright (c) 2014-2019 Yegor Bugayenko
+Copyright (c) 2014-2023 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,7 +1,6 @@
+[![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)
 
-## Install Jekyll plugin
-
 Install it first:
 
 ```
@@ -61,7 +60,7 @@ Now, it's time to create a diagram, in your Jekyll blog page:
 {% endplantuml %}
 ```
 
-Check [this blog post](http://www.yegor256.com/2014/06/01/aop-aspectj-java-method-logging.html).
-UML sequence diagram in this page is generated with this plugin.
-Blog sources are available in [Github](https://github.com/yegor256/blog).
+Now, check [this blog post](http://www.yegor256.com/2014/06/01/aop-aspectj-java-method-logging.html):
+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).
 

data/Rakefile

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 # (The MIT License)
 #
-# Copyright (c) 2014-2019 Yegor Bugayenko
+# Copyright (c) 2014-2023 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
@@ -33,7 +35,11 @@ def version
   Gem::Specification.load(Dir['*.gemspec'].first).version
 end
 
-task default: [:clean]
+task default: %i[clean jekylls rubocop copyright]
+
+task :jekylls do
+  sh 'cd test-jekylls; make'
+end
 
 require 'rdoc/task'
 desc 'Build RDoc documentation'
@@ -43,3 +49,18 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
+
+require 'rubocop/rake_task'
+desc 'Run RuboCop on all directories'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.fail_on_error = true
+  task.requires << 'rubocop-rspec'
+end
+
+task :copyright do
+  sh "grep -q -r '2014-#{Date.today.strftime('%Y')}' \
+    --include '*.rb' \
+    --include '*.txt' \
+    --include 'Rakefile' \
+    ."
+end

data/jekyll-plantuml.gemspec

@@ -1,27 +1,25 @@
-# coding: utf-8
+# frozen_string_literal: true
 
-lib = File.expand_path('../lib', __FILE__)
+require 'English'
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'version'
 
 Gem::Specification.new do |s|
-  s.specification_version = 2 if s.respond_to? :specification_version=
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.rubygems_version = '2.2.2'
+  s.required_rubygems_version = Gem::Requirement.new('>= 0') if s.respond_to? :required_rubygems_version=
   s.required_ruby_version = '>= 1.9.3'
   s.name = 'jekyll-plantuml'
   s.version = PlantUML::VERSION
   s.license = 'MIT'
-  s.summary = "Jekyll PlantUML Automation"
-  s.description = "PlantUML diagrams in Jekyll pages"
-  s.authors = ["Yegor Bugayenko"]
+  s.summary = 'Jekyll PlantUML Automation'
+  s.description = 'PlantUML diagrams in Jekyll pages'
+  s.authors = ['Yegor Bugayenko']
   s.email = 'yegor@tpc2.com'
-  s.homepage = 'http://github.com/yegor256/jekyll-plantuml'
-  s.files = `git ls-files`.split($/)
+  s.homepage = 'https://github.com/yegor256/jekyll-plantuml'
+  s.files = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   s.executables = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  s.test_files = s.files.grep(%r{^(test|spec|features)/})
-  s.rdoc_options = ["--charset=UTF-8"]
+  s.rdoc_options = ['--charset=UTF-8']
   s.extra_rdoc_files = %w[README.md LICENSE.txt]
   s.add_runtime_dependency 'jekyll', '>2.0'
-  s.add_development_dependency 'rake', '12.0.0'
+  s.metadata['rubygems_mfa_required'] = 'true'
 end

data/lib/jekyll-plantuml.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 # (The MIT License)
 #
-# Copyright (c) 2014-2019 Yegor Bugayenko
+# Copyright (c) 2014-2023 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,7 +25,12 @@
 require 'digest'
 require 'fileutils'
 
+# Jekyll main module.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2014-2023 Yegor Bugayenko
+# License:: MIT
 module Jekyll
+  # The main class
   class PlantumlBlock < Liquid::Block
     def initialize(tag_name, markup, tokens)
       super
@@ -33,18 +40,18 @@ module Jekyll
     def render(context)
       site = context.registers[:site]
       name = Digest::MD5.hexdigest(super)
-      if !File.exists?(File.join(site.dest, "uml/#{name}.svg"))
+      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.exists?(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') { |f|
+          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"

data/lib/version.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 # (The MIT License)
 #
-# Copyright (c) 2014-2019 Yegor Bugayenko
+# Copyright (c) 2014-2023 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
@@ -21,5 +23,5 @@
 # SOFTWARE.
 
 module PlantUML
-  VERSION = '1.3.4'
+  VERSION = '1.4.1'
 end

data/renovate.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": [
+    "config:base"
+  ]
+}

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/simple/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'jekyll', '4.3.2'
+gem 'jekyll-plantuml', path: '../..'

data/test-jekylls/simple/_config.yml

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

data/test-jekylls/simple/_layouts/default.html

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

data/test-jekylls/simple/_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 %}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-plantuml
 version: !ruby/object:Gem::Version
-  version: 1.3.4
+  version: 1.4.1
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-10 00:00:00.000000000 Z
+date: 2023-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -24,20 +24,6 @@ dependencies:
     - - ">"
       - !ruby/object:Gem::Version
         version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 12.0.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 12.0.0
 description: PlantUML diagrams in Jekyll pages
 email: yegor@tpc2.com
 executables: []
@@ -47,10 +33,12 @@ extra_rdoc_files:
 - LICENSE.txt
 files:
 - ".0pdd.yml"
-- ".github/ISSUE_TEMPLATE.md"
-- ".github/PULL_REQUEST_TEMPLATE.md"
+- ".github/workflows/pdd.yml"
+- ".github/workflows/rake.yml"
+- ".github/workflows/xcop.yml"
 - ".gitignore"
 - ".pdd"
+- ".rubocop.yml"
 - ".rultor.yml"
 - ".travis.yml"
 - Gemfile
@@ -60,10 +48,18 @@ files:
 - jekyll-plantuml.gemspec
 - lib/jekyll-plantuml.rb
 - lib/version.rb
-homepage: http://github.com/yegor256/jekyll-plantuml
+- renovate.json
+- test-jekylls/.gitignore
+- test-jekylls/Makefile
+- test-jekylls/simple/Gemfile
+- test-jekylls/simple/_config.yml
+- test-jekylls/simple/_layouts/default.html
+- test-jekylls/simple/_posts/2023/06/2023-06-02-test.md
+homepage: https://github.com/yegor256/jekyll-plantuml
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options:
 - "--charset=UTF-8"
@@ -80,8 +76,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.2.15
 signing_key: 
-specification_version: 2
+specification_version: 4
 summary: Jekyll PlantUML Automation
 test_files: []

data/.github/ISSUE_TEMPLATE.md

@@ -1,12 +0,0 @@
-Make sure the title of the issue explains the problem you are having. Also, the description of the issue must clearly explain what is broken, not what you want us to implement. Go through this checklist and make sure you answer "YES" to all points:
-
-  - You have all pre-requisites listed in README.md installed
-  - You are sure that you are not reporting a duplicate (search all issues)
-  - You say "is broken" or "doesn't work" in the title
-  - You tell us what you are trying to do
-  - You explain the results you are getting
-  - You suggest an alternative result you would like to see
-
-This article will help you understand what we are looking for: http://www.yegor256.com/2014/11/24/principles-of-bug-tracking.html
-
-Thank you for your contribution!

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -1,11 +0,0 @@
-Many thanks for your contribution, we truly appreciate it. We will appreciate it even more, if you make sure that you can say "YES" to each point in this short checklist:
-
-  - You made a small amount of changes (less than 100 lines, less than 10 files)
-  - You made changes related to only one bug (create separate PRs for separate problems)
-  - You are ready to defend your changes (there will be a code review)
-  - You don't touch what you don't understand
-  - You ran the build locally and it passed
-
-This article will help you understand what we are looking for: http://www.yegor256.com/2015/02/09/serious-code-reviewer.html
-
-Thank you for your contribution!