liquid-diagrams 0.1.0

data/spec/liquid_diagrams/utils_spec.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe LiquidDiagrams::Utils do
+  describe '.join' do
+    context 'with string input' do
+      it 'join the string with prefix' do
+        args = described_class.join('path', with: ' -I')
+
+        expect(args).to eq ' -Ipath'
+      end
+    end
+
+    context 'with array input' do
+      it 'join the array with prefix' do
+        args = described_class.join(
+          %w[path1 path2], with: ' -I'
+        )
+
+        expect(args).to eq ' -Ipath1 -Ipath2'
+      end
+    end
+
+    context 'with hash input' do
+      it 'join the hash with prefix' do
+        args = described_class.join(
+          { color: 'red', size: '10' }, with: ' --'
+        ) { |k, v| "#{k} #{v}" }
+
+        expect(args).to eq ' --color red --size 10'
+      end
+    end
+  end
+
+  describe '.merge' do
+    it 'merge the hash' do
+      hash = described_class.merge({ k1: 1, k2: 2 }, { k1: 11, k3: 13 })
+
+      expect(hash).to eq({ k1: 11, k2: 2 })
+    end
+  end
+
+  describe '.run_jar' do
+    it 'run jar in headless mode' do
+      command = described_class.run_jar('test.jar')
+
+      expect(command).to match '-Djava.awt.headless=true'
+      expect(command).to match '-jar test.jar'
+    end
+  end
+
+  describe '.vendor_path' do
+    context 'with no input' do
+      it 'return the vendor directory path' do
+        expect(described_class.vendor_path).to end_with 'vendor/'
+      end
+    end
+
+    context 'with input file name' do
+      it 'return the file path under vendor direcotry' do
+        expect(described_class.vendor_path('file')).to end_with 'vendor/file'
+      end
+    end
+  end
+end

data/spec/liquid_diagrams_spec.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+RSpec.describe LiquidDiagrams do
+  describe '.diagrams' do
+    before do
+      allow(described_class).to receive(:renderers).and_return({})
+    end
+
+    it 'return and cache diagrams' do
+      3.times { described_class.diagrams }
+
+      expect(described_class).to have_received(:renderers).once
+    end
+  end
+
+  describe '.renderers' do
+    before do
+      allow(described_class::Renderers).to receive(:constants).and_return(
+        %i[FirstRenderer SecondRenderer OtherConstant]
+      )
+      allow(described_class::Renderers).to receive(:const_get)
+    end
+
+    it 'return and cache renderers' do
+      3.times { described_class.renderers }
+
+      expect(described_class.renderers.keys).to eq %i[first second]
+      expect(described_class::Renderers).to have_received(:constants).once
+    end
+  end
+
+  describe '.register_diagrams' do
+    before { allow(described_class).to receive(:register_diagram).and_return '!' }
+
+    it 'call .register_diagram for every diagrams' do
+      described_class.register_diagrams(('a'..'e').to_a)
+
+      expect(described_class).to have_received(:register_diagram).exactly(5).times
+    end
+  end
+
+  describe '.register_diagram' do
+    before do
+      allow(described_class).to receive(:diagrams).and_return({ test: Class.new })
+    end
+
+    context 'when diagram not found' do
+      it 'raise diagram not found error' do
+        expect do
+          described_class.register_diagrams(:unkown)
+        end.to raise_error LiquidDiagrams::Errors::DiagramNotFoundError
+      end
+    end
+
+    context 'when diagram is found' do
+      let(:block) { Class.new }
+
+      before do
+        allow(Liquid::Template).to receive(:register_tag)
+        allow(described_class::Blocks).to receive(:const_get).and_return(block)
+        allow(described_class).to receive(:registered_diagrams).and_return({})
+
+        described_class.register_diagram(:test)
+      end
+
+      it 'search diagram block in Blocks module' do
+        expect(LiquidDiagrams::Blocks).to have_received(:const_get).with('TestBlock')
+      end
+
+      it 'register a liquid tag with the diagram block' do
+        expect(Liquid::Template).to have_received(:register_tag).with(:test, block)
+      end
+
+      it 'store diagram to .registered_diagrams' do
+        expect(described_class).to have_received(:registered_diagrams)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+
+require 'simplecov'
+require 'pry-byebug'
+
+require 'liquid-diagrams'
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = '.rspec_status'
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end
+
+Dir[File.join(__dir__, 'support/*.rb')].sort.each { |file| require file }

data/spec/support/shared_examples.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+RSpec.shared_examples 'render with stdin and stdout' do |kclass|
+  let(:renderer) { kclass.new 'content' }
+
+  before do
+    allow(renderer).to receive(:build_command).and_return 'cmd'
+    allow(LiquidDiagrams::Rendering).to receive(
+      :render_with_stdin_stdout
+    ).and_return 'ok'
+  end
+
+  it 'call build_command' do
+    renderer.render
+
+    expect(renderer).to have_received(:build_command)
+  end
+
+  it 'render with tempfile' do
+    expect(renderer.render).to eq 'ok'
+
+    expect(LiquidDiagrams::Rendering).to have_received(
+      :render_with_stdin_stdout
+    ).with('cmd', renderer.instance_variable_get(:@content))
+  end
+end
+
+RSpec.shared_examples 'render with tempfile' do |kclass|
+  let(:renderer) { kclass.new 'content' }
+
+  before do
+    allow(renderer).to receive(:build_command)
+    allow(LiquidDiagrams::Rendering).to receive(
+      :render_with_tempfile
+    ).and_yield('in', 'out')
+
+    renderer.render
+  end
+
+  it 'call build_command' do
+    expect(renderer).to have_received(:build_command)
+  end
+
+  it 'render with tempfile' do
+    expect(LiquidDiagrams::Rendering).to have_received(:render_with_tempfile)
+  end
+end

data/vendor/mermaid_puppeteer_config.json

@@ -0,0 +1,3 @@
+{
+    "args": ["--no-sandbox"]
+}

metadata

@@ -0,0 +1,232 @@
+--- !ruby/object:Gem::Specification
+name: liquid-diagrams
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- zhustec
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-05-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: liquid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '12.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '14.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '12.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '14.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.82.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.82.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.30'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.30'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: simplecov-lcov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+description: |
+  A Liquid plugin with support for Blockdiag, Erd, GraphViz, Mermaid,
+  Nomnoml, PlantUML, Svgbob, Syntrax, Vega, Vega-Lite and WaveDrom.
+email:
+- zhustec@foxmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/liquid-diagrams.rb
+- lib/liquid_diagrams.rb
+- lib/liquid_diagrams/basic_block.rb
+- lib/liquid_diagrams/basic_renderer.rb
+- lib/liquid_diagrams/errors.rb
+- lib/liquid_diagrams/renderers/blockdiag_renderer.rb
+- lib/liquid_diagrams/renderers/erd_renderer.rb
+- lib/liquid_diagrams/renderers/graphviz_renderer.rb
+- lib/liquid_diagrams/renderers/mermaid_renderer.rb
+- lib/liquid_diagrams/renderers/nomnoml_renderer.rb
+- lib/liquid_diagrams/renderers/plantuml_renderer.rb
+- lib/liquid_diagrams/renderers/smcat_renderer.rb
+- lib/liquid_diagrams/renderers/svgbob_renderer.rb
+- lib/liquid_diagrams/renderers/syntrax_renderer.rb
+- lib/liquid_diagrams/renderers/vega_renderer.rb
+- lib/liquid_diagrams/renderers/wavedrom_renderer.rb
+- lib/liquid_diagrams/rendering.rb
+- lib/liquid_diagrams/utils.rb
+- lib/liquid_diagrams/version.rb
+- spec/liquid_diagrams/basic_block_spec.rb
+- spec/liquid_diagrams/basic_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/syntrax_renderer_spec.rb
+- spec/liquid_diagrams/renderers/vega_renderer_spec.rb
+- spec/liquid_diagrams/renderers/wavedrom_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
+- vendor/mermaid_puppeteer_config.json
+- vendor/plantuml.1.2020.1.jar
+homepage: https://github.com/zhustec/liquid-diagrams
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/zhustec/liquid-diagrams
+  changelog_uri: https://github.com/zhustec/liquid-diagrams/releases
+  source_code_uri: https://github.com/zhustec/liquid-diagrams
+  bug_tracker_uri: https://github.com/zhustec/liquid-diagrams/issues
+post_install_message: "\n    __________________________________________________________\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
+  \   ..........................................................\n    __________________________________________________________\n
+  \ "
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+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/renderers/mermaid_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/wavedrom_renderer_spec.rb
+- spec/liquid_diagrams/renderers/erd_renderer_spec.rb
+- spec/liquid_diagrams/utils_spec.rb
+- spec/liquid_diagrams_spec.rb