deep-cover 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3a8450fe7655e95139f1443a7e81f3c73b726e03
-  data.tar.gz: b04f9ef3b69060ff9568cae7224bc89a845137bf
+  metadata.gz: 23dab9f10f66926115fc7a84107eaaa364ea232f
+  data.tar.gz: a5e5a3e0d3b39829928acd724702f306282d03b4
 SHA512:
-  metadata.gz: 822e717af608dd6b6ed0010ce00f75aff18f4f60cfddc866df90ceefaf6131820a19f8a7a0e2d5eb00d961412dbcac23295e4b3aebb8be9cd1ae7ca7ecf13ab5
-  data.tar.gz: a5849e499b6f4eb7975af2e4529f5564e99a982d0cda525e0d246e6bce698f289e24cadf9a44ba3a85c4e78ae60da41813ef443f3f7114a261a6a856cd6a024e
+  metadata.gz: 746c9f0d6ee8bd832e2629d37996050f309bcc7724be618f72da0c3851705b714f6c56b458bc4727bdb5b7fe62f64eda6b99f61e6ca21e306b3ed8f339a526c5
+  data.tar.gz: 3aa28c66195e1cd61bfeafe38df9caa82e4e5ffd55bf6fdb3b3c4fcee8aa8ac0efb6a369b74c6656954e761e7e5f659aea36d9d25d582049e0d04b92c20a0f4d

data/.gitignore

@@ -1,5 +1,5 @@
-/.bundle/
-/.yardoc
+.bundle/
+.yardoc
 /Gemfile.lock
 /_yardoc/
 /coverage/
@@ -7,9 +7,10 @@
 /pkg/
 /spec/reports/
 /tmp/
-/.idea
-/.sass-cache
+.idea
+.sass-cache
 
 # rspec failure tracking
 .rspec_status
 /Gemfile.local
+/spec/cli_fixtures/covered_trivial_gem/deep_cover/

data/.rubocop.yml

@@ -7,6 +7,7 @@ AllCops:
     - 'spec/full_usage/**/*'
     - 'spec/specs_tools.rb'
     - 'bin/**/*'
+    - '_*/**/*'
   TargetRubyVersion: 2.1
 
 
@@ -192,6 +193,9 @@ Style/MultilineIfModifier:
 Style/NilComparison:
   Enabled: false
 
+Style/NonNilCheck:
+  Enabled: false
+
 Lint/EmptyWhen:
   Enabled: false
 
@@ -221,17 +225,14 @@ Style/StructInheritance:
 Security/YAMLLoad:
   Enabled: false
 
-Style/ExtendSelf:
-  Enabled: false
-
 Style/CommentedKeyword:
   Enabled: false # See https://github.com/bbatsov/rubocop/issues/5259
 
-Gemspec/RequiredRubyVersion:
-  Enabled: false # See https://github.com/bbatsov/rubocop/issues/5260
-
 Style/MixinUsage:
   Enabled: false # See https://github.com/bbatsov/rubocop/issues/5261
 
 Style/EvalWithLocation:
   Enabled: false
+
+Lint/BooleanSymbol:
+  Enabled: false

data/.travis.yml

@@ -1,14 +1,15 @@
 sudo: false
 language: ruby
 rvm:
+  - ruby-head
+  - 2.5.0
   - 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
+  - gem update --system
   - npm install -g nyc
 before_script:
   - bundle exec rake dev:install
@@ -17,3 +18,4 @@ script:
 matrix:
   allow_failures:
   - rvm: jruby-9.1.9.0
+  - rvm: ruby-head

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## 0.4
+
+* Added `deep-cover exec`
+* Support for # nocov
+
+## 0.3
+
+* Text reporter
+* Lazy loading
+
 ## 0.2
 
 * HTML reporter

data/README.md

@@ -45,9 +45,63 @@ These examples are direct outputs from our HTML reporter:
 
     gem install deep-cover
 
+First we present the official way. There are also quick and dirty ways to try `deep-cover` without changing much your current setup, which we present afterwards.
+
+### Canonical installation
+
+*1* Add the `deep-cover` gem as a dependency:
+
+For a standalone project (Rails app), add `deep-cover` to your Gemfile:
+
+    gem 'deep-cover', '~> 0.4', group: :test
+
+Then run `bundle`
+
+For a gem, you want to add `spec.add_development_dependency 'deep-cover', '~> 0.4'` to your `gemspec` file instead.
+
+*2* Require `deep-cover`
+
+You must call `require 'deep-cover'` *before* the code you want to cover is loaded.
+
+Typically, you want to insert that line in your `test/test_helper.rb` or `spec/spec_helper.rb` file at the right place. For example
+
+```
+ENV['RAILS_ENV'] ||= 'test'
+require 'deep-cover' # Must be before the environment is loaded on the next line
+require File.expand_path('../../config/environment', __FILE__)
+require 'rails/test_help'
+# ...
+```
+
+*3* Create a config file (optional)
+
+You may want to create a config file `.deep-cover.rb` at the root of your project, where you can set the config as you wish.
+
+```
+# File .deep-cover.rb
+DeepCover.config do
+  ignore :default_arguments
+  # ...
+end
+```
+
+*4* Launch it
+
+Even after `DeepCover` is `require`d and configured, only a very minimal amount of code is actually loaded and coverage is *not started*.
+
+The easiest way to actually start it is to use `deep-cover exec` instead of `bundle exec`.
+
+For example:
+
+```
+$ deep-cover exec rspec
+# ...all the output of rspec
+# ...coverage report
+```
+
 ### Command line interface (for a Rails app or a Gem):
 
-An easy way to check coverage, without any configuration needed:
+An easy way to try `deep-cover`, without any configuration needed:
 
     deep-cover /path/to/rails/app/or/gem
 
@@ -55,7 +109,9 @@ This assumes your project has a `Gemfile`, and that your default `rake` task is
 
 It also uses our builtin HTML reporter. Check the produced `coverage/index.html`.
 
-### Builtin Coverage (including SimpleCov) users
+### Projects using builtin Coverage (including SimpleCov) users
+
+To make it easier to transition for projects already using the builtin `Coverage` library (or indirectly those using `SimpleCov`), there is a way to overwrite the `Coverage` library using `deep-cover`'s extended coverage.
 
 Add to your Gemfile `gem 'deep-cover'`, then run `bundle`.
 
@@ -85,21 +141,9 @@ DeepCover.configure do
 end
 ```
 
-### Low level usage
+The file `.deep-cover.rb` is loaded automatically when requiring `deep-cover` and is the best place to put the configuration.
 
-```
-# 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')
-```
+*Note*: The configuration block is only executed when `deep-cover` is actually started.
 
 ## Development
 
@@ -117,7 +161,7 @@ More details in the [contributing guide](https://github.com/deep-cover/deep-cove
 
 ### Status
 
-Currently in heavy development. *Alpha stage, API subject to change every day*. Best time to get involved though ;-)
+Currently in development. *Alpha stage, API still subject to change*. Best time to get involved though ;-)
 
 ## Contributing
 

data/bin/testall

@@ -12,6 +12,7 @@
 # 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'
 

data/deep_cover.gemspec

@@ -23,13 +23,13 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   ### Runtime dependencies
-  spec.required_ruby_version = '>= 2.0.0'
+  spec.required_ruby_version = '>= 2.1.0'
 
   # Main dependency
   spec.add_runtime_dependency 'parser'
 
   # Support
-  spec.add_runtime_dependency 'backports', '>= 3.10.1'
+  spec.add_runtime_dependency 'backports', '>= 3.11.0'
   spec.add_runtime_dependency 'binding_of_caller'
 
   # CLI
@@ -50,5 +50,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'psych', '>= 2.0'
   spec.add_development_dependency 'rake', '~> 12.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop', '0.52.1' # About every single release breaks something
 end

data/lib/deep_cover.rb

@@ -6,6 +6,17 @@ module DeepCover
   load_absolute_basics
 
   extend Base
-  extend Config::Setter
+  extend ConfigSetter
 end
 DeepCover::GLOBAL_BINDING = binding
+
+require './.deep_cover.rb' if File.exist?('./.deep_cover.rb')
+
+if ENV['DEEP_COVER_OPTIONS']
+  DeepCover.config.set(YAML.load(ENV['DEEP_COVER_OPTIONS']))
+end
+if %w[1 t true].include?(ENV['DEEP_COVER'])
+  DeepCover.start
+  require_relative 'deep_cover/auto_run'
+  DeepCover::AutoRun.run!('.').and_report!(**DeepCover.config)
+end

data/lib/deep_cover/analyser/node.rb

@@ -11,7 +11,8 @@ module DeepCover
     def initialize(source, ignore_uncovered: [], **options)
       @cache = {}.compare_by_identity
       super
-      @allow_filters = Array(ignore_uncovered).map { |kind| method(:"is_#{kind}?") }
+      @allow_filters = Array(ignore_uncovered).map { |kind| :"is_#{kind}?" }
+      @nocov_ranges = FlagCommentAssociator.new(covered_code)
     end
 
     def node_runs(node)
@@ -22,35 +23,10 @@ module DeepCover
       end
     end
 
-    def is_raise?(node)
-      node.is_a?(Node::Send) && (node.message == :raise || node.message == :exit)
-    end
-
-    def is_default_argument?(node)
-      node.parent.is_a?(Node::Optarg)
-    end
-
-    def is_case_implicit_else?(node)
-      parent = node.parent
-      node.is_a?(Node::EmptyBody) && parent.is_a?(Node::Case) && !parent.has_else?
-    end
-
     def in_subset?(node, _parent)
       node.executable?
     end
 
-    def is_trivial_if?(node)
-      # Supports only node being a branch or the fork itself
-      node.parent.is_a?(Node::If) && node.parent.condition.is_a?(Node::SingletonLiteral)
-    end
-
-    def self.optionally_covered
-      @optionally_covered ||= instance_methods(false).map do |method|
-        method =~ /^is_(.*)\?$/
-        Regexp.last_match(1)
-      end.compact.map(&:to_sym).freeze
-    end
-
     protected
 
     def convert(node, **)
@@ -60,7 +36,9 @@ module DeepCover
     private
 
     def should_be_ignored?(node)
-      @allow_filters.any? { |f| f[node] } || is_ignored?(node.parent)
+      @nocov_ranges.include?(node) ||
+        @allow_filters.any? { |f| node.public_send(f) } ||
+        is_ignored?(node.parent)
     end
 
     def is_ignored?(node)

data/lib/deep_cover/auto_run.rb

@@ -11,25 +11,36 @@ module DeepCover
       end
 
       def run!
-        detect
-        load
+        @coverage = load_coverage
         after_tests { save }
+        self
       end
 
-      private
-
-      def detect
-        Coverage.saved? @covered_path
+      def report!(**options)
+        after_tests { puts report(**options) }
+        self
       end
 
-      def load
-        @coverage = Coverage.load(@covered_path, with_trackers: false)
+      private
+
+      def load_coverage
+        @not_saved = DeepCover.respond_to?(:running?) && DeepCover.running?
+        if @not_saved
+          DeepCover.coverage
+        else
+          Coverage.load(@covered_path, with_trackers: false)
+        end
       end
 
       def save
+        @coverage.save(@covered_path) if @not_saved
         @coverage.save_trackers(@covered_path)
       end
 
+      def report(**options)
+        @coverage.report(**options)
+      end
+
       def after_tests
         use_at_exit = true
         if defined?(Minitest)
@@ -49,9 +60,12 @@ module DeepCover
     end
 
     def self.run!(covered_path)
-      @already_setup ||= false # Avoid ruby warning
-      Runner.new(covered_path).run! unless @already_setup
-      @already_setup = true
+      @runner ||= Runner.new(covered_path).run!
+      self
+    end
+
+    def self.and_report!(**options)
+      @runner.report!(**options)
     end
   end
 end

data/lib/deep_cover/backports.rb

@@ -1,9 +1,6 @@
 # frozen_string_literal: true
 
-# We use a few features newer than our target of Ruby 2.0+:
-class Module
-  public :prepend # Public in Ruby 2.1+.
-end
+# We use a few features newer than our target of Ruby 2.1+:
 require 'pathname'
 class Pathname
   def write(*args)
@@ -13,9 +10,8 @@ class Pathname
     File.binwrite(to_path, *args)
   end unless method_defined? :binwrite
 end
-require 'backports/2.1.0/module/include'
-require 'backports/2.1.0/enumerable/to_h'
 require 'backports/2.4.0/false_class/dup'
 require 'backports/2.4.0/true_class/dup'
 require 'backports/2.4.0/hash/transform_values'
 require 'backports/2.4.0/enumerable/sum'
+require 'backports/2.5.0/hash/slice'

data/lib/deep_cover/base.rb

@@ -17,6 +17,7 @@ module DeepCover
       end
       require_relative 'core_ext/require_overrides'
       RequireOverride.active = true
+      config # actualize configuration
       @started = true
     end
 
@@ -28,7 +29,7 @@ module DeepCover
     end
 
     def line_coverage(filename)
-      coverage.line_coverage(handle_relative_filename(filename), **config)
+      coverage.line_coverage(handle_relative_filename(filename), **config.to_h)
     end
 
     def covered_code(filename)
@@ -48,9 +49,13 @@ module DeepCover
     end
 
     def config_changed(what)
-      if what == :paths
+      case what
+      when :paths
         warn "Changing DeepCover's paths after starting coverage is highly discouraged" if @started
         @custom_requirer = nil
+      when :tracker_global
+        raise NotImplementedError, "Changing DeepCover's tracker global after starting coverage is not supported" if @started
+        @coverage = nil
       end
     end
 
@@ -62,7 +67,7 @@ module DeepCover
     end
 
     def coverage
-      @coverage ||= Coverage.new
+      @coverage ||= Coverage.new(tracker_global: config.tracker_global)
     end
 
     def custom_requirer

data/lib/deep_cover/basics.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# Basic constants without any dependencies are here
+module DeepCover
+  DEFAULTS = {
+               ignore_uncovered: [].freeze,
+               paths: %w[./app ./lib].freeze,
+               allow_partial: false,
+               tracker_global: '$_cov',
+               reporter: :html,
+               output: './coverage',
+             }.freeze
+
+  CLI_DEFAULTS = {
+                   command: 'bundle exec rake',
+                   bundle: true,
+                   process: true,
+                   open: false,
+                 }.freeze
+
+  OPTIONALLY_COVERED = %i[case_implicit_else default_argument raise trivial_if].freeze
+end

data/lib/deep_cover/cli/debugger.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
 module DeepCover
+  require 'deep_cover'
+  bootstrap
+
   module CLI
     class Debugger
       include Tools

data/lib/deep_cover/cli/deep_cover.rb

@@ -3,14 +3,16 @@
 module DeepCover
   require 'bundler/setup'
   require 'slop'
-  require 'deep_cover'
-  bootstrap
-  require_relative_dir '.'
+  require_relative '../basics'
 
+  module CLI
+  end
   module CLI::DeepCover
     extend self
 
     def show_version
+      require_relative '../version'
+      require 'parser'
       puts "deep-cover v#{DeepCover::VERSION}; parser v#{Parser::VERSION}"
     end
 
@@ -36,20 +38,26 @@ module DeepCover
 
     def menu
       @menu ||= parse do |o|
-        o.banner = 'usage: deep-cover [options] [path/to/app/or/gem]'
+        o.banner = ['usage: deep-cover [options] exec <command ...>',
+                    '   or  deep-cover [options] [path/to/app/or/gem]',
+                   ].join("\n")
         o.separator ''
-        o.string '-o', '--output', 'output folder', default: './coverage'
-        o.string '-c', '--command', 'command to run tests', default: 'bundle exec rake'
-        o.string '--reporter', 'reporter', default: 'html'
-        o.bool '--bundle', 'run bundle before the tests', default: true
-        o.bool '--process', 'turn off to only redo the reporting', default: true
-        o.bool '--open', 'open the output coverage', default: false
+        o.string '-o', '--output', 'output folder', default: DEFAULTS[:output]
+        o.string '--reporter', 'reporter', default: DEFAULTS[:reporter]
+        o.bool '--open', 'open the output coverage', default: CLI_DEFAULTS[:open]
+
         o.separator 'Coverage options'
-        @ignore_uncovered_map = Analyser::Node.optionally_covered.map do |option|
-          default = Config::DEFAULTS[:ignore_uncovered].include?(option)
-          o.bool "--ignore-#{Tools.dasherize(option)}", '', default: default
+        @ignore_uncovered_map = OPTIONALLY_COVERED.map do |option|
+          default = DEFAULTS[:ignore_uncovered].include?(option)
+          o.bool "--ignore-#{dasherize(option)}", '', default: default
           [:"ignore_#{option}", option]
         end.to_h
+
+        o.separator '\nWhen not using ’exec’:'
+        o.string '-c', '--command', 'command to run tests', default: CLI_DEFAULTS[:command]
+        o.bool '--bundle', 'run bundle before the tests', default: CLI_DEFAULTS[:bundle]
+        o.bool '--process', 'turn off to only redo the reporting', default: CLI_DEFAULTS[:process]
+
         o.separator "\nFor testing purposes:"
         o.bool '--profile', 'use profiler' unless RUBY_PLATFORM == 'java'
         o.string '-e', '--expression', 'test ruby expression instead of a covering a path'
@@ -69,19 +77,33 @@ module DeepCover
       @ignore_uncovered_map.each do |cli_option, option|
         iu << option if options.delete(cli_option)
       end
+      options[:output] = false if ['false', 'f', ''].include?(options[:output])
       options
     end
 
     def go
       options = convert_options(menu.to_h)
+      first, *rest = menu.arguments
       if options[:help]
         show_help
       elsif options[:expression]
+        require_relative 'debugger'
         CLI::Debugger.new(options[:expression], **options).show
+      elsif first == 'exec'
+        require_relative 'exec'
+        CLI::Exec.new(rest, **options).run
       else
-        path = menu.arguments.first || '.'
+        require_relative 'instrumented_clone_reporter'
+        path = first || '.'
         CLI::InstrumentedCloneReporter.new(path, **options).run
       end
     end
+
+    private
+
+    # Poor man's dasherize. 'an_example' => 'an-example'
+    def dasherize(string)
+      string.to_s.tr('_', '-')
+    end
   end
 end

data/lib/deep_cover/cli/exec.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module DeepCover
+  module CLI
+    class Exec
+      class Option
+        def keep_file_descriptors?
+        end
+      end
+
+      def initialize(argv, **options)
+        @argv = argv
+        @options = options
+      end
+
+      def run
+        require 'bundler'
+        require 'bundler/cli'
+        require 'bundler/cli/exec'
+        require 'yaml'
+        require_relative '../backports'
+        ENV['DEEP_COVER'] = 't'
+        ENV['DEEP_COVER_OPTIONS'] = YAML.dump(@options.slice(*DEFAULTS.keys))
+        Bundler::CLI::Exec.new(Option.new, @argv).run
+      end
+    end
+  end
+end

data/lib/deep_cover/cli/instrumented_clone_reporter.rb

@@ -1,18 +1,19 @@
 # frozen_string_literal: true
 
-require 'yaml'
 require 'tmpdir'
 
 module DeepCover
+  require 'deep_cover'
+  bootstrap
+
   module CLI
     class InstrumentedCloneReporter
       include Tools
       # matches regular files, .files, ..files, but not '.' or '..'
       GLOB_ALL_CONTENT = '{,.[^.],..?}*'
 
-      def initialize(source_path, command: 'rake', **options)
-        @command = command
-        @options = options
+      def initialize(source_path, **options)
+        @options = CLI_DEFAULTS.merge(options)
         @root_path = @source_path = Pathname.new(source_path).expand_path
         unless @root_path.join('Gemfile').exist?
           # E.g. rails/activesupport
@@ -149,7 +150,7 @@ module DeepCover
 
       def process
         Bundler.with_clean_env do
-          system("cd #{@main_path} && #{@command}")
+          system("cd #{@main_path} && #{@options[:command]}")
         end
       end
 
@@ -166,12 +167,12 @@ module DeepCover
       end
 
       def run
-        if @options.fetch(:process, true)
+        if @options[:process]
           clear
           copy
           cover
           patch
-          bundle if @options.fetch(:bundle, true)
+          bundle if @options[:bundle]
           process
         end
         report

data/lib/deep_cover/config.rb

@@ -2,14 +2,6 @@
 
 module DeepCover
   class Config
-    DEFAULTS = {
-                 ignore_uncovered: [].freeze,
-                 paths: %w[./app ./lib].freeze,
-                 allow_partial: false,
-               }.freeze
-
-    OPTIONALLY_COVERED = %i[raise default_argument case_implicit_else trivial_if]
-
     def initialize(notify = nil)
       @notify = notify
       @options = DEFAULTS.dup
@@ -24,7 +16,7 @@ module DeepCover
       if keywords.empty?
         @options[:ignore_uncovered]
       else
-        check_uncovered(keywords)
+        keywords = check_uncovered(keywords)
         change(:ignore_uncovered, @options[:ignore_uncovered] | keywords)
       end
     end
@@ -33,7 +25,7 @@ module DeepCover
       if keywords.empty?
         OPTIONALLY_COVERED - @options[:ignore_uncovered]
       else
-        check_uncovered(keywords)
+        keywords = check_uncovered(keywords)
         change(:ignore_uncovered, @options[:ignore_uncovered] - keywords)
       end
     end
@@ -46,17 +38,53 @@ module DeepCover
       end
     end
 
+    def tracker_global(tracker_global = nil)
+      if tracker_global
+        change(:tracker_global, tracker_global)
+      else
+        @options[:tracker_global]
+      end
+    end
+
+    def reporter(reporter = nil)
+      if reporter
+        change(:reporter, reporter)
+      else
+        @options[:reporter]
+      end
+    end
+
+    def output(path_or_false = nil)
+      if path_or_false != nil
+        change(:output, path_or_false)
+      else
+        @options[:output]
+      end
+    end
+
     def reset
       DEFAULTS.each do |key, value|
         change(key, value)
       end
+      self
+    end
+
+    def set(**options)
+      @options[:ignore_uncovered] = [] if options.has_key?(:ignore_uncovered)
+      options.each do |key, value|
+        next if key == :allow_partial
+        public_send key, value
+      end
+      self
     end
 
     private
 
     def check_uncovered(keywords)
+      keywords = keywords.first if keywords.size == 1 && keywords.first.is_a?(Array)
       unknown = keywords - OPTIONALLY_COVERED
       raise ArgumentError, "unknown options: #{unknown.join(', ')}" unless unknown.empty?
+      keywords
     end
 
     def change(option, value)
@@ -66,21 +94,5 @@ module DeepCover
       end
       self
     end
-
-    module Setter
-      def config(notify = self)
-        @config ||= Config.new(notify)
-      end
-
-      def configure(&block)
-        raise 'Must provide a block' unless block
-        case block.arity
-        when 0
-          config.instance_eval(&block)
-        when 1
-          block.call(config)
-        end
-      end
-    end
   end
 end

data/lib/deep_cover/config_setter.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module DeepCover
+  module ConfigSetter
+    def config_queue
+      @config_queue ||= []
+    end
+
+    def config(notify = self)
+      @config ||= Config.new(notify)
+      config_queue.each { |block| configure(&block) }
+      config_queue.clear
+      @config
+    end
+
+    def configure(&block)
+      raise 'Must provide a block' unless block
+      @config ||= nil # avoid warning
+      if @config == nil
+        config_queue << block
+      else
+        case block.arity
+        when 0
+          @config.instance_eval(&block)
+        when 1
+          block.call(@config)
+        end
+      end
+      self
+    end
+  end
+end

data/lib/deep_cover/coverage/base.rb

@@ -34,10 +34,15 @@ module DeepCover
     end
 
     def report(**options)
-      case (reporter = options.fetch(:reporter, :html).to_sym)
+      case (reporter = options.fetch(:reporter, DEFAULTS[:reporter]).to_sym)
       when :html
-        Reporter::HTML.report(self, **options)
-        Reporter::Text.report(self, **options) + "\n\nHTML generated: open #{options[:output]}/index.html"
+        msg = if (output = options.fetch(:output, DEFAULTS[:output]))
+                Reporter::HTML.report(self, **options)
+                "HTML generated: open #{output}/index.html"
+              else
+                'No HTML generated'
+              end
+        Reporter::Text.report(self, **options) + "\n\n" + msg
       when :istanbul
         if Reporter::Istanbul.available?
           report_istanbul(**options)
@@ -70,7 +75,7 @@ module DeepCover
     end
 
     def tracker_global
-      @options.fetch(:tracker_global, CoveredCode::DEFAULT_TRACKER_GLOBAL)
+      @options.fetch(:tracker_global, DEFAULTS[:tracker_global])
     end
   end
 end

data/lib/deep_cover/coverage/istanbul.rb

@@ -19,7 +19,7 @@ module DeepCover
 
     def report_istanbul(output: nil, **options)
       dir = output_istanbul(**options).dirname
-      unless [nil, '', 'false'].include? output
+      unless [nil, false, '', 'false'].include? output
         output = File.expand_path(output)
         html = "--reporter=html --report-dir='#{output}'"
         if options[:open]

data/lib/deep_cover/coverage/persistence.rb

@@ -57,7 +57,7 @@ module DeepCover
 
     # rubocop:disable Security/MarshalLoad
     def load_coverage
-      Marshal.load(dir_path.join(BASENAME).binread).tap do |version: raise, coverage: raise|
+      Marshal.load(dir_path.join(BASENAME).binread).tap do |version:, coverage:|
         raise "dump version mismatch: #{version}, currently #{DeepCover::VERSION}" unless version == DeepCover::VERSION
         return coverage
       end
@@ -65,7 +65,7 @@ module DeepCover
 
     def load_trackers
       tracker_files.each do |full_path|
-        Marshal.load(full_path.binread).tap do |version: raise, global: raise, trackers: raise|
+        Marshal.load(full_path.binread).tap do |version:, global:, trackers:|
           raise "dump version mismatch: #{version}, currently #{DeepCover::VERSION}" unless version == DeepCover::VERSION
           merge_trackers(eval("#{global} ||= {}"), trackers) # rubocop:disable Security/Eval
         end

data/lib/deep_cover/covered_code.rb

@@ -5,13 +5,11 @@ module DeepCover
   load_parser
 
   class CoveredCode
-    DEFAULT_TRACKER_GLOBAL = '$_cov'
-
     attr_accessor :covered_source, :buffer, :tracker_global, :local_var, :name
     @@counter = 0
     @@globals = Hash.new { |h, global| h[global] = eval("#{global} ||= {}") } # rubocop:disable Security/Eval
 
-    def initialize(path: nil, source: nil, lineno: 1, tracker_global: DEFAULT_TRACKER_GLOBAL, local_var: '_temp', name: nil)
+    def initialize(path: nil, source: nil, lineno: 1, tracker_global: DEFAULTS[:tracker_global], local_var: '_temp', name: nil)
       raise 'Must provide either path or source' unless path || source
 
       @buffer = Parser::Source::Buffer.new(path, lineno)
@@ -89,9 +87,14 @@ module DeepCover
       root.main
     end
 
+    def comments
+      root
+      @comments
+    end
+
     def root
       @root ||= begin
-        ast = parser.parse(@buffer)
+        ast, @comments = parser.parse_with_comments(@buffer)
         Node::Root.new(ast, self)
       end
     end

data/lib/deep_cover/custom_requirer.rb

@@ -7,7 +7,7 @@ module DeepCover
     class LoadPathsSubset
       attr_reader :last_lookup_path
 
-      def initialize(load_paths: raise, lookup_paths: raise)
+      def initialize(load_paths:, lookup_paths:)
         @original_load_paths = load_paths
         @cached_load_paths_subset = []
         @cached_load_paths_hash = nil
@@ -69,7 +69,12 @@ module DeepCover
       else
         (@load_paths_subset || self).load_paths.each do |load_path|
           possible_path = File.absolute_path(path, load_path)
-          return possible_path if (@load_paths_subset || File).exist?(possible_path)
+
+          next unless (@load_paths_subset || File).exist?(possible_path)
+          # Ruby 2.5 changed some behaviors of require related to symlinks in $LOAD_PATH
+          # https://bugs.ruby-lang.org/issues/10222
+          return File.realpath(possible_path) if RUBY_VERSION >= '2.5'
+          return possible_path
         end
         nil
       end

data/lib/deep_cover/flag_comment_associator.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module DeepCover
+  ##
+  # A processor which computes which lines to be considered flagged with the
+  # given lookup
+  #
+  class FlagCommentAssociator
+    ##
+    # @param [DeepCover::RootNode] ast
+    # @param [Array(Parser::Source::Comment)] comments
+    def initialize(covered_code, lookup = 'nocov')
+      @covered_code = covered_code
+      @lookup      = /^#[\s#*-]*#{lookup}[\s#*-]*$/
+      @ranges      = nil
+    end
+
+    def include?(range)
+      return false unless (exp = range.expression)
+      lineno = exp.line
+      ranges.any? { |r| r.cover? lineno }
+    end
+
+    def ranges
+      @ranges ||= compute_ranges
+    end
+
+    private
+
+    def compute_ranges
+      @ranges     = []
+      @flag_start = nil
+      index_ast_lines
+      @covered_code.comments.each { |comment| process(comment) }
+      toggle_flag(@covered_code.buffer.last_line) # handle end of file in case of opened flag
+      @ranges
+    end
+
+    def process(comment)
+      return unless comment.text =~ @lookup
+      ln = comment.location.expression.line
+      toggle_flag(ln) unless line_has_only_comments?(ln)
+      toggle_flag(ln + 1)
+    end
+
+    def toggle_flag(lineno)
+      if @flag_start
+        @ranges << (@flag_start..(lineno - 1))
+        @flag_start = nil
+      else
+        @flag_start = lineno
+      end
+    end
+
+    def index_ast_lines
+      @starts = []
+      @covered_code.each_node do |node|
+        if (exp = node.expression)
+          @starts[exp.line] = true
+        end
+      end
+    end
+
+    def line_has_only_comments?(line)
+      !@starts[line]
+    end
+  end
+end

data/lib/deep_cover/load.rb

@@ -2,19 +2,23 @@
 
 module DeepCover
   module Load
-    AUTOLOAD = %i[analyser autoload_tracker coverage covered_code custom_requirer memoize
-                  module_override node problem_with_diagnostic reporter
+    AUTOLOAD = %i[analyser autoload_tracker config coverage covered_code custom_requirer
+                  flag_comment_associator memoize module_override node
+                  problem_with_diagnostic reporter
                  ]
 
     def load_absolute_basics
       require_relative 'base'
-      require_relative 'config'
+      require_relative 'basics'
+      require_relative 'config_setter'
       require_relative 'tools/camelize'
       AUTOLOAD.each do |module_name|
         DeepCover.autoload(Tools::Camelize.camelize(module_name), "#{__dir__}/#{module_name}")
       end
+      DeepCover.autoload :VERSION, 'deep_cover/version'
       Object.autoload :Term, 'term/ansicolor'
       Object.autoload :Terminal, 'terminal-table'
+      Object.autoload :YAML, 'yaml'
       require 'pry'
     end
 
@@ -42,6 +46,7 @@ module DeepCover
       AUTOLOAD.each do |module_name|
         DeepCover.const_get(Tools::Camelize.camelize(module_name))
       end
+      DeepCover::VERSION # rubocop:disable Lint/Void
       @all_loaded = true
     end
   end

data/lib/deep_cover/node/base.rb

@@ -14,10 +14,11 @@ module DeepCover
     include IsStatement
     include ExecutionLocation
     include ChildCanBeEmpty
+    include Filters
 
     attr_reader :index, :parent, :children, :base_node
 
-    def initialize(base_node, parent: raise, index: 0, base_children: base_node.children)
+    def initialize(base_node, parent:, index: 0, base_children: base_node.children)
       @base_node = base_node
       @parent = parent
       @index = index

data/lib/deep_cover/node/branch.rb

@@ -18,7 +18,7 @@ module DeepCover
     end
 
     class TrivialBranch < Node::EmptyBody
-      def initialize(other_branch: raise, condition: raise, position: true)
+      def initialize(other_branch:, condition:, position: true)
         @condition = condition
         @other_branch = other_branch
         super(nil, parent: condition.parent, position: position)

data/lib/deep_cover/node/empty_body.rb

@@ -2,7 +2,7 @@
 
 module DeepCover
   class Node::EmptyBody < Node
-    def initialize(base_node, parent: raise, index: 0, position: ChildCanBeEmpty.last_empty_position)
+    def initialize(base_node, parent:, index: 0, position: ChildCanBeEmpty.last_empty_position)
       @position = position
       super(base_node, parent: parent, index: index, base_children: [])
     end

data/lib/deep_cover/node/mixin/filters.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module DeepCover
+  module Node::Mixin
+    module Filters
+      RAISING_MESSAGES = %i[raise exit].freeze
+      def is_raise?
+        is_a?(Node::Send) && RAISING_MESSAGES.include?(message) && receiver == nil
+      end
+
+      def is_default_argument?
+        parent.is_a?(Node::Optarg)
+      end
+
+      def is_case_implicit_else?
+        is_a?(Node::EmptyBody) && parent.is_a?(Node::Case) && !parent.has_else?
+      end
+
+      def is_trivial_if?
+        # Supports only node being a branch or the fork itself
+        parent.is_a?(Node::If) && parent.condition.is_a?(Node::SingletonLiteral)
+      end
+    end
+  end
+end

data/lib/deep_cover/reporter/html/base.rb

@@ -4,7 +4,7 @@ module DeepCover
   module Reporter::HTML::Base
     include Tools::ContentTag
     def setup
-      DeepCover::Config::DEFAULTS.keys.map do |setting|
+      DeepCover::DEFAULTS.keys.map do |setting|
         value = options[setting]
         value = value.join(', ') if value.respond_to? :join
         content_tag :span, value, class: setting

data/lib/deep_cover/reporter/html/site.rb

@@ -70,7 +70,7 @@ module DeepCover
         end
       end
 
-      def self.save(covered_codes, output: raise, **options)
+      def self.save(covered_codes, output:, **options)
         Site.new(covered_codes, output: output, **options).save
       end
     end

data/lib/deep_cover/tools/dump_covered_code.rb

@@ -11,7 +11,7 @@ module DeepCover
       coverage.save(dest_path)
     end
 
-    def dump_covered_code(source_path, coverage: raise, dest_path: Dir.mktmpdir, root_path: source_path)
+    def dump_covered_code(source_path, coverage:, dest_path: Dir.mktmpdir, root_path: source_path)
       source_path = File.join(File.expand_path(source_path), '')
       dest_path = File.join(File.expand_path(dest_path), '')
       root_path = Pathname.new(root_path)

data/lib/deep_cover/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DeepCover
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: deep-cover
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Marc-André Lafortune
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-18 00:00:00.000000000 Z
+date: 2018-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -31,14 +31,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.10.1
+        version: 3.11.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.10.1
+        version: 3.11.0
 - !ruby/object:Gem::Dependency
   name: binding_of_caller
   requirement: !ruby/object:Gem::Requirement
@@ -211,16 +211,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.52.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.52.1
 description: expression and branch coverage for Ruby.
 email:
 - github@marc-andre.ca
@@ -269,11 +269,14 @@ files:
 - lib/deep_cover/autoload_tracker.rb
 - lib/deep_cover/backports.rb
 - lib/deep_cover/base.rb
+- lib/deep_cover/basics.rb
 - lib/deep_cover/builtin_takeover.rb
 - lib/deep_cover/cli/debugger.rb
 - lib/deep_cover/cli/deep_cover.rb
+- lib/deep_cover/cli/exec.rb
 - lib/deep_cover/cli/instrumented_clone_reporter.rb
 - lib/deep_cover/config.rb
+- lib/deep_cover/config_setter.rb
 - lib/deep_cover/core_ext/autoload_overrides.rb
 - lib/deep_cover/core_ext/coverage_replacement.rb
 - lib/deep_cover/core_ext/load_overrides.rb
@@ -285,6 +288,7 @@ files:
 - lib/deep_cover/coverage/persistence.rb
 - lib/deep_cover/covered_code.rb
 - lib/deep_cover/custom_requirer.rb
+- lib/deep_cover/flag_comment_associator.rb
 - lib/deep_cover/load.rb
 - lib/deep_cover/memoize.rb
 - lib/deep_cover/module_override.rb
@@ -310,6 +314,7 @@ files:
 - lib/deep_cover/node/mixin/child_can_be_empty.rb
 - lib/deep_cover/node/mixin/executed_after_children.rb
 - lib/deep_cover/node/mixin/execution_location.rb
+- lib/deep_cover/node/mixin/filters.rb
 - lib/deep_cover/node/mixin/flow_accounting.rb
 - lib/deep_cover/node/mixin/has_child.rb
 - lib/deep_cover/node/mixin/has_child_handler.rb
@@ -350,7 +355,6 @@ files:
 - lib/deep_cover/tools/camelize.rb
 - lib/deep_cover/tools/content_tag.rb
 - lib/deep_cover/tools/covered.rb
-- lib/deep_cover/tools/dasherize.rb
 - lib/deep_cover/tools/dump_covered_code.rb
 - lib/deep_cover/tools/execute_sample.rb
 - lib/deep_cover/tools/format.rb
@@ -379,7 +383,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/deep_cover/tools/dasherize.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-module DeepCover
-  module Tools::Dasherize
-    # Poor man's dasherize. 'an_example' => 'an-example'
-    def dasherize(string)
-      string.to_s.tr('_', '-')
-    end
-  end
-end