sorbet-result 0.3.0 → 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.rubocop.yml +1 -1
- data/CHANGELOG.md +13 -0
- data/Gemfile.lock +17 -15
- data/README.md +16 -2
- data/lib/typed/failure.rb +20 -0
- data/lib/typed/result.rb +15 -0
- data/lib/typed/success.rb +19 -0
- data/sorbet/rbi/gems/{minitest@5.18.0.rbi → minitest@5.18.1.rbi} +134 -134
- data/sorbet/rbi/gems/{parser@3.2.2.1.rbi → parser@3.2.2.3.rbi} +544 -544
- data/sorbet/rbi/gems/racc@1.7.1.rbi +161 -0
- data/sorbet/rbi/gems/{regexp_parser@2.8.0.rbi → regexp_parser@2.8.1.rbi} +33 -32
- data/sorbet/rbi/gems/{rubocop@1.52.0.rbi → rubocop@1.52.1.rbi} +155 -169
- data/sorbet/rbi/gems/{unparser@0.6.7.rbi → unparser@0.6.8.rbi} +19 -18
- metadata +9 -8
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 79770af90bc94993111e0e11b8d4dfcf7660d19e878a1f55642e607fcc6db579
|
4
|
+
data.tar.gz: eb5c66753067b295ed7750aec1a0de64630c9f0fe5d5f5e3f20b5f3d66b33de2
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 75311c18528aa78e426b0f497d4a5d6bb69dc859811b1bfe27201df062422243f2ba091c232141baa13d8a5092e10dc52d11e6e3654b7bc47979e0d88a306e63
|
7
|
+
data.tar.gz: 0e76944518d89dfa80d5025590ccb4c6867977edcf4ae626f155a5b8ce8cc1e52b1a8d61186e9e24c9d0d13af9fca51612374a178ef91ebe6ef672bd9b59efd1
|
data/.rubocop.yml
CHANGED
data/CHANGELOG.md
CHANGED
@@ -6,6 +6,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|
6
6
|
|
7
7
|
## [Unreleased]
|
8
8
|
|
9
|
+
## [1.0.0] - 2023-06-20
|
10
|
+
|
11
|
+
### Removed
|
12
|
+
|
13
|
+
- Remove support for Ruby < 3.0
|
14
|
+
|
15
|
+
## [0.3.1] - 2023-06-20
|
16
|
+
|
17
|
+
### Added
|
18
|
+
|
19
|
+
- Add `#on_error` to `Typed::Result` to allow behavior when an error is encountered during chaining.
|
20
|
+
- Add `#payload_or` to `Typed::Result` to allow callers to specify a default value if `Failure` is returned.
|
21
|
+
|
9
22
|
## [0.3.0] - 2023-06-06
|
10
23
|
|
11
24
|
### Added
|
data/Gemfile.lock
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
PATH
|
2
2
|
remote: .
|
3
3
|
specs:
|
4
|
-
sorbet-result (0.
|
4
|
+
sorbet-result (1.0.0)
|
5
5
|
sorbet-runtime (~> 0.5)
|
6
6
|
zeitwerk (~> 2.6)
|
7
7
|
|
@@ -17,11 +17,13 @@ GEM
|
|
17
17
|
irb (1.7.0)
|
18
18
|
reline (>= 0.3.0)
|
19
19
|
json (2.6.3)
|
20
|
-
minitest (5.18.
|
20
|
+
minitest (5.18.1)
|
21
21
|
netrc (0.11.0)
|
22
22
|
parallel (1.23.0)
|
23
|
-
parser (3.2.2.
|
23
|
+
parser (3.2.2.3)
|
24
24
|
ast (~> 2.4.1)
|
25
|
+
racc
|
26
|
+
racc (1.7.1)
|
25
27
|
rainbow (3.1.1)
|
26
28
|
rake (13.0.6)
|
27
29
|
rbi (0.0.16)
|
@@ -29,14 +31,14 @@ GEM
|
|
29
31
|
parser (>= 2.6.4.0)
|
30
32
|
sorbet-runtime (>= 0.5.9204)
|
31
33
|
unparser
|
32
|
-
regexp_parser (2.8.
|
34
|
+
regexp_parser (2.8.1)
|
33
35
|
reline (0.3.5)
|
34
36
|
io-console (~> 0.5)
|
35
37
|
rexml (3.2.5)
|
36
|
-
rubocop (1.52.
|
38
|
+
rubocop (1.52.1)
|
37
39
|
json (~> 2.3)
|
38
40
|
parallel (~> 1.10)
|
39
|
-
parser (>= 3.2.
|
41
|
+
parser (>= 3.2.2.3)
|
40
42
|
rainbow (>= 2.2.2, < 4.0)
|
41
43
|
regexp_parser (>= 1.8, < 3.0)
|
42
44
|
rexml (>= 3.2.5, < 4.0)
|
@@ -52,14 +54,14 @@ GEM
|
|
52
54
|
rubocop-sorbet (0.7.0)
|
53
55
|
rubocop (>= 0.90.0)
|
54
56
|
ruby-progressbar (1.13.0)
|
55
|
-
sorbet (0.5.
|
56
|
-
sorbet-static (= 0.5.
|
57
|
-
sorbet-runtime (0.5.
|
58
|
-
sorbet-static (0.5.
|
59
|
-
sorbet-static (0.5.
|
60
|
-
sorbet-static-and-runtime (0.5.
|
61
|
-
sorbet (= 0.5.
|
62
|
-
sorbet-runtime (= 0.5.
|
57
|
+
sorbet (0.5.10880)
|
58
|
+
sorbet-static (= 0.5.10880)
|
59
|
+
sorbet-runtime (0.5.10880)
|
60
|
+
sorbet-static (0.5.10880-universal-darwin-22)
|
61
|
+
sorbet-static (0.5.10880-x86_64-linux)
|
62
|
+
sorbet-static-and-runtime (0.5.10880)
|
63
|
+
sorbet (= 0.5.10880)
|
64
|
+
sorbet-runtime (= 0.5.10880)
|
63
65
|
spoom (1.2.1)
|
64
66
|
sorbet (>= 0.5.10187)
|
65
67
|
sorbet-runtime (>= 0.5.9204)
|
@@ -75,7 +77,7 @@ GEM
|
|
75
77
|
yard-sorbet
|
76
78
|
thor (1.2.2)
|
77
79
|
unicode-display_width (2.4.2)
|
78
|
-
unparser (0.6.
|
80
|
+
unparser (0.6.8)
|
79
81
|
diff-lcs (~> 1.3)
|
80
82
|
parser (>= 3.2.0)
|
81
83
|
yard (0.9.34)
|
data/README.md
CHANGED
@@ -76,10 +76,11 @@ Finally, there are a few methods you can use on both `Typed::Result` types.
|
|
76
76
|
```ruby
|
77
77
|
result = call_api(1)
|
78
78
|
|
79
|
-
result.success? # => true
|
80
|
-
result.failure? # => true
|
79
|
+
result.success? # => true on success, false on failure
|
80
|
+
result.failure? # => true on failure, false on success
|
81
81
|
result.payload # => nil on failure, payload type on failure
|
82
82
|
result.error # => nil on success, error type on failure
|
83
|
+
result.payload_or("fallback") # => returns payload on success, given value on failure
|
83
84
|
|
84
85
|
# You can combine all the above to write flow-sensitive type-checked code
|
85
86
|
if result.success?
|
@@ -113,6 +114,19 @@ else
|
|
113
114
|
end
|
114
115
|
```
|
115
116
|
|
117
|
+
You can also use the `#on_error` chain to take an action only on failure, such as logging or capturing error information in an error monitoring service.
|
118
|
+
|
119
|
+
```ruby
|
120
|
+
# In this example, retrieve_user and send_notification both return a Typed::Result
|
121
|
+
# retrieve_user: Typed::Result[User, RetrieveUserError
|
122
|
+
# send_notification: Typed::Result[T::Boolean, SendNotificationError]
|
123
|
+
res = retrieve_user(user_id)
|
124
|
+
.and_then { |user| send_notification(user.email) } # this block will only run if retrieve_user returns a Typed::Success
|
125
|
+
.on_error { |error| puts "Encountered this error: #{error}"}
|
126
|
+
```
|
127
|
+
|
128
|
+
If the above chain does not fail, the `puts` statement is never run. If the chain does yield a `Failure`, the `puts` block is executed and the `Failure` is ultimately returned.
|
129
|
+
|
116
130
|
## Why use Results?
|
117
131
|
|
118
132
|
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.
|
data/lib/typed/failure.rb
CHANGED
@@ -57,5 +57,25 @@ module Typed
|
|
57
57
|
def and_then(&_block)
|
58
58
|
self
|
59
59
|
end
|
60
|
+
|
61
|
+
sig do
|
62
|
+
override
|
63
|
+
.params(block: T.proc.params(arg0: Error).void)
|
64
|
+
.returns(T.self_type)
|
65
|
+
end
|
66
|
+
def on_error(&block)
|
67
|
+
block.call(error)
|
68
|
+
self
|
69
|
+
end
|
70
|
+
|
71
|
+
sig do
|
72
|
+
override
|
73
|
+
.type_parameters(:Fallback)
|
74
|
+
.params(value: T.type_parameter(:Fallback))
|
75
|
+
.returns(T.any(Payload, T.type_parameter(:Fallback)))
|
76
|
+
end
|
77
|
+
def payload_or(value)
|
78
|
+
value
|
79
|
+
end
|
60
80
|
end
|
61
81
|
end
|
data/lib/typed/result.rb
CHANGED
@@ -32,5 +32,20 @@ module Typed
|
|
32
32
|
.returns(T.any(Result[T.type_parameter(:U), T.type_parameter(:T)], Result[T.type_parameter(:U), Error]))
|
33
33
|
end
|
34
34
|
def and_then(&_block); end
|
35
|
+
|
36
|
+
sig do
|
37
|
+
abstract
|
38
|
+
.params(block: T.proc.params(arg0: Error).void)
|
39
|
+
.returns(T.self_type)
|
40
|
+
end
|
41
|
+
def on_error(&block); end
|
42
|
+
|
43
|
+
sig do
|
44
|
+
abstract
|
45
|
+
.type_parameters(:Fallback)
|
46
|
+
.params(value: T.type_parameter(:Fallback))
|
47
|
+
.returns(T.any(Payload, T.type_parameter(:Fallback)))
|
48
|
+
end
|
49
|
+
def payload_or(value); end
|
35
50
|
end
|
36
51
|
end
|
data/lib/typed/success.rb
CHANGED
@@ -57,5 +57,24 @@ module Typed
|
|
57
57
|
def and_then(&block)
|
58
58
|
block.call(payload)
|
59
59
|
end
|
60
|
+
|
61
|
+
sig do
|
62
|
+
override
|
63
|
+
.params(_block: T.proc.params(arg0: Error).void)
|
64
|
+
.returns(T.self_type)
|
65
|
+
end
|
66
|
+
def on_error(&_block)
|
67
|
+
self
|
68
|
+
end
|
69
|
+
|
70
|
+
sig do
|
71
|
+
override
|
72
|
+
.type_parameters(:Fallback)
|
73
|
+
.params(_value: T.type_parameter(:Fallback))
|
74
|
+
.returns(T.any(Payload, T.type_parameter(:Fallback)))
|
75
|
+
end
|
76
|
+
def payload_or(_value)
|
77
|
+
payload
|
78
|
+
end
|
60
79
|
end
|
61
80
|
end
|