sorbet-result 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94d11199cfc745364d1c1163b60f8a1602699f136f5c6522dfa7a81f64d6f8b1
-  data.tar.gz: b867a4439f5a0e5f8335848c42599563149b950a42e54495cbbe1c38b8d4c60d
+  metadata.gz: 62795733b699fe9adec850e9584a6c45c47e6fa00daa93cb93221a43ca16b131
+  data.tar.gz: 3b0f4ef2e5fc20e61e88724dc6e6637f254f41ec6394b802896f30861c9a40cb
 SHA512:
-  metadata.gz: 73a6915ad1ca43e1bc729f4be2d0b7bec3c5dcacce072e96074b0d8ce98b9033ffcbdc254b743e10e5156bac08d418d912f45ea50f83c571774c3419f449f6e9
-  data.tar.gz: 18d8c8f3921cb4d60fde19d8270281f67de8d39aecb57830b8eb6c79e96fdfe5ac18b3ca056e7c265ede393ba91e180d078b9b0aa9396ff4a92f917b26d8819f
+  metadata.gz: 59395f384a03d978f128695fc2cf9c1b79a34b91e0c0aeae0e995b9a3ecc440901ff599112d14d06cab99a92cd0dd82ff8831d7d852255ae9ed5f872a14cc17f
+  data.tar.gz: d536a970dc7c60490c6a106178c1e32ef61cfb816d46405fb389dd62d43e0f5d8ac1e7b6a7097aa73b225d4752ab702bc75bafe25b3f365ba08f7d67c1137e75

data/.ruby-version

@@ -1 +1 @@
-3.3.0
+3.3.5

data/.standard.yml

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

data/.tool-versions

@@ -1 +1 @@
-ruby 3.3.0
+ruby 3.3.5

data/CHANGELOG.md

@@ -6,6 +6,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [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,106 @@
 PATH
   remote: .
   specs:
-    sorbet-result (1.1.0)
+    sorbet-result (1.2.0)
       sorbet-runtime (~> 0.5)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
-    debug (1.9.1)
+    debug (1.9.2)
       irb (~> 1.10)
       reline (>= 0.3.8)
-    erubi (1.12.0)
+    erubi (1.13.0)
     io-console (0.7.2)
-    irb (1.11.2)
-      rdoc
+    irb (1.14.1)
+      rdoc (>= 4.0.0)
       reline (>= 0.4.2)
-    json (2.7.1)
+    json (2.7.5)
     language_server-protocol (3.17.0.3)
     lint_roller (1.1.0)
-    minitest (5.22.2)
+    minitest (5.25.1)
     netrc (0.11.0)
-    parallel (1.24.0)
-    parser (3.3.0.5)
+    parallel (1.26.3)
+    parser (3.3.5.1)
       ast (~> 2.4.1)
       racc
-    prettier_print (1.2.1)
-    prism (0.24.0)
+    prism (1.2.0)
     psych (5.1.2)
       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)
+    rake (13.2.1)
+    rbi (0.2.1)
+      prism (~> 1.0)
       sorbet-runtime (>= 0.5.9204)
-    rdoc (6.6.2)
+    rdoc (6.7.0)
       psych (>= 4.0.0)
-    regexp_parser (2.9.0)
-    reline (0.4.2)
+    regexp_parser (2.9.2)
+    reline (0.5.10)
       io-console (~> 0.5)
-    rexml (3.2.6)
-    rubocop (1.60.2)
+    rubocop (1.66.1)
       json (~> 2.3)
       language_server-protocol (>= 3.17.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.4, < 3.0)
+      rubocop-ast (>= 1.32.2, < 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-ast (1.33.1)
+      parser (>= 3.3.1.0)
+    rubocop-performance (1.22.1)
       rubocop (>= 1.48.1, < 2.0)
-      rubocop-ast (>= 1.30.0, < 2.0)
-    rubocop-sorbet (0.7.7)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    rubocop-sorbet (0.7.8)
       rubocop (>= 0.90.0)
     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.11633)
+      sorbet-static (= 0.5.11633)
+    sorbet-runtime (0.5.11633)
+    sorbet-static (0.5.11633-universal-darwin)
+    sorbet-static (0.5.11633-x86_64-linux)
+    sorbet-static-and-runtime (0.5.11633)
+      sorbet (= 0.5.11633)
+      sorbet-runtime (= 0.5.11633)
+    spoom (1.5.0)
       erubi (>= 1.10.0)
+      prism (>= 0.28.0)
       sorbet-static-and-runtime (>= 0.5.10187)
-      syntax_tree (>= 6.1.1)
       thor (>= 0.19.2)
-    standard (1.34.0)
+    standard (1.41.1)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.0)
-      rubocop (~> 1.60)
+      rubocop (~> 1.66.0)
       standard-custom (~> 1.0.0)
-      standard-performance (~> 1.3)
+      standard-performance (~> 1.5)
     standard-custom (1.0.2)
       lint_roller (~> 1.0)
       rubocop (~> 1.50)
-    standard-performance (1.3.1)
+    standard-performance (1.5.0)
       lint_roller (~> 1.1)
-      rubocop-performance (~> 1.20.2)
+      rubocop-performance (~> 1.22.0)
     standard-sorbet (0.0.2)
       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)
+    stringio (3.1.1)
+    tapioca (0.16.3)
       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 (2.6.0)
+    yard (0.9.37)
+    yard-sorbet (0.9.0)
+      sorbet-runtime
+      yard
 
 PLATFORMS
   arm64-darwin-22
@@ -125,4 +120,4 @@ DEPENDENCIES
   tapioca
 
 BUNDLED WITH
-   2.4.12
+   2.5.18

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
@@ -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/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]) }
@@ -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

@@ -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

data/sorbet/rbi/gems/{erubi@1.12.0.rbi → erubi@1.13.0.rbi}

@@ -4,14 +4,19 @@
 # This is an autogenerated file for types exported from the `erubi` gem.
 # Please instead update this file by running `bin/tapioca gem erubi`.
 
+
 # source://erubi//lib/erubi.rb#3
 module Erubi
+  private
+
+  def h(_arg0); end
+
   class << self
     def h(_arg0); end
   end
 end
 
-# source://erubi//lib/erubi.rb#54
+# source://erubi//lib/erubi.rb#51
 class Erubi::Engine
   # Initialize a new Erubi::Engine.  Options:
   # +:bufval+ :: The value to use for the buffer variable, as a string (default <tt>'::String.new'</tt>).
@@ -42,64 +47,64 @@ class Erubi::Engine
   #
   # @return [Engine] a new instance of Engine
   #
-  # source://erubi//lib/erubi.rb#94
+  # source://erubi//lib/erubi.rb#91
   def initialize(input, properties = T.unsafe(nil)); end
 
   # The variable name used for the buffer variable.
   #
-  # source://erubi//lib/erubi.rb#65
+  # source://erubi//lib/erubi.rb#62
   def bufvar; end
 
   # The filename of the template, if one was given.
   #
-  # source://erubi//lib/erubi.rb#62
+  # source://erubi//lib/erubi.rb#59
   def filename; end
 
   # The frozen ruby source code generated from the template, which can be evaled.
   #
-  # source://erubi//lib/erubi.rb#59
+  # source://erubi//lib/erubi.rb#56
   def src; end
 
   private
 
   # Add ruby code to the template
   #
-  # source://erubi//lib/erubi.rb#226
+  # source://erubi//lib/erubi.rb#223
   def add_code(code); end
 
   # Add the given ruby expression result to the template,
   # escaping it based on the indicator given and escape flag.
   #
-  # source://erubi//lib/erubi.rb#235
+  # source://erubi//lib/erubi.rb#232
   def add_expression(indicator, code); end
 
   # Add the result of Ruby expression to the template
   #
-  # source://erubi//lib/erubi.rb#244
+  # source://erubi//lib/erubi.rb#241
   def add_expression_result(code); end
 
   # Add the escaped result of Ruby expression to the template
   #
-  # source://erubi//lib/erubi.rb#249
+  # source://erubi//lib/erubi.rb#246
   def add_expression_result_escaped(code); end
 
   # Add the given postamble to the src.  Can be overridden in subclasses
   # to make additional changes to src that depend on the current state.
   #
-  # source://erubi//lib/erubi.rb#255
+  # source://erubi//lib/erubi.rb#252
   def add_postamble(postamble); end
 
   # Add raw text to the template.  Modifies argument if argument is mutable as a memory optimization.
   # Must be called with a string, cannot be called with nil (Rails's subclass depends on it).
   #
-  # source://erubi//lib/erubi.rb#213
+  # source://erubi//lib/erubi.rb#210
   def add_text(text); end
 
   # Raise an exception, as the base engine class does not support handling other indicators.
   #
   # @raise [ArgumentError]
   #
-  # source://erubi//lib/erubi.rb#261
+  # source://erubi//lib/erubi.rb#258
   def handle(indicator, code, tailch, rspace, lspace); end
 
   # Make sure that any current expression has been terminated.
@@ -107,7 +112,7 @@ class Erubi::Engine
   # the chain_appends option is used, expressions may not be
   # terminated.
   #
-  # source://erubi//lib/erubi.rb#289
+  # source://erubi//lib/erubi.rb#286
   def terminate_expression; end
 
   # Make sure the buffer variable is the target of the next append
@@ -117,13 +122,13 @@ class Erubi::Engine
   # This method should only be called if the block will result in
   # code where << will append to the bufvar.
   #
-  # source://erubi//lib/erubi.rb#271
+  # source://erubi//lib/erubi.rb#268
   def with_buffer; end
 end
 
 # The default regular expression used for scanning.
 #
-# source://erubi//lib/erubi.rb#56
+# source://erubi//lib/erubi.rb#53
 Erubi::Engine::DEFAULT_REGEXP = T.let(T.unsafe(nil), Regexp)
 
 # source://erubi//lib/erubi.rb#17

data/sorbet/rbi/gems/io-console@0.7.2.rbi

@@ -4,5 +4,6 @@
 # This is an autogenerated file for types exported from the `io-console` gem.
 # Please instead update this file by running `bin/tapioca gem io-console`.
 
+
 # THIS IS AN EMPTY RBI FILE.
 # see https://github.com/Shopify/tapioca#manually-requiring-parts-of-a-gem