[](https://travis-ci.org/f34nk/modest_ex)
[](https://hex.pm/packages/modest_ex)
[](https://hex.pm/packages/modest_ex)
# ModestEx
A library to do pipeable transformations on html strings with CSS selectors, e.g. find(), prepend(), append(), replace() etc.
Elixir/Erlang bindings for lexborisovs **Modest**
>Modest is a fast HTML renderer implemented as a pure C99 library with no outside dependencies.
- [Modest](https://github.com/lexborisov/Modest)
- HTML5 parsing library in pure C99
- fully conformant with the HTML5 spec
The binding is implemented as a **C-Node** following the excellent example in Overbryd package **nodex**. If you want to learn how to set up bindings to C/C++, you should definitely check it out.
- [nodex](https://github.com/Overbryd/nodex)
- distributed Elixir
- save binding with C-Nodes
>C-Nodes are external os-processes that communicate with the Erlang VM through erlang messaging. That way you can implement native code and call into it from Elixir in a safe predictable way. The Erlang VM stays unaffected by crashes of the external process.
## Example
[Full list of features.](https://github.com/f34nk/modest_ex/blob/master/FEATURES.md)
iex> ModestEx.find("<p><a>Hello</a> World</p>", "p a")
["<a>Hello</a>"]
iex> ModestEx.get_attribute("<p><a href=\"https://elixir-lang.org\">Hello</a></p>", "p a", "href")
["https://elixir-lang.org"]
iex> ModestEx.set_attribute("<p><a href=\"\">Hello</a></p>", "p a", "href", "https://elixir-lang.org")
"<html><head></head><body><p><a href=\"https://elixir-lang.org\">Hello</a></p></body></html>"
iex> ModestEx.append("<div><p>Hello</p></div>", "div", "<p>World</p>")
"<html><head></head><body><div><p>Hello</p><p>World</p></div></body></html>"
Build transformation pipelines...
test "more complex transformation" do
result = "<div><div><a>Hello</a></div><div><a>World</a></div></div>"
|> ModestEx.set_attribute("body > div", "class", "col-md-12")
|> ModestEx.set_attribute("div.col-md-12 div", "class", "col-md-6")
|> ModestEx.set_attribute("div.col-md-6:first-of-type a", "href", "https://elixir-lang.org")
|> ModestEx.set_attribute("div.col-md-6:last-of-type a", "href", "https://google.de")
|> List.first()
assert result == "<div class=\"col-md-12\"><div class=\"col-md-6\"><a href=\"https://elixir-lang.org\">Hello</a></div><div class=\"col-md-6\"><a href=\"https://google.de\">World</a></div></div>"
end
**Stay tuned for more...**
*prepend, insert_after, insert_before, remove...*
## Supported CSS Selectors
All common CSS Selectors are supported. For an extensive list please [check out this table](https://github.com/f34nk/modest_ex/blob/master/SELECTORS.md).
## Installation
Available on [hex](https://hex.pm/packages/modest_ex).
```elixir
def deps do
[
{:modest_ex, "~> 0.0.6-dev"}
]
end
```
## Target dependencies
cmake 3.x
erlang-dev
erlang-xmerl
erlang-parsetools
## Compile and test
mix deps.get
mix compile
mix test
## Cloning
git clone git@github.com:f34nk/modest_ex.git
cd modest_ex
All binding targets are added as submodules in the `target/` folder.
git submodule update --init --recursive --remote
mix deps.get
mix compile
mix test
mix test.target
Cleanup
mix clean
Benchmark
mix bench
## Roadmap
See [CHANGELOG](https://github.com/f34nk/modest_ex/blob/master/CHANGELOG.md).
- [ ] Bindings
- [x] Call as C-Node
- [ ] Call as dirty-nif
- [ ] Tests
- [x] Call as C-Node
- [ ] Call as dirty-nif
- [x] Target tests
- [x] Feature tests
- [x] Package test
- [ ] Features
- [x] Find nodes using a CSS selector
- [x] Serialize any string with valid or broken html
- [x] Get attribute with optional CSS selector
- [x] Set attribute with optional CSS selector
- [x] Get text with optional CSS selector
- [x] Set text with optional CSS selector
- [x] Remove a node from html
- [x] Append node to another node
- [x] Prepend node to another node
- [ ] Replace node with another node
- [ ] Slice html to a subset of nodes
- [x] List of supported CSS Selectors
- [ ] Documentation
- [x] Publish as hex package
## License
ModestEx is under LGPL license. Check the [LICENSE](https://github.com/f34nk/modest_ex/blob/master/LICENSE) file for more details.
## Icon Credit
humble by Eliricon from the Noun Project
