Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lfex/bombadil
A wrapper for the Erlang toml library that uses the map data structure
https://github.com/lfex/bombadil
erlang hacktoberfest lfe maps toml
Last synced: 27 days ago
JSON representation
A wrapper for the Erlang toml library that uses the map data structure
- Host: GitHub
- URL: https://github.com/lfex/bombadil
- Owner: lfex
- License: apache-2.0
- Created: 2020-10-26T03:55:01.000Z (about 4 years ago)
- Default Branch: release/0.4.x
- Last Pushed: 2023-11-29T06:03:56.000Z (12 months ago)
- Last Synced: 2024-09-30T03:42:15.722Z (about 1 month ago)
- Topics: erlang, hacktoberfest, lfe, maps, toml
- Language: LFE
- Homepage:
- Size: 293 KB
- Stars: 4
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# bombadil
*A wrapper for the [Erlang toml library](https://github.com/dozzie/toml) that uses the map data structure*
[![Build Status][gh-actions-badge]][gh-actions]
[![LFE Versions][lfe-badge]][lfe]
[![Erlang Versions][erlang-badge]][versions]
[![Tag][github-tag-badge]][github-tag]
[![Project Logo][logo]][logo-large]
##### Table of Contents
* [About](#about-)
* [Build](#build-)
* [Tests](#tests-)
* [Usage](#usage-)
* [License](#license-)
## About [↟](#table-of-contents)
This is an LFE TOML library 100% usable in any other BEAM language that is
capable of building `rebar3`-based projects. While it used to offer unique
features for the old Erlang TOML library, the newer tomerl library provides
very similar features. As such, this library has become little more than a
convenience wrapper for tomerl, with just a touch of sugar on top.
## Build [↟](#table-of-contents)
```shell
rebar3 compile
```
# Tests [↟](#table-of-contents)
```shell
rebar3 as test ltest
```
## Usage [↟](#table-of-contents)
Add to your `rebar.config` file:
``` erlang
{deps, [
{bombadil, "0.4.0", {pkg, toml_bombadil}}
]}.
```
Read a TOML file, parse its contents, and convert the parsed data to an Erlang
map:
```lisp
(set `#(ok ,data) (bombadil:read "priv/testing/deep-sections.toml"))
```
or from Erlang:
```erlang
1> {ok, Data} = bombadil:read("priv/testing/deep-sections.toml").
```
One may work with the resulting data structure in the following ways:
```lisp
lfe> (bombadil:get data "ab")
42
lfe> (bombadil:get-in data '("a" "b" "d" "e"))
#M("in" "deep")
lfe> (bombadil:assoc-in data '("a" "b" "d" "e") 42)
#M(#"ab" 42
#"cd" 3.14159
#"a" #M(#"stuff" #"things"
#"b" #M(#"other" #"stuff"
#"c" #M(#"things" #"n stuff")
#"d" #M(#"things" #"n other things"
#"e" 42))
#"f" #M(#"other" #"things"))
#"g" #M(#"h" #M(#"woah" #"wut"))
#"i" #M(#"j" #M(#"k" #M(#"no" #"way")))
#"l" #M(#"stuff" #"fur reelies"))
```
or from Erlang:
```erlang
2> bombadil:get(Data, "ab").
42
3> bombadil:get_in(Data, ["a", "b", "d", "e"]).
#{<<"in">> => <<"deep">>}
4> bombadil:assoc_in(Data, ["a", "b", "d", "e"], 42).
#{<<"a">> =>
#{<<"b">> =>
#{<<"c">> => #{<<"things">> => <<"n stuff">>},
<<"d">> =>
#{<<"e">> => 42,<<"things">> => <<"n other things">>},
<<"other">> => <<"stuff">>},
<<"f">> => #{<<"other">> => <<"things">>},
<<"stuff">> => <<"things">>},
<<"ab">> => 42,<<"cd">> => 3.14159,
<<"g">> => #{<<"h">> => #{<<"woah">> => <<"wut">>}},
<<"i">> =>
#{<<"j">> => #{<<"k">> => #{<<"no">> => <<"way">>}}},
<<"l">> => #{<<"stuff">> => <<"fur reelies">>}}
```
Note that since all of these functions have `data` as their first argument, the
"thread-left" macro in LFE -- `->` -- may be used to chain outputs:
```lisp
lfe> (include-lib "lfe/include/clj.lfe")
lfe> (-> data
(bombadil:assoc-in '("a" "b" "d" "e") 42)
(bombadil:get-in '("a" "b" "d" "e")))
42
```
That last is, of course, a contrived example; those who have used the data threading
macros in the past are well familiar with the benefits (mostly in code clarity
and thus ease of debugging and maintenance).
Unfortunately this last LFE macro convenience is not usable from Erlang.
## License [↟](#table-of-contents)
Apache License, Version 2.0
Copyright © 2020-2023, Duncan McGreggor .
[//]: ---Named-Links---
[logo]: priv/images/logo.png
[logo-large]: https://en.wikipedia.org/wiki/File:Gallen-Kallela_The_defence_of_the_Sampo.jpg
[gh-actions-badge]: https://github.com/lfex/bombadil/workflows/ci%2Fcd/badge.svg
[gh-actions]: https://github.com/lfex/bombadil/actions
[lfe]: https://github.com/rvirding/lfe
[lfe-badge]: https://img.shields.io/badge/lfe-2.1-blue.svg
[erlang-badge]: https://img.shields.io/badge/erlang-23%20to%2026-blue.svg
[versions]: https://github.com/lfex/bombadil/blob/master/.github/workflows/cicd.yml
[github-tag]: https://github.com/lfex/bombadil/tags
[github-tag-badge]: https://img.shields.io/github/tag/lfex/bombadil.svg