jekyll-plantuml-url 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 704560f8d6bdb811e639567dc5f3ab37c698e90f
+  data.tar.gz: 215487c4f41a3708423961be71751a4f850113ca
+SHA512:
+  metadata.gz: 8f3fa6599ff1ab107155ada87c30d23c24b065c7ce37654188e18e0ac0141fe98f0793d8a8e94a6dc912b36618c94a7bb13f357eea6ce3e7d424ae6aebd4ae8b
+  data.tar.gz: 45fbda79d8d3888c708cc2f554c067c2ebae3922c84679b768449e9194f8593cf7cfbee0e521694160038c9d7ec2784dc7595e7d38aaa080156c7b641e1d82f2

data/.gitignore

@@ -0,0 +1,4 @@
+Gemfile.lock
+*.gem
+.bundle/
+.DS_Store

data/.gitlab-ci.yml

@@ -0,0 +1,51 @@
+image: "ruby:2.3"
+
+stages:
+- build
+- staging
+- production
+
+Buid:
+  stage: build
+  script:
+    - bundle install
+    - rake set_git_tag
+    - rake
+    - gem build jekyll-plantuml-url.gemspec
+  artifacts:
+    paths:
+     - ./*.gem
+    expire_in: 1 week
+  tags:
+  - docker
+
+Release_Staging:
+  stage: staging
+  script:
+    - ls -la
+#   - deployctl release .... need to build the website for release, who? deployd ?
+  artifacts:
+    paths:
+    - ./*.gem
+  only:
+  - tags
+  except:
+  - branches
+  tags:
+  - docker
+
+Release_Production:
+  stage: production
+  environment: production
+  script:
+    - ls -la
+    - gem push *.gem -k $GEM_API_PUSH
+  only:
+  - tags
+  except:
+  - branches
+  tags:
+  - docker
+  when: manual
+  
+

data/.pdd

@@ -0,0 +1,7 @@
+--source=.
+--verbose
+--exclude target/**/*
+--exclude src/main/resources/images/**/*
+--rule min-words:20
+--rule min-estimate:15
+--rule max-estimate:90

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+gemspec
+

data/LICENSE.txt

@@ -0,0 +1,21 @@
+(The MIT License)
+
+Copyright (c) 2017 dgoo2308 @ GiOXA Ltd.
+
+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,66 @@
+[![Gem Version](https://badge.fury.io/rb/jekyll-plantuml-url.svg)](http://badge.fury.io/rb/jekyll-plantuml-url)
+
+A plugin for jekyll to use plantuml diagram inside your Jekyll 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 software or the using the plantuml jar file.
+
+## Install Jekyll plugin
+
+Install it first:
+
+```
+gem install jekyll-plantuml-url
+```
+
+With Jekyll 2, simply add the gem to your `_config.yml` gems list:
+
+```yaml
+gems:
+  - 'jekyll-plantuml-url'
+  - ...
+```
+
+Or for previous versions,
+create a plugin file within your Jekyll project's `_plugins` directory:
+
+```ruby
+# _plugins/plantuml-plugin.rb
+
+require "jekyll-plantuml-url"
+```
+
+Highly recommend to use Bundler. If you're using it, add this line
+to your `Gemfile`:
+
+```
+gem "jekyll-plantuml-url"
+```
+
+## choose a PlantUML-Server
+
+Checkout [PlantUML-Server](https://github.com/plantuml/plantuml-server) to install your own plantUML server or use http://www.plantuml.com/plantuml.
+
+and setup the `_config.yml`
+
+```yaml
+Plantuml:
+  url:          'http://www.plantuml.com/plantuml/' 
+  type:         'svg'
+  ssl_noverify: '0'
+  http_debug:   '0'
+```
+
+If above settings are not defined, the above values are the default settings.
+
+## Test
+
+Now, it's time to create a diagram, in your Jekyll blog page:
+
+```
+{% plantuml %}
+[First] - [Second]
+{% endplantuml %}
+```
+

data/Rakefile

@@ -0,0 +1,62 @@
+# (The MIT License)
+#
+# Copyright (c) 2014-2017 Danny Goossen GiOxa Ltd.
+#
+# 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 'rubygems'
+require 'rake'
+require 'rdoc'
+require 'rake/clean'
+
+def name
+  @name ||= File.basename(Dir['*.gemspec'].first, '.*')
+end
+
+def version
+  Gem::Specification.load(Dir['*.gemspec'].first).version
+end
+
+
+task default: [:clean]
+
+require 'rdoc/task'
+desc 'Build RDoc documentation'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "#{name} #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+task set_git_tag: [:tagit]
+desc 'Set git tag as version'
+task :tagit do
+  f = open("|git describe --always --tags")
+  git_version = f.read()
+  git_version = git_version.chomp
+  git_version = git_version.gsub('-', '.')
+  
+    puts " Version: #{git_version}"
+  version_file=Dir['lib/version.rb'].first
+  puts version_file
+  fh = File.open(version_file, 'w')
+  fh.puts "module PlantUML\nVERSION = \'#{git_version}\'\nend\n"
+  fh.close
+end

data/jekyll-plantuml-url.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'version'
+
+Gem::Specification.new do |s|
+  s.specification_version = 2 if s.respond_to? :specification_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.rubygems_version = '2.2.2'
+  s.required_ruby_version = '>= 1.9.3'
+  s.name = 'jekyll-plantuml-url'
+  s.version = PlantUML::VERSION
+  s.license = 'MIT'
+  s.summary = "Jekyll PlantUML url Automation"
+  s.description = "PlantUML diagrams in Jekyll pages from plantUML-url"
+  s.authors = ["dgoo2308"]
+  s.email = 'danny@gioxa.com'
+  s.homepage = 'https://gitlab.com/dgoo2308/jekyll-plantuml-url'
+  s.files = `git ls-files`.split($/)
+  s.executables = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.extra_rdoc_files = %w[README.md LICENSE.txt]
+  s.add_runtime_dependency('jekyll', '>2.0')
+  s.add_development_dependency('rake', ["~> 0"])
+end

data/lib/jekyll-plantuml-url.rb

@@ -0,0 +1,134 @@
+# (The MIT License)
+#
+# Copyright (c) 2014-2017 Yegor Bugayenko
+#
+# 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 'digest'
+require 'fileutils'
+require 'net/http'
+require 'uri'
+require 'openssl'
+require 'open-uri'
+
+module Jekyll
+  class PlantumlBlock < Liquid::Block
+    def initialize(tag_name, markup, tokens)
+      super
+      @html = (markup or '').strip
+    end
+
+    def render(context)
+      site = context.registers[:site]
+      name = Digest::MD5.hexdigest(super)
+      if site.config['plantuml']
+        uml_config=site.config['plantuml']
+      else
+        puts "** No configuration for plantuml in present in _config.yml, using default" 
+        uml_config={
+          'type'         => 'svg',
+          'url'          => 'http://www.plantuml.com/plantuml',
+          'ssl_noverify' => '0',
+          'http_debug'   => '0'
+        }
+      end
+      if uml_config['type'] == ""
+        uml_type="svg"
+      else
+        uml_type=uml_config['type']
+      end  
+      if !File.exists?(File.join(site.dest, "uml/#{name}.#{uml_type}"))
+        uml_out_file = File.join(site.source, "uml/#{name}.#{uml_type}")
+        if File.exists?(uml_out_file)
+          puts "File #{uml_out_file} already exists (#{File.size(uml_out_file)} bytes)"
+        else
+          if uml_config['url'] == ""
+            uml_url="http://www.plantuml.com/plantuml"
+            puts "using default url: #{uml_url}"
+          else
+            uml_url=uml_config['url']
+            puts "using config url: #{uml_url}"
+          end
+          uri = URI.parse(uml_url)
+          http = Net::HTTP.new(uri.host, uri.port)
+          if uri.scheme == "https"
+            http.use_ssl = true
+            if uml_config['ssl_noverify'] == "1"
+              http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+            end
+          end
+          if uml_config['http_debug'] == "1"
+            puts "*** http debug on ***"
+            http.set_debug_output $stderr
+          end
+          
+          request = Net::HTTP::Post.new("#{uri.path}/form")
+          request.add_field('Content-Type', 'application/x-www-form-urlencoded')
+          request.body = "text=" + URI::encode("@startuml\n"+super+"\n@enduml\n".force_encoding('ASCII-8BIT'))
+          response = http.request(request)
+       
+          if response.code == "302" or response.code == "301"
+            # expected redirect of 302 with a new url with code-hash
+            newlocation=response["Location"]
+            newlocation["/uml/"]= "/#{uml_type}/"
+            begin # loop for 301 and 302 of the code request
+              newuri = URI.parse(newlocation)
+              if newuri.host != uri.host or newuri.port != uri.port or newuri.scheme != uri.scheme
+                http = Net::HTTP.new(newuri.host, newuri.port)
+                if newuri.scheme == "https"
+                  http.use_ssl = true
+                  if uml_config['ssl_noverify'] == "1"
+                    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+                  end
+                end
+                if uml_config['http_debug'] == "1"
+                  puts "*** http debug on ***"
+                  http.set_debug_output $stderr
+                end
+              end  
+              request_img = Net::HTTP::Get.new(newuri.path)
+              response_img = http.request(request_img)
+              if response_img.code == "200"
+                #puts response_img.body
+                FileUtils.mkdir_p(File.dirname(uml_out_file))
+                File.open(uml_out_file, 'w') { |f|
+                  f.write(response_img.body)
+                }
+                site.static_files << Jekyll::StaticFile.new( site, site.source, 'uml', "#{name}.#{uml_type}")
+                puts "File #{uml_out_file} created (#{File.size(uml_out_file)} bytes)"
+              elsif response_img.code == "302" or response_img.code == "301"
+                # not expected www.plantuml.com redirect to plantuml.com, what a waste of time
+                # it is what it is
+                newlocation=response_img["Location"]
+              else
+                puts "error #{response_img.code} getting #{uri.host}#{request_img}"
+              end
+            end while  response_img.code == "302" or response_img.code == "301"
+          else
+            puts "Error #{response.code} getting #{uri.host}/plantuml/form "
+          end
+        end
+      end
+      "<p><img src='/uml/#{name}.#{uml_type}' #{@html}
+        alt='PlantUML #{uml_type} diagram' class='plantuml'/></p>"
+    end
+  end
+end
+
+Liquid::Template.register_tag('plantuml', Jekyll::PlantumlBlock)

data/lib/version.rb

@@ -0,0 +1,3 @@
+module PlantUML
+VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-plantuml-url
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- dgoo2308
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>'
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>'
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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'
+description: PlantUML diagrams in Jekyll pages from plantUML-url
+email: danny@gioxa.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE.txt
+files:
+- .gitignore
+- .gitlab-ci.yml
+- .pdd
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- jekyll-plantuml-url.gemspec
+- lib/jekyll-plantuml-url.rb
+- lib/version.rb
+homepage: https://gitlab.com/dgoo2308/jekyll-plantuml-url
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- --charset=UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 2
+summary: Jekyll PlantUML url Automation
+test_files: []