vispan 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dbe9fe566ea5f0e162c6a7cafcef542cdcef52a7
+  data.tar.gz: 8da510a7bcaab07ae848f650a2d19ce57c909c56
+SHA512:
+  metadata.gz: 2485a48fee6b3a87b3f026845c0bafcfa25df604ac4cb3b416b530454d770b950fc039fca349cb935b4c77a4e0aa6fc53acbac729a8e7991edba014db4b306e0
+  data.tar.gz: 063433caa99ad5ed07caef983b4f2ae5773609e3dac851fc625c97ae1465a1d4711d96b1373c5a508b85f35f5a3cb4ae3e5ec69026a8ca56a734a52f16ab1823

data/bin/generate

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+# require "./input.rb"
+require "./lib/process_visualisation.rb"
+
+if ARGV.length == 2
+  input_file = ARGV[0]
+  output_file = ARGV[1]
+  process = ProcessVisualisation.new(input_file)
+  process.display_text
+  process.visualize(output_file)
+else
+  puts 'wrong number of arguments!'
+end

data/lib/process_visualisation.rb

@@ -0,0 +1,73 @@
+# require "process_visualisation/version.rb"
+require 'rack'
+require "szenario.rb"
+require "relation.rb"
+require "node.rb"
+require "output_console.rb"
+require "output_graphic.rb"
+
+module ProcessVisualisation
+  attr_reader :processed_string, :nodes, :text, :szenarios
+
+  class WebPreview < Rack::Static
+    def call(env)
+      # initialize()
+      self.visualize(Rails.root.join('app/assets/images/process.png'))
+      #generate process.png
+      # [200, {"Content-Type" => "text/plain"}, env]
+      [200, {"Content-Type" => "image/png"}, [IO.read(Rails.root.join('app/assets/images/process.png'))]]
+    end
+
+    def initialize(input_file)
+      @szenarios = []
+      separate_szenarios(input_file)
+    end
+
+    def separate_szenarios(input_file)
+      @single_szenario = Szenario.new()
+      @relation_lines = []
+      @lines = File.readlines(input_file)
+      @lines.each do |line|
+
+        if line[0] == "-"
+          create_new_szenario(line)
+        elsif (line == "\n" && !@relation_lines.empty?) || (line == @lines.last)
+          create_new_relation(line)
+        elsif line != "\n"
+          @relation_lines << line
+        end
+
+      end
+
+      @szenarios << @single_szenario
+    end
+
+    def create_new_szenario(line)
+      if @single_szenario.title == ""
+        @single_szenario.set_title(line)
+      else
+        @szenarios << @single_szenario
+        @single_szenario = Szenario.new(line)
+      end
+    end
+
+    def create_new_relation(line)
+      @relation_lines << line if line != "\n"
+      relation = Relation.new(@relation_lines, @szenarios.length)
+      @single_szenario.add_relation(relation)
+      @relation_lines = []
+    end
+
+    def display_text
+      text = OutputConsole.new(@szenarios)
+      text.generate
+    end
+
+    def visualize(output_file)
+      png = OutputGraphic.new(@szenarios, output_file)
+      png.generate
+    end
+
+  end
+
+end

data/lib/process_visualisation/config.rb

@@ -0,0 +1,13 @@
+NODE_WIDTH = 3.3
+NODE_MARGIN = 0.2
+
+SZENARIO = {szenario:{bgcolor:"mintcream:lightcyan", margin:60, fontsize:18}}
+
+NODE = {screen:{color:"none", shape:"rect", style:"rounded, filled", fillcolor:"yellowgreen:lemonchiffon", width:"#{NODE_WIDTH}", margin:"#{NODE_MARGIN}"},
+              email:{color:"none", shape:"rect",style:"rounded, filled", fillcolor:"grey:ghostwhite", width:"#{NODE_WIDTH}", margin:"#{NODE_MARGIN}"},
+              pdf:{color:"none", shape:"rect", style:"rounded, filled", fillcolor:"gold:orange", width:"#{NODE_WIDTH}", margin:"#{NODE_MARGIN}"},
+              command:{color:"none", shape:"rect",style:"rounded, filled", fillcolor:"lightblue:steelblue", width:"#{NODE_WIDTH}", margin:"#{NODE_MARGIN}"}
+              }
+RELATION = {event:{color:"red"},
+                  link:{arrowhead:"none", arrowsize:"30"}
+                  }

data/lib/process_visualisation/graphwriter.rb

@@ -0,0 +1,34 @@
+require "config.rb"
+
+class GraphWriter
+
+  def build_string(szenarios)
+    "Digraph G{ rankdir=LR; splines=ortho;labeljust=l#{szenarios.map.with_index {|szenario, index| build_szenario(szenario, index)}.join("")}}"
+  end
+
+  def build_szenario(szenario, index)
+    node_definitions = szenario.nodes.map{|node| write_node(node)}.join("")
+    relation_definitions = szenario.relations.map{|relation| write_relations(relation)}.join("")
+    effect_definitions = szenario.relations.map {|relation| write_effects(relation)}.join("")
+
+    "\n\nsubgraph cluster#{index.to_s} {label=\"#{szenario.title}\"#{find_attributes(szenario)};\n#{node_definitions}\n#{relation_definitions}#{effect_definitions}}"
+  end
+
+  def write_node(node)
+    "#{node.name} [label=\"#{node.label}\" #{find_attributes(node)}]\n"
+  end
+
+  def write_relations(relation)
+    "#{relation.start.name} -> #{relation.stop.name} [label=\"#{relation.label}\" #{find_attributes(relation)}]\n"
+  end
+
+  def write_effects(relation)
+    "{rank = same; #{relation.stop.name}; #{relation.effects.map(&:name).join('; ')};}" unless relation.effects.empty?
+  end
+
+  def find_attributes(element)
+    type = element.class.to_s.upcase
+    GraphWriter.const_get(type)[element.type.to_sym].map{|attribute| "; #{attribute[0]}=\"#{attribute[1]}\""}.join("")
+  end
+
+end

data/lib/process_visualisation/node.rb

@@ -0,0 +1,16 @@
+class Node
+
+  attr_accessor :name, :type, :label
+  NODE_TYPES = ["screen", "email", "pdf", "command"]
+
+  def initialize(type, label, index)
+    @name = transform_to_name(label, index)
+    @type = NODE_TYPES.include?(type)? type : ""
+    @label = label
+  end
+
+  def transform_to_name(label, index)
+    label.gsub(/[-\s.]/, "") + index.to_s
+  end
+
+end

data/lib/process_visualisation/output_console.rb

@@ -0,0 +1,33 @@
+class OutputConsole
+
+  def initialize(szenarios)
+    @text = ""
+    @szenarios = szenarios
+  end
+
+  def generate
+    build_text
+    puts @text
+  end
+
+  def build_text
+    @szenarios.each do |szenario|
+      @text += "\nProzess Ablauf in '#{szenario.title}'\n"
+      done = []
+      szenario.relations.each do |rel|
+
+        if !done.include? rel.start
+          @text += "\n"
+          @text += "'#{rel.start.label}' führt zu '#{rel.stop.label}'"
+          done << rel.start
+
+        else
+          @text += " und zu '#{rel.stop.label}'"
+        end
+      end
+
+      @text += "\n"
+    end
+  end
+
+end

data/lib/process_visualisation/output_graphic.rb

@@ -0,0 +1,38 @@
+class OutputGraphic
+
+  def initialize(szenarios, output_file)
+    @szenarios = szenarios
+    @processed_string = ""
+    @output_file = output_file
+  end
+
+  def generate
+    build_graph
+    generate_processed_file(@processed_string)
+    generate_graph(@output_file)
+  end
+
+  def build_graph
+    graph = GraphWriter.new()
+    @processed_string = graph.build_string(@szenarios)
+  end
+
+  def generate_processed_file(processed_string)
+    ready = File.open("lib/process_visualisation/input_processed.dot", "w") {
+      |file| file.write(processed_string)
+    }
+  end
+
+  def generate_graph(output_file)
+
+    file_ending = check_output(output_file)
+    cmd = "dot -T#{file_ending} lib/process_visualisation/input_processed.dot -o #{output_file}"
+    system(cmd)
+  end
+
+  def check_output(output_file)
+    output_file = output_file.to_s
+    output_file.split(".")[1]
+  end
+
+end

data/lib/process_visualisation/relation.rb

@@ -0,0 +1,49 @@
+class Relation
+  attr_accessor :start, :stop, :type, :effects, :label
+
+  def initialize(relation_array, index)
+    @effects = []
+    @label = ""
+
+    extract(relation_array, index)
+  end
+
+  def extract(relation_array, index)
+    @start = set_node(relation_array.shift, index)
+    set_connection(relation_array.shift)
+    @stop = set_node(relation_array.shift, index)
+    @effects = relation_array.map{|effect| set_node(effect, index)}
+  end
+
+  def set_connection(label_string)
+    label = label_string.split(":")
+    @label = label[1].strip if label[0].include? "Event"
+    adjust_length(@label)
+    @type = label[0].strip.downcase
+  end
+
+  def set_node(node_string, index)
+    node_array = node_string.split(":")
+    type = node_array[0].strip.downcase
+    label = node_array[1].strip
+    # puts label
+    adjust_length(label)
+    Node.new(type, label, index)
+  end
+
+  def adjust_length(string)
+
+    if string.length > 30
+      (20..string.length).step(20){ |limit|
+
+        if string[limit, string.length-limit].include?(" ")
+          empty = string[limit, string.length-limit].index(" ")
+          string[limit+empty] = "\n"
+        end
+
+      }
+    end
+
+  end
+
+end

data/lib/process_visualisation/szenario.rb

@@ -0,0 +1,42 @@
+require "graphwriter.rb"
+
+class Szenario
+  attr_accessor :title, :relations, :nodes, :type
+
+  def initialize(line = "")
+    @title = line.gsub(/--/, "").strip
+    @relations = []
+    @nodes = []
+    @type = "szenario"
+  end
+
+  def build_szenario(index)
+    graph = GraphWriter.new()
+    node_definitions = @nodes.map{|node| graph.write_node(node)}.join("")
+    relation_definitions = @relations.map{|relation| graph.write_relations(relation)}.join("")
+    effect_definitions = @relations.map {|relation| graph.write_effects(relation)}.join("")
+
+    "\n\nsubgraph cluster#{index.to_s} {bgcolor=aliceblue; label=\"#{title}\";\n#{node_definitions}\n#{relation_definitions}#{effect_definitions}}"
+  end
+
+  def set_title(line)
+    @title = line.gsub(/--/, "").strip
+  end
+
+  def add_relation(relation)
+    @relations << relation
+    add_nodes([relation.start, relation.stop, relation.effects])
+  end
+
+  def add_nodes(nodes_array)
+    nodes_array = nodes_array.flatten
+    nodes_array.map{|node| @nodes << node if is_not_saved(node, @nodes)}
+  end
+
+  def is_not_saved(node, szenario_nodes)
+    szenario_nodes.each do |szenario_node|
+      return false if szenario_node.name == node.name
+    end
+  end
+
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: vispan
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Witek
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-09-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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.11.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.11.3
+description: 
+email: daniel.witek@edgycircle.com
+executables:
+- generate
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/generate
+- lib/process_visualisation.rb
+- lib/process_visualisation/config.rb
+- lib/process_visualisation/graphwriter.rb
+- lib/process_visualisation/node.rb
+- lib/process_visualisation/output_console.rb
+- lib/process_visualisation/output_graphic.rb
+- lib/process_visualisation/relation.rb
+- lib/process_visualisation/szenario.rb
+homepage: ''
+licenses:
+- BSD-3-Clause
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib/process_visualisation
+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.2.3
+signing_key: 
+specification_version: 4
+summary: Visualize processes with simple syntax and multiple output formats
+test_files: []