asciidoctor-plantuml 0.0.11 → 0.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b550934d0e6408099c74544fa93071a1c04f64392353e1a11a7388d1a897bc8a
-  data.tar.gz: cd0627162cf7f60af7d2b9fc2e4a7edd20c36ac429e4e7340129281968a14422
+  metadata.gz: 7673d42a2b0bcc381cb0111511bfc05584ed0c509dfad8dcf9b20919b9d8b689
+  data.tar.gz: 2a8c98b8a3adfc09e57a7928e9f23a86230072da14ca9a9593d627401f40d194
 SHA512:
-  metadata.gz: 5d9131c6af8a5be72c7732afe20ac2fd9fd874c22774dafe0cfc37be4c94941d8ab3a1bddacdb973e9a4e7bff6b45a76c6d69b5bd9136375104d9415fff4cb0b
-  data.tar.gz: 8a200585455b8937b6d4f2f7772d3f77321c38de64633a81b2525c38b5e55050f6948870b2010b829cb8b8ce0fb912f77f5e9792a9cd0e548f58e7f93fe4bc07
+  metadata.gz: 9ed82c582714d60f1a0cf57d5bbb070250dc07744a7545b28912d2e4e97f13ceff292d3d528df7f23ea683e4bfbd1cd6ce5c2500f1b8fb2b274429395fede02c
+  data.tar.gz: 78e840faff576976ecdf0d1584d0e9b86d07a8afed74c7248f210d7bd306a25c1c67c1bb41165d2e54b559d02f122d0cc8c8d960c989b0a3a0fc057f32e4d600

data/lib/asciidoctor_plantuml/plantuml.rb

@@ -3,7 +3,6 @@
 require 'uri'
 require 'open-uri'
 require 'zlib'
-require 'open-uri'
 require 'net/http'
 
 module Asciidoctor
@@ -12,14 +11,16 @@ module Asciidoctor
     # PlantUML Configuration
     class Configuration
       DEFAULT_URL = ENV['PLANTUML_URL'] || ''
+      DEFAULT_ENCODING = ENV['PLANTUML_ENCODING'] || 'legacy'
 
-      attr_accessor :url, :txt_enable, :svg_enable, :png_enable
+      attr_accessor :url, :txt_enable, :svg_enable, :png_enable, :encoding
 
       def initialize
         @url = DEFAULT_URL
         @txt_enable = true
         @svg_enable = true
         @png_enable = true
+        @encoding = DEFAULT_ENCODING
       end
     end
 
@@ -39,6 +40,13 @@ module Asciidoctor
     class Processor
       FORMATS = %w[png svg txt].freeze
       DEFAULT_FORMAT = FORMATS[0]
+
+      ENCODINGS = %w[legacy deflate].freeze
+      DEFAULT_ENCODING = ENCODINGS[0]
+
+      ENCODINGS_MAGIC_STRINGS_MAP = Hash.new('')
+      ENCODINGS_MAGIC_STRINGS_MAP['deflate'] = '~1'
+
       URI_SCHEMES_REGEXP = ::URI::DEFAULT_PARSER.make_regexp(%w[http https])
 
       class << self
@@ -46,6 +54,10 @@ module Asciidoctor
           FORMATS.include?(format)
         end
 
+        def valid_encoding?(encoding)
+          ENCODINGS.include?(encoding)
+        end
+
         def server_url
           PlantUml.configuration.url
         end
@@ -67,10 +79,9 @@ module Asciidoctor
         end
 
         def plantuml_content_format(code, format, attrs = {})
-          if %w[png svg].include?(format)
-            plantuml_img_content(code, format, attrs)
-          elsif format == 'txt' && txt_enabled?
-            plantuml_txt_content(code, format, attrs)
+          if %w[png svg txt].include?(format) &&
+             method("#{format}_enabled?").call
+            method("plantuml_#{format}_content").call(code, format, attrs)
           else
             plantuml_invalid_content(format, attrs)
           end
@@ -81,9 +92,7 @@ module Asciidoctor
 
           return plantuml_disabled_content(code, attrs) unless enabled?
 
-          unless valid_uri?(server_url)
-            return plantuml_server_unavailable_content(server_url, attrs)
-          end
+          return plantuml_server_unavailable_content(server_url, attrs) unless valid_uri?(server_url)
 
           plantuml_content_format(code, format, attrs)
         end
@@ -92,6 +101,7 @@ module Asciidoctor
         # the transcoder class in the PlantUML java code.
         def gen_url(text, format)
           result = ''
+          result += encoding_magic_prefix
           compressed_data = Zlib::Deflate.deflate(text)
           compressed_data.chars.each_slice(3) do |bytes|
             # print bytes[0], ' ' , bytes[1] , ' ' , bytes[2]
@@ -111,7 +121,7 @@ module Asciidoctor
             plantuml_ascii_content(f.read, attrs)
           end
         rescue OpenURI::HTTPError, Errno::ECONNREFUSED, SocketError
-          plantuml_img_content(code, format, attrs)
+          plantuml_png_content(code, format, attrs)
         end
 
         def plantuml_ascii_content(code, attrs = {})
@@ -126,7 +136,7 @@ module Asciidoctor
           content + '</div>'
         end
 
-        def plantuml_img_content(code, format, attrs = {})
+        def plantuml_png_content(code, format, attrs = {})
           content = '<div class="imageblock">'
           content += '<div class="content">'
           content += '<img '
@@ -140,37 +150,43 @@ module Asciidoctor
           content + '</div>'
         end
 
-        def plantuml_invalid_content(format, attrs = {})
-          content = '<div class="listingblock">'
+        def plantuml_svg_content(code, format, attrs = {})
+          content = '<div class="imageblock">'
           content += '<div class="content">'
-          content += '<pre '
+          content += '<object type="image/svg+xml" '
+          content += "data=\"#{gen_url(code, format)}\" "
           content += "id=\"#{attrs['id']}\" " if attrs['id']
-          content += 'class="plantuml plantuml-error"> '
-          content += "PlantUML Error: Invalid format \"#{format}\""
-          content += '</pre>'
+          content += "width=\"#{attrs['width']}\" " if attrs['width']
+          content += "height=\"#{attrs['height']}\" " if attrs['height']
+          content += '>'
+          attrs['id'] = 'fallback_' + attrs['id'] if attrs['id']
+          content += plantuml_png_content(code, format, attrs)
+          content += '</object>'
           content += '</div>'
           content + '</div>'
         end
 
+        def plantuml_invalid_content(format, attrs = {})
+          error = "PlantUML Error: Invalid format \"#{format}\""
+          _plantuml_error_content(error, attrs)
+        end
+
         def plantuml_server_unavailable_content(url, attrs = {})
-          content = '<div class="listingblock">'
-          content += '<div class="content">'
-          content += '<pre '
-          content += "id=\"#{attrs['id']}\" " if attrs['id']
-          content += 'class="plantuml plantuml-error"> '
-          content += "Error: cannot connect to PlantUML server at \"#{url}\""
-          content += '</pre>'
-          content += '</div>'
-          content + '</div>'
+          error = "Error: cannot connect to PlantUML server at \"#{url}\""
+          _plantuml_error_content(error, attrs)
         end
 
         def plantuml_disabled_content(code, attrs = {})
+          _plantuml_error_content(code, attrs)
+        end
+
+        def _plantuml_error_content(error, attrs = {})
           content = '<div class="listingblock">'
           content += '<div class="content">'
           content += '<pre '
           content += "id=\"#{attrs['id']}\" " if attrs['id']
           content += 'class="plantuml plantuml-error">\n'
-          content += code
+          content += error
           content += '</pre>'
           content += '</div>'
           content + '</div>'
@@ -204,6 +220,10 @@ module Asciidoctor
             encode6bit(c4 & 0x3F).chr
         end
 
+        def encoding_magic_prefix
+          ENCODINGS_MAGIC_STRINGS_MAP[PlantUml.configuration.encoding]
+        end
+
         # Make a call to the PlantUML server with the simplest diagram possible
         # to check if the server is available or not.
         def check_server(check_url)
@@ -228,9 +248,7 @@ module Asciidoctor
         def expand_path(path, current, last, separator)
           path = path[1..-1] if path.start_with?(separator) && current.zero?
 
-          unless path.end_with?(separator) || current == last
-            path = [path, separator]
-          end
+          path = [path, separator] unless path.end_with?(separator) || current == last
 
           path
         end
@@ -241,15 +259,13 @@ module Asciidoctor
     class BlockProcessor < Asciidoctor::Extensions::BlockProcessor
       use_dsl
       named :plantuml
-      on_context :listing
+      on_context :listing, :literal
       content_model :simple
 
       def process(parent, target, attrs)
         lines = target.lines
 
-        unless target.lines[0] =~ /@startuml/
-          lines = ['@startuml'] + target.lines
-        end
+        lines = ['@startuml'] + target.lines unless target.lines[0] =~ /@startuml/
 
         lines += ['@enduml'] unless target.lines[-1] =~ /@enduml/
 

data/lib/asciidoctor_plantuml/version.rb

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

data/test/test_plantuml.rb

@@ -17,6 +17,17 @@ DOC_BASIC = <<~ENDOFSTRING
   ----
 ENDOFSTRING
 
+DOC_BASIC_LITERAL = <<~ENDOFSTRING
+  = Hello PlantUML!
+
+  [plantuml, format="png"]
+  .Title Of this
+  ....
+  User -> (Start)
+  User --> (Use the application) : Label
+  ....
+ENDOFSTRING
+
 DOC_BASIC2 = <<~ENDOFSTRING
   = Hello PlantUML!
 
@@ -31,6 +42,20 @@ DOC_BASIC2 = <<~ENDOFSTRING
   ----
 ENDOFSTRING
 
+DOC_BASIC2_LITERAL = <<~ENDOFSTRING
+  = Hello PlantUML!
+
+  [plantuml, format="png"]
+  .Title Of this
+  [[fig-xref]]
+  ....
+  @startuml
+  User -> (Start)
+  User --> (Use the application) : Label
+  @enduml
+  ....
+ENDOFSTRING
+
 DOC_BASIC3 = <<~ENDOFSTRING
   = Hello Compound PlantUML!
 
@@ -43,6 +68,18 @@ DOC_BASIC3 = <<~ENDOFSTRING
   ----
 ENDOFSTRING
 
+DOC_BASIC3_LITERAL = <<~ENDOFSTRING
+  = Hello Compound PlantUML!
+
+  [plantuml, format="png"]
+  ....
+  [COMP1]
+  [COMP2]
+  [COMP1] -> [COMP2]
+  [COMP2] --> [COMP3]
+  ....
+ENDOFSTRING
+
 DOC_ID = <<~ENDOFSTRING
   = Hello PlantUML!
 
@@ -105,6 +142,28 @@ DOC_MULTI = <<~ENDOFSTRING
   ----
 ENDOFSTRING
 
+DOC_MULTI_LITERAL = <<~ENDOFSTRING
+  = Hello PlantUML!
+
+  [plantuml, format="png"]
+  ....
+  User -> (Start)
+  User --> (Use the application) : Label
+  ....
+
+  [plantuml, format="png"]
+  ....
+  User -> (Start)
+  User --> (Use the application) : Label
+  ....
+
+  [plantuml, format="txt"]
+  ....
+  User -> (Start)
+  User --> (Use the application) : Label
+  ....
+ENDOFSTRING
+
 DOC_TXT = <<~ENDOFSTRING
   = Hello PlantUML!
 
@@ -115,14 +174,28 @@ DOC_TXT = <<~ENDOFSTRING
   ----
 ENDOFSTRING
 
+DOC_SVG = <<~ENDOFSTRING
+  = Hello PlantUML!
+
+  [plantuml, format="svg"]
+  ----
+  User -> (Start)
+  User --> (Use the application) : Label
+  ----
+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'
+  SVGGENURL = 'http://localhost:8080/plantuml/svg/~1U9npA2v9B2efpStX2YrEBLBGjLFG20Q9Q4Bv804WIw4a8rKXiQ0W9pCviIGpFqzJmKh19p4fDOVB8JKl1QWT05kd5wq0'
 
   def setup
     Asciidoctor::PlantUml.configure do |c|
       c.url = 'http://localhost:8080/plantuml'
       c.txt_enable = true
+      c.png_enable = true
+      c.svg_enable = true
     end
   end
 
@@ -139,8 +212,40 @@ class PlantUmlTest < Test::Unit::TestCase
     assert_equal GENURL, element['src']
   end
 
+  def test_plantuml_block_literal_processor
+    html = ::Asciidoctor.convert(
+      StringIO.new(DOC_BASIC_LITERAL), 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_plantuml_block_processor2
-    html = ::Asciidoctor.convert(StringIO.new(DOC_BASIC2), backend: 'html5')
+    html = ::Asciidoctor.convert(
+      StringIO.new(DOC_BASIC2), 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_plantuml_block_literal_processor2
+    html = ::Asciidoctor.convert(
+      StringIO.new(DOC_BASIC2_LITERAL), backend: 'html5'
+    )
     page = Nokogiri::HTML(html)
 
     elements = page.css('img.plantuml')
@@ -165,6 +270,38 @@ class PlantUmlTest < Test::Unit::TestCase
     assert_equal GENURL2, element['src']
   end
 
+  def test_plantuml_block_literal_processor3
+    html = ::Asciidoctor.convert(
+      StringIO.new(DOC_BASIC3_LITERAL), backend: 'html5'
+    )
+    page = Nokogiri::HTML(html)
+
+    elements = page.css('img.plantuml')
+
+    assert_equal elements.size, 1
+
+    element = elements.first
+
+    assert_equal GENURL2, element['src']
+  end
+
+  def test_plantuml_block_processor_encoding
+    Asciidoctor::PlantUml.configure do |c|
+      c.encoding = 'deflate'
+    end
+
+    html = ::Asciidoctor.convert(StringIO.new(DOC_BASIC), 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_id_attribute
     html = ::Asciidoctor.convert(StringIO.new(DOC_ID), backend: 'html5')
     page = Nokogiri::HTML(html)
@@ -211,7 +348,7 @@ class PlantUmlTest < Test::Unit::TestCase
     assert_equal elements.size, 1
   end
 
-  def test_plantuml_multiple
+  def test_plantuml_multiple_listing
     html = ::Asciidoctor.convert(StringIO.new(DOC_MULTI), backend: 'html5')
     page = Nokogiri::HTML(html)
 
@@ -222,6 +359,19 @@ class PlantUmlTest < Test::Unit::TestCase
     assert_equal elements.size, 0
   end
 
+  def test_plantuml_multiple_literal
+    html = ::Asciidoctor.convert(
+      StringIO.new(DOC_MULTI_LITERAL), backend: 'html5'
+    )
+    page = Nokogiri::HTML(html)
+
+    elements = page.css('img.plantuml')
+    assert elements.size >= 2
+
+    elements = page.css('.plantuml-error')
+    assert_equal elements.size, 0
+  end
+
   def test_plantuml_bad_server
     Asciidoctor::PlantUml.configure do |c|
       c.url = 'http://nonexistent.com/plantuml'
@@ -281,4 +431,44 @@ class PlantUmlTest < Test::Unit::TestCase
     elements = page.css('pre.plantuml-error')
     assert_equal elements.size, 1
   end
+
+  def test_svg
+    Asciidoctor::PlantUml.configure do |c|
+      c.url = 'http://localhost:8080/plantuml'
+      c.svg_enable = true
+    end
+
+    html = ::Asciidoctor.convert(StringIO.new(DOC_SVG), backend: 'html5')
+    page = Nokogiri::HTML(html)
+    elements = page.css("object[type='image/svg+xml']")
+    assert_equal elements.size, 1
+
+    element = elements.first
+
+    assert_equal SVGGENURL, element['data']
+  end
+
+  def test_disable_svg
+    Asciidoctor::PlantUml.configure do |c|
+      c.url = 'http://localhost:8080/plantuml'
+      c.svg_enable = false
+    end
+
+    html = ::Asciidoctor.convert(StringIO.new(DOC_SVG), backend: 'html5')
+    page = Nokogiri::HTML(html)
+    elements = page.css('pre.plantuml-error')
+    assert_equal elements.size, 1
+  end
+
+  def test_disable_png
+    Asciidoctor::PlantUml.configure do |c|
+      c.url = 'http://localhost:8080/plantuml'
+      c.png_enable = false
+    end
+
+    html = ::Asciidoctor.convert(StringIO.new(DOC_BASIC_LITERAL), backend: 'html5')
+    page = Nokogiri::HTML(html)
+    elements = page.css('pre.plantuml-error')
+    assert_equal elements.size, 1
+  end
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-plantuml
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 0.0.15
 platform: ruby
 authors:
 - Horacio Sanson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-01 00:00:00.000000000 Z
+date: 2021-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 2.2.10
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 2.2.10
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.11'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.66'
+        version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.66'
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
@@ -123,15 +123,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Asciidoctor support for PlantUML diagrams.