miss_cleo 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1d889d4159d13979e2976e1eebe9a73128071d3f
-  data.tar.gz: 13628125e02da62520de6811604ea8b494787678
+  metadata.gz: d7443ba51e59b7d1941d4ee652e26543136da4d1
+  data.tar.gz: 5f8c6e24bafa1eafff383a4435fcd25bf45428d6
 SHA512:
-  metadata.gz: 97c85e168bdf2907c93ca4efd7232d33697a598e9654003fbdcb98cb57024f23b2ef69732c1eaa144acb7e6f850b2c395c4711f80963c6b258d157f5c4838136
-  data.tar.gz: 7797c5a2b7de1db2b1874f8b476baeb51641c3493045ea9e9f9d8ece57375b1ade890aa28e26e37c5461cd6bfed7a066ada5904617efc8b22f9e5518e6ad247f
+  metadata.gz: 05a3e70338e08f3c3ac99397f15def5b6212e76b0d7dd458fd4fc0715d24288db41a078337336aaad4d6c30cedf97ebcca26cf8d424059c08cbabf1e617a3fcc
+  data.tar.gz: f29c165a827f380f548b10fa62fdc24f08c8ef0220a8a5b2cd1f3c8dfa01b33260a0e62d21239187a10015b29e5ce8c7ae96702f5f1473ece4237d9b478400d1

data/README.md

@@ -25,7 +25,7 @@ Or install it yourself as:
 
 ## Setup 
 
-Right now Miss Cleo only supports Cucumber and RSpec tests. To use Miss Cleo.
+Right now Miss Cleo only supports Cucumber and RSpec tests. To use Miss Cleo:
 
 ### Cucumber
 Before you can use Miss Cleo with your Cucumber tests, add the following line to your `support/env.rb` file:
@@ -43,19 +43,32 @@ MissCleo::TestConfigurations::RspecConfig.setup_hooks(self)
 
 ### How to get predictin'
 
-To use Miss Cleo, you'll need to first build a coverage map of your *green* build. Do this by running your tests with the `COVERAGE` environment variable set to true.
+To use Miss Cleo, you'll need to first build a coverage diff of your *green* build. Do this by running your tests with the `COVERAGE` environment variable set to true.
 
 Examples:
 
 * `COVERAGE=true cucumber features/user.feature`
 * `COVERAGE=true rspec spec/user_spec.rb`
 
+With your coverage diffs built, you'll need to generate a coverage map, which we're calling a *deck*. To build your deck, run:
+`miss_cleo build_deck <list of coverage diff files>`
+
 ## Usage
 
-After you've made some code changes, run `miss_cleo` to be shown the relevant tests to run.
+After you've made some code changes, run `miss_cleo predict` to be shown the relevant tests to run.
 
 **Note**: Miss Cleo only tries to predict tests failures for uncommitted changes. Make sure your build is green before committing code!
 
+
+## Known Oversights
+
+Like the real Miss Cleo, we can't predict everything. Things we can't predict include:
+- Rails views
+- ActiveRecord methods
+- ActiveRecord concerns
+- Anything that generally runs only through gem code
+- Any external library code
+
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/miss_cleo/fork )

data/bin/miss_cleo

@@ -49,53 +49,62 @@ def diff before, after
   end
 end
 
-def get_cov_map_for(file_name)
+def build_coverage_map(cov_diffs)
   cov_map = Hash.new { |h, file| h[file] = Hash.new { |i, line| i[line] = [] } }
+  cov_diffs.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)
+
+    # calculate the per test coverage
+    delta = diff 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
 
-  if File.exists?(file_name)
-    File.open(file_name, "r") do |f|
-      content = f.read
-      return if content.empty?
-      # Read in the coverage info
-      JSON.parse(content).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)
-
-        # calculate the per test coverage
-        delta = diff 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
-          end
-        end
+        # 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
       end
     end
   end
   cov_map
 end
 
-cuke_map = get_cov_map_for(MissCleo::TestConfigurations::CucumberConfig::CUCUMBER_MAP)
-spec_map = get_cov_map_for(MissCleo::TestConfigurations::RspecConfig::RSPEC_MAP)
+case ARGV.first
+when "build_deck"
+  filenames = ARGV[1..-1]
+  coverage_diffs = []
+  filenames.each do |filename|
+    File.open(filename, "r") do |f|
+      f.read
+    end.tap do |contents|
+      coverage_diffs += JSON.parse(contents)
+    end
+  end
+
+  coverage_map = build_coverage_map(coverage_diffs)
 
-puts "You need to run"
-lines_to_run.each do |file, line|
-  spec_map && spec_map[File.expand_path(file)].fetch(line, []).uniq.each do |desc|
-    puts desc
+  File.open("total_coverage_map.json", "w") do |f|
+    f.write(JSON.dump(coverage_map))
   end
-  cuke_map && cuke_map[File.expand_path(file)].fetch(line, []).uniq.each do |desc|
-    puts desc
+when "predict"
+  coverage_map = JSON.parse(File.open("total_coverage_map.json").read)
+  puts "You need to run"
+  tests_to_run = []
+  lines_to_run.each do |file, line|
+    coverage_map && coverage_map[File.expand_path(file)] && coverage_map[File.expand_path(file)].fetch(line.to_s, []).uniq.each do |desc|
+      tests_to_run << desc
+    end
   end
+  puts tests_to_run.uniq.sort
 end
+

data/lib/miss_cleo/version.rb

@@ -1,3 +1,3 @@
 module MissCleo
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: miss_cleo
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Dean Hu
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-09 00:00:00.000000000 Z
+date: 2015-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -90,3 +90,4 @@ signing_key:
 specification_version: 4
 summary: Predict your test failures
 test_files: []
+has_rdoc: