asciidoctor-diagram 2.2.9 → 2.2.11

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

@@ -0,0 +1,32 @@
+= Installation
+include::partial$uris.adoc[]
+
+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
+
+To install the gem using Bundler, first add the following entry to your project's [.path]_Gemfile_.
+
+.Gemfile
+[source,ruby]
+----
+gem 'asciidoctor-diagram'
+----
+
+Then execute `bundle` in the CLI.
+
+ $ bundle
+
+== Diagram Renderer Installation Paths
+
+Asciidoctor Diagram depends on external tools to generate images.
+In most cases it will locate these tools automatically for you by looking for specific executables in each directory in the `PATH` environment variable.
+
+In case you've installed a tool in a way where the executable is not in the `PATH`, you can override its location manually using document attributes.
+If, for instance, you installed `diag_tool` in `/home/me/diag_tool/bin` and this path is not included in the `PATH` you can specify its location on the command line
+
+ $ asciidoctor -a diag_tool=/home/me/actdiag/bin/diag_tool -r asciidoctor-diagram sample.adoc
+
+The exact document attributes to use are described in the documentation of each diagram type.

data/docs/modules/ROOT/pages/output.adoc

@@ -0,0 +1,19 @@
+= Output Directories
+
+== Image Output Directory
+
+When Asciidoctor Diagram writes images to disk it will go over the following options in order to determine where to write the files.
+
+. `\{imagesoutdir\}` if the `imagesoutdir` attribute has been specified
+. `\{outdir\}/\{imagesdir\}` if the `outdir` attribute has been specified
+. `\{to_dir\}/\{imagesdir\}` if the `to_dir` attribute has been specified
+. `\{base_dir\}/\{imagesdir\}`
+
+== Image Cache Directory
+
+The image generation also outputs metadata files that by default are located in `.asciidoctor/diagram`.
+To place them in different location, Asciidoctor Diagram checks for (in this order).
+
+. `\{cachedir\}` attribute is specified  in the block header (i.e. `[plantuml, png, cachedir=my-cache]`)
+. `\{diagram-cachedir\}` if the `diagram-cachedir` attribute has been specified
+. `\{outdir\}/\{imagesdir\}`

data/docs/modules/ROOT/partials/shared-attrs.adoc

@@ -0,0 +1,12 @@
+[cols=">,<,<",options="header"]
+|===
+|Name          |Default value   |Description
+|svg-type      |unspecified     |One of `static`, `inline` or `interactive`.
+This determines the style of SVG embedding that's used in certain backends.
+The xref:asciidoc:macros:image-svg.adoc[asciidoc spec] describes this in more detail.
+|server-url    |unspecified    |External service to render diagram.
+Usage removes the need to depend on external tools to be installed locally.
+|server-type   |unspecified    |One of `plantuml` or `kroki_io`
+|max-get-size  |1024           |The maximum size of the URI path for HTTP GET requests.
+If the maximum size is exceeded, POST requests are used instead
+|===

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

@@ -18,12 +18,14 @@
 :uri-imagemagick: http://www.imagemagick.org
 :uri-java: http://java.sun.com
 :uri-jsyntrax: https://atp-mipt.github.io/jsyntrax/
+:uri-lilypond: https://lilypond.org
 :uri-mermaid: https://github.com/mermaid-js/mermaid-cli
 :uri-mscgen: http://www.mcternan.me.uk/mscgen/
 :uri-mscgen-js: https://github.com/mscgenjs/mscgenjs-cli
 :uri-nomnoml: http://nomnoml.com
 :uri-nwdiag: http://blockdiag.com/en/nwdiag/index.html
 :uri-packetdiag: http://blockdiag.com/en/nwdiag/index.html
+:uri-penrose: https://penrose.cs.cmu.edu
 :uri-phantomjs: http://phantomjs.org
 :uri-pikchr: https://pikchr.org
 :uri-plantuml: http://plantuml.sourceforge.net

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

@@ -27,7 +27,7 @@ module Asciidoctor
       include DiagramConverter
 
       def supported_formats
-        [:png, :svg, :txt]
+        [:svg, :png, :txt]
       end
 
       def collect_options(source)
@@ -52,84 +52,88 @@ module Asciidoctor
         code = source.code
         type = source.config[:type]
 
-        case type
-          when :bookland
-            require 'barby/barcode/bookland'
-            barcode = Barby::Bookland.new(code)
-          when :codabar
-            require 'barby/barcode/codabar'
-            barcode = Barby::Codabar.new(code)
-          when :code25
-            require 'barby/barcode/code_25'
-            barcode = Barby::Code25.new(code)
-          when :code25iata
-            require 'barby/barcode/code_25_iata'
-            barcode = Barby::Code25IATA.new(code)
-          when :code25interleaved
-            require 'barby/barcode/code_25_interleaved'
-            barcode = Barby::Code25Interleaved.new(code)
-          when :code39
-            require 'barby/barcode/code_39'
-            barcode = Barby::Code39.new(code)
-          when :code93
-            require 'barby/barcode/code_93'
-            barcode = Barby::Code93.new(code)
-          when :code128
-            require 'barby/barcode/code_128'
-            barcode = Barby::Code128.new(code)
-          when :code128a
-            require 'barby/barcode/code_128'
-            barcode = Barby::Code128A.new(code)
-          when :code128b
-            require 'barby/barcode/code_128'
-            barcode = Barby::Code128B.new(code)
-          when :code128c
-            require 'barby/barcode/code_128'
-            barcode = Barby::Code128C.new(code)
-          when :ean8
-            require 'barby/barcode/ean_8'
-            barcode = Barby::EAN8.new(code)
-          when :ean13
-            require 'barby/barcode/ean_13'
-            barcode = Barby::EAN13.new(code)
-          when :gs1_128
-            require 'barby/barcode/code_128'
-            code = code.gsub /\([^)]+\)/ do |control|
-              case control.upcase
-                when '(FNC1)'
-                  Barby::Code128::FNC1
-                when '(FNC2)'
-                  Barby::Code128::FNC2
-                when '(FNC3)'
-                  Barby::Code128::FNC3
-                when '(FNC4)'
-                  Barby::Code128::FNC4
-                when '(CODEA)'
-                  Barby::Code128::CODEA
-                when '(CODEB)'
-                  Barby::Code128::CODEB
-                when '(CODEC)'
-                  Barby::Code128::CODEC
-                when '(SHIFT)'
-                  Barby::Code128::SHIFT
-                when '(SP)'
-                  ' '
-                else
-                  control
+        begin
+          case type
+            when :bookland
+              require 'barby/barcode/bookland'
+              barcode = Barby::Bookland.new(code)
+            when :codabar
+              require 'barby/barcode/codabar'
+              barcode = Barby::Codabar.new(code)
+            when :code25
+              require 'barby/barcode/code_25'
+              barcode = Barby::Code25.new(code)
+            when :code25iata
+              require 'barby/barcode/code_25_iata'
+              barcode = Barby::Code25IATA.new(code)
+            when :code25interleaved
+              require 'barby/barcode/code_25_interleaved'
+              barcode = Barby::Code25Interleaved.new(code)
+            when :code39
+              require 'barby/barcode/code_39'
+              barcode = Barby::Code39.new(code)
+            when :code93
+              require 'barby/barcode/code_93'
+              barcode = Barby::Code93.new(code)
+            when :code128
+              require 'barby/barcode/code_128'
+              barcode = Barby::Code128.new(code)
+            when :code128a
+              require 'barby/barcode/code_128'
+              barcode = Barby::Code128A.new(code)
+            when :code128b
+              require 'barby/barcode/code_128'
+              barcode = Barby::Code128B.new(code)
+            when :code128c
+              require 'barby/barcode/code_128'
+              barcode = Barby::Code128C.new(code)
+            when :ean8
+              require 'barby/barcode/ean_8'
+              barcode = Barby::EAN8.new(code)
+            when :ean13
+              require 'barby/barcode/ean_13'
+              barcode = Barby::EAN13.new(code)
+            when :gs1_128
+              require 'barby/barcode/code_128'
+              gs1_code = code.gsub /\([^)]+\)/ do |control|
+                case control.upcase
+                  when '(FNC1)'
+                    Barby::Code128::FNC1
+                  when '(FNC2)'
+                    Barby::Code128::FNC2
+                  when '(FNC3)'
+                    Barby::Code128::FNC3
+                  when '(FNC4)'
+                    Barby::Code128::FNC4
+                  when '(CODEA)'
+                    Barby::Code128::CODEA
+                  when '(CODEB)'
+                    Barby::Code128::CODEB
+                  when '(CODEC)'
+                    Barby::Code128::CODEC
+                  when '(SHIFT)'
+                    Barby::Code128::SHIFT
+                  when '(SP)'
+                    ' '
+                  else
+                    control
+                end
               end
-            end
-            code = code.gsub(/\s+/, '')
-            code = code.prepend(Barby::Code128::FNC1) unless code[0] == Barby::Code128::FNC1
-            barcode = Barby::Code128.new(code)
-          when :qrcode
-            BarcodeDependencies::QRCODE_DEPENDENCIES.each_pair { |n, v| source.ensure_gem(n, v) }
-            require 'barby/barcode/qr_code'
-            barcode = Barby::QrCode.new(code)
-          when :upca
-            require 'barby/barcode/ean_13'
-            barcode = Barby::UPCA.new(code)
-          else
-            raise "Unsupported barcode type: #{type}"
+              gs1_code = gs1_code.gsub(/\s+/, '')
+              gs1_code = gs1_code.prepend(Barby::Code128::FNC1) unless gs1_code[0] == Barby::Code128::FNC1
+              barcode = Barby::Code128.new(gs1_code)
+            when :qrcode
+              BarcodeDependencies::QRCODE_DEPENDENCIES.each_pair { |n, v| source.ensure_gem(n, v) }
+              require 'barby/barcode/qr_code'
+              barcode = Barby::QrCode.new(code)
+            when :upca
+              require 'barby/barcode/ean_13'
+              barcode = Barby::UPCA.new(code)
+            else
+              raise "Unsupported barcode type: #{type}"
+          end
+        rescue ArgumentError
+          raise "Invalid #{type} data"
         end
 
         case format
@@ -142,6 +146,7 @@ module Asciidoctor
             barcode.to_png(options)
           when :svg
             require_relative 'svg_outputter'
+            options[:title] = code
             options[:foreground] = "##{options[:foreground]}" if options[:foreground] =~ /^[0-9a-f]+$/i
             options[:background] = "##{options[:background]}" if options[:background] =~ /^[0-9a-f]+$/i
             barcode.to_svg(options)

data/lib/asciidoctor-diagram/diagram_processor.rb

@@ -423,7 +423,16 @@ module Asciidoctor
         block = generate_block(parent, reader_or_target, attributes)
         attrs = block.attributes.dup
         target = attrs.delete('target')
-        create_inline(parent, :image, nil, :type => 'image', :target => target, :attributes => attrs).convert
+
+        # Don't let the asciidoctor try to apply substitutions.
+        # The text of inline macros is nil which will cause an error
+        attrs.delete('subs')
+
+        if block.context == :image
+          create_inline(parent, :image, nil, :type => 'image', :target => target, :attributes => attrs)
+        else
+          create_inline(parent, :quoted, block.source, :type => :monospaced, :attributes => attrs)
+        end
       end
 
       def supported_formats(converter)

data/lib/asciidoctor-diagram/diagram_source.rb

@@ -226,7 +226,7 @@ module Asciidoctor
       end
 
       def checksum
-        @checksum ||= compute_checksum(code)
+        @checksum ||= "#{diagram_type.to_s}-#{compute_checksum(code)}"
       end
 
       protected
@@ -248,7 +248,7 @@ module Asciidoctor
           md5 << k.to_s if k
           md5 << v.to_s if v
         end
-        md5.hexdigest
+        "md5-#{md5.hexdigest}"
       end
     end
 

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

@@ -24,9 +24,9 @@ module Asciidoctor
           :bullet_characters => lambda { |o, v| o  << '--bullet-characters' << v if v }
       }
 
-      CLASSPATH_ENV = 'DIAGRAM_DITAA_CLASSPATH'
-      DITAA_JARS = if ENV.has_key?(CLASSPATH_ENV)
-                        ENV[CLASSPATH_ENV].split(File::PATH_SEPARATOR)
+      CLASSPATH_ENV = Java.environment_variable('DIAGRAM_DITAA_CLASSPATH')
+      DITAA_JARS = if CLASSPATH_ENV
+                        CLASSPATH_ENV.split(File::PATH_SEPARATOR)
                       else
                         begin
                           require 'asciidoctor-diagram/ditaa/classpath'

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

@@ -47,7 +47,7 @@ module Asciidoctor
         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'
+          args << "-dcrop=#t"
           args << "-dresolution=#{resolution}" if resolution
           args << "-dpixmap-format=pngalpha" if format == :png
 
@@ -55,7 +55,7 @@ module Asciidoctor
 
           {
               :args => args,
-              :out_file => "#{output_path}.#{format.to_s}"
+              :out_file => "#{output_path}.cropped.#{format.to_s}"
           }
         end        
       end

data/lib/asciidoctor-diagram/penrose/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 PenroseConverter
+      include DiagramConverter
+      include CliGenerator
+
+      def supported_formats
+        [:svg]
+      end
+
+      def collect_options(source)
+        {
+            :domain => source.attr('domain_file'),
+            :style => source.attr('style_file'),
+            :variation => source.attr('variation')
+        }
+      end
+
+      def convert(source, format, options)
+        domain_path = options[:domain]
+        raise "Domain file is required" unless domain_path
+        style_path = options[:style]
+        raise "Style file is required" unless style_path
+        variation = options[:variation]
+
+        generate_file(source.find_command('roger'), 'substance', format.to_s, source.to_s) do |tool_path, source_path, output_path|
+          args = [tool_path, 'trio', '-o', Platform.native_path(output_path)]
+
+          args << "-v" << variation if variation
+
+          args << "--path"
+          args << "/"
+
+          args << "--trio"
+          args << Platform.native_path(source_path)
+          args << Platform.native_path(source.resolve_path(domain_path))
+          args << Platform.native_path(source.resolve_path(style_path))
+          args << "--"
+
+          args
+        end        
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+require_relative 'converter'
+require_relative '../diagram_processor'
+
+module Asciidoctor
+  module Diagram
+    class PenroseBlockProcessor < DiagramBlockProcessor
+      use_converter PenroseConverter
+    end
+
+    class PenroseBlockMacroProcessor < DiagramBlockMacroProcessor
+      use_converter PenroseConverter
+    end
+
+    class PenroseInlineMacroProcessor < DiagramInlineMacroProcessor
+      use_converter PenroseConverter
+    end
+  end
+end

data/lib/asciidoctor-diagram/penrose.rb

@@ -0,0 +1,8 @@
+require 'asciidoctor/extensions'
+require_relative 'penrose/extension'
+
+Asciidoctor::Extensions.register do
+  block Asciidoctor::Diagram::PenroseBlockProcessor, :penrose
+  block_macro Asciidoctor::Diagram::PenroseBlockMacroProcessor, :penrose
+  inline_macro Asciidoctor::Diagram::PenroseInlineMacroProcessor, :penrose
+end

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

@@ -8,10 +8,10 @@ module Asciidoctor
     class PlantUmlConverter
       include DiagramConverter
 
-      CLASSPATH_ENV = 'DIAGRAM_PLANTUML_CLASSPATH'
+      CLASSPATH_ENV = Java.environment_variable('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)
+      PLANTUML_JARS = if CLASSPATH_ENV
+                        CLASSPATH_ENV.split(File::PATH_SEPARATOR)
                       else
                         begin
                           require 'asciidoctor-diagram/plantuml/classpath'

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

@@ -11,12 +11,12 @@ module Asciidoctor
     class StructurizrConverter
       include DiagramConverter
 
-      CLASSPATH_ENV = 'DIAGRAM_STRUCTURIZR_CLASSPATH'
-      CLI_HOME_ENV = 'DIAGRAM_STRUCTURIZRCLI_HOME'
-      STRUCTURIZR_JARS = if ENV.has_key?(CLASSPATH_ENV)
-                           ENV[CLASSPATH_ENV].split(File::PATH_SEPARATOR)
-                         elsif ENV.has_key?(CLI_HOME_ENV)
-                           lib_dir = File.expand_path('lib', ENV[CLI_HOME_ENV])
+      CLASSPATH_ENV = Java.environment_variable('DIAGRAM_STRUCTURIZR_CLASSPATH')
+      CLI_HOME_ENV = Java.environment_variable('DIAGRAM_STRUCTURIZRCLI_HOME')
+      STRUCTURIZR_JARS = if CLASSPATH_ENV
+                           CLASSPATH_ENV.split(File::PATH_SEPARATOR)
+                         elsif CLI_HOME_ENV
+                           lib_dir = File.expand_path('lib', CLI_HOME_ENV)
                            Dir[File.join(lib_dir, '*.jar')]
                          else
                            nil

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

@@ -9,12 +9,12 @@ module Asciidoctor
       include DiagramConverter
       include CliGenerator
 
-      CLASSPATH_ENV = 'DIAGRAM_JSYNTRAX_CLASSPATH'
-      CLI_HOME_ENV = 'DIAGRAM_JSYNTRAX_HOME'
-      JSYNTRAX_JARS = if ENV.has_key?(CLASSPATH_ENV)
-                           ENV[CLASSPATH_ENV].split(File::PATH_SEPARATOR)
-                         elsif ENV.has_key?(CLI_HOME_ENV)
-                           lib_dir = File.expand_path('lib', ENV[CLI_HOME_ENV])
+      CLASSPATH_ENV = Java.environment_variable('DIAGRAM_JSYNTRAX_CLASSPATH')
+      CLI_HOME_ENV = Java.environment_variable('DIAGRAM_JSYNTRAX_HOME')
+      JSYNTRAX_JARS = if CLASSPATH_ENV
+                           CLASSPATH_ENV.split(File::PATH_SEPARATOR)
+                         elsif CLI_HOME_ENV
+                           lib_dir = File.expand_path('lib', CLI_HOME_ENV)
                            Dir.children(lib_dir).select { |c| c.end_with? '.jar' }.map { |c| File.expand_path(c, lib_dir) }
                          else
                            nil

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

@@ -5,6 +5,10 @@ module Asciidoctor
   module Diagram
     # @private
     module Java
+      def self.environment_variable(key)
+        ENV[key] || ENV_JAVA[key.downcase.gsub('_', '.')]
+      end
+
       def self.load
         if defined?(@loaded) && @loaded
           return

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

@@ -8,6 +8,10 @@ module Asciidoctor
   module Diagram
     # @private
     module Java
+      def self.environment_variable(key)
+        ENV[key]
+      end
+
       class CommandServer
         def initialize(java, classpath)
           classpath.each do |file|

data/lib/asciidoctor-diagram/version.rb

@@ -1,5 +1,5 @@
 module Asciidoctor
   module Diagram
-    VERSION = "2.2.9"
+    VERSION = "2.2.11"
   end
 end

data/lib/asciidoctor-diagram.rb

@@ -17,6 +17,7 @@ require_relative 'asciidoctor-diagram/meme'
 require_relative 'asciidoctor-diagram/mermaid'
 require_relative 'asciidoctor-diagram/msc'
 require_relative 'asciidoctor-diagram/nomnoml'
+require_relative 'asciidoctor-diagram/penrose'
 require_relative 'asciidoctor-diagram/pikchr'
 require_relative 'asciidoctor-diagram/plantuml'
 require_relative 'asciidoctor-diagram/salt'

data/spec/barcode_spec.rb

@@ -99,7 +99,7 @@ END:VCARD
 
     target = b.attributes['target']
     expect(target).to_not be_nil
-    expect(target).to match(/\.png$/)
+    expect(target).to match(/\.svg$/)
     expect(File.exist?(target)).to be true
 
     expect(b.attributes['width']).to_not be_nil
@@ -129,7 +129,7 @@ Doc Writer <doc@example.com>
 
       target = b.attributes['target']
       expect(target).to_not be_nil
-      expect(target).to match(/\.png$/)
+      expect(target).to match(/\.svg$/)
       expect(File.exist?(target)).to be true
 
       expect(b.attributes['width']).to_not be_nil
@@ -166,7 +166,7 @@ Doc Writer <doc@example.com>
       src = src_match[1]
 
       expect(src).to_not be_nil
-      expect(src).to match(/\.png$/)
+      expect(src).to match(/\.svg$/)
       expect(File.exist?(src)).to be true
 
       expect(/width="([^"]*)"/.match(img)).to_not be_nil

data/spec/d2_spec.rb

@@ -37,7 +37,7 @@ describe Asciidoctor::Diagram::D2BlockProcessor, :broken_on_windows do
 
   it "should not use sketch mode by default" do
     doc = <<-eos
-= Hello, D2!
+= Hello, d2!
 Doc Writer <doc@example.com>
 
 == First Section

data/spec/mermaid_spec.rb

@@ -141,43 +141,6 @@ end
 describe Asciidoctor::Diagram::MermaidBlockProcessor do
   include_examples "block", :mermaid, MERMAID_CODE, [:png, :svg]
 
-  it "should work with kroki.io" do
-    doc = <<-eos
-= Hello, kroki!
-:diagram-server-url: https://kroki.io/
-:diagram-server-type: kroki_io
-Doc Writer <doc@example.com>
-
-== First Section
-
-[mermaid, format=svg]
-----
-graph TD
-  A[ Anyone ] -->|Can help | B( Go to github.com/yuzutech/kroki )
-  B --> C{ How to contribute? }
-  C --> D[ Reporting bugs ]
-  C --> E[ Sharing ideas ]
-  C --> F[ Advocating ]
-----
-    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 report unsupported scaling factors" do
     doc = <<-eos
 = Hello, Mermaid!

data/spec/test_helper_methods.rb

@@ -47,6 +47,8 @@ end
 module Asciidoctor
   module Diagram
     module TestHelpers
+      include ::Asciidoctor::Logging
+
       def load_asciidoc(source, options = {})
         options = options.dup
         options[:trace] = true
@@ -71,7 +73,8 @@ module Asciidoctor
           options[:attributes]['diagram-on-error'] = 'abort'
         end
 
-        ::Asciidoctor.load(StringIO.new(source), options.merge({:trace => true}))
+        logger.level = ::Logger::Severity::DEBUG
+        ::Asciidoctor.load(StringIO.new(source), options.merge({:trace => true, :verbose => 2}))
       end
     end
   end