lordoftheflies-jekyll-plantuml-proxy 0.1.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2cff2c6a2fb117d78e534cce523971750d2ed5e623f2c3fa7de1f771fa38f23f
+  data.tar.gz: b5be8bb0079b5b4f6c7a4d24c8d20167f129df2169685afc45cba05106771290
+SHA512:
+  metadata.gz: d56d22f1698554b3e181fe4485df5c2efa271fb7b672b6edfc82ff3c998b519b54f9a3549379937404dee4c167d1ea08bd1e6332208f54e7a3979ad1bcd5e273
+  data.tar.gz: 3991234da609af5223cd12a37d8c3af2e1f566e1af9b1fe8160d0caf10c4f8faae8ed02d1786a53589d88324cc68ba2268ebc12cee698a1aea3515d095ccaa20

data/LICENSE.txt

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Patrick Allain
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,54 @@
+# jekyll-plantuml-proxy
+
+[![security](https://hakiri.io/github/Patouche/jekyll-plantuml-proxy/master.svg)](https://hakiri.io/github/Patouche/jekyll-plantuml-proxy/master) [![Build Status](https://travis-ci.org/Patouche/jekyll-plantuml-proxy.svg)](https://travis-ci.org/Patouche/jekyll-plantuml-proxy)
+
+
+A plugin for jekyll to use plantuml diagram inside your [Jekyll](http://jekyllrb.com/) for you website. This will use external resource to build plantuml diagram. Once created, the diagram is store on the filesystem to prevent any unnecessary diagram generation. So, using this plugin, provide a simple way to integrate plantuml diagramm without the [Graphiz](http://www.graphviz.org/) software or the using the [plantuml](http://sourceforge.net/projects/plantuml/files/plantuml.jar/download) jar file.
+
+## Installation
+
+To install this plugin on Jekyll, you just have to follow the guideline of Jekyll [documentation](http://jekyllrb.com/docs/plugins/)
+
+## Usage
+
+To use the jekyll-plantuml-proxy plugin, you just have to wrap you text between `{% uml %}` and `{% enduml %}` tags.
+
+For example, to create a basic shema between Bob and Alice, you can write the following code :
+
+``` text
+{% uml %}
+Bob -> Alice : Hello 
+{% enduml %}
+```
+
+This will retrieve the binary from a remote provider and add it into the folder defined in your configuration.
+
+![Bob and Alice generated](./images/bob-alice.png)
+
+The generated html will have be something like :
+
+``` html
+<img src="/assets/images/plantuml/765f88ab868d9706e797ff2c90c67a549a144c52adf0bf2e247d355cf981b9aa.png" />
+```
+
+Any update of the uml will regenerated the image file using the remote. If the uml is not modified, no request will be made on the remote provider.
+
+## Configuration
+
+For now, the configuration is really poor. You can just change the remote provider and the location where are store the binary files.
+
+``` yaml
+plantuml:
+  url:	 'http://www.plantuml.com/plantuml/png/{code}'
+  assets:  '_images/plantuml/'
+```
+
+### Notes
+
+I'm sorry if it's sad code for a ruby developper which I'm not. I tried to do my best and to share it with the community. So please be lenient.
+
+If you have any request, please leave a message and don't hesitate for any pull request.
+
+## License
+
+This plugin is under the MIT license. See [LICENSE.txt](./LICENSE.txt) file for more details.

data/lib/jekyll-remote-plantuml.rb

@@ -0,0 +1,58 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2015 Patrick Allain
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy of
+# this software and associated documentation files (the "Software"), to deal in
+# the Software without restriction, including without limitation the rights to
+# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+# the Software, and to permit persons to whom the Software is furnished to do so,
+# subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+require 'jekyll'
+require 'plantuml-config'
+require 'plantuml-encode64'
+require 'plantuml-loader'
+
+#
+
+# Jekyll plugin for plantuml generation
+#
+# Any generation is store localy to prevent any further call
+# on a remote provider.
+module Jekyll
+
+    class PlantUmlBlock < Liquid::Block
+
+        # Plugin initilializer
+        def initialize(tag_name, markup, tokens)
+            super
+            @markup = markup;
+        end
+
+        # Render
+        def render(context)
+            output = super(context);
+            code, pconf, baseurl = PlantUmlEncode64.new(output).encode(), PlantUmlConfig::DEFAULT, Jekyll.configuration({})['baseurl'];
+            p = {:url => pconf[:url], :type => pconf[:type], :code => code }
+            Jekyll.logger.debug "Generate html with input params  :", p;
+            d = RemoteLoader.instance.savedRemoteBinary(p);
+            return "<img src=\"%{baseurl}%{uri}\" />" % d.merge({ :baseurl => baseurl });
+        end
+
+    end
+    
+end
+
+Liquid::Template.register_tag('uml', Jekyll::PlantUmlBlock);
+

data/lib/plantuml-config.rb

@@ -0,0 +1,43 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2015 Patrick Allain
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy of
+# this software and associated documentation files (the "Software"), to deal in
+# the Software without restriction, including without limitation the rights to
+# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+# the Software, and to permit persons to whom the Software is furnished to do so,
+# subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+require 'singleton';
+
+#
+
+# Jelyll plugin configuration for plantuml plugin.
+# This will define default value for any missing value in configuration
+#
+# @todo : for now, all of this value are not use.
+class PlantUmlConfig
+    include Singleton
+
+    # Default configuration as a constant hash
+    # If a definition cannot be found in the jekyll configuration, this configuration
+    # will be use
+    DEFAULT = {
+        :assets       => '_images/plantuml/',
+        :type         => 'svg',
+        :encode       => 'encode64',
+        :url          => 'http://www.plantuml.com/plantuml/{type}/{code}'
+    }
+
+end

data/lib/plantuml-encode64.rb

@@ -0,0 +1,90 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2015 Patrick Allain
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy of
+# this software and associated documentation files (the "Software"), to deal in
+# the Software without restriction, including without limitation the rights to
+# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+# the Software, and to permit persons to whom the Software is furnished to do so,
+# subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+# Encode the uml code into a string to provide for building the image with a remote provider.
+#
+# This code is inspired by the page of plantuml website http://plantuml.sourceforge.net/codephp.html
+class PlantUmlEncode64
+
+    def initialize(input)
+        @input = input;
+    end
+
+    # Public : proceed to the encoding for plantuml servlet
+    #
+    # Returns the encoded uml to send to the servlet
+    def encode()
+        require 'zlib';
+        o = @input.force_encoding("utf-8");
+        o = Zlib::Deflate.new(nil, -Zlib::MAX_WBITS).deflate(o, Zlib::FINISH)
+        return PlantUmlEncode64.encode64(o);
+    end
+
+    # Internal : Encode is some special base 64.
+    #
+    # @param a deflate string
+    # Returns a encoded string
+    def self.encode64(input)
+        len, i, out =  input.length, 0, "";
+        while i < len do
+            i1 = (i+1 < len) ? input[i+1].ord : 0;
+            i2 = (i+2 < len) ? input[i+2].ord : 0;
+            out += append3bytes(input[i].ord, i1, i2);
+            i += 3;
+        end
+        return out
+    end
+
+    def self.encode6bit(b)
+        if b < 10 then
+        return (48 + b).chr;
+        end
+
+        b -= 10;
+        if b < 26 then
+        return (65 + b).chr;
+        end
+
+        b -= 26;
+        if b < 26 then
+        return (97 + b).chr;
+        end
+
+        b -= 26;
+        if b == 0 then
+            return '-';
+        end
+
+        return (b == 1) ? '_' : '?';
+    end
+
+    def self.append3bytes(b1, b2, b3)
+        c1 = (b1 >> 2)
+        c2 = ((b1 & 0x3) << 4) | (b2 >> 4)
+        c3 = ((b2 & 0xF) << 2) | (b3 >> 6)
+        c4 = b3 & 0x3F;
+        r = encode6bit(c1 & 0x3F)
+        r += encode6bit(c2 & 0x3F);
+        r += encode6bit(c3 & 0x3F);
+        return r + encode6bit(c4 & 0x3F);
+    end
+
+end

data/lib/plantuml-loader.rb

@@ -0,0 +1,122 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2015 Patrick Allain
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy of
+# this software and associated documentation files (the "Software"), to deal in
+# the Software without restriction, including without limitation the rights to
+# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+# the Software, and to permit persons to whom the Software is furnished to do so,
+# subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+# Remote loader to retrieve binary or text file from remote url
+# depending of the parameters provide and the method use
+#
+
+require 'digest'
+require 'fileutils'
+require 'jekyll';
+
+require 'singleton'
+require 'open-uri'
+require 'plantuml-config'
+
+# Load data from a remote url.
+
+#
+# data is loaded once time. If we can found data in cache, just use
+# the cache instead of making lot of remote call.
+class RemoteLoader
+    include Singleton
+
+    # Callback for plain text content
+    CONTENT_CALLBACKS = {
+        'svg' => { :matcher => /\<\?xml.*?\>/, :replacement => '' }
+    }
+
+    # Initialization of the loaded dir
+    #
+    # Define the constant for the prefix url for binary file
+    # and the directory where all file will be saved
+    def initialize()
+        conf = Jekyll.configuration({});
+        initConf = conf['plantuml'] || {};
+        pconf = PlantUmlConfig::DEFAULT.merge(initConf);
+        dirname = conf['source'] + File::SEPARATOR + pconf[:assets].gsub(/\//, File::SEPARATOR).sub(/\/*$/, '').sub(/^\/*/, '');
+        Jekyll.logger.info "Directory for storage remote data : %s" % [dirname],
+        unless File.directory?(dirname) then
+            Jekyll.logger.info "Create directory %s because this seems to be missing" % [dirname]
+            FileUtils.mkdir_p(dirname)
+        end
+        @prefixUrl = pconf[:assets];
+        @dirname = dirname;
+    end
+
+    # Internal : get the url from a config
+    #
+    # @param a hash with {:url, :code, :type } inside it
+    # Returns the url for remote to retrieve
+    def createRemoteUri(params)
+        uri = params[:url];
+        uri = uri.gsub(/\{code\}/, params[:code])
+        uri = uri.gsub(/\{type\}/,  params[:type])
+        return uri;
+    end
+
+    # Internal : get the data for the remote connection
+    #
+    # @param a hash with {:url, :code, :type } inside it
+    # Returns the data as a hash
+    def getData(params)
+        ruri = createRemoteUri(params);
+        fn = Digest::SHA256.hexdigest(ruri) + "." + params[:type]
+        return { :remoteUri => ruri, :uri  => @prefixUrl + fn, :path => @dirname + File::SEPARATOR + fn }
+    end
+
+    # Public : get and saved the remote uri from a parameters hash
+    # if the same content has already been downloaded previously,
+    # just retrieve return the file information.
+    #
+    # @param a hash with {:url, :code, :type } inside it
+    # Returns a hash with { :remoteUri, :uri, :path }
+    def savedRemoteBinary(params)
+        Jekyll.logger.debug "Plantuml remote loader params :", params;
+        data = getData(params);
+        unless File.exist?(data[:path]) then
+            Jekyll.logger.info "Starting download content at %{remoteUri} done into file %{path}." % data;
+            open(data[:path], 'wb') do |file|
+                file << open(data[:remoteUri]).read
+                Jekyll.logger.info "End download content at %{remoteUri} done into file %{path}." % data;
+            end
+        else
+            Jekyll.logger.info "File %{path} has been found. Not download at %{remoteUri} will be made." % data;
+        end
+        return data;
+    end
+
+    # Public : get and saved the remote uri from a parameters hash
+    # if the same content has already been downloaded previously,
+    # just return the file content.
+    #
+    # @param a hash with {:url, :code, :type } inside it
+    # Returns the content of the remote
+    def loadText(params)
+        d = savedRemoteBinary(params);
+        content, tc = File.read(d[:path]), CONTENT_CALLBACKS[params[:type].downcase];
+        if tc then
+            content = content.gsub(tc[:matcher], tc[:replacement]);
+        end
+        return content;
+    end
+
+end

data/test/test_plantuml-encode64.rb

@@ -0,0 +1,14 @@
+require 'minitest/autorun'
+require 'plantuml-encode64'
+
+class PlantUmlEncode64Test < Minitest::Test
+
+    def setup
+        Jekyll.logger.log_level = :debug
+    end
+
+    def test_encode_one
+        assert_equal "SyfFqhLppCbCJbMmKiX8pSd91m00", PlantUmlEncode64.new("Bob->Alice : hello").encode()
+    end
+
+end

data/test/test_plantuml-loader.rb

@@ -0,0 +1,66 @@
+require 'minitest/autorun'
+require 'plantuml-loader'
+require 'plantuml-config'
+require 'jekyll'
+
+class RemoteLoaderTest < Minitest::Test
+
+    GENERATION_FOLDER = PlantUmlConfig::DEFAULT[:assets].sub(/^\/*/, '');
+
+    ROOT_FOLDER = GENERATION_FOLDER.sub(/^([^\/]+).*$/, '\1');
+
+    GENERATED = "_images/plantuml/1fc2071adfcf94c83cb527ea98c29cae1656a085ff72acb12db7518fe93f1869.png";
+
+    def setup
+        Jekyll.logger.log_level = :debug
+        d = d = Jekyll.configuration({})['source'] + File::SEPARATOR + GENERATION_FOLDER;
+        if !File.exist?(d) then
+            FileUtils.mkdir_p(d);
+        end
+    end
+
+    def teardown
+        d = Jekyll.configuration({})['source'] + File::SEPARATOR + ROOT_FOLDER;
+        if File.exist?(d) then
+            FileUtils.remove_dir(d);
+        end
+    end
+
+    def test_createUri
+        params = { :url => "http://someurl.com/{type}/{code}", :type => "inputType", :code => "inputCode" };
+        assert_equal "http://someurl.com/inputType/inputCode", RemoteLoader.instance.createRemoteUri(params), "uri generation";
+    end
+
+    def test_savedRemoteBinary_checkDownload
+        #skip('Remote connection made')
+        params = { :url => "http://www.plantuml.com/plantuml/{type}/{code}", :type => "png", :code => "SyfFKj2rKt3CoKnELR1Io4ZDoSa70000" };
+
+        obj = RemoteLoader.instance.savedRemoteBinary(params);
+        assert_equal GENERATED, obj[:uri], "file created with defined hash";
+        assert File.exist?(obj[:path]), "file exist";
+    end
+
+    def test_savedRemoteBinary_downloadOnlyOnce
+        #skip('Remote connection made')
+        params = { :url => "http://www.plantuml.com/plantuml/{type}/{code}", :type => "png", :code => "SyfFKj2rKt3CoKnELR1Io4ZDoSa70000" };
+
+        obj =  RemoteLoader.instance.savedRemoteBinary(params);
+        assert_equal GENERATED, obj[:uri], "file created with defined hash";;
+        assert File.exist?(obj[:path]), "file exist";;
+        mtime = File.mtime(obj[:path]);
+
+        obj2 =  RemoteLoader.instance.savedRemoteBinary(params);
+        assert_equal mtime, File.mtime(obj2[:path]), "file not modified";;
+    end
+
+    def test_loadText
+        #skip('Remote connection made')
+        params = { :url => "http://www.plantuml.com/plantuml/{type}/{code}", :type => "svg", :code => "SyfFKj2rKt3CoKnELR1Io4ZDoSa70000" };
+
+        content = RemoteLoader.instance.loadText(params);
+        refute_nil content, "retrieve content must not be null";
+        assert_match /^\<svg/, content, "start with svg tag";
+        assert_match /<\/svg>$/, content, "end with svg tag";
+    end
+
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: lordoftheflies-jekyll-plantuml-proxy
+version: !ruby/object:Gem::Version
+  version: 0.1.6
+platform: ruby
+authors:
+- László Hegedűs
+- Patouche
+bindir: bin
+cert_chain: []
+date: 2025-05-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.4'
+description: Jekyll to use plantuml with remote provider without any local plantuml.jar
+  installation
+email: laszlo.hegedus@cherubits.hu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/jekyll-remote-plantuml.rb
+- lib/plantuml-config.rb
+- lib/plantuml-encode64.rb
+- lib/plantuml-loader.rb
+- test/test_plantuml-encode64.rb
+- test/test_plantuml-loader.rb
+homepage: http://github.com/lordoftheflies/jekyll-plantuml-proxy
+licenses:
+- MIT
+metadata: {}
+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.6.7
+specification_version: 4
+summary: Jekyll remote plantuml
+test_files:
+- test/test_plantuml-encode64.rb
+- test/test_plantuml-loader.rb