iron_oxide 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 689ead17e28d9c0bf0b7b70d8f607ad8cfb838937159568b13b8acc0c832de5b
+  data.tar.gz: 243c1f6494cf34f30a251792501f3cddb89512a290ca1a4a9db1d8cd096446cc
+SHA512:
+  metadata.gz: 5f931fa4c52470ac1b74d473337940e5a19c13fe496f061d62bb54fa26949a6dc36b25577c1ce6e497cba4b84355f89be2351e50ebf2e3ac675035e7a8e51065
+  data.tar.gz: 21a8a63cc77150ad9b812a2add7e81ff4aad80c069951bc8c326bea3c28565fe761cec3c035a8f98089194dd0f1051524ba96e5e9deacf3c55fd6d0c9162035a

data/.github/CODEOWNERS

@@ -0,0 +1,4 @@
+# You can read more about CODEOWNERS at
+# https://help.github.com/github/creating-cloning-and-archiving-repositories/about-code-owners
+
+* @fnando

data/.github/FUNDING.yml

@@ -0,0 +1,4 @@
+# These are supported funding model platforms
+---
+github: [fnando]
+custom: ["https://paypal.me/[USER]/🍕"]

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,41 @@
+---
+name: "🐛 Bug Report"
+about: Report a reproducible bug or regression.
+title: 'Bug: '
+labels: 'Status: Unconfirmed'
+
+---
+
+<!--
+  - Please provide a clear and concise description of what the bug is.
+  - If possible, add an example reproducing your issue.
+  - Please test using the latest version of iron_oxide
+    to make sure your issue has not already been fixed.
+-->
+
+## Description
+
+[Add bug description here]
+
+## How to reproduce
+
+[Add steps on how to reproduce this issue]
+
+## What do you expect
+
+[Describe what do you expect to happen]
+
+## What happened instead
+
+[Describe the actual results]
+
+## Software:
+
+- Gem version: [Add gem version here]
+- Ruby version: [Add version here]
+
+## Full backtrace
+
+```text
+[Paste full backtrace here]
+```

data/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+---
+contact_links:
+  - name: "🤨 Q&A"
+    url: https://github.com/fnando/iron_oxide/discussions/new?category=q-a
+    about: Have a question? Ask it away here!

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,23 @@
+---
+name: "💡 Feature request"
+about: Have an idea that may be useful? Make a suggestion!
+title: 'Feature Request: '
+labels: 'Feature request'
+
+---
+
+## Description
+
+_A clear and concise description of what the problem is._
+
+## Describe the solution
+
+_A clear and concise description of what you want to happen._
+
+## Alternatives you considered
+
+_A clear and concise description of any alternative solutions or features you've considered._
+
+## Additional context
+
+_Add any other context, screenshots, links, etc about the feature request here._

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,38 @@
+<!--
+If you're making a doc PR or something tiny where the below is irrelevant,
+delete this template and use a short description, but in your description aim to
+include both what the change is, and why it is being made, with enough context
+for anyone to understand.
+-->
+
+<details>
+  <summary>PR Checklist</summary>
+
+### PR Structure
+
+- [ ] This PR has reasonably narrow scope (if not, break it down into smaller
+      PRs).
+- [ ] This PR avoids mixing refactoring changes with feature changes (split into
+      two PRs otherwise).
+- [ ] This PR's title starts is concise and descriptive.
+
+### Thoroughness
+
+- [ ] This PR adds tests for the most critical parts of the new functionality or
+      fixes.
+- [ ] I've updated any docs, `.md` files, etc… affected by this change.
+
+</details>
+
+### What
+
+[TODO: Short statement about what is changing.]
+
+### Why
+
+[TODO: Why this change is being made. Include any context required to understand
+the why.]
+
+### Known limitations
+
+[TODO or N/A]

data/.github/dependabot.yml

@@ -0,0 +1,15 @@
+---
+# Documentation:
+# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"
+
+  - package-ecosystem: bundler
+    directory: "/"
+    schedule:
+      interval: "daily"

data/.github/workflows/ruby-tests.yml

@@ -0,0 +1,52 @@
+---
+name: ruby-tests
+
+on:
+  pull_request_target:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+    inputs: {}
+
+jobs:
+  build:
+    name: Tests with Ruby ${{ matrix.ruby }} and ${{ matrix.gemfile }}
+    runs-on: "ubuntu-latest"
+    if: |
+      github.actor == 'dependabot[bot]' && github.event_name == 'pull_request_target' ||
+      github.actor != 'dependabot[bot]'
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ["3.3"]
+        gemfile:
+          - Gemfile
+
+    steps:
+      - uses: actions/checkout@v1
+
+      - uses: actions/cache@v2
+        with:
+          path: vendor/bundle
+          key: >
+            ${{ runner.os }}-${{ matrix.ruby }}-gems-${{ hashFiles(matrix.gemfile) }}
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - name: Install gem dependencies
+        env:
+          BUNDLE_GEMFILE: ${{ matrix.gemfile }}
+        run: |
+          gem install bundler
+          bundle config path vendor/bundle
+          bundle update --jobs 4 --retry 3
+
+      - name: Run Tests
+        env:
+          BUNDLE_GEMFILE: ${{ matrix.gemfile }}
+        run: |
+          bundle exec rake

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/
+*.log
+*.lock

data/.rubocop.yml

@@ -0,0 +1,10 @@
+---
+inherit_gem:
+  rubocop-fnando: .rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 3.3
+  NewCops: enable
+  Exclude:
+    - vendor/**/*
+    - gemfiles/**/*

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+
+<!--
+Prefix your message with one of the following:
+
+- [Added] for new features.
+- [Changed] for changes in existing functionality.
+- [Deprecated] for soon-to-be removed features.
+- [Removed] for now removed features.
+- [Fixed] for any bug fixes.
+- [Security] in case of vulnerabilities.
+-->
+
+## 0.0.1
+
+- Initial release.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at me@fnando.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/CONTRIBUTING.md

@@ -0,0 +1,79 @@
+# Contributing to iron_oxide
+
+👍🎉 First off, thanks for taking the time to contribute! 🎉👍
+
+The following is a set of guidelines for contributing to this project. These are
+mostly guidelines, not rules. Use your best judgment, and feel free to propose
+changes to this document in a pull request.
+
+## Code of Conduct
+
+Everyone interacting in this project's codebases, issue trackers, chat rooms and
+mailing lists is expected to follow the [code of conduct](https://github.com/fnando/iron_oxide/blob/main/CODE_OF_CONDUCT.md).
+
+## Reporting bugs
+
+This section guides you through submitting a bug report. Following these
+guidelines helps maintainers and the community understand your report, reproduce
+the behavior, and find related reports.
+
+- Before creating bug reports, please check the open issues; somebody may
+  already have submitted something similar, and you may not need to create a new
+  one.
+- When you are creating a bug report, please include as many details as
+  possible, with an example reproducing the issue.
+
+## Contributing with code
+
+Before making any radicals changes, please make sure you discuss your intention
+by [opening an issue on Github](https://github.com/fnando/iron_oxide/issues).
+
+When you're ready to make your pull request, follow checklist below to make sure
+your contribution is according to how this project works.
+
+1. [Fork](https://help.github.com/forking/) iron_oxide
+2. Create a topic branch - `git checkout -b my_branch`
+3. Make your changes using [descriptive commit messages](#commit-messages)
+4. Update CHANGELOG.md describing your changes by adding an entry to the
+   "Unreleased" section. If this section is not available, create one right
+   before the last version.
+5. Push to your branch - `git push origin my_branch`
+6. [Create a pull request](https://help.github.com/articles/creating-a-pull-request)
+7. That's it!
+
+## Styleguides
+
+### Commit messages
+
+- Use the present tense ("Add feature" not "Added feature")
+- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
+- Limit the first line to 72 characters or less
+- Reference issues and pull requests liberally after the first line
+
+### Changelog
+
+- Add a message describing your changes to the "Unreleased" section. The
+  changelog message should follow the same style as the commit message.
+- Prefix your message with one of the following:
+  - `[Added]` for new features.
+  - `[Changed]` for changes in existing functionality.
+  - `[Deprecated]` for soon-to-be removed features.
+  - `[Removed]` for now removed features.
+  - `[Fixed]` for any bug fixes.
+  - `[Security]` in case of vulnerabilities.
+
+### Ruby code
+
+- This project uses [Rubocop](https://rubocop.org) to enforce code style. Before
+  submitting your changes, make sure your tests are passing and code conforms to
+  the expected style by running `rake`.
+- Do not change the library version. This will be done by the maintainer
+  whenever a new version is about to be released.
+
+### JavaScript code
+
+- This project uses [ESLint](https://eslint.org) to enforce code style. Before
+  submitting your changes, make sure your tests are passing and code conforms to
+  the expected style by running `yarn test:ci`.
+- Do not change the library version. This will be done by the maintainer
+  whenever a new version is about to be released.

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec

data/LICENSE.md

@@ -0,0 +1,20 @@
+# The MIT License (MIT)
+
+Copyright (c) 2024 Nando Vieira
+
+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,64 @@
+# iron_oxide
+
+[![Tests](https://github.com/fnando/iron_oxide/workflows/ruby-tests/badge.svg)](https://github.com/fnando/iron_oxide)
+[![Gem](https://img.shields.io/gem/v/iron_oxide.svg)](https://rubygems.org/gems/iron_oxide)
+[![Gem](https://img.shields.io/gem/dt/iron_oxide.svg)](https://rubygems.org/gems/iron_oxide)
+[![MIT License](https://img.shields.io/:License-MIT-blue.svg)](https://tldrlegal.com/license/mit-license)
+
+An experiment that brings most of Rust's `Result` and `Option` patterns to Ruby.
+
+## Installation
+
+```bash
+gem install iron_oxide
+```
+
+Or add the following line to your project's Gemfile:
+
+```ruby
+gem "iron_oxide"
+```
+
+## Usage
+
+```ruby
+require "iron_oxide"
+
+include IronOxide::Aliases
+
+Some(1).some?
+None.some?
+None.none?
+
+Ok(1).ok?
+Err("oh noes!").ok?
+```
+
+Most of `Result` and `Option` has been ported to Ruby. You can
+[check tests](https://github.com/fnando/iron_oxide/tree/main/test/iron_oxide)
+for examples.
+
+## Maintainer
+
+- [Nando Vieira](https://github.com/fnando)
+
+## Contributors
+
+- https://github.com/fnando/iron_oxide/contributors
+
+## Contributing
+
+For more details about how to contribute, please read
+https://github.com/fnando/iron_oxide/blob/main/CONTRIBUTING.md.
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT). A copy of the license can be
+found at https://github.com/fnando/iron_oxide/blob/main/LICENSE.md.
+
+## Code of Conduct
+
+Everyone interacting in the iron_oxide project's codebases, issue trackers, chat
+rooms and mailing lists is expected to follow the
+[code of conduct](https://github.com/fnando/iron_oxide/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "iron_oxide"
+
+# 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.
+
+begin
+  require "pry"
+  Pry.start
+rescue LoadError
+  require "irb"
+  IRB.start(__FILE__)
+end

data/bin/setup

@@ -0,0 +1,10 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/iron_oxide.gemspec

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative "lib/iron_oxide/version"
+
+Gem::Specification.new do |spec|
+  spec.name    = "iron_oxide"
+  spec.version = IronOxide::VERSION
+  spec.authors = ["Nando Vieira"]
+  spec.email   = ["me@fnando.com"]
+  spec.metadata = {"rubygems_mfa_required" => "true"}
+
+  spec.summary     = "An experiment that brings some Rust patterns to Ruby."
+  spec.description = spec.summary
+  spec.license     = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.3.0")
+
+  github_url = "https://github.com/fnando/iron_oxide"
+  github_tree_url = "#{github_url}/tree/v#{spec.version}"
+
+  spec.homepage = github_url
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["bug_tracker_uri"] = "#{github_url}/issues"
+  spec.metadata["source_code_uri"] = github_tree_url
+  spec.metadata["changelog_uri"] = "#{github_tree_url}/CHANGELOG.md"
+  spec.metadata["documentation_uri"] = "#{github_tree_url}/README.md"
+  spec.metadata["license_uri"] = "#{github_tree_url}/LICENSE.md"
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`
+      .split("\x0")
+      .reject {|f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) {|f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "minitest-utils"
+  spec.add_development_dependency "pry-meta"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "rubocop-fnando"
+  spec.add_development_dependency "simplecov"
+end

data/lib/iron_oxide/aliases.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module IronOxide
+  module Aliases
+    def Some(value) # rubocop:disable Naming/MethodName
+      Option::Some(value)
+    end
+
+    None = Option::None
+
+    def Ok(value) # rubocop:disable Naming/MethodName
+      Result::Ok(value)
+    end
+
+    def Err(error) # rubocop:disable Naming/MethodName
+      Result::Err(error)
+    end
+  end
+end

data/lib/iron_oxide/option.rb

@@ -0,0 +1,214 @@
+# frozen_string_literal: true
+
+module IronOxide
+  module Option
+    class Base
+      attr_reader :value
+
+      # Checks if the instance represents a `Some` value.
+      def some?
+        instance_of?(SomeClass)
+      end
+
+      # Checks if the instance represents a `None` value.
+      def none?
+        instance_of?(NoneClass)
+      end
+
+      # Evaluates a block for a `Some` value and checks its result.
+      def some_and?
+        some? && yield(value)
+      end
+
+      # Evaluates a block for a `None` value and checks its result.
+      def none_or?
+        none? || yield(value)
+      end
+
+      # Converts a `Some` value into an array or returns an empty array
+      # for `None`.
+      def as_slice
+        some? ? [value] : []
+      end
+
+      # Retrieves the contained value or raises an error with a custom message.
+      def expect(message)
+        some? ? value : raise(ExpectError, message)
+      end
+
+      # Retrieves the contained value or raises an error for a `None` value.
+      def unwrap
+        some? ? value : raise(ExpectError, "error unwrapping None")
+      end
+
+      # Retrieves the contained value or returns a provided default value.
+      def unwrap_or(default)
+        some? ? value : default
+      end
+
+      # Retrieves the contained value or computes a default value using a block.
+      def unwrap_or_else
+        some? ? value : yield
+      end
+
+      # Applies a transformation to a `Some` value using a block.
+      def map
+        some? ? Option::Some(yield(value)) : None
+      end
+
+      # Checks equality with another `Option` value.
+      def ==(other)
+        Option.option?(other) &&
+          ((none? && other.none?) ||
+                    (some? && other.some? && value == other.value))
+      end
+
+      # Applies a transformation to a `Some` value or returns a default value
+      # for `None`.
+      def map_or(default)
+        some? ? yield(value) : default
+      end
+
+      # Converts a `Some` value into an `Ok` result or returns an `Err` result
+      # with a provided error.
+      def ok_or(error)
+        some? ? Result::Ok(value) : Result::Err(error)
+      end
+
+      # Converts a `Some` value into an `Ok` result or computes an `Err` result
+      # using a block.
+      def ok_or_else
+        some? ? Result::Ok(value) : Result::Err(yield)
+      end
+
+      # Combines the `Option` with another, returning `None` if the instance
+      # is `None`.
+      def and(other)
+        none? ? None : other
+      end
+
+      # Transforms the contained value of a `Some` instance using a block or
+      # returns `None`.
+      def and_then
+        return None if none?
+
+        yield(value).tap do |other|
+          next if Option.option?(other)
+
+          raise TypeError,
+                "expected block to return an Option; got #{other.class.name}"
+        end
+      end
+
+      # Filters a `Some` value based on a predicate block.
+      def filter
+        return None if none?
+
+        yield(value) ? self : None
+      end
+
+      # Combines the `Option` with another, returning the first `Some`
+      # encountered.
+      def or(other)
+        some? ? self : other
+      end
+
+      # Combines the `Option` with another, using a block to produce an
+      # alternative value.
+      def or_else
+        some? ? self : yield
+      end
+
+      # Computes the exclusive-or of two `Option` values.
+      def xor(other)
+        return Option::None if some? && other.some?
+        return Option::None if none? && other.none?
+        return self if some?
+
+        other
+      end
+
+      # Combines two `Option` values into a single `Option` containing a tuple
+      # of their values.
+      def zip(other)
+        some? && other.some? ? Option::Some([value, other.value]) : None
+      end
+
+      # Splits the contained value into two `Option` values if it is a pair.
+      def unzip
+        return None unless some?
+
+        unless value.respond_to?(:to_a)
+          raise ArgumentError,
+                "expected value to respond to #to_a"
+        end
+
+        items = value.to_a
+        size = items.size
+
+        unless size == 2
+          raise ArgumentError,
+                "expected value to have exactly 2 items; got #{size}"
+        end
+
+        items.map { Option::Some(_1) }
+      end
+
+      # Transposes a contained `Result` value to swap the `Option` and `Result`
+      # structure.
+      def transpose
+        return Result::Ok(Option::None) if none?
+
+        unless Result.result?(value)
+          raise TypeError,
+                "expected value to be a Result; got #{value.class.name}"
+        end
+
+        return Result::Ok(Option::Some(value.value)) if some? && value.ok?
+
+        Result::Err(value.value) if some? && value.err?
+      end
+
+      # Flattens nested `Option` values into a single `Option`.
+      def flatten
+        unless Option.option?(value)
+          raise TypeError,
+                "expected value to be an Option; got #{value.class.name}"
+        end
+
+        if none? || value.none?
+          None
+        else
+          Option::Some(value.value)
+        end
+      end
+    end
+
+    class SomeClass < Base
+      def initialize(value)
+        super()
+        @value = value
+      end
+    end
+
+    class NoneClass < Base
+      def initialize(*)
+        super()
+        @value = self
+      end
+    end
+
+    # Creates a new `Some` instance with a specified value.
+    def self.Some(value) # rubocop:disable Naming/MethodName
+      SomeClass.new(value)
+    end
+
+    # The `None` instance is a singleton.
+    None = NoneClass.new.freeze
+
+    # Checks if a given value is an `Option`.
+    def self.option?(value)
+      value.is_a?(Base)
+    end
+  end
+end

data/lib/iron_oxide/result.rb

@@ -0,0 +1,195 @@
+# frozen_string_literal: true
+
+module IronOxide
+  module Result
+    class Base
+      attr_reader :value
+
+      def initialize(value)
+        @value = value
+      end
+
+      # Compares the current result with another result.
+      def ==(other)
+        Result.result?(other) &&
+          ((err? && other.err?) || (ok? && other.ok? && value == other.value))
+      end
+
+      # Checks if the result is of type `Ok`.
+      def ok?
+        instance_of?(OkClass)
+      end
+
+      # Checks if the result is of type `Err`.
+      def err?
+        instance_of?(ErrClass)
+      end
+
+      # Checks if the result is `Ok` and the provided block evaluates to `true`.
+      def ok_and?
+        ok? && yield(value)
+      end
+
+      # Checks if the result is `Err` and the provided block evaluates
+      # to `true`.
+      def err_and?
+        err? && yield(value)
+      end
+
+      # Converts an `Ok` result into an `Option::Some` or
+      # returns `Option::None`.
+      def ok
+        ok? ? Option::Some(value) : Option::None
+      end
+
+      # Converts an `Err` result into an `Option::Some` or
+      # returns `Option::None`.
+      def err
+        err? ? Option::Some(value) : Option::None
+      end
+
+      # Maps the value of an `Ok` result using the provided block; otherwise,
+      # returns itself.
+      def map
+        ok? ? Result::Ok(yield(value)) : self
+      end
+
+      # Maps the value of an `Ok` result or returns a default value.
+      def map_or(default)
+        ok? ? yield(value) : default
+      end
+
+      # Wraps the `Err` into another error `Err` using the provided block;
+      # otherwise, returns itself.
+      def map_err
+        err? ? Result::Err(yield(value)) : self
+      end
+
+      # Unwraps the value if the result is `Ok`, raising an error otherwise.
+      def expect(message)
+        ok? ? value : raise(ExpectError, message)
+      end
+
+      # Unwraps the value if the result is `Ok`, raising an error otherwise.
+      def unwrap
+        ok? ? value : raise(ExpectError, "error unwrapping Err")
+      end
+
+      # Unwraps the value if the result is `Ok`, or returns the default value
+      # otherwise.
+      def unwrap_or(default)
+        ok? ? value : default
+      end
+
+      # Unwraps the value if the result is `Ok`, or computes a value using the
+      # provided block.
+      def unwrap_or_else
+        ok? ? value : yield
+      end
+
+      # Unwraps the error value if the result is `Err`, raising an error
+      # otherwise.
+      def expect_err
+        raise(ExpectError, "expected Err; got Ok<#{value.inspect}>") unless err?
+
+        value
+      end
+      alias unwrap_err expect_err
+
+      # Combines this result with another, returning the second result if both
+      # are `Ok`.
+      def and(other)
+        unless other.is_a?(Result::Base)
+          raise TypeError,
+                "expected Result; got #{other.class.name}"
+        end
+
+        other_ok = other.instance_of?(Result::OkClass)
+
+        return other.value if ok? && other_ok
+        return self if err? && other_ok
+
+        other
+      end
+
+      # Combines this result with another, transforming the value of `Ok` using
+      # the provided block.
+      def and_then
+        return self if err?
+
+        Result::Ok(yield(value))
+      end
+
+      # Combines this result with another, returning the first `Ok` encountered.
+      def or(other)
+        unless other.is_a?(Result::Base)
+          raise TypeError, "expected Result; got #{other.class.name}"
+        end
+
+        return self if ok?
+        return other if other.ok?
+
+        err? ? self : other
+      end
+
+      # Combines this result with another, transforming the error value using
+      # the provided block.
+      def or_else
+        return self if ok?
+
+        yield(value).tap do |other|
+          unless Result.result?(other)
+            raise TypeError, "expected Result; got #{other.class.name}"
+          end
+        end
+      end
+
+      # Converts a result of an `Option` into an `Option` of a result.
+      def transpose
+        if ok? && !Option.option?(value)
+          raise TypeError,
+                "expected value to be Option; got #{value.class.name}"
+        end
+
+        return Option::Some(Result::Ok(value.value)) if ok? && value.some?
+        return Option::None if ok? && value.none?
+
+        Option::Some(self)
+      end
+
+      # Flattens a nested result if the value of `Ok` is another result.
+      def flatten
+        if ok? && !Result.result?(value)
+          raise TypeError,
+                "expected value to be Result; got #{value.class.name}"
+        end
+
+        return Result::Ok(value.value) if ok? && value.ok?
+        return value if ok? && value.err?
+
+        self
+      end
+    end
+
+    class OkClass < Base
+    end
+
+    class ErrClass < Base
+    end
+
+    # Factory method to create a new `Ok` result.
+    def self.Ok(value) # rubocop:disable Naming/MethodName
+      OkClass.new(value)
+    end
+
+    # Factory method to create a new `Err` result.
+    def self.Err(error) # rubocop:disable Naming/MethodName
+      ErrClass.new(error)
+    end
+
+    # Checks if a value is a result.
+    def self.result?(value)
+      value.is_a?(Base)
+    end
+  end
+end

data/lib/iron_oxide/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module IronOxide
+  VERSION = "0.0.1"
+end

data/lib/iron_oxide.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module IronOxide
+  ExpectError = Class.new(StandardError)
+
+  require "iron_oxide/version"
+  require "iron_oxide/option"
+  require "iron_oxide/result"
+  require "iron_oxide/aliases"
+end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: iron_oxide
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nando Vieira
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-11-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-utils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-meta
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-fnando
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: An experiment that brings some Rust patterns to Ruby.
+email:
+- me@fnando.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/CODEOWNERS"
+- ".github/FUNDING.yml"
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/config.yml"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/PULL_REQUEST_TEMPLATE.md"
+- ".github/dependabot.yml"
+- ".github/workflows/ruby-tests.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- iron_oxide.gemspec
+- lib/iron_oxide.rb
+- lib/iron_oxide/aliases.rb
+- lib/iron_oxide/option.rb
+- lib/iron_oxide/result.rb
+- lib/iron_oxide/version.rb
+homepage: https://github.com/fnando/iron_oxide
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+  homepage_uri: https://github.com/fnando/iron_oxide
+  bug_tracker_uri: https://github.com/fnando/iron_oxide/issues
+  source_code_uri: https://github.com/fnando/iron_oxide/tree/v0.0.1
+  changelog_uri: https://github.com/fnando/iron_oxide/tree/v0.0.1/CHANGELOG.md
+  documentation_uri: https://github.com/fnando/iron_oxide/tree/v0.0.1/README.md
+  license_uri: https://github.com/fnando/iron_oxide/tree/v0.0.1/LICENSE.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: An experiment that brings some Rust patterns to Ruby.
+test_files: []