Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/f34nk/modest_ex
Elixir library to do pipeable transformations on html strings (with CSS selectors)
https://github.com/f34nk/modest_ex
css-selector elixir html-parser html-renderer
Last synced: about 1 month ago
JSON representation
Elixir library to do pipeable transformations on html strings (with CSS selectors)
- Host: GitHub
- URL: https://github.com/f34nk/modest_ex
- Owner: f34nk
- License: lgpl-2.1
- Created: 2018-02-26T23:11:36.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2022-01-18T09:15:21.000Z (almost 3 years ago)
- Last Synced: 2024-10-10T18:20:14.964Z (2 months ago)
- Topics: css-selector, elixir, html-parser, html-renderer
- Language: C
- Homepage:
- Size: 580 KB
- Stars: 31
- Watchers: 3
- Forks: 5
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- freaking_awesome_elixir - C - A library to do pipeable transformations on html strings with CSS selectors, e.g. find(), prepend(), append(), replace() etc. (HTML)
- fucking-awesome-elixir - modest_ex - A library to do pipeable transformations on html strings with CSS selectors, e.g. find(), prepend(), append(), replace() etc. (HTML)
- awesome-elixir - modest_ex - A library to do pipeable transformations on html strings with CSS selectors, e.g. find(), prepend(), append(), replace() etc. (HTML)
README
# This project is not maintained anymore.
[](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 lexborisov's **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
All Modest-related features are implemented in `C` using my wrapper library [modest_html](https://github.com/f34nk/modest_html).
The binding is implemented as a **C-Node** following the excellent example in Overbryd's 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.
For news and updates please check out the [forum discussion](https://elixirforum.com/t/modestex-pipeable-transformations-on-html-strings-with-css-selectors/12793).
## Example
Total **16** features implemented. See [**complete feature list**](https://github.com/f34nk/modest_ex/blob/master/FEATURES.md).
Build transformation pipelines...
```elixir
test "build up a complete DOM" do
result = ""
|> ModestEx.serialize()
|> ModestEx.append("body", "
")
|> ModestEx.set_attribute("div", "class", "col-md-12")
|> ModestEx.append("div", "")
|> ModestEx.set_attribute("div.col-md-12 div", "class", "col-md-6")
|> ModestEx.append("div.col-md-12 div", "")
|> ModestEx.set_text("a", "Hello")
copy = ModestEx.find(result, "div.col-md-12 div")
|> ModestEx.set_text("a", "World")
result = ModestEx.insert_after(result, "div.col-md-12 div", copy)
|> 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")
assert result == "
"
end
```
## Supported CSS Selectors
All common CSS Selectors are supported. Total **38** selector patterns implemented.
See [**complete list of supported CSS selectors**](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, "~> 1.0.4"}
]
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 [email protected]: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
```
## 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
- [x] Insert node before another node
- [x] Insert node after another node
- [x] Replace node with another node
- [x] Slice html to a subset of nodes
- [x] Get position of node in relation to its parent
- [x] Wrap node with another node
- [x] Pretty print html
- [ ] Compare two html strings (see [here](https://github.com/f34nk/modest_html/blob/master/CHANGELOG.md#200))
- [ ] Transform html string by list of actions
- [x] Custom CSS selector for pseudo class `:contains(text)` implemented in [Modest](https://github.com/lexborisov/Modest/pull/42)
- [x] Scope flag to control serialization
- [x] List of supported CSS Selectors
- [x] 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