asciidoctor-diagram 1.0.1

data/lib/asciidoctor-diagram/ditaa.rb

@@ -0,0 +1,7 @@
+require 'asciidoctor/extensions'
+require_relative 'version'
+
+Asciidoctor::Extensions.register do
+  require_relative 'ditaa/extension'
+  block :ditaa, Asciidoctor::Diagram::DitaaBlock
+end

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

@@ -0,0 +1,65 @@
+require_relative '../diagram'
+require_relative '../java'
+require_relative '../png'
+require_relative '../svg'
+
+module Asciidoctor
+  module Diagram
+    DITAA_JAR_PATH = File.expand_path File.join('../..', 'ditaamini0_9.jar'), File.dirname(__FILE__)
+
+    class DitaaBlock < DiagramBlock
+      option :contexts, [:listing, :literal, :open]
+      option :content_model, :simple
+      option :pos_attrs, ['target', 'format']
+      option :default_attrs, {'format' => 'png'}
+
+      def name
+        "Ditaa"
+      end
+
+      def allowed_formats
+        @allowed_formats ||= [:png]
+      end
+
+      def generate_image(parent, diagram_code, format)
+        ditaa(diagram_code)
+      end
+
+      private
+
+      Java.classpath << DITAA_JAR_PATH
+
+      def ditaa(code, *flags)
+        Java.load
+
+        cmd = ['-e', 'UTF-8']
+        cmd += flags if flags
+
+        bytes = code.encode(Encoding::UTF_8).bytes.to_a
+        bis = Java.java.io.ByteArrayInputStream.new(Java.array_to_java_array(bytes, :byte))
+        bos = Java.java.io.ByteArrayOutputStream.new
+        result_code = Java.org.stathissideris.ascii2image.core.CommandLineConverter.convert(Java.array_to_java_array(cmd, :string), bis, bos)
+        bis.close
+        bos.close
+
+        result = Java.string_from_java_bytes(bos.toByteArray)
+
+        raise "Ditaa image generation failed: #{result}" unless result_code == 0
+
+        result
+      end
+
+      def get_default_flags(parent)
+        flags = []
+
+        document = parent.document
+        config = document.attributes['plantumlconfig']
+        if config
+          flags += ['-config', File.expand_path(config, document.attributes['docdir'])]
+        end
+
+        flags
+      end
+    end
+  end
+end

data/lib/asciidoctor-diagram/java.rb

@@ -0,0 +1,5 @@
+if RUBY_PLATFORM == "java"
+  require_relative 'java_jruby'
+else
+  require_relative 'java_rjb'
+end

data/lib/asciidoctor-diagram/java_jruby.rb

@@ -0,0 +1,36 @@
+require 'java'
+
+module Asciidoctor
+  module Diagram
+    module Java
+      def self.classpath
+        @classpath ||= []
+      end
+
+      def self.load
+        if @loaded
+          return
+        end
+
+        classpath.each { |j| require j }
+        @loaded = true
+      end
+
+      def self.array_to_java_array(array, type)
+        array.to_java(type)
+      end
+
+      def self.string_from_java_bytes(bytes)
+        String.from_java_bytes(bytes)
+      end
+
+      def self.method_missing(meth, *args, &block)
+        raise "No arguments expected" unless args.empty?
+        raise "No block expected" if block
+
+        load
+        ::Java.send(meth)
+      end
+    end
+  end
+end

data/lib/asciidoctor-diagram/java_rjb.rb

@@ -0,0 +1,82 @@
+require 'rjb'
+
+module Asciidoctor
+  module Diagram
+    module Java
+      INITAWT_JAR_PATH = File.expand_path File.join('..', 'initawt.jar'), File.dirname(__FILE__)
+
+      module Package
+        def method_missing(meth, *args, &block)
+          raise "No arguments expected" unless args.empty?
+          raise "No block expected" if block
+
+          name = meth.to_s
+          @proxies ||= {}
+          @proxies[name] ||= create_java_proxy(name)
+        end
+
+        private
+
+        def create_java_proxy(name)
+          qualified_name = @name ? "#{@name}.#{name}" : name
+          if name =~ /^[[:upper:]]/
+            Package.create_class(qualified_name)
+          else
+            Package.create_package(qualified_name)
+          end
+        end
+
+        def self.create_class(name)
+          ::Rjb.import(name)
+        end
+
+        def self.create_package(name)
+          package = Module.new
+          package.extend Package
+          package.instance_variable_set :@name, name
+          package.instance_variable_set :@parent, name
+          package
+        end
+      end
+
+      def self.classpath
+        @classpath ||= []
+      end
+
+      def self.load
+        if @loaded
+          return
+        end
+
+        Rjb::load(classpath.join(File::PATH_SEPARATOR))
+
+        # On OS X using AWT from JNI is extremely deadlock prone. Enabling AWT headless mode resolves this issue. We're
+        # never actually going to display an AWT GUI, so this should be fairly safe.
+        Rjb::import('java.lang.System').setProperty 'java.awt.headless', 'true'
+
+        @loaded = true
+      end
+
+      def self.array_to_java_array(array, type)
+        # Rjb does not require an explicit conversion of a Ruby Array containing Ruby Strings to a Ruby Array containing
+        # Java Strings. It handles this implicitly when calling Java methods.
+        array
+      end
+
+      def self.string_from_java_bytes(bytes)
+        # Rjb implictly converts Java byte arrays to Ruby Strings so nothing needs to be done here
+        bytes
+      end
+
+      def self.method_missing(meth, *args, &block)
+        raise "No arguments expected" unless args.empty?
+        raise "No block expected" if block
+
+        load
+
+        @root_package ||= Package.send(:create_package, nil)
+        @root_package.send(meth, *args)
+      end
+    end
+  end
+end

data/lib/asciidoctor-diagram/plantuml.rb

@@ -0,0 +1,7 @@
+require 'asciidoctor/extensions'
+require_relative 'version'
+
+Asciidoctor::Extensions.register do
+  require_relative 'plantuml/extension'
+  block :plantuml, Asciidoctor::Diagram::PlantUmlBlock
+end

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

@@ -0,0 +1,88 @@
+require_relative '../diagram'
+require_relative '../java'
+require_relative '../png'
+require_relative '../svg'
+
+module Asciidoctor
+  module Diagram
+    PLANTUML_JAR_PATH = File.expand_path File.join('../..', 'plantuml.jar'), File.dirname(__FILE__)
+
+    class PlantUmlBlock < DiagramBlock
+      option :contexts, [:listing, :literal, :open]
+      option :content_model, :simple
+      option :pos_attrs, ['target', 'format']
+      option :default_attrs, {'format' => 'png'}
+
+      def name
+        "PlantUml"
+      end
+
+      def allowed_formats
+        @allowed_formats ||= [:svg, :png, :txt]
+      end
+
+      def generate_image(parent, diagram_code, format)
+        flags = get_default_flags(parent)
+        if format == :svg
+          flags << "-tsvg"
+        end
+
+        plantuml(diagram_code, *flags)
+      end
+
+      def generate_text(parent, diagram_code)
+        flags = get_default_flags(parent)
+        flags << '-tutxt'
+
+        plantuml(diagram_code, *flags)
+      end
+
+      private
+
+      Java.classpath << PLANTUML_JAR_PATH
+
+      def plantuml(code, *flags)
+        Java.load
+
+        code = "@startuml\n#{code}\n@enduml" unless code.index '@startuml'
+
+        # When the -pipe command line flag is used, PlantUML calls System.exit which kills our process. In order
+        # to avoid this we call some lower level components of PlantUML directly.
+        # This snippet of code corresponds approximately with net.sourceforge.plantuml.Run#managePipe
+        cmd = ['-charset', 'UTF-8', '-failonerror']
+        cmd += flags
+
+        option = Java.net.sourceforge.plantuml.Option.new(Java.array_to_java_array(cmd, :string))
+        source_reader = Java.net.sourceforge.plantuml.SourceStringReader.new(
+            Java.net.sourceforge.plantuml.preproc.Defines.new(),
+            code,
+            option.getConfig()
+        )
+
+        bos = Java.java.io.ByteArrayOutputStream.new
+        ps = Java.java.io.PrintStream.new(bos)
+        source_reader.generateImage(ps, 0, option.getFileFormatOption())
+        ps.close
+        Java.string_from_java_bytes(bos.toByteArray)
+      end
+
+      def get_default_flags(parent)
+        flags = []
+
+        document = parent.document
+        config = document.attributes['plantumlconfig']
+        if config
+          flags += ['-config', File.expand_path(config, document.attributes['docdir'])]
+        end
+
+        flags
+      end
+
+      def code_checksum(code)
+        md5 = Digest::MD5.new
+        md5 << code
+        md5.hexdigest
+      end
+    end
+  end
+end

data/lib/asciidoctor-diagram/png.rb

@@ -0,0 +1,24 @@
+require_relative 'binaryio'
+
+module Asciidoctor
+  module Diagram
+    module PNG
+      PNG_SIGNATURE = [137, 80, 78, 71, 13, 10, 26, 10].pack('CCCCCCCC')
+
+      def self.get_image_size(data)
+        bio = BinaryIO.new(data)
+        png_signature = bio.read_string(8)
+        raise "Invalid PNG signature" unless png_signature == PNG_SIGNATURE
+
+        chunk_length = bio.read_uint32_be
+        chunk_type = bio.read_string(4, Encoding::US_ASCII)
+        raise "Unexpected PNG chunk type '#{chunk_type}'; expected 'IHDR'" unless chunk_type == 'IHDR'
+        raise "Unexpected PNG chunk length '#{chunk_length}'; expected '13'" unless chunk_length == 13
+
+        width = bio.read_uint32_be
+        height = bio.read_uint32_be
+        [width, height]
+      end
+    end
+  end
+end

data/lib/asciidoctor-diagram/svg.rb

@@ -0,0 +1,18 @@
+require_relative 'binaryio'
+
+module Asciidoctor
+  module Diagram
+    module SVG
+      SVG_SIZE_REGEX = /style="width:(?<width>\d+)px;height:(?<height>\d+)px/
+
+      def self.get_image_size(data)
+        match_data = SVG_SIZE_REGEX.match(data)
+        if match_data
+          [match_data[:width].to_i, match_data[:height].to_i]
+        else
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/asciidoctor-diagram/version.rb

@@ -0,0 +1,5 @@
+module Asciidoctor
+  module Diagram
+    VERSION = "1.0.1"
+  end
+end

data/plantuml-license.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.