jekyll-diagrams 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50b1e58e8ce58f22fef54776c2413abafc5ee1ee16b8ceecd84cf64b8bdfb25c
-  data.tar.gz: e440f946189747d473e4d0cca362a4732b7d1e2fcac94c91d8f0c63e1aaf416b
+  metadata.gz: 45645fc482eb66caa1e9dcc420f1da9f500c5c3c4735df834f51a265b9ab5234
+  data.tar.gz: 630469bb87099ce469e507f03e3b2567bd9e7eb6cc16b9d295427c39c3e8cd5a
 SHA512:
-  metadata.gz: f62eab1353bd18378dc8b53ade153079fa4b9d99f032a81f5a7130fc15e86fb2727495eaff9e780d48fb8dfb4fc009c6d0d5ecdb1f226e65356da3546d7a615a
-  data.tar.gz: 48ab6a18cf4f93ac5ad50368674c2fb06a0b5ad134f51cadaa46355683751e79dad0e1edf8db60e2a66842c750a7352e49539842cd1ce826f8274be0dc943275
+  metadata.gz: b1fe97c25a68ebe37dccc5e5583dcb6ac0768c76922e89d5a033c4205dcf5005aa8abe1e1cb7a2f0261046a0329dd87d24c3c92b20761b41b0fa5e96fc2e22c4
+  data.tar.gz: bd1017c5fd734b0a080cec05a309e4c829475ec34644d76af6df934644dd920e1e3371543c36a4038f6fe185e3708d51d9e8fbc55ecbbfe9a31a8c66d3a8cded

data/.gitignore

@@ -1,8 +1,5 @@
+.jekyll-cache
+Gemfile.lock
 /.bundle/
-/Gemfile.lock
-/doc/
 /pkg/
-/test/dest/
-/test/fixtures/.jekyll-cache/
-/tmp/
-/*.gem
+/test/dummy_site/_site/

data/.travis.yml

@@ -9,16 +9,17 @@ rvm:
 addons:
   apt:
     packages:
+      - cabal-install
       - default-jre
       - gnuplot
       - graphviz
-      - node
       - npm
       - python3
       - python3-pip
       - python3-setuptools
 
 before_install:
-  - sudo pip3 install blockdiag seqdiag actdiag nwdiag
-  - gem update --system && gem install bundler
-  - npm install -g wavedrom-cli mermaid.cli
+  - sudo cabal update && sudo cabal install erd
+  - sudo gem update --system && sudo gem install bundler
+  - sudo npm install -g mermaid.cli state-machine-cat wavedrom-cli 
+  - sudo pip3 install blockdiag seqdiag actdiag nwdiag syntrax

data/README.md

@@ -7,13 +7,13 @@
 
 Jekyll Diagrams is a jekyll plugins for creating amazing diagrams, including:
 
-- Blockdiag(Blockdia, Seqdiag, Actdiag, Nwdiag, Rackdiag and Packatdiag)
-- Erd
-- Graphviz
-- Mermaid
-- PlantUML
-- State Machine cat
-- Syntrax
+- [**Blockdiag**](#blockdiag)
+- [**Erd**](#erd)
+- [**Graphviz**](#graphviz)
+- [**Mermaid**](#mermaid)
+- [**PlantUML**](#plantUML)
+- [**State Machine Cat**](#state-machine-cat)
+- [**Syntrax**](#syntrax)
 
 ## Installation
 
@@ -112,6 +112,7 @@ jekyll-diagrams:
 
 - Install Graphviz
 - [**Install Erd**](https://github.com/BurntSushi/erd#installation)
+- Set path properly, make sure your system can find it
 
 #### Examples
 
@@ -191,6 +192,7 @@ jekyll-diagrams:
 #### Prerequisites
 
 - [**Install mermaid.cli**](https://github.com/mermaidjs/mermaid.cli#mermaidcli)
+- Set path properly, make sure your system can find it
 
 #### Configurations
 
@@ -229,13 +231,13 @@ Car -- Person : < owns
 {% endplantuml %}
 ```
 
-### State Machine cat
+### State Machine Cat
 
 #### Prerequisites
 
 - Nodejs Runtime
 - Install it `npm install [-g] state-machine-cat`
-- Set path
+- Set path properly, make sure your system can find it
 
 #### Examples
 
@@ -267,15 +269,16 @@ jekyll-diagrams:
     direction: top-down
 ```
 
-- `input-type`: smcat|scxml|json (default: "smcat")
-- `engine`: dot|circo|fdp|neato|osage|twopi (default: "dot")
-- `direction`: top-down|bottom-top|left-right|right-left (default: "top-down")
+- `input-type`: `smcat|scxml|json` (Default: `smcat`)
+- `engine`: `dot|circo|fdp|neato|osage|twopi` (Default: `dot`)
+- `direction`: `top-down|bottom-top|left-right|right-left` (Default: `top-down`)
 
 ### Syntrax
 
 #### Prerequisites
 
-- [Install it with Pango and PangoCairo](https://kevinpt.github.io/syntrax/#requirements)
+- [Install Syntrax, Pango and PangoCairo](https://kevinpt.github.io/syntrax/#requirements)
+- Set path properly, make sure your system can find it
 
 #### Examples
 

data/Rakefile

@@ -7,4 +7,15 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList['test/**/*_test.rb']
 end
 
-task default: :test
+task default: :test
+
+desc 'Run dummy site'
+task :dummy_site do
+  dummy_site_path = File.expand_path('test/dummy_site', __dir__)
+
+  Dir.chdir(dummy_site_path) do
+    puts "Current directory: #{Dir.pwd}"
+
+    %x(bundle exec jekyll serve --trace)
+  end
+end

data/lib/jekyll-diagrams/blockdiag.rb

@@ -4,6 +4,8 @@ require 'tempfile'
 module Jekyll
   module Diagrams
     class BlockdiagBlock < Block
+      CONFIGURATIONS = %w(config font fontmap size).freeze
+
       def render_svg(code, config)
         command = build_command(config)
         
@@ -13,14 +15,16 @@ module Jekyll
       end
 
       def read_config(context)
-        Util.config_for(context, 'blockdiag').merge(Util.config_for(context, block_name))
+        Util.config_for(context, 'blockdiag').merge(
+          Util.config_for(context, block_name)
+        )
       end
 
       def build_command(config)
-        command = "#{block_name} -Tsvg --nodoctype"
+        command = "#{block_name} -T svg --nodoctype"
         command << ' --antialias' if config.has_key?('antialias')
 
-        %w(config font fontmap size).each do |conf|
+        CONFIGURATIONS.each do |conf|
           command << " --#{conf}=#{config[conf]}" if config.has_key?(conf)
         end
 

data/lib/jekyll-diagrams/erd.rb

@@ -1,14 +1,18 @@
 module Jekyll
     module Diagrams
       class ErdBlock < Block
+        CONFIGURATIONS = %w(config edge).freeze
+        
         def render_svg(code, config)
-          render_with_stdin_stdout(build_command(config), code)
+          svg = render_with_stdin_stdout(build_command(config), code)
+          svg.sub!(/^<\?xml(([^>]|\n)*>\n?){2}/, '')
         end
   
         def build_command(config)
           command = 'erd --fmt=svg'
+          command << ' --dot-entity' if config.has_key?('dot-entity')
 
-          %w(config edge).each do |conf|
+          CONFIGURATIONS.each do |conf|
             command << " --#{conf}=#{config[conf]}" if config.has_key?(conf)
           end
 
@@ -18,4 +22,4 @@ module Jekyll
     end
   end
   
-  Liquid::Template.register_tag(:erb, Jekyll::Diagrams::ErdBlock)
+  Liquid::Template.register_tag(:erd, Jekyll::Diagrams::ErdBlock)

data/lib/jekyll-diagrams/graphviz.rb

@@ -10,7 +10,7 @@ module Jekyll
       
       def render_svg(code, config)
         svg = render_with_stdin_stdout(build_command(config), code)
-        svg.sub!(/^<\?xml(([^>]|\n)*>\n?){4}/, '')
+        svg.sub!(/^<\?xml(([^>]|\n)*>\n?){2}/, '')
       end
 
       def build_command(config)

data/lib/jekyll-diagrams/mermaid.rb

@@ -17,6 +17,7 @@ module Jekyll
         def build_command(config)
           command = 'mmdc'
           command << ' --transparent' if config.has_key?('transparent')
+          command << " --puppeteerConfigFile #{Util.vendor_path('mermaid_puppeteer_config.json')}"
 
           CONFIGURATIONS.merge(config).each do |conf, value|
             command << " --#{conf} #{value}"

data/lib/jekyll-diagrams/plantuml.rb

@@ -2,14 +2,15 @@ module Jekyll
   module Diagrams
     class PlantUMLBlock < Block
       def render_svg(code, config)
-        render_with_stdin_stdout(build_command(config), code)
+        svg = render_with_stdin_stdout(build_command(config), code)
+        svg.sub!(/^<\?xml([^>]|\n)*>\n?/, '')
       end
 
       def build_command(config)
         options = 'java'
         options << ' -Djava.awt.headless=true'
         options << ' -jar '
-        options << Util.java_classpath('plantuml.1.2020.1.jar')
+        options << Util.vendor_path('plantuml.1.2020.1.jar')
         options << ' -tsvg -pipe'
       end
     end

data/lib/jekyll-diagrams/smcat.rb

@@ -12,7 +12,7 @@ module Jekyll
             "#{command} #{input} --output-to #{output}"
           end
 
-          svg.sub!(/^<\?xml(([^>]|\n)*>\n?){4}/, '')
+          svg.sub!(/^<\?xml(([^>]|\n)*>\n?){2}/, '')
         end
   
         def build_command(config)

data/lib/jekyll-diagrams/syntrax.rb

@@ -1,6 +1,8 @@
 module Jekyll
     module Diagrams
       class SyntraxBlock < Block
+        CONFIGURATIONS = %w(scale style).freeze
+
         def render_svg(code, config)
           render_with_tempfile(build_command(config), code) do |command, input, output|
             "#{command} --input #{input} --output #{output}"
@@ -10,7 +12,7 @@ module Jekyll
         def build_command(config)
           command = 'syntrax'
 
-          %w(scale style).each do |conf|
+          CONFIGURATIONS.each do |conf|
             command << " --#{conf} #{config[conf]}" if config.has_key?(conf)
           end
 

data/lib/jekyll-diagrams/util.rb

@@ -19,12 +19,8 @@ module Jekyll
           diagrams_config(context).fetch(name, {})
         end
 
-        def java_classpath(jar)
-          File.join(vendor_path, jar)
-        end
-
-        def vendor_path
-          File.expand_path('../../vendor', __dir__)
+        def vendor_path(file = '')
+          File.join(File.expand_path('../../vendor', __dir__), file)
         end
       end
     end

data/lib/jekyll-diagrams/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module Diagrams
-    VERSION = '0.7.0'
+    VERSION = '0.7.1'
   end
 end

data/test/dummy_site/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+gem "jekyll", "~> 4.0.0"
+gem "minima", "~> 2.5"
+
+group :jekyll_plugins do
+  gem "jekyll-diagrams", path: "../../"
+end

data/test/dummy_site/_config.yml

@@ -0,0 +1,21 @@
+title: Dummy Site
+description: This is a dummy site for testing.
+
+theme: minima
+plugins:
+  - jekyll-diagrams
+
+jekyll-diagrams:
+  graphviz:
+    default_layout: dot
+    graph_attribute: color=red
+    node_attribute:
+      - color=blue
+      - fillcolor=red
+    edge_attribute:
+      color: red
+      fillcolor: blue
+  blockdiag:
+    antialias: true
+  syntax:
+    transparent: true

data/test/dummy_site/_posts/2020-01-01-graphviz-test.md

@@ -0,0 +1,23 @@
+---
+layout: post
+title: Graphviz Test
+date: 2020-01-01 00:00:00 +0800
+---
+
+# Graphviz Test
+
+{% graphviz %}
+digraph {
+  node [shape=circle, style=filled];
+  S ;
+  A ;
+  B ;
+  C ;
+  D [shape=doublecircle, fillcolor=green];
+  S -> A [label=a];
+  S -> B [label=b];
+  A -> D [label=c];
+  B -> D [label=d];
+}
+{% endgraphviz %}
+

data/test/dummy_site/_posts/2020-01-02-blockdiag-test.md

@@ -0,0 +1,29 @@
+---
+layout: post
+title: Blockdiag Test
+date: 2020-01-02 00:00:00 +0800
+---
+
+# Blockdiag Test
+
+## Blockdiag
+
+{% blockdiag %}
+blockdiag {
+   A -> B -> C -> D;
+   A -> E -> F -> G;
+}
+{% endblockdiag %}
+
+## Seqdiag
+
+{% 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/dummy_site/_posts/2020-01-03-plantuml-test.md

@@ -0,0 +1,80 @@
+---
+layout: post
+title: PlantUML Test
+date: 2020-01-03 00:00:00 +0800
+---
+
+# PlantUML Test
+
+{% plantuml %}
+@startuml
+actor Foo1
+boundary Foo2
+control Foo3
+entity Foo4
+database Foo5
+collections Foo6
+Foo1 -> Foo2 : To boundary
+Foo1 -> Foo3 : To control
+Foo1 -> Foo4 : To entity
+Foo1 -> Foo5 : To database
+Foo1 -> Foo6 : To collections
+
+@enduml
+{% endplantuml %}
+
+
+{% plantuml %}
+@startuml
+:Main Admin: as Admin
+(Use the application) as (Use)
+
+User -> (Start)
+User --> (Use)
+
+Admin ---> (Use)
+
+note right of Admin : This is an example.
+
+note right of (Use)
+  A note can also
+  be on several lines
+end note
+
+note "This note is connected\nto several objects." as N2
+(Start) .. N2
+N2 .. (Use)
+@enduml
+{% endplantuml %}
+
+{% plantuml %}
+@startuml
+class Car
+
+Driver - Car : drives >
+Car *- Wheel : have 4 >
+Car -- Person : < owns
+
+@enduml
+{% endplantuml %}
+
+{% plantuml %}
+@startuml
+nwdiag {
+  network dmz {
+    address = "210.x.x.x/24"
+
+    web01 [address = "210.x.x.1"];
+    web02 [address = "210.x.x.2"];
+  }
+  network internal {
+    address = "172.x.x.x/24";
+
+    web01 [address = "172.x.x.1"];
+    web02 [address = "172.x.x.2"];
+    db01;
+    db02;
+  }
+}
+@enduml
+{% endplantuml %}

data/test/dummy_site/_posts/2020-01-04-mermaid-test.md

@@ -0,0 +1,65 @@
+---
+layout: post
+title: Mermaid Test
+date: 2020-01-04 00:00:00 +0800
+---
+
+# Mermaid Test
+
+{% mermaid %}
+graph TB
+    c1-->a2
+    subgraph one
+    a1-->a2
+    end
+    subgraph two
+    b1-->b2
+    end
+    subgraph three
+    c1-->c2
+    end
+{% endmermaid %}
+
+{% mermaid %}
+sequenceDiagram
+    participant John
+    participant Alice
+    Alice->>John: Hello John, how are you?
+    John-->>Alice: Great!
+{% endmermaid %}
+
+{% mermaid %}
+ classDiagram
+      Animal <|-- Duck
+      Animal <|-- Fish
+      Animal <|-- Zebra
+      Animal : +int age
+      Animal : +String gender
+      Animal: +isMammal()
+      Animal: +mate()
+      class Duck{
+          +String beakColor
+          +swim()
+          +quack()
+      }
+      class Fish{
+          -int sizeInFeet
+          -canEat()
+      }
+      class Zebra{
+          +bool is_wild
+          +run()
+      }
+{% endmermaid %}
+
+{% mermaid %}
+gantt
+    title A Gantt Diagram
+    dateFormat  YYYY-MM-DD
+    section Section
+    A task           :a1, 2014-01-01, 30d
+    Another task     :after a1  , 20d
+    section Another
+    Task in sec      :2014-01-12  , 12d
+    another task      : 24d
+{% endmermaid %}

data/test/dummy_site/_posts/2020-01-05-wavedrom-test.md

@@ -0,0 +1,16 @@
+---
+layout: post
+title: Wavedrom Test
+date: 2020-01-05 00:00:00 +0800
+---
+
+# Wavedrom Test
+
+{% wavedrom %}
+{signal: [
+  {name: 'clk', wave: 'p.....|...'},
+  {name: 'dat', wave: 'x.345x|=.x', data: ['head', 'body', 'tail', 'data']},
+  {name: 'req', wave: '0.1..0|1.0'},
+  {name: 'ack', wave: '1.....|01.'}
+]}
+{% endwavedrom %}

data/test/dummy_site/_posts/2020-01-06-smcat-test.md

@@ -0,0 +1,24 @@
+---
+layout: post
+title: State Machine Cat Test
+date: 2020-01-06 00:00:00 +0800
+---
+
+# State Machine Cat Test
+
+{% smcat %}
+initial,
+doing: entry/ write unit test
+       do/ write code
+       exit/ ...,
+# smcat recognizes initial
+# and final states by name
+# and renders them appropriately
+final;
+
+initial      => "on backlog" : item adds most value;
+"on backlog" => doing        : working on it;
+doing        => testing      : built & unit tested;
+testing      => "on backlog" : test not ok;
+testing      => final        : test ok;
+{% endsmcat %}

data/test/dummy_site/_posts/2020-01-07-erd-test.md

@@ -0,0 +1,116 @@
+---
+layout: post
+title: Erd Test
+date: 2020-01-07 00:00:00 +0800
+---
+
+# Erd Test
+
+{% erd %}
+[Person]
+*name
+height
+weight
+`birth date`
++birth_place_id
+
+[`Birth Place`]
+*id
+`birth city`
+'birth state'
+"birth country"
+
+# Each relationship must be between exactly two entities, which need not
+# be distinct. Each entity in the relationship has exactly one of four
+# possible cardinalities:
+#
+# Cardinality    Syntax
+# 0 or 1         ?
+# exactly 1      1
+# 0 or more      *
+# 1 or more      +
+Person *--1 `Birth Place`
+{% enderd %}
+
+{% erd %}
+title {label: "nfldb Entity-Relationship diagram (condensed)", size: "20"}
+
+# Entities
+
+[player] {bgcolor: "#d0e0d0"}
+  *player_id {label: "varchar, not null"}
+  full_name {label: "varchar, null"}
+  team {label: "varchar, not null"}
+  position {label: "player_pos, not null"}
+  status {label: "player_status, not null"}
+
+[team] {bgcolor: "#d0e0d0"}
+  *team_id {label: "varchar, not null"}
+  city {label: "varchar, not null"}
+  name {label: "varchar, not null"}
+
+[game] {bgcolor: "#ececfc"}
+  *gsis_id {label: "gameid, not null"}
+  start_time {label: "utctime, not null"}
+  week {label: "usmallint, not null"}
+  season_year {label: "usmallint, not null"}
+  season_type {label: "season_phase, not null"}
+  finished {label: "boolean, not null"}
+  home_team {label: "varchar, not null"}
+  home_score {label: "usmallint, not null"}
+  away_team {label: "varchar, not null"}
+  away_score {label: "usmallint, not null"}
+
+[drive] {bgcolor: "#ececfc"}
+  *+gsis_id {label: "gameid, not null"}
+  *drive_id {label: "usmallint, not null"}
+  start_field {label: "field_pos, null"}
+  start_time {label: "game_time, not null"}
+  end_field {label: "field_pos, null"}
+  end_time {label: "game_time, not null"}
+  pos_team {label: "varchar, not null"}
+  pos_time {label: "pos_period, null"}
+
+[play] {bgcolor: "#ececfc"}
+  *+gsis_id {label: "gameid, not null"}
+  *+drive_id {label: "usmallint, not null"}
+  *play_id {label: "usmallint, not null"}
+  time {label: "game_time, not null"}
+  pos_team {label: "varchar, not null"}
+  yardline {label: "field_pos, null"}
+  down {label: "smallint, null"}
+  yards_to_go {label: "smallint, null"}
+
+[play_player] {bgcolor: "#ececfc"}
+  *+gsis_id {label: "gameid, not null"}
+  *+drive_id {label: "usmallint, not null"}
+  *+play_id {label: "usmallint, not null"}
+  *+player_id {label: "varchar, not null"}
+  team {label: "varchar, not null"}
+
+[meta] {bgcolor: "#fcecec"}
+  version {label: "smallint, null"}
+  season_type {label: "season_phase, null"}
+  season_year {label: "usmallint, null"}
+  week {label: "usmallint, null"}
+
+# Relationships
+
+player      *--1 team
+game        *--1 team {label: "home"}
+game        *--1 team {label: "away"}
+drive       *--1 team
+play        *--1 team
+play_player *--1 team
+
+game        1--* drive
+game        1--* play
+game        1--* play_player
+
+drive       1--* play
+drive       1--* play_player
+
+play        1--* play_player
+
+player      1--* play_player
+{% enderd %}

data/test/dummy_site/index.md

@@ -0,0 +1,3 @@
+---
+layout: home
+---

data/vendor/mermaid_puppeteer_config.json

@@ -0,0 +1,3 @@
+{
+    "args": ["--no-sandbox"]
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-diagrams
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - zhustec
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-28 00:00:00.000000000 Z
+date: 2020-02-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -99,7 +99,18 @@ files:
 - lib/jekyll-diagrams/util.rb
 - lib/jekyll-diagrams/version.rb
 - lib/jekyll-diagrams/wavedrom.rb
+- test/dummy_site/Gemfile
+- test/dummy_site/_config.yml
+- test/dummy_site/_posts/2020-01-01-graphviz-test.md
+- test/dummy_site/_posts/2020-01-02-blockdiag-test.md
+- test/dummy_site/_posts/2020-01-03-plantuml-test.md
+- test/dummy_site/_posts/2020-01-04-mermaid-test.md
+- test/dummy_site/_posts/2020-01-05-wavedrom-test.md
+- test/dummy_site/_posts/2020-01-06-smcat-test.md
+- test/dummy_site/_posts/2020-01-07-erd-test.md
+- test/dummy_site/index.md
 - test/test_helper.rb
+- vendor/mermaid_puppeteer_config.json
 - vendor/plantuml.1.2020.1.jar
 homepage: https://github.com/zhustec/jekyll-diagrams
 licenses:
@@ -127,4 +138,14 @@ specification_version: 4
 summary: Jekyll plugins for diagrams support, including Graphviz, Blockdiag, PlantUML
   and so on.
 test_files:
+- test/dummy_site/Gemfile
+- test/dummy_site/_config.yml
+- test/dummy_site/_posts/2020-01-01-graphviz-test.md
+- test/dummy_site/_posts/2020-01-02-blockdiag-test.md
+- test/dummy_site/_posts/2020-01-03-plantuml-test.md
+- test/dummy_site/_posts/2020-01-04-mermaid-test.md
+- test/dummy_site/_posts/2020-01-05-wavedrom-test.md
+- test/dummy_site/_posts/2020-01-06-smcat-test.md
+- test/dummy_site/_posts/2020-01-07-erd-test.md
+- test/dummy_site/index.md
 - test/test_helper.rb