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.

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

Jump to bottom

Add unit_separator to #humanize and #humanize_bytes #15176

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
+30 −16
Open

Add unit_separator to #humanize and #humanize_bytes #15176

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
c077a1b
adds separate_unit param to humanize and humanize_bytes + specs
CTC97 Nov 9, 2024
eeb30a0
cleanup :broom:
CTC97 Nov 9, 2024
3bb84d6
Merge branch 'master' into cc/humanize-separate_unit
CTC97 Nov 10, 2024
80c50b9
rework to unit_separator : String
CTC97 Nov 10, 2024
4b41c29
drop type requirement on unit_separator
CTC97 Nov 12, 2024
ef19e52
test cleanup :broom:
CTC97 Nov 15, 2024
87edf74
nit clean :broom:
CTC97 Nov 22, 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
13 changes: 13 additions & 0 deletions spec/std/humanize_spec.cr
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,6 +207,16 @@ describe Number do
it { assert_prints 1.0e+34.humanize, "10,000Q" }
it { assert_prints 1.0e+35.humanize, "100,000Q" }

it { assert_prints 0.humanize(unit_separator: '_'), "0.0" }
it { assert_prints 0.123_456_78.humanize(5, unit_separator: '\u00A0'), "123.46\u00A0m" }
it { assert_prints 1.0e-14.humanize(unit_separator: ' '), "10.0 f" }
it { assert_prints 0.000_001.humanize(unit_separator: '\u2009'), "1.0\u2009µ" }
it { assert_prints 1_000_000_000_000.humanize(unit_separator: "__"), "1.0__T" }
it { assert_prints 0.000_000_001.humanize(unit_separator: "."), "1.0.n" }
it { assert_prints 1.0e+9.humanize(unit_separator: "\t"), "1.0\tG" }
it { assert_prints 123_456_789_012.humanize(unit_separator: 0), "1230G" }
it { assert_prints 123_456_789_012.humanize(unit_separator: nil), "123G" }

it { assert_prints Float32::INFINITY.humanize, "Infinity" }
it { assert_prints (-Float32::INFINITY).humanize, "-Infinity" }
it { assert_prints Float32::NAN.humanize, "NaN" }
Expand Down Expand Up @@ -261,6 +271,7 @@ describe Number do
it { assert_prints 1.0e+8.humanize(prefixes: CUSTOM_PREFIXES), "100d" }
it { assert_prints 1.0e+9.humanize(prefixes: CUSTOM_PREFIXES), "1,000d" }
it { assert_prints 1.0e+10.humanize(prefixes: CUSTOM_PREFIXES), "10,000d" }
it { assert_prints 1.0e+10.humanize(prefixes: CUSTOM_PREFIXES, unit_separator: '\u00A0'), "10,000\u00A0d" }
end
end
end
Expand All @@ -281,6 +292,7 @@ describe Int do
it { assert_prints 1025.humanize_bytes(format: Int::BinaryPrefixFormat::JEDEC), "1.0KB" }
it { assert_prints 1026.humanize_bytes(format: Int::BinaryPrefixFormat::JEDEC), "1.01KB" }
it { assert_prints 2048.humanize_bytes(format: Int::BinaryPrefixFormat::JEDEC), "2.0KB" }
it { assert_prints 2048.humanize_bytes(format: Int::BinaryPrefixFormat::JEDEC, unit_separator: '\u202F'), "2.0\u202FKB" }

it { assert_prints 1536.humanize_bytes(format: Int::BinaryPrefixFormat::JEDEC), "1.5KB" }
it { assert_prints 524288.humanize_bytes(format: Int::BinaryPrefixFormat::JEDEC), "512KB" }
Expand All @@ -289,6 +301,7 @@ describe Int do
it { assert_prints 1099511627776.humanize_bytes(format: Int::BinaryPrefixFormat::JEDEC), "1.0TB" }
it { assert_prints 1125899906842624.humanize_bytes(format: Int::BinaryPrefixFormat::JEDEC), "1.0PB" }
it { assert_prints 1152921504606846976.humanize_bytes(format: Int::BinaryPrefixFormat::JEDEC), "1.0EB" }
it { assert_prints 1152921504606846976.humanize_bytes(format: Int::BinaryPrefixFormat::JEDEC, unit_separator: '\u2009'), "1.0\u2009EB" }

it { assert_prints 1024.humanize_bytes(format: Int::BinaryPrefixFormat::IEC), "1.0kiB" }
it { assert_prints 1073741824.humanize_bytes(format: Int::BinaryPrefixFormat::IEC), "1.0GiB" }
Expand Down
33 changes: 17 additions & 16 deletions src/humanize.cr
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,17 +152,17 @@ struct Number
# delimiter (see `#format`).
#
# See `Int#humanize_bytes` to format a file size.
def humanize(io : IO, precision = 3, separator = '.', delimiter = ',', *, base = 10 ** 3, significant = true, prefixes : Indexable = SI_PREFIXES) : Nil
humanize(io, precision, separator, delimiter, base: base, significant: significant) do |magnitude, _|
def humanize(io : IO, precision = 3, separator = '.', delimiter = ',', *, base = 10 ** 3, significant = true, unit_separator = nil, prefixes : Indexable = SI_PREFIXES) : Nil
Copy link
Member

Choose a reason for hiding this comment

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

I agree, documentation is needed.

We also have an opportunity to mention:

"Consider using '\u00A0' (non -breaking space) as the value for unit_separator, it can prevent the output from being split across lines".

Copy link
Author

Choose a reason for hiding this comment

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

For sure - I'm not immediately seeing where I can add to the docs, can someone point me in the right direction? 😅

humanize(io, precision, separator, delimiter, base: base, significant: significant, unit_separator: unit_separator) do |magnitude, _|
magnitude = Number.prefix_index(magnitude, prefixes: prefixes)
{magnitude, Number.si_prefix(magnitude, prefixes)}
end
end

# :ditto:
def humanize(precision = 3, separator = '.', delimiter = ',', *, base = 10 ** 3, significant = true, prefixes = SI_PREFIXES) : String
def humanize(precision = 3, separator = '.', delimiter = ',', *, base = 10 ** 3, significant = true, unit_separator = nil, prefixes = SI_PREFIXES) : String
String.build do |io|
humanize(io, precision, separator, delimiter, base: base, significant: significant, prefixes: prefixes)
humanize(io, precision, separator, delimiter, base: base, significant: significant, unit_separator: unit_separator, prefixes: prefixes)
end
end

Expand Down Expand Up @@ -215,7 +215,7 @@ struct Number
# ```
#
# See `Int#humanize_bytes` to format a file size.
def humanize(io : IO, precision = 3, separator = '.', delimiter = ',', *, base = 10 ** 3, significant = true, &prefixes : (Int32, Float64) -> {Int32, _} | {Int32, _, Bool}) : Nil
def humanize(io : IO, precision = 3, separator = '.', delimiter = ',', *, base = 10 ** 3, significant = true, unit_separator = nil, &prefixes : (Int32, Float64) -> {Int32, _} | {Int32, _, Bool}) : Nil
if zero? || (responds_to?(:infinite?) && self.infinite?) || (responds_to?(:nan?) && self.nan?)
digits = 0
else
Expand Down Expand Up @@ -259,29 +259,30 @@ struct Number

number.format(io, separator, delimiter, decimal_places: decimal_places, only_significant: significant)

io << unit_separator if unit
io << unit
end

# :ditto:
def humanize(precision = 3, separator = '.', delimiter = ',', *, base = 10 ** 3, significant = true, &) : String
def humanize(precision = 3, separator = '.', delimiter = ',', *, base = 10 ** 3, significant = true, unit_separator = nil, &) : String
String.build do |io|
humanize(io, precision, separator, delimiter, base: base, significant: significant) do |magnitude, number|
humanize(io, precision, separator, delimiter, base: base, significant: significant, unit_separator: unit_separator) do |magnitude, number|
yield magnitude, number
end
end
end

# :ditto:
def humanize(io : IO, precision = 3, separator = '.', delimiter = ',', *, base = 10 ** 3, significant = true, prefixes : Proc) : Nil
humanize(io, precision, separator, delimiter, base: base, significant: significant) do |magnitude, number|
def humanize(io : IO, precision = 3, separator = '.', delimiter = ',', *, base = 10 ** 3, significant = true, unit_separator = nil, prefixes : Proc) : Nil
humanize(io, precision, separator, delimiter, base: base, significant: significant, unit_separator: unit_separator) do |magnitude, number|
prefixes.call(magnitude, number)
end
end

# :ditto:
def humanize(precision = 3, separator = '.', delimiter = ',', *, base = 10 ** 3, significant = true, prefixes : Proc) : String
def humanize(precision = 3, separator = '.', delimiter = ',', *, base = 10 ** 3, significant = true, unit_separator = nil, prefixes : Proc) : String
String.build do |io|
humanize(io, precision, separator, delimiter, base: base, significant: significant, prefixes: prefixes)
humanize(io, precision, separator, delimiter, base: base, significant: significant, unit_separator: unit_separator, prefixes: prefixes)
end
end
end
Expand Down Expand Up @@ -321,7 +322,7 @@ struct Int
# ```
#
# See `Number#humanize` for more details on the behaviour and arguments.
def humanize_bytes(io : IO, precision : Int = 3, separator = '.', *, significant : Bool = true, format : BinaryPrefixFormat = :IEC) : Nil
def humanize_bytes(io : IO, precision : Int = 3, separator = '.', *, significant : Bool = true, unit_separator = nil, format : BinaryPrefixFormat = :IEC) : Nil
humanize(io, precision, separator, nil, base: 1024, significant: significant) do |magnitude|
magnitude = Number.prefix_index(magnitude)

Expand All @@ -330,19 +331,19 @@ struct Int
unit = "B"
else
if format.iec?
unit = "#{prefix}iB"
unit = "#{unit_separator}#{prefix}iB"
else
unit = "#{prefix.upcase}B"
unit = "#{unit_separator}#{prefix.upcase}B"
end
end
{magnitude, unit, magnitude > 0}
end
end

# :ditto:
def humanize_bytes(precision : Int = 3, separator = '.', *, significant : Bool = true, format : BinaryPrefixFormat = :IEC) : String
def humanize_bytes(precision : Int = 3, separator = '.', *, significant : Bool = true, unit_separator = nil, format : BinaryPrefixFormat = :IEC) : String
String.build do |io|
humanize_bytes(io, precision, separator, significant: significant, format: format)
humanize_bytes(io, precision, separator, significant: significant, unit_separator: unit_separator, format: format)
end
end
end