stable_profile 0.5.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fdc1251ab06ef89ebd5900e3159d0783f45c283f47e3e8d536c2f3d264c0f482
-  data.tar.gz: c46a33e840de54c00ff9be23cef7fa31a95340e2ac8b7866e23e3b0733f54ad4
+  metadata.gz: 7a59002ea5da6a514556069ad4094c316d59c1affc362d6f5cd3ea1afc21e697
+  data.tar.gz: 6a06ffeb62d321301e169248a94f8b76578dfa3f05683a76347e7152d5099fbc
 SHA512:
-  metadata.gz: 3bd390ac4a17735e2d4fab46196c1bce4a3152f1f0b1e958e58d15e03a4b6f83e437fdb8c25fb586f68fcca53b5949201ed10b92ad9076b6417cd948efdc2ab0
-  data.tar.gz: 2b21c63b395890dac6b1a7f4afef4efda08bb727f1ac339ef2899d718b26a2f06a013c4638ad3edbaa4669e26e2e8298becec6c9b17c6f65cc661a4570a078ab
+  metadata.gz: a6a899e53d5404cab959c4b6ac5d54b8564e22ccfbc2a138fb10d0ddaf16eb089240d341bfda3601ae368dd9a4c20740e5e2b20d2c4e3876f8dc3047fc1b4741
+  data.tar.gz: e002f7bc8cab5643c276d0af9ad9ecfd66ed45c42a9763ab4299dcd8e359c987a1cd6ee99745460faae05d5226b5126397a1dc793b7fafcaad24bd1d8f1505a2

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

@@ -16,13 +16,7 @@ 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.
-  ITERATIONS           = 20
-  MINIMUM_SAMPLE_SIZE  = ITERATIONS * 0.75
   DECIMAL_PLACES       = 4
-
   OUTPUT_DIR = 'tmp/stable_profile'
 
 
@@ -31,14 +25,16 @@ module StableProfile
   end
 
 
-  def run
+  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|
+    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
@@ -77,11 +73,11 @@ 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 count == top_slowest_examples
+      next if record[:run_times].size < minimum_sample_size
       count += 1
 
       example = record.fetch(:example)
@@ -91,11 +87,11 @@ module StableProfile
     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 count == top_slowest_examples
+      next if record[:run_times].size < minimum_sample_size
       count += 1
 
       group = record.fetch(:group)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stable_profile
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Robb Shecter