gisele 0.1.0 → 0.2.0

data/CHANGELOG.md

@@ -1,4 +1,19 @@
-# 0.1.0 / FIX ME
+# 0.2.0 / 2012-02-17
+
+## Enhancements
+
+* A --graph option has been added to the main `gisele` shell command. It outputs a graph in
+  the graphviz/dot format representing a process as a box-and-arrow workflow.
+
+## Breaking changes
+
+* Boolean literals (true, false) are now explicitly represented in boolean expressions,
+  under a :bool_lit AST node.
+* All statements and clauses relying on boolean conditions (if_st, while_st, elsif_clause,
+  when_clause) have now an explicit :bool_expr node as first child. Previously, a subnode
+  of the boolean grammar was used.
+
+# 0.1.0 / 2012-02-17
 
 ## Enhancements
 

data/Gemfile

@@ -5,6 +5,7 @@ group :runtime do
   gem "epath", "~> 0.0.1"
   gem "quickl", "~> 0.4.3"
   gem "awesome_print", "~> 1.0"
+  gem "yargi", "~> 0.2.0"
 end
 
 group :development do

data/Gemfile.lock

@@ -16,6 +16,7 @@ GEM
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.8.0)
     wlang (0.10.2)
+    yargi (0.2.0)
 
 PLATFORMS
   ruby
@@ -29,3 +30,4 @@ DEPENDENCIES
   rake (~> 0.9.2)
   rspec (~> 2.8.0)
   wlang (~> 0.10.2)
+  yargi (~> 0.2.0)

data/gisele.gemspec

@@ -131,6 +131,7 @@ Gem::Specification.new do |s|
   s.add_dependency("epath", "~> 0.0.1")
   s.add_dependency("quickl", "~> 0.4.3")
   s.add_dependency("awesome_print", "~> 1.0")
+  s.add_dependency("yargi", "~> 0.2.0")
 
   # The version of ruby required by this gem
   #

data/gisele.noespec

@@ -12,7 +12,7 @@ variables:
   upper:
     Gisele
   version:
-    0.1.0
+    0.2.0
   summary: |-
     Gisele is a Process Analyzer Toolset
   description: |-
@@ -29,6 +29,7 @@ variables:
     - {name: epath,         version: "~> 0.0.1",  groups: [runtime]}
     - {name: quickl,        version: "~> 0.4.3",  groups: [runtime]}
     - {name: awesome_print, version: "~> 1.0",    groups: [runtime]}
+    - {name: yargi,         version: "~> 0.2.0",  groups: [runtime]}
     #
     - {name: rake,      version: "~> 0.9.2",  groups: [development]}
     - {name: bundler,   version: "~> 1.0",    groups: [development]}

data/lib/gisele/command.rb

@@ -5,7 +5,7 @@ module Gisele
   #
   # SYNOPSIS
   #   gisele [--version] [--help]
-  #   gisele [--ast] PROCESS_FILE
+  #   gisele [--ast | --graph] PROCESS_FILE
   #
   # OPTIONS
   # #{summarized_options}
@@ -14,14 +14,18 @@ module Gisele
   #   The Gisele process analyzer toolset provides tools and technique to model and analyze
   #   complex process models such as care processes.
   #
-  #   When --ast is used, the command parses a process file and prints its Abstract Syntax
+  #   When --no-sugar is specified, syntactic sugar is first removed before making any other
+  #   transformation. For now, this rewrites all `if` statements as explicit `case` guarded
+  #   commands.
+  #
+  #   When --ast is used, the command parses the process file and prints its Abstract Syntax
   #   Tree (AST) on standard output. By default, this option prints the AST for manual
   #   debugging, that is with colors and extra information. Use --ast=ruby to get a ruby
   #   array for automatic processing.
   #
-  #   When --no-sugar is specified, syntactic sugar is first removed before making any other
-  #   transformation. For now, this rewrites all `if` statements as explicit `case` guarded
-  #   commands.
+  #   When --graph is used, the command parses the process file. It then converts the AST into
+  #   a directed graph representing the process as a box-and-arrow workflow and outputs it on 
+  #   standard output. For now, the only output format available is dot (from graphviz).
   #
   class Gisele::Command <  Quickl::Command(__FILE__, __LINE__)
 
@@ -35,6 +39,10 @@ module Gisele
       opt.on('--no-sugar', 'Apply syntactic sugar removal') do
         @sugar = false
       end
+      @print_graph = nil
+      opt.on('--graph=[MODE]', 'Converts and print a graph (dot)') do |value|
+        @print_graph = (value || "dot").to_sym
+      end
       opt.on_tail('--help', "Show this help message") do
         raise Quickl::Help
       end
@@ -52,7 +60,9 @@ module Gisele
 
       ast = Gisele.ast(file)
       ast = Gisele::Language::SugarRemoval.new.call(ast) unless @sugar
+
       print_ast(ast, @print_ast) if @print_ast
+      print_graph(ast, @print_graph) if @print_graph
     end
 
     private
@@ -68,5 +78,10 @@ module Gisele
       ap ast, options
     end
 
-  end # class Command
+    def print_graph(ast, option)
+      graph = Gisele::Language::ToGraph.new.call(ast)
+      puts graph.to_dot
+    end
+
+end # class Command
 end # module Gisele

data/lib/gisele/language/ast/bool_and.rb

@@ -0,0 +1,14 @@
+module Gisele
+  module Language
+    module AST
+      module BoolAnd
+        include Node
+
+        def label
+          markers[:match] ? markers[:match].to_s : "(#{self[1].label} and #{self[2].label})"
+        end
+
+      end # module BoolAnd
+    end # module AST
+  end # module Language
+end # module Gisele

data/lib/gisele/language/ast/bool_expr.rb

@@ -0,0 +1,14 @@
+module Gisele
+  module Language
+    module AST
+      module BoolExpr
+        include Node
+
+        def label
+          markers[:match] ? markers[:match].to_s : last.label
+        end
+
+      end # module BoolExpr
+    end # module AST
+  end # module Language
+end # module Gisele

data/lib/gisele/language/ast/bool_not.rb

@@ -0,0 +1,14 @@
+module Gisele
+  module Language
+    module AST
+      module BoolNot
+        include Node
+
+        def label
+          markers[:match] ? markers[:match].to_s : "not(#{last.label})"
+        end
+
+      end # module BoolNot
+    end # module AST
+  end # module Language
+end # module Gisele

data/lib/gisele/language/ast/bool_or.rb

@@ -0,0 +1,14 @@
+module Gisele
+  module Language
+    module AST
+      module BoolOr
+        include Node
+
+        def label
+          markers[:match] ? markers[:match].to_s : "(#{self[1].label} or #{self[2].label})"
+        end
+
+      end # module BoolOr
+    end # module AST
+  end # module Language
+end # module Gisele

data/lib/gisele/language/ast/elsif_clause.rb

@@ -0,0 +1,14 @@
+module Gisele
+  module Language
+    module AST
+      module ElsifClause
+        include Node
+
+        def label
+          self[1].label
+        end
+
+      end # module ElsifClause
+    end # module AST
+  end # module Language
+end # module Gisele

data/lib/gisele/language/ast/helpers.rb

@@ -3,17 +3,17 @@ module Gisele
     module AST
       module Helpers
 
-        def ast(arg)
-          return node(arg) if looks_a_node?(arg)
-          Syntax.ast(arg)
+        def ast(arg, markers = {})
+          return node(arg, markers) if looks_a_node?(arg)
+          ast(Syntax.ast(arg), markers)
         end
 
-        def node(arg)
+        def node(arg, markers = {})
           return arg if arg.is_a?(Node)
           unless looks_a_node?(arg)
             raise ArgumentError, "Array expected, #{arg.inspect} found."
           end
-          extend_node(arg).tap do |node|
+          extend_node(arg, markers).tap do |node|
             node.children.each{|c| node(c) if looks_a_node?(c)}
           end
         end
@@ -24,10 +24,16 @@ module Gisele
           arg.is_a?(Node) or (arg.is_a?(Array) and arg.first.is_a?(Symbol))
         end
 
-        def extend_node(arg)
-          modname = Language.rule2mod(arg.first)
-          mod     = AST.const_get(modname) rescue Node
-          arg.extend(mod)
+        def extend_node(arg, markers)
+          mod = ast_module(arg)
+          arg.extend(mod).tap do |node|
+            node.markers = markers
+          end
+        end
+
+        def ast_module(node)
+          modname = Language.rule2mod(node.first)
+          AST.const_get(modname) rescue Node
         end
 
         extend(self)

data/lib/gisele/language/ast/if_st.rb

@@ -0,0 +1,14 @@
+module Gisele
+  module Language
+    module AST
+      module IfSt
+        include Node
+
+        def label
+          self[1].label
+        end
+
+      end # module IfSt
+    end # module AST
+  end # module Language
+end # module Gisele

data/lib/gisele/language/ast/node.rb

@@ -3,6 +3,16 @@ module Gisele
     module AST
       module Node
 
+        # Returns the node markers
+        def markers
+          @markers ||= {}
+        end
+
+        # Sets node markers
+        def markers=(markers)
+          @markers = markers
+        end
+
         # Returns the rule name, that is, the first Symbol element
         # of the node array.
         #
@@ -24,6 +34,11 @@ module Gisele
           self[1..-1]
         end
 
+        # Returns the associated ast_module
+        def ast_module
+          AST::Helpers.send(:ast_module, self)
+        end
+
         # Applies copy-and-transform to this node.
         #
         # Example:
@@ -34,7 +49,7 @@ module Gisele
         #   # => [:something, ...]
         #
         def copy(&block)
-          base = AST.node([rule_name])
+          base = AST.node([rule_name], markers.dup)
           children.inject(base, &block)
         end
 
@@ -44,11 +59,32 @@ module Gisele
         # will correctly be applied to the duplicated array.
         #
         def dup
-          AST.node(super)
+          AST.node(super, markers.dup)
+        end
+
+        # Returns a label for this AST node
+        def label
+          ""
+        end
+
+        # Returns attributes to use for dot printing
+        def dot_attributes
+          attrs = Language::DOT_ATTRIBUTES[rule_name.to_s] || {}
+          attrs.merge(:label => label)
         end
 
       end # module Node
     end # module AST
   end # module Language
 end # module Gisele
-require_relative 'unit'
+require_relative 'unit'
+require_relative 'task_call_st'
+require_relative 'while_st'
+require_relative 'if_st'
+require_relative 'elsif_clause'
+require_relative 'when_clause'
+require_relative 'bool_expr'
+require_relative 'bool_and'
+require_relative 'bool_or'
+require_relative 'bool_not'
+require_relative 'var_ref'

data/lib/gisele/language/ast/task_call_st.rb

@@ -0,0 +1,14 @@
+module Gisele
+  module Language
+    module AST
+      module TaskCallSt
+        include Node
+
+        def label
+          last.to_s
+        end
+
+      end # module TaskCallSt
+    end # module AST
+  end # module Language
+end # module Gisele

data/lib/gisele/language/ast/var_ref.rb

@@ -0,0 +1,14 @@
+module Gisele
+  module Language
+    module AST
+      module VarRef
+        include Node
+
+        def label
+          last.to_s
+        end
+
+      end # module BoolNot
+    end # module AST
+  end # module Language
+end # module Gisele

data/lib/gisele/language/ast/when_clause.rb

@@ -0,0 +1,14 @@
+module Gisele
+  module Language
+    module AST
+      module WhenClause
+        include Node
+
+        def label
+          self[1].label
+        end
+
+      end # module WhenClause
+    end # module AST
+  end # module Language
+end # module Gisele

data/lib/gisele/language/ast/while_st.rb

@@ -0,0 +1,14 @@
+module Gisele
+  module Language
+    module AST
+      module WhileSt
+        include Node
+
+        def label
+          self[1].label
+        end
+
+      end # module WhileSt
+    end # module AST
+  end # module Language
+end # module Gisele

data/lib/gisele/language/ast.rb

@@ -2,8 +2,8 @@ module Gisele
   module Language
     module AST
 
-      def node(arg)
-        AST::Helpers.node(arg)
+      def node(arg, markers = {})
+        AST::Helpers.node(arg, markers)
       end
       module_function :node
 

data/lib/gisele/language/dot.yml

@@ -0,0 +1,19 @@
+task_refinement:
+  shape: circle
+  style: filled
+  fillcolor: black
+  fixed: true
+  width: 0.1
+task_call_st:
+  shape: box
+while_st:
+  shape: diamond
+if_st:
+  shape: diamond
+case_st:
+  shape: diamond
+par_st:
+  shape: box
+  height: 0.1
+  style: filled
+  fillcolor: black

data/lib/gisele/language/sugar_removal.rb

@@ -15,8 +15,17 @@ module Gisele
 
         def on_if_st(node)
           condition, dost, *clauses = node.children
-          base = [:case_st, [:when_clause, condition, @main.call(dost)] ]
-          @condition = negate(condition)
+
+          # create case_st with same markers as the if_st
+          when_clause = [:when_clause, condition, @main.call(dost)]
+          when_clause = node(when_clause, node.markers.dup)
+          base        = [:case_st, when_clause]
+          base        = node(base, node.markers.dup)
+
+          # this is the condition for elsif clauses
+          @condition = negate(condition.last)
+
+          # make injection now
           clauses.inject base do |memo,clause|
             memo << call(clause)
           end
@@ -24,17 +33,29 @@ module Gisele
 
         def on_elsif_clause(node)
           condition, dost, = node.children
-          prev, @condition = @condition, [:bool_and, negate(condition), @condition]
-          [:when_clause,
-            [:bool_and, condition, prev],
-            @main.call(dost)]
+
+          # install new conditions for me and next elsif clauses
+          condition = condition.last
+          previous  = @condition
+          @condition = [:bool_and, negate(condition), @condition]
+
+          # convert elsif to when and keep the markers
+          base = \
+            [:when_clause,
+              [:bool_expr, [:bool_and, condition, previous]],
+              @main.call(dost) ]
+          node(base, node.markers.dup)
         end
 
         def on_else_clause(node)
           dost, = node.children
-          [:when_clause,
-            @condition,
-            @main.call(dost)]
+
+          # convert else to when and keep the markers
+          base = \
+            [:when_clause,
+              [:bool_expr, @condition],
+              @main.call(dost)]
+          node(base, node.markers.dup)
         end
 
         private

data/lib/gisele/language/syntax/bool_expr.rb

@@ -0,0 +1,14 @@
+module Gisele
+  module Language
+    module Syntax
+      module BoolExpr
+        include Node
+
+        def _to_ast
+          [:bool_expr, captures[:theexpr].first.to_ast]
+        end
+
+      end # module BoolExpr
+    end # module Syntax
+  end # module Language
+end # module Gisele

data/lib/gisele/language/syntax/bool_lit.rb

@@ -5,7 +5,7 @@ module Gisele
         include Node
 
         def _to_ast
-          captures[:boolean_literal].first.value
+          [:bool_lit, strip == "true"]
         end
 
       end # module BoolLit

data/lib/gisele/language/syntax/grammar.citrus

@@ -90,7 +90,8 @@ grammar Gisele::Language::Syntax::Grammar
   ### Boolean expressions
 
   rule bool_expr
-    bool_or
+    (spacing theexpr:bool_or)
+    <Gisele::Language::Syntax::BoolExpr>
   end
 
   rule bool_or
@@ -112,11 +113,11 @@ grammar Gisele::Language::Syntax::Grammar
   end
 
   rule bool_term
-    bool_paren | boolean_literal | bool_varref
+    bool_paren | bool_lit | bool_varref
   end
 
   rule bool_paren
-    ('(' spacing expr:bool_expr spacing ')')
+    ('(' spacing expr:bool_or spacing ')')
     <Gisele::Language::Syntax::BoolParen>
   end
 

data/lib/gisele/language/syntax/node.rb

@@ -4,7 +4,7 @@ module Gisele
       module Node
 
         def to_ast
-          Language::AST.node(_to_ast)
+          Language::AST.node(_to_ast, {:match => self})
         end
 
       end # module Node
@@ -20,6 +20,7 @@ require_relative 'bool_paren'
 require_relative 'bool_not'
 require_relative 'bool_and'
 require_relative 'bool_or'
+require_relative 'bool_expr'
 require_relative 'st_list'
 require_relative 'implicit_seq_st'
 require_relative 'task_call_st'

data/lib/gisele/language/to_graph.rb

@@ -0,0 +1,119 @@
+module Gisele
+  module Language
+    class ToGraph < Transformer
+      module Connector; end
+
+      def recurse_on_last(node)
+        call(node.last)
+      end
+      alias :on_unit :recurse_on_last
+
+      def on_task_def(node)
+        @graph = Yargi::Digraph.new
+        call(SugarRemoval.new.call(node.last))
+        @graph.vertices(Connector).each do |vertex|
+          next unless vertex.out_edges.size == 1
+          target = vertex.out_edges.first.target
+          @graph.reconnect(vertex.in_edges, nil, target)
+          @graph.remove_vertex(vertex)
+        end
+        @graph
+      end
+
+      def on_task_refinement(node)
+        entry, exit = add_vertex(node), add_vertex(node)
+        c_entry, c_exit = call(node.last)
+        connect(entry, c_entry)
+        connect(c_exit, exit)
+        [entry, exit]
+      end
+
+      def on_seq_st(node)
+        mine    = entry_and_exit(node)
+        current = mine.first
+        node.children.each do |child|
+          c_entry, c_exit = call(child)
+          connect(current, c_entry)
+          current = c_exit
+        end
+        connect(current, mine.last)
+        mine
+      end
+
+      def on_par_st(node)
+        entry, exit = add_vertex(node), add_vertex(node)
+        node.children.each do |child|
+          c_entry, c_exit = call(child)
+          connect(entry, c_entry)
+          connect(c_exit, exit)
+        end
+        [entry, exit]
+      end
+
+      def on_case_st(node)
+        entry, exit = entry_and_exit(node)
+
+        diamond = add_vertex(node)
+        connect(entry, diamond)
+
+        node.children.each do |when_clause|
+          c_entry, c_exit = call(when_clause.last)
+          connect(diamond, c_entry, when_clause)
+          connect(c_exit, exit)
+        end
+
+        [entry, exit]
+      end
+
+
+      def on_while_st(node)
+        cond, dost, = node.children
+
+        entry, exit = entry_and_exit(node)
+
+        diamond = add_vertex(node)
+        connect(entry, diamond)
+
+        c_entry, c_exit = call(node.last)
+
+        connect(diamond, exit,    false_ast_node)
+        connect(diamond, c_entry, true_ast_node)
+        connect(c_exit, diamond)
+
+        [entry, exit]
+      end
+
+      def on_task_call_st(node)
+        entry, exit = entry_and_exit(node)
+        task = add_vertex(node)
+        connect(entry, task)
+        connect(task, exit)
+        [entry, exit]
+      end
+
+      private
+
+      def add_vertex(node)
+        @graph.add_vertex(node.dot_attributes)
+      end
+
+      def entry_and_exit(node, tag = Connector)
+        @graph.add_n_vertices(2, tag)
+      end
+
+      def connect(source, target, node = nil)
+        marks = node.nil? ? {} : node.dot_attributes
+        @graph.connect(source, target, marks)
+      end
+
+      def false_ast_node
+        Syntax.ast("false", :root => :bool_expr)
+      end
+
+      def true_ast_node
+        Syntax.ast("true", :root => :bool_expr)
+      end
+
+    end # class SugarRemoval
+  end # module Language
+end # module Gisele