asciidoctor-diagram 1.5.9 → 1.5.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: abeb00e6c1a06050264ad6af1d4d2aeb1273e91f
-  data.tar.gz: 378319e93a82170c6544523d31bad76728643084
+  metadata.gz: b210b428ba58c0332817b65d14cbcf5140fa5d23
+  data.tar.gz: aa70930c788129a4b352b96b69d195ab40bacc59
 SHA512:
-  metadata.gz: 7d18137fa76b2612d93d25224aa18d771cc64cad4e24990384645bb8025f114ad4d038bdb543b4cddfb8d100c178e10115501bf73244a26bfb859029c06fa723
-  data.tar.gz: 9f9b51ea388030a030026b7bba7c58c05345ba989764324631ab6b5e85ded33350d85d0c27922a23de7c36f021b3a6e3664790ef7db07c23c9dbb92c5a880699
+  metadata.gz: db4a23dc9a0f9edf9683b58d5967153eefa2b938cb6da46a5a3bdfa9d0cde59ee1875a94f8ece94588b1f11023c6064ec1bdcac0f5fd33a48bcd6e479729197b
+  data.tar.gz: f353f04830771ed1141a3abef0b685af085f1157f9990ebdf93904dcc944317631c0c532177a7e5a1e070dec3eb97dc7649d395964d5dc8f65d361a9250d0a09

data/CHANGELOG.adoc

@@ -1,5 +1,13 @@
 = Asciidoctor-diagram Changelog
 
+== 1.5.10
+
+Bug Fixes::
+
+  * Issue #186: Avoid preprocessing of PlantUML stdlib !includes (@habamax)
+  * Issue #193: Update PlantUML to 2018.10
+  * Issue #194: Silence unitialized instance variable warning when using JRuby
+
 == 1.5.9
 
 Enhancements::

data/README.adoc

@@ -52,9 +52,11 @@ The generated file is then inserted into your converted document.
 
 Asciidoctor Diagram was inspired by the {uri-py-plantuml}[AsciiDoc PlantUML filter].
 
+ifndef::env-site[]
 Translations of the document are available in the following languages:
 
 * link:README_zh-CN.adoc[汉语]
+endif::[]
 
 ifdef::status[]
 [discrete]

data/lib/asciidoctor-diagram.rb

@@ -11,6 +11,7 @@ require_relative 'asciidoctor-diagram/salt'
 require_relative 'asciidoctor-diagram/shaape'
 require_relative 'asciidoctor-diagram/svgbob'
 require_relative 'asciidoctor-diagram/syntrax'
+require_relative 'asciidoctor-diagram/tikz'
 require_relative 'asciidoctor-diagram/umlet'
 require_relative 'asciidoctor-diagram/vega'
 require_relative 'asciidoctor-diagram/wavedrom'

data/lib/asciidoctor-diagram/a2s/extension.rb

@@ -28,12 +28,12 @@ module Asciidoctor
         font = source.attr('fontfamily', nil, inherit_prefix)
 
         generate_stdin(which(parent, 'a2s'), format.to_s, source.to_s) do |tool_path, output_path|
-          args = [tool_path, "-o#{Platform.native_path(output_path)}"]
+          args = [tool_path, '-o', Platform.native_path(output_path)]
 
           if sx && sy
-            args << "-s#{sx},#{sy}"
+            args << '-s' << "#{sx},#{sy}"
           elsif scale
-            args << "-s#{scale},#{scale}"
+            args << '-s' << "#{scale},#{scale}"
           end
 
           if noblur
@@ -41,7 +41,7 @@ module Asciidoctor
           end
 
           if font
-            args << "-f#{font}"
+            args << '-f' << font
           end
 
           args

data/lib/asciidoctor-diagram/plantuml/extension.rb

@@ -58,8 +58,8 @@ module Asciidoctor
           resolve_path(match, parent, parent.attr('imagesdir'))
         end
 
-        code.gsub!(/(?<=!include )[^!\n\r]+/) do |match|
-          resolve_path(match, parent, base_dir)
+        code.gsub!(/(?<=!include )\s*[^<][^!\n\r]+/) do |match|
+          resolve_path(match.lstrip, parent, base_dir)
         end
 
         code

data/lib/asciidoctor-diagram/tikz.rb

@@ -0,0 +1,7 @@
+require_relative 'extensions'
+
+Asciidoctor::Extensions.register do
+  require_relative 'tikz/extension'
+  block Asciidoctor::Diagram::TikZBlockProcessor, :tikz
+  block_macro Asciidoctor::Diagram::TikZBlockMacroProcessor, :tikz
+end

data/lib/asciidoctor-diagram/tikz/extension.rb

@@ -0,0 +1,68 @@
+require_relative '../extensions'
+require_relative '../util/cli_generator'
+require_relative '../util/platform'
+require_relative '../util/which'
+
+module Asciidoctor
+  module Diagram
+    # @private
+    module TikZ
+      include CliGenerator
+      include Which
+
+      def self.included(mod)
+        [:pdf, :svg].each do |f|
+          mod.register_format(f, :image) do |parent, source|
+            tikz(parent, source, f)
+          end
+        end
+      end
+
+      def tikz(parent, source, format)
+        latexpath = which(parent, 'pdflatex')
+
+        if format == :svg
+          svgpath = which(parent, 'pdf2svg')
+        else
+          svgpath = nil
+        end
+
+        latex = <<'END'
+\documentclass[border=2bp]{standalone}
+\usepackage{tikz}
+\begin{document}
+\begingroup
+\tikzset{every picture/.style={scale=1}}
+END
+        latex << source.to_s
+        latex << <<'END'
+\endgroup
+\end{document}
+END
+
+        pdf = generate_file(latexpath, 'tex', 'pdf', latex) do |tool_path, input_path, output_path|
+          {
+              :args => [tool_path, '-shell-escape', '-file-line-error', '-interaction=nonstopmode', '-output-directory', Platform.native_path(File.dirname(output_path)), Platform.native_path(input_path)],
+              :out_file => "#{File.dirname(input_path)}/#{File.basename(input_path, '.*')}.pdf"
+          }
+        end
+
+        if svgpath
+          generate_file(svgpath, 'pdf', 'svg', pdf) do |tool_path, input_path, output_path|
+            [tool_path, Platform.native_path(File.dirname(input_path)), Platform.native_path(File.dirname(output_path))]
+          end
+        else
+          pdf
+        end
+      end
+    end
+
+    class TikZBlockProcessor < Extensions::DiagramBlockProcessor
+      include TikZ
+    end
+
+    class TikZBlockMacroProcessor < Extensions::DiagramBlockMacroProcessor
+      include TikZ
+    end
+  end
+end

data/lib/asciidoctor-diagram/util/java_jruby.rb

@@ -6,7 +6,7 @@ module Asciidoctor
     # @private
     module Java
       def self.load
-        if @loaded
+        if defined?(@loaded) && @loaded
           return
         end
 

data/lib/asciidoctor-diagram/version.rb

@@ -1,5 +1,5 @@
 module Asciidoctor
   module Diagram
-    VERSION = "1.5.9"
+    VERSION = "1.5.10"
   end
 end

data/spec/plantuml_spec.rb

@@ -808,6 +808,54 @@ List <|.. ArrayList
     expect(content).to_not include('!include')
   end
 
+  it 'should not resolve stdlib !include directives' do
+    doc = <<-eos
+= Hello, PlantUML!
+Doc Writer <doc@example.com>
+
+== First Section
+
+[plantuml, format="svg"]
+----
+@startuml
+!include <tupadr3/common>
+!include <tupadr3/font-awesome/server>
+!include <tupadr3/font-awesome/database>
+
+title Styling example
+
+FA_SERVER(web1,web1) #Green
+FA_SERVER(web2,web2) #Yellow
+FA_SERVER(web3,web3) #Blue
+FA_SERVER(web4,web4) #YellowGreen
+
+FA_DATABASE(db1,LIVE,database,white) #RoyalBlue
+FA_DATABASE(db2,SPARE,database) #Red
+
+db1 <--> db2
+
+web1 <--> db1
+web2 <--> db1
+web3 <--> db1
+web4 <--> db1
+@enduml
+----
+    eos
+
+    d = load_asciidoc doc, :attributes => {'backend' => 'html5'}
+
+    expect(d).to_not be_nil
+
+    b = d.find { |bl| bl.context == :image }
+    expect(b).to_not be_nil
+
+    target = b.attributes['target']
+    expect(File.exist?(target)).to be true
+
+    content = File.read(target, :encoding => Encoding::UTF_8)
+    expect(content).to_not include('!include')
+  end
+
   it 'should support substitutions' do
     doc = <<-eos
 = Hello, PlantUML!

data/spec/test_helper.rb

@@ -18,6 +18,7 @@ require_relative '../lib/asciidoctor-diagram/plantuml/extension'
 require_relative '../lib/asciidoctor-diagram/shaape/extension'
 require_relative '../lib/asciidoctor-diagram/svgbob/extension'
 require_relative '../lib/asciidoctor-diagram/syntrax/extension'
+require_relative '../lib/asciidoctor-diagram/tikz/extension'
 require_relative '../lib/asciidoctor-diagram/umlet/extension'
 require_relative '../lib/asciidoctor-diagram/vega/extension'
 require_relative '../lib/asciidoctor-diagram/wavedrom/extension'

data/spec/tikz_spec.rb

@@ -0,0 +1,127 @@
+require_relative 'test_helper'
+
+code = <<-'eos'
+\begin{tikzpicture}[font=\LARGE] 
+
+% Figure parameters (tta and k needs to have the same sign)
+% They can be modified at will
+\def \tta{ -10.00000000000000 } % Defines the first angle of perspective
+\def \k{    -3.00000000000000 } % Factor for second angle of perspective
+\def \l{     6.00000000000000 } % Defines the width  of the parallelepiped
+\def \d{     5.00000000000000 } % Defines the depth  of the parallelepiped
+\def \h{     7.00000000000000 } % Defines the heigth of the parallelepiped
+
+% The vertices A,B,C,D define the reference plan (vertical)
+\coordinate (A) at (0,0); 
+\coordinate (B) at ({-\h*sin(\tta)},{\h*cos(\tta)}); 
+\coordinate (C) at ({-\h*sin(\tta)-\d*sin(\k*\tta)},
+                    {\h*cos(\tta)+\d*cos(\k*\tta)}); 
+\coordinate (D) at ({-\d*sin(\k*\tta)},{\d*cos(\k*\tta)}); 
+
+% The vertices Ap,Bp,Cp,Dp define a plane translated from the 
+% reference plane by the width of the parallelepiped
+\coordinate (Ap) at (\l,0); 
+\coordinate (Bp) at ({\l-\h*sin(\tta)},{\h*cos(\tta)}); 
+\coordinate (Cp) at ({\l-\h*sin(\tta)-\d*sin(\k*\tta)},
+                     {\h*cos(\tta)+\d*cos(\k*\tta)}); 
+\coordinate (Dp) at ({\l-\d*sin(\k*\tta)},{\d*cos(\k*\tta)}); 
+
+% Marking the vertices of the tetrahedron (red)
+% and of the parallelepiped (black)
+\fill[black]  (A) circle [radius=2pt]; 
+\fill[red]    (B) circle [radius=2pt]; 
+\fill[black]  (C) circle [radius=2pt]; 
+\fill[red]    (D) circle [radius=2pt]; 
+\fill[red]   (Ap) circle [radius=2pt]; 
+\fill[black] (Bp) circle [radius=2pt]; 
+\fill[red]   (Cp) circle [radius=2pt]; 
+\fill[black] (Dp) circle [radius=2pt]; 
+
+% painting first the three visible faces of the tetrahedron
+\filldraw[draw=red,bottom color=red!50!black, top color=cyan!50]
+  (B) -- (Cp) -- (D);
+\filldraw[draw=red,bottom color=red!50!black, top color=cyan!50]
+  (B) -- (D)  -- (Ap);
+\filldraw[draw=red,bottom color=red!50!black, top color=cyan!50]
+  (B) -- (Cp) -- (Ap);
+
+% Draw the edges of the tetrahedron
+\draw[red,-,very thick] (Ap) --  (D)
+                        (Ap) --  (B)
+                        (Ap) -- (Cp)
+                        (B)  --  (D)
+                        (Cp) --  (D)
+                        (B)  -- (Cp);
+
+% Draw the visible edges of the parallelepiped
+\draw [-,thin] (B)  --  (A)
+               (Ap) -- (Bp)
+               (B)  --  (C)
+               (D)  --  (C)
+               (A)  --  (D)
+               (Ap) --  (A)
+               (Cp) --  (C)
+               (Bp) --  (B)
+               (Bp) -- (Cp);
+
+% Draw the hidden edges of the parallelepiped
+\draw [gray,-,thin] (Dp) -- (Cp);
+                    (Dp) --  (D);
+                    (Ap) -- (Dp);
+
+% Name the vertices (the names are not consistent
+%  with the node name, but it makes the programming easier)
+\draw (Ap) node [right]           {$A$}
+      (Bp) node [right, gray]     {$F$}
+      (Cp) node [right]           {$D$}
+      (C)  node [left,gray]       {$E$}
+      (D)  node [left]            {$B$}
+      (A)  node [left,gray]       {$G$}
+      (B)  node [above left=+5pt] {$C$}
+      (Dp) node [right,gray]      {$H$};
+
+% Drawing again vertex $C$, node (B) because it disappeared behind the edges.
+% Drawing again vertex $H$, node (Dp) because it disappeared behind the edges.
+\fill[red]   (B) circle [radius=2pt]; 
+\fill[gray] (Dp) circle [radius=2pt]; 
+
+% From the reference and this example one can easily draw 
+% the twin tetrahedron jointly to this one.
+% Drawing the edges of the twin tetrahedron
+% switching the p_s: A <-> Ap, etc...
+\draw[red,-,dashed, thin] (A)  -- (Dp)
+                          (A)  -- (Bp)
+                          (A)  --  (C)
+                          (Bp) -- (Dp)
+                          (C)  -- (Dp)
+                          (Bp) --  (C);
+\end{tikzpicture}
+eos
+
+describe Asciidoctor::Diagram::TikZBlockMacroProcessor, :broken_on_travis, :broken_on_windows do
+  it "should generate PDF images when format is set to 'pdf'" do
+    File.write('tikz.txt', code)
+
+    doc = <<-eos
+= Hello, Tikz!
+Doc Writer <doc@example.com>
+
+== First Section
+
+tikz::tikz.txt[format="pdf"]
+    eos
+
+    d = load_asciidoc doc
+    expect(d).to_not be_nil
+
+    b = d.find { |bl| bl.context == :image }
+    expect(b).to_not be_nil
+
+    expect(b.content_model).to eq :empty
+
+    target = b.attributes['target']
+    expect(target).to_not be_nil
+    expect(target).to match(/\.pdf/)
+    expect(File.exist?(target)).to be true
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-diagram
 version: !ruby/object:Gem::Version
-  version: 1.5.9
+  version: 1.5.10
 platform: ruby
 authors:
 - Pepijn Van Eeckhoudt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-28 00:00:00.000000000 Z
+date: 2018-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -111,6 +111,8 @@ files:
 - lib/asciidoctor-diagram/svgbob/extension.rb
 - lib/asciidoctor-diagram/syntrax.rb
 - lib/asciidoctor-diagram/syntrax/extension.rb
+- lib/asciidoctor-diagram/tikz.rb
+- lib/asciidoctor-diagram/tikz/extension.rb
 - lib/asciidoctor-diagram/umlet.rb
 - lib/asciidoctor-diagram/umlet/extension.rb
 - lib/asciidoctor-diagram/util/binaryio.rb
@@ -151,6 +153,7 @@ files:
 - spec/svgbob_spec.rb
 - spec/syntrax_spec.rb
 - spec/test_helper.rb
+- spec/tikz_spec.rb
 - spec/umlet_spec.rb
 - spec/vega_spec.rb
 - spec/wavedrom_spec.rb
@@ -194,6 +197,7 @@ test_files:
 - spec/svgbob_spec.rb
 - spec/syntrax_spec.rb
 - spec/test_helper.rb
+- spec/tikz_spec.rb
 - spec/umlet_spec.rb
 - spec/vega_spec.rb
 - spec/wavedrom_spec.rb