jekyll-kroki-tag 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 488d990027da2d4ae306d839ab723012fa54b771af9d018b85b164ee898813f1
+  data.tar.gz: 8492e2cc74b6d5741a85c0863b1523c09969d08e16139cb9fc816f63a2c13a51
+SHA512:
+  metadata.gz: 6e96ebe980202292b408f202aac57bcb6579e12a76ff1725c2046db91cf240e33cbb3bec0c9837ef02a5925e331ab5103da754dfdf34f1f7e068a82ed4e85ee6
+  data.tar.gz: 1206b2112fe9c275221cc65494ea111b14fc460037cdee1929b8b7c6a80c58cdaa5907df9954c9f967583fa3bab66cb729f74aa30aed4ee5b7898d5b0c1d9b5e

data/.editorconfig

@@ -0,0 +1,5 @@
+[*]
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true

data/.rubocop.yml

@@ -0,0 +1,5 @@
+require:
+  - standard
+
+inherit_gem:
+  standard: config/base.yml  

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard
+ruby_version: 2.7

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## [0.1.0] 2023-08-17
+
+- Initial release

data/Gemfile

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in jekyll-kroki-tag.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+
+gem "standard", "~> 1"
+
+gem "solargraph", "~> 0.49.0"
+
+gem "jekyll", "~> 4.3"
+
+gem "minitest-power_assert", "~> 0.3.1"
+
+gem "minitest-reporters", "~> 1.6"

data/LICENSE

@@ -0,0 +1,9 @@
+Copyright (c) 2023, wtnabe
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,74 @@
+# Jekyll::KrokiTag
+
+A plugin that add feature \`text to diagram\` to Jekyll using [kroki.io](https://kroki.io/) hosting. To experiment with that code, run `bin/console` for an interactive prompt.
+
+```
+irb(main)> Liquid::Template.register_tag('kroki', Jekyll::KrokiTag::Block)
+irb(main)> t = Liquid::Template.parse('{% kroki type: "plantuml" %}actor User{% endkroki %}'
+irb(main)> puts t.render
+```
+
+result
+
+```
+  <figure class="jekyll-kroki" data-kroki-type="plantuml" data-kroki-format="svg">
+    <img src="https://kroki.io/plantuml/svg/eJxLTC7JL1IILU4tAgAVLQPZ" alt="">
+
+  </figure>
+```
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add jekyll-kroki-tag
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install jekyll-kroki-tag
+
+## Usage
+
+Add to config.
+
+```yaml
+plugins:
+  - jekyll-kroki-tag
+```
+
+Write your content.
+
+```liquid
+{% kroki type: 'plantuml' %}
+actor User
+usecase "Write great code" as case
+User -> case
+{% endkroki %}
+```
+
+A Converted HTML as below.
+
+```html
+<figure class="jekyll-kroki" data-kroki-type="plantuml" data-kroki-format="svg">
+  <img src="https://kroki.io/plantuml/svg/eJzjSkwuyS9SCC1OLeIqLU5NTixOVVAKL8osSVVIL0pNLFFIzk9JVVJILFYASXGB1Cno2kE4AHFnE90%3D" alt="">
+</figure>
+```
+
+Now you don't need to convert every test-diagram image into real image file and store it and write its path in Markdown or HTML flle.
+
+### Supported attribute
+
+ * type ( required. PlantUML, Graphviz, Mermaid, ... )
+ * format ( PNG, SVG, and more. default is svg )
+ * alt
+ * caption
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/wtnabe/jekyll-kroki-tag.

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:spec) do |t|
+  t.libs << "spec"
+  t.libs << "lib"
+  t.test_files = FileList["spec/**/*_spec.rb"]
+end
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/jekyll-kroki-tag.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "lib/jekyll/kroki_tag/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "jekyll-kroki-tag"
+  spec.version = Jekyll::KrokiTag::VERSION
+  spec.authors = ["wtnabe"]
+  spec.email = ["18510+wtnabe@users.noreply.github.com"]
+
+  spec.summary = "text-to-diagram power to Jekyll with kroki.io"
+  spec.homepage = "https://github.com/wtnabe/jekyll-kroki-tag"
+  spec.required_ruby_version = ">= 2.7.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "liquid", "~> 4"
+  spec.add_dependency "parser", "~> 3"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/jekyll/kroki_tag/error.rb

@@ -0,0 +1,5 @@
+module Jekyll
+  module KrokiTag
+    class Error < StandardError; end
+  end
+end

data/lib/jekyll/kroki_tag/option_parser.rb

@@ -0,0 +1,126 @@
+require_relative "./error"
+require "parser/current"
+
+module Jekyll
+  module KrokiTag
+    class SyntaxError < Error; end
+
+    class ArgumentError < Error; end
+
+    class MissingRequiredArgument < Error; end
+
+    class OptionParser
+      DEFINED_KWORDS = %w[type format alt caption].map(&:to_sym).freeze
+
+      #
+      # @param [string] args
+      #
+      class << self
+        #
+        # @param [string] args
+        # @return [Hash]
+        #
+        def parse(args)
+          parser = new(args)
+          parser.opts
+        end
+      end
+
+      #
+      # @param [string] args
+      #
+      def initialize(args)
+        @opts = parse!(args)
+      end
+      attr_reader :tree, :opts
+
+      #
+      # @param [string] args
+      # @return [Hash]
+      #
+      def parse!(args)
+        @tree = Parser::CurrentRuby.parse("{ #{args} }")
+
+        opts = Hash[*node_value(@tree.to_sexp_array).flatten]
+
+        if valid_options?(opts)
+          raise MissingRequiredArgument.new("required arg `type` is missing") unless opts[:type]
+          normalize(opts)
+        end
+      rescue Parser::SyntaxError => e
+        raise SyntaxError.new(e)
+      end
+
+      #
+      # @param [Hash] opts
+      # @return [Hash]
+      #
+      def normalize(opts)
+        opts[:format] ||= "svg"
+        [:type, :format].each { |k|
+          opts[k].downcase!
+        }
+
+        opts
+      end
+
+      #
+      # @param [array] opts
+      # @return [true]
+      #
+      def valid_options?(opts)
+        opts.all? { |key, val|
+          config = key.to_s.downcase.sub(/:$/, "").to_sym # standard:disable Lint/RedundantStringCoercion
+
+          if DEFINED_KWORDS.include?(config)
+            true
+          else
+            raise ArgumentError.new("`#{config}` is not allowed keyword")
+          end
+        }
+      end
+
+      #
+      # make sexp into type-type array of array
+      #
+      # [[:sym, :str], [:sym, :sym], ...]
+      #
+      def node_type(ast_array)
+        node_attribute(ast_array, key: :type)
+      end
+
+      #
+      # make sexp into value-value array of array
+      #
+      # [[:type, "plantuml"], [:format, "png"], ...]
+      #
+      def node_value(ast_array)
+        node_attribute(ast_array, key: :value)
+      end
+
+      #
+      # @param [array] ast_array
+      # @param [Symnol] key
+      # @return [array]
+      #
+      def node_attribute(ast_array, key: :type)
+        type, *vals = ast_array
+
+        case type
+        when :hash
+          vals.map { |e| node_attribute(e, key: key) }
+        when :pair
+          vals.map { |e| node_attribute(e, key: key) }
+        when :sym, :str, :int, :float
+          if key == :type
+            type
+          else
+            vals.first
+          end
+        else
+          raise ArgumentError.new("#{vals} is not in type Symbol, String, Integer and Float. Did you write invalid syntax ?")
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/kroki_tag/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module KrokiTag
+    VERSION = "0.1.0"
+  end
+end

data/lib/jekyll/kroki_tag.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+require "liquid"
+require "base64"
+require "zlib"
+require "parser/current"
+require_relative "kroki_tag/option_parser"
+require_relative "kroki_tag/error"
+require_relative "kroki_tag/version"
+
+module Jekyll
+  module KrokiTag
+    module Util
+      #
+      # @param [string] args
+      # @return [Hash]
+      #
+      def parse_args(args)
+        OptionParser.parse(args)
+      end
+
+      #
+      # @param [string] diagram
+      # @return [string]
+      #
+      def encode_diagram(diagram)
+        Base64.urlsafe_encode64(Zlib.deflate(diagram))
+      end
+
+      #
+      # @param [string] str
+      # @return [string]
+      #
+      def esc(str)
+        CGI.escapeHTML(str.to_s)
+      end
+
+      #
+      # @param [Symbol|String] type - diagram type
+      # @param [Symbol|String] format - imgage ( or document ) format
+      # @param [String] content - diagram content
+      # @return [URI]
+      #
+      def uri(type:, format:, content:)
+        URI.join("https://kroki.io/", [type, format, encode_diagram(content)].map { |e| URI.encode_www_form_component(e) }.join("/"))
+      end
+
+      #
+      # @param [string] body
+      # @param [Hash] opts
+      # @return [String]
+      #
+      def render_body(body, opts:)
+        u = uri(type: opts[:type], format: opts[:format], content: body).to_s
+        img = "<img src=\"#{u}\" alt=\"#{esc(opts[:alt])}\">"
+
+        caption = "<figcaption>#{esc(opts[:caption])}</figcaption>" if opts[:caption]
+
+        <<-EOD.chomp
+  <figure class="jekyll-kroki" data-kroki-type="#{esc(opts[:type])}" data-kroki-format="#{esc(opts[:format])}">
+    #{img}
+    #{caption}
+  </figure>
+        EOD
+      end
+    end
+
+    class Block < ::Liquid::Block
+      include Liquid::StandardFilters
+      include Util
+
+      class << self
+        #
+        # if you want to customize, read from `site.config`
+        #
+        # @param [Jekyll:Site] site
+        #
+        def register(site)
+          Liquid::Template.register_tag("kroki", self)
+        end
+      end
+
+      #
+      # @param [string] tag_name
+      # @param [string] text
+      # @param [Object] tokens
+      #
+      def initialize(tag_name, text, tokens)
+        super
+
+        @opts = parse_args(text)
+      end
+
+      #
+      # @param [Liquid::Context] context
+      # @return [string]
+      #
+      def render(context)
+        inner_text = super
+
+        render_body(inner_text, opts: @opts)
+      end
+    end
+  end
+end
+
+if defined? Jekyll::Hooks
+  Jekyll::Hooks.register(:site, :post_read) do |site|
+    Jekyll::KrokiTag::Block.register(site)
+  end
+end

data/lib/jekyll-kroki-tag.rb

@@ -0,0 +1 @@
+require_relative "./jekyll-kroki_tag"

data/lib/jekyll-kroki_tag.rb

@@ -0,0 +1 @@
+require_relative "./jekyll/kroki_tag"

data/sig/jekyll/kroki_tag.rbs

@@ -0,0 +1,8 @@
+module Jekyll
+  module KrokiTag
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+    class Block
+    end
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-kroki-tag
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- wtnabe
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-08-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: liquid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+description:
+email:
+- 18510+wtnabe@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".rubocop.yml"
+- ".standard.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- jekyll-kroki-tag.gemspec
+- lib/jekyll-kroki-tag.rb
+- lib/jekyll-kroki_tag.rb
+- lib/jekyll/kroki_tag.rb
+- lib/jekyll/kroki_tag/error.rb
+- lib/jekyll/kroki_tag/option_parser.rb
+- lib/jekyll/kroki_tag/version.rb
+- sig/jekyll/kroki_tag.rbs
+homepage: https://github.com/wtnabe/jekyll-kroki-tag
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/wtnabe/jekyll-kroki-tag
+  source_code_uri: https://github.com/wtnabe/jekyll-kroki-tag
+  changelog_uri: https://github.com/wtnabe/jekyll-kroki-tag/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: text-to-diagram power to Jekyll with kroki.io
+test_files: []