liquid-diagrams 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bf13af189666b210d371da56b940db2a64d320f154867ef334d196ed4d4213dd
+  data.tar.gz: 5e9c1f89224785821de3de8c7d0365b00dbec7a864e08b0de1aa9dea7ac03e8c
+SHA512:
+  metadata.gz: 5c50fbdc3ab16e9f6fd411d2819ca5492d03e239fc185273d4d2382d32c198c7c53884d0ffcef61eeda154eff0f3984c130b90e542424ebc32fae462b8b6be82
+  data.tar.gz: 203812b4bb6ecbf2d812dcb8748124f8a13050afed77986d59d22d38b0837f730ffd1ea4c3405d4ae2fdba4aa7bab1d81711456552651291bd02842f82a2d067

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 zhustec
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,124 @@
+# Liquid Diagrams
+
+[![Gem](https://img.shields.io/gem/v/liquid-diagrams.svg?label=Gem&style=flat-square)](https://rubygems.org/gems/liquid-diagrams)
+[![Test](https://img.shields.io/github/workflow/status/zhustec/liquid-diagrams/Test?label=Test&style=flat-square)](https://github.com/zhustec/liquid-diagrams/actions?query=workflow%3ATest)
+[![Linter](https://img.shields.io/github/workflow/status/zhustec/liquid-diagrams/Lint?label=Style&style=flat-square)](https://github.com/zhustec/liquid-diagrams/actions?query=workflow%3ALint)
+[![Coverage](https://img.shields.io/coveralls/github/zhustec/liquid-diagrams?label=Coverage&style=flat-square)](https://coveralls.io/github/zhustec/liquid-diagrams)
+[![License](https://img.shields.io/github/license/zhustec/liquid-diagrams.svg?label=License&style=flat-square)](https://github.com/zhustec/liquid-diagrams/blob/master/LICENSE)
+
+Liquid Diagrams is a liquid plugins for creating diagrams, it is inspired by [asciidoctor-diagram](https://github.com/asciidoctor/asciidoctor-diagram). Currently support:
+
+- [**Blockdiag**](http://blockdiag.com/en/)
+- [**Erd**](https://github.com/BurntSushi/erd)
+- [**GraphViz**](http://graphviz.org/)
+- [**Mermaid**](https://mermaid-js.github.io/mermaid/)
+- [**Nomnoml**](http://nomnoml.com/)
+- [**PlantUML**](https://plantuml.com/)
+- [**Svgbob**](https://ivanceras.github.io/svgbob-editor/)
+- [**Syntrax**](https://kevinpt.github.io/syntrax/)
+- [**Vega**](https://vega.github.io/vega/)
+- [**Vega-Lite**](https://vega.github.io/vega-lite/)
+- [**WaveDrom**](https://wavedrom.com/).
+
+**NOTE:** This project is under development currently.
+
+- [Installation](#installation)
+- [Usage](#usage)
+  - [List of diagrams](#list-of-diagrams)
+  - [Register diagrams](#register-diagrams)
+  - [Now you can use the diagrams in liquid](#now-you-can-use-the-diagrams-in-liquid)
+- [Configurations](#configurations)
+- [Contributing](#contributing)
+- [License](#license)
+- [Code of Conduct](#code-of-conduct)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'liquid-diagrams'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install liquid-diagrams
+```
+
+## Usage
+
+```ruby
+# Require `liquid_diagrams` or `liquid-diagrams`
+
+require 'liquid_diagrams'
+```
+
+### List of diagrams
+
+```ruby
+LiquidDiagrams.diagrams
+#=> [:actdiag, :blockdiag, :graphviz, :mermaid, ...]
+
+# Registered diagrams, no diagrams is registered by default
+LiquidDiagrams.registered_diagrams
+# => {}
+```
+
+### Register diagrams
+
+```ruby
+# Register one by one
+LiquidDiagrams.register_diagram :graphviz
+# => LiquidDiagrams::Blocks::GraphvizBlock
+
+# Register in batch
+LiquidDiagrams.register_diagrams :blockdiag, :mermaid
+# => [Blocks::BlockdiagBlock, Blocks::MermaidBlock]
+
+# Registered diagrams
+LiquidDiagrams.registered_diagrams
+# => {:graphviz => LiquidDiagrams::Blocks::GraphvizBlock, ...}
+
+# Register all available diagrams
+LiquidDiagrams.register_diagrams(LiquidDiagrams.diagrams)
+```
+
+### Now you can use the diagrams in liquid
+
+```ruby
+content = <<~CONTENT
+  {% blockdiag %}
+    blockdiag {
+      A -> B -> C -> D;
+      A -> E -> F -> G;
+    }
+  {% endblockdiag %}
+CONTENT
+
+template = Liquid::Template.parse(content)
+template.render
+# => "<svg ...>...</svg>"
+```
+
+## Configurations
+
+See [Configrurations](CONFIGURATIONS.md)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at <https://github.com/zhustec/liquid-diagrams.> This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/zhustec/liquid-diagrams/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the `liquid-diagrams` project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](CODE_OF_CONDUCT.md).

data/lib/liquid-diagrams.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'liquid_diagrams'

data/lib/liquid_diagrams/basic_block.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module LiquidDiagrams
+  # @abstract Subclass and override {#render} or {#render!} 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
+
+    # Render with error rescued
+    #
+    # @param context [Liquid::Context]
+    #
+    # @return String
+    def render(context)
+      @content = super.to_s
+
+      render!(context)
+    rescue Errors::BasicError => error
+      error
+    end
+
+    # Render without error rescued
+    #
+    # @param context [Liquid::Context]
+    #
+    # @return String
+    #
+    # @raise [Errors::BasicError]
+    #
+    # rubocop:disable Lint/UnusedMethodArgument
+    def render!(context)
+      self.class.renderer.render(@content, config)
+    end
+    # rubocop:enable Lint/UnusedMethodArgument
+
+    def config
+      config = (parse_context[:config] || {})
+      config.fetch(name.split('::').last.chomp('Block').downcase, {})
+    end
+  end
+end

data/lib/liquid_diagrams/basic_renderer.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module LiquidDiagrams
+  # @abstract Subclass and override {#render} to implement
+  class BasicRenderer
+    def self.render(content, options = {})
+      new(content, options).render
+    end
+
+    def initialize(content, options = {})
+      @content = content
+      @options = options
+      @config = @options.delete(:config) || {}
+    end
+
+    def render
+      raise Errors::NotImplementedError
+    end
+  end
+end

data/lib/liquid_diagrams/errors.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module LiquidDiagrams
+  module Errors
+    BasicError = Class.new(::StandardError)
+
+    CommandNotFoundError = Class.new(BasicError)
+    DiagramNotFoundError = Class.new(BasicError)
+    RenderingFailedError = Class.new(BasicError)
+    NotImplementedError = Class.new(BasicError)
+  end
+end

data/lib/liquid_diagrams/renderers/blockdiag_renderer.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module LiquidDiagrams
+  module Renderers
+    %i[ Blockdiag
+        Seqdiag
+        Actdiag
+        Nwdiag
+        Rackdiag
+        Packetdiag ].each do |diagram|
+      renderer = Class.new(BasicRenderer) do
+        const_set :OPTIONS, %w[
+          config
+          font
+          fontmap
+          size
+        ].freeze
+
+        const_set :SWITCHES, {
+          'antialias' => false
+        }.freeze
+
+        def render
+          Rendering.render_with_tempfile(build_command, @content) do |input, output|
+            "#{input} -o #{output}"
+          end
+        end
+
+        define_method :build_command do
+          command = +"#{diagram.downcase} -T svg --nodoctype"
+
+          options = self.class.const_get(:OPTIONS)
+          switches = self.class.const_get(:SWITCHES)
+
+          @config.slice(*options).each do |opt, value|
+            command << " --#{opt}=#{value}"
+          end
+
+          Utils.merge(switches, @config).each do |swc, value|
+            command << " --#{swc}" if value
+          end
+
+          command
+        end
+      end
+
+      const_set "#{diagram}Renderer", renderer
+    end
+  end
+end

data/lib/liquid_diagrams/renderers/erd_renderer.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module LiquidDiagrams
+  module Renderers
+    class ErdRenderer < BasicRenderer
+      OPTIONS = %w[
+        config
+        edge
+      ].freeze
+
+      SWITCHES = {
+        'dot-entity' => false
+      }.freeze
+
+      XML_REGEX = /^<\?xml(([^>]|\n)*>\n?){2}/.freeze
+
+      def render
+        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
+      end
+    end
+  end
+end

data/lib/liquid_diagrams/renderers/graphviz_renderer.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module LiquidDiagrams
+  module Renderers
+    class GraphvizRenderer < BasicRenderer
+      MAPPERS = {
+        'layout' => 'K',
+        'graph_attributes' => 'G',
+        'node_attributes' => 'N',
+        'edge_attributes' => 'E'
+      }.freeze
+
+      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, '')
+      end
+
+      def build_command
+        command = +'dot -Tsvg'
+
+        @config.slice(*MAPPERS.keys).each do |opt, attrs|
+          command << Utils.join(attrs, with: " -#{MAPPERS[opt]}") do |attr|
+            Array(attr).join('=')
+          end
+        end
+
+        command
+      end
+    end
+  end
+end

data/lib/liquid_diagrams/renderers/mermaid_renderer.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module LiquidDiagrams
+  module Renderers
+    class MermaidRenderer < BasicRenderer
+      OPTIONS = %w[
+        theme
+        width
+        height
+        backgroundColor
+        configFile
+        cssFile
+        scale
+      ].freeze
+
+      def render
+        Rendering.render_with_tempfile(build_command, @content) do |input, output|
+          "--input #{input} --output #{output}"
+        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
+      end
+    end
+  end
+end

data/lib/liquid_diagrams/renderers/nomnoml_renderer.rb

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

data/lib/liquid_diagrams/renderers/plantuml_renderer.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module LiquidDiagrams
+  module Renderers
+    class PlantumlRenderer < BasicRenderer
+      XML_REGEX = /^<\?xml([^>]|\n)*>\n?/.freeze
+
+      def render
+        Rendering.render_with_stdin_stdout(build_command, @content).sub(XML_REGEX, '')
+      end
+
+      def build_command
+        jar = Utils.vendor_path('Plantuml.1.2020.1.jar')
+
+        options = +Utils.run_jar(jar)
+        options << ' -tsvg -pipe'
+      end
+    end
+  end
+end

data/lib/liquid_diagrams/renderers/smcat_renderer.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module LiquidDiagrams
+  module Renderers
+    class SmcatRenderer < BasicRenderer
+      OPTIONS = %w[
+        direction
+        engine
+        input-type
+      ].freeze
+
+      XML_REGEX = /^<\?xml(([^>]|\n)*>\n?){2}/.freeze
+
+      def render
+        Rendering.render_with_tempfile(build_command, @content) do |input, output|
+          "#{input} --output-to #{output}"
+        end.sub(XML_REGEX, '')
+      end
+
+      def build_command
+        command = +'Smcat'
+
+        @config.slice(*OPTIONS).each do |opt, value|
+          command << " --#{opt} #{value}"
+        end
+
+        command
+      end
+    end
+  end
+end

data/lib/liquid_diagrams/renderers/svgbob_renderer.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module LiquidDiagrams
+  module Renderers
+    class SvgbobRenderer < BasicRenderer
+      OPTIONS = %w[
+        font-family
+        font-size
+        scale
+        stroke-width
+      ].freeze
+
+      def render
+        Rendering.render_with_stdin_stdout(build_command, @content)
+      end
+
+      def build_command
+        command = +'svgbob'
+
+        @config.slice(*OPTIONS).each do |opt, value|
+          command << " --#{opt} #{value}"
+        end
+
+        command
+      end
+    end
+  end
+end

data/lib/liquid_diagrams/renderers/syntrax_renderer.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module LiquidDiagrams
+  module Renderers
+    class SyntraxRenderer < BasicRenderer
+      OPTIONS = %w[
+        scale
+        style
+      ].freeze
+
+      def render
+        Rendering.render_with_tempfile(build_command, @content) do |input, output|
+          "--input #{input} --output #{output}"
+        end
+      end
+
+      def build_command
+        command = +'syntrax'
+
+        @config.slice(*OPTIONS).each do |opt, value|
+          command << " --#{opt} #{value}"
+        end
+
+        command
+      end
+    end
+  end
+end

data/lib/liquid_diagrams/renderers/vega_renderer.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module LiquidDiagrams
+  module Renderers
+    class VegaRenderer < BasicRenderer
+      OPTIONS = %w[
+        scale
+      ].freeze
+
+      def render
+        Rendering.render_with_stdin_stdout(build_command, @content)
+      end
+
+      def build_command
+        command = +'vg2svg'
+
+        @config.slice(*OPTIONS).each do |opt, value|
+          command << " --#{opt} #{value}"
+        end
+
+        command
+      end
+    end
+  end
+end

data/lib/liquid_diagrams/renderers/wavedrom_renderer.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module LiquidDiagrams
+  module Renderers
+    class WavedromRenderer < BasicRenderer
+      def render
+        Rendering.render_with_tempfile(build_command, @content) do |input, output|
+          "--input #{input} --svg #{output}"
+        end
+      end
+
+      def build_command
+        'wavedrom-cli'
+      end
+    end
+  end
+end

data/lib/liquid_diagrams/rendering.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'open3'
+require 'tempfile'
+require 'tmpdir'
+
+module LiquidDiagrams
+  module Rendering
+    module_function
+
+    def render_with_stdin_stdout(command, content)
+      render_with_command(command, :stdout, stdin_data: content)
+    end
+
+    def render_with_tempfile(command, content)
+      input = Tempfile.new('input')
+      output = Tempfile.new(%w[output .svg])
+
+      File.write(input.path, content)
+
+      extra = yield input.path, output.path
+      command = "#{command} #{extra}"
+
+      render_with_command(command, output.path)
+    # TODO: recue Tempfile.new and File.write error
+    ensure
+      input.close!
+      output.close!
+    end
+
+    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

data/lib/liquid_diagrams/utils.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module LiquidDiagrams
+  module Utils
+    module_function
+
+    # Join the args with prefix
+    #
+    # @param args
+    # @param with [String]
+    #
+    # @return [String]
+    #
+    # @example join on string
+    #   join('path', with: ' -I')                     # => ' -Ipath'
+    #
+    # @example join on array
+    #   join(['path1', 'path2'], with: ' -I')         # => ' -Ipath1 -Ipath2'
+    #
+    # @example join on hash
+    #   join({ color: 'red', size: '10' }, with: ' --') do |k, v|
+    #     "#{k} #{v}"
+    #   end                                           # => ' --color red --size 10'
+    def join(args, with:)
+      args = Array(args)
+      args = args.map { |arg| yield arg } if block_given?
+
+      "#{with}#{args.join(with)}"
+    end
+
+    # Merge from the hash with only those keys exists
+    #
+    # @example
+    #   merge({ k1: 1, k2: 2}, { k1: 11, k3: 13})     # => { k1: 11, k2: 2 }
+    def merge(first, second)
+      first.merge(second.slice(*first.keys))
+    end
+
+    def run_jar(jar)
+      +"java -Djava.awt.headless=true -jar #{jar}"
+    end
+
+    def vendor_path(file = '')
+      File.join(__dir__, '../../vendor', file)
+    end
+  end
+end

data/lib/liquid_diagrams/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module LiquidDiagrams
+  VERSION = '0.1.0'
+end