dryer_services 1.2.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3fc730ff5d7dc75aed6d18e68f50f2de371535271974ed5d12d6d08ad3cf5207
-  data.tar.gz: 61f6a0e307a4d0b9e7104a870b53ffc234f743515e67ef9a6232ce6f7a15648f
+  metadata.gz: 8517d9874a4dacf5dde964d7e89a133a76946db8f46b44cdd70eebf755726007
+  data.tar.gz: 2f07cb9670f4edc93622582bc876104c1a4346526b1acbb56b14b9e03443a693
 SHA512:
-  metadata.gz: 1ada4c583fe9f5eded4af12b4bdda7e003376ae55d79de3d3609d9ee19d3d0e4c56483317139e9cee6fa43bf05a0af4df7a53741f01ca7dae6c97999e9649cd6
-  data.tar.gz: 9cbf2836e9b0dde5377c7fc576300dc0894bce93697f4649445f238235b42daf1366820aa8535ec0da1b228fc5c67192b564cbd1b13601d9461105793d2409b1
+  metadata.gz: 5753a1ae9d7a04c597d3a23aa41668cb4d6245ffb577696f69672cd9186026eda7e074438d1a17dc2598b2867f093154b0a742769efb186f6966c620836e9d52
+  data.tar.gz: d6c06c481ee47355b128784f839859f4bbab288ae87d0587097e28ad3f2b45ec2a304c5c80542f3494f7187d971917cfc86617ec91cc9a390e8d8d76145e2140

data/README.md

@@ -37,13 +37,23 @@ end
 Add.call(1,2) # returns 3
 ```
 
-### ResultService Example
-
-Result Service wraps the value returned from `call` in a `Dry::Monad::Result`.
-If the return value is an Error, it will return a Failure. If the return value
-is already a `Dry::Monad::Result`, it will not wrap the result, otherwise it
-will wrap the result in a `Dry::Monads::Success`
-
+### ResultService Examples
+
+ResultService wraps the value returned from `call` in a `Dry::Monad::Result`.
+There are several cases
+    - If the return value is an Error, it will return a Failure
+    - If the return value is not an Error, and is not a Result, it will wrap the
+      return value in a Result
+    - If the return value is a list of Results eg [Success(1), Success(2)] it
+      will condense those results into a single Result eg Success([1,2]). If any
+      of the results in the list are Failures eg [Success(1), Failure(2)], It
+      will return the first failure encountered eg Failure(2). Changing a list
+      of Monads (Results) into a Monad containing a list of values, is called
+      'traversing'
+   - If the return value is already a `Dry::Monad::Result`, it will not wrap the
+     result
+
+#### Wrapping an error in a Failure
 ```
 class Divide < Dryer::Services::ResultService
     def initialize(a, b)
@@ -63,23 +73,41 @@ class Divide < Dryer::Services::ResultService
     attr_reader :a, :b
 end
 
-Add.call(4,2) # returns Dry::Monads::Success(2)
-Add.call(4,0) # returns Dry::Monads::Failure("Can not divide by zero")
+Divide.call(4,2) # returns Dry::Monads::Success(2)
+Divide.call(4,0) # returns Dry::Monads::Failure("Can not divide by zero")
+```
+
+#### Traversing a list of results
+```
+class DivideMany < Dryer::Services::ResultService
+    def initialize(a, b)
+        @a = a
+        @b = b
+    end
+
+    def call
+        # each call to Divide returns a Result
+        # so we are returning a list of Results
+        a.map { |x| Divide.call(x,b) }
+    end
+
+    private
+    attr_reader :a, :b
+end
+
+DivideMany.call([2,4,6],2) # returns Dry::Monads::Success([1,2,3])
+DivideMany.call([2,4,6],0) # returns Dry::Monads::Failure("Can not divide by zero")
 ```
 
 ## Advantages
 Using the Service pattern can help to make code more modular, and make it easier
 to separate data modeling from transformations.
 
-# Development
-This gem is set up to be developed using [Nix](https://nixos.org/)
-Once you have nix installed you can run
-`make env`
-to enter the development environment. Then run `make` to see other available
-commands
-
-If you don't want to use nix, all the scripts can be run directly from the
-`scripts` directory.
+## Development
+This gem is set up to be developed using [Nix](https://nixos.org/) and
+[ruby_gem_dev_shell](https://github.com/jbernie2/ruby_gem_dev_shell)
+Once you have nix installed you can run `make env` to enter the development
+environment and then `make` to see the list of available commands
 
 ## Contributing
 Please create a github issue to report any problems using the Gem.

data/dryer_services.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name                  = 'dryer_services'
-  spec.version               = "1.2.0"
+  spec.version               = "2.0.1"
   spec.authors               = ['John Bernier']
   spec.email                 = ['john.b.bernier@gmail.com']
   spec.summary               = 'A service object leveraging the dry-monads gem'

data/lib/dryer/services/services/result_service.rb

@@ -5,6 +5,7 @@ module Dryer
   module Services
     module Services
       class ResultService < SimpleService
+        include Dry::Monads[:result]
 
         def self.call(*args)
           wrap_result(super(*args))
@@ -15,6 +16,11 @@ module Dryer
             result
           elsif result.is_a?(StandardError)
             Dry::Monads::Failure(result)
+          elsif result.is_a?(Array) && result.all?{ |x| x.is_a?(Dry::Monads::Result) }
+            Dry::Monads::List[*result]
+              .typed(Dry::Monads::Result)
+              .traverse
+              .fmap(&:value)
           else
             Dry::Monads::Success(result)
           end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dryer_services
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.0.1
 platform: ruby
 authors:
 - John Bernier