asciidoctor-mermaid 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cf054c6571d774e0c343d901f9f8891a49132718b417aaad6289f3062e254457
+  data.tar.gz: 19325bd648918a4aa728aca18979d591075d4cb380f62f175b0746ba9da10ae0
+SHA512:
+  metadata.gz: 05ff0b4ddd38f36c531665c5fc775be5790159cd0c25ba043f102bad97bf51224af794a5cea3605ad52fcc3ffbed444851b0d2b1a5997d585533a423c4c134cb
+  data.tar.gz: 51e6e80ee1e9db6b942d52a151507409a6355b535679598e6fffa4ce804cc534c3e30a0841627cdfa8efc042877936a16cc5b79f18e65f0977388f78988bcf4e

data/lib/asciidoctor-mermaid/cli.rb

@@ -0,0 +1,20 @@
+require 'open3'
+
+module Asciidoctor
+  module Mermaid
+    class Cli
+      def self.run(content, *args)
+        stdout, stderr, status =
+          Open3.capture3('mmdc', *args, stdin_data: content)
+
+        exit = status.exitstatus
+
+        if exit != 0
+          raise "mermaid-cli failed: #{stdout.empty? ? stderr : stdout}"
+        end
+
+        stdout
+      end
+    end
+  end
+end

data/lib/asciidoctor-mermaid/extension.rb

@@ -0,0 +1,41 @@
+require 'asciidoctor/extensions'
+require 'digest/md5'
+require 'tempfile'
+require_relative 'cli'
+
+class MermaidTreeProcessor < Asciidoctor::Extensions::TreeProcessor
+  def process(document)
+    document.blocks.map! do |block|
+      if block.attributes['style'] === 'source' &&
+           block.attributes['language'] === 'mermaid'
+        self.convert_block(block)
+      else
+        block
+      end
+    end
+  end
+
+  protected
+
+  def convert_block(block)
+    Asciidoctor::Block.new block.parent,
+                           :pass,
+                           source: self.render_svg(block.source).lines,
+                           attributes: {
+                             'style' => 'pass',
+                           }
+  end
+
+  def render_svg(content)
+    file_name = Digest::MD5.hexdigest(content)
+    output_file = Tempfile.new([file_name, '.svg'])
+    begin
+      ::Asciidoctor::Mermaid::Cli.run(content, "-o#{output_file.path}")
+      File.read(output_file.path)
+    ensure
+      output_file.unlink
+    end
+  end
+end
+
+Asciidoctor::Extensions.register { treeprocessor MermaidTreeProcessor }

data/lib/asciidoctor-mermaid/version.rb

@@ -0,0 +1,5 @@
+module Asciidoctor
+  module Mermaid
+    VERSION = '0.1.0'
+  end
+end

data/lib/asciidoctor-mermaid.rb

@@ -0,0 +1 @@
+require_relative 'asciidoctor-mermaid/extension'

data/spec/extension_spec.rb

@@ -0,0 +1,19 @@
+require 'asciidoctor'
+require 'asciidoctor-mermaid'
+require 'pry'
+
+MERMAID_DOC = <<-eos
+lorem ipsum 
+
+```mermaid
+flowchart LR
+    id1[flowchart node text]
+```
+eos
+
+describe 'extension' do
+  it 'renders a basic mermaid diagram' do
+    doc = Asciidoctor.convert MERMAID_DOC
+    expect(doc).to include('flowchart node text')
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,100 @@
+require 'rspec/snapshot'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See https://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
+=begin
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  # https://relishapp.com/rspec/rspec-core/docs/configuration/zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: asciidoctor-mermaid
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Justin Bennett
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-03-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: asciidoctor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: gem-release
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Asciidoctor mermaid extension
+email:
+- oss@just-be.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/asciidoctor-mermaid.rb
+- lib/asciidoctor-mermaid/cli.rb
+- lib/asciidoctor-mermaid/extension.rb
+- lib/asciidoctor-mermaid/version.rb
+- spec/extension_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/oxidecomputer/asciidoctor-mermaid
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: An Asciidoctor extension that transforms Mermaid diagrams in markdown codefences
+  to inline svgs.
+test_files:
+- spec/extension_spec.rb
+- spec/spec_helper.rb