stable_profile 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 302e1a928fc81f6d35e7f00419d6def5389f84ffbee1a49c37d46268c0769fd0
-  data.tar.gz: 172cc9fffbf9c3601328f23be2ed0c49551d9849131fdb8898f6117b04d99e1d
+  metadata.gz: fdc1251ab06ef89ebd5900e3159d0783f45c283f47e3e8d536c2f3d264c0f482
+  data.tar.gz: c46a33e840de54c00ff9be23cef7fa31a95340e2ac8b7866e23e3b0733f54ad4
 SHA512:
-  metadata.gz: dbf59497da62a1ded24a969a699baeb26819b974069db9bd0c126c8c4ea9acecf46b44822b851a39ccf511fc9ede30aaccaebb0dfca296bcd13525db8737db61
-  data.tar.gz: f0f6877b89257b90aaca0868af3c5eb4209a2dbc007287de54a7e6aa19b3edbf6a73616bd878df52534eab03538d0ca56e81d3e0a67d6b63117087c5e7873c25
+  metadata.gz: 3bd390ac4a17735e2d4fab46196c1bce4a3152f1f0b1e958e58d15e03a4b6f83e437fdb8c25fb586f68fcca53b5949201ed10b92ad9076b6417cd948efdc2ab0
+  data.tar.gz: 2b21c63b395890dac6b1a7f4afef4efda08bb727f1ac339ef2899d718b26a2f06a013c4638ad3edbaa4669e26e2e8298becec6c9b17c6f65cc661a4570a078ab

data/lib/stable_profile.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'colorize'
 require 'fileutils'
 require 'json'
 require 'ruby-progressbar'
@@ -12,27 +13,22 @@ module StableProfile
   #   --iterations 10
   #   --top-slowest-examples 10
 
-  class String
-    def bold
-      "\e[1m#{self}\e[22m" 
-    end
-  end
-
   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
+  ITERATIONS           = 20
+  MINIMUM_SAMPLE_SIZE  = ITERATIONS * 0.75
+  DECIMAL_PLACES       = 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/stable_profile'
 
-  OUTPUT_DIR = 'tmp/multi_profile'
+
+  def bold(string)
+    "\e[1m#{string}\e[22m" 
+  end
 
 
   def run
@@ -43,12 +39,14 @@ module StableProfile
     # 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")
+      system("rspec --profile --order random --format json > #{OUTPUT_DIR}/multi_profile_#{i+1}.json")
       progressbar.increment
     end
 
     # Read the results from the JSON files into an array.
-    outputs = Dir.glob("#{OUTPUT_DIR}/*.json").map { |file| JSON.parse(File.read(file)) }
+    outputs = Dir.glob("#{OUTPUT_DIR}/*.json").map do |file| 
+      JSON.parse(File.read(file))
+    end
 
     # Extract the JSON profile structures from the full results.
     profile_blocks = outputs.map { |output| output.fetch('profile') }
@@ -88,8 +86,8 @@ module StableProfile
 
       example = record.fetch(:example)
 
-      puts "  #{example['full_description']}"
-      puts "    #{record[:average_time]} seconds".bold.ljust(27) + " (N=#{record[:run_times].size})".ljust(7) + " #{example['file_path']}:#{example['line_number']}"
+      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
@@ -102,8 +100,8 @@ module StableProfile
 
       group = record.fetch(:group)
 
-      puts "  #{group['description']}"
-      puts "    #{record[:average_time]} seconds".bold.ljust(27) + " (N=#{record[:run_times].size})".ljust(7) + " #{group['location']}"
+      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
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: stable_profile
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.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: