Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Introduce assign/2 to set many assigns #600

Merged
merged 1 commit into from
May 14, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion lib/bamboo/template.ex
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,25 @@ defmodule Bamboo.Template do
end

@doc """
Sets an assign for the email. These will be available when rendering the email
Sets many assigns for an email. Accepts a map or a keyword list. See
`assign/3` for more.

## Example

new_email()
|> assign(%{user: user})
|> render(:template_name)

new_email()
|> assign(user: user)
|> render(:template_name)
"""
def assign(%{assigns: assigns} = email, attrs) when is_map(attrs) or is_list(attrs) do
%{email | assigns: Enum.into(attrs, assigns)}
end

@doc """
Sets an assign for the email. These will be available when rendering the email.

## Example

Expand Down
57 changes: 57 additions & 0 deletions test/lib/bamboo/template_test.exs
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,12 @@ defmodule Bamboo.TemplateTest do
|> render(:email_with_assigns)
end

def email_with_many_assigns(user) do
new_email()
|> assign(%{user: user})
|> render(:email_with_assigns)
end

def html_email do
new_email()
|> render("html_email.html")
Expand Down Expand Up @@ -130,6 +136,11 @@ defmodule Bamboo.TemplateTest do
email = Email.email_with_already_assigned_user(%{name: name})
assert email.html_body =~ "<strong>#{name}</strong>"
assert email.text_body =~ name

name = "Paul"
email = Email.email_with_many_assigns(%{name: name})
assert email.html_body =~ "<strong>#{name}</strong>"
assert email.text_body =~ name
end

test "render/2 renders html body if template extension is .html" do
Expand Down Expand Up @@ -183,4 +194,50 @@ defmodule Bamboo.TemplateTest do
EmailNoView.no_view()
end
end

describe "assign/2" do
test "it accepts a map of assigns" do
email =
Bamboo.Email.new_email()
|> Bamboo.Template.assign(%{name: "Jules"})

assert %{name: "Jules"} = email.assigns
end

test "it accepts a list of assigns" do
email =
Bamboo.Email.new_email()
|> Bamboo.Template.assign(name: "Jules")

assert %{name: "Jules"} = email.assigns
end

test "it overrides any existing assigns with the same keys" do
email =
Bamboo.Email.new_email()
|> Bamboo.Template.assign(name: "James")
|> Bamboo.Template.assign(name: "Jules")

assert %{name: "Jules"} = email.assigns
end
end

describe "assign/3" do
test "sets given assign in list of assigns" do
email =
Bamboo.Email.new_email()
|> Bamboo.Template.assign(:name, "Jules")

assert %{name: "Jules"} = email.assigns
end

test "overrides any assigns already listed" do
email =
Bamboo.Email.new_email()
|> Bamboo.Template.assign(:name, "James")
|> Bamboo.Template.assign(:name, "Jules")

assert %{name: "Jules"} = email.assigns
end
end
end