ductwork 0.25.0 → 0.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 970768539836272ed6d411c51898eb3abc90daedf469699ab11436614271db52
-  data.tar.gz: 07fe94c58e54abf798a9d2e33bf3efdaf28ed9c3b084d3d80f330f178bb4fb47
+  metadata.gz: ad0ce6f40af82ff2fcc08abb65083e32fdee666be43646a9f53f59033da85fa6
+  data.tar.gz: 7ba3f5a80167323fff58ae89b82fbfa44d10e4d20d6f6046436906250f1d9715
 SHA512:
-  metadata.gz: 2e40a877565d3e9ebdec716ada4c6bbcb5bec0bcef1bf6e15c9bc4ed58c4b8050672dc076f46461e91756d627a5225caaaf4476de2d360be3a9680367b498575
-  data.tar.gz: bfe7ef9eb3ea768b0f2b37e29064a13baff9209523545d5971fbb34c670b5ee792f3130d1e126270ee91b4c296bc6b7beaa13a2b3f46e88512499e1b88663071
+  metadata.gz: 34b29a0aaacc4994fadd9542c2d38696c15b88caaa6660f36d0b2cdac82aca27b818e7173ef633e03d2deea0fd162a24db41a7090feab2ff8c68d1fc6b8bcec3
+  data.tar.gz: 68bf238bdc9bdf4528cbbd5ba2554525d849d6008e5a7a6c5c0e35c96cf2896c04c2a8900ba29b69188b34f6ea1d30692dd25762b174c7b8bd7ee8afa146d9c1

data/CHANGELOG-PRO.md

@@ -1,5 +1,17 @@
 # Ductwork Pro Changelog
 
+## [0.7.0]
+
+- feat: allow for passing an argument when resuming a pipeline - this will replace passing the previous step's output payload as the input arguments to the next step
+
+## [0.6.0]
+
+- feat: introduce `dampen` transition - this is the first iteration of the human-in-the-loop feature
+- fix: bump `ductwork` dependency to v0.25.0
+- fix: bump `ductwork` dependency to v0.24.0
+- fix: bump `ductwork` dependency to v0.23.0 and set pipeline klass when creating availabilities
+- feat: add optional `to` keyword argument to `chain` transition - this makes the DSL a bit more aligned
+
 ## [0.5.0]
 
 - feat: enqueue jobs in batches when expanding and support starting delays

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Ductwork Changelog
 
+## [0.26.0]
+
+- feat: add `divert` and complementary `converge` transitions - this is essentially a conditional/case statement transition for pipelines including it's "fan-in" method
+
 ## [0.25.0]
 
 - chore: align "dampen" naming and remove "pause" naming

data/lib/ductwork/dsl/branch_builder.rb

@@ -43,6 +43,31 @@ module Ductwork
         self
       end
 
+      def divert(to:)
+        to_map = {}
+        next_nodes = []
+        to.each do |key, klass|
+          node = node_name(klass)
+          definition[:edges][node] ||= { klass: klass.name }
+          to_map[key.to_s] = node
+          next_nodes << node
+        end
+
+        definition[:edges][last_node][:to] = to_map
+        definition[:edges][last_node][:type] = :divert
+        definition[:nodes].push(*next_nodes)
+
+        if block_given?
+          sub_branches = next_nodes.map do |last_node|
+            Ductwork::DSL::BranchBuilder.new(last_node:, definition:)
+          end
+
+          yield sub_branches
+        end
+
+        self
+      end
+
       def combine(*branch_builders, into:)
         next_klass_name = node_name(into)
         definition[:edges][last_node][:to] = [next_klass_name]
@@ -58,6 +83,21 @@ module Ductwork
         self
       end
 
+      def converge(*branch_builders, into:)
+        next_klass_name = node_name(into)
+        definition[:edges][last_node][:to] = [next_klass_name]
+        definition[:edges][last_node][:type] = :converge
+
+        branch_builders.each do |branch|
+          definition[:edges][branch.last_node][:to] = [next_klass_name]
+          definition[:edges][branch.last_node][:type] = :converge
+        end
+        definition[:nodes].push(next_klass_name)
+        definition[:edges][next_klass_name] ||= { klass: into.name }
+
+        self
+      end
+
       def expand(to:)
         next_klass_name = node_name(to)
         definition[:edges][last_node][:to] = [next_klass_name]

data/lib/ductwork/dsl/definition_builder.rb

@@ -2,10 +2,12 @@
 
 module Ductwork
   module DSL
-    class DefinitionBuilder
+    class DefinitionBuilder # rubocop:todo Metrics/ClassLength
       class StartError < StandardError; end
       class CollapseError < StandardError; end
       class CombineError < StandardError; end
+      class DivertError < StandardError; end
+      class ConvergeError < StandardError; end
 
       def initialize
         @definition = {
@@ -112,6 +114,66 @@ module Ductwork
         self
       end
 
+      def divert(to:) # rubocop:todo Metrics/AbcSize
+        validate_classes!(to.values)
+        validate_definition_started!(action: "diverting chain")
+        validate_fallback_step!(to.keys)
+
+        to_map = {}
+        to_nodes = []
+        to.each do |key, klass|
+          node = node_name(klass)
+          definition[:edges][node] ||= { klass: klass.name }
+          to_map[key.to_s] = node
+          to_nodes << node
+        end
+
+        last_nodes.each do |last_node|
+          definition[:edges][last_node][:to] = to_map
+          definition[:edges][last_node][:type] = :divert
+        end
+
+        @last_nodes = to_nodes
+
+        definition[:nodes].push(*to_nodes)
+        divergences.push(:divert)
+
+        if block_given?
+          branches = last_nodes.map do |last_node|
+            Ductwork::DSL::BranchBuilder
+              .new(last_node:, definition:)
+          end
+
+          yield branches
+        end
+
+        self
+      end
+
+      def converge(into:) # rubocop:todo Metrics/AbcSize
+        validate_classes!(into)
+        validate_definition_started!(action: "converging steps")
+        validate_can_converge!
+
+        divergences.pop
+
+        into_node = node_name(into)
+        definition[:edges][into_node] ||= { klass: into.name }
+        last_nodes = definition[:nodes].reverse.select do |node|
+          definition.dig(:edges, node, :to).blank?
+        end
+        last_nodes.each do |last_node|
+          definition[:edges][last_node][:to] = [into_node]
+          definition[:edges][last_node][:type] = :converge
+        end
+
+        @last_nodes = Array(into_node)
+
+        definition[:nodes].push(into_node)
+
+        self
+      end
+
       def on_halt(klass)
         validate_classes!(klass)
 
@@ -176,6 +238,20 @@ module Ductwork
         end
       end
 
+      def validate_can_converge!
+        if divergences.empty?
+          raise ConvergeError, "Must divert pipeline definition before converging steps"
+        elsif divergences[-1] != :divert
+          raise ConvergeError, "Ambiguous converge on most recently divided/expanded definition"
+        end
+      end
+
+      def validate_fallback_step!(keys)
+        if keys.exclude?(:otherwise)
+          raise DivertError, "Must specify an `otherwise` branch"
+        end
+      end
+
       def add_edge_to_last_nodes(*klasses, type:)
         to_nodes = klasses.map do |klass|
           node = node_name(klass)

data/lib/ductwork/models/pipeline.rb

@@ -196,7 +196,7 @@ module Ductwork
       klass = edge[:klass]
 
       steps.where(id: advancing_ids, klass: klass).find_each do |step|
-        if to_transition.in?(%w[chain divide])
+        if to_transition.in?(%w[chain divide divert converge])
           advance_to_next_steps(step.id, edge)
         elsif to_transition == "expand"
           expand_to_next_steps(step.id, edge)
@@ -212,6 +212,25 @@ module Ductwork
     end
 
     def advance_to_next_steps(step_id, edge)
+      if edge[:type] == "divert"
+        advance_to_divert_step(step_id, edge)
+      else
+        advance_to_array_steps(step_id, edge)
+      end
+    end
+
+    def advance_to_divert_step(step_id, edge)
+      input_arg = Ductwork::Job.find_by(step_id:).return_value
+      node = edge[:to][input_arg.to_s] || edge[:to]["otherwise"]
+
+      if node.nil?
+        halt!
+      else
+        create_step_and_enqueue_job(edge:, input_arg:, node:)
+      end
+    end
+
+    def advance_to_array_steps(step_id, edge)
       too_many = edge[:to].tally.any? do |to_klass, count|
         depth = Ductwork
                 .configuration

data/lib/ductwork/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Ductwork
-  VERSION = "0.25.0"
+  VERSION = "0.26.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ductwork
 version: !ruby/object:Gem::Version
-  version: 0.25.0
+  version: 0.26.0
 platform: ruby
 authors:
 - Tyler Ewing