jekyll-mscgen 0.1.0

data/.gitignore

@@ -0,0 +1,16 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Wiktor Macura
+
+MIT License
+
+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,50 @@
+# jekyll-mscgen
+
+A Jekyll plugin for generating message sequence charts using the `mscgen`
+tool.
+
+## Usage
+You need to have `mscgen` installed (it's available through homebrew).
+
+Expose the mscgen plugin to jekyll through a `_plugins/gems.rb` type file:
+
+	require 'jekyll-mscgen'
+
+Then you can create a chart as so:
+
+	{% mscgen %}
+	hscale = "0.7";
+	# arcgradient = "2";
+
+	swap1,host1,host2,swap2;
+	|||;
+
+	# proposal
+	--- [ label=" attempt swap " ];
+
+	swap1->host1 [ label="propose swap1" ];
+	swap1<-host1 [ label="ok" ];
+
+	# ...
+	{% endmscgen %}
+
+Generally you want to use CSS to add some styling, for example:
+
+	svg {
+		line {
+			color: #333;
+		}
+	}
+
+But expand as you wish:
+
+![Image](https://raw.github.com/wkm/jekyll-mscgen/master/doc/samplemsc.png)
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/jekyll-mscgen.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-mscgen/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jekyll-mscgen"
+  spec.version       = Jekyll::Mscgen::VERSION
+  spec.authors       = ["Wiktor Macura"]
+  spec.email         = ["wmacura@gmail.com"]
+  spec.description   = %q{mscgen integration for jekyll to make message sequence charts}
+  spec.summary       = %q{mscgen integration for jekyll to make message sequence charts}
+  spec.homepage      = "http://github.com/wkm/jekyll-mscgen"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+
+  spec.add_runtime_dependency "jekyll"
+end

data/lib/jekyll-mscgen.rb

@@ -0,0 +1,58 @@
+require 'liquid'
+require 'jekyll-mscgen/version'
+require 'open3'
+require 'cgi'
+
+module Jekyll
+  # defaults which get stripped out
+  class MscgenBlock < Liquid::Block
+    def initialize(tag_name, text, tokens)
+      super
+    end
+
+    # remove basic styling from output
+    def purify(output)
+      [
+        'stroke="black"', 'font-family="Helvetica"', 'font-size="12"',
+        /textLength="\d+"/
+      ].each do |pattern|
+        output.gsub! pattern, ''
+      end
+
+      output
+    end
+
+    def render(context)
+      @text = @nodelist.join('')
+      @text = "msc {\n #{@text} \n}"
+
+      Open3.popen3('mscgen -i- -o- -T svg') do |stdin,out,err|
+        begin
+          stdin.puts(@text)
+          stdin.close
+        rescue Error
+          puts 'error generating mscgen chart'
+
+        ensure
+          errors = err.read.strip
+          output = out.read.strip
+          if errors != "" and errors != nil
+            puts "mscgen error: #{errors}"
+            errors = "<div style='color: red; background: \#ffeeee;'>#{CGI.escapeHTML(errors)}</div>"
+            if output != nil
+              output = CGI.escapeHTML(output)
+            end
+          end
+        
+          output = output.lines.drop(2).join('')
+          output = purify(output)
+
+          return "<div class='mscgen-chart'>#{errors}#{output}</div>"
+        end
+      end
+    end
+  end
+end
+
+
+Liquid::Template.register_tag('mscgen', Jekyll::MscgenBlock)

data/lib/jekyll-mscgen/version.rb

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

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification 
+name: jekyll-mscgen
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Wiktor Macura
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-06-17 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 3
+        version: "1.3"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: jekyll
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+description: mscgen integration for jekyll to make message sequence charts
+email: 
+- wmacura@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- doc/samplemsc.png
+- jekyll-mscgen.gemspec
+- lib/jekyll-mscgen.rb
+- lib/jekyll-mscgen/version.rb
+has_rdoc: true
+homepage: http://github.com/wkm/jekyll-mscgen
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: mscgen integration for jekyll to make message sequence charts
+test_files: []
+