rspec-blame 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 03e959676379519da460e2bcfc1b35aaa4cd8911
-  data.tar.gz: 343f39882eb2cea82d0c8d555c73f94e2bffc453
+  metadata.gz: 1f2581ea0444b1dbf50a23c0afe9e37342b4b4ea
+  data.tar.gz: a17c38ba2013978c08549b6733cf6400b3c9664f
 SHA512:
-  metadata.gz: b33ecf5a099181d20e4ca1389b8ba3a4a18c59aac0f359fadc3306bf9fa38802809e384ff2760eafe79aec29d20ea8c01428e52267c0757a7217723acdf25639
-  data.tar.gz: 8c77b7c6da2a29a488571d6f895418ce0f7f95f83bb3c3ea9fe89e9b3d652c0803f955ecfc0f1f4bfc59020fa18f18af6fe347c058c9745786bcb1e6b30596b3
+  metadata.gz: fab4bc385d851a834e6354b8f8525871c3424538aa9dad1c48c351f4320dd4060d8a0d86de8c95015838aea024818cf63094a308aa534fb5b960d391a9e433f7
+  data.tar.gz: 4abad81e752070ddf79b9361a884bd88ea1a86ac43b7b1c6606c36f1970c69641bff35fa3f07ca85fb1de87743cf7cca5b83b0d7c761a7ac3682363a07338b14

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+gem "rspec-core", ["~> 2.14"]
+
+group :develpoment do
+  gem "rake"
+  gem "mocha"
+  gem "rspec"
+end

data/README.md

@@ -0,0 +1,67 @@
+# rspec-blame
+
+rspec-blame provides a Blame RSpec foramtter that outputs the author, commit hash, and
+commit date for the slowest examples when profiling with RSpec in a **git** project.
+
+## Usage
+
+    gem 'rspec-blame'
+
+After including the above line in your Gemfile and running `bundle install`, there are
+several ways to use the formatter:
+
+### Command Line
+
+`rspec --require rspec/blame --profile --format Blame file_spec.rb` or `rspec -r rspec/blame -p -f Blame file_spec.rb`
+
+### Rake Task
+
+```ruby
+require "rspec/blame"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec) { |t| t.rspec_opts = "-p -f Blame" }
+```
+
+### Configure RSpec
+
+Add `--require "rspec/blame"`, `--profile`, and `--format Blame` to your `.rspec` file.
+
+Alternatively, add `require "spec_helper"` to any spec files and add the following to
+your spec_helper.rb:
+
+```ruby
+Rspec.configure do |config|
+  config.profile_examples = true
+  config.format = Blame
+end
+```
+
+## Output
+
+```
+......
+
+Slowest 6 examples finished in 0.0074 secs (100.0% of total time: 0.0074 secs).
+Blame dump_profile_slowest_examples prints the number of examples to profile
+0.0016 secs ./spec/lib/rspec/blame_spec.rb:21                                               Author: dseeto (i0r2i2s5), Date: 2014-05-28
+Blame dump_profile_slowest_examples prints summary including author, commit, and date
+0.0012 secs ./spec/lib/rspec/blame_spec.rb:42                                               Author: dseeto (i0r2i2s5), Date: 2014-05-28
+Blame dump_profile_slowest_examples prints the time taken for the slowest tests
+0.0012 secs ./spec/lib/rspec/blame_spec.rb:25                                               Author: dseeto (i0r2i2s5), Date: 2014-05-28
+Blame dump_profile_slowest_examples prints the path to test example
+0.0012 secs ./spec/lib/rspec/blame_spec.rb:37                                               Author: dseeto (i0r2i2s5), Date: 2014-05-28
+Blame dump_profile_slowest_examples prints the percentage taken from the total time
+0.0011 secs ./spec/lib/rspec/blame_spec.rb:33                                               Author: dseeto (i0r2i2s5), Date: 2014-05-28
+Blame dump_profile_slowest_examples prints the name of the examples
+0.0011 secs ./spec/lib/rspec/blame_spec.rb:29                                               Author: dseeto (i0r2i2s5), Date: 2014-05-28
+
+Finished in 0.00792 seconds
+6 examples, 0 failures
+```
+
+## Author
+
+[David Seeto](https://github.com/dseeto)
+
+seeto.david@gmail.com

data/Rakefile

@@ -0,0 +1,5 @@
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:test)
+
+task :default => [:test]

data/lib/rspec/blame.rb

@@ -1,11 +1,8 @@
-require 'rspec/core/formatters/progress_formatter'
+require "rspec/core/formatters/progress_formatter"
 
-# Formatter that ouputs the git blame details for the slowest examples.
-# Requirements: Project must be version controlled with git.
-# Usage: `rspec --profile --formatter Blame rspec_file.rb` or `rspec -p -f Blame rspec_file.rb`
-# Alternative Usage: RSpec::Core::RakeTask.new(:task) { |t| t.rspec_opts = "-p -f Blame" }
+# Formatter that ouputs git blame details for the slowest examples.
 class Blame < RSpec::Core::Formatters::ProgressFormatter
-  # Overrides ProgressFormatter's output.
+  # Appends to ProgressFormatter's output by executing git blame in a subprocess and parsing its output.
   def dump_profile_slowest_examples
     number_of_examples_to_profile = RSpec.configuration.profile_examples
 

data/rspec-blame.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new do |s|
+  s.name        = "rspec-blame"
+  s.version     = "0.1.2"
+  s.date        = "2014-05-23"
+  s.license     = "MIT"
+
+  s.authors     = ["David Seeto"]
+  s.email       = "seeto.david@gmail.com"
+  s.homepage    = "https://github.com/dseeto/rspec-blame"
+
+  s.summary     = "Git blame when profiling your slowest RSpec examples."
+  s.description = %q{rspec-blame provides a Blame formatter that outputs git blame details for the slowest examples when profiling with RSpec.}
+  s.files       = `git ls-files`.split("\n")
+
+  s.add_runtime_dependency     "rspec-core", ["~> 2.14"]
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "mocha"
+end

data/spec/lib/rspec/blame_spec.rb

@@ -0,0 +1,46 @@
+require "spec_helper"
+require "rspec"
+require "rspec/blame"
+
+describe Blame do
+  let(:output)    { StringIO.new }
+
+  describe "dump_profile_slowest_examples" do
+    before do
+      RSpec.configuration.stubs(:profile_examples).returns(1)
+      group = RSpec::Core::ExampleGroup.describe("group") { example("example") { sleep 0.001 } }
+      group.examples.each { |example| example.execution_result[:run_time] = 0.42 }
+
+      formatter = Blame.new(output)
+      formatter.stubs(:examples).returns(group.examples)
+      formatter.expects(:`).returns("i0r2i2s5        ( dseeto     2014-05-23      10)")
+
+      formatter.dump_profile_slowest_examples
+    end
+
+    it "prints the number of examples to profile" do
+      expect(output.string).to match(/Slowest 1 examples/)
+    end
+
+    it "prints the time taken for the slowest tests" do
+      expect(output.string).to match(/finished in 0\.42 secs/)
+    end
+
+    it "prints the name of the examples" do
+      expect(output.string).to match(/group example/m)
+    end
+
+    it "prints the percentage taken from the total time" do
+      expect(output.string).to match(/100.0% of total time/)
+    end
+
+    it "prints the path to test example" do
+      filename = __FILE__.split(File::SEPARATOR).last
+      expect(output.string).to match(/#{filename}\:11/)
+    end
+
+    it "prints summary including author, commit, and date" do
+      expect(output.string).to match(/Author:.*\(.*\), Date:/)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+ENV["RAILS_ENV"] ||= "test"
+
+RSpec.configure do |config|
+  config.mock_with :mocha
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-blame
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - David Seeto
@@ -28,52 +28,59 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: rspec-blame provides a Blame formatter that outputs the author, commit,
-  and date of your slowest examples when profiling with RSpec.
+description: rspec-blame provides a Blame formatter that outputs git blame details
+  for the slowest examples when profiling with RSpec.
 email: seeto.david@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
 - lib/rspec/blame.rb
+- rspec-blame.gemspec
+- spec/lib/rspec/blame_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/dseeto/rspec-blame
 licenses:
 - MIT
@@ -84,12 +91,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []