asciidoctor-plantuml 0.0.9 → 0.0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e836d29f06c357381929224f4c3c344aa1eea0288ac5aff95b391898ffd0e80
-  data.tar.gz: e02e8fa50763daa1c78d86e8a9c4af7be72905c45de61ae4c60b8d7bf9e3a3fb
+  metadata.gz: '0758c3c21b6b684c8d1659332edbb2dd21e2733973cf59e8c4317754f1697505'
+  data.tar.gz: 5ea7379ddaf79330b11930a719b03b97df72580da00a2b291121378b5a785503
 SHA512:
-  metadata.gz: 40d310baa03ed8f773d457bdde42ed92e7ef387c1bde39ef37475117a95b8c2544f7cf7420623491fbcbf0fcd024f03c8ad4139289728a7b4e010033ddea0853
-  data.tar.gz: 1ca5d165518845bc57f5c0ddb8fbdddbcb52127faa950ebe51b551cd1a4604576409d6562a5035ec3dbbeb4f3c2577e1937a33446b4b38aff913b62fc2836551
+  metadata.gz: 647dfb74a0015698ffb4b85c72f35c7c299a52ac7bdff85fe2d4252d891cceadd636f0008089420d91e144d39e74c88dc080234d273f81b6f3175a586156ba56
+  data.tar.gz: cc9da76d59762c3dd34570a77d0b9c4ddb826af087798b34068d14bcbb8f5caf19f5cc075b1057b143cb419b88dc1e19117abef886ebaaa782984622e68272b6

data/lib/asciidoctor-plantuml.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 require 'asciidoctor'
 require 'asciidoctor/extensions'
-require_relative 'asciidoctor-plantuml/plantuml'
+require_relative 'asciidoctor_plantuml/plantuml'
 
 Asciidoctor::Extensions.register do
   block Asciidoctor::PlantUml::BlockProcessor, :plantuml

data/lib/asciidoctor_plantuml/plantuml.rb

@@ -0,0 +1,288 @@
+# frozen_string_literal: true
+
+require 'uri'
+require 'open-uri'
+require 'zlib'
+require 'net/http'
+
+module Asciidoctor
+  # PlantUML Module
+  module PlantUml
+    # PlantUML Configuration
+    class Configuration
+      DEFAULT_URL = ENV['PLANTUML_URL'] || ''
+      DEFAULT_ENCODING = ENV['PLANTUML_ENCODING'] || 'legacy'
+
+      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
+
+    class << self
+      attr_writer :configuration
+    end
+
+    def self.configuration
+      @configuration ||= Configuration.new
+    end
+
+    def self.configure
+      yield(configuration)
+    end
+
+    # PlantUML Processor
+    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
+        def valid_format?(format)
+          FORMATS.include?(format)
+        end
+
+        def valid_encoding?(encoding)
+          ENCODINGS.include?(encoding)
+        end
+
+        def server_url
+          PlantUml.configuration.url
+        end
+
+        def txt_enabled?
+          PlantUml.configuration.txt_enable
+        end
+
+        def png_enabled?
+          PlantUml.configuration.png_enable
+        end
+
+        def svg_enabled?
+          PlantUml.configuration.svg_enable
+        end
+
+        def enabled?
+          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)
+          else
+            plantuml_invalid_content(format, attrs)
+          end
+        end
+
+        def plantuml_content(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)
+        end
+
+        # Compression code used to generate PlantUML URLs. Taken directly from
+        # 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]
+            b1 = bytes[0].nil? ? 0 : (bytes[0].ord & 0xFF)
+            b2 = bytes[1].nil? ? 0 : (bytes[1].ord & 0xFF)
+            b3 = bytes[2].nil? ? 0 : (bytes[2].ord & 0xFF)
+            result += append3bytes(b1, b2, b3)
+          end
+          join_paths(server_url, "#{format}/", result).to_s
+        end
+
+        private
+
+        def plantuml_txt_content(code, format, attrs = {})
+          url = gen_url(code, format)
+          URI(url).open do |f|
+            plantuml_ascii_content(f.read, attrs)
+          end
+        rescue OpenURI::HTTPError, Errno::ECONNREFUSED, SocketError
+          plantuml_png_content(code, format, attrs)
+        end
+
+        def plantuml_ascii_content(code, attrs = {})
+          content = '<div class="listingblock">'
+          content += '<div class="content">'
+          content += '<pre '
+          content += "id=\"#{attrs['id']}\" " if attrs['id']
+          content += 'class="plantuml">\n'
+          content += code
+          content += '</pre>'
+          content += '</div>'
+          content + '</div>'
+        end
+
+        def plantuml_png_content(code, format, attrs = {})
+          content = '<div class="imageblock">'
+          content += '<div class="content">'
+          content += '<img '
+          content += "id=\"#{attrs['id']}\" " if attrs['id']
+          content += 'class="plantuml" '
+          content += "width=\"#{attrs['width']}\" " if attrs['width']
+          content += "height=\"#{attrs['height']}\" " if attrs['height']
+          content += "alt=\"#{attrs['alt']}\" " if attrs['alt']
+          content += "src=\"#{gen_url(code, format)}\" />"
+          content += '</div>'
+          content + '</div>'
+        end
+
+        def plantuml_svg_content(code, format, attrs = {})
+          content = '<div class="imageblock">'
+          content += '<div class="content">'
+          content += '<object type="image/svg+xml" '
+          content += "data=\"#{gen_url(code, format)}\" "
+          content += "id=\"#{attrs['id']}\" " if attrs['id']
+          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 = {})
+          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 += error
+          content += '</pre>'
+          content += '</div>'
+          content + '</div>'
+        end
+
+        def encode6bit(bit)
+          return ('0'.ord + bit).chr if bit < 10
+
+          bit -= 10
+          return ('A'.ord + bit).chr if bit < 26
+
+          bit -= 26
+          return ('a'.ord + bit).chr if bit < 26
+
+          bit -= 26
+          return '-' if bit.zero?
+
+          return '_' if bit == 1
+
+          '?'
+        end
+
+        def append3bytes(bit1, bit2, bit3)
+          c1 = bit1 >> 2
+          c2 = ((bit1 & 0x3) << 4) | (bit2 >> 4)
+          c3 = ((bit2 & 0xF) << 2) | (bit3 >> 6)
+          c4 = bit3 & 0x3F
+          encode6bit(c1 & 0x3F).chr +
+            encode6bit(c2 & 0x3F).chr +
+            encode6bit(c3 & 0x3F).chr +
+            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)
+          response = Net::HTTP.get_response(URI(check_url))
+          response.is_a?(Net::HTTPSuccess)
+        rescue OpenURI::HTTPError, Errno::ECONNREFUSED, SocketError
+          false
+        end
+
+        def valid_uri?(uri)
+          !(uri =~ /\A#{URI_SCHEMES_REGEXP}\z/).nil?
+        end
+
+        def join_paths(*paths, separator: '/')
+          paths = paths.compact.reject(&:empty?)
+          last = paths.length - 1
+          paths.each_with_index.map do |path, index|
+            expand_path(path, index, last, separator)
+          end.join
+        end
+
+        def expand_path(path, current, last, separator)
+          path = path[1..-1] if path.start_with?(separator) && current.zero?
+
+          path = [path, separator] unless path.end_with?(separator) || current == last
+
+          path
+        end
+      end
+    end
+
+    # PlantUML BlockProcessor
+    class BlockProcessor < Asciidoctor::Extensions::BlockProcessor
+      use_dsl
+      named :plantuml
+      on_context :listing, :literal
+      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)
+      end
+
+      private
+
+      def create_plantuml_block(parent, content, attrs)
+        Asciidoctor::Block.new parent, :pass,  {
+          content_model: :raw,
+          source: content,
+          subs: :default
+        }.merge(attrs)
+      end
+    end
+  end
+end

data/lib/asciidoctor_plantuml/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Asciidoctor
+  module PlantUML
+    VERSION = '0.0.14'
+  end
+end

data/test/test_plantuml.rb

@@ -1,133 +1,221 @@
-require "test/unit"
-require "asciidoctor"
-require "stringio"
-require "nokogiri"
-require "asciidoctor-plantuml"
-
-DOC_BASIC = <<-eos
-= Hello PlantUML!
-
-[plantuml, format="png"]
-.Title Of this
-----
-User -> (Start)
-User --> (Use the application) : Label
-----
-eos
-
-DOC_BASIC2 = <<-eos
-= Hello PlantUML!
-
-[plantuml, format="png"]
-.Title Of this
-[[fig-xref]]
-----
-@startuml
-User -> (Start)
-User --> (Use the application) : Label
-@enduml
-----
-eos
-
-DOC_BASIC3 = <<-eos
-= Hello Compound PlantUML!
-
-[plantuml, format="png"]
-----
-[COMP1]
-[COMP2]
-[COMP1] -> [COMP2]
-[COMP2] --> [COMP3]
-----
-eos
-
-DOC_ID = <<-eos
-= Hello PlantUML!
-
-[plantuml, format="png", id="myId"]
-----
-User -> (Start)
-User --> (Use the application) : Label
-----
-eos
-
-DOC_DIM = <<-eos
-= Hello PlantUML!
-
-[plantuml, format="png", width="100px", height="50px"]
-----
-User -> (Start)
-User --> (Use the application) : Label
-----
-eos
-
-DOC_ALT = <<-eos
-= Hello PlantUML!
-
-[plantuml, format="png", alt="alt"]
-----
-User -> (Start)
-User --> (Use the application) : Label
-----
-eos
-
-DOC_BAD_FORMAT = <<-eos
-= Hello PlantUML!
-
-[plantuml, format="jpg"]
-----
-User -> (Start)
-User --> (Use the application) : Label
-----
-eos
-
-DOC_MULTI = <<-eos
-= 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
-----
-eos
-
-DOC_TXT = <<-eos
-= Hello PlantUML!
-
-[plantuml, format="txt"]
-----
-User -> (Start)
-User --> (Use the application) : Label
-----
-eos
+# frozen_string_literal: true
+
+require 'test/unit'
+require 'asciidoctor'
+require 'stringio'
+require 'nokogiri'
+require 'asciidoctor-plantuml'
+
+DOC_BASIC = <<~ENDOFSTRING
+  = Hello PlantUML!
+
+  [plantuml, format="png"]
+  .Title Of this
+  ----
+  User -> (Start)
+  User --> (Use the application) : Label
+  ----
+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!
+
+  [plantuml, format="png"]
+  .Title Of this
+  [[fig-xref]]
+  ----
+  @startuml
+  User -> (Start)
+  User --> (Use the application) : Label
+  @enduml
+  ----
+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!
+
+  [plantuml, format="png"]
+  ----
+  [COMP1]
+  [COMP2]
+  [COMP1] -> [COMP2]
+  [COMP2] --> [COMP3]
+  ----
+ENDOFSTRING
+
+DOC_BASIC3_LITERAL = <<~ENDOFSTRING
+  = Hello Compound PlantUML!
+
+  [plantuml, format="png"]
+  ....
+  [COMP1]
+  [COMP2]
+  [COMP1] -> [COMP2]
+  [COMP2] --> [COMP3]
+  ....
+ENDOFSTRING
+
+DOC_ID = <<~ENDOFSTRING
+  = Hello PlantUML!
+
+  [plantuml, format="png", id="myId"]
+  ----
+  User -> (Start)
+  User --> (Use the application) : Label
+  ----
+ENDOFSTRING
+
+DOC_DIM = <<~ENDOFSTRING
+  = Hello PlantUML!
+
+  [plantuml, format="png", width="100px", height="50px"]
+  ----
+  User -> (Start)
+  User --> (Use the application) : Label
+  ----
+ENDOFSTRING
+
+DOC_ALT = <<~ENDOFSTRING
+  = Hello PlantUML!
+
+  [plantuml, format="png", alt="alt"]
+  ----
+  User -> (Start)
+  User --> (Use the application) : Label
+  ----
+ENDOFSTRING
+
+DOC_BAD_FORMAT = <<~ENDOFSTRING
+  = Hello PlantUML!
+
+  [plantuml, format="jpg"]
+  ----
+  User -> (Start)
+  User --> (Use the application) : Label
+  ----
+ENDOFSTRING
+
+DOC_MULTI = <<~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_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!
+
+  [plantuml, format="txt"]
+  ----
+  User -> (Start)
+  User --> (Use the application) : Label
+  ----
+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 = '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.url = 'http://localhost:8080/plantuml'
       c.txt_enable = true
+      c.png_enable = true
+      c.svg_enable = true
     end
   end
 
   def test_plantuml_block_processor
+    html = ::Asciidoctor.convert(StringIO.new(DOC_BASIC), backend: 'html5')
+    page = Nokogiri::HTML(html)
+
+    elements = page.css('img.plantuml')
+
+    assert_equal elements.size, 1
 
-    html = ::Asciidoctor.convert(StringIO.new(DOC_BASIC), backend: "html5")
+    element = elements.first
+
+    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')
@@ -136,11 +224,28 @@ class PlantUmlTest < Test::Unit::TestCase
 
     element = elements.first
 
-    assert_equal GENURL, element["src"]
+    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')
@@ -149,11 +254,11 @@ class PlantUmlTest < Test::Unit::TestCase
 
     element = elements.first
 
-    assert_equal GENURL, element["src"]
+    assert_equal GENURL, element['src']
   end
 
   def test_plantuml_block_processor3
-    html = ::Asciidoctor.convert(StringIO.new(DOC_BASIC3), backend: "html5")
+    html = ::Asciidoctor.convert(StringIO.new(DOC_BASIC3), backend: 'html5')
     page = Nokogiri::HTML(html)
 
     elements = page.css('img.plantuml')
@@ -162,26 +267,55 @@ class PlantUmlTest < Test::Unit::TestCase
 
     element = elements.first
 
-    assert_equal GENURL2, element["src"]
+    assert_equal GENURL2, element['src']
   end
 
-  def test_plantuml_id_attribute
+  def test_plantuml_block_literal_processor3
+    html = ::Asciidoctor.convert(
+      StringIO.new(DOC_BASIC3_LITERAL), backend: 'html5'
+    )
+    page = Nokogiri::HTML(html)
 
-    html = ::Asciidoctor.convert(StringIO.new(DOC_ID), backend: "html5")
+    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 "myId", element["id"]
+    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)
 
+    elements = page.css('img.plantuml')
+
+    assert_equal elements.size, 1
+    element = elements.first
+
+    assert_equal 'myId', element['id']
   end
 
   def test_plantuml_dimension_attribute
-
-    html = ::Asciidoctor.convert(StringIO.new(DOC_DIM), backend: "html5")
+    html = ::Asciidoctor.convert(StringIO.new(DOC_DIM), backend: 'html5')
     page = Nokogiri::HTML(html)
 
     elements = page.css('img.plantuml')
@@ -189,14 +323,12 @@ class PlantUmlTest < Test::Unit::TestCase
     assert_equal elements.size, 1
     element = elements.first
 
-    assert_equal "100px", element["width"]
-    assert_equal "50px", element["height"]
-
+    assert_equal '100px', element['width']
+    assert_equal '50px', element['height']
   end
 
   def test_plantuml_alt_attribute
-
-    html = ::Asciidoctor.convert(StringIO.new(DOC_ALT), backend: "html5")
+    html = ::Asciidoctor.convert(StringIO.new(DOC_ALT), backend: 'html5')
     page = Nokogiri::HTML(html)
 
     elements = page.css('img.plantuml')
@@ -204,23 +336,20 @@ class PlantUmlTest < Test::Unit::TestCase
     assert_equal elements.size, 1
     element = elements.first
 
-    assert_equal "alt", element["alt"]
-
+    assert_equal 'alt', element['alt']
   end
 
   def test_should_show_bad_format
-    html = ::Asciidoctor.convert(StringIO.new(DOC_BAD_FORMAT), backend: "html5")
+    html = ::Asciidoctor.convert(StringIO.new(DOC_BAD_FORMAT), backend: 'html5')
 
     page = Nokogiri::HTML(html)
 
     elements = page.css('pre.plantuml-error')
     assert_equal elements.size, 1
-
   end
 
-  def test_plantuml_multiple
-
-    html = ::Asciidoctor.convert(StringIO.new(DOC_MULTI), backend: "html5")
+  def test_plantuml_multiple_listing
+    html = ::Asciidoctor.convert(StringIO.new(DOC_MULTI), backend: 'html5')
     page = Nokogiri::HTML(html)
 
     elements = page.css('img.plantuml')
@@ -228,72 +357,118 @@ class PlantUmlTest < Test::Unit::TestCase
 
     elements = page.css('.plantuml-error')
     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"
+      c.url = 'http://nonexistent.com/plantuml'
     end
 
-    html = ::Asciidoctor.convert(StringIO.new(DOC_MULTI), backend: "html5")
+    html = ::Asciidoctor.convert(StringIO.new(DOC_MULTI), backend: 'html5')
     page = Nokogiri::HTML(html)
 
     elements = page.css('img.plantuml')
-    assert_equal elements.size, 3
+    assert_equal 3, elements.size
 
     elements = page.css('.plantuml-error')
-    assert_equal elements.size, 0
+    assert_equal 0, elements.size
   end
 
   def test_plantuml_invalid_uri
-
     Asciidoctor::PlantUml.configure do |c|
-      c.url = "ftp://test.com"
+      c.url = 'ftp://test.com'
     end
 
-    html = ::Asciidoctor.convert(StringIO.new(DOC_BASIC), backend: "html5")
+    html = ::Asciidoctor.convert(StringIO.new(DOC_BASIC), backend: 'html5')
     page = Nokogiri::HTML(html)
     elements = page.css('pre.plantuml-error')
     assert_equal elements.size, 1
   end
 
   def test_plantuml_nil_uri
-
     Asciidoctor::PlantUml.configure do |c|
       c.url = nil
     end
 
-    html = ::Asciidoctor.convert(StringIO.new(DOC_BASIC), backend: "html5")
+    html = ::Asciidoctor.convert(StringIO.new(DOC_BASIC), backend: 'html5')
     page = Nokogiri::HTML(html)
     elements = page.css('pre.plantuml-error')
     assert_equal elements.size, 1
   end
 
   def test_plantuml_empty_uri
-
     Asciidoctor::PlantUml.configure do |c|
-      c.url = ""
+      c.url = ''
     end
 
-    html = ::Asciidoctor.convert(StringIO.new(DOC_BASIC), backend: "html5")
+    html = ::Asciidoctor.convert(StringIO.new(DOC_BASIC), backend: 'html5')
     page = Nokogiri::HTML(html)
     elements = page.css('pre.plantuml-error')
     assert_equal elements.size, 1
   end
 
   def test_disable_txt
-
     Asciidoctor::PlantUml.configure do |c|
-      c.url = "http://localhost:8080/plantuml"
+      c.url = 'http://localhost:8080/plantuml'
       c.txt_enable = false
     end
 
-    html = ::Asciidoctor.convert(StringIO.new(DOC_TXT), backend: "html5")
+    html = ::Asciidoctor.convert(StringIO.new(DOC_TXT), backend: 'html5')
+    page = Nokogiri::HTML(html)
+    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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-plantuml
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.14
 platform: ruby
 authors:
 - Horacio Sanson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-17 00:00:00.000000000 Z
+date: 2021-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,34 +24,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.5'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.5'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: nokogiri
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
@@ -94,8 +108,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/asciidoctor-plantuml.rb
-- lib/asciidoctor-plantuml/plantuml.rb
-- lib/asciidoctor-plantuml/version.rb
+- lib/asciidoctor_plantuml/plantuml.rb
+- lib/asciidoctor_plantuml/version.rb
 - test/test_plantuml.rb
 homepage: https://github.com/hsanson/asciidoctor-plantuml
 licenses:
@@ -109,17 +123,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.1'
+      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: An extension for Asciidoctor that enables support for PlantUML diagrams.
+summary: Asciidoctor support for PlantUML diagrams.
 test_files:
 - test/test_plantuml.rb

data/lib/asciidoctor-plantuml/plantuml.rb

@@ -1,286 +0,0 @@
-require 'uri'
-require 'zlib'
-require 'open-uri'
-require 'net/http'
-
-module Asciidoctor
-  module PlantUml
-
-    class Configuration
-
-      DEFAULT_URL = ENV["PLANTUML_URL"] || ""
-
-      attr_accessor :url, :txt_enable, :svg_enable, :png_enable
-
-      def initialize
-        @url = DEFAULT_URL
-        @txt_enable = true
-        @svg_enable = true
-        @png_enable = true
-      end
-    end
-
-    class << self
-      attr_writer :configuration
-    end
-
-    def self.configuration
-      @configuration ||= Configuration.new
-    end
-
-    def self.configure
-      yield(configuration)
-    end
-
-    class Processor
-
-      FORMATS = ["png", "svg", "txt"]
-      DEFAULT_FORMAT = FORMATS[0]
-
-      class << self
-        def valid_format?(format)
-          FORMATS.include?(format)
-        end
-
-        def server_url
-          PlantUml::configuration.url
-        end
-
-        def txt_enabled?
-          PlantUml::configuration.txt_enable
-        end
-
-        def png_enabled?
-          PlantUml::configuration.png_enable
-        end
-
-        def svg_enabled?
-          PlantUml::configuration.svg_enable
-        end
-
-        def enabled?
-          txt_enabled? || png_enabled? || svg_enabled?
-        end
-
-        def plantuml_content(code, attrs = {})
-
-          format = attrs["format"] || DEFAULT_FORMAT
-
-          if !enabled?
-            return plantuml_disabled_content(code, attrs)
-          end
-
-          if !valid_uri?(server_url)
-            return plantuml_server_unavailable_content(server_url, attrs)
-          end
-
-          case format
-          when "png"
-            plantuml_img_content(code, format, attrs)
-          when "txt"
-            if txt_enabled?
-              plantuml_txt_content(code, format, attrs)
-            else
-              plantuml_invalid_content(format, attrs)
-            end
-          when "svg"
-            plantuml_img_content(code, format, attrs)
-          else
-            plantuml_invalid_content(format, attrs)
-          end
-        end
-
-        # Compression code used to generate PlantUML URLs. Taken directly from the
-        # Transcoder class in the PlantUML java code.
-        def gen_url(text, format)
-          result = ""
-          compressedData = Zlib::Deflate.deflate(text)
-          compressedData.chars.each_slice(3) do |bytes|
-            #print bytes[0], ' ' , bytes[1] , ' ' , bytes[2]
-            b1 = bytes[0].nil? ? 0 : (bytes[0].ord & 0xFF)
-            b2 = bytes[1].nil? ? 0 : (bytes[1].ord & 0xFF)
-            b3 = bytes[2].nil? ? 0 : (bytes[2].ord & 0xFF)
-            result += append3bytes(b1, b2, b3)
-          end
-          join_paths(server_url, "/#{format}/", result).to_s
-        end
-
-        private
-
-        def plantuml_txt_content(code, format, attrs = {})
-          begin
-            url = gen_url(code, format)
-            open(url) do |f|
-              plantuml_ascii_content(f.read, format, attrs)
-            end
-          rescue
-            plantuml_img_content(code, format, attrs)
-          end
-        end
-
-        def plantuml_ascii_content(code, format, attrs = {})
-          content = "<div class=\"listingblock\">"
-          content += "<div class=\"content\">"
-          content += "<pre "
-          content +="id=\"#{attrs['id']}\" " if attrs['id']
-          content +="class=\"plantuml\">\n"
-          content += code
-          content +="</pre>"
-          content += "</div>"
-          content += "</div>"
-        end
-
-        def plantuml_img_content(code, format, attrs = {})
-          content = "<div class=\"imageblock\">"
-          content += "<div class=\"content\">"
-          content += "<img "
-          content +="id=\"#{attrs['id']}\" " if attrs['id']
-          content +="class=\"plantuml\" "
-          content +="width=\"#{attrs['width']}\" " if attrs['width']
-          content +="height=\"#{attrs['height']}\" " if attrs['height']
-          content +="alt=\"#{attrs['alt']}\" " if attrs['alt']
-          content +="src=\"#{gen_url(code, format)}\" />"
-          content += "</div>"
-          content += "</div>"
-        end
-
-        def plantuml_invalid_content(format, attrs = {})
-          content = "<div class=\"listingblock\">"
-          content += "<div class=\"content\">"
-          content += "<pre "
-          content +="id=\"#{attrs['id']}\" " if attrs['id']
-          content +="class=\"plantuml plantuml-error\"> "
-          content += "PlantUML Error: Invalid format \"#{format}\""
-          content +="</pre>"
-          content += "</div>"
-          content += "</div>"
-        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 += "PlantUML Error: cannot connect to PlantUML server at \"#{url}\""
-          content +="</pre>"
-          content += "</div>"
-          content += "</div>"
-        end
-
-        def plantuml_disabled_content(code, 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 +="</pre>"
-          content += "</div>"
-          content += "</div>"
-        end
-
-        def encode6bit(b)
-          if b < 10
-            return ('0'.ord + b).chr
-          end
-          b = b - 10
-          if b < 26
-            return ('A'.ord + b).chr
-          end
-          b = b - 26
-          if b < 26
-            return ('a'.ord + b).chr
-          end
-          b = b - 26
-          if b == 0
-            return '-'
-          end
-          if b == 1
-            return '_'
-          end
-          return '?'
-        end
-
-        def append3bytes(b1, b2, b3)
-          c1 = b1 >> 2
-          c2 = ((b1 & 0x3) << 4) | (b2 >> 4)
-          c3 = ((b2 & 0xF) << 2) | (b3 >> 6)
-          c4 = b3 & 0x3F
-          return encode6bit(c1 & 0x3F).chr +
-                 encode6bit(c2 & 0x3F).chr +
-                 encode6bit(c3 & 0x3F).chr +
-                 encode6bit(c4 & 0x3F).chr
-        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)
-          response = Net::HTTP.get_response(URI(check_url))
-          return response.is_a?(Net::HTTPSuccess)
-        rescue
-          return false
-        end
-
-        def valid_uri?(uri)
-          !(uri =~ /\A#{URI::regexp(['http', 'https'])}\z/).nil?
-        end
-
-        def join_paths(*paths, separator: '/')
-          paths = paths.compact.reject(&:empty?)
-          last = paths.length - 1
-          paths.each_with_index.map { |path, index|
-            expand_path(path, index, last, separator)
-          }.join
-        end
-
-        def expand_path(path, current, last, separator)
-          if path.start_with?(separator) && current != 0
-            path = path[1..-1]
-          end
-
-          unless path.end_with?(separator) || current == last
-            path = [path, separator]
-          end
-
-          path
-        end
-      end
-    end
-
-    class BlockProcessor < Asciidoctor::Extensions::BlockProcessor
-
-      use_dsl
-      named :plantuml
-      on_context :listing
-      content_model :simple
-
-      def process(parent, target, attrs)
-
-        lines = target.lines
-
-        if !(target.lines[0] =~ /@startuml/)
-          lines = ["@startuml"] + target.lines
-        end
-
-        if !(target.lines[-1] =~ /@enduml/)
-          lines += ["@enduml"]
-        end
-
-        content = Processor.plantuml_content(lines.join("\n"), attrs)
-
-        return create_plantuml_block(parent, content, attrs)
-
-      end
-
-      private
-
-      def create_plantuml_block(parent, content, attrs)
-        Asciidoctor::Block.new parent, :pass,  { content_model: :raw,
-                                      source: content, subs: :default }.merge(attrs)
-      end
-
-    end
-
-  end
-end

data/lib/asciidoctor-plantuml/version.rb

@@ -1,5 +0,0 @@
-module Asciidoctor
-  module PlantUML
-    VERSION = '0.0.9'.freeze
-  end
-end