asciidoctor-mermaid 0.1.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc6cd61b1b5833e22f2f3865f120f7972e117a7a25a1636e25a387cd9b6e320e
-  data.tar.gz: c185efdacc78a3a50f649126dc16566008c4b7f6f1d4ac93c3ac66bdb0bbf0cb
+  metadata.gz: 577319efee650e33d1db7ee0a56917ae8b6107fdfaeee67ea9018a857c189529
+  data.tar.gz: 5c2df794560ef01598f5dd475310e894a9f68bd60b4b0a20d4acaf870536180c
 SHA512:
-  metadata.gz: 4580feaec78a7cb864e6f62e1fc8753c3c4fae3e709df8ae0a444c20487921e7e4cd1fc0991b240f06fbc250ad52a4936d6847d24fbd65035e5da2ec63b69d18
-  data.tar.gz: 39e5f2d9127491299d97b1839d52c0eecfcb2b0ef25b0a47c82ca9c3605772f717b0d8a0516b9718de3901dfe08007dd2a6aac9539ac1631ae63c338353e9e81
+  metadata.gz: 3996fb7d9d1c3a15a0013489763154ee68881a05a5f1e67d3f0a9d31310899ed717f201e33edd835154022edad3be3b5592b8db0fc70b1fa6514f78641eb8cab
+  data.tar.gz: 12a5dc56e46770bb26b41fb2b800fc5314d05b67b7d7a42ad62c41a4dedf7ac232ee930c0b298eb07b8001ad43cec17d651338549631c70ae264d795082677de

data/lib/asciidoctor-mermaid/extension.rb

@@ -6,13 +6,17 @@ require_relative 'cli'
 class MermaidTreeProcessor < Asciidoctor::Extensions::TreeProcessor
   def process(document)
     document.blocks.map! do |block|
-      if block.attributes['style'] === 'source' &&
+      if block.respond_to?(:blocks) && !block.blocks.empty?
+        process(block)
+      elsif block.respond_to?(:attributes) &&
+           block.attributes['style'] === 'source' &&
            block.attributes['language'] === 'mermaid'
         self.convert_block(block)
       else
         block
       end
     end
+    document
   end
 
   protected

data/lib/asciidoctor-mermaid/pdf.rb

@@ -0,0 +1,45 @@
+# An alternative entry point to be used w/ asciidoctor-pdf
+require 'asciidoctor/extensions'
+require 'digest/md5'
+require 'tempfile'
+require_relative 'cli'
+
+class MermaidPDFTreeProcessor < Asciidoctor::Extensions::TreeProcessor
+  def process(document)
+    document.blocks.map! do |block|
+      if block.respond_to?(:blocks) && !block.blocks.empty?
+        process(block)
+      elsif block.respond_to?(:attributes) &&
+           block.attributes['style'] === 'source' &&
+           block.attributes['language'] === 'mermaid'
+        self.convert_block(block)
+      else
+        block
+      end
+    end
+    document
+  end
+
+  protected
+
+  def convert_block(block)
+    # TODO: Currently I'm unsure how to clean up tmp images after pdf generation completes
+    img = self.render_svg(block.source)
+    Asciidoctor::Block.new block.parent,
+                           :image,
+                           attributes: {
+                             'imagesdir' => nil,
+                             'target' => img.path,
+                             'align' => 'center',
+                           }
+  end
+
+  def render_svg(content)
+    file_name = Digest::MD5.hexdigest(content)
+    output_file = Tempfile.new([file_name, '.png'])
+    ::Asciidoctor::Mermaid::Cli.run(content, "-o#{output_file.path}")
+    output_file
+  end
+end
+
+Asciidoctor::Extensions.register { treeprocessor MermaidPDFTreeProcessor }

data/lib/asciidoctor-mermaid/version.rb

@@ -1,5 +1,5 @@
 module Asciidoctor
   module Mermaid
-    VERSION = '0.1.1'
+    VERSION = '0.4.0'
   end
 end

data/spec/extension_spec.rb

@@ -1,8 +1,7 @@
 require 'asciidoctor'
 require 'asciidoctor-mermaid'
-require 'pry'
 
-MERMAID_DOC = <<-eos
+mermaid_doc = <<-eos
 lorem ipsum 
 
 ```mermaid
@@ -11,9 +10,37 @@ flowchart LR
 ```
 eos
 
+array_handling = <<-eos
+[glossary]
+== Glossary
+
+- [[g-foo, FOO]]
+FOO::
+
+This is the first entry
+
+- [[g-bar, BAR]]
+BAR::
+
+This is the second entry
+eos
+
 describe 'extension' do
+  before do
+    Asciidoctor::Extensions.unregister_all
+    Asciidoctor::Extensions.register { treeprocessor MermaidTreeProcessor }
+  end
+
   it 'renders a basic mermaid diagram' do
-    doc = Asciidoctor.convert MERMAID_DOC
+    doc = Asciidoctor.convert mermaid_doc
+    expect(doc).to include('id="mermaid-')
     expect(doc).to include('flowchart node text')
   end
+
+  # On v0.3.0 this should fail with NoMethodError: undefined method `blocks' for #<Array...>
+  it 'renders a document containing arrays' do
+    doc = Asciidoctor.convert array_handling
+    expect(doc).to include('FOO')
+    expect(doc).to include('BAR')
+  end
 end

data/spec/pdf_extension_spec.rb

@@ -0,0 +1,46 @@
+require 'asciidoctor'
+require 'asciidoctor-mermaid/pdf'
+
+mermaid_doc = <<-eos
+lorem ipsum 
+
+```mermaid
+flowchart LR
+    id1[flowchart node text]
+```
+eos
+
+array_handling = <<-eos
+[glossary]
+== Glossary
+
+- [[g-foo, FOO]]
+FOO::
+
+This is the first entry
+
+- [[g-bar, BAR]]
+BAR::
+
+This is the second entry
+eos
+
+describe 'pdf extension' do
+  before do
+    Asciidoctor::Extensions.unregister_all
+    Asciidoctor::Extensions.register { treeprocessor MermaidPDFTreeProcessor }
+  end
+
+  it 'renders a basic mermaid diagram' do
+    doc = Asciidoctor.convert mermaid_doc
+    expect(doc).to include('class="imageblock text-center"')
+    expect(doc).to include('<img src=')
+  end
+
+  # On v0.3.0 this should fail with NoMethodError: undefined method `blocks' for #<Array...>
+  it 'renders a document containing arrays' do
+    doc = Asciidoctor.convert array_handling
+    expect(doc).to include('FOO')
+    expect(doc).to include('BAR')
+  end
+end

data/spec/spec_helper.rb

@@ -1,4 +1,4 @@
-require 'rspec/snapshot'
+require 'asciidoctor'
 
 # This file was generated by the `rspec --init` command. Conventionally, all
 # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-mermaid
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Justin Bennett
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-05 00:00:00.000000000 Z
+date: 2022-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -104,8 +104,10 @@ files:
 - lib/asciidoctor-mermaid.rb
 - lib/asciidoctor-mermaid/cli.rb
 - lib/asciidoctor-mermaid/extension.rb
+- lib/asciidoctor-mermaid/pdf.rb
 - lib/asciidoctor-mermaid/version.rb
 - spec/extension_spec.rb
+- spec/pdf_extension_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/oxidecomputer/asciidoctor-mermaid
 licenses:
@@ -133,4 +135,5 @@ summary: An Asciidoctor extension that transforms Mermaid diagrams in markdown c
   to inline svgs.
 test_files:
 - spec/extension_spec.rb
+- spec/pdf_extension_spec.rb
 - spec/spec_helper.rb