operabl 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9b3ba688d5654641a8e622b6015e181a8f46dadb
-  data.tar.gz: a212c8298374b6626b05ee65a3af2417dbba4608
+  metadata.gz: 168cb99f7ba5539c9e4f086f417e08533a2dc7d6
+  data.tar.gz: ecc885a0319bc0e81ec58d32224419334f67ed56
 SHA512:
-  metadata.gz: d8820785187c2acbca1eb1cd72b0dd7d723a47eb5daea54dc14ba2461110214f50afdae0dd575faa88dcd1151f8d2abf18ca4db21c6ebe1c6c9c111e3240f736
-  data.tar.gz: 46330e1b4c9f30963b8e65acb0b09ce558e7559e74ac09714b3019e725669af9aa3dfc29aa74a885b2a8022429bece93f09dfb1f381c8843fed42f01ddea7474
+  metadata.gz: 985dfd83d846deb7f01efa44d92776561e585402f44c1ce34eb85d29ba3f340e27cf16454591c4fc3a41b57320af93def9b751883e515348b7ef42b0495c1734
+  data.tar.gz: dcf5ecc1a8c14bb2c73be1f40aaa4efd40823c0837487a308ef6afcc799ae3d7cd22f0e14d63a5bdb0d687b76bf4d7b4901ad16379b3160d55ff890d9309a518

data/README.md

@@ -1,6 +1,6 @@
 # Operabl
 
-Railway oriented aproach for your classes. Operabl let you define steps in your class to be executed sequentially
+Railway oriented aproach for your classes. Operabl let you define steps in your class or module to be executed sequentially. Steps can be class methods, procs or other Operabl classes/modules.
 
 ## Installation
 
@@ -20,6 +20,8 @@ Or install it yourself as:
 
 ## Usage
 
+Include Operable in your Class/Module. Steps can be class methods, procs or other Operabl class/module
+
 ```ruby
 class ProcOp
 
@@ -30,7 +32,7 @@ class ProcOp
         ctx[:amethod_call] = amethod
     }
 
-    def amethod
+    def self.amethod
         return "something else"
     end
 
@@ -41,14 +43,19 @@ op.failure? # => false
 op.success? # => true
 op[:key] # => "something"
 op[:amethod_call] # => "something else"
+```
+
+
+Steps are Class level methods. This is because steps only work with a context provided, they don't change classes state.
 
+```ruby
 class MethodOp
 
     include Operabl
 
     step :a
 
-    def a(ctx)
+    def self.a(ctx)
         ctx[:key] = ctx.params[:pkey]
     end
 end
@@ -56,7 +63,11 @@ end
 op = MethodOp.call({pkey: "something"})
 op.success? # => true
 op.result # => {}
+```
+
+Another example of an Operabl as a step.
 
+```ruby
 class ComposedOp
 
     include Operabl
@@ -64,7 +75,7 @@ class ComposedOp
     step MethodOp
     step :b
 
-    def b(ctx)
+    def self.b(ctx)
         ctx.success!({status: 200, response: "OK"})
     end
 
@@ -76,6 +87,33 @@ op[:key] # => "something else"
 op.result # => {status: 200, response: "OK"}
 ```
 
+The result from #call is a Operabl::Context, it can be passed to a new Operabl call.
+
+If Operation failed, AnotherOp is not going to succed but it will run any :failure step defined in it.
+
+```ruby
+
+class AnotherOp
+
+    include Operabl
+
+    step :a
+    failure :b
+
+    def self.a(ctx)
+        #do something
+    end
+
+    def self.b(ctx)
+        #recover from failure
+    end
+
+end
+
+op = Operation.call({pkey: "something else"})
+op2 = AnotherOp.call(op)
+```
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/operabl.rb

@@ -20,20 +20,18 @@ module Operabl
         Operabl::Context.new({})
       end
 
-      operable = self.new
-
-      steps.each do |step_branch, step_obj, options|
+      steps.each do |step_branch, step_def, options|
         if step_branch == ctx.branch
-          case step_obj
+          case step_def
           when String, Symbol
-            operable.method(step_obj).call(ctx)
+            self.method(step_def).call(ctx)
           when Proc
-            operable.instance_exec ctx, &step_obj
+            self.instance_exec ctx, &step_def
           else
-            if step_obj.respond_to? :call
-              step_obj.call(ctx)
+            if step_def.respond_to? :call
+              step_def.call(ctx)
             else
-              raise "#{step_obj.inspect} is invalid step argument"
+              raise "#{step_def.inspect} is invalid step argument"
             end
           end
           break if options[:fastforward]
@@ -49,12 +47,12 @@ module Operabl
       @steps ||= []
     end
 
-    def step(symbol, options={})
-      steps << [:success, symbol, options]
+    def step(step_def, options={})
+      steps << [:success, step_def, options]
     end
 
-    def failure(symbol, options={})
-      steps << [:failure, symbol, options]
+    def failure(step_def, options={})
+      steps << [:failure, step_def, options]
     end
   end
 

data/lib/operabl/version.rb

@@ -1,3 +1,3 @@
 module Operabl
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/operabl.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Monkey Square Lab"]
   spec.email         = ["monkeysquarelab@gmail.com"]
 
-  spec.summary       = %q{Railway oriented aproach for your classes.}
-  spec.description   = %q{Operabl let you define steps in your class to be executed sequentially.}
+  spec.summary       = %q{Railway oriented aproach for your classes and modules.}
+  spec.description   = %q{Railway oriented aproach for your classes and modules.}
   spec.homepage      = "https://github.com/monkeysquarelab/operabl"
   spec.license       = "MIT"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: operabl
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Monkey Square Lab
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-05 00:00:00.000000000 Z
+date: 2018-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,7 +52,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
-description: Operabl let you define steps in your class to be executed sequentially.
+description: Railway oriented aproach for your classes and modules.
 email:
 - monkeysquarelab@gmail.com
 executables: []
@@ -96,5 +96,5 @@ rubyforge_project:
 rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
-summary: Railway oriented aproach for your classes.
+summary: Railway oriented aproach for your classes and modules.
 test_files: []