jekyll-diagrams 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2acdd1cfd11996e6bff65f52ec3b305401bc7bee
+  data.tar.gz: 41e77e050c03a246f752faa4333db6d4e2e3b09d
+SHA512:
+  metadata.gz: 69b4859fd220a7efc77d4d218c892bff96d9d3869f1ade3499220161fcff08d7d4d6624db75e44b01b375ae90caef1441b831496fabf77c21379578bc870d6f8
+  data.tar.gz: a4fe990ece18cca948f9d5ad2cdea1604fedbfd17884ca9d170ff84170fe7ab2aaf75929b47f82720739638b2cfd341c7c7be8a3958a91795d32926b111a3757

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.3.0
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at farkasity@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 farkasity
+
+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,41 @@
+# Jekyll::Diagrams
+
+[![Build Status](https://travis-ci.org/farkasity/jekyll-diagrams.svg?branch=master)](https://travis-ci.org/farkasity/jekyll-diagrams.svg?branch=master)
+[![Build status](https://ci.appveyor.com/api/projects/status/f5l7k3971pmjbjcq?svg=true)](https://ci.appveyor.com/project/farkasity/jekyll-diagrams)
+[![Dependency Status](https://gemnasium.com/farkasity/jekyll-diagrams.svg)](https://gemnasium.com/farkasity/jekyll-diagrams)
+[![Code Climate](https://codeclimate.com/github/farkasity/jekyll-diagrams/badges/gpa.svg)](https://codeclimate.com/github/farkasity/jekyll-diagrams)
+[![Inline Docs](https://inch-ci.org/github/farkasity/jekyll-diagrams.svg)](https://inch-ci.org/github/farkasity/jekyll-diagrams)
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/jekyll/diagrams`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jekyll-diagrams'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jekyll-diagrams
+
+## Usage
+
+## 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-diagrams. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://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/jekyll-diagrams.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jekyll/diagrams/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jekyll-diagrams"
+  spec.version       = Jekyll::Diagrams::VERSION
+  spec.authors       = ["farkasity"]
+  spec.email         = ["farkasity@gmail.com"]
+
+  spec.summary       = "Jekyll plugins for diagrams support, including Graphviz."
+  spec.description   = "Jekyll plugins for diagrams support, including Graphviz."
+  spec.homepage      = "https://github.com/farkasity/jekyll-diagrams"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "jekyll", "~> 3.1.0"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/jekyll/diagrams/diag.rb

@@ -0,0 +1,65 @@
+require 'open3'
+require 'tempfile'
+
+module Jekyll
+  module Diagrams
+    class DiagBlock < Liquid::Block
+      def initialize(tag_name, text, tokens)
+        super
+        @tag_name = tag_name
+      end
+
+      def render(context)
+        config = context.registers[:site].config["diagrams"]
+
+        @renderer = DiagRenderer.new(config[@tag_name])
+
+        render_diagram(super)
+      end
+
+      private
+
+      def render_diagram(code)
+        @renderer.render(code, @tag_name)
+      end
+    end
+
+    class DiagRenderer
+      DEFAULTS = {
+        'options' => '-Tsvg --nodoctype'
+      }
+
+      def initialize(config)
+        @config = DEFAULTS.merge(config)
+      end
+
+      def render(code, engine)
+        tmp = Temfile.new(engine).path
+        dest = "#{tmp}.svg"
+        
+        File.write(tmp, code)
+        cmd = "#{engine} #{@config['options']} #{tmp} -o #{dest}"
+        ret, status = Open3.capture2(cmd, binmode: true)
+
+        if !status.success?
+          raise "Non-zero exit status '#{cmd}': #{status}"
+        end
+        
+        svg = File.read(dest).force_encoding 'UTF-8'
+
+        wrap_div(svg, engine)
+      end
+
+      private
+
+      def wrap_div(svg, engine)
+        "<div class='#{engine}'>#{svg}</div>"
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag('blockdiag', Jekyll::Diagrams::DiagBlock)
+Liquid::Template.register_tag('seqdiag', Jekyll::Diagrams::DiagBlock)
+Liquid::Template.register_tag('actdiag', Jekyll::Diagrams::DiagBlock)
+Liquid::Template.register_tag('nwdiag', Jekyll::Diagrams::DiagBlock)

data/lib/jekyll/diagrams/graphviz.rb

@@ -0,0 +1,82 @@
+require 'open3'
+
+module Jekyll
+  module Diagrams
+    class GraphvizBlock < Liquid::Block
+      def initialize(tag_name, text, tokens)
+        super
+        @tag_name = tag_name
+        @engine = text.strip
+      end
+
+      def render(context)
+        config = context.registers[:site].config["diagrams"]
+
+        @renderer = GraphvizRenderer.new(config["graphviz"])
+
+        render_diagram(super)
+      end
+
+      private
+
+      def render_diagram(code)
+        code = case @tag_name
+               when 'graphviz'
+                 code
+               when 'graph'
+                 "graph {\n#{code}\n}"
+               when 'digraph'
+                 "digraph {\n#{code}\n}"
+               else
+                 raise "unknown liquid tag name: #{@tag_name}"
+               end
+
+        @renderer.render(code, @engine)
+      end
+    end
+
+    class GraphvizRenderer
+      DEFAULTS = {
+        'engine'  => 'dot',
+        'options' => '-Tsvg'
+      }
+
+      def initialize(config)
+        @config = DEFAULTS.merge(config)
+      end
+
+      def render(code, engine = DEFAULTS['engine'])
+        cmd = "#{@config['engine']} #{@config['options']}"
+        svg, status = Open3.capture2(
+          cmd,
+          stdin_data: code,
+          binmode: true
+        )
+
+        if !status.success?
+          raise "Non-zero exit status '#{cmd}': #{status}"
+        end
+
+        svg.force_encoding 'UTF-8'
+
+        strip_metainfo(svg)
+        wrap_div(svg)
+      end
+
+      private
+
+      def strip_metainfo(svg)
+        svg.gsub(/(?:.*\n){4}/, '')
+      end
+
+      def wrap_div(svg)
+        "<div class='graphviz'>#{svg}</div>"
+      end
+    end
+  end
+end
+
+
+Liquid::Template.register_tag('graphviz', Jekyll::Diagrams::GraphvizBlock)
+Liquid::Template.register_tag('graph', Jekyll::Diagrams::GraphvizBlock)
+Liquid::Template.register_tag('digraph', Jekyll::Diagrams::GraphvizBlock)

data/lib/jekyll/diagrams/version.rb

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

data/lib/jekyll/diagrams.rb

@@ -0,0 +1,9 @@
+require 'jekyll'
+require "jekyll/diagrams/version"
+require 'jekyll/diagrams/graphviz'
+
+module Jekyll
+  module Diagrams
+    
+  end
+end

data/lib/jekyll-diagrams.rb

@@ -0,0 +1 @@
+require 'jekyll/diagrams'

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-diagrams
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- farkasity
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Jekyll plugins for diagrams support, including Graphviz.
+email:
+- farkasity@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- jekyll-diagrams.gemspec
+- lib/jekyll-diagrams.rb
+- lib/jekyll/diagrams.rb
+- lib/jekyll/diagrams/diag.rb
+- lib/jekyll/diagrams/graphviz.rb
+- lib/jekyll/diagrams/version.rb
+homepage: https://github.com/farkasity/jekyll-diagrams
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Jekyll plugins for diagrams support, including Graphviz.
+test_files: []