AkkomaGang/temple
Archived
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Rename Temple.htm to Temple.temple

Browse source
This commit is contained in:
Mitchell Hanberg 2019-07-08 22:29:41 -04:00
parent 006535ec44
commit 7ad4b0e941
11 changed files with 111 additions and 111 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
.formatter.exs
View file

@ -1,6 +1,6 @@
locals_without_parens = ~w[
html htm
head title style script
temple
html head title style script
noscript template
body section nav article aside h1 h2 h3 h4 h5 h6
header footer address main

8
README.md
View file

@ -19,14 +19,14 @@ end
## Usage
Using Temple is a as simple as using the DSL inside of an `htm/1` block. This returns a safe result of the form `{:safe, html_string}`.
Using Temple is a as simple as using the DSL inside of an `temple/1` block. This returns a safe result of the form `{:safe, html_string}`.
See the [documentation](https://hexdocs.pm/temple/0.1.0/Temple.Tags.html) for more details.
```elixir
use Temple
htm do
temple do
h2 "todos"
ul class: "list" do
@ -68,7 +68,7 @@ defcomponent :flex do
end
end
htm do
temple do
flex id: "my-flex" do
div "Item 1"
div "Item 2"
@ -86,7 +86,7 @@ Most of the macros are purely wrappers, while the semantics of some are changed
See the [documentation](https://hexdocs.pm/temple/0.1.0/Temple.Form.html#content) for more details.
```elixir
htm do
temple do
form_for @conn, Routes.some_path(@conn, :create) do
text_input form, :name
end

12
lib/temple.ex
View file

@ -11,7 +11,7 @@ defmodule Temple do
@doc """
Creates a markup context.
All tags must be called inside of a `Temple.htm/1` block.
All tags must be called inside of a `Temple.temple/1` block.
Returns a safe result of the form `{:safe, result}`
@ -20,7 +20,7 @@ defmodule Temple do
```
team = ["Alice", "Bob", "Carol"]
htm do
temple do
for name <- team do
div class: "text-bold" do
text name
@ -31,7 +31,7 @@ defmodule Temple do
# {:safe, "<div class=\"text-bold\">Alice</div><div class=\"text-bold\">Bob</div><div class=\"text-bold\">Carol</div>"}
```
"""
defmacro htm([do: block] = _block) do
defmacro temple([do: block] = _block) do
quote do
import Kernel, except: [div: 2]
@ -51,7 +51,7 @@ defmodule Temple do
Emits a text node into the markup.
```
htm do
temple do
div do
text "Hello, world!"
end
@ -73,7 +73,7 @@ defmodule Temple do
Emits a Phoenix partial into the markup.
```
htm do
temple do
html lang: "en" do
head do
title "MyApp"
@ -128,7 +128,7 @@ defmodule Temple do
end
end
htm do
temple do
flex id: "my-flex" do
div "Item 1"
div "Item 2"

4
lib/temple/engine.ex
View file

@ -25,7 +25,7 @@ defmodule Temple.Engine do
`assigns` (@conn, etc) are handled the same as normal `Phoenix.HTML.Engine` templates.
Note: The `Temple.htm/1` macro is _not_ needed for Temple templates due to the engine taking care of that for you.
Note: The `Temple.temple/1` macro is _not_ needed for Temple templates due to the engine taking care of that for you.
```
# app.html.exs
@ -78,7 +78,7 @@ defmodule Temple.Engine do
quote do
use Temple
htm do: unquote(template)
temple do: unquote(template)
end
end

12
lib/temple/form.ex
View file

@ -27,7 +27,7 @@ defmodule Temple.Form do
## Example
```
htm do
temple do
form_for @conn, Routes.some_path(@conn, :create) do
text_input form, :name
end
@ -118,7 +118,7 @@ defmodule Temple.Form do
defmacro submit(do: block) do
quote do
{:safe, content} =
htm do
temple do
unquote(block)
end
@ -142,7 +142,7 @@ defmodule Temple.Form do
defmacro submit(opts, do: block) do
quote do
{:safe, content} =
htm do
temple do
unquote(block)
end
@ -177,7 +177,7 @@ defmodule Temple.Form do
defmacro phx_label(form, field, do: block) do
quote do
{:safe, content} =
htm do
temple do
unquote(block)
end
@ -201,7 +201,7 @@ defmodule Temple.Form do
defmacro phx_label(form, field, opts, do: block) do
quote do
{:safe, content} =
htm do
temple do
unquote(block)
end
@ -252,7 +252,7 @@ defmodule Temple.Form do
## Example
```
htm do
temple do
form_for @parent, Routes.some_path(@conn, :create) do
text_input form, :name

4
lib/temple/link.ex
View file

@ -12,7 +12,7 @@ defmodule Temple.Link do
defmacro phx_link(opts, do: block) do
quote do
{:safe, content} =
htm do
temple do
unquote(block)
end
@ -36,7 +36,7 @@ defmodule Temple.Link do
defmacro phx_button(opts, do: block) do
quote do
{:safe, content} =
htm do
temple do
unquote(block)
end

4
lib/temple/tags.ex
View file

@ -2,7 +2,7 @@ defmodule Temple.Tags do
@moduledoc """
The `Temple.Tags` module defines macros for all HTML5 compliant elements.
`Temple.Tags` macros must be called inside of a `Temple.htm/1` block.
`Temple.Tags` macros must be called inside of a `Temple.temple/1` block.
## Attributes
@ -17,7 +17,7 @@ defmodule Temple.Tags do
## Example
```
htm do
temple do
# empty non-void element
div()

74
test/temple/form_test.exs
View file

@ -8,7 +8,7 @@ defmodule Temple.FormTest do
action = "/"
{:safe, result} =
htm do
temple do
form_for(conn, action, [])
end
@ -22,7 +22,7 @@ defmodule Temple.FormTest do
opts = []
{:safe, result} =
htm do
temple do
form_for conn, action, opts do
div()
end
@ -39,7 +39,7 @@ defmodule Temple.FormTest do
opts = []
{:safe, result} =
htm do
temple do
form_for conn, action, opts do
text_input(form, :bob)
end
@ -90,7 +90,7 @@ defmodule Temple.FormTest do
opts = []
{:safe, result} =
htm do
temple do
form_for changeset, action, opts do
text_input(form, :name)
@ -125,7 +125,7 @@ defmodule Temple.FormTest do
opts = []
{:safe, result} =
htm do
temple do
form_for changeset, action, opts do
text_input(form, :name)
@ -154,7 +154,7 @@ defmodule Temple.FormTest do
opts = []
{:safe, result} =
htm do
temple do
form_for conn, action, opts do
checkbox(form, :bob, class: "styles")
end
@ -172,7 +172,7 @@ defmodule Temple.FormTest do
opts = []
{:safe, result} =
htm do
temple do
form_for conn, action, opts do
color_input(form, :bob, class: "styles")
end
@ -190,7 +190,7 @@ defmodule Temple.FormTest do
opts = []
{:safe, result} =
htm do
temple do
form_for conn, action, opts do
date_input(form, :bob, class: "date-styles")
end
@ -208,7 +208,7 @@ defmodule Temple.FormTest do
opts = []
{:safe, result} =
htm do
temple do
form_for conn, action, opts do
date_select(form, :bob, class: "date-styles")
end
@ -223,7 +223,7 @@ defmodule Temple.FormTest do
opts = []
{:safe, result} =
htm do
temple do
form_for conn, action, opts do
datetime_local_input(form, :bob, class: "date-styles")
end
@ -241,7 +241,7 @@ defmodule Temple.FormTest do
opts = []
{:safe, result} =
htm do
temple do
form_for conn, action, opts do
datetime_select(form, :bob, class: "datetime-select-styles")
end
@ -256,7 +256,7 @@ defmodule Temple.FormTest do
opts = []
{:safe, result} =
htm do
temple do
form_for conn, action, opts do
email_input(form, :bob, class: "email-styles")
end
@ -274,7 +274,7 @@ defmodule Temple.FormTest do
opts = [multipart: true]
{:safe, result} =
htm do
temple do
form_for conn, action, opts do
file_input(form, :bob, class: "file-styles")
end
@ -292,7 +292,7 @@ defmodule Temple.FormTest do
opts = []
{:safe, result} =
htm do
temple do
form_for conn, action, opts do
hidden_input(form, :bob, class: "hidden-styles")
end
@ -310,7 +310,7 @@ defmodule Temple.FormTest do
opts = []
{:safe, result} =
htm do
temple do
form_for conn, action, opts do
number_input(form, :bob, class: "number-styles")
end
@ -328,7 +328,7 @@ defmodule Temple.FormTest do
opts = []
{:safe, result} =
htm do
temple do
form_for conn, action, opts do
password_input(form, :bob, class: "password-styles")
end
@ -346,7 +346,7 @@ defmodule Temple.FormTest do
opts = []
{:safe, result} =
htm do
temple do
form_for conn, action, opts do
range_input(form, :bob, class: "range-styles")
end
@ -364,7 +364,7 @@ defmodule Temple.FormTest do
opts = []
{:safe, result} =
htm do
temple do
form_for conn, action, opts do
search_input(form, :bob, class: "search-styles")
end
@ -382,7 +382,7 @@ defmodule Temple.FormTest do
opts = []
{:safe, result} =
htm do
temple do
form_for conn, action, opts do
telephone_input(form, :bob, class: "telephone-styles")
end
@ -400,7 +400,7 @@ defmodule Temple.FormTest do
opts = []
{:safe, result} =
htm do
temple do
form_for conn, action, opts do
text_area(form, :bob)
end
@ -416,7 +416,7 @@ defmodule Temple.FormTest do
opts = []
{:safe, result} =
htm do
temple do
form_for conn, action, opts do
text_area(form, :bob, class: "textarea-styles")
end
@ -433,7 +433,7 @@ defmodule Temple.FormTest do
opts = []
{:safe, result} =
htm do
temple do
form_for conn, action, opts do
time_input(form, :bob, class: "time-styles")
end
@ -451,7 +451,7 @@ defmodule Temple.FormTest do
opts = []
{:safe, result} =
htm do
temple do
form_for conn, action, opts do
time_select(form, :bob)
end
@ -466,7 +466,7 @@ defmodule Temple.FormTest do
opts = []
{:safe, result} =
htm do
temple do
form_for conn, action, opts do
url_input(form, :bob, class: "url-styles")
end
@ -480,7 +480,7 @@ defmodule Temple.FormTest do
test "generates a reset input" do
{:safe, result} =
htm do
temple do
reset("Reset", class: "reset-styles")
end
@ -491,7 +491,7 @@ defmodule Temple.FormTest do
test "generates a submit/1 input" do
{:safe, result} =
htm do
temple do
submit("Submit")
end
@ -503,7 +503,7 @@ defmodule Temple.FormTest do
test "generates a submit/1 input that takes a block" do
{:safe, result} =
htm do
temple do
submit do
text "Submit"
end
@ -517,7 +517,7 @@ defmodule Temple.FormTest do
test "generates a submit/2 input that takes text and opts" do
{:safe, result} =
htm do
temple do
submit("Submit", class: "btn")
end
@ -530,7 +530,7 @@ defmodule Temple.FormTest do
test "generates a submit/2 input that takes opts and a block" do
{:safe, result} =
htm do
temple do
submit class: "btn" do
text "Submit"
end
@ -545,7 +545,7 @@ defmodule Temple.FormTest do
test "generates a phx_label/2 tag" do
{:safe, result} =
htm do
temple do
phx_label(:user, :name)
end
@ -557,7 +557,7 @@ defmodule Temple.FormTest do
test "generates a phx_label/3 with attrs" do
{:safe, result} =
htm do
temple do
phx_label(:user, :name, class: "label-style")
end
@ -570,7 +570,7 @@ defmodule Temple.FormTest do
test "generates a phx_label/3 with text" do
{:safe, result} =
htm do
temple do
phx_label(:user, :name, "Name")
end
@ -582,7 +582,7 @@ defmodule Temple.FormTest do
test "generates a phx_label/3 with block" do
{:safe, result} =
htm do
temple do
phx_label :user, :name do
div do
text "Name"
@ -598,7 +598,7 @@ defmodule Temple.FormTest do
test "generates a phx_label/4 with text and opts" do
{:safe, result} =
htm do
temple do
phx_label(:user, :name, "Name", class: "label-style")
end
@ -611,7 +611,7 @@ defmodule Temple.FormTest do
test "generates a phx_label/4 with block" do
{:safe, result} =
htm do
temple do
phx_label :user, :name, class: "label-style" do
div do
text "Name"
@ -634,7 +634,7 @@ defmodule Temple.FormTest do
]
{:safe, result} =
htm do
temple do
multiple_select(:user, :name, options, class: "label-style")
end
@ -660,7 +660,7 @@ defmodule Temple.FormTest do
]
{:safe, result} =
htm do
temple do
select :user, :name, options, class: "label-style"
end

20
test/temple/link_test.exs
View file

@ -5,7 +5,7 @@ defmodule Temple.LinkTest do
describe "phx_link" do
test "emits a link" do
{:safe, actual} =
htm do
temple do
phx_link("hi", to: "/hello")
end
@ -16,7 +16,7 @@ defmodule Temple.LinkTest do
test "emits a link when passed block that has text" do
{:safe, actual} =
htm do
temple do
phx_link to: "/hello" do
text "hi"
end
@ -30,7 +30,7 @@ defmodule Temple.LinkTest do
test "emits a link when passed block that has more markup" do
{:safe, actual} =
htm do
temple do
phx_link to: "/hello" do
div do
div "hi"
@ -48,7 +48,7 @@ defmodule Temple.LinkTest do
test "emits a link with additional html attributes" do
{:safe, actual} =
htm do
temple do
phx_link("hi",
to: "/hello",
class: "phoenix",
@ -68,7 +68,7 @@ defmodule Temple.LinkTest do
test "emits a link with a non GET method" do
{:safe, actual} =
htm do
temple do
phx_link("hi",
to: "/hello",
method: :delete
@ -86,7 +86,7 @@ defmodule Temple.LinkTest do
describe "phx_button" do
test "emits a button" do
{:safe, actual} =
htm do
temple do
phx_button("hi", to: "/hello")
end
@ -98,7 +98,7 @@ defmodule Temple.LinkTest do
test "emits a button when passed block that has text" do
{:safe, actual} =
htm do
temple do
phx_button to: "/hello" do
text "hi"
end
@ -113,7 +113,7 @@ defmodule Temple.LinkTest do
test "emits a button when passed block that has more markup" do
{:safe, actual} =
htm do
temple do
phx_button to: "/hello" do
div do
div "hi"
@ -132,7 +132,7 @@ defmodule Temple.LinkTest do
test "emits a button with additional html attributes" do
{:safe, actual} =
htm do
temple do
phx_button("hi",
to: "/hello",
class: "phoenix",
@ -152,7 +152,7 @@ defmodule Temple.LinkTest do
test "emits a button with a non GET method" do
{:safe, actual} =
htm do
temple do
phx_button("hi",
to: "/hello",
method: :delete

56
test/temple/tags_test.exs
View file

@ -5,7 +5,7 @@ defmodule Temple.TagsTest do
for tag <- Temple.Tags.nonvoid_elements() do
test "renders a #{tag}" do
{:safe, result} =
htm do
temple do
unquote(tag)()
end
@ -14,7 +14,7 @@ defmodule Temple.TagsTest do
test "renders a #{tag} with attrs" do
{:safe, result} =
htm do
temple do
unquote(tag)(class: "hello")
end
@ -23,7 +23,7 @@ defmodule Temple.TagsTest do
test "renders a #{tag} with content" do
{:safe, result} =
htm do
temple do
unquote(tag)("Hi")
end
@ -32,7 +32,7 @@ defmodule Temple.TagsTest do
test "renders a #{tag} with attrs and content" do
{:safe, result} =
htm do
temple do
unquote(tag)("Hi", class: "hello")
end
@ -41,7 +41,7 @@ defmodule Temple.TagsTest do
test "renders a #{tag} with a block" do
{:safe, result} =
htm do
temple do
unquote(tag)(do: unquote(tag)())
end
@ -50,7 +50,7 @@ defmodule Temple.TagsTest do
test "renders a #{tag} with attrs and a block" do
{:safe, result} =
htm do
temple do
unquote(tag)(class: "hello") do
unquote(tag)()
end
@ -66,7 +66,7 @@ defmodule Temple.TagsTest do
for tag <- Temple.Tags.void_elements() do
test "renders a #{tag}" do
{:safe, result} =
htm do
temple do
unquote(tag)()
end
@ -75,7 +75,7 @@ defmodule Temple.TagsTest do
test "renders a #{tag} with attrs" do
{:safe, result} =
htm do
temple do
unquote(tag)(class: "hello")
end
@ -86,7 +86,7 @@ defmodule Temple.TagsTest do
describe "non-void elements" do
test "renders two divs" do
{:safe, result} =
htm do
temple do
div()
div()
end
@ -96,7 +96,7 @@ defmodule Temple.TagsTest do
test "renders two els in the right order" do
{:safe, result} =
htm do
temple do
div()
span()
end
@ -106,7 +106,7 @@ defmodule Temple.TagsTest do
test "renders an el that taks attrs and a block" do
{:safe, result} =
htm do
temple do
div class: "bob" do
span()
span()
@ -118,7 +118,7 @@ defmodule Temple.TagsTest do
test "renders one els nested inside an el" do
{:safe, result} =
htm do
temple do
div do
span()
end
@ -129,7 +129,7 @@ defmodule Temple.TagsTest do
test "renders two els nested inside an el" do
{:safe, result} =
htm do
temple do
div do
span()
span()
@ -141,7 +141,7 @@ defmodule Temple.TagsTest do
test "renders two divs that are rendered by a loop" do
{:safe, result} =
htm do
temple do
for _ <- 1..2 do
div()
end
@ -152,7 +152,7 @@ defmodule Temple.TagsTest do
test "renders two spans" do
{:safe, result} =
htm do
temple do
span()
span()
end
@ -162,7 +162,7 @@ defmodule Temple.TagsTest do
test "renders a div within a div" do
{:safe, result} =
htm do
temple do
div do
div()
end
@ -173,7 +173,7 @@ defmodule Temple.TagsTest do
test "renders an attribute on a div" do
{:safe, result} =
htm do
temple do
div class: "hello" do
div class: "hi"
end
@ -184,7 +184,7 @@ defmodule Temple.TagsTest do
test "renders an attribute passed in as a map on a div" do
{:safe, result} =
htm do
temple do
div %{class: "hello"} do
div %{"class" => "hi"}
end
@ -198,7 +198,7 @@ defmodule Temple.TagsTest do
attrs2 = [class: "hi"]
{:safe, result} =
htm do
temple do
div attrs1 do
div attrs2
end
@ -209,7 +209,7 @@ defmodule Temple.TagsTest do
test "renders multiple attributes on a div without block" do
{:safe, result} =
htm do
temple do
div class: "hello", id: "12"
end
@ -218,7 +218,7 @@ defmodule Temple.TagsTest do
test "can accept content as the first argument" do
{:safe, result} =
htm do
temple do
div "CONTENT"
div "MORE", class: "hi"
end
@ -231,7 +231,7 @@ defmodule Temple.TagsTest do
more = "MORE"
{:safe, result} =
htm do
temple do
div content
div more, class: "hi"
end
@ -243,7 +243,7 @@ defmodule Temple.TagsTest do
describe "void elements" do
test "renders an input" do
{:safe, result} =
htm do
temple do
input()
end
@ -252,7 +252,7 @@ defmodule Temple.TagsTest do
test "renders an input with an attribute" do
{:safe, result} =
htm do
temple do
input type: "number"
end
@ -263,7 +263,7 @@ defmodule Temple.TagsTest do
interop = "hi"
{:safe, result} =
htm do
temple do
div class: "#{interop} world"
end
@ -274,7 +274,7 @@ defmodule Temple.TagsTest do
describe "escaping" do
test "text is excaped" do
{:safe, result} =
htm do
temple do
text "<div>Text</div>"
end
@ -285,7 +285,7 @@ defmodule Temple.TagsTest do
describe "data attributes" do
test "can have one data attributes" do
{:safe, result} =
htm do
temple do
div data_controller: "stimulus-controller"
end
@ -294,7 +294,7 @@ defmodule Temple.TagsTest do
test "can have multiple data attributes" do
{:safe, result} =
htm do
temple do
div data_controller: "stimulus-controller", data_target: "stimulus-target"
end

24
test/temple_test.exs
View file

@ -7,7 +7,7 @@ defmodule TempleTest do
import Component
{:safe, result} =
htm do
temple do
flex()
end
@ -18,7 +18,7 @@ defmodule TempleTest do
import Component
{:safe, result} =
htm do
temple do
takes_children do
div id: "dynamic-child"
end
@ -32,7 +32,7 @@ defmodule TempleTest do
import Component
{:safe, result} =
htm do
temple do
takes_children do
div id: "dynamic-child-1"
div id: "dynamic-child-2"
@ -47,7 +47,7 @@ defmodule TempleTest do
import Component
{:safe, result} =
htm do
temple do
takes_children name: "mitch" do
text @name
end
@ -61,7 +61,7 @@ defmodule TempleTest do
import Component
{:safe, result} =
htm do
temple do
arbitrary_code()
end
@ -72,7 +72,7 @@ defmodule TempleTest do
import Component
{:safe, result} =
htm do
temple do
uses_conditionals(condition: true)
uses_conditionals(condition: false)
end
@ -84,7 +84,7 @@ defmodule TempleTest do
import Component
{:safe, result} =
htm do
temple do
arbitrary_data(
lists: [:atom, %{key: "value"}, {:status, :tuple}, "string", 1, [1, 2, 3]]
)
@ -100,7 +100,7 @@ defmodule TempleTest do
bob = "hi"
{:safe, result} =
htm do
temple do
variable_as_prop(bob: bob)
end
@ -113,7 +113,7 @@ defmodule TempleTest do
bob = "hi"
{:safe, result} =
htm do
temple do
variable_as_prop_with_block bob: bob do
div()
end
@ -128,7 +128,7 @@ defmodule TempleTest do
props = [bob: "hi"]
{:safe, result} =
htm do
temple do
variable_as_prop(props)
end
@ -141,7 +141,7 @@ defmodule TempleTest do
props = [bob: "hi"]
{:safe, result} =
htm do
temple do
variable_as_prop_with_block props do
div()
end
@ -156,7 +156,7 @@ defmodule TempleTest do
props = %{bob: "hi"}
{:safe, result} =
htm do
temple do
variable_as_prop_with_block props do
div()
end