gisele 0.2.0 → 0.3.0

data/CHANGELOG.md

@@ -1,55 +1,84 @@
+# 0.3.0 / 2012-02-20
+
+* Major enhancements
+
+  * The ugly "refinement ... end" construction has been removed. See info in the breaking
+    changes section below.
+  * The grammar now allows a task definition to contain the definition of sub tasks. The
+    idiomatic place is after fluent and trackvar definitions and before the refinement.
+
+* Minor enhancements
+
+  * The --graph option now outputs one graph for each task_def in the unit. Previously only
+    the graph of the last task definition was printed.
+
+* Bugfixes
+
+  * Missing edges for absent else clauses are now added to the graph generated by
+    the --graph option (ToGraph).
+
+* Breaking changes
+
+  * The syntax and AST of a task definition has changed. The "refinement ... end" construct
+    has been removed and replaced by an explicit process statement. Accordingly, the nodes
+    task_refinement and task_signature have been removed as well. The AST signature of a task
+    definition is now as follows:
+
+        [:task_def, "TaskName", (fluent_def, trackvar_def, task_def)*, explicit_statement]
+
 # 0.2.0 / 2012-02-17
 
-## Enhancements
+* 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.
+  * 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
+* 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.
+  * 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
-
-* The main `gisele` command now accepts a --no-sugar option that removes syntactic
-  sugar. This option is limited to the rewriting of `if` statements as guarded `case`
-  commands for now. Additional rewriting could be added in the future.
-* All AST nodes (obtained via `Gisele.ast` or similar) now include the module 
-  `Gisele::Language::AST::Node` which contains a few utilities.
-
-## Breaking changes
-
-* The language package has been reorganized and is now considered as belonging to
-  the private API. Further changes there will therefore not b considered as Breaking
-  changes in the future (expect the structure of the AST, of course). 
-  The `Gisele.parse` and `Gisele.ast` methods belong to the public API and are therefore
-  the way to (parse / get an AST) from a process file / source.
-
-* The top AST element of a process file is always a :unit. The latter may contain 
-  one ore more task definitions. Import/include nodes will probably be added later
-  and authorized at the beginning of the file.
-
-* The following syntax nodes have been renamed:
-    :varref     -> :var_ref
-    :or         -> :bool_or
-    :and        -> :bool_and
-    :not        -> :bool_not
-    :if         -> :if_st
-    :else       -> :else_clause
-    :elsif      -> :elsif_clause
-    :while      -> :while_st
-    :seq        -> :seq_st
-    :par        -> :par_st
-    :task_call  -> :task_call_st
-    :task       -> :task_def
-    :signature  -> :task_signature
-    :refinement -> :task_refinement
+* Enhancements
+
+  * The main `gisele` command now accepts a --no-sugar option that removes syntactic
+    sugar. This option is limited to the rewriting of `if` statements as guarded `case`
+    commands for now. Additional rewriting could be added in the future.
+  * All AST nodes (obtained via `Gisele.ast` or similar) now include the module
+    `Gisele::Language::AST::Node` which contains a few utilities.
+
+* Breaking changes
+
+  * The language package has been reorganized and is now considered as belonging to
+    the private API. Further changes there will therefore not b considered as Breaking
+    changes in the future (expect the structure of the AST, of course).
+    The `Gisele.parse` and `Gisele.ast` methods belong to the public API and are therefore
+    the way to (parse / get an AST) from a process file / source.
+
+  * The top AST element of a process file is always a :unit. The latter may contain
+    one ore more task definitions. Import/include nodes will probably be added later
+    and authorized at the beginning of the file.
+
+  * The following syntax nodes have been renamed:
+
+        :varref     -> :var_ref
+        :or         -> :bool_or
+        :and        -> :bool_and
+        :not        -> :bool_not
+        :if         -> :if_st
+        :else       -> :else_clause
+        :elsif      -> :elsif_clause
+        :while      -> :while_st
+        :seq        -> :seq_st
+        :par        -> :par_st
+        :task_call  -> :task_call_st
+        :task       -> :task_def
+        :signature  -> :task_signature
+        :refinement -> :task_refinement
 
 # 0.0.1 / 2012-02-16
 

data/Gemfile.lock

@@ -19,6 +19,7 @@ GEM
     yargi (0.2.0)
 
 PLATFORMS
+  java
   ruby
 
 DEPENDENCIES

data/examples/meeting-scheduler/MeetingScheduling.gis

@@ -1,34 +1,34 @@
 #
-# This is a Gisele process for the Meeting Scheduler example, similar to what can be found 
-# in [Lam11]. The main difference between this model and the one defined there is the use 
+# This is a Gisele process for the Meeting Scheduler example, similar to what can be found
+# in [Lam11]. The main difference between this model and the one defined there is the use
 # of tracking variables. Tracking variables are introduced and explained in [Dam11].
 #
 # The Meeting Scheduler examplar [Fea97]
 #
-#     A meeting initiator issues a meeting request, specifying the expected participants and 
-#     the date range within which the meeting should take place. The scheduler then sends an 
-#     electronic invitation to each participant, requesting them to provide their date 
-#     constraints. 
-# 
-#     A date conflict occurs when no date can be found that fits all participant constraints. 
-#     In such case, the initiator may extend the date range or request some participants to 
-#     weaken their constraints; a new scheduling cycle is then required. Otherwise, the 
+#     A meeting initiator issues a meeting request, specifying the expected participants and
+#     the date range within which the meeting should take place. The scheduler then sends an
+#     electronic invitation to each participant, requesting them to provide their date
+#     constraints.
+#
+#     A date conflict occurs when no date can be found that fits all participant constraints.
+#     In such case, the initiator may extend the date range or request some participants to
+#     weaken their constraints; a new scheduling cycle is then required. Otherwise, the
 #     meeting is planned at a date meeting all constraints.
-# 
-#     A soft goal requires meetings to be scheduled as quickly as possible once initiated; 
-#     another one requires interactions with participants to be minimized. In the simplified 
-#     version considered here, only two scheduling cycles are allowed; the meeting is planned 
-#     after that. In such case, we will assume that the best date is chosen so as to maximize 
-#     the number of participants attending. We also ignore features like meeting cancellations, 
+#
+#     A soft goal requires meetings to be scheduled as quickly as possible once initiated;
+#     another one requires interactions with participants to be minimized. In the simplified
+#     version considered here, only two scheduling cycles are allowed; the meeting is planned
+#     after that. In such case, we will assume that the best date is chosen so as to maximize
+#     the number of participants attending. We also ignore features like meeting cancellations,
 #     meeting locations, etc.
 #
 # References
 #
-#   * [Dam11] Christophe Damas, Analyzing Multi-View Models of Software Systems, PhD thesis, 
+#   * [Dam11] Christophe Damas, Analyzing Multi-View Models of Software Systems, PhD thesis,
 #             University of Louvain, November 2011
-#   * [Fea97] M.S. Feather, S. Fickas, A. Finkelstein and A. van Lamsweerde, Requirements and 
+#   * [Fea97] M.S. Feather, S. Fickas, A. Finkelstein and A. van Lamsweerde, Requirements and
 #             Specification Exemplars, Automated Software Engineering, 1997
-#   * [Lam11] Bernard Lambeau, Synthesizing Multi-View Models of Software Systems, PhD thesis, 
+#   * [Lam11] Bernard Lambeau, Synthesizing Multi-View Models of Software Systems, PhD thesis,
 #             University of Louvain, November 2011
 #
 task MeetingScheduling
@@ -37,17 +37,17 @@ task MeetingScheduling
   # have been weakened or the date range extended.
   fluent secondCycle
     {WeakenConstraints:end, ExtendDateRange:end},
-    {InitiateMeeting:end} 
+    {InitiateMeeting:end}
   initially false
 
   # A date conflict may only occur when constraints are acquired or weakened. Being a tracking
   # variable and not fluent, we do not know the exact value of this variable when these tasks
   # occur.
-  trackvar dateConflict 
+  trackvar dateConflict
     {AcquireConstraints:end, WeakenConstraints:end}
   initially false
 
-  # The arbitrator decides to resolve a conflict during the Arbitrate task. The following 
+  # The arbitrator decides to resolve a conflict during the Arbitrate task. The following
   # definition does not capture the precise value of the variable but only that the value
   # can only change during Arbitrate.
   trackvar resolveByWeakening
@@ -55,7 +55,7 @@ task MeetingScheduling
   initially false
 
   # This is the task refinement
-  refinement 
+  seq
     InitiateMeeting
     AcquireConstraints
     while dateConflict and not(secondCycle)

data/examples/rectal-cancer-pathway/RectalCancerPathway.gis

@@ -0,0 +1,64 @@
+#
+# This is a Gisele process for the example of a rectal cancer care process, similar to the
+# case study that can be found in [Dam11].
+#
+# References
+#
+#   * [Dam11] Christophe Damas, Analyzing Multi-View Models of Software Systems, PhD thesis,
+#             University of Louvain, November 2011
+task RectalCancerPathway
+
+  # This variable tracks if the cancer is treated in emergency
+  # in the initial state
+  trackvar emergency
+    {RectalCancerPathway:start}
+
+  # Is the cancer confirmed by the diagnosis?
+  trackvar cancerConfirmed
+    {Diagnosis:start}
+  initially false
+
+  # Is the emergency treatment envisioned by the
+  # multi-disciplinary staff?
+  trackvar surgeryEnvisioned
+    {StaffMeeting:end}
+  initially false
+
+  # The diagnosis task
+  task Diagnosis
+
+    fluent diagKnown
+      {EndoBio:end}, {}
+
+    fluent extensionKnown
+      {SpreadEvaluation:end}, {}
+
+    while not(diagKnown and extensionKnown)
+      Consultation
+      if diagKnown
+        SpreadEvaluation
+      else
+        EndoBio
+      end
+    end
+
+  end # Diagnosis
+
+  # main task refinement
+  if emergency
+    Emergency
+    Surgery
+    PostTreatment
+  else
+    Diagnosis
+    if cancerConfirmed
+      StaffMeeting
+      if surgeryEnvisioned
+        PreTreatment
+        Surgery
+        PostTreatment
+      end
+    end
+  end
+
+end

data/gisele.noespec

@@ -12,7 +12,7 @@ variables:
   upper:
     Gisele
   version:
-    0.2.0
+    0.3.0
   summary: |-
     Gisele is a Process Analyzer Toolset
   description: |-

data/lib/gisele/command.rb

@@ -24,7 +24,7 @@ module Gisele
   #   array for automatic processing.
   #
   #   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 
+  #   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__)
@@ -59,7 +59,7 @@ module Gisele
       end
 
       ast = Gisele.ast(file)
-      ast = Gisele::Language::SugarRemoval.new.call(ast) unless @sugar
+      ast = Language::SugarRemoval.new.call(ast) unless @sugar
 
       print_ast(ast, @print_ast) if @print_ast
       print_graph(ast, @print_graph) if @print_graph
@@ -79,8 +79,10 @@ module Gisele
     end
 
     def print_graph(ast, option)
-      graph = Gisele::Language::ToGraph.new.call(ast)
-      puts graph.to_dot
+      graphs = Gisele::Language::ToGraph.new.call(ast)
+      graphs.each do |graph|
+        puts graph.to_dot
+      end
     end
 
 end # class Command

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

@@ -0,0 +1,14 @@
+module Gisele
+  module Language
+    module AST
+      module CaseSt
+        include Node
+
+        def label
+          (self[1] && self[1].label) || ""
+        end
+
+      end # module CaseSt
+    end # module AST
+  end # module Language
+end # module Gisele

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

@@ -0,0 +1,14 @@
+module Gisele
+  module Language
+    module AST
+      module ElseClause
+        include Node
+
+        def label
+          "[else]"
+        end
+
+      end # module ElseClause
+    end # module AST
+  end # module Language
+end # module Gisele

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

@@ -77,11 +77,13 @@ module Gisele
     end # module AST
   end # module Language
 end # module Gisele
-require_relative 'unit'
+require_relative 'unit_def'
 require_relative 'task_call_st'
 require_relative 'while_st'
 require_relative 'if_st'
+require_relative 'else_clause'
 require_relative 'elsif_clause'
+require_relative 'case_st'
 require_relative 'when_clause'
 require_relative 'bool_expr'
 require_relative 'bool_and'

data/lib/gisele/language/ast/{unit.rb → unit_def.rb}

@@ -1,10 +1,10 @@
 module Gisele
   module Language
     module AST
-      module Unit
+      module UnitDef
         include Node
 
-      end # module Node
+      end # module UnitDef
     end # module AST
   end # module Language
 end # module Gisele

data/lib/gisele/language/dot.yml

@@ -1,4 +1,4 @@
-task_refinement:
+task_def:
   shape: circle
   style: filled
   fillcolor: black

data/lib/gisele/language/elsif_flattener.rb

@@ -0,0 +1,35 @@
+module Gisele
+  module Language
+    class ElsifFlattener < Rewriter
+      alias :on_missing :copy_and_applyall
+
+      def on_if_st(node)
+        condition, dost, *clauses = node.children
+
+        base = [:if_st, condition, dost]
+        base = node(base, node.markers.dup)
+
+        clauses.inject base do |cur_if, clause|
+          rw_clause = call(clause)
+          cur_if << rw_clause
+          rw_clause.last
+        end
+
+        base
+      end
+
+      def on_elsif_clause(node)
+        base = \
+          [:else_clause,
+           [:if_st, node[1], mainflow.call(node[2])] ]
+        base = node(base, node.markers.dup)
+      end
+
+      def on_else_clause(node)
+        [:else_clause, mainflow.call(node.last)]
+      end
+
+    end # class ElsifFlattener
+  end # module Language
+end # module Gisele
+

data/lib/gisele/language/if_to_case.rb

@@ -0,0 +1,63 @@
+module Gisele
+  module Language
+    class IfToCase < Rewriter
+      alias :on_missing :copy_and_applyall
+
+      def on_if_st(node)
+        condition, dost, *clauses = node.children
+
+        # create case_st with same markers as the if_st
+        when_clause = [:when_clause, condition, mainflow.call(dost)]
+        when_clause = node(when_clause, node.markers.dup)
+        base        = [:case_st, nil, 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
+      end
+
+      def on_elsif_clause(node)
+        condition, dost, = node.children
+
+        # 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]],
+            mainflow.call(dost) ]
+        node(base, node.markers.dup)
+      end
+
+      def on_else_clause(node)
+        dost, = node.children
+
+        # convert else to when and keep the markers
+        base = \
+          [:when_clause,
+            [:bool_expr, @condition],
+            mainflow.call(dost)]
+        node(base, node.markers.dup)
+      end
+
+      private
+
+      def negate(cond)
+        if cond.rule_name == :bool_not
+          cond.last
+        else
+          [:bool_not, cond]
+        end
+      end
+
+    end # class IfToCase
+  end # module Language
+end # module Gisele

data/lib/gisele/language/rewriter/helper.rb

@@ -0,0 +1,41 @@
+module Gisele
+  module Language
+    class Rewriter
+      class Helper
+
+        attr_accessor :next_in_chain
+
+        def self.install_on(rewriter)
+          methods = const_get(:Methods)
+          rewriter.module_eval do
+            include methods
+          end
+          rewriter.add_helper(new)
+        end
+
+        def call(rw, node, &bl)
+          meth = :"on_#{node.first}"
+          meth = :"on_missing" unless respond_to?(meth)
+          send(meth, rw, node) do |r,n|
+            next_call(r, n, bl)
+          end
+        end
+
+        def on_missing(rw, node)
+          yield(rw, node)
+        end
+
+        private
+
+        def next_call(rw, node, toplevel)
+          if nic = next_in_chain
+            nic.call(rw, node, &toplevel)
+          else
+            toplevel.call(rw, node)
+          end
+        end
+
+      end # class Helper
+    end # class Rewriter
+  end # module Language
+end # module Gisele

data/lib/gisele/language/rewriter/scoping.rb

@@ -0,0 +1,34 @@
+module Gisele
+  module Language
+    class Rewriter
+      class Scoping < Helper
+
+        module Methods
+
+          def scope_stack
+            @scope_stack ||= []
+          end
+
+          def with_scope(scope)
+            scope_stack.push(scope)
+            result = yield
+            scope_stack.pop
+            result
+          end
+
+        end # module Methods
+
+        def on_missing(rw, node)
+          if node.rule_name.to_s =~ /_def/
+            rw.with_scope(node) do
+              yield(rw, node)
+            end
+          else
+            yield(rw, node)
+          end
+        end
+
+      end # module Scoping
+    end # class Rewriter
+  end # module Language
+end # module Gisele

data/lib/gisele/language/rewriter/work_on_nodes.rb

@@ -0,0 +1,30 @@
+module Gisele
+  module Language
+    class Rewriter
+      class WorkOnNodes < Helper
+        include AST::Helpers
+
+        def call(rw, node, &bl)
+          node = pre_call(node)
+          tran = next_call(rw, node, bl)
+          post_call(tran)
+        end
+
+        protected
+
+        def pre_call(node)
+          unless looks_a_node?(node)
+            msg = "AST node expected, got #{node.inspect}"
+            raise ArgumentError, msg, caller
+          end
+          node(node)
+        end
+
+        def post_call(t)
+          looks_a_node?(t) ? node(t) : t
+        end
+
+      end # module WorkOnNodes
+    end # class Rewriter
+  end # module Language
+end # module Gisele

data/lib/gisele/language/rewriter.rb

@@ -0,0 +1,60 @@
+module Gisele
+  module Language
+    class Rewriter
+      include AST::Helpers
+
+      ### class methods
+
+      def self.helpers
+        @helpers ||= [ WorkOnNodes.new ]
+      end
+
+      def self.add_helper(helper)
+        unless helpers.empty?
+          helpers.last.next_in_chain = helper
+        end
+        helpers << helper
+      end
+
+      ### instance methods
+
+      attr_reader :mainflow
+
+      def initialize(options = {})
+        @options  = options
+        @mainflow = options[:mainflow] || self
+      end
+
+      def call(node)
+        help(node) do |n|
+          meth = :"on_#{node.first}"
+          meth = :"on_missing" unless respond_to?(meth)
+          send(meth, node)
+        end
+      end
+
+      def on_missing(node)
+        raise UnexpectedNodeError, "Unexpected node: #{node.inspect}"
+      end
+
+      def copy_and_applyall(node)
+        node.copy do |memo,child|
+          memo << (child.is_a?(AST::Node) ? call(child) : child)
+        end
+      end
+
+      private
+
+      def help(node)
+        @first_helper ||= self.class.helpers.first
+        @first_helper.call(self, node) do |_,n|
+          yield(n)
+        end
+      end
+
+    end # class Rewriter
+  end # module Language
+end # module Gisele
+require_relative 'rewriter/helper'
+require_relative 'rewriter/work_on_nodes'
+require_relative 'rewriter/scoping'