trailblazer-activity 0.10.0 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7bfa65d9c33030f9512d1d465cbb47862336c4cff11be999ea64845bc8d8dff
-  data.tar.gz: a28d2c3bd407fbc5db2cf0d250e68e13f169ae62297d50c51e0507bb743d641b
+  metadata.gz: c94f3dbe368043f005ec5d68fc099246c8f302dd6e1b366989b321665d5f2b98
+  data.tar.gz: 28f0b58b9d2de3b7adffd543860baed3e47eb25945161cbe7cc5f45a8f907abd
 SHA512:
-  metadata.gz: 64a06dd8ff913d4ad708de7bcca3e846f81333eb1c70aaf1a2de132de6ac4044cee55fb6715865fd8580989ce5f944bb4e331e3e758ab925102330bb09397cd6
-  data.tar.gz: 1e00a9ee8523d21901f7a912a02afc8e25038c13111775b367226cf792796da2edbbef6853e5a4ead885858021b92a4eb9d48e466bf94a84126956b716a3397a
+  metadata.gz: 78eaabeff700dd6b22ff61efe8efe993287875c02e7a80197ca6880c435bba2732d61ebaa41acc4da3737ad556ae669b8dc03f6dad445394486e7a1298d62569
+  data.tar.gz: '08b7cbeea9a42fc99a8d38f95439d6e265f0fe4051ccfa8e95a18f18c117e34bf6ae2824e07a8eb139db32e4559bd094c30d621e1fb82cc2c8e80916e7c6ee88'

data/CHANGES.md

@@ -1,3 +1,7 @@
+# 0.10.1
+
+* Update IllegalSignalError exception for more clarity
+
 # 0.10.0
 
 * Require `developer` >= 0.0.7.

data/README.md

@@ -1,22 +1,22 @@
 # Activity
 
-implements Intermediate, Implementation, compiler and `Activity::Implementation`, Activity::Interface
+Implements Intermediate, Implementation and compiler
 
 The `activity` gem brings a light-weight DSL to define business processes, and the runtime logic to run those activities.
 
 A process is a set of arbitrary pieces of logic you define, chained together and put into a meaningful context by an activity. Activity lets you focus on the implementation of steps while Trailblazer takes care of the control flow.
 
-Please find the [full documentation on the Trailblazer website](http://trailblazer.to/api-docs). [Note that the docs are WIP.]
+Please find the [full documentation on the Trailblazer website](https://2019.trailblazer.to/2.1/docs/activity.html). [Note that the docs are WIP.]
 
 ## Example
 
-The `activity` gem provides three default patterns to model processes: `Path`, `Railway` and `FastTrack`. Here's an example what a railway activity could look like, along with some more complex connections.
+In conjunction with [`dsl-linear`](https://github.com/trailblazer/trailblazer-activity-dsl-linear), the `activity` gem provides three default patterns to model processes: `Path`, `Railway` and `FastTrack`. Here's an example of what a railway activity could look like, along with some more complex connections (you can read more about Railway strategy in the [docs](https://2019.trailblazer.to/2.1/docs/activity.html#activity-strategy-railway)).
 
 ```ruby
-module Memo::Update
-  extend Trailblazer::Activity::Railway()
-  module_function
+require "trailblazer-activity"
+require "trailblazer-activity-dsl-linear"
 
+class Memo::Update < Trailblazer::Activity::Railway
   # here goes your business logic
   #
   def find_model(ctx, id:, **)
@@ -39,10 +39,10 @@ module Memo::Update
 
   # here comes the DSL describing the layout of the activity
   #
-  step method(:find_model)
-  step method(:validate), Output(:failure) => End(:validation_error)
-  step method(:save)
-  fail method(:log_error)
+  step :find_model
+  step :validate, Output(:failure) => End(:validation_error)
+  step :save
+  fail :log_error
 end
 ```
 
@@ -71,17 +71,22 @@ With Activity, modeling business processes turns out to be ridiculously simple:
 ## Features
 
 * Activities can model any process with arbitrary flow and connections.
-* Nesting and compositions are allowed and encouraged.
+* Nesting and compositions are allowed and encouraged (via Trailblazer's [`dsl-linear`](https://github.com/trailblazer/trailblazer-activity-dsl-linear) gem).
 * Different step interfaces, manual processing of DSL options, etc is all possible.
 * Steps can be any kind of callable objects.
-* Tracing!
+* Tracing! (via Trailblazer's [`developer`](https://github.com/trailblazer/trailblazer-developer) gem)
 
 ## Operation
 
-Trailblazer's [`Operation`](http://trailblazer.to/2.1/operation) internally uses an activity to model the processes.
+Trailblazer's [`Operation`](https://2019.trailblazer.to/2.1/docs/operation.html#operation-overview) internally uses an activity to model the processes.
+
+## Workflow
+Activities can be formed into bigger compounds and using workflow, you can build long-running processes such as a moderated blog post or a parcel delivery. Also, you don't have to use the DSL but can use the [`editor`](https://2019.trailblazer.to/2.1/docs/pro.html#pro-editor)instead(cool for more complex, long-running flows). Here comes a sample screenshot.
+
+<img src="http://2019.trailblazer.to/2.1/dist/img/flow.png">
 
 ## License
 
 © Copyright 2018, Trailblazer GmbH
 
-Licensed under the LGPLv3 license. We also offer a [commercial-friendly license](http://trailblazer.to/pro).
+Licensed under the LGPLv3 license. We also offer a commercial-friendly [license](https://2019.trailblazer.to/2.1/docs/pro.html#pro-license).

data/lib/trailblazer/activity/circuit.rb

@@ -51,7 +51,16 @@ module Trailblazer
           # Stop execution of the circuit when we hit a stop event (< End). This could be an task's End or Suspend.
           return [ last_signal, args ] if @stop_events.include?(task) # DISCUSS: return circuit_options here?
 
-          task = next_for(task, last_signal) or raise IllegalSignalError.new("<#{@name}>[#{task}][ #{last_signal.inspect} ]")
+          if (next_task = next_for(task, last_signal))
+            task = next_task
+          else
+            raise IllegalSignalError.new(
+              task,
+              signal: last_signal,
+              outputs: @map[task],
+              exec_context: circuit_options[:exec_context], # passed at run-time from DSL
+            )
+          end
         end
       end
 
@@ -67,7 +76,26 @@ module Trailblazer
         outputs[signal]
       end
 
+      # Common reasons to raise IllegalSignalError are
+      #   * Returning invalid signal from custom Macros
+      #   * Returning invalid signal from steps which are not taskWrapped, for example: `step task: method(:validate)`
+      #
+      # Rest assured, it won't be raised in case of below scenarios where they can return any value,
+      #   * Steps with instance method signature, for example, `step :load_user`
+      #   * Steps with proc signature, for example `step ->(ctx, **){}`
       class IllegalSignalError < RuntimeError
+        attr_reader :task, :signal
+
+        def initialize(task, signal:, outputs:, exec_context:)
+          @task = task
+          @signal = signal
+
+          message = "#{exec_context.class}: \n\t" \
+            "\sUnrecognized Signal `#{signal.inspect}` returned from #{task.inspect}. Registered signals are, \n" \
+            "- #{outputs.keys.join("\n- ")}"
+
+          super(message)
+        end
       end
     end
   end

data/lib/trailblazer/activity/version.rb

@@ -1,7 +1,7 @@
 module Trailblazer
   module Version
     module Activity
-      VERSION = "0.10.0"
+      VERSION = "0.10.1"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trailblazer-activity
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.10.1
 platform: ruby
 authors:
 - Nick Sutterer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-23 00:00:00.000000000 Z
+date: 2020-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trailblazer-context
@@ -142,8 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Runtime code for Trailblazer activities.