deep-cover 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e0bfde5bb75505e45c28d6e28a2cf89464a0c5ad
+  data.tar.gz: effb8e5d1322f994532f65406ad867e5f6b0c30c
+SHA512:
+  metadata.gz: 267136d48b010079e4ddd88c35044757aa6eeafb8619e087b52669754e105ef66b7ecc34c6e5f4b3b53f0d94dc66190ea7a6f0f7c20add4a437511560621fd44
+  data.tar.gz: 70bb129eecdc023b306308076b722ccb07d6200fa38e0d305a00eb844d7ebb7bcbc2e7fb7f4c165793350a1880a9d285a077d5a3a3f0220f94b203c88ccbe1f7

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--tag ~skip

data/.travis.yml

@@ -0,0 +1,10 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+  - 2.3.4
+  - 2.2.7
+  - 2.1.10
+  - 2.0.0
+  - jruby-9.1.9.0
+before_install: gem install bundler -v 1.15.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at github@marc-andre.ca. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in deep_cover.gemspec
+gemspec
+
+gem 'pry-byebug', platforms: :mri

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Marc-Andre Lafortune
+
+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,127 @@
+[![Build Status](https://travis-ci.org/deep-cover/deep-cover.svg?branch=master)](https://travis-ci.org/deep-cover/deep-cover)
+
+# DeepCover
+
+Deep Cover aims to be the best coverage tool for Ruby code:
+
+* more accurate line coverage
+* branch coverage
+* can be used as a drop-in replacement for the built-in Coverage library.
+
+It reports a more accurate picture of your code usage. In particular a line is considered covered if and only if it is entirely executed:
+
+```
+def foo(something: false)
+  bar if something  # => This is considered covered by builtin coverage,
+                    #    even though `bar` might not even exist
+end
+
+# somewhere in a test:
+foo
+```
+
+Optionally, branch coverage will detect if some branches are never taken. In the following example, `test_foo` only provides values for `x` that respond to `:to_s`, thus the implicit `else` is never tested (i.e. a value of `x` that does not respond to `:to_s`)
+
+```
+def foo(x)
+  x = x.to_s if x.respond_to? :to_s
+  # ...
+end
+
+def test_foo
+  assert_equal something, foo(42)
+  assert_equal something_else, foo(:hello)
+end
+```
+
+## Installation
+
+    gem install deep-cover
+
+DeepCover currently uses [`Istanbul`](https://istanbul.js.org/)'s reporter, so you'll need `node` and Istanbul's command line `nyc`:
+
+    yarn global add nyc   # or npm install nyc -g
+
+### Command line interface (for a Rails app or a Gem):
+
+An easy way to check coverage, without any configuration needed:
+
+    deep-cover /path/to/rails/app/or/gem
+
+This assumes your project has a `Gemfile`, and that your default `rake` task is set to execute all tests (otherwise set the `--command` option)
+
+### Builtin Coverage (including SimpleCov) users
+
+Add to your Gemfile `gem 'deep-cover'`, then run `bundle`.
+
+Before you require `coverage` or `simplecov`, do a `require 'deep-cover/builtin_takeover'`.
+
+For example, the `test/test_helper.rb` file for `simplecov` users will look like
+
+```
+require 'deep_cover/builtin_takeover'
+require 'simplecov'
+SimpleCov.start
+# rest of `test_helper.rb`
+```
+
+## Usage
+
+### Configuration
+
+`configure` is used to specify how specific `DeepCover` should be and which files it should analyse. The following code reflects the default settings:
+
+```
+DeepCover.configure do
+  ignore_uncovered :raise, :default_arguments
+  detect_uncovered :trivial_if
+  # TODO
+  cover_paths %w[app lib]
+end
+```
+
+### Low level usage
+
+```
+# Setup
+require 'deep-cover'
+DeepCover.configure { ignore_uncovered :trivial_if }
+# Cover
+DeepCover.cover do
+  require 'my_file_to_cover'
+  require 'my_other_file_to_cover'
+end
+require 'this_file_wont_be_covered'
+tests.run()
+puts DeepCover.line_coverage('foo')
+```
+
+## Development
+
+After checking out the repo, run `bundle` to install dependencies. Then, run `rake` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+For detailed analysis:
+
+`deep-cover -e "if(:try_me); puts 'cool'; end"`
+
+To run one of the specs in `spec`:
+
+`bin/cov boolean`
+
+### Status
+
+Currently in heavy development. *Alpha stage, API subject to change every day*. Best time to get involved though ;-)
+
+## Contributing
+
+Please ask questions on StackOverflow.com. Maintainers monitor the tag `deep-cover.rb`.
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/deep-cover/deep-cover. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the DeepCover project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/deep-cover/deep-cover/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "deep_cover"
+
+# 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(__FILE__)

data/bin/cov

@@ -0,0 +1,43 @@
+#!/usr/bin/env ruby
+module DeepCover
+  require "bundler/setup"
+
+  $LOAD_PATH.unshift('../covered_deep_cover') if ENV["CC"]
+  require "deep_cover"
+  require_relative "../spec/specs_tools"
+  require 'deep_cover/cli/debugger'
+
+  example = ARGV[0] || 'simple_if'
+  fn = "./spec/samples/#{example}.rb"
+  fn = "./spec/char_cover/#{example}.rb" unless File.exist?(fn)
+  if File.exist?(fn)
+    fn = File.absolute_path(fn)
+    source = File.read(fn)
+  else
+    fn = "<passed_from_command_line>"
+    source = ARGV[0].gsub(';;', "\n")
+  end
+
+  groups = Specs::AnnotatedExamplesParser.process(source)
+  if groups.size == 1 && groups.first.last.size == 1
+    lines, lineno = groups.values.first.values.first
+  else
+    menu = []
+    item = -1
+    examples = groups.flat_map do |title, examples|
+      menu << Term::ANSIColor.green(title) if title
+      menu.concat(examples.keys.map {|ex| "  #{item+=1}: #{ex || '(General)'}"})
+      examples.values
+    end
+    if ARGV[1]
+      answer = ARGV[1].to_i
+    else
+      require 'highline'
+      puts menu
+      answer = HighLine.new.ask(Term::ANSIColor.blue("Which?  "), Integer) { |q| q.in = 0...examples.size }
+    end
+    lines, lineno = examples[answer]
+  end
+
+  CLI::Debugger.new(lines.join, filename: fn, lineno: lineno, pry: true).show
+end

data/bin/gemcov

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+module DeepCover
+  require "bundler/setup"
+  require 'deep_cover'
+  require 'deep_cover/cli/instrumented_clone_reporter'
+
+  CLI::InstrumentedCloneReporter.new(ARGV[0] || "~/inky-rb").run
+end

data/bin/selfcov

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+require "bundler/setup"
+require "pry"
+
+covered_path = ARGV[0]
+if covered_path
+  $LOAD_PATH.unshift(covered_path)
+end
+require "deep_cover"
+
+if covered_path.nil?
+  covered_path = DeepCover::Tools.dump_covered_code('./lib', '../covered_deep_cover')
+  puts "Covered code generation done. Output in", covered_path
+  exec 'bin/selfcov', covered_path
+else
+  coverage = DeepCover::Coverage.load(covered_path)
+  require 'rspec'
+  error = RSpec::Core::Runner::run(Dir.glob('./spec/*_spec.rb'))
+  puts "Lines not covered:", coverage.report
+  binding.pry
+end

data/bin/setup

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

data/bin/testall

@@ -0,0 +1,88 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# Will run rake test on every ruby version you have installed that matches the .travis-ci.yml
+#
+# This is a script that does basically what wwtd is meant to do (run tests following
+# the config in travis-ci), but:
+#  * Only flow_entry_count the tests that are coded to be run from here
+#  * ignores rails_head and ruby-head
+#
+# Other differences from wwtd:
+#  * automatically installs the bundler gem if it is missing from a ruby version.
+#
+require 'term/ansicolor'
+require 'yaml'
+TRAVIS_CONFIG = '.travis.yml'
+
+def run_command(env_vars, command)
+  puts "RUNNING: #{command}  WITH: #{env_vars}"
+  system(env_vars, command)
+end
+
+travis_yml = (File.exist?(TRAVIS_CONFIG) ? YAML.load_file(TRAVIS_CONFIG) : {})
+ruby_versions = travis_yml['rvm']
+gemfiles = travis_yml['gemfile'] || [nil]
+matrix_options = travis_yml['matrix'] || {}
+matrix_include = matrix_options['include'] || []
+matrix_exclude = matrix_options['exclude'] || []
+
+configs = ruby_versions.product(gemfiles)
+matrix_include.each do |conf|
+  configs << [conf[:rvm], conf[:gemfile] || nil]
+end
+matrix_exclude.each do |conf|
+  configs.delete [conf[:rvm], conf[:gemfile] || nil]
+end
+
+rubies = {}
+results = []
+
+if (`which rvm`; $?.success?)
+  ruby_exec = "rvm-exec %{ruby_version} "
+elsif (`which chruby-exec`; $?.success?)
+  ruby_exec = "chruby-exec %{version} -- "
+end
+
+configs.each do |ruby_version, gemfile|
+  next if ruby_version == "ruby-head"
+
+  current_ruby_exec = ruby_exec % {ruby_version: ruby_version}
+
+  env_vars = { "BUNDLE_GEMFILE" => gemfile, "WITHOUT_PENDING" => ENV["WITHOUT_PENDING"] || "1"}
+  gemfile_text = gemfile || "Default gemfile"
+  success = true
+
+  if !rubies.include?(ruby_version)
+    if (`#{current_ruby_exec} ruby -v`; $?.success?)
+      if !system("#{current_ruby_exec} gem list -i '^bundler$' 1>/dev/null")
+        success &&= run_command(env_vars, "#{current_ruby_exec} gem install bundler")
+      end
+      rubies[ruby_version] = true
+    else
+      rubies[ruby_version] = false
+    end
+  end
+
+  if rubies[ruby_version] == false
+    results << Term::ANSIColor.yellow("MISING RUBY: #{ruby_version} for #{gemfile_text}")
+    next
+  end
+
+  if success
+    bundle_installed = run_command(env_vars, "#{current_ruby_exec} bundle check 1>/dev/null 2>&1")
+    bundle_installed ||= run_command(env_vars, "#{current_ruby_exec} bundle install --quiet 1>/dev/null 2>&1")
+    bundle_installed ||= run_command(env_vars, "#{current_ruby_exec} bundle update --quiet")
+    success &&= bundle_installed
+  end
+  success &&= run_command(env_vars, "#{current_ruby_exec} bundle exec rspec --format=progress") if success
+
+  if success
+    results << Term::ANSIColor.green("SUCCESS: #{ruby_version} for #{gemfile_text}")
+  else
+    results << Term::ANSIColor.red("FAILURE: #{ruby_version} for #{gemfile_text}")
+  end
+end
+
+puts results