sorbet-result 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7ccd5a2608d32086b0266b9fe940859619017347dc299d05bb49378c621e804e
+  data.tar.gz: 8fb081fd6236e7670de6e43e9703d4c37c6b64919710e80af9950de1233f2b17
+SHA512:
+  metadata.gz: 88e927e89b348ee44075411233d0d97c551b3be5cb37654189c838332803559aecf030d8780e2b668834bdec133154538b7fb7e92694c58d0ef05722cf4e7532
+  data.tar.gz: 2fbaa5dba370f482ad70fe051ed75791b37478d446a225bb9af0f2eed51dcca9bd1b83e977e4e5826be827d5f75f64a9a3a708ee05e7de6dcc18ccc43be75354

data/.rubocop.yml

@@ -0,0 +1,28 @@
+inherit_mode:
+  merge:
+    - Exclude
+
+require:
+  - rubocop-minitest
+  - rubocop-rake
+  - rubocop-sorbet
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.7
+  Exclude:
+    - sorbet/**/*.rbi
+
+Style/AccessorGrouping:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/.ruby-version

@@ -0,0 +1 @@
+3.2.2

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.2.2

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2023-04-17
+
+### Added
+
+- `T::Result`, `T::Success` and `T::Failure` types.
+- Basic documentation.

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 maxveldink@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/Gemfile

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in activerecord-ejection_seat.gemspec
+gemspec
+
+group :development do
+  gem "rake"
+  gem "rubocop"
+  gem "rubocop-minitest"
+  gem "rubocop-rake"
+  gem "rubocop-sorbet"
+  gem "sorbet"
+  gem "spoom"
+  gem "tapioca", require: false
+end
+
+group :development, :test do
+  gem "minitest"
+  gem "sorbet-runtime"
+
+  gem "debug"
+end

data/Gemfile.lock

@@ -0,0 +1,104 @@
+PATH
+  remote: .
+  specs:
+    sorbet-result (0.1.0)
+      sorbet-runtime
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    debug (1.7.2)
+      irb (>= 1.5.0)
+      reline (>= 0.3.1)
+    diff-lcs (1.5.0)
+    io-console (0.6.0)
+    irb (1.6.4)
+      reline (>= 0.3.0)
+    json (2.6.3)
+    minitest (5.18.0)
+    netrc (0.11.0)
+    parallel (1.22.1)
+    parser (3.2.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rbi (0.0.16)
+      ast
+      parser (>= 2.6.4.0)
+      sorbet-runtime (>= 0.5.9204)
+      unparser
+    regexp_parser (2.7.0)
+    reline (0.3.3)
+      io-console (~> 0.5)
+    rexml (3.2.5)
+    rubocop (1.50.2)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.0)
+      parser (>= 3.2.1.0)
+    rubocop-minitest (0.30.0)
+      rubocop (>= 1.39, < 2.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-sorbet (0.7.0)
+      rubocop (>= 0.90.0)
+    ruby-progressbar (1.13.0)
+    sorbet (0.5.10782)
+      sorbet-static (= 0.5.10782)
+    sorbet-runtime (0.5.10782)
+    sorbet-static (0.5.10782-universal-darwin-22)
+    sorbet-static (0.5.10782-x86_64-linux)
+    sorbet-static-and-runtime (0.5.10782)
+      sorbet (= 0.5.10782)
+      sorbet-runtime (= 0.5.10782)
+    spoom (1.2.1)
+      sorbet (>= 0.5.10187)
+      sorbet-runtime (>= 0.5.9204)
+      thor (>= 0.19.2)
+    tapioca (0.11.5)
+      bundler (>= 2.2.25)
+      netrc (>= 0.11.0)
+      parallel (>= 1.21.0)
+      rbi (~> 0.0.0, >= 0.0.16)
+      sorbet-static-and-runtime (>= 0.5.10187)
+      spoom (~> 1.2.0, >= 1.2.0)
+      thor (>= 1.2.0)
+      yard-sorbet
+    thor (1.2.1)
+    unicode-display_width (2.4.2)
+    unparser (0.6.7)
+      diff-lcs (~> 1.3)
+      parser (>= 3.2.0)
+    yard (0.9.34)
+    yard-sorbet (0.8.1)
+      sorbet-runtime (>= 0.5)
+      yard (>= 0.9)
+
+PLATFORMS
+  arm64-darwin-22
+  x86_64-linux
+
+DEPENDENCIES
+  debug
+  minitest
+  rake
+  rubocop
+  rubocop-minitest
+  rubocop-rake
+  rubocop-sorbet
+  sorbet
+  sorbet-result!
+  sorbet-runtime
+  spoom
+  tapioca
+
+BUNDLED WITH
+   2.4.12

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Max VelDink
+
+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,139 @@
+# T::Result, T::Success and T::Failure
+
+A simple, strongly-typed monad for modeling results, helping you implement [Railway Oriented Programming concepts](https://blog.logrocket.com/what-is-railway-oriented-programming/) in Ruby. Helps alleviate error-driven development, all the while boosting your confidence with Sorbet static checks.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add sorbet-result
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install sorbet-result
+
+## Usage
+
+Using a basic Result in your methods is as simple as indicating something could return a `T::Result`.
+
+```ruby
+sig { params(resource_id: Integer).returns(T::Result) }
+def call_api(resource_id)
+  # something bad happened
+  return T::Failure.new
+
+  # something other bad thing happened
+  return T::Failure.new
+
+  # Success!
+  T::Success.new
+end
+```
+
+Generally, it's nice to have a payload with results, and it's nice to have more information on failures. We can indicate what types these are in our signatures for better static checks. Note that payloads and errors can be _any_ type.
+
+```ruby
+sig { params(resource_id: Integer).returns(T::Result[Float, String]) }
+def call_api(resource_id)
+  # something bad happened
+  return T::Failure.new(error: "I couldn't do it!")
+
+  # something other bad thing happened
+  return T::Failure.new(error: "I couldn't do it for another reason!")
+
+  # Success!
+  T::Success.new(payload: 1.12)
+end
+```
+
+*Note:* We use Sorbet's generics for payload and error typing. The generic payload and error types are erased at runtime, so you won't get a type error at runtime if you violate the generic types. These types will help you statically so be sure to run `srb tc` on your project.
+
+Further, if another part of your program needs the Result, it can depend on _only_ `T::Success`es (or `T::Failure`s if you're doing something with those results).
+
+```ruby
+sig { params(success_result: T::Success).void }
+def do_something_with_resource(success_result)
+  ...
+end
+```
+
+Finally, there are a few methods you can use on both `T::Result` types.
+
+```ruby
+result = call_api(1)
+
+result.success? # => true if success, false if failure
+result.failure? # => true if failure, false if success
+
+result.error # => nil on success, nil or error type on failure
+
+result.payload # => nil on failure, nil or payload type on failure
+
+result.payload! # => payload type or raises NilPayloadError on success, raises NoPayloadOnFailureError on failure
+```
+
+The `payload!` method is useful if you don't want to do a `T.must` escape hatch, since the payload _could_ always be `nil`. If you're writing Railway inspired code, you should do the `success?` check before calling `payload!` and know that you've returned a payload on the Result.
+
+### Why use Results?
+
+Let's say you're working on a method that reaches out to an API and fetches a resource. We hope to get a successful response and continue on in our program, but you can imagine several scenarios where we don't get that response: our authentication could fail, the server could return a 5XX response code, or the resource we were querying could have moved or not exist any more.
+
+You might be tempted to use exceptions to model these "off-ramps" from the method.
+
+```ruby
+sig { params(resource_id: Integer).returns(Float) }
+def call_api(resource_id)
+  # something bad happened
+  raise ArgumentError
+
+  # something other bad thing happened
+  raise StandardError
+
+  # Success!
+  1.12
+end
+```
+
+This has several downsides; primarily, this required your caller to _know_ what exceptions to watch out for, or risk bubbling the error all the way out of your program when you could have recovered from it. Our Sorbet signature also becomes less helpful, as we can't indicate what errors could be raised here.
+
+Railway Oriented Programming, which comes from the functional programming community, alleviates this by _expecting_ the failure states and making them a part of the normal flow of a method. Most errors are recoverable; at the very least we can message them back to the user in some way. We should inform the caller with a Result that could be either a Success or Failure, and allow them continue or take an "off-ramp" with a failure message. If we embrace this style of programming, our `call_api` method turns into this:
+
+```ruby
+sig { params(resource_id: Integer).returns(T::Result[Float, String]) }
+def call_api(resource_id)
+  # something bad happened
+  return T::Failure.new(error: "I couldn't do it!")
+
+  # something other bad thing happened
+  return T::Failure.new(error: "I couldn't do it for another reason!")
+
+  # Success!
+  T::Success.new(payload: 1.12)
+end
+```
+
+Sorbet is useful here now, as it the signature covers all possible return values and informs the caller what it should do: check the result status first, then do something with the error or payload. Statically, Sorbet will also know the types associated with our Result for better typechecking across the codebase.
+
+Our caller doesn't need to guess which errors to rescue from (or doesn't need to be paranoid about rescuing all errors) and can proceed in both a success and a failure case.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake` to run Rubocop and 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`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/maxveldink/sorbet-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/maxveldink/sorbet-result/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in this project's codebase, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/maxveldink/sorbet-result/blob/master/CODE_OF_CONDUCT.md).
+
+## Sponsorships
+
+I love creating in the open. If you find this or any other [maxveld.ink](https://maxveld.ink) content useful, please consider sponsoring me on [GitHub](https://github.com/sponsors/maxveldink).

data/Rakefile

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create do |t|
+  t.test_globs = ["test/**/*_test.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+desc "Run tapioca compilers"
+task :tapioca do
+  sh "bin/tapioca gem"
+end
+
+desc "Run Sorbet typechecker"
+task :sorbet do
+  sh "bundle exec srb tc"
+end
+
+task default: %i[rubocop:autocorrect_all sorbet test]

data/lib/sorbet-result.rb

@@ -0,0 +1,11 @@
+# rubocop:disable Naming/FileName
+# rubocop:enable Naming/FileName
+# typed: strict
+# frozen_string_literal: true
+
+require "sorbet-runtime"
+require "t/result"
+require "t/nil_payload_error"
+require "t/success"
+require "t/no_payload_on_failure_error"
+require "t/failure"

data/lib/t/failure.rb

@@ -0,0 +1,43 @@
+# typed: strict
+# frozen_string_literal: true
+
+module T
+  # Represents a failed result. Contains error information but no payload.
+  class Failure
+    extend Sig
+    extend Generic
+
+    include Result
+
+    Payload = type_member
+    Error = type_member
+
+    sig { override.returns(T.nilable(Error)) }
+    attr_reader :error
+
+    sig { params(error: T.nilable(Error)).void }
+    def initialize(error: nil)
+      @error = error
+    end
+
+    sig { override.returns(Boolean) }
+    def success?
+      false
+    end
+
+    sig { override.returns(Boolean) }
+    def failure?
+      true
+    end
+
+    sig { override.returns(T.nilable(Payload)) }
+    def payload
+      nil
+    end
+
+    sig { override.returns(Payload) }
+    def payload!
+      raise NoPayloadOnFailureError
+    end
+  end
+end

data/lib/t/nil_payload_error.rb

@@ -0,0 +1,14 @@
+# typed: strict
+# frozen_string_literal: true
+
+module T
+  # Error when user attempts to unwrap payload for Success Result without payload.
+  class NilPayloadError < StandardError
+    extend Sig
+
+    sig { void }
+    def initialize
+      super("Attempted to unwrap payload from a Success Result where payload is nil. If you need to return a value, make sure the Result is initialized with a payload.") # rubocop:disable Layout/LineLength
+    end
+  end
+end

data/lib/t/no_payload_on_failure_error.rb

@@ -0,0 +1,14 @@
+# typed: strict
+# frozen_string_literal: true
+
+module T
+  # Error when user attempts to access payload from a Failure Result.
+  class NoPayloadOnFailureError < StandardError
+    extend Sig
+
+    sig { void }
+    def initialize
+      super("Attempted to access a payload from a Failure Result. You were probably expecting a Success Result. Check the result with #success? or #failure? before attempting to access the payload.") # rubocop:disable Layout/LineLength
+    end
+  end
+end

data/lib/t/result.rb

@@ -0,0 +1,31 @@
+# typed: strict
+# frozen_string_literal: true
+
+module T
+  # A monad representing either a success or a failure. Contains payload and error information as well.
+  module Result
+    extend Sig
+    extend Helpers
+    extend Generic
+
+    interface!
+
+    Payload = type_member
+    Error = type_member
+
+    sig { abstract.returns(Boolean) }
+    def success?; end
+
+    sig { abstract.returns(Boolean) }
+    def failure?; end
+
+    sig { abstract.returns(T.nilable(Payload)) }
+    def payload; end
+
+    sig { abstract.returns(T.nilable(Error)) }
+    def error; end
+
+    sig { abstract.returns(Payload) }
+    def payload!; end
+  end
+end

data/lib/t/success.rb

@@ -0,0 +1,48 @@
+# typed: strict
+# frozen_string_literal: true
+
+module T
+  # Represents a successful result. Contains a payload and no error information.
+  class Success
+    extend Sig
+    extend Generic
+
+    include Result
+
+    Payload = type_member
+    Error = type_member
+
+    sig { override.returns(T.nilable(Payload)) }
+    attr_reader :payload
+
+    sig { params(payload: T.nilable(Payload)).void }
+    def initialize(payload: nil)
+      @payload = payload
+    end
+
+    sig { override.returns(Boolean) }
+    def success?
+      true
+    end
+
+    sig { override.returns(Boolean) }
+    def failure?
+      false
+    end
+
+    sig { override.returns(NilClass) }
+    def error
+      nil
+    end
+
+    sig { override.returns(Payload) }
+    def payload!
+      case @payload
+      when nil
+        raise NilPayloadError
+      else
+        @payload
+      end
+    end
+  end
+end

data/sorbet/config

@@ -0,0 +1,4 @@
+--dir
+.
+--ignore=tmp/
+--ignore=vendor/