time_up 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: acd14bdf2f241538214317bdc29461d543d95988458b24f17cd0ee9265ddcc0d
-  data.tar.gz: 3e4a9033800d1ddfa4cf40b2a9c84b0bfb5ef8c7c049d2d5801159c4d3710ad6
+  metadata.gz: f6241f3e0e1e66bc75c67a7e7cfc76424ae4e711c5a535b87da3bdf4fa78c153
+  data.tar.gz: 33c77eb409cb4d4d4142207ff93a938a1124b87768047f29be0d51057c4eb5fb
 SHA512:
-  metadata.gz: 0bdeee99d7c5e49754786901bf8d5c9560e759a2b93d681c50f535cc039a8418a92a024779c901ad9fb4dd46fa3843486955a77e1c85c78a29897b035794814c
-  data.tar.gz: 135c285c49557d24bd4306fdd77ca243247a3d523e8f5d55408fef34fd2cd05c0712bcfa54420673bf5c512266177eb3c4dcc595c7924c74ca7eaea1a8bea57d
+  metadata.gz: df9e90669ceef219dcea0bf8b21548252b97abe40b950b922f6c9ee17987494d145fdd130b5c4735a6e57daffaf5ba2d915057044f424ba68656d9b55b5f7820
+  data.tar.gz: ad014a9ec0471bfbc3f315b673988d7d5b5115ad29d0cc664ad63eaa81547086bff539de50e311078261c99a9616a0e683c75f9e552bf0a254d26e14d0ef702d

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 0.0.5
+
+- Add `median` and `percentile` timer statistics, and added them to
+  `print_detailed_summary`
+
 # 0.0.4
 
 - Add `TimeUp.print_detailed_summary`

data/Gemfile.lock

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

data/README.md

@@ -11,6 +11,9 @@ process and that you want to measure in aggregate. (For example, to see how
 much time your test suite spends creating factories, truncating the database, or
 invoking a critical code path.)
 
+Here's a [blog post about time_up](https://blog.testdouble.com/posts/2021-07-19-benchmarking-your-ruby-with-time_up/) and 
+a [great example of when it can be useful](https://gist.github.com/searls/feee0b0eac7c329b390fed90c4714afb).
+
 ## Install
 
 Just run `gem install time_up` or add time_up to your Gemfile:
@@ -122,13 +125,13 @@ 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
+=============================================================================
+  Name    | Elapsed | Count |   Min   |   Max   |  Mean   | Median  | 95th %
+-----------------------------------------------------------------------------
+:roast    | 0.08454 | 3     | 0.00128 | 0.07280 | 0.02818 | 0.01046 | 0.06657
+:veggies  | 0.03779 | 1     | 0.03779 | 0.03779 | 0.03779 | 0.03779 | 0.03779
+:pasta    | 0.01260 | 11    | 0.00000 | 0.01258 | 0.00115 | 0.00000 | 0.00630
+:souffle* | 0.00024 | 1     | 0.00024 | 0.00025 | 0.00025 | 0.00025 | 0.00026
 
 * Denotes that the timer is still active
 ```
@@ -168,6 +171,12 @@ the current timing, if the timer is running)
 
 `TimeUp.mean(name)` - The arithmetic mean of all recordings by the timer
 
+`TimeUp.median(name)` - The median of all recordings by the timer
+
+`TimeUp.percentile(name, percent)` - The timing for the given
+[percentile](https://en.wikipedia.org/wiki/Percentile) of all recordings by the
+timer
+
 `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
@@ -219,6 +228,12 @@ timer (including the current one, if the timer is running)
 
 `mean` - The arithmetic mean of all recorded durations of the timer
 
+`median(name)` - The median of all recordings by the timer
+
+`percentile(name, percent)` - The timing for the given
+[percentile](https://en.wikipedia.org/wiki/Percentile) of all recordings by the
+timer
+
 `active?` - Returns `true` if the timer is running
 
 `reset(force: false)` - Resets the timer to 0 elapsed seconds. If `force` is

data/lib/time_up.rb

@@ -22,7 +22,8 @@ module TimeUp
     :count,
     :min,
     :max,
-    :mean
+    :mean,
+    :median
   ].each do |method_name|
     define_singleton_method method_name do |name|
       __ensure_timer(name)
@@ -30,6 +31,11 @@ module TimeUp
     end
   end
 
+  def self.percentile(name, percentage)
+    __ensure_timer(name)
+    __timers[name].percentile(percentage)
+  end
+
   # Interrogative methods
   def self.total_elapsed
     __timers.values.sum(&:elapsed)
@@ -48,7 +54,9 @@ module TimeUp
         count: timer.count,
         min: timer.min,
         max: timer.max,
-        mean: timer.mean
+        mean: timer.mean,
+        median: timer.median,
+        "95th": timer.percentile(95)
       }]
     }.to_h
   end
@@ -80,7 +88,9 @@ module TimeUp
       count: ["Count"],
       min: ["Min"],
       max: ["Max"],
-      mean: ["Mean"]
+      mean: ["Mean"],
+      median: ["Median"],
+      "95th": ["95th %"]
     }
     __timers.values.each { |timer|
       cols[:names] << "#{timer.name.inspect}#{"*" if timer.active?}"
@@ -89,6 +99,8 @@ module TimeUp
       cols[:min] << "%.5f" % timer.min
       cols[:max] << "%.5f" % timer.max
       cols[:mean] << "%.5f" % timer.mean
+      cols[:median] << "%.5f" % timer.median
+      cols[:"95th"] << "%.5f" % timer.percentile(95)
     }
 
     widths = cols.map { |name, vals|
@@ -211,6 +223,25 @@ module TimeUp
       times.sum / times.size
     end
 
+    def median
+      times = timings.sort
+      return if times.empty?
+      (times[(times.size - 1) / 2] + times[times.size / 2]) / 2.0
+    end
+
+    def percentile(percent)
+      times = timings.sort
+      return if times.empty?
+      return 0 if percent <= 0
+      return max if percent >= 100
+      return times.first if times.size == 1
+      position = (percent / 100.0) * (times.size - 1)
+
+      partial_ratio = position - position.floor
+      whole, partial = times[position.floor, 2]
+      whole + (partial - whole) * partial_ratio
+    end
+
     def timings
       if active?
         @past_timings + [now - @start_time]

data/lib/time_up/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: time_up
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Justin Searls
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-07-19 00:00:00.000000000 Z
+date: 2021-07-20 00:00:00.000000000 Z
 dependencies: []
 description:
 email: