to-result 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07abb60c2975a418781ae77cfc53ae596fc8e559ab270b81837719dc10967493
-  data.tar.gz: ed6e2b66cea364e686d4fd37ddc8c98973e89a2ffcacaaa627f7bb060c9a4a4e
+  metadata.gz: 842070fb5be7a4388055318b3956091d4869885c76d745c0dd01ba87cde415e5
+  data.tar.gz: 0a7c4e93685409f3f96479df8482255e501a88db53523c55d2f5f171255f58a3
 SHA512:
-  metadata.gz: 3fef23d1986e562ea127f7f2d61f200ff3b1b1b8cc71a9b892919b84211c87b120f0af7c61ee53abc4aeb6f191ca71865f4004208ebd4e7956064f7de55f80bf
-  data.tar.gz: '0895b62c8e0d5ee2b4834e265964baa684712f57119f6b95b5793b510f76f44ff6facf4e2a8c3b959c4a894ab9ccb590f0178712bd66fb65070c040459d76019'
+  metadata.gz: c16327c7a1420c8c1b711d98ffd59de246a3221c98dd6a3bae2cf3650c731c558ccbb02effccdd25d6f9f99e0097d030d751cf8c1dac40569b97dd95b4845817
+  data.tar.gz: 23d78aac99bc431eb9b47aafe9aca8dde5b95615766a60305ce016638a3c26e74ac632f5c19bf9c913a5ce70a2ba14d187dc3aea99f8c5876155db4ad9cbed34

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pulsarcli.gemspec
+gemspec
+
+gem 'dry-monads', '~> 1.4'
+
+gem 'byebug', '~> 11.1'
+
+gem 'minitest', '~> 5.16'
+
+gem 'mocha', '~> 1.15'

data/Gemfile.lock

@@ -0,0 +1,30 @@
+PATH
+  remote: .
+  specs:
+    to-result (0.0.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (11.1.3)
+    concurrent-ruby (1.1.10)
+    dry-core (0.8.1)
+      concurrent-ruby (~> 1.0)
+    dry-monads (1.4.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.7)
+    minitest (5.16.3)
+    mocha (1.15.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug (~> 11.1)
+  dry-monads (~> 1.4)
+  minitest (~> 5.16)
+  mocha (~> 1.15)
+  to-result!
+
+BUNDLED WITH
+   2.3.15

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Christian
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,134 @@
+
+# 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**.
+
+## Why I created ToResult
+
+`dry-monads` is full of edge cases that require to write boilerplate code everytime I want a method to return a `Success` or `Failure`, for example:
+
+```ruby
+def my_method
+  Success(another_method.call)
+rescue StandardError => e
+  Failure(e)
+end
+```
+
+so I started using `Try`, that makes the code easier to read and faster to write:
+```ruby
+def my_method
+  Try do
+    another_method.call
+  end.to_result
+end
+```
+
+but I feel like `to_result` is not really visible at the end of the code and if you forget to write it (as always happens to me) your application blows up.
+
+But this is not the bigget problem, bear with me.
+
+One of the biggest problem is that we cannot use the `Do Notation` inside a `Try` block:
+```ruby
+# this will return a Failure(Dry::Monads::Do::Halt)
+def my_method
+  Try do
+    yield Failure('error code')
+  end.to_result
+end
+```
+
+and you cannot even use `yield` and `rescue` in the same method:
+
+```ruby
+# this will return a Failure(Dry::Monads::Do::Halt)
+def my_method
+  yield Failure('error code')
+rescue StandardError => e
+  # e is an instance of Dry::Monads::Do::Halt
+  Failure(e)
+end
+```
+
+because they will raise a `Dry::Monads::Do::Halt` exception and the original exception will be forever lost if we do not "unbox" the exception with `e.result`.
+
+## Installation
+
+To install with bundler:
+```bash
+bundle add to-result
+```
+or with `gem`:
+```bash
+gem install to-result
+```
+
+## Usage
+
+To use it with instances of a class, just include it
+```ruby
+require 'to_result'
+
+class MyClass
+  include ToResultMixin
+
+  def my_method
+    ToResult do
+      whatever_method.call
+    end
+  end
+end
+```
+
+or if you want to use it with Singleton Classes:
+```ruby
+require 'to_result'
+
+class MyClass
+  extend ToResultMixin
+
+  class << self
+    def my_method
+      ToResult do
+        whatever_method.call
+      end
+    end
+  end
+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.
+
+Look at this:
+
+```ruby
+ToResult { raise StandardError.new('error code') }
+# returns Failure(StandardError('error code'))
+
+ToResult { yield Success('hello!') }
+# returns Success('hello!')
+
+ToResult { yield Failure('error code') }
+# returns Failure('error code')
+
+ToResult { yield Failure(StandardError.new('error code')) }
+# returns Failure(StandardError('error code'))
+
+ToResult([YourCustomError]) { yield Failure(YourCustomError.new('error code')) }
+# returns Failure(YourCustomError('error code'))
+
+ToResult([ArgumentError]) { yield Failure(YourCustomError.new('error code')) }
+# raises YourCustomError('error code')
+```
+
+## Roadmap
+I'm already planning to implement some useful features:
+- [x] write more examples/documentation/tests
+- [ ] configurable error logging when an exception is catched inside `DoResult`
+e.g. sending the log to Airbrake or whathever service you are using
+- [ ] transform/process the catched error
+- [ ] any other suggestion would be appreciated 😁
+
+## Authors
+
+- [@a-chris](https://www.github.com/a-chris)

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'to-result'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/lib/to-result.rb

@@ -0,0 +1,43 @@
+require 'dry/monads'
+
+module ToResultMixin
+  include Dry::Monads[:do, :result, :try]
+
+  Configuration = Struct.new(:on_error)
+
+  @@configuration = Configuration.new(on_error: nil)
+
+  #
+  # Allow to override the @@configuration fields
+  #
+  def self.configure
+    yield @@configuration
+  end
+
+  #
+  # ToResult executes a block of code and returns Success or Failure.
+  # All exceptions inherited from StandardError are catched and
+  # converted to Failure or you can pass a list of exceptions to catch.
+  #
+  # @param [Array<Class>] exceptions
+  # @param [Proc] &f
+  #
+  # @return [Success]
+  # @return [Failure]
+  #
+  def ToResult(exceptions = [StandardError], &f)
+    Try.run(
+      exceptions,
+      Proc.new do
+        f.call
+      rescue Dry::Monads::Do::Halt => e
+        error = e.result
+        @@configuration.on_error.call(error) if @@configuration.on_error.respond_to?(:call)
+        return error
+      rescue *exceptions => e
+        @@configuration.on_error.call(e) if @@configuration.on_error.respond_to?(:call)
+        raise e
+      end
+    ).to_result
+  end
+end

data/tests/support/fake_logger.rb

@@ -0,0 +1,5 @@
+class FakeLogger
+  def self.log_error
+    true
+  end
+end

data/tests/to_result_test.rb

@@ -0,0 +1,68 @@
+require 'minitest/autorun'
+require 'mocha/minitest'
+require 'byebug'
+
+require './lib/to-result'
+require './tests/support/fake_logger'
+
+class ToResultTest < Minitest::Test
+  include ToResultMixin
+
+  def setup
+    super
+    @value = 'hello world!'
+  end
+
+  def teardown
+    super
+
+    # reset the configuration after each test
+    ToResultMixin.configure { |c| c = {} }
+  end
+
+  def test_string
+    assert ToResult { @value } == Success(@value)
+  end
+
+  def test_success
+    expected = Success(@value)
+    assert ToResult { expected } == Success(expected)
+  end
+
+  def test_exception
+    expected = StandardError.new(@value)
+    assert ToResult { raise expected } == Failure(expected)
+  end
+
+  def test_exception_included_in_exceptions_list
+    expected = ArgumentError.new(@value)
+    assert ToResult([ArgumentError]) { raise expected } == Failure(expected)
+  end
+
+  def test_exception_not_included_in_exceptions_list
+    expected = NameError.new(@value)
+    assert_raises(NameError) { ToResult([ArgumentError]) { raise expected } }
+  end
+
+  def test_yield_failure
+    expected = Failure(@value)
+    # this will raise a Dry::Monads::Do::Halt exception
+    assert ToResult { yield expected } == expected
+  end
+
+  def test_yield_failure_exception
+    expected = Failure(StandardError.new(@value))
+    # this will raise a Dry::Monads::Do::Halt exception
+    assert ToResult { yield expected } == expected
+  end
+
+  def test_on_error
+    FakeLogger.expects(:log_error).once
+
+    ToResultMixin.configure do |c|
+      c.on_error = Proc.new { FakeLogger.log_error }
+    end
+
+    ToResult { raise StandardError.new(@value) }
+  end
+end

data/to-result.gemspec

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |s|
+  s.name        = 'to-result'
+  s.version     = '0.0.3'
+  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']
+  s.homepage    = 'https://github.com/a-chris/to-result'
+  s.license     = 'MIT'
+
+  s.require_paths = ['lib']
+  s.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR).reject { |f| (f == '.gitignore') || f =~ /^examples/ }
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: to-result
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Christian Toscano
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-18 00:00:00.000000000 Z
+date: 2022-10-08 00:00:00.000000000 Z
 dependencies: []
 description: A wrapper over dry-monads to offer a handy and consistent way to implement
   the Railway pattern.
@@ -17,7 +17,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/to_result.rb
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- bin/console
+- lib/to-result.rb
+- tests/support/fake_logger.rb
+- tests/to_result_test.rb
+- to-result.gemspec
 homepage: https://github.com/a-chris/to-result
 licenses:
 - MIT

data/lib/to_result.rb

@@ -1,18 +0,0 @@
-require 'dry/monads'
-
-module ToResultMixin
-  include Dry::Monads[:do, :result, :try]
-
-  def ToResult(exceptions = [StandardError], &f)
-    Dry::Monads::Try.run(
-      [StandardError],
-      Proc.new do
-        f.call
-      rescue Dry::Monads::Do::Halt => e
-        return e.result
-      rescue StandardError => e
-        raise e
-      end
-    ).to_result
-  end
-end