humane 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94b64259f8b2dc0d78f3f6feb6b48b4d908f23bfa74f133d901c57f5232294bd
-  data.tar.gz: 65e61cee90061fb0eba0e08053c2d24104d7e7d8bc711b8789661a5b27dd9f52
+  metadata.gz: 9f1d568f746432126417fdd6541c249d81475c663e4e9ae9a772fcbc1dc59e3f
+  data.tar.gz: f85e12c6dbd402a4a1d452ba4629e6921418ff8609d6222333b17c1b51ae6a05
 SHA512:
-  metadata.gz: a3320656c10207ff6e941325d26085bc16acb4a56807cf4daafd2bb7560396cd36a37afcc77b270114b330d83ae9e0a7b8b394444958b0a7f96207a775c9492a
-  data.tar.gz: 84d09dac947371900807718502d17055a914b91e58833a10fc2868c0179794fbf8ba80a42d14b359aef4fa4c32c2dbdcaa9265d737195f90c7978bc381a2dce2
+  metadata.gz: fa9e176a20d540c3c325c6f1015c2353b2fbced72397d9bcb645eea021129341781543399ac0a94d1cde5b885e64738e7d723d14c2bfb8548c3b7f7d392664cd
+  data.tar.gz: e59a7270df069333babc2d10f6234bbb507853b9b2c1583e437e41f1451a1f0dd6bc82cba1f88ec83989bb31a2957132f8d8c38a4bd96a056fb1a1b293ebd39f

data/README.md

@@ -22,6 +22,14 @@ time_formatter = Humane::TimeFormatter.new
 time_formatter.string(at: Time.now - 180, relative_to: Time.now) # "3 minutes ago"
 ```
 
+Both methods also accept positional arguments, matching `humane` (Go)'s
+positional-only calling convention:
+
+```ruby
+Humane::SizeFormatter.new.string(225_935) # "226 KB"
+time_formatter.string(Time.now - 180, Time.now) # "3 minutes ago"
+```
+
 Corresponding functions in Swift will have consistent output.
 
 ```swift
@@ -52,8 +60,11 @@ gem "humane"
 
 ## Beyond Foundation's defaults
 
-Two options on `Humane::TimeFormatter`, both off by default so it matches
-`RelativeDateTimeFormatter` exactly out of the box:
+Foundation is the baseline every default matches exactly, in all three
+languages -- these two options on `Humane::TimeFormatter` are how you layer
+ActionView's wording on top of it, not a replacement for it. Both off by
+default, so `Humane::TimeFormatter.new` and calling `RelativeDateTimeFormatter`
+directly always agree:
 
 - `include_seconds` (default `false`): under 30 seconds, collapses to "less than a
   minute ago"/"in less than a minute" instead of an exact second count. Named after

data/lib/humane/size_formatter.rb

@@ -5,8 +5,11 @@ module Humane
   class SizeFormatter
     UNITS = %w[B KB MB GB TB PB EB].freeze
 
-    # Returns from_byte_count as a Finder-style human-readable string.
-    def string(from_byte_count:)
+    # Returns from_byte_count as a Finder-style human-readable string; accepts positional or from_byte_count: keyword argument -- see docs/COMMENTS.md.
+    def string(positional_from_byte_count = nil, from_byte_count: nil)
+      from_byte_count ||= positional_from_byte_count
+      raise ArgumentError, "from_byte_count is required" unless from_byte_count
+
       return "#{from_byte_count} B" if from_byte_count < 1000
 
       exponent = [(Math.log(from_byte_count) / Math.log(1000)).to_i, UNITS.size - 1].min

data/lib/humane/time_formatter.rb

@@ -10,8 +10,13 @@ module Humane
       @approximate = approximate
     end
 
-    # Returns the time at `at` relative to `relative_to` as a human-readable string.
-    def string(at:, relative_to:)
+    # Returns at relative to relative_to; accepts positional or at:/relative_to: keyword arguments -- see docs/COMMENTS.md.
+    def string(positional_at = nil, positional_relative_to = nil, at: nil, relative_to: nil)
+      at ||= positional_at
+      relative_to ||= positional_relative_to
+      raise ArgumentError, "at is required" unless at
+      raise ArgumentError, "relative_to is required" unless relative_to
+
       seconds = relative_to - at
       future = seconds.negative?
       seconds = seconds.abs

data/lib/humane/version.rb

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

metadata

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