threeaccents
Dealing with private and public function default conflicts
I wanted to see how others deal with private and public function defaults conflict. In my context I like to have public functions that take the current_user from the request what ever other arguments are needed with a “matching” private function that only takes the arguments after the public function does some authorization.
here is a quick example of update user
# user context
def update_user(%User{} = current_user, %UpdateUser{} = update_user) do
with :ok <- authorize(:update_user, current_user, update_user),
{:ok, updated_user} <- update_user(update_user) do
# some logic
end
end
defp update_user(%UpdateUser{} = update_user) do
# some logic
end
This works great 95% of the time but sometimes certain functions need to have default parameters
def list_company_users(%User{} = current_user, company_id, filters \\ %{}) do
# some logic
end
defp list_company_users(company_id, filters) do
# some logic
end
For situations like this there is a conflict of having a private and a public function
defp list_company_users/2 conflicts with defaults from list_company_users/3
As a hacky workaround I made the arguments of the private function a tuple.
defp list_company_users({company_id, filters}) do
# some logic
end
I was curious if anyone else used a similar pattern and what solution they’ve taken when running into this issue.
Marked As Solved
sanswork
Personally I’d use different names for the private functions. To add to this I know _function is pretty common for private, personally I use function/do_function
def update_user
defp do_update_user
Anything will work as long as you’re consistent though then you don’t have to go check the def.
Also Liked
dimitarvp
Seconded, I use the do_* private functions notations myself. Mostly because I have no better idea. 
Aetherus
It seems that do_* has become a convention 
By the way, I follow this convention, too.
eksperimental
This is one of my favorite patterns, the _guarded suffix. You do all your guard checks in your public function, and you delegate to a private one and call it recursively if needed, without checking for a guard again and increasing performance.
This is the current implementation for Keyword.update/4
@spec update(t, key, default :: value, (existing_value :: value -> new_value :: value)) :: t
def update(keywords, key, default, fun)
when is_list(keywords) and is_atom(key) and is_function(fun, 1) do
update_guarded(keywords, key, default, fun)
end
defp update_guarded([{key, value} | keywords], key, _default, fun) do
[{key, fun.(value)} | delete(keywords, key)]
end
defp update_guarded([{_, _} = pair | keywords], key, default, fun) do
[pair | update_guarded(keywords, key, default, fun)]
end
defp update_guarded([], key, default, _fun) do
[{key, default}]
end
kokolegorille
There is no way to detect if You call list_company_users/3 without filter, and list_company_users/2
You might add guard clauses…
# Use when is_binary if You use binary id.
def list_company_users(%User{} = current_user, company_id, filters \\ %{}) when is_integer(company_id) do
# some logic
end
defp list_company_users(company_id, filters) when is_map(filters) do
# some logic
end
I also prefer do_* for private functions…
You might also check how to use function’s signature
threeaccents
Thank you for all the replies. It does seem the Elixir community has a convention of doing do_* for private functions. I’m going to try it out and see how it feels.
Thank you everyone for the replies!







