wolflow 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 341f216c39d06eda0e99156f6513335473821dbde3529496c59b49917b5bcb7d
+  data.tar.gz: 32fc5ae80dca08b3c766cc220be6e26dae9ad1a3915d6e797dd33f069fdb5b01
+SHA512:
+  metadata.gz: e172f8032758cf66ab3b8a4463b79c2b081bc12906c454111f560d74f6c625ebb36882622e1b880503df6cc0e989ab424dc50c1e1645952bc9aed9aa10c9434d
+  data.tar.gz: 16a23a7c0587d0ed3d4a9fd306625f4a53b72ea4b2088973ec4720fa09ae340a6859cab37f89445dae7225d9a22443733d9e2aece08d89a8381dbcc84d00c928

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.0.1] - 2024-12-18
+
+- Initial release.

data/LICENSE.txt

@@ -0,0 +1,239 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        https://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2013-2017 Docker, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       https://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+
+* lib/httpx/domain_name.rb
+
+This file is derived from the implementation of punycode available at
+here:
+
+https://www.verisign.com/en_US/channel-resources/domain-registry-products/idn-sdks/index.xhtml
+
+Copyright (C) 2000-2002 Verisign Inc., All rights reserved.
+
+Redistribution and use in source and binary forms, with or
+without modification, are permitted provided that the following
+conditions are met:
+
+ 1) Redistributions of source code must retain the above copyright
+    notice, this list of conditions and the following disclaimer.
+
+ 2) Redistributions in binary form must reproduce the above copyright
+    notice, this list of conditions and the following disclaimer in
+    the documentation and/or other materials provided with the
+    distribution.
+
+ 3) Neither the name of the VeriSign Inc. nor the names of its
+    contributors may be used to endorse or promote products derived
+    from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
+OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
+AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.
+
+This software is licensed under the BSD open source license. For more
+information visit www.opensource.org.
+
+Authors:
+ John Colosi (VeriSign)
+ Srikanth Veeramachaneni (VeriSign)
+ Nagesh Chigurupati (Verisign)
+ Praveen Srinivasan(Verisign)

data/README.md

@@ -0,0 +1,393 @@
+# Wolflow
+
+[![Gem Version](https://badge.fury.io/rb/wolflow.svg)](http://rubygems.org/gems/wolflow)
+[![pipeline status](https://gitlab.com/os85/wolflow/badges/master/pipeline.svg)](https://gitlab.com/os85/wolflow/pipelines?page=1&scope=all&ref=master)
+[![coverage report](https://gitlab.com/os85/wolflow/badges/master/coverage.svg?job=coverage)](https://os85.gitlab.io/wolflow/#_AllFiles)
+
+Wolflow is a workflow engine which implements [workflow patterns](http://www.workflowpatterns.com/) in ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'wolflow'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install wolflow
+
+## Usage
+
+`wolflow` exposes the workflow patterns building blocks as objects. As a user, you first build a specification of your workflow (the "workflow spec") as a series of linked "task specs"; then you execute and monitor its progress using a "workflow":
+
+```ruby
+require "wolflow"
+
+include Wolflow
+
+class MathSpec < Simple
+  def on_complete(task)
+    task.workflow.data[:tasks] += 1
+    puts("do math exercises")
+    super
+  end
+end
+
+class ScienceSpec < Simple
+  def on_complete(task)
+    task.workflow.data[:tasks] += 1
+    puts("do science exercises")
+    super
+  end
+end
+
+# build homework specification
+wspec = WorkflowSpec.new(id: "My Homework")
+
+# first do math, then do science homework
+wspec.connect(MathSpec.new(id: "math")).connect(ScienceSpec.new(id: "science"))
+
+# preare workflow instance
+wflow = Workflow.new(id: "homework", workflow_spec: wspec)
+wflow.data[:tasks] = 0
+
+# run a task each second
+while wflow.complete_one
+  sleep(1)
+end
+
+# or run all tasks at once
+wflow.complete_all
+#=> "do math exercises"
+#=> "do science exercises"
+puts wflow.data
+#≈> {:tasks=>2}
+```
+
+Workflow Specs, as well as Workflows, are serializable, which can be convenient for storage, or transfering representations across programs:
+
+```ruby
+require "json"
+
+# convert wspec to hash first, then dump to json
+spec_dump = JSON.dump(Hash[wspec])
+#=> => "{\"id\":\"My Homework\",\"task_specs\":[{\"id\":\"math\",\"name\":\"math_spec\",\"next_tasks\":[\"science\"]},{\"id\":\"science\",\"name\":\"science_spec\",\"next_tasks\":[]}]}"
+loaded_spec = WorkflowSpec.from_hash(JSON.parse(spec_dump, symbolize_names: true))
+#=>  #<Wolflow::WorkflowSpec:0x000000012899e340 @id="My Homework", @....
+
+wf_dump = JSON.dump(Hash[wflow])
+#=> "{\"id\":\"homework\",\"workflow_spec\":{\"id\":\"My Homework\",\"task_specs\":[{\"id\":\"math\",\"name\":\"math_spec\",\"next_tasks\":[\"science\"]},{\"id\":\"science\",\"name\":\"science_spec\",...
+loaded_wf = Workflow.from_hash(JSON.parse(wf_dump, symbolize_names: true))
+```
+
+## Patterns
+
+Here are a few snippets on how to apply the workflow patterns supported by `wolflow`. For simplification purposes, assume that all snippets are preceded by:
+
+```ruby
+require "wolflow"
+
+include Wolflow
+```
+
+and can be loaded into a worlfow using:
+
+```ruby
+wf = Workflow.new(id: test, workflow_spec: spec)
+# and, if applicable:
+wf.complete_all
+```
+
+### Sequence
+
+* http://www.workflowpatterns.com/patterns/control/basic/wcp1.php
+* A task in a process in enabled after the completion of a preceding task in the same process.
+
+```ruby
+spec = WorkflowSpec.new(id: "sequence")
+
+spec.connect(Simple.new(id: "one")).connect(Simple.new(id: "two")) #=> returns the simple task with id "two"
+```
+
+### Parallel Split
+
+* http://www.workflowpatterns.com/patterns/control/basic/wcp2.php
+* The divergence of a branch into two or more parallel branches each of which execute concurrently.
+
+```ruby
+spec = WorkflowSpec.new(id: "parallel_split")
+
+task_one = spec.connect(Simple.new(id: "one"))
+
+task_one.connect(Simple.new(id: "parallel_1"), Simple.new(id: "parallel_2"), Simple.new(id: "parallel_2")) #=> returns parallel tasks
+```
+
+### Synchronization
+
+* http://www.workflowpatterns.com/patterns/control/basic/wcp3.php
+* The convergence of two or more branches into a single subsequent branch such that the thread of control is passed to the subsequent branch when all input branches have been enabled.
+
+```ruby
+spec = WorkflowSpec.new(id: "synchronization")
+
+task_one = spec.connect(Simple.new(id: "one"))
+
+parallel_tasks = task_one.connect(Simple.new(id: "parallel_1"), Simple.new(id: "parallel_2"), Simple.new(id: "parallel_2"))
+
+sync_task = Synchronization.new(id: "sync_tasks")
+
+sync_task.join(*parallel_tasks)
+```
+
+### Exclusive Choice
+
+* http://www.workflowpatterns.com/patterns/control/basic/wcp4.php
+* The divergence of a branch into two or more branches such that when the incoming branch is enabled, the thread of control is immediately passed to precisely one of the outgoing branches based on a mechanism that can select one of the outgoing branches.
+
+```ruby
+spec = WorkflowSpec.new(id: "exclusive_choice")
+
+task_one = spec.connect(Simple.new(id: "one"))
+if_spec = Simple.new(id: "if")
+else_spec = Simple.new(id: "else")
+
+choice_spec, _ = task_one.choose(else_spec, id: "choice")
+# equivalent to:
+# choice_spec = ExclusiveChoice.new(id: "choice", else_tasks: [else_spec])
+
+choice_spec.connect(->(_task) { Time.now.hour < 13 }, if_spec)
+```
+
+### Simple Merge
+
+* http://www.workflowpatterns.com/patterns/control/basic/wcp5.php
+* The convergence of two or more branches into a single subsequent branch such that each enablement of an incoming branch results in the thread of control being passed to the subsequent branch.
+
+```ruby
+spec = WorkflowSpec.new(id: "simple_merge")
+
+task_one = spec.connect(Simple.new(id: "one"))
+
+parallel_tasks = task_one.connect(Simple.new(id: "parallel_1"), Simple.new(id: "parallel_2"), Simple.new(id: "parallel_2"))
+
+merge_task = SimpleMerge.new(id: "merge_tasks")
+
+merge_task.join(*parallel_tasks)
+```
+
+### Multi Choice
+
+* http://www.workflowpatterns.com/patterns/control/advanced_branching/wcp6.php
+* The divergence of a branch into two or more branches such that when the incoming branch is enabled, the thread of control is immediately passed to one or more of the outgoing branches based on a mechanism that selects one or more outgoing branches.
+
+```ruby
+spec = WorkflowSpec.new(id: "multi_choice")
+
+task_one = spec.connect(Simple.new(id: "one"))
+if_spec = Simple.new(id: "if")
+if2_spec = Simple.new(id: "if2")
+
+choice_spec = MultiChoice.new(id: "choice")
+
+choice_spec.connect(->(_task) { Time.now.hour < 13 }, if_spec)
+choice_spec.connect(->(_task) { Time.now.hour < 7 }, if2_spec)
+```
+
+### Structured Synchronized Merge
+
+* http://www.workflowpatterns.com/patterns/control/advanced_branching/wcp7.php
+* The Structured Synchronizing Merge occurs in a structured context, i.e. there must be a single Multi-Choice construct earlier in the process model with which the Structured Synchronizing Merge is associated and it must merge all of the branches emanating from the Multi-Choice. These branches must either flow from the Structured Synchronizing Merge without any splits or joins or they must be structured in form (i.e. balanced splits and joins).
+
+```ruby
+task_one = spec.connect(Simple.new(id: "structured_synchronized_merge"))
+if_spec = Simple.new(id: "if")
+if2_spec = Simple.new(id: "if2")
+
+choice_spec = MultiChoice.new(id: "choice")
+
+choice_spec.connect(->(_task) { Time.now.hour < 13 }, if_spec)
+choice_spec.connect(->(_task) { Time.now.hour < 7 }, if2_spec)
+
+merge_task = StructuredSynchronizingMerge.new(id: "merge_tasks")
+
+merge_task.join(if_spec, if2_spec) #=> would raise error unless all arguments are branched from the same multi choice spec
+```
+
+### Multi Merge
+
+* http://www.workflowpatterns.com/patterns/control/advanced_branching/wcp8.php
+* The convergence of two or more branches into a single subsequent branch such that each enablement of an incoming branch results in the thread of control being passed to the subsequent branch.
+
+```ruby
+spec = WorkflowSpec.new(id: "multi_merge")
+
+task_one = spec.connect(Simple.new(id: "one"))
+
+parallel_tasks = task_one.connect(Simple.new(id: "parallel_1"), Simple.new(id: "parallel_2"), Simple.new(id: "parallel_2"))
+
+merge_task = MultiMerge.new(id: "merge_tasks")
+
+merge_task.join(*parallel_tasks)
+```
+
+### Arbitrary Cycles
+
+* http://www.workflowpatterns.com/patterns/control/structural/wcp10.php
+* The ability to represent cycles in a process model that have more than one entry or exit point. It must be possible for individual entry and exit points to be associated with distinct branches.
+
+```ruby
+spec = WorkflowSpec.new(id: "cycle")
+
+task_one = spec.connect(Simple.new(id: "one"))
+task_two = task_one.connect(Simple.new(id: "two"))
+cycle = task_two.connect(Cycle.new(id: "cycle"))
+cycle.connect(task_one)
+```
+
+### Structured Loop
+
+* http://www.workflowpatterns.com/patterns/control/new/wcp21.php
+* The ability to execute a task or sub-process repeatedly. The loop has either a pre-test or post-test condition associated with it that is either evaluated at the beginning or end of the loop to determine whether it should continue.
+
+```ruby
+spec = WorkflowSpec.new(id: "structured_loop")
+
+task_one = spec.connect(Simple.new(id: "one"))
+task_two = task_one.connect(Simple.new(id: "two"))
+structured_loop = task_two.connect(StructuredLoop.new(id: "structured_loop"))
+structured_loop.connect(->(_) { Time.now.hour < 13 }, task_one)
+structured_loop.connect_else(Simple.new(id: "three"))
+```
+
+### Recursion
+
+* http://www.workflowpatterns.com/patterns/control/new/wcp22.php
+* The ability of a task to invoke itself during its execution or an ancestor in terms of the overall decomposition structure with which it is associated.
+
+```ruby
+spec = WorkflowSpec.new(id: "recursion")
+
+task_one = spec.connect(Simple.new(id: "one"))
+task_two = task_one.connect(Simple.new(id: "two"))
+recursion = task_two.connect(Recursion.new(id: "recursion"))
+recursion.connect(task_one)
+```
+
+## Operators
+
+In the examples above, ruby lambdas are used to showcase the selection mechanism for deciding whether a given conditional branch is followed:
+
+```ruby
+# ...
+choice_spec.connect(->(_task) { Time.now.hour < 13 }, if_spec)
+```
+
+This is not the only option though; the only requirement for these selection mechanism is that it responds to `#call(?Task)`:
+
+```ruby
+class IsBeforeLunch
+  def self.call(_task)
+    Time.now.hour < 13
+  end
+end
+choice_spec.connect(IsBeforeLunch, if_spec)
+```
+
+Both options wouldn't be enough though, if you need to serialize workflows (lambdas and singleton classes can't be marshalled into hashes).
+
+`wolflow` ships with **operators**, which are low-level hash-serializable primitives which can describe the type of expression one would most commonly expect in conditionals.
+
+There are 3 basic operators: "literals" (plain values), "attributes" (variables pointing at data in the workflow), "operations" (applies a reducer function on a sequence of arguments)
+Here are a few examples:
+
+```ruby
+require "wolflow"
+
+include Wolflow
+
+lit = Operators::Literal.new(value: 3) #=> 3, serializes to { type: "literal", value: 3 }"
+
+lit2 = Operators::Literal.new(value: 4)
+var = Operators::Attribute.new(name: "foo") #=> "foo", serializes to { type: "attribute", name: "foo" }
+Operators::Operation.new(op: "+", members: [lit, lit2, var]) #=> "3 + 4 + foo", serializes to { type: "operation", op: "+", members: [{ type: "literal", name: "3" }, { type: "literal", name: "4" }, { type: "attribute", name: "foo" }]
+```
+
+Then there is "base", where others extend from, and which can also be used for extending the operator language.
+
+```ruby
+# example of custom class calculation levenshtein distance using the gem:
+
+require "levenshtein"
+
+class LevenshteinDistance < Operators::Base
+  # (strings: Array[Operators::Base], threshold: Float, **untyped) -> void
+  def initialize(strings:, threshold: 0.8, **args)
+    @strings = strings
+    @threshold = threshold
+    super(**args)
+  end
+
+  # (Task task) -> Float
+  def call(task)
+    string1, string2 = @strings.map { |s| s.call(task) }
+
+    Levenshtein.normalized_distance(string1, string2, @threhsold)
+  end
+
+  def to_hash
+    hs = super
+    hs[:threshold] = @threshold.to_hash
+    hs[:strings] = @strings.map(&:to_hash)
+    hs
+  end
+
+  def self.from_hash(hash)
+    case hash
+    in { threshold: Hash => threshold, strings: [*, Hash, *] => strings, ** }
+      super(hash.merge(threshold: Operators.from_hash(threshold), strings: strings.map{ |s| Operators.from_hash(s) }))
+    else
+      super
+    end
+  end
+end
+
+op = Operators.from_hash({ type: "levenshtein_distance", threshold:  { type: "literal", value: 0.8}, strings: [{ type: "literal", value: "test_string"}, {type: "attribute", name: "foo"}]})
+#=>
+#<LevenshteinDistance:0x000000012a796960 ...
+
+op.call(Task.new(data: { foo: "bar" })) #=> calculates levenshtein distance between "test_string" and "bar"
+```
+
+## Design Concepts
+
+`wolflow` is designed to provide workflow engine primitives as plain ruby objects, with a simple yet extensive API which allows defining, extending, and executing workflows. It's therefore defined by what it explicitly does not support.
+
+* **No custom business language** to build workflows. It's impossible to provide such a language which fits all use cases. It's however possible to design your own language of top of it.
+* **Does not support standard workflow representations** (like BPMN) out-of-the-box. However, it's possible to build support on top of it.
+* **No storage support**. There are too many options to consider in the space. However, every object encodes to / decodes from ruby hashes, so p.ex. storing them in a database with JSON support should be fairly easy.
+* **No execution engine**. You may want to distribute task execution to thread pools, separate processes, background jobs.
+
+## Related Links/Projects
+
+* [Workflow Patterns documentation](http://www.workflowpatterns.com/patterns/control/index.php)
+* [flor](https://github.com/floraison/flor), a ruby workflow engine with its own custom workflow definition "language", with built-in storage and execution mechanisms.
+* [Spiff Workflow](https://github.com/sartography/SpiffWorkflow), a python workflow engine allowing in-code workflow definitions, with BPMN and DMN support.
+* [Camunda](https://camunda.com/), a workflow engine which is most commonly used "standalone", but can also be embedded in a Java (Spring Boot) application.
+
+You can also find other interesting resources about workflow engines [here](https://github.com/meirwah/awesome-workflow-engines)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://gitlab.com/os85/wolflow.