asciidoctor-diagram 2.0.5 → 2.2.0

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

@@ -0,0 +1,15 @@
+== Generating a Diagram from a Terminal
+
+You can load Asciidoctor diagram in a terminal using the `-r` flag.
+
+ $ asciidoctor -r asciidoctor-diagram sample.adoc
+
+You can also use Asciidoctor diagram with other converters, such as Asciidoctor EPUB.
+Asciidoctor-epub3 is also loaded with the `-r` flag.
+
+ $ asciidoctor -r asciidoctor-diagram -r asciidoctor-epub3 -b epub3 sample.adoc
+
+Or, you can invoke Asciidoctor and the EPUB converter with the `asciidoctor-epub3` command.
+The command implicitly sets the `-r` and `-b` flags for EPUB3 output.
+
+ $ asciidoctor-epub3 -r asciidoctor-diagram sample.adoc

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

@@ -0,0 +1,19 @@
+== Installation
+
+Asciidoctor Diagram is a RubyGem, which can be installed using the `gem` or `bundle` commands.
+
+You can install the Asciidoctor Diagram gem by typing `gem install` in the CLI.
+
+ $ gem install asciidoctor-diagram
+
+by first adding the following entry to your project's [.path]_Gemfile_.
+
+.Gemfile
+[source,ruby]
+----
+gem 'asciidoctor-diagram'
+----
+
+Then execute `bundle` in the CLI.
+
+ $ bundle

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

@@ -0,0 +1,41 @@
+:uri-a2s: https://github.com/asciitosvg/asciitosvg
+:uri-actdiag: http://blockdiag.com/en/actdiag/index.html
+:uri-asciidoctor-api: http://asciidoctor.org/docs/user-manual/#api
+:uri-asciidoctor-extensions: http://asciidoctor.org/docs/user-manual/#extension-points
+:uri-blockdiag: http://blockdiag.com
+:uri-bpmn: https://github.com/gtudan/bpmn-js-cmd
+:uri-bytefield: https://github.com/Deep-Symmetry/bytefield-svg
+:uri-diagrams: https://diagrams.mingrammer.com
+:uri-ditaa: http://ditaa.sourceforge.net/
+:uri-dpic: https://gitlab.com/aplevich/dpic
+:uri-dot: https://graphviz.gitlab.io/_pages/doc/info/lang.html
+:uri-erd: https://github.com/BurntSushi/erd
+:uri-gnuplot: http://gnuplot.info
+:uri-graphviz: https://graphviz.gitlab.io
+:uri-imagemagick: http://www.imagemagick.org
+:uri-java: http://java.sun.com
+:uri-mermaid: https://github.com/mermaid-js/mermaid-cli
+:uri-mscgen: http://www.mcternan.me.uk/mscgen/
+:uri-nomnoml: http://nomnoml.com
+:uri-nwdiag: http://blockdiag.com/en/nwdiag/index.html
+:uri-packetdiag: http://blockdiag.com/en/nwdiag/index.html
+:uri-phantomjs: http://phantomjs.org
+:uri-pikchr: https://pikchr.org
+:uri-plantuml: http://plantuml.sourceforge.net
+:uri-py-plantuml: https://code.google.com/p/asciidoc-plantuml/
+:uri-python: https://www.python.org
+:uri-rackdiag: http://blockdiag.com/en/nwdiag/index.html
+:uri-seqdiag: http://blockdiag.com/en/seqdiag/index.html
+:uri-shaape: https://github.com/christiangoltz/shaape
+:uri-smcat: https://github.com/sverweij/state-machine-cat
+:uri-svgbob: https://github.com/ivanceras/svgbobrus
+:uri-symbolator: https://github.com/kevinpt/symbolator
+:uri-syntrax: https://kevinpt.github.io/syntrax/
+:uri-jsyntrax: https://atp-mipt.github.io/jsyntrax/
+:uri-tikz: https://github.com/pgf-tikz/pgf
+:uri-umlet: http://www.umlet.com/
+:uri-vega: https://vega.github.io/vega/
+:uri-vegalite: https://vega.github.io/vega-lite/
+:uri-wavedrom: http://wavedrom.com
+:uri-wavedromeditor: https://github.com/wavedrom/wavedrom.github.io/releases
+:uri-wavedromcli: https://github.com/wavedrom/cli

data/examples/features.adoc

@@ -150,7 +150,7 @@ results in a block with the correct caption and id applied to it.
 Asciidoctor-diagram also supports the various diagram block in block macro form.
 These are macros of the form `<name>::<target>[<attrlist>]`.
 
-In asciidoctor-diagram the macro names are identical to the block styles: `ditaa`, `graphivz` and `plantuml`
+In asciidoctor-diagram the macro names are identical to the block styles: `ditaa`, `graphviz` and `plantuml`
 The target is the path to the file containing the diagram source code.
 When the target is a relative path it is resolved with respect to the location of the document being processed.
 The attribute list behaves mostly the same as with the block styles.

data/lib/asciidoctor-diagram.rb

@@ -1,7 +1,9 @@
 require_relative 'asciidoctor-diagram/a2s'
+require_relative 'asciidoctor-diagram/barcode'
 require_relative 'asciidoctor-diagram/blockdiag'
 require_relative 'asciidoctor-diagram/bpmn'
 require_relative 'asciidoctor-diagram/bytefield'
+require_relative 'asciidoctor-diagram/diagrams'
 require_relative 'asciidoctor-diagram/ditaa'
 require_relative 'asciidoctor-diagram/dpic'
 require_relative 'asciidoctor-diagram/erd'

data/lib/asciidoctor-diagram/a2s.rb

@@ -4,4 +4,5 @@ require_relative 'a2s/extension'
 Asciidoctor::Extensions.register do
   block Asciidoctor::Diagram::AsciiToSvgBlockProcessor, :a2s
   block_macro Asciidoctor::Diagram::AsciiToSvgBlockMacroProcessor, :a2s
+  inline_macro Asciidoctor::Diagram::AsciiToSvgInlineMacroProcessor, :a2s
 end

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

@@ -10,5 +10,9 @@ module Asciidoctor
     class AsciiToSvgBlockMacroProcessor < DiagramBlockMacroProcessor
       use_converter AsciiToSvgConverter
     end
+
+    class AsciiToSvgInlineMacroProcessor < DiagramInlineMacroProcessor
+      use_converter AsciiToSvgConverter
+    end
   end
 end

data/lib/asciidoctor-diagram/barcode.rb

@@ -0,0 +1,11 @@
+require 'asciidoctor/extensions'
+require_relative 'barcode/extension'
+require_relative 'barcode/converter'
+
+Asciidoctor::Extensions.register do
+  Asciidoctor::Diagram::BarcodeConverter::BARCODE_TYPES.each do |type|
+    block Asciidoctor::Diagram::BarcodeBlockProcessor, type, :type => type
+    block_macro Asciidoctor::Diagram::BarcodeBlockMacroProcessor, type, :type => type
+    inline_macro Asciidoctor::Diagram::BarcodeInlineMacroProcessor, type, :type => type
+  end
+end

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

@@ -0,0 +1,157 @@
+require_relative '../diagram_converter'
+require_relative 'dependencies'
+
+module Asciidoctor
+  module Diagram
+    # @private
+    class BarcodeConverter
+      BARCODE_TYPES = [
+        :bookland,
+        :codabar,
+        :code25,
+        :code25iata,
+        :code25interleaved,
+        :code39,
+        :code93,
+        :code128,
+        :code128a,
+        :code128b,
+        :code128c,
+        :ean8,
+        :ean13,
+        :gs1_128,
+        :qrcode,
+        :upca,
+      ]
+
+      include DiagramConverter
+
+      def supported_formats
+        [:png, :svg, :txt]
+      end
+
+      def collect_options(source)
+        options = {}
+
+        options[:xdim] = source.attr('xdim')
+        options[:ydim] = source.attr('ydim')
+        options[:margin] = source.attr('margin')
+        options[:height] = source.attr('height')
+        options[:foreground] = source.attr('foreground')
+        options[:background] = source.attr('background')
+
+        [:xdim, :ydim, :margin, :height].each { |o| options[o] = options[o].to_i if options[o] }
+
+        options
+      end
+
+      def convert(source, format, options)
+        BarcodeDependencies::BARCODE_DEPENDENCIES.each_pair { |n, v| source.ensure_gem(n, v) }
+        require 'barby'
+
+        code = source.code
+        type = source.config[:type]
+
+        case type
+          when :bookland
+            require 'barby/barcode/bookland'
+            barcode = Barby::Bookland.new(code)
+          when :codabar
+            require 'barby/barcode/codabar'
+            barcode = Barby::Codabar.new(code)
+          when :code25
+            require 'barby/barcode/code_25'
+            barcode = Barby::Code25.new(code)
+          when :code25iata
+            require 'barby/barcode/code_25_iata'
+            barcode = Barby::Code25IATA.new(code)
+          when :code25interleaved
+            require 'barby/barcode/code_25_interleaved'
+            barcode = Barby::Code25Interleaved.new(code)
+          when :code39
+            require 'barby/barcode/code_39'
+            barcode = Barby::Code39.new(code)
+          when :code93
+            require 'barby/barcode/code_93'
+            barcode = Barby::Code93.new(code)
+          when :code128
+            require 'barby/barcode/code_128'
+            barcode = Barby::Code128.new(code)
+          when :code128a
+            require 'barby/barcode/code_128'
+            barcode = Barby::Code128A.new(code)
+          when :code128b
+            require 'barby/barcode/code_128'
+            barcode = Barby::Code128B.new(code)
+          when :code128c
+            require 'barby/barcode/code_128'
+            barcode = Barby::Code128C.new(code)
+          when :ean8
+            require 'barby/barcode/ean_8'
+            barcode = Barby::EAN8.new(code)
+          when :ean13
+            require 'barby/barcode/ean_13'
+            barcode = Barby::EAN13.new(code)
+          when :gs1_128
+            require 'barby/barcode/code_128'
+            code = code.gsub /\([^)]+\)/ do |control|
+              case control.upcase
+                when '(FNC1)'
+                  Barby::Code128::FNC1
+                when '(FNC2)'
+                  Barby::Code128::FNC2
+                when '(FNC3)'
+                  Barby::Code128::FNC3
+                when '(FNC4)'
+                  Barby::Code128::FNC4
+                when '(CODEA)'
+                  Barby::Code128::CODEA
+                when '(CODEB)'
+                  Barby::Code128::CODEB
+                when '(CODEC)'
+                  Barby::Code128::CODEC
+                when '(SHIFT)'
+                  Barby::Code128::SHIFT
+                when '(SP)'
+                  ' '
+                else
+                  control
+              end
+            end
+            code = code.gsub(/\s+/, '')
+            code = code.prepend(Barby::Code128::FNC1) unless code[0] == Barby::Code128::FNC1
+            barcode = Barby::Code128.new(code)
+          when :qrcode
+            BarcodeDependencies::QRCODE_DEPENDENCIES.each_pair { |n, v| source.ensure_gem(n, v) }
+            require 'barby/barcode/qr_code'
+            barcode = Barby::QrCode.new(code)
+          when :upca
+            require 'barby/barcode/ean_13'
+            barcode = Barby::UPCA.new(code)
+          else
+            raise "Unsupported barcode type: #{type}"
+        end
+
+        case format
+          when :png
+            BarcodeDependencies::PNG_DEPENDENCIES.each_pair { |n, v| source.ensure_gem(n, v) }
+            require 'barby/outputter/png_outputter'
+            require 'chunky_png/color'
+            options[:foreground] = ChunkyPNG::Color(options[:foreground]) if options[:foreground]
+            options[:background] = ChunkyPNG::Color(options[:background]) if options[:background]
+            barcode.to_png(options)
+          when :svg
+            require_relative 'svg_outputter'
+            options[:foreground] = "##{options[:foreground]}" if options[:foreground] =~ /^[0-9a-f]+$/i
+            options[:background] = "##{options[:background]}" if options[:background] =~ /^[0-9a-f]+$/i
+            barcode.to_svg(options)
+          when :txt
+            require 'barby/outputter/ascii_outputter'
+            barcode.to_ascii
+          else
+            raise "Unsupported format: #{format}"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+module Asciidoctor
+  module Diagram
+    module BarcodeDependencies
+      BARCODE_DEPENDENCIES = {'barby' => '~> 0.6.8'}
+      PNG_DEPENDENCIES = {'chunky_png' => '~> 1.4.0'}
+      QRCODE_DEPENDENCIES = {'rqrcode' => '~> 2.0.0'}
+      ALL_DEPENDENCIES = {}.merge(BARCODE_DEPENDENCIES).merge(PNG_DEPENDENCIES).merge(QRCODE_DEPENDENCIES)
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+require_relative 'converter'
+require_relative '../diagram_processor'
+
+module Asciidoctor
+  module Diagram
+    module BarcodeProcessor
+      def self.check_config(config = {})
+        type = config[:type]
+        raise "Barcode type not specified in config" if type.nil?
+        raise "Unsupported barcode type: '#{type}'" unless BarcodeConverter::BARCODE_TYPES.include?(type)
+      end
+
+      def initialize(name = nil, config = {})
+        super
+        BarcodeProcessor.check_config(config)
+      end
+    end
+
+    module BarcodeMacroProcessor
+      def create_source(parent, target, attributes)
+        if attributes['external']
+          super
+        else
+          code = parent.sub_attributes(target, :attribute_missing => 'warn')
+          ::Asciidoctor::Diagram::ReaderSource.new(self, parent, code, attributes)
+        end
+      end
+    end
+
+    class BarcodeBlockProcessor < DiagramBlockProcessor
+      use_converter BarcodeConverter
+      include BarcodeProcessor
+    end
+
+    class BarcodeBlockMacroProcessor < DiagramBlockMacroProcessor
+      use_converter BarcodeConverter
+      include BarcodeProcessor
+      include BarcodeMacroProcessor
+    end
+
+    class BarcodeInlineMacroProcessor < DiagramInlineMacroProcessor
+      use_converter BarcodeConverter
+      include BarcodeProcessor
+      include BarcodeMacroProcessor
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+require 'barby/outputter/svg_outputter'
+
+module Barby
+  class SvgOutputter
+    # Monkey patch to fix foreground color in SVG output
+    def bars_to_path(opts={})
+      with_options opts do
+        %Q|<path stroke="#{foreground}" stroke-width="#{xdim}" d="#{bars_to_path_data(opts)}" />|
+      end
+    end
+  end
+end

data/lib/asciidoctor-diagram/blockdiag.rb

@@ -5,5 +5,6 @@ Asciidoctor::Extensions.register do
   ['BlockDiag', 'SeqDiag', 'ActDiag', 'NwDiag', 'RackDiag', 'PacketDiag'].each do |tool|
     block ::Asciidoctor::Diagram.const_get("#{tool}BlockProcessor"), tool.downcase.to_sym
     block_macro ::Asciidoctor::Diagram.const_get("#{tool}BlockMacroProcessor"), tool.downcase.to_sym
+    inline_macro ::Asciidoctor::Diagram.const_get("#{tool}InlineMacroProcessor"), tool.downcase.to_sym
   end
 end

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

@@ -13,6 +13,11 @@ module Asciidoctor
         use_converter ::Asciidoctor::Diagram.const_get("#{tool}Converter")
       end
       ::Asciidoctor::Diagram.const_set("#{tool}BlockMacroProcessor", block_macro)
+
+      inline_macro = Class.new(DiagramInlineMacroProcessor) do
+        use_converter ::Asciidoctor::Diagram.const_get("#{tool}Converter")
+      end
+      ::Asciidoctor::Diagram.const_set("#{tool}InlineMacroProcessor", inline_macro)
     end
   end
 end

data/lib/asciidoctor-diagram/bpmn.rb

@@ -4,4 +4,5 @@ require_relative 'bpmn/extension'
 Asciidoctor::Extensions.register do
   block Asciidoctor::Diagram::BpmnBlockProcessor, :bpmn
   block_macro Asciidoctor::Diagram::BpmnBlockMacroProcessor, :bpmn
+  inline_macro Asciidoctor::Diagram::BpmnInlineMacroProcessor, :bpmn
 end

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

@@ -10,5 +10,9 @@ module Asciidoctor
     class BpmnBlockMacroProcessor < DiagramBlockMacroProcessor
       use_converter BpmnConverter
     end
+
+    class BpmnInlineMacroProcessor < DiagramInlineMacroProcessor
+      use_converter BpmnConverter
+    end
   end
 end

data/lib/asciidoctor-diagram/bytefield.rb

@@ -4,4 +4,5 @@ require_relative 'bytefield/extension'
 Asciidoctor::Extensions.register do
   block Asciidoctor::Diagram::BytefieldBlockProcessor, :bytefield
   block_macro Asciidoctor::Diagram::BytefieldBlockMacroProcessor, :bytefield
+  inline_macro Asciidoctor::Diagram::BytefieldInlineMacroProcessor, :bytefield
 end

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

@@ -10,5 +10,9 @@ module Asciidoctor
     class BytefieldBlockMacroProcessor < DiagramBlockMacroProcessor
       use_converter BytefieldConverter
     end
+
+    class BytefieldInlineMacroProcessor < DiagramInlineMacroProcessor
+      use_converter BytefieldConverter
+    end
   end
 end

data/lib/asciidoctor-diagram/diagram_converter.rb

@@ -7,6 +7,10 @@ module Asciidoctor
         raise NotImplementedError.new
       end
 
+      def wrap_source(source)
+        source
+      end
+
       def collect_options(source)
         {}
       end

data/lib/asciidoctor-diagram/diagram_processor.rb

@@ -50,6 +50,8 @@ module Asciidoctor
           }
       }
 
+      TEXT_FORMATS = [:txt, :atxt, :utxt]
+
       # 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
@@ -57,17 +59,22 @@ module Asciidoctor
       #        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)
         location = parent.document.reader.cursor_at_mark
 
         normalised_attributes = attributes.inject({}) { |h, (k, v)| h[normalise_attribute_name(k)] = v; h }
-        source = create_source(parent, reader_or_target, normalised_attributes)
-
         converter = config[:converter].new
 
-        supported_formats = converter.supported_formats
+        supported_formats = supported_formats(converter)
+
+        source = create_source(parent, reader_or_target, normalised_attributes)
+        # memorize current code here for error message to avoid calling wrapped source's code method later
+        code = source.code
 
         begin
+          source = converter.wrap_source(source)
+
           format = source.attributes.delete('format') || source.global_attr('format', supported_formats[0])
           format = format.to_sym if format.respond_to?(:to_sym)
 
@@ -80,7 +87,7 @@ module Asciidoctor
           caption = source.attributes.delete 'caption'
 
           case format
-          when :txt, :atxt, :utxt
+          when *TEXT_FORMATS
             block = create_literal_block(parent, source, format, converter)
           else
             block = create_image_block(parent, source, format, converter)
@@ -103,7 +110,7 @@ module Asciidoctor
             logger.error message_with_context warn_msg, source_location: location
 
             text << "\n"
-            text << source.code
+            text << code
             Asciidoctor::Block.new parent, :listing, :source => text, :attributes => attributes
           end
 
@@ -129,6 +136,10 @@ module Asciidoctor
 
       private
 
+      def supported_formats(converter)
+        converter.supported_formats
+      end
+
       def normalise_attribute_name(k)
         case k
         when String
@@ -174,7 +185,8 @@ module Asciidoctor
           metadata = source.create_image_metadata
           metadata[:options] = options
 
-          result, metadata[:width], metadata[:height] = params[:decoder].post_process_image(result)
+          allow_image_optimisation = source.attr('optimise', 'true') == 'true'
+          result, metadata[:width], metadata[:height] = params[:decoder].post_process_image(result, allow_image_optimisation)
 
           FileUtils.mkdir_p(File.dirname(image_file)) unless Dir.exist?(File.dirname(image_file))
           File.open(image_file, 'wb') {|f| f.write result}
@@ -370,5 +382,42 @@ module Asciidoctor
         FileSource.new(self, parent, apply_target_subs(parent, target), attributes)
       end
     end
+
+    # Base class for diagram inline macro processors.
+    class DiagramInlineMacroProcessor < Asciidoctor::Extensions::InlineMacroProcessor
+      include DiagramProcessor
+
+      def self.inherited(subclass)
+        subclass.name_positional_attributes ['format']
+      end
+
+      def apply_target_subs(parent, target)
+        if target
+          parent.normalize_system_path(parent.sub_attributes(target, :attribute_missing => 'warn'))
+        else
+          nil
+        end
+      end
+
+      alias_method(:generate_block,:process)
+
+      def process(parent, reader_or_target, attributes)
+        block = generate_block(parent, reader_or_target, attributes)
+        attrs = block.attributes.dup
+        target = attrs.delete('target')
+        create_inline(parent, :image, nil, :type => 'image', :target => target, :attributes => attrs).convert
+      end
+
+      def supported_formats(converter)
+        converter.supported_formats.reject { |f| TEXT_FORMATS.include?(f) }
+      end
+
+      # Creates a FileSource using target as the file name.
+      #
+      # @return [FileSource] a FileSource
+      def create_source(parent, target, attributes)
+        FileSource.new(self, parent, apply_target_subs(parent, target), attributes)
+      end
+    end
   end
 end