sorbet-result 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cff6b167022f8dd885a13ad6340e5c406790578043fb6ba236c26d9bec5497ec
-  data.tar.gz: 6233fa6e5ab9b956c7bc2f57ccc11bed9c594eb01fb69dba9ce6816906968efe
+  metadata.gz: 445c79091954105691cf4c5d0f0084ca69ea9bee925bd8c87374b1e93d7d9811
+  data.tar.gz: b5e200826decd0aa68b3efe53c39cedfb34b1d3ac8807eff1af7f4ae89c36e8b
 SHA512:
-  metadata.gz: 105c454951452c5102a768d26a99b0b004aa5004d071eb377be2f28117cdf9ad39d6596e2fc98596e936a33d3f180f2753a7734c9e25dde3e5e184aa963f6e3d
-  data.tar.gz: 68146f7dbe9d72b97702d779825750a1e76d23b76ebd30cba6c1f9902fb9efdaab44f86847c126f4f5c54c9eebf1cab21a910f26361981ce3827054da3c56e32
+  metadata.gz: f4a9faca56fe08cc9c8338df268ba3d203ccfcc0ce292a63c7cbdd6e8f1532c86833b56002ef2544659834af6f0b06eb0a799dbc37cadf88a6034ae09a856f6b
+  data.tar.gz: 3fd929e0dc36870f908eb0c2111def18d0dc33dfd90700869cf611ddb362ecb6f0323cb6acdc9d789a07031576851593323eb47ce73bc7a987a2932f82c20010

data/CHANGELOG.md

@@ -4,6 +4,15 @@ 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.2.0] - 2023-04-21
+
+### Changed
+
+- *Breaking* Updated all `T::` modules to `Typed::`. This allows the Sorbet project freedom to explore these constants in the future.
+- Pulled in Zeitwerk for autoloading.
+
 ## [0.1.1] - 2023-04-17
 
 ### Changed

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    sorbet-result (0.1.1)
-      sorbet-runtime
+    sorbet-result (0.2.0)
+      sorbet-runtime (~> 0.5)
+      zeitwerk (~> 2.6)
 
 GEM
   remote: https://rubygems.org/
@@ -18,7 +19,7 @@ GEM
     json (2.6.3)
     minitest (5.18.0)
     netrc (0.11.0)
-    parallel (1.22.1)
+    parallel (1.23.0)
     parser (3.2.2.0)
       ast (~> 2.4.1)
     rainbow (3.1.1)
@@ -51,14 +52,14 @@ GEM
     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)
+    sorbet (0.5.10792)
+      sorbet-static (= 0.5.10792)
+    sorbet-runtime (0.5.10792)
+    sorbet-static (0.5.10792-universal-darwin-22)
+    sorbet-static (0.5.10792-x86_64-linux)
+    sorbet-static-and-runtime (0.5.10792)
+      sorbet (= 0.5.10792)
+      sorbet-runtime (= 0.5.10792)
     spoom (1.2.1)
       sorbet (>= 0.5.10187)
       sorbet-runtime (>= 0.5.9204)
@@ -81,6 +82,7 @@ GEM
     yard-sorbet (0.8.1)
       sorbet-runtime (>= 0.5)
       yard (>= 0.9)
+    zeitwerk (2.6.7)
 
 PLATFORMS
   arm64-darwin-22

data/README.md

@@ -1,4 +1,4 @@
-# T::Result, T::Success and T::Failure
+# Typed::Result, Typed::Success and Typed::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.
 
@@ -14,50 +14,50 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
-Using a basic Result in your methods is as simple as indicating something could return a `T::Result`.
+Using a basic Result in your methods is as simple as indicating something could return a `Typed::Result`.
 
 ```ruby
-sig { params(resource_id: Integer).returns(T::Result) }
+sig { params(resource_id: Integer).returns(Typed::Result) }
 def call_api(resource_id)
   # something bad happened
-  return T::Failure.new
+  return Typed::Failure.new
 
   # something other bad thing happened
-  return T::Failure.new
+  return Typed::Failure.new
 
   # Success!
-  T::Success.new
+  Typed::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]) }
+sig { params(resource_id: Integer).returns(Typed::Result[Float, String]) }
 def call_api(resource_id)
   # something bad happened
-  return T::Failure.new(error: "I couldn't do it!")
+  return Typed::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!")
+  return Typed::Failure.new(error: "I couldn't do it for another reason!")
 
   # Success!
-  T::Success.new(payload: 1.12)
+  Typed::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).
+Further, if another part of your program needs the Result, it can depend on _only_ `Typed::Success`es (or `Typed::Failure`s if you're doing something with those results).
 
 ```ruby
-sig { params(success_result: T::Success).void }
+sig { params(success_result: Typed::Success).void }
 def do_something_with_resource(success_result)
   ...
 end
 ```
 
-Finally, there are a few methods you can use on both `T::Result` types.
+Finally, there are a few methods you can use on both `Typed::Result` types.
 
 ```ruby
 result = call_api(1)
@@ -99,16 +99,16 @@ This has several downsides; primarily, this required your caller to _know_ what
 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]) }
+sig { params(resource_id: Integer).returns(Typed::Result[Float, String]) }
 def call_api(resource_id)
   # something bad happened
-  return T::Failure.new(error: "I couldn't do it!")
+  return Typed::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!")
+  return Typed::Failure.new(error: "I couldn't do it for another reason!")
 
   # Success!
-  T::Success.new(payload: 1.12)
+  Typed::Success.new(payload: 1.12)
 end
 ```
 

data/lib/sorbet-result.rb

@@ -4,8 +4,11 @@
 # 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"
+require "zeitwerk"
+
+# Sorbet-aware namespace to super-charge your projects
+module Typed; end
+
+loader = Zeitwerk::Loader.new
+loader.push_dir("#{__dir__}/typed", namespace: Typed)
+loader.setup

data/lib/{t → typed}/failure.rb

@@ -1,11 +1,11 @@
 # typed: strict
 # frozen_string_literal: true
 
-module T
+module Typed
   # Represents a failed result. Contains error information but no payload.
   class Failure < Result
-    extend Sig
-    extend Generic
+    extend T::Sig
+    extend T::Generic
 
     Payload = type_member
     Error = type_member
@@ -19,12 +19,12 @@ module T
       super()
     end
 
-    sig { override.returns(Boolean) }
+    sig { override.returns(T::Boolean) }
     def success?
       false
     end
 
-    sig { override.returns(Boolean) }
+    sig { override.returns(T::Boolean) }
     def failure?
       true
     end

data/lib/{t → typed}/nil_payload_error.rb

@@ -1,10 +1,10 @@
 # typed: strict
 # frozen_string_literal: true
 
-module T
+module Typed
   # Error when user attempts to unwrap payload for Success Result without payload.
   class NilPayloadError < StandardError
-    extend Sig
+    extend T::Sig
 
     sig { void }
     def initialize

data/lib/{t → typed}/no_payload_on_failure_error.rb

@@ -1,10 +1,10 @@
 # typed: strict
 # frozen_string_literal: true
 
-module T
+module Typed
   # Error when user attempts to access payload from a Failure Result.
   class NoPayloadOnFailureError < StandardError
-    extend Sig
+    extend T::Sig
 
     sig { void }
     def initialize

data/lib/{t → typed}/result.rb

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

data/lib/{t → typed}/success.rb

@@ -1,11 +1,11 @@
 # typed: strict
 # frozen_string_literal: true
 
-module T
+module Typed
   # Represents a successful result. Contains a payload and no error information.
   class Success < Result
-    extend Sig
-    extend Generic
+    extend T::Sig
+    extend T::Generic
 
     Payload = type_member
     Error = type_member
@@ -19,12 +19,12 @@ module T
       super()
     end
 
-    sig { override.returns(Boolean) }
+    sig { override.returns(T::Boolean) }
     def success?
       true
     end
 
-    sig { override.returns(Boolean) }
+    sig { override.returns(T::Boolean) }
     def failure?
       false
     end