miss_cleo 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 04e41f5049ab3702747dd2585b5995d9f76d33a5
+  data.tar.gz: a58b4dd402cafc3b5a1d01367515456e1d8aee6c
+SHA512:
+  metadata.gz: f05fd1c915fcb06a02c4067fc14674d9f89068f4f32c8a3bb860544e0dbe10af15b585c88c54d391375997ec5a6a2bd8ea1caa6d1f404aa05e3603813b32f3a1
+  data.tar.gz: 3be489fbcf2fdff2a47cf54eddb79a055b133481e26743c4a16c703233ea3bbee4e088721b575f82761989333384dda8183361de5a0c86e30518fad4303c8b2f

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 david rosenbloom
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,65 @@
+# MissCleo
+![Miss Cleo](http://i.imgur.com/v4vmFtq.jpg)
+
+Miss Cleo is a test failure predictor based on [Tenderlove's idea](http://tenderlovemaking.com/2015/02/13/predicting-test-failues.html). The idea is to give you a reasonable amount of confidence that your code changes are ok without having to run your full CI build.
+
+## Requirements
+
+Miss Cleo depends on Ruby 2.3.x (currently trunk Ruby) for its `Coverage.peek_result` functionality.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'miss_cleo'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install miss_cleo
+
+## Setup 
+
+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:
+
+```ruby
+MissCleo::TestConfigurations::CucumberConfig.setup_hooks(self)
+```
+
+### Rspec
+Before you can use Miss Cleo with your RSpec tests, add the following line to your `spec/spec_helper.rb` file:
+
+```ruby
+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.
+
+Examples:
+
+* `COVERAGE=true cucumber features/user.feature`
+* `COVERAGE=true rspec spec/user_spec.rb`
+
+## Usage
+
+After you've made some code changes, run `miss_cleo` 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!
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/miss_cleo/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "miss_cleo"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/miss_cleo

@@ -0,0 +1,101 @@
+#!/usr/bin/env ruby
+
+require "miss_cleo"
+require 'pry'
+
+repo = Rugged::Repository.new '.'
+lines_to_run = Set.new
+
+def exclude_from_map?(file_name)
+  # Let's add a configuration for ignored files
+  file_name == "db/structure.sql"
+end
+
+repo.index.diff.each_patch do |patch|
+  file = patch.delta.old_file[:path]
+
+  patch.each_hunk do |hunk|
+    hunk.each_line do |line|
+      case line.line_origin
+      when :addition
+        lines_to_run << [file, line.new_lineno] unless exclude_from_map?(file)
+      when :deletion
+        lines_to_run << [file, line.old_lineno] unless exclude_from_map?(file)
+      when :context
+        # do nothing
+      end
+    end
+  end
+end
+
+def diff before, after
+  after.each_with_object({}) do |(file_name,line_cov), res|
+    before_line_cov = before[file_name] || []
+
+    # skip arrays that are exactly the same
+    next if before_line_cov == line_cov
+
+    # subtract the old coverage from the new coverage
+    cov = line_cov.zip(before_line_cov).map do |line_after, line_before|
+      if line_before
+        line_after - line_before
+      else
+        line_after
+      end
+    end
+
+    # add the "diffed" coverage to the hash
+    res[file_name] = cov
+  end
+end
+
+def get_cov_map_for(file_name)
+  cov_map = Hash.new { |h, file| h[file] = Hash.new { |i, line| i[line] = [] } }
+
+  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
+      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)
+
+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
+  end
+  cuke_map && cuke_map[File.expand_path(file)].fetch(line, []).uniq.each do |desc|
+    puts desc
+  end
+end

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/miss_cleo.rb

@@ -0,0 +1,14 @@
+# Pull these into bundler
+require 'json'
+require 'coverage'
+require 'shellwords'
+require 'rugged'
+require 'set'
+
+require "miss_cleo/version"
+require 'miss_cleo/coverage_filter'
+require 'miss_cleo/test_configurations/cucumber_config'
+require 'miss_cleo/test_configurations/rspec_config'
+
+module MissCleo
+end

data/lib/miss_cleo/coverage_filter.rb

@@ -0,0 +1,15 @@
+module MissCleo
+  class CoverageFilter
+    GEM_PATHS = ENV["GEM_PATH"].split(":")
+    RUBY_PATH = `which ruby`.chomp.gsub("/bin/ruby","")
+
+    def self.filter_core(result_hash)
+
+      # Don't include gems in coverage map
+      result_hash.reject do |file, line|
+        ([RUBY_PATH] + GEM_PATHS).any? { |path| file.include?(path) }
+      end
+    end
+  end
+
+end

data/lib/miss_cleo/test_configurations/cucumber_config.rb

@@ -0,0 +1,26 @@
+module MissCleo
+  module TestConfigurations
+    class CucumberConfig
+      CUCUMBER_MAP = "cucumber_map.json"
+      LOGS = []
+
+      def self.setup_hooks(context)
+        if ENV["COVERAGE"]
+          Coverage.start
+          context.Around do |scenario, execute|
+            before = Coverage.peek_result
+            execute.call
+            after = Coverage.peek_result
+            if file_and_line = scenario.try(:file_colon_line)
+              LOGS << [ file_and_line, before, after ]
+            end
+          end
+
+          at_exit do
+            File.open(CUCUMBER_MAP, 'w') { |f| f.write JSON.dump LOGS }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/miss_cleo/test_configurations/rspec_config.rb

@@ -0,0 +1,26 @@
+module MissCleo
+  module TestConfigurations
+    class RspecConfig
+      RSPEC_MAP = "rspec_map.json"
+      LOGS = []
+
+      def self.setup_hooks(context)
+        if ENV["COVERAGE"]
+          Coverage.start
+          RSpec.configuration.after(:suite) do
+            File.open(RSPEC_MAP, 'w') { |f| f.write JSON.dump LOGS }
+          end
+
+          RSpec.configuration.around(:example) do |example|
+            before = Coverage.peek_result
+            example.call
+            after = Coverage.peek_result
+            LOGS << [ example.location, CoverageFilter.filter_core(before),
+                      CoverageFilter.filter_core(after) ]
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/miss_cleo/version.rb

@@ -0,0 +1,3 @@
+module MissCleo
+  VERSION = "0.1.1"
+end

data/miss_cleo.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'miss_cleo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "miss_cleo"
+  spec.version       = MissCleo::VERSION
+  spec.authors       = ["Dean Hu", "Lee Ourand"]
+  spec.email         = ["devs@gust.com"]
+  spec.required_ruby_version = ">= 2.3.0"
+
+  spec.summary       = %q{Predict your test failures}
+  spec.description   = %q{Miss Cleo frees you from having to run your full test suite to be confident in your recent code changes. Call me now!}
+  spec.homepage      = "http://github.com/gust/miss_cleo"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = ["miss_cleo"]
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: miss_cleo
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Dean Hu
+- Lee Ourand
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Miss Cleo frees you from having to run your full test suite to be confident
+  in your recent code changes. Call me now!
+email:
+- devs@gust.com
+executables:
+- miss_cleo
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/miss_cleo
+- bin/setup
+- lib/miss_cleo.rb
+- lib/miss_cleo/coverage_filter.rb
+- lib/miss_cleo/test_configurations/cucumber_config.rb
+- lib/miss_cleo/test_configurations/rspec_config.rb
+- lib/miss_cleo/version.rb
+- miss_cleo.gemspec
+homepage: http://github.com/gust/miss_cleo
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Predict your test failures
+test_files: []