kramdown-plantuml 1.0.4 → 1.0.5

data/README.md

@@ -4,13 +4,14 @@
 ![Build][build-badge]
 ![No Java][no-java-build-badge]
 ![No PlantUML][no-plantuml-badge]
-[![MIT License][license-badge]][license]
+[![License][license-badge]][license]
+[![Dependabot Status][dependabot-badge]][dependabot]
 [![CLA assistant][cla-badge]][cla]
 [![Contributor Covenant][coc-badge]][coc]
 
 `kramdown-plantuml` allows you to use [PlantUML][plantuml] syntax within [fenced
-code blocks][fenced] in [Jekyll] with its default [Kramdown][kramdown] Markdown
-parser:
+code blocks][fenced] in [Kramdown][kramdown] ([Jekyll][jekyll]'s default
+Markdown parser):
 
 ````md
 ```plantuml
@@ -87,34 +88,33 @@ git commits and tags, and push the `.gem` file to [rubygems.org][gems].
 
 Bug reports and pull requests are welcome on [GitHub][github]. This project is
 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].
+expected to adhere to the [code of conduct][coc] and sign the
+[contributor's license agreement][cla].
 
 ## License
 
-The gem is available as open source under the terms of the [MIT
-License][license].
-
-## Code of Conduct
-
-Everyone interacting in the Kramdown::PlantUml project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct][coc].
-
-[plantuml]: https://plantuml.com/
-[jekyll]: https://jekyllrb.com/
-[kramdown]: https://kramdown.gettalong.org/
-[gems]: https://rubygems.org
-[github]: https://github.com/SwedbankPay/kramdown-plantuml/
-[coc]: ./CODE_OF_CONDUCT.md
-[coc-badge]: https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg
-[cla]: https://cla-assistant.io/SwedbankPay/kramdown-plantuml
-[cla-badge]: https://cla-assistant.io/readme/badge/SwedbankPay/design.swedbankpay.com
-[license]: https://opensource.org/licenses/MIT
-[license-badge]: https://img.shields.io/github/license/SwedbankPay/kramdown-plantuml
-[fenced]: https://www.markdownguide.org/extended-syntax/#syntax-highlighting
-[svg]: https://developer.mozilla.org/en-US/docs/Web/SVG
-[diagram-svg]: spec/diagram.svg
-[gem-badge]: https://badge.fury.io/rb/kramdown-plantuml.svg
-[gem-url]: https://rubygems.org/gems/kramdown-plantuml
-[build-badge]: https://github.com/SwedbankPay/kramdown-plantuml/workflows/Ruby%20Gem/badge.svg?branch=master
-[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
+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
+[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
+[fenced]:               https://www.markdownguide.org/extended-syntax/#syntax-highlighting
+[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/
+[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
+[plantuml]:             https://plantuml.com/
+[svg]:                  https://developer.mozilla.org/en-US/docs/Web/SVG

data/Rakefile

@@ -1,10 +1,23 @@
+# frozen_string_literal: true
+
 require 'rake'
 require 'bundler/gem_tasks'
 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.pattern = Dir.glob('spec/**/*_spec.rb')
+  t.rspec_opts = '--format documentation --tag ~no_plantuml --tag ~no_java'
+end
+
+namespace :codecov do
+  desc 'Uploads the latest SimpleCov result set to codecov.io'
+  task :upload do
+    require 'simplecov'
+    require 'codecov'
+
+    formatter = SimpleCov::Formatter::Codecov.new
+    formatter.format(SimpleCov::ResultMerger.merged_result)
+  end
 end
 
-task :default => :spec
+task default: :spec

data/kramdown-plantuml.gemspec

@@ -1,33 +1,41 @@
+# frozen_string_literal: true
+
 require_relative 'lib/which'
 require_relative 'lib/kramdown-plantuml/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "kramdown-plantuml"
+  spec.name          = 'kramdown-plantuml'
   spec.version       = Kramdown::PlantUml::VERSION
-  spec.authors       = ["Asbjørn Ulsberg"]
-  spec.email         = ["asbjorn@ulsberg.no"]
+  spec.authors       = ['Swedbank Pay']
+  spec.email         = ['opensource@swedbankpay.com']
 
-  spec.summary       = "Short summary"
-  spec.homepage      = "https://github.com/SwedbankPay/kramdown-plantuml"
-  spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.summary       = "kramdown-plantuml allows you to use PlantUML syntax within fenced code blocks with Kramdown (Jekyll's default Markdown parser)"
+  spec.homepage      = 'https://github.com/SwedbankPay/kramdown-plantuml'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
 
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/SwedbankPay/kramdown-plantuml"
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/SwedbankPay/kramdown-plantuml'
 
   # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-    if Which::which('git')
-      `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into Git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    if Which.which('git')
+      files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+      # Explicitly add plantuml.jar to the list of files as it is not committed to Git.
+      files.append(Dir['bin/**/plantuml*.jar'].first)
     else
       puts "Git not found, no files added to #{spec.name}."
     end
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'kramdown', '~> 2.3'
+  spec.add_dependency 'open3', '~> 0.1'
 
-  spec.add_development_dependency "rake", "~> 13.0"
-  spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.2'
+  spec.add_development_dependency 'rubocop', '~> 0.92'
 end

data/lib/kramdown-plantuml.rb

@@ -1,7 +1,11 @@
-require 'kramdown-plantuml/version'
-require 'kramdown-plantuml/converter'
-require 'kramdown_html'
+# frozen_string_literal: true
 
-module Kramdown::PlantUml
+require_relative 'kramdown-plantuml/version'
+require_relative 'kramdown-plantuml/converter'
+require_relative 'kramdown_html'
+
+module Kramdown
+  module PlantUml
     class Error < StandardError; end
+  end
 end

data/lib/kramdown-plantuml/converter.rb

@@ -1,45 +1,44 @@
-require 'which'
+# frozen_string_literal: true
+
 require 'open3'
+require_relative '../which'
 require_relative 'version'
 
-module Kramdown::PlantUml
-  class Converter
-    def initialize
-      dir = File.dirname __dir__
-      bin = File.join dir, "../bin"
-      bin = File.expand_path bin
-      @plant_uml_jar_file = File.join bin, "plantuml.1.2020.5.jar"
-
-      if not File.exists? @plant_uml_jar_file
-        raise IOError.new("'#{@plant_uml_jar_file}' does not exist")
+module Kramdown
+  module PlantUml
+    # Converts PlantUML markup to SVG
+    class Converter
+      def initialize
+        dir = File.dirname __dir__
+        jar_glob = File.join dir, '../bin/**/plantuml*.jar'
+        @plant_uml_jar_file = Dir[jar_glob].first
+
+        raise IOError, 'Java can not be found' unless Which.which('java')
+        raise IOError, "No 'plantuml.jar' file could be found" if @plant_uml_jar_file.nil?
+        raise IOError, "'#{@plant_uml_jar_file}' does not exist" unless File.exist? @plant_uml_jar_file
       end
 
-      unless Which::which("java")
-        raise IOError.new("Java can not be found")
-      end
-    end
+      def convert_plantuml_to_svg(content)
+        cmd = "java -jar #{@plant_uml_jar_file} -tsvg -pipe"
 
-    def convert_plantuml_to_svg(content)
-      cmd = "java -jar #{@plant_uml_jar_file} -tsvg -pipe"
+        stdout, stderr, = Open3.capture3(cmd, stdin_data: content)
 
-      stdout, stderr, _ = Open3.capture3(cmd, :stdin_data => content)
+        # Circumvention of https://bugs.openjdk.java.net/browse/JDK-8244621
+        raise stderr unless stderr.empty? || stderr.include?('CoreText note:')
 
-      unless stderr.empty?
-        raise stderr
-      end
-      
-      xml_prologue_start = "<?xml"
-      xml_prologue_end = "?>"
+        xml_prologue_start = '<?xml'
+        xml_prologue_end = '?>'
 
-      start_index = stdout.index(xml_prologue_start)
-      end_index = stdout.index(xml_prologue_end, xml_prologue_start.length) + xml_prologue_end.length
+        start_index = stdout.index(xml_prologue_start)
+        end_index = stdout.index(xml_prologue_end, xml_prologue_start.length) + xml_prologue_end.length
 
-      stdout.slice! start_index, end_index
+        stdout.slice! start_index, end_index
 
-      wrapper_element_start = "<div class=\"plantuml\">"
-      wrapper_element_end = "</div>"
+        wrapper_element_start = '<div class="plantuml">'
+        wrapper_element_end = '</div>'
 
-      return "#{wrapper_element_start}#{stdout}#{wrapper_element_end}"
+        "#{wrapper_element_start}#{stdout}#{wrapper_element_end}"
+      end
     end
   end
 end

data/lib/kramdown-plantuml/version.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 module Kramdown
   module PlantUml
-    @version = ENV['GEM_VERSION'] || '0.0.1-INVALID'
-    VERSION = @version
+    VERSION = '1.0.5'
   end
 end

data/lib/kramdown_html.rb

@@ -1,15 +1,23 @@
+# frozen_string_literal: true
+
 require 'kramdown'
-require "kramdown-plantuml/converter"
+require_relative 'kramdown-plantuml/converter'
+
+PlantUmlConverter = Kramdown::PlantUml::Converter
 
-class Kramdown::Converter::Html
-    alias_method :super_convert_codeblock, :convert_codeblock
+module Kramdown
+  module Converter
+    # Plugs into Kramdown::Converter::Html to provide conversion of PlantUML markup
+    # into beautiful SVG.
+    class Html
+      alias super_convert_codeblock convert_codeblock
 
-    def convert_codeblock(element, indent)
-        if element.attr["class"] != "language-plantuml"
-            return super_convert_codeblock(element, indent)
-        end
+      def convert_codeblock(element, indent)
+        return super_convert_codeblock(element, indent) if element.attr['class'] != 'language-plantuml'
 
-        converter = Kramdown::PlantUml::Converter.new
-        return converter.convert_plantuml_to_svg(element.value)
+        converter = PlantUmlConverter.new
+        converter.convert_plantuml_to_svg(element.value)
+      end
     end
+  end
 end

data/lib/which.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+
+# Wraps the `which` Unix utility
 class Which
   def self.which(cmd)
     exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']

data/pom.xml

@@ -0,0 +1,16 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
+                        http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <groupId>com.swedbankpay</groupId>
+    <artifactId>kramdown-plantuml</artifactId>
+    <version>INVALID</version>
+    <name>Kramdown::PlantUml</name>
+    <dependencies>
+        <dependency>
+            <groupId>net.sourceforge.plantuml</groupId>
+            <artifactId>plantuml</artifactId>
+            <version>1.2020.18</version>
+        </dependency>
+    </dependencies>
+</project>

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: kramdown-plantuml
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
-- Asbjørn Ulsberg
+- Swedbank Pay
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-28 00:00:00.000000000 Z
+date: 2020-10-09 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: open3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -38,32 +66,53 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.92'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.92'
 description: 
 email:
-- asbjorn@ulsberg.no
+- opensource@swedbankpay.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/scripts/build-gem.sh"
+- ".github/scripts/bundle-install.sh"
+- ".github/scripts/inspect-gem.sh"
+- ".github/scripts/publish-gem.sh"
+- ".github/scripts/test-gem.sh"
+- ".github/scripts/variables.sh"
 - ".github/workflows/no-java.yml"
 - ".github/workflows/no-plantuml.yml"
 - ".github/workflows/ruby.yml"
+- ".github/workflows/shell.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
-- bin/console
-- bin/plantuml.1.2020.5.jar
-- bin/setup
+- bin/net/sourceforge/plantuml/plantuml/1.2020.18/plantuml-1.2020.18.jar
 - kramdown-plantuml.gemspec
 - lib/kramdown-plantuml.rb
 - lib/kramdown-plantuml/converter.rb
 - lib/kramdown-plantuml/version.rb
 - lib/kramdown_html.rb
 - lib/which.rb
+- pom.xml
 homepage: https://github.com/SwedbankPay/kramdown-plantuml
 licenses:
 - MIT
@@ -85,8 +134,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: Short summary
+summary: kramdown-plantuml allows you to use PlantUML syntax within fenced code blocks
+  with Kramdown (Jekyll's default Markdown parser)
 test_files: []

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "kramdown-plantuml"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)