jekyll-diagrams 0.9.2 → 0.9.3

data/lib/jekyll-diagrams.rb

@@ -1,6 +1,69 @@
 # frozen_string_literal: true
 
-require_relative 'jekyll-diagrams/util'
+require 'jekyll'
+
+module Jekyll
+  module Diagrams
+    class << self
+      # Return configuration of Jekyll Diagrams
+      #
+      # @param context [Liquid::Context, :registers] Parsed context
+      # @return Configuration
+      def configuration(context)
+        site_config = context.registers[:site].config
+        page_config = context.registers[:page]
+
+        site_config.merge(page_config)
+      end
+
+      def config_for(context, name)
+        configuration(context).dig(config_name, name) || {}
+      end
+
+      def error_mode(context)
+        liquid_mode = configuration(context).dig('liquid', 'error_mode')
+        custom_mode = configuration(context).dig(config_name, 'error_mode')
+
+        (custom_mode || liquid_mode || :warn).to_sym
+      end
+
+      # Return file path under vendor path
+      #
+      # @param file [String] If not given, return directory path
+      def vendor_path(file = '')
+        File.join(File.expand_path('../vendor', __dir__), file)
+      end
+
+      # @param jar [String] Jar path to run
+      def run_jar(jar)
+        "java -Djava.awt.headless=true -jar #{jar} "
+      end
+
+      def normalized_attrs(attrs, prefix:, sep: '=')
+        attrs =
+          case attrs
+          when String
+            attrs
+          when Array
+            attrs.join(prefix)
+          when Hash
+            attrs.map { |k, v| "#{k}#{sep}#{v}" }.join(prefix)
+          end
+
+        "#{prefix}#{attrs}"
+      end
+
+      private
+
+      def config_name
+        'jekyll-diagrams'
+      end
+    end
+  end
+end
+
+require_relative 'jekyll-diagrams/errors'
+require_relative 'jekyll-diagrams/rendering'
 require_relative 'jekyll-diagrams/block'
 
 require_relative 'jekyll-diagrams/blockdiag'

data/lib/jekyll-diagrams/block.rb

@@ -3,23 +3,48 @@
 module Jekyll
   module Diagrams
     class Block < Liquid::Block
-      include Util
+      include Rendering
 
       def render(context)
-        svg = render_svg(super.to_s, read_config(context))
-        wrap_class(svg)
+        config = Diagrams.config_for(context, block_name)
+
+        output = render_svg(super.to_s, config)
+        wrap_class(output)
+      rescue StandardError => e
+        error_mode = Diagrams.error_mode(context)
+
+        output = handle_error(e, error_mode)
+        wrap_class(output)
       end
 
-      def render_svg(_, _)
+      private
+
+      def render_svg(_code, _config)
         ''
       end
 
-      def read_config(context)
-        config_for(context, block_name)
+      def wrap_class(content)
+        <<~CONTENT
+          <div class='jekyll-diagrams diagrams #{block_name}'>
+            #{content}
+          </div>"
+        CONTENT
       end
 
-      def wrap_class(content)
-        "<div class='jekyll-diagrams diagrams #{block_name}'>#{content}</div>"
+      def handle_error(error, mode)
+        topic = 'Jekyll Diagrams:'
+        msg = error.message
+
+        case mode
+        when :lax
+          Jekyll.logger.info topic, msg
+          ''
+        when :warn
+          Jekyll.logger.warn topic, msg
+          msg
+        when :strict
+          Jekyll.logger.abort_with topic, msg
+        end
       end
     end
   end

data/lib/jekyll-diagrams/blockdiag.rb

@@ -4,6 +4,9 @@ module Jekyll
   module Diagrams
     class BlockdiagBlock < Block
       CONFIGURATIONS = %w[config font fontmap size].freeze
+      SWITCHES = {
+        'antialias' => false
+      }.freeze
 
       def render_svg(code, config)
         command = build_command(config)
@@ -13,13 +16,12 @@ module Jekyll
         end
       end
 
-      def read_config(context)
-        config_for(context, 'blockdiag').merge(config_for(context, block_name))
-      end
-
       def build_command(config)
-        command = "#{block_name} -T svg --nodoctype"
-        command << ' --antialias' if config.fetch('antialias', false) != false
+        command = +"#{block_name} -T svg --nodoctype"
+
+        SWITCHES.merge(config.slice(*SWITCHES.keys)).each do |switch, value|
+          command << " --#{switch}" if value != false
+        end
 
         CONFIGURATIONS.each do |conf|
           command << " --#{conf}=#{config[conf]}" if config.key?(conf)

data/lib/jekyll-diagrams/erd.rb

@@ -5,6 +5,9 @@ module Jekyll
     class ErdBlock < Block
       XML_REGEX = /^<\?xml(([^>]|\n)*>\n?){2}/.freeze
       CONFIGURATIONS = %w[config edge].freeze
+      SWITCHES = {
+        'dot-entity' => false
+      }.freeze
 
       def render_svg(code, config)
         command = build_command(config)
@@ -15,7 +18,10 @@ module Jekyll
 
       def build_command(config)
         command = +'erd --fmt=svg'
-        command << ' --dot-entity' if config.fetch('dot-entity', false) != false
+
+        SWITCHES.merge(config.slice(*SWITCHES.keys)).each do |switch, value|
+          command << " --#{switch}" if value != false
+        end
 
         CONFIGURATIONS.each do |conf|
           command << " --#{conf}=#{config[conf]}" if config.key?(conf)

data/lib/jekyll-diagrams/errors.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Diagrams
+    module Errors
+      BaseError = Class.new(::StandardError) do
+        def initialize(msg)
+          @msg = msg
+        end
+      end
+
+      CommandNotFoundError = Class.new(BaseError) do
+        def message
+          "Command Not Found: #{@msg}"
+        end
+      end
+
+      RenderingFailedError = Class.new(BaseError) do
+        def message
+          "Rendering Failed: #{@msg}"
+        end
+      end
+    end
+  end
+end

data/lib/jekyll-diagrams/graphviz.rb

@@ -27,7 +27,8 @@ module Jekyll
         CONFIGRATIONS.each do |prefix, conf|
           next unless config.key?(conf)
 
-          command << normalized_attrs(config[conf], prefix: " -#{prefix}")
+          command << Diagrams.normalized_attrs(config[conf],
+                                               prefix: " -#{prefix}")
         end
 
         command

data/lib/jekyll-diagrams/mermaid.rb

@@ -3,7 +3,8 @@
 module Jekyll
   module Diagrams
     class MermaidBlock < Block
-      CONFIGURATIONS = %w[backgroundColor height theme width].freeze
+      CONFIGURATIONS = %w[theme width height backgroundColor
+                          configFile cssFile scale].freeze
 
       def render_svg(code, config)
         command = build_command(config)
@@ -14,10 +15,8 @@ module Jekyll
       end
 
       def build_command(config)
-        command = +'mmdc'
-        command << ' --puppeteerConfigFile '
-        command << vendor_path('mermaid_puppeteer_config.json')
-        command << ' --transparent' if config.fetch('transparent', false) != false
+        command = +'mmdc --puppeteerConfigFile '
+        command << Diagrams.vendor_path('mermaid_puppeteer_config.json')
 
         CONFIGURATIONS.each do |conf|
           command << " --#{conf} #{config[conf]}" if config.key?(conf)

data/lib/jekyll-diagrams/nomnoml.rb

@@ -6,8 +6,8 @@ module Jekyll
       def render_svg(code, config)
         command = build_command(config)
 
-        render_with_tempfile(command, code, stdout: true) do |input|
-          input
+        render_with_tempfile(command, code) do |input, output|
+          "#{input} #{output}"
         end
       end
 

data/lib/jekyll-diagrams/plantuml.rb

@@ -13,10 +13,9 @@ module Jekyll
       end
 
       def build_command(_config)
-        options = +'java'
-        options << ' -Djava.awt.headless=true'
-        options << ' -jar '
-        options << vendor_path('plantuml.1.2020.1.jar')
+        jar = Diagrams.vendor_path('plantuml.1.2020.1.jar')
+
+        options = +Diagrams.run_jar(jar)
         options << ' -tsvg -pipe'
       end
     end

data/lib/jekyll-diagrams/rendering.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require 'open3'
+require 'tempfile'
+require 'tmpdir'
+
+module Jekyll
+  module Diagrams
+    module Rendering
+      module_function
+
+      # Render SVG with stdin and stdout
+      #
+      # @param command Command to run
+      # @param content Content passed to command
+      # @return        The SVG output
+      def render_with_stdin_stdout(command, content)
+        render_with_command(command, :stdout, stdin_data: content)
+      end
+
+      # Render SVG with tempfile
+      #
+      # @param command Command to run
+      # @param content Content passed to command
+      # @param block   Result of block will append to command
+      # @return        The SVG output
+      def render_with_tempfile(command, content)
+        Dir.mktmpdir('jekyll-diagrams-rendering') do |dir|
+          input = Tempfile.new('input', tmpdir: dir)
+          output = Tempfile.new(%w[output .svg], tmpdir: dir)
+
+          File.write(input.path, content)
+
+          extra = yield input.path, output.path
+          command = "#{command} #{extra}"
+
+          render_with_command(command, output.path)
+        ensure
+          input.close!
+          output.close!
+        end
+      end
+
+      # Render SVG with command
+      #
+      # @param command Command to run
+      # @param output  Output path, use :stdout for stdout
+      # @param options Extra options passed to Open3.captrue3
+      # @return        The SVG output
+      def render_with_command(command, output = :stdout, **options)
+        begin
+          stdout, stderr, status = Open3.capture3(command, **options)
+        rescue Errno::ENOENT
+          raise Errors::CommandNotFoundError, command.split(' ')[0]
+        end
+
+        unless status.success?
+          raise Errors::RenderingFailedError, <<~MSG
+            #{command}: #{stderr.empty? ? stdout : stderr}
+          MSG
+        end
+
+        output == :stdout ? stdout : File.read(output)
+      end
+    end
+  end
+end

data/lib/jekyll-diagrams/smcat.rb

@@ -9,8 +9,8 @@ module Jekyll
       def render_svg(code, config)
         command = build_command(config)
 
-        svg = render_with_tempfile(command, code, stdout: true) do |input|
-          "#{input} --output-to -"
+        svg = render_with_tempfile(command, code) do |input, output|
+          "#{input} --output-to #{output}"
         end
 
         svg.sub!(XML_REGEX, '')

data/lib/jekyll-diagrams/vega.rb

@@ -6,7 +6,9 @@ module Jekyll
       CONFIGURATIONS = %w[scale].freeze
 
       def render_svg(code, config)
-        code = render_with_stdin_stdout('vl2vg', code) if block_name == 'vegalite'
+        if block_name == 'vegalite'
+          code = render_with_stdin_stdout('vl2vg', code)
+        end
 
         command = build_command(config)
 

data/lib/jekyll-diagrams/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module Diagrams
-    VERSION = '0.9.2'
+    VERSION = '0.9.3'
   end
 end

data/test/block_test.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class BlockTest < Minitest::Test
+end

data/test/blockdiag_test.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class BlockdiagTest < Minitest::Test
+  def setup
+    @block = Jekyll::Diagrams::BlockdiagBlock.parse(
+      'blockdiag',
+      '',
+      Liquid::Tokenizer.new('{% endblockdiag %}'),
+      Liquid::ParseContext.new
+    )
+  end
+
+  def test_build_command_with_default_config
+    config = {}
+    assert_equal 'blockdiag -T svg --nodoctype', @block.build_command(config)
+
+    config = { 'antialias' => true }
+    assert_match '--antialias', @block.build_command(config)
+
+    config = { 'antialias' => false }
+    refute_match '--antialias', @block.build_command(config)
+
+    config = { 'size' => 3 }
+    assert_match '--size=3', @block.build_command(config)
+  end
+end

data/test/erd_test.rb

@@ -4,8 +4,11 @@ require 'test_helper'
 
 class ErdTest < Minitest::Test
   def setup
-    @block = Jekyll::Diagrams::ErdBlock.send(
-      :new, 'erd', '', Liquid::ParseContext.new
+    @block = Jekyll::Diagrams::ErdBlock.parse(
+      'erd',
+      '',
+      Liquid::Tokenizer.new('test {% enderd %}'),
+      Liquid::ParseContext.new
     )
   end
 

data/test/rendering_test.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class RenderingTest < Minitest::Test
+  include Jekyll::Diagrams::Errors
+  include Jekyll::Diagrams::Rendering
+
+  def test_raise_command_not_found_error
+    assert_raises CommandNotFoundError do
+      render_with_command('not_exist_command')
+    end
+  end
+
+  def test_raise_rendering_failed_error
+    assert_raises RenderingFailedError do
+      render_with_command('/bin/bash -c "exit 1"')
+    end
+  end
+end