sorbet-result 1.1.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94d11199cfc745364d1c1163b60f8a1602699f136f5c6522dfa7a81f64d6f8b1
-  data.tar.gz: b867a4439f5a0e5f8335848c42599563149b950a42e54495cbbe1c38b8d4c60d
+  metadata.gz: 9283d02fabd31c86d614eae2c2cb72aa87f38a4769acff196ac0021460282307
+  data.tar.gz: 74b5fba1a9296cfad0fadae13a7df80e23f45e4ef766a172abdde9ff97e4932f
 SHA512:
-  metadata.gz: 73a6915ad1ca43e1bc729f4be2d0b7bec3c5dcacce072e96074b0d8ce98b9033ffcbdc254b743e10e5156bac08d418d912f45ea50f83c571774c3419f449f6e9
-  data.tar.gz: 18d8c8f3921cb4d60fde19d8270281f67de8d39aecb57830b8eb6c79e96fdfe5ac18b3ca056e7c265ede393ba91e180d078b9b0aa9396ff4a92f917b26d8819f
+  metadata.gz: 4c59bda910e9a16117f9573426d9fd4a6edd0fc75f03918d3540445d035e9ef6e240a08acfba34c9ba9c25565f9f1287d959af22977b8c8f665cc938b06e116e
+  data.tar.gz: 67ffd89d399ef5b79b2b1752de24fc92d03aaa47f7a455fc40945e11e2f34def317197241f95d1828723059226c7ff630d8a7b69d52b4eb7d0882c06b8f476d1

data/.ruby-version

@@ -1 +1 @@
-3.3.0
+3.1.4

data/.standard.yml

@@ -1,5 +1,5 @@
 parallel: true
-ruby_version: 3.0
+ruby_version: 3.1
 ignore:
   - 'vendor/**/*'
 plugins:

data/CHANGELOG.md

@@ -6,6 +6,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.3.0] - 2025-06-29
+
+### Added
+
+- Added error details to `Typed::NoPayloadOnFailureError` error message
+
+## [1.2.0] - 2024-11-03
+
+### Added
+
+- Add `Typed::Success(payload)` and `Typed::Failure(error)` convenience method (no more `.new`-ing!)
+- Add `Typed::Success#==` and `Typed::Failure#==` implementations
+
+### Removed
+
+- **POTENTIALLY BREAKING** Remove support for Ruby < 3.1.
+
 ## [1.1.0] - 2024-02-21
 
 ### Added

data/Gemfile

@@ -2,7 +2,7 @@
 
 source "https://rubygems.org"
 
-# Specify your gem's dependencies in activerecord-ejection_seat.gemspec
+# Specify your gem's dependencies in sorbet-result.gemspec
 gemspec
 
 group :development do

data/Gemfile.lock

@@ -1,111 +1,128 @@
 PATH
   remote: .
   specs:
-    sorbet-result (1.1.0)
+    sorbet-result (1.3.0)
       sorbet-runtime (~> 0.5)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.2)
-    debug (1.9.1)
+    ast (2.4.3)
+    benchmark (0.4.1)
+    cgi (0.5.0)
+    date (3.4.1)
+    debug (1.11.0)
       irb (~> 1.10)
       reline (>= 0.3.8)
-    erubi (1.12.0)
-    io-console (0.7.2)
-    irb (1.11.2)
-      rdoc
+    erb (4.0.4)
+      cgi (>= 0.3.3)
+    erubi (1.13.1)
+    io-console (0.8.0)
+    irb (1.15.2)
+      pp (>= 0.6.0)
+      rdoc (>= 4.0.0)
       reline (>= 0.4.2)
-    json (2.7.1)
-    language_server-protocol (3.17.0.3)
+    json (2.12.2)
+    language_server-protocol (3.17.0.5)
     lint_roller (1.1.0)
-    minitest (5.22.2)
+    logger (1.7.0)
+    minitest (5.25.5)
     netrc (0.11.0)
-    parallel (1.24.0)
-    parser (3.3.0.5)
+    parallel (1.27.0)
+    parser (3.3.8.0)
       ast (~> 2.4.1)
       racc
-    prettier_print (1.2.1)
-    prism (0.24.0)
-    psych (5.1.2)
+    pp (0.6.2)
+      prettyprint
+    prettyprint (0.2.0)
+    prism (1.4.0)
+    psych (5.2.6)
+      date
       stringio
-    racc (1.7.3)
+    racc (1.8.1)
     rainbow (3.1.1)
-    rake (13.1.0)
-    rbi (0.1.9)
-      prism (>= 0.18.0, < 0.25)
-      sorbet-runtime (>= 0.5.9204)
-    rdoc (6.6.2)
+    rake (13.3.0)
+    rbi (0.3.6)
+      prism (~> 1.0)
+      rbs (>= 3.4.4)
+    rbs (3.9.4)
+      logger
+    rdoc (6.14.1)
+      erb
       psych (>= 4.0.0)
-    regexp_parser (2.9.0)
-    reline (0.4.2)
+    regexp_parser (2.10.0)
+    reline (0.6.1)
       io-console (~> 0.5)
-    rexml (3.2.6)
-    rubocop (1.60.2)
+    rubocop (1.75.8)
       json (~> 2.3)
-      language_server-protocol (>= 3.17.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
       parallel (~> 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.30.0, < 2.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.44.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.30.0)
-      parser (>= 3.2.1.0)
-    rubocop-performance (1.20.2)
-      rubocop (>= 1.48.1, < 2.0)
-      rubocop-ast (>= 1.30.0, < 2.0)
-    rubocop-sorbet (0.7.7)
-      rubocop (>= 0.90.0)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.45.1)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    rubocop-performance (1.25.0)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.75.0, < 2.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
+    rubocop-sorbet (0.9.0)
+      lint_roller (~> 1.1)
+      rubocop (>= 1)
     ruby-progressbar (1.13.0)
-    sorbet (0.5.11262)
-      sorbet-static (= 0.5.11262)
-    sorbet-runtime (0.5.11262)
-    sorbet-static (0.5.11262-universal-darwin)
-    sorbet-static (0.5.11262-x86_64-linux)
-    sorbet-static-and-runtime (0.5.11262)
-      sorbet (= 0.5.11262)
-      sorbet-runtime (= 0.5.11262)
-    spoom (1.2.4)
+    sorbet (0.5.12210)
+      sorbet-static (= 0.5.12210)
+    sorbet-runtime (0.5.12210)
+    sorbet-static (0.5.12210-universal-darwin)
+    sorbet-static (0.5.12210-x86_64-linux)
+    sorbet-static-and-runtime (0.5.12210)
+      sorbet (= 0.5.12210)
+      sorbet-runtime (= 0.5.12210)
+    spoom (1.6.1)
       erubi (>= 1.10.0)
+      prism (>= 0.28.0)
+      rbi (>= 0.2.3)
       sorbet-static-and-runtime (>= 0.5.10187)
-      syntax_tree (>= 6.1.1)
       thor (>= 0.19.2)
-    standard (1.34.0)
+    standard (1.50.0)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.0)
-      rubocop (~> 1.60)
+      rubocop (~> 1.75.5)
       standard-custom (~> 1.0.0)
-      standard-performance (~> 1.3)
+      standard-performance (~> 1.8)
     standard-custom (1.0.2)
       lint_roller (~> 1.0)
       rubocop (~> 1.50)
-    standard-performance (1.3.1)
+    standard-performance (1.8.0)
       lint_roller (~> 1.1)
-      rubocop-performance (~> 1.20.2)
-    standard-sorbet (0.0.2)
+      rubocop-performance (~> 1.25.0)
+    standard-sorbet (0.0.3)
       lint_roller (~> 1.1)
-      rubocop-sorbet (~> 0.7.0)
-    stringio (3.1.0)
-    syntax_tree (6.2.0)
-      prettier_print (>= 1.2.0)
-    tapioca (0.12.0)
+      rubocop-sorbet (~> 0.9.0)
+    stringio (3.1.7)
+    tapioca (0.16.11)
+      benchmark
       bundler (>= 2.2.25)
       netrc (>= 0.11.0)
       parallel (>= 1.21.0)
-      rbi (>= 0.1.4, < 0.2)
-      sorbet-static-and-runtime (>= 0.5.10820)
-      spoom (~> 1.2.0, >= 1.2.0)
+      rbi (~> 0.2)
+      sorbet-static-and-runtime (>= 0.5.11087)
+      spoom (>= 1.2.0)
       thor (>= 1.2.0)
       yard-sorbet
-    thor (1.3.0)
-    unicode-display_width (2.5.0)
-    yard (0.9.34)
-    yard-sorbet (0.8.1)
-      sorbet-runtime (>= 0.5)
-      yard (>= 0.9)
+    thor (1.3.2)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
+    yard (0.9.37)
+    yard-sorbet (0.9.0)
+      sorbet-runtime
+      yard
 
 PLATFORMS
   arm64-darwin-22
@@ -125,4 +142,4 @@ DEPENDENCIES
   tapioca
 
 BUNDLED WITH
-   2.4.12
+   2.4.22

data/README.md

@@ -78,8 +78,8 @@ result = call_api(1)
 
 result.success? # => true on success, false on failure
 result.failure? # => true on failure, false on success
-result.payload # => nil on failure, payload type on failure
-result.error # => nil on success, error type on failure
+result.payload # => raises error on failure, payload type on success
+result.error # => raises error on success, error type on failure
 result.payload_or("fallback") # => returns payload on success, given value on failure
 
 # You can combine all the above to write flow-sensitive type-checked code
@@ -98,7 +98,7 @@ To do so, use the `#and_then` method to transform the payload of a `Typed::Succe
 
 ```ruby
 # In this example, retrieve_user and send_notification both return a Typed::Result
-#  retrieve_user: Typed::Result[User, RetrieveUserError
+#  retrieve_user: Typed::Result[User, RetrieveUserError]
 #  send_notification: Typed::Result[T::Boolean, SendNotificationError]
 res = retrieve_user(user_id)
   .and_then { |user| send_notification(user.email) } # this block will only run if retrieve_user returns a Typed::Success
@@ -134,7 +134,7 @@ We ship with a few Minitest assertions that can be used to easily verify Results
 ```ruby
 # test_helper.rb
 
-require "minitest/results_assertions"
+require "minitest/result_assertions"
 # You also need add this to `sorbet/tapioca/require.rb` and rebuild the Minitest gem RBIs
 
 # *_test.rb

data/lib/typed/no_payload_on_failure_error.rb

@@ -6,9 +6,14 @@ module Typed
   class NoPayloadOnFailureError < StandardError
     extend T::Sig
 
-    sig { void }
-    def initialize
-      super("Attempted to access `payload` from a Failure Result. You were probably expecting a Success Result. Check the result with `#success?` or `#failure?` before attempting to access `payload`.") # rubocop:disable Layout/LineLength
+    sig { params(failure: Failure[T.untyped]).void }
+    def initialize(failure)
+      super(
+        "Attempted to access `payload` from a Failure Result. " \
+        "You were probably expecting a Success Result. " \
+        "Check the result with `#success?` or `#failure?` before attempting to access `payload`. " \
+        "Error encountered: #{failure.error.inspect}"
+      )
     end
   end
 end

data/lib/typed/result.rb

@@ -5,6 +5,8 @@ require_relative "no_error_on_success_error"
 require_relative "no_payload_on_failure_error"
 
 module Typed
+  extend T::Sig
+
   # A monad representing either a success or a failure. Contains payload and error information as well.
   class Result
     extend T::Sig
@@ -76,7 +78,7 @@ module Typed
         .returns(Typed::Success[T.type_parameter(:T)])
     end
     def self.new(payload)
-      super(payload)
+      super
     end
 
     sig { returns(Typed::Success[NilClass]) }
@@ -133,6 +135,29 @@ module Typed
     def payload_or(_value)
       payload
     end
+
+    sig { params(other: T.untyped).returns(T::Boolean) }
+    def ==(other)
+      other.is_a?(Success) && other.payload == payload
+    end
+  end
+
+  sig do
+    type_parameters(:T)
+      .params(payload: T.type_parameter(:T))
+      .returns(Typed::Success[T.type_parameter(:T)])
+  end
+  def self.Success(payload)
+    Success.new(payload)
+  end
+
+  sig do
+    type_parameters(:T)
+      .params(error: T.type_parameter(:T))
+      .returns(Typed::Failure[T.type_parameter(:T)])
+  end
+  def self.Failure(error)
+    Failure.new(error)
   end
 
   class Failure < Result
@@ -151,7 +176,7 @@ module Typed
         .returns(Typed::Failure[T.type_parameter(:T)])
     end
     def self.new(error)
-      super(error)
+      super
     end
 
     sig { returns(Typed::Failure[NilClass]) }
@@ -177,7 +202,7 @@ module Typed
 
     sig { override.returns(T.noreturn) }
     def payload
-      raise NoPayloadOnFailureError
+      raise NoPayloadOnFailureError.new(self)
     end
 
     sig do
@@ -209,5 +234,10 @@ module Typed
     def payload_or(value)
       value
     end
+
+    sig { params(other: T.untyped).returns(T::Boolean) }
+    def ==(other)
+      other.is_a?(Failure) && other.error == error
+    end
   end
 end

data/sorbet/rbi/gems/{ast@2.4.2.rbi → ast@2.4.3.rbi}

@@ -4,6 +4,7 @@
 # This is an autogenerated file for types exported from the `ast` gem.
 # Please instead update this file by running `bin/tapioca gem ast`.
 
+
 # {AST} is a library for manipulating abstract syntax trees.
 #
 # It embraces immutability; each AST node is inherently frozen at
@@ -159,7 +160,7 @@ class AST::Node
 
   # Returns the precomputed hash value for this node
   #
-  # @return [Fixnum]
+  # @return [Integer]
   #
   # source://ast//lib/ast/node.rb#61
   def hash; end
@@ -556,8 +557,8 @@ end
 # to define deeply nested ASTs from Ruby code, for example, in
 # tests. It should be used like this:
 #
-#     describe YourLanguage::AST do
-#       include Sexp
+#     describe YourLanguage do
+#       include ::AST::Sexp
 #
 #       it "should correctly parse expressions" do
 #         YourLanguage.parse("1 + 2 * 3").should ==