time_up 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b040cfa422a59cc1c7f2157e8f7261ed1bdc7c470da76fead75b026159f02c8
-  data.tar.gz: 4b817578713714392dd0ab8f2694bce78c6ddf93e9b5eea16f302a5d4549c559
+  metadata.gz: acd14bdf2f241538214317bdc29461d543d95988458b24f17cd0ee9265ddcc0d
+  data.tar.gz: 3e4a9033800d1ddfa4cf40b2a9c84b0bfb5ef8c7c049d2d5801159c4d3710ad6
 SHA512:
-  metadata.gz: 3b4fe6bff25861a0b9b76b95684e25eed9056886091556f22b70820251ea3f41b08879b2628dd8b8bee74e03720b0f39d7af87af5664c0bcaa152f7e8b88d329
-  data.tar.gz: e0b0953129fc39ed079d3b6addebf579d8defbebcda484649a9826ff0a3e3b2383360d7d8269572746b5f5469cb076d4e6fa770ed36735f1c2fe55f319c91c5b
+  metadata.gz: 0bdeee99d7c5e49754786901bf8d5c9560e759a2b93d681c50f535cc039a8418a92a024779c901ad9fb4dd46fa3843486955a77e1c85c78a29897b035794814c
+  data.tar.gz: 135c285c49557d24bd4306fdd77ca243247a3d523e8f5d55408fef34fd2cd05c0712bcfa54420673bf5c512266177eb3c4dcc595c7924c74ca7eaea1a8bea57d

data/.standard.yml

@@ -0,0 +1 @@
+ruby_version: 2.4

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 0.0.4
+
+- Add `TimeUp.print_detailed_summary`
+
 # 0.0.3
 
 - Change the return value of TimeUp.start when passed a block to be the

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    time_up (0.0.3)
+    time_up (0.0.4)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -107,7 +107,7 @@ TimeUp.print_summary
 Which will output something like:
 
 ```
-TimeUp timers summary
+TimeUp summary
 ========================
 :roast   	0.07267s
 :veggies 	0.03760s
@@ -117,10 +117,27 @@ TimeUp timers summary
 * Denotes that the timer is still active
 ```
 
+And if you're calling the timers multiple times and want to see some basic
+statistics in the print-out, you can call `TimeUp.print_detailed_summary`, which
+will produce this:
+
+```
+=========================================================
+  Name    | Elapsed | Count |   Min   |   Max   |  Mean
+---------------------------------------------------------
+:roast    | 0.08641 | 3     | 0.00127 | 0.07261 | 0.02880
+:veggies  | 0.03759 | 1     | 0.03759 | 0.03759 | 0.03759
+:pasta    | 0.01256 | 11    | 0.00000 | 0.01255 | 0.00114
+:souffle* | 0.00006 | 1     | 0.00007 | 0.00007 | 0.00007
+
+* Denotes that the timer is still active
+```
+
 ## API
 
 This gem defines a bunch of public methods but they're all pretty short and
-straightforward, so I'd encourage you to [read the code](/lib/time_up.rb).
+straightforward, so when in doubt, I'd encourage you to [read the
+code](/lib/time_up.rb).
 
 ### `TimeUp` module
 
@@ -128,51 +145,54 @@ straightforward, so I'd encourage you to [read the code](/lib/time_up.rb).
 if it doesn't exist)
 
 `TimeUp.start(name, [&blk])` - Starts (or restarts) a named
-[Timer](#timeuptimer-class). If passed with a block, will return whatever the
-block evaluates to. If passed without a block, it will return the timer object
+[Timer](#timeuptimer-class). If passed a block, will return whatever the block
+evaluates to. If called without a block, it will return the timer object
 
-`TimeUp.stop(name)` - Stops the named timer or raises if it's not defined
+`TimeUp.stop(name)` - Stops the named timer
 
 `TimeUp.reset(name)` - Resets the named timer's elapsed time to 0, effectively
-restarting it if it's currently running. Raises if the timer isn't defined.
+restarting it if it's currently running
 
 `TimeUp.elapsed(name)` - Returns a `Float` of the total elapsed seconds that the
-named timer has been running (and raises if no timer is defined with the given
-`name`)
+named timer has been running
 
 `TimeUp.timings(name)` - Returns an array of each recorded start-to-stop
-duration of the timer (including the current one, if active)
+duration (including the current one, if the timer is running) of the named timer
 
-`TimeUp.count(name)` - The number of times the timer has been started and
-stopped (including the current timing, if active)
+`TimeUp.count(name)` - The number of times the timer has been started (including
+the current timing, if the timer is running)
 
-`TimeUp.min(name)` - The shortest recording of the timer (including the current
-one, if active)
+`TimeUp.min(name)` - The shortest recording by the timer
 
-`TimeUp.max(name)` - The longest recording of the timer (including the current
-one, if active)
+`TimeUp.max(name)` - The longest recording by the timer
 
-`TimeUp.mean(name)` - The arithmetic mean of all recorded durations of the timer
+`TimeUp.mean(name)` - The arithmetic mean of all recordings by the timer
 
-`TimeUp.total_elapsed` - Returns a `Float` of the sum of `elapsed` for all the
-timers you've created
+`TimeUp.total_elapsed` - Returns a `Float` of the sum of `elapsed` across all
+the timers you've created (note that because you can easily run multiple logical
+timers simultaneously, this figure may exceed the total time spent by the
+computer)
 
-`TimeUp.all_elapsed` - Returns a hash of timer name keys mapped to their
-`elapsed` values. Handy for grabbing a snapshot of the state of things at a
-particular point in time without stopping all your timers
+`TimeUp.all_elapsed` - Returns a Hash of timer name keys mapped to their
+`elapsed` values. Handy for grabbing a reference to a snapshot of the state of
+things without requiring you to stop your timers
 
-`TimeUp.all_stats` - Returns a hash of timer name keys mapped to another
-hash of their basic statistics (elapsed time, number of recordings, min, max,
-and mean)
+`TimeUp.all_stats` - Returns a Hash of timer name keys mapped to another
+hash of their basic statistics (`elapsed`, `count`, `min`, `max`,
+and `mean`)
 
-`TimeUp.active_timers` - Returns an array of all timers that are currently
-running. Useful for detecting cases where you might be counting the same time in
-multiple places simultaneously
+`TimeUp.active_timers` - Returns an Array of all timers that are currently
+running. Useful for detecting cases where you might be keeping time in multiple
+places simultaneously
 
 `TimeUp.print_summary([io])` - Pretty-prints a multi-line summary of all your
-timers to standard output (or the provided
+timers' total elapsed times to standard output (or the provided
 [IO](https://ruby-doc.org/core-3.0.1/IO.html))
 
+`TimeUp.print_detailed_summary([io])` - Pretty-prints a multi-line summary of
+all your timers' elapsed times and basic statistics to standard output (or the
+provided [IO](https://ruby-doc.org/core-3.0.1/IO.html))
+
 `TimeUp.stop_all` - Stops all timers
 
 `TimeUp.reset_all` - Resets all timers
@@ -188,17 +208,14 @@ reference to them
 
 `elapsed` - A `Float` of the total elapsed seconds the timer has been running
 
-`timings` - Returns an array of each recorded start-to-stop duration of the
-timer (including the current one, if active)
+`timings` - Returns an Array of each recorded start-to-stop duration of the
+timer (including the current one, if the timer is running)
 
-`count` - The number of times the timer has been started and stopped (including
-the current timing, if active)
+`count` - The number of times the timer has been started and stopped
 
-`min` - The shortest recording of the timer (including the current one, if
-active)
+`min` - The shortest recording of the timer
 
-`max` - The longest recording of the timer (including the current one, if
-active)
+`max` - The longest recording of the timer
 
 `mean` - The arithmetic mean of all recorded durations of the timer
 

data/lib/time_up.rb

@@ -65,7 +65,7 @@ module TimeUp
     }
     io.puts <<~SUMMARY
 
-      TimeUp timers summary
+      TimeUp summary
       ========================
       #{summaries.join("\n")}
 
@@ -73,6 +73,52 @@ module TimeUp
     SUMMARY
   end
 
+  def self.print_detailed_summary(io = $stdout)
+    cols = {
+      names: ["Name"],
+      elapsed: ["Elapsed"],
+      count: ["Count"],
+      min: ["Min"],
+      max: ["Max"],
+      mean: ["Mean"]
+    }
+    __timers.values.each { |timer|
+      cols[:names] << "#{timer.name.inspect}#{"*" if timer.active?}"
+      cols[:elapsed] << "%.5f" % timer.elapsed
+      cols[:count] << timer.count.to_s
+      cols[:min] << "%.5f" % timer.min
+      cols[:max] << "%.5f" % timer.max
+      cols[:mean] << "%.5f" % timer.mean
+    }
+
+    widths = cols.map { |name, vals|
+      [name, vals.map(&:length).max]
+    }.to_h
+
+    rows = cols[:names].size.times.map { |i|
+      if i == 0
+        cols.keys.map { |name|
+          cols[name][i].center(widths[name])
+        }
+      else
+        cols.keys.map { |name|
+          cols[name][i].ljust(widths[name])
+        }
+      end
+    }
+
+    full_width = widths.values.sum + (rows[0].size - 1) * 3
+    io.puts <<~SUMMARY
+
+      #{"=" * full_width}
+      #{rows[0].join(" | ")}
+      #{"-" * full_width}
+      #{rows[1..-1].map { |row| row.join(" | ") }.join("\n")}
+
+      #{"* Denotes that the timer is still active\n" if __timers.values.any?(&:active?)}
+    SUMMARY
+  end
+
   # Iterative methods
   def self.stop_all
     __timers.values.each(&:stop)

data/lib/time_up/version.rb

@@ -1,3 +1,3 @@
 module TimeUp
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: time_up
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Justin Searls
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-07-17 00:00:00.000000000 Z
+date: 2021-07-19 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -19,6 +19,7 @@ extra_rdoc_files: []
 files:
 - ".github/workflows/main.yml"
 - ".gitignore"
+- ".standard.yml"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock