stable_profile 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 16437ef249a5c2ac5fb5191c05027e0c6c44c49bbf67474f423cbf548983349a
+  data.tar.gz: '0954a34a0d551bbcf65b107eebf54b48ea4068f4bdf1e94767dd0390b1022d02'
+SHA512:
+  metadata.gz: 70d79de08dde779a5533725b63bfd2d66dc451c79a8a2e4bc327e5ba98f5905a4653358090330c965079070cd035c9d0bcaa034d9f205a04ad990d4cc7664e56
+  data.tar.gz: 488c8a2ef2fdeb8cd89bee5d1fb28873d40b4ece0b370c4f57c58f43c168bd3e5d2fcc46d705122206ef1586e502db560948c1e2412362afafc4a955df41f87a

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Robb Shecter
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,36 @@
+# Stable RSpec Profile
+
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/stable_profile`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/stable_profile.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/stable_profile/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module StableProfile
+  VERSION = "0.1.0"
+end

data/lib/stable_profile.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'json'
+require 'ruby-progressbar'
+
+require_relative "stable_profile/version"
+
+module StableProfile
+  class Error < StandardError; end
+
+  # TODO: Create command line options:
+  #   --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
+
+  # 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'
+
+
+  def run
+    # 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.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)) }
+
+    # Extract the JSON profile structures from the full results.
+    profile_blocks = outputs.map { |output| output.fetch('profile') }
+    examples       = profile_blocks.map { |profile| profile.fetch('examples') }.flatten
+    groups         = profile_blocks.map { |profile| profile.fetch('groups') }.flatten
+
+    # Create a hash, keyed by "id", with the times spent in each example.
+    example_times = examples.each_with_object({}) do |example, hash|
+      hash[example.fetch('id')] ||= {run_times: [], average_time: 0, example: example}
+      hash[example.fetch('id')][:run_times] << example.fetch('run_time')
+    end
+
+    # Create a hash, keyed by "location", with the times spent in each group.
+    group_times = groups.each_with_object({}) do |group, hash|
+      hash[group.fetch('location')] ||= {run_times: [], average_time: 0, group: group}
+      hash[group.fetch('location')][:run_times] << group.fetch('total_time')
+    end
+
+    # Calculate the average time spent in each example.
+    example_times.each do |id, record|
+      example_times[id][:average_time] = (record[:run_times].inject(:+) / record[:run_times].size).round(DECIMAL_PLACES)
+    end
+
+    # Calculate the average time spent in each group.
+    group_times.each do |id, record|
+      group_times[id][:average_time] = (record[:run_times].inject(:+) / record[:run_times].size).round(DECIMAL_PLACES)
+    end
+
+    # Mimic RSpec profile output
+    puts
+    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
+      count += 1
+
+      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']}"
+    end
+
+    puts
+    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
+      count += 1
+
+      group = record.fetch(:group)
+
+      puts "  #{group['description']}"
+      puts "    #{record[:average_time]} seconds".bold.ljust(27) + " (N=#{record[:run_times].size})".ljust(7) + " #{group['location']}"
+    end
+  end
+end

data/sig/stable_profile.rbs

@@ -0,0 +1,4 @@
+module StableProfile
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: stable_profile
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Robb Shecter
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-10-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-progressbar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.13.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.13.0
+description: Repeatedly run --profile, averaging the results.
+email:
+- robb@public.law
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/stable_profile.rb
+- lib/stable_profile/version.rb
+- sig/stable_profile.rbs
+homepage:
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.21
+signing_key:
+specification_version: 4
+summary: Runs RSpec profile with predictable results.
+test_files: []