jekyll-diagrams 0.9.3 → 0.10.0

data/lib/jekyll-diagrams/version.rb

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

data/lib/jekyll-diagrams/wavedrom.rb

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

data/lib/jekyll-diagrams/wavedrom/block.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Diagrams
+    class WavedromBlock < BasicBlock
+    end
+  end
+end

data/lib/jekyll-diagrams/wavedrom/renderer.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Diagrams
+    class WavedromRenderer < BasicRenderer
+      def render_svg(code, config)
+        command = build_command(config)
+
+        render_with_tempfile(command, code) do |input, output|
+          "--input #{input} --svg #{output}"
+        end
+      end
+
+      def build_command(_config)
+        'wavedrom-cli'
+      end
+    end
+  end
+end

data/spec/basic_block_spec.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Jekyll::Diagrams::BasicBlock do
+  before do
+    stub_const('TestBlock', Class.new(described_class))
+  end
+
+  describe '.renderer_name' do
+    subject { TestBlock.renderer_name }
+
+    it { is_expected.to eq 'TestRenderer' }
+  end
+
+  describe '.renderer' do
+    subject { TestBlock.renderer }
+
+    context 'when the renderer is not found' do
+      it 'raise an renderer not found error' do
+        expect { TestBlock.renderer }.to raise_error(
+          Jekyll::Diagrams::Errors::RendererNotFoundError
+        )
+      end
+    end
+
+    context 'when the renderer is found' do
+      before { stub_const('TestRenderer', Class.new) }
+
+      it { is_expected.to be TestRenderer }
+    end
+  end
+
+  describe '#render' do
+    context 'when the renderer is not found' do
+      it 'raise renderer not found error' do
+        allow(Jekyll::Diagrams::Utils).to receive(:handle_error)
+
+        Liquid::Template.register_tag(:test, TestBlock)
+
+        content = '{% test %}test{% endtest %}'
+        context = Liquid::Template.parse(content)
+        context.render(context_with_config)
+
+        expect(Jekyll::Diagrams::Utils).to have_received(:handle_error)
+      end
+    end
+
+    context 'when the renderer is found' do
+      before do
+        renderer = Class.new do
+          def self.render(_context, input, _name)
+            input
+          end
+        end
+
+        stub_const('TestRenderer', renderer)
+
+        Liquid::Template.register_tag(:test, TestBlock)
+      end
+
+      it 'render the content with the renderer' do
+        content = '{% test %}test{% endtest %}'
+        context = Liquid::Template.parse(content)
+
+        expect(context.render(context_with_config)).to eq 'test'
+      end
+    end
+  end
+end

data/spec/basic_renderer_spec.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Jekyll::Diagrams::BasicRenderer do
+  describe '.render' do
+    it 'create an instance and render' do
+      allow(described_class).to receive_message_chain(:new, :render)
+
+      described_class.render('context', 'content', { key: 'value' })
+
+      expect(described_class).to have_received(:new).with(
+        'context', 'content', { key: 'value' }
+      )
+    end
+  end
+
+  describe '#render' do
+    it 'call render_svg to render' do
+      renderer = described_class.new('context', 'content')
+
+      allow(renderer).to receive(:render_svg)
+      allow(renderer).to receive(:configuration)
+      allow(Jekyll::Diagrams::Utils).to receive(:wrap_class)
+
+      renderer.render
+
+      expect(renderer).to have_received(:render_svg)
+    end
+
+    context 'when rendering successfully' do
+      it 'wrap the output' do
+        renderer = described_class.new(context_with_config, '')
+
+        allow(renderer).to receive(:render_svg)
+        allow(Jekyll::Diagrams::Utils).to receive(:wrap_class)
+
+        renderer.render
+
+        expect(Jekyll::Diagrams::Utils).to have_received(:wrap_class)
+      end
+    end
+
+    context 'when rendering failed' do
+      it 'handle the error and wrap the return value' do
+        renderer = described_class.new(context_with_config, '')
+
+        allow(renderer).to receive(:render_svg).and_raise
+        allow(Jekyll::Diagrams::Utils).to receive(:handle_error)
+        allow(Jekyll::Diagrams::Utils).to receive(:wrap_class)
+
+        renderer.render
+
+        expect(Jekyll::Diagrams::Utils).to have_received(:handle_error)
+        expect(Jekyll::Diagrams::Utils).to have_received(:wrap_class)
+      end
+    end
+  end
+
+  describe '#render_svg' do
+    it 'raise not implemented error' do
+      renderer = described_class.new('context', 'content')
+
+      expect do
+        renderer.send(:render_svg, '', '')
+      end.to raise_error NotImplementedError
+    end
+  end
+end

data/spec/blockdiag_renderer_spec.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Jekyll::Diagrams::BlockdiagRenderer do
+  subject(:renderer) do
+    described_class.new(Liquid::ParseContext.new, '')
+  end
+
+  describe '#build_command' do
+    context 'when config is empty' do
+      let(:config) { {} }
+
+      it 'build command' do
+        expect(renderer.build_command(config)).to match '-T svg --nodoctype'
+      end
+    end
+
+    context 'when switch is true' do
+      let(:config) { { 'antialias' => true } }
+
+      it 'build command' do
+        expect(renderer.build_command(config)).to match '--antialias'
+      end
+    end
+
+    context 'when switch is false' do
+      let(:config) { { 'antialias' => false } }
+
+      it 'build command' do
+        expect(renderer.build_command(config)).not_to match '--antialias'
+      end
+    end
+
+    context 'when options with value' do
+      let(:config) { { 'size' => 3 } }
+
+      it 'build command' do
+        expect(renderer.build_command(config)).to match '--size=3'
+      end
+    end
+  end
+end

data/spec/erd_renderer_spec.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Jekyll::Diagrams::ErdRenderer do
+  subject(:renderer) do
+    described_class.new(Liquid::ParseContext.new, '')
+  end
+
+  describe '#build_command' do
+    context 'when config is empty' do
+      let(:config) { {} }
+
+      it 'build command' do
+        expect(renderer.build_command(config)).to eq 'erd --fmt=svg'
+      end
+    end
+
+    context 'when switch is true' do
+      let(:config) { { 'dot-entity' => true } }
+
+      it 'build command' do
+        expect(renderer.build_command(config)).to match '--dot-entity'
+      end
+    end
+
+    context 'when switch is false' do
+      let(:config) { { 'dot-entity' => false } }
+
+      it 'build command' do
+        expect(renderer.build_command(config)).not_to match '--dot-entity'
+      end
+    end
+
+    context 'when options with value' do
+      let(:config) { { 'edge' => 'compound' } }
+
+      it 'build command' do
+        expect(renderer.build_command(config)).to match '--edge'
+      end
+    end
+  end
+end

data/spec/graphviz_renderer_spec.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Jekyll::Diagrams::GraphvizRenderer do
+  subject(:renderer) do
+    described_class.new(Liquid::ParseContext.new, '')
+  end
+
+  describe '#build_command' do
+    context 'when config is empty' do
+      subject { renderer.build_command(config) }
+
+      let(:config) { {} }
+
+      it { is_expected.to eq 'dot -Tsvg' }
+    end
+  end
+end

data/spec/jekyll-diagrams_spec.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Jekyll::Diagrams do
+  describe '.config_name' do
+    subject { described_class.config_name }
+
+    it { is_expected.to eq 'jekyll-diagrams' }
+  end
+
+  describe '.logger_topic' do
+    subject { described_class.logger_topic }
+
+    it { is_expected.to eq 'Jekyll Diagrams:' }
+  end
+
+  describe '.defaut_error_mode' do
+    subject { described_class.default_error_mode }
+
+    it { is_expected.to eq :warn }
+  end
+end

data/spec/mermaid_renderer_spec.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Jekyll::Diagrams::MermaidRenderer do
+  subject(:renderer) do
+    described_class.new(Liquid::ParseContext.new, '')
+  end
+
+  describe '#build_command' do
+    context 'when config is empty' do
+      subject { renderer.build_command(config) }
+
+      let(:config) { {} }
+
+      it { is_expected.to match 'mmdc --puppeteerConfigFile' }
+    end
+  end
+end

data/spec/nomnoml_renderer_spec.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Jekyll::Diagrams::NomnomlRenderer do
+  subject(:renderer) do
+    described_class.new(Liquid::ParseContext.new, '')
+  end
+
+  describe '#build_command' do
+    context 'when config is empty' do
+      subject { renderer.build_command(config) }
+
+      let(:config) { {} }
+
+      it { is_expected.to eq 'nomnoml' }
+    end
+  end
+end

data/spec/plantuml_renderer_spec.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Jekyll::Diagrams::PlantUMLRenderer do
+  subject(:renderer) do
+    described_class.new(Liquid::ParseContext.new, '')
+  end
+
+  describe '#build_command' do
+    context 'when config is empty' do
+      subject { renderer.build_command(config) }
+
+      let(:config) { {} }
+
+      it { is_expected.to match 'plantuml' }
+      it { is_expected.to match '-tsvg -pipe' }
+    end
+  end
+end

data/spec/rendering_spec.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Jekyll::Diagrams::Rendering do
+  describe '.render_with_stdin_stdout' do
+    it 'call render_with_command' do
+      allow(described_class).to receive(:render_with_command)
+
+      described_class.render_with_stdin_stdout('command', 'content')
+
+      expect(described_class).to have_received(:render_with_command).with(
+        'command', :stdout, stdin_data: 'content'
+      )
+    end
+  end
+
+  describe '.render_with_tempfile' do
+    before do
+      allow(described_class).to receive(:render_with_command)
+
+      allow(Dir).to receive(:mktmpdir).and_yield('/tmp')
+      allow(File).to receive(:write)
+      allow(Tempfile).to receive_message_chain(:new, :close!)
+      allow(Tempfile).to receive_message_chain(:new, :path)
+    end
+
+    it 'call Dir.mktmpdir to create a direcory' do
+      allow(Dir).to receive(:mktmpdir)
+
+      described_class.render_with_tempfile('command', 'content')
+
+      expect(Dir).to have_received(:mktmpdir)
+    end
+
+    it 'call Tempfile.new twice to create temp file' do
+      described_class.render_with_tempfile('command', 'content') {}
+
+      expect(Tempfile).to have_received(:new).twice
+    end
+
+    it 'call render_with_command' do
+      described_class.render_with_tempfile('command', 'content') {}
+
+      expect(described_class).to have_received(:render_with_command)
+    end
+  end
+
+  describe '.render_with_command' do
+    it 'call Open3.capture3 to render' do
+      status = Object.new
+      allow(status).to receive(:success?).and_return(true)
+      allow(Open3).to receive(:capture3).and_return(['o', 'e', status])
+
+      described_class.render_with_command('command')
+
+      expect(Open3).to have_received(:capture3)
+    end
+
+    context 'when command not found' do
+      it 'raise a command not found error' do
+        allow(Open3).to receive(:capture3).and_raise(Errno::ENOENT)
+
+        expect do
+          described_class.render_with_command('command_that_is_not_exist')
+        end.to raise_error Jekyll::Diagrams::Errors::CommandNotFoundError
+      end
+    end
+
+    context 'when rendering failed' do
+      before do
+        status = Object.new
+        allow(status).to receive(:success?).and_return(false)
+        allow(Open3).to receive(:capture3).and_return(['o', 'e', status])
+      end
+
+      it 'raise a rendering failed error' do
+        expect do
+          described_class.render_with_command('command_that_will_failed')
+        end.to raise_error Jekyll::Diagrams::Errors::RenderingFailedError
+      end
+    end
+
+    context 'when output is stdout' do
+      before do
+        status = Object.new
+        allow(status).to receive(:success?).and_return(true)
+        allow(Open3).to receive(:capture3).and_return(['o', 'e', status])
+      end
+
+      it 'read output from stdout' do
+        expect(described_class.render_with_command('cmd', :stdout)).to eq 'o'
+      end
+    end
+
+    context 'when output is a file' do
+      before do
+        status = Object.new
+        allow(status).to receive(:success?).and_return(true)
+        allow(Open3).to receive(:capture3).and_return(['o', 'e', status])
+        allow(File).to receive(:read)
+      end
+
+      it 'read output from the file' do
+        described_class.render_with_command('cmd', 'a_file')
+
+        expect(File).to have_received(:read).with('a_file')
+      end
+    end
+  end
+end