u-service 0.13.1 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b93d4099f9d4f7646b94241bb5b66190635dff1a56781c7aa152fb458acce958
-  data.tar.gz: bf4a7a017a8fbc891904a74ffa80b8aaaadc577cfcfd178e062ed42410dfec9a
+  metadata.gz: a511f12c5bc76025f0156c65d934988065f1c51c0d540b67a2cf2f4dcde48f22
+  data.tar.gz: 12489e03b009e02bef85329051952f50866c06f0d585812e55146569b4d535ad
 SHA512:
-  metadata.gz: 7d69adaf4e77a2707904a31a29ffd51abc866a27cdd210039b24c5def4ce9fbbbb0dec88e0b39bbfe6e855692d2a186c0931de6225d0269de6b972f048de936e
-  data.tar.gz: eb3812b5a44fa8742560eee26e49fd987f6bb4a5fb30e35aafa6a0b6d870c4a96b62a9a1af5b5387c7a58b8e97d45e739b64b4768d95bdd53c3784fa4df879f2
+  metadata.gz: '0811b8d7893d0cb810345a582b3bb2c2a1dd2c0a21753e512212b9445e6f42bcab601e55ee1b683f2477ec72fa6ee690b741d23f105ffe63d1758dffa66fed50'
+  data.tar.gz: 950935aee3330a885206a85333894c2d27886bb1373ac7151efc95dbb9cdacc1ebe489967dafb1cca0351473460f0122e3d2cbbcea9ca52ea6836995a85de241

data/README.md

@@ -183,9 +183,9 @@ module Steps
   end
 end
 
-#=================================================#
+#-------------------------------------------------#
 # Creating a pipeline using the collection syntax #
-#=================================================#
+#-------------------------------------------------#
 
 Add2ToAllNumbers = Micro::Service::Pipeline[
   Steps::ConvertToNumbers,
@@ -197,9 +197,9 @@ result = Add2ToAllNumbers.call(numbers: %w[1 1 2 2 3 4])
 p result.success? # true
 p result.value    # {:numbers => [3, 3, 4, 4, 5, 6]}
 
-#=======================================================#
+#-------------------------------------------------------#
 # An alternative way to create a pipeline using classes #
-#=======================================================#
+#-------------------------------------------------------#
 
 class DoubleAllNumbers
   include Micro::Service::Pipeline
@@ -211,9 +211,9 @@ DoubleAllNumbers
   .call(numbers: %w[1 1 b 2 3 4])
   .on_failure { |message| p message } # "numbers must contain only numeric types"
 
-#=================================================================#
+#-----------------------------------------------------------------#
 # Another way to create a pipeline using the composition operator #
-#=================================================================#
+#-----------------------------------------------------------------#
 
 SquareAllNumbers =
   Steps::ConvertToNumbers >> Steps::Square
@@ -221,6 +221,21 @@ SquareAllNumbers =
 SquareAllNumbers
   .call(numbers: %w[1 1 2 2 3 4])
   .on_success { |value| p value[:numbers] } # [1, 1, 4, 4, 9, 16]
+
+#=================================================================#
+# Attention:                                                      #
+# When happening a failure, the service object responsible for it #
+# will be accessible in the result                                #
+#=================================================================#
+
+result = SquareAllNumbers.call(numbers: %w[1 1 b 2 3 4])
+
+result.failure?                               # true
+result.service.is_a?(Steps::ConvertToNumbers) # true
+
+result.on_failure do |_message, service|
+  puts "#{service.class.name} was the service responsible by the failure" } # Steps::ConvertToNumbers was the service responsible by the failure
+end
 ```
 
 ### What is a strict Service Object?

data/lib/micro/service/base.rb

@@ -5,7 +5,7 @@ module Micro
     class Base
       include Micro::Attributes.without(:strict_initialize)
 
-      UNEXPECTED_RESULT = '#call! must return a Micro::Service::Result instance'.freeze
+      UNEXPECTED_RESULT = '#call! must return an instance of Micro::Service::Result'.freeze
       InvalidResultInstance = ArgumentError.new('argument must be an instance of Micro::Service::Result'.freeze)
       ResultIsAlreadyDefined = ArgumentError.new('result is already defined'.freeze)
 
@@ -53,13 +53,13 @@ module Micro
         end
 
         def Success(arg = :ok)
-          block_given? ? (value, type = yield, arg) : (value, type = arg, :ok)
-          __get_result__.__set__(true, value, type)
+          value, type = block_given? ? [yield, arg] : [arg, :ok]
+          __get_result__.__set__(true, value, type, nil)
         end
 
         def Failure(arg = :error)
-          block_given? ? (value, type = yield, arg) : (value, type = arg, :error)
-          __get_result__.__set__(false, value, type)
+          value, type = block_given? ? [yield, arg] : [arg, :error]
+          __get_result__.__set__(false, value, type, self)
         end
     end
   end

data/lib/micro/service/pipeline.rb

@@ -45,7 +45,7 @@ module Micro
             return arg.call if arg_to_call?(arg)
             return arg if arg.is_a?(Micro::Service::Result)
             result = Micro::Service::Result.new
-            result.__set__(true, arg, :ok)
+            result.__set__(true, arg, :ok, nil)
           end
 
           def arg_to_call?(arg)

data/lib/micro/service/result.rb

@@ -3,14 +3,22 @@
 module Micro
   module Service
     class Result
-      InvalidType = TypeError.new('type must be a symbol'.freeze)
+      InvalidType = TypeError.new('type must be a Symbol'.freeze)
+      InvalidService = TypeError.new('service must be a kind or an instance of Micro::Service::Base'.freeze)
+
+      class InvalidAccessToTheServiceObject < StandardError
+        MSG = 'only a failure result can access its service object'.freeze
+
+        def initialize(message = MSG); super; end
+      end
 
       attr_reader :value, :type
 
-      def __set__(is_success, value, type)
+      def __set__(is_success, value, type, service)
         raise InvalidType unless type.is_a?(Symbol)
+        raise InvalidService if !is_success && !is_a_service?(service)
 
-        @success, @value, @type = is_success, value, type
+        @success, @value, @type, @service = is_success, value, type, service
 
         self
       end
@@ -23,12 +31,18 @@ module Micro
         !success?
       end
 
+      def service
+        return @service if failure?
+
+        raise InvalidAccessToTheServiceObject
+      end
+
       def on_success(arg = :ok)
         self.tap { yield(value) if success_type?(arg) }
       end
 
       def on_failure(arg = :error)
-        self.tap{ yield(value) if failure_type?(arg) }
+        self.tap{ yield(value, @service) if failure_type?(arg) }
       end
 
       private
@@ -40,6 +54,10 @@ module Micro
         def failure_type?(arg)
           failure? && (arg == :error || arg == type)
         end
+
+        def is_a_service?(arg)
+          (arg.is_a?(Class) && arg < Service::Base) || arg.is_a?(Service::Base)
+        end
     end
   end
 end

data/lib/micro/service/version.rb

@@ -2,6 +2,6 @@
 
 module Micro
   module Service
-    VERSION = '0.13.1'.freeze
+    VERSION = '0.14.0'.freeze
   end
 end

data/lib/micro/service/with_validation.rb

@@ -8,7 +8,7 @@ module Micro
       include Micro::Attributes::Features::ActiveModelValidations
 
       def call
-        return Failure(:validation_error) { {errors: self.errors, service: self} } unless valid?
+        return Failure(:validation_error) { self.errors } unless valid?
 
         __call
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: u-service
 version: !ruby/object:Gem::Version
-  version: 0.13.1
+  version: 0.14.0
 platform: ruby
 authors:
 - Rodrigo Serradura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-19 00:00:00.000000000 Z
+date: 2019-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: u-attributes