kramdown-plantuml 1.0.0 → 1.1.1

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in kramdown-plantuml.gemspec
+gemspec
+
+gem 'codecov', require: false, group: :test

data/GitVersion.yml

@@ -0,0 +1,5 @@
+mode: ContinuousDeployment
+
+branches:
+  main:
+    mode: ContinuousDelivery

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2020 Swedbank Pay and contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,208 @@
+# Kramdown::PlantUml
+
+[![Gem Version][gem-badge]][gem-url]
+[![Ruby Gem][ruby-badge]][ruby-workflow]
+[![No Java][no-java-badge]][no-java-workflow]
+[![No PlantUML][no-plantuml-badge]][no-plantuml-workflow]
+[![Shell][shell-badge]][shell-workflow]
+[![Codecov][codecov-badge]][codecov]
+[![License][license-badge]][license]
+[![CLA assistant][cla-badge]][cla]
+[![Contributor Covenant][coc-badge]][coc]
+
+`kramdown-plantuml` allows you to use [PlantUML][plantuml] syntax within [fenced
+code blocks][fenced] in [Kramdown][kramdown] ([Jekyll][jekyll]'s default
+Markdown parser):
+
+````md
+```plantuml
+@startuml Diagram
+actor client
+node app
+database db
+db -> app
+app -> client
+@enduml
+```
+````
+
+Using the `plantuml` language identifier in fenced code blocks will allow
+`kramdown-plantuml` to pick it up and replace it with a rendered [SVG][svg]
+diagram when the Markdown is rendered to HTML. The above diagram will be
+replaced with the following (abbreviated) HTML code:
+
+```html
+<div class="plantuml">
+  <svg>
+    <!-- Snip converted SVG code -->
+  </svg>
+</div>
+```
+
+Which in place will be rendered as the following:
+
+![Rendered SVG Diagram][diagram-svg]
+
+If you configure theming (described below), the generated HTML will contain the
+name of the configured theme:
+
+```html
+<div class="plantuml theme-spacelab">
+  <svg>
+    <!-- Snip converted SVG code -->
+  </svg>
+</div>
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'kramdown-plantuml'
+```
+
+And then execute:
+
+```sh
+bundle install
+```
+
+Or install it yourself as:
+
+```sh
+gem install kramdown-plantuml
+```
+
+And then add the following to your Jekyll site's `_config.yml` file:
+
+```yaml
+plugins:
+  - "kramdown-plantuml"
+```
+
+Then, `bundle exec jekyll build` or `bundle exec jekyll serve` will execute
+`kramdown-plantuml`, converting code fenced PlantUML diagrams to beautiful
+SVG.
+
+## Requirements
+
+`kramdown-plantuml` is dependent on the Java application [PlantUML], which in
+turn is dependent on [Graphviz]. This means that both Java and Graphviz need to
+be installed for `kramdown-plantuml` to work.
+
+## Configuration
+
+`kramdown-plantuml` can be configured either directly in the `options` Hash
+provided through Kramdown or by `_config.yml` provided through Jekyll.
+
+### Theming
+
+In order to [theme] all PlantUML diagrams fed through `kramdown-plantuml`, you
+can configure a global theme with the `plantuml.theme.name` and
+`plantuml.theme.directory` properties. Only `name` is required and will allow
+any of the built-in themes to be used.
+
+The theme is simply inserted into each PlantUML diagram with the `!theme`
+declaration, so this can be centralized in configuration instead of duplicating
+it across all diagrams.
+
+Here's an example of how to configure `kramdown-plantuml` to use the `spacelab`
+theme in Jekyll's `_config.yml`:
+
+```yaml
+kramdown:
+  plantuml:
+    theme:
+      name: spacelab
+```
+
+If you have custom, local themes you'd like to use, you need to provide the
+`directory` in which they are placed alongside the `name` of the theme you'd
+like to use:
+
+```yaml
+kramdown:
+  plantuml:
+    theme:
+      name: my-custom-theme
+      directory: path/to/themes
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on [GitHub][github]. This project is
+intended to be a safe, welcoming space for collaboration, and contributors are
+expected to adhere to the [code of conduct][coc] and sign the
+[contributor's license agreement][cla].
+
+### Development
+
+In order to do development on `kramdown-plantuml`, [clone] or [fork]
+this repository, perform the changes you want and submit a [pull request][pr].
+
+The easiest way to develop and test `kramdown-plantuml` is to add it as a
+[Jekyll][jekyll] plugin installed from a local path in your `Gemfile`:
+
+```ruby
+gem 'kramdown-plantuml', path: 'path/to/kramdown-plantuml'
+```
+
+Every time you perform a change to `kramdown-plantuml`, you can then, within
+the directory of your Jekyll site, do a `bundle install` to bring the changes
+in and then start Jekyll up again afterwards with `bundle exec jekyll serve`.
+
+#### Tests
+
+A few tests are exercised with GitHub Actions every time code is pushed to the
+repository on GitHub. You can execute these tests locally by first installing
+all dependencies as such:
+
+```shell
+bundle install # Installs required Ruby Gems
+bundle exec rake maven:install # Installs the PlantUML .jar file
+```
+
+And then to execute the tests you run the following:
+
+```shell
+bundle exec rake
+```
+
+## License
+
+The code within this repository is available as open source under the terms of
+the [Apache 2.0 License][license] and the [contributor's license
+agreement][cla].
+
+[cla-badge]:            https://cla-assistant.io/readme/badge/SwedbankPay/kramdown-plantuml
+[cla]:                  https://cla-assistant.io/SwedbankPay/kramdown-plantuml
+[clone]:                https://docs.github.com/en/free-pro-team@latest/github/creating-cloning-and-archiving-repositories/cloning-a-repository
+[coc-badge]:            https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg
+[coc]:                  ./CODE_OF_CONDUCT.md
+[codecov-badge]:        https://codecov.io/gh/SwedbankPay/kramdown-plantuml/branch/main/graph/badge.svg?token=U3QJLVG3HY
+[codecov]:              https://codecov.io/gh/SwedbankPay/kramdown-plantuml/
+[diagram-svg]:          ./spec/examples/diagram.svg
+[fenced]:               https://www.markdownguide.org/extended-syntax/#syntax-highlighting
+[fork]:                 https://docs.github.com/en/free-pro-team@latest/github/getting-started-with-github/fork-a-repo
+[gem-badge]:            https://badge.fury.io/rb/kramdown-plantuml.svg
+[gem-url]:              https://rubygems.org/gems/kramdown-plantuml
+[gems]:                 https://rubygems.org
+[github]:               https://github.com/SwedbankPay/kramdown-plantuml/
+[graphviz]:             https://graphviz.org/
+[jekyll]:               https://jekyllrb.com/
+[kramdown]:             https://kramdown.gettalong.org/
+[license-badge]:        https://img.shields.io/github/license/SwedbankPay/kramdown-plantuml
+[license]:              https://opensource.org/licenses/Apache-2.0
+[no-java-badge]:        https://github.com/SwedbankPay/kramdown-plantuml/actions/workflows/no-java.yml/badge.svg
+[no-java-workflow]:     https://github.com/SwedbankPay/kramdown-plantuml/actions/workflows/no-java.yml
+[no-plantuml-badge]:    https://github.com/SwedbankPay/kramdown-plantuml/actions/workflows/no-plantuml.yml/badge.svg
+[no-plantuml-workflow]: https://github.com/SwedbankPay/kramdown-plantuml/actions/workflows/no-plantuml.yml
+[plantuml]:             https://plantuml.com/
+[pr]:                   https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/about-pull-requests
+[ruby-badge]:           https://github.com/SwedbankPay/kramdown-plantuml/actions/workflows/ruby.yml/badge.svg
+[ruby-workflow]:        https://github.com/SwedbankPay/kramdown-plantuml/actions/workflows/ruby.yml
+[shell-badge]:          https://github.com/SwedbankPay/kramdown-plantuml/actions/workflows/shell.yml/badge.svg
+[shell-workflow]:       https://github.com/SwedbankPay/kramdown-plantuml/actions/workflows/shell.yml
+[svg]:                  https://developer.mozilla.org/en-US/docs/Web/SVG
+[theme]:                https://plantuml.com/theme

data/Rakefile

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'rake'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = Dir.glob('spec/**/*_spec.rb')
+  t.rspec_opts = '--format documentation --tag ~no_plantuml --tag ~no_java --tag ~debug'
+end
+
+namespace :maven do
+  task :install do
+    require 'fileutils'
+
+    system 'mvn install'
+    bin_dir = File.join __dir__, 'bin'
+    target_file = File.join bin_dir, 'plantuml.jar'
+    repo_dir = File.expand_path '~/.m2/repository'
+    jar_glob = File.join repo_dir, '/**/plantuml*.jar'
+    first_jar = Dir[jar_glob].first
+    jar_file = File.expand_path first_jar
+
+    FileUtils.mkdir_p bin_dir
+    FileUtils.move(jar_file, target_file)
+  end
+end
+
+namespace :codecov do
+  desc 'Uploads the latest SimpleCov result set to codecov.io'
+  task :upload do
+    require 'simplecov'
+    require 'codecov'
+
+    formatter = SimpleCov::Formatter::Codecov.new
+    formatter.format(SimpleCov::ResultMerger.merged_result)
+  end
+end
+
+task default: :spec