asciidoctor-diagram 1.5.1 → 1.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 20f26c9e257f9041fae90a6f1ce31a8cd363c903
-  data.tar.gz: e249114bfa2333f2acce3dc32646d0f3dec578f0
+  metadata.gz: c7c8a0442a43c4f2b062c9a2875db9bfe487ebfe
+  data.tar.gz: e5ed8001a95d21ff5461ab9adf71b679dcdeb8c5
 SHA512:
-  metadata.gz: 05a5da2d13c1e7ae0bb3292209b13770c46be24bce41d87a54d62e33fb85b82802db2291b2d34bf46ebdb319fab9664079a49d7deb7b48dc81c2bc366ecebb65
-  data.tar.gz: dd4fdc2bd64db018cf83c6dce02a17540f8baaf4872febe09b77c58729adfc2854d55bbaf1518a364bae8f077a381bb82a62646211a5aff0f3cfb50a502431d1
+  metadata.gz: 9261c02e0ce34b5b532352d5c8816f682c4cea2e352e90c7a8ac51909ed1295da58f4b337e41a852a63469bf9280596b8d11e321d8a7587f2a8e77e38274967e
+  data.tar.gz: 3540b311b595776f6bac442827a077fcfeefbd24e50ee8fbe58d9a756633213bd4a02336847fcda91647dd6feb2c113d701506859ec6c61dc3660b3e073d4762

data/CHANGELOG.adoc

@@ -2,6 +2,18 @@
 
 == Development
 
+== 1.5.2
+
+Enhancements::
+
+  * Apply anti-aliasing to blockdiag generated images
+  * Issue #118: Add support for Erd.
+
+Bug Fixes::
+
+  * Issue #125: Use correct path separator when running under Cygwin.
+  * Issue #127: Resolved Ruby warnings when running in verbose mode.
+
 == 1.5.1
 
 Bug Fixes::

data/README.adoc

@@ -19,6 +19,7 @@ ifndef::env-site[:status:]
 :uri-blockdiag: http://blockdiag.com
 :uri-ditaa: http://ditaa.sourceforge.net/
 :uri-dot: http://www.graphviz.org/content/dot-language
+:uri-erd: https://github.com/BurntSushi/erd
 :uri-graphviz: http://www.graphviz.org
 :uri-imagemagick: http://www.imagemagick.org
 :uri-java: http://java.sun.com
@@ -108,6 +109,7 @@ The following diagram types and output formats are available:
 |{uri-actdiag}[actdiag]      |       |{check}|{check}|
 |{uri-blockdiag}[blockdiag]  |       |{check}|{check}|
 |{uri-ditaa}[ditaa]          |       |{check}|       |
+|{uri-erd}[erd]              |       |{check}|{check}|
 |{uri-dot}[graphviz]         |       |{check}|{check}|
 |<<meme,meme>>               |{check}|{check}|       |
 |{uri-mermaid}[mermaid]      |       |{check}|{check}|
@@ -229,7 +231,7 @@ or load and register each extension individually.
 require 'asciidoctor-diagram/<extension_name>'
 ----
 
-`<extension_name>` can be one of `blockdiag`, `ditaa`, `graphviz`, `meme`, `mermaid`, `plantuml`, `shaape`, or `wavedrom`.
+`<extension_name>` can be one of `blockdiag`, `ditaa`, `erd`, `graphviz`, `meme`, `mermaid`, `plantuml`, `shaape`, or `wavedrom`.
 
 Requiring one or more of these files will automatically register the extensions for all processed documents.
 
@@ -275,6 +277,7 @@ The following table lists the tools that are required for each diagram type, the
    |actdiag      |{uri-actdiag}[ActDiag]                                                |`actdiag`
    |blockdiag    |{uri-blockdiag}[BlockDiag]                                            |`blockdiag`
    |ditaa        |{uri-java}[Java]                                                      |`java`
+   |erd          |{uri-erd}[Erd]                                                        |`erd`
    |graphviz     |{uri-graphviz}[GraphViz]                                              |`dot` or `graphvizdot`
    |meme         |{uri-imagemagick}[ImageMagick]                                        |`convert` and `identify`
    |mermaid      |{uri-mermaid}[Mermaid]                                                |`mermaid`

data/lib/asciidoctor-diagram.rb

@@ -1,5 +1,6 @@
 require_relative 'asciidoctor-diagram/blockdiag'
 require_relative 'asciidoctor-diagram/ditaa'
+require_relative 'asciidoctor-diagram/erd'
 require_relative 'asciidoctor-diagram/graphviz'
 require_relative 'asciidoctor-diagram/meme'
 require_relative 'asciidoctor-diagram/mermaid'

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

@@ -85,17 +85,18 @@ module Asciidoctor
         end
 
         block = Class.new(Extensions::DiagramBlockProcessor) do
-          self.instance_eval &init
+          self.instance_eval(&init)
         end
         ::Asciidoctor::Diagram.const_set("#{name}BlockProcessor", block)
 
         block_macro = Class.new(Extensions::DiagramBlockMacroProcessor) do
-          self.instance_eval &init
+          self.instance_eval(&init)
         end
 
         ::Asciidoctor::Diagram.const_set("#{name}BlockMacroProcessor", block_macro)
       end
 
+      include CliGenerator
       include Which
 
       def blockdiag(tool, parent, source, format)
@@ -105,8 +106,8 @@ module Asciidoctor
         # a '3' suffix.
         alt_cmd_name = "#{tool.downcase}3"
 
-        CliGenerator.generate_stdin(which(parent, cmd_name, :alt_cmds => [alt_cmd_name]), format.to_s, source.to_s) do |tool_path, output_path|
-          [tool_path, '-o', Platform.native_path(output_path), "-T#{format.to_s}", '-']
+        generate_stdin(which(parent, cmd_name, :alt_cmds => [alt_cmd_name]), format.to_s, source.to_s) do |tool_path, output_path|
+          [tool_path, '-a', '-o', Platform.native_path(output_path), "-T#{format.to_s}", '-']
         end
       end
     end

data/lib/asciidoctor-diagram/erd.rb

@@ -0,0 +1,7 @@
+require_relative 'extensions'
+
+Asciidoctor::Extensions.register do
+  require_relative 'erd/extension'
+  block Asciidoctor::Diagram::ErdBlockProcessor, :erd
+  block_macro Asciidoctor::Diagram::ErdBlockMacroProcessor, :erd
+end

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

@@ -0,0 +1,43 @@
+require_relative '../extensions'
+require_relative '../util/cli_generator'
+require_relative '../util/platform'
+require_relative '../util/which'
+
+module Asciidoctor
+  module Diagram
+    # @private
+    module Erd
+      include CliGenerator
+      include Which
+
+      def self.included(mod)
+        [:png, :svg].each do |f|
+          mod.register_format(f, :image) do |parent, source|
+            erd(parent, source, f)
+          end
+        end
+      end
+
+      def erd(parent, source, format)
+        erd_path = which(parent, 'erd')
+        dot_path = which(parent, 'dot', :alt_attrs => ['graphvizdot'])
+
+        dot_code = generate_stdin(erd_path, format.to_s, source.to_s) do |tool_path, output_path|
+          [tool_path, '-o', Platform.native_path(output_path), '-f', 'dot']
+        end
+
+        generate_stdin(dot_path, format.to_s, dot_code) do |tool_path, output_path|
+          [tool_path, "-o#{Platform.native_path(output_path)}", "-T#{format.to_s}"]
+        end
+      end
+    end
+
+    class ErdBlockProcessor < Extensions::DiagramBlockProcessor
+      include Erd
+    end
+
+    class ErdBlockMacroProcessor < Extensions::DiagramBlockMacroProcessor
+      include Erd
+    end
+  end
+end

data/lib/asciidoctor-diagram/extensions.rb

@@ -32,7 +32,7 @@ module Asciidoctor
         def register_format(format, type, &block)
           raise "Unsupported output type: #{type}" unless type == :image || type == :literal
 
-          unless @default_format
+          unless defined?(@default_format)
             @default_format = format
           end
 
@@ -40,7 +40,7 @@ module Asciidoctor
               :type => type,
               :generator => block
           }
-       end
+        end
 
         # Returns the registered formats
         #
@@ -115,7 +115,11 @@ module Asciidoctor
                 raise e
               else
                 text = "Failed to generate image: #{e.message}"
-                warn %(asciidoctor-diagram: ERROR: #{text})
+                warn_msg = text.dup
+                if $VERBOSE
+                  warn_msg << "\n" << e.backtrace.join("\n")
+                end
+                warn %(asciidoctor-diagram: ERROR: #{warn_msg})
                 text << "\n"
                 text << source.code
                 Asciidoctor::Block.new parent, :listing, :source => text, :attributes => attributes
@@ -149,7 +153,7 @@ module Asciidoctor
           image_file = parent.normalize_system_path image_name, image_dir
           metadata_file = parent.normalize_system_path "#{image_name}.cache", cache_dir
 
-          if File.exists? metadata_file
+          if File.exist? metadata_file
             metadata = File.open(metadata_file, 'r') { |f| JSON.load f }
           else
             metadata = {}
@@ -157,7 +161,7 @@ module Asciidoctor
 
           image_attributes = source.attributes
 
-          if !File.exists?(image_file) || source.should_process?(image_file, metadata)
+          if !File.exist?(image_file) || source.should_process?(image_file, metadata)
             params = IMAGE_PARAMS[format]
 
             result = instance_exec(parent, source, &generator_info[:generator])

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

@@ -7,6 +7,7 @@ module Asciidoctor
   module Diagram
     # @private
     module Graphviz
+      include CliGenerator
       include Which
 
       def self.included(mod)
@@ -18,7 +19,7 @@ module Asciidoctor
       end
 
       def graphviz(parent, source, format)
-        CliGenerator.generate_stdin(which(parent, 'dot', :alt_attrs => ['graphvizdot']), format.to_s, source.to_s) do |tool_path, output_path|
+        generate_stdin(which(parent, 'dot', :alt_attrs => ['graphvizdot']), format.to_s, source.to_s) do |tool_path, output_path|
           args = [tool_path, "-o#{Platform.native_path(output_path)}", "-T#{format.to_s}"]
 
           layout = source.attr('layout')

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

@@ -36,7 +36,7 @@ module Asciidoctor
         options = c.attr('options', '').split(',')
         noupcase = options.include?('noupcase')
 
-        dimensions = CliGenerator.run_cli(identify, '-format', '%w %h', bg_img).match /(?<w>\d+) (?<h>\d+)/
+        dimensions = Cli.run(identify, '-format', '%w %h', bg_img).match(/(?<w>\d+) (?<h>\d+)/)
         bg_width = dimensions['w'].to_i
         bg_height = dimensions['h'].to_i
         label_width = bg_width
@@ -44,7 +44,7 @@ module Asciidoctor
 
         if top_label
           top_img = Tempfile.new(['meme', '.png'])
-          CliGenerator.run_cli(
+          Cli.run(
               convert,
               '-background', 'none',
               '-fill', fill_color,
@@ -62,7 +62,7 @@ module Asciidoctor
 
         if bottom_label
           bottom_img = Tempfile.new(['meme', '.png'])
-          CliGenerator.run_cli(
+          Cli.run(
               convert,
               '-background', 'none',
               '-fill', fill_color,
@@ -91,7 +91,7 @@ module Asciidoctor
 
         args << final_img.path
 
-        CliGenerator.run_cli(*args)
+        Cli.run(*args)
 
         File.binread(final_img)
       end

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

@@ -1,4 +1,5 @@
 require_relative '../extensions'
+require_relative '../util/cli'
 require_relative '../util/cli_generator'
 require_relative '../util/platform'
 require_relative '../util/which'
@@ -7,6 +8,7 @@ module Asciidoctor
   module Diagram
     # @private
     module Mermaid
+      include CliGenerator
       include Which
 
       def self.included(mod)
@@ -19,7 +21,7 @@ module Asciidoctor
 
       def mermaid(parent, source, format)
         mermaid = which(parent, 'mermaid')
-        @is_mermaid_v6 ||= `#{mermaid} --version`.split('.')[0].to_i >= 6
+        @is_mermaid_v6 ||= ::Asciidoctor::Diagram::Cli.run(mermaid, '--version').split('.')[0].to_i >= 6
         # Mermaid >= 6.0.0 requires PhantomJS 2.1; older version required 1.9
         phantomjs = which(parent, 'phantomjs', :alt_attrs => [@is_mermaid_v6 ? 'phantomjs_2' : 'phantomjs_19'])
 
@@ -30,7 +32,7 @@ module Asciidoctor
 
         width = source.attr('width')
 
-        CliGenerator.generate_file(mermaid, 'mmd', format.to_s, source.to_s) do |tool_path, input_path, output_path|
+        generate_file(mermaid, 'mmd', format.to_s, source.to_s) do |tool_path, input_path, output_path|
           output_dir = File.dirname(output_path)
           output_file = File.expand_path(File.basename(input_path) + ".#{format.to_s}", output_dir)
 

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

@@ -65,7 +65,7 @@ module Asciidoctor
       end
 
       def resolve_path(path, parent, base_dir)
-        if path =~ ::URI.regexp
+        if path =~ ::URI::ABS_URI
           uri = ::URI.parse(path)
           if uri.scheme == 'file'
             parent.normalize_system_path(uri.path, base_dir)

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

@@ -7,6 +7,7 @@ module Asciidoctor
   module Diagram
     # @private
     module Shaape
+      include CliGenerator
       include Which
 
       def self.included(mod)
@@ -18,7 +19,7 @@ module Asciidoctor
       end
 
       def shaape(parent, source, format)
-        CliGenerator.generate_stdin(which(parent, 'shaape'), format.to_s, source.to_s) do |tool_path, output_path|
+        generate_stdin(which(parent, 'shaape'), format.to_s, source.to_s) do |tool_path, output_path|
           [tool_path, '-o', Platform.native_path(output_path), '-t', format.to_s, '-']
         end
       end

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

@@ -0,0 +1,19 @@
+require 'tempfile'
+require 'open3'
+
+module Asciidoctor
+  module Diagram
+    # @private
+    module Cli
+      def self.run(*args)
+        stdout, stderr, status = Open3.capture3(*args)
+
+        if status != 0
+          raise "#{File.basename(args[0])} failed: #{stdout.empty? ? stderr : stdout}"
+        end
+
+        stdout.empty? ? stderr : stdout
+      end
+    end
+  end
+end

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

@@ -1,11 +1,11 @@
 require 'tempfile'
-require 'open3'
+require_relative 'cli'
 
 module Asciidoctor
   module Diagram
     # @private
     module CliGenerator
-      def self.generate_stdin(tool, format, code)
+      def generate_stdin(tool, format, code)
         tool_name = File.basename(tool)
 
         target_file = Tempfile.new([tool_name, ".#{format}"])
@@ -20,7 +20,7 @@ module Asciidoctor
         end
       end
 
-      def self.generate_file(tool, input_ext, output_ext, code)
+      def generate_file(tool, input_ext, output_ext, code)
         tool_name = File.basename(tool)
 
         source_file = Tempfile.new([tool_name, ".#{input_ext}"])
@@ -42,7 +42,7 @@ module Asciidoctor
         end
       end
 
-      def self.generate(opts, target_file, open3_opts = {})
+      def generate(opts, target_file, open3_opts = {})
         case opts
           when Array
             args = opts
@@ -54,7 +54,7 @@ module Asciidoctor
             raise "Block passed to generate_file should return an Array or a Hash"
         end
 
-        output = run_cli(*args, open3_opts)
+        output = ::Asciidoctor::Diagram::Cli.run(*args, open3_opts)
 
         raise "#{args[0]} failed: #{output}" unless File.exist?(out_file || target_file.path)
 
@@ -64,16 +64,6 @@ module Asciidoctor
 
         File.binread(target_file.path)
       end
-
-      def self.run_cli(*args)
-        stdout, stderr, status = Open3.capture3(*args)
-
-        if status != 0
-          raise "#{File.basename(args[0])} failed: #{stdout.empty? ? stderr : stdout}"
-        end
-
-        stdout.empty? ? stderr : stdout
-      end
     end
   end
 end

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

@@ -78,7 +78,7 @@ module Asciidoctor
         if content_type.start_with? 'application/json'
           json = JSON.parse(response[:body].force_encoding(Encoding::UTF_8))
           ruby_bt = Kernel.caller(2)
-          java_bt = json['stk'].map { |java_line| "#{java_line[0]}:#{java_line[3]}: in `#{java_line[2]}'" }
+          java_bt = json['stk'].map { |java_line| "#{java_line[0]}:#{java_line[3]}: in '#{java_line[2]}'" }
           error = RuntimeError.new("#{prefix_msg}: #{json['msg']}")
           error.set_backtrace java_bt + ruby_bt
           raise error

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

@@ -1,6 +1,7 @@
 require 'socket'
-require 'rbconfig'
 
+require_relative 'cli'
+require_relative 'platform'
 require_relative 'which'
 
 module Asciidoctor
@@ -15,10 +16,10 @@ module Asciidoctor
           args << '-Djava.awt.headless=true'
           args << '-cp'
           # special case for cygwin, it requires path translation for java to work
-          if RbConfig::CONFIG['host_os'] =~ /cygwin/i
+          if ::Asciidoctor::Diagram::Platform.os_variant == :cygwin
             cygpath = ::Asciidoctor::Diagram::Which.which('cygpath')
-            if(cygpath != nil) 
-              args << classpath.flatten.map { |jar| `cygpath -w "#{jar}"`.strip }.join(";")
+            if cygpath != nil
+              args << classpath.flatten.map { |jar| ::Asciidoctor::Diagram::Cli.run(cygpath, '-w', jar).strip }.join(";")
             else
               puts 'cygwin warning: cygpath not found'
               args << classpath.flatten.join(File::PATH_SEPARATOR)
@@ -44,7 +45,7 @@ module Asciidoctor
       end
 
       def self.load
-        if @loaded
+        if defined?(@loaded) && @loaded
           return
         end
 
@@ -56,7 +57,7 @@ module Asciidoctor
         @java_exe ||= find_java
         raise "Could not find Java executable" unless @java_exe
 
-        unless @command_server
+        unless defined?(@command_server) && @command_server
           server = CommandServer.new(@java_exe, classpath)
           @command_server = server
           at_exit do
@@ -77,15 +78,13 @@ module Asciidoctor
 
       private
       def self.find_java
-        if /cygwin|mswin|mingw|bccwin|wince|emx/ =~ RUBY_PLATFORM
-          # Windows
-          path_to(ENV['JAVA_HOME'], 'bin/java.exe') || registry_lookup || ::Asciidoctor::Diagram::Which.which('java')
-        elsif /darwin/ =~ RUBY_PLATFORM
-          # Mac
-          path_to(ENV['JAVA_HOME'], 'bin/java') || path_to(`/usr/libexec/java_home`.strip, 'bin/java') || ::Asciidoctor::Diagram::Which.which('java')
-        else
-          # Other unix-like system
-          path_to(ENV['JAVA_HOME'], 'bin/java') || ::Asciidoctor::Diagram::Which.which('java')
+        case ::Asciidoctor::Diagram::Platform.os
+          when :windows
+            path_to(ENV['JAVA_HOME'], 'bin/java.exe') || registry_lookup || ::Asciidoctor::Diagram::Which.which('java')
+          when :macosx
+            path_to(ENV['JAVA_HOME'], 'bin/java') || path_to(::Asciidoctor::Diagram::Cli.run('/usr/libexec/java_home').strip, 'bin/java') || ::Asciidoctor::Diagram::Which.which('java')
+          else
+            path_to(ENV['JAVA_HOME'], 'bin/java') || ::Asciidoctor::Diagram::Which.which('java')
         end
       end
 
@@ -98,21 +97,90 @@ module Asciidoctor
         end
       end
 
+      JDK_KEY = 'HKEY_LOCAL_MACHINE\SOFTWARE\JavaSoft\Java Development Kit'
+      JRE_KEY = 'HKEY_LOCAL_MACHINE\SOFTWARE\JavaSoft\Java Runtime Environment'
+
       def self.registry_lookup
-        key_re = /^HKEY_LOCAL_MACHINE\\SOFTWARE\\JavaSoft\\.*\\([0-9\.]+)/
-        value_re = /\s*JavaHome\s*REG_SZ\s*(.*)/
-        result = `reg query "HKEY_LOCAL_MACHINE\\SOFTWARE\\JavaSoft" /s /v JavaHome`.lines.map { |l| l.strip }
-        vms = result.each_slice(3).map do |_, key, value|
-          key_match = key_re.match(key)
-          value_match = value_re.match(value)
-          if key_match && value_match
-            [key_match[1].split('.').map { |v| v.to_i }, value_match[1]]
-          else
-            nil
+        registry_current(JRE_KEY) || registry_current(JDK_KEY) || registry_any()
+      end
+
+      def self.registry_current(key)
+        current_version = registry_query(key, 'CurrentVersion')
+        if current_version
+          java_home = registry_query("#{key}\\#{current_version}", 'JavaHome')
+          java_exe(java_home)
+        else
+          nil
+        end
+      end
+
+      def self.registry_any()
+        java_homes = registry_query('HKEY_LOCAL_MACHINE\SOFTWARE\JavaSoft', 'JavaHome', :recursive => true).values
+        java_homes.map { |path| java_exe(path) }.find { |exe| !exe.nil? }
+      end
+
+      def self.java_exe(java_home)
+        java = File.expand_path('bin/java.exe', java_home)
+
+        if File.executable?(java)
+          java
+        else
+          nil
+        end
+      end
+
+      def self.registry_query(key, value = nil, opts = {})
+        args = ['reg', 'query']
+        args << key
+        args << '/v' << value unless value.nil?
+        args << '/s' if opts[:recursive]
+
+        begin
+          lines = ::Asciidoctor::Diagram::Cli.run(*args).lines.reject { |l| l.strip.empty? }.each
+        rescue
+          lines = [].each
+        end
+
+        result = {}
+
+        while true
+          begin
+            begin
+              k = lines.next
+            rescue StopIteration
+              break
+            end
+
+            unless k.start_with? key
+              next
+            end
+
+            v = nil
+            begin
+              v = lines.next.strip if lines.peek.start_with?(' ')
+            rescue StopIteration
+              break
+            end
+
+            if !k.valid_encoding? || (v && !v.valid_encoding?)
+              next
+            end
+
+            if v && (md = /([^\s]+)\s+(REG_[^\s]+)\s+(.+)/.match(v))
+              v_name = md[1]
+              v_value = md[3]
+              result["#{k}\\#{v_name}"] = v_value
+            else
+              result[k] = v
+            end
           end
-        end.reject { |v| v.nil? }.sort_by { |v| v[0] }
-        java_exes = vms.map { |version, path| File.expand_path('bin/java.exe', path) }.select { |exe| File.executable?(exe) }
-        java_exes && java_exes[0]
+        end
+
+        if value && !opts[:recursive]
+          result.values[0]
+        else
+          result
+        end
       end
     end
   end