Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wnuqui/presence
Presence is very small library for Elixir projects that checks if a value is blank.
https://github.com/wnuqui/presence
blank elixir presence present protocol
Last synced: 3 months ago
JSON representation
Presence is very small library for Elixir projects that checks if a value is blank.
- Host: GitHub
- URL: https://github.com/wnuqui/presence
- Owner: wnuqui
- License: mit
- Created: 2017-03-29T14:57:16.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2021-08-20T20:29:06.000Z (over 3 years ago)
- Last Synced: 2024-09-28T17:20:54.306Z (4 months ago)
- Topics: blank, elixir, presence, present, protocol
- Language: Elixir
- Homepage:
- Size: 33.2 KB
- Stars: 6
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
## Presence [](https://travis-ci.org/wnuqui/presence) [](https://coveralls.io/github/wnuqui/presence?branch=master) [](http://inch-ci.org/github/wnuqui/presence) [](https://github.com/wnuqui/presence/releases/latest) [](https://hex.pm/packages/presence) [](https://ebertapp.io/github/wnuqui/presence)
Presence is very small library for Elixir projects that needs to check if a value is blank. A value is blank if it's nil, false, empty, or a whitespace string.
The complete documentation for Presence is located [here](https://hexdocs.pm/presence).
## Getting Started
Some examples can be found below, but I highly recommend you review the
API docs [here](https://hexdocs.pm/presence). There are examples for `Atom`, `BitString`, `Float`, `Integer`, `List`, `Map` and `Tuple`.
### Adding Presence To Your Project
To use Presence with your projects, edit your `mix.exs` file and add it as a dependency:
```elixir
defp deps do
[{:presence, "~> 0.9.1"}]
end
```
### Examples
To use Presence, I recommend you add
```elixir
import Presence
```
to the top of the module where you will be working with Presence module. We `import` to easily access functions from modules implementing `Presence` protocol without using the fully-qualified name.
These functions are `is_blank/1`, `is_present/1`, `presence/1`
Few examples below:
```elixir
iex> is_blank(nil)
true
```
```elixir
iex> is_blank([])
true
```
```elixir
iex> is_blank(%{})
true
```
```elixir
iex> is_present({:ok, %{data: [1, 2, 3]}})
true
```
```elixir
iex> is_present({})
false
```
```elixir
iex> presence(" ")
nil
```
## Current Implementation
Presence is a Protocol that is currently implemented by the following:
- `Atom`
- `BitString`
- `Float`
- `Integer`
- `List`
- `Map`
- `Tuple`
Other modules can implement the Protocol by defining these functions:
- `is_blank/1`
- `is_present/1`
- `presence/1`
## Inspiration
Many thanks to [Rails](http://rubyonrails.org/) for the inspiration.
## License
This software is licensed under [the MIT license](LICENSE.md).