humane 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 433a88d823e187b4481fb3c2632ba816b487b3b8047f272b5c4b17a930b6227b
-  data.tar.gz: 5c90d3a7ee778274382e8ca25d604d39e672333ddfb8985941b97e7ce345f335
+  metadata.gz: 572a6a4a29165d48eec68db31af6cb222a88de6f989099d353811225898c4673
+  data.tar.gz: cfc60adb65c39694c156f7b173d053431d469ec26d1bf98a584c83b05bfc5887
 SHA512:
-  metadata.gz: 42ceb33a1bd570aa85b8cc5a9417204fcd9d6041e79e6e44c3b7a65469f9139c2897019afef22aab9269bd3956599c2e1ed430021a64f399a2fc6fac0e996c30
-  data.tar.gz: fc9eaa4b043bf6547444631fde9fa2bba69c493ecc07d5e43375ac65f6a20c9f607c73776c7f3e535080a4d2c682747cb8bff8e017e5ddfe67a0f79e3869a4ae
+  metadata.gz: baa6946270a2a9bcaa4636993324df9cae89da3ff2a753552bc21bcdc5569a9fe10075dc48e4e2e910a2f50d811ff324bf7e7ce59168c03025cc2f2157626d5e
+  data.tar.gz: 4dc6ee4899fe1ae32d33c36307a5a01bef49cf34fb368668b28bd584cae6bce38d9a00be13d9aef532020015d40f00375c1c9ad8299380882bdcc29935469f78

data/README.md

@@ -45,6 +45,24 @@ or in a `Gemfile`:
 gem "humane"
 ```
 
+## Beyond Foundation's defaults
+
+Two options on `Humane::TimeFormatter`, both off by default so it matches
+`RelativeDateTimeFormatter` exactly out of the box:
+
+- `include_seconds` (default `false`): below a minute, collapses to "less than a
+  minute ago"/"in less than a minute" instead of an exact second count. Named after
+  ActionView's `include_seconds`, which defaults the same way.
+- `approximate` (default `false`): prefixes "about"/"in about" on buckets of an hour
+  or larger, the way ActionView's `distance_of_time_in_words` does past that same
+  boundary -- for a render that can't refresh itself and shouldn't overstate its own
+  precision.
+
+```ruby
+Humane::TimeFormatter.new(approximate: true).string(at: t - 15 * 3600, relative_to: t)
+# => "about 15 hours ago"
+```
+
 ## Scope
 
 Finder's `.file` byte-count style, and a numeric (non-calendar-aware)

data/lib/humane/time_formatter.rb

@@ -4,8 +4,10 @@ module Humane
   # Formats one time relative to another the way Finder-adjacent tools do.
   class TimeFormatter
     # include_seconds shows exact seconds under a minute instead of collapsing to "less than a minute ago/in less than a minute". Defaults to false, matching ActionView's include_seconds.
-    def initialize(include_seconds: false)
+    # approximate prefixes "about"/"in about" on buckets of an hour or more, matching ActionView's distance_of_time_in_words past that same boundary. Defaults to false.
+    def initialize(include_seconds: false, approximate: false)
       @include_seconds = include_seconds
+      @approximate = approximate
     end
 
     # Returns the time at `at` relative to `relative_to` as a human-readable string.
@@ -29,6 +31,8 @@ module Humane
           pluralize((seconds / 86_400.0).round, "day")
         end
 
+      text = "about #{text}" if @approximate && seconds >= 3600
+
       future ? "in #{text}" : "#{text} ago"
     end
 

data/lib/humane/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Humane
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: humane
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - John Woodell