asciidoctor-diagram 2.0.2 → 2.1.2

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

@@ -2,8 +2,8 @@ module Asciidoctor
   module Diagram
     # @private
     module PDF
-      def self.get_image_size(_)
-        nil
+      def self.post_process_image(data, optimise)
+        [data, nil, nil]
       end
     end
   end

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

@@ -6,7 +6,7 @@ module Asciidoctor
     module PNG
       PNG_SIGNATURE = [137, 80, 78, 71, 13, 10, 26, 10].pack('CCCCCCCC')
 
-      def self.get_image_size(data)
+      def self.post_process_image(data, optimise)
         bio = BinaryIO.new(data)
         png_signature = bio.read_string(8)
         raise "Invalid PNG signature" unless png_signature == PNG_SIGNATURE
@@ -18,7 +18,7 @@ module Asciidoctor
 
         width = bio.read_uint32_be
         height = bio.read_uint32_be
-        [width, height]
+        [data, width, height]
       end
     end
   end

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

@@ -1,34 +1,82 @@
 require_relative 'binaryio'
+require 'rexml/document'
 
 module Asciidoctor
   module Diagram
     # @private
     module SVG
-      def self.get_image_size(data)
-        if m = START_TAG_REGEX.match(data)
-          start_tag = m[0]
-          if (w = WIDTH_REGEX.match(start_tag)) && (h = HEIGHT_REGEX.match(start_tag))
-            width = w[:value].to_i * to_px_factor(w[:unit])
-            height = h[:value].to_i * to_px_factor(h[:unit])
-            return [width.to_i, height.to_i]
-          end
+      def self.post_process_image(data, optimise)
+        svg = REXML::Document.new(data)
 
-          if v = VIEWBOX_REGEX.match(start_tag)
-            width = v[:width]
-            height = v[:height]
-            return [width.to_i, height.to_i]
-          end
+        root = svg.root
+
+        unless root.attributes['xmlns']
+          root.add_attribute('xmlns', 'http://www.w3.org/2000/svg')
         end
 
-        nil
+        unless root.attributes['preserveAspectRatio']
+          root.add_attribute('preserveAspectRatio', 'xMidYMid meet')
+        end
+
+        width = nil
+        height = nil
+
+        if (w = WIDTH_HEIGHT_REGEX.match(root.attributes['width'])) && (h = WIDTH_HEIGHT_REGEX.match(root.attributes['height']))
+          width = to_numeric(w[:value]) * to_px_factor(w[:unit])
+          height = to_numeric(h[:value]) * to_px_factor(h[:unit])
+        end
+
+        viewbox = root.attributes['viewBox']
+        if (v = VIEWBOX_REGEX.match(viewbox)) && width.nil? && height.nil?
+          width = to_numeric(v[:width])
+          height = to_numeric(v[:height])
+        end
+
+        if viewbox.nil? && width && height
+          root.add_attribute('viewBox', "0 0 #{width.to_s} #{height.to_s}")
+        end
+
+        indent = 2
+        if optimise
+          remove_comments(svg)
+          indent = -1
+        end
+
+        patched_svg = ""
+        svg.write(:output => patched_svg, :indent => indent, :transitive => true)
+
+        [patched_svg, width, height]
       end
 
       private
 
-      START_TAG_REGEX = /<svg[^>]*>/
-      WIDTH_REGEX = /width="(?<value>\d+(?:\.\d+)?)(?<unit>[a-zA-Z]+)?"/
-      HEIGHT_REGEX = /height="(?<value>\d+(?:\.\d+)?)(?<unit>[a-zA-Z]+)?"/
-      VIEWBOX_REGEX = /viewBox="\d+(?:\.\d+)? \d+(?:\.\d+)? (?<width>\d+(?:\.\d+)?) (?<height>\d+(?:\.\d+)?)"/
+      def self.remove_comments(parent)
+        comments = []
+
+        parent.each do |child|
+          case child
+            when REXML::Comment
+              comments << child
+            when REXML::Parent
+              remove_comments(child)
+          end
+        end
+
+        comments.each do |c|
+          c.remove
+        end
+      end
+
+      def self.to_numeric(text)
+        if text.include? '.'
+          text.to_f
+        else
+          text.to_i
+        end
+      end
+
+      WIDTH_HEIGHT_REGEX = /^\s*(?<value>\d+(?:\.\d+)?)\s*(?<unit>[a-zA-Z]+)?\s*$/
+      VIEWBOX_REGEX = /^\s*\d+(?:\.\d+)?\s*\d+(?:\.\d+)?\s*(?<width>\d+(?:\.\d+)?)\s*(?<height>\d+(?:\.\d+)?)\s*$/
 
       def self.to_px_factor(unit)
         case unit

data/lib/asciidoctor-diagram/vega/converter.rb

@@ -15,9 +15,9 @@ module Asciidoctor
       end
 
 
-      def collect_options(source, name)
+      def collect_options(source)
         {
-            :vegalite => name.to_s.include?('lite') || source.attr('vegalite')
+            :vegalite => source.diagram_type.to_s.include?('lite') || source.attr('vegalite')
         }
       end
 

data/lib/asciidoctor-diagram/version.rb

@@ -1,5 +1,5 @@
 module Asciidoctor
   module Diagram
-    VERSION = "2.0.2"
+    VERSION = "2.1.2"
   end
 end

data/spec/a2s_spec.rb

@@ -1,6 +1,6 @@
 require_relative 'test_helper'
 
-code = <<-eos
+A2S_CODE = <<-eos
                       .--.            .---.  .---. .---.  .---.    .---.  .---. 
                       |  |   OS API   '---'  '---' '---'  '---'    '---'  '---' 
                       v  |              |      |     |      |        |      |   
@@ -20,148 +20,10 @@ code = <<-eos
                                       '---------------------------------------'
 eos
 
-describe Asciidoctor::Diagram::AsciiToSvgBlockMacroProcessor, :broken_on_travis, :broken_on_windows do
-  it "should generate SVG images when format is set to 'svg'" do
-    File.write('a2s.txt', code)
-
-    doc = <<-eos
-= Hello, a2s!
-Doc Writer <doc@example.com>
-
-== First Section
-
-a2s::a2s.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
+describe Asciidoctor::Diagram::AsciiToSvgBlockMacroProcessor do
+  include_examples "block_macro", :a2s, A2S_CODE, [:svg]
 end
 
-describe Asciidoctor::Diagram::AsciiToSvgBlockProcessor, :broken_on_travis, :broken_on_windows do
-  it "should generate SVG images when format is set to 'svg'" do
-    doc = <<-eos
-= Hello, a2s!
-Doc Writer <doc@example.com>
-
-== First Section
-
-[a2s, 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, a2s!
-Doc Writer <doc@example.com>
-
-== First Section
-
-[a2s, 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('a2s.txt', code)
-
-    doc = <<-eos
-= Hello, a2s!
-Doc Writer <doc@example.com>
-
-== First Section
-
-a2s::a2s.txt
-
-[a2s]
-----
-#{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('a2s.txt', code)
-
-    doc = <<-eos
-= Hello, a2s!
-Doc Writer <doc@example.com>
-
-== First Section
-
-a2s::a2s.txt[]
-a2s::a2s.txt[]
-    eos
-
-    load_asciidoc doc
-    expect(File.exist?('a2s.svg')).to be true
-  end
-
-  it "should respect target attribute in block macros" do
-    File.write('a2s.txt', code)
-
-    doc = <<-eos
-= Hello, a2s!
-Doc Writer <doc@example.com>
-
-== First Section
-
-a2s::a2s.txt["foobar"]
-a2s::a2s.txt["foobaz"]
-    eos
-
-    load_asciidoc doc
-    expect(File.exist?('foobar.svg')).to be true
-    expect(File.exist?('foobaz.svg')).to be true
-    expect(File.exist?('a2s.svg')).to be false
-  end
-end
+describe Asciidoctor::Diagram::AsciiToSvgBlockProcessor do
+  include_examples "block", :svgbob, A2S_CODE, [:svg]
+end

data/spec/blockdiag_spec.rb

@@ -1,214 +1,16 @@
 require_relative 'test_helper'
 
-code = <<-eos
+BLOCKDIAG_CODE = <<-eos
 blockdiag {
    A -> B -> C -> D;
    A -> E -> F -> G;
 }
 eos
 
-describe Asciidoctor::Diagram::BlockDiagBlockMacroProcessor, :broken_on_appveyor do
-  it "should generate PNG images when format is set to 'png'" do
-    File.write('blockdiag.txt', code)
-
-    doc = <<-eos
-= Hello, BlockDiag!
-Doc Writer <doc@example.com>
-
-== First Section
-
-blockdiag::blockdiag.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
+describe Asciidoctor::Diagram::BlockDiagBlockMacroProcessor do
+  include_examples "block_macro", :blockdiag, BLOCKDIAG_CODE, [:png, :svg, :pdf]
 end
 
-describe Asciidoctor::Diagram::BlockDiagBlockProcessor, :broken_on_appveyor do
-  it "should generate PNG images when format is set to 'png'" do
-    doc = <<-eos
-= Hello, BlockDiag!
-Doc Writer <doc@example.com>
-
-== First Section
-
-[blockdiag, 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, BlockDiag!
-Doc Writer <doc@example.com>
-
-== First Section
-
-[blockdiag, 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 generate PDF files when format is set to 'pdf'" do
-    doc = <<-eos
-= Hello, BlockDiag!
-Doc Writer <doc@example.com>
-
-== First Section
-
-[blockdiag, format="pdf"]
-----
-#{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(/\.pdf/)
-    expect(File.exist?(target)).to be true
-
-    expect(b.attributes['width']).to be_nil
-    expect(b.attributes['height']).to be_nil
-  end
-
-  it "should raise an error when when format is set to an invalid value" do
-    doc = <<-eos
-= Hello, BlockDiag!
-Doc Writer <doc@example.com>
-
-== First Section
-
-[blockdiag, 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('blockdiag.txt', code)
-
-    doc = <<-eos
-= Hello, BlockDiag!
-Doc Writer <doc@example.com>
-
-== First Section
-
-blockdiag::blockdiag.txt
-
-[blockdiag, 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('blockdiag.txt', code)
-
-    doc = <<-eos
-= Hello, BlockDiag!
-Doc Writer <doc@example.com>
-
-== First Section
-
-blockdiag::blockdiag.txt[]
-blockdiag::blockdiag.txt[]
-    eos
-
-    load_asciidoc doc
-    expect(File.exist?('blockdiag.png')).to be true
-  end
-
-  it "should respect target attribute in block macros" do
-    File.write('blockdiag.txt', code)
-
-    doc = <<-eos
-= Hello, BlockDiag!
-Doc Writer <doc@example.com>
-
-== First Section
-
-blockdiag::blockdiag.txt["foobar"]
-blockdiag::blockdiag.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?('blockdiag.png')).to be false
-  end
-end
+describe Asciidoctor::Diagram::BlockDiagBlockProcessor do
+  include_examples "block", :blockdiag, BLOCKDIAG_CODE, [:png, :svg, :pdf]
+end