Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/CrowdHailer/OK
Elegant error/exception handling in Elixir, with result monads.
https://github.com/CrowdHailer/OK
elixir elixir-pipelines macros monad pipeline
Last synced: about 1 month ago
JSON representation
Elegant error/exception handling in Elixir, with result monads.
- Host: GitHub
- URL: https://github.com/CrowdHailer/OK
- Owner: CrowdHailer
- License: apache-2.0
- Created: 2015-10-20T19:58:33.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2020-01-13T09:05:34.000Z (almost 5 years ago)
- Last Synced: 2024-10-27T13:29:04.401Z (about 2 months ago)
- Topics: elixir, elixir-pipelines, macros, monad, pipeline
- Language: Elixir
- Homepage: http://insights.workshop14.io/2015/10/18/handling-errors-in-elixir-no-one-say-monad.html
- Size: 119 KB
- Stars: 600
- Watchers: 10
- Forks: 20
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- freaking_awesome_elixir - Elixir - Elegant error handling with result monads, featuring a simple & powerful `with` construct and a happy path pipe operator. (Errors and Exception Handling)
- fucking-awesome-elixir - OK - Elegant error handling with result monads, featuring a simple & powerful `with` construct and a happy path pipe operator. (Errors and Exception Handling)
- awesome-elixir - OK - Elegant error handling with result monads, featuring a simple & powerful `with` construct and a happy path pipe operator. (Errors and Exception Handling)
README
# OK
**Elegant error/exception handling in Elixir, with result monads.**
[](https://hex.pm/packages/ok)
[](https://travis-ci.org/CrowdHailer/OK)
[](LICENSE)
- [Install from Hex](https://hex.pm/packages/ok)
- [Documentation available on hexdoc](https://hexdocs.pm/ok)
## Result tuples
The OK module works with result tuples by treating them as a result monad.
```elixir
{:ok, value} | {:error, reason}
```
See [Handling Errors in Elixir](http://insights.workshop14.io/2015/10/18/handling-errors-in-elixir-no-one-say-monad.html) for a more detailed explanation.
See [FAQ](#faq) at end of README for a few common question.
## OK.for
`OK.for/1` combines several functions that may fail.
- Use the `<-` operator to match & extract a value for an `:ok` tuple.
- Use the `=` operator as you normally would for pattern matching an untagged result.
```elixir
require OK
OK.for do
user <- fetch_user(1) # `<-` operator means func returns {:ok, user}
cart <- fetch_cart(1) # `<-` again, {:ok, cart}
order = checkout(cart, user) # `=` allows pattern matching on non-tagged funcs
saved_order <- save_order(order)
after
saved_order # Value will be wrapped if not already a result tuple
end
```
`OK.for/1` guarantees that it's return value is also in the structure of a result tuple.
## OK.try
`OK.try/1` combines several functions that may fail, and handles errors.
This is useful when writing code that has it's own representation of errors.
e.g. HTTP Responses.
For example when using raxx to build responses the following code will always return a response.
```elixir
require OK
import Raxx
OK.try do
user <- fetch_user(1) # `<-` operator means func returns {:ok, user}
cart <- fetch_cart(1) # `<-` again, {:ok, cart}
order = checkout(cart, user) # `=` allows pattern matching on non-tagged funcs
saved_order <- save_order(order)
after
response(:created) # Value will be returned unwrapped
rescue
:user_not_found ->
response(:not_found)
:could_not_save ->
response(:internal_server_error)
end
```
## OK Pipe
The pipe (`~>>`) is equivalent to `bind`/`flat_map`.
The pipe (`~>`) is equivalent to `map`.
These macros allows pipelining result tuples through multiple functions
for an extremely concise happy path.
```elixir
use OK.Pipe
def get_employee_data(file, name) do
{:ok, file}
~>> File.read
~> String.upcase
end
```
Use `~>>` for `File.read` because it returns a result tuple.
Use `~>` for `String.upcase` because it returns a bare value that should be wrapped in an ok tuple.
## Semantic matches
`OK` provides macros for matching on success and failure cases.
This allows for code to check if a result returned from a function was a
success or failure while hiding implementation details about how that result is
structured.
```elixir
import OK, only: [success: 1, failure: 1]
case fetch_user(id) do
success(user) ->
user
failure(:not_found) ->
create_guest_user()
end
```
## FAQ
#### Why does `OK` not catch raised errors?
For the main rational behind this decision see the article [Errors are not exceptional](http://crowdhailer.me/2018-08-26/errors-are-not-exceptional/)
Two other reasons:
- Exceptional input and errors are not the same thing,
`OK` leaves raising exceptions as a way to handle errors that should never happen.
- Calls inside try/1 are not tail recursive since the VM needs to keep the stacktrace in case an exception happens.
[see source](https://github.com/elixir-lang/elixir/blob/22bd10a8170af0b187029d115abe4cc8edcf2ae6/lib/elixir/lib/kernel/special_forms.ex#L1622).
#### What about other shapes of error and success?
- Accepting any extra forms is a slippery slope, and they are not always unambiguous.
If a library is not returning errors as you like it is very easy to wrap in a custom function.
```elixir
def fetch_foo(map) do
case Map.fetch(map, :foo) do
{:ok, foo} -> {:ok, foo}
:error -> {:error, :no_foo}
end
end
```
#### What changed in version 2.0
- `OK.with` was deprecated.
- `use OK.Pipe` was added.
- `OK.bind` was renamed `OK.flat_map`.
## Additional External Links and Resources
- Elixir Forum
- [OK v1 library](https://elixirforum.com/t/ok-elegant-error-handling-for-elixir-pipelines-version-1-0-released/1932/)
- [Railway programming](http://www.zohaib.me/railway-programming-pattern-in-elixir/)
- Similar Libraries
- [exceptional](https://github.com/expede/exceptional)
- [elixir-monad](https://github.com/nickmeharry/elixir-monad)
- [happy_with](https://github.com/vic/happy_with)
- [monad](https://github.com/rmies/monad)
- [ok_jose](https://github.com/vic/ok_jose)
- [towel](https://github.com/knrz/towel)