asciidoctor-diagram 2.1.0 → 2.2.1

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'}
+      QRCODE_DEPENDENCIES = {'rqrcode' => '~> 2.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/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/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/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/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/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/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/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/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
@@ -227,9 +238,17 @@ module Asciidoctor
         use_absolute_path = source.attr('data-uri', nil, true)
 
         if format == :svg
-          svg_type = source.global_attr('svg-type')
+          if node.option? 'inline'
+            svg_type = 'inline'
+          elsif node.option? 'interactive'
+            svg_type = 'interactive'
+          else
+            svg_type = source.global_attr('svg-type')
+          end
+
           case svg_type
             when nil, 'static'
+              # Nothing to do
             when 'inline', 'interactive'
               node.set_option(svg_type)
               use_absolute_path = true
@@ -371,5 +390,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

data/lib/asciidoctor-diagram/diagram_source.rb

@@ -19,6 +19,10 @@ module Asciidoctor
       # @return [String] the String representation of the source code for the diagram
       # @abstract
       def code
+        @code ||= load_code
+      end
+
+      def load_code
         raise NotImplementedError.new
       end
 
@@ -134,6 +138,22 @@ module Asciidoctor
         cmd_path
       end
 
+      def ensure_gem(name, version)
+        begin
+          gem_var = "gem-#{name}"
+          unless config.key? gem_var
+            gem(name, version)
+            config[gem_var] = true
+          end
+        rescue Gem::LoadError => e
+          msg = "You are using functionality that requires the optional gem dependency `#{e.name}` which could not be loaded. Add `gem '#{e.name}', '#{e.requirement}'` to your Gemfile."
+          err = Gem::LoadError.new(msg)
+          err.name = e.name
+          err.requirement = e.requirement
+          raise err
+        end
+      end
+
       def resolve_path target, start = base_dir
         raise NotImplementedError.new
       end
@@ -233,8 +253,8 @@ module Asciidoctor
         @reader = reader
       end
 
-      def code
-        @code ||= @parent_block.apply_subs(@reader.lines, resolve_diagram_subs).join("\n")
+      def load_code
+        @parent_block.apply_subs(@reader.lines, resolve_diagram_subs).join("\n")
       end
     end
 
@@ -267,11 +287,7 @@ module Asciidoctor
         (@file_name && File.mtime(@file_name) > File.mtime(image_file)) || super
       end
 
-      def code
-        @code ||= read_code
-      end
-
-      def read_code
+      def load_code
         if @file_name
           lines = File.readlines(@file_name)
           lines = prepare_source_array(lines)

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

@@ -0,0 +1,49 @@
+require_relative '../diagram_converter'
+require_relative '../util/cli_generator'
+require_relative '../util/platform'
+
+module Asciidoctor
+  module Diagram
+    # @private
+    class DiagramsConverter
+      include DiagramConverter
+      include CliGenerator
+
+
+      def supported_formats
+        [:png, :svg, :pdf]
+      end
+
+      def convert(source, format, options)
+        python_path = source.find_command('python3', :attrs => ['diagrams-python'], :alt_cmds => ['python'])
+
+        code = source.to_s
+
+        match_data = /Diagram\((.*?)\)/.match(code)
+        raise "Could not find Diagram constructor" unless match_data
+
+        args = match_data[1].strip
+
+        target_file = Tempfile.new('diagrams')
+
+        diagram = 'Diagram('
+        diagram << args
+        diagram << ',' unless args.empty?
+        diagram << "filename=\"#{target_file.path}\""
+        diagram << ",outformat=\"#{format}\""
+        diagram << ')'
+
+        code = match_data.pre_match + diagram + match_data.post_match
+
+        begin
+          target_file.close
+          generate_stdin_file(python_path, code, target_file.path + ".#{format}") do |tool|
+            [tool, '-']
+          end
+        ensure
+          target_file.unlink
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+require_relative 'converter'
+require_relative '../diagram_processor'
+
+module Asciidoctor
+  module Diagram
+    class DiagramsBlockProcessor < DiagramBlockProcessor
+      use_converter DiagramsConverter
+    end
+
+    class DiagramsBlockMacroProcessor < DiagramBlockMacroProcessor
+      use_converter DiagramsConverter
+    end
+
+    class DiagramsInlineMacroProcessor < DiagramInlineMacroProcessor
+      use_converter DiagramsConverter
+    end
+  end
+end

data/lib/asciidoctor-diagram/diagrams.rb

@@ -0,0 +1,8 @@
+require 'asciidoctor/extensions'
+require_relative 'diagrams/extension'
+
+Asciidoctor::Extensions.register do
+  block Asciidoctor::Diagram::DiagramsBlockProcessor, :diagrams
+  block_macro Asciidoctor::Diagram::DiagramsBlockMacroProcessor, :diagrams
+  inline_macro Asciidoctor::Diagram::DiagramsInlineMacroProcessor, :diagrams
+end

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

@@ -10,5 +10,9 @@ module Asciidoctor
     class DitaaBlockMacroProcessor < DiagramBlockMacroProcessor
       use_converter DitaaConverter
     end
+
+    class DitaaInlineMacroProcessor < DiagramInlineMacroProcessor
+      use_converter DitaaConverter
+    end
   end
 end

data/lib/asciidoctor-diagram/ditaa.rb

@@ -4,4 +4,5 @@ require_relative 'ditaa/extension'
 Asciidoctor::Extensions.register do
   block Asciidoctor::Diagram::DitaaBlockProcessor, :ditaa
   block_macro Asciidoctor::Diagram::DitaaBlockMacroProcessor, :ditaa
+  inline_macro Asciidoctor::Diagram::DitaaInlineMacroProcessor, :ditaa
 end

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

@@ -10,5 +10,9 @@ module Asciidoctor
     class DpicBlockMacroProcessor < DiagramBlockMacroProcessor
       use_converter DpicConverter
     end
+
+    class DpicInlineMacroProcessor < DiagramInlineMacroProcessor
+      use_converter DpicConverter
+    end
   end
 end