asciidoctor-diagram 1.0.1 → 1.1.0

data/lib/asciidoctor-diagram/graphviz.rb

@@ -0,0 +1,8 @@
+require 'asciidoctor/extensions'
+require_relative 'version'
+
+Asciidoctor::Extensions.register do
+  require_relative 'graphviz/extension'
+  block :graphviz, Asciidoctor::Diagram::GraphvizBlock
+  block_macro :graphviz, Asciidoctor::Diagram::GraphvizBlockMacro
+end

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

@@ -0,0 +1,41 @@
+require_relative '../util/diagram'
+require_relative '../plantuml/generator'
+
+module Asciidoctor
+  module Diagram
+    module GraphvizBase
+      include PlantUmlGenerator
+
+      private
+
+      def register_formats
+        register_format(:png, :image) do |c, p|
+          plantuml(p, c, 'dot')
+        end
+        register_format(:svg, :image) do |c, p|
+          plantuml(p, c, 'dot', '-tsvg')
+        end
+      end
+    end
+
+    class GraphvizBlock < Asciidoctor::Extensions::BlockProcessor
+      include DiagramProcessorBase
+      include GraphvizBase
+
+      def initialize(context, document, opts = {})
+        super
+        register_formats()
+      end
+    end
+
+    class GraphvizBlockMacro < Asciidoctor::Extensions::BlockMacroProcessor
+      include DiagramProcessorBase
+      include GraphvizBase
+
+      def initialize(context, document, opts = {})
+        super
+        register_formats()
+      end
+    end
+  end
+end

data/lib/asciidoctor-diagram/plantuml.rb

@@ -4,4 +4,5 @@ require_relative 'version'
 Asciidoctor::Extensions.register do
   require_relative 'plantuml/extension'
   block :plantuml, Asciidoctor::Diagram::PlantUmlBlock
+  block_macro :plantuml, Asciidoctor::Diagram::PlantUmlBlockMacro
 end

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

@@ -1,87 +1,49 @@
-require_relative '../diagram'
-require_relative '../java'
-require_relative '../png'
-require_relative '../svg'
+require_relative '../util/diagram'
+require_relative 'generator'
 
 module Asciidoctor
   module Diagram
-    PLANTUML_JAR_PATH = File.expand_path File.join('../..', 'plantuml.jar'), File.dirname(__FILE__)
+    module PlantUmlBase
+      include PlantUmlGenerator
 
-    class PlantUmlBlock < DiagramBlock
-      option :contexts, [:listing, :literal, :open]
-      option :content_model, :simple
-      option :pos_attrs, ['target', 'format']
-      option :default_attrs, {'format' => 'png'}
-
-      def name
-        "PlantUml"
-      end
-
-      def allowed_formats
-        @allowed_formats ||= [:svg, :png, :txt]
-      end
+      private
 
-      def generate_image(parent, diagram_code, format)
-        flags = get_default_flags(parent)
-        if format == :svg
-          flags << "-tsvg"
+      def register_formats(document)
+        config_args = []
+        config = document.attributes['plantumlconfig']
+        if config
+          config_args += ['-config', File.expand_path(config, document.attributes['docdir'])]
         end
 
-        plantuml(diagram_code, *flags)
-      end
-
-      def generate_text(parent, diagram_code)
-        flags = get_default_flags(parent)
-        flags << '-tutxt'
-
-        plantuml(diagram_code, *flags)
+        register_format(:png, :image) do |c, p|
+          plantuml(p, c, 'uml', *config_args)
+        end
+        register_format(:svg, :image) do |c, p|
+          plantuml(p, c, 'uml', '-tsvg', *config_args)
+        end
+        register_format(:txt, :literal) do |c, p|
+          plantuml(p, c, 'uml', '-tutxt', *config_args)
+        end
       end
+    end
 
-      private
-
-      Java.classpath << PLANTUML_JAR_PATH
-
-      def plantuml(code, *flags)
-        Java.load
-
-        code = "@startuml\n#{code}\n@enduml" unless code.index '@startuml'
-
-        # When the -pipe command line flag is used, PlantUML calls System.exit which kills our process. In order
-        # to avoid this we call some lower level components of PlantUML directly.
-        # This snippet of code corresponds approximately with net.sourceforge.plantuml.Run#managePipe
-        cmd = ['-charset', 'UTF-8', '-failonerror']
-        cmd += flags
-
-        option = Java.net.sourceforge.plantuml.Option.new(Java.array_to_java_array(cmd, :string))
-        source_reader = Java.net.sourceforge.plantuml.SourceStringReader.new(
-            Java.net.sourceforge.plantuml.preproc.Defines.new(),
-            code,
-            option.getConfig()
-        )
+    class PlantUmlBlock < Asciidoctor::Extensions::BlockProcessor
+      include DiagramProcessorBase
+      include PlantUmlBase
 
-        bos = Java.java.io.ByteArrayOutputStream.new
-        ps = Java.java.io.PrintStream.new(bos)
-        source_reader.generateImage(ps, 0, option.getFileFormatOption())
-        ps.close
-        Java.string_from_java_bytes(bos.toByteArray)
+      def initialize(context, document, opts = {})
+        super
+        register_formats(document)
       end
+    end
 
-      def get_default_flags(parent)
-        flags = []
-
-        document = parent.document
-        config = document.attributes['plantumlconfig']
-        if config
-          flags += ['-config', File.expand_path(config, document.attributes['docdir'])]
-        end
-
-        flags
-      end
+    class PlantUmlBlockMacro < Asciidoctor::Extensions::BlockMacroProcessor
+      include DiagramProcessorBase
+      include PlantUmlBase
 
-      def code_checksum(code)
-        md5 = Digest::MD5.new
-        md5 << code
-        md5.hexdigest
+      def initialize(context, document, opts = {})
+        super
+        register_formats(document)
       end
     end
   end

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

@@ -0,0 +1,50 @@
+require_relative '../util/java'
+
+module Asciidoctor
+  module Diagram
+    module PlantUmlGenerator
+      private
+
+      PLANTUML_JAR_PATH = File.expand_path File.join('../..', 'plantuml.jar'), File.dirname(__FILE__)
+      Java.classpath << PLANTUML_JAR_PATH
+
+      def plantuml(parent, code, tag, *flags)
+        unless @graphvizdot
+          @graphvizdot = parent.document.attributes['graphvizdot']
+          @graphvizdot = which('dot') unless @graphvizdot && File.executable?(@graphvizdot)
+          raise "Could not find the Graphviz 'dot' executable in PATH; add it to the PATH or specify its location using the 'graphvizdot' document attribute" unless @graphvizdot
+        end
+
+        Java.load
+
+        code = "@start#{tag}\n#{code}\n@end#{tag}" unless code.index "@start#{tag}"
+
+        flags += ['-charset', 'UTF-8', '-failonerror', '-graphvizdot', @graphvizdot]
+
+        option = Java.net.sourceforge.plantuml.Option.new(Java.array_to_java_array(flags, :string))
+        source_reader = Java.net.sourceforge.plantuml.SourceStringReader.new(
+            Java.net.sourceforge.plantuml.preproc.Defines.new(),
+            code,
+            option.getConfig()
+        )
+
+        bos = Java.java.io.ByteArrayOutputStream.new
+        ps = Java.java.io.PrintStream.new(bos)
+        source_reader.generateImage(ps, 0, option.getFileFormatOption())
+        ps.close
+        Java.string_from_java_bytes(bos.toByteArray)
+      end
+
+      def which(cmd)
+        exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
+        ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
+          exts.each { |ext|
+            exe = File.join(path, "#{cmd}#{ext}")
+            return exe if File.executable? exe
+          }
+        end
+        nil
+      end
+    end
+  end
+end

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

@@ -0,0 +1,198 @@
+require 'asciidoctor/extensions'
+require 'digest'
+require 'json'
+require_relative 'java'
+require_relative 'png'
+require_relative 'svg'
+
+module Asciidoctor
+  module Diagram
+    module DiagramProcessorBase
+      IMAGE_PARAMS = {
+          :svg => {
+              :encoding => Encoding::UTF_8,
+              :decoder => SVG
+          },
+          :png => {
+              :encoding => Encoding::ASCII_8BIT,
+              :decoder => PNG
+          }
+      }
+
+      def self.included(base)
+        base.option :pos_attrs, ['target', 'format']
+
+        if base.ancestors.include?(Asciidoctor::Extensions::BlockProcessor)
+          base.option :contexts, [:listing, :literal, :open]
+          base.option :content_model, :simple
+
+          base.instance_eval do
+            alias_method :process, :process_block
+          end
+        else
+          base.instance_eval do
+            alias_method :process, :process_macro
+          end
+        end
+
+      end
+
+      def process_macro(parent, target, attributes)
+        source = FileSource.new(File.expand_path(target, parent.document.attributes['docdir']))
+        attributes['target'] = File.basename(target, File.extname(target))
+
+        generate_block(parent, source, attributes)
+      end
+
+      def process_block(parent, reader, attributes)
+        generate_block(parent, ReaderSource.new(reader), attributes)
+      end
+
+      def generate_block(parent, source, attributes)
+        format = attributes.delete('format') || @default_format
+        format = format.to_sym if format.respond_to?(:to_sym)
+
+        raise "Format undefined" unless format
+
+        generator_info = formats[format]
+
+        raise "#{self.class.name} does not support output format #{format}" unless generator_info
+
+        case generator_info[:type]
+          when :image
+            create_image_block(parent, source, attributes, format, generator_info)
+          when :literal
+            create_literal_block(parent, source, attributes, generator_info)
+          else
+            raise "Unsupported output format: #{format}"
+        end
+      end
+
+      private
+
+      #
+      # Registers a supported format. The first registered format becomes the default format for the block processor.
+      #
+      # +format+ is a symbol with the format name
+      # +type+ is a symbol and should be either :image or :literal
+      # +block+ is a block that produces the diagrams from code. The block receives the parent asciidoc block and the diagram code as arguments
+      #
+      def register_format(format, type, &block)
+        unless @default_format
+          @default_format = format
+        end
+
+        formats[format] = {
+            :type => type,
+            :generator => block
+        }
+      end
+
+      def formats
+        @formats ||= {}
+      end
+
+      def create_image_block(parent, source, attributes, format, generator_info)
+        target = attributes.delete('target')
+
+        image_name = "#{target || source.checksum}.#{format}"
+        image_dir = File.expand_path(parent.document.attributes['imagesdir'] || '', parent.document.attributes['docdir'])
+        image_file = File.expand_path(image_name, image_dir)
+
+        if source.newer_than?(image_file)
+          cache_file = File.expand_path("#{image_name}.cache", image_dir)
+
+          if File.exists? cache_file
+            metadata = File.open(cache_file, 'r') { |f| JSON.load f }
+          else
+            metadata = nil
+          end
+
+          unless File.exists?(image_file) && metadata && metadata['checksum'] == source.checksum
+            params = IMAGE_PARAMS[format]
+
+            result = generator_info[:generator].call(source.code, parent)
+
+            result.force_encoding(params[:encoding])
+
+            metadata = {'checksum' => source.checksum}
+            metadata['width'], metadata['height'] = params[:decoder].get_image_size(result)
+
+            File.open(image_file, 'w') { |f| f.write result }
+            File.open(cache_file, 'w') { |f| JSON.dump(metadata, f) }
+          end
+        end
+
+        attributes['target'] = image_name
+        attributes['width'] ||= metadata['width'] if metadata['width']
+        attributes['height'] ||= metadata['height'] if metadata['height']
+        attributes['alt'] ||= if (title_text = attributes['title'])
+                                title_text
+                              elsif target
+                                (File.basename target, (File.extname target) || '').tr '_-', ' '
+                              else
+                                'Diagram'
+                              end
+
+        Asciidoctor::Block.new parent, :image, :content_model => :empty, :attributes => attributes
+      end
+
+      def create_literal_block(parent, source, attributes, generator_info)
+        attributes.delete('target')
+
+        result = generator_info[:generator].call(source.code, parent)
+
+        result.force_encoding(Encoding::UTF_8)
+        Asciidoctor::Block.new parent, :literal, :code => result, :attributes => attributes
+      end
+
+      def code_checksum(code)
+        md5 = Digest::MD5.new
+        md5 << code
+        md5.hexdigest
+      end
+    end
+
+    class Source
+      def newer_than?(image)
+        true
+      end
+
+      def checksum
+        @checksum ||= compute_checksum(code)
+      end
+
+      private
+
+      def compute_checksum(code)
+        md5 = Digest::MD5.new
+        md5 << code
+        md5.hexdigest
+      end
+    end
+
+    class ReaderSource < Source
+      def initialize(reader)
+        @reader = reader
+      end
+
+      def code
+        @code ||= @reader.lines.join
+      end
+    end
+
+    class FileSource < Source
+      def initialize(file_name)
+        @file_name = file_name
+      end
+
+      def code
+        @code ||= File.read(@file_name)
+      end
+
+      def newer_than?(image)
+        !File.exists?(image) || File.mtime(@file_name) > File.mtime(image)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+require_relative 'binaryio'
+
+module Asciidoctor
+  module Diagram
+    module SVG
+      def self.get_image_size(data)
+        get_from_style(data) || get_from_viewport(data)
+      end
+
+      private
+
+      SVG_STYLE_REGEX = /style\s*=\s*"width:(?<width>\d+)px;height:(?<height>\d+)px/
+
+      def self.get_from_style(data)
+        match_data = SVG_STYLE_REGEX.match(data)
+        if match_data
+          [match_data[:width].to_i, match_data[:height].to_i]
+        else
+          nil
+        end
+      end
+
+      SVG_VIEWPORT_REGEX = /<svg width="(?<width>\d+)(?<width_unit>[a-zA-Z]+)" height="(?<height>\d+)(?<height_unit>[a-zA-Z]+)"/
+
+      def self.get_from_viewport(data)
+        match_data = SVG_VIEWPORT_REGEX.match(data)
+        if match_data
+          width = match_data[:width].to_i * to_px_factor(match_data[:width_unit])
+          height = match_data[:height].to_i * to_px_factor(match_data[:height_unit])
+          [width.to_i, height.to_i]
+        else
+          nil
+        end
+      end
+
+      def self.to_px_factor(unit)
+        case unit
+          when 'pt'
+            1.33
+          else
+            1
+        end
+      end
+    end
+  end
+end