liquid-diagrams 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf13af189666b210d371da56b940db2a64d320f154867ef334d196ed4d4213dd
-  data.tar.gz: 5e9c1f89224785821de3de8c7d0365b00dbec7a864e08b0de1aa9dea7ac03e8c
+  metadata.gz: df588bcd7fd4a7aaa39d7b84616886346cd3ef33e9e731eda9eca167f6e4e546
+  data.tar.gz: b14f75ad3612cf7438acd839f91530e82197e09c8ae55e8a0c049c7edf78603a
 SHA512:
-  metadata.gz: 5c50fbdc3ab16e9f6fd411d2819ca5492d03e239fc185273d4d2382d32c198c7c53884d0ffcef61eeda154eff0f3984c130b90e542424ebc32fae462b8b6be82
-  data.tar.gz: 203812b4bb6ecbf2d812dcb8748124f8a13050afed77986d59d22d38b0837f730ffd1ea4c3405d4ae2fdba4aa7bab1d81711456552651291bd02842f82a2d067
+  metadata.gz: 06152201c6a73f2198737ddb543a2fa7ad6a04f583569de17273658e5c3a270f33d3cc1bfb55660afcbf05b1ad43c64ca32916607b03229efb90d39a9cf9e96c
+  data.tar.gz: ea18e10f7b712012f179759d6baa0bab4c73471539ee4580927e75173cb3e14730414d7930b4d1de3bcbb32b4c41c993c05d049fc6e0f39145401530ee1a5e42

data/README.md

@@ -26,7 +26,7 @@ Liquid Diagrams is a liquid plugins for creating diagrams, it is inspired by [as
 - [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)
+  - [Use diagrams tag](#use-diagrams-tag)
 - [Configurations](#configurations)
 - [Contributing](#contributing)
 - [License](#license)
@@ -90,7 +90,7 @@ LiquidDiagrams.registered_diagrams
 LiquidDiagrams.register_diagrams(LiquidDiagrams.diagrams)
 ```
 
-### Now you can use the diagrams in liquid
+### Use diagrams tag
 
 ```ruby
 content = <<~CONTENT
@@ -107,9 +107,33 @@ template.render
 # => "<svg ...>...</svg>"
 ```
 
-## Configurations
+## Dependencies and Configurations
 
-See [Configrurations](CONFIGURATIONS.md)
+Configurations can be set for each diagrams when parse content, e.g.:
+
+```ruby
+content = <<~CONTENT
+  {% blockdiag %}
+    blockdiag {
+      A -> B -> C -> D;
+      A -> E -> F -> G;
+    }
+  {% endblockdiag %}
+CONTENT
+
+options = {
+  blockdiag: {
+    'scale' => 3
+  }
+  # options for other diagrams
+}
+
+template = Liquid::Template.parse(content, liquid_diagrams: options)
+template.render
+# => "<svg ...>...</svg>"
+```
+
+See [Configurations](CONFIGURATIONS.md)
 
 ## Contributing
 

data/lib/liquid_diagrams/basic_block.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
 module LiquidDiagrams
-  # @abstract Subclass and override {#render} or {#render!} to implement
+  # @abstract Subclass and override {#render_with_rescue} or
+  #   {#render_without_rescue} to implement
   class BasicBlock < ::Liquid::Block
     # Return the renderer class matching the block
     #
@@ -14,36 +15,47 @@ module LiquidDiagrams
       )
     end
 
-    # Render with error rescued
-    #
-    # @param context [Liquid::Context]
-    #
-    # @return String
+    # @note Do not overwite this method, overwrite {#render_with_rescue} or
+    #   {#render_without_recue} instead
     def render(context)
       @content = super.to_s
+      @context = context
 
-      render!(context)
-    rescue Errors::BasicError => error
-      error
+      render_with_rescue
     end
 
-    # Render without error rescued
+    # Render diagram with error rescued
     #
-    # @param context [Liquid::Context]
-    #
-    # @return String
+    # @return [String]
+    def render_with_rescue
+      render_without_rescue
+    rescue Errors::BasicError => error
+      handle_error(error)
+    end
+
+    # Render diagram without error rescued
     #
-    # @raise [Errors::BasicError]
+    # @return [String]
     #
-    # rubocop:disable Lint/UnusedMethodArgument
-    def render!(context)
+    # @raise [NameError] @see {.renderer}
+    # @raise [Errors::BasicError] if rendering failed
+    def render_without_rescue
       self.class.renderer.render(@content, config)
     end
-    # rubocop:enable Lint/UnusedMethodArgument
 
+    def handle_error(error)
+      error
+    end
+
+    # Read block config from parse context
+    #
+    # @return [Hash]
     def config
-      config = (parse_context[:config] || {})
-      config.fetch(name.split('::').last.chomp('Block').downcase, {})
+      opts = options[:liquid_diagrams] || options['liquid_diagrams'] || {}
+
+      opts.fetch block_name.to_sym do
+        opts.fetch(block_name.to_s, {})
+      end
     end
   end
 end

data/lib/liquid_diagrams/basic_renderer.rb

@@ -9,8 +9,7 @@ module LiquidDiagrams
 
     def initialize(content, options = {})
       @content = content
-      @options = options
-      @config = @options.delete(:config) || {}
+      @config = options
     end
 
     def render

data/lib/liquid_diagrams/renderers/blockdiag_renderer.rb

@@ -2,12 +2,7 @@
 
 module LiquidDiagrams
   module Renderers
-    %i[ Blockdiag
-        Seqdiag
-        Actdiag
-        Nwdiag
-        Rackdiag
-        Packetdiag ].each do |diagram|
+    %i[Blockdiag Seqdiag Actdiag Nwdiag Rackdiag Packetdiag].each do |diagram|
       renderer = Class.new(BasicRenderer) do
         const_set :OPTIONS, %w[
           config
@@ -29,14 +24,11 @@ module LiquidDiagrams
         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|
+          @config.slice(*self.class.const_get(:OPTIONS)).each do |opt, value|
             command << " --#{opt}=#{value}"
           end
 
-          Utils.merge(switches, @config).each do |swc, value|
+          Utils.merge(self.class.const_get(:SWITCHES), @config).each do |swc, value|
             command << " --#{swc}" if value
           end
 

data/lib/liquid_diagrams/renderers/plantuml_renderer.rb

@@ -10,7 +10,7 @@ module LiquidDiagrams
       end
 
       def build_command
-        jar = Utils.vendor_path('Plantuml.1.2020.1.jar')
+        jar = Utils.vendor_path('plantuml.1.2020.1.jar')
 
         options = +Utils.run_jar(jar)
         options << ' -tsvg -pipe'

data/lib/liquid_diagrams/renderers/smcat_renderer.rb

@@ -18,7 +18,7 @@ module LiquidDiagrams
       end
 
       def build_command
-        command = +'Smcat'
+        command = +'smcat'
 
         @config.slice(*OPTIONS).each do |opt, value|
           command << " --#{opt} #{value}"

data/lib/liquid_diagrams/renderers/vega_renderer.rb

@@ -2,24 +2,32 @@
 
 module LiquidDiagrams
   module Renderers
-    class VegaRenderer < BasicRenderer
-      OPTIONS = %w[
-        scale
-      ].freeze
+    %i[Vega Vegalite].each do |diagram|
+      renderer = Class.new(BasicRenderer) do
+        const_set :OPTIONS, %w[
+          scale
+        ].freeze
 
-      def render
-        Rendering.render_with_stdin_stdout(build_command, @content)
-      end
-
-      def build_command
-        command = +'vg2svg'
+        define_method :render do
+          if diagram.downcase == 'vegalite'
+            @content = Rendering.render_with_stdin_stdout('vl2vg', @content)
+          end
 
-        @config.slice(*OPTIONS).each do |opt, value|
-          command << " --#{opt} #{value}"
+          Rendering.render_with_stdin_stdout(build_command, @content)
         end
 
-        command
+        def build_command
+          command = +'vg2svg'
+
+          @config.slice(*self.class.const_get(:OPTIONS)).each do |opt, value|
+            command << " --#{opt} #{value}"
+          end
+
+          command
+        end
       end
+
+      const_set("#{diagram}Renderer", renderer)
     end
   end
 end

data/lib/liquid_diagrams/version.rb

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

data/spec/liquid_diagrams/basic_block_spec.rb

@@ -22,28 +22,35 @@ RSpec.describe LiquidDiagrams::BasicBlock do
   end
 
   describe '#render' do
-    it 'call #render!' do
-      allow(block).to receive(:render!).and_return 'success'
+    it 'call #render_with_rescue' do
+      allow(block).to receive(:render_with_rescue).and_return 'success'
 
       expect(block.render(Liquid::Context.new)).to eq 'success'
     end
+  end
 
-    context 'when rendering failed' do
-      let(:error) { LiquidDiagrams::Errors::BasicError.new }
+  describe '#render_with_rescue' do
+    it 'call #render_without_rescue' do
+      allow(block).to receive(:render_without_rescue).and_return 'success'
 
-      it 'rescue and return the error' do
-        allow(block).to receive(:render!).and_raise(error)
+      expect(block.render(Liquid::Context.new)).to eq 'success'
+    end
 
-        expect(block.render(Liquid::Context.new)).to eq error
-      end
+    it 'rescue and handle the error' do
+      allow(block).to receive(:render_without_rescue).and_raise(
+        LiquidDiagrams::Errors::BasicError.new
+      )
+      allow(block).to receive(:handle_error).and_return 'ok'
+
+      expect(block.render(Liquid::Context.new)).to eq 'ok'
     end
   end
 
-  describe '#render!' do
+  describe '#render_without_rescue' do
     it 'render with renderer' do
       allow(TestRenderer).to receive(:render).and_return 'success'
 
-      expect(block.render!(Liquid::Context.new)).to eq 'success'
+      expect(block.render(Liquid::Context.new)).to eq 'success'
     end
   end
 end

data/spec/liquid_diagrams/renderers/plantuml_renderer_spec.rb

@@ -34,7 +34,7 @@ RSpec.describe LiquidDiagrams::Renderers::PlantumlRenderer do
     it do
       command = renderer.build_command
 
-      expect(command).to match 'Plantuml'
+      expect(command).to match 'plantuml'
       expect(command).to match '-tsvg -pipe'
     end
   end

data/spec/liquid_diagrams/renderers/smcat_renderer_spec.rb

@@ -11,7 +11,7 @@ RSpec.describe LiquidDiagrams::Renderers::SmcatRenderer do
 
   describe '#build_command' do
     context 'when config is empty' do
-      it { expect(renderer.build_command).to eq 'Smcat' }
+      it { expect(renderer.build_command).to eq 'smcat' }
     end
 
     context 'when config is not empty' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: liquid-diagrams
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - zhustec