# Solid
[![Build Status](https://github.com/edgurgel/solid/workflows/CI/badge.svg?branch=master)](https://github.com/edgurgel/solid/actions?query=workflow%3ACI)
[![Module Version](https://img.shields.io/hexpm/v/solid.svg)](https://hex.pm/packages/solid)
[![Hex Docs](https://img.shields.io/badge/hex-docs-lightgreen.svg)](https://hexdocs.pm/solid/)
[![Total Download](https://img.shields.io/hexpm/dt/solid.svg)](https://hex.pm/packages/solid)
[![License](https://img.shields.io/hexpm/l/solid.svg)](https://github.com/edgurgel/solid/blob/master/LICENSE.md)
[![Last Updated](https://img.shields.io/github/last-commit/edgurgel/solid.svg)](https://github.com/edgurgel/solid/commits/master)
Solid is an implementation in Elixir of the template language [Liquid](https://shopify.github.io/liquid/). It uses [nimble_parsec](https://github.com/plataformatec/nimble_parsec) to generate the parser.
## Basic Usage
```elixir
iex> template = "My name is {{ user.name }}"
iex> {:ok, template} = Solid.parse(template)
iex> Solid.render(template, %{ "user" => %{ "name" => "José" } }) |> to_string
"My name is José"
```
## Installation
The package can be installed with:
```elixir
def deps do
[{:solid, "~> 0.10"}]
end
```
## Custom tags
To implement a new tag you need to create a new module that implements the `Tag` behaviour:
```elixir
defmodule MyCustomTag do
import NimbleParsec
@behaviour Solid.Tag
@impl true
def spec(_parser) do
space = Solid.Parser.Literal.whitespace(min: 0)
ignore(string("{%"))
|> ignore(space)
|> ignore(string("my_tag"))
|> ignore(space)
|> ignore(string("%}"))
end
@impl true
def render(tag, _context, _options) do
[text: "my first tag"]
end
end
```
- `spec` defines how to parse your tag;
- `render` defines how to render your tag.
Now we need to add the tag to the parser
```elixir
defmodule MyParser do
use Solid.Parser.Base, custom_tags: [MyCustomTag]
end
```
And finally pass the custom parser as an option:
```elixir
"{% my_tag %}"
|> Solid.parse!(parser: MyParser)
|> Solid.render()
```
## Contributing
When adding new functionality or fixing bugs consider adding a new test case here inside `test/cases`. These cases are tested against the Ruby gem so we can try to stay as close as possible to the original implementation.
## TODO
* [x] Integration tests using Liquid gem to build fixtures; [#3](https://github.com/edgurgel/solid/pull/3)
* [x] All the standard filters [#8](https://github.com/edgurgel/solid/issues/8)
* [x] Support to custom filters [#11](https://github.com/edgurgel/solid/issues/11)
* [x] Tags (if, case, unless, etc)
- [x] `for`
- [x] `else`
- [x] `break`
- [x] `continue`
- [x] `limit`
- [x] `offset`
- [x] Range (3..5)
- [x] `reversed`
- [x] `forloop` object
- [x] `raw` [#18](https://github.com/edgurgel/solid/issues/18)
- [x] `cycle` [#17](https://github.com/edgurgel/solid/issues/17)
- [x] `capture` [#19](https://github.com/edgurgel/solid/issues/19)
- [x] `increment` [#16](https://github.com/edgurgel/solid/issues/16)
- [x] `decrement` [#16](https://github.com/edgurgel/solid/issues/16)
* [x] Boolean operators [#2](https://github.com/edgurgel/solid/pull/2)
* [x] Whitespace control [#10](https://github.com/edgurgel/solid/issues/10)
## Copyright and License
Copyright (c) 2016 Eduardo Gurgel Pinho
This work is free. You can redistribute it and/or modify it under the
terms of the MIT License. See the [LICENSE.md](./LICENSE.md) file for more details.