jekyll-diagrams 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94652913742bd24e2f69b464a8836a424358ecd5babb10724428b8c3991a70b3
-  data.tar.gz: b6b21032b1dfb7cc19c986cdfcf55d7eeee43d5aa54657a9fb58928965dfad31
+  metadata.gz: 52a77bb73a18b1e0b3d922615f50a062ce500c7f7ad1d220b3f648ad1cba8ba1
+  data.tar.gz: 45b4d1695a7494c8a4ecfd70b0d32f33dd31007b1d63408d44f5762d5fb47639
 SHA512:
-  metadata.gz: 552cf35767c1a2d057acfd791f819b24050d352b8797a6a9809689ac67be94ea23bec365a006cee4b4807b6a87f728f67e3bf30b5251901d667b487a3174fb5d
-  data.tar.gz: 2565847c3a1fdbd14dc10d574ca9f92d0069010da7748d1d4a6f0be16274a3a5e35f8c1a7c05b4742a39e0e68c9d0ad28ae86869ff1732e2e7a1880580c9505a
+  metadata.gz: 012db758b38a586e03675b7af7c37ae88628361180d5ad1dd09aa6fb029c1cbd80eb98710542de4a490796cb45303aa1c5b3377536d2a8bfddf23cbc4fd80ba1
+  data.tar.gz: 0b62461401ae935a95c74e34412bcdb159ddf7b5f8c83d478e496d103f65d6643b7279ea12d98e8a9cdd6387e922a2c2aec1db1a6b4081d2d26324e9dea5bf19

data/.gitignore

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

data/.travis.yml

@@ -5,8 +5,14 @@ rvm:
   - 2.5
   - 2.6
 
+addons:
+  apt:
+    packages:
+      - graphviz
+      - python3
+      - python3-pip
+      - python3-setuptools
+
 before_install:
-  - sudo apt update && sudo apt install -y graphviz
-  - sudo apt install -y python3 python3-pip python3-setuptools
   - sudo pip3 install blockdiag seqdiag actdiag nwdiag
   - gem update --system && gem install bundler

data/README.md

@@ -45,12 +45,7 @@ plugins:
 
 ### Graphviz
 
-You need first install graphviz with package manager on your system. e.g.
-
-* Gentoo Linux : `emerge graphviz`
-* Arch Linux : `pacman -S graphviz`
-
-Then you can use `graphviz`, `graph`, and `digraph` Liquid Tag for creating amazing Graphviz images!
+You need first install graphviz with package manager on your system. Then you can use `graphviz` Liquid Tag to create amazing Graphviz images!
 
 ```
 {% graphviz %}
@@ -69,41 +64,18 @@ digraph {
 {% endgraphviz %}
 ```
 
-You can also use `diagraph` and `graph` tag. e.g.
-
-```
-{% 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 %}
-```
-
 ### Blockdiag
 
 Blockdiag contains:
 
-* `blockdiag` : simple block-diagram image generator
-* `seqdiag` : simple sequence-diagram image generator
-* `actdiag` : simple activity-diagram image generator
-* `nwdiag` : simple network-diagram image generators
+* `blockdiag` : generates block diagram image
+* `seqdiag` : generates sequence diagram image
+* `actdiag` : generates activity diagram image
+* `nwdiag` : generates network diagram image
+* `rackdiag` : generates rack structure diagram
+* `packetdiag` : generates packet header diagram
 
-Fisrt you should install them via `pip`:
-
-```bash
-$ pip install blockdiag seqdiag actdiag nwdiag
-```
-
-And set `$PATH` to make sure your system can find it in `$PATH`.
-
-Then you can use `blockdiag`, `seqdiag`, `actdiag` and `nwdiag` Liquid Tag. e.g.
+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.
 
 ```
 {% blockdiag %}
@@ -131,40 +103,21 @@ seqdiag {
 
 ## Configuration
 
-You need to provide a configuration.
-A simple configuration is shown below:
+You can to provide a configuration, this is optional.
+
+A simple example configuration is shown below:
 
 ```yaml
 diagrams:
   graphviz:
     engine: dot
-    options: '-Tsvg'
   blockdiag:
-    options: '-Tsvg --nodoctype'
+    options: '--antialias'
 ```
 
 ### Graphviz
 
-`engine` is the default image render engine. Default is set to `dot`. You can also specify for every single image via:
-
-```
-{% 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 %}
-```
-
-`options` is the command line options, and will be appended to the command.
+`engine` is the default image render engine. Default is set to `dot`.
 
 ### Blockdiag
 

data/lib/jekyll-diagrams/version.rb

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

data/lib/jekyll/diagrams.rb

@@ -1,3 +1,14 @@
 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

@@ -4,62 +4,43 @@ 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)
-        config = context.registers[:site].config["diagrams"]
-
-        @renderer = DiagRenderer.new(config['blockdiag'])
-
-        render_diagram(super)
-      end
-
-      private
-
-      def render_diagram(code)
-        @renderer.render(code, @tag_name)
-      end
-    end
+        code = super.to_s
+        config = DEFAULTS.merge(Utils.config_for(context, 'blockdiag'))
 
-    class DiagRenderer
-      DEFAULTS = {
-        'options' => '-Tsvg --nodoctype'
-      }
+        tmpfile = Tempfile.new(@tag_name).path
+        output = "#{tmpfile}.svg"
 
-      def initialize(config)
-        @config = DEFAULTS.merge(config)
-      end
-
-      def render(code, engine)
-        tmp = Tempfile.new(engine).path
-        dest = "#{tmp}.svg"
-
-        File.write(tmp, code)
-        cmd = "#{engine} #{@config['options']} #{tmp} -o #{dest}"
-        ret, status = Open3.capture2(cmd, binmode: true)
+        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(dest).force_encoding 'UTF-8'
-
-        wrap_div(svg, engine)
+        svg = File.read(output)
+        wrap(svg.force_encoding('UTF-8'))
       end
 
       private
 
-      def wrap_div(svg, engine)
-        "<div class='diag #{engine}'>#{svg}</div>"
+      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
+  Liquid::Template.register_tag(tag, Jekyll::Diagrams::BlockdiagBlock)
 end

data/lib/jekyll/diagrams/graphviz.rb

@@ -3,62 +3,44 @@ 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
-        @engine = text.strip
       end
 
       def render(context)
-        config = context.registers[:site].config["diagrams"]
-
-        @renderer = GraphvizRenderer.new(config["graphviz"])
-
-        render_diagram(super)
-      end
-
-      private
+        code = super.to_s
+        config = DEFAULTS.merge(Utils.config_for(context, 'graphviz'))
 
-      def render_diagram(code)
         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
-        else
-          raise "unknown liquid tag name: #{@tag_name}"
         end
 
-        @renderer.render(code, @engine)
-      end
-    end
-
-    class GraphvizRenderer
-      DEFAULTS = {
-        'engine'  => 'dot',
-        'options' => '-Tsvg'
-      }
-
-      def initialize(config)
-        @config = DEFAULTS.merge(config)
-      end
-
-      def render(code, engine = DEFAULTS['engine'])
-        cmd = "#{@config['engine']} #{@config['options']}"
-        svg, status = Open3.capture2(
-          cmd,
-          stdin_data: code,
-          binmode: true
-        )
+        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! /^<!DOCTYPE(([^>]|\n)*)>(\n?)/, ''
-        svg.force_encoding 'UTF-8'
+        svg.sub!(/^<\?xml(([^>]|\n)*>\n?){4}/, '')
+        wrap(svg.force_encoding('UTF-8'))
+      end
+
+      private
 
-        "<div class='graphviz'>#{svg}</div>"
+      def wrap(svg)
+        "<div class='diagrams graphviz'>#{svg}</div>"
       end
     end
   end

data/test/jekyll-diagrams_test.rb

@@ -16,10 +16,10 @@ class TestJekyllDiagrams < Minitest::Test
 
 
   def test_render_graphviz
-    assert_match %r!<div class="graphviz">!, @graphviz_contents
+    assert_match %r!<div class="diagrams graphviz">!, @graphviz_contents
   end
 
   def test_render_blockdiag
-    assert_match %r!<div class="diag \w+">!, @blockdiag_contents
+    assert_match %r!<div class="diagrams \w+">!, @blockdiag_contents
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-diagrams
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - zhustec
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-25 00:00:00.000000000 Z
+date: 2019-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll