asciidoctor-plantuml 0.0.15 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7673d42a2b0bcc381cb0111511bfc05584ed0c509dfad8dcf9b20919b9d8b689
-  data.tar.gz: 2a8c98b8a3adfc09e57a7928e9f23a86230072da14ca9a9593d627401f40d194
+  metadata.gz: fa9d42baca46ef240d1621640dce548f96a46e4e535a6405cace400e2495f097
+  data.tar.gz: b7320f06086d5230ceb3507945971f48efe988edfd159ebde0cc1c5609bc86f6
 SHA512:
-  metadata.gz: 9ed82c582714d60f1a0cf57d5bbb070250dc07744a7545b28912d2e4e97f13ceff292d3d528df7f23ea683e4bfbd1cd6ce5c2500f1b8fb2b274429395fede02c
-  data.tar.gz: 78e840faff576976ecdf0d1584d0e9b86d07a8afed74c7248f210d7bd306a25c1c67c1bb41165d2e54b559d02f122d0cc8c8d960c989b0a3a0fc057f32e4d600
+  metadata.gz: e0f9dc73e4f6f116b1321d2d25a23a268d8158777abeb2c3984c5ce642dd1aecbe2febeb602d9d8e0fb038cb310fb934f460300996170e2e83d81a57fc159588
+  data.tar.gz: b9aea5f39cb2c27e48b1239518a9d8a63b7938cc81899c3454782a6afe235a0597817525bdfe125441e09f03dcc4b6abd276fc1509f5b8aa86abcf64e2287afd

data/lib/asciidoctor-plantuml.rb

@@ -6,4 +6,5 @@ require_relative 'asciidoctor_plantuml/plantuml'
 
 Asciidoctor::Extensions.register do
   block Asciidoctor::PlantUml::BlockProcessor, :plantuml
+  block_macro Asciidoctor::PlantUml::BlockMacroProcessor, :plantuml
 end

data/lib/asciidoctor_plantuml/plantuml.rb

@@ -10,8 +10,8 @@ module Asciidoctor
   module PlantUml
     # PlantUML Configuration
     class Configuration
-      DEFAULT_URL = ENV['PLANTUML_URL'] || ''
-      DEFAULT_ENCODING = ENV['PLANTUML_ENCODING'] || 'legacy'
+      DEFAULT_URL = ENV.fetch('PLANTUML_URL', '')
+      DEFAULT_ENCODING = ENV.fetch('PLANTUML_ENCODING', 'legacy')
 
       attr_accessor :url, :txt_enable, :svg_enable, :png_enable, :encoding
 
@@ -78,23 +78,56 @@ module Asciidoctor
           txt_enabled? || png_enabled? || svg_enabled?
         end
 
-        def plantuml_content_format(code, format, attrs = {})
-          if %w[png svg txt].include?(format) &&
-             method("#{format}_enabled?").call
-            method("plantuml_#{format}_content").call(code, format, attrs)
+        def plantuml_content_format(parent, code, format, attrs = {})
+          content = code.read
+
+          # honor subs attributes
+          # e.g. replace asciidoc variables
+          subs = attrs['subs']
+          content = parent.apply_subs(content, parent.resolve_subs(subs)) if subs
+
+          # add @start... and @end... if missing
+          content = "@startuml\n#{content}\n@enduml" unless content =~ /^@start.*@end[a-z]*$/m
+
+          # insert global plantuml config after first line
+          config_path = parent.attr('plantuml-include', '', true)
+
+          unless config_path.empty?
+            begin
+              source_file = parent.document.normalize_system_path(config_path, nil, nil, recover: false)
+              content = insert_config_to_content(parent, source_file, content, attrs)
+            rescue StandardError => e
+              return plantuml_invalid_file(source_file, e.message, attrs)
+            rescue SecurityError => e
+              return plantuml_insecure_file(source_file, e.message, attrs)
+            end
+          end
+
+          if %w[png svg txt].include?(format) && method("#{format}_enabled?").call
+            method("plantuml_#{format}_content").call(content, format, attrs)
           else
             plantuml_invalid_content(format, attrs)
           end
         end
 
-        def plantuml_content(code, attrs = {})
+        def plantuml_content(parent, code, attrs = {})
           format = attrs['format'] || DEFAULT_FORMAT
 
           return plantuml_disabled_content(code, attrs) unless enabled?
 
           return plantuml_server_unavailable_content(server_url, attrs) unless valid_uri?(server_url)
 
-          plantuml_content_format(code, format, attrs)
+          plantuml_content_format(parent, code, format, attrs)
+        end
+
+        def plantuml_content_from_file(parent, target, attrs = {})
+          source_file = parent.document.normalize_system_path(target, nil, nil, recover: false)
+          content = ::File.open(source_file, mode: FILE_READ_MODE)
+          plantuml_content(parent, content, attrs)
+        rescue StandardError => e
+          plantuml_invalid_file(source_file, e.message, attrs)
+        rescue SecurityError => e
+          plantuml_insecure_file(source_file, e.message, attrs)
         end
 
         # Compression code used to generate PlantUML URLs. Taken directly from
@@ -113,8 +146,23 @@ module Asciidoctor
           join_paths(server_url, "#{format}/", result).to_s
         end
 
+        def create_plantuml_block(parent, content, attrs)
+          Asciidoctor::Block.new parent, :pass, {
+            content_model: :raw,
+            source: content,
+            subs: :default
+          }.merge(attrs)
+        end
+
         private
 
+        def insert_config_to_content(parent, config_path, content, attrs)
+          config = File.read(config_path, mode: FILE_READ_MODE)
+          subs = attrs['subs']
+          config = parent.apply_subs(config, parent.resolve_subs(subs)) if subs
+          return content.dup.insert(content.index("\n"), "\n#{config}") unless config.empty?
+        end
+
         def plantuml_txt_content(code, format, attrs = {})
           url = gen_url(code, format)
           URI(url).open do |f|
@@ -180,6 +228,16 @@ module Asciidoctor
           _plantuml_error_content(code, attrs)
         end
 
+        def plantuml_invalid_file(file, error, attrs = {})
+          error = "PlantUML Error: Could not parse \"#{file}\": #{error}"
+          _plantuml_error_content(error, attrs)
+        end
+
+        def plantuml_insecure_file(file, error, attrs = {})
+          error = "PlantUML Error: Could not read \"#{file}\": #{error}"
+          _plantuml_error_content(error, attrs)
+        end
+
         def _plantuml_error_content(error, attrs = {})
           content = '<div class="listingblock">'
           content += '<div class="content">'
@@ -246,7 +304,7 @@ module Asciidoctor
         end
 
         def expand_path(path, current, last, separator)
-          path = path[1..-1] if path.start_with?(separator) && current.zero?
+          path = path[1..] if path.start_with?(separator) && current.zero?
 
           path = [path, separator] unless path.end_with?(separator) || current == last
 
@@ -263,25 +321,19 @@ module Asciidoctor
       content_model :simple
 
       def process(parent, target, attrs)
-        lines = target.lines
-
-        lines = ['@startuml'] + target.lines unless target.lines[0] =~ /@startuml/
-
-        lines += ['@enduml'] unless target.lines[-1] =~ /@enduml/
-
-        content = Processor.plantuml_content(lines.join("\n"), attrs)
-
-        create_plantuml_block(parent, content, attrs)
+        content = Processor.plantuml_content(parent, target, attrs)
+        Processor.create_plantuml_block(parent, content, attrs)
       end
+    end
 
-      private
+    # PlantUML BlockMacroProcessor
+    class BlockMacroProcessor < Asciidoctor::Extensions::BlockMacroProcessor
+      use_dsl
+      named :plantuml
 
-      def create_plantuml_block(parent, content, attrs)
-        Asciidoctor::Block.new parent, :pass,  {
-          content_model: :raw,
-          source: content,
-          subs: :default
-        }.merge(attrs)
+      def process(parent, target, attrs)
+        content = Processor.plantuml_content_from_file(parent, target, attrs)
+        Processor.create_plantuml_block(parent, content, attrs)
       end
     end
   end

data/lib/asciidoctor_plantuml/version.rb

@@ -2,6 +2,6 @@
 
 module Asciidoctor
   module PlantUML
-    VERSION = '0.0.15'
+    VERSION = '0.1.1'
   end
 end

data/test/fixtures/config.puml

@@ -0,0 +1,3 @@
+skinparam monochrome true
+skinparam backgroundColor transparent
+skinparam style strictuml

data/test/fixtures/test.puml

@@ -0,0 +1,4 @@
+@startuml
+User -> (Start)
+User --> (Use the application) : Label
+@enduml

data/test/test_plantuml.rb

@@ -184,10 +184,88 @@ DOC_SVG = <<~ENDOFSTRING
   ----
 ENDOFSTRING
 
+DOC_BLOCK_MACRO = <<~ENDOFSTRING
+  = Hello PlantUML!
+
+  .Title Of this
+  plantuml::test/fixtures/test.puml[]
+ENDOFSTRING
+
+DOC_BLOCK_MACRO_MISSING_FILE = <<~ENDOFSTRING
+  = Hello PlantUML!
+
+  .Title Of this
+  plantuml::test/fixtures/missing.puml[]
+ENDOFSTRING
+
+DOC_BLOCK_MACRO_INSECURE_FILE = <<~ENDOFSTRING
+  = Hello PlantUML!
+
+  .Title Of this
+  plantuml::/etc/passwd[]
+ENDOFSTRING
+
+DOC_SUBS_ATTRIBUTES = <<~ENDOFSTRING
+  = Hello PlantUML!
+  :text: Label
+
+  [plantuml, format="png", subs="attributes+"]
+  .Title Of this
+  ----
+  User -> (Start)
+  User --> (Use the application) : {text}
+  ----
+ENDOFSTRING
+
+DOC_CONFIG_INCLUDE = <<~ENDOFSTRING
+  = Hello PlantUML!
+  :plantuml-include: test/fixtures/config.puml
+
+  [plantuml, format="png"]
+  .Title Of this
+  ----
+  User -> (Start)
+  User --> (Use the application) : Label
+  ----
+ENDOFSTRING
+
+DOC_CONFIG_INCLUDE_MISSING_FILE = <<~ENDOFSTRING
+  = Hello PlantUML!
+  :plantuml-include: test/fixtures/missing.puml
+
+  [plantuml, format="png"]
+  .Title Of this
+  ----
+  User -> (Start)
+  User --> (Use the application) : Label
+  ----
+ENDOFSTRING
+
+DOC_CONFIG_INCLUDE_INSECURE_FILE = <<~ENDOFSTRING
+  = Hello PlantUML!
+  :plantuml-include: /etc/passwd
+
+  [plantuml, format="png"]
+  .Title Of this
+  ----
+  User -> (Start)
+  User --> (Use the application) : Label
+  ----
+ENDOFSTRING
+
+DOC_CONFIG_INCLUDE_MACRO_BLOCK = <<~ENDOFSTRING
+  = Hello PlantUML!
+  :plantuml-include: test/fixtures/config.puml
+
+  [plantuml, format="png"]
+  plantuml::test/fixtures/test.puml[]
+ENDOFSTRING
+
 class PlantUmlTest < Test::Unit::TestCase
   GENURL = 'http://localhost:8080/plantuml/png/U9npA2v9B2efpStX2YrEBLBGjLFG20Q9Q4Bv804WIw4a8rKXiQ0W9pCviIGpFqzJmKh19p4fDOVB8JKl1QWT05kd5wq0'
   GENURL2 = 'http://localhost:8080/plantuml/png/U9npA2v9B2efpStXYdRszmqmZ8NGHh4mleAkdGAAa15G22Pc7Clba9gN0jGE00W75Cm0'
   GENURL_ENCODING = 'http://localhost:8080/plantuml/png/~1U9npA2v9B2efpStX2YrEBLBGjLFG20Q9Q4Bv804WIw4a8rKXiQ0W9pCviIGpFqzJmKh19p4fDOVB8JKl1QWT05kd5wq0'
+  GENURL_CONFIG = 'http://localhost:8080/plantuml/png/~1U9nDZJ4Emp08HVUSWh4PUe4ELQIktQeUW3YeiMA31NZexKEg3bc-Fly1Vp97zLxBO5lcXeeLgh2aLQKIk7OwaHdJzb7fl3oaY0P6ja34Vjeo_nOArPn-dzz62jSxN5v7r_YVZo0S-4g0hPMSqBFm23Tuuanbc8YNEDy1SzOwlG00'
   SVGGENURL = 'http://localhost:8080/plantuml/svg/~1U9npA2v9B2efpStX2YrEBLBGjLFG20Q9Q4Bv804WIw4a8rKXiQ0W9pCviIGpFqzJmKh19p4fDOVB8JKl1QWT05kd5wq0'
 
   def setup
@@ -302,6 +380,94 @@ class PlantUmlTest < Test::Unit::TestCase
     assert_equal GENURL_ENCODING, element['src']
   end
 
+  def test_plantuml_block_macro_processor
+    html = ::Asciidoctor.convert(StringIO.new(DOC_BLOCK_MACRO), backend: 'html5')
+    page = Nokogiri::HTML(html)
+
+    elements = page.css('img.plantuml')
+
+    assert_equal elements.size, 1
+
+    element = elements.first
+
+    assert_equal GENURL, element['src']
+  end
+
+  def test_should_show_file_error
+    html = ::Asciidoctor.convert(StringIO.new(DOC_BLOCK_MACRO_MISSING_FILE), backend: 'html5', safe: :secure)
+    page = Nokogiri::HTML(html)
+
+    elements = page.css('pre.plantuml-error')
+    assert_equal elements.size, 1
+    assert_includes html, 'No such file or directory'
+  end
+
+  def test_should_show_insecure_error
+    html = ::Asciidoctor.convert(StringIO.new(DOC_BLOCK_MACRO_INSECURE_FILE), backend: 'html5', safe: :secure)
+    page = Nokogiri::HTML(html)
+
+    elements = page.css('pre.plantuml-error')
+    assert_equal elements.size, 1
+    assert_includes html, 'is outside of jail'
+  end
+
+  def test_plantuml_subs_attributes
+    html = ::Asciidoctor.convert(StringIO.new(DOC_SUBS_ATTRIBUTES), backend: 'html5')
+    page = Nokogiri::HTML(html)
+
+    elements = page.css('img.plantuml')
+
+    assert_equal elements.size, 1
+
+    element = elements.first
+
+    assert_equal GENURL_ENCODING, element['src']
+  end
+
+  def test_plantuml_config_include
+    html = ::Asciidoctor.convert(StringIO.new(DOC_CONFIG_INCLUDE), backend: 'html5', safe: :secure)
+    page = Nokogiri::HTML(html)
+
+    elements = page.css('img.plantuml')
+
+    assert_equal elements.size, 1
+
+    element = elements.first
+
+    assert_equal GENURL_CONFIG, element['src']
+  end
+
+  def test_plantuml_config_include_missing_file
+    html = ::Asciidoctor.convert(StringIO.new(DOC_CONFIG_INCLUDE_MISSING_FILE), backend: 'html5')
+    page = Nokogiri::HTML(html)
+
+    elements = page.css('pre.plantuml-error')
+    assert_equal elements.size, 1
+    assert_includes html, 'No such file or directory'
+  end
+
+  def test_plantuml_config_include_insecure_file
+    html = ::Asciidoctor.convert(StringIO.new(DOC_CONFIG_INCLUDE_INSECURE_FILE), backend: 'html5', safe: :secure)
+    page = Nokogiri::HTML(html)
+
+    elements = page.css('pre.plantuml-error')
+    assert_equal elements.size, 1
+    assert_includes html, 'is outside of jail'
+  end
+
+  def test_plantuml_config_include_macro_block
+    html = ::Asciidoctor.convert(StringIO.new(DOC_CONFIG_INCLUDE_MACRO_BLOCK), backend: 'html5', safe: :secure)
+    page = Nokogiri::HTML(html)
+
+    elements = page.css('img.plantuml')
+
+    assert_equal elements.size, 1
+
+    element = elements.first
+
+    assert_equal GENURL_CONFIG, element['src']
+  end
+
   def test_plantuml_id_attribute
     html = ::Asciidoctor.convert(StringIO.new(DOC_ID), backend: 'html5')
     page = Nokogiri::HTML(html)

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-plantuml
 version: !ruby/object:Gem::Version
-  version: 0.0.15
+  version: 0.1.1
 platform: ruby
 authors:
 - Horacio Sanson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-28 00:00:00.000000000 Z
+date: 2022-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.10
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.10
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: 1.13.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: 1.13.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -58,35 +58,35 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.28'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.28'
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: asciidoctor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.6
+        version: 2.0.17
     - - "<"
       - !ruby/object:Gem::Version
         version: 3.0.0
@@ -96,7 +96,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.6
+        version: 2.0.17
     - - "<"
       - !ruby/object:Gem::Version
         version: 3.0.0
@@ -110,11 +110,14 @@ files:
 - lib/asciidoctor-plantuml.rb
 - lib/asciidoctor_plantuml/plantuml.rb
 - lib/asciidoctor_plantuml/version.rb
+- test/fixtures/config.puml
+- test/fixtures/test.puml
 - test/test_plantuml.rb
 homepage: https://github.com/hsanson/asciidoctor-plantuml
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -123,7 +126,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -135,4 +138,6 @@ signing_key:
 specification_version: 4
 summary: Asciidoctor support for PlantUML diagrams.
 test_files:
+- test/fixtures/config.puml
+- test/fixtures/test.puml
 - test/test_plantuml.rb