asciidoctor-kroki 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8c9c6ddeb0a82d775506971be5d140b80f3b06a0799a740430c109e7718312f4
+  data.tar.gz: 9f354c2a63e2426e40471ba6db010088e14163bc0a7bcd3cb3e9693a70685521
+SHA512:
+  metadata.gz: fde22365b6ce1ac9379bfefd955324b07ada0dbc3bc51e8edc90efce696c15bb1142068819d2ad56cedcf1315290d22451fe36d1caf10d891384d98bf9ca0e91
+  data.tar.gz: 2b1906da6dea90f743e104cfd0cb279f3b469b08c8ed791e9e39e10c0945568b60cdd2a2d374e45636847ccb04282d9391d804138ed7a57683af55ce4c874978

data/.gitignore

@@ -0,0 +1 @@
+pkg/

data/.rubocop.yml

@@ -0,0 +1,14 @@
+Style/Encoding:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 160
+
+Metrics/MethodLength:
+  Max: 50
+
+Metrics/CyclomaticComplexity:
+  Max : 10
+
+Metrics/AbcSize:
+  Max: 25

data/.ruby-version

@@ -0,0 +1 @@
+2.6.5

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,101 @@
+PATH
+  remote: .
+  specs:
+    asciidoctor-kroki (0.1.0)
+      asciidoctor (~> 2.0)
+      asciidoctor-pdf (= 1.5.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    Ascii85 (1.0.3)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    afm (0.2.2)
+    asciidoctor (2.0.10)
+    asciidoctor-pdf (1.5.3)
+      asciidoctor (>= 1.5.3, < 3.0.0)
+      concurrent-ruby (~> 1.1.0)
+      prawn (~> 2.2.0)
+      prawn-icon (~> 2.5.0)
+      prawn-svg (~> 0.30.0)
+      prawn-table (~> 0.2.0)
+      prawn-templates (~> 0.1.0)
+      safe_yaml (~> 1.0.0)
+      thread_safe (~> 0.3.0)
+      treetop (~> 1.6.0)
+      ttfunk (~> 1.5.0, >= 1.5.1)
+    ast (2.4.1)
+    concurrent-ruby (1.1.6)
+    css_parser (1.7.1)
+      addressable
+    diff-lcs (1.3)
+    hashery (2.1.2)
+    jaro_winkler (1.5.4)
+    parallel (1.19.1)
+    parser (2.7.1.3)
+      ast (~> 2.4.0)
+    pdf-core (0.7.0)
+    pdf-reader (2.4.0)
+      Ascii85 (~> 1.0.0)
+      afm (~> 0.2.1)
+      hashery (~> 2.0)
+      ruby-rc4
+      ttfunk
+    polyglot (0.3.5)
+    prawn (2.2.2)
+      pdf-core (~> 0.7.0)
+      ttfunk (~> 1.5)
+    prawn-icon (2.5.0)
+      prawn (>= 1.1.0, < 3.0.0)
+    prawn-svg (0.30.0)
+      css_parser (~> 1.6)
+      prawn (>= 0.11.1, < 3)
+    prawn-table (0.2.2)
+      prawn (>= 1.3.0, < 3.0.0)
+    prawn-templates (0.1.2)
+      pdf-reader (~> 2.0)
+      prawn (~> 2.2)
+    public_suffix (4.0.5)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.3)
+    rubocop (0.74.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    ruby-rc4 (0.1.5)
+    safe_yaml (1.0.5)
+    thread_safe (0.3.6)
+    treetop (1.6.10)
+      polyglot (~> 0.3)
+    ttfunk (1.5.1)
+    unicode-display_width (1.6.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  asciidoctor-kroki!
+  rake (~> 12.3.2)
+  rspec (~> 3.8.0)
+  rubocop (~> 0.74.0)
+
+BUNDLED WITH
+   1.17.3

data/Rakefile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+Dir.glob('tasks/*.rake').each { |file| load file }
+
+task default: %w[lint spec]

data/asciidoctor-kroki.gemspec

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |s|
+  s.name = 'asciidoctor-kroki'
+  s.version = '0.1.0'
+  s.summary = 'Asciidoctor extension to convert diagrams to images using Kroki'
+  s.description = 'An extension for Asciidoctor to convert diagrams to images using https://kroki.io'
+
+  s.authors = ['Guillaume Grossetie']
+  s.email = ['ggrossetie@yuzutech.fr']
+  s.homepage = 'https://github.com/Mogztter/asciidoctor-kroki'
+  s.license = 'MIT'
+  s.metadata = {
+    'bug_tracker_uri' => 'https://github.com/Mogztter/asciidoctor-kroki/issues',
+    'source_code_uri' => 'https://github.com/Mogztter/asciidoctor-kroki'
+  }
+  s.files = `git ls-files`.split($RS)
+  s.test_files = s.files.grep(%r{^(test|spec|features|tasks)/})
+  s.require_paths = ['lib']
+
+  s.add_runtime_dependency 'asciidoctor', '~> 2.0'
+  s.add_runtime_dependency 'asciidoctor-pdf', '1.5.3'
+
+  s.add_development_dependency 'rake', '~> 12.3.2'
+  s.add_development_dependency 'rspec', '~> 3.8.0'
+  s.add_development_dependency 'rubocop', '~> 0.74.0'
+end

data/lib/asciidoctor/extensions/asciidoctor_kroki.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'asciidoctor/extensions' unless RUBY_ENGINE == 'opal'
+require_relative 'asciidoctor_kroki/extension'
+
+Asciidoctor::Extensions.register do
+  names = %w[plantuml ditaa graphviz blockdiag seqdiag actdiag nwdiag packetdiag rackdiag c4plantuml erd mermaid nomnoml svgbob umlet vega vegalite wavedrom]
+  names.each do |name|
+    block_macro ::AsciidoctorExtensions::KrokiBlockMacroProcessor, name
+    block ::AsciidoctorExtensions::KrokiBlockProcessor, name
+  end
+end

data/lib/asciidoctor/extensions/asciidoctor_kroki/extension.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+require 'asciidoctor/extensions' unless RUBY_ENGINE == 'opal'
+require 'stringio'
+require 'zlib'
+
+# Asciidoctor extensions
+#
+module AsciidoctorExtensions
+  include Asciidoctor
+
+  # A block extension that converts a diagram into an image.
+  #
+  class KrokiBlockProcessor < Extensions::BlockProcessor
+    use_dsl
+
+    on_context :listing, :literal
+    name_positional_attributes 'target', 'format'
+
+    def process(parent, reader, attrs)
+      diagram_type = @name
+      diagram_text = reader.string
+      KrokiProcessor.process(self, parent, attrs, diagram_type, diagram_text)
+    end
+  end
+
+  # A block macro extension that converts a diagram into an image.
+  #
+  class KrokiBlockMacroProcessor < Asciidoctor::Extensions::BlockMacroProcessor
+    use_dsl
+
+    def process(parent, target, attrs)
+      diagram_type = @name
+      target = parent.apply_subs(target, ['attributes'])
+      diagram_text = read(target)
+      KrokiProcessor.process(self, parent, attrs, diagram_type, diagram_text)
+    end
+
+    def read(target)
+      if target.start_with?('http://') || target.start_with?('https://')
+        require 'open-uri'
+        URI.open(target, &:read)
+      else
+        File.open(target, &:read)
+      end
+    end
+  end
+
+  # Internal processor
+  #
+  class KrokiProcessor
+    class << self
+      def process(processor, parent, attrs, diagram_type, diagram_text)
+        doc = parent.document
+        diagram_text = prepend_plantuml_config(diagram_text, diagram_type, doc)
+        # If "subs" attribute is specified, substitute accordingly.
+        # Be careful not to specify "specialcharacters" or your diagram code won't be valid anymore!
+        if (subs = attrs['subs'])
+          diagram_text = parent.apply_subs(diagram_text, parent.resolve_subs(subs))
+        end
+        title = attrs.delete('title')
+        caption = attrs.delete('caption')
+        attrs.delete('opts')
+        role = attrs['role']
+        format = get_format(doc, attrs, diagram_type)
+        attrs['role'] = get_role(format, role)
+        attrs['alt'] = get_alt(attrs)
+        attrs['target'] = create_image_src(doc, diagram_type, format, diagram_text)
+        attrs['format'] = format
+        block = processor.create_image_block(parent, attrs)
+        block.title = title
+        block.assign_caption(caption, 'figure')
+        block
+      end
+
+      private
+
+      def prepend_plantuml_config(diagram_text, diagram_type, doc)
+        if diagram_type == :plantuml && doc.attr?('kroki-plantuml-include')
+          # TODO: this behaves different than the JS version
+          # The file should be added by !include #{plantuml_include}" once we have a preprocessor for ruby
+          config = File.read(doc.attr('kroki-plantuml-include'))
+          diagram_text = config + '\n' + diagram_text
+        end
+        diagram_text
+      end
+
+      def get_alt(attrs)
+        if (title = attrs['title'])
+          title
+        elsif (target = attrs['target'])
+          target
+        else
+          'Diagram'
+        end
+      end
+
+      def get_role(format, role)
+        if role
+          if format
+            "#{role} kroki-format-#{format} kroki"
+          else
+            "#{role} kroki"
+          end
+        else
+          'kroki'
+        end
+      end
+
+      def get_format(doc, attrs, diagram_type)
+        format = attrs['format'] || 'svg'
+        # The JavaFX preview doesn't support SVG well, therefore we'll use PNG format...
+        if doc.attr?('env-idea') && format == 'svg'
+          # ... unless the diagram library does not support PNG as output format!
+          # Currently, mermaid, nomnoml, svgbob, wavedrom only support SVG as output format.
+          svg_only_diagram_types = %w[:mermaid :nomnoml :svgbob :wavedrom]
+          format = 'png' unless svg_only_diagram_types.include?(diagram_type)
+        end
+        format
+      end
+
+      def create_image_src(doc, type, format, text)
+        data = Base64.urlsafe_encode64(Zlib::Deflate.deflate(text, 9))
+        "#{server_url(doc)}/#{type}/#{format}/#{data}"
+      end
+
+      def server_url(doc)
+        doc.attr('kroki-server-url') || 'https://kroki.io'
+      end
+    end
+  end
+end

data/spec/.rubocop.yml

@@ -0,0 +1,5 @@
+inherit_from:
+  - ../.rubocop.yml
+
+Metrics/BlockLength:
+  Max: 500

data/spec/asciidoctor_kroki_spec.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'asciidoctor'
+require_relative '../lib/asciidoctor/extensions/asciidoctor_kroki'
+
+describe ::AsciidoctorExtensions::KrokiBlockProcessor do
+  context 'convert to html5' do
+    it 'should convert a PlantUML block to an image' do
+      input = <<~'ADOC'
+        [plantuml]
+        ....
+        alice -> bob: hello
+        ....
+      ADOC
+      output = Asciidoctor.convert(input, standalone: false)
+      (expect output).to eql %(<div class="imageblock kroki">
+<div class="content">
+<img src="https://kroki.io/plantuml/svg/eNpLzMlMTlXQtVNIyk-yUshIzcnJBwA9iwZL" alt="Diagram">
+</div>
+</div>)
+    end
+    it 'should use png if env-idea is defined' do
+      input = <<~'ADOC'
+        [plantuml]
+        ....
+        alice -> bob: hello
+        ....
+      ADOC
+      output = Asciidoctor.convert(input, attributes: { 'env-idea' => '' }, standalone: false)
+      (expect output).to eql %(<div class="imageblock kroki">
+<div class="content">
+<img src="https://kroki.io/plantuml/png/eNpLzMlMTlXQtVNIyk-yUshIzcnJBwA9iwZL" alt="Diagram">
+</div>
+</div>)
+    end
+    it 'should include the plantuml-include file' do
+      input = <<~'ADOC'
+        [plantuml]
+        ....
+        alice -> bob: hello
+        ....
+      ADOC
+      output = Asciidoctor.convert(input, attributes: { 'env-idea' => '', 'kroki-plantuml-include' => 'spec/fixtures/config.puml' }, standalone: false)
+      (expect output).to eql %(<div class="imageblock kroki">
+<div class="content">
+<img src="https://kroki.io/plantuml/png/eNorzs7MK0gsSsxVyM3Py0_OKMrPTVUoKSpN5YrJS8zJTE5V0LVTSMpPslLISM3JyQcArVsRHA==" alt="Diagram">
+</div>
+</div>)
+    end
+  end
+end

data/spec/fixtures/config.puml

@@ -0,0 +1 @@
+skinparam monochrome true

data/tasks/bundler.rake

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+begin
+  require 'bundler/gem_tasks'
+rescue LoadError
+  warn $ERROR_INFO.message
+end

data/tasks/lint.rake

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new :lint

data/tasks/rspec.rake

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new :spec
+rescue LoadError
+  warn $ERROR_INFO.message
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: asciidoctor-kroki
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Guillaume Grossetie
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-09-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: asciidoctor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: asciidoctor-pdf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.5.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.5.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.74.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.74.0
+description: An extension for Asciidoctor to convert diagrams to images using https://kroki.io
+email:
+- ggrossetie@yuzutech.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- asciidoctor-kroki.gemspec
+- lib/asciidoctor/extensions/asciidoctor_kroki.rb
+- lib/asciidoctor/extensions/asciidoctor_kroki/extension.rb
+- spec/.rubocop.yml
+- spec/asciidoctor_kroki_spec.rb
+- spec/fixtures/config.puml
+- tasks/bundler.rake
+- tasks/lint.rake
+- tasks/rspec.rake
+homepage: https://github.com/Mogztter/asciidoctor-kroki
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/Mogztter/asciidoctor-kroki/issues
+  source_code_uri: https://github.com/Mogztter/asciidoctor-kroki
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Asciidoctor extension to convert diagrams to images using Kroki
+test_files:
+- spec/.rubocop.yml
+- spec/asciidoctor_kroki_spec.rb
+- spec/fixtures/config.puml
+- tasks/bundler.rake
+- tasks/lint.rake
+- tasks/rspec.rake