flows 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79e8e96fb6de7ee4b138c11b64d430e1937f906093f86cb990e1c4c24a3eab3d
-  data.tar.gz: 3f22f6b60a7d872d779189371f1f5a274296dc302dc5d93b5aba31a83a0a9925
+  metadata.gz: 12213313efb3ea2ba0d786043d82ac3ec4279547de96f3b136303eab4078acf9
+  data.tar.gz: a383ca5ae142ddf2385f0d17e12f4f41f353c4dae577743638b1d2db8748ba05
 SHA512:
-  metadata.gz: 8c3cd416cd84f853d6690b94fda9d721422d5b0f4934bf02036c2294aaa589eb362e3fd95422e333d53b636762080641ee6d18ec40df537b4c6890898b202546
-  data.tar.gz: b3cb5df724b36cd50edeb107dc5604e965f06f3032b24aed2e734c5a86224f2ed6d15e2bceb977ef8ce8c66debf0bf0736821ef827e1dbe4b1db62d7ce9db40b
+  metadata.gz: f4ec655af858b58f0ef7da44cbb79d1fc6dfa9d49c985cc5e4fbc504b349a8ca8d68e7b78be73e1b3ec1c7f28f121f7b2456fd7477ef88f5f04aa537bd63c232
+  data.tar.gz: 8cc7a7e6693c47c2463e8bf2dbf1b6ec4492a3c3125dfd97fbbc8a3e9e1af2763ff6e48320c846cd5a72b44d4c49fae84e14a57b2faba8842154b0793e6591f0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    flows (0.0.1)
+    flows (0.0.2)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -2,6 +2,7 @@
 
 [![Build Status](https://travis-ci.com/ffloyd/flows.svg?branch=master)](https://travis-ci.com/ffloyd/flows)
 [![codecov](https://codecov.io/gh/ffloyd/flows/branch/master/graph/badge.svg)](https://codecov.io/gh/ffloyd/flows)
+[![Gem Version](https://badge.fury.io/rb/flows.svg)](https://badge.fury.io/rb/flows)
 
 _TODO_
 

data/bin/demo

@@ -0,0 +1,66 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'flows'
+
+# Helper for demonstrations
+module Demo
+  def self.run(name)
+    puts '-' * 60
+    puts name
+    puts '-' * 60
+    puts
+
+    begin
+      yield
+    rescue StandardError => e
+      puts "Exception raised:\n\n#{e.full_message}"
+    end
+    puts "\n" + '-' * 60 + "\n" * 2
+  end
+end
+
+# Simple division
+class DivisionOperation
+  include Flows::Operation
+
+  step :check_for_zero
+  step :divide
+
+  success :result
+  failure :error
+
+  def check_for_zero(denominator:, **)
+    if denominator.zero?
+      err(error: 'Denominator cannot be zero')
+    else
+      ok
+    end
+  end
+
+  def divide(numerator:, denominator:, **)
+    ok(result: numerator / denominator)
+  end
+end
+
+# Division in nested operation - we do division
+class NestedDivisionOperation
+  include Flows::Operation
+
+  step :do_division
+
+  success :result
+  failure :error
+
+  def do_division(**params)
+    DivisionOperation.new.call(**params)
+  end
+end
+
+Demo.run 'Unwrap Error verbosity' do
+  DivisionOperation.new.call(numerator: 1, denominator: 0).unwrap[:result]
+end
+
+Demo.run 'Unwrap Error verbosity when error happened in nested operation' do
+  NestedDivisionOperation.new.call(numerator: 1, denominator: 0).unwrap[:result]
+end

data/lib/flows/operation/builder.rb

@@ -44,7 +44,8 @@ module Flows
             body: step[:body],
             preprocessor: method(:node_preprocessor),
             postprocessor: method(:node_postprocessor),
-            router: make_router(step)
+            router: make_router(step),
+            meta: { name: step[:name] }
           )
         end
       end
@@ -53,9 +54,10 @@ module Flows
         context[:data]
       end
 
-      def node_postprocessor(output, context, _meta)
+      def node_postprocessor(output, context, meta)
         output_data = output.ok? ? output.unwrap : output.error
         context[:data].merge!(output_data)
+        context[:last_step] = meta[:name]
 
         output
       end

data/lib/flows/operation/executor.rb

@@ -4,11 +4,12 @@ module Flows
     class Executor
       include ::Flows::Result::Helpers
 
-      def initialize(flow:, success_shapes:, failure_shapes:)
+      def initialize(flow:, success_shapes:, failure_shapes:, class_name:)
         @flow = flow
 
         @success_shapes = success_shapes
         @failure_shapes = failure_shapes
+        @operation_class_name = class_name
       end
 
       def call(**params)
@@ -25,7 +26,7 @@ module Flows
 
         case last_result
         when Flows::Result::Ok then build_success_result(status, context)
-        when Flows::Result::Err then build_failure_result(status, context)
+        when Flows::Result::Err then build_failure_result(status, context, last_result)
         end
       end
 
@@ -38,15 +39,16 @@ module Flows
         ok(status, data)
       end
 
-      def build_failure_result(status, context)
+      def build_failure_result(status, context, last_result)
         raise ::Flows::Operation::NoFailureShapeError if @failure_shapes.nil?
 
         shape = @failure_shapes[status]
         raise ::Flows::Operation::UnexpectedFailureStatusError.new(status, @failure_shapes.keys) if shape.nil?
 
         data = extract_data(context[:data], shape)
+        meta = build_meta(context, last_result)
 
-        err(status, data)
+        Flows::Result::Err.new(data, status: status, meta: meta)
       end
 
       def extract_data(output, keys)
@@ -54,6 +56,18 @@ module Flows
 
         output.slice(*keys)
       end
+
+      def build_meta(context, last_result)
+        meta = {
+          operation: @operation_class_name,
+          step: context[:last_step],
+          context_data: context[:data]
+        }
+
+        meta[:nested_metadata] = last_result.meta if last_result.meta.any?
+
+        meta
+      end
     end
   end
 end

data/lib/flows/operation.rb

@@ -17,16 +17,7 @@ module Flows
     def initialize
       _flows_do_checks
 
-      flow = ::Flows::Operation::Builder.new(
-        steps: self.class.steps,
-        method_source: self
-      ).call
-
-      @_flows_executor = ::Flows::Operation::Executor.new(
-        flow: flow,
-        success_shapes: self.class.success_shapes,
-        failure_shapes: self.class.failure_shapes
-      )
+      @_flows_executor = _flows_make_executor(_flows_make_flow)
     end
 
     def call(**params)
@@ -39,5 +30,21 @@ module Flows
       raise NoStepsError if self.class.steps.empty?
       raise NoSuccessShapeError, self if self.class.success_shapes.nil?
     end
+
+    def _flows_make_flow
+      ::Flows::Operation::Builder.new(
+        steps: self.class.steps,
+        method_source: self
+      ).call
+    end
+
+    def _flows_make_executor(flow)
+      ::Flows::Operation::Executor.new(
+        flow: flow,
+        success_shapes: self.class.success_shapes,
+        failure_shapes: self.class.failure_shapes,
+        class_name: self.class.name
+      )
+    end
   end
 end

data/lib/flows/result/err.rb

@@ -2,8 +2,6 @@ module Flows
   class Result
     # Wrapper for failure results
     class Err < Result
-      class UnwrapError < Flows::Error; end
-
       def initialize(data, status: :failure, meta: {})
         super
       end
@@ -17,7 +15,7 @@ module Flows
       end
 
       def unwrap
-        raise UnwrapError
+        raise UnwrapError.new(@status, @data, @meta)
       end
 
       def error

data/lib/flows/result/errors.rb

@@ -0,0 +1,30 @@
+module Flows
+  class Result
+    # Error for unwrapping non-successful result object
+    class UnwrapError < Flows::Error
+      def initialize(status, data, meta)
+        @status = status
+        @data = data
+        @meta = meta
+      end
+
+      def message
+        "You're trying to unwrap non-successful result with status `#{@status.inspect}` and data `#{@data.inspect}`\n\
+Result metadata: `#{@meta.inspect}`"
+      end
+    end
+
+    # Error for dealing with failure result as success one
+    class NoErrorError < Flows::Error
+      def initialize(status, data)
+        @status = status
+        @data = data
+      end
+
+      def message
+        "You're trying to get error data for successful result with status \
+`#{@status.inspect}` and data `#{@data.inspect}`"
+      end
+    end
+  end
+end

data/lib/flows/result/ok.rb

@@ -2,8 +2,6 @@ module Flows
   class Result
     # Wrapper for successful results
     class Ok < Result
-      class NoErrorError < Flows::Error; end
-
       def initialize(data, status: :success, meta: {})
         super
       end
@@ -21,7 +19,7 @@ module Flows
       end
 
       def error
-        raise NoErrorError
+        raise NoErrorError.new(@status, @data)
       end
     end
   end

data/lib/flows/result.rb

@@ -13,6 +13,7 @@ module Flows
   end
 end
 
+require_relative 'result/errors'
 require_relative 'result/ok'
 require_relative 'result/err'
 require_relative 'result/helpers'

data/lib/flows/version.rb

@@ -1,3 +1,3 @@
 module Flows
-  VERSION = '0.0.1'.freeze
+  VERSION = '0.0.2'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flows
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Roman Kolesnev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-27 00:00:00.000000000 Z
+date: 2019-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -155,6 +155,7 @@ files:
 - README.md
 - Rakefile
 - bin/console
+- bin/demo
 - bin/setup
 - flows.gemspec
 - lib/flows.rb
@@ -167,6 +168,7 @@ files:
 - lib/flows/operation/executor.rb
 - lib/flows/result.rb
 - lib/flows/result/err.rb
+- lib/flows/result/errors.rb
 - lib/flows/result/helpers.rb
 - lib/flows/result/ok.rb
 - lib/flows/router.rb