asciidoctor-diagram 1.1.6 → 1.2.0.preview.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0098efdea85dc852061d2d62e6372757ce5dd564
-  data.tar.gz: 419ac386041d57d824dcf202c18a64929fb6fc85
+  metadata.gz: b9105f3a758a381ee41273031fcdabb5c6e6c7c7
+  data.tar.gz: 9b8a9602d6832d46bb9d8e6b483a390b1d491c34
 SHA512:
-  metadata.gz: 8e115238d21a4f3600f3671b9b614181ef37c609a07e3d880bbe30383355d315094a0d0f0ce8da364d24aa7b2a4a3ce85529bcd364c60afea7cc4fc410d81fd1
-  data.tar.gz: 2af83d989277ca19f966ce79df019c6c9e94689c5a88397638579397525ca7bcd6d3489ef3a51118a344c733f9e74809202d8ed803d35d9c283dab1a0bcf2717
+  metadata.gz: f6d2ef13b181388d1737a021e163ba3376da41ac68bfde8974a3ff2e4ba4ad4ccc8ee142b12a0bf0ee9bc2317d59ebe043d8f49d3971d5a9a0b0e55ca78c62c6
+  data.tar.gz: 6fea7bf3a26ed2a07c5548ca90dc93fcbdaa175815bbf32f6bcb85eacb7d864ec692b25035f87c61d043692fe37647267af02b85eb1f566abf543c362dfc4b8b

data/CHANGELOG.adoc

@@ -1,47 +1,10 @@
 = Asciidoctor-diagram Changelog
 
-== 1.1.6
+== 1.2.0
 
 Enhancements::
 
-  * Updated PlantUML to revision 8002 (23/07U/2014)
-  * Add support for Shaape diagrams (requires Shaape to be installed separately)
-  * Add support for Blockdiag diagrams (requires Blockdiag to be installed separately)
-  * Add support for Actdiag diagrams (requires Actdiag to be installed separately)
-  * Add support for Seqdiag diagrams (requires Seqdiag to be installed separately)
-  * Add support for Nwdiag diagrams (requires Nwdiag to be installed separately)
-
-Bug Fixes::
-  * Issue #38: Resolved Graphviz syntax errors with certain diagrams
-
-== 1.1.5
-
-Enhancements::
-
-  * Use the output directory (outdir attribute) as base directory if it's specified.
-  * Do not auto-generate width/height attributes when outputting to a non-HTML backend. This resolves issues with
-    oversized images in docbook output.
-
-== 1.1.4
-
-Bug Fixes::
-
-  * Under CRuby in combination with certain Java versions a FileNotFoundException could be triggered due to incorrect
-    method selection by RJB
-
-== 1.1.3
-
-Bug Fixes::
-
-  * Image regeneration logic did not always correctly detect cases where images did not need to be updated
-
-== 1.1.2
-
-Bug Fixes::
-
-  * Fix corrupt PNG images on Windows
-  * Fix NoSuchMethodError in block macro processing when target image file already existed
-  * Respect target attribute in block macros
+  * Updated to Asciidoctor 1.5.0
 
 == 1.1.1
 

data/examples/README.adoc

@@ -1,6 +1,18 @@
 = Asciidoctor-diagram Examples
 
 This directory contains a number of example files that illustrate how to use the asciidoctor-diagram extension.
-Asciidoctor 0.1.4 does not support loading extensions via the command line.
-In order to process the examples correctly you should use the `build-example.rb` script.
-This wraps the regular `asciidoctor` command line tool and automatically loads the asciidoctor-diagram extension.
+
+In order to build the examples correctly the asciidoctor-diagram extension should be loaded.
+This can be done using bundler by running
+
+----
+bundle exec asciidoctor -r asciidoctor-diagram <asciidoc file>
+----
+
+If you do not want to use bundler you can alternatively run
+
+----
+asciidoctor -r asciidoctor-diagram -I ../lib <asciidoc file>
+----
+
+This variant requires you to explicitly specify the load path from which asciidoctor-diagram can be loaded.

data/lib/asciidoctor-diagram.rb

@@ -1,5 +1,3 @@
-require 'asciidoctor-diagram/blockdiag'
 require 'asciidoctor-diagram/ditaa'
 require 'asciidoctor-diagram/graphviz'
-require 'asciidoctor-diagram/plantuml'
-require 'asciidoctor-diagram/shaape'
+require 'asciidoctor-diagram/plantuml'

data/lib/asciidoctor-diagram/ditaa.rb

@@ -3,6 +3,6 @@ require_relative 'version'
 
 Asciidoctor::Extensions.register do
   require_relative 'ditaa/extension'
-  block :ditaa, Asciidoctor::Diagram::DitaaBlock
-  block_macro :ditaa, Asciidoctor::Diagram::DitaaBlockMacro
+  block Asciidoctor::Diagram::DitaaBlock, :ditaa
+  block_macro Asciidoctor::Diagram::DitaaBlockMacro, :ditaa
 end

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

@@ -1,35 +1,37 @@
 require_relative '../util/diagram'
-require_relative '../util/java'
+require_relative 'generator'
 
 module Asciidoctor
   module Diagram
-    module DitaaGenerator
-      DITAA_JAR_PATH = File.expand_path File.join('../..', 'ditaamini0_9.jar'), File.dirname(__FILE__)
-      Java.classpath << DITAA_JAR_PATH
+    module DitaaBase
+      include DitaaGenerator
 
-      def self.ditaa(code)
-        Java.load
+      private
 
-        args = ['-e', 'UTF-8']
-
-        bytes = code.encode(Encoding::UTF_8).bytes.to_a
-        bis = Java.new_object(Java.java.io.ByteArrayInputStream, '[B', Java.array_to_java_array(bytes, :byte))
-        bos = Java.new_object(Java.java.io.ByteArrayOutputStream)
-        result_code = Java.org.stathissideris.ascii2image.core.CommandLineConverter.convert(Java.array_to_java_array(args, :string), bis, bos)
-        bis.close
-        bos.close
-
-        result = Java.string_from_java_bytes(bos.toByteArray)
+      def register_formats
+        register_format(:png, :image) do |c|
+          ditaa(c)
+        end
+      end
+    end
 
-        raise "Ditaa image generation failed: #{result}" unless result_code == 0
+    class DitaaBlock < Asciidoctor::Extensions::BlockProcessor
+      include DiagramProcessorBase
+      include DitaaBase
 
-        result
+      def initialize name = nil, config = {}
+        super
+        register_formats()
       end
     end
 
-    DiagramProcessor.define_processors('Ditaa') do
-      register_format(:png, :image) do |c|
-        DitaaGenerator.ditaa(c)
+    class DitaaBlockMacro < Asciidoctor::Extensions::BlockMacroProcessor
+      include DiagramProcessorBase
+      include DitaaBase
+
+      def initialize name = nil, config = {}
+        super
+        register_formats()
       end
     end
   end

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

@@ -0,0 +1,31 @@
+require_relative '../util/java'
+
+module Asciidoctor
+  module Diagram
+    module DitaaGenerator
+      private
+
+      DITAA_JAR_PATH = File.expand_path File.join('../..', 'ditaamini0_9.jar'), File.dirname(__FILE__)
+      Java.classpath << DITAA_JAR_PATH
+
+      def ditaa(code)
+        Java.load
+
+        args = ['-e', 'UTF-8']
+
+        bytes = code.encode(Encoding::UTF_8).bytes.to_a
+        bis = Java.java.io.ByteArrayInputStream.new(Java.array_to_java_array(bytes, :byte))
+        bos = Java.java.io.ByteArrayOutputStream.new
+        result_code = Java.org.stathissideris.ascii2image.core.CommandLineConverter.convert(Java.array_to_java_array(args, :string), bis, bos)
+        bis.close
+        bos.close
+
+        result = Java.string_from_java_bytes(bos.toByteArray)
+
+        raise "Ditaa image generation failed: #{result}" unless result_code == 0
+
+        result
+      end
+    end
+  end
+end

data/lib/asciidoctor-diagram/graphviz.rb

@@ -3,6 +3,6 @@ require_relative 'version'
 
 Asciidoctor::Extensions.register do
   require_relative 'graphviz/extension'
-  block :graphviz, Asciidoctor::Diagram::GraphvizBlock
-  block_macro :graphviz, Asciidoctor::Diagram::GraphvizBlockMacro
+  block Asciidoctor::Diagram::GraphvizBlock, :graphviz
+  block_macro Asciidoctor::Diagram::GraphvizBlockMacro, :graphviz
 end

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

@@ -1,18 +1,41 @@
-require_relative '../util/cli_generator'
 require_relative '../util/diagram'
+require_relative '../plantuml/generator'
 
 module Asciidoctor
   module Diagram
-    module Diagram
-      DiagramProcessor.define_processors('Graphviz') do
-        [:png, :svg].each do |f|
-          register_format(f, :image) do |c, p|
-            CliGenerator.generate('dot', p, c) do |tool_path, output_path|
-              [tool_path, "-o#{output_path}", "-T#{f.to_s}"]
-            end
-          end
+    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 name = nil, config = {}
+        super
+        register_formats()
+      end
+    end
+
+    class GraphvizBlockMacro < Asciidoctor::Extensions::BlockMacroProcessor
+      include DiagramProcessorBase
+      include GraphvizBase
+
+      def initialize name = nil, config = {}
+        super
+        register_formats()
+      end
+    end
   end
 end

data/lib/asciidoctor-diagram/plantuml.rb

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

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

@@ -3,25 +3,41 @@ require_relative 'generator'
 
 module Asciidoctor
   module Diagram
-    DiagramProcessor.define_processors('PlantUml') do
-      def config_args(parent)
-        config_args = []
-        config = parent.document.attributes['plantumlconfig']
-        if config
-          config_args += ['-config', File.expand_path(config, parent.document.attributes['docdir'])]
-        end
+    module PlantUmlBase
+      include PlantUmlGenerator
 
-        config_args
-      end
+      private
 
-      register_format(:png, :image) do |c, p|
-        PlantUmlGenerator.plantuml(p, c, 'uml', *config_args(p))
+      def register_formats()
+        register_format(:png, :image) do |c, p|
+          plantuml(p, c, 'uml')
+        end
+        register_format(:svg, :image) do |c, p|
+          plantuml(p, c, 'uml', '-tsvg')
+        end
+        register_format(:txt, :literal) do |c, p|
+          plantuml(p, c, 'uml', '-tutxt')
+        end
       end
-      register_format(:svg, :image) do |c, p|
-        PlantUmlGenerator.plantuml(p, c, 'uml', '-tsvg', *config_args(p))
+    end
+
+    class PlantUmlBlock < Asciidoctor::Extensions::BlockProcessor
+      include DiagramProcessorBase
+      include PlantUmlBase
+
+      def initialize name = nil, config = {}
+        super
+        register_formats()
       end
-      register_format(:txt, :literal) do |c, p|
-        PlantUmlGenerator.plantuml(p, c, 'uml', '-tutxt', *config_args(p))
+    end
+
+    class PlantUmlBlockMacro < Asciidoctor::Extensions::BlockMacroProcessor
+      include DiagramProcessorBase
+      include PlantUmlBase
+
+      def initialize name = nil, config = {}
+        super
+        register_formats()
       end
     end
   end

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

@@ -1,5 +1,4 @@
 require_relative '../util/java'
-require_relative '../util/which'
 
 module Asciidoctor
   module Diagram
@@ -9,10 +8,10 @@ module Asciidoctor
       PLANTUML_JAR_PATH = File.expand_path File.join('../..', 'plantuml.jar'), File.dirname(__FILE__)
       Java.classpath << PLANTUML_JAR_PATH
 
-      def self.plantuml(parent, code, tag, *flags)
+      def plantuml(parent, code, tag, *flags)
         unless @graphvizdot
           @graphvizdot = parent.document.attributes['graphvizdot']
-          @graphvizdot = ::Asciidoctor::Diagram.which('dot') unless @graphvizdot && File.executable?(@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
 
@@ -22,20 +21,35 @@ module Asciidoctor
 
         flags += ['-charset', 'UTF-8', '-failonerror', '-graphvizdot', @graphvizdot]
 
-        option = Java.new_object( Java.net.sourceforge.plantuml.Option, '[Ljava.lang.String;', Java.array_to_java_array(flags, :string) )
-        source_reader = Java.new_object( Java.net.sourceforge.plantuml.SourceStringReader,
-                                         'Lnet.sourceforge.plantuml.preproc.Defines;Ljava.lang.String;Ljava.util.List;',
-                                         Java.new_object( Java.net.sourceforge.plantuml.preproc.Defines ),
-                                         code,
-                                         option.getConfig()
+        config_file = parent.document.attributes['plantumlconfig']
+        if config_file
+          flags += ['-config', File.expand_path(config_file, parent.document.attributes['docdir'])]
+        end
+
+        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.new_object( Java.java.io.ByteArrayOutputStream )
-        ps = Java.new_object( Java.java.io.PrintStream, 'Ljava.io.OutputStream;', bos )
+        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

@@ -1,14 +1,13 @@
 require 'asciidoctor/extensions'
 require 'digest'
 require 'json'
-require 'fileutils'
 require_relative 'java'
 require_relative 'png'
 require_relative 'svg'
 
 module Asciidoctor
   module Diagram
-    module DiagramProcessor
+    module DiagramProcessorBase
       IMAGE_PARAMS = {
           :svg => {
               :encoding => Encoding::UTF_8,
@@ -20,81 +19,42 @@ module Asciidoctor
           }
       }
 
-      module ClassMethods
-        #
-        # 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
+      def self.included(base)
+        base.option :pos_attrs, ['target', 'format']
 
-          formats[format] = {
-              :type => type,
-              :generator => block
-          }
-        end
+        if base.ancestors.include?(Asciidoctor::Extensions::BlockProcessor)
+          base.option :contexts, [:listing, :literal, :open]
+          base.option :content_model, :simple
 
-        def formats
-          @formats ||= {}
-        end
-
-        def default_format
-          @default_format
-        end
-      end
-
-      def self.included base
-        base.extend ClassMethods
-      end
-
-      def self.define_processors(name, &init)
-        block = Class.new(Asciidoctor::Extensions::BlockProcessor) do
-          include DiagramProcessor
-
-          option :pos_attrs, ['target', 'format']
-          option :contexts, [:listing, :literal, :open]
-          option :content_model, :simple
-
-          def process(parent, reader, attributes)
-            generate_block(parent, ReaderSource.new(reader), attributes)
+          base.instance_eval do
+            alias_method :process, :process_block
+          end
+        else
+          base.instance_eval do
+            alias_method :process, :process_macro
           end
-
-          self.instance_eval &init
         end
 
-        block_macro = Class.new(Asciidoctor::Extensions::BlockMacroProcessor) do
-          include DiagramProcessor
-
-          option :pos_attrs, ['target', 'format']
-
-          def process(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
+      end
 
-          self.instance_eval &init
-        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))
 
-        Asciidoctor::Diagram.const_set("#{name}Block", block)
-        Asciidoctor::Diagram.const_set("#{name}BlockMacro", block_macro)
+        generate_block(parent, source, attributes)
       end
 
-      private
+      def process_block(parent, reader, attributes)
+        generate_block(parent, ReaderSource.new(reader), attributes)
+      end
 
       def generate_block(parent, source, attributes)
-        format = attributes.delete('format') || self.class.default_format
+        format = attributes.delete('format') || @default_format
         format = format.to_sym if format.respond_to?(:to_sym)
 
         raise "Format undefined" unless format
 
-        generator_info = self.class.formats[format]
+        generator_info = formats[format]
 
         raise "#{self.class.name} does not support output format #{format}" unless generator_info
 
@@ -108,41 +68,65 @@ module Asciidoctor
         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 || ('diag-' + source.checksum)}.#{format}"
-        image_dir = File.expand_path(parent.document.attributes['imagesdir'] || '', parent.document.attributes['outdir'] || parent.document.attributes['docdir'])
+        image_dir = File.expand_path(parent.document.attributes['imagesdir'] || '', parent.document.attributes['docdir'])
         image_file = File.expand_path(image_name, image_dir)
-        metadata_file = File.expand_path("#{image_name}.cache", image_dir)
 
-        if File.exists? metadata_file
-          metadata = File.open(metadata_file, 'r') { |f| JSON.load f }
-        else
-          metadata = {}
-        end
+        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
 
-        if source.should_process?(image_file, metadata['checksum'])
-          params = IMAGE_PARAMS[format]
+          unless File.exists?(image_file) && metadata && metadata['checksum'] == source.checksum
+            params = IMAGE_PARAMS[format]
 
-          result = generator_info[:generator].call(source.code, parent)
+            result = generator_info[:generator].call(source.code, parent)
 
-          result.force_encoding(params[:encoding])
+            result.force_encoding(params[:encoding])
 
-          metadata = {'checksum' => source.checksum}
-          metadata['width'], metadata['height'] = params[:decoder].get_image_size(result)
+            metadata = {'checksum' => source.checksum}
+            metadata['width'], metadata['height'] = params[:decoder].get_image_size(result)
 
-          FileUtils.mkdir_p(image_dir) unless Dir.exists?(image_dir)
-          File.open(image_file, 'wb') { |f| f.write result }
-          File.open(metadata_file, 'w') { |f| JSON.dump(metadata, f) }
+            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
-        if /html/i =~ parent.document.attributes['backend']
-          attributes['width'] ||= metadata['width'] if metadata['width']
-          attributes['height'] ||= metadata['height'] if metadata['height']
-        end
-        attributes['alt'] ||= if title_text = attributes['title']
+        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 '_-', ' '
@@ -170,12 +154,12 @@ module Asciidoctor
     end
 
     class Source
-      def checksum
-        @checksum ||= compute_checksum(code)
+      def newer_than?(image)
+        true
       end
 
-      def should_process?(image_file, old_checksum)
-        !File.exists?(image_file) || (newer_than?(image_file) && old_checksum != checksum)
+      def checksum
+        @checksum ||= compute_checksum(code)
       end
 
       private
@@ -192,12 +176,8 @@ module Asciidoctor
         @reader = reader
       end
 
-      def newer_than?(image_file)
-        true
-      end
-
       def code
-        @code ||= @reader.lines.join
+        @code ||= @reader.lines.join("\n")
       end
     end
 
@@ -206,13 +186,13 @@ module Asciidoctor
         @file_name = file_name
       end
 
-      def newer_than?(image_file)
-        File.mtime(@file_name) > File.mtime(image_file)
-      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