derailed_benchmarks 1.7.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 843a6c3b99ee45120c15af62a592e9bbecb2d88f0917fa292faf9f7128ab721a
-  data.tar.gz: f1cdfb9c4145c27a8dac7f2c868077c6359213c3c367f2cf8a0f8909f50c9468
+  metadata.gz: 24d0d07556d2d6676ea8b2c06d58583071fd9302c056d36db05d252480889308
+  data.tar.gz: 0c783db16c1612173975c12760b101fc30cbd5765d296b2fd66506992305ac69
 SHA512:
-  metadata.gz: 1936293cd836af98e6af454a7482534c7481b938f4944813a5261a04a9b766b0a169b866397b3d9745d25316cd8916df3b74fc1fd4f1ff46f6e5753eba92bd96
-  data.tar.gz: 7de041007e174314699cac83eef5b70626e5447eddd705190d68d74cc7d50c0b9d660d032127cf747ea67566a096bbca4aafa05774c413da6f4ca802c8da2c08
+  metadata.gz: e37aa667a5fe031a384a343de999a34ef9f1e0ba98f8190d6f86d326ee30f968e3555344fbaf8841f99da85354c2b4383fe1b75ab166eb0df9134d20ee48fd95
+  data.tar.gz: 3f581637e835d808b8264786ffd70159fe534c4147e72e65f5649fe7ecb0b92b9edc215c9edd43e2ca51a510793ae475da3e0318262103bb741823746d9f3421

data/.github/workflows/check_changelog.yml

@@ -1,10 +1,13 @@
 name: Check Changelog
-on: [pull_request]
+
+on:
+ pull_request:
+  types: [opened, reopened, edited, synchronize]
 jobs:
- build:
-   runs-on: ubuntu-latest
-   steps:
-   - uses: actions/checkout@v1
-   - name: Check that CHANGELOG is touched
-     run: |
-       cat $GITHUB_EVENT_PATH | jq .pull_request.title |  grep -i '\[\(\(changelog skip\)\|\(ci skip\)\)\]' ||  git diff remotes/origin/${{ github.base_ref }} --name-only | grep CHANGELOG.md
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - name: Check that CHANGELOG is touched
+      run: |
+        cat $GITHUB_EVENT_PATH | jq .pull_request.title |  grep -i '\[\(\(changelog skip\)\|\(ci skip\)\)\]' ||  git diff remotes/origin/${{ github.base_ref }} --name-only | grep CHANGELOG.md

data/.travis.yml

@@ -1,18 +1,20 @@
 language: ruby
 rvm:
-  - 2.5.5
-  - 2.6.3
-  - ruby-head
+  - 2.2.10
+  - 2.5.8
+  - 2.7.1
 
 gemfile:
   - gemfiles/rails_5_1.gemfile
-  - gemfiles/rails_5_2.gemfile
   - gemfiles/rails_6_0.gemfile
   - gemfiles/rails_git.gemfile
 
 before_install:
-  - gem install bundler
+  - gem install bundler -v 1.17.3
 
-matrix:
+jobs:
   allow_failures:
-    - rvm: ruby-head
+    - rvm: 2.2.10
+      gemfile: gemfiles/rails_6_0.gemfile
+    - rvm: 2.2.10
+      gemfile: gemfiles/rails_git.gemfile

data/CHANGELOG.md

@@ -1,4 +1,8 @@
-## master (unreleased)
+## HEAD
+
+## 1.8.0
+
+- Ruby 2.2 is now officialy supported and tested (https://github.com/schneems/derailed_benchmarks/pull/177)
 
 ## 1.7.0
 

data/README.md

@@ -10,7 +10,7 @@ A series of things you can use to benchmark a Rails or Ruby app.
 ## Compatibility/Requirements
 
 This gem has been tested and is known to work with Rails 3.2+ using Ruby
-2.1+. Some commands __may__ work on older versions of Ruby, but not all commands are supported.
+2.2+. Some commands __may__ work on older versions of Ruby, but not all commands are supported.
 
 For some benchmarks, not all, you'll need to verify you have a working version of curl on your OS:
 

data/derailed_benchmarks.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.required_ruby_version = ">= 2.1.0"
+  gem.required_ruby_version = ">= 2.2.0"
 
   gem.add_dependency "heapy",           "~> 0"
   gem.add_dependency "memory_profiler", "~> 0"
@@ -30,8 +30,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency "rake",            "> 10", "< 14"
   gem.add_dependency "thor",            ">= 0.19", "< 2"
   gem.add_dependency "ruby-statistics", ">= 2.1"
-  gem.add_dependency "unicode_plot",    ">= 0.0.4", "< 1.0.0"
-  gem.add_dependency "mini_histogram",    "~> 0"
+  gem.add_dependency "mini_histogram",    ">= 0.2.1"
 
   gem.add_development_dependency "capybara",  "~> 2"
   gem.add_development_dependency "m"

data/lib/derailed_benchmarks.rb

@@ -43,8 +43,9 @@ end
 require 'derailed_benchmarks/require_tree'
 require 'derailed_benchmarks/auth_helper'
 
-require 'derailed_benchmarks/stats_in_file'
+require 'derailed_benchmarks/stats_for_file'
 require 'derailed_benchmarks/stats_from_dir'
+require 'derailed_benchmarks/git/switch_project'
 
 if DerailedBenchmarks.gem_is_bundled?("devise")
   DerailedBenchmarks.auth = DerailedBenchmarks::AuthHelpers::Devise.new

data/lib/derailed_benchmarks/git/commit.rb

@@ -0,0 +1,36 @@
+module DerailedBenchmarks
+  # Represents a specific commit in a git repo
+  #
+  # Can be used to get information from the commit or to check it out
+  #
+  # commit = GitCommit.new(path: "path/to/repo", ref: "6e642963acec0ff64af51bd6fba8db3c4176ed6e")
+  # commit.short_sha # => "6e64296"
+  # commit.checkout! # Will check out the current commit at the repo in the path
+  class Git::Commit
+    attr_reader :ref, :description, :time, :short_sha, :log
+
+    def initialize(path: , ref: , log_dir: Pathname.new("/dev/null"))
+      @in_git_path = Git::InPath.new(path)
+      @ref = ref
+      @log = log_dir.join("#{file_safe_ref}.bench.txt")
+
+      Dir.chdir(path) do
+        checkout!
+        @description = @in_git_path.description
+        @short_sha = @in_git_path.short_sha
+        @time = @in_git_path.time
+      end
+    end
+
+    alias :desc :description
+    alias :file :log
+
+    def checkout!
+      @in_git_path.checkout!(ref)
+    end
+
+    private def file_safe_ref
+      ref.gsub('/', ':')
+    end
+  end
+end

data/lib/derailed_benchmarks/git/in_path.rb

@@ -0,0 +1,59 @@
+module DerailedBenchmarks
+  # A class for running commands in a git directory
+  #
+  # It's faster to check if we're already in that directory instead
+  # of having to `cd` into each time. https://twitter.com/schneems/status/1305196730170961920
+  #
+  # Example:
+  #
+  #   in_git_path = InGitPath.new(`bundle info heapy --path`.strip)
+  #   in_git_path.checkout!("f0f92b06156f2274021aa42f15326da041ee9009")
+  #   in_git_path.short_sha # => "f0f92b0"
+  class Git::InPath
+    attr_reader :path
+
+    def initialize(path)
+      @path = path
+    end
+
+    def description
+      run!("git log --oneline --format=%B -n 1 HEAD | head -n 1")
+    end
+
+    def short_sha
+      run!("git rev-parse --short HEAD")
+    end
+
+    def time_stamp_string
+      run!("git log -n 1 --pretty=format:%ci") # https://stackoverflow.com/a/25921837/147390
+    end
+
+    def branch
+      branch = run!("git rev-parse --abbrev-ref HEAD")
+      branch == "HEAD" ? nil : branch
+    end
+
+    def checkout!(ref)
+      run!("git checkout '#{ref}' 2>&1")
+    end
+
+    def time
+      DateTime.parse(time_stamp_string)
+    end
+
+    def run(cmd)
+      if Dir.pwd == path
+        out = `#{cmd}`.strip
+      else
+        out = `cd #{path} && #{cmd}`.strip
+      end
+      out
+    end
+
+    def run!(cmd)
+      out = run(cmd)
+      raise "Error while running #{cmd.inspect}: #{out}" unless $?.success?
+      out
+    end
+  end
+end

data/lib/derailed_benchmarks/git/switch_project.rb

@@ -0,0 +1,128 @@
+module DerailedBenchmarks
+  class Git
+  end
+end
+require_relative "in_path.rb"
+require_relative "commit.rb"
+
+module DerailedBenchmarks
+  # Wraps two or more git commits in a specific location
+  #
+  # Returns an array of GitCommit objects that can be used to manipulate
+  # and checkout the repo
+  #
+  # Example:
+  #
+  #   `git clone https://sharpstone/default_ruby tmp/default_ruby`
+  #
+  #   project = GitSwitchProject.new(path: "tmp/default_ruby")
+  #
+  # By default it will represent the last two commits:
+  #
+  #   project.commits.length # => 2
+  #
+  # You can pass in explicit REFs in an array:
+  #
+  #   ref_array = ["da748a59340be8b950e7bbbfb32077eb67d70c3c", "9b19275a592f148e2a53b87ead4ccd8c747539c9"]
+  #   project = GitSwitchProject.new(path: "tmp/default_ruby", ref_array: ref_array)
+  #
+  #   puts project.commits.map(&:ref) == ref_array # => true
+  #
+  #
+  # It knows the current branch or sha:
+  #
+  #    `cd tmp/ruby && git checkout -b mybranch`
+  #    project.current_branch_or_sha #=> "mybranch"
+  #
+  # It can be used for safely wrapping checkouts to ensure the project returns to it's original branch:
+  #
+  #    project.restore_branch_on_return do
+  #      project.commits.first.checkout!
+  #      project.current_branch_or_sha # => "da748a593"
+  #    end
+  #
+  #    project.current_branch_or_sha # => "mybranch"
+  class Git::SwitchProject
+    attr_reader :commits
+
+    def initialize(path: , ref_array: [], io: STDOUT, log_dir: "/dev/null")
+      @path = Pathname.new(path)
+
+      @in_git_path = Git::InPath.new(@path.expand_path)
+
+      raise "Must be a path with a .git directory '#{@path}'" if !@path.join(".git").exist?
+      @io = io
+      @commits = []
+      log_dir = Pathname(log_dir)
+
+      expand_refs(ref_array).each do |ref|
+        restore_branch_on_return(quiet: true) do
+          @commits << Git::Commit.new(path: @path, ref: ref, log_dir: log_dir)
+        end
+      end
+
+      if (duplicate = @commits.group_by(&:short_sha).detect {|(k, v)| v.length > 1})
+        raise "Duplicate SHA resolved #{duplicate[0].inspect}: #{duplicate[1].map {|c| "'#{c.ref}' => '#{c.short_sha}'"}.join(", ") } at #{@path}"
+      end
+    end
+
+    def current_branch_or_sha
+      branch_or_sha = @in_git_path.branch
+      branch_or_sha ||= @in_git_path.short_sha
+      branch_or_sha
+    end
+
+    def dirty?
+      !clean?
+    end
+
+    # https://stackoverflow.com/a/3879077/147390
+    def clean?
+      @in_git_path.run("git diff-index --quiet HEAD --") && $?.success?
+    end
+
+    private def status(pattern: "*.gemspec")
+      @in_git_path.run("git status #{pattern}")
+    end
+
+    def restore_branch_on_return(quiet: false)
+      if dirty? && status.include?("gemspec")
+        dirty_gemspec = true
+        unless quiet
+          @io.puts "Working tree at #{@path} is dirty, stashing. This will be popped on return"
+          @io.puts "Bundler modifies gemspec files on git install, this is normal"
+          @io.puts "Original status:\n#{status}"
+        end
+        @in_git_path.run!("git stash")
+      end
+      branch_or_sha = self.current_branch_or_sha
+      yield
+    ensure
+      return unless branch_or_sha
+      @io.puts "Resetting git dir of '#{@path.to_s}' to #{branch_or_sha.inspect}" unless quiet
+
+      @in_git_path.checkout!(branch_or_sha)
+      if dirty_gemspec
+        out = @in_git_path.run!("git stash apply 2>&1")
+        @io.puts "Applying stash of '#{@path.to_s}':\n#{out}" unless quiet
+      end
+    end
+
+    # case ref_array.length
+    # when >= 2
+    #   returns original array
+    # when 1
+    #   returns the given ref plus the one before it
+    # when 0
+    #   returns the most recent 2 refs
+    private def expand_refs(ref_array)
+      return ref_array if ref_array.length >= 2
+
+      @in_git_path.checkout!(ref_array.first) if ref_array.first
+
+      branches_string = @in_git_path.run!("git log --format='%H' -n 2")
+      ref_array = branches_string.split($/)
+      return ref_array
+    end
+  end
+end

data/lib/derailed_benchmarks/git_switch_project.rb

@@ -0,0 +1 @@
+

data/lib/derailed_benchmarks/require_tree.rb

@@ -40,7 +40,7 @@ module DerailedBenchmarks
     end
 
     def to_string
-      str = +"#{name}: #{cost.round(4)} MiB"
+      str = String.new("#{name}: #{cost.round(4)} MiB")
       if parent && REQUIRED_BY[self.name.to_s]
         names = REQUIRED_BY[self.name.to_s].uniq - [parent.name.to_s]
         if names.any?

data/lib/derailed_benchmarks/{stats_in_file.rb → stats_for_file.rb}

@@ -16,24 +16,30 @@ module DerailedBenchmarks
   #  x.average # => 10.5
   #  x.name    # => "muhfile"
   class StatsForFile
-    attr_reader :name, :values, :desc, :time
+    attr_reader :name, :values, :desc, :time, :short_sha
 
-    def initialize(file:, name:, desc: "", time: )
+    def initialize(file:, name:, desc: "", time: , short_sha: nil)
       @file = Pathname.new(file)
       FileUtils.touch(@file)
 
       @name = name
       @desc = desc
       @time = time
+      @short_sha = short_sha
     end
 
     def call
       load_file!
+      return if values.empty?
 
       @median = (values[(values.length - 1) / 2] + values[values.length/ 2]) / 2.0
       @average = values.inject(:+) / values.length
     end
 
+    def empty?
+      values.empty?
+    end
+
     def median
       @median.to_f
     end

data/lib/derailed_benchmarks/stats_from_dir.rb

@@ -2,9 +2,9 @@
 
 require 'bigdecimal'
 require 'statistics'
-require 'unicode_plot'
 require 'stringio'
 require 'mini_histogram'
+require 'mini_histogram/plot'
 
 module DerailedBenchmarks
   # A class used to read several benchmark files
@@ -29,14 +29,28 @@ module DerailedBenchmarks
     FORMAT = "%0.4f"
     attr_reader :stats, :oldest, :newest
 
-    def initialize(hash)
+    def initialize(input)
       @files = []
 
-      hash.each do |branch, info_hash|
-        file = info_hash.fetch(:file)
-        desc = info_hash.fetch(:desc)
-        time = info_hash.fetch(:time)
-        @files << StatsForFile.new(file: file, desc: desc, time: time, name: branch)
+      if input.is_a?(Hash)
+        hash = input
+        hash.each do |branch, info_hash|
+          file = info_hash.fetch(:file)
+          desc = info_hash.fetch(:desc)
+          time = info_hash.fetch(:time)
+          short_sha = info_hash["short_sha"]
+          @files << StatsForFile.new(file: file, desc: desc, time: time, name: branch, short_sha: short_sha)
+        end
+      else
+        input.each do |commit|
+          @files << StatsForFile.new(
+            file: commit.file,
+            desc: commit.desc,
+            time: commit.time,
+            name: commit.ref,
+            short_sha: commit.short_sha
+          )
+        end
       end
       @files.sort_by! { |f| f.time }
       @oldest = @files.first
@@ -46,6 +60,8 @@ module DerailedBenchmarks
     def call
       @files.each(&:call)
 
+      return self if @files.detect(&:empty?)
+
       stats_95 = statistical_test(confidence: 95)
 
       # If default check is good, see if we also pass a more rigorous test
@@ -109,12 +125,12 @@ module DerailedBenchmarks
       MiniHistogram.set_average_edges!(newest_histogram, oldest_histogram)
 
       {newest => newest_histogram, oldest => oldest_histogram}.each do |report, histogram|
-        plot = UnicodePlot.histogram(
-          histogram,
-          title: "\n#{' ' * 18 }Histogram - [#{report.name}] #{report.desc.inspect}",
+        plot = histogram.plot(
+          title: "\n#{' ' * 18 }Histogram - [#{report.short_sha || report.name}] #{report.desc.inspect}",
           ylabel: "Time (s)",
           xlabel: "# of runs in range"
         )
+
         plot.render(io)
         io.puts
       end
@@ -123,6 +139,8 @@ module DerailedBenchmarks
     end
 
     def banner(io = $stdout)
+      return if @files.detect(&:empty?)
+
       io.puts
       if significant?
         io.puts "❤️ ❤️ ❤️  (Statistically Significant) ❤️ ❤️ ❤️"
@@ -130,11 +148,11 @@ module DerailedBenchmarks
         io.puts "👎👎👎(NOT Statistically Significant) 👎👎👎"
       end
       io.puts
-      io.puts "[#{newest.name}] #{newest.desc.inspect} - (#{newest.median} seconds)"
+      io.puts "[#{newest.short_sha || newest.name}] (#{FORMAT % newest.median} seconds) #{newest.desc.inspect} ref: #{newest.name.inspect}"
       io.puts "  #{change_direction} by:"
       io.puts "    #{align}#{FORMAT % x_faster}x [older/newer]"
       io.puts "    #{FORMAT % percent_faster}\% [(older - newer) / older * 100]"
-      io.puts "[#{oldest.name}] #{oldest.desc.inspect} - (#{oldest.median} seconds)"
+      io.puts "[#{oldest.short_sha || oldest.name}] (#{FORMAT % oldest.median} seconds) #{oldest.desc.inspect} ref: #{oldest.name.inspect}"
       io.puts
       io.puts "Iterations per sample: #{ENV["TEST_COUNT"]}"
       io.puts "Samples: #{newest.values.length}"

data/lib/derailed_benchmarks/tasks.rb

@@ -17,96 +17,57 @@ namespace :perf do
       script = ENV["DERAILED_SCRIPT"] || "bundle exec derailed exec perf:test"
 
       if ENV["DERAILED_PATH_TO_LIBRARY"]
-        library_dir = ENV["DERAILED_PATH_TO_LIBRARY"]
+        library_dir = ENV["DERAILED_PATH_TO_LIBRARY"].chomp
       else
         library_dir = DerailedBenchmarks.rails_path_on_disk
       end
-
-      raise "Must be a path with a .git directory '#{library_dir}'" unless File.exist?(File.join(library_dir, ".git"))
-
-      # Use either the explicit SHAs when present or grab last two SHAs from commit history
-      # if only one SHA is given, then use it and the last SHA from commit history
-      branch_names = []
-      branch_names = ENV.fetch("SHAS_TO_TEST").split(",") if ENV["SHAS_TO_TEST"]
-      if branch_names.length < 2
-        Dir.chdir(library_dir) do
-          run!("git checkout '#{branch_names.first}'") unless branch_names.empty?
-
-          branches = run!('git log --format="%H" -n 2').chomp.split($/)
-          if branch_names.empty?
-            branch_names = branches
-          else
-            branches.shift
-            branch_names << branches.shift
-          end
-        end
-      end
-
-      current_library_branch = ""
-      Dir.chdir(library_dir) { current_library_branch = run!('git describe --contains --all HEAD').chomp }
+      library_dir = Pathname.new(library_dir)
 
       out_dir = Pathname.new("tmp/compare_branches/#{Time.now.strftime('%Y-%m-%d-%H-%M-%s-%N')}")
       out_dir.mkpath
 
-      branches_to_test = branch_names.each_with_object({}) {|elem, hash| hash[elem] = out_dir + "#{elem.gsub('/', ':')}.bench.txt" }
-      branch_info = {}
-      branch_to_sha = {}
+      ref_string = ENV["SHAS_TO_TEST"] || ENV["REFS_TO_TEST"] || ""
 
-      branches_to_test.each do |branch, file|
-        Dir.chdir(library_dir) do
-          run!("git checkout '#{branch}'")
-          description = run!("git log --oneline --format=%B -n 1 HEAD | head -n 1").strip
-          time_stamp  = run!("git log -n 1 --pretty=format:%ci").strip # https://stackoverflow.com/a/25921837/147390
-          short_sha   = run!("git rev-parse --short HEAD").strip
-          branch_to_sha[branch] = short_sha
+      project = DerailedBenchmarks::Git::SwitchProject.new(
+        path: library_dir,
+        ref_array: ref_string.split(","),
+        log_dir: out_dir
+      )
 
-          branch_info[short_sha] = { desc: description, time: DateTime.parse(time_stamp), file: file }
-        end
-        run!("#{script}")
-      end
+      stats = DerailedBenchmarks::StatsFromDir.new(project.commits)
 
+      # Advertise branch names early to make sure people know what they're testing
       puts
       puts
-      branches_to_test.each.with_index do |(branch, _), i|
-        short_sha = branch_to_sha[branch]
-        desc      = branch_info[short_sha][:desc]
-        puts "Testing #{i + 1}: #{short_sha}: #{desc}"
+      project.commits.each_with_index do |commit, i|
+        puts "Testing #{i + 1}: #{commit.short_sha}: #{commit.description}"
       end
       puts
       puts
 
-      raise "SHAs to test must be different" if branch_info.length == 1
-      stats = DerailedBenchmarks::StatsFromDir.new(branch_info)
-      puts "Env var no longer has any affect DERAILED_STOP_VALID_COUNT" if ENV["DERAILED_STOP_VALID_COUNT"]
+      project.restore_branch_on_return do
+        DERAILED_SCRIPT_COUNT.times do |i|
+          puts "Sample: #{i.next}/#{DERAILED_SCRIPT_COUNT} iterations per sample: #{ENV['TEST_COUNT']}"
+          project.commits.each do |commit|
+            commit.checkout!
 
-      DERAILED_SCRIPT_COUNT.times do |i|
-        puts "Sample: #{i.next}/#{DERAILED_SCRIPT_COUNT} iterations per sample: #{ENV['TEST_COUNT']}"
-        branches_to_test.each do |branch, file|
-          Dir.chdir(library_dir) { run!("git checkout '#{branch}'") }
-          run!(" #{script} 2>&1 | tail -n 1 >> '#{file}'")
-        end
+            output = run!("#{script} 2>&1")
+            commit.log.open("a") {|f| f.puts output.lines.last }
+          end
 
-        if (i % 50).zero?
-          puts "Intermediate result"
-          stats.call
-          stats.banner
-          puts "Continuing execution"
+          if (i % 50).zero?
+            puts "Intermediate result"
+            stats.call.banner
+            puts "Continuing execution"
+          end
         end
       end
 
     ensure
-      if library_dir && current_library_branch
-        puts "Resetting git dir of '#{library_dir.to_s}' to #{current_library_branch.inspect}"
-        Dir.chdir(library_dir) do
-          run!("git checkout '#{current_library_branch}'")
-        end
-      end
-
       if stats
-        stats.call
-        stats.banner
+        stats.call.banner
 
-        result_file = out_dir + "results.txt"
+        result_file = out_dir.join("results.txt")
         File.open(result_file, "w") do |f|
           stats.banner(f)
         end

data/lib/derailed_benchmarks/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DerailedBenchmarks
-  VERSION = "1.7.0"
+  VERSION = "1.8.0"
 end

data/test/derailed_benchmarks/git_switch_project_test.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class GitSwitchProjectTest < ActiveSupport::TestCase
+  test "tells me when it's not pointing at a git project" do
+    exception = assert_raises {
+      DerailedBenchmarks::Git::SwitchProject.new(path: "/dev/null")
+    }
+    assert_includes(exception.message, '.git directory')
+  end
+
+  test "dirty gemspec cleaning" do
+    Dir.mktmpdir do |dir|
+      run!("git clone https://github.com/sharpstone/default_ruby #{dir} 2>&1 && cd #{dir} && git checkout 6e642963acec0ff64af51bd6fba8db3c4176ed6e 2>&1 && git checkout -b mybranch 2>&1")
+      run!("cd #{dir} && echo lol > foo.gemspec && git add .")
+
+      io = StringIO.new
+      project = DerailedBenchmarks::Git::SwitchProject.new(path: dir, io: io)
+
+      assert project.dirty?
+      refute project.clean?
+
+      project.restore_branch_on_return do
+        project.commits.map(&:checkout!)
+      end
+
+      assert_includes io.string, "Bundler modifies gemspec files"
+      assert_includes io.string, "Applying stash"
+    end
+  end
+
+  test "works on a git repo" do
+    Dir.mktmpdir do |dir|
+      run!("git clone https://github.com/sharpstone/default_ruby #{dir} 2>&1 && cd #{dir} && git checkout 6e642963acec0ff64af51bd6fba8db3c4176ed6e 2>&1 && git checkout -b mybranch 2>&1")
+
+      # finds shas when none given
+      project = DerailedBenchmarks::Git::SwitchProject.new(path: dir)
+
+      assert_equal ["6e642963acec0ff64af51bd6fba8db3c4176ed6e", "da748a59340be8b950e7bbbfb32077eb67d70c3c"], project.commits.map(&:ref)
+      first_commit = project.commits.first
+
+      assert_equal "CI test support", first_commit.description
+      assert_equal "6e64296", first_commit.short_sha
+      assert_equal "/dev/null/6e642963acec0ff64af51bd6fba8db3c4176ed6e.bench.txt", first_commit.log.to_s
+      assert_equal DateTime.parse("Tue, 14 Apr 2020 13:26:03 -0500"), first_commit.time
+
+      assert_equal "mybranch", project.current_branch_or_sha
+
+      # Finds shas when 1 is given
+      project = DerailedBenchmarks::Git::SwitchProject.new(path: dir, ref_array: ["da748a59340be8b950e7bbbfb32077eb67d70c3c"])
+
+      assert_equal ["da748a59340be8b950e7bbbfb32077eb67d70c3c", "5c09f748957d2098182762004adee27d1ff83160"], project.commits.map(&:ref)
+
+
+      # Returns correct refs if given
+      project = DerailedBenchmarks::Git::SwitchProject.new(path: dir, ref_array: ["da748a59340be8b950e7bbbfb32077eb67d70c3c", "9b19275a592f148e2a53b87ead4ccd8c747539c9"])
+
+      assert_equal ["da748a59340be8b950e7bbbfb32077eb67d70c3c", "9b19275a592f148e2a53b87ead4ccd8c747539c9"], project.commits.map(&:ref)
+
+      first_commit = project.commits.first
+
+      first_commit.checkout!
+
+      assert_equal first_commit.short_sha, project.current_branch_or_sha
+
+      # Test restore_branch_on_return
+      project.restore_branch_on_return(quiet: true) do
+        project.commits.last.checkout!
+
+        assert_equal project.commits.last.short_sha, project.current_branch_or_sha
+      end
+
+      assert_equal project.commits.first.short_sha, project.current_branch_or_sha
+
+      exception = assert_raise {
+        DerailedBenchmarks::Git::SwitchProject.new(path: dir, ref_array: ["6e642963acec0ff64af51bd6fba8db3c4176ed6e", "mybranch"])
+      }
+
+      assert_includes(exception.message, 'Duplicate SHA resolved "6e64296"')
+    end
+  end
+end

data/test/derailed_benchmarks/stats_from_dir_test.rb

@@ -3,6 +3,19 @@
 require 'test_helper'
 
 class StatsFromDirTest < ActiveSupport::TestCase
+  test "empty files" do
+    Dir.mktmpdir do |dir|
+      dir = Pathname.new(dir)
+      branch_info = {}
+      branch_info["loser"]  = { desc: "Old commit", time: Time.now, file: dir.join("loser"), name: "loser" }
+      branch_info["winner"] = { desc: "I am the new commit", time: Time.now + 1, file: dir.join("winner"), name: "winner" }
+      stats = DerailedBenchmarks::StatsFromDir.new(branch_info).call
+      io = StringIO.new
+      stats.call.banner(io: io) # Doesn't error
+      assert_equal "", io.read
+    end
+  end
+
   test "that it works" do
     dir = fixtures_dir("stats/significant")
     branch_info = {}
@@ -38,7 +51,6 @@ class StatsFromDirTest < ActiveSupport::TestCase
 
     io = StringIO.new
     stats.call.banner(io)
-    puts io.string
 
     assert_match(/11\.2 , 11\.28/, io.string)
     assert_match(/11\.8 , 11\.88/, io.string)
@@ -64,10 +76,13 @@ class StatsFromDirTest < ActiveSupport::TestCase
 
   test "banner faster" do
     dir = fixtures_dir("stats/significant")
-    branch_info = {}
-    branch_info["loser"]  = { desc: "Old commit", time: Time.now, file: dir.join("loser.bench.txt"), name: "loser" }
-    branch_info["winner"] = { desc: "I am the new commit", time: Time.now + 1, file: dir.join("winner.bench.txt"), name: "winner" }
-    stats = DerailedBenchmarks::StatsFromDir.new(branch_info).call
+    Branch_info = {}
+
+    require 'ostruct'
+    commits = []
+    commits << OpenStruct.new({ desc: "Old commit", time: Time.now, file: dir.join("loser.bench.txt"), ref: "loser", short_sha: "aaaaa" })
+    commits << OpenStruct.new({ desc: "I am the new commit", time: Time.now + 1, file: dir.join("winner.bench.txt"), ref: "winner", short_sha: "bbbbb" })
+    stats = DerailedBenchmarks::StatsFromDir.new(commits).call
     newest = stats.newest
     oldest = stats.oldest
 
@@ -88,12 +103,12 @@ class StatsFromDirTest < ActiveSupport::TestCase
       11.0
     end
 
-    expected = <<~EOM
-[winner] "I am the new commit" - (10.5 seconds)
+    expected = <<-EOM
+[bbbbb] (10.5000 seconds) "I am the new commit" ref: "winner"
   FASTER 🚀🚀🚀 by:
     1.0476x [older/newer]
     4.5455% [(older - newer) / older * 100]
-[loser] "Old commit" - (11.0 seconds)
+[aaaaa] (11.0000 seconds) "Old commit" ref: "loser"
 EOM
 
     actual = StringIO.new
@@ -119,12 +134,12 @@ EOM
       11.0
     end
 
-    expected = <<~EOM
-[loser] "I am the new commit" - (11.0 seconds)
+    expected = <<-EOM
+[loser] (11.0000 seconds) "I am the new commit" ref: "loser"
   SLOWER 🐢🐢🐢 by:
      0.9545x [older/newer]
     -4.7619% [(older - newer) / older * 100]
-[winner] "Old commit" - (10.5 seconds)
+[winner] (10.5000 seconds) "Old commit" ref: "winner"
 EOM
 
     actual = StringIO.new

data/test/fixtures/require/child_one.rb

@@ -1,4 +1,4 @@
 class ChildOne
-  @retained = +""
+  @retained = String.new("")
   50_000.times.map { @retained << "A" }
 end

data/test/fixtures/require/child_two.rb

@@ -1,5 +1,5 @@
 class ChildTwo
-  @retained = +""
+  @retained = String.new("")
   200_000.times.map { @retained << "A" }
 end
 

data/test/fixtures/require/parent_one.rb

@@ -1,5 +1,5 @@
 class ParentOne
-  @retained = +""
+  @retained = String.new("")
   1_000_000.times.map { @retained << "A" }
 end
 require File.expand_path('../child_one.rb', __FILE__)

data/test/integration/tasks_test.rb

@@ -26,21 +26,45 @@ class TasksTest < ActiveSupport::TestCase
     env_string = env.map {|key, value| "#{key.shellescape}=#{value.to_s.shellescape}" }.join(" ")
     cmd        = "env #{env_string} bundle exec rake -f perf.rake #{cmd} --trace"
     puts "Running: #{cmd}"
-    result = Bundler.with_original_env { `cd '#{rails_app_path}' && #{cmd}` }
-    if assert_success
-      assert $?.success?, "Expected '#{cmd}' to return a success status.\nOutput: #{result}"
+    result = Bundler.with_original_env { `cd '#{rails_app_path}' && #{cmd} 2>&1` }
+    if assert_success && !$?.success?
+      puts result
+      raise "Expected '#{cmd}' to return a success status.\nOutput: #{result}"
     end
 
     result
   end
 
-  test 'library_branches' do
+  test 'non-rails library with branch specified' do
+    skip unless ENV['USING_RAILS_WICKED_BRANCH']
+
+    gem_path = run!("bundle info wicked --path")
+    env = { "TEST_COUNT" => 10, "DERAILED_SCRIPT_COUNT" => 2, "DERAILED_PATH_TO_LIBRARY" => gem_path}
+    puts rake "perf:library", { env: env }
+  end
+
+  test 'rails perf:library from git' do
+    # BUNDLE_GEMFILE="$(pwd)/gemfiles/rails_git.gemfile" bundle exec m test/integration/tasks_test.rb:<linenumber>
+
     skip unless ENV['USING_RAILS_GIT']
 
-    env = { "TEST_COUNT" => 10, "DERAILED_SCRIPT_COUNT" => 2, "SHAS_TO_TEST" => "3054e1d584e7eca110c69a1f8423f2e0866abbf9,80f989aecece1a2b1830e9c953e5887421b52d3c"}
+    env = { "TEST_COUNT" => 2, "DERAILED_SCRIPT_COUNT" => 2, "SHAS_TO_TEST" => "3054e1d584e7eca110c69a1f8423f2e0866abbf9,80f989aecece1a2b1830e9c953e5887421b52d3c"}
     puts rake "perf:library", { env: env }
   end
 
+  test "rails perf:library with bad script" do
+    # BUNDLE_GEMFILE="$(pwd)/gemfiles/rails_git.gemfile" bundle exec m test/integration/tasks_test.rb:<linenumber>
+
+    skip unless ENV['USING_RAILS_GIT']
+
+    error = assert_raises {
+      env = { "DERAILED_SCRIPT" => "nopenopenop", "TEST_COUNT" => 2, "DERAILED_SCRIPT_COUNT" => 2, "SHAS_TO_TEST" => "3054e1d584e7eca110c69a1f8423f2e0866abbf9,80f989aecece1a2b1830e9c953e5887421b52d3c"}
+      puts rake "perf:library", { env: env }
+    }
+
+    assert error.message =~ /nopenopenop:( command)? not found/, "Expected #{error.message} to include /nopenopenop: (command)? not found/ but it did not"
+  end
+
   test 'hitting authenticated devise apps' do
     env = { "PATH_TO_HIT" => "authenticated", "USE_AUTH" => "true", "TEST_COUNT" => "2" }
     result = rake 'perf:test', env: env

data/test/test_helper.rb

@@ -63,3 +63,9 @@ end
 def rails_app_path(name = "")
   root_path("test/rails_app").join(name)
 end
+
+def run!(cmd)
+  output = `#{cmd}`
+  raise "Cmd #{cmd} failed:\n#{output}" unless $?.success?
+  output
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: derailed_benchmarks
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.8.0
 platform: ruby
 authors:
 - Richard Schneeman
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-03-25 00:00:00.000000000 Z
+date: 2020-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: heapy
@@ -135,39 +135,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.1'
 - !ruby/object:Gem::Dependency
-  name: unicode_plot
+  name: mini_histogram
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.4
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 0.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.4
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-- !ruby/object:Gem::Dependency
-  name: mini_histogram
-  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'
+        version: 0.2.1
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement
@@ -277,13 +257,18 @@ files:
 - lib/derailed_benchmarks/auth_helper.rb
 - lib/derailed_benchmarks/auth_helpers/devise.rb
 - lib/derailed_benchmarks/core_ext/kernel_require.rb
+- lib/derailed_benchmarks/git/commit.rb
+- lib/derailed_benchmarks/git/in_path.rb
+- lib/derailed_benchmarks/git/switch_project.rb
+- lib/derailed_benchmarks/git_switch_project.rb
 - lib/derailed_benchmarks/load_tasks.rb
 - lib/derailed_benchmarks/require_tree.rb
+- lib/derailed_benchmarks/stats_for_file.rb
 - lib/derailed_benchmarks/stats_from_dir.rb
-- lib/derailed_benchmarks/stats_in_file.rb
 - lib/derailed_benchmarks/tasks.rb
 - lib/derailed_benchmarks/version.rb
 - test/derailed_benchmarks/core_ext/kernel_require_test.rb
+- test/derailed_benchmarks/git_switch_project_test.rb
 - test/derailed_benchmarks/require_tree_test.rb
 - test/derailed_benchmarks/stats_from_dir_test.rb
 - test/derailed_test.rb
@@ -348,7 +333,7 @@ homepage: https://github.com/schneems/derailed_benchmarks
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -356,7 +341,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -364,11 +349,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Benchmarks designed to performance test your ENTIRE site
 test_files:
 - test/derailed_benchmarks/core_ext/kernel_require_test.rb
+- test/derailed_benchmarks/git_switch_project_test.rb
 - test/derailed_benchmarks/require_tree_test.rb
 - test/derailed_benchmarks/stats_from_dir_test.rb
 - test/derailed_test.rb