stable_profile 0.4.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69f29fc4583e9a306a7aabbf1d9e267e924ea0be97ba6c3c592cc25899a9aa75
-  data.tar.gz: aba44a7c4cc527a500c8e547aeda1d51944e1f2da271df0aec434967f88d6e00
+  metadata.gz: 924cfdff88d8cc5778394fdab96b6bf5e446d92e700e995aaddea7744fbf1eaf
+  data.tar.gz: d80755e9aa8810910baa570e9fca02db34efd52d3cad8bae22fb883f8c5ea2c5
 SHA512:
-  metadata.gz: d1374fbf762bed4ec91bc9207cd225546480bf68d4b94ce978277905d18360ee992aacad83cc19a45444f39ed9481263c7a831774cccbe9ec0b21f01288c7777
-  data.tar.gz: c761db15d550d213bc0d629874dc2f50acb693d58fba3b656eb841ae590d863f70fafb231bcbd82b37844ebf2ab5aa56a70724e3af0975a2b320b67224bb5773
+  metadata.gz: f1310ffc4a01c70433b737342d862e3de0540168dc43d1e237c4e0549b0376b675efb10435277ae65c15ebda335d25eaf20965b43587453ed742c6728f25959c
+  data.tar.gz: 9ab86cfbd9ec8194c645be23b35d94e3860da7f4a23f6967832cc82f5e84cc7dc4bb31138c4eeb05c403ee97557572b8a2b3fd38a0aaa936e9bac3daba8a82ac

data/lib/stable_profile/cli.rb

@@ -4,9 +4,11 @@ require 'stable_profile'
 
 module StableProfile
   class CLI < Thor
-    desc "profile", "Run RSpec profile with predictable results."
+    desc "profile", "Run RSpec profile multiple times, averaging the results."
+    method_option :iterations, aliases:           "-i", type: :numeric, default: 20, desc: "Number of times to run RSpec"
+    method_option :top_slowest_examples, aliases: "-t", type: :numeric, default: 5,  desc: "Number of slowest examples to output"
     def profile
-      StableProfile.run
+      StableProfile.run(iterations: options[:iterations], top_slowest_examples: options[:top_slowest_examples])
     end
     default_task :profile
   end

data/lib/stable_profile.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'colorize'
 require 'fileutils'
 require 'json'
 require 'ruby-progressbar'
@@ -15,18 +16,8 @@ module StableProfile
   module_function
 
   # How many items to output in each category.
-  TOP_SLOWEST_EXAMPLES = 5
-
-  # The more iterations you run, the more accurate the results will be.
-  # 20 seems like plenty, but it could take a while depending on the
-  # size of your test suite.
-  ITERATIONS = 4
-
-  # It's a slow one if it showed up in at least half the profile runs.
-  MINIMUM_SAMPLE_SIZE = ITERATIONS / 2
-  DECIMAL_PLACES = 4
-
-  OUTPUT_DIR = 'tmp/multi_profile'
+  DECIMAL_PLACES       = 4
+  OUTPUT_DIR = 'tmp/stable_profile'
 
 
   def bold(string)
@@ -34,17 +25,17 @@ module StableProfile
   end
 
 
-  def run
-    puts "pwd = #{system('pwd')}"
+  def run(iterations:, top_slowest_examples:)
+    minimum_sample_size = iterations * 0.75
 
     # Erase and Create the output directory
     FileUtils.rm_rf(OUTPUT_DIR)
     FileUtils.mkdir_p(OUTPUT_DIR)
 
     # Run the specs ITERATIONS times, each time with a different random seed
-    progressbar = ProgressBar.create(title: 'Running profiles', total: ITERATIONS, format: '%t: |%B| %p%% %a')
-    ITERATIONS.times do |i|
-      system("rspec --profile 50 --order random --format json > #{OUTPUT_DIR}/multi_profile_#{i+1}.json")
+    progressbar = ProgressBar.create(title: 'Running profiles', total: iterations, format: '%t: |%B| %p%% %a')
+    iterations.times do |i|
+      system("rspec --profile --order random --format json > #{OUTPUT_DIR}/multi_profile_#{i+1}.json")
       progressbar.increment
     end
 
@@ -82,30 +73,30 @@ module StableProfile
 
     # Mimic RSpec profile output
     puts
-    puts "Top #{TOP_SLOWEST_EXAMPLES} slowest examples:"
+    puts "Top #{top_slowest_examples} slowest examples:"
     count = 0
     example_times.sort_by { |id, record| record[:average_time] }.reverse.each do |id, record|
       next if count == TOP_SLOWEST_EXAMPLES
-      next if record[:run_times].size < MINIMUM_SAMPLE_SIZE
+      next if record[:run_times].size < minimum_sample_size
       count += 1
 
       example = record.fetch(:example)
 
-      puts "  #{example['full_description']}"
+      puts "  #{example['full_description']}".colorize(:light_black)
       puts bold("    #{record[:average_time]} seconds").ljust(27) + " (N=#{record[:run_times].size})".ljust(7) + " #{example['file_path']}:#{example['line_number']}"
     end
 
     puts
-    puts "Top #{TOP_SLOWEST_EXAMPLES} slowest example groups:"
+    puts "Top #{top_slowest_examples} slowest example groups:"
     count = 0
     group_times.sort_by { |id, record| record[:average_time] }.reverse.each do |id, record|
       next if count == TOP_SLOWEST_EXAMPLES
-      next if record[:run_times].size < MINIMUM_SAMPLE_SIZE
+      next if record[:run_times].size < minimum_sample_size
       count += 1
 
       group = record.fetch(:group)
 
-      puts "  #{group['description']}"
+      puts "  #{group['description']}".colorize(:light_black)
       puts bold("    #{record[:average_time]} seconds").ljust(27) + " (N=#{record[:run_times].size})".ljust(7) + " #{group['location']}"
     end
   end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: stable_profile
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Robb Shecter
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-31 00:00:00.000000000 Z
+date: 2023-11-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: ruby-progressbar
   requirement: !ruby/object:Gem::Requirement
@@ -80,7 +94,11 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.12.0
-description: Repeatedly run --profile, averaging the results.
+description: 'Solves a quirk of rspec --profile in some code bases: result vary with
+  every random spec ordering. This seems to be due to differences in dependency load
+  order, class initialization, and test server startup. This lib runs rspec --profile
+  many times, averaging the results to always give the same (stable) and meaningful
+  result.'
 email:
 - robb@public.law
 executables: