what_to_run 0.0.0 → 0.0.1.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8627bc44ac70f2e2911589b7a59e1c7bfac33bac
-  data.tar.gz: 26b2e777319a8d6ebcac6e7552aa95a23b8ce94d
+  metadata.gz: 6fd560629ae7b8791f59fe5cfb47d9049febbe04
+  data.tar.gz: 58c24411992a29a737103d1072e62594e311b0eb
 SHA512:
-  metadata.gz: af570365e27f5a2c07e9debf012e7d2962e8c44849ae3fd10a8308de46b30aff32578d4c9fcef809aaf725d9da2aa36e195e0745aa172d3b875b336ebed3552e
-  data.tar.gz: f338f32e7886d66b61f2f816e4176287d2944ba4a7a107e57aad97705f9df3401307837790be6945c9979f82339f46fc4329902b9b4496c97bac3eb6770c8dcc
+  metadata.gz: 3861db56557e5f50e273a43caf790aa19163068b69a0e27f9cdc7ef8bf79189a3f9878017b3eda49c1aa9241778395e86e7e068fc622446f3c5c127de90b1159
+  data.tar.gz: 87d098e0915aad867239ebf93280d44d1487dab7b288294fbcc46fb05fb2908d48e6dba83c8481a1199b2c60628a4d51978e2a021bba98735d4f90b3d7b64c7d

data/README.md

@@ -1,67 +1,77 @@
-# Regression Test Selection
+# What To Run
 
-This is a demo repository for regression test selection.  You will need Ruby 2.3 to use this (which is currently trunk Ruby).
+What To Run is a lib for regression test selection, use it to predict which tests you should run when you make any modification on your codebase.
 
-## Make it go with Minitest
+This lib is based on [@tenderlove](https://github.com/tenderlove) idea and guidance, make sure to read his [blog post](http://tenderlovemaking.com/2015/02/13/predicting-test-failues.html) on the subject.
 
-To try it with Minitest, do:
+## Requirements
+
+- Project must be inside a Git repository
+
+## Installation
+
+Add this line to your application's Gemfile:
 
 ```
-$ COLLECTION=1 ruby -I lib spec/whatever_test.rb
+gem 'what_to_run'
 ```
 
-This will create the initial coverage information.  Then modify `lib/my_thing.rb` so that the diff looks like this:
+And then execute
 
-```patch
-diff --git a/lib/my_thing.rb b/lib/my_thing.rb
-index 806deff..eb057b9 100644
---- a/lib/my_thing.rb
-+++ b/lib/my_thing.rb
-@@ -4,7 +4,7 @@ class Whatever
-   end
- 
-   def bar
--    "bar #{@foo}"
-+    raise
-   end
- 
-   def baz
+```
+$ bundle
 ```
 
-Now to predict which tests will fail, do this:
+Or install it yourself as:
 
 ```
-$ ruby what_to_run.rb
+gem install what_to_run
 ```
 
-## Make it go with RSpec
+## Usage
+
+Require the lib with:
 
-To try it with RSpec, do:
+Minitest
 
 ```
-$ COLLECTION=1 rspec spec/whatever_spec.rb
+require 'what_to_run/minitest'
 ```
 
-This will create the initial coverage information.  Then modify `lib/my_thing.rb` so that the diff looks like this:
+RSpec
 
-```patch
-diff --git a/lib/my_thing.rb b/lib/my_thing.rb
-index 806deff..eb057b9 100644
---- a/lib/my_thing.rb
-+++ b/lib/my_thing.rb
-@@ -4,7 +4,7 @@ class Whatever
-   end
- 
-   def bar
--    "bar #{@foo}"
-+    raise
-   end
- 
-   def baz
+```
+require 'what_to_run/rspec'
+```
+
+Run your tests on a clean git branch
+
+Minitest
+
+```
+$ COLLECTION=1 bundle exec rake test
 ```
 
-Now to predict which tests will fail, do this:
+RSpec
 
 ```
-$ ruby what_to_run.rb
+$ COLLECTION=1 bundle exec rspec
 ```
+
+This will create the initial coverage information. Then make your desired modifications on your code.
+
+Now to predict which tests is likely fail, run this:
+
+```
+$ what_to_run
+```
+
+:warning: A `run_log.json` file will be created in the current directory, you might want to include it in your `.gitignore`.
+
+## Contributing
+
+Open an [issue](https://github.com/DyegoCosta/what_to_run/issues) or fork it and submit a [pull-request](https://help.github.com/articles/using-pull-requests/).
+
+## License
+
+What To Run is released under the [MIT License](http://www.opensource.org/licenses/MIT).

data/ext/coverage_peeker/extconf.rb

@@ -0,0 +1,3 @@
+require 'mkmf'
+
+create_makefile('coverage_peeker/coverage_peeker')

data/lib/coverage_peeker.rb

@@ -0,0 +1,5 @@
+require 'coverage_peeker/coverage_peeker'
+
+module CoveragePeeker
+  VERSION = '1.0.0'
+end

data/lib/what_to_run.rb

@@ -1,5 +1,4 @@
 require 'json'
-require 'shellwords'
 require 'rugged'
 require 'set'
 
@@ -8,22 +7,20 @@ module WhatToRun
 
   def predict
     lines_to_run.inject([]) do |tests, (file, line)|
-      cov_map[File.expand_path(file)][line].each do |desc|
-        tests += Array(desc)
-      end
-      tests
+      path = File.expand_path(file)
+      tests += Array cov_map[path][line]
     end
   end
 
   def lines_to_run
-    repo = Rugged::Repository.new '.'
+    repo = Rugged::Repository.new('.')
     lines_to_run = Set.new
 
-    repo.index.diff.each_patch { |patch|
+    repo.index.diff.each_patch do |patch|
       file = patch.delta.old_file[:path]
 
-      patch.each_hunk { |hunk|
-        hunk.each_line { |line|
+      patch.each_hunk do |hunk|
+        hunk.each_line do |line|
           case line.line_origin
           when :addition
             lines_to_run << [file, line.new_lineno]
@@ -32,31 +29,25 @@ module WhatToRun
           when :context
             # do nothing
           end
-        }
-      }
-    }
+        end
+      end
+    end
 
     lines_to_run
   end
 
-  def diff before, after
-    after.each_with_object({}) do |(file_name,line_cov), res|
-      before_line_cov = before[file_name]
+  def cov_delta(before, after)
+    after.each_with_object({}) do |(file_name, lines_cov), delta|
+      before_lines_cov = before[file_name]
 
       # skip arrays that are exactly the same
-      next if before_line_cov == line_cov
+      next if before_lines_cov == lines_cov
 
       # subtract the old coverage from the new coverage
-      cov = line_cov.zip(before_line_cov).map do |line_after, line_before|
-        if line_after
-          line_after - line_before
-        else
-          line_after
-        end
-      end
+      cov = lines_cov_delta(before_lines_cov, lines_cov)
 
       # add the "diffed" coverage to the hash
-      res[file_name] = cov
+      delta[file_name] = cov
     end
   end
 
@@ -64,29 +55,17 @@ module WhatToRun
     cov_map = Hash.new { |h, file| h[file] = Hash.new { |i, line| i[line] = [] } }
 
     File.open('run_log.json') do |f|
-      # Read in the coverage info
-      JSON.parse(f.read).each do |args|
-        if args.length == 4 # for Minitest
-          desc = args.first(2).join('#')
-        else                # for RSpec
-          desc = args.first
-        end
-
-        before, after = args.last(2)
+      JSON.parse(f.read).each do |cov_info|
+        before, after = cov_info.last(2)
+        desc = build_test_desc(cov_info)
 
-        # calculate the per test coverage
-        delta = diff before, after
+        delta = cov_delta(before, after)
 
         delta.each_pair do |file, lines|
           file_map = cov_map[file]
 
           lines.each_with_index do |val, i|
-            # skip lines that weren't executed
-            next unless val && val > 0
-
-            # add the test name to the map. Multiple tests can execute the same
-            # line, so we need to use an array.
-            file_map[i + 1] << desc
+            file_map[i + 1] << desc if line_executed?(val)
           end
         end
       end
@@ -94,4 +73,19 @@ module WhatToRun
 
     cov_map
   end
+
+  def build_test_desc(cov_info)
+    using_minitest = cov_info.length == 4
+    using_minitest ? cov_info.first(2).join('#') : cov_info.first
+  end
+
+  def line_executed?(line)
+    line.to_i > 0
+  end
+
+  def lines_cov_delta(before_lines_cov, after_lines_cov)
+    after_lines_cov.zip(before_lines_cov).map do |lines_after, lines_before|
+      lines_after ? lines_after - lines_before : lines_after
+    end
+  end
 end

data/lib/what_to_run/minitest.rb

@@ -1,5 +1,6 @@
-require 'coverage'
 require 'json'
+require 'coverage'
+require 'coverage_peeker'
 
 Coverage.start
 
@@ -16,9 +17,9 @@ class Minitest::Runnable
     alias :old_run_one_method :run_one_method
 
     def run_one_method klass, method_name, reporter
-      before = Coverage.peek_result
+      before = CoveragePeeker.peek_result
       old_run_one_method klass, method_name, reporter
-      after = Coverage.peek_result
+      after = CoveragePeeker.peek_result
       LOGS << [ klass.name, method_name.to_s, before, after ]
     end
   end

data/lib/what_to_run/rspec.rb

@@ -1,7 +1,9 @@
-require 'coverage'
 require 'json'
 require 'rspec'
 
+require 'coverage'
+require 'coverage_peeker'
+
 LOGS = []
 Coverage.start
 
@@ -10,8 +12,8 @@ RSpec.configuration.after(:suite) {
 }
 
 RSpec.configuration.around(:example) do |example|
-  before = Coverage.peek_result
+  before = CoveragePeeker.peek_result
   example.call
-  after = Coverage.peek_result
+  after = CoveragePeeker.peek_result
   LOGS << [ example.full_description, before, after ]
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: what_to_run
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1.pre
 platform: ruby
 authors:
 - Aaron Patterson
@@ -35,11 +35,15 @@ description: Predict which tests are likely to fail after you’ve changed the c
 email: dyego@dyegocosta.com
 executables:
 - what_to_run
-extensions: []
+extensions:
+- ext/coverage_peeker/extconf.rb
 extra_rdoc_files: []
 files:
 - README.md
 - bin/what_to_run
+- ext/coverage_peeker/extconf.rb
+- lib/coverage_peeker.rb
+- lib/coverage_peeker/coverage_peeker.bundle
 - lib/what_to_run.rb
 - lib/what_to_run/minitest.rb
 - lib/what_to_run/rspec.rb
@@ -53,17 +57,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Regression test selection