liquid-diagrams 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ff0b7ca83fbf4cf490ab4fa623e57d76ecc2cbcebb2745c697fb183744210f0
-  data.tar.gz: f4a5288d833f989b1a95bb0ccdcf4cfced26dcbbee7a312b474963c52649fc3d
+  metadata.gz: f509267c783705d06c2de382fcdc3c6438b3301b263fcc4ec05242fe1b395427
+  data.tar.gz: b0bb12b012cd8e65f5fd159f88916157d243166b6dd8863a97e384e53ee66c98
 SHA512:
-  metadata.gz: bf10760e1b09e1c35c50034bf8110d1ec9df78d9ad99d296cb1d28590f58fed2e42cf9695530ae0257b738e7d7b2918162b6cb200b31892bf94d45a7258021e7
-  data.tar.gz: 1c90195bd2e4b205e801bf3b2a9c1be779d8f79d98a1f9fee90affbd20b95da3255ed238d231443d8a1ec4ac601a73a4a3099ca452da5fd7f4506f06a3adf1e5
+  metadata.gz: 9868d981fab84249f42023676e6f0bedd4673230a32361fb395e18792de26f6207bf3d5d2b10967e0800119491fef595962fd5dd39409e1e52ce7851077c2a68
+  data.tar.gz: e5306fa06220c4ffd2a449ccb1b5c923212587ff6d546f885b60425399302e89dc60bb6d1439bca45504dbc591d584f8f924f9dfa72da86e28282ed3c4487ecb

data/README.md

@@ -7,22 +7,7 @@
 [![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/)
-- [**Bitfield**](https://github.com/wavedrom/bitfield)
-- [**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/)
-- [**Vegalite**](https://vega.github.io/vega-lite/)
-- [**Wavedrom**](https://wavedrom.com/).
-
-**NOTE:** This project is under development currently.
+Liquid Diagrams is a liquid plugins for rendering svg diagrams, it is inspired by [asciidoctor-diagram](https://github.com/asciidoctor/asciidoctor-diagram). Currently support: [**Blockdiag**](http://blockdiag.com/en/), [**Bitfield**](https://github.com/wavedrom/bitfield), [**Erd**](https://github.com/BurntSushi/erd), [**GraphViz**](http://graphviz.org/), [**Mermaid**](https://mermaid-js.github.io/mermaid/), [**Nomnoml**](http://nomnoml.com/), [**Netlistsvg**](https://github.com/nturley/netlistsvg), [**PlantUML**](https://plantuml.com/), [**Svgbob**](https://ivanceras.github.io/svgbob-editor/), [**Syntrax**](https://kevinpt.github.io/syntrax/), [**Vega**](https://vega.github.io/vega/), [**Vegalite**](https://vega.github.io/vega-lite/), [**Wavedrom**](https://wavedrom.com/).
 
 - [Installation](#installation)
 - [Usage](#usage)
@@ -37,12 +22,14 @@ Liquid Diagrams is a liquid plugins for creating diagrams, it is inspired by [as
   - [Erd](#erd)
   - [Graphviz](#graphviz)
   - [Mermaid](#mermaid)
+  - [Netlistsvg](#netlistsvg)
   - [Nomnoml](#nomnoml)
   - [PlantUML](#plantuml)
   - [State Machine Cat](#state-machine-cat)
   - [Svgbob](#svgbob)
   - [Syntrax](#syntrax)
   - [Vega](#vega)
+  - [Vegalite](#vegalite)
   - [Wavedrom](#wavedrom)
 - [Contributing](#contributing)
 - [License](#license)
@@ -161,6 +148,8 @@ You still need to install some dependencies, please refer to [Prerequisites](Pre
 
 ## Configurations
 
+**Warning:** All default configuration are provided by upstream, so it maybe different from here.
+
 ### Blockdiag
 
 | Config      | Type          | Default     | Description                             |
@@ -218,6 +207,10 @@ Available values:
 | `backgroundColor` | `string` | white   | Background color   |
 | `theme`           | `string` | default | Theme of the chart |
 
+### Netlistsvg
+
+Currently no configurations
+
 ### Nomnoml
 
 Currently no configurations
@@ -263,6 +256,12 @@ Available values:
 | ------- | ----- | ------- | ----------- |
 | `scale` | `int` | 1       | Scale image |
 
+### Vegalite
+
+| Config  | Type  | Default | Description |
+| ------- | ----- | ------- | ----------- |
+| `scale` | `int` | 1       | Scale image |
+
 ### Wavedrom
 
 Currently no configurations

data/features/diagrams/bitfield.feature

@@ -0,0 +1,48 @@
+@diagrams
+Feature: Bitfield
+
+  As a liquid user, I want to use bitfield diagram
+
+  Background:
+    Given I have a liquid template with:
+      """
+      {% bitfield %}
+      [
+        { "name": "IPO",   "bits": 8, "attr": "RO" },
+        {                  "bits": 7 },
+        { "name": "BRK",   "bits": 5, "attr": "RW", "type": 4 },
+        { "name": "CPK",   "bits": 1 },
+        { "name": "Clear", "bits": 3 },
+        { "bits": 8 }
+      ]
+      {% endbitfield %}
+      """
+
+  Scenario: Basic Rendering
+    When I render it
+    Then the output should contains 'viewBox="0 0 640 160"'
+
+  Scenario: Configuration
+    When I render it with 'bitfield' options:
+      | hspace | 800 |
+      | vspace | 100 |
+    Then the output should contains 'viewBox="0 0 800 200"'
+
+  Scenario: Inline options
+    Given I have a liquid template with:
+      """
+      {% bitfield hspace=840 vspace=120 %}
+      [
+        { "name": "IPO",   "bits": 8, "attr": "RO" },
+        {                  "bits": 7 },
+        { "name": "BRK",   "bits": 5, "attr": "RW", "type": 4 },
+        { "name": "CPK",   "bits": 1 },
+        { "name": "Clear", "bits": 3 },
+        { "bits": 8 }
+      ]
+      {% endbitfield %}
+      """
+    When I render it with 'bitfield' options:
+      | hspace | 800 |
+      | vspace | 100 |
+    Then the output should contains 'viewBox="0 0 840 240"'

data/features/diagrams/blockdiag.feature

@@ -0,0 +1,19 @@
+@diagrams
+Feature: Blockdiag
+
+  As a liquid user, I want to use blockdiag diagram
+
+  Background:
+    Given I have a liquid template with:
+      """
+      {% blockdiag %}
+      blockdiag {
+        A -> B -> C -> D;
+        A -> E -> F -> G;
+      }
+      {% endblockdiag %}
+      """
+
+  Scenario: Basic Rendering
+    When I render it
+    Then the output should contains '<svg'

data/features/diagrams/erd.feature

@@ -0,0 +1,19 @@
+@diagrams
+@slow
+Feature: Erd
+
+  As a liquid user, I want to use erd diagram
+
+  Background:
+    Given I have a liquid template with:
+      """
+      {% erd %}
+        [Person]
+        name
+        height
+      {% enderd %}
+      """
+
+  Scenario: Basic Rendering
+    When I render it
+    Then the output should contains '<svg'

data/features/diagrams/graphviz.feature

@@ -0,0 +1,19 @@
+@diagrams
+Feature: Graphviz
+
+  As a liquid user, I want to use graphviz diagram
+
+  Background:
+    Given I have a liquid template with:
+      """
+      {% graphviz %}
+      digraph {
+        A -> B;
+      }
+      {% endgraphviz %}
+      """
+
+  Scenario: Basic Rendering
+    When I render it
+    Then the output should contains '<svg'
+    And the output should not contains '<\?xml'

data/features/diagrams/mermaid.feature

@@ -0,0 +1,20 @@
+@diagrams
+Feature: Mermaid
+
+  As a liquid user, I want to use mermaid diagram
+
+  Background:
+    Given I have a liquid template with:
+      """
+      {% mermaid %}
+      sequenceDiagram
+          participant John
+          participant Alice
+          Alice->>John: Hello John, how are you?
+          John-->>Alice: Great!
+      {% endmermaid %}
+      """
+
+  Scenario: Basic Rendering
+    When I render it
+    Then the output should contains '<svg'

data/features/diagrams/netlistsvg.feature

@@ -0,0 +1,27 @@
+@diagrams
+Feature: Netlistsvg
+
+  As a liquid user, I want to use netlistsvg diagram
+
+  Background:
+    Given I have a liquid template with:
+      """
+      {% netlistsvg %}
+      {
+        modules: {
+          up3down5: {
+            cells: {
+              "$add$input.v:17$3": {
+                type: "$add",
+                connections: {}
+              }
+            }
+          }
+        }
+      }
+      {% endnetlistsvg %}
+      """
+
+  Scenario: Basic Rendering
+    When I render it
+    Then the output should contains '<svg'

data/features/diagrams/nomnoml.feature

@@ -0,0 +1,19 @@
+@diagrams
+Feature: Nomnoml
+
+  As a liquid user, I want to use nomnoml diagram
+
+  Background:
+    Given I have a liquid template with:
+      """
+      {% nomnoml %}
+      [Pirate|eyeCount: Int|raid();pillage()|
+        [beard]--[parrot]
+        [beard]-:>[foul mouth]
+      ]
+      {% endnomnoml %}
+      """
+
+  Scenario: Basic Rendering
+    When I render it
+    Then the output should contains '<svg'

data/features/diagrams/plantuml.feature

@@ -0,0 +1,17 @@
+@diagrams
+Feature: Plantuml
+
+  As a liquid user, I want to use plantuml diagram
+
+  Background:
+    Given I have a liquid template with:
+      """
+      {% plantuml %}
+      Bob->Alice : hello
+      {% endplantuml %}
+      """
+
+  Scenario: Basic Rendering
+    When I render it
+    Then the output should contains '<svg'
+    And the output should not contains '<\?xml'

data/features/diagrams/smcat.feature

@@ -0,0 +1,23 @@
+@diagrams
+Feature: Smcat
+
+  As a liquid user, I want to use smcat diagram
+
+  Background:
+    Given I have a liquid template with:
+      """
+      {% smcat %}
+        playing {
+          resting => walking;
+          walking => resting;
+        };
+
+        playing => playing: ingest food;
+        playing => playing [type=internal]: ingest drink;
+      {% endsmcat %}
+      """
+
+  Scenario: Basic Rendering
+    When I render it
+    Then the output should contains '<svg'
+    And the output should not contains '<\?xml'

data/features/diagrams/svgbob.feature

@@ -0,0 +1,19 @@
+@diagrams
+@slow
+Feature: Svgbob
+
+  As a liquid user, I want to use svgbob diagram
+
+  Background:
+    Given I have a liquid template with:
+      """
+      {% svgbob %}
+        +------+
+        |      |
+        +------+
+      {% endsvgbob %}
+      """
+
+  Scenario: Basic Rendering
+    When I render it
+    Then the output should contains '<svg'

data/features/diagrams/syntrax.feature

@@ -0,0 +1,20 @@
+@diagrams
+Feature: Syntrax
+
+  As a liquid user, I want to use syntrax diagram
+
+  Background:
+    Given I have a liquid template with:
+      """
+      {% syntrax %}
+      indentstack(10,
+        line(opt('-'), choice('0', line('1-9', loop(None, '0-9'))),
+          opt('.', loop('0-9', None))),
+        line(opt(choice('e', 'E'), choice(None, '+', '-'), loop('0-9', None)))
+      )
+      {% endsyntrax %}
+      """
+
+  Scenario: Basic Rendering
+    When I render it
+    Then the output should contains '<svg'

data/features/diagrams/vega.feature

@@ -0,0 +1,23 @@
+@diagrams
+Feature: Vega
+
+  As a liquid user, I want to use vega diagram
+
+  Background:
+    Given I have a liquid template with:
+      """
+      {% vega %}
+      {
+        "data": {
+          "values": [
+            {"a": "A", "b": 28}
+          ]
+        },
+        "mark": "bar"
+      }
+      {% endvega %}
+      """
+
+  Scenario: Basic Rendering
+    When I render it
+    Then the output should contains '<svg'

data/features/diagrams/vegalite.feature

@@ -0,0 +1,23 @@
+@diagrams
+Feature: Vegalite
+
+  As a liquid user, I want to use vegalite diagram
+
+  Background:
+    Given I have a liquid template with:
+      """
+      {% vegalite %}
+      {
+        "data": {
+          "values": [
+            {"a": "A", "b": 28}
+          ]
+        },
+        "mark": "bar"
+      }
+      {% endvegalite %}
+      """
+
+  Scenario: Basic Rendering
+    When I render it
+    Then the output should contains '<svg'

data/features/diagrams/wavedrom.feature

@@ -0,0 +1,24 @@
+@diagrams
+Feature: Wavedrom
+
+  As a liquid user, I want to use wavedrom diagram
+
+  Background:
+    Given I have a liquid template with:
+      """
+      {% wavedrom %}
+      {
+        signal: [
+          { name: "clk",         wave: "p.....|..." },
+          { name: "Data",        wave: "x.345x|=.x", data: ["head", "body", "tail", "data"] },
+          { name: "Request",     wave: "0.1..0|1.0" },
+          {},
+          { name: "Acknowledge", wave: "1.....|01." }
+        ]
+      }
+      {% endwavedrom %}
+      """
+
+  Scenario: Basic Rendering
+    When I render it
+    Then the output should contains '<svg'

data/features/step_definitions/diagrams.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+Given('I have a liquid template with:') do |content|
+  @content = content
+end
+
+When('I render it') do
+  @output = render_liquid(@content)
+end
+
+When('I render it with {string} options:') do |key, options|
+  @output = render_liquid(@content, key.to_sym => Hash[options.raw])
+end
+
+Then('the output should contains {string}') do |pattern|
+  expect(@output).to match Regexp.new(pattern)
+end
+
+Then('the output should not contains {string}') do |pattern|
+  expect(@output).not_to match Regexp.new(pattern)
+end