jekyll-diagrams 0.9.1 → 0.9.2

data/features/mermaid.feature

@@ -0,0 +1,21 @@
+Feature: Mermaid
+
+
+  Scenario: Default configuration
+    Given I have a file 'mermaid.md' with content:
+      """
+      ---
+      ---
+
+      {% mermaid %}
+      sequenceDiagram
+          participant John
+          participant Alice
+          Alice->>John: Hello John, how are you?
+          John-->>Alice: Great!
+      {% endmermaid %}
+      """
+    When I run jekyll build
+    Then the file '_site/mermaid.html' should exist
+    And I should see 'diagrams mermaid' in '_site/mermaid.html'
+    And I should see svg output in '_site/mermaid.html'

data/features/nomnoml.feature

@@ -0,0 +1,36 @@
+Feature: Nomnoml
+
+
+  Scenario: Default configuration
+    Given I have a file 'nomnoml.md' with content:
+      """
+      ---
+      ---
+
+      {% nomnoml %}
+      [Pirate|eyeCount: Int|raid();pillage()|
+        [beard]--[parrot]
+        [beard]-:>[foul mouth]
+      ]
+
+      [<abstract>Marauder]<:--[Pirate]
+      [Pirate]- 0..7[mischief]
+      [jollyness]->[Pirate]
+      [jollyness]->[rum]
+      [jollyness]->[singing]
+      [Pirate]-> *[rum|tastiness: Int|swig()]
+      [Pirate]->[singing]
+      [singing]<->[rum]
+
+      [<start>st]->[<state>plunder]
+      [plunder]->[<choice>more loot]
+      [more loot]->[st]
+      [more loot] no ->[<end>e]
+
+      [<actor>Sailor] - [<usecase>shiver me;timbers]
+      {% endnomnoml %}
+      """
+    When I run jekyll build
+    Then the file '_site/nomnoml.html' should exist
+    And I should see 'diagrams nomnoml' in '_site/nomnoml.html'
+    And I should see svg output in '_site/nomnoml.html'

data/features/plantuml.feature

@@ -0,0 +1,24 @@
+Feature: PlantUML
+
+
+  Scenario: Default configuration
+    Given I have a file 'plantuml.md' with content:
+      """
+      ---
+      ---
+
+      {% plantuml %}
+      @startuml
+      class Car
+
+      Driver - Car : drives >
+      Car *- Wheel : have 4 >
+      Car -- Person : < owns
+
+      @enduml
+      {% endplantuml %}
+      """
+    When I run jekyll build
+    Then the file '_site/plantuml.html' should exist
+    And I should see 'diagrams plantuml' in '_site/plantuml.html'
+    And I should see svg output in '_site/plantuml.html'

data/features/smcat.feature

@@ -0,0 +1,29 @@
+Feature: SMCat
+
+
+  Scenario: Default configuration
+    Given I have a file 'smcat.md' with content:
+      """
+      ---
+      ---
+
+      {% smcat %}
+      initial,
+      "tape player off",
+      "tape player on" {
+        stopped => playing : play;
+        playing => stopped : stop;
+        playing => paused  : pause;
+        paused  => playing : pause;
+        paused  => stopped : stop;
+      };
+
+      initial           => "tape player off";
+      "tape player off" => stopped           : power;
+      "tape player on"  => "tape player off" : power;
+      {% endsmcat %}
+      """
+    When I run jekyll build
+    Then the file '_site/smcat.html' should exist
+    And I should see 'diagrams smcat' in '_site/smcat.html'
+    And I should see svg output in '_site/smcat.html'

data/features/step_definitions/jekyll-diagrams.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+Given('I have a file {string} with content:') do |file, content|
+  File.write(file, content)
+end
+
+When('I run jekyll build') do
+  run_jekyll
+end
+
+Then('the file {string} should exist') do |file|
+  assert File.exist?(file)
+end
+
+Then('I should see svg output in {string}') do |file|
+  assert_match %r{<svg(.|\r|\n)*?>(.|\r|\n)*</svg>}, File.read(file)
+end
+
+Then('I should see {string} in {string}') do |pattern, file|
+  assert_match Regexp.new(pattern), File.read(file)
+end
+
+Then('I should not see {string} in {string}') do |pattern, file|
+  refute_match Regexp.new(pattern), File.read(file)
+end

data/features/support/env.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'coveralls'
+Coveralls.wear!
+
+require 'tmpdir'
+require 'minitest'
+require 'jekyll'
+require 'jekyll-diagrams'
+
+TEST_DIR = File.join(Dir.tmpdir, 'jekyll-diagrams-features')
+
+Before do
+  FileUtils.rm_rf(TEST_DIR) if File.exist?(TEST_DIR)
+  FileUtils.mkdir_p(TEST_DIR)
+  Dir.chdir(TEST_DIR)
+end
+
+After do
+  if File.exist?(TEST_DIR)
+    Dir.chdir(File.dirname(TEST_DIR))
+    FileUtils.rm_rf(TEST_DIR)
+  end
+end
+
+def run_jekyll
+  options = Jekyll.configuration(source: TEST_DIR, quiet: true)
+
+  Jekyll::Site.new(options).process
+end

data/features/svgbob.feature

@@ -0,0 +1,22 @@
+Feature: Svgbob
+
+
+  Scenario: Default configuration
+    Given I have a file 'svgbob.md' with content:
+      """
+      ---
+      ---
+
+      {% svgbob %}
+                                 .--->  F
+        A       B      C  D     /
+        *-------*-----*---*----*----->  E
+                 \            ^ \
+                  v          /   '--->  G
+                   B --> C -'
+      {% endsvgbob %}
+      """
+    When I run jekyll build
+    Then the file '_site/svgbob.html' should exist
+    And I should see 'diagrams svgbob' in '_site/svgbob.html'
+    And I should see svg output in '_site/svgbob.html'

data/features/syntrax.feature

@@ -0,0 +1,22 @@
+Feature: Syntrax
+
+
+  Scenario: Default configuration
+    Given I have a file 'syntrax.md' with content:
+      """
+      ---
+      ---
+
+      {% syntrax %}
+      indentstack(10,
+        line(opt('-'), choice('0', line('1-9', loop(None, '0-9'))),
+          opt('.', loop('0-9', None))),
+
+        line(opt(choice('e', 'E'), choice(None, '+', '-'), loop('0-9', None)))
+      )
+      {% endsyntrax %}
+      """
+    When I run jekyll build
+    Then the file '_site/syntrax.html' should exist
+    And I should see 'diagrams syntrax' in '_site/syntrax.html'
+    And I should see svg output in '_site/syntrax.html'

data/features/vega.feature

@@ -0,0 +1,32 @@
+Feature: Vega
+
+
+  Scenario: Default configuration
+    Given I have a file 'vega.md' with content:
+      """
+      ---
+      ---
+
+      {% vega %}
+      {
+        "": "https://vega.github.io/schema/vega-lite/v4.json",
+        "description": "A simple bar chart with embedded data.",
+        "data": {
+          "values": [
+            {"a": "A", "b": 28}, {"a": "B", "b": 55}, {"a": "C", "b": 43},
+            {"a": "D", "b": 91}, {"a": "E", "b": 81}, {"a": "F", "b": 53},
+            {"a": "G", "b": 19}, {"a": "H", "b": 87}, {"a": "I", "b": 52}
+          ]
+        },
+        "mark": "bar",
+        "encoding": {
+          "x": {"field": "a", "type": "ordinal"},
+          "y": {"field": "b", "type": "quantitative"}
+        }
+      }
+      {% endvega %}
+      """
+    When I run jekyll build
+    Then the file '_site/vega.html' should exist
+    And I should see 'diagrams vega' in '_site/vega.html'
+    And I should see svg output in '_site/vega.html'

data/features/wavedrom.feature

@@ -0,0 +1,22 @@
+Feature: Wavedrom
+
+
+  Scenario: Default configuration
+    Given I have a file 'wavedrom.md' with content:
+      """
+      ---
+      ---
+
+      {% 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 %}
+      """
+    When I run jekyll build
+    Then the file '_site/wavedrom.html' should exist
+    And I should see 'diagrams wavedrom' in '_site/wavedrom.html'
+    And I should see svg output in '_site/wavedrom.html'

data/jekyll-diagrams.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
@@ -6,20 +8,24 @@ require 'jekyll-diagrams/version'
 Gem::Specification.new do |spec|
   spec.name          = 'jekyll-diagrams'
   spec.version       = Jekyll::Diagrams::VERSION
-  spec.authors       = ['zhustec']
-  spec.email         = ['zhustec@foxmail.com']
+  spec.author        = '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.summary       = 'Jekyll plugins for diagrams support'
+  spec.description   = <<~DESC
+    Jekyll plugins for diagrams support, including Graphviz, Blockdiag,
+    PlantUML and so on.
+  DESC
 
   spec.files         = `git ls-files -z`.split("\x0")
-  spec.test_files    = spec.files.grep(%r!^(test|spec|features)!)
+  spec.test_files    = spec.files.grep(/^(test|spec|features)/)
   spec.require_paths = ['lib']
 
   spec.add_dependency 'jekyll', '>= 3.7', '< 5.0'
 
   spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'cucumber'
   spec.add_development_dependency 'minitest', '~> 5.0'
-end
+  spec.add_development_dependency 'rake'
+end

data/lib/jekyll-diagrams.rb

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
+
 require_relative 'jekyll-diagrams/util'
-require_relative 'jekyll-diagrams/renderer'
 require_relative 'jekyll-diagrams/block'
 
 require_relative 'jekyll-diagrams/blockdiag'
@@ -12,4 +13,4 @@ require_relative 'jekyll-diagrams/smcat'
 require_relative 'jekyll-diagrams/svgbob'
 require_relative 'jekyll-diagrams/syntrax'
 require_relative 'jekyll-diagrams/vega'
-require_relative 'jekyll-diagrams/wavedrom'
+require_relative 'jekyll-diagrams/wavedrom'

data/lib/jekyll-diagrams/block.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
+
 module Jekyll
   module Diagrams
     class Block < Liquid::Block
-      include Renderer
       include Util
 
       def render(context)
@@ -9,8 +10,8 @@ module Jekyll
         wrap_class(svg)
       end
 
-      def render_svg(content, config)
-        raise 'Not Implemented'
+      def render_svg(_, _)
+        ''
       end
 
       def read_config(context)
@@ -22,4 +23,4 @@ module Jekyll
       end
     end
   end
-end
+end

data/lib/jekyll-diagrams/blockdiag.rb

@@ -1,13 +1,15 @@
+# frozen_string_literal: true
+
 module Jekyll
   module Diagrams
     class BlockdiagBlock < Block
-      CONFIGURATIONS = %w( config font fontmap size ).freeze
+      CONFIGURATIONS = %w[config font fontmap size].freeze
 
       def render_svg(code, config)
         command = build_command(config)
 
-        render_with_tempfile(command, code) do |command, input, output|
-          "#{command} #{input} -o #{output}"
+        render_with_tempfile(command, code) do |input, output|
+          "#{input} -o #{output}"
         end
       end
 
@@ -17,10 +19,10 @@ module Jekyll
 
       def build_command(config)
         command = "#{block_name} -T svg --nodoctype"
-        command << ' --antialias' if config.has_key?('antialias')
+        command << ' --antialias' if config.fetch('antialias', false) != false
 
         CONFIGURATIONS.each do |conf|
-          command << " --#{conf}=#{config[conf]}" if config.has_key?(conf)
+          command << " --#{conf}=#{config[conf]}" if config.key?(conf)
         end
 
         command
@@ -29,6 +31,6 @@ module Jekyll
   end
 end
 
-%i(blockdiag seqdiag actdiag nwdiag rackdiag packetdiag).each do |tag|
+%i[blockdiag seqdiag actdiag nwdiag rackdiag packetdiag].each do |tag|
   Liquid::Template.register_tag(tag, Jekyll::Diagrams::BlockdiagBlock)
-end
+end

data/lib/jekyll-diagrams/erd.rb

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

data/lib/jekyll-diagrams/graphviz.rb

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
 module Jekyll
   module Diagrams
     class GraphvizBlock < Block
+      XML_REGEX = /^<\?xml(([^>]|\n)*>\n?){2}/.freeze
       CONFIGRATIONS = {
         'K' => 'default_layout',
         'G' => 'graph_attributes',
@@ -11,28 +14,20 @@ module Jekyll
       def render_svg(code, config)
         command = build_command(config)
 
-        svg = render_with_stdin_stdout(command, code)
-        svg.sub!(/^<\?xml(([^>]|\n)*>\n?){2}/, '')
+        svg = render_with_stdin_stdout(command, code).force_encoding(
+          config.fetch('encoding', 'utf-8')
+        )
+
+        svg.sub!(XML_REGEX, '')
       end
 
       def build_command(config)
-        command = 'dot -Tsvg'
+        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
+          next unless config.key?(conf)
 
-          command << " -#{prefix}#{attrs}"
+          command << normalized_attrs(config[conf], prefix: " -#{prefix}")
         end
 
         command
@@ -41,4 +36,4 @@ module Jekyll
   end
 end
 
-Liquid::Template.register_tag(:graphviz, Jekyll::Diagrams::GraphvizBlock)
+Liquid::Template.register_tag(:graphviz, Jekyll::Diagrams::GraphvizBlock)