asciidoctor-diagram 1.5.3 → 1.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ed682b9f1a5ebc023f78291b9cb575ab954a7c98
-  data.tar.gz: fb35b25a74669f7eb1540a2733b7c667ba0f2859
+  metadata.gz: d38f932148312e67e4249a2c171c71da2c796a49
+  data.tar.gz: c50317e4443b383f73be0b3e068364185cba7a97
 SHA512:
-  metadata.gz: 29d512423d17e0cd4bb3c6f4ef21816e5716ad07e11df2059961c50a667d15a963521f6fe24b5702852d2610fededad4ab4b699aab5be52efed428e507deff6a
-  data.tar.gz: 21829e5be06344ea24a6a48c43968d71a8c2f51c4828acaf456b97d04f80141a2fc83cb731829dfdf7ef52682966c6b30891e5d9f823fcdc4f23558302339b95
+  metadata.gz: 9d8544bb90e946c5b20b9e675268e519cf52f9dd89a3b054b4214a9c1b3dff59d6ce9683569616c3ed9d81441dc089179cb559e1569b1c11e4d586f99d457a41
+  data.tar.gz: d26cbf53122d923276a543f49efe434ba8690fbb85ba0e44ced6c52bd4c24779fb110bcef1c3f03c29f5b731dfc15c4a30c06d78516742987815c70a6d6886ab

data/CHANGELOG.adoc

@@ -1,5 +1,16 @@
 = Asciidoctor-diagram Changelog
 
+== 1.5.4
+
+Enhancements::
+
+  * Add support for UMLet.
+  * Issue #141: Allow blockdiag fontpath to be specified via attributes
+
+Bug Fixes::
+
+  * Issue #140: Restore PNG as default format for Graphviz diagrams
+
 == 1.5.3
 
 Enhancements::

data/README.adoc

@@ -32,6 +32,7 @@ ifndef::env-site[:status:]
 :uri-rackdiag: http://blockdiag.com/en/nwdiag/index.html
 :uri-seqdiag: http://blockdiag.com/en/seqdiag/index.html
 :uri-shaape: https://github.com/christiangoltz/shaape
+:uri-umlet: http://www.umlet.com/
 :uri-wavedrom: http://wavedrom.com
 :uri-wavedromeditor: https://github.com/wavedrom/wavedrom.github.io/releases
 :uri-wavedromcli: https://github.com/wavedrom/cli
@@ -119,6 +120,7 @@ The following diagram types and output formats are available:
 |{uri-rackdiag}[rackdiag]    |       |{check}|{check}|{check}|
 |{uri-seqdiag}[seqdiag]      |       |{check}|{check}|{check}|
 |{uri-shaape}[shaape]        |       |       |{check}|{check}|
+|{uri-umlet}[umlet]          |{check}|{check}|{check}|{check}|
 |{uri-wavedrom}[wavedrom]    |       |       |{check}|{check}|
 |===
 
@@ -287,6 +289,7 @@ The following table lists the tools that are required for each diagram type, the
    |rackdiag     |{uri-nwdiag}[NwDiag]                                                  |`rackdiag`
    |seqdiag      |{uri-seqdiag}[SeqDiag]                                                |`seqdiag`
    |shaape       |{uri-shaape}[Shaape]                                                  |`shaape`
+   |umlet        |{uri-umlet}[Umlet]                                                    |`umlet`
 .2+|wavedrom     |{uri-wavedromeditor}[WaveDrom Editor]                                 |`wavedrom`
                  |{uri-wavedromcli}[WaveDrom CLI] and {uri-phantomjs}[PhantomJS]        |`wavedrom` and `phantomjs`
 |===
@@ -312,6 +315,36 @@ Occurrences of `\\` surrounded by whitespace are interpreted as line breaks.
 === Diagram Attributes
 
 Certain diagram types allow image generation to be customized using attributes.
+Each attribute can be specified either at the block level or at the document level.
+This is illustrated for the blockdiag `fontpath` attribute in the example below.
+
+----
+= Asciidoctor Diagram
+:blockdiag-fontpath: /path/to/font.ttf <1>
+
+[blockdiag] <2>
+....
+....
+
+[blockdiag, fontpath="/path/to/otherfont.ttf"] <3>
+....
+....
+----
+<1> Block level attributes can be specified at the document level by prefixing them with `<blocktype>-`
+<2> The first diagram does not specify an explicit value for `fontpath` so the global value will be used
+<3> The second diagram specifies a `fontpath` value which overrrides the global value
+
+Each attribute can either be specified at the block level or at the document level.
+The attribute name at the block level should be prefixed with the name of the diagram type and a dash.
+
+
+==== Blockdiag
+
+[cols=">,<,<",options="header"]
+|===
+|Name         |Default value   |Description
+|fontpath     |unspecified     |The path to the font that should be used by blockdiag
+|===
 
 ==== Ditaa
 

data/lib/asciidoctor-diagram.rb

@@ -7,4 +7,5 @@ require_relative 'asciidoctor-diagram/mermaid'
 require_relative 'asciidoctor-diagram/plantuml'
 require_relative 'asciidoctor-diagram/salt'
 require_relative 'asciidoctor-diagram/shaape'
+require_relative 'asciidoctor-diagram/umlet'
 require_relative 'asciidoctor-diagram/wavedrom'

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

@@ -106,8 +106,13 @@ module Asciidoctor
         # a '3' suffix.
         alt_cmd_name = "#{tool.downcase}3"
 
+        font_path = source.attr('fontpath', nil, tool.downcase)
+
         generate_stdin(which(parent, cmd_name, :alt_cmds => [alt_cmd_name]), format.to_s, source.to_s) do |tool_path, output_path|
-          [tool_path, '-a', '-o', Platform.native_path(output_path), "-T#{format.to_s}", '-']
+          args = [tool_path, '-a', '-o', Platform.native_path(output_path), "-T#{format.to_s}"]
+          args << "-f#{Platform.native_path(font_path)}" if font_path
+          args << '-'
+          args
         end
       end
     end

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

@@ -11,7 +11,7 @@ module Asciidoctor
       include Which
 
       def self.included(mod)
-        [:pdf, :png, :svg].each do |f|
+        [:png, :pdf, :svg].each do |f|
           mod.register_format(f, :image) do |parent, source|
             graphviz(parent, source, f)
           end

data/lib/asciidoctor-diagram/umlet.rb

@@ -0,0 +1,8 @@
+require_relative 'extensions'
+
+Asciidoctor::Extensions.register do
+  require_relative 'umlet/extension'
+
+  block Asciidoctor::Diagram::UmletBlockProcessor, :umlet
+  block_macro Asciidoctor::Diagram::UmletBlockMacroProcessor, :umlet
+end

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

@@ -0,0 +1,36 @@
+require_relative '../extensions'
+require_relative '../util/cli_generator'
+require_relative '../util/platform'
+require_relative '../util/which'
+
+module Asciidoctor
+  module Diagram
+    # @private
+    module Umlet
+      include CliGenerator
+      include Which
+
+      def self.included(mod)
+        [:svg, :png, :pdf, :gif].each do |f|
+          mod.register_format(f, :image) do |parent, source|
+            umlet(parent, source, f)
+          end
+        end
+      end
+
+      def umlet(parent, source, format)
+        generate_file(which(parent, 'umlet'), 'uxf', format.to_s, source.to_s) do |tool_path, input_path, output_path|
+          [tool_path, '-action=convert', "-format=#{format.to_s}", "-filename=#{Platform.native_path(input_path)}", "-output=#{Platform.native_path(output_path)}"]
+        end
+      end
+    end
+
+    class UmletBlockProcessor < Extensions::DiagramBlockProcessor
+      include Umlet
+    end
+
+    class UmletBlockMacroProcessor < Extensions::DiagramBlockMacroProcessor
+      include Umlet
+    end
+  end
+end

data/lib/asciidoctor-diagram/version.rb

@@ -1,5 +1,5 @@
 module Asciidoctor
   module Diagram
-    VERSION = "1.5.3"
+    VERSION = "1.5.4"
   end
 end

data/spec/test_helper.rb

@@ -14,6 +14,7 @@ require_relative '../lib/asciidoctor-diagram/meme/extension'
 require_relative '../lib/asciidoctor-diagram/mermaid/extension'
 require_relative '../lib/asciidoctor-diagram/plantuml/extension'
 require_relative '../lib/asciidoctor-diagram/shaape/extension'
+require_relative '../lib/asciidoctor-diagram/umlet/extension'
 require_relative '../lib/asciidoctor-diagram/wavedrom/extension'
 
 require_relative '../lib/asciidoctor-diagram/util/platform'
@@ -42,9 +43,24 @@ module Asciidoctor
         options = options.dup
         options[:trace] = true
         options[:attributes] ||= {}
+
         options[:attributes]['phantomjs_19'] = ENV['PHANTOMJS_19']
+
         options[:attributes]['phantomjs_2'] = ENV['PHANTOMJS_2']
+
+        fontpath = ENV['BLOCKDIAG_FONTPATH']
+        if fontpath
+          options[:attributes]['actdiag-fontpath'] = fontpath
+          options[:attributes]['blockdiag-fontpath'] = fontpath
+          options[:attributes]['seqdiag-fontpath'] = fontpath
+          options[:attributes]['nwdiag-fontpath'] = fontpath
+          options[:attributes]['rackdiag-fontpath'] = fontpath
+          options[:attributes]['packetdiag-fontpath'] = fontpath
+          options[:attributes]['seqdiag-fontpath'] = fontpath
+        end
+
         options[:attributes]['diagram-on-error'] = 'abort'
+
         ::Asciidoctor.load(StringIO.new(source), options.merge({:trace => true}))
       end
     end

data/spec/umlet_spec.rb

@@ -0,0 +1,85 @@
+require_relative 'test_helper'
+
+code = <<-eos
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<diagram program="umlet" version="14.2">
+  <zoom_level>10</zoom_level>
+  <element>
+    <id>UMLActor</id>
+    <coordinates>
+      <x>20</x>
+      <y>20</y>
+      <w>60</w>
+      <h>120</h>
+    </coordinates>
+    <panel_attributes>Hello
+AsciiDoc</panel_attributes>
+    <additional_attributes/>
+  </element>
+</diagram>
+eos
+
+
+describe Asciidoctor::Diagram::UmletBlockMacroProcessor do
+  it "should generate SVG images when format omitted" do
+    File.write('umlet.uxf', code)
+
+    doc = <<-eos
+= Hello, Umlet!
+Doc Writer <doc@example.com>
+
+== First Section
+
+umlet::umlet.uxf[]
+    eos
+    
+    d = load_asciidoc doc
+    expect(d).to_not be_nil
+  
+    b = d.find { |bl| bl.context == :image }
+    expect(b).to_not be_nil
+
+    expect(b.content_model).to eq :empty
+
+    target = b.attributes['target']
+    expect(target).to_not be_nil
+    expect(target).to match(/\.svg$/)
+    expect(File.exist?(target)).to be true
+
+    expect(b.attributes['width']).to_not be_nil
+    expect(b.attributes['height']).to_not be_nil
+  end
+end
+
+
+describe Asciidoctor::Diagram::UmletBlockProcessor do
+  it "should generate SVG images when format is omitted" do
+    doc = <<-eos
+= Hello, Umlet!
+Doc Writer <doc@example.com>
+
+== First Section
+
+[umlet]
+----
+#{code}
+----
+    eos
+    
+    d = load_asciidoc doc
+    expect(d).to_not be_nil
+  
+    b = d.find { |bl| bl.context == :image }
+    expect(b).to_not be_nil
+
+    expect(b.content_model).to eq :empty
+
+    target = b.attributes['target']
+    expect(target).to_not be_nil
+    expect(target).to match(/\.svg$/)
+    expect(File.exist?(target)).to be true
+
+    expect(b.attributes['width']).to_not be_nil
+    expect(b.attributes['height']).to_not be_nil
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-diagram
 version: !ruby/object:Gem::Version
-  version: 1.5.3
+  version: 1.5.4
 platform: ruby
 authors:
 - Pepijn Van Eeckhoudt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-03 00:00:00.000000000 Z
+date: 2017-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -104,6 +104,8 @@ files:
 - lib/asciidoctor-diagram/salt.rb
 - lib/asciidoctor-diagram/shaape.rb
 - lib/asciidoctor-diagram/shaape/extension.rb
+- lib/asciidoctor-diagram/umlet.rb
+- lib/asciidoctor-diagram/umlet/extension.rb
 - lib/asciidoctor-diagram/util/binaryio.rb
 - lib/asciidoctor-diagram/util/cli.rb
 - lib/asciidoctor-diagram/util/cli_generator.rb
@@ -131,6 +133,7 @@ files:
 - spec/plantuml_spec.rb
 - spec/shaape_spec.rb
 - spec/test_helper.rb
+- spec/umlet_spec.rb
 - spec/wavedrom_spec.rb
 homepage: https://github.com/asciidoctor/asciidoctor-diagram
 licenses:
@@ -168,4 +171,5 @@ test_files:
 - spec/plantuml_spec.rb
 - spec/shaape_spec.rb
 - spec/test_helper.rb
+- spec/umlet_spec.rb
 - spec/wavedrom_spec.rb