markdoc 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: deff189b4d519699fdc3084eb9b43d329cc65170
+  data.tar.gz: c33222481bf908352ae01a77c6f12d1133b5e1f6
+SHA512:
+  metadata.gz: 30ab7219434100465479985e1041b9e6eeb4db228540b5a033b8f638ed254d2967b745c6f43d73c3c4c7d01d26e7b7e4a8f55e61da9557af71129064d8c48f62
+  data.tar.gz: 81495e7b1a4cab6ace31bfb91d8cc60803c80f8777440c486360e5e26be979028aca4c24011562d89f132cf74f7f99ec1443e663d1c9a9dea7360c8038037b63

data/bin/markdoc

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'markdoc'
+
+input = ARGV[0] ? IO.read(ARGV[0]) : ARGF.read
+
+puts Markdoc.render(input)

data/bin/pseudo2svg

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+# Pseudo code to Graphviz converter
+#
+# Usage:
+#   pseudo2svg example.pseudo > example.svg
+
+require 'markdoc'
+input = ARGV[0] ? IO.read(ARGV[0]) : ARGF.read
+puts Markdoc::Pseudocode.draw(input)

data/bin/sequence2svg

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+# Sequence definition to image converter using sequence.pic macros.
+#   http://www.umlgraph.org/doc/seq-intro.html
+#
+# Usage:
+#   sequence2svg example.sequence > example.svg
+
+require 'markdoc'
+input = ARGV[0] ? IO.read(ARGV[0]) : ARGF.read
+puts Markdoc::Sequence.draw(input)

data/lib/markdoc.rb

@@ -0,0 +1,13 @@
+require 'digest'
+require 'tempfile'
+
+require 'markdoc/pseudocode'
+require 'markdoc/sequence'
+require 'markdoc/renderer'
+
+module Markdoc
+  def self.render(doc)
+    markdown = Redcarpet::Markdown.new(Renderer, fenced_code_blocks: true)
+    markdown.render(doc)
+  end
+end

data/lib/markdoc/pseudocode.rb

@@ -0,0 +1,134 @@
+require 'polyglot'
+require 'treetop'
+
+module Markdoc
+  module Pseudocode
+    class Register
+      def self.id
+        @id ||= 0
+        @id += 1
+        "N#{@id}"
+      end
+    end
+
+    class ActionLiteral < Treetop::Runtime::SyntaxNode
+      def out(file)
+        file.write %Q(#{id} [shape=box label="#{label}"]\n)
+      end
+      def id
+        sentence.id
+      end
+      def label
+        sentence.value
+      end
+      def ends
+        [id]
+      end
+    end
+
+    class IfLiteral < Treetop::Runtime::SyntaxNode
+      def out(file)
+        file.write %Q(#{id} [shape=diamond label="#{cond.value}"]\n)
+
+        unless yes.nil?
+          yes.out(file)
+          file.write %Q(  #{id} -> #{yes.id} [label="Yes"]\n)
+        end
+        unless no.nil?
+          no.out(file)
+          file.write %Q(  #{id} -> #{no.id} [label="No"]\n)
+        end
+      end
+
+      def id
+        cond.id
+      end
+      def ends
+        ary = []
+        if yes.elements.empty?
+          ary << yes.id
+        else
+          ary << yes.elements.last.ends
+        end
+        if no.elements.empty?
+          ary << no.id
+        else
+          ary << no.elements.last.ends
+        end
+        ary.flatten
+      end
+    end
+
+    class SentenceLiteral < Treetop::Runtime::SyntaxNode
+      def value
+        text_value.strip
+      end
+      def id
+        @id ||= Register.id
+      end
+    end
+
+    class ExpressionLiteral < Treetop::Runtime::SyntaxNode
+      def out(file)
+        prev = nil
+        elements.each do |node|
+          next if node.nil?
+          node.out(file)
+          unless prev.nil?
+            prev.ends.each do |endid|
+              file.write %Q(#{endid} -> #{node.id}\n)
+            end
+          end
+          prev = node
+        end
+      end
+
+      def id
+        elements.first.id
+      end
+
+      def ends
+        ary = []
+        elements.each do |node|
+          if node.elements.empty?
+            ary << node.id
+          else
+            ary << node.ends
+          end
+        end
+        ary.flatten
+      end
+    end
+
+    def self.draw(code)
+      parser = PseudocodeParser.new
+      tree = parser.parse(code)
+
+      if(tree.nil?)
+        puts parser.failure_reason
+        raise "Can't generate graphviz code"
+      else
+        digest = Digest::MD5.hexdigest code
+
+        graphviz = nil
+        Tempfile.open([digest, '.gv']) do |file|
+          file.write "digraph G {\n"
+          tree.out(file)
+          file.write "}\n"
+          graphviz = file.path
+        end
+
+        image = Tempfile.new([digest, '.svg'])
+        image.close
+
+        if system("dot -n -Tsvg -o#{image.path} #{graphviz}")
+          IO.read image
+        else
+          raise "Can't generate flowchart"
+        end
+      end
+    end
+  end
+
+  Treetop.load File.join(File.dirname(__FILE__), 'pseudocode')
+end

data/lib/markdoc/pseudocode.treetop

@@ -0,0 +1,39 @@
+module Markdoc
+  grammar Pseudocode
+    rule expression
+      (if / action )+ <ExpressionLiteral>
+    end
+
+    rule if
+      'if' cond:sentence
+      newline yes:expression
+      'else' newline no:expression
+      'end' newline
+      <IfLiteral>
+    end
+
+    rule keywords
+      'if' / 'else' / 'end'
+    end
+
+    rule action
+      sentence newline <ActionLiteral>
+    end
+
+    rule sentence
+      ( !keywords word )+ <SentenceLiteral>
+    end
+
+    rule word
+      [a-zA-Z0-9 ]+
+    end
+
+    rule space
+      [ ]
+    end
+
+    rule newline
+      space* [\n]+ space*
+    end
+  end
+end

data/lib/markdoc/renderer.rb

@@ -0,0 +1,47 @@
+require 'redcarpet'
+require 'pygments'
+
+module Markdoc
+  class Renderer < Redcarpet::Render::HTML
+
+    def block_code(code, language)
+      case language
+      when 'pseudo', 'pseudocode'
+        wrap_svg Pseudocode.draw(code)
+      when 'seq', 'sequence'
+        wrap_svg Sequence.draw(code)
+      else
+        Pygments.highlight(code, lexer: language)
+      end
+    end
+
+    # removes xml or doctype meta info
+    def wrap_svg(source)
+      stripped = source.
+                 sub(/<\?xml[^>]+>/i, '').
+                 sub(/<!DOCTYPE[^>]+>/im, '').
+                 gsub(/<!\-\-[^>]+\-\->/, '')
+
+      %Q(<div class="svg-holder">\n#{stripped}\n</div>)
+    end
+
+    def doc_header
+      <<-END
+<html>
+<head>
+  <title>Doc</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <style>
+#{IO.read File.expand_path('../../../css/style.css', __FILE__)}
+#{IO.read File.expand_path('../../../css/pygments.css', __FILE__)}
+  </style>
+</head>
+<body>
+END
+    end
+
+    def doc_footer
+      "</body>\n</html>"
+    end
+  end
+end

data/lib/markdoc/sequence.rb

@@ -0,0 +1,211 @@
+module Markdoc
+  module Sequence
+    def self.draw(code)
+      parser = Parser.new(code)
+
+      digest = Digest::MD5.hexdigest code
+
+      pic = nil
+      Tempfile.open([digest, '.pic']) do |file|
+        file.write parser.parse
+        pic = file.path
+      end
+
+      image = Tempfile.new([digest, '.svg'])
+      image.close
+
+      if system("pic2plot -Tsvg #{pic} > #{image.path}")
+        IO.read image
+      else
+        raise "Can't generate sequence diagram"
+      end
+    end
+
+    class Role
+      attr_accessor :type, :id, :label, :active
+      def initialize(type, id, label)
+        self.type, self.id, self.label = type, id, label
+        self.active = false
+      end
+      def activate
+        return if active
+        self.active = true
+        "active(#{id});"
+      end
+      def deactivate
+        return unless active
+        self.active = false
+        "inactive(#{id});"
+      end
+    end
+
+    class Message
+      attr_accessor :type, :source, :dest, :label, :comment
+      def initialize(type, source, dest, label, comment)
+        self.type, self.source, self.dest, self.label, self.comment = type, source, dest, label.strip, comment.strip
+      end
+
+      def roles
+        [source, dest]
+      end
+
+      def deliver
+        %Q[#{type}(#{source.id},#{dest.id}, "#{label}");]
+      end
+
+      def describe
+        return if comment.empty?
+        width = comment.length > 10 ? 1 : comment.length * 0.13
+        width = 0.5 if width < 0.5
+        %Q[comment(#{dest.id},C,up 0.2 right, wid #{'%.1f' % width} ht 0.3 "#{comment}");]
+      end
+
+      def height
+        source == dest ? 2 : 1
+      end
+    end
+
+    class Parser
+      attr_accessor :source, :variables, :roles, :messages, :output
+
+      def defaults
+        {
+          boxht:     '0.5', # Object box height
+          boxwid:    '1.3', # Object box width
+          awid:      '0.1', # Active lifeline width
+          spacing:   '0.25', # Spacing between messages
+          movewid:   '0.75', # Spacing between objects
+          dashwid:   '0.05', # Interval for dashed lines
+          maxpswid:  '20', # Maximum width of picture
+          maxpsht:   '20', # Maximum height of picture
+          underline: '0', # Underline the name of objects
+        }
+      end
+
+      def initialize(source, options = {})
+        self.source = source
+        self.output = []
+        self.roles = []
+        self.messages = []
+        self.variables = defaults.dup
+        options.each do |key, value|
+          variables[key] = value
+        end
+      end
+
+      def find(id)
+        id.strip!
+        roles.detect{|role| role.id == id}
+      end
+
+      def parse
+        source.split("\n").each do |line|
+          next if line.strip.empty?
+          # Student = Actor
+          # SD = SD Site
+          if match = line.match(/^([a-zA-Z0-9_ \t]+) *= *([a-zA-Z0-9_ \t]+)/)
+            if match[2] =~ /Actor/
+              roles << Role.new(:actor, match[1].strip, match[1].strip)
+            else
+              roles << Role.new(:object, match[1].strip, match[2].strip)
+            end
+          # Reg -> Rems : Register(K, F) # New API
+          elsif match = line.match(/^([a-zA-Z0-9_ \t]+) *([<\-~>]{2}) *([a-zA-Z0-9_ \t]+):([^#]+)#?(.*)/)
+            role1, role2, op = find(match[1]), find(match[3]), match[2]
+
+            if op.index('>')
+              source, dest = role1, role2
+            elsif op.index('<')
+              source, dest = role2, role1
+            else
+              raise "Message direction must be one of ->, ~>, <-, <~"
+            end
+
+            if op.index('-')
+              type = :message
+            elsif op.index('~')
+              type = :rmessage
+            else
+              raise "Message direction must be one of ->, ~>, <-, <~"
+            end
+
+            message = Message.new(type, source, dest, match[4], match[5])
+            # deactivate prev messages roles
+            if last = messages.last
+              (last.roles - message.roles).each do |role|
+                output << role.deactivate if role.active
+              end
+            end
+            # activate source before send message
+            output << source.activate unless source.active
+            output << message.deliver
+            output << message.describe
+            # activate dest
+            output << dest.activate unless dest.active
+            messages << message
+          # Reg : Save the form(F)
+          elsif match = line.match(/^([a-zA-Z0-9_ \t]+) *:([^#]+)#?(.*)/)
+            role = find(match[1])
+            message = Message.new(:message, role, role, match[2], match[3])
+            # deactivate prev messages roles
+            if last = messages.last
+              (last.roles - message.roles).each do |role|
+                output << role.deactivate if role.active
+              end
+            end
+            # activate role before send message
+            output << role.activate unless role.active
+            output << message.deliver
+            output << message.describe
+            messages << message
+          end
+        end
+
+        header
+        footer
+
+        output.compact.join("\n")
+      end
+
+      def macros
+        IO.read File.join(File.dirname(__FILE__), 'sequence.pic')
+      end
+
+      def header
+        headers = []
+        headers << '.PS'
+        headers << ''
+        headers << macros
+        headers << ''
+        headers << '# Variables'
+        # calculate height
+
+        variables[:maxpsht] = ((variables[:spacing].to_f *
+                                messages.map(&:height).reduce(:+)) +
+                               variables[:boxht].to_f).ceil
+
+        variables.each do |key, value|
+          headers << "#{key} = #{value};"
+        end
+        headers << '# Actors and Objects'
+        roles.each do |object|
+          headers << %Q[#{object.type}(#{object.id},"#{object.label}");]
+        end
+        headers << 'step();'
+        headers << ''
+        self.output =  headers + output
+      end
+
+      def footer
+        output << ''
+        output << 'step();'
+        output << '# Complete the lifelines'
+        roles.each do |object|
+          output << "complete(#{object.id});"
+        end
+        output << ''
+        output << '.PE'
+      end
+    end
+  end
+end

data/lib/markdoc/version.rb

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

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: markdoc
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lkhagva Ochirkhuyag
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: polyglot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: treetop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: pygments.rb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+description: Markdown with support for pseudocode to flowchart and sequence diagram
+  generation
+email: ochkoo@gmail.com
+executables:
+- markdoc
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/markdoc
+- bin/pseudo2svg
+- bin/sequence2svg
+- lib/markdoc.rb
+- lib/markdoc/pseudocode.rb
+- lib/markdoc/pseudocode.treetop
+- lib/markdoc/renderer.rb
+- lib/markdoc/sequence.rb
+- lib/markdoc/version.rb
+homepage: https://github.com/ochko/markdoc
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Markdown to HTML converter with diagrams
+test_files: []