jekyll-diagrams 0.9.3 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e01b0efc75e18e6fc6eb105f1bdbd31380407a653bdf3972b61f96e69495d2f2
-  data.tar.gz: 8e505b39fa89147623fb456f6e08ba20837b92f77e4f612177f0bb25e7f2aa21
+  metadata.gz: e747a50f5b7243d7385068b039987f6a562423a2de58c5fca5a6ba2b0e3f5fcd
+  data.tar.gz: 2d2e9080efbefdea34b81df49e7b47c01ebdc753571317754ae1bfb4e28a6e0f
 SHA512:
-  metadata.gz: 2cb41b3ca6850ed7be3389369fc928cb52d7b128fef27568858a28d9ba3ade5a3b024dca39828ff875f0e69f0e6b4c0b3f9806b0c39b044f8ebc38cd5b5e7f25
-  data.tar.gz: 7a52d3fdb72daf02efb5ecc89f86f4c791c2ec8281a5787165997385baa9b156d37105fbd973a13ed6d0ad01deea22c553ead6059a80894259f97a10664a15b0
+  metadata.gz: dce4156ef2128881613b401747c9a32c17e0ac56f420e6359f32cb6c39478a5a39d807b2ed615e27f00b4ce0f357a2d3a444f50651247684f990769d0fc5a78e
+  data.tar.gz: 7d987eb136d804ce0023abe94f6acf48557063c96f9e94e11e082b65a3075d1f5fdd40d784fc682d1928bd63bc95a02fd041c8f5f782bf40303b8544bbef6edf

data/features/{blockdiag.feature → blockdiag/block.feature}

@@ -1,8 +1,8 @@
-Feature: Blockdiag
+Feature: Blockdiag Block
 
 
   Scenario: Basic Rendering
-    Given I have a file 'blockdiag.md' with content:
+    Given I have a file named 'blockdiag.md' with:
       """
       ---
       ---

data/features/graphviz/block.feature

@@ -0,0 +1,26 @@
+Feature: Graphviz Block
+
+
+  Background: I have a file with Graghviz
+    Given I have a file named 'graphviz.md' with:
+      """
+      ---
+      ---
+
+      {% graphviz %}
+      digraph {
+        A -> B;
+      }
+      {% endgraphviz %}
+      """
+
+  Scenario: Basic Rendering
+    When I run jekyll build
+    Then the file '_site/graphviz.html' should exist
+    And I should see svg output in '_site/graphviz.html'
+
+  Scenario: It Remove XML Heading
+    When I run jekyll build
+    Then the file '_site/graphviz.html' should exist
+    And I should not see '<\?xml' in '_site/graphviz.html'
+    And I should not see '<!DOCTYPE' in '_site/graphviz.html'

data/features/{graphviz.feature → graphviz/config.feature}

@@ -1,8 +1,18 @@
-Feature: Graphviz
+Feature: Graphviz Configuration
 
 
-  Background: I have a file with Graghviz
-    Given I have a file 'graphviz.md' with content:
+  Scenario: Global Configuration
+    Given I have a file named '_config.yml' with:
+      """
+      jekyll-diagrams:
+        graphviz:
+          graph_attributes: bgcolor=red
+          edge_attributes:
+            - color=green
+          node_attributes:
+            color: blue
+      """
+    And I have a file named 'graphviz.md' with:
       """
       ---
       ---
@@ -13,29 +23,6 @@ Feature: Graphviz
       }
       {% endgraphviz %}
       """
-
-  Scenario: Basic Rendering
-    When I run jekyll build
-    Then the file '_site/graphviz.html' should exist
-    And I should see svg output in '_site/graphviz.html'
-
-  Scenario: Remove XML Heading
-    When I run jekyll build
-    Then the file '_site/graphviz.html' should exist
-    And I should not see '<\?xml' in '_site/graphviz.html'
-    And I should not see '<!DOCTYPE' in '_site/graphviz.html'
-
-  Scenario: Global Configugration
-    Given I have a file '_config.yml' with content:
-      """
-      jekyll-diagrams:
-        graphviz:
-          graph_attributes: bgcolor=red
-          edge_attributes:
-            - color=green
-          node_attributes:
-            color: blue
-      """
     When I run jekyll build
     Then the file '_site/graphviz.html' should exist
     # Graph
@@ -45,15 +32,15 @@ Feature: Graphviz
     # Node
     And I should see '<ellipse .*? stroke="#0000ff"' in '_site/graphviz.html'
 
-  Scenario: Page Configugration Will Overwite Site Configuration
-    Given I have a file '_config.yml' with content:
+  Scenario: Page Configuration Will Overwite Site Configuration
+    Given I have a file named '_config.yml' with:
       """
       jekyll-diagrams:
         graphviz:
           edge_attributes:
-            color: blue
+            color: green
       """
-    And I have a file 'graphviz.md' with content:
+    And I have a file named 'graphviz.md' with:
       """
       ---
       jekyll-diagrams:
@@ -71,4 +58,4 @@ Feature: Graphviz
     When I run jekyll build
     Then the file '_site/graphviz.html' should exist
     And I should see '<path .*? stroke="#ff0000"' in '_site/graphviz.html'
-    And I should not see '<path .*? stroke="#0000ff"' in '_site/graphviz.html'
+    And I should not see '<path .*? stroke="#00ff00"' in '_site/graphviz.html'

data/features/{mermaid.feature → mermaid/block.feature}

@@ -1,8 +1,8 @@
-Feature: Mermaid
+Feature: Mermaid Block
 
 
   Scenario: Basic Rendering
-    Given I have a file 'mermaid.md' with content:
+    Given I have a file named 'mermaid.md' with:
       """
       ---
       ---

data/features/{nomnoml.feature → nomnoml/block.feature}

@@ -1,8 +1,8 @@
-Feature: Nomnoml
+Feature: Nomnoml Block
 
 
   Scenario: Basic Rendering
-    Given I have a file 'nomnoml.md' with content:
+    Given I have a file named 'nomnoml.md' with:
       """
       ---
       ---

data/features/{plantuml.feature → plantuml/block.feature}

@@ -1,8 +1,8 @@
-Feature: PlantUML
+Feature: PlantUML Block
 
 
   Background: I have a file with PlantUML
-    Given I have a file 'plantuml.md' with content:
+    Given I have a file named 'plantuml.md' with:
       """
       ---
       ---
@@ -13,20 +13,11 @@ Feature: PlantUML
       """
 
   Scenario: Basic Rendering
-    Given I have a file 'plantuml.md' with content:
-      """
-      ---
-      ---
-
-      {% plantuml %}
-      Bob->Alice : hello
-      {% endplantuml %}
-      """
     When I run jekyll build
     Then the file '_site/plantuml.html' should exist
     And I should see svg output in '_site/plantuml.html'
 
-  Scenario: Remove XML Heading
+  Scenario: It Remove XML Heading
     When I run jekyll build
     Then the file '_site/plantuml.html' should exist
     And I should not see '<\?xml' in '_site/plantuml.html'

data/features/{smcat.feature → smcat/block.feature}

@@ -1,8 +1,8 @@
-Feature: SMCat
+Feature: SMCat Block
 
 
   Background: I have a file with SMCat
-    Given I have a file 'smcat.md' with content:
+    Given I have a file named 'smcat.md' with:
       """
       ---
       ---
@@ -17,7 +17,7 @@ Feature: SMCat
     Then the file '_site/smcat.html' should exist
     And I should see svg output in '_site/smcat.html'
 
-  Scenario: Remove XML Heading
+  Scenario: It Remove XML Heading
     When I run jekyll build
     Then the file '_site/smcat.html' should exist
     And I should not see '<\?xml' in '_site/smcat.html'

data/features/step_definitions/jekyll-diagrams.rb

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

data/features/support/env.rb

@@ -3,13 +3,8 @@
 lib = File.expand_path('../lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
-# Don't use coveralls in Github Actions
-unless ENV['GITHUB_ACTIONS']
-  require 'coveralls'
-  Coveralls.wear!
-end
-
-require 'minitest'
+require 'simplecov'
+require 'rspec'
 require 'tmpdir'
 require 'jekyll-diagrams'
 
@@ -31,8 +26,7 @@ end
 def run_jekyll
   options = Jekyll.configuration(
     source: TEST_DIR,
-    quiet: true,
-    liquid: { 'error_mode' => 'strict' }
+    quiet: true
   )
 
   Jekyll::Site.new(options).process

data/features/{syntrax.feature → syntrax/block.feature}

@@ -1,8 +1,8 @@
-Feature: Syntrax
+Feature: Syntrax Block
 
 
   Scenario: Basic Rendering
-    Given I have a file 'syntrax.md' with content:
+    Given I have a file named 'syntrax.md' with:
       """
       ---
       ---

data/features/{vega.feature → vega/block.feature}

@@ -1,8 +1,8 @@
-Feature: Vega
+Feature: Vega Block
 
 
   Scenario: Basic Vega Rendering
-    Given I have a file 'vega.md' with content:
+    Given I have a file named 'vega.md' with:
       """
       ---
       ---
@@ -23,7 +23,7 @@ Feature: Vega
     And I should see svg output in '_site/vega.html'
 
   Scenario: Basic Vegalite Rendering
-    Given I have a file 'vegalite.md' with content:
+    Given I have a file named 'vegalite.md' with:
       """
       ---
       ---

data/features/{wavedrom.feature → wavedrom/block.feature}

@@ -1,8 +1,8 @@
-Feature: Wavedrom
+Feature: Wavedrom Block
 
 
   Scenario: Basic Rendering
-    Given I have a file 'wavedrom.md' with content:
+    Given I have a file named 'wavedrom.md' with:
       """
       ---
       ---

data/lib/jekyll-diagrams.rb

@@ -2,69 +2,12 @@
 
 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/utils'
 require_relative 'jekyll-diagrams/rendering'
-require_relative 'jekyll-diagrams/block'
+
+require_relative 'jekyll-diagrams/basic_renderer'
+require_relative 'jekyll-diagrams/basic_block'
 
 require_relative 'jekyll-diagrams/blockdiag'
 require_relative 'jekyll-diagrams/erd'
@@ -77,3 +20,21 @@ require_relative 'jekyll-diagrams/svgbob'
 require_relative 'jekyll-diagrams/syntrax'
 require_relative 'jekyll-diagrams/vega'
 require_relative 'jekyll-diagrams/wavedrom'
+
+module Jekyll
+  module Diagrams
+    class << self
+      def config_name
+        'jekyll-diagrams'
+      end
+
+      def logger_topic
+        'Jekyll Diagrams:'
+      end
+
+      def default_error_mode
+        :warn
+      end
+    end
+  end
+end

data/lib/jekyll-diagrams/basic_block.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Diagrams
+    class BasicBlock < Liquid::Block
+      def self.renderer
+        @renderer ||= const_get(renderer_name)
+      rescue NameError => error
+        raise Errors::RendererNotFoundError, error.message.split(' ').last
+      end
+
+      def self.renderer_name
+        @renderer_name ||= name.sub(/Block$/, 'Renderer')
+      end
+
+      def render(context)
+        self.class.renderer.render(
+          context, super.to_s, {
+            diagram_name: self.class.name.split('::').last
+                              .sub(/Block$/, '').downcase
+          }
+        )
+      rescue Errors::RendererNotFoundError => error
+        Utils.handle_error(context, error)
+      end
+    end
+  end
+end

data/lib/jekyll-diagrams/basic_renderer.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Diagrams
+    class BasicRenderer
+      include Rendering
+
+      def self.render(context, content, options = {})
+        new(context, content, options).render
+      end
+
+      def initialize(context, content, options = {})
+        @context = context
+        @content = content
+        @diagram = options.fetch(:diagram_name) do
+          self.class.name.split('::').last.sub(/Renderer$/, '').downcase
+        end
+      end
+
+      def render
+        output = render_svg(@content, configuration)
+        Utils.wrap_class(output, @diagram)
+      rescue StandardError => error
+        Utils.wrap_class(Utils.handle_error(@context, error), @diagram)
+      end
+
+      private
+
+      def configuration
+        Utils.config_for(@context, @diagram)
+      end
+
+      def render_svg(_code, _config)
+        raise NotImplementedError
+      end
+    end
+  end
+end