dynflow 0.4.1 → 0.5.0

data/lib/dynflow/action.rb

@@ -21,16 +21,18 @@ module Dynflow
     require 'dynflow/action/cancellable_polling'
 
     def self.all_children
-      children.inject(children) { |children, child| children + child.all_children }
+      children.values.inject(children.values) do |children, child|
+        children + child.all_children
+      end
     end
 
     def self.inherited(child)
-      children << child
+      children[child.name] = child
       super child
     end
 
     def self.children
-      @children ||= []
+      @children ||= {}
     end
 
     def self.middleware
@@ -154,6 +156,27 @@ module Dynflow
       execution_plan.steps.fetch(plan_step_id)
     end
 
+    # @param [Class] filter_class return only actions which are kind of `filter_class`
+    # @return [Array<Action>] of directly planned actions by this action,
+    # returned actions are in Present phase
+    def planned_actions(filter = Action)
+      phase! Present
+      plan_step.
+          planned_steps(execution_plan).
+          map { |s| s.action execution_plan }.
+          select { |a| a.is_a?(filter) }
+    end
+
+    # @param [Class] filter_class return only actions which are kind of `filter_class`
+    # @return [Array<Action>] of all (including indirectly) planned actions by this action,
+    # returned actions are in Present phase
+    def all_planned_actions(filter_class = Action)
+      phase! Present
+      mine = planned_actions
+      (mine + mine.reduce([]) { |arr, action| arr + action.all_planned_actions }).
+          select { |a| a.is_a?(filter_class) }
+    end
+
     def run_step
       phase! Present
       execution_plan.steps.fetch(run_step_id) if run_step_id
@@ -283,7 +306,7 @@ module Dynflow
       @execution_plan.switch_flow(Flows::Sequence.new([]), &block)
     end
 
-    def plan_self(input)
+    def plan_self(input = {})
       phase! Plan
       self.input.update input
 

data/lib/dynflow/execution_plan.rb

@@ -264,18 +264,12 @@ module Dynflow
       plan_total > 0 ? (plan_done / plan_total) : 1
     end
 
-    # This method can be used to access result of the whole execution plan and detailed
-    # progress.
-    # @return [Array<Action::Presenter>] presenter of the actions
-    # involved in the plan
+    # @return [Array<Action>] actions in Present phase, consider using
+    # Steps::Abstract#action instead
     def actions
       @actions ||= begin
-        action_ids = steps.values.map(&:action_id).uniq
-        action_ids.map do |action_id|
-          attributes = world.persistence.adapter.load_action(id, action_id)
-          Action.from_hash(attributes.update(phase: Action::Present, execution_plan: self),
-                           world)
-        end
+        action_ids = steps.reduce({}) { |h, (_, s)| h.update s.action_id => s }
+        action_ids.map { |_, step| step.action self }
       end
     end
 

data/lib/dynflow/execution_plan/steps/abstract.rb

@@ -86,6 +86,8 @@ module Dynflow
         raise NotImplementedError, "Expected to be implemented in RunStep and FinalizeStep"
       end
 
+      # @return [Action] in presentation mode, intended for retrieving: progress information,
+      # details, human outputs, etc.
       def action(execution_plan)
         attributes = world.persistence.adapter.load_action(execution_plan_id, action_id)
         Action.from_hash(attributes.update(phase: Action::Present, execution_plan: execution_plan),

data/lib/dynflow/execution_plan/steps/plan_step.rb

@@ -23,6 +23,10 @@ module Dynflow
         @children = children
       end
 
+      def planned_steps(execution_plan)
+        @children.map { |id| execution_plan.steps.fetch(id) }
+      end
+
       def phase
         Action::Plan
       end

data/lib/dynflow/testing/factories.rb

@@ -20,6 +20,20 @@ module Dynflow
             execution_plan.world)
       end
 
+      def create_action_presentation(action_class)
+        execution_plan = DummyExecutionPlan.new
+        action_class.new(
+            { execution_plan:    execution_plan,
+              execution_plan_id: execution_plan.id,
+              id:                Testing.get_id,
+              phase:             Action::Present,
+              plan_step_id:      1,
+              run_step_id:       nil,
+              finalize_step_id:  nil,
+              input:             nil },
+            execution_plan.world)
+      end
+
       # @return [Action::PlanPhase]
       def plan_action(plan_action, *args, &block)
         Match! plan_action.phase, Action::Plan

data/lib/dynflow/version.rb

@@ -1,3 +1,3 @@
 module Dynflow
-  VERSION = '0.4.1'
+  VERSION = '0.5.0'
 end

data/test/action_test.rb

@@ -61,9 +61,7 @@ module Dynflow
       end
 
       let :presenter do
-        execution_plan.actions.find do |action|
-          action.is_a? Support::CodeWorkflowExample::IncomingIssues
-        end
+        execution_plan.root_plan_step.action execution_plan
       end
 
       specify { presenter.class.must_equal Support::CodeWorkflowExample::IncomingIssues }

data/test/execution_plan_test.rb

@@ -64,7 +64,7 @@ module Dynflow
         describe 'for error in running phase' do
 
           before do
-            step_id                             = execution_plan.run_flow.all_step_ids[2]
+            step_id = execution_plan.run_flow.all_step_ids[2]
             execution_plan.steps[step_id].set_state :error, true
           end
 
@@ -77,7 +77,7 @@ module Dynflow
         describe 'for pending step in running phase' do
 
           before do
-            step_id                             = execution_plan.run_flow.all_step_ids[2]
+            step_id = execution_plan.run_flow.all_step_ids[2]
             execution_plan.steps[step_id].set_state :pending, true
           end
 
@@ -239,10 +239,10 @@ module Dynflow
           world.plan(Support::CodeWorkflowExample::IncomingIssues, issues_data)
         end
 
-        it 'provides the access to the actions data via Action::Presenter' do
-          execution_plan.actions.size.must_equal 9
-          execution_plan.actions.each do |action|
-            action.phase.must_equal Action::Present
+        it 'provides the access to the actions data via steps #action' do
+          execution_plan.steps.size.must_equal 20
+          execution_plan.steps.each do |_, step|
+            step.action(execution_plan).phase.must_equal Action::Present
           end
         end
       end

data/test/support/code_workflow_example.rb

@@ -24,9 +24,8 @@ module Support
       end
 
       def summary
-        triages   = execution_plan.actions.find_all do |action|
-          action.is_a? Triage
-        end
+        # TODO fix, not a good pattern, it should delegate to IncomingIssue first
+        triages   = all_planned_actions(Triage)
         assignees = triages.map do |triage|
           triage.output[:classification] &&
               triage.output[:classification][:assignee]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dynflow
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-18 00:00:00.000000000 Z
+date: 2014-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport