asciidoctor-diagram 1.5.16 → 1.5.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd917dfffdfbdf86a9a2d1f94d67567adf0296b1e9b1e1b8e64e4dacfef06645
-  data.tar.gz: e8b7f3554732fa3a051890a12fa943ea803a455d6a15281b86bd6df889312bfe
+  metadata.gz: 4de9d84055932e070c6726c178dd10aeb05e871edc2d511f957511f3f87fc073
+  data.tar.gz: c7e304a8620640a9fbbed81a52ccfb1d9e7900faeeb905a0dfbd92fe3346232e
 SHA512:
-  metadata.gz: fee236ca6ef2e424d872be4517b9f6d27007a1d5177235678a20acd5533a34580234e469913468e697bb744b57411c386a29ad936597dcbdb4f9a226cf16c3d3
-  data.tar.gz: 75b4a0a5981798b5af94ad2f0e9d8db9f509b6c460a4b5dd962d04fc179ddf454b9ad54b3c693afe2451bc5fcffd6cd5ad7dda187f459c6a7d5764eea45eff0c
+  metadata.gz: 4b5e2b48bd00c293e920d2a31b110b43f1f34d4f1d703d77fa512b4e0738b790704ac385eff37260f005b5ad9a1e77d6c2c105b2ef43a516f3e1d6c9e232616a
+  data.tar.gz: b5f136b19bd2f7fb3d7674b2e5fe1f8b63300ad21d44afe7d5694c7ef21148d16898c33aef04349d04cb2d77508577bff041057b6428cf20237ac4a48e6064f1

data/CHANGELOG.adoc

@@ -1,5 +1,12 @@
 = Asciidoctor-diagram Changelog
 
+== 1.5.17
+
+Enhancements::
+  * Issue #173: Apply path resolution to PlantUML `!includesub` directives
+  * Issue #222: Update PlantUML to 1.2019.6
+  * Issue #223: Log diagram processing errors using Asciidoctor logging infrastructure
+
 == 1.5.16
 
 Enhancements::

data/lib/asciidoctor-diagram/extensions.rb

@@ -1,5 +1,6 @@
 require 'asciidoctor' unless defined? ::Asciidoctor::VERSION
 require 'asciidoctor/extensions'
+require 'asciidoctor/logging'
 require 'digest'
 require 'json'
 require 'fileutils'
@@ -13,11 +14,6 @@ require_relative 'util/svg'
 module Asciidoctor
   module Diagram
     module Extensions
-      if Asciidoctor::VERSION =~ /^1\.*/
-        POSITIONAL_ATTRS_KEY = :pos_attrs
-      else
-        POSITIONAL_ATTRS_KEY = :positional_attrs
-      end
 
       # Provides the means for diagram processors to register supported output formats and image
       # generation routines
@@ -69,6 +65,8 @@ module Asciidoctor
       # 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
+        include Asciidoctor::Logging
+
         IMAGE_PARAMS = {
             :svg => {
                 :encoding => Encoding::UTF_8,
@@ -89,6 +87,7 @@ module Asciidoctor
         }
 
         def self.included(mod)
+          mod.enable_dsl
           class << mod
             include FormatRegistry
           end
@@ -102,18 +101,20 @@ module Asciidoctor
         # @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
+
           source = create_source(parent, reader_or_target, attributes.dup)
 
-          format = source.attributes.delete('format') || source.attr('format', self.class.default_format, name)
-          format = format.to_sym if format.respond_to?(:to_sym)
+          begin
+            format = source.attributes.delete('format') || source.attr('format', self.class.default_format, name)
+            format = format.to_sym if format.respond_to?(:to_sym)
 
-          raise "Format undefined" unless format
+            raise "Format undefined" unless format
 
-          generator_info = self.class.formats[format]
+            generator_info = self.class.formats[format]
 
-          raise "#{self.class.name} does not support output format #{format}" unless generator_info
+            raise "#{self.class.name} does not support output format #{format}" unless generator_info
 
-          begin
             title = source.attributes.delete 'title'
             caption = source.attributes.delete 'caption'
 
@@ -137,7 +138,9 @@ module Asciidoctor
                 if $VERBOSE
                   warn_msg << "\n" << e.backtrace.join("\n")
                 end
-                warn %(asciidoctor-diagram: ERROR: #{warn_msg})
+
+                logger.error message_with_context warn_msg, source_location: location
+
                 text << "\n"
                 text << source.code
                 Asciidoctor::Block.new parent, :listing, :source => text, :attributes => attributes
@@ -300,9 +303,9 @@ module Asciidoctor
         include DiagramProcessor
 
         def self.inherited(subclass)
-          subclass.option Asciidoctor::Diagram::Extensions::POSITIONAL_ATTRS_KEY, ['target', 'format']
-          subclass.option :contexts, [:listing, :literal, :open]
-          subclass.option :content_model, :simple
+          subclass.positional_attributes ['target', 'format']
+          subclass.contexts [:listing, :literal, :open]
+          subclass.content_model :simple
         end
 
         # Creates a ReaderSource from the given reader.
@@ -318,7 +321,7 @@ module Asciidoctor
         include DiagramProcessor
 
         def self.inherited(subclass)
-          subclass.option Asciidoctor::Diagram::Extensions::POSITIONAL_ATTRS_KEY, ['target', 'format']
+          subclass.positional_attributes ['target', 'format']
         end
 
         def apply_target_subs(parent, target)

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

@@ -118,7 +118,7 @@ module Asciidoctor
         end
       end
 
-      option Asciidoctor::Diagram::Extensions::POSITIONAL_ATTRS_KEY, %w(top bottom target format)
+      positional_attributes %w(top bottom target format)
 
       def create_source(parent, target, attributes)
         attributes = attributes.dup

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

@@ -57,13 +57,13 @@ module Asciidoctor
         code = source.to_s
         base_dir = source.base_dir
 
-        code = "@start#{tag}\n#{code}\n@end#{tag}" unless code.index "@start#{tag}"
+        code = "@start#{tag}\n#{code}\n@end#{tag}" unless code.index("@start") && code.index("@end")
 
         code.gsub!(/(?<=<img:)[^>]+(?=>)/) do |match|
           resolve_path(match, parent, parent.attr('imagesdir'))
         end
 
-        code.gsub!(/(?<=!include )\s*[^<][^!\n\r]+/) do |match|
+        code.gsub!(/(?:(?<=!include\s)|(?<=!includesub\s))\s*[^<][^!\n\r]+/) do |match|
           resolve_path(match.lstrip, parent, base_dir)
         end
 

data/lib/asciidoctor-diagram/version.rb

@@ -1,5 +1,5 @@
 module Asciidoctor
   module Diagram
-    VERSION = "1.5.16"
+    VERSION = "1.5.17"
   end
 end

data/spec/plantuml_spec.rb

@@ -832,8 +832,22 @@ List : int size()
 List : void clear()
     eos
 
+    sub = <<-eos
+@startuml
+A -> A : stuff1
+!startsub BASIC
+B -> B : stuff2
+!endsub
+C -> C : stuff3
+!startsub BASIC
+D -> D : stuff4
+!endsub
+@enduml
+    eos
+
     Dir.mkdir('dir')
     File.write('dir/List.iuml', included)
+    File.write('dir/Sub.iuml', sub)
 
     creole_doc = <<-eos
 = Hello, PlantUML!
@@ -844,6 +858,7 @@ Doc Writer <doc@example.com>
 [plantuml, format="svg"]
 ----
 !include dir/List.iuml
+!includesub dir/Sub.iuml!BASIC
 List <|.. ArrayList
 ----
     eos
@@ -860,6 +875,7 @@ List <|.. ArrayList
 
     content = File.read(target, :encoding => Encoding::UTF_8)
     expect(content).to_not include('!include')
+    expect(content).to_not include('!includesub')
   end
 
   it 'should not resolve stdlib !include directives' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-diagram
 version: !ruby/object:Gem::Version
-  version: 1.5.16
+  version: 1.5.17
 platform: ruby
 authors:
 - Pepijn Van Eeckhoudt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-23 00:00:00.000000000 Z
+date: 2019-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler