jekyll-remote-plantuml 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ef3b3830254af6eb301a6a952509d1890f8ceccf
-  data.tar.gz: 180146fbde5d88778a055590bf42e23820cd64ce
+  metadata.gz: c6e930414f1210fd0acb997f2f5c6b0a6de64104
+  data.tar.gz: 4a5d12faeccfbd0c6a9dc40baf85f9771fd26314
 SHA512:
-  metadata.gz: d40428cd4f2781f08690f8e6b5dc901ebeb6397104aa58f49e30ce252ffd99cb167263b8835a98ef027e034b63f72c6600fbf46e193e435083c1689dbc0b35fa
-  data.tar.gz: 6da9259e12e38aa6254159e8b895e6f0c96d30c2102ef1f0fc29f3c811aebf84f38e5cad1afce5a6b1b35487f8c638fb099f71667717b692ee05f589d5982412
+  metadata.gz: 5d406c74e495242ea55581293a9659342aca4c646780cad8b78f9314245e6b23113398df99777eabb3f92b8918df2334c4b0750848851c5108cae60936fc63b3
+  data.tar.gz: 1e7907f9f2174897048c693238cbb10218a65de9e457c03b660d2a74946ca87a56eeb02eea6a6ca89d86f1044cde8782b6287659368a8b2e81806be5bd1f257a

data/README.md

@@ -1,5 +1,8 @@
 # jekyll-remote-plantuml
 
+[![security](https://hakiri.io/github/Patouche/jekyll-remote-plantuml/master.svg)](https://hakiri.io/github/Patouche/jekyll-remote-plantuml/master) [![Build Status](https://travis-ci.org/Patouche/jekyll-remote-plantuml.svg)](https://travis-ci.org/Patouche/jekyll-remote-plantuml)
+
+
 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
@@ -13,9 +16,9 @@ To use the jekyll-remote-plantuml plugin, you just have to wrap you text between
 For example, to create a basic shema between Bob and Alice, you can write the following code :
 
 ``` text
-{% minibundle js %}
+{% uml %}
 Bob -> Alice : Hello 
-{% endminibundle %}
+{% enduml %}
 ```
 
 This will retrieve the binary from a remote provider and add it into the folder defined in your configuration.

data/lib/plantuml-config.rb

@@ -1,12 +1,40 @@
-# Config for plantuml plugin.
+# 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     => 'assets/images/plantuml/',
+        :assets       => 'assets/images/plantuml/',
         :type         => 'png',
         :encode       => 'encode64',
         :url          => 'http://www.plantuml.com/plantuml/{type}/{code}'

data/lib/plantuml-encode64.rb

@@ -1,17 +1,17 @@
 # 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
@@ -19,6 +19,9 @@
 # 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)

data/lib/plantuml-loader.rb

@@ -111,8 +111,7 @@ class RemoteLoader
     # Returns the content of the remote
     def loadText(params)
         d = savedRemoteBinary(params);
-        content = File.read(d[:path]);
-        tc = CONTENT_CALLBACKS[params[:type].downcase];
+        content, tc = File.read(d[:path]), CONTENT_CALLBACKS[params[:type].downcase];
         if tc then
             content = content.gsub(tc[:matcher], tc[:replacement]);
         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 = "assets/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

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-remote-plantuml
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Patouche
@@ -14,16 +14,16 @@ dependencies:
   name: jekyll
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.2
+        version: '2.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.2
+        version: '2.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.4'
 description: Jekyll to use plantuml with remote provider without any local plantuml.jar
   installation
 email: patralla@gmail.com
@@ -65,6 +65,8 @@ files:
 - 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/Patouche/jekyll-remote-plantuml
 licenses:
 - MIT
@@ -89,4 +91,6 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Jekyll remote plantuml
-test_files: []
+test_files:
+- test/test_plantuml-loader.rb
+- test/test_plantuml-encode64.rb