timed_specs 0.0.1

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in timed_specs.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/timed_specs/version.rb

@@ -0,0 +1 @@
+VERSION = "0.0.1"

data/lib/timed_specs.rb

@@ -0,0 +1,75 @@
+require 'rspec/core/formatters/documentation_formatter'
+
+
+class TimedSpecs < RSpec::Core::Formatters::DocumentationFormatter
+  SLOWEST_EXAMPLES_COUNT = (ENV['SLOWEST_EXAMPLES_COUNT'] || 20).to_i
+
+  def initialize(*args)
+    super
+    @examples_with_execution_time = []
+  end
+
+  def start(*args)
+    @output.puts "Time Specs Enabled"
+    super
+  end
+
+  def example_group_started(*args)
+    @group_time = Time.now
+    super
+  end
+
+  def example_group_finished(*args)
+    super
+    if @group_time
+      output.puts current_indentation + white("#{(Time.now - @group_time).round(3)}s")
+      @group_time = nil
+    else
+      output.puts
+    end
+  end
+
+  # Overridden method of the base documentation formatter
+  # Is executed after each passed example
+  def example_passed(example)
+    super(example)
+    @examples_with_execution_time << [
+      example.description,
+      example.metadata[:execution_result][:run_time], # this is the time taken to execute the example
+      format_caller(example.location) # relative path to the example file
+    ]
+  end
+
+  # Overridden method of the base documentation formatter
+  # Used by DocumentationFormatter to display the example info after each passed example
+  # super - displays the example description
+  # Then display the execution time beside it
+  def passed_output(example)
+    super + cyan(" : #{example.metadata[:execution_result][:run_time].round(3)}s")
+  end
+
+  def start_dump
+    output_slowest_examples unless @examples_with_execution_time.empty?
+    super
+  end
+
+  private
+
+  def output_slowest_examples
+    output.puts bold("\n\nSlowest examples:\n")
+
+    sort_by_run_time(@examples_with_execution_time)[0..SLOWEST_EXAMPLES_COUNT-1].each do |example|
+      output_slow_example(example)
+    end
+  end
+
+  def output_slow_example(example)
+    output.puts "#{bold(example[1].round(4))} #{example[0]}"
+    output.puts "    " + cyan("# #{example[2]}")
+  end
+
+  def sort_by_run_time(examples)
+    # example[1] = example_run_time
+    examples.sort{|x,y| y[1] <=> x[1] }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,33 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'pry'
+require 'timed_specs'
+
+# To properly reset the value of constants
+# Extracted from: http://digitaldumptruck.jotabout.com/?p=551
+def with_constants(constants)
+  saved_constants = {}
+
+  begin
+    constants.each do |constant, val|
+      saved_constants[constant] = TimedSpecs.const_get( constant )
+      without_warnings { TimedSpecs.const_set(constant, val) }
+    end
+    yield
+  ensure
+    saved_constants.each do |constant, val|
+      without_warnings { TimedSpecs.const_set(constant, val) }
+    end
+  end
+end
+
+# Assigning a value to a constant generates a warning which is supressed by this method
+def without_warnings
+  original_verbosity = $VERBOSE
+  begin
+    $VERBOSE = nil
+    yield
+  ensure
+    $VERBOSE = original_verbosity
+  end
+end

data/spec/time_specs_spec.rb

@@ -0,0 +1,201 @@
+require 'spec_helper'
+
+describe TimedSpecs do
+
+  let(:output) { StringIO.new }
+  let(:formatter) { TimedSpecs.new(output) }
+  let(:example_group){ RSpec::Core::ExampleGroup.describe("dummy example group") }
+
+  context "when initialized" do
+    describe "@examples_with_execution_time" do
+      it "should be initialized" do
+        formatter.instance_variables.should include(:@examples_with_execution_time)
+      end
+      it "should be an empty array" do
+        formatter.instance_variable_get("@examples_with_execution_time").should eq([])
+      end
+    end
+  end
+
+  describe "#start" do
+    context "output" do
+      before do
+        formatter.start(0)
+      end
+      specify{ formatter.output.string.should include("Time Specs Enabled") }
+    end
+  end
+
+  describe "#example_group_started" do
+    before do
+      @current_time = Time.now + 50
+      Time.stub(:now).and_return(@current_time)
+      formatter.example_group_started(example_group)
+    end
+
+    it "should initialize @group_time" do
+      formatter.instance_variables.should include(:@group_time)
+    end
+
+    it "should set @group_time to the current time" do
+      formatter.instance_variable_get("@group_time").should eq(@current_time)
+    end
+
+  end
+
+  describe "#example_group_finished" do
+    context "when @group_time is set" do
+      before do
+        @time1 = Time.now
+        @time2 = Time.now + 10
+        Time.stub(:now).and_return(@time2)
+        formatter.stub(:current_indentation).and_return("###")
+        formatter.instance_variable_set("@group_time", @time1)
+        formatter.example_group_finished(example_group)
+      end
+
+      it "should reset @group_time" do
+        formatter.instance_variable_get("@group_time").should be_nil
+      end
+
+      context "output" do
+        subject{ formatter.output.string }
+        it "should include the group time" do
+          subject.should include((@time2 - @time1).round(3).to_s)
+        end
+
+        it "should include the current indentation" do
+          subject.should include("###")
+        end
+      end
+    end
+
+    context "when @group_time is not set" do
+      specify{ expect{formatter.example_group_finished(example_group)}.to_not raise_error }
+      context "output" do
+        before do
+          formatter.example_group_finished(example_group)
+        end
+        subject{ formatter.output.string }
+        it{ should include("\n") }
+      end
+    end
+  end
+
+  describe "#example_passed" do
+    let(:example){
+      double(
+        "dummy example",
+        :description => "my dummy example",
+        :metadata => {
+          :execution_result => {:status => 'passed', :exception => Exception.new , :run_time => 1.1234}
+        },
+        :location => "location_to_the_example"
+      )
+    }
+
+    before do
+      formatter.stub(:format_caller).with("location_to_the_example").and_return("formatted_location_to_the_example")
+      formatter.example_passed(example)
+    end
+
+    it "should store the example in @examples_with_execution_time" do
+      formatter.instance_variable_get("@examples_with_execution_time").length.should eq(1)
+    end
+
+    context "the stored example" do
+      subject{ formatter.instance_variable_get("@examples_with_execution_time").first }
+
+      it{ should be_an(Array) }
+
+      it "should contain the description" do
+        subject[0].should eq("my dummy example")
+      end
+
+      it "should contain the execution time" do
+        subject[1].should eq(1.1234)
+      end
+
+      it "should contain the formatted location" do
+        subject[2].should eq("formatted_location_to_the_example")
+      end
+    end
+
+    context "output" do
+      subject{ formatter.output.string }
+
+      it{ should include(formatter.send(:cyan," : 1.123s")) }
+    end
+  end
+
+  describe "#start_dump" do
+    context "when there are no examples" do
+      it "should not attempt to display the slowest examples" do
+        formatter.should_receive(:output_slowest_examples).exactly(0).times
+        formatter.start_dump
+      end
+    end
+    context "when there are some examples" do
+      it "should display the slowest examples" do
+        formatter.instance_variable_set("@examples_with_execution_time", [1])
+        formatter.should_receive(:output_slowest_examples).once.and_return(true)
+        formatter.start_dump
+      end
+    end
+  end
+
+  describe "#output_slowest_examples" do
+    let(:examples_with_execution_time){
+      5.times.map{|x| ["example#{x}", rand(1000)/rand(1000).to_f, "location_to_example#{x}"] }
+    }
+    before do
+      formatter.instance_variable_set("@examples_with_execution_time", examples_with_execution_time)
+    end
+    context "output" do
+      it "should contain the slowest examples heading" do
+        formatter.send("output_slowest_examples")
+        formatter.output.string.should include("Slowest examples:")
+      end
+    end
+    context "when the SLOWEST_EXAMPLES_COUNT is greater than the examples count" do
+      it "should show the times for all the examples" do
+        formatter.should_receive(:output_slow_example).exactly(5).times.and_return(true)
+        formatter.send("output_slowest_examples")
+      end
+    end
+
+    context "when the SLOWEST_EXAMPLES_COUNT is less than the examples count" do
+      it "should only show the SLOWEST_EXAMPLES_COUNT number of examples" do
+        formatter.should_receive(:output_slow_example).exactly(2).times.and_return(true)
+        with_constants :SLOWEST_EXAMPLES_COUNT => 2 do
+          formatter.send("output_slowest_examples")
+        end
+      end
+    end
+  end
+
+  describe "#output_slow_example" do
+    let(:slow_example){ ["example1", 1.23456, "location_to_example1"] }
+    before do
+      formatter.send("output_slow_example", slow_example)
+    end
+    context "output" do
+      subject{ formatter.output.string }
+      
+      it{ should include("example1"), "should include the example description" }
+      it{ should include(formatter.send(:bold, "1.2346")), "should include the example time" }
+      it{ should include(formatter.send(:cyan, "# location_to_example1")), "should include the example location" }
+    end
+  end
+  
+  describe "#sort_by_run_time" do
+    it "should sort the items in descending order of the second element in the array" do
+      examples = 5.times.map{ [nil, rand(100), nil] }
+      sorted_examples = formatter.send("sort_by_run_time", examples)
+
+      sorted_examples[0..-2].each_index do |index|
+        sorted_examples[index][1].should be > sorted_examples[index + 1][1]
+      end
+    end
+  end
+end

data/timed_specs.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/timed_specs/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["dipil-saud"]
+  gem.email         = ["dipil.saud@gmail.com"]
+  gem.description   = %q{
+    A Rspec formatter built upon the default DocumentationFormatter which shows the time taken for each example along with the other information shown by the DocumentationFormatter. You also have the option to list the slowest 'n' examples at the end.
+  }
+  gem.summary       = %q{A rspec formatter which displays the individual time taken by each example and lists the slowest examples. }
+  gem.homepage      = ""
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "timed_specs"
+  gem.require_paths = ["lib"]
+  gem.version       = VERSION
+  
+  gem.add_runtime_dependency "rspec"
+  gem.add_development_dependency "pry"  
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: timed_specs
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- dipil-saud
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2165151740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2165151740
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: &2165151040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2165151040
+description: ! "\n    A Rspec formatter built upon the default DocumentationFormatter
+  which shows the time taken for each example along with the other information shown
+  by the DocumentationFormatter. You also have the option to list the slowest 'n'
+  examples at the end.\n  "
+email:
+- dipil.saud@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Rakefile
+- lib/timed_specs.rb
+- lib/timed_specs/version.rb
+- spec/spec_helper.rb
+- spec/time_specs_spec.rb
+- timed_specs.gemspec
+homepage: ''
+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: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: A rspec formatter which displays the individual time taken by each example
+  and lists the slowest examples.
+test_files:
+- spec/spec_helper.rb
+- spec/time_specs_spec.rb
+has_rdoc: