crowdhailer/eex_html

Extension to Embedded Elixir (EEx), that allows content to be safely embedded into HTML.

EExHTML

Extension to Embedded Elixir (EEx), that allows content to be safely embedded into HTML.

• Install from hex.pm
• Documentation available on hexdoc

Usage

iex> title = "EEx Rocks!"
iex> content = ~E"<h1><%= title %></h1>"
iex> "#{content}"
"<h1>EEx Rocks!</h1>"

iex> title = "<script>"
iex> content = ~E"<h1><%= title %></h1>"
iex> "#{content}"
"<h1>&lt;script&gt;</h1>"

Elixir language proposal

I would like to see this project as part of the Elixir language. The reasons for this are explained in this proposal.

eex_html's Issues

Library fails to compile: no function clause matching in EExHTML.sigil_E/2

After an Elixir & OTP update this library fails to compile with the following reason:

==> eex_html
Compiling 3 files (.ex)

== Compilation error in file lib/eex_html.ex ==
** (FunctionClauseError) no function clause matching in EExHTML.sigil_E/2    
    expanding macro: EExHTML.sigil_E/2
    lib/eex_html.ex:255: EExHTML.javascript_variables/1
    (elixir 1.11.3) lib/kernel/parallel_compiler.ex:314: anonymous fn/4 in Kernel.ParallelCompiler.spawn_workers/7

My elixir version:

└──╼ elixir -v
Erlang/OTP 23 [erts-11.1.6] [source] [64-bit] [smp:8:8] [ds:8:8:10] [async-threads:1] [hipe]

Elixir 1.11.3 (compiled with Erlang/OTP 23)

Opening this repo in my IDE it looks like the javascript_variables function doesn't know the ~E sigil. Maybe Elixir no longer allows using sigils in the same file that declared them? The same error also occurs on the Elixir master 0.12 development branch.

Fix link in mix.exs

points to raxx, needs to point to this repo

if condition needs an else clause or it will crash

If you use an if structure, you need to add an else clause, or nil will be added to the output, which will crash when the content is attempted to convert to string.

For example here, the empty else clause is required, to return an empty string instead of nil:

<%= raw(if ... do %>
  <%= ... %>
<% else %>
<% end) %>

for and other control structures need raw() to escape contents

If you use for, if, case etc. structures, you need to wrap it in raw() to prevent escaping of the contents:

<%= for i <- 1..10 do %> <span id="<%= i %>"></span><% end %>
<%= raw(for i <- 1..10 do %> <span id="<%= i %>"></span><% end) %>

results in

<span id="1"></span> <span id="2"></span> <span id="3"></span> <span id="4"></span> <span id="5"></span> <span id="6"></span> <span id="7"></span> <span id="8"></span> <span id="9"></span> <span id="10"></span>
<span id="1"></span> <span id="2"></span> <span id="3"></span> <span id="4"></span> <span id="5"></span> <span id="6"></span> <span id="7"></span> <span id="8"></span> <span id="9"></span> <span id="10"></span>

This is inconsistent with the behaviour of Phoenix, for example. It would be more convenient to not need to wrap the structures in raw().

Fix warnings that come from the `EEx.HTML.Safe` protocol warnings.

:0: Unknown function 'Elixir.EEx.HTML.Safe.Atom':'__impl__'/1
:0: Unknown function 'Elixir.EEx.HTML.Safe.BitString':'__impl__'/1
:0: Unknown function 'Elixir.EEx.HTML.Safe.Float':'__impl__'/1
:0: Unknown function 'Elixir.EEx.HTML.Safe.Function':'__impl__'/1
:0: Unknown function 'Elixir.EEx.HTML.Safe.Integer':'__impl__'/1
:0: Unknown function 'Elixir.EEx.HTML.Safe.List':'__impl__'/1
:0: Unknown function 'Elixir.EEx.HTML.Safe.Map':'__impl__'/1
:0: Unknown function 'Elixir.EEx.HTML.Safe.PID':'__impl__'/1
:0: Unknown function 'Elixir.EEx.HTML.Safe.Port':'__impl__'/1
:0: Unknown function 'Elixir.EEx.HTML.Safe.Reference':'__impl__'/1
:0: Unknown function 'Elixir.EEx.HTML.Safe.Tuple':'__impl__'/1

I think these warnings can be fixed by adding an implementation for each of the types.
It would be overkill because everysingle implementation would just call the implementation of String.Chars.to_string and escape the result.

Because I have an implementation for Any I think they would all be redundant an exist only to clean up these warnings.

Is there a better way to fix this?

Issue copied from CrowdHailer/raxx#133

Unexpected EEx.Engine state

I am trying to update elixir from 1.7.4 to 1.16.2.
I am running into a compilation error.

Compilation error in file lib/myapp/api/actions/support/some_action.ex ==
** (RuntimeError) unexpected EEx.Engine state: {{:., [], [{:__aliases__, [alias: false], [:EExHTML]}, :raw]}, [], [[]]}. This typically means a bug or an outdated EEx.Engine or tool
    (eex 1.16.2) lib/eex/engine.ex:218: EEx.Engine.check_state!/1
    (eex 1.16.2) lib/eex/engine.ex:181: EEx.Engine.handle_text/3
    (eex 1.16.2) lib/eex/compiler.ex:321: EEx.Compiler.generate_buffer/4
    (raxx_view 0.1.7) expanding macro: Raxx.View.__using__/1
    lib/myapp/api/actions/support/some_action:6: SomeAction (module)
    (elixir 1.16.2) expanding macro: Kernel.use/2
    lib/myapp/api/actions/support/some_action.ex:6: SomeAction (module)
    expanding macro: MyApp.API.SupportLayout.__using__/1

I have an action like

def SomeAction
  ...
    use MyApp.API.SupportLayout,
    arguments: [:transaction],
    template: Path.join(__DIR__, "transaction.html.eex")

...
end

Support Layout

defmodule MyApp.API.SupportLayout do
  use Raxx.View.Layout,
    optional: [
      page_title: "Admin",
      with_navbar: true,
      message: nil,
      message_type: "info"
    ]
end

EEx.Engine.check_state!/1 expects %{binary: _, dynamic: _, vars_count: _} which was added in Elixir v1.8.
EExHTML.Engine.init/1 doesn't set any of these params.