chore: movs display name helper to won helper module

This commit is contained in:
carla 2026-01-07 09:54:37 +01:00
parent 29a953c038
commit 9f97515d74
10 changed files with 234 additions and 84 deletions

View file

@ -0,0 +1,64 @@
defmodule MvWeb.Helpers.MemberHelpers do
@moduledoc """
Helper functions for member-related operations in the web layer.
Provides utilities for formatting and displaying member information.
"""
alias Mv.Membership.Member
@doc """
Returns a display name for a member.
Combines first_name and last_name if available, otherwise falls back to email.
This ensures that members without names still have a meaningful display name.
## Examples
iex> member = %Member{first_name: "John", last_name: "Doe", email: "john@example.com"}
iex> MvWeb.Helpers.MemberHelpers.display_name(member)
"John Doe"
iex> member = %Member{first_name: nil, last_name: nil, email: "john@example.com"}
iex> MvWeb.Helpers.MemberHelpers.display_name(member)
"john@example.com"
iex> member = %Member{first_name: "John", last_name: nil, email: "john@example.com"}
iex> MvWeb.Helpers.MemberHelpers.display_name(member)
"John"
"""
def display_name(%Member{} = member) do
name_parts =
[member.first_name, member.last_name]
|> Enum.reject(&blank?/1)
|> Enum.map_join(" ", &String.trim/1)
if name_parts == "" do
member.email
else
name_parts
end
end
@doc """
Checks if a value is blank (nil, empty string, or only whitespace).
## Examples
iex> MvWeb.Helpers.MemberHelpers.blank?(nil)
true
iex> MvWeb.Helpers.MemberHelpers.blank?("")
true
iex> MvWeb.Helpers.MemberHelpers.blank?(" ")
true
iex> MvWeb.Helpers.MemberHelpers.blank?("John")
false
"""
def blank?(nil), do: true
def blank?(""), do: true
def blank?(value) when is_binary(value), do: String.trim(value) == ""
def blank?(_), do: false
end

View file

@ -36,7 +36,7 @@ defmodule MvWeb.ContributionPeriodLive.Show do
<.mockup_warning />
<.header>
{gettext("Contributions for %{name}", name: MvWeb.MemberLive.Index.display_name(@member))}
{gettext("Contributions for %{name}", name: MvWeb.Helpers.MemberHelpers.display_name(@member))}
<:subtitle>
{gettext("Contribution type")}:
<span class="font-semibold">{@member.contribution_type}</span>

View file

@ -52,7 +52,7 @@ defmodule MvWeb.CustomFieldValueLive.Form do
options={custom_field_options(@custom_fields)}
prompt={gettext("Choose a custom field")}
/>
<!-- Member Selection -->
<.input
field={@form[:member_id]}
@ -61,7 +61,7 @@ defmodule MvWeb.CustomFieldValueLive.Form do
options={member_options(@members)}
prompt={gettext("Choose a member")}
/>
<!-- Value Input - handles Union type -->
<%= if @selected_custom_field do %>
<.union_value_input form={@form} custom_field={@selected_custom_field} />
@ -289,6 +289,6 @@ defmodule MvWeb.CustomFieldValueLive.Form do
end
defp member_options(members) do
Enum.map(members, &{MvWeb.MemberLive.Index.display_name(&1), &1.id})
Enum.map(members, &{MvWeb.Helpers.MemberHelpers.display_name(&1), &1.id})
end
end

View file

@ -43,7 +43,7 @@ defmodule MvWeb.MemberLive.Form do
<h1 class="text-2xl font-bold text-center flex-1">
<%= if @member do %>
{MvWeb.MemberLive.Index.display_name(@member)}
{MvWeb.Helpers.MemberHelpers.display_name(@member)}
<% else %>
{gettext("New Member")}
<% end %>

View file

@ -1165,61 +1165,6 @@ defmodule MvWeb.MemberLive.Index do
end
end
@doc """
Returns a display name for a member.
Combines first_name and last_name if available, otherwise falls back to email.
This ensures that members without names still have a meaningful display name.
## Examples
iex> member = %Member{first_name: "John", last_name: "Doe", email: "john@example.com"}
iex> display_name(member)
"John Doe"
iex> member = %Member{first_name: nil, last_name: nil, email: "john@example.com"}
iex> display_name(member)
"john@example.com"
iex> member = %Member{first_name: "John", last_name: nil, email: "john@example.com"}
iex> display_name(member)
"John"
"""
def display_name(member) do
name_parts =
[member.first_name, member.last_name]
|> Enum.reject(&blank?/1)
|> Enum.map_join(" ", &String.trim/1)
if name_parts == "" do
member.email
else
name_parts
end
end
@doc """
Checks if a value is blank (nil, empty string, or only whitespace).
## Examples
iex> blank?(nil)
true
iex> blank?("")
true
iex> blank?(" ")
true
iex> blank?("John")
false
"""
def blank?(nil), do: true
def blank?(""), do: true
def blank?(value) when is_binary(value), do: String.trim(value) == ""
def blank?(_), do: false
# Public helper function to format dates for use in templates
def format_date(date), do: DateFormatter.format_date(date)

View file

@ -35,7 +35,7 @@ defmodule MvWeb.MemberLive.Show do
</.button>
<h1 class="text-2xl font-bold text-center flex-1">
{MvWeb.MemberLive.Index.display_name(@member)}
{MvWeb.Helpers.MemberHelpers.display_name(@member)}
</h1>
<.button variant="primary" navigate={~p"/members/#{@member}/edit?return_to=show"}>

View file

@ -44,7 +44,7 @@ defmodule MvWeb.UserLive.Form do
<.form class="max-w-xl" for={@form} id="user-form" phx-change="validate" phx-submit="save">
<.input field={@form[:email]} label={gettext("Email")} required type="email" />
<!-- Password Section -->
<div class="mt-6">
<label class="flex items-center space-x-2">
@ -69,7 +69,7 @@ defmodule MvWeb.UserLive.Form do
required
autocomplete="new-password"
/>
<!-- Only show password confirmation for new users (register_with_password) -->
<%= if !@user do %>
<.input
@ -120,7 +120,7 @@ defmodule MvWeb.UserLive.Form do
<% end %>
<% end %>
</div>
<!-- Member Linking Section -->
<div class="mt-6">
<h2 class="mb-3 text-base font-semibold">{gettext("Linked Member")}</h2>
@ -131,7 +131,7 @@ defmodule MvWeb.UserLive.Form do
<div class="flex items-center justify-between">
<div>
<p class="font-medium text-green-900">
{MvWeb.MemberLive.Index.display_name(@user.member)}
{MvWeb.Helpers.MemberHelpers.display_name(@user.member)}
</p>
<p class="text-sm text-green-700">{@user.member.email}</p>
</div>
@ -210,7 +210,7 @@ defmodule MvWeb.UserLive.Form do
)
]}
>
<p class="font-medium">{MvWeb.MemberLive.Index.display_name(member)}</p>
<p class="font-medium">{MvWeb.Helpers.MemberHelpers.display_name(member)}</p>
<p class="text-sm text-base-content/70">{member.email}</p>
</div>
<% end %>
@ -438,7 +438,7 @@ defmodule MvWeb.UserLive.Form do
member_name =
if selected_member,
do: MvWeb.MemberLive.Index.display_name(selected_member),
do: MvWeb.Helpers.MemberHelpers.display_name(selected_member),
else: ""
# Store the selected member ID and name in socket state and clear unlink flag

View file

@ -57,7 +57,7 @@ defmodule MvWeb.UserLive.Show do
class="text-blue-600 underline hover:text-blue-800"
>
<.icon name="hero-users" class="inline w-4 h-4 mr-1" />
{MvWeb.MemberLive.Index.display_name(@user.member)}
{MvWeb.Helpers.MemberHelpers.display_name(@user.member)}
</.link>
<% else %>
<span class="italic text-gray-500">{gettext("No member linked")}</span>

View file

@ -0,0 +1,141 @@
defmodule MvWeb.Helpers.MemberHelpersTest do
@moduledoc """
Tests for the display_name/1 helper function in MemberHelpers.
"""
use Mv.DataCase, async: true
alias Mv.Membership.Member
alias MvWeb.Helpers.MemberHelpers
describe "display_name/1" do
test "returns full name when both first_name and last_name are present" do
member = %Member{
first_name: "John",
last_name: "Doe",
email: "john@example.com"
}
assert MemberHelpers.display_name(member) == "John Doe"
end
test "returns email when both first_name and last_name are nil" do
member = %Member{
first_name: nil,
last_name: nil,
email: "john@example.com"
}
assert MemberHelpers.display_name(member) == "john@example.com"
end
test "returns first_name only when last_name is nil" do
member = %Member{
first_name: "John",
last_name: nil,
email: "john@example.com"
}
assert MemberHelpers.display_name(member) == "John"
end
test "returns last_name only when first_name is nil" do
member = %Member{
first_name: nil,
last_name: "Doe",
email: "john@example.com"
}
assert MemberHelpers.display_name(member) == "Doe"
end
test "returns email when first_name and last_name are empty strings" do
member = %Member{
first_name: "",
last_name: "",
email: "john@example.com"
}
assert MemberHelpers.display_name(member) == "john@example.com"
end
test "returns email when first_name and last_name are whitespace only" do
member = %Member{
first_name: " ",
last_name: " \t ",
email: "john@example.com"
}
assert MemberHelpers.display_name(member) == "john@example.com"
end
test "trims whitespace from name parts" do
member = %Member{
first_name: " John ",
last_name: " Doe ",
email: "john@example.com"
}
assert MemberHelpers.display_name(member) == "John Doe"
end
test "handles one empty string and one nil" do
member = %Member{
first_name: "",
last_name: nil,
email: "john@example.com"
}
assert MemberHelpers.display_name(member) == "john@example.com"
end
test "handles one nil and one empty string" do
member = %Member{
first_name: nil,
last_name: "",
email: "john@example.com"
}
assert MemberHelpers.display_name(member) == "john@example.com"
end
test "handles one whitespace and one nil" do
member = %Member{
first_name: " ",
last_name: nil,
email: "john@example.com"
}
assert MemberHelpers.display_name(member) == "john@example.com"
end
test "handles one valid name and one whitespace" do
member = %Member{
first_name: "John",
last_name: " ",
email: "john@example.com"
}
assert MemberHelpers.display_name(member) == "John"
end
test "handles member with only first_name containing whitespace" do
member = %Member{
first_name: " John ",
last_name: nil,
email: "john@example.com"
}
assert MemberHelpers.display_name(member) == "John"
end
test "handles member with only last_name containing whitespace" do
member = %Member{
first_name: nil,
last_name: " Doe ",
email: "john@example.com"
}
assert MemberHelpers.display_name(member) == "Doe"
end
end
end

View file

@ -1,11 +1,11 @@
defmodule MvWeb.MemberLive.Index.DisplayNameTest do
defmodule MvWeb.Helpers.MemberHelpersTest do
@moduledoc """
Tests for the display_name/1 helper function in MemberLive.Index.
Tests for the display_name/1 helper function in MemberHelpers.
"""
use Mv.DataCase, async: true
alias Mv.Membership.Member
alias MvWeb.MemberLive.Index
alias MvWeb.Helpers.MemberHelpers
describe "display_name/1" do
test "returns full name when both first_name and last_name are present" do
@ -15,7 +15,7 @@ defmodule MvWeb.MemberLive.Index.DisplayNameTest do
email: "john@example.com"
}
assert Index.display_name(member) == "John Doe"
assert MemberHelpers.display_name(member) == "John Doe"
end
test "returns email when both first_name and last_name are nil" do
@ -25,7 +25,7 @@ defmodule MvWeb.MemberLive.Index.DisplayNameTest do
email: "john@example.com"
}
assert Index.display_name(member) == "john@example.com"
assert MemberHelpers.display_name(member) == "john@example.com"
end
test "returns first_name only when last_name is nil" do
@ -35,7 +35,7 @@ defmodule MvWeb.MemberLive.Index.DisplayNameTest do
email: "john@example.com"
}
assert Index.display_name(member) == "John"
assert MemberHelpers.display_name(member) == "John"
end
test "returns last_name only when first_name is nil" do
@ -45,7 +45,7 @@ defmodule MvWeb.MemberLive.Index.DisplayNameTest do
email: "john@example.com"
}
assert Index.display_name(member) == "Doe"
assert MemberHelpers.display_name(member) == "Doe"
end
test "returns email when first_name and last_name are empty strings" do
@ -55,7 +55,7 @@ defmodule MvWeb.MemberLive.Index.DisplayNameTest do
email: "john@example.com"
}
assert Index.display_name(member) == "john@example.com"
assert MemberHelpers.display_name(member) == "john@example.com"
end
test "returns email when first_name and last_name are whitespace only" do
@ -65,7 +65,7 @@ defmodule MvWeb.MemberLive.Index.DisplayNameTest do
email: "john@example.com"
}
assert Index.display_name(member) == "john@example.com"
assert MemberHelpers.display_name(member) == "john@example.com"
end
test "trims whitespace from name parts" do
@ -75,7 +75,7 @@ defmodule MvWeb.MemberLive.Index.DisplayNameTest do
email: "john@example.com"
}
assert Index.display_name(member) == "John Doe"
assert MemberHelpers.display_name(member) == "John Doe"
end
test "handles one empty string and one nil" do
@ -85,7 +85,7 @@ defmodule MvWeb.MemberLive.Index.DisplayNameTest do
email: "john@example.com"
}
assert Index.display_name(member) == "john@example.com"
assert MemberHelpers.display_name(member) == "john@example.com"
end
test "handles one nil and one empty string" do
@ -95,7 +95,7 @@ defmodule MvWeb.MemberLive.Index.DisplayNameTest do
email: "john@example.com"
}
assert Index.display_name(member) == "john@example.com"
assert MemberHelpers.display_name(member) == "john@example.com"
end
test "handles one whitespace and one nil" do
@ -105,7 +105,7 @@ defmodule MvWeb.MemberLive.Index.DisplayNameTest do
email: "john@example.com"
}
assert Index.display_name(member) == "john@example.com"
assert MemberHelpers.display_name(member) == "john@example.com"
end
test "handles one valid name and one whitespace" do
@ -115,7 +115,7 @@ defmodule MvWeb.MemberLive.Index.DisplayNameTest do
email: "john@example.com"
}
assert Index.display_name(member) == "John"
assert MemberHelpers.display_name(member) == "John"
end
test "handles member with only first_name containing whitespace" do
@ -125,7 +125,7 @@ defmodule MvWeb.MemberLive.Index.DisplayNameTest do
email: "john@example.com"
}
assert Index.display_name(member) == "John"
assert MemberHelpers.display_name(member) == "John"
end
test "handles member with only last_name containing whitespace" do
@ -135,7 +135,7 @@ defmodule MvWeb.MemberLive.Index.DisplayNameTest do
email: "john@example.com"
}
assert Index.display_name(member) == "Doe"
assert MemberHelpers.display_name(member) == "Doe"
end
end
end