jekyll-diagrams 0.9.1 → 0.9.2

data/lib/jekyll-diagrams/mermaid.rb

@@ -1,29 +1,32 @@
+# frozen_string_literal: true
+
 module Jekyll
-    module Diagrams
-      class MermaidBlock < Block
-        CONFIGURATIONS = %w( backgroundColor height theme width).freeze
+  module Diagrams
+    class MermaidBlock < Block
+      CONFIGURATIONS = %w[backgroundColor height theme width].freeze
 
-        def render_svg(code, config)
-          command = build_command(config)
+      def render_svg(code, config)
+        command = build_command(config)
 
-          render_with_tempfile(command, code) do |command, input, output|
-            "#{command} --input #{input} --output #{output}"
-          end
+        render_with_tempfile(command, code) do |input, output|
+          "--input #{input} --output #{output}"
         end
+      end
 
-        def build_command(config)
-          command = 'mmdc'
-          command << ' --transparent' if config.has_key?('transparent')
-          command << " --puppeteerConfigFile #{vendor_path('mermaid_puppeteer_config.json')}"
-
-          CONFIGURATIONS.each do |conf|
-            command << " --#{conf} #{config[conf]}" if config.has_key?(conf)
-          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
+        CONFIGURATIONS.each do |conf|
+          command << " --#{conf} #{config[conf]}" if config.key?(conf)
         end
+
+        command
       end
     end
   end
+end
 
-  Liquid::Template.register_tag(:mermaid, Jekyll::Diagrams::MermaidBlock)
+Liquid::Template.register_tag(:mermaid, Jekyll::Diagrams::MermaidBlock)

data/lib/jekyll-diagrams/nomnoml.rb

@@ -1,19 +1,21 @@
+# frozen_string_literal: true
+
 module Jekyll
   module Diagrams
     class NomnomlBlock < Block
       def render_svg(code, config)
         command = build_command(config)
 
-        render_with_tempfile(command, code, stdout: true) do |command, input|
-          "#{command} #{input}"
+        render_with_tempfile(command, code, stdout: true) do |input|
+          input
         end
       end
 
-      def build_command(config)
+      def build_command(_config)
         'nomnoml'
       end
     end
   end
 end
 
-Liquid::Template.register_tag(:nomnoml, Jekyll::Diagrams::NomnomlBlock)
+Liquid::Template.register_tag(:nomnoml, Jekyll::Diagrams::NomnomlBlock)

data/lib/jekyll-diagrams/plantuml.rb

@@ -1,15 +1,19 @@
+# frozen_string_literal: true
+
 module Jekyll
   module Diagrams
     class PlantUMLBlock < Block
+      XML_REGEX = /^<\?xml([^>]|\n)*>\n?/.freeze
+
       def render_svg(code, config)
         command = build_command(config)
 
         svg = render_with_stdin_stdout(command, code)
-        svg.sub!(/^<\?xml([^>]|\n)*>\n?/, '')
+        svg.sub!(XML_REGEX, '')
       end
 
-      def build_command(config)
-        options = 'java'
+      def build_command(_config)
+        options = +'java'
         options << ' -Djava.awt.headless=true'
         options << ' -jar '
         options << vendor_path('plantuml.1.2020.1.jar')
@@ -19,4 +23,4 @@ module Jekyll
   end
 end
 
-Liquid::Template.register_tag(:plantuml, Jekyll::Diagrams::PlantUMLBlock)
+Liquid::Template.register_tag(:plantuml, Jekyll::Diagrams::PlantUMLBlock)

data/lib/jekyll-diagrams/smcat.rb

@@ -1,23 +1,26 @@
+# frozen_string_literal: true
+
 module Jekyll
   module Diagrams
     class SMCatBlock < Block
-      CONFIGURATIONS = %w( direction engine input-type ).freeze
+      XML_REGEX = /^<\?xml(([^>]|\n)*>\n?){2}/.freeze
+      CONFIGURATIONS = %w[direction engine input-type].freeze
 
       def render_svg(code, config)
         command = build_command(config)
 
-        svg = render_with_tempfile(command, code, stdout: true) do |command, input|
-          "#{command} #{input} -"
+        svg = render_with_tempfile(command, code, stdout: true) do |input|
+          "#{input} --output-to -"
         end
 
-        svg.sub!(/^<\?xml(([^>]|\n)*>\n?){2}/, '')
+        svg.sub!(XML_REGEX, '')
       end
 
       def build_command(config)
-        command = 'smcat'
+        command = +'smcat'
 
         CONFIGURATIONS.each do |conf|
-          command << " --#{conf} #{config[conf]}" if config.has_key?(conf)
+          command << " --#{conf} #{config[conf]}" if config.key?(conf)
         end
 
         command
@@ -26,4 +29,4 @@ module Jekyll
   end
 end
 
-Liquid::Template.register_tag(:smcat, Jekyll::Diagrams::SMCatBlock)
+Liquid::Template.register_tag(:smcat, Jekyll::Diagrams::SMCatBlock)

data/lib/jekyll-diagrams/svgbob.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module Jekyll
   module Diagrams
     class SvgbobBlock < Block
-      CONFIGURATIONS = %w( font-family font-size scale stroke-width ).freeze
+      CONFIGURATIONS = %w[font-family font-size scale stroke-width].freeze
 
       def render_svg(code, config)
         command = build_command(config)
@@ -10,10 +12,10 @@ module Jekyll
       end
 
       def build_command(config)
-        command = 'svgbob'
+        command = +'svgbob'
 
         CONFIGURATIONS.each do |conf|
-          command << " --#{conf} #{config[conf]}" if config.has_key?(conf)
+          command << " --#{conf} #{config[conf]}" if config.key?(conf)
         end
 
         command
@@ -22,4 +24,4 @@ module Jekyll
   end
 end
 
-Liquid::Template.register_tag(:svgbob, Jekyll::Diagrams::SvgbobBlock)
+Liquid::Template.register_tag(:svgbob, Jekyll::Diagrams::SvgbobBlock)

data/lib/jekyll-diagrams/syntrax.rb

@@ -1,21 +1,23 @@
+# frozen_string_literal: true
+
 module Jekyll
   module Diagrams
     class SyntraxBlock < Block
-      CONFIGURATIONS = %w( scale style ).freeze
+      CONFIGURATIONS = %w[scale style].freeze
 
       def render_svg(code, config)
         command = build_command(config)
 
-        render_with_tempfile(command, code) do |command, input, output|
-          "#{command} --input #{input} --output #{output}"
+        render_with_tempfile(command, code) do |input, output|
+          "--input #{input} --output #{output}"
         end
       end
 
       def build_command(config)
-        command = 'syntrax'
+        command = +'syntrax'
 
         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 +26,4 @@ module Jekyll
   end
 end
 
-Liquid::Template.register_tag(:syntrax, Jekyll::Diagrams::SyntraxBlock)
+Liquid::Template.register_tag(:syntrax, Jekyll::Diagrams::SyntraxBlock)

data/lib/jekyll-diagrams/util.rb

@@ -1,28 +1,95 @@
+# frozen_string_literal: true
+
+require 'open3'
+require 'tempfile'
+
 module Jekyll
   module Diagrams
     module Util
-      extend self
+      module_function
 
       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?
+        site_config = context.registers[:site].config.fetch(config_name, {})
+        page_config = context.registers[:page].fetch(config_name, {})
 
-        Jekyll.warn "Configuration `diagram` in _config.yml will be depreated"
-        Jekyll.warn "    Rename it to `jekyll-diagram` instead."
-
-        old_config.merge(new_config)
+        site_config.merge(page_config)
       end
 
       def config_for(context, name)
         diagrams_config(context).fetch(name, {})
       end
 
+      def config_name
+        'jekyll-diagrams'
+      end
+
       def vendor_path(file = '')
         File.join(File.expand_path('../../vendor', __dir__), file)
       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
+
+      def render_with_stdin_stdout(command, content)
+        render_with_stdin(command, content, stdout: true)
+      end
+
+      def render_with_stdin(command, content, stdout: false, &block)
+        if stdout == true
+          render_with_command(command, :stdout, stdin_data: content)
+        else
+          output = Tempfile.open(['jekyll_diagrams_output', '.svg'])
+          output.close
+          extra = block.call(ouput.path)
+          command = "#{command} #{extra}"
+
+          render_with_command(command, output.path, stdin_data: content)
+        end
+      end
+
+      def render_with_tempfile(command, content, stdout: false, &block)
+        Tempfile.open('jekyll_diagrams_input') do |input|
+          File.write(input.path, content)
+
+          if stdout == true
+            extra = block.call(input.path)
+            command = "#{command} #{extra}"
+
+            render_with_command(command, :stdout)
+          else
+            output = Tempfile.open(['jekyll_diagrams_output', '.svg'])
+            output.close
+            extra = block.call(input.path, output.path)
+            command = "#{command} #{extra}"
+
+            render_with_command(command, output.path)
+          end
+        end
+      end
+
+      def render_with_command(command, output, options = {})
+        stdout, stderr, status = Open3.capture3(command, options)
+
+        unless status.success?
+          raise <<~MESSAGE
+            Failed to render command: #{command}
+            #{stdout}
+            #{stderr}
+          MESSAGE
+        end
+
+        output == :stdout ? stdout : File.read(output)
+      end
     end
   end
-end
+end

data/lib/jekyll-diagrams/vega.rb

@@ -1,20 +1,23 @@
+# frozen_string_literal: true
+
 module Jekyll
   module Diagrams
     class VegaBlock < Block
-      CONFIGURATIONS = %w( scale )
+      CONFIGURATIONS = %w[scale].freeze
 
       def render_svg(code, config)
         code = render_with_stdin_stdout('vl2vg', code) if block_name == 'vegalite'
+
         command = build_command(config)
 
         render_with_stdin_stdout(command, code)
       end
 
       def build_command(config)
-        command = 'vg2svg'
+        command = +'vg2svg'
 
         CONFIGURATIONS.each do |conf|
-          command << " --#{conf} #{config[conf]}" if config.has_key?(conf)
+          command << " --#{conf} #{config[conf]}" if config.key?(conf)
         end
 
         command
@@ -23,6 +26,6 @@ module Jekyll
   end
 end
 
-%i(vega vegalite).each do |tag|
+%i[vega vegalite].each do |tag|
   Liquid::Template.register_tag(tag, Jekyll::Diagrams::VegaBlock)
-end
+end

data/lib/jekyll-diagrams/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Jekyll
   module Diagrams
-    VERSION = '0.9.1'
+    VERSION = '0.9.2'
   end
-end
+end

data/lib/jekyll-diagrams/wavedrom.rb

@@ -1,19 +1,21 @@
+# frozen_string_literal: true
+
 module Jekyll
   module Diagrams
     class WavedromBlock < Block
       def render_svg(code, config)
         command = build_command(config)
 
-        render_with_tempfile(command, code) do |command, input, output|
-          "#{command} --input #{input} --svg #{output}"
+        render_with_tempfile(command, code) do |input, output|
+          "--input #{input} --svg #{output}"
         end
       end
 
-      def build_command(config)
+      def build_command(_config)
         'wavedrom-cli'
       end
     end
   end
 end
 
-Liquid::Template.register_tag(:wavedrom, Jekyll::Diagrams::WavedromBlock)
+Liquid::Template.register_tag(:wavedrom, Jekyll::Diagrams::WavedromBlock)

data/test/erd_test.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class ErdTest < Minitest::Test
+  def setup
+    @block = Jekyll::Diagrams::ErdBlock.send(
+      :new, 'erd', '', Liquid::ParseContext.new
+    )
+  end
+
+  def test_build_command_with_default_config
+    config = {}
+    assert_equal 'erd --fmt=svg', @block.build_command(config)
+
+    config = { 'edge' => 'compound' }
+    assert_match 'edge', @block.build_command(config)
+
+    config = { 'dot-entity' => true }
+    assert_match 'dot-entity', @block.build_command(config)
+  end
+end

data/test/test_helper.rb

@@ -1,16 +1,13 @@
+# frozen_string_literal: true
 
 lib = File.expand_path('../lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 require 'coveralls'
-
 Coveralls.wear!
 
+require 'minitest/autorun'
+
 require 'fileutils'
 require 'jekyll'
-
-require 'jekyll-diagrams/util'
-require 'jekyll-diagrams/renderer'
-require 'jekyll-diagrams/block'
-
-require 'minitest/autorun'
+require 'jekyll-diagrams'

data/test/util_test.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class UtilTest < Minitest::Test
+  include Jekyll::Diagrams::Util
+
+  def test_normalized_attrs
+    attrs = 'color=red'
+    assert_equal ' -Ecolor=red', normalized_attrs(attrs, prefix: ' -E')
+
+    attrs = %w[color=red background=green]
+    assert_equal ' -Gcolor=red -Gbackground=green',
+                 normalized_attrs(attrs, prefix: ' -G')
+
+    attrs = { 'color' => 'red', 'background' => 'green' }
+    assert_equal ' -Ncolor=red -Nbackground=green',
+                 normalized_attrs(attrs, prefix: ' -N')
+  end
+end