asciidoctor-diagram 1.3.1 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2aa855d0a4d2453cb80b237827e331367c52121f
-  data.tar.gz: 68ad84950f5592103d829ee8518d20aa2a7f0de2
+  metadata.gz: 13041fe1a06833bb670496dbe28c3fb3adf23ae2
+  data.tar.gz: 858a4b0482f58e3e4593a04dfd3e3fa3103632cb
 SHA512:
-  metadata.gz: ae3dc63dd88b9c307687505b0c7d6c41c127e8d25d9abd45683b0aa712753a5bee6d902df8b505b7a925c1557239309ff35c0f0b9a753e351044c5f0b8db6824
-  data.tar.gz: 8e2c8d867b1e1a91093305aa2d8cbbd3cdcb15c78279e1de99ee3833809ed0651e46bb7958953d3d145e1a151941356a10a8ba4f1e872cadeff260b1ed45b931
+  metadata.gz: 001e2013fe9d1b9263f2b015dd0cb62f1471b097204def7f216892643bff0b2324936690889234b5838c29ba5221cbdb16bec800119425ce8cbafa0dd22ee89a
+  data.tar.gz: ceeafbd38f5648f651aee4ee0d691f561392406c8222949058b8a377d34e38e78e3ace0b6cfc3a4769f8e1760d4a696bf39b06c0666ba9028f80ff5ced9b5243

data/CHANGELOG.adoc

@@ -1,5 +1,20 @@
 = Asciidoctor-diagram Changelog
 
+== 1.3.2
+
+Enhancements::
+
+  * Add support for WaveDrom diagrams (requires WaveDrom Editor to be installed separately)
+  * Allow error handling to be controlled using the `diagram-on-error` attribute.
+    Setting this attribute to `log` (default) logs an error message and continues processing of the document.
+    Setting it to `abort` triggers an exception and aborts document processing.
+  * Resolve relative image references in PlantUML diagrams to absolute ones up front to ensure PlantUML can locate the images
+
+Bug Fixes::
+
+  * Issue #83: Omit stack trace information from error message that gets embedded in the output document
+  * Issue #84: Restore support for specifying the location of the `dot` executable using the `graphvizdot` attribute
+
 == 1.3.1
 
 Bug Fixes::

data/README.adoc

@@ -9,6 +9,7 @@ These extensions allow you to embed plain text diagrams inside your AsciiDoc doc
 - https://github.com/christiangoltz/shaape[Shaape]
 - http://blockdiag.com[BlockDiag, SeqDiag, ActDiag, NwDiag]
 - http://www.graphviz.org/content/dot-language[GraphViz DOT]
+- http://wavedrom.com[WaveDrom]
 
 The extension takes care of running the diagram processor to generate the images from the input text and insert them into the rendered document.
 
@@ -43,6 +44,7 @@ Certain diagram types require other tools to be installed seperately.
 - PlantUML and Graphviz: the Graphviz `dot` tool.
 - Shaape: the Shaape Python package
 - Block/Seq/Act/Nw diag: the block/seq/act/nw diag Python packages
+- WaveDrom: the https://github.com/wavedrom/wavedrom.github.io/releases[WaveDrom editor] application
 
 == Usage
 
@@ -58,6 +60,7 @@ In your script you can then either require one or more of the following files:
 . `asciidoctor-diagram/graphviz`: to enable the graphviz extension
 . `asciidoctor-diagram/plantuml`: to enable the plantuml extension
 . `asciidoctor-diagram/shaape`: to enable the shaape extension
+. `asciidoctor-diagram/wavedrom`: to enable the wavedrom extension
 
 Requiring one or more of these files will automatically register the extensions for all processed documents.
 If you need more fine grained control over when the extensions are enabled or not, `asciidoctor-diagram/ditaa/extension`, `asciidoctor-diagram/graphviz/extension` and `asciidoctor-diagram/plantuml/extension` can be used instead.
@@ -73,6 +76,7 @@ Once the extensions are enabled the following block types becomes available for
 - `graphviz`
 - `plantuml`
 - `shaape`
+- `wavedrom`
 
 Detailed descriptions of the supported syntax inside these blocks is available on the http://plantuml.sourceforge.net/[PlantUML], http://www.graphviz.org/content/dot-language[Graphviz] and http://ditaa.sourceforge.net/[ditaa] websites.
 
@@ -98,7 +102,7 @@ The diagram blocks support the following attributes:
 . `format` (or 3rd position): the output format. PlantUML blocks support `png`, `svg` and `txt`. Graphviz, Shaape and BlockDiag support `png` and `svg`. Ditaa only supports `png`.
 
 Once you have all of this in place and your original AsciiDoc file contains a diagram block, it's time to build it into an HTML file with Asciidoctor Diagram magic! 
-When executing Asciidoctor, you must reference the Adciidoctor Diagram library, otherwise your diagam blocks won't be recognized as such. When executing Asciidoctor from the command line, do it using the -r parameter to reference this external library:
+When executing Asciidoctor, you must reference the Adciidoctor Diagram library, otherwise your diagram blocks won't be recognized as such. When executing Asciidoctor from the command line, do it using the -r parameter to reference this external library:
 
 $ asciidoctor -r asciidoctor-diagram doc.adoc
 

data/lib/asciidoctor-diagram.rb

@@ -3,4 +3,5 @@ require 'asciidoctor-diagram/ditaa'
 require 'asciidoctor-diagram/graphviz'
 require 'asciidoctor-diagram/plantuml'
 require 'asciidoctor-diagram/salt'
-require 'asciidoctor-diagram/shaape'
+require 'asciidoctor-diagram/shaape'
+require 'asciidoctor-diagram/wavedrom'

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

@@ -1,24 +1,9 @@
 require_relative '../extensions'
 require_relative '../util/cli_generator'
+require_relative '../util/which'
 
 module Asciidoctor
   module Diagram
-    # @private
-    module BlockDiag
-      def self.define_processors(name, &init)
-        block = Class.new(Extensions::DiagramBlockProcessor) do
-          self.instance_eval &init
-        end
-        ::Asciidoctor::Diagram.const_set("#{name}BlockProcessor", block)
-
-        block_macro = Class.new(Extensions::DiagramBlockMacroProcessor) do
-          self.instance_eval &init
-        end
-
-        ::Asciidoctor::Diagram.const_set("#{name}BlockMacroProcessor", block_macro)
-      end
-    end
-
     # @!parse
     #   # Block processor converts blockdiag code into images.
     #   #
@@ -84,11 +69,30 @@ module Asciidoctor
     #   #
     #   # Supports PNG and SVG output.
     #   class PacketDiagBlockMacroProcessor < API::DiagramBlockMacroProcessor; end
+
+    # @private
+    module BlockDiag
+      def self.define_processors(name, &init)
+        block = Class.new(Extensions::DiagramBlockProcessor) do
+          self.instance_eval &init
+        end
+        ::Asciidoctor::Diagram.const_set("#{name}BlockProcessor", block)
+
+        block_macro = Class.new(Extensions::DiagramBlockMacroProcessor) do
+          self.instance_eval &init
+        end
+
+        ::Asciidoctor::Diagram.const_set("#{name}BlockMacroProcessor", block_macro)
+      end
+    end
+
     ['BlockDiag', 'SeqDiag', 'ActDiag', 'NwDiag', 'RackDiag', 'PacketDiag'].each do |tool|
       BlockDiag.define_processors(tool) do
+        include Which
+
         [:png, :svg].each do |f|
           register_format(f, :image) do |c, p|
-            CliGenerator.generate(tool.downcase, p, c.to_s) do |tool_path, output_path|
+            CliGenerator.generate_stdin(which(p, tool.downcase), c.to_s) do |tool_path, output_path|
               [tool_path, '-o', output_path, "-T#{f.to_s}", '-']
             end
           end

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

@@ -24,7 +24,7 @@ module Asciidoctor
         )
 
         unless response[:code] == 200
-          raise "Ditaa image generation failed: #{response[:reason]} #{response[:body]}"
+          raise Java.create_error("Ditaa image generation failed", response)
         end
 
         response[:body]

data/lib/asciidoctor-diagram/extensions.rb

@@ -103,11 +103,17 @@ module Asciidoctor
                 create_image_block(parent, source, format, generator_info)
             end
           rescue => e
-            text = "Failed to generate image: #{e.message}"
-            warn %(asciidoctor-diagram: ERROR: #{text})
-            text << "\n"
-            text << source.code
-            Asciidoctor::Block.new parent, :listing, :source => text, :attributes => attributes
+            case parent.attr('diagram-on-error') || 'log'
+              when 'abort'
+                raise e
+              else
+                text = "Failed to generate image: #{e.message}"
+                warn %(asciidoctor-diagram: ERROR: #{text})
+                text << "\n"
+                text << source.code
+                Asciidoctor::Block.new parent, :listing, :source => text, :attributes => attributes
+            end
+
           end
         end
 
@@ -153,7 +159,7 @@ module Asciidoctor
             metadata = source.create_image_metadata
             metadata['width'], metadata['height'] = params[:decoder].get_image_size(result)
 
-            FileUtils.mkdir_p(image_dir) unless Dir.exists?(image_dir)
+            FileUtils.mkdir_p(image_dir) unless Dir.exist?(image_dir)
             File.open(image_file, 'wb') { |f| f.write result }
             File.open(metadata_file, 'w') { |f| JSON.dump(metadata, f) }
           end

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

@@ -1,14 +1,17 @@
 require_relative '../extensions'
 require_relative '../util/cli_generator'
+require_relative '../util/which'
 
 module Asciidoctor
   module Diagram
     # @private
     module Graphviz
+      include Which
+
       def self.included(mod)
         [:png, :svg].each do |f|
           mod.register_format(f, :image) do |c, p|
-            CliGenerator.generate('dot', p, c.to_s) do |tool_path, output_path|
+            CliGenerator.generate_stdin(which(p, 'dot', :attr_names => ['dot', 'graphvizdot']), c.to_s) do |tool_path, output_path|
               [tool_path, "-o#{output_path}", "-T#{f.to_s}"]
             end
           end

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

@@ -1,4 +1,5 @@
 require_relative '../extensions'
+require_relative '../util/which'
 
 module Asciidoctor
   module Diagram
@@ -14,7 +15,7 @@ module Asciidoctor
       def plantuml(parent, code, tag, mime_type)
         Java.load
 
-        code = "@start#{tag}\n#{code}\n@end#{tag}" unless code.index "@start#{tag}"
+        code = preprocess_code(parent, code, tag)
 
         headers = {
             'Accept' => mime_type
@@ -32,12 +33,31 @@ module Asciidoctor
         )
 
         unless response[:code] == 200
-          raise "PlantUML image generation failed: #{response[:reason]} #{response[:body]}"
+          raise Java.create_error("PlantUML image generation failed", response)
         end
 
         response[:body]
       end
 
+      def preprocess_code(parent, code, tag)
+        code = "@start#{tag}\n#{code}\n@end#{tag}" unless code.index "@start#{tag}"
+
+        code.gsub!(/(?<=<img:)[^>]+(?=>)/) do |match|
+          if match =~ URI.regexp
+            uri = URI.parse(match)
+            if uri.scheme == 'file'
+              parent.normalize_system_path(uri.path, parent.attr('imagesdir'))
+            else
+              parent.normalize_web_path(match)
+            end
+          else
+            parent.normalize_system_path(match, parent.attr('imagesdir'))
+          end
+        end
+
+        code
+      end
+
       def self.included(mod)
         mod.register_format(:png, :image) do |c, p|
           plantuml(p, c.to_s, mod.tag, 'image/png')

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

@@ -1,14 +1,17 @@
 require_relative '../extensions'
 require_relative '../util/cli_generator'
+require_relative '../util/which'
 
 module Asciidoctor
   module Diagram
     # @private
     module Shaape
+      include Which
+
       def self.included(mod)
         [:png, :svg].each do |f|
           mod.register_format(f, :image) do |c, p|
-            CliGenerator.generate('shaape', p, c.to_s) do |tool_path, output_path|
+            CliGenerator.generate_stdin(which(p, 'shaape'), c.to_s) do |tool_path, output_path|
               [tool_path, '-o', output_path, '-t', f.to_s, '-']
             end
           end

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

@@ -1,41 +1,57 @@
 require 'tempfile'
 
-require_relative '../util/java'
-require_relative '../util/which'
-
 module Asciidoctor
   module Diagram
     # @private
     module CliGenerator
-      def self.generate(tool, parent, code)
-        tool_var = '@' + tool
-
-        tool_path = instance_variable_get(tool_var)
-        unless tool_path
-          tool_path = parent.document.attributes[tool]
-          tool_path = ::Asciidoctor::Diagram.which(tool) unless tool_path && File.executable?(tool_path)
-          raise "Could not find the '#{tool}' executable in PATH; add it to the PATH or specify its location using the '#{tool}' document attribute" unless tool_path
-          instance_variable_set(tool_var, tool_path)
-        end
+      def self.generate_stdin(tool, code)
+        tool_name = File.basename(tool)
 
-        target_file = Tempfile.new(tool)
+        target_file = Tempfile.new(tool_name)
         begin
           target_file.close
 
-          args = yield tool_path, target_file.path
+          args = yield tool, target_file.path
 
           IO.popen(args, "w") do |io|
             io.write code
           end
           result_code = $?
 
-          raise "#{tool} image generation failed" unless result_code == 0
+          raise "#{tool_name} image generation failed" unless result_code == 0
 
           File.binread(target_file.path)
         ensure
           target_file.unlink
         end
       end
+
+      def self.generate_file(tool, code)
+        tool_name = File.basename(tool)
+
+        source_file = Tempfile.new(tool_name)
+        begin
+          File.write(source_file.path, code)
+
+          target_file = Tempfile.new(tool_name)
+          begin
+            target_file.close
+
+            args = yield tool, source_file.path, target_file.path
+
+            system(*args)
+            result_code = $?
+
+            raise "#{tool_name} image generation failed" unless result_code == 0
+
+            File.binread(target_file.path)
+          ensure
+            target_file.unlink
+          end
+        ensure
+          source_file.unlink
+        end
+      end
     end
   end
 end

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

@@ -1,10 +1,12 @@
+require 'json'
+
 module Asciidoctor
   module Diagram
     # @private
     module Java
       def self.classpath
         @classpath ||= [
-            File.expand_path(File.join('../..', 'asciidoctor-diagram-java-1.3.4.jar'), File.dirname(__FILE__))
+            File.expand_path(File.join('../..', 'asciidoctor-diagram-java-1.3.7.jar'), File.dirname(__FILE__))
         ]
       end
 
@@ -70,6 +72,22 @@ module Asciidoctor
 
         resp
       end
+
+      def self.create_error(prefix_msg, response)
+        content_type = response[:headers]['Content-Type'] || 'text/plain'
+        if content_type.start_with? 'application/json'
+          json = JSON.parse(response[:body].force_encoding(Encoding::UTF_8))
+          ruby_bt = Kernel.caller(2)
+          java_bt = json['stk'].map { |java_line| "#{java_line[0]}:#{java_line[3]}: in `#{java_line[2]}'" }
+          error = RuntimeError.new("#{prefix_msg}: #{json['msg']}")
+          error.set_backtrace java_bt + ruby_bt
+          raise error
+        elsif content_type.start_with? 'text/plain'
+          raise "#{prefix_msg}: #{response[:reason]} #{response[:body].force_encoding(Encoding::UTF_8)}"
+        else
+          raise "#{prefix_msg}: #{response[:reason]}"
+        end
+      end
     end
   end
 end

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

@@ -16,7 +16,7 @@ module Asciidoctor
           args << '-cp'
           # special case for cygwin, it requires path translation for java to work
           if RbConfig::CONFIG['host_os'] =~ /cygwin/i
-            cygpath = ::Asciidoctor::Diagram.which('cygpath')
+            cygpath = ::Asciidoctor::Diagram::Which.which('cygpath')
             if(cygpath != nil) 
               args << classpath.flatten.map { |jar| `cygpath -w "#{jar}"`.strip }.join(";")
             else
@@ -79,13 +79,13 @@ module Asciidoctor
       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')
+          path_to(ENV['JAVA_HOME'], 'bin/java.exe') || registry_lookup || ::Asciidoctor::Diagram::Which.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')
+          path_to(ENV['JAVA_HOME'], 'bin/java') || path_to(`/usr/libexec/java_home`.strip, 'bin/java') || ::Asciidoctor::Diagram::Which.which('java')
         else
           # Other unix-like system
-          path_to(ENV['JAVA_HOME'], 'bin/java') || ::Asciidoctor::Diagram.which('java')
+          path_to(ENV['JAVA_HOME'], 'bin/java') || ::Asciidoctor::Diagram::Which.which('java')
         end
       end
 

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

@@ -1,15 +1,34 @@
 module Asciidoctor
   module Diagram
-    # @private
-    def self.which(cmd)
-      exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
-      ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
-        exts.each { |ext|
-          exe = File.join(path, "#{cmd}#{ext}")
-          return exe if File.executable? exe
-        }
+    module Which
+      # @private
+      def self.which(cmd, options = {})
+        exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
+
+        paths = (options[:path] || []) + ENV['PATH'].split(File::PATH_SEPARATOR)
+        paths.each do |path|
+          exts.each { |ext|
+            exe = File.join(path, "#{cmd}#{ext}")
+            return exe if File.executable? exe
+          }
+        end
+        nil
+      end
+
+      def which(parent_block, cmd, options = {})
+        attr_names = options[:attr_names] || [cmd]
+
+        cmd_var = '@' + attr_names[0]
+
+        cmd_path = instance_variable_get(cmd_var)
+        unless cmd_path
+          cmd_path = attr_names.map { |attr_name| parent_block.document.attributes[attr_name] }.find { |attr| !attr.nil? }
+          cmd_path = ::Asciidoctor::Diagram::Which.which(cmd, :path => options[:path]) unless cmd_path && File.executable?(cmd_path)
+          raise "Could not find the '#{cmd}' executable in PATH; add it to the PATH or specify its location using the '#{attr_names[0]}' document attribute" unless cmd_path
+          instance_variable_set(cmd_var, cmd_path)
+        end
+        cmd_path
       end
-      nil
     end
   end
 end

data/lib/asciidoctor-diagram/version.rb

@@ -1,5 +1,5 @@
 module Asciidoctor
   module Diagram
-    VERSION = "1.3.1"
+    VERSION = "1.3.2"
   end
 end

data/lib/asciidoctor-diagram/wavedrom.rb

@@ -0,0 +1,9 @@
+require 'asciidoctor/extensions'
+require_relative 'version'
+
+Asciidoctor::Extensions.register do
+  require_relative 'wavedrom/extension'
+
+  block Asciidoctor::Diagram::WavedromBlockProcessor, :wavedrom
+  block_macro Asciidoctor::Diagram::WavedromBlockMacroProcessor, :wavedrom
+end

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

@@ -0,0 +1,39 @@
+require_relative '../extensions'
+require_relative '../util/cli_generator'
+require_relative '../util/which'
+
+module Asciidoctor
+  module Diagram
+    # @private
+    module Wavedrom
+      include Which
+
+      def self.included(mod)
+        [:png, :svg].each do |f|
+          mod.register_format(f, :image) do |c, p|
+            if /darwin/ =~ RUBY_PLATFORM
+              wavedrom = which(p, 'WaveDromEditor.app', :attr_names => ['wavedrom'], :path => ['/Applications'])
+              if wavedrom
+                wavedrom = File.join(wavedrom, 'Contents/MacOS/nwjs')
+              end
+            else
+              wavedrom = which(p, 'WaveDromEditor', :attr_names => ['wavedrom'])
+            end
+
+            CliGenerator.generate_file(wavedrom, c.to_s) do |tool_path, input_path, output_path|
+              [tool_path, 'source', input_path, f.to_s, output_path]
+            end
+          end
+        end
+      end
+    end
+
+    class WavedromBlockProcessor < Extensions::DiagramBlockProcessor
+      include Wavedrom
+    end
+
+    class WavedromBlockMacroProcessor < Extensions::DiagramBlockMacroProcessor
+      include Wavedrom
+    end
+  end
+end

data/spec/blockdiag_spec.rb

@@ -133,6 +133,7 @@ blockdiag::blockdiag.txt
 
     d = Asciidoctor.load StringIO.new(doc)
     b = d.find { |b| b.context == :image }
+    expect(b).to_not be_nil
     target = b.attributes['target']
     mtime1 = File.mtime(target)
 

data/spec/plantuml_spec.rb

@@ -485,4 +485,31 @@ A -> B
     expect(scaled_image.attributes['width']).to be_within(1).of(unscaled_image.attributes['width'] * 1.5)
     expect(scaled_image.attributes['height']).to be_within(1).of(unscaled_image.attributes['height'] * 1.5)
   end
+
+  it "should handle embedded creole images correctly" do
+    creole_doc = <<-eos
+= Hello, PlantUML!
+Doc Writer <doc@example.com>
+
+== First Section
+
+[plantuml, format="png"]
+----
+:* You can change <color:red>text color</color>
+* You can change <back:cadetblue>background color</back>
+* You can change <size:18>size</size>
+* You use <u>legacy</u> <b>HTML <i>tag</i></b>
+* You use <u:red>color</u> <s:green>in HTML</s> <w:#0000FF>tag</w>
+* Use image : <img:sourceforge.jpg>
+* Use image : <img:http://www.foo.bar/sourceforge.jpg>
+* Use image : <img:file:///sourceforge.jpg>
+
+;
+----
+    eos
+
+    Asciidoctor.load StringIO.new(creole_doc), :attributes => {'backend' => 'html5'}
+
+    # No real way to assert this since PlantUML doesn't produce an error on file not found
+  end
 end

data/spec/shaape_spec.rb

@@ -1,6 +1,6 @@
 require_relative 'test_helper'
 
-describe Asciidoctor::Diagram::ShaapeBlockMacroProcessor do
+describe Asciidoctor::Diagram::ShaapeBlockMacroProcessor, :broken => /darwin/ =~ RUBY_PLATFORM do
   it "should generate PNG images when format is set to 'png'" do
     code = <<-eos
     +--------+    +-------------+
@@ -40,7 +40,7 @@ shaape::shaape.txt[format="png"]
   end
 end
 
-describe Asciidoctor::Diagram::ShaapeBlockProcessor do
+describe Asciidoctor::Diagram::ShaapeBlockProcessor, :broken => /darwin/ =~ RUBY_PLATFORM do
   it "should generate PNG images when format is set to 'png'" do
     doc = <<-eos
 = Hello, Shaape!
@@ -159,6 +159,7 @@ shaape::shaape.txt
 
     d = Asciidoctor.load StringIO.new(doc)
     b = d.find { |b| b.context == :image }
+    expect(b).to_not be_nil
     target = b.attributes['target']
     mtime1 = File.mtime(target)
 

data/spec/test_helper.rb

@@ -11,6 +11,7 @@ require_relative '../lib/asciidoctor-diagram/ditaa/extension'
 require_relative '../lib/asciidoctor-diagram/graphviz/extension'
 require_relative '../lib/asciidoctor-diagram/plantuml/extension'
 require_relative '../lib/asciidoctor-diagram/shaape/extension'
+require_relative '../lib/asciidoctor-diagram/wavedrom/extension'
 
 module Asciidoctor
   class AbstractBlock
@@ -30,6 +31,8 @@ module Asciidoctor
 end
 
 RSpec.configure do |c|
+  c.filter_run_excluding :broken => true
+
   TEST_DIR = File.expand_path('testing')
 
   c.before(:suite) do

data/spec/wavedrom_spec.rb

@@ -0,0 +1,214 @@
+require_relative 'test_helper'
+
+code = <<-eos
+{ signal : [
+  { name: "clk",  wave: "p......" },
+  { name: "bus",  wave: "x.34.5x",   data: "head body tail" },
+  { name: "wire", wave: "0.1..0." },
+]}
+eos
+
+describe Asciidoctor::Diagram::WavedromBlockMacroProcessor, :broken => true do
+  it "should generate PNG images when format is set to 'png'" do
+    File.write('wavedrom.txt', code)
+
+    doc = <<-eos
+= Hello, Wavedrom!
+Doc Writer <doc@example.com>
+
+== First Section
+
+wavedrom::wavedrom.txt[format="png"]
+    eos
+
+    d = Asciidoctor.load StringIO.new(doc)
+    expect(d).to_not be_nil
+
+    b = d.find { |b| b.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 /\.png$/
+    expect(File.exists?(target)).to be true
+
+    expect(b.attributes['width']).to_not be_nil
+    expect(b.attributes['height']).to_not be_nil
+  end
+
+  it "should generate SVG images when format is set to 'svg'" do
+    File.write('wavedrom.txt', code)
+
+    doc = <<-eos
+= Hello, Wavedrom!
+Doc Writer <doc@example.com>
+
+== First Section
+
+wavedrom::wavedrom.txt[format="svg"]
+    eos
+
+    d = Asciidoctor.load StringIO.new(doc)
+    expect(d).to_not be_nil
+
+    b = d.find { |b| b.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.exists?(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::WavedromBlockProcessor, :broken => true do
+  it "should generate PNG images when format is set to 'png'" do
+    doc = <<-eos
+= Hello, Wavedrom!
+Doc Writer <doc@example.com>
+
+== First Section
+
+[wavedrom, format="png"]
+----
+#{code}
+----
+    eos
+
+    d = Asciidoctor.load StringIO.new(doc)
+    expect(d).to_not be_nil
+
+    b = d.find { |b| b.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 /\.png$/
+    expect(File.exists?(target)).to be true
+
+    expect(b.attributes['width']).to_not be_nil
+    expect(b.attributes['height']).to_not be_nil
+  end
+
+  it "should generate SVG images when format is set to 'svg'" do
+    doc = <<-eos
+= Hello, Wavedrom!
+Doc Writer <doc@example.com>
+
+== First Section
+
+[wavedrom, format="svg"]
+----
+#{code}
+----
+    eos
+
+    d = Asciidoctor.load StringIO.new(doc)
+    expect(d).to_not be_nil
+
+    b = d.find { |b| b.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.exists?(target)).to be true
+
+    expect(b.attributes['width']).to_not be_nil
+    expect(b.attributes['height']).to_not be_nil
+  end
+
+  it "should raise an error when when format is set to an invalid value" do
+    doc = <<-eos
+= Hello, Wavedrom!
+Doc Writer <doc@example.com>
+
+== First Section
+
+[wavedrom, format="foobar"]
+----
+----
+    eos
+
+    expect { Asciidoctor.load StringIO.new(doc) }.to raise_error /support.*format/i
+  end
+
+  it "should not regenerate images when source has not changed" do
+    File.write('wavedrom.txt', code)
+
+    doc = <<-eos
+= Hello, Wavedrom!
+Doc Writer <doc@example.com>
+
+== First Section
+
+wavedrom::wavedrom.txt
+
+[wavedrom, format="png"]
+----
+#{code}
+----
+    eos
+
+    d = Asciidoctor.load StringIO.new(doc)
+    b = d.find { |b| b.context == :image }
+    expect(b).to_not be_nil
+    target = b.attributes['target']
+    mtime1 = File.mtime(target)
+
+    sleep 1
+
+    d = Asciidoctor.load StringIO.new(doc)
+
+    mtime2 = File.mtime(target)
+
+    expect(mtime2).to eq mtime1
+  end
+
+  it "should handle two block macros with the same source" do
+    File.write('wavedrom.txt', code)
+
+    doc = <<-eos
+= Hello, Wavedrom!
+Doc Writer <doc@example.com>
+
+== First Section
+
+wavedrom::wavedrom.txt[]
+wavedrom::wavedrom.txt[]
+    eos
+
+    Asciidoctor.load StringIO.new(doc)
+    expect(File.exists?('wavedrom.png')).to be true
+  end
+
+  it "should respect target attribute in block macros" do
+    File.write('wavedrom.txt', code)
+
+    doc = <<-eos
+= Hello, Wavedrom!
+Doc Writer <doc@example.com>
+
+== First Section
+
+wavedrom::wavedrom.txt["foobar"]
+wavedrom::wavedrom.txt["foobaz"]
+    eos
+
+    Asciidoctor.load StringIO.new(doc)
+    expect(File.exists?('foobar.png')).to be true
+    expect(File.exists?('foobaz.png')).to be true
+    expect(File.exists?('wavedrom.png')).to be false
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-diagram
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.2
 platform: ruby
 authors:
 - Pepijn Van Eeckhoudt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-30 00:00:00.000000000 Z
+date: 2016-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -81,7 +81,7 @@ files:
 - examples/README.adoc
 - examples/design.adoc
 - examples/features.adoc
-- lib/asciidoctor-diagram-java-1.3.4.jar
+- lib/asciidoctor-diagram-java-1.3.7.jar
 - lib/asciidoctor-diagram.rb
 - lib/asciidoctor-diagram/blockdiag.rb
 - lib/asciidoctor-diagram/blockdiag/extension.rb
@@ -104,6 +104,8 @@ files:
 - lib/asciidoctor-diagram/util/svg.rb
 - lib/asciidoctor-diagram/util/which.rb
 - lib/asciidoctor-diagram/version.rb
+- lib/asciidoctor-diagram/wavedrom.rb
+- lib/asciidoctor-diagram/wavedrom/extension.rb
 - lib/ditaamini-0.10.jar
 - lib/plantuml.jar
 - spec/blockdiag_spec.rb
@@ -112,6 +114,7 @@ files:
 - spec/plantuml_spec.rb
 - spec/shaape_spec.rb
 - spec/test_helper.rb
+- spec/wavedrom_spec.rb
 homepage: https://github.com/asciidoctor/asciidoctor-diagram
 licenses:
 - MIT
@@ -144,4 +147,5 @@ test_files:
 - spec/plantuml_spec.rb
 - spec/shaape_spec.rb
 - spec/test_helper.rb
+- spec/wavedrom_spec.rb
 has_rdoc: