jekyll-graphviz 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7cd56a8d30dbd430bafd40b578c38fa075f2712d
+  data.tar.gz: 09e373b945c734a0c6d911a55ea2e33d5cddd5ff
+SHA512:
+  metadata.gz: 532b8b40af6c152542d0824f722250afc2da1d5868607e3f48367aa7d67068834fcf90c9979d4bcd20884ddbf65d8037ba0e17120e7967e4fb255664fb121bcc
+  data.tar.gz: 12da6ef7adb5a20824abf7a247f7e363a38414ae8821122882cfc28bce01ff96b32e1196ccfb0e2f6b062066e404bd917534ced202286cf3d69806986b1c5c92

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jekyll-graphviz.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Keiichiro Ui
+
+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,73 @@
+# Jekyll::Graphviz
+
+A liquid tag to convert with Graphviz for Jekyll.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+group :jekyll_plugins do
+  gem 'jekyll-graphviz'
+end
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jekyll-graphviz
+
+## Usage
+
+~~~~~~~~~~~~~~~~~~~~~~~
+---
+---
+
+{% graph some graph title %}
+a -- b
+b -- c
+c -- a
+{% endgraph %}
+
+{% digraph some digraph title %}
+a -> b
+b -> c
+c -> a
+{% enddigraph %}
+
+{% graphviz %}
+digraph "some graphviz title" {
+  a -> b
+  b -> c
+  c -> a
+}
+{% enddigraphviz %}
+~~~~~~~~~~~~~~~~~~~~~~~
+
+### Configs and Default Values
+
+~~~~~~~~~~~~~~~~~~~~~~~yaml
+# _config.yaml
+graphviz:
+  options: "-Tsvg" # 'dot' command option
+  command: "dot"   # execute this string. specify full path to 'dot' if you need
+~~~~~~~~~~~~~~~~~~~~~~~
+
+## 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 tags, 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/[USERNAME]/jekyll-graphviz. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "jekyll/graphviz"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/jekyll-graphviz.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jekyll/graphviz/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jekyll-graphviz"
+  spec.version       = Jekyll::Graphviz::VERSION
+  spec.authors       = ["Keiichiro Ui"]
+  spec.email         = ["keiichiro.ui@gmail.com"]
+
+  spec.summary       = %q{A liquid tag to convert with Graphviz for Jekyll}
+  spec.homepage      = "https://github.com/kui/jekyll-graphviz"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "jekyll", ENV['JEKYLL_VERSION'] ? "~> #{ENV['JEKYLL_VERSION']}" : ">= 2.0"
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+end

data/lib/jekyll/graphviz.rb

@@ -0,0 +1,12 @@
+require "jekyll"
+require "jekyll/graphviz/version"
+require "jekyll/graphviz/block"
+
+module Jekyll
+  module Graphviz
+  end
+end
+
+Liquid::Template.register_tag('graphviz', Jekyll::Graphviz::Block)
+Liquid::Template.register_tag('graph', Jekyll::Graphviz::Block)
+Liquid::Template.register_tag('digraph', Jekyll::Graphviz::Block)

data/lib/jekyll/graphviz/block.rb

@@ -0,0 +1,35 @@
+require "liquid/block"
+require "jekyll/graphviz/renderer"
+
+module Jekyll
+  module Graphviz
+    class Block < Liquid::Block
+      def initialize tag_name, text, tokens
+        super
+        @tag_name = tag_name
+        @title = text.strip
+      end
+
+      def render context
+        config = context.registers[:site].config
+        @renderer = Jekyll::Graphviz::Renderer.new(config["graphviz"])
+        render_graph super
+      end
+
+      private
+
+      def render_graph code
+        case @tag_name
+        when 'graphviz' then render_graphviz code
+        when 'graph'    then render_graphviz %[graph "#{@title}" {\n#{code}\n}]
+        when 'digraph'  then render_graphviz %[digraph "#{@title}" {\n#{code}\n}]
+        else raise "unknown liquid tag name: #{@tag_name}"
+        end
+      end
+
+      def render_graphviz code
+        @renderer.render code, @title
+      end
+    end
+  end
+end

data/lib/jekyll/graphviz/renderer.rb

@@ -0,0 +1,86 @@
+require "digest/md5"
+require "open3"
+
+module Jekyll
+  class Graphviz::Renderer
+
+    DIV_CLASS_ATTR = "graphviz-wrapper"
+    DEFAULT_OPTIONS = "-Tsvg"
+    DEFAULT_EXECUTABLE = "dot"
+
+    def initialize config = nil
+      @config = config || {}
+    end
+
+    def render code, title = nil
+      title = gen_title(title, code)
+      svg = generate_svg code
+      svg = remove_declarations svg
+      svg = remove_xmlns_attrs svg
+      svg = add_desc_attrs svg, title
+      svg = insert_desc_elements svg, title, code
+      svg = wrap_with_div svg
+      svg
+    end
+
+    private
+
+    def gen_title title, code
+      if title.nil? or title.empty?
+      then "graphviz-#{digest code}"
+      else title
+      end
+    end
+
+    def digest str
+      Digest::MD5.hexdigest str
+    end
+
+    def generate_svg code
+      svg, status = Open3.capture2(cmd, stdin_data: code, binmode: true)
+      raise "Non-zero exit status '#{cmd}': #{status}" unless status.success?
+      svg.force_encoding 'UTF-8'
+      svg
+    end
+
+    def remove_declarations svg
+      svg
+        .sub(/<!DOCTYPE .+?>/im,'')
+        .sub(/<\?xml .+?\?>/im,'')
+    end
+
+    def remove_xmlns_attrs svg
+      svg
+        .sub(%[xmlns="http://www.w3.org/2000/svg"], '')
+        .sub(%[xmlns:xlink="http://www.w3.org/1999/xlink"], '')
+    end
+
+    def add_desc_attrs svg, title
+      svg
+        .sub("<svg", %[<svg aria-label="#{CGI::escapeHTML title}"])
+        .sub("<svg", %[<svg role="img"])
+    end
+
+    def insert_desc_elements svg, title, desc
+      inserted_elements = %[<title>#{CGI::escapeHTML title}</title>\n] +
+                          %[<desc>#{CGI::escapeHTML desc}</desc>\n]
+      svg.sub(/(<svg [^>]*>)/, "\\1\n#{inserted_elements}")
+    end
+
+    def wrap_with_div svg
+      %[<div class="#{DIV_CLASS_ATTR}">#{svg}</div>]
+    end
+
+    def cmd
+      "#{exec} #{opts}"
+    end
+
+    def exec
+      @config && @config["executable"] || DEFAULT_EXECUTABLE
+    end
+
+    def opts
+      @config && @config["options"] || DEFAULT_OPTIONS
+    end
+  end
+end

data/lib/jekyll/graphviz/version.rb

@@ -0,0 +1,5 @@
+module Jekyll
+  module Graphviz
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-graphviz
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Keiichiro Ui
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-27 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: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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: 
+email:
+- keiichiro.ui@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- jekyll-graphviz.gemspec
+- lib/jekyll/graphviz.rb
+- lib/jekyll/graphviz/block.rb
+- lib/jekyll/graphviz/renderer.rb
+- lib/jekyll/graphviz/version.rb
+homepage: https://github.com/kui/jekyll-graphviz
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: A liquid tag to convert with Graphviz for Jekyll
+test_files: []