rspec-profiler 1.0.8

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem 'rake'

data/README.textile

@@ -0,0 +1,41 @@
+h1. rspec-profiler
+
+_Currently_ _tested_ _only_ _for_ _rspec-2.11_
+
+The rspec-profiler is a custom formatter that adds functionality to the existing --profile option in
+rspec. The rspec-profiler first groups tests together by their folder under the spec directory
+(models, lib, controllers, etc...). Then the standard deviation is calculated. Any test within a
+group that is 2 or more standard deviations away from the mean is listed.
+
+There are downsides of course to doing it this way. For example, with a mean of .02 seconds and a
+standard deviation of .01 seconds, a test that takes .04 seconds will be listed when perhaps one
+wouldn't think a test that takes 0.04 seconds to complete to be in need of attention. I will simply
+advise, as with any benchmark, to not take the results too seriously. Rather, you should use the
+results as a way to identify tests that _may_ need to be looked at for performance issues. And, as
+always, running the benchmark multiple times will give you a better sense of the tests that are
+consistantly slow. A test may be benchmarked noticably slower in one trial due any number of reasons
+but run faster in the next.
+
+h2. Installation
+
+1. Put the profiler in your @Gemfile@
+
+2. When running your specs use:
+
+bc. $ rspec --format Profiler -p spec
+
+If for some reason rspec cannot find the Profiler, you case use the @-r@ option and provide the PATH
+to @profiler.rb@.
+
+Alternatively, you can make the Profiler formatter your default formatter by modifying your @.rspec@
+file (the Profiler inherits from the Progress formatter, you know, the one that uses the green dots):
+
+bc. --format Profiler
+
+_Note_: The performance profile will not display unless you specify the @-p@ option when running
+rspec. Additionally, when tests fail, the profile will not display which is consistant with how the
+bundled profiler works as well.
+
+_If you use Timecop_: If you use the timecop gem to freeze or change time be sure to also return the
+time after each of your tests. Not doing so will make it appear as if your tests are taking either
+far too long or have taken negative time to complete. 

data/Rakefile

@@ -0,0 +1,6 @@
+require 'rake'
+
+task :default => :spec
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new

data/lib/profiler.rb

@@ -0,0 +1,90 @@
+require 'rspec/core/formatters/progress_formatter'
+
+module Math::Array
+  def sum
+    self.inject(0){ |accum, i| accum + i }
+  end
+
+  def mean
+    self.sum/self.length.to_f
+  end
+
+  def sample_variance
+    m = self.mean
+    sum = self.inject(0) { |accum, i| accum + (i - m) ** 2 }
+    sum / (self.length).to_f
+  end
+
+  def standard_deviation
+    return Math.sqrt(self.sample_variance)
+  end
+end
+
+class Profiler < RSpec::Core::Formatters::ProgressFormatter
+  def dump_profile
+    groups = {}
+    examples.each do |e|
+      e.location =~ /\/spec\//
+      key = $'.gsub(/\/.*$/,'').strip.to_sym
+      if groups.has_key? key
+        groups[key] = groups[key] << e
+      else
+        groups[key] = [e]
+      end
+    end
+
+    groups.each_key do |group_name|
+      print_report(groups[group_name.to_sym], group_name.to_s)
+    end
+  end
+
+  protected
+
+  def print_report(grouped_examples, group_name)
+    grouped_examples = grouped_examples.sort_by do |e|
+      e.execution_result[:run_time]
+    end.reverse
+
+    times = grouped_examples.map { |e| e.execution_result[:run_time] }
+    times.extend Math::Array
+    mean = times.mean
+    stddev = times.standard_deviation
+    k = 2
+    grouped_examples.reject! { |e| e.execution_result[:run_time] < (mean + k * stddev) }
+
+    output.puts "\n\nGroup: #{bold magenta(group_name.to_s.capitalize)}"
+    output.puts "#{bold red(grouped_examples.size)} of #{bold green(times.size)} spec(s) were 2 or greater standard deviations above the mean"
+    output.puts cyan "#{"Mean execution time:"} #{format_time(mean)}"
+    output.puts cyan "#{"Standard Deviation:"} #{"%.5f" % stddev}"
+
+    grouped_examples.each_with_index do |example, i|
+      location = example.location.match(/\/spec\/.*$/)[0]
+      output.puts cyan("#{i+1}.\t#{format_time(example.execution_result[:run_time])}") + white(" \t#{format_caller(location)}")
+    end
+  end
+
+  def format_time(duration)
+    if duration > 60
+      minutes = duration.to_i / 60
+      seconds = duration - minutes * 60
+
+      red "#{minutes}m #{format_seconds(seconds)}s"
+    elsif duration > 10
+      red "#{format_seconds(duration)}s"
+    elsif duration > 3
+      yellow "#{format_seconds(duration)}s"
+    else
+      "#{format_seconds(duration)}s"
+    end
+  end
+
+  def format_seconds(float)
+    precision ||= (float < 1) ? SUB_SECOND_PRECISION : DEFAULT_PRECISION
+    sprintf("%.#{precision}f", float)
+  end
+
+  def cyan(text)
+    color(text, "\e[36m")
+  end
+  
+end

data/rspec-profiler.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new do |s|
+  s.name        = "rspec-profiler"
+  s.version     = "1.0.8"
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Michael Blumberg"]
+  s.email       = ["mblum14@gmail.com"]
+  s.homepage    = "https://github.com/mblum14/rspec-profiler"
+  s.summary     = %q{A better formatter for the rspec performance profile}
+  s.description = %q{A better formatter for the rspec performance profile}
+
+  s.rubyforge_project = "rspec-profiler"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency('rspec', ["~> 2.8.0"])
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: rspec-profiler
+version: !ruby/object:Gem::Version
+  version: 1.0.8
+  prerelease: 
+platform: ruby
+authors:
+- Michael Blumberg
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+description: A better formatter for the rspec performance profile
+email:
+- mblum14@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.textile
+- Rakefile
+- lib/profiler.rb
+- rspec-profiler.gemspec
+homepage: https://github.com/mblum14/rspec-profiler
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: rspec-profiler
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A better formatter for the rspec performance profile
+test_files: []