Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nurugger07/calliope
An elixir haml parser
https://github.com/nurugger07/calliope
Last synced: 5 days ago
JSON representation
An elixir haml parser
- Host: GitHub
- URL: https://github.com/nurugger07/calliope
- Owner: nurugger07
- License: apache-2.0
- Created: 2013-09-24T20:00:42.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2024-09-05T21:09:45.000Z (2 months ago)
- Last Synced: 2024-10-25T12:39:04.876Z (10 days ago)
- Language: Elixir
- Size: 167 KB
- Stars: 198
- Watchers: 8
- Forks: 37
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- freaking_awesome_elixir - Elixir - An Elixir HAML parser. (Templating)
- fucking-awesome-elixir - calliope - An Elixir HAML parser. (Templating)
- awesome-elixir - calliope - An Elixir HAML parser. (Templating)
README
# Calliope - An Elixir Haml Parser [](https://travis-ci.org/nurugger07/calliope)
For those of you that prefer the poetic beauty of [HAML](https://github.com/haml/haml) templates over HTML, then Calliope is the package for you. Calliope is a parser written in [Elixir](http://elixir-lang.org/) that will render HAML/Elixir templates into HTML. For example, we can render the following HAML:
``` haml
!!! 5
%html{lang: "en-US"}
%head
%title Welcome to Calliope
%body
%h1 Calliope
%h2 The muse of epic poetry
```
Into this HTML:
``` html
Welcome to Calliope
Calliope
The muse of epic poetry
```
## Using
Calliope is simple to add to any project. If you are using the hex package manager, just add the following to your mix file:
``` elixir
def deps do
[ { :calliope, '~> 0.4.2' } ]
end
```
If you aren't using hex, add the reference to the github repo.
``` elixir
def deps do
[ { :calliope, github: "nurugger07/calliope" } ]
end
```
Then run `mix deps.get` in the shell to fetch and compile the dependencies. Then you can either call to Calliope directly:
``` shell
iex(1)> Calliope.render "%h1 Welcome to Calliope"
"
Welcome to Calliope
"
```
Or you can `use` Calliope in a module and call through your module:
``` elixir
defmodule MyModule do
use Calliope
end
```
``` shell
iex(1)> MyModule.render "%h1 Welcome to Calliope"
"
Welcome to Calliope
"
```
## Formating
If you are not familiar with HAML syntax I would suggest you checkout the [reference](http://haml.info/docs/yardoc/file.REFERENCE.html) page. Most of the syntax has been accounted for but we are in the process of adding more functionality.
HAML is basically a whitespace sensitive shorthand for HTML that does not use end-tags. Although Calliope uses HAML formating, it does use its own flavor. Sounds great but what does it look like:
``` haml
%tag{ attr: "", attr: "" } Content
```
Or you could use the following:
``` haml
%tag(attr="" attr="" ) Content
```
The `id` and `class` attributes can also be assigned directly to the tag:
``` haml
%tag#id.class Content
```
If you are creating a div you don't need to include the tag at all. This HAML
``` haml
#main
.blue Content
```
Will generate the following HTML
``` html
Content
```
## Passing Arguments
The render function will also take a list of named arguments that can be evaluated when compiling the HTML
Given the following HAML:
``` haml
#main
.blue= content
```
Then call render and pass in the `haml` and `content`:
``` elixir
Calliope.render haml, [content: "Hello, World"]
```
Calliope will render:
``` html
Hello, World
```
## Embedded Elixir
Calliope doesn't just evaluate arguments, you can actually embed Elixir directly into the templates:
### for
``` haml
- for { id, headline, content } <- posts do
%h1
%a{href: "posts/#{id}"}= headline
.content
= content
```
Pass that to `render` with a list of posts
``` elixir
Calliope.render haml, [posts: [{1, "Headline 1", "Content 1"}, {2, "Headline 2", "Content 2"}]
```
Will render
``` html
Headline 1
Content 1
Headline 2
Content 2
```
### if, else, and unless
``` haml
- if post do
%h1= post.title
- if post.comments do
%p Has some comments
- else
%p No Comments
- unless user_guest(user)
%a{href: "posts/edit/#{id}"}= Edit
```
### case
``` haml
- case example do
- "one" ->
%p Example one
- other ->
%p Other Example
#{other}
```
### Local Variables
``` haml
- answer = 42
%p= "What is the answer #{answer}"
```
### Anonymous Functions
``` haml
- form_for @changeset, @action, fn f ->
.form-group
= label f, :name, "Name", class: "control-label"
= text_input f, :name, class: "form-control"
.form-group
= submit "Submit", class: "btn btn-primary"
```
## Precompile Templates
Calliope provides an Engine to precompile your haml templates into functions. This parses the template at compile time and creates a function that takes the name and args needed to render the page. These functions are scoped to the module that uses the engine.
Adding this functionality is easy.
``` elixir
defmodule Simple do
use Calliope.Engine
def show do
content_for(:show, [title: Calliope])
end
end
```
If you are using layouts, you can set the layout and call the `content_with_layout` function.
``` elixir
defmodule Simple do
use Calliope.Engine, layout: "application"
def show do
content_with_layout(:show, [title: Calliope])
end
end
```
In addition to `:layout`, you can also set the following options:
`:path` - provides the root path. The default is the current working directory.
`:templates` - used to define where the templates are stored. By default it will use `:path`
`:alias` - used to set the directory where the templates are located. The
default value is 'templates'.
`:layout_directory` - the directory that your layouts are stored relative to the
templates path. The default directory is `layouts`
`:layout` - the layout to use for templates. The default is `:none` or you can pass in
the name of a layout.
## Coming Soon
* Rendering partials
* Exception messages