bcdd-result 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e27dee9c053eeb9f6025b17e09eede49ca6cbc69cd9120947bad34b26a79859d
+  data.tar.gz: c8c080d43a3eb46139f7bf5299c64346809d1c0df4bf0181ccb02ba3005d5ee0
+SHA512:
+  metadata.gz: 253e14ef154c2b863bb65139134a903b2a6fd035fb7a995158cf5ebab395d6ba2bd9f8e999c29305f2d2cd2f6e10db9923166a13d1f06e627df276c87c7a644d
+  data.tar.gz: 7d62559447a5ee3cb665713645f1db7729428f9cf94bd349574758ea3f9bae361f65a218640b2d5bfeb138ef108c27dec426a44ec89dbc971620671b6eab945c

data/.rubocop.yml

@@ -0,0 +1,22 @@
+inherit_from: .rubocop_todo.yml
+
+require:
+  - rubocop-performance
+  - rubocop-minitest
+  - rubocop-rake
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.7
+
+Layout/LineLength:
+  Max: 120
+
+Layout/ExtraSpacing:
+  AllowBeforeTrailingComments: true
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Minitest/MultipleAssertions:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,19 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2023-09-23 03:05:24 UTC using RuboCop version 1.56.3.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 8
+# Configuration parameters: AllowedConstants.
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/bcdd/result.rb'
+    - 'lib/bcdd/result/base.rb'
+    - 'lib/bcdd/result/error.rb'
+    - 'lib/bcdd/result/failure.rb'
+    - 'lib/bcdd/result/success.rb'

data/CHANGELOG.md

@@ -0,0 +1,43 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-09-25
+
+### Added
+
+- Add `BCDD::Result` to represent a result.
+
+- Add `BCDD::Result#type` to get the result type. The type must be a symbol.
+
+- Add `BCDD::Result#value` to get the result value. The value can be anything.
+
+- Add `BCDD::Result#success?` to check if the result is a success. You can also check the result type by passing an argument to it. For example, `result.success?(:ok)` will check if the result is a success and if the type is `:ok`.
+
+- Add `BCDD::Result#failure?` to check if the result is a failure. You can also check the result type by passing an argument to it. For example, `result.failure?(:error)` will check if the result is a failure and if the type is `:error`.
+
+- Add `BCDD::Result#value_or` to get the value of a successful result or a default value (from the block) if it is a failure.
+
+- Add `BCDD::Result#==` to compare two results.
+
+- Add `BCDD::Result#eql?` to compare two results.
+
+- Add `BCDD::Result#hash` to get the hash of a result.
+
+- Add `BCDD::Result#inspect` to get the string representation of a result.
+
+- Add `BCDD::Result#on` to execute a block depending on the result type (independently of the result being a success or a failure). The block will receive the result value as an argument, and the result itself will be returned after (or not) the block execution. The method can be called multiple times and with one or more arguments. For example, `result.on(:ok, :error) { |value| # ... }` will execute the block if the result type is `:ok` or `:error`.
+
+- Add `BCDD::Result#on_success` to execute a block if the result is a success. It works like `BCDD::Result#on` but only for success results.
+
+- Add `BCDD::Result#on_failure` to execute a block if the result is a failure. It works like `BCDD::Result#on` but only for failure results.
+
+- Add `BCDD::Result#and_then` to execute the block if the result is a success. You can use it to chain multiple operations. If the block returns a failure result and there are other `and_then` calls after it, the next blocks will be skipped.
+
+- Add `BCDD::Result#data` as an alias for `BCDD::Result#value`.
+
+- Add `BCDD::Result#data_or` as an alias for `BCDD::Result#value_or`.
+
+- Add `BCDD::Result#on_type` as an alias for `BCDD::Result#on`.
+
+- Add `BCDD::Result::Success()` to factory a success result.
+
+- Add `BCDD::Result::Failure()` to factory a failure result.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at rodrigo.serradura@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Rodrigo Serradura
+
+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,371 @@
+# BCDD::Result <!-- omit in toc -->
+
+A general-purpose result monad that allows you to create objects that represent a success (`BCDD::Result::Success`) or failure (`BCDD::Result::Failure`).
+
+**What problem does it solve?**
+
+It allows you to consistently represent the concept of success and failure throughout your codebase.
+
+Furthermore, this abstraction exposes several methods that will be useful to make the code flow react clearly and cleanly to the result represented by these objects.
+
+- [Installation](#installation)
+- [Usage](#usage)
+- [Reference](#reference)
+  - [Result Attributes](#result-attributes)
+    - [Receiving types in `result.success?` or `result.failure?`](#receiving-types-in-resultsuccess-or-resultfailure)
+  - [Result Hooks](#result-hooks)
+    - [`result.on`](#resulton)
+    - [`result.on_type`](#resulton_type)
+    - [`result.on_success`](#resulton_success)
+    - [`result.on_failure`](#resulton_failure)
+  - [Result value](#result-value)
+    - [`result.value_or`](#resultvalue_or)
+    - [`result.data_or`](#resultdata_or)
+  - [Railway Oriented Programming](#railway-oriented-programming)
+    - [`result.and_then`](#resultand_then)
+- [About](#about)
+- [Development](#development)
+- [Contributing](#contributing)
+- [License](#license)
+- [Code of Conduct](#code-of-conduct)
+
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add bcdd-result
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install bcdd-result
+
+## Usage
+
+To create a result, you must define a type (symbol) and its value (any kind of object). e.g.,
+
+```ruby
+BCDD::Result::Success(:ok, :1)           #
+                                         # The value can be any kind of object
+BCDD::Result::Failure(:err, 'the value') #
+```
+
+The reason for defining a `type` is that it is very common for a method/operation to return different types of successes or failures. Because of this, the `type` will always be required. e,g.,
+
+```ruby
+BCDD::Result::Success(:ok)  #
+                            # The type is mandatory and the value is optional
+BCDD::Result::Failure(:err) #
+```
+
+<p align="right">(<a href="#bcddresult-">⬆️ &nbsp;back to top</a>)</p>
+
+## Reference
+
+### Result Attributes
+
+Both `BCDD::Result::Success` and `BCDD::Result::Failure` are composed of the same methods. Look at the basic ones:
+
+**BCDD::Result::Success**
+
+```ruby
+################
+# With a value #
+################
+result = BCDD::Result::Success(:ok, my: 'value')
+
+result.success? # true
+result.failure? # false
+result.type     # :ok
+result.value    # {:my => "value"}
+
+###################
+# Without a value #
+###################
+result = BCDD::Result::Success(:yes)
+
+result.success? # true
+result.failure? # false
+result.type     # :yes
+result.value    # nil
+```
+
+**BCDD::Result::Failure**
+
+```ruby
+################
+# With a value #
+################
+result = BCDD::Result::Failure(:err, my: 'value')
+
+result.success? # false
+result.failure? # true
+result.type     # :err
+result.value    # {:my => "value"}
+
+###################
+# Without a value #
+###################
+result = BCDD::Result::Failure(:no)
+
+result.success? # false
+result.failure? # true
+result.type     # :no
+result.value    # nil
+```
+
+<p align="right">(<a href="#bcddresult-">⬆️ &nbsp;back to top</a>)</p>
+
+#### Receiving types in `result.success?` or `result.failure?`
+
+`BCDD::Result#success?` and `BCDD::Result#failure?` are methods that allow you to check if the result is a success or a failure.
+
+You can also check the result type by passing an argument to it. For example, `result.success?(:ok)` will check if the result is a success and if the type is `:ok`.
+
+```ruby
+result = BCDD::Result::Success(:ok)
+
+result.success?        # true
+result.success?(:ok)   # true
+result.success?(:okay) # false
+```
+
+The same is valid for `BCDD::Result#failure?`.
+
+```ruby
+result = BCDD::Result::Failure(:err)
+
+result.failure?         # true
+result.failure?(:err)   # true
+result.failure?(:error) # false
+```
+
+<p align="right">(<a href="#bcddresult-">⬆️ &nbsp;back to top</a>)</p>
+
+### Result Hooks
+
+Result hooks are methods that allow you to perform a block of code depending on the result type.
+
+To exemplify the them, I will implement a method that knows how to divide two numbers.
+
+```ruby
+def divide(arg1, arg2)
+  arg1.is_a?(::Numeric) or return BCDD::Result::Failure(:invalid_arg, 'arg1 must be numeric')
+  arg2.is_a?(::Numeric) or return BCDD::Result::Failure(:invalid_arg, 'arg2 must be numeric')
+
+  return BCDD::Result::Failure(:division_by_zero, 'arg2 must not be zero') if arg2.zero?
+
+  BCDD::Result::Success(:division_completed, arg1 / arg2)
+end
+```
+
+#### `result.on`
+
+`BCDD::Result#on` will perform the block when the type matches the result type.
+
+Regardless of the block being executed, the return of the method will always be the result itself.
+
+The result value will be exposed as the first argument of the block.
+
+```ruby
+result = divide(nil, 2)
+
+output =
+  result
+    .on(:invalid_arg) { |msg| puts msg }
+    .on(:division_by_zero) { |msg| puts msg }
+    .on(:division_completed) { |number| puts number }
+
+# The code above will print 'arg1 must be numeric' and return the result itself.
+
+result.object_id == output.object_id # true
+```
+
+You can define multiple types to be handled by the same hook/block
+```ruby
+result = divide(4, 0)
+
+output =
+  result.on(:invalid_arg, :division_by_zero, :division_completed) { |value| puts value }
+
+# The code above will print 'arg2 must not be zero' and return the result itself.
+
+result.object_id == output.object_id # true
+```
+
+<p align="right">(<a href="#bcddresult-">⬆️ &nbsp;back to top</a>)</p>
+
+#### `result.on_type`
+
+`BCDD::Result#on_type` is an alias of `BCDD::Result#on`.
+
+#### `result.on_success`
+
+`BCDD::Result#on_success` is very similar to the `BCDD::Result#on` hook. The main differences are:
+
+1. Only perform the block when the result is a success.
+2. If the type is missing it will perform the block for any success.
+
+```ruby
+# It performs the block and return itself.
+
+divide(4, 2).on_success { |number| puts number }
+
+divide(4, 2).on_success(:division_completed) { |number| puts number }
+
+# It doesn't perform the block, but return itself.
+
+divide(4, 4).on_success(:ok) { |value| puts value }
+
+divide(4, 4).on_failure { |error| puts error }
+```
+
+<p align="right">(<a href="#bcddresult-">⬆️ &nbsp;back to top</a>)</p>
+
+#### `result.on_failure`
+
+Is the opposite of `Result#on_success`.
+
+```ruby
+# It performs the block and return itself.
+
+divide(nil, 2).on_failure { |error| puts error }
+
+divide(4, 0).on_failure(:invalid_arg, :division_by_zero) { |error| puts error }
+
+# It doesn't perform the block, but return itself.
+
+divide(4, 0).on_success { |number| puts number }
+
+divide(4, 0).on_failure(:invalid_arg) { |error| puts error }
+```
+
+<p align="right">(<a href="#bcddresult-">⬆️ &nbsp;back to top</a>)</p>
+
+### Result value
+
+The most simple way to get the result value is by calling `BCDD::Result#value` or `BCDD::Result#data`.
+
+But sometimes you need to get the value of a successful result or a default value if it is a failure. In this case, you can use `BCDD::Result#value_or` or `BCDD::Result#data_or`.
+
+#### `result.value_or`
+
+`BCCD::Result#value_or` returns the value when the result is a success, but if is a failure the block will be performed, and its outcome will be the output.
+
+```ruby
+def divide(arg1, arg2)
+  arg1.is_a?(::Numeric) or return BCDD::Result::Failure(:invalid_arg)
+  arg2.is_a?(::Numeric) or return BCDD::Result::Failure(:invalid_arg)
+
+  return BCDD::Result::Failure(:division_by_zero) if arg2.zero?
+
+  BCDD::Result::Success(:division_completed, arg1 / arg2)
+end
+
+# When the result is success
+divide(4, 2).value_or { 0 } # 2
+
+# When the result is failure
+divide('4', 2).value_or { 0 } # 0
+divide(4, '2').value_or { 0 } # 0
+divide(100, 0).value_or { 0 } # 0
+```
+
+<p align="right">(<a href="#bcddresult-">⬆️ &nbsp;back to top</a>)</p>
+
+#### `result.data_or`
+
+`BCDD::Result#data_or` is an alias of `BCDD::Result#value_or`.
+
+
+### Railway Oriented Programming
+
+#### `result.and_then`
+
+This feature/pattern is also known as ["Railway Oriented Programming"](https://fsharpforfunandprofit.com/rop/).
+
+The idea is to chain blocks and creates a pipeline of operations that can be interrupted by a failure.
+
+In other words, the block will be executed only if the result is a success.
+So, if some block returns a failure, the following blocks will be skipped.
+
+Due to this characteristic, you can use this feature to express some logic as a sequence of operations. And have the guarantee that the process will stop by the first failure detection, and if everything is ok, the final result will be a success. e.g.,
+
+```ruby
+module Divide
+  extend self
+
+  def call(arg1, arg2)
+    validate_numbers(arg1, arg2)
+      .and_then { |numbers| validate_non_zero(numbers) }
+      .and_then { |numbers| divide(numbers) }
+  end
+
+  private
+
+  def validate_numbers(arg1, arg2)
+    arg1.is_a?(::Numeric) or return BCDD::Result::Failure(:invalid_arg, 'arg1 must be numeric')
+    arg2.is_a?(::Numeric) or return BCDD::Result::Failure(:invalid_arg, 'arg2 must be numeric')
+
+    BCDD::Result::Success(:ok, [arg1, arg2])
+  end
+
+  def validate_non_zero(numbers)
+    return BCDD::Result::Success(:ok, numbers) unless numbers.last.zero?
+
+    BCDD::Result::Failure(:division_by_zero, "arg2 must not be zero")
+  end
+
+  def divide((number1, number2))
+    BCDD::Result::Success(:division_completed, number1 / number2)
+  end
+end
+```
+
+Example of outputs:
+
+```ruby
+Divide.call('4', 2)
+#<BCDD::Result::Failure type=:invalid_arg data="arg1 must be numeric">
+
+Divide.call(2, '2')
+#<BCDD::Result::Failure type=:invalid_arg data="arg2 must be numeric">
+
+Divide.call(2, 0)
+#<BCDD::Result::Failure type=:division_by_zero data="arg2 must not be zero">
+
+Divide.call(2, 2)
+#<BCDD::Result::Success type=:division_completed data=1>
+```
+
+<p align="right">(<a href="#bcddresult-">⬆️ &nbsp;back to top</a>)</p>
+
+## About
+
+[Rodrigo Serradura](https://github.com/serradura) created this project. He is the B/CDD process/method creator and has already made similar gems like the [u-case](https://github.com/serradura/u-case) and [kind](https://github.com/serradura/kind/blob/main/lib/kind/result.rb). This gem is a general-purpose abstraction/monad, but it also contains key features that serve as facilitators for adopting B/CDD in the code.
+
+<p align="right">(<a href="#bcddresult-">⬆️ &nbsp;back to top</a>)</p>
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+<p align="right">(<a href="#bcddresult-">⬆️ &nbsp;back to top</a>)</p>
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/B-CDD/bcdd-result. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/B-CDD/bcdd-result/blob/master/CODE_OF_CONDUCT.md).
+
+<p align="right">(<a href="#bcddresult-">⬆️ &nbsp;back to top</a>)</p>
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+<p align="right">(<a href="#bcddresult-">⬆️ &nbsp;back to top</a>)</p>
+
+## Code of Conduct
+
+Everyone interacting in the BCDD::Result project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/B-CDD/bcdd-result/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/Steepfile

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+D = Steep::Diagnostic
+
+target :lib do
+  signature 'sig'
+
+  check 'lib'                       # Directory name
+  # check 'Gemfile'                   # File name
+  # check 'app/models/**/*.rb'        # Glob
+  # ignore 'lib/templates/*.rb'
+
+  # library 'pathname'              # Standard libraries
+  # library 'strong_json'           # Gems
+
+  # configure_code_diagnostics(D::Ruby.default)      # `default` diagnostics setting (applies by default)
+  # configure_code_diagnostics(D::Ruby.strict)       # `strict` diagnostics setting
+  # configure_code_diagnostics(D::Ruby.lenient)      # `lenient` diagnostics setting
+  # configure_code_diagnostics(D::Ruby.silent)       # `silent` diagnostics setting
+  # configure_code_diagnostics do |hash|             # You can setup everything yourself
+  #   hash[D::Ruby::NoMethod] = :information
+  # end
+end
+
+# target :test do
+#   signature 'sig', 'sig-private'
+#
+#   check 'test'
+#
+#   # library 'pathname'              # Standard libraries
+# end

data/lib/bcdd/result/error.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+class BCDD::Result
+  class Error < ::StandardError
+    class NotImplemented < self
+    end
+
+    class MissingTypeArgument < self
+      def initialize(_arg = nil)
+        super('A type (argument) is required to invoke the #on/#on_type method')
+      end
+    end
+
+    class UnexpectedBlockOutcome < self
+      def initialize(arg = nil)
+        message =
+          "Unexpected outcome: #{arg.inspect}. The block must return this object wrapped by " \
+          'BCDD::Result::Success or BCDD::Result::Failure'
+
+        super(message)
+      end
+    end
+  end
+end

data/lib/bcdd/result/failure.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+class BCDD::Result
+  class Failure < self
+    def success?(_type = nil)
+      false
+    end
+
+    def failure?(type = nil)
+      type.nil? || type == self.type
+    end
+
+    def value_or
+      yield
+    end
+
+    alias data_or value_or
+  end
+
+  def self.Failure(type, value = nil)
+    Failure.new(type: type, value: value)
+  end
+end

data/lib/bcdd/result/success.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+class BCDD::Result
+  class Success < self
+    def success?(type = nil)
+      type.nil? || type == self.type
+    end
+
+    def failure?(_type = nil)
+      false
+    end
+
+    def value_or
+      value
+    end
+
+    alias data_or value_or
+  end
+
+  def self.Success(type, value = nil)
+    Success.new(type: type, value: value)
+  end
+end

data/lib/bcdd/result/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module BCDD
+  class Result
+    VERSION = '0.1.0'
+  end
+end

data/lib/bcdd/result.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require_relative 'result/version'
+require_relative 'result/error'
+require_relative 'result/failure'
+require_relative 'result/success'
+
+class BCDD::Result
+  attr_reader :type, :value
+
+  def initialize(type:, value:)
+    @type = type.to_sym
+    @value = value
+  end
+
+  def success?(_type = nil)
+    raise Error::NotImplemented
+  end
+
+  def failure?(_type = nil)
+    raise Error::NotImplemented
+  end
+
+  def value_or(&_block)
+    raise Error::NotImplemented
+  end
+
+  def ==(other)
+    self.class == other.class && type == other.type && value == other.value
+  end
+  alias eql? ==
+
+  def hash
+    [self.class, type, value].hash
+  end
+
+  def inspect
+    format('#<%<class_name>s type=%<type>p value=%<value>p>', class_name: self.class.name, type: type, value: value)
+  end
+
+  def on(*types)
+    raise Error::MissingTypeArgument if types.empty?
+
+    tap { yield(value, type) if expected_type?(types) }
+  end
+
+  def on_success(*types)
+    tap { yield(value, type) if success? && allowed_to_handle?(types) }
+  end
+
+  def on_failure(*types)
+    tap { yield(value, type) if failure? && allowed_to_handle?(types) }
+  end
+
+  def and_then
+    return self if failure?
+
+    result = yield(value)
+
+    return result if result.is_a?(::BCDD::Result)
+
+    raise Error::UnexpectedBlockOutcome, result
+  end
+
+  alias data value
+  alias data_or value_or
+  alias on_type on
+
+  private
+
+  def expected_type?(types)
+    types.any?(type)
+  end
+
+  def allowed_to_handle?(types)
+    types.empty? || expected_type?(types)
+  end
+end

data/sig/bcdd/result.rbs

@@ -0,0 +1,66 @@
+module BCDD
+  class Result
+    VERSION: String
+  end
+end
+
+class BCDD::Result
+  attr_reader type: Symbol
+  attr_reader value: untyped
+
+  def initialize: (type: Symbol, value: untyped) -> void
+
+  def success?: (?Symbol type) -> bool
+  def failure?: (?Symbol type) -> bool
+
+  def value_or: { () -> untyped } -> untyped
+
+  def ==: (untyped) -> bool
+  alias eql? ==
+
+  def hash: -> Integer
+
+  def inspect: -> String
+
+  def on: (*Symbol) { (untyped, Symbol) -> void } -> BCDD::Result
+  def on_success: (*Symbol) { (untyped, Symbol) -> void } -> BCDD::Result
+  def on_failure: (*Symbol) { (untyped, Symbol) -> void } -> BCDD::Result
+
+  def and_then: { (untyped) -> untyped } -> BCDD::Result
+
+  alias data value
+  alias data_or value_or
+  alias on_type on
+
+  private
+
+  def expected_type?: (Array[Symbol]) -> bool
+  def allowed_to_handle?: (Array[Symbol]) -> bool
+end
+
+class BCDD::Result
+  class Failure < BCDD::Result
+  end
+
+  def self.Success: (Symbol type, untyped value) -> BCDD::Result::Success
+end
+
+class BCDD::Result
+  class Success < BCDD::Result
+  end
+
+  def self.Failure: (Symbol type, untyped value) -> BCDD::Result::Failure
+end
+
+class BCDD::Result
+  class Error < ::StandardError
+    class NotImplemented < BCDD::Result::Error
+    end
+
+    class MissingTypeArgument < BCDD::Result::Error
+    end
+
+    class UnexpectedBlockOutcome < BCDD::Result::Error
+    end
+  end
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: bcdd-result
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rodrigo Serradura
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-09-25 00:00:00.000000000 Z
+dependencies: []
+description: A general-purpose result monad that allows you to create objects that
+  represent a success (BCDD::Result::Success) or failure (BCDD::Result::Failure).
+email:
+- rodrigo.serradura@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- Steepfile
+- lib/bcdd/result.rb
+- lib/bcdd/result/error.rb
+- lib/bcdd/result/failure.rb
+- lib/bcdd/result/success.rb
+- lib/bcdd/result/version.rb
+- sig/bcdd/result.rbs
+homepage: https://github.com/b-cdd/result
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/b-cdd/result
+  source_code_uri: https://github.com/b-cdd/result
+  changelog_uri: https://github.com/b-cdd/result/blob/main/CHANGELOG.md
+  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: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: A result abstraction (monad based) for Ruby.
+test_files: []