monadic-exceptions 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c3699758583b43eed740a9f0c153b64fa3adc8ebf32f502111d87deb9d02fd90
+  data.tar.gz: 7d78da7f3a5a454c52df368d22695417b32ca89c8e8f8beadab0a6977be916f2
+SHA512:
+  metadata.gz: a2b1504bbbb5109349825a73d82c7ed9cef546ffa38cd90757bf1e41f80010ff21eab423a87eeacc272e7f957338cdb039ca24c96d16fa63212688d4806e63d4
+  data.tar.gz: f51a0591a4e9135095190b701efa9e48906aa5ee33e09954f3711de488999ff2244dc40567a3db0fd84955a26dace10bb65348b4bc65a17578f871eede0ba80f

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2015-2023 dry-rb team
+
+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,13 @@
+# Monadic Exceptions
+
+This gem aims to provide an interface from plain ruby exceptions to monads(using the [dry-monad gem](https://dry-rb.org/gems/dry-monads/1.3/maybe/))
+
+## Initial goals for this gem
+
+- Initially I'm planning just to provide a interface between `Exception ->
+Result[Failure(), Success()]` where I try to provide as much information I can
+get from that exception so it's easier for you to manage it.
+
+## Disclaimers
+
+Today we only support `Proc` as a parameter to the `from_exception` method because I still didn't discover a nice way to manage method references.

data/lib/monadic_exceptions.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'result'

data/lib/result.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'dry/monads/all'
+
+require_relative 'result_sanitizer'
+
+module MonadicExceptions
+  # Result wrap a static method called `from_exception` that receive a Proc and
+  # rescue it's exception raises returning either a Failure or a Success
+  # variant of the Result monad.
+  class Result
+    # This static method act as a bridge between exception to Result, it
+    # supress any raises a method invokes and transform into a valid Failure
+    # return.
+    # @param callback [Proc]
+    # @return [Failure({error: Symbol, where: String, orig_exception: Exception, message: String}), Success(data)]
+    def self.from_exception(callback)
+      result = callback.call
+
+      Dry::Monads::Result::Success.new(result)
+    rescue => e
+      exception_name = MonadicExceptions::ResultSanitizer.new.treat_exception_name(e.class.to_s)
+      Dry::Monads::Result::Failure.new({ error: exception_name,
+                                         where: callback.source_location.first, orig_exception: e,
+                                         message: e.message })
+    end
+  end
+end

data/lib/result_sanitizer.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module MonadicExceptions
+  # ResultSanitizer hold methods responsible to perform string transformations on the exception name
+  class ResultSanitizer
+    # @param exception [String] before calling this method call the .to_s method on the exception at hand.
+    # @return [Symbol]
+    def treat_exception_name(exception)
+      apply_transformations_to_string(exception, [
+                                        proc { |x| x.downcase },
+                                        proc { |x| remove_non_ascii_characters(x) },
+                                        proc { |x| x.to_sym }
+                                      ])
+    end
+
+    # @param input [String]
+    # @return [String] without any character outside the ascii range
+    def remove_non_ascii_characters(input)
+      input.gsub(/[^\x00-\x7F]/, '')
+    end
+
+    # This function apply any number of transformations (a proc that receive
+    # the value and return the transformed value) into a string input.
+    # @param input [String] A target to start the transformations
+    # @param transformations [Array<Proc>] An list of procs that perform pure transformation at a target
+    # @return [String] The modified input
+    def apply_transformations_to_string(input, transformations)
+      modified_string = input.dup
+
+      transformations.each do |transformation|
+        modified_string = transformation.call(modified_string)
+      end
+
+      modified_string
+    end
+  end
+end

data/monadic-exceptions.gemspec

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name        = 'monadic-exceptions'
+  spec.version     = '0.1.0'
+  spec.summary     = 'A bridge between a exception and a Result monad provided by dry-monads gem'
+  spec.description = 'A bridge between a exception and a Result monad provided by dry-monads gem'
+  spec.authors     = ['Cherry Ramatis']
+  spec.homepage    = 'https://github.com/cherryramatisdev/monadic-exceptions.git'
+  spec.license     = 'MIT'
+
+  spec.required_ruby_version = '>= 3.0.0'
+
+  spec.require_paths = ['lib']
+  spec.files         = Dir['LICENSE', 'README.md', 'monadic-exceptions.gemspec', 'lib/**/*']
+
+  spec.add_dependency 'dry-monads', '~> 1.5'
+  spec.metadata['rubygems_mfa_required'] = 'true'
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: monadic-exceptions
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Cherry Ramatis
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-08-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-monads
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+description: A bridge between a exception and a Result monad provided by dry-monads
+  gem
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/monadic_exceptions.rb
+- lib/result.rb
+- lib/result_sanitizer.rb
+- monadic-exceptions.gemspec
+homepage: https://github.com/cherryramatisdev/monadic-exceptions.git
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: A bridge between a exception and a Result monad provided by dry-monads gem
+test_files: []