to-result 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc8202a00d4cc8938cac602f09b0a9b0694a29421bedb0c71be82f94fad66e89
-  data.tar.gz: 783334b0487c880174639c699eb61fc6eacd695086a5c5b9b531947bd1645b30
+  metadata.gz: fc48c861de210a05cba164c61710457447f04b60b492ef15791ab7e5c28a3375
+  data.tar.gz: fb5802866e75958e710ec9a0be23584f8f737101ef8afd18c5b212a775539c1c
 SHA512:
-  metadata.gz: 4e2b40217e547f2cabbcc84847f1f257676863997c088f4e2c43416a608fd804b07bf7586e95d6ab60b8c70fa501b6cd297deb7d9ad7a86f0acade0977ef5f64
-  data.tar.gz: feceedd4425f782ee47637da08a69fbef6f54b226a5bd104e6a8f22ea219a9b4be1fd30ffac56e88df0ec1aa2212f4c2ea2994b81f51155f8d1dae8ff29fb41b
+  metadata.gz: 60728e022ce553988082effc1ab86a3260cf399a464bddea06d936e6428bf54f0604a8b86638ee7932526a20d72b3c80bcc491f6d816d6d17bdd93326c11b2ce
+  data.tar.gz: 959d7af9b3eb1367269c6650ca9c9babedd8c3cfd6e36403d3d4f01b750219dc7781cec78e4bc2a4972ce34e230d157dbd17a8bee70b7c9cc24c407fb71f5bc3

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## [0.1.1](https://github.com/a-chris/to-result/tree/0.1.1) (2023-08-16)
+
+HOTFIXES:
+
+- Always pass the error to the `on_error` callable object instead of mixed `error/Failure(error)`
+
 ## [0.1.0](https://github.com/a-chris/to-result/tree/0.1.0) (2022-10-28)
 
 - Explicit requires `dry-monads` >= 1.x, just for convenience

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    to-result (0.1.0)
+    to-result (0.1.1)
       dry-monads (~> 1.5)
 
 GEM

data/README.md

@@ -1,7 +1,7 @@
 
 # ToResult
 
-ToResult is a wrapper built over `dry-monads` to make the `Do Notation`, `Result` and `Try` concepts more handy and consistent to use, in particular to implement the **Railway Pattern**.
+ToResult is a wrapper built over `dry-monads` to make the `Do Notation`, `Result` and `Try` concepts more handy and consistent to use, especially to implement the **Railway Pattern**.
 
 ## Why I created ToResult
 
@@ -120,7 +120,7 @@ class MyClass
 end
 ```
 
-now you can always use `ToResult` all the time you wanted to use `Success`, `Failure` or `Try` but with a more convenient interface and consistent behaviour.
+now you can always use `ToResult` all the time you wanted to use `Try` or return `Success/Failure` but with a more convenient interface and consistent behaviour, my goal is to have a solution that can be used for every use-case.
 
 Look at this:
 
@@ -144,6 +144,30 @@ ToResult(only: [ArgumentError]) { yield Failure(YourCustomError.new('error code'
 # raises YourCustomError('error code')
 ```
 
+## Local and global callback on errors
+to-result gives you the possibility to define a callback to be called when an error is raised inside the `ToResult` block, this is a handy place to log errors.
+
+You can define a global callback, usually defined into an initializer:
+
+```ruby
+# initializers/to_result.rb
+
+ToResultMixin.configure do |c|
+  c.on_error = Proc.new { |e| Logger.log_error(e) }
+end
+```
+
+or a local callback:
+
+```ruby
+ToResult(on_error: proc { |e| Logger.log_error(e) }) do
+  yield Failure(StandardError.new('error code'))
+end
+```
+
+you can even use both at the same time but keep in mind that **local callback overrides the global one**.
+
+
 ## Changelog
 
 [Changelog](CHANGELOG.md)
@@ -154,7 +178,7 @@ I'm already planning to implement some useful features:
 - [x] configurable error logging when an exception is catched inside `DoResult`
 e.g. sending the log to Airbrake or whathever service you are using
 - [x] transform/process the catched error => this can be handled with `alt_map` or other methods already available in `dry-monads`
-- [ ] any other suggestion would be appreciated 😁
+- [ ] any type of suggestion is appreciated 😁
 
 ## Authors
 

data/lib/to-result.rb

@@ -48,9 +48,10 @@ module ToResultMixin
       Proc.new do
         f.call
       rescue Dry::Monads::Do::Halt => e
-        error = e.result
+        failure = error = e.result
+        error = error.failure if error.respond_to?(:failure)
         on_error.call(error) if on_error.respond_to?(:call)
-        return error
+        return failure
       rescue *only => e
         on_error.call(e) if on_error.respond_to?(:call)
         raise e

data/tests/support/fake_logger.rb

@@ -1,6 +1,6 @@
 class FakeLogger
-  def self.log_error
-    true
+  def self.log_error(e)
+    e
   end
 
   def self.return_error(e)

data/tests/to_result_test.rb

@@ -67,7 +67,7 @@ class ToResultTest < Minitest::Test
     clean_room = Class.new(Object)
     clean_room.new.instance_eval do
       ToResultMixin.configure do |c|
-        c.on_error = Proc.new { FakeLogger.log_error }
+        c.on_error = Proc.new { |e| FakeLogger.log_error(e) }
       end
     end
   end
@@ -78,6 +78,7 @@ class ToResultTest < Minitest::Test
     FakeLogger.expects(:log_error).once
 
     expected = StandardError.new(@value)
+
     assert ToResult { raise expected } == Failure(expected)
   end
 
@@ -108,6 +109,6 @@ class ToResultTest < Minitest::Test
 
     expected = StandardError.new(@value)
     FakeLogger.expects(:return_error).with(expected).returns(expected).once
-    assert ToResult(on_error: local_on_error) { raise expected } == Failure(expected)
+    assert ToResult(on_error: local_on_error) { yield Failure(expected) } == Failure(expected)
   end
 end

data/to-result.gemspec

@@ -5,7 +5,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |s|
   s.name        = 'to-result'
-  s.version     = '0.1.0'
+  s.version     = '0.1.1'
   s.summary     = 'A wrapper over dry-monads to offer a handy and consistent way to implement the Railway pattern.'
   s.description = 'A wrapper over dry-monads to offer a handy and consistent way to implement the Railway pattern.'
   s.authors     = ['Christian Toscano']

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: to-result
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Christian Toscano
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-27 00:00:00.000000000 Z
+date: 2023-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-monads
@@ -60,7 +60,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: A wrapper over dry-monads to offer a handy and consistent way to implement