asciidoctor-diagram 2.0.5 → 2.1.0

data/docs/modules/ROOT/partials/generate.adoc

@@ -0,0 +1,15 @@
+== Generating a Diagram from a Terminal
+
+You can load Asciidoctor diagram in a terminal using the `-r` flag.
+
+ $ asciidoctor -r asciidoctor-diagram sample.adoc
+
+You can also use Asciidoctor diagram with other converters, such as Asciidoctor EPUB.
+Asciidoctor-epub3 is also loaded with the `-r` flag.
+
+ $ asciidoctor -r asciidoctor-diagram -r asciidoctor-epub3 -b epub3 sample.adoc
+
+Or, you can invoke Asciidoctor and the EPUB converter with the `asciidoctor-epub3` command.
+The command implicitly sets the `-r` and `-b` flags for EPUB3 output.
+
+ $ asciidoctor-epub3 -r asciidoctor-diagram sample.adoc

data/docs/modules/ROOT/partials/installation.adoc

@@ -0,0 +1,19 @@
+== Installation
+
+Asciidoctor Diagram is a RubyGem, which can be installed using the `gem` or `bundle` commands.
+
+You can install the Asciidoctor Diagram gem by typing `gem install` in the CLI.
+
+ $ gem install asciidoctor-diagram
+
+by first adding the following entry to your project's [.path]_Gemfile_.
+
+.Gemfile
+[source,ruby]
+----
+gem 'asciidoctor-diagram'
+----
+
+Then execute `bundle` in the CLI.
+
+ $ bundle

data/docs/modules/ROOT/partials/uris.adoc

@@ -0,0 +1,38 @@
+:uri-a2s: https://github.com/dhobsd/asciitosvg
+:uri-actdiag: http://blockdiag.com/en/actdiag/index.html
+:uri-asciidoctor-api: http://asciidoctor.org/docs/user-manual/#api
+:uri-asciidoctor-extensions: http://asciidoctor.org/docs/user-manual/#extension-points
+:uri-blockdiag: http://blockdiag.com
+:uri-bpmn: https://github.com/gtudan/bpmn-js-cmd
+:uri-bytefield: https://github.com/Deep-Symmetry/bytefield-svg
+:uri-ditaa: http://ditaa.sourceforge.net/
+:uri-dpic: https://gitlab.com/aplevich/dpic
+:uri-dot: https://graphviz.gitlab.io/_pages/doc/info/lang.html
+:uri-erd: https://github.com/BurntSushi/erd
+:uri-gnuplot: http://gnuplot.info
+:uri-graphviz: https://graphviz.gitlab.io
+:uri-imagemagick: http://www.imagemagick.org
+:uri-java: http://java.sun.com
+:uri-mermaid: https://github.com/mermaid-js/mermaid-cli
+:uri-mscgen: http://www.mcternan.me.uk/mscgen/
+:uri-nomnoml: http://nomnoml.com
+:uri-nwdiag: http://blockdiag.com/en/nwdiag/index.html
+:uri-packetdiag: http://blockdiag.com/en/nwdiag/index.html
+:uri-phantomjs: http://phantomjs.org
+:uri-pikchr: https://pikchr.org
+:uri-plantuml: http://plantuml.sourceforge.net
+:uri-py-plantuml: https://code.google.com/p/asciidoc-plantuml/
+:uri-rackdiag: http://blockdiag.com/en/nwdiag/index.html
+:uri-seqdiag: http://blockdiag.com/en/seqdiag/index.html
+:uri-shaape: https://github.com/christiangoltz/shaape
+:uri-smcat: https://github.com/sverweij/state-machine-cat
+:uri-svgbob: https://github.com/ivanceras/svgbobrus
+:uri-symbolator: https://github.com/kevinpt/symbolator
+:uri-syntrax: https://kevinpt.github.io/syntrax/
+:uri-tikz: https://github.com/pgf-tikz/pgf
+:uri-umlet: http://www.umlet.com/
+:uri-vega: https://vega.github.io/vega/
+:uri-vegalite: https://vega.github.io/vega-lite/
+:uri-wavedrom: http://wavedrom.com
+:uri-wavedromeditor: https://github.com/wavedrom/wavedrom.github.io/releases
+:uri-wavedromcli: https://github.com/wavedrom/cli

data/examples/features.adoc

@@ -150,7 +150,7 @@ results in a block with the correct caption and id applied to it.
 Asciidoctor-diagram also supports the various diagram block in block macro form.
 These are macros of the form `<name>::<target>[<attrlist>]`.
 
-In asciidoctor-diagram the macro names are identical to the block styles: `ditaa`, `graphivz` and `plantuml`
+In asciidoctor-diagram the macro names are identical to the block styles: `ditaa`, `graphviz` and `plantuml`
 The target is the path to the file containing the diagram source code.
 When the target is a relative path it is resolved with respect to the location of the document being processed.
 The attribute list behaves mostly the same as with the block styles.

data/lib/asciidoctor-diagram/diagram_processor.rb

@@ -174,7 +174,8 @@ module Asciidoctor
           metadata = source.create_image_metadata
           metadata[:options] = options
 
-          result, metadata[:width], metadata[:height] = params[:decoder].post_process_image(result)
+          allow_image_optimisation = source.attr('optimise', 'true') == 'true'
+          result, metadata[:width], metadata[:height] = params[:decoder].post_process_image(result, allow_image_optimisation)
 
           FileUtils.mkdir_p(File.dirname(image_file)) unless Dir.exist?(File.dirname(image_file))
           File.open(image_file, 'wb') {|f| f.write result}

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

@@ -23,11 +23,20 @@ module Asciidoctor
           :transparent => lambda { |o, v| o  << '--transparent' if v == 'true'}
       }
 
-      JARS = ['ditaa-1.3.15.jar', 'ditaamini-0.12.jar'].map do |jar|
-        File.expand_path File.join('../..', jar), File.dirname(__FILE__)
-      end
-      Java.classpath.concat JARS
-
+      CLASSPATH_ENV = 'DIAGRAM_DITAA_CLASSPATH'
+      DITAA_JARS = if ENV.has_key?(CLASSPATH_ENV)
+                        ENV[CLASSPATH_ENV].split(File::PATH_SEPARATOR)
+                      else
+                        begin
+                          require 'asciidoctor-diagram/ditaa/classpath'
+                          ::Asciidoctor::Diagram::DitaaClasspath::JAR_FILES
+                        rescue LoadError
+                          raise "Could not load PlantUML. Eiter require 'asciidoctor-diagram-ditaamini' or specify the location of the PlantUML JAR(s) using the 'DIAGRAM_DITAA_CLASSPATH' environment variable."
+                        end
+                      end
+
+      Java.classpath.concat Dir[File.join(File.dirname(__FILE__), '*.jar')]
+      Java.classpath.concat DITAA_JARS
 
       def supported_formats
         [:png, :svg]

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

@@ -23,12 +23,6 @@ module Asciidoctor
         @converter.supported_formats
       end
 
-      def collect_options(source, name)
-        {
-            :block_name => name
-        }
-      end
-
       def convert(source, format, options)
         code = source.code
 
@@ -58,7 +52,7 @@ module Asciidoctor
 
           path = uri.path
           path << '/' unless path.end_with? '/'
-          path << options[:block_name].to_s
+          path << source.diagram_type.to_s
           path << '/' << format.to_s
           path << '/' << data
           uri.path = path

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

@@ -9,6 +9,16 @@ module Asciidoctor
       include DiagramConverter
       include CliGenerator
 
+      EXTRA_PATH = []
+
+      if ::Asciidoctor::Diagram::Platform.os == :macosx
+        lilypond_app = ::Asciidoctor::Diagram::Which.which('LilyPond.app', :path => ['/Applications'])
+        if lilypond_app
+          EXTRA_PATH << File.join(lilypond_app, 'Contents/Resources/bin')
+        end
+      end
+
+      EXTRA_PATH.freeze
 
       def supported_formats
         [:png, :pdf]
@@ -34,7 +44,7 @@ module Asciidoctor
 
         resolution = options[:resolution]
 
-        generate_stdin(source.find_command('lilypond'), format.to_s, code) do |tool_path, output_path|
+        generate_stdin(source.find_command('lilypond', :path => EXTRA_PATH), format.to_s, code) do |tool_path, output_path|
           args = [tool_path, '-daux-files=#f', '-dbackend=eps', '-dno-gs-load-fonts', '-dinclude-eps-fonts', '-o', Platform.native_path(output_path), '-f', format.to_s]
 
           args << '-dsafe'

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

@@ -34,8 +34,16 @@ module Asciidoctor
       end
 
       def convert(source, format, options)
-        convert = source.find_command('convert')
-        identify = source.find_command('identify')
+        magick = source.find_command('magick', :raise_on_error => false)
+        if magick
+          convert = ->(*args) { Cli.run(magick, 'convert', *args) }
+          identify = ->(*args) { Cli.run(magick, 'identify', *args) }
+        else
+          convert_cmd = source.find_command('convert')
+          convert = ->(*args) { Cli.run(convert_cmd, *args) }
+          identify_cmd = source.find_command('identify')
+          identify = ->(*args) { Cli.run(identify_cmd, *args) }
+        end
 
         bg_img = options[:bg_img]
         raise "background attribute is required" unless bg_img
@@ -50,7 +58,7 @@ module Asciidoctor
         font = options[:font] || 'Impact'
         noupcase = options[:noupcase]
 
-        dimensions = Cli.run(identify, '-format', '%w %h', bg_img)[:out].match(/(?<w>\d+) (?<h>\d+)/)
+        dimensions = identify.call('-format', '%w %h', bg_img)[:out].match(/(?<w>\d+) (?<h>\d+)/)
         bg_width = dimensions['w'].to_i
         bg_height = dimensions['h'].to_i
         label_width = bg_width
@@ -58,8 +66,7 @@ module Asciidoctor
 
         if top_label
           top_img = Tempfile.new(['meme', '.png'])
-          Cli.run(
-              convert,
+          convert.call(
               '-background', 'none',
               '-fill', fill_color,
               '-stroke', stroke_color,
@@ -76,8 +83,7 @@ module Asciidoctor
 
         if bottom_label
           bottom_img = Tempfile.new(['meme', '.png'])
-          Cli.run(
-              convert,
+          convert.call(
               '-background', 'none',
               '-fill', fill_color,
               '-stroke', stroke_color,
@@ -94,7 +100,7 @@ module Asciidoctor
 
         final_img = Tempfile.new(['meme', ".#{format.to_s}"])
 
-        args = [convert, bg_img]
+        args = [bg_img]
         if top_img
           args << top_img.path << '-geometry' << '+0+0' << '-composite'
         end
@@ -105,7 +111,7 @@ module Asciidoctor
 
         args << final_img.path
 
-        Cli.run(*args)
+        convert.call(*args)
 
         File.binread(final_img)
       end

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

@@ -64,9 +64,15 @@ module Asciidoctor
 
         opts[:width] = options[:width]
 
-        mmdc = source.find_command('mmdc', :raise_on_error => false)
-        node = source.find_command('node', :raise_on_error => false)
-        if mmdc && node
+        mmdc = nil
+        mmdc_exception = nil
+        begin
+          mmdc = source.find_command('mmdc')
+        rescue => e
+          mmdc_exception = e
+        end
+
+        if mmdc
           opts[:height] = options[:height]
           opts[:scale] = options[:scale]
           opts[:theme] = options[:theme]
@@ -75,17 +81,25 @@ module Asciidoctor
           if config
             opts[:config] = source.resolve_path(config)
           end
-          run_mmdc(node, mmdc, source, format, opts)
+          run_mmdc(mmdc, source, format, opts)
         else
-          mermaid = source.find_command('mermaid')
-          run_mermaid(mermaid, source, format, opts)
+          begin
+            mermaid = source.find_command('mermaid')
+            run_mermaid(mermaid, source, format, opts)
+          rescue
+            if mmdc_exception
+              raise mmdc_exception
+            else
+              raise
+            end
+          end
         end
       end
 
       private
-      def run_mmdc(node, mmdc, source, format, options = {})
-        generate_file(node, 'mmd', format.to_s, source.to_s) do |tool_path, input_path, output_path|
-          args = [tool_path, '--unhandled-rejections=strict', mmdc, '-i', Platform.native_path(input_path), '-o', Platform.native_path(output_path)]
+      def run_mmdc(mmdc, source, format, options = {})
+        generate_file(mmdc, 'mmd', format.to_s, source.to_s) do |tool_path, input_path, output_path|
+          args = [tool_path, '-i', Platform.native_path(input_path), '-o', Platform.native_path(output_path)]
 
           if options[:css]
             args << '--cssFile' << Platform.native_path(options[:css])
@@ -148,7 +162,10 @@ module Asciidoctor
             args << '--puppeteerConfigFile' << Platform.native_path(options[:puppeteer])
           end
 
-          args
+          {
+              :args => args,
+              :env => {'NODE_OPTIONS' => '--unhandled-rejections=strict'}
+          }
         end
       end
 

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

@@ -17,9 +17,16 @@ module Asciidoctor
       def convert(source, format, options)
         pikchr_path = source.find_command('pikchr')
 
-        generate_file_stdout(pikchr_path, format.to_s, source.to_s) do |tool_path, input_path|
+        output = generate_file_stdout(pikchr_path, format.to_s, source.to_s) do |tool_path, input_path|
           [tool_path, "--svg-only", input_path]
         end
+
+        if output.start_with? '<svg'
+          output
+        else
+          error = output.gsub(/<\/?[a-z]+>\n?/i, '')
+          raise error
+        end
       end
     end
   end

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

@@ -7,15 +7,21 @@ module Asciidoctor
     class PlantUmlConverter
       include DiagramConverter
 
-      JARS = [
-          'plantuml-1.3.15.jar',
-          'plantuml.jar',
-          'jlatexmath-minimal-1.0.5.jar',
-          'batik-all-1.10.jar'
-      ].map do |jar|
-        File.expand_path File.join('../..', jar), File.dirname(__FILE__)
-      end
-      Java.classpath.concat JARS
+      CLASSPATH_ENV = 'DIAGRAM_PLANTUML_CLASSPATH'
+      LIB_DIR = File.expand_path('../..', File.dirname(__FILE__))
+      PLANTUML_JARS = if ENV.has_key?(CLASSPATH_ENV)
+                        ENV[CLASSPATH_ENV].split(File::PATH_SEPARATOR)
+                      else
+                        begin
+                          require 'asciidoctor-diagram/plantuml/classpath'
+                          ::Asciidoctor::Diagram::PlantUmlClasspath::JAR_FILES
+                        rescue LoadError
+                          raise "Could not load PlantUML. Eiter require 'asciidoctor-diagram-plantuml' or specify the location of the PlantUML JAR(s) using the 'DIAGRAM_PLANTUML_CLASSPATH' environment variable."
+                        end
+                      end
+
+      Java.classpath.concat Dir[File.join(File.dirname(__FILE__), '*.jar')].freeze
+      Java.classpath.concat PLANTUML_JARS
 
       def supported_formats
         [:png, :svg, :txt, :atxt, :utxt]

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

@@ -14,6 +14,10 @@ module Asciidoctor
         [:svg]
       end
 
+      def native_scaling?
+        true
+      end
+
       OPTIONS = {
           :font_family => lambda { |o, v| o << '--font-family' << v if v },
           :font_size => lambda { |o, v| o << '--font-size' << v if v },

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

@@ -12,7 +12,16 @@ module Asciidoctor
           opts = args.pop.dup if args.last.is_a? Hash
           in_data = opts && opts[:stdin_data]
 
+          if Hash === args.first
+            env = args.shift.dup
+          else
+            env = {}
+          end
+
           pb = java.lang.ProcessBuilder.new(*args)
+          env.each_pair do |key, value|
+            pb.environment.put(key, value)
+          end
           p = pb.start
 
           stdout = ""
@@ -67,12 +76,18 @@ module Asciidoctor
             opts = {}
           end
 
+          if Hash === args.first
+            env = args.shift.dup
+          else
+            env = {}
+          end
+
           # When the first argument is an array, we force capture3 (or better the underlying Kernel#spawn)
           # to use a non-shell execution variant.
           cmd = File.basename(args[0])
           args[0] = [args[0], cmd]
 
-          stdout, stderr, status = Open3.capture3(*args, opts)
+          stdout, stderr, status = Open3.capture3(env, *args, opts)
 
           exit = status.exitstatus
 

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

@@ -74,15 +74,17 @@ module Asciidoctor
           when Array
             args = opts
             out_file = nil
+            env = {}
           when Hash
             args = opts[:args]
             out_file = opts[:out_file]
+            env = opts[:env] || {}
           else
             raise "Block passed to generate_file should return an Array or a Hash"
         end
 
-        logger.debug "Executing #{args} with options #{open3_opts}"
-        result = ::Asciidoctor::Diagram::Cli.run(*args, open3_opts)
+        logger.debug "Executing #{args} with options #{open3_opts} and environment #{env}"
+        result = ::Asciidoctor::Diagram::Cli.run(env, *args, open3_opts)
 
         data = target_file == :stdout ? result[:out] : read_result(target_file, out_file)
 

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

@@ -7,7 +7,7 @@ module Asciidoctor
       GIF87A_SIGNATURE = 'GIF87a'.force_encoding(Encoding::ASCII_8BIT)
       GIF89A_SIGNATURE = 'GIF89a'.force_encoding(Encoding::ASCII_8BIT)
 
-      def self.post_process_image(data)
+      def self.post_process_image(data, optimise)
         bio = BinaryIO.new(data)
         gif_signature = bio.read_string(6)
         raise "Invalid GIF signature" unless gif_signature == GIF87A_SIGNATURE || gif_signature == GIF89A_SIGNATURE

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

@@ -5,9 +5,7 @@ module Asciidoctor
     # @private
     module Java
       def self.classpath
-        @classpath ||= [
-            File.expand_path(File.join('../..', 'server-1.3.15.jar'), File.dirname(__FILE__))
-        ]
+        @classpath ||= Dir[File.join(File.dirname(__FILE__), '*.jar')]
       end
 
       CRLF = "\r\n".encode(Encoding::US_ASCII)
@@ -53,6 +51,10 @@ module Asciidoctor
         io.set_encoding Encoding::US_ASCII
         status_line = io.readline(CRLF)
         status_line_parts = STATUS_LINE.match status_line
+        unless status_line_parts
+          raise "Unexpected HTTP status line: #{status_line}"
+        end
+
         resp[:code] = status_line_parts[1].to_i
         resp[:reason] = status_line_parts[2]