asciidoctor-plantuml 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ed5ecef9a1e029694a9d18e2800a7a95869455e6
+  data.tar.gz: b47a156f1e832ac35092f3ff6dfec092ebda99a6
+SHA512:
+  metadata.gz: 4b8ee673ee3d5a3432a27d94bee9525e7e941791f6055a529300a5a065a1d659925d7d63b8a5d942e35ec4ec6ca11d2a5387232c9fb2cd2e28988b0500850742
+  data.tar.gz: 34a6ebd97cacd0ee47361c6ba1e62aa014f6e4ba028f0e7a43863a51212ae2985be179db107db811daf3094097453189d77938d3d65f3e5eac0ad5ba3f86cb22

data/lib/asciidoctor-plantuml.rb

@@ -0,0 +1,7 @@
+require 'asciidoctor'
+require 'asciidoctor/extensions'
+require_relative 'asciidoctor-plantuml/plantuml'
+
+Asciidoctor::Extensions.register do
+  block Asciidoctor::PlantUml::BlockProcessor, :plantuml
+end

data/lib/asciidoctor-plantuml/plantuml.rb

@@ -0,0 +1,178 @@
+require 'uri'
+require 'zlib'
+require 'open-uri'
+require 'net/http'
+
+module Asciidoctor
+  module PlantUml
+
+    class Configuration
+
+      DEFAULT_URL = ENV["PLANTUML_URL"] || "http://localhost:8080/plantuml"
+
+      attr_accessor :url, :test
+
+      def initialize
+        @url = DEFAULT_URL
+        @test = false
+      end
+    end
+
+    class << self
+      attr_writer :configuration
+    end
+
+    def self.configuration
+      @configuration ||= Configuration.new
+    end
+
+    def self.configure
+      yield(configuration)
+    end
+
+    module Processor
+
+      FORMATS = ["png", "svg", "txt"]
+      DEFAULT_FORMAT = FORMATS[0]
+
+      def valid_format?(format)
+        FORMATS.include?(format)
+      end
+
+      def server_url
+        PlantUml::configuration.url
+      end
+
+      def plantuml_content(code, format, attrs = {})
+        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)}\" />"
+      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
+
+      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 create_plantuml_block(parent, content)
+        Asciidoctor::Block.new parent, :pass, :content_model => :raw,
+          :source => content, :subs => :default
+      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
+
+    class BlockProcessor < Asciidoctor::Extensions::BlockProcessor
+      include Processor
+
+      def process(parent, target, attrs)
+
+        testing = attrs["test"] == "true"
+
+        check_url = join_paths(server_url, "/png/SyfFKj2rKt3CoKnELR1Io4ZDoSa70000")
+
+        if ! check_server(check_url) && ! testing
+          content = "<div class='plantuml'>PlantUML server [#{check_url}] is unreachable</div>"
+          return create_plantuml_block(parent, content)
+        end
+
+        format = attrs["format"] || DEFAULT_FORMAT
+
+        if ! valid_format?(format)
+          content = "<div class='plantuml'>Invalid format #{format}</div>"
+          return create_plantuml_block(parent, content)
+        end
+
+        lines = target.lines
+
+        if !(target.lines[0] =~ /@startuml/)
+          lines = ["@startuml"] + target.lines
+        end
+
+        if !(target.lines[-1] =~ /@enduml/)
+          lines += ["@enduml"]
+        end
+
+        content = plantuml_content(lines.join("\n"), format, attrs)
+        return create_plantuml_block(parent, content)
+
+      end
+    end
+
+  end
+end

data/lib/asciidoctor-plantuml/version.rb

@@ -0,0 +1,5 @@
+module Asciidoctor
+  module PlantUML
+    VERSION = "0.0.2"
+  end
+end

data/test/test_plantuml.rb

@@ -0,0 +1,166 @@
+require "test/unit"
+require "asciidoctor"
+require "stringio"
+require "nokogiri"
+require "asciidoctor-plantuml"
+
+DOC_BASIC = <<-eos
+= Hello PlantUML!
+
+[plantuml, format="png", test="true"]
+User -> (Start)
+User --> (Use the application) : Label
+eos
+
+DOC_BASIC2 = <<-eos
+= Hello PlantUML!
+
+[plantuml, format="png", test="true"]
+@startuml
+User -> (Start)
+User --> (Use the application) : Label
+@enduml
+eos
+
+DOC_ID = <<-eos
+= Hello PlantUML!
+
+[plantuml, format="png", test="true", id="myId"]
+User -> (Start)
+User --> (Use the application) : Label
+eos
+
+DOC_DIM = <<-eos
+= Hello PlantUML!
+
+[plantuml, format="png", test="true", width="100px", height="50px"]
+User -> (Start)
+User --> (Use the application) : Label
+eos
+
+DOC_ALT = <<-eos
+= Hello PlantUML!
+
+[plantuml, format="png", test="true", alt="alt"]
+User -> (Start)
+User --> (Use the application) : Label
+eos
+
+DOC_BAD_FORMAT = <<-eos
+= Hello PlantUML!
+
+[plantuml, format="jpg", test="true"]
+User -> (Start)
+User --> (Use the application) : Label
+eos
+
+DOC_MULTI = <<-eos
+= Hello PlantUML!
+
+[plantuml, format="png", test="true"]
+User -> (Start)
+User --> (Use the application) : Label
+
+[plantuml, format="txt", test="true"]
+User -> (Start)
+User --> (Use the application) : Label
+eos
+
+class PlantUmlTest < Test::Unit::TestCase
+
+  GENURL = "http://localhost:8080/plantuml/png/U9npA2v9B2efpStX2YrEBLBGjLFG20Q9Q4Bv804WIw4a8rKXiQ0W9pCviIGpFqzJmKh19p4fDOVB8JKl1QWT05kd5wq0"
+
+  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
+
+    element = elements.first
+
+    assert_equal GENURL, element["src"]
+  end
+
+  def test_plantuml_block_processor2
+    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_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")
+    page = Nokogiri::HTML(html)
+
+    elements = page.css('img.plantuml')
+
+    assert_equal elements.size, 1
+    element = elements.first
+
+    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")
+    page = Nokogiri::HTML(html)
+
+    elements = page.css('img.plantuml')
+
+    assert_equal elements.size, 1
+    element = elements.first
+
+    assert_equal "alt", element["alt"]
+
+  end
+
+  def test_should_show_bad_format
+    html = ::Asciidoctor.convert(StringIO.new(DOC_BAD_FORMAT), backend: "html5")
+
+    page = Nokogiri::HTML(html)
+
+    elements = page.css('img.plantuml')
+    assert_equal elements.size, 0
+
+    elements = page.css('div.plantuml')
+    assert_equal elements.size, 1
+  end
+
+  def test_plantuml_multiple
+
+    html = ::Asciidoctor.convert(StringIO.new(DOC_MULTI), backend: "html5")
+    page = Nokogiri::HTML(html)
+
+    elements = page.css('img.plantuml')
+
+    assert_equal elements.size, 2
+
+  end
+
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: asciidoctor-plantuml
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Horacio Sanson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.5'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: asciidoctor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+description: Asciidoctor PlantUML extension
+email:
+- hsanson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/asciidoctor-plantuml.rb
+- lib/asciidoctor-plantuml/plantuml.rb
+- lib/asciidoctor-plantuml/version.rb
+- test/test_plantuml.rb
+homepage: https://github.com/hsanson/asciidoctor-plantuml
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: An extension for Asciidoctor that enables support for PlantUML diagrams.
+test_files:
+- test/test_plantuml.rb