pallets 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ffde33a5c57e9528172a4ba0b75c1a9cbaca30e62fd5ebe0028cad69e5590b9
-  data.tar.gz: ab123ae6de59a28fe8c99a886ec7299adde7ded2121e55719465aef7ff2c7af2
+  metadata.gz: a2894dd7dff299d2cb4f2c9bf67b7be01f27adc93cfc7729fbbac8c3c9988722
+  data.tar.gz: ce6d91fc194a7441557bd3250f994b65dbb35dd29d7adbb0a08c3be699a88cf8
 SHA512:
-  metadata.gz: e96b0c486602044964eb01fafb82ac329d8ca779f70e85d01781a8605e13e141e5e14bdc443e0ce64bbdfed5bf6502f1ca7e77d50bb82afa68d5523e135e1558
-  data.tar.gz: e02b283810944d41e23ba4c96d8380f7f0a1a5799615d7c73c264af251b6447f9b1ea925bd6cfb790f53c55269b3728480efc0231ee89ce19121800c72955648
+  metadata.gz: 37ff1a501b2661b0a63d9d0c3844d323952e07e05135661169138dd3ee88f906115c3db13b33205dbcc7faf94af6ac2dc4a8cc2e2e49982789ca5e75cca0ea2a
+  data.tar.gz: 5cc7c495ca3b2463ef2d8d168f0bb43f73c6c7d7a970d66b21ebe22068db389e272819e2d2f7bb49c6fc2835f6b22a8b3991421e5501dc763a94c5aecd5aca88

data/CHANGELOG.md

@@ -6,6 +6,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.6.0] - 2019-09-02
+### Added
+- define task aliases in order to reuse tasks within a workflow definition (#44)
+- define anonymous workflows (#45)
+
 ## [0.5.1] - 2019-06-01
 ### Changed
 - fix transaction completeness in Appsignal instrumenter (#43)

data/examples/aliases.rb

@@ -0,0 +1,28 @@
+require 'pallets'
+
+class Aliases < Pallets::Workflow
+  task 'StartSmtpServer'
+  task 'SendEmail', as: 'SayHello', depends_on: 'StartSmtpServer'
+  task 'SendEmail', as: 'SayGoodbye', depends_on: 'StartSmtpServer'
+  task 'StopSmtpServer' => ['SayHello', 'SayGoodbye']
+end
+
+class StartSmtpServer < Pallets::Task
+  def run
+    puts "Starting SMTP server..."
+  end
+end
+
+class SendEmail < Pallets::Task
+  def run
+    puts "* sending e-mail"
+  end
+end
+
+class StopSmtpServer < Pallets::Task
+  def run
+    puts "Stopped SMTP server"
+  end
+end
+
+Aliases.new.run

data/examples/anonymous.rb

@@ -0,0 +1,13 @@
+require 'pallets'
+
+class Anonymous < Pallets::Task
+  def run
+    puts 'This is anonymous!'
+  end
+end
+
+workflow = Pallets::Workflow.build do
+  task 'Anonymous'
+end
+
+workflow.new.run

data/lib/pallets/dsl/workflow.rb

@@ -1,7 +1,7 @@
 module Pallets
   module DSL
     module Workflow
-      def task(arg, depends_on: nil, max_failures: nil, &block)
+      def task(arg, as: nil, depends_on: nil, max_failures: nil, &block)
         klass, dependencies = case arg
         when Hash
           # The `task Foo => Bar` notation
@@ -12,10 +12,13 @@ module Pallets
         end
 
         task_class = klass.to_s
+        as ||= task_class
+
         dependencies = Array(dependencies).compact.uniq.map(&:to_s)
-        graph.add(task_class, dependencies)
+        graph.add(as, dependencies)
 
-        task_config[task_class] = {
+        task_config[as] = {
+          'workflow_class' => self.name,
           'task_class' => task_class,
           'max_failures' => max_failures || Pallets.configuration.max_failures
         }

data/lib/pallets/graph.rb

@@ -9,15 +9,19 @@ module Pallets
     end
 
     def add(node, dependencies)
-      @nodes[node] = dependencies
+      raise WorkflowError, "Task #{node} is already defined in this workflow. "\
+                           "Use `task '#{node}', as: 'FooBar'` to define an "\
+                           "alias and reuse task" if nodes.key?(node)
+
+      nodes[node] = dependencies
     end
 
     def parents(node)
-      @nodes[node]
+      nodes[node]
     end
 
     def empty?
-      @nodes.empty?
+      nodes.empty?
     end
 
     # Returns nodes topologically sorted, together with their order (number of
@@ -37,12 +41,14 @@ module Pallets
 
     private
 
+    attr_reader :nodes
+
     def tsort_each_node(&block)
-      @nodes.each_key(&block)
+      nodes.each_key(&block)
     end
 
     def tsort_each_child(node, &block)
-      @nodes.fetch(node).each(&block)
+      nodes.fetch(node).each(&block)
     rescue KeyError
       raise WorkflowError, "Task #{node} is marked as a dependency but not defined"
     end

data/lib/pallets/version.rb

@@ -1,3 +1,3 @@
 module Pallets
-  VERSION = "0.5.1"
+  VERSION = "0.6.0"
 end

data/lib/pallets/workflow.rb

@@ -4,6 +4,12 @@ module Pallets
 
     attr_reader :context
 
+    def self.build(&block)
+      Class.new(self).tap do |workflow_class|
+        workflow_class.instance_eval(&block)
+      end
+    end
+
     def initialize(context_hash = {})
       @id = nil
       # Passed in context hash needs to be buffered
@@ -25,19 +31,18 @@ module Pallets
     private
 
     def jobs_with_order
-      self.class.graph.sorted_with_order.map do |task_class, order|
-        job = serializer.dump(construct_job(task_class))
+      self.class.graph.sorted_with_order.map do |task_alias, order|
+        job = serializer.dump(construct_job(task_alias))
         [order, job]
       end
     end
 
-    def construct_job(task_class)
-      {}.tap do |job|
+    def construct_job(task_alias)
+      Hash[self.class.task_config[task_alias]].tap do |job|
         job['wfid'] = id
-        job['jid'] = "J#{Pallets::Util.generate_id(task_class)}".upcase
-        job['workflow_class'] = self.class.name
+        job['jid'] = "J#{Pallets::Util.generate_id(job['task_class'])}".upcase
         job['created_at'] = Time.now.to_f
-      end.merge(self.class.task_config[task_class])
+      end
     end
 
     def backend
@@ -48,6 +53,10 @@ module Pallets
       Pallets.serializer
     end
 
+    def self.name
+      @name ||= super || '<Anonymous>'
+    end
+
     def self.task_config
       @task_config ||= {}
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pallets
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Andrei Horak
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-01 00:00:00.000000000 Z
+date: 2019-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -56,6 +56,8 @@ files:
 - README.md
 - Rakefile
 - bin/pallets
+- examples/aliases.rb
+- examples/anonymous.rb
 - examples/appsignal.rb
 - examples/config/appsignal.yml
 - examples/config_savvy.rb