asciidoctor-diagram 2.0.2 → 2.1.2

data/spec/test_helper.rb

@@ -6,29 +6,8 @@ require 'stringio'
 require 'tmpdir'
 
 require_relative '../lib/asciidoctor-diagram'
-require_relative '../lib/asciidoctor-diagram/a2s/extension'
-require_relative '../lib/asciidoctor-diagram/blockdiag/extension'
-require_relative '../lib/asciidoctor-diagram/bytefield'
-require_relative '../lib/asciidoctor-diagram/ditaa/extension'
-require_relative '../lib/asciidoctor-diagram/erd/extension'
-require_relative '../lib/asciidoctor-diagram/gnuplot/extension'
-require_relative '../lib/asciidoctor-diagram/graphviz/extension'
-require_relative '../lib/asciidoctor-diagram/lilypond/extension'
-require_relative '../lib/asciidoctor-diagram/meme/extension'
-require_relative '../lib/asciidoctor-diagram/mermaid/extension'
-require_relative '../lib/asciidoctor-diagram/msc/extension'
-require_relative '../lib/asciidoctor-diagram/nomnoml/extension'
-require_relative '../lib/asciidoctor-diagram/plantuml/extension'
-require_relative '../lib/asciidoctor-diagram/shaape/extension'
-require_relative '../lib/asciidoctor-diagram/smcat/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'
-
 require_relative '../lib/asciidoctor-diagram/util/platform'
+require_relative 'shared_examples'
 
 module Asciidoctor
   class AbstractBlock
@@ -106,12 +85,8 @@ RSpec.configure do |c|
       c.filter_run_excluding :broken_on_windows => true
   end
 
-  if ENV['TRAVIS']
-    c.filter_run_excluding :broken_on_travis => true
-  end
-
-  if ENV['APPVEYOR']
-    c.filter_run_excluding :broken_on_appveyor => true
+  if ENV['GITHUB_ACTIONS']
+    c.filter_run_excluding :broken_on_github => true
   end
 
   TEST_DIR = File.expand_path('testing')
@@ -133,4 +108,4 @@ RSpec.configure do |c|
       example.run
     end
   end
-end
+end

data/spec/tikz_spec.rb

@@ -1,6 +1,6 @@
 require_relative 'test_helper'
 
-code = <<-'eos'
+TIKZ_CODE = <<-'eos'
 \begin{tikzpicture}[font=\LARGE] 
 
 % Figure parameters (tta and k needs to have the same sign)
@@ -98,30 +98,80 @@ code = <<-'eos'
 \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)
+describe Asciidoctor::Diagram::TikZBlockMacroProcessor, :broken_on_windows do
+  include_examples "block_macro", :tikz, TIKZ_CODE, [:pdf]
+end
 
-    doc = <<-eos
-= Hello, Tikz!
+describe Asciidoctor::Diagram::TikZBlockProcessor, :broken_on_windows do
+  include_examples "block", :tikz, TIKZ_CODE, [:pdf]
+  
+  it "should support the preamble attribute" do
+      File.write("tikz.txt", TIKZ_CODE)
+
+      doc = <<'eos'
+= Hello, tikz!
 Doc Writer <doc@example.com>
 
 == First Section
 
-tikz::tikz.txt[format="pdf"]
-    eos
+[tikz, preamble="true"]
+----
+\usepackage{tkz-euclide}
+\usepackage{etoolbox}
+\usepackage{MnSymbol}
+\usetikzlibrary{angles,patterns,calc}
+\usepackage[most]{tcolorbox}
+\usepackage{pgfplots}
+\pgfplotsset{compat=1.7}
+~~~~
+\begin{tikzpicture}
+\tikzset{>=stealth}
+% draw axises and labels. We store a single coordinate to have the
+% direction of the x axis
+\draw[->] (-4,0) -- ++(8,0) coordinate (X) node[below] {$x$};
+\draw[->] (0,-4) -- ++(0,8) node[left] {$y$};
+
+\newcommand\CircleRadius{3cm}
+\draw (0,0) circle (\CircleRadius);
+% special method of noting the position of a point
+\coordinate (P) at (-495:\CircleRadius);
+
+\draw[thick]
+(0,0)
+coordinate (O) % store origin
+node[] {} % label
+--
+node[below left, pos=1] {$P(-\frac{\sqrt{2}}{2}, -\frac{\sqrt{2}}{2})$} % some labels
+node[below right, midway] {$r$}
+(P)
+--
+node[midway,left] {$y$}
+(P |- O) coordinate (Px) % projection onto horizontal line through
+                            % O, saved for later
+--
+node[midway, below] {$x$}
+cycle % closed path
+
+% pic trick is from the angles library, requires the three points of
+% the marked angle to be named
+
+pic [] {angle=X--O--P};
+\draw[->,red] (5mm, 0mm) arc (0:-495:5mm) node[midway,xshift=-4mm,yshift=3.5mm] {$-495^\circ$};
+% right angle marker
+\draw ($(Px)+(0.3, 0)$) -- ++(0, -0.3) -- ++(-0.3,0);
+\end{tikzpicture}
+----
+eos
 
-    d = load_asciidoc doc
-    expect(d).to_not be_nil
+      d = load_asciidoc doc
+      expect(d).to_not be_nil
 
-    b = d.find { |bl| bl.context == :image }
-    expect(b).to_not be_nil
+      b = d.find { |bl| bl.context == :image }
+      expect(b).to_not be_nil
 
-    expect(b.content_model).to eq :empty
+      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
+      target = b.attributes['target']
+      expect(target).to_not be_nil
   end
-end
+end

data/spec/umlet_spec.rb

@@ -1,6 +1,6 @@
 require_relative 'test_helper'
 
-code = <<-eos
+CODE = <<-eos
 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
 <diagram program="umlet" version="14.2">
   <zoom_level>10</zoom_level>
@@ -21,65 +21,9 @@ eos
 
 
 describe Asciidoctor::Diagram::UmletBlockMacroProcessor do
-  it "should generate SVG images when format omitted" do
-    File.write('umlet.uxf', code)
-
-    doc = <<-eos
-= Hello, Umlet!
-Doc Writer <doc@example.com>
-
-== First Section
-
-umlet::umlet.uxf[]
-    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(/\.svg$/)
-    expect(File.exist?(target)).to be true
-
-    expect(b.attributes['width']).to_not be_nil
-    expect(b.attributes['height']).to_not be_nil
-  end
+  include_examples "block_macro", :umlet, CODE, [:svg]
 end
 
-
 describe Asciidoctor::Diagram::UmletBlockProcessor do
-  it "should generate SVG images when format is omitted" do
-    doc = <<-eos
-= Hello, Umlet!
-Doc Writer <doc@example.com>
-
-== First Section
-
-[umlet]
-----
-#{code}
-----
-    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(/\.svg$/)
-    expect(File.exist?(target)).to be true
-
-    expect(b.attributes['width']).to_not be_nil
-    expect(b.attributes['height']).to_not be_nil
-  end
+  include_examples "block", :umlet, CODE, [:svg]
 end

data/spec/vega_spec.rb

@@ -1,6 +1,6 @@
 require_relative 'test_helper'
 
-vega_code = <<-eos
+VEGA_CODE = <<-eos
 {
   "$schema": "https://vega.github.io/schema/vega/v3.json",
   "width": 400,
@@ -98,7 +98,7 @@ vega_code = <<-eos
 }
 eos
 
-vegalite_code = <<-eos
+VEGALITE_CODE = <<-eos
 {
   "$schema": "https://vega.github.io/schema/vega-lite/v2.json",
   "description": "A simple bar chart with embedded data.",
@@ -118,124 +118,11 @@ vegalite_code = <<-eos
 eos
 
 describe Asciidoctor::Diagram::VegaBlockMacroProcessor, :broken_on_windows do
-  it "should generate vega SVG images when format omitted" do
-    File.write('vega.json', vega_code)
-
-    doc = <<-eos
-= Hello, Vega!
-Doc Writer <doc@example.com>
-
-== First Section
-
-vega::vega.json[]
-    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(/\.svg$/)
-    expect(File.exist?(target)).to be true
-
-    expect(b.attributes['width']).to_not be_nil
-    expect(b.attributes['height']).to_not be_nil
-  end
-
-  it "should generate vegalite SVG images when format omitted" do
-    File.write('vega.json', vegalite_code)
-
-    doc = <<-eos
-= Hello, Vega!
-Doc Writer <doc@example.com>
-
-== First Section
-
-vegalite::vega.json[]
-    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(/\.svg$/)
-    expect(File.exist?(target)).to be true
-
-    expect(b.attributes['width']).to_not be_nil
-    expect(b.attributes['height']).to_not be_nil
-  end
+  include_examples "block_macro", :vega, VEGA_CODE, [:svg]
+  # include_examples "block_macro", :vegalite, VEGALITE_CODE, [:svg]
 end
 
-
 describe Asciidoctor::Diagram::VegaBlockProcessor, :broken_on_windows do
-  it "should generate vega SVG images when format is omitted" do
-    doc = <<-eos
-= Hello, Vega!
-Doc Writer <doc@example.com>
-
-== First Section
-
-[vega]
-----
-#{vega_code}
-----
-    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(/\.svg$/)
-    expect(File.exist?(target)).to be true
-
-    expect(b.attributes['width']).to_not be_nil
-    expect(b.attributes['height']).to_not be_nil
-  end
-
-  it "should generate vegalite SVG images when format is omitted" do
-    doc = <<-eos
-= Hello, Vega!
-Doc Writer <doc@example.com>
-
-== First Section
-
-[vegalite]
-----
-#{vegalite_code}
-----
-    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(/\.svg$/)
-    expect(File.exist?(target)).to be true
-
-    expect(b.attributes['width']).to_not be_nil
-    expect(b.attributes['height']).to_not be_nil
-  end
+  include_examples "block", :vega, VEGA_CODE, [:svg]
+  # include_examples "block", :vegalite, VEGALITE_CODE, [:svg]
 end

data/spec/wavedrom_spec.rb

@@ -1,6 +1,6 @@
 require_relative 'test_helper'
 
-code = <<-eos
+WAVEDROM_CODE = <<-eos
 { signal : [
   { name: "clk",  wave: "p......" },
   { name: "bus",  wave: "x.34.5x",   data: "head body tail" },
@@ -9,206 +9,9 @@ code = <<-eos
 eos
 
 describe Asciidoctor::Diagram::WavedromBlockMacroProcessor, :broken_on_windows do
-  it "should generate PNG images when format is set to 'png'" do
-    File.write('wavedrom.txt', code)
-
-    doc = <<-eos
-= Hello, Wavedrom!
-Doc Writer <doc@example.com>
-
-== First Section
-
-wavedrom::wavedrom.txt[format="png"]
-    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(/\.png$/)
-    expect(File.exist?(target)).to be true
-
-    expect(b.attributes['width']).to_not be_nil
-    expect(b.attributes['height']).to_not be_nil
-  end
-
-  it "should generate SVG images when format is set to 'svg'" do
-    File.write('wavedrom.txt', code)
-
-    doc = <<-eos
-= Hello, Wavedrom!
-Doc Writer <doc@example.com>
-
-== First Section
-
-wavedrom::wavedrom.txt[format="svg"]
-    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(/\.svg/)
-    expect(File.exist?(target)).to be true
-
-    expect(b.attributes['width']).to_not be_nil
-    expect(b.attributes['height']).to_not be_nil
-  end
+  include_examples "block_macro", :wavedrom, WAVEDROM_CODE, [:png, :svg]
 end
 
 describe Asciidoctor::Diagram::WavedromBlockProcessor, :broken_on_windows do
-  it "should generate PNG images when format is set to 'png'" do
-    doc = <<-eos
-= Hello, Wavedrom!
-Doc Writer <doc@example.com>
-
-== First Section
-
-[wavedrom, format="png"]
-----
-#{code}
-----
-    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(/\.png$/)
-    expect(File.exist?(target)).to be true
-
-    expect(b.attributes['width']).to_not be_nil
-    expect(b.attributes['height']).to_not be_nil
-  end
-
-  it "should generate SVG images when format is set to 'svg'" do
-    doc = <<-eos
-= Hello, Wavedrom!
-Doc Writer <doc@example.com>
-
-== First Section
-
-[wavedrom, format="svg"]
-----
-#{code}
-----
-    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(/\.svg/)
-    expect(File.exist?(target)).to be true
-
-    expect(b.attributes['width']).to_not be_nil
-    expect(b.attributes['height']).to_not be_nil
-  end
-
-  it "should raise an error when when format is set to an invalid value" do
-    doc = <<-eos
-= Hello, Wavedrom!
-Doc Writer <doc@example.com>
-
-== First Section
-
-[wavedrom, format="foobar"]
-----
-----
-    eos
-
-    expect { load_asciidoc doc }.to raise_error(/support.*format/i)
-  end
-
-  it "should not regenerate images when source has not changed" do
-    File.write('wavedrom.txt', code)
-
-    doc = <<-eos
-= Hello, Wavedrom!
-Doc Writer <doc@example.com>
-
-== First Section
-
-wavedrom::wavedrom.txt
-
-[wavedrom, format="png"]
-----
-#{code}
-----
-    eos
-
-    d = load_asciidoc doc
-    b = d.find { |bl| bl.context == :image }
-    expect(b).to_not be_nil
-    target = b.attributes['target']
-    mtime1 = File.mtime(target)
-
-    sleep 1
-
-    d = load_asciidoc doc
-
-    mtime2 = File.mtime(target)
-
-    expect(mtime2).to eq mtime1
-  end
-
-  it "should handle two block macros with the same source" do
-    File.write('wavedrom.txt', code)
-
-    doc = <<-eos
-= Hello, Wavedrom!
-Doc Writer <doc@example.com>
-
-== First Section
-
-wavedrom::wavedrom.txt[]
-wavedrom::wavedrom.txt[]
-    eos
-
-    load_asciidoc doc
-    expect(File.exist?('wavedrom.png')).to be true
-  end
-
-  it "should respect target attribute in block macros" do
-    File.write('wavedrom.txt', code)
-
-    doc = <<-eos
-= Hello, Wavedrom!
-Doc Writer <doc@example.com>
-
-== First Section
-
-wavedrom::wavedrom.txt["foobar"]
-wavedrom::wavedrom.txt["foobaz"]
-    eos
-
-    load_asciidoc doc
-    expect(File.exist?('foobar.png')).to be true
-    expect(File.exist?('foobaz.png')).to be true
-    expect(File.exist?('wavedrom.png')).to be false
-  end
+  include_examples "block", :wavedrom, WAVEDROM_CODE, [:png, :svg]
 end