liquid-diagrams 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df588bcd7fd4a7aaa39d7b84616886346cd3ef33e9e731eda9eca167f6e4e546
-  data.tar.gz: b14f75ad3612cf7438acd839f91530e82197e09c8ae55e8a0c049c7edf78603a
+  metadata.gz: 7ff0b7ca83fbf4cf490ab4fa623e57d76ecc2cbcebb2745c697fb183744210f0
+  data.tar.gz: f4a5288d833f989b1a95bb0ccdcf4cfced26dcbbee7a312b474963c52649fc3d
 SHA512:
-  metadata.gz: 06152201c6a73f2198737ddb543a2fa7ad6a04f583569de17273658e5c3a270f33d3cc1bfb55660afcbf05b1ad43c64ca32916607b03229efb90d39a9cf9e96c
-  data.tar.gz: ea18e10f7b712012f179759d6baa0bab4c73471539ee4580927e75173cb3e14730414d7930b4d1de3bcbb32b4c41c993c05d049fc6e0f39145401530ee1a5e42
+  metadata.gz: bf10760e1b09e1c35c50034bf8110d1ec9df78d9ad99d296cb1d28590f58fed2e42cf9695530ae0257b738e7d7b2918162b6cb200b31892bf94d45a7258021e7
+  data.tar.gz: 1c90195bd2e4b205e801bf3b2a9c1be779d8f79d98a1f9fee90affbd20b95da3255ed238d231443d8a1ec4ac601a73a4a3099ca452da5fd7f4506f06a3adf1e5

data/README.md

@@ -2,13 +2,15 @@
 
 [![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)
+[![Feature](https://img.shields.io/travis/com/zhustec/liquid-diagrams.svg?label=Feature&style=flat-square)](https://travis-ci.com/zhustec/liquid-diagrams)
+[![Lint](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/)
+- [**Bitfield**](https://github.com/wavedrom/bitfield)
 - [**Erd**](https://github.com/BurntSushi/erd)
 - [**GraphViz**](http://graphviz.org/)
 - [**Mermaid**](https://mermaid-js.github.io/mermaid/)
@@ -17,17 +19,31 @@ Liquid Diagrams is a liquid plugins for creating diagrams, it is inspired by [as
 - [**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/).
+- [**Vegalite**](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)
+  - [Supported diagrams](#supported-diagrams)
   - [Register diagrams](#register-diagrams)
   - [Use diagrams tag](#use-diagrams-tag)
+  - [Parse Configurations](#parse-configurations)
+- [Prerequisites](#prerequisites)
 - [Configurations](#configurations)
+  - [Blockdiag](#blockdiag)
+  - [Bitfield](#bitfield)
+  - [Erd](#erd)
+  - [Graphviz](#graphviz)
+  - [Mermaid](#mermaid)
+  - [Nomnoml](#nomnoml)
+  - [PlantUML](#plantuml)
+  - [State Machine Cat](#state-machine-cat)
+  - [Svgbob](#svgbob)
+  - [Syntrax](#syntrax)
+  - [Vega](#vega)
+  - [Wavedrom](#wavedrom)
 - [Contributing](#contributing)
 - [License](#license)
 - [Code of Conduct](#code-of-conduct)
@@ -60,38 +76,44 @@ gem install liquid-diagrams
 require 'liquid_diagrams'
 ```
 
-### List of diagrams
+### Supported diagrams
 
 ```ruby
+# All supported diagrams
 LiquidDiagrams.diagrams
 #=> [:actdiag, :blockdiag, :graphviz, :mermaid, ...]
-
-# Registered diagrams, no diagrams is registered by default
-LiquidDiagrams.registered_diagrams
-# => {}
 ```
 
 ### Register diagrams
 
+Diagrams must be registered before use, no diagrams is registered by default.
+
 ```ruby
+# Registered diagrams
+LiquidDiagrams.registered_diagrams
+# => {}
+
 # 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
+You can register all diagrams with:
+
+```ruby
 LiquidDiagrams.register_diagrams(LiquidDiagrams.diagrams)
 ```
 
 ### Use diagrams tag
 
+Now you can use diagrams tag in liquid template:
+
 ```ruby
 content = <<~CONTENT
   {% blockdiag %}
@@ -107,9 +129,9 @@ template.render
 # => "<svg ...>...</svg>"
 ```
 
-## Dependencies and Configurations
+### Parse Configurations
 
-Configurations can be set for each diagrams when parse content, e.g.:
+Configurations can be set for each diagrams when parse content:
 
 ```ruby
 content = <<~CONTENT
@@ -133,7 +155,117 @@ template.render
 # => "<svg ...>...</svg>"
 ```
 
-See [Configurations](CONFIGURATIONS.md)
+## Prerequisites
+
+You still need to install some dependencies, please refer to [Prerequisites](Prerequisites.md).
+
+## Configurations
+
+### Blockdiag
+
+| Config      | Type          | Default     | Description                             |
+| ----------- | ------------- | ----------- | --------------------------------------- |
+| `antialias` | `boolean`     | unspecified | Pass diagram image to anti-alias filter |
+| `font`      | `string`      | unspecified | use FONT to draw diagram                |
+| `fontmap`   | `string`      | unspecified | use FONTMAP file to draw diagram        |
+| `size`      | `int` x `int` | unspecified | Size of diagram (ex. 320x240)           |
+
+### Bitfield
+
+| Config       | Type     | Default      | Description      |
+| ------------ | -------- | ------------ | ---------------- |
+| `fontfamily` | `string` | "sans-serif" | font family      |
+| `fontweight` | `string` | "normal"     | font weight      |
+| `fontsize`   | `number` | 14           | font size        |
+| `lanes`      | `number` | 2            | rectangle lanes  |
+| `vspace`     | `number` | 80           | vertical space   |
+| `hspace`     | `number` | 640          | horizontal space |
+| `bits`       | `number` | 32           | overall bitwidth |
+
+### Erd
+
+| Config       | Type      | Default     | Description                           |
+| ------------ | --------- | ----------- | ------------------------------------- |
+| `config`     | `string`  | unspecified | Configuration file                    |
+| `edge`       | `string`  | unspecified | Select one type of edge               |
+| `dot-entity` | `boolean` | unspecified | Use dot tables instead of HTML tables |
+
+Available values:
+
+- `edge`: `compound`, `noedge`, `ortho`, `poly`, `spline`
+
+### Graphviz
+
+| Config             | Type      | Default     | Description                  |
+| ------------------ | --------- | ----------- | ---------------------------- |
+| `layout`           | `string`  | `dot`       | Set layout engine            |
+| `graph_attributes` | see below | unspecified | Set default graph attributes |
+| `node_attributes`  | see below | unspecified | Set default node attributes  |
+| `edge_attributes`  | see below | unspecified | Set default edge attributes  |
+
+**NOTICE:** attributes can be:
+
+- `String`: eg. `color=red`
+- `Array`: eg. `['color=blue', 'fontsize=14]` or `[['color', 'blue'], ['fontsize', '14']]`
+- `Hash`: eg. `{ color: 'green', fontsize: '14' }`
+
+### Mermaid
+
+| Config            | Type     | Default | Description        |
+| ----------------- | -------- | ------- | ------------------ |
+| `width`           | `int`    | 800     | Width of the page  |
+| `height`          | `int`    | 600     | Height of the page |
+| `backgroundColor` | `string` | white   | Background color   |
+| `theme`           | `string` | default | Theme of the chart |
+
+### Nomnoml
+
+Currently no configurations
+
+### PlantUML
+
+Currently no configurations
+
+### State Machine Cat
+
+| Config       | Type     | Default    | Description              |
+| ------------ | -------- | ---------- | ------------------------ |
+| `input-type` | `string` | `smcat`    | Input type               |
+| `engine`     | `string` | `dot`      | Layout engine to use     |
+| `direction`  | `string` | `top-down` | Direction of the diagram |
+
+Available values:
+
+- `input-type`: `smcat`, `scxml`, `json`
+- `egine`: `dot`, `circo`, `fdp`, `neato`, `osage`, `twopi`
+- `direction`: `top-down`, `bottom-top`, `left-right`, `right-left`
+
+### Svgbob
+
+| Config         | Type     | Default | Description                |
+| -------------- | -------- | ------- | -------------------------- |
+| `font-family`  | `string` | arial   | Font                       |
+| `font-size`    | `int`    | 12      | Font size                  |
+| `scale`        | `int`    | 1       | Scale the entire svg       |
+| `stroke-width` | `int`    | 2       | stroke width for all lines |
+
+### Syntrax
+
+| Config        | Type      | Default     | Description            |
+| ------------- | --------- | ----------- | ---------------------- |
+| `scale`       | `int`     | 1           | Scale image            |
+| `style`       | `string`  | unspecified | Style config file      |
+| `transparent` | `boolean` | unspecified | Transparent background |
+
+### Vega
+
+| Config  | Type  | Default | Description |
+| ------- | ----- | ------- | ----------- |
+| `scale` | `int` | 1       | Scale image |
+
+### Wavedrom
+
+Currently no configurations
 
 ## Contributing
 

data/lib/liquid_diagrams.rb

@@ -30,6 +30,8 @@ module LiquidDiagrams
     end
   end
 
+  OPTIONS_KEY = :liquid_diagrams
+
   class << self
     # Return all diagrams defined in {Renderers}
     #

data/lib/liquid_diagrams/basic_block.rb

@@ -43,19 +43,28 @@ module LiquidDiagrams
       self.class.renderer.render(@content, config)
     end
 
+    # Default error handler
     def handle_error(error)
       error
     end
 
-    # Read block config from parse context
+    # Read configurations
     #
     # @return [Hash]
     def config
-      opts = options[:liquid_diagrams] || options['liquid_diagrams'] || {}
+      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
 
-      opts.fetch block_name.to_sym do
-        opts.fetch(block_name.to_s, {})
-      end
+    # Read inline options from markup
+    def inline_options
+      Utils.parse_inline_options(@markup.strip)
     end
   end
 end

data/lib/liquid_diagrams/renderers/bitfield_renderer.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module LiquidDiagrams
+  module Renderers
+    class BitfieldRenderer < BasicRenderer
+      OPTIONS = %w[
+        vspace
+        hspace
+        lanes
+        bits
+        fontsize
+        fontfamily
+        fontweight
+      ].freeze
+
+      def render
+        Rendering.render_with_tempfile(build_command, @content) do |input, output|
+          "--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/utils.rb

@@ -43,5 +43,20 @@ module LiquidDiagrams
     def vendor_path(file = '')
       File.join(__dir__, '../../vendor', file)
     end
+
+    INLINE_OPTIONS_SYNTAX = /^\s*(?:(\w+)=(\w+|"[^"]+")\s+)*\s*$/.freeze
+    INLINE_OPTIONS_REGEXP = /(?:(\w+)=(\w+|"[^"]+"))/.freeze
+
+    def parse_inline_options(input)
+      options = {}
+
+      input.scan(INLINE_OPTIONS_REGEXP) do |key, value|
+        value.delete!('"') if value&.include?('"')
+
+        options[key.to_sym] = value
+      end
+
+      options
+    end
   end
 end

data/lib/liquid_diagrams/version.rb

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

data/spec/liquid_diagrams/basic_block_spec.rb

@@ -53,4 +53,52 @@ RSpec.describe LiquidDiagrams::BasicBlock do
       expect(block.render(Liquid::Context.new)).to eq 'success'
     end
   end
+
+  describe '#config' do
+    it 'merge template options with inline options' do
+      allow(block).to receive(:template_options).and_return({ k1: :v1 })
+      allow(block).to receive(:inline_options).and_return({ k1: :v2, k2: :v2 })
+
+      expect(block.config).to eq({ k1: :v2, k2: :v2 })
+    end
+  end
+
+  describe '#template_options' do
+    let(:key) { LiquidDiagrams::OPTIONS_KEY }
+
+    it 'accept symbol key' do
+      allow(block).to receive(:parse_context).and_return({ key => { test: '1' } })
+
+      expect(block.template_options).to eq '1'
+    end
+
+    it 'accept string key' do
+      allow(block).to receive(:parse_context).and_return({ key => { 'test' => '2' } })
+
+      expect(block.template_options).to eq '2'
+    end
+  end
+
+  describe '#inline_options' do
+    let(:markup) { 'a1=v1 a2="v2" a3="k3 v3"' }
+
+    let :block do
+      TestBlock.parse(
+        'test', markup, Liquid::Tokenizer.new('{% endtest %}'),
+        Liquid::ParseContext.new
+      )
+    end
+
+    before do
+      allow(LiquidDiagrams::Utils).to receive :parse_inline_options
+    end
+
+    it 'call Utils.parse_inline_options' do
+      block.inline_options
+
+      expect(LiquidDiagrams::Utils).to have_received(
+        :parse_inline_options
+      ).with(markup)
+    end
+  end
 end

data/spec/liquid_diagrams/renderers/bitfield_renderer_spec.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe LiquidDiagrams::Renderers::BitfieldRenderer do
+  subject(:renderer) { described_class.new('content') }
+
+  describe '#render' do
+    include_examples 'render with tempfile', described_class
+  end
+
+  describe '#build_command' do
+    context 'when config is empty' do
+      it { expect(renderer.build_command).to match 'bitfield' }
+    end
+
+    context 'when config is not empty' do
+      before do
+        renderer.instance_variable_set(:@config, { 'fontsize' => 10 })
+      end
+
+      it 'build command with config' do
+        expect(renderer.build_command).to match '--fontsize 10'
+      end
+    end
+  end
+end

data/spec/liquid_diagrams/utils_spec.rb

@@ -63,4 +63,14 @@ RSpec.describe LiquidDiagrams::Utils do
       end
     end
   end
+
+  describe '.parse_inline_options' do
+    it 'parse inline options' do
+      input = 'a1=v1 a2="v2" a3="k3 v3"'
+
+      options = described_class.parse_inline_options(input)
+
+      expect(options).to match a_hash_including(a1: 'v1', a2: 'v2', a3: 'k3 v3')
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: liquid-diagrams
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - zhustec
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-02 00:00:00.000000000 Z
+date: 2020-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: liquid
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -144,6 +158,7 @@ files:
 - lib/liquid_diagrams/basic_block.rb
 - lib/liquid_diagrams/basic_renderer.rb
 - lib/liquid_diagrams/errors.rb
+- lib/liquid_diagrams/renderers/bitfield_renderer.rb
 - lib/liquid_diagrams/renderers/blockdiag_renderer.rb
 - lib/liquid_diagrams/renderers/erd_renderer.rb
 - lib/liquid_diagrams/renderers/graphviz_renderer.rb
@@ -160,6 +175,7 @@ files:
 - lib/liquid_diagrams/version.rb
 - spec/liquid_diagrams/basic_block_spec.rb
 - spec/liquid_diagrams/basic_renderer_spec.rb
+- spec/liquid_diagrams/renderers/bitfield_renderer_spec.rb
 - spec/liquid_diagrams/renderers/blockdiag_renderer_spec.rb
 - spec/liquid_diagrams/renderers/erd_renderer_spec.rb
 - spec/liquid_diagrams/renderers/graphviz_renderer_spec.rb
@@ -190,7 +206,7 @@ post_install_message: "\n    ___________________________________________________
   \   ..........................................................\n\n    Thank you
   for installing liquid-diagrams.\n\n    But it doesn't mean that you can use all
   diagrams for now,\n    You still need to install some dependencies by your self.\n\n
-  \   Please refer to the link below for more details:\n\n    https://github.com/zhustec/liquid-diagrams#readme\n\n
+  \   Please refer to the link below for more details:\n\n    https://github.com/zhustec/liquid-diagrams#prerequisites\n\n
   \   ..........................................................\n    __________________________________________________________\n
   \ "
 rdoc_options: []
@@ -212,21 +228,22 @@ signing_key:
 specification_version: 4
 summary: Liquid plugins for diagrams support.
 test_files:
-- spec/spec_helper.rb
-- spec/support/shared_examples.rb
-- spec/liquid_diagrams/rendering_spec.rb
-- spec/liquid_diagrams/basic_renderer_spec.rb
 - spec/liquid_diagrams/basic_block_spec.rb
-- spec/liquid_diagrams/renderers/nomnoml_renderer_spec.rb
+- spec/liquid_diagrams/basic_renderer_spec.rb
+- spec/liquid_diagrams/renderers/bitfield_renderer_spec.rb
+- spec/liquid_diagrams/renderers/blockdiag_renderer_spec.rb
+- spec/liquid_diagrams/renderers/erd_renderer_spec.rb
+- spec/liquid_diagrams/renderers/graphviz_renderer_spec.rb
 - spec/liquid_diagrams/renderers/mermaid_renderer_spec.rb
+- spec/liquid_diagrams/renderers/nomnoml_renderer_spec.rb
 - spec/liquid_diagrams/renderers/plantuml_renderer_spec.rb
 - spec/liquid_diagrams/renderers/smcat_renderer_spec.rb
 - spec/liquid_diagrams/renderers/svgbob_renderer_spec.rb
-- spec/liquid_diagrams/renderers/vega_renderer_spec.rb
-- spec/liquid_diagrams/renderers/blockdiag_renderer_spec.rb
-- spec/liquid_diagrams/renderers/graphviz_renderer_spec.rb
 - spec/liquid_diagrams/renderers/syntrax_renderer_spec.rb
+- spec/liquid_diagrams/renderers/vega_renderer_spec.rb
 - spec/liquid_diagrams/renderers/wavedrom_renderer_spec.rb
-- spec/liquid_diagrams/renderers/erd_renderer_spec.rb
+- spec/liquid_diagrams/rendering_spec.rb
 - spec/liquid_diagrams/utils_spec.rb
 - spec/liquid_diagrams_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples.rb