deep-cover 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 23dab9f10f66926115fc7a84107eaaa364ea232f
-  data.tar.gz: a5e5a3e0d3b39829928acd724702f306282d03b4
+  metadata.gz: cd810c9ed86848f16da708afa29617606737f5d5
+  data.tar.gz: fa5f6561e9b952e24f43fa7b06eed8c2a21bd0d4
 SHA512:
-  metadata.gz: 746c9f0d6ee8bd832e2629d37996050f309bcc7724be618f72da0c3851705b714f6c56b458bc4727bdb5b7fe62f64eda6b99f61e6ca21e306b3ed8f339a526c5
-  data.tar.gz: 3aa28c66195e1cd61bfeafe38df9caa82e4e5ffd55bf6fdb3b3c4fcee8aa8ac0efb6a369b74c6656954e761e7e5f659aea36d9d25d582049e0d04b92c20a0f4d
+  metadata.gz: 4f26c1f20f3268174c55f2b3bfe17dbf42cecf2e70f1456b395006a8d03545e95388cbe0f3fc18b6b38c5c7413b88327f74c2c921fd55ced04771379a01fb6b0
+  data.tar.gz: 5b220912488dde079c748c4376c9a94adbfeac5a144f6d27c362eb9ff29fabc28247990354a646aa9f2b6f449d2c4de88f94f8d6dbe86f83181da06bd2389732

data/.gitignore

@@ -14,3 +14,4 @@
 .rspec_status
 /Gemfile.local
 /spec/cli_fixtures/covered_trivial_gem/deep_cover/
+/deep_cover

data/CHANGELOG.md

@@ -1,9 +1,14 @@
 # Changelog
 
+## 0.5
+
+* Added custom filters
+
 ## 0.4
 
 * Added `deep-cover exec`
-* Support for # nocov
+* Automatic loading of `.deep-cover.rb`
+* Support for `# nocov`
 
 ## 0.3
 

data/Gemfile

@@ -9,5 +9,4 @@ gemspec
 
 eval_gemfile 'Gemfile.local' if File.exist?('Gemfile.local')
 
-gem 'parser', git: 'https://github.com/marcandre/parser.git', branch: 'tree_rewriter_release'
 gem 'ruby-prof', platforms: :mri

data/README.md

@@ -145,6 +145,24 @@ The file `.deep-cover.rb` is loaded automatically when requiring `deep-cover` an
 
 *Note*: The configuration block is only executed when `deep-cover` is actually started.
 
+#### Custom filters
+
+`deep-cover` comes with a few filters that make it possible to ignore certain uncovered codes.
+
+It is easy to add you own filters.
+
+For example, if one wants to ignore uncovered calls to `raise` but the code uses `our_custom_raise` instead, the following with work:
+
+```
+DeepCover.configure do
+  ignore_uncovered do
+    type == :send &&
+      receiver == nil &&
+      message == :our_custom_raise
+  end
+end
+```
+
 ## Development
 
 After checking out the repo, run `bundle` then `rake dev:install` 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.

data/deep_cover.gemspec

@@ -27,6 +27,7 @@ Gem::Specification.new do |spec|
 
   # Main dependency
   spec.add_runtime_dependency 'parser'
+  spec.add_runtime_dependency 'parser_tree_rewriter'
 
   # Support
   spec.add_runtime_dependency 'backports', '>= 3.11.0'

data/lib/deep_cover/analyser/node.rb

@@ -11,7 +11,7 @@ module DeepCover
     def initialize(source, ignore_uncovered: [], **options)
       @cache = {}.compare_by_identity
       super
-      @allow_filters = Array(ignore_uncovered).map { |kind| :"is_#{kind}?" }
+      @allow_filters = Array(ignore_uncovered).map { |kind| Node.filter_to_method_name(kind) }
       @nocov_ranges = FlagCommentAssociator.new(covered_code)
     end
 

data/lib/deep_cover/backports.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
 # We use a few features newer than our target of Ruby 2.1+:
+class Module
+  public :define_method
+end
 require 'pathname'
 class Pathname
   def write(*args)

data/lib/deep_cover/basics.rb

@@ -18,5 +18,5 @@ module DeepCover
                    open: false,
                  }.freeze
 
-  OPTIONALLY_COVERED = %i[case_implicit_else default_argument raise trivial_if].freeze
+  OPTIONALLY_COVERED = %i[case_implicit_else default_argument raise trivial_if]
 end

data/lib/deep_cover/cli/deep_cover.rb

@@ -7,6 +7,21 @@ module DeepCover
 
   module CLI
   end
+
+  module CLI::SlopExtension
+    attr_accessor :stopped
+    attr_reader :ignored
+
+    def try_process(*)
+      @ignored ||= 0
+      return if stopped
+      o = super
+      @ignored += 1 unless o
+      o
+    end
+  end
+  Slop::Parser.prepend CLI::SlopExtension
+
   module CLI::DeepCover
     extend self
 
@@ -53,7 +68,7 @@ module DeepCover
           [:"ignore_#{option}", option]
         end.to_h
 
-        o.separator '\nWhen not using ’exec’:'
+        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]
@@ -69,6 +84,10 @@ module DeepCover
           exit
         end
         o.boolean('-h', '--help')
+
+        o.boolean('exec', '', help: false) do
+          o.parser.stopped = true if o.parser.ignored == 0
+        end
       end
     end
 
@@ -83,18 +102,17 @@ module DeepCover
 
     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'
+      elsif menu.parser.stopped
         require_relative 'exec'
-        CLI::Exec.new(rest, **options).run
+        CLI::Exec.new(menu.arguments, **options).run
       else
         require_relative 'instrumented_clone_reporter'
-        path = first || '.'
+        path = menu.arguments.first || '.'
         CLI::InstrumentedCloneReporter.new(path, **options).run
       end
     end

data/lib/deep_cover/config.rb

@@ -12,7 +12,12 @@ module DeepCover
     end
     alias_method :to_h, :to_hash
 
-    def ignore_uncovered(*keywords)
+    def ignore_uncovered(*keywords, &block)
+      if block
+        raise ArgumentError, "wrong number of arguments (given #{keywords.size}, expected 0..1)" if keywords.size > 1
+        keywords << Node.unique_filter if keywords.empty?
+        Node.create_filter(keywords.first, &block)
+      end
       if keywords.empty?
         @options[:ignore_uncovered]
       else
@@ -22,6 +27,7 @@ module DeepCover
     end
 
     def detect_uncovered(*keywords)
+      raise ArgumentError, 'No block is accepted' if block_given?
       if keywords.empty?
         OPTIONALLY_COVERED - @options[:ignore_uncovered]
       else

data/lib/deep_cover/load.rb

@@ -2,7 +2,8 @@
 
 module DeepCover
   module Load
-    AUTOLOAD = %i[analyser autoload_tracker config coverage covered_code custom_requirer
+    AUTOLOAD = %i[analyser autoload_tracker auto_run config
+                  coverage covered_code custom_requirer
                   flag_comment_associator memoize module_override node
                   problem_with_diagnostic reporter
                  ]
@@ -35,6 +36,7 @@ module DeepCover
       silence_warnings do
         require 'parser/current'
       end
+      require 'parser_tree_rewriter'
       require_relative_dir 'parser_ext'
       @parser_loaded
     end

data/lib/deep_cover/node/base.rb

@@ -15,6 +15,7 @@ module DeepCover
     include ExecutionLocation
     include ChildCanBeEmpty
     include Filters
+    extend Filters::ClassMethods
 
     attr_reader :index, :parent, :children, :base_node
 

data/lib/deep_cover/node/case.rb

@@ -16,7 +16,7 @@ module DeepCover
       # See https://github.com/jruby/jruby/issues/4804
       # This is solved in jruby 9.2.0.0, better keep the workaround
       # for compatibility.
-      has_child condition: Node, rewrite: '(((%{entry_tracker}) && %{node}))',
+      has_child condition: Node, rewrite: '((%{entry_tracker}) && %{node})',
                 flow_entry_count: :entry_tracker_hits
       executed_loc_keys []
 
@@ -78,7 +78,7 @@ module DeepCover
       has_extra_children whens: When
       has_child else: Node,
                 can_be_empty: -> { base_node.loc.end.begin },
-                rewrite: -> { "#{'else;' unless has_else?}((%{else_entry_tracker};%{local}=nil;%{node}))" },
+                rewrite: -> { "#{'else;' unless has_else?}(%{else_entry_tracker};%{local}=nil;%{node})" },
                 executed_loc_keys: [:else],
                 is_statement: true,
                 flow_entry_count: :else_entry_tracker_hits

data/lib/deep_cover/node/exceptions.rb

@@ -13,7 +13,7 @@ module DeepCover
                 can_be_empty: -> { (base_node.loc.begin || base_node.loc.expression.succ).end },
                 flow_entry_count: :entered_body_tracker_hits,
                 is_statement: true,
-                rewrite: '((%{entered_body_tracker};%{local}=nil;%{node}))'
+                rewrite: '(%{entered_body_tracker};%{local}=nil;%{node})'
 
       def is_statement
         false

data/lib/deep_cover/node/loops.rb

@@ -9,7 +9,7 @@ module DeepCover
       has_child body: Node,
                 can_be_empty: -> { base_node.loc.end.begin },
                 flow_entry_count: :body_tracker_hits,
-                rewrite: '((%{body_tracker};%{local}=nil;%{node}))'
+                rewrite: '(%{body_tracker};%{local}=nil;%{node})'
       check_completion
 
       def execution_count

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

@@ -3,6 +3,24 @@
 module DeepCover
   module Node::Mixin
     module Filters
+      module ClassMethods
+        def filter_to_method_name(kind)
+          :"is_#{kind}?"
+        end
+
+        def create_filter(name, &block)
+          Filters.define_method(filter_to_method_name(name), &block)
+          OPTIONALLY_COVERED << name
+        end
+
+        def unique_filter
+          (1..Float::INFINITY).each do |i|
+            name = :"custom_filter_#{i}"
+            return name unless Filters.method_defined?(filter_to_method_name(name))
+          end
+        end
+      end
+
       RAISING_MESSAGES = %i[raise exit].freeze
       def is_raise?
         is_a?(Node::Send) && RAISING_MESSAGES.include?(message) && receiver == nil

data/lib/deep_cover/node/short_circuit.rb

@@ -9,7 +9,7 @@ module DeepCover
       has_tracker :conditional
       has_child lhs: Node
       has_child conditional: Node, flow_entry_count: :conditional_tracker_hits,
-                rewrite: '((%{conditional_tracker};%{node}))'
+                rewrite: '(%{conditional_tracker};%{node})'
 
       def branches
         [

data/lib/deep_cover/reporter/util/tree.rb

@@ -34,7 +34,7 @@ module DeepCover
         #    {a: {b: {d: {} } } }]
         # => {a: {b: {c: {}, d: {} }}}
         def deep_merge(trees)
-          trees.inject do |result, h|
+          trees.inject({}) do |result, h|
             result.merge(h) { |k, val, val_b| deep_merge([val, val_b]) }
           end
         end

data/lib/deep_cover/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: deep-cover
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Marc-André Lafortune
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-07 00:00:00.000000000 Z
+date: 2018-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -25,6 +25,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: parser_tree_rewriter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: backports
   requirement: !ruby/object:Gem::Requirement