joao.dubas/ex_trainer
1
0
Fork 0
Code Issues 1 Pull Requests 2 Projects Releases Wiki Activity

chore(growth): improve age documentation and typing

Browse Source
This commit is contained in:
João Paulo Dubas 2024-06-09 19:59:33 +00:00
parent 025ab1537d
commit d3c1aa9b6b
Signed by: joao.dubas
SSH Key Fingerprint: SHA256:V1mixgOGRc/YMhGx/DNkOSmJxgA2vHNrDZEk3wt/kOA
1 changed files with 11 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
lib/growth/calc/age.ex
View File

@ -3,6 +3,8 @@ defmodule Growth.Calc.Age do
Calculate the age in months. Calculate the age in months.
""" """
@type precision :: :day | :week | :month | :year
# NOTE: (jpd): based on [WHO instructions][0] # NOTE: (jpd): based on [WHO instructions][0]
# [0]: https://cdn.who.int/media/docs/default-source/child-growth/child-growth-standards/indicators/instructions-en.pdf # [0]: https://cdn.who.int/media/docs/default-source/child-growth/child-growth-standards/indicators/instructions-en.pdf
@day_in_month 30.4375 @day_in_month 30.4375
@ -10,16 +12,22 @@ defmodule Growth.Calc.Age do
@day_in_week 7.0 @day_in_week 7.0
@doc """ @doc """
Calculate the age with the precision of day, or week, or month. For age in weeks or months, considers completed ones, removing decimal value. Calculate the age with the precision of `:day`, or `:week`, or `:month`, considering the measurement date as today.
If only date of birth is available, assumes that measurement date is today. For age in weeks or months, considers completed ones, removing decimal value.
""" """
@spec calculate(:day | :week | :month, Date.t(), Date.t()) :: pos_integer() @spec calculate(precision(), Date.t(), Date.t()) :: pos_integer()
def calculate(precision, date_of_birth) do def calculate(precision, date_of_birth) do
calculate(precision, date_of_birth, Date.utc_today()) calculate(precision, date_of_birth, Date.utc_today())
end end
@doc """
Calculate the age with the precision of `:day`, or `:week`, or `:month`.
For age in weeks or months, considers completed ones, removing decimal value.
"""
def calculate(:month, date_of_birth, date_of_measurement) do def calculate(:month, date_of_birth, date_of_measurement) do
:day :day
|> calculate(date_of_birth, date_of_measurement) |> calculate(date_of_birth, date_of_measurement)