jekyll-diagrams 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52a77bb73a18b1e0b3d922615f50a062ce500c7f7ad1d220b3f648ad1cba8ba1
-  data.tar.gz: 45b4d1695a7494c8a4ecfd70b0d32f33dd31007b1d63408d44f5762d5fb47639
+  metadata.gz: 939c351c21994ececde693c60b108ddd81d8fd98f3dacc11a7722b8972f294bf
+  data.tar.gz: cb597bafa191ce822a239ab565718ae4efce683204bd45a39ed4e61f656e6b91
 SHA512:
-  metadata.gz: 012db758b38a586e03675b7af7c37ae88628361180d5ad1dd09aa6fb029c1cbd80eb98710542de4a490796cb45303aa1c5b3377536d2a8bfddf23cbc4fd80ba1
-  data.tar.gz: 0b62461401ae935a95c74e34412bcdb159ddf7b5f8c83d478e496d103f65d6643b7279ea12d98e8a9cdd6387e922a2c2aec1db1a6b4081d2d26324e9dea5bf19
+  metadata.gz: f19c1dd680ffdd9f11af3ea082e38759d120b63d163ecd9bba19ab27cfd185c08eca82ee036ae9f675597ccd58db60eabecac8abb9d0dfdf7f78b312ecc1e6fa
+  data.tar.gz: f6675947274f26d32558e06446ed3617fda8c183287aa54df9835df9446fccdcbb1d8eb7fa3126751ba70192f0e5de1b3b4362ccbf46fe4bb60eebe17a4130c4

data/.gitignore

@@ -5,3 +5,4 @@
 /test/dest/
 /test/fixtures/.jekyll-cache/
 /tmp/
+/*.gem

data/.travis.yml

@@ -4,10 +4,12 @@ rvm:
   - 2.4
   - 2.5
   - 2.6
+  - 2.7
 
 addons:
   apt:
     packages:
+      - default-jre
       - graphviz
       - python3
       - python3-pip
@@ -15,4 +17,4 @@ addons:
 
 before_install:
   - sudo pip3 install blockdiag seqdiag actdiag nwdiag
-  - gem update --system && gem install bundler
+  - gem update --system && gem install bundler

data/Gemfile

@@ -1,3 +1,3 @@
 source 'https://rubygems.org'
 
-gemspec
+gemspec

data/LICENSE

@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+THE SOFTWARE.

data/README.md

@@ -9,6 +9,7 @@ Jekyll Diagrams is a jekyll plugins for creating amazing diagrams, including:
 
 - Graphviz
 - Blockdiag, Seqdiag, Actdiag and Nwdiag
+- PlantUML
 
 ## Installation
 
@@ -47,7 +48,7 @@ plugins:
 
 You need first install graphviz with package manager on your system. Then you can use `graphviz` Liquid Tag to create amazing Graphviz images!
 
-```
+```text
 {% graphviz %}
 digraph {
   node [shape=circle, style=filled];
@@ -64,6 +65,26 @@ digraph {
 {% endgraphviz %}
 ```
 
+#### Configuration
+
+A simple configuration example is shown below:
+
+```yaml
+jekyll-diagrams:
+  graphviz:
+    default_layout: dot
+    graph_attribute: color=red
+    node_attribute:
+      - color=blue
+      - fillcolor=red
+    edge_attribute:
+      color: red
+      fillcolor: blue
+```
+
+- `default_layout`: Change the default layout here.
+- `graph/node/edge_attribute`: Default graph/node/edge attribute, can be String(when just one attribute), Array or Hash.
+
 ### Blockdiag
 
 Blockdiag contains:
@@ -77,7 +98,7 @@ Blockdiag contains:
 
 You need first install it and set path properly to make sure your system can find it. Then you can use `blockdiag`, `seqdiag`, `actdiag`, `nwdiag`, `rackdiag`, `packetdiag` Liquid Tag.
 
-```
+```text
 {% blockdiag %}
 blockdiag {
    A -> B -> C -> D;
@@ -88,7 +109,7 @@ blockdiag {
 
 And `seqdiag`:
 
-```
+```text
 {% seqdiag %}
 seqdiag {
   browser  -> webserver [label = "GET /index.html"];
@@ -101,27 +122,32 @@ seqdiag {
 {% endseqdiag %}
 ```
 
-## Configuration
-
-You can to provide a configuration, this is optional.
-
-A simple example configuration is shown below:
+#### Configuration
 
 ```yaml
-diagrams:
-  graphviz:
-    engine: dot
+jekyll-diagrams:
   blockdiag:
-    options: '--antialias'
+    antialias: true
+    config: configuration_file
+    font: your_custom_font
+    fontmap: your_custom_font
+    size: 320x400
 ```
 
-### Graphviz
+### PlantUML
 
-`engine` is the default image render engine. Default is set to `dot`.
+```text
+{% plantuml %}
+@startuml
+class Car
 
-### Blockdiag
+Driver - Car : drives >
+Car *- Wheel : have 4 >
+Car -- Person : < owns
 
-`options` is the command line options, and will be appended to the command.
+@enduml
+{% endplantuml %}
+```
 
 ## Contributing
 
@@ -129,4 +155,4 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/zhuste
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -7,4 +7,4 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList['test/**/*_test.rb']
 end
 
-task default: :test
+task default: :test

data/jekyll-diagrams.gemspec

@@ -5,24 +5,21 @@ require 'jekyll-diagrams/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'jekyll-diagrams'
-  spec.summary       = 'Jekyll plugins for diagrams support'
   spec.version       = Jekyll::Diagrams::VERSION
   spec.authors       = ['zhustec']
   spec.email         = ['zhustec@foxmail.com']
   spec.homepage      = 'https://github.com/zhustec/jekyll-diagrams'
+  spec.description   = 'Jekyll plugins for diagrams support.'
+  spec.summary       = 'Jekyll plugins for diagrams support, including Graphviz, Blockdiag, PlantUML and so on.'
   spec.license       = 'MIT'
-  spec.description   = 'Jekyll plugins for diagrams support, including Graphviz, Blockdiag, Seqdiag and so on.'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.test_files    = spec.files.grep(%r!^(test|spec|features)!)
-
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.3.0'
-
   spec.add_dependency 'jekyll', '>= 3.7', '< 5.0'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'minitest', '~> 5.0'
-end
+end

data/lib/jekyll-diagrams.rb

@@ -1 +1,6 @@
-require 'jekyll/diagrams'
+require_relative 'jekyll-diagrams/util'
+require_relative 'jekyll-diagrams/renderer'
+require_relative 'jekyll-diagrams/block'
+require_relative 'jekyll-diagrams/blockdiag'
+require_relative 'jekyll-diagrams/graphviz'
+require_relative 'jekyll-diagrams/plantuml'

data/lib/jekyll-diagrams/block.rb

@@ -0,0 +1,24 @@
+module Jekyll
+  module Diagrams
+    class Block < Liquid::Block
+      include Renderer
+
+      def render(context)
+        svg = render_svg(super.to_s, read_config(context))
+        wrap_class(svg)
+      end
+
+      def render_svg(content, config)
+        raise 'Not Implemented'
+      end
+
+      def read_config(context)
+        Util.config_for(context, block_name)
+      end
+      
+      def wrap_class(content)
+        "<div class='diagrams #{block_name}'>#{content}</div>"
+      end
+    end
+  end
+end

data/lib/jekyll-diagrams/blockdiag.rb

@@ -0,0 +1,41 @@
+require 'open3'
+require 'tempfile'
+
+module Jekyll
+  module Diagrams
+    class BlockdiagBlock < Block
+      def render_svg(code, config)
+        command = build_command(config)
+        
+        render_with_tempfile(command, code, :svg) do |command, input, output|
+          "#{command} #{input} -o #{output}"
+        end
+      end
+
+      def read_config(context)
+        Util.config_for(context, 'blockdiag').merge(Util.config_for(context, block_name))
+      end
+
+      def build_command(config)
+        command = "#{block_name} -Tsvg --nodoctype"
+
+        antialias = config.fetch('antialias', false)
+
+        if antialias && antialias != 'false'
+          command << ' --antialias'
+        end
+
+        %w(config font fontmap size).each do |key|
+          value = config.fetch(key, nil)
+          command << " --#{key}=#{value}" if value
+        end
+
+        command
+      end
+    end
+  end
+end
+
+%i(blockdiag seqdiag actdiag nwdiag rackdiag packetdiag).each do |tag|
+  Liquid::Template.register_tag(tag, Jekyll::Diagrams::BlockdiagBlock)
+end

data/lib/jekyll-diagrams/graphviz.rb

@@ -0,0 +1,42 @@
+module Jekyll
+  module Diagrams
+    class GraphvizBlock < Block
+      CONFIGRATIONS = {
+        'K' => 'default_layout',
+        'G' => 'graph_attribute',
+        'N' => 'node_attribute',
+        'E' => 'edge_attribute'
+      }.freeze
+      
+      def render_svg(code, config)
+        svg = render_with_stdin_stdout(build_command(config), code)
+        svg.sub!(/^<\?xml(([^>]|\n)*>\n?){4}/, '')
+      end
+
+      def build_command(config)
+        command = 'dot -Tsvg'
+
+        CONFIGRATIONS.each do |prefix, conf|
+          next unless config.has_key?(conf)
+            
+          attrs = config[conf]
+          
+          attrs = case attrs
+          when String
+            attrs
+          when Array
+            attrs.join(" -#{prefix}")
+          when Hash
+            attrs.map { |k, v| "#{k}=#{v}" }.join(" -#{prefix}")
+          end
+
+          command << " -#{prefix}#{attrs}"
+        end
+
+        command
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag(:graphviz, Jekyll::Diagrams::GraphvizBlock)

data/lib/jekyll-diagrams/plantuml.rb

@@ -0,0 +1,19 @@
+module Jekyll
+  module Diagrams
+    class PlantUMLBlock < Block
+      def render_svg(code, config)
+        render_with_stdin_stdout(build_command(config), code)
+      end
+
+      def build_command(config)
+        options = 'java'
+        options << ' -Djava.awt.headless=true'
+        options << ' -jar '
+        options << Util.java_classpath('plantuml.1.2020.1.jar')
+        options << ' -tsvg -pipe'
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag(:plantuml, Jekyll::Diagrams::PlantUMLBlock)

data/lib/jekyll-diagrams/renderer.rb

@@ -0,0 +1,46 @@
+require 'open3'
+require 'tempfile'
+
+module Jekyll
+  module Diagrams
+    module Renderer
+      def render_with_stdin_stdout(command, content)
+        command = yield command if block_given?
+
+        render_with_command(command, :stdout, stdin_data: content, binmode: true)
+      end
+
+      def render_with_stdin(command, content, format)
+        Tempfile.open(['jekyll_diagrams_output', ".#{format}"]) do |output|
+          output.close
+          command = yield command, output.path
+
+          render_with_command(command, output.path, stdin_data: content)
+        end
+      end
+
+      def render_with_tempfile(command, content, format)
+        Tempfile.open('jekyll_diagrams_input') do |input|
+          File.write(input.path, content)
+          
+          Tempfile.open(['jekyll_diagrams_output', ".#{format}"]) do |output|
+            output.close
+            command = yield command, input.path, output.path
+
+            render_with_command(command, output.path)
+          end
+        end
+      end
+
+      def render_with_command(command, output, options = {})
+        stdout, stderr, status = Open3.capture3(command, options)
+
+        if !status.success?
+          raise "#{command} failed: #{stdout.empty? ? stderr : stdout}"
+        end
+
+        output == :stdout ? stdout : File.read(output)        
+      end
+    end
+  end
+end

data/lib/jekyll-diagrams/util.rb

@@ -0,0 +1,32 @@
+module Jekyll
+  module Diagrams
+    module Util
+      class << self
+        def diagrams_config(context)
+          site_config = context.registers[:site].config
+          new_config = site_config.fetch('jekyll-diagrams', {})   
+          old_config = site_config.fetch('diagrams', {})
+          
+          return new_config if old_config.empty?
+          
+          Jekyll.warn "Configuration `diagram` in _config.yml will be depreated"
+          Jekyll.warn "    Rename it to `jekyll-diagram` instead."
+
+          old_config.merge(new_config)
+        end
+        
+        def config_for(context, name)
+          diagrams_config(context).fetch(name, {})
+        end
+
+        def java_classpath(jar)
+          File.join(vendor_path, jar)
+        end
+
+        def vendor_path
+          File.expand_path('../../vendor', __dir__)
+        end
+      end
+    end
+  end
+end

data/lib/jekyll-diagrams/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module Diagrams
-    VERSION = '0.5.1'
+    VERSION = '0.6.0'
   end
-end
+end

data/test/test_helper.rb

@@ -2,17 +2,4 @@ require 'jekyll'
 require 'fileutils'
 require File.expand_path('../lib/jekyll-diagrams', __dir__)
 
-Jekyll.logger.log_level = :error
-
-SOURCE_DIR = File.expand_path("fixtures", __dir__)
-DEST_DIR   = File.expand_path("dest", __dir__)
-
-def source_dir(*files)
-  File.join(SOURCE_DIR, *files)
-end
-
-def dest_dir(*files)
-  File.join(DEST_DIR, *files)
-end
-
-require 'minitest/autorun'
+require 'minitest/autorun'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-diagrams
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - zhustec
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-01 00:00:00.000000000 Z
+date: 2020-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -72,8 +72,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
-description: Jekyll plugins for diagrams support, including Graphviz, Blockdiag, Seqdiag
-  and so on.
+description: Jekyll plugins for diagrams support.
 email:
 - zhustec@foxmail.com
 executables: []
@@ -88,16 +87,15 @@ files:
 - Rakefile
 - jekyll-diagrams.gemspec
 - lib/jekyll-diagrams.rb
+- lib/jekyll-diagrams/block.rb
+- lib/jekyll-diagrams/blockdiag.rb
+- lib/jekyll-diagrams/graphviz.rb
+- lib/jekyll-diagrams/plantuml.rb
+- lib/jekyll-diagrams/renderer.rb
+- lib/jekyll-diagrams/util.rb
 - lib/jekyll-diagrams/version.rb
-- lib/jekyll/diagrams.rb
-- lib/jekyll/diagrams/blockdiag.rb
-- lib/jekyll/diagrams/graphviz.rb
-- test/fixtures/_config.yml
-- test/fixtures/_layouts/default.html
-- test/fixtures/_posts/2019-08-25-blockdiag.md
-- test/fixtures/_posts/2019-08-25-graphviz.md
-- test/jekyll-diagrams_test.rb
 - test/test_helper.rb
+- vendor/plantuml.1.2020.1.jar
 homepage: https://github.com/zhustec/jekyll-diagrams
 licenses:
 - MIT
@@ -110,7 +108,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -121,11 +119,7 @@ rubyforge_project:
 rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
-summary: Jekyll plugins for diagrams support
+summary: Jekyll plugins for diagrams support, including Graphviz, Blockdiag, PlantUML
+  and so on.
 test_files:
-- test/fixtures/_config.yml
-- test/fixtures/_layouts/default.html
-- test/fixtures/_posts/2019-08-25-blockdiag.md
-- test/fixtures/_posts/2019-08-25-graphviz.md
-- test/jekyll-diagrams_test.rb
 - test/test_helper.rb

data/lib/jekyll/diagrams.rb

@@ -1,14 +0,0 @@
-require 'jekyll'
-
-module Jekyll
-  module Diagrams
-    module Utils
-      def self.config_for(context, name)
-        context.registers[:site].config.fetch('diagrams', {}).fetch(name, {})
-      end
-    end
-  end
-end
-
-require 'jekyll/diagrams/graphviz'
-require 'jekyll/diagrams/blockdiag'

data/lib/jekyll/diagrams/blockdiag.rb

@@ -1,46 +0,0 @@
-require 'open3'
-require 'tempfile'
-
-module Jekyll
-  module Diagrams
-    class BlockdiagBlock < Liquid::Block
-      DEFAULTS = {
-      }
-      OPTIONS = '-T svg --nodoctype'
-
-      def initialize(tag_name, text, tokens)
-        super
-        @tag_name = tag_name
-      end
-
-      def render(context)
-        code = super.to_s
-        config = DEFAULTS.merge(Utils.config_for(context, 'blockdiag'))
-
-        tmpfile = Tempfile.new(@tag_name).path
-        output = "#{tmpfile}.svg"
-
-        File.write(tmpfile, code)
-        cmd = "#@tag_name #{OPTIONS} #{config['options']} #{tmpfile} -o #{output}"
-        _, status = Open3.capture2(cmd, binmode: true)
-
-        if !status.success?
-          raise "Non-zero exit status '#{cmd}': #{status}"
-        end
-
-        svg = File.read(output)
-        wrap(svg.force_encoding('UTF-8'))
-      end
-
-      private
-
-      def wrap(svg)
-        "<div class='diagrams #@tag_name'>#{svg}</div>"
-      end
-    end
-  end
-end
-
-%w(blockdiag seqdiag actdiag nwdiag rackdiag packetdiag).each do |tag|
-  Liquid::Template.register_tag(tag, Jekyll::Diagrams::BlockdiagBlock)
-end

data/lib/jekyll/diagrams/graphviz.rb

@@ -1,51 +0,0 @@
-require 'open3'
-
-module Jekyll
-  module Diagrams
-    class GraphvizBlock < Liquid::Block
-      DEFAULTS = {
-        'engine'  => 'dot'
-      }
-      OPTIONS = '-T svg'
-
-      def initialize(tag_name, text, tokens)
-        super
-        @tag_name = tag_name
-      end
-
-      def render(context)
-        code = super.to_s
-        config = DEFAULTS.merge(Utils.config_for(context, 'graphviz'))
-
-        code = case @tag_name
-        when 'graph', 'digraph'
-          Jekyll.logger.warn "Warning:", "graph and digraph is depreated and will remove in the later version."
-          Jekyll.logger.warn "", "Using graphviz instead."
-          "#@tag_name {\n#{code}\n}"
-        when 'graphviz'
-          code
-        end
-
-        cmd = "#{config['engine']} #{OPTIONS} #{config['options']}"
-        svg, status = Open3.capture2(cmd, stdin_data: code, binmode: true)
-
-        if !status.success?
-          raise "Non-zero exit status '#{cmd}': #{status}"
-        end
-
-        svg.sub!(/^<\?xml(([^>]|\n)*>\n?){4}/, '')
-        wrap(svg.force_encoding('UTF-8'))
-      end
-
-      private
-
-      def wrap(svg)
-        "<div class='diagrams graphviz'>#{svg}</div>"
-      end
-    end
-  end
-end
-
-%w(graphviz graph digraph).each do |tag|
-  Liquid::Template.register_tag(tag, Jekyll::Diagrams::GraphvizBlock)
-end

data/test/fixtures/_config.yml

@@ -1,6 +0,0 @@
-diagrams:
-  graphviz:
-    engine: dot
-    options: '-Tsvg'
-  blockdiag:
-    options: '-Tsvg --nodoctype'

data/test/fixtures/_layouts/default.html

@@ -1,8 +0,0 @@
-<html>
-  <head>
-    <title>Jekyll Diagrams Testing Page</title>
-  </head>
-  <body>
-    {{ content }}
-  </body>
-</html>

data/test/fixtures/_posts/2019-08-25-blockdiag.md

@@ -1,23 +0,0 @@
----
-title: A post with blockdiag
-description: A post with blockdiag
-layout: default
----
-
-{% blockdiag %}
-blockdiag {
-   A -> B -> C -> D;
-   A -> E -> F -> G;
-}
-{% endblockdiag %}
-
-{% seqdiag %}
-seqdiag {
-  browser  -> webserver [label = "GET /index.html"];
-  browser <-- webserver;
-  browser  -> webserver [label = "POST /blog/comment"];
-              webserver  -> database [label = "INSERT comment"];
-              webserver <-- database;
-  browser <-- webserver;
-}
-{% endseqdiag %}

data/test/fixtures/_posts/2019-08-25-graphviz.md

@@ -1,48 +0,0 @@
----
-title: A post with graphviz
-description: A post with graphviz
-layout: default
----
-
-{% graphviz %}
-digraph {
-  node [shape=circle, style=filled];
-  S [fillcolor=green];
-  A [fillcolor=yellow];
-  B [fillcolor=yellow];
-  C [fillcolor=yellow];
-  D [shape=doublecircle, fillcolor=green];
-  S -> A [label=a];
-  S -> B [label=b];
-  A -> D [label=c];
-  B -> D [label=d];
-}
-{% endgraphviz %}
-
-{% digraph %}
-node [shape=circle, style=filled];
-S [fillcolor=green];
-A [fillcolor=yellow];
-B [fillcolor=yellow];
-C [fillcolor=yellow];
-D [shape=doublecircle, fillcolor=green];
-S -> A [label=a];
-S -> B [label=b];
-A -> D [label=c];
-B -> D [label=d];
-{% enddigraph %}
-
-{% graphviz neato %}
-digraph {
-  node [shape=circle, style=filled];
-  S [fillcolor=green];
-  A [fillcolor=yellow];
-  B [fillcolor=yellow];
-  C [fillcolor=yellow];
-  D [shape=doublecircle, fillcolor=green];
-  S -> A [label=a];
-  S -> B [label=b];
-  A -> D [label=c];
-  B -> D [label=d];
-}
-{% endgraphviz %}

data/test/jekyll-diagrams_test.rb

@@ -1,25 +0,0 @@
-require 'test_helper'
-
-class TestJekyllDiagrams < Minitest::Test
-  def setup
-    @config = Jekyll.configuration({
-      source: source_dir,
-      destination: dest_dir,
-      url: 'http://example.org'
-    })
-  
-    @site = Jekyll::Site.new(@config)
-    @site.process
-    @graphviz_contents = File.read(dest_dir('2019/08/25/graphviz.html'))
-    @blockdiag_contents = File.read(dest_dir('2019/08/25/blockdiag.html'))
-  end
-
-
-  def test_render_graphviz
-    assert_match %r!<div class="diagrams graphviz">!, @graphviz_contents
-  end
-
-  def test_render_blockdiag
-    assert_match %r!<div class="diagrams \w+">!, @blockdiag_contents
-  end
-end