asciidoctor-diagram 1.2.1-java → 1.3.0.preview.1-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1bd129d7f1a3bcb983c175ff81f7278736e8f84f
-  data.tar.gz: fbd0f23226b3dd0df2b648e7b69a3c4721a3a4e0
+  metadata.gz: e1cbd019a0247c43f55f350f3897a689b3af5d83
+  data.tar.gz: 3d85e72167829121d471faa6f20586cc2eb1eab4
 SHA512:
-  metadata.gz: c6b8951de8298832807be2187d14894194d92a0f61467dbc5d53ec2d9e6f2f7dd1f13bb00d5c63e66f82dc5a09eee65710f4619cb3acc93e9be97ad07330c2d0
-  data.tar.gz: 3431ef61b193d3029a657bdec8955c9062ab7cf25f8c49533d40ca3006e338e90a85605d80177563ecaae0140c503791aac9f533b9a393bd2732a860d443ebbb
+  metadata.gz: 24de85845930e2d4b87458dbf5e79308d09134975e61bc8ec8f34f354c3b8f2c317f8687a18e8a58f3deaee85c6ac7e183da3b9b332f67dbfa2f352667ac5810
+  data.tar.gz: ff54af102f2a7d21eefa591f4db10985826c97f2eff4044bb305a91f2c0cc888f5d965fddea4bba4f75ad96ed03baa2f5bcca8edf6e952d664c5cd8663183cd7

data/CHANGELOG.adoc

@@ -1,10 +1,14 @@
 = Asciidoctor-diagram Changelog
 
-== 1.2.1
+== 1.3.0
 
 Enhancements::
 
-  * Add support for Actdiag, Seqdiag, Nwdiag, Packetdiag and Rackdiag diagrams (requires resp. Python packages to be installed separately)
+  * Introduces a documented, public extension API
+  * 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)
+  * Updated PlantUML to revision 8004 (23/08/2014)
 
 == 1.2.0
 
@@ -16,11 +20,12 @@ Enhancements::
 
 Enhancements::
 
-  * Updated PlantUML to revision 8002 (23/07U/2014)
-  * Add support for Shaape diagrams (requires Shaape Python package to be installed separately)
-  * Add support for Blockdiag diagrams (requires Blockdiag Python package to be installed separately)
+  * Updated PlantUML to revision 8002 (23/07/2014)
+  * Add support for Shaape diagrams (requires Shaape to be installed separately)
+  * Add support for Blockdiag diagrams (requires Blockdiag to be installed separately)
 
 Bug Fixes::
+
   * Issue #38: Resolved Graphviz syntax errors with certain diagrams
 
 == 1.1.5

data/README.adoc

@@ -2,7 +2,14 @@
 Pepijn Van_Eeckhoudt
 
 Asciidoctor Diagram is a set of extensions for http://asciidoctor.org[Asciidoctor], the Ruby-based AsciiDoc processor.
-These extensions allow you to embed diagrams written using the http://plantuml.sourceforge.net[PlantUML] or Ditaa syntax inside your AsciiDoc documents.
+These extensions allow you to embed plain text diagrams inside your AsciiDoc documents using one of the following syntaxes:
+
+- http://plantuml.sourceforge.net[PlantUML]
+- http://ditaa.sourceforge.net[Ditaa].
+- https://github.com/christiangoltz/shaape[Shaape]
+- http://blockdiag.com[BlockDiag, SeqDiag, ActDiag, NwDiag]
+- http://www.graphviz.org/content/dot-language[GraphViz DOT]
+
 The extension takes care of running the diagram processor to generate the images from the input text and insert them into the rendered document.
 
 This gem was inspired by the https://code.google.com/p/asciidoc-plantuml/[AsciiDoc PlantUML filter] for AsciiDoc Python.
@@ -23,6 +30,14 @@ Or install it yourself as:
 
  $ gem install asciidoctor-diagram
 
+=== Additional Requirements
+
+Certain diagram types require other tools to be installed seperately.
+
+- PlantUML and Graphviz: the Graphviz `dot` tool.
+- Shaape: the Shaape Python package
+- Block/Seq/Act/Nw diag: the block/seq/act/nw diag Python packages
+
 == Usage
 
 === Enable the extensions
@@ -32,9 +47,11 @@ In order to use extensions you should need to invoke Asciidoctor via the http://
 In your script you can then either require one or more of the following files:
 
 . `asciidoctor-diagram`: to enable all the diagramming extensions
+. `asciidoctor-diagram/blockdiag`: to enable the block/act/seq/nw diag extension
 . `asciidoctor-diagram/ditaa`: to enable the ditaa extension
 . `asciidoctor-diagram/graphviz`: to enable the graphviz extension
 . `asciidoctor-diagram/plantuml`: to enable the plantuml extension
+. `asciidoctor-diagram/shaape`: to enable the shaape extension
 
 Requiring one or more of these files will automatically register the extensions for all processed documents.
 If you need more fine grained control over when the extensions are enabled or not, `asciidoctor-diagram/ditaa/extension`, `asciidoctor-diagram/graphviz/extension` and `asciidoctor-diagram/plantuml/extension` can be used instead.
@@ -43,7 +60,14 @@ You should then register the extensions yourself at the appropriate time using t
 
 === Using the extensions
 
-Once the extensions are enabled support for `ditaa`, `graphviz` and `plantuml` blocks becomes available for your documents.
+Once the extensions are enabled the following block types becomes available for your documents:
+
+- `blockdiag`, `actdiag`, `seqdiag`, `nwdiag`, `rackdiag` and `packetdiag`
+- `ditaa`
+- `graphviz`
+- `plantuml`
+- `shaape`
+
 Detailed descriptions of the supported syntax inside these blocks is available on the http://plantuml.sourceforge.net/[PlantUML], http://www.graphviz.org/content/dot-language[Graphviz] and http://ditaa.sourceforge.net/[ditaa] websites.
 
 At this point you can start adding diagrams to your application, like the following example:
@@ -65,7 +89,7 @@ DiagramBlock <|-- PlantUmlBlock
 The diagram blocks support the following attributes:
 
 . `target` (or 2nd position): the basename of the file to generate. If not specified an auto-generated name will be used.
-. `format` (or 3rd position): the output format. PlantUML blocks support `png`, `svg` and `txt`. Graphviz supports `png` and `svg`. Ditaa only supports `png`.
+. `format` (or 3rd position): the output format. PlantUML blocks support `png`, `svg` and `txt`. Graphviz, Shaape and BlockDiag support `png` and `svg`. Ditaa only supports `png`.
 
 == Contributing
 

data/lib/asciidoctor-diagram/blockdiag.rb

@@ -5,11 +5,7 @@ Asciidoctor::Extensions.register do
   require_relative 'blockdiag/extension'
 
   ['BlockDiag', 'SeqDiag', 'ActDiag', 'NwDiag', 'RackDiag', 'PacketDiag'].each do |tool|
-    name = tool.downcase.to_sym
-    block = Asciidoctor::Diagram.const_get("#{tool}Block")
-    block_macro = Asciidoctor::Diagram.const_get("#{tool}BlockMacro")
-
-    block block, name
-    block_macro block_macro, name
+    block ::Asciidoctor::Diagram.const_get("#{tool}BlockProcessor"), tool.downcase.to_sym
+    block_macro ::Asciidoctor::Diagram.const_get("#{tool}BlockMacroProcessor"), tool.downcase.to_sym
   end
 end

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

@@ -1,13 +1,94 @@
+require_relative '../extensions'
 require_relative '../util/cli_generator'
-require_relative '../util/diagram'
 
 module Asciidoctor
   module Diagram
+    # @private
+    module BlockDiag
+      def self.define_processors(name, &init)
+        block = Class.new(Extensions::DiagramBlockProcessor) do
+          self.instance_eval &init
+        end
+        ::Asciidoctor::Diagram.const_set("#{name}BlockProcessor", block)
+
+        block_macro = Class.new(Extensions::DiagramBlockMacroProcessor) do
+          self.instance_eval &init
+        end
+
+        ::Asciidoctor::Diagram.const_set("#{name}BlockMacroProcessor", block_macro)
+      end
+    end
+
+    # @!parse
+    #   # Block processor converts blockdiag code into images.
+    #   #
+    #   # Supports PNG and SVG output.
+    #   class BlockDiagBlockProcessor < API::DiagramBlockProcessor; end
+    #
+    #   # Block macro processor converts blockdiag source files into images.
+    #   #
+    #   # Supports PNG and SVG output.
+    #   class BlockDiagBlockMacroProcessor < DiagramBlockMacroProcessor; end
+
+    # @!parse
+    #   # Block processor converts seqdiag code into images.
+    #   #
+    #   # Supports PNG and SVG output.
+    #   class SeqDiagBlockProcessor < API::DiagramBlockProcessor; end
+    #
+    #   # Block macro processor converts seqdiag source files into images.
+    #   #
+    #   # Supports PNG and SVG output.
+    #   class SeqDiagBlockMacroProcessor < API::DiagramBlockMacroProcessor; end
+
+    # @!parse
+    #   # Block processor converts actdiag code into images.
+    #   #
+    #   # Supports PNG and SVG output.
+    #   class ActDiagBlockProcessor < API::DiagramBlockProcessor; end
+    #
+    #   # Block macro processor converts actdiag source files into images.
+    #   #
+    #   # Supports PNG and SVG output.
+    #   class ActDiagBlockMacroProcessor < API::DiagramBlockMacroProcessor; end
+
+    # @!parse
+    #   # Block processor converts nwdiag code into images.
+    #   #
+    #   # Supports PNG and SVG output.
+    #   class NwDiagBlockProcessor < API::DiagramBlockProcessor; end
+    #
+    #   # Block macro processor converts nwdiag source files into images.
+    #   #
+    #   # Supports PNG and SVG output.
+    #   class NwDiagBlockMacroProcessor < API::DiagramBlockMacroProcessor; end
+
+    # @!parse
+    #   # Block processor converts rackdiag code into images.
+    #   #
+    #   # Supports PNG and SVG output.
+    #   class RackDiagBlockProcessor < API::DiagramBlockProcessor; end
+    #
+    #   # Block macro processor converts rackdiag source files into images.
+    #   #
+    #   # Supports PNG and SVG output.
+    #   class RackDiagBlockMacroProcessor < API::DiagramBlockMacroProcessor; end
+
+    # @!parse
+    #   # Block processor converts packetdiag code into images.
+    #   #
+    #   # Supports PNG and SVG output.
+    #   class PacketDiagBlockProcessor < API::DiagramBlockProcessor; end
+    #
+    #   # Block macro processor converts packetdiag source files into images.
+    #   #
+    #   # Supports PNG and SVG output.
+    #   class PacketDiagBlockMacroProcessor < API::DiagramBlockMacroProcessor; end
     ['BlockDiag', 'SeqDiag', 'ActDiag', 'NwDiag', 'RackDiag', 'PacketDiag'].each do |tool|
-      define_processors(tool) do
+      BlockDiag.define_processors(tool) do
         [:png, :svg].each do |f|
           register_format(f, :image) do |c, p|
-            CliGenerator.generate(tool.downcase, p, c) do |tool_path, output_path|
+            CliGenerator.generate(tool.downcase, p, c.to_s) do |tool_path, output_path|
               [tool_path, '-o', output_path, "-T#{f.to_s}", '-']
             end
           end

data/lib/asciidoctor-diagram/ditaa.rb

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

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

@@ -1,13 +1,14 @@
-require_relative '../util/diagram'
+require_relative '../extensions'
 require_relative '../util/java'
 
 module Asciidoctor
   module Diagram
-    module DitaaGenerator
+    # @private
+    module Ditaa
       DITAA_JAR_PATH = File.expand_path File.join('../..', 'ditaamini0_9.jar'), File.dirname(__FILE__)
       Java.classpath << DITAA_JAR_PATH
 
-      def self.ditaa(code)
+      def ditaa(code)
         Java.load
 
         args = ['-e', 'UTF-8']
@@ -25,12 +26,20 @@ module Asciidoctor
 
         result
       end
-    end
 
-    define_processors('Ditaa') do
-      register_format(:png, :image) do |c|
-        DitaaGenerator.ditaa(c)
+      def self.included(mod)
+        mod.register_format(:png, :image) do |c|
+          ditaa(c.to_s)
+        end
       end
     end
+
+    class DitaaBlockProcessor < Extensions::DiagramBlockProcessor
+      include Ditaa
+    end
+
+    class DitaaBlockMacroProcessor < Extensions::DiagramBlockMacroProcessor
+      include Ditaa
+    end
   end
 end

data/lib/asciidoctor-diagram/extensions.rb

@@ -0,0 +1,325 @@
+require 'asciidoctor/extensions'
+require 'digest'
+require 'json'
+require 'fileutils'
+require_relative 'util/java'
+require_relative 'util/png'
+require_relative 'util/svg'
+
+module Asciidoctor
+  module Diagram
+    module Extensions
+      # Provides the means for diagram processors to register supported output formats and image
+      # generation routines
+      module FormatRegistry
+        # Registers a supported format. The first registered format becomes the default format for the block
+        # processor.
+        #
+        # @param [Symbol] format the format name
+        # @param [Symbol] type a symbol indicating the type of block that should be generated; either :image or :literal
+        # @yieldparam parent [Asciidoctor::AbstractNode] the asciidoc block that is being processed
+        # @yieldparam source [DiagramSource] the source object
+        # @yieldreturn [String] the generated diagram
+        #
+        # Examples
+        #
+        #   register_format(:png, :image ) do |parent, source|
+        #     File.read(source.to_s)
+        #   end
+        def register_format(format, type, &block)
+          unless @default_format
+            @default_format = format
+          end
+
+          formats[format] = {
+              :type => type,
+              :generator => block
+          }
+        end
+
+        # Returns the registered formats
+        #
+        # @return [Hash]
+        # @api private
+        def formats
+          @formats ||= {}
+        end
+
+        # Returns the default format
+        #
+        # @return [Symbol] the default format
+        # @api private
+        def default_format
+          @default_format
+        end
+      end
+
+      # Mixin that provides the basic machinery for image generation.
+      # When this module is included it will include the FormatRegistry into the singleton class of the target class.
+      module DiagramProcessor
+        IMAGE_PARAMS = {
+            :svg => {
+                :encoding => Encoding::UTF_8,
+                :decoder => SVG
+            },
+            :png => {
+                :encoding => Encoding::ASCII_8BIT,
+                :decoder => PNG
+            }
+        }
+
+        def self.included(mod)
+          class << mod
+            include FormatRegistry
+          end
+        end
+
+        # Processes the diagram block or block macro by converting it into an image or literal block.
+        #
+        # @param parent [Asciidoctor::AbstractBlock] the parent asciidoc block of the block or block macro being processed
+        # @param reader_or_target [Asciidoctor::Reader, String] a reader that provides the contents of a block or the
+        #        target value of a block macro
+        # @param attributes [Hash] the attributes of the block or block macro
+        # @return [Asciidoctor::AbstractBlock] a new block that replaces the original block or block macro
+        def process(parent, reader_or_target, attributes)
+          source = create_source(parent, reader_or_target, attributes)
+
+          format = attributes.delete('format') || self.class.default_format
+          format = format.to_sym if format.respond_to?(:to_sym)
+
+          raise "Format undefined" unless format
+
+          generator_info = self.class.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
+
+        protected
+
+        # Creates a DiagramSource object for the block or block macro being processed. Classes using this
+        # mixin must implement this method.
+        #
+        # @param parent [Asciidoctor::AbstractBlock] the parent asciidoc block of the block or block macro being processed
+        # @param reader_or_target [Asciidoctor::Reader, String] a reader that provides the contents of a block or the
+        #        target value of a block macro
+        # @param attributes [Hash] the attributes of the block or block macro
+        #
+        # @return [DiagramSource] an object that implements the interface described by DiagramSource
+        #
+        # @abstract
+        def create_source(parent, reader_or_target, attributes)
+          raise NotImplementedError.new
+        end
+
+        private
+        def create_image_block(parent, source, attributes, format, generator_info)
+          image_name = "#{source.image_name}.#{format}"
+          outdir = parent.document.attr('imagesoutdir') || parent.document.attr('outdir')
+          image_dir = parent.normalize_system_path parent.document.attr 'imagesdir', outdir
+          image_file = parent.normalize_system_path image_name, image_dir
+          metadata_file = parent.normalize_system_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 !File.exists?(image_file) || source.should_process?(image_file, metadata)
+            params = IMAGE_PARAMS[format]
+
+            result = instance_exec(source, parent, &generator_info[:generator])
+
+            result.force_encoding(params[:encoding])
+
+            metadata = source.create_image_metadata
+            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) }
+          end
+
+          image_attributes = attributes.dup
+          image_attributes['target'] = image_name
+          if /html/i =~ parent.document.attributes['backend']
+            image_attributes['width'] ||= metadata['width'] if metadata['width']
+            image_attributes['height'] ||= metadata['height'] if metadata['height']
+          end
+          image_attributes['alt'] ||= if title_text = attributes['title']
+                                        title_text
+                                      elsif target = attributes['target']
+                                        (File.basename target, (File.extname target) || '').tr '_-', ' '
+                                      else
+                                        'Diagram'
+                                      end
+
+          Asciidoctor::Block.new parent, :image, :content_model => :empty, :attributes => image_attributes
+        end
+
+        def create_literal_block(parent, source, attributes, generator_info)
+          literal_attributes = attributes.dup
+          literal_attributes.delete('target')
+
+          result = instance_exec(source, parent, &generator_info[:generator])
+
+          result.force_encoding(Encoding::UTF_8)
+          Asciidoctor::Block.new parent, :literal, :source => result, :attributes => literal_attributes
+        end
+      end
+
+      # Base class for diagram block processors.
+      class DiagramBlockProcessor < Asciidoctor::Extensions::BlockProcessor
+        include DiagramProcessor
+
+        def self.inherited(subclass)
+          subclass.option :pos_attrs, ['target', 'format']
+          subclass.option :contexts, [:listing, :literal, :open]
+          subclass.option :content_model, :simple
+        end
+
+        # Creates a ReaderSource from the given reader.
+        #
+        # @return [ReaderSource] a ReaderSource
+        def create_source(parent, reader, attributes)
+          ReaderSource.new(reader, attributes)
+        end
+      end
+
+      # Base class for diagram block macro processors.
+      class DiagramBlockMacroProcessor < Asciidoctor::Extensions::BlockMacroProcessor
+        include DiagramProcessor
+
+        def self.inherited(subclass)
+          subclass.option :pos_attrs, ['target', 'format']
+        end
+
+        # Creates a FileSource using target as the file name.
+        #
+        # @return [FileSource] a FileSource
+        def create_source(parent, target, attributes)
+          FileSource.new(File.expand_path(target, parent.document.attributes['docdir']), attributes)
+        end
+      end
+
+      # This module describes the duck-typed interface that diagram sources must implement. Implementations
+      # may include this module but it is not required.
+      module DiagramSource
+        # @return [String] the base name for the image file that will be produced
+        # @abstract
+        def image_name
+          raise NotImplementedError.new
+        end
+
+        # @return [String] the String representation of the source code for the diagram
+        # @abstract
+        def code
+          raise NotImplementedError.new
+        end
+
+        # Alias for code
+        def to_s
+          code
+        end
+
+        # Determines if the diagram should be regenerated or not. The default implementation of this method simply
+        # returns true.
+        #
+        # @param image_file [String] the path to the previously generated version of the image
+        # @param image_metadata [Hash] the image metadata Hash that was stored during the previous diagram generation pass
+        # @return [Boolean] true if the diagram should be regenerated; false otherwise
+        def should_process?(image_file, image_metadata)
+          true
+        end
+
+        # Creates an image metadata Hash that will be stored to disk alongside the generated image file. The contents
+        # of this Hash are reread during subsequent document processing and then passed to the should_process? method
+        # where it can be used to determine if the diagram should be regenerated or not.
+        # The default implementation returns an empty Hash.
+        # @return [Hash] a Hash containing metadata
+        def create_image_metadata
+          {}
+        end
+      end
+
+      # Base class for diagram source implementations that uses an md5 checksum of the source code of a diagram to
+      # determine if it has been updated or not.
+      class BasicSource
+        include DiagramSource
+
+        def initialize(attributes)
+          @attributes = attributes
+        end
+
+        def image_name
+          @attributes['target'] || ('diag-' + checksum)
+        end
+
+        def should_process?(image_file, image_metadata)
+          image_metadata['checksum'] != checksum
+        end
+
+        def create_image_metadata
+          {'checksum' => checksum}
+        end
+
+        def checksum
+          @checksum ||= compute_checksum(code)
+        end
+
+        def compute_checksum(code)
+          md5 = Digest::MD5.new
+          md5 << code
+          md5.hexdigest
+        end
+      end
+
+      # A diagram source that retrieves the code for the diagram from the contents of a block.
+      class ReaderSource < BasicSource
+        include DiagramSource
+
+        def initialize(reader, attributes)
+          super(attributes)
+          @reader = reader
+        end
+
+        def code
+          @code ||= @reader.lines.join("\n")
+        end
+      end
+
+      # A diagram source that retrieves the code for a diagram from an external source file.
+      class FileSource < BasicSource
+        def initialize(file_name, attributes)
+          super(attributes)
+          @file_name = file_name
+        end
+
+        def image_name
+          if @attributes['target']
+            super
+          else
+            File.basename(@file_name, File.extname(@file_name))
+          end
+        end
+
+        def should_process?(image_file, image_metadata)
+          File.mtime(@file_name) > File.mtime(image_file) || super
+        end
+
+        def code
+          @code ||= File.read(@file_name)
+        end
+      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 Asciidoctor::Diagram::GraphvizBlock, :graphviz
-  block_macro Asciidoctor::Diagram::GraphvizBlockMacro, :graphviz
+  block Asciidoctor::Diagram::GraphvizBlockProcessor, :graphviz
+  block_macro Asciidoctor::Diagram::GraphvizBlockMacroProcessor, :graphviz
 end

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

@@ -1,16 +1,27 @@
+require_relative '../extensions'
 require_relative '../util/cli_generator'
-require_relative '../util/diagram'
 
 module Asciidoctor
   module Diagram
-    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}"]
+    # @private
+    module Graphviz
+      def self.included(mod)
+        [:png, :svg].each do |f|
+          mod.register_format(f, :image) do |c, p|
+            CliGenerator.generate('dot', p, c.to_s) do |tool_path, output_path|
+              [tool_path, "-o#{output_path}", "-T#{f.to_s}"]
+            end
           end
         end
       end
     end
+
+    class GraphvizBlockProcessor < Extensions::DiagramBlockProcessor
+      include Graphviz
+    end
+
+    class GraphvizBlockMacroProcessor < Extensions::DiagramBlockMacroProcessor
+      include Graphviz
+    end
   end
 end

data/lib/asciidoctor-diagram/plantuml.rb

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

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

@@ -1,9 +1,47 @@
-require_relative '../util/diagram'
-require_relative 'generator'
+require_relative '../extensions'
 
 module Asciidoctor
   module Diagram
-    define_processors('PlantUml') do
+    # @private
+    module PlantUml
+      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['dot']
+          @graphvizdot = ::Asciidoctor::Diagram.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 'dot' 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]
+
+        config_file = parent.document.attributes['plantumlconfig']
+        if config_file
+          flags += ['-config', File.expand_path(config_file, parent.document.attributes['docdir'])]
+        end
+
+        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()
+        )
+
+        bos = Java.new_object( Java.java.io.ByteArrayOutputStream )
+        ps = Java.new_object( Java.java.io.PrintStream, 'Ljava.io.OutputStream;', bos )
+        source_reader.generateImage(ps, 0, option.getFileFormatOption())
+        ps.close
+        Java.string_from_java_bytes(bos.toByteArray)
+      end
+
       def config_args(parent)
         config_args = []
         config = parent.document.attributes['plantumlconfig']
@@ -14,15 +52,25 @@ module Asciidoctor
         config_args
       end
 
-      register_format(:png, :image) do |c, p|
-        PlantUmlGenerator.plantuml(p, c, 'uml', *config_args(p))
-      end
-      register_format(:svg, :image) do |c, p|
-        PlantUmlGenerator.plantuml(p, c, 'uml', '-tsvg', *config_args(p))
-      end
-      register_format(:txt, :literal) do |c, p|
-        PlantUmlGenerator.plantuml(p, c, 'uml', '-tutxt', *config_args(p))
+      def self.included(mod)
+        mod.register_format(:png, :image) do |c, p|
+          plantuml(p, c.to_s, 'uml', *config_args(p))
+        end
+        mod.register_format(:svg, :image) do |c, p|
+          plantuml(p, c.to_s, 'uml', '-tsvg', *config_args(p))
+        end
+        mod.register_format(:txt, :literal) do |c, p|
+          plantuml(p, c.to_s, 'uml', '-tutxt', *config_args(p))
+        end
       end
     end
+
+    class PlantUmlBlockProcessor < Extensions::DiagramBlockProcessor
+      include PlantUml
+    end
+
+    class PlantUmlBlockMacroProcessor < Extensions::DiagramBlockMacroProcessor
+      include PlantUml
+    end
   end
 end

data/lib/asciidoctor-diagram/shaape.rb

@@ -4,6 +4,6 @@ require_relative 'version'
 Asciidoctor::Extensions.register do
   require_relative 'shaape/extension'
 
-  block Asciidoctor::Diagram::ShaapeBlock, :shaape
-  block_macro Asciidoctor::Diagram::ShaapeBlockMacro, :shaape
+  block Asciidoctor::Diagram::ShaapeBlockProcessor, :shaape
+  block_macro Asciidoctor::Diagram::ShaapeBlockMacroProcessor, :shaape
 end

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

@@ -1,16 +1,27 @@
+require_relative '../extensions'
 require_relative '../util/cli_generator'
-require_relative '../util/diagram'
 
 module Asciidoctor
   module Diagram
-    define_processors('Shaape') do
-      [:png, :svg].each do |f|
-        register_format(f, :image) do |c, p|
-          CliGenerator.generate('shaape', p, c) do |tool_path, output_path|
-            [tool_path, '-o', output_path, '-t', f.to_s, '-']
+    # @private
+    module Shaape
+      def self.included(mod)
+        [:png, :svg].each do |f|
+          mod.register_format(f, :image) do |c, p|
+            CliGenerator.generate('shaape', p, c.to_s) do |tool_path, output_path|
+              [tool_path, '-o', output_path, '-t', f.to_s, '-']
+            end
           end
         end
       end
     end
+
+    class ShaapeBlockProcessor < Extensions::DiagramBlockProcessor
+      include Shaape
+    end
+
+    class ShaapeBlockMacroProcessor < Extensions::DiagramBlockMacroProcessor
+      include Shaape
+    end
   end
 end

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

@@ -1,5 +1,7 @@
 module Asciidoctor
   module Diagram
+    # Helper class to read binary values from a String
+    # @private
     class BinaryIO
       def initialize(string)
         @data = string

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

@@ -5,6 +5,7 @@ require_relative '../util/which'
 
 module Asciidoctor
   module Diagram
+    # @private
     module CliGenerator
       def self.generate(tool, parent, code)
         tool_var = '@' + tool
@@ -13,7 +14,7 @@ module Asciidoctor
         unless tool_path
           tool_path = parent.document.attributes[tool]
           tool_path = ::Asciidoctor::Diagram.which(tool) unless tool_path && File.executable?(tool_path)
-          raise "Could not find the '#{tool}' executable in PATH; add it to the PATH or specify its location using the 'shaape' document attribute" unless tool_path
+          raise "Could not find the '#{tool}' executable in PATH; add it to the PATH or specify its location using the '#{tool}' document attribute" unless tool_path
           instance_variable_set(tool_var, tool_path)
         end
 

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

@@ -2,6 +2,7 @@ require 'java'
 
 module Asciidoctor
   module Diagram
+    # @private
     module Java
       def self.classpath
         @classpath ||= []

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

@@ -2,6 +2,7 @@ require 'rjb'
 
 module Asciidoctor
   module Diagram
+    # @private
     module Java
       INITAWT_JAR_PATH = File.expand_path File.join('..', 'initawt.jar'), File.dirname(__FILE__)
 

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

@@ -2,6 +2,7 @@ require_relative 'binaryio'
 
 module Asciidoctor
   module Diagram
+    # @private
     module PNG
       PNG_SIGNATURE = [137, 80, 78, 71, 13, 10, 26, 10].pack('CCCCCCCC')
 

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

@@ -2,6 +2,7 @@ require_relative 'binaryio'
 
 module Asciidoctor
   module Diagram
+    # @private
     module SVG
       def self.get_image_size(data)
         if m = START_TAG_REGEX.match(data)

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

@@ -1,5 +1,6 @@
 module Asciidoctor
   module Diagram
+    # @private
     def self.which(cmd)
       exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
       ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|

data/lib/asciidoctor-diagram/version.rb

@@ -1,5 +1,5 @@
 module Asciidoctor
   module Diagram
-    VERSION = "1.2.1"
+    VERSION = "1.3.0.preview.1"
   end
 end

data/spec/blockdiag_spec.rb

@@ -7,7 +7,7 @@ blockdiag {
 }
 eos
 
-describe Asciidoctor::Diagram::BlockDiagBlockMacro do
+describe Asciidoctor::Diagram::BlockDiagBlockMacroProcessor do
   it "should generate PNG images when format is set to 'png'" do
     File.write('blockdiag.txt', code)
 
@@ -38,7 +38,7 @@ blockdiag::blockdiag.txt[format="png"]
   end
 end
 
-describe Asciidoctor::Diagram::BlockDiagBlock do
+describe Asciidoctor::Diagram::BlockDiagBlockProcessor do
   it "should generate PNG images when format is set to 'png'" do
     doc = <<-eos
 = Hello, BlockDiag!

data/spec/ditaa_spec.rb

@@ -1,6 +1,6 @@
 require_relative 'test_helper'
 
-describe Asciidoctor::Diagram::DitaaBlockMacro do
+describe Asciidoctor::Diagram::DitaaBlockMacroProcessor do
   it "should generate PNG images when format is set to 'png'" do
     code = <<-eos
 +--------+   +-------+    +-------+
@@ -43,7 +43,7 @@ ditaa::ditaa.txt[format="png"]
   end
 end
 
-describe Asciidoctor::Diagram::DitaaBlock do
+describe Asciidoctor::Diagram::DitaaBlockProcessor do
   it "should generate PNG images when format is set to 'png'" do
     doc = <<-eos
 = Hello, ditaa!

data/spec/graphviz_spec.rb

@@ -1,6 +1,6 @@
 require_relative 'test_helper'
 
-describe Asciidoctor::Diagram::GraphvizBlockMacro do
+describe Asciidoctor::Diagram::GraphvizBlockMacroProcessor do
   it "should generate PNG images when format is set to 'png'" do
     code = <<-eos
 digraph foo {
@@ -42,7 +42,7 @@ graphviz::graphviz.txt[format="png"]
   end
 end
 
-describe Asciidoctor::Diagram::GraphvizBlock do
+describe Asciidoctor::Diagram::GraphvizBlockProcessor do
   it "should generate PNG images when format is set to 'png'" do
     doc = <<-eos
 = Hello, graphviz!

data/spec/plantuml_spec.rb

@@ -1,6 +1,6 @@
 require_relative 'test_helper'
 
-describe Asciidoctor::Diagram::PlantUmlBlockMacro do
+describe Asciidoctor::Diagram::PlantUmlBlockMacroProcessor do
   it "should generate PNG images when format is set to 'png'" do
     code = <<-eos
 User -> (Start)
@@ -38,7 +38,7 @@ plantuml::plantuml.txt[format="png"]
   end
 end
 
-describe Asciidoctor::Diagram::PlantUmlBlock do
+describe Asciidoctor::Diagram::PlantUmlBlockProcessor do
   it "should generate PNG images when format is set to 'png'" do
     doc = <<-eos
 = Hello, PlantUML!

data/spec/shaape_spec.rb

@@ -1,6 +1,6 @@
 require_relative 'test_helper'
 
-describe Asciidoctor::Diagram::ShaapeBlockMacro do
+describe Asciidoctor::Diagram::ShaapeBlockMacroProcessor do
   it "should generate PNG images when format is set to 'png'" do
     code = <<-eos
     +--------+    +-------------+
@@ -40,7 +40,7 @@ shaape::shaape.txt[format="png"]
   end
 end
 
-describe Asciidoctor::Diagram::ShaapeBlock do
+describe Asciidoctor::Diagram::ShaapeBlockProcessor do
   it "should generate PNG images when format is set to 'png'" do
     doc = <<-eos
 = Hello, Shaape!

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-diagram
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0.preview.1
 platform: java
 authors:
 - Pepijn Van Eeckhoudt
@@ -86,16 +86,15 @@ files:
 - lib/asciidoctor-diagram/blockdiag/extension.rb
 - lib/asciidoctor-diagram/ditaa.rb
 - lib/asciidoctor-diagram/ditaa/extension.rb
+- lib/asciidoctor-diagram/extensions.rb
 - lib/asciidoctor-diagram/graphviz.rb
 - lib/asciidoctor-diagram/graphviz/extension.rb
 - lib/asciidoctor-diagram/plantuml.rb
 - lib/asciidoctor-diagram/plantuml/extension.rb
-- lib/asciidoctor-diagram/plantuml/generator.rb
 - lib/asciidoctor-diagram/shaape.rb
 - lib/asciidoctor-diagram/shaape/extension.rb
 - lib/asciidoctor-diagram/util/binaryio.rb
 - lib/asciidoctor-diagram/util/cli_generator.rb
-- lib/asciidoctor-diagram/util/diagram.rb
 - lib/asciidoctor-diagram/util/java.rb
 - lib/asciidoctor-diagram/util/java_jruby.rb
 - lib/asciidoctor-diagram/util/java_rjb.rb
@@ -126,9 +125,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.0.14

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

@@ -1,46 +0,0 @@
-require_relative '../util/java'
-require_relative '../util/which'
-
-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 self.plantuml(parent, code, tag, *flags)
-        unless @graphvizdot
-          @graphvizdot = parent.document.attributes['graphvizdot']
-          @graphvizdot = ::Asciidoctor::Diagram.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]
-
-        config_file = parent.document.attributes['plantumlconfig']
-        if config_file
-          flags += ['-config', File.expand_path(config_file, parent.document.attributes['docdir'])]
-        end
-        
-        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()
-        )
-
-        bos = Java.new_object( Java.java.io.ByteArrayOutputStream )
-        ps = Java.new_object( Java.java.io.PrintStream, 'Ljava.io.OutputStream;', bos )
-        source_reader.generateImage(ps, 0, option.getFileFormatOption())
-        ps.close
-        Java.string_from_java_bytes(bos.toByteArray)
-      end
-    end
-  end
-end

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

@@ -1,220 +0,0 @@
-require 'asciidoctor/extensions'
-require 'digest'
-require 'json'
-require 'fileutils'
-require_relative 'java'
-require_relative 'png'
-require_relative 'svg'
-
-module Asciidoctor
-  module Diagram
-    def self.define_processors(name, &init)
-      block = Class.new(Asciidoctor::Extensions::BlockProcessor) do
-        class << self
-          include FormatRegistry
-        end
-        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)
-        end
-
-        self.instance_eval &init
-      end
-
-      block_macro = Class.new(Asciidoctor::Extensions::BlockMacroProcessor) do
-        class << self
-          include FormatRegistry
-        end
-        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
-
-        self.instance_eval &init
-      end
-
-      Asciidoctor::Diagram.const_set("#{name}Block", block)
-      Asciidoctor::Diagram.const_set("#{name}BlockMacro", block_macro)
-    end
-
-    module FormatRegistry
-      #
-      # 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 default_format
-        @default_format
-      end
-    end
-
-    module DiagramProcessor
-      IMAGE_PARAMS = {
-          :svg => {
-              :encoding => Encoding::UTF_8,
-              :decoder => SVG
-          },
-          :png => {
-              :encoding => Encoding::ASCII_8BIT,
-              :decoder => PNG
-          }
-      }
-
-      private
-
-      def generate_block(parent, source, attributes)
-        format = attributes.delete('format') || self.class.default_format
-        format = format.to_sym if format.respond_to?(:to_sym)
-
-        raise "Format undefined" unless format
-
-        generator_info = self.class.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
-
-      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_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.should_process?(image_file, metadata['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)
-
-          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) }
-        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']
-                                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 checksum
-        @checksum ||= compute_checksum(code)
-      end
-
-      def should_process?(image_file, old_checksum)
-        !File.exists?(image_file) || (newer_than?(image_file) && old_checksum != checksum)
-      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 newer_than?(image_file)
-        true
-      end
-
-      def code
-        @code ||= @reader.lines.join("\n")
-      end
-    end
-
-    class FileSource < Source
-      def initialize(file_name)
-        @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
-    end
-  end
-end