humane-ruby
Human-readable file sizes (1000-based math, capitalized labels, the way Mac
Finder displays them) and relative times ("3 minutes ago", "in 3 hours")
for Ruby and Go HTML templates -- as simple to drop in as ActionView's own
helpers, with output that's consistent with
humane (Go) and
humane-swift.
require "humane"
Humane::SizeFormatter.human_size(225_935) # "226 KB"
Humane::TimeFormatter.time_ago(Time.now - 180, Time.now) # "3 minutes ago"
Install
gem install humane
or in a Gemfile:
gem "humane"
time_ago options
time_ago's recommended defaults already match ActionView's own
distance_of_time_in_words defaults -- pass no keyword arguments at all and
you get them for free:
Humane::TimeFormatter.time_ago(at, relative_to) # approximate: true, include_seconds: false
approximate(defaulttrue): prefixes"about"/"in about"on the hour-scale buckets (1 hour, and 2..24 hours), matching ActionView'sdistance_of_time_in_wordswording for those buckets exactly (down to its 44:30/89:30 rounding cutoffs), through the "1 day" bucket.include_seconds(defaultfalse): under 30 seconds, collapses to"less than a minute ago"/"in less than a minute"instead of an exact second count. Matches ActionView'sinclude_secondsdefault.when_nil(defaultnil): ifatisnil,time_agoreturns this value without formatting -- for a scan, download, or other record that doesn't have a timestamp yet.
Humane::TimeFormatter.time_ago(t, now, approximate: false) # "15 hours ago", not "about 15 hours ago"
Humane::TimeFormatter.time_ago(nil, now, when_nil: "an unknown time") # "an unknown time"
Scope
Finder's byte-count style, and a numeric (non-calendar-aware) relative time
style through the "1 day" bucket -- that's the whole surface area today.
Alternate size units/styles and a :named style ("yesterday",
calendar-boundary-aware) aren't implemented -- contributions welcome.
Development
bundle exec standardrb
bundle exec rspec -fd spec