Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/massivefermion/bison
BSON encoder and decoder for gleam
https://github.com/massivefermion/bison
Last synced: about 1 month ago
JSON representation
BSON encoder and decoder for gleam
- Host: GitHub
- URL: https://github.com/massivefermion/bison
- Owner: massivefermion
- License: apache-2.0
- Created: 2023-10-05T15:20:17.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-18T05:00:58.000Z (8 months ago)
- Last Synced: 2024-04-18T21:49:51.655Z (8 months ago)
- Language: Gleam
- Homepage: https://hex.pm/packages/bison
- Size: 421 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://hex.pm/packages/bison)
[](https://hexdocs.pm/bison/)
# bison
BSON encoder and decoder for Gleam
## 
Quick start
```sh
gleam test # Run the tests
gleam shell # Run an Erlang shell
```
## Installation
```sh
gleam add bison
```
## Roadmap
- [x] support encoding and decoding basic bson types (null, string, int32, int64, double, boolean, objectId, array, document).
- [x] support encoding and decoding min, max, timestamp, datetime, javascript and regex bson types.
- [x] support encoding and decoding the generic, md5, uuid and user-defined binary subtypes.
- [x] support generating new object-ids
- [ ] support encoding and decoding decimal128 bson type.
- [ ] support encoding and decoding encrypted binary subtype.
- [ ] support encoding and decoding relaxed EJSON.
## Usage
### Encoding
```gleam
import gleam/dict
import gleam/list
import gleam/result
import bison
import bison/md5
import bison/bson
import bison/object_id
fn calf_to_bson(calf: Calf) -> Result(BitArray, Nil) {
use id <- result.then(object_id.from_string(calf.id))
use checksum <- result.then(md5.from_string(calf.checksum))
[
#("id", bson.ObjectId(id)),
#("age", bson.Int32(calf.age)),
#("name", bson.String(calf.name)),
#("weight", bson.Double(calf.weight)),
#("birthdate", bson.DateTime(calf.birthdate)),
#("is_healthy", bson.Boolean(calf.is_healthy)),
#("checksum", bson.Binary(bson.MD5(checksum))),
#("nicknames", bson.Array(list.map(calf.nicknames, bson.String))),
]
|> dict.from_list
|> bison.encode
|> Ok
}
```
### Decoding
```gleam
import gleam/dict
import gleam/result
import gleam/dynamic
import bison
import bison/bson
import bison/decoders
pub type Habitat {
Habitat(kind: String, location: String)
}
pub type Species {
Species(alternative_name: String, weight_range: List(Int), habitat: Habitat)
}
pub type ExtantBisons {
ExtantBisons(buffalo: Species, wisent: Species)
}
pub fn extant_bisons_from_bson(
binary: BitArray,
) -> Result(ExtantBisons, List(dynamic.DecodeError)) {
let habitat_decoder =
dynamic.decode2(
Habitat,
dynamic.field("kind", decoders.string),
dynamic.field("location", decoders.string),
)
let species_decoder =
dynamic.decode3(
Species,
dynamic.field("alternative name", decoders.string),
dynamic.field("weight range", decoders.list(decoders.int)),
dynamic.field("habitat", decoders.wrap(habitat_decoder)),
)
let decoder =
dynamic.decode2(
ExtantBisons,
dynamic.field("Buffalo", decoders.wrap(species_decoder)),
dynamic.field("Wisent", decoders.wrap(species_decoder)),
)
use doc <- result.then(
bison.decode(binary)
|> result.replace_error([dynamic.DecodeError("BSON", "bit array", [])]),
)
bison.to_custom_type(doc, decoder)
}
```