liquid-diagrams 0.3.0 → 0.4.0

data/features/support/env.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+
+require 'pry-byebug'
+
+require 'liquid_diagrams'
+
+LiquidDiagrams.register_diagrams(LiquidDiagrams.diagrams)
+
+def render_liquid(content, options = {})
+  template = Liquid::Template.parse(content, liquid_diagrams: options)
+
+  template.render
+end

data/lib/liquid_diagrams.rb

@@ -11,28 +11,20 @@ require_relative 'liquid_diagrams/rendering'
 require_relative 'liquid_diagrams/basic_renderer'
 require_relative 'liquid_diagrams/basic_block'
 
-module LiquidDiagrams
-  # @note All renderers should be defined under this module
-  module Renderers
-    pattern = File.join(__dir__, 'liquid_diagrams/renderers/*_renderer.rb')
-
-    Dir[pattern].sort.each { |renderer| require renderer }
-  end
+require_relative 'liquid_diagrams/renderers'
+require_relative 'liquid_diagrams/blocks'
 
-  # @note All blocks are automaticly define under this module if not exist
-  module Blocks
-    Renderers.constants.grep(/Renderer$/).each do |renderer|
-      block_name = "#{renderer.to_s.chomp('Renderer')}Block"
+module LiquidDiagrams
+  OPTIONS_KEY = :liquid_diagrams
 
-      next if Blocks.const_defined?(block_name)
+  class << self
+    # Return configuration of diagram
+    def configuration(options, key: nil, default: {})
+      config = options[OPTIONS_KEY.to_sym] || options[OPTIONS_KEY.to_s] || {}
 
-      Blocks.const_set(block_name, Class.new(BasicBlock))
+      key ? (config.dig(key.to_sym) || config.dig(key.to_s) || default) : config
     end
-  end
 
-  OPTIONS_KEY = :liquid_diagrams
-
-  class << self
     # Return all diagrams defined in {Renderers}
     #
     # @return [Array<Symbol>]

data/lib/liquid_diagrams/basic_block.rb

@@ -1,70 +1,40 @@
 # frozen_string_literal: true
 
 module LiquidDiagrams
-  # @abstract Subclass and override {#render_with_rescue} or
-  #   {#render_without_rescue} to implement
+  # @abstract Subclass and override {#render_content} to implement
   class BasicBlock < ::Liquid::Block
     # Return the renderer class matching the block
-    #
-    # @return [BasicRenderer]
-    #
-    # @raise [NameError] if renderer class not found
     def self.renderer
       @renderer ||= Renderers.const_get(
         name.split('::').last.gsub(/Block$/, 'Renderer')
       )
     end
 
-    # @note Do not overwite this method, overwrite {#render_with_rescue} or
-    #   {#render_without_recue} instead
+    # @note Do not override this method, override {#render_content} instead
     def render(context)
-      @content = super.to_s
       @context = context
+      @content = super.to_s
+      @config = read_config
 
-      render_with_rescue
+      render_content
     end
 
-    # Render diagram with error rescued
-    #
-    # @return [String]
-    def render_with_rescue
-      render_without_rescue
+    def render_content
+      self.class.renderer.render(@content, @config)
     rescue Errors::BasicError => error
       handle_error(error)
     end
 
-    # Render diagram without error rescued
-    #
-    # @return [String]
-    #
-    # @raise [NameError] @see {.renderer}
-    # @raise [Errors::BasicError] if rendering failed
-    def render_without_rescue
-      self.class.renderer.render(@content, config)
-    end
-
-    # Default error handler
     def handle_error(error)
       error
     end
 
-    # Read configurations
-    #
-    # @return [Hash]
-    def config
-      template_options.merge(inline_options)
-    end
-
-    # Read block options from parse context
-    def template_options
-      opts = parse_context[OPTIONS_KEY] || parse_context[OPTIONS_KEY.to_s] || {}
-
-      opts.fetch(block_name.to_sym) { opts.fetch(block_name, {}) }
-    end
+    # @api private
+    def read_config
+      options = LiquidDiagrams.configuration(parse_context, key: block_name)
+      inline_options = Utils.parse_inline_options(@markup.strip)
 
-    # Read inline options from markup
-    def inline_options
-      Utils.parse_inline_options(@markup.strip)
+      options.merge(inline_options)
     end
   end
 end

data/lib/liquid_diagrams/basic_renderer.rb

@@ -1,8 +1,25 @@
 # frozen_string_literal: true
 
 module LiquidDiagrams
-  # @abstract Subclass and override {#render} to implement
+  # @abstract Subclass and override {#render} to implement.
   class BasicRenderer
+    include Rendering
+
+    # Configuration key for argument with boolean value.
+    FLAGS = [].freeze
+
+    # Prefix for {FLAGS}
+    FLAGS_PREFIX = '--'
+
+    # Configuration key for argument with key-value pairs.
+    OPTIONS = [].freeze
+
+    # Separator for key and value of {OPTIONS}.
+    OPTIONS_SEPARATOR = ' '
+
+    # Prefix for {OPTIONS}
+    OPTIONS_PREFIX = '--'
+
     def self.render(content, options = {})
       new(content, options).render
     end
@@ -12,8 +29,33 @@ module LiquidDiagrams
       @config = options
     end
 
+    # Default render method with {Errors::NotImplementedError} raised
+    #
+    # @important You should overrite this method in your own renderer class
     def render
       raise Errors::NotImplementedError
     end
+
+    def build_command
+      "#{executable} #{arguments}".strip
+    end
+
+    def executable
+      self.class.name.split('::').last.sub(/Renderer$/, '').downcase
+    end
+
+    def arguments
+      flags = Utils.build_flags(
+        @config, self.class.const_get(:FLAGS),
+        prefix: self.class.const_get(:FLAGS_PREFIX)
+      )
+      options = Utils.build_options(
+        @config, self.class.const_get(:OPTIONS),
+        prefix: self.class.const_get(:OPTIONS_PREFIX),
+        sep: self.class.const_get(:OPTIONS_SEPARATOR)
+      )
+
+      "#{flags} #{options}".strip
+    end
   end
 end

data/lib/liquid_diagrams/blocks.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module LiquidDiagrams
+  # @note All blocks are automaticly define under this module if not defined
+  module Blocks
+    Renderers.constants.grep(/Renderer$/).each do |renderer|
+      block_name = "#{renderer.to_s.chomp('Renderer')}Block"
+
+      next if Blocks.const_defined?(block_name)
+
+      Blocks.const_set(block_name, Class.new(BasicBlock))
+    end
+  end
+end

data/lib/liquid_diagrams/renderers.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module LiquidDiagrams
+  # @note All renderers should be defined under this module
+  module Renderers
+    pattern = File.join(__dir__, 'renderers/*_renderer.rb')
+
+    Dir[pattern].sort.each { |renderer| require renderer }
+  end
+end

data/lib/liquid_diagrams/renderers/bitfield_renderer.rb

@@ -3,11 +3,17 @@
 module LiquidDiagrams
   module Renderers
     class BitfieldRenderer < BasicRenderer
+      FLAGS = %w[
+        compact
+        hflip
+        vflip
+      ].freeze
+
       OPTIONS = %w[
-        vspace
-        hspace
-        lanes
         bits
+        lanes
+        hspace
+        vspace
         fontsize
         fontfamily
         fontweight
@@ -18,16 +24,6 @@ module LiquidDiagrams
           "--input #{input} > #{output}"
         end
       end
-
-      def build_command
-        command = +'bitfield'
-
-        @config.slice(*OPTIONS).each do |opt, value|
-          command << " --#{opt} #{value}"
-        end
-
-        command
-      end
     end
   end
 end

data/lib/liquid_diagrams/renderers/blockdiag_renderer.rb

@@ -4,6 +4,10 @@ module LiquidDiagrams
   module Renderers
     %i[Blockdiag Seqdiag Actdiag Nwdiag Rackdiag Packetdiag].each do |diagram|
       renderer = Class.new(BasicRenderer) do
+        const_set :FLAGS, %w[
+          antialias
+        ].freeze
+
         const_set :OPTIONS, %w[
           config
           font
@@ -11,9 +15,7 @@ module LiquidDiagrams
           size
         ].freeze
 
-        const_set :SWITCHES, {
-          'antialias' => false
-        }.freeze
+        const_set :OPTIONS_SEPARATOR, '='
 
         def render
           Rendering.render_with_tempfile(build_command, @content) do |input, output|
@@ -21,18 +23,8 @@ module LiquidDiagrams
           end
         end
 
-        define_method :build_command do
-          command = +"#{diagram.downcase} -T svg --nodoctype"
-
-          @config.slice(*self.class.const_get(:OPTIONS)).each do |opt, value|
-            command << " --#{opt}=#{value}"
-          end
-
-          Utils.merge(self.class.const_get(:SWITCHES), @config).each do |swc, value|
-            command << " --#{swc}" if value
-          end
-
-          command
+        define_method :executable do
+          "#{diagram.downcase} -Tsvg --nodoctype"
         end
       end
 

data/lib/liquid_diagrams/renderers/erd_renderer.rb

@@ -3,14 +3,16 @@
 module LiquidDiagrams
   module Renderers
     class ErdRenderer < BasicRenderer
+      FLAGS = %w[
+        dot-entity
+      ].freeze
+
       OPTIONS = %w[
         config
         edge
       ].freeze
 
-      SWITCHES = {
-        'dot-entity' => false
-      }.freeze
+      OPTIONS_SEPARATOR = '='
 
       XML_REGEX = /^<\?xml(([^>]|\n)*>\n?){2}/.freeze
 
@@ -18,18 +20,8 @@ module LiquidDiagrams
         Rendering.render_with_stdin_stdout(build_command, @content).sub(XML_REGEX, '')
       end
 
-      def build_command
-        command = +'erd --fmt=svg'
-
-        @config.slice(*OPTIONS).each do |opt, value|
-          command << " --#{opt}=#{value}"
-        end
-
-        Utils.merge(SWITCHES, @config).each do |switch, value|
-          command << " --#{switch}" if value
-        end
-
-        command
+      def executable
+        'erd --fmt=svg'
       end
     end
   end

data/lib/liquid_diagrams/renderers/graphviz_renderer.rb

@@ -3,7 +3,7 @@
 module LiquidDiagrams
   module Renderers
     class GraphvizRenderer < BasicRenderer
-      MAPPERS = {
+      CONFIG_MAPPERS = {
         'layout' => 'K',
         'graph_attributes' => 'G',
         'node_attributes' => 'N',
@@ -13,20 +13,20 @@ module LiquidDiagrams
       XML_REGEX = /^<\?xml(([^>]|\n)*>\n?){2}/.freeze
 
       def render
-        output = Rendering.render_with_stdin_stdout(build_command, @content)
-        output.dup.force_encoding('utf-8').sub(XML_REGEX, '')
+        Rendering.render_with_stdin_stdout(build_command, @content)
+                 .encode('utf-8').sub(XML_REGEX, '')
       end
 
-      def build_command
-        command = +'dot -Tsvg'
+      def executable
+        'dot -Tsvg'
+      end
 
-        @config.slice(*MAPPERS.keys).each do |opt, attrs|
-          command << Utils.join(attrs, with: " -#{MAPPERS[opt]}") do |attr|
+      def arguments
+        @config.slice(*CONFIG_MAPPERS.keys).map do |opt, attrs|
+          Utils.join(attrs, with: " -#{CONFIG_MAPPERS[opt]}") do |attr|
             Array(attr).join('=')
           end
-        end
-
-        command
+        end.join(' ')
       end
     end
   end

data/lib/liquid_diagrams/renderers/mermaid_renderer.rb

@@ -19,15 +19,8 @@ module LiquidDiagrams
         end
       end
 
-      def build_command
-        command = +'mmdc --puppeteerConfigFile '
-        command << Utils.vendor_path('mermaid_puppeteer_config.json')
-
-        @config.slice(*OPTIONS).each do |opt, value|
-          command << " --#{opt} #{value}"
-        end
-
-        command
+      def executable
+        "mmdc --puppeteerConfigFile #{Utils.vendor_path('puppeteer.json')}"
       end
     end
   end

data/lib/liquid_diagrams/renderers/netlistsvg_renderer.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module LiquidDiagrams
+  module Renderers
+    class NetlistsvgRenderer < BasicRenderer
+      def render
+        Rendering.render_with_tempfile(build_command, @content) do |input, output|
+          "#{input} -o #{output}"
+        end
+      end
+    end
+  end
+end

data/lib/liquid_diagrams/renderers/nomnoml_renderer.rb

@@ -8,10 +8,6 @@ module LiquidDiagrams
           "#{input} #{output}"
         end
       end
-
-      def build_command
-        'nomnoml'
-      end
     end
   end
 end

data/lib/liquid_diagrams/renderers/plantuml_renderer.rb

@@ -6,14 +6,14 @@ module LiquidDiagrams
       XML_REGEX = /^<\?xml([^>]|\n)*>\n?/.freeze
 
       def render
-        Rendering.render_with_stdin_stdout(build_command, @content).sub(XML_REGEX, '')
+        Rendering.render_with_stdin_stdout(build_command, @content)
+                 .sub(XML_REGEX, '')
       end
 
-      def build_command
-        jar = Utils.vendor_path('plantuml.1.2020.1.jar')
+      def executable
+        jar_path = Utils.vendor_path('plantuml.1.2020.1.jar')
 
-        options = +Utils.run_jar(jar)
-        options << ' -tsvg -pipe'
+        "#{Utils.run_jar(jar_path)} -tsvg -pipe"
       end
     end
   end