jekyll-remote-plantuml 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f3d50bbea5bd6cde9c986bac6a241469e2991e0c
+  data.tar.gz: 72f51fb9ca50fcea5f745a36510ca302c6afe927
+SHA512:
+  metadata.gz: 996b4c79ec386508ff8a5070ea2a6c5fca9159ca339d79510c37bba54510d2ab122692050530c012eb68faa2b18f8ecbaded16d664e33cc6eb48036c1352376e
+  data.tar.gz: cf5960abd36745dc8be6a555dbc7322af86a6c21bb782456d77256117bc37da7c190a518298677c067acaa6f81b23abfebe1d454034bda65c32245a2d6905fa8

data/lib/jekyll-remote-plantuml.rb

@@ -0,0 +1,56 @@
+# 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,15 @@
+# Config for plantuml plugin.
+
+require 'singleton';
+
+class PlantUmlConfig
+    include Singleton
+
+    DEFAULT = {
+        :assets     => 'assets/images/plantuml/',
+        :type         => 'png',
+        :encode       => 'encode64',
+        :url          => 'http://www.plantuml.com/plantuml/{type}/{code}'
+    }
+
+end

data/lib/plantuml-encode64.rb

@@ -0,0 +1,87 @@
+# 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.
+
+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({});
+        pconf = PlantUmlConfig::DEFAULT.merge(conf['plantuml'] || {});
+        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 = File.read(d[:path]);
+        tc = CONTENT_CALLBACKS[params[:type].downcase];
+        if tc then
+            content = content.gsub(tc[:matcher], tc[:replacement]);
+        end
+        return content;
+    end
+
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-remote-plantuml
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Patouche
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.11.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.11.2
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Jekyll to use plantuml with remote provider without any local plantuml.jar
+  installation
+email: patralla@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/jekyll-remote-plantuml.rb
+- lib/plantuml-config.rb
+- lib/plantuml-encode64.rb
+- lib/plantuml-loader.rb
+homepage: http://rubygems.org/gems/jekyll-remote-plantuml
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Jekyll remote plantuml
+test_files: []