asciidoctor-diagram 1.3.2 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 13041fe1a06833bb670496dbe28c3fb3adf23ae2
-  data.tar.gz: 858a4b0482f58e3e4593a04dfd3e3fa3103632cb
+  metadata.gz: d373774bdb564cd5b002d0c09fa3473f9e5760c3
+  data.tar.gz: 37ac247cb289425bed03821a56573d7d2b45e9c4
 SHA512:
-  metadata.gz: 001e2013fe9d1b9263f2b015dd0cb62f1471b097204def7f216892643bff0b2324936690889234b5838c29ba5221cbdb16bec800119425ce8cbafa0dd22ee89a
-  data.tar.gz: ceeafbd38f5648f651aee4ee0d691f561392406c8222949058b8a377d34e38e78e3ace0b6cfc3a4769f8e1760d4a696bf39b06c0666ba9028f80ff5ced9b5243
+  metadata.gz: 40e342aa5f7f6625d260b7de22d0bc68dbfcc859b8f5d0dc0e260be05e937f3b39ded65596aabfc09dc084103d086aa8a5e8c75c7d913ee53fa4b9ea2d876a90
+  data.tar.gz: c5355e1ad0d749eb88204ac3b824cf53e91a6fa6f286fdc92a7a6b74655a6b9a40b2e300c2b62a1f23230fa43773279524552df8bdf0b97b89b7b2c2bac97ab3

data/CHANGELOG.adoc

@@ -1,5 +1,18 @@
 = Asciidoctor-diagram Changelog
 
+== 1.4.0
+
+Enhancements::
+
+  * Use wavedrom-cli when available
+  * Add meme generator
+
+Bug Fixes::
+
+  * Issue #71: Don't fail early for PlantUML diagrams if `dot` can't be found. PlantUML doesn't need it for all diagrams
+    types so invoke PlantUML without specifying the location of `dot` and let PlantUML produce an error when necessary.
+  * Issue #85: Support target attribute values containing one or more directory names.
+
 == 1.3.2
 
 Enhancements::

data/README.adoc

@@ -4,13 +4,16 @@ Pepijn Van_Eeckhoudt
 Asciidoctor Diagram is a set of extensions for http://asciidoctor.org[Asciidoctor], the Ruby-based AsciiDoc processor.
 These extensions allow you to embed plain text diagrams inside your AsciiDoc documents using one of the following syntaxes:
 
-- http://plantuml.sourceforge.net[PlantUML]
-- http://ditaa.sourceforge.net[Ditaa].
-- https://github.com/christiangoltz/shaape[Shaape]
 - http://blockdiag.com[BlockDiag, SeqDiag, ActDiag, NwDiag]
+- http://ditaa.sourceforge.net[Ditaa].
 - http://www.graphviz.org/content/dot-language[GraphViz DOT]
+- http://knsv.github.io/mermaid/[Mermaid]
+- http://plantuml.sourceforge.net[PlantUML]
+- https://github.com/christiangoltz/shaape[Shaape]
 - http://wavedrom.com[WaveDrom]
 
+Additionally Asciidoctor Diagram includes a basic meme generator extension.
+
 The extension takes care of running the diagram processor to generate the images from the input text and insert them into the rendered document.
 
 This gem was inspired by the https://code.google.com/p/asciidoc-plantuml/[AsciiDoc PlantUML filter] for AsciiDoc Python.
@@ -41,9 +44,12 @@ Or install it yourself as:
 
 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
+- Graphviz: the http://www.graphviz.org[Graphviz] package
+- Meme: http://www.imagemagick.org[ImageMagick]
+- Mermaid: the http://knsv.github.io/mermaid[Mermaid] CLI and http://phantomjs.org[PhantomJS] 1.9.x
+- PlantUML: http://www.graphviz.org[Graphviz] package for certain diagram types.
+- Shaape: the Shaape Python package
 - WaveDrom: the https://github.com/wavedrom/wavedrom.github.io/releases[WaveDrom editor] application
 
 == Usage
@@ -58,6 +64,8 @@ In your script you can then either require one or more of the following files:
 . `asciidoctor-diagram/blockdiag`: to enable the block/act/seq/nw diag extension
 . `asciidoctor-diagram/ditaa`: to enable the ditaa extension
 . `asciidoctor-diagram/graphviz`: to enable the graphviz extension
+. `asciidoctor-diagram/meme`: to enable the mermaid extension
+. `asciidoctor-diagram/mermaid`: to enable the mermaid 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
@@ -74,13 +82,16 @@ Once the extensions are enabled the following block types becomes available for
 - `blockdiag`, `actdiag`, `seqdiag`, `nwdiag`, `rackdiag` and `packetdiag`
 - `ditaa`
 - `graphviz`
+- `meme`
+- `mermaid`
 - `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.
+Detailed descriptions of the supported syntax inside these blocks is available on websites of the respective projects.
 
-At this point you can start adding diagrams to your application, like the following example:
+At this point you can start adding diagrams to your application.
+Here's an example to get you started:
 
 ----
 ["plantuml", "asciidoctor-diagram-classes", "png"]
@@ -96,16 +107,49 @@ DiagramBlock <|-- PlantUmlBlock
 ---------------------------------------------------------------------
 ----
 
-The diagram blocks support the following attributes:
+All the diagram blocks except `meme` support the following attributes:
 
-. `target` (or 2nd position): the basename of the file to generate. If not specified an auto-generated name will be used.
-. `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`.
+. `target` (1st positional attribute): the basename of the file to generate. If not specified an auto-generated name will be used.
+. `format` (2nd positional attribute): 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 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
+----
+
+If you don't want to embed your diagram code in your document then you can use the diagram extension as block macros.
+The target of diagram block macro should refer to the file containing the diagram source code.
+The attributes for the block macros are the same as for the inline blocks.
+The example above in block macro form becomes
+
+----
+plantuml::mydiagram.puml["asciidoctor-diagram-classes", "png"]
+----
+
+=== The meme extension
+
+The meme extension provides a basic 'Advice Animal' style image generator.
+It's usage is easiest to explain with an example.
+
+----
+meme::doge.jpg[Perhaps haters...,Just hate to \\ love?]
+----
+
+The target of the block macro tells the extension which image to use as background.
+The first two positional attributes are `top` and `bottom` and are used for the top and bottom label.
+Occurrences of ` \\ ` are interpreted as line breaks.
+
+The block macro also supports the following named attributes:
 
+. `fillColor`: the fill color for the text. Defaults to `white`.
+. `strokeColor`:  the outline color for the text. Defaults to `black`.
+. `strokeWidth`:  the width of the text outline. Defaults to `2`.
+. `font`: the font face to use for the text. Defaults to `Impact`.
+. `options`: a comma separate list of flags that modify the image rendering. Currently only `noupcase` is supported which disable upper casing the labels.
+. `target` (3rd positional attribute): the basename of the file to generate. If not specified an auto-generated name will be used.
+. `format` (4th positional attribute): the output image format. The meme extension supports `png` and `gif`.
 
 == Contributing
 

data/lib/asciidoctor-diagram.rb

@@ -1,6 +1,8 @@
 require 'asciidoctor-diagram/blockdiag'
 require 'asciidoctor-diagram/ditaa'
 require 'asciidoctor-diagram/graphviz'
+require 'asciidoctor-diagram/meme'
+require 'asciidoctor-diagram/mermaid'
 require 'asciidoctor-diagram/plantuml'
 require 'asciidoctor-diagram/salt'
 require 'asciidoctor-diagram/shaape'

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

@@ -92,7 +92,7 @@ module Asciidoctor
 
         [:png, :svg].each do |f|
           register_format(f, :image) do |c, p|
-            CliGenerator.generate_stdin(which(p, tool.downcase), c.to_s) do |tool_path, output_path|
+            CliGenerator.generate_stdin(which(p, tool.downcase), f.to_s, 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

@@ -73,16 +73,6 @@ module Asciidoctor
 
           @options = options.join(' ')
         end
-
-        def should_process?(image_file, image_metadata)
-          super(image_file, image_metadata) || image_metadata['options'] != @options
-        end
-
-        def create_image_metadata
-          metadata = super
-          metadata['options'] = @options
-          metadata
-        end
       end
     end
 

data/lib/asciidoctor-diagram/extensions.rb

@@ -3,6 +3,7 @@ require 'digest'
 require 'json'
 require 'fileutils'
 require_relative 'util/java'
+require_relative 'util/gif'
 require_relative 'util/png'
 require_relative 'util/svg'
 
@@ -64,6 +65,10 @@ module Asciidoctor
                 :encoding => Encoding::UTF_8,
                 :decoder => SVG
             },
+            :gif => {
+                :encoding => Encoding::ASCII_8BIT,
+                :decoder => GIF
+            },
             :png => {
                 :encoding => Encoding::ASCII_8BIT,
                 :decoder => PNG
@@ -159,7 +164,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.exist?(image_dir)
+            FileUtils.mkdir_p(File.dirname(image_file)) unless Dir.exist?(File.dirname(image_file))
             File.open(image_file, 'wb') { |f| f.write result }
             File.open(metadata_file, 'w') { |f| JSON.dump(metadata, f) }
           end
@@ -260,7 +265,7 @@ module Asciidoctor
         #
         # @return [FileSource] a FileSource
         def create_source(parent, target, attributes)
-          FileSource.new(File.expand_path(target, parent.document.base_dir), attributes)
+          FileSource.new(target.empty? ? nil : parent.normalize_system_path(target, parent.document.base_dir), attributes)
         end
       end
 
@@ -331,9 +336,14 @@ module Asciidoctor
           @checksum ||= compute_checksum(code)
         end
 
+        private
         def compute_checksum(code)
           md5 = Digest::MD5.new
           md5 << code
+          attributes.each do |k, v|
+            md5 << k.to_s if k
+            md5 << v.to_s if v
+          end
           md5.hexdigest
         end
       end
@@ -362,8 +372,10 @@ module Asciidoctor
         def image_name
           if @attributes['target']
             super
-          else
+          elsif @file_name
             File.basename(@file_name, File.extname(@file_name))
+          else
+            checksum
           end
         end
 
@@ -372,9 +384,13 @@ module Asciidoctor
         end
 
         def code
-          lines = File.readlines(@file_name)
-          lines = ::Asciidoctor::Helpers.normalize_lines(lines)
-          @code ||= lines.join("\n")
+          if @file_name
+            lines = File.readlines(@file_name)
+            lines = ::Asciidoctor::Helpers.normalize_lines(lines)
+            @code ||= lines.join("\n")
+          else
+            @code ||= ''
+          end
         end
       end
     end

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

@@ -11,7 +11,7 @@ module Asciidoctor
       def self.included(mod)
         [:png, :svg].each do |f|
           mod.register_format(f, :image) do |c, p|
-            CliGenerator.generate_stdin(which(p, 'dot', :attr_names => ['dot', 'graphvizdot']), c.to_s) do |tool_path, output_path|
+            CliGenerator.generate_stdin(which(p, 'dot', :attr_names => ['dot', 'graphvizdot']), f.to_s, c.to_s) do |tool_path, output_path|
               [tool_path, "-o#{output_path}", "-T#{f.to_s}"]
             end
           end

data/lib/asciidoctor-diagram/meme.rb

@@ -0,0 +1,8 @@
+require 'asciidoctor/extensions'
+require_relative 'version'
+
+Asciidoctor::Extensions.register do
+  require_relative 'meme/extension'
+
+  block_macro Asciidoctor::Diagram::MemeBlockMacroProcessor, :meme
+end

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

@@ -0,0 +1,116 @@
+require_relative '../extensions'
+require_relative '../util/cli_generator'
+require_relative '../util/which'
+require 'tempfile'
+require 'open3'
+
+module Asciidoctor
+  module Diagram
+    # @private
+    module Meme
+      include Which
+
+      def self.included(mod)
+        [:png, :gif].each do |format|
+          mod.register_format(format, :image) do |c, p|
+            convert = which(p, 'convert')
+            identify = which(p, 'identify')
+
+            attrs = c.attributes
+            bg_img = attrs["background"]
+            raise "background attribute is required" unless bg_img
+
+            bg_img = p.normalize_system_path(bg_img, p.document.attr('imagesdir'))
+
+            top_label = attrs["top"]
+            bottom_label = attrs["bottom"]
+            fill_color = attrs.fetch('fillColor', 'white')
+            stroke_color = attrs.fetch('strokeColor', 'black')
+            stroke_width = attrs.fetch('strokeWidth', '2')
+            font = attrs.fetch('font', 'Impact')
+            options = attrs.fetch('options', '').split(',')
+            noupcase = options.include?('noupcase')
+
+            dimensions = CliGenerator.run_cli(identify, '-format', '%w %h', bg_img).match /(?<w>\d+) (?<h>\d+)/
+            bg_width = dimensions['w'].to_i
+            bg_height = dimensions['h'].to_i
+            label_width = bg_width
+            label_height = bg_height / 5
+
+            if top_label
+              top_img = Tempfile.new(['meme', '.png'])
+              CliGenerator.run_cli(
+                  convert,
+                  '-background', 'none',
+                  '-fill', fill_color,
+                  '-stroke', stroke_color,
+                  '-strokewidth', stroke_width,
+                  '-font', font,
+                  '-size', "#{label_width}x#{label_height}",
+                  '-gravity', 'north',
+                  "label:#{prepare_label(top_label, noupcase)}",
+                  top_img.path
+              )
+            else
+              top_img = nil
+            end
+
+            if bottom_label
+              bottom_img = Tempfile.new(['meme', '.png'])
+              CliGenerator.run_cli(
+                  convert,
+                  '-background', 'none',
+                  '-fill', fill_color,
+                  '-stroke', stroke_color,
+                  '-strokewidth', stroke_width,
+                  '-font', font,
+                  '-size', "#{label_width}x#{label_height}",
+                  '-gravity', 'south',
+                  "label:#{prepare_label(bottom_label, noupcase)}",
+                  bottom_img.path
+              )
+            else
+              bottom_img = nil
+            end
+
+            final_img = Tempfile.new(['meme', ".#{format.to_s}"])
+
+            args = [convert, bg_img]
+            if top_img
+              args << top_img.path << '-geometry'<< '+0+0' << '-composite'
+            end
+
+            if bottom_img
+              args << bottom_img.path << '-geometry'<< "+0+#{bg_height - label_height}" << '-composite'
+            end
+
+            args << final_img.path
+
+            CliGenerator.run_cli(*args)
+
+            File.binread(final_img)
+          end
+        end
+      end
+
+      private
+      def prepare_label(label, noupcase)
+        label = label.upcase unless noupcase
+        label = label.gsub(' // ', '\n')
+        label
+      end
+    end
+
+    class MemeBlockMacroProcessor < Extensions::DiagramBlockMacroProcessor
+      include Meme
+
+      option :pos_attrs, %w(top bottom target format)
+
+      def create_source(parent, target, attributes)
+        attributes = attributes.dup
+        attributes['background'] = target
+        ::Asciidoctor::Diagram::Extensions::FileSource.new(nil, attributes)
+      end
+    end
+  end
+end

data/lib/asciidoctor-diagram/mermaid.rb

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

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

@@ -0,0 +1,57 @@
+require_relative '../extensions'
+require_relative '../util/cli_generator'
+require_relative '../util/which'
+
+module Asciidoctor
+  module Diagram
+    # @private
+    module Mermaid
+      include Which
+
+      def self.included(mod)
+        [:png, :svg].each do |f|
+          mod.register_format(f, :image) do |c, p|
+            mermaid = which(p, 'mermaid')
+
+            seq_config = c.attributes['sequenceConfig'] || p.attr('sequenceConfig')
+            if seq_config
+              seq_config = p.normalize_system_path(seq_config, p.document.base_dir)
+            end
+
+            width = c.attributes['width']
+
+            CliGenerator.generate_file(mermaid, f.to_s, c.to_s) do |tool_path, input_path, output_path|
+              output_dir = File.dirname(output_path)
+              output_file = File.expand_path(File.basename(input_path) + ".#{f.to_s}", output_dir)
+
+              args = [tool_path, "--#{f.to_s}", '-o', output_dir]
+
+              if seq_config
+                args << '--sequenceConfig' << seq_config
+              end
+
+              if width
+                args << '--width' << width
+              end
+
+              args << input_path
+
+              {
+                  :args => args,
+                  :out_file => output_file
+              }
+            end
+          end
+        end
+      end
+    end
+
+    class MermaidBlockProcessor < Extensions::DiagramBlockProcessor
+      include Mermaid
+    end
+
+    class MermaidBlockMacroProcessor < Extensions::DiagramBlockMacroProcessor
+      include Mermaid
+    end
+  end
+end