asciidoctor-diagram 1.5.18 → 2.0.4

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

@@ -1,34 +1,61 @@
 require_relative 'binaryio'
+require 'rexml/document'
+require 'bigdecimal'
+require 'bigdecimal/util'
 
 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
-
-          if v = VIEWBOX_REGEX.match(start_tag)
-            width = v[:width]
-            height = v[:height]
-            return [width.to_i, height.to_i]
-          end
+      def self.post_process_image(data)
+        svg = REXML::Document.new(data)
+
+        root = svg.root
+
+        unless root.attributes['xmlns']
+          root.add_attribute('xmlns', 'http://www.w3.org/2000/svg')
+        end
+
+        unless root.attributes['preserveAspectRatio']
+          root.add_attribute('preserveAspectRatio', 'xMidYMid meet')
         end
 
-        nil
+        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
+
+        patched_svg = ""
+        svg.write(:output => patched_svg, :indent => 2)
+
+        [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.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/util/which.rb

@@ -15,35 +15,6 @@ module Asciidoctor
 
         nil
       end
-
-      def which(parent_block, cmd, options = {})
-        attr_names = options[:attrs] || options.fetch(:alt_attrs, []) + [cmd]
-        cmd_names = [cmd] + options.fetch(:alt_cmds, [])
-
-        cmd_var = 'cmd-' + attr_names[0]
-
-        if config.key? cmd_var
-          cmd_path = config[cmd_var]
-        else
-          cmd_path = attr_names.map { |attr_name| parent_block.attr(attr_name, nil, true) }.find { |attr| !attr.nil? }
-
-          unless cmd_path && File.executable?(cmd_path)
-            cmd_paths = cmd_names.map do |c|
-              ::Asciidoctor::Diagram::Which.which(c, :path => options[:path])
-            end
-
-            cmd_path = cmd_paths.reject { |c| c.nil? }.first
-          end
-
-          config[cmd_var] = cmd_path
-
-          if cmd_path.nil? && options.fetch(:raise_on_error, true)
-            raise "Could not find the #{cmd_names.map { |c| "'#{c}'" }.join(', ')} executable in PATH; add it to the PATH or specify its location using the '#{attr_names[0]}' document attribute"
-          end
-        end
-
-        cmd_path
-      end
     end
   end
 end

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

@@ -0,0 +1,47 @@
+require_relative '../diagram_converter'
+require_relative '../util/cli_generator'
+require_relative '../util/platform'
+
+module Asciidoctor
+  module Diagram
+    # @private
+    class VegaConverter
+      include DiagramConverter
+      include CliGenerator
+
+
+      def supported_formats
+        [:svg, :png]
+      end
+
+
+      def collect_options(source)
+        {
+            :vegalite => source.diagram_type.to_s.include?('lite') || source.attr('vegalite')
+        }
+      end
+
+      def convert(source, format, options)
+        base_dir = source.base_dir
+
+        code = source.to_s
+
+        if code.include?('/schema/vega-lite/') || options[:vegalite]
+          vega_code = generate_stdin_stdout(source.find_command("vl2vg"), code)
+        else
+          vega_code = code
+        end
+
+        generate_file(source.find_command("vg2#{format}"), "json", format.to_s, vega_code) do |tool_path, input_path, output_path|
+          args = [tool_path, '--base', Platform.native_path(base_dir)]
+          if format == :svg
+            args << '--header'
+          end
+
+          args << Platform.native_path(input_path)
+          args << Platform.native_path(output_path)
+        end
+      end
+    end
+  end
+end

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

@@ -1,52 +1,14 @@
-require_relative '../extensions'
-require_relative '../util/cli_generator'
-require_relative '../util/platform'
-require_relative '../util/which'
+require_relative '../diagram_processor'
+require_relative 'converter'
 
 module Asciidoctor
   module Diagram
-    # @private
-    module Vega
-      include CliGenerator
-      include Which
-
-      def self.included(mod)
-        [:svg, :png].each do |f|
-          mod.register_format(f, :image) do |parent, source|
-            vega(parent, source, f)
-          end
-        end
-      end
-
-      def vega(parent, source, format)
-        base_dir = source.base_dir
-
-        code = source.to_s
-
-        if code.include?('/schema/vega-lite/') || name.to_s.include?('lite') || source.attr('vegalite')
-          vega_code = generate_stdin_stdout(which(parent, "vl2vg"), code)
-        else
-          vega_code = code
-        end
-
-        generate_file(which(parent, "vg2#{format}"), "json", format.to_s, vega_code) do |tool_path, input_path, output_path|
-          args = [tool_path, '--base', Platform.native_path(base_dir)]
-          if format == :svg
-            args << '--header'
-          end
-
-          args << Platform.native_path(input_path)
-          args << Platform.native_path(output_path)
-        end
-      end
-    end
-
-    class VegaBlockProcessor < Extensions::DiagramBlockProcessor
-      include Vega
+    class VegaBlockProcessor < DiagramBlockProcessor
+      use_converter VegaConverter
     end
 
-    class VegaBlockMacroProcessor < Extensions::DiagramBlockMacroProcessor
-      include Vega
+    class VegaBlockMacroProcessor < DiagramBlockMacroProcessor
+      use_converter VegaConverter
     end
   end
 end

data/lib/asciidoctor-diagram/version.rb

@@ -1,5 +1,5 @@
 module Asciidoctor
   module Diagram
-    VERSION = "1.5.18"
+    VERSION = "2.0.4"
   end
 end

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

@@ -0,0 +1,50 @@
+require_relative '../diagram_converter'
+require_relative '../util/cli_generator'
+require_relative '../util/platform'
+
+module Asciidoctor
+  module Diagram
+    # @private
+    class WavedromConverter
+      include DiagramConverter
+      include CliGenerator
+
+
+      def supported_formats
+        [:png, :svg]
+      end
+
+
+      def convert(source, format, options)
+        wavedrom_cli = source.find_command('wavedrom-cli', :raise_on_error => false)
+        if wavedrom_cli
+          generate_file(wavedrom_cli, 'wvd', format.to_s, source.to_s) do |tool_path, input_path, output_path|
+            [Platform.native_path(tool_path), '--input', Platform.native_path(input_path), "--#{format.to_s}", Platform.native_path(output_path)]
+          end
+        else
+          wavedrom_cli = source.find_command('wavedrom', :raise_on_error => false)
+          phantomjs = source.find_command('phantomjs', :alt_attrs => ['phantomjs_2'], :raise_on_error => false)
+
+          if wavedrom_cli && !wavedrom_cli.include?('WaveDromEditor') && phantomjs
+            generate_file(wavedrom_cli, 'wvd', format.to_s, source.to_s) do |tool_path, input_path, output_path|
+              [phantomjs, Platform.native_path(tool_path), '-i', Platform.native_path(input_path), "-#{format.to_s[0]}", Platform.native_path(output_path)]
+            end
+          else
+            if ::Asciidoctor::Diagram::Platform.os == :macosx
+              wavedrom = source.find_command('WaveDromEditor.app', :alt_cmds => ['wavedrom-editor.app'], :attrs => ['WaveDromEditorApp'], :path => ['/Applications'])
+              if wavedrom
+                wavedrom = File.join(wavedrom, 'Contents/MacOS/nwjs')
+              end
+            else
+              wavedrom = source.find_command('WaveDromEditor')
+            end
+
+            generate_file(wavedrom, 'wvd', format.to_s, source.to_s) do |tool_path, input_path, output_path|
+              [tool_path, 'source', Platform.native_path(input_path), format.to_s, Platform.native_path(output_path)]
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,54 +1,14 @@
-require_relative '../extensions'
-require_relative '../util/cli_generator'
-require_relative '../util/platform'
-require_relative '../util/which'
+require_relative '../diagram_processor'
+require_relative 'converter'
 
 module Asciidoctor
   module Diagram
-    # @private
-    module Wavedrom
-      include CliGenerator
-      include Which
-
-      def self.included(mod)
-        [:png, :svg].each do |f|
-          mod.register_format(f, :image) do |parent, source|
-            wavedrom(parent, source, f)
-          end
-        end
-      end
-
-      def wavedrom(parent, source, format)
-        wavedrom_cli = which(parent, 'wavedrom', :raise_on_error => false)
-        phantomjs = which(parent, 'phantomjs', :alt_attrs => ['phantomjs_2'], :raise_on_error => false)
-
-        if wavedrom_cli && !wavedrom_cli.include?('WaveDromEditor') && phantomjs
-          generate_file(wavedrom_cli, 'wvd', format.to_s, source.to_s) do |tool_path, input_path, output_path|
-            [phantomjs, Platform.native_path(tool_path), '-i', Platform.native_path(input_path), "-#{format.to_s[0]}", Platform.native_path(output_path)]
-          end
-        else
-          if ::Asciidoctor::Diagram::Platform.os == :macosx
-            wavedrom = which(parent, 'WaveDromEditor.app', :alt_cmds => ['wavedrom-editor.app'], :attrs => ['WaveDromEditorApp'],:path => ['/Applications'])
-            if wavedrom
-              wavedrom = File.join(wavedrom, 'Contents/MacOS/nwjs')
-            end
-          else
-            wavedrom = which(parent, 'WaveDromEditor')
-          end
-
-          generate_file(wavedrom, 'wvd', format.to_s, source.to_s) do |tool_path, input_path, output_path|
-            [tool_path, 'source', Platform.native_path(input_path), format.to_s, Platform.native_path(output_path)]
-          end
-        end
-      end
-    end
-
-    class WavedromBlockProcessor < Extensions::DiagramBlockProcessor
-      include Wavedrom
+    class WavedromBlockProcessor < DiagramBlockProcessor
+      use_converter WavedromConverter
     end
 
-    class WavedromBlockMacroProcessor < Extensions::DiagramBlockMacroProcessor
-      include Wavedrom
+    class WavedromBlockMacroProcessor < DiagramBlockMacroProcessor
+      use_converter WavedromConverter
     end
   end
 end

data/spec/a2s_spec.rb

@@ -21,147 +21,9 @@ 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
+  include_examples "block_macro", :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
+  include_examples "block", :svgbob, code, [:svg]
 end