asciidoctor-diagram 1.3.0.preview.1 → 1.3.0.preview.2

data/CHANGELOG.adoc

@@ -9,6 +9,7 @@ Enhancements::
   * Add support for Seqdiag diagrams (requires Seqdiag to be installed separately)
   * Add support for Nwdiag diagrams (requires Nwdiag to be installed separately)
   * Updated PlantUML to revision 8004 (23/08/2014)
+  * Remove dependency on RJB to simplify installation
 
 == 1.2.0
 

data/Rakefile

@@ -5,9 +5,5 @@ RSpec::Core::RakeTask.new(:test)
 
 task :default => :test
 
-['ruby', 'java'].map do |platform|
-  $platform = platform
-  Gem::Specification.reset
-  spec = Gem::Specification.load('asciidoctor-diagram.gemspec')
-  Gem::PackageTask.new(spec) { |task| }
-end
+spec = Gem::Specification.load('asciidoctor-diagram.gemspec')
+Gem::PackageTask.new(spec) { |task| }

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

@@ -5,26 +5,22 @@ module Asciidoctor
   module Diagram
     # @private
     module Ditaa
-      DITAA_JAR_PATH = File.expand_path File.join('../..', 'ditaamini0_9.jar'), File.dirname(__FILE__)
-      Java.classpath << DITAA_JAR_PATH
+      JARS = ['ditaamini0_9.jar'].map do |jar|
+        File.expand_path File.join('../..', jar), File.dirname(__FILE__)
+      end
+      Java.classpath.concat JARS
 
       def ditaa(code)
         Java.load
 
-        args = ['-e', 'UTF-8']
-
-        bytes = code.encode(Encoding::UTF_8).bytes.to_a
-        bis = Java.new_object(Java.java.io.ByteArrayInputStream, '[B', Java.array_to_java_array(bytes, :byte))
-        bos = Java.new_object(Java.java.io.ByteArrayOutputStream)
-        result_code = Java.org.stathissideris.ascii2image.core.CommandLineConverter.convert(Java.array_to_java_array(args, :string), bis, bos)
-        bis.close
-        bos.close
-
-        result = Java.string_from_java_bytes(bos.toByteArray)
+        response = Java.send_request(
+            :url => '/ditaa',
+            :body => code
+        )
 
-        raise "Ditaa image generation failed: #{result}" unless result_code == 0
+        raise "Ditaa image generation failed: #{response[:reason]}" unless response[:code] == 200
 
-        result
+        response[:body]
       end
 
       def self.included(mod)

data/lib/asciidoctor-diagram/extensions.rb

@@ -123,8 +123,7 @@ module Asciidoctor
         private
         def create_image_block(parent, source, attributes, format, generator_info)
           image_name = "#{source.image_name}.#{format}"
-          outdir = parent.document.attr('imagesoutdir') || parent.document.attr('outdir')
-          image_dir = parent.normalize_system_path parent.document.attr 'imagesdir', outdir
+          image_dir = image_output_dir(parent)
           image_file = parent.normalize_system_path image_name, image_dir
           metadata_file = parent.normalize_system_path "#{image_name}.cache", image_dir
 
@@ -158,7 +157,7 @@ module Asciidoctor
           image_attributes['alt'] ||= if title_text = attributes['title']
                                         title_text
                                       elsif target = attributes['target']
-                                        (File.basename target, (File.extname target) || '').tr '_-', ' '
+                                        (File.basename(target, File.extname(target)) || '').tr '_-', ' '
                                       else
                                         'Diagram'
                                       end
@@ -166,6 +165,21 @@ module Asciidoctor
           Asciidoctor::Block.new parent, :image, :content_model => :empty, :attributes => image_attributes
         end
 
+        def image_output_dir(parent)
+          document = parent.document
+
+          images_dir = document.attr('imagesoutdir')
+
+          if images_dir
+            base_dir = nil
+          else
+            base_dir = document.attr('outdir') || (document.respond_to?(:options) && document.options[:to_dir])
+            images_dir = document.attr('imagesdir')
+          end
+
+          parent.normalize_system_path(images_dir, base_dir)
+        end
+
         def create_literal_block(parent, source, attributes, generator_info)
           literal_attributes = attributes.dup
           literal_attributes.delete('target')

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

@@ -6,61 +6,45 @@ module Asciidoctor
     module PlantUml
       private
 
-      PLANTUML_JAR_PATH = File.expand_path File.join('../..', 'plantuml.jar'), File.dirname(__FILE__)
-      Java.classpath << PLANTUML_JAR_PATH
-
-      def plantuml(parent, code, tag, *flags)
-        unless @graphvizdot
-          @graphvizdot = parent.document.attributes['dot']
-          @graphvizdot = ::Asciidoctor::Diagram.which('dot') unless @graphvizdot && File.executable?(@graphvizdot)
-          raise "Could not find the Graphviz 'dot' executable in PATH; add it to the PATH or specify its location using the 'dot' document attribute" unless @graphvizdot
-        end
+      JARS = ['plantuml.jar'].map do |jar|
+        File.expand_path File.join('../..', jar), File.dirname(__FILE__)
+      end
+      Java.classpath.concat JARS
 
+      def plantuml(parent, code, tag, mime_type)
         Java.load
 
         code = "@start#{tag}\n#{code}\n@end#{tag}" unless code.index "@start#{tag}"
 
-        flags += ['-charset', 'UTF-8', '-failonerror', '-graphvizdot', @graphvizdot]
+        headers = {
+            'Accept' => mime_type
+        }
 
         config_file = parent.document.attributes['plantumlconfig']
         if config_file
-          flags += ['-config', File.expand_path(config_file, parent.document.attributes['docdir'])]
+          headers['X-PlantUML-Config'] = File.expand_path(config_file, parent.document.attributes['docdir'])
         end
 
-        option = Java.new_object( Java.net.sourceforge.plantuml.Option, '[Ljava.lang.String;', Java.array_to_java_array(flags, :string) )
-        source_reader = Java.new_object( Java.net.sourceforge.plantuml.SourceStringReader,
-                                         'Lnet.sourceforge.plantuml.preproc.Defines;Ljava.lang.String;Ljava.util.List;',
-                                         Java.new_object( Java.net.sourceforge.plantuml.preproc.Defines ),
-                                         code,
-                                         option.getConfig()
+        response = Java.send_request(
+            :url => '/plantuml',
+            :body => code,
+            :headers => headers
         )
 
-        bos = Java.new_object( Java.java.io.ByteArrayOutputStream )
-        ps = Java.new_object( Java.java.io.PrintStream, 'Ljava.io.OutputStream;', bos )
-        source_reader.generateImage(ps, 0, option.getFileFormatOption())
-        ps.close
-        Java.string_from_java_bytes(bos.toByteArray)
-      end
-
-      def config_args(parent)
-        config_args = []
-        config = parent.document.attributes['plantumlconfig']
-        if config
-          config_args += ['-config', File.expand_path(config, parent.document.attributes['docdir'])]
-        end
+        raise "PlantUML image generation failed: #{response[:reason]}" unless response[:code] == 200
 
-        config_args
+        response[:body]
       end
 
       def self.included(mod)
         mod.register_format(:png, :image) do |c, p|
-          plantuml(p, c.to_s, 'uml', *config_args(p))
+          plantuml(p, c.to_s, 'uml', 'image/png')
         end
         mod.register_format(:svg, :image) do |c, p|
-          plantuml(p, c.to_s, 'uml', '-tsvg', *config_args(p))
+          plantuml(p, c.to_s, 'uml', 'image/svg+xml')
         end
         mod.register_format(:txt, :literal) do |c, p|
-          plantuml(p, c.to_s, 'uml', '-tutxt', *config_args(p))
+          plantuml(p, c.to_s, 'uml', 'text/plain;charset=utf-8')
         end
       end
     end

data/lib/asciidoctor-diagram/util/java.rb

@@ -1,5 +1,81 @@
+module Asciidoctor
+  module Diagram
+    # @private
+    module Java
+      def self.classpath
+        @classpath ||= [
+            File.expand_path(File.join('../..', 'asciidoctor-diagram-java-1.3.1.jar'), File.dirname(__FILE__))
+        ]
+      end
+
+      CRLF = "\r\n".encode(Encoding::US_ASCII)
+
+      def self.format_request(req, io)
+        io.set_encoding Encoding::US_ASCII
+        io.write "POST #{req[:url]} HTTP/1.1"
+        io.write CRLF
+
+        headers = req[:headers]
+        if headers
+          headers.each_pair do |key, value|
+            io.write "#{key}: #{value}"
+            io.write CRLF
+          end
+        end
+
+        if req[:body]
+          unless headers && headers['Content-Length']
+            io.write 'Content-Length: '
+            io.write req[:body].bytesize.to_s
+            io.write CRLF
+          end
+
+          unless headers && headers['Content-Type']
+            io.write 'Content-Type: text/plain; charset='
+            io.write req[:body].encoding.name
+            io.write CRLF
+          end
+        end
+
+        io.write CRLF
+
+        io.set_encoding Encoding::BINARY
+        io.write req[:body]
+      end
+
+      STATUS_LINE = Regexp.new("HTTP/1.1 (\\d+) (.*)\r\n".encode(Encoding::US_ASCII))
+
+      def self.parse_response(io)
+        resp = {}
+
+        io.set_encoding Encoding::US_ASCII
+        status_line = io.readline(CRLF)
+        status_line_parts = STATUS_LINE.match status_line
+        resp[:code] = status_line_parts[1].to_i
+        resp[:reason] = status_line_parts[2]
+
+        headers = {}
+        until (header = io.readline(CRLF).strip).empty?
+          key, value = header.split ':', 2
+          headers[key] = value.strip
+        end
+
+        resp[:headers] = headers
+
+        content_length = headers['Content-Length']
+        if content_length
+          io.set_encoding Encoding::BINARY
+          resp[:body] = io.read(content_length.to_i)
+        end
+
+        resp
+      end
+    end
+  end
+end
+
 if RUBY_PLATFORM == "java"
   require_relative 'java_jruby'
 else
-  require_relative 'java_rjb'
+  require_relative 'java_socket'
 end

data/lib/asciidoctor-diagram/util/java_jruby.rb

@@ -1,40 +1,33 @@
 require 'java'
+require 'stringio'
 
 module Asciidoctor
   module Diagram
     # @private
     module Java
-      def self.classpath
-        @classpath ||= []
-      end
-
       def self.load
         if @loaded
           return
         end
 
-        classpath.each { |j| require j }
+        classpath.flatten.each { |j| require j }
         @loaded = true
       end
 
-      def self.array_to_java_array(array, type)
-        array.to_java(type)
-      end
+      def self.send_request(req)
+        cp = ::Java.org.asciidoctor.diagram.CommandProcessor.new()
 
-      def self.string_from_java_bytes(bytes)
-        String.from_java_bytes(bytes)
-      end
+        req_io = StringIO.new
+        format_request(req, req_io)
+        req_io.close
 
-      def self.method_missing(meth, *args, &block)
-        raise "No arguments expected" unless args.empty?
-        raise "No block expected" if block
+        response = cp.processRequest(req_io.string.to_java_bytes)
 
-        load
-        ::Java.send(meth)
-      end
+        resp_io = StringIO.new(String.from_java_bytes(response))
+        resp = parse_response(resp_io)
+        resp_io.close
 
-      def self.new_object(java_class, signature = nil, *args)
-        java_class.new(*args)
+        resp
       end
     end
   end

data/lib/asciidoctor-diagram/util/java_socket.rb

@@ -0,0 +1,93 @@
+require 'socket'
+
+require_relative 'which'
+
+module Asciidoctor
+  module Diagram
+    # @private
+    module Java
+      class CommandServer
+        attr_reader :port
+
+        def initialize(java, classpath)
+          args = []
+          args << '-Djava.awt.headless=true'
+          args << '-cp'
+          args << classpath.flatten.join(File::PATH_SEPARATOR)
+          args << 'org.asciidoctor.diagram.CommandServer'
+
+          @server = IO.popen([java, *args])
+          @port = @server.readline.strip.to_i
+          @client = TCPSocket.new 'localhost', port
+        end
+
+        def io
+          @client
+        end
+      end
+
+      def self.load
+        if @loaded
+          return
+        end
+
+        command_server
+        @loaded = true
+      end
+
+      def self.command_server
+        @java_exe ||= find_java
+        raise "Could not find Java executable" unless @java_exe
+        @command_server ||= CommandServer.new(@java_exe, classpath)
+      end
+
+      def self.send_request(req)
+        svr = command_server
+        headers = req[:headers] ||= {}
+        headers['Host'] = "localhost:#{svr.port}"
+        format_request(req, svr.io)
+        parse_response(svr.io)
+      end
+
+      private
+      def self.find_java
+        if /cygwin|mswin|mingw|bccwin|wince|emx/ =~ RUBY_PLATFORM
+          # Windows
+          path_to(ENV['JAVA_HOME'], 'bin/java.exe') || registry_lookup || ::Asciidoctor::Diagram.which('java')
+        elsif /darwin/ =~ RUBY_PLATFORM
+          # Mac
+          path_to(ENV['JAVA_HOME'], 'bin/java') || path_to(`/usr/libexec/java_home`.strip, 'bin/java') || ::Asciidoctor::Diagram.which('java')
+        else
+          # Other unix-like system
+          path_to(ENV['JAVA_HOME'], 'bin/java') || ::Asciidoctor::Diagram.which('java')
+        end
+      end
+
+      def self.path_to(java_home, java_binary)
+        exe_path = File.expand_path(java_binary, java_home)
+        if File.executable?(exe_path)
+          exe_path
+        else
+          nil
+        end
+      end
+
+      def self.registry_lookup
+        key_re = /^HKEY_LOCAL_MACHINE\\SOFTWARE\\JavaSoft\\.*\\([0-9\.]+)/
+        value_re = /\s*JavaHome\s*REG_SZ\s*(.*)/
+        result = `reg query "HKEY_LOCAL_MACHINE\\SOFTWARE\\JavaSoft" /s /v JavaHome`.lines.map { |l| l.strip }
+        vms = result.each_slice(3).map do |_, key, value|
+          key_match = key_re.match(key)
+          value_match = value_re.match(value)
+          if key_match && value_match
+            [key_match[1].split('.').map { |v| v.to_i }, value_match[1]]
+          else
+            nil
+          end
+        end.reject { |v| v.nil? }.sort_by { |v| v[0] }
+        java_exes = vms.map { |version, path| File.expand_path('bin/java.exe', path) }.select { |exe| File.executable?(exe) }
+        java_exes && java_exes[0]
+      end
+    end
+  end
+end

data/lib/asciidoctor-diagram/version.rb

@@ -1,5 +1,5 @@
 module Asciidoctor
   module Diagram
-    VERSION = "1.3.0.preview.1"
+    VERSION = "1.3.0.preview.2"
   end
 end

data/spec/plantuml_spec.rb

@@ -297,6 +297,31 @@ Foo1 -> Foo2 : To boundary
     expect(File.exists?(File.expand_path(target, 'foo'))).to be true
   end
 
+  it "should write files to imagesoutdir if set" do
+    doc = <<-eos
+= Hello, PlantUML!
+Doc Writer <doc@example.com>
+
+== First Section
+
+[plantuml, format="svg"]
+----
+actor Foo1
+boundary Foo2
+Foo1 -> Foo2 : To boundary
+----
+    eos
+
+    d = Asciidoctor.load StringIO.new(doc), {:attributes => {'imagesoutdir' => 'bar', 'outdir' => 'foo'}}
+    b = d.find { |b| b.context == :image }
+
+    target = b.attributes['target']
+    expect(target).to_not be_nil
+    expect(File.exists?(target)).to be false
+    expect(File.exists?(File.expand_path(target, 'bar'))).to be true
+    expect(File.exists?(File.expand_path(target, 'foo'))).to be false
+  end
+
   it "should omit width/height attributes when generating docbook" do
     doc = <<-eos
 = Hello, PlantUML!

metadata

@@ -1,18 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-diagram
 version: !ruby/object:Gem::Version
-  version: 1.3.0.preview.1
+  version: 1.3.0.preview.2
+  prerelease: 6
 platform: ruby
 authors:
 - Pepijn Van Eeckhoudt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-02 00:00:00.000000000 Z
+date: 2014-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -20,6 +22,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -27,34 +30,39 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: asciidoctor
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -62,24 +70,11 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.5.0
-- !ruby/object:Gem::Dependency
-  name: rjb
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.4.8
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.4.8
 description: Asciidoctor diagramming extension
 email:
 - pepijn@vaneeckhoudt.net
@@ -95,6 +90,7 @@ files:
 - examples/README.adoc
 - examples/design.adoc
 - examples/features.adoc
+- lib/asciidoctor-diagram-java-1.3.1.jar
 - lib/asciidoctor-diagram.rb
 - lib/asciidoctor-diagram/blockdiag.rb
 - lib/asciidoctor-diagram/blockdiag/extension.rb
@@ -111,7 +107,7 @@ files:
 - lib/asciidoctor-diagram/util/cli_generator.rb
 - lib/asciidoctor-diagram/util/java.rb
 - lib/asciidoctor-diagram/util/java_jruby.rb
-- lib/asciidoctor-diagram/util/java_rjb.rb
+- lib/asciidoctor-diagram/util/java_socket.rb
 - lib/asciidoctor-diagram/util/png.rb
 - lib/asciidoctor-diagram/util/svg.rb
 - lib/asciidoctor-diagram/util/which.rb
@@ -127,26 +123,27 @@ files:
 homepage: https://github.com/asciidoctor/asciidoctor-diagram
 licenses:
 - MIT
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>'
+  - - ! '>'
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 1.8.23.2
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: An extension for asciidoctor that adds support for UML diagram generation
   using PlantUML
 test_files:

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: ec30717e348b864e01a962749e47514a55c1106c
-  data.tar.gz: 3d85e72167829121d471faa6f20586cc2eb1eab4
-SHA512:
-  metadata.gz: daedbb3ba7ef2bc7517ba7c67052a6ee9e468adf5a5ca710bbc3ca80f3dbdf078748b679696d95f791121e651f920d25bdf039e88ace183fde759f32c18b75ba
-  data.tar.gz: ff54af102f2a7d21eefa591f4db10985826c97f2eff4044bb305a91f2c0cc888f5d965fddea4bba4f75ad96ed03baa2f5bcca8edf6e952d664c5cd8663183cd7

data/lib/asciidoctor-diagram/util/java_rjb.rb

@@ -1,91 +0,0 @@
-require 'rjb'
-
-module Asciidoctor
-  module Diagram
-    # @private
-    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
-
-      def self.new_object(java_class, signature = nil, *args)
-        if signature
-          java_class.new_with_sig(signature, *args)
-        else
-          java_class.new(*args)
-        end
-      end
-    end
-  end
-end