Skip to content

dk_use_iodata_for_datetime_formatting #14130

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.

Sign up for GitHub

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

Merged
merged 10 commits into from
Dec 31, 2024
Merged

dk_use_iodata_for_datetime_formatting #14130

Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
4f66340
dk_use_iodata_when_formatting_dates
dkuku Dec 30, 2024
621cef0
add datatime_to_iodata
dkuku Dec 30, 2024
9303f84
optimize_microseconds_conversion
dkuku Dec 30, 2024
75ed764
use integers instead of 1 byte strings
dkuku Dec 30, 2024
6f63ca3
add docs
dkuku Dec 30, 2024
7025133
typo
dkuku Dec 30, 2024
e091108
use improper lists, add missing spec, update tests
dkuku Dec 30, 2024
09eb9bf
docs update
dkuku Dec 31, 2024
fbdf235
add newline
dkuku Dec 31, 2024
3a1a74e
Apply suggestions from code review
josevalim Dec 31, 2024
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
96 changes: 68 additions & 28 deletions lib/elixir/lib/calendar/iso.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1237,11 +1237,19 @@ defmodule Calendar.ISO do

## Examples

iex> Calendar.ISO.time_to_iodata(2, 2, 2, {2, 6})
[[["0", "2"], 58, ["0", "2"], 58, ["0", "2"]], 46, ["00000", "2"]]
iex> data = Calendar.ISO.time_to_iodata(2, 2, 2, {2, 6})
iex> IO.iodata_to_binary(data)
"02:02:02.000002"

"""
@doc since: "1.19.0"
@spec time_to_iodata(
Calendar.hour(),
Calendar.minute(),
Calendar.second(),
Calendar.microsecond(),
:basic | :extended
) :: iodata
def time_to_iodata(
hour,
minute,
Expand All @@ -1261,15 +1269,16 @@ defmodule Calendar.ISO do
defp time_to_iodata_guarded(hour, minute, second, {microsecond, precision}, format) do
[
time_to_iodata_format(hour, minute, second, format),
?.,
microseconds_to_iodata(microsecond, precision)
?.
| microseconds_to_iodata(microsecond, precision)
]
end

defp microseconds_to_iodata(_microsecond, 0), do: []
defp microseconds_to_iodata(microsecond, 6), do: zero_pad(microsecond, 6)
@doc false
def microseconds_to_iodata(_microsecond, 0), do: []
def microseconds_to_iodata(microsecond, 6), do: zero_pad(microsecond, 6)

defp microseconds_to_iodata(microsecond, precision) do
def microseconds_to_iodata(microsecond, precision) do
Copy link
Contributor Author

@dkuku dkuku Dec 30, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I need it in the next pr

num = div(microsecond, div_factor(precision))
zero_pad(num, precision)
end
Expand All @@ -1281,11 +1290,11 @@ defmodule Calendar.ISO do
defp div_factor(5), do: 10

defp time_to_iodata_format(hour, minute, second, :extended) do
[zero_pad(hour, 2), ?:, zero_pad(minute, 2), ?:, zero_pad(second, 2)]
[zero_pad(hour, 2), ?:, zero_pad(minute, 2), ?: | zero_pad(second, 2)]
end

defp time_to_iodata_format(hour, minute, second, :basic) do
[zero_pad(hour, 2), zero_pad(minute, 2), zero_pad(second, 2)]
[zero_pad(hour, 2), zero_pad(minute, 2) | zero_pad(second, 2)]
end

@doc """
Expand Down Expand Up @@ -1324,8 +1333,9 @@ defmodule Calendar.ISO do

## Examples

iex> Calendar.ISO.date_to_iodata(2015, 2, 28)
["2015", 45, ["0", "2"], 45, "28"]
iex> data = Calendar.ISO.date_to_iodata(2015, 2, 28)
iex> IO.iodata_to_binary(data)
"2015-02-28"
"""
@doc since: "1.19.0"
@spec date_to_iodata(year, month, day, :basic | :extended) :: iodata
Expand All @@ -1336,11 +1346,11 @@ defmodule Calendar.ISO do
end

defp date_to_iodata_guarded(year, month, day, :extended) do
[zero_pad(year, 4), ?-, zero_pad(month, 2), ?-, zero_pad(day, 2)]
[zero_pad(year, 4), ?-, zero_pad(month, 2), ?- | zero_pad(day, 2)]
end

defp date_to_iodata_guarded(year, month, day, :basic) do
[zero_pad(year, 4), zero_pad(month, 2), zero_pad(day, 2)]
[zero_pad(year, 4), zero_pad(month, 2) | zero_pad(day, 2)]
end

@doc """
Expand Down Expand Up @@ -1402,11 +1412,26 @@ defmodule Calendar.ISO do

## Examples

iex> Calendar.ISO.naive_datetime_to_iodata(2015, 2, 28, 1, 2, 3, {4, 6}, :basic)
[["2015", ["0", "2"], "28"], 32, [[["0", "1"], ["0", "2"], ["0", "3"]], 46, ["00000", "4"]]]
iex> data = Calendar.ISO.naive_datetime_to_iodata(2015, 2, 28, 1, 2, 3, {4, 6}, :basic)
iex> IO.iodata_to_binary(data)
"20150228 010203.000004"

iex> data = Calendar.ISO.naive_datetime_to_iodata(2015, 2, 28, 1, 2, 3, {4, 6}, :extended)
iex> IO.iodata_to_binary(data)
"2015-02-28 01:02:03.000004"

"""
@doc since: "1.19.0"
@spec naive_datetime_to_string(
year,
month,
day,
Calendar.hour(),
Calendar.minute(),
Calendar.second(),
Calendar.microsecond(),
:basic | :extended
) :: iodata
def naive_datetime_to_iodata(
year,
month,
Expand All @@ -1419,8 +1444,8 @@ defmodule Calendar.ISO do
) do
[
date_to_iodata(year, month, day, format),
?\s,
time_to_iodata(hour, minute, second, microsecond, format)
?\s
| time_to_iodata(hour, minute, second, microsecond, format)
]
end

Expand Down Expand Up @@ -1512,11 +1537,26 @@ defmodule Calendar.ISO do
## Examples

iex> time_zone = "Etc/UTC"
iex> Calendar.ISO.datetime_to_iodata(2017, 8, 1, 1, 2, 3, {4, 5}, time_zone, "UTC", 0, 0)
[["2017", 45, ["0", "8"], 45, ["0", "1"]], 32, [[["0", "1"], 58, ["0", "2"], 58, ["0", "3"]], 46, ["0000", "0"]], 90, []]
iex> data = Calendar.ISO.datetime_to_iodata(2017, 8, 1, 1, 2, 3, {4, 5}, time_zone, "UTC", 0, 0)
iex> IO.iodata_to_binary(data)
"2017-08-01 01:02:03.00000Z"

"""
@doc since: "1.19.0"
@spec datetime_to_iodata(
year,
month,
day,
Calendar.hour(),
Calendar.minute(),
Calendar.second(),
Calendar.microsecond(),
Calendar.time_zone(),
Calendar.zone_abbr(),
Calendar.utc_offset(),
Calendar.std_offset(),
:basic | :extended
) :: iodata
def datetime_to_iodata(
year,
month,
Expand Down Expand Up @@ -1562,15 +1602,15 @@ defmodule Calendar.ISO do
end

defp format_offset(total, hour, minute, :extended) do
[sign(total), zero_pad(hour, 2), ?:, zero_pad(minute, 2)]
[sign(total), zero_pad(hour, 2), ?: | zero_pad(minute, 2)]
end

defp format_offset(total, hour, minute, :basic) do
[sign(total), zero_pad(hour, 2), zero_pad(minute, 2)]
[sign(total), zero_pad(hour, 2) | zero_pad(minute, 2)]
end

defp zone_to_iodata(_, _, _, "Etc/UTC"), do: []
defp zone_to_iodata(_, _, abbr, zone), do: [?\s, abbr, ?\s, zone]
defp zone_to_iodata(_, _, abbr, zone), do: [?\s, abbr, ?\s | zone]

@doc """
Determines if the date given is valid according to the proleptic Gregorian calendar.
Expand Down Expand Up @@ -1639,16 +1679,16 @@ defmodule Calendar.ISO do

case max(count - byte_size(num), 0) do
0 -> num
1 -> ["0", num]
2 -> ["00", num]
3 -> ["000", num]
4 -> ["0000", num]
5 -> ["00000", num]
1 -> ["0" | num]
2 -> ["00" | num]
3 -> ["000" | num]
4 -> ["0000" | num]
5 -> ["00000" | num]
end
end

defp zero_pad(val, count) do
[?-, zero_pad(-val, count)]
[?- | zero_pad(-val, count)]
end

@doc """
Expand Down