tago 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ce49c7e11433395a7963fd3b8ae9a7bfc10dbb00e10fb0a2791b13fb432cf35
-  data.tar.gz: 861df150e33bcdc48e0d8ec3a34c2a33a5c455be7b19b7b6ebad11e166772b1c
+  metadata.gz: 7065628d4d10a5ecb484a5a08973d4091bdcb94858932b7ff353e1472d4572d0
+  data.tar.gz: 4f41a9476eb8838e0476e4586e226a81fd7b4874518cc9ab5c856df79e7b56e1
 SHA512:
-  metadata.gz: afdfb3de82966a409d8d59498788eaf623d5251f1bd0561e5025662d12a28d705ac96e236014c539fe1e0e4c6270367687d4000f540cd46a5afd1d73c09ddf18
-  data.tar.gz: ddd745356b376ec6254cf5bfec47b5a388c5d3e595d30ed99d7729bcb91ff678e03a6b3722a891fb569582937b9b0d0078931bde34861efb83dc1f9c5829c2e8
+  metadata.gz: b719d14e52e638a19e74d1f25d1c17d5b8e435d88d611fbb91290add6646374639300eb091c711e6e34f000294d28937f12bc3c9e89d70a9e014c7fc763bd775
+  data.tar.gz: 6f7d4e72147f350ec57d4bcb9193ec1976e6e8aea47f2e411482b6cbe3dd4acf65fda17e9a7f8bce410b12efd7c4646b69d6c568a9b7e566e9b5d8f05b9ca42e

data/Gemfile.lock

@@ -8,12 +8,12 @@ GEM
   specs:
     ast (2.4.3)
     docile (1.4.1)
-    json (2.15.1)
+    json (2.15.2)
     language_server-protocol (3.17.0.5)
     lint_roller (1.1.0)
-    minitest (5.26.0)
+    minitest (5.26.2)
     parallel (1.27.0)
-    parser (3.3.9.0)
+    parser (3.3.10.0)
       ast (~> 2.4.1)
       racc
     prism (1.5.2)
@@ -22,7 +22,7 @@ GEM
     rake (13.3.1)
     regexp_parser (2.11.3)
     rexml (3.4.2)
-    rubocop (1.81.6)
+    rubocop (1.81.7)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)
@@ -60,7 +60,7 @@ GEM
     unicode-display_width (3.2.0)
       unicode-emoji (~> 4.1)
     unicode-emoji (4.1.0)
-    yard (0.9.37)
+    yard (0.9.38)
 
 PLATFORMS
   arm64-darwin-22

data/README.md

@@ -32,6 +32,27 @@ s = Time.now - start
 puts "It took #{s.seconds}"
 ```
 
+The `seconds` method accepts optional formatting flags:
+
+```ruby
+9.444.seconds           # => "9s444ms"
+9.444.seconds(:round)   # => "9s" (omits sub-units)
+9.444.seconds(:short)   # => "9s" (also omits sub-units)
+300.0.seconds(:pretty)  # => "five minutes" (words instead of abbreviations)
+300.0.seconds(:pretty, :short) # => "5 min" (numeric with short unit names)
+5.0.seconds(:pretty, :caps)    # => "Five seconds" (capitalizes first letter)
+```
+
+The same flags work with `ago`:
+
+```ruby
+start.ago(:round)
+start.ago(:pretty)
+start.ago(:pretty, :short)
+start.ago(:pretty, :caps)
+start.ago(Time.now, :round)
+```
+
 The gem basically extends the `Float` and `Time` classes with new methods.
 
 ## How to contribute

data/Rakefile

@@ -31,6 +31,7 @@ require 'yard'
 desc 'Build Yard documentation'
 YARD::Rake::YardocTask.new do |t|
   t.files = ['lib/**/*.rb']
+  t.options = ['--fail-on-warning']
 end
 
 require 'rubocop/rake_task'

data/lib/tago.rb

@@ -11,17 +11,20 @@ require 'time'
 # Copyright:: Copyright (c) 2024-2025 Yegor Bugayenko
 # License:: MIT
 class Float
-  def seconds(format = nil)
+  def seconds(*args)
     s = self
     s = -s if s.negative?
-    if format == :pretty
+    if args.include?(:pretty)
       locales = {
         en: {
           numbers: { 0 => 'zero', 1 => 'one', 2 => 'two', 3 => 'three', 4 => 'four', 5 => 'five', 6 => 'six',
                      7 => 'seven', 8 => 'eight', 9 => 'nine', 10 => 'ten' },
           units: { microsecond: %w[microsecond microseconds], millisecond: %w[millisecond milliseconds],
                    second: %w[second seconds], minute: %w[minute minutes], hour: %w[hour hours], day: %w[day days],
-                   week: %w[week weeks] }
+                   week: %w[week weeks] },
+          short_units: {
+            microsecond: 'μs', millisecond: 'ms', second: 'sec', minute: 'min', hour: 'hr', day: 'd', week: 'wk'
+          }
         }
       }.freeze
 
@@ -47,11 +50,14 @@ class Float
         val = (s / (7 * 24 * 60 * 60)).to_i
         unit = :week
       end
-
-      num = val < 10 ? locales[:en][:numbers][val] : val.to_s
-      names = locales[:en][:units].fetch(unit)
-      unit_name = val == 1 ? names[0] : names[1]
-      return format('%<num>s %<unit_name>s', num:, unit_name:)
+      short = args.include?(:short)
+      number_to_words = val <= 10 ? locales[:en][:numbers][val] : val.to_s
+      num = short ? val : number_to_words
+      names = locales[:en][:units][unit]
+      unit_symbol = val == 1 ? names[0] : names[1]
+      unit_name = short ? locales[:en][:short_units][unit] : unit_symbol
+      result = format('%<num>s %<unit_name>s', num:, unit_name:)
+      return args.include?(:caps) ? result.capitalize : result
     end
 
     if s < 0.001
@@ -60,7 +66,7 @@ class Float
       format('%dms', s * 1000)
     elsif s < 10
       ms = (s * 1000 % 1000).to_i
-      if format == :round || ms.zero?
+      if args.include?(:round) || args.include?(:short) || ms.zero?
         format('%ds', s)
       else
         format('%<s>ds%<ms>dms', s:, ms:)
@@ -70,7 +76,7 @@ class Float
     elsif s < 60 * 60
       mins = (s / 60).to_i
       secs = (s % 60).to_i
-      if format == :round || secs.zero?
+      if args.include?(:round) || args.include?(:short) || secs.zero?
         format('%dm', mins)
       else
         format('%<mins>dm%<secs>ds', mins:, secs:)
@@ -78,7 +84,7 @@ class Float
     elsif s < 24 * 60 * 60
       hours = (s / (60 * 60)).to_i
       mins = ((s % (60 * 60)) / 60).to_i
-      if format == :round || mins.zero?
+      if args.include?(:round) || args.include?(:short) || mins.zero?
         format('%dh', hours)
       else
         format('%<hours>dh%<mins>dm', hours:, mins:)
@@ -86,7 +92,7 @@ class Float
     elsif s < 7 * 24 * 60 * 60
       days = (s / (24 * 60 * 60)).to_i
       hours = ((s % (24 * 60 * 60)) / (60 * 60)).to_i
-      if format == :round || hours.zero?
+      if args.include?(:round) || args.include?(:short) || hours.zero?
         format('%dd', days)
       else
         format('%<days>dd%<hours>dh', days:, hours:)
@@ -94,7 +100,7 @@ class Float
     else
       weeks = (s / (7 * 24 * 60 * 60)).to_i
       days = (s / (24 * 60 * 60) % 7).to_i
-      if format == :round || days.zero?
+      if args.include?(:round) || args.include?(:short) || days.zero?
         format('%dw', weeks)
       else
         format('%<weeks>dw%<days>dd', weeks:, days:)
@@ -109,15 +115,13 @@ end
 # Copyright:: Copyright (c) 2024-2025 Yegor Bugayenko
 # License:: MIT
 class Time
-  def ago(arg = Time.now, pretty = nil)
-    if arg.is_a?(Symbol) || arg.nil?
-      format = arg
-      now = pretty || Time.now
-    else
+  def ago(arg = Time.now, *options)
+    if arg.is_a?(Time)
       now = arg
-      format = pretty
+    else
+      now = Time.now
+      options = [arg] + options
     end
-
-    (now - self).seconds(format)
+    (now - self).seconds(*options)
   end
 end

data/tago.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = Gem::Requirement.new('>= 0') if s.respond_to? :required_rubygems_version=
   s.required_ruby_version = '>=3.0'
   s.name = 'tago'
-  s.version = '0.4.0'
+  s.version = '0.6.0'
   s.license = 'MIT'
   s.summary = 'A new .ago() method for the Time class'
   s.description =

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tago
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Yegor Bugayenko