workflows 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 82262e54a1a6ddd11b7c05f8169f4035ff289677
-  data.tar.gz: 3562c0579e24c0b92dbc3d23426f2c31d840f167
+  metadata.gz: f04dc0293e71b313565f3fd0ef0d7ed890e71daf
+  data.tar.gz: 1383744ebe41d421c1d7a12a03716f7823bea67b
 SHA512:
-  metadata.gz: f9346dde057c147c66444331dc18570906db016f862b27b77dda6760fc635bf19a30244d18e5c8a8c87dc92f927e698cf4b2aa8232a4ead91ee300aa69feffbd
-  data.tar.gz: fc07d9ecf4933fc9ea77488528df903a11440a96c4e3cc35e21b1ef586aa1bf02aa48b098f97ebfc7cbe631360f98aae6be0bfb7acbdeac61b604fdcf0f876aa
+  metadata.gz: 78534b357ba6f368f087799d0d9728b350d62ae5bfc4d2c7561e8f98fff482a438ec3d46dcca2e0ac8a60048d71ad4ca4434be7604e66c1442e11a3f349a13d4
+  data.tar.gz: 859e56d98fac93caf713ed2afb9f85bcdd62fe9dba727ceb35bd190ce01f8c6ed40642b306be1dc1f82ffd38481f53c867852d02db3a8d764db5f299c09e2fbc

data/README.md

@@ -1,8 +1,14 @@
 # Workflows
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/workflows`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Workflows is an attempt to create multiple-step services. each step of
+the workflow is service by itself that has a run method. it can fail or
+succeed and the status of the step will change to :fail or :ok
+respectively. each service in this model has two types of output. one
+that is called state and another that is called output. state will be
+passed to the next step of the workflow, so if there are objects that
+need to be passed between the steps, they should be kept in state.
+outputs are not passed between the steps and are only holding the output
+value of each executed step of the workflow.
 
 ## Installation
 
@@ -20,9 +26,85 @@ Or install it yourself as:
 
     $ gem install workflows
 
-## Usage
+## Example
+
+You can find more examples in the example directory of the gem.
+
+If you have a workflow such as the following:
 
-TODO: Write usage instructions here
+```ruby
+class BarbieMakerFlow
+  include Workflows
+
+
+  has_flow [
+    {
+      name: 'design',
+      service: Design,
+      args: [:gender, :specification]
+    },
+    {
+      name: 'make',
+      service: Make,
+      args: [:outfit]
+    }
+  ]
+
+end
+
+class Design
+  include Workflows::StepService
+
+  def run
+    set_state(
+      barbie: Barbie.new(args.gender, args.specification)
+    )
+  end
+end
+
+class Make
+  include Workflows::StepService
+
+  def run
+    barbie = get_state[:barbie]
+    msg = barbie.dress_up(args.outfit)
+
+    set_output(msg)
+    set_state(barbie: barbie)
+  end
+end
+
+class Barbie
+  attr_reader :gender,
+              :specification,
+              :outfit
+
+  def initialize(gender, specification)
+    @gender = gender
+    @specification = specification
+  end
+
+  def dress_up(outfit)
+    @outfit = outfit
+    "#{@gender} #{@specification} barbie is wearing a #{outfit}"
+  end
+end
+```
+
+you can now run your flow by providing input arguments for each step:
+
+```ruby
+bmf = BarbieMakerFlow.new(
+  design: { gender: 'female', specification: 'Software Engineer' },
+  make: { outfit: 'white shirt and navy shorts' }
+)
+
+bmf.run  #=> runs the flow with provided inputs
+bmf.status #=> [:ok, :ok] | [:ok, :fail] | [:fail, :fail]
+bmf.output #=> ['output of design', 'output of make']
+bmf.state #=> Barbie.new(gender: 'female',
+specification: ....)
+```
 
 ## Development
 

data/lib/workflows/version.rb

@@ -1,3 +1,3 @@
 module Workflows
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: workflows
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Shamim