deep-cover 0.1.13 → 0.1.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ef02156435418688aa0934036aa4273c3179468c
-  data.tar.gz: ba37d24e7cbf1e34f0fbd0db4f3f2720527825f4
+  metadata.gz: e6de45ce3979398ef5abb25a8147848ad13fa370
+  data.tar.gz: 74dfa0b7b03271419f0b2c7094e124b447392c46
 SHA512:
-  metadata.gz: 0c209ce060a984b41dc8e454fccebb6d9911a464a1b76de267ccdd326e567b9af9e427c42e66f75007b7fd81cdb27d4bc5b513772cf2d0d0e11c98a8d152a164
-  data.tar.gz: 492ebdb2f56861e7b9d8d195cfdc2818568ff245e7e64c778d9062290785d420c31e43cb1cdcd2efbd204ef40141ba6e80d7d05e220250beba4bf88759b39a1d
+  metadata.gz: 2a455c059204f7eeb91f57ca3d4453a7a79021ece85e3228b4a312034dcaef7d022f0776dc9179bcb1dc44049971ba5248fcdc94badcacc6ab1c08bbd9da195e
+  data.tar.gz: 8c6ec4f7204c95968a329d1ae3896cf9c0e41c68973883add1beca6d1efdcdba353e09ff11dfa97651488a75e2cb4f6dd7cc70d5f23159b21efaba6e967233e4

data/Rakefile

@@ -14,6 +14,7 @@ namespace :dev do
     if RUBY_VERSION >= '2.2.2' && (!defined?(RUBY_ENGINE) || RUBY_ENGINE != 'jruby')
       commands << 'bundle install --gemfile=spec/full_usage/rails51_project/Gemfile'
     end
+    commands << 'bundle install --gemfile=spec/cli_fixtures/simple_rails42_app/Gemfile'
 
     commands.each do |command|
       puts "Running: #{command}"

data/bin/test_gems

@@ -8,7 +8,8 @@ def gem_list
     rspec-support thread_safe rspec-core rspec-expectations rspec-mocks rspec mini_portile
     multi_json rspec-support rspec-expectations rspec-mocks mail nokogiri rack rspec unf
     json thread_safe rspec-core json rack-protection sdoc docile faraday multi_xml coderay
-    mime-types net-scp multi_json turbolinks formatador coffee-script rack-test]
+    mime-types net-scp multi_json turbolinks formatador coffee-script rack-test] +
+    %w[devise]
   # How I got those:
   require 'gems'
   Gems.most_downloaded

data/bin/testall

@@ -12,7 +12,6 @@
 # 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/lib/deep_cover.rb

@@ -1,5 +1,7 @@
 module DeepCover
   require 'parser'
+  require 'term/ansicolor'
+  require 'pry'
   require_relative 'deep_cover/backports'
   require_relative 'deep_cover/tools'
   require_relative_dir 'deep_cover/parser_ext'

data/lib/deep_cover/analyser/base.rb

@@ -33,7 +33,13 @@ module DeepCover
     def each_node(from = covered_code.root, &block)
       return to_enum(:each_node) unless block_given?
       children = node_children(from)
-      yield from, children unless from.is_a?(Node::Root)
+      begin
+        yield from, children unless from.is_a?(Node::Root)
+      rescue ProblemWithDiagnostic
+        raise
+      rescue StandardError, SystemStackError => e
+        raise ProblemWithDiagnostic.new(covered_code, from.diagnostic_expression, e)
+      end
       children.each do |child|
         each_node(child, &block)
       end

data/lib/deep_cover/analyser/per_char.rb

@@ -9,7 +9,7 @@ module DeepCover
         runs = node_runs(node)
         if runs != nil
           node.proper_range.each do |pos|
-            bc[buffer.line_for_position(pos)-1][buffer.column_for_position(pos)] = runs > 0 ? ' ' : 'x'
+            bc[buffer.line_for_position(pos)-buffer.first_line][buffer.column_for_position(pos)] = runs > 0 ? ' ' : 'x'
           end
         end
       end

data/lib/deep_cover/analyser/per_line.rb

@@ -3,7 +3,7 @@ module DeepCover
     # Returns an array of runs, one per line.
     def results
       disallow_partial = !options.fetch(:allow_partial, true)
-      line_hits = Array.new(covered_code.nb_lines)
+      line_hits = Array.new(covered_code.nb_lines + covered_code.lineno - 1)
       each_node do |node, _children|
         if (runs = node_runs(node))
           node.executed_locs.each do |loc|

data/lib/deep_cover/cli/debugger.rb

@@ -1,5 +1,3 @@
-require 'term/ansicolor'
-
 module DeepCover
   module CLI
     class Debugger

data/lib/deep_cover/cli/deep_cover.rb

@@ -37,8 +37,9 @@ module DeepCover
           o.banner = "usage: deep-cover [options] [path/to/app/or/gem]"
           o.separator ''
           o.string '-o', '--output', 'output folder', default: './coverage'
-          o.string '-c', '--command', 'command to run tests', default: 'rake'
+          o.string '-c', '--command', 'command to run tests', default: 'bundle exec rake'
           o.bool '--bundle', 'run bundle before the tests', default: true
+          o.bool '--process', 'turn off to only redo the reporting', default: true
           o.separator 'Coverage options'
           @ignore_uncovered_map = Analyser.optionally_covered.map do |option|
             default = Config::DEFAULTS[:ignore_uncovered].include?(option)

data/lib/deep_cover/cli/instrumented_clone_reporter.rb

@@ -8,10 +8,10 @@ module DeepCover
       # matches regular files, .files, ..files, but not '.' or '..'
       GLOB_ALL_CONTENT = '{,.[^.],..?}*'
 
-      def initialize(gem_path, command: 'rake', **options)
+      def initialize(source_path, command: 'rake', **options)
         @command = command
         @options = options
-        @root_path = gem_path = Pathname.new(gem_path).expand_path
+        @root_path = @source_path = Pathname.new(source_path).expand_path
         unless @root_path.join('Gemfile').exist?
           # E.g. rails/activesupport
           @root_path = @root_path.dirname
@@ -20,40 +20,85 @@ module DeepCover
         @dest_root = Pathname('~/test_deep_cover').expand_path
         @dest_root = Pathname.new(Dir.mktmpdir("deep_cover_test")) unless @dest_root.exist?
 
-        FileUtils.rm_rf(Dir.glob("#{@dest_root}/#{GLOB_ALL_CONTENT}"))
-        gem_relative_path = gem_path.relative_path_from(@root_path)
+        gem_relative_path = @source_path.relative_path_from(@root_path)
         @main_path = @dest_root.join(gem_relative_path)
+        singleton_class.include self.class.const_get(Tools.camelize(style))
+      end
+
+      def clear
+        FileUtils.rm_rf(Dir.glob("#{@dest_root}/#{GLOB_ALL_CONTENT}"))
       end
 
       def copy
         return true if @copied
+        puts "Cloning..."
         FileUtils.cp_r(Dir.glob("#{@root_path}/#{GLOB_ALL_CONTENT}"), @dest_root)
         @copied = true
       end
 
       def patch_ruby_file(ruby_file)
-        content = File.read(ruby_file)
+        content = ruby_file.read
         # Insert our code after leading comments:
         content.sub!(/^((#.*\n+)*)/, "#{$1}require 'deep_cover/auto_run';DeepCover::AutoRun.run! '#{@dest_root}';")
-        File.write(ruby_file, content)
+        ruby_file.write(content)
       end
 
-      def each_gem_path
-        return to_enum __method__ unless block_given?
-        if @main_path.join('lib').exist?
-          yield @main_path
+      def style
+        if @source_path.join('config/environments/test.rb').exist?
+          :rails
+        elsif @source_path.join('lib').exist?
+          :single_gem
         else # Rails style
+          :gem_collection
+        end
+      end
+
+      # Style specific functionality
+      module Gem
+        def each_main_ruby_files(&block)
+          each_gem_path do |dest_path|
+            main = dest_path.join('lib/*.rb')
+            Pathname.glob(main).select(&:file?).each(&block)
+          end
+        end
+
+        def each_dir_to_cover
+          each_gem_path do |dest_path|
+            yield dest_path.join('lib')
+          end
+        end
+      end
+
+      module SingleGem
+        include Gem
+        def each_gem_path
+          yield @main_path
+        end
+      end
+
+      module GemCollection
+        include Gem
+        def each_gem_path
           Pathname.glob(@main_path.join('*/lib')).each{|p| yield p.dirname}
         end
       end
 
+      module Rails
+        def each_main_ruby_files
+          yield @main_path.join('config/environments/test.rb')
+        end
+
+        def each_dir_to_cover
+          yield @main_path.join('app')
+          yield @main_path.join('lib')
+        end
+      end
+
+      # Back to global functionality
       def patch_main_ruby_files
-        each_gem_path do |dest_path|
-          main = dest_path.join('lib/*.rb')
-          Dir.glob(main).select{|p| File.file?(p) }.each do |main|
-            puts "Patching #{main}"
-            patch_ruby_file(main)
-          end
+        each_main_ruby_files do |main|
+          puts "Patching #{main}"
+          patch_ruby_file(main)
         end
       end
 
@@ -88,11 +133,12 @@ module DeepCover
 
       def cover
         coverage = Coverage.new
-        each_gem_path do |dest_path|
-          FileUtils.cp_r("#{dest_path}/lib", "#{dest_path}/lib_original")
-          Tools.dump_covered_code(File.join(dest_path, 'lib_original'),
+        each_dir_to_cover do |to_cover|
+          original = to_cover.sub_ext('_original')
+          FileUtils.cp_r(to_cover, original)
+          Tools.dump_covered_code(original,
             coverage: coverage, root_path: @dest_root.to_s,
-            dest_path: File.join(dest_path, 'lib'))
+            dest_path: to_cover)
         end
         coverage.save(@dest_root.to_s)
       end
@@ -116,11 +162,14 @@ module DeepCover
       end
 
       def run
-        copy
-        cover
-        patch
-        bundle if @options.fetch(:bundle, true)
-        process
+        if @options.fetch(:process, true)
+          clear
+          copy
+          cover
+          patch
+          bundle if @options.fetch(:bundle, true)
+          process
+        end
         report
       end
     end

data/lib/deep_cover/coverage.rb

@@ -3,7 +3,6 @@ module DeepCover
   silence_warnings do
     require 'parser/current'
   end
-  require 'pry'
   require_relative 'covered_code'
   require 'securerandom'
 
@@ -133,11 +132,15 @@ module DeepCover
 
       def save_trackers(global)
         saved?
+        trackers = eval(global)
+        # Some testing involves more than one process, some of which don't run any of our covered code.
+        # Don't save anything if that's the case
+        return if trackers.nil?
         basename = TRACKER_TEMPLATE % {unique: SecureRandom.urlsafe_base64}
         dir_path.join(basename).binwrite(Marshal.dump({
           version: DeepCover::VERSION,
           global: global,
-          trackers: eval(global),
+          trackers: trackers,
         }))
       end
 

data/lib/deep_cover/covered_code.rb

@@ -6,12 +6,11 @@ module DeepCover
     @@counter = 0
     @@globals = Hash.new{|h, global| h[global] = eval("#{global} ||= {}") }
 
-    def initialize(path: nil, source: nil, lineno: nil, tracker_global: DEFAULT_TRACKER_GLOBAL, local_var: '_temp', name: nil)
+    def initialize(path: nil, source: nil, lineno: 1, tracker_global: DEFAULT_TRACKER_GLOBAL, local_var: '_temp', name: nil)
       raise "Must provide either path or source" unless path || source
 
-      @buffer = ::Parser::Source::Buffer.new(path)
+      @buffer = ::Parser::Source::Buffer.new(path, lineno)
       @buffer.source = source ||= File.read(path)
-      @lineno = lineno
       @tracker_count = 0
       @tracker_global = tracker_global
       @local_var = local_var
@@ -23,6 +22,10 @@ module DeepCover
       @buffer.name || "(source: '#{@buffer.source[0..20]}...')"
     end
 
+    def lineno
+      @buffer.first_line
+    end
+
     def nb_lines
       @nb_lines ||= begin
         lines = buffer.source_lines
@@ -37,7 +40,7 @@ module DeepCover
     def execute_code(binding: DeepCover::GLOBAL_BINDING.dup)
       return if has_executed?
       global[nb] = Array.new(@tracker_count, 0)
-      eval(@covered_source, binding, @buffer.name || '<raw_code>', @lineno || 1)
+      eval(@covered_source, binding, @buffer.name || '<raw_code>', lineno)
       self
     end
 

data/lib/deep_cover/node/base.rb

@@ -30,9 +30,38 @@ module DeepCover
 
     ### Public API
 
+    # Search self and descendants for a particular Class or type
+    def find_all(lookup)
+      case lookup
+      when ::Class
+        each_node.grep(lookup)
+      when ::Symbol
+        each_node.find_all{|n| n.type == lookup}
+      when ::String
+        each_node.find_all{|n| n.source == lookup}
+      when ::Regexp
+        each_node.find_all{|n| n.source =~ lookup}
+      else
+        binding.pry
+        raise ::TypeError, "Expected class or symbol, got #{lookup.class}: #{lookup.inspect}"
+      end
+    end
+
     # Shortcut to access children
     def [](v)
-      children[v]
+      if v.is_a?(Integer)
+        children.fetch(v)
+      else
+        found = find_all(v)
+        case found.size
+        when 1
+          found.first
+        when 0
+          raise "No children of type #{v}"
+        else
+          raise "Ambiguous lookup #{v}, found #{found}."
+        end
+      end
     end
 
     # Shortcut to create a node from source code
@@ -106,7 +135,6 @@ module DeepCover
 
     private
     def diagnose(exception)
-      exp = base_node.loc.expression
       msg = if self.class == Node
         "Unknown node type encountered: #{base_node.type}"
       else
@@ -116,7 +144,7 @@ module DeepCover
         'Attempting to continue, but this node will not be handled properly',
         ('Its subnodes will be ignored' if children.empty?),
         'Source:',
-        exp && exp.source,
+        expression,
         "Original exception:",
         exception.inspect,
       ].join("\n")

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

@@ -49,6 +49,10 @@ module DeepCover
         expression.source if expression
       end
 
+      def diagnostic_expression
+        expression || parent.diagnostic_expression
+      end
+
       # Returns an array of character numbers (in the original buffer) that
       # pertain exclusively to this node (and thus not to any children).
       def proper_range

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

@@ -58,6 +58,11 @@ module DeepCover
           flow_entry_count
         end
       end
+
+      # Returns the counts in a hash
+      def counts
+        {flow_entry: flow_entry_count, flow_completion: flow_completion_count, execution: execution_count}
+      end
     end
   end
 end

data/lib/deep_cover/node/send.rb

@@ -37,16 +37,25 @@ module DeepCover
 
       private
 
-      # Only need to add them to deal with ambiguous cases where a method is hidden by a local. Ex:
+      # In different circumstances, we need ().
+      # Deal with ambiguous cases where a method is hidden by a local. Ex:
       #   foo 42, 'hello'  #=> Works
       #   foo (42), 'hello'  #=> Simplification of what DeepCover would generate, still works
       #   foo = 1; foo 42, 'hello'  #=> works
       #   foo = 1; foo (42), 'hello'  #=> syntax error.
       #   foo = 1; foo((42), 'hello')  #=> works
+      # Deal with do/end block. Ex:
+      #   x.foo 42, 43 # => ok
+      #   x.foo (42), 43 # => ok
+      #   x.foo ((42)), 43 # => ok
+      #   x.foo 42, 43 do ; end # => ok
+      #   x.foo (42), 43 do ; end # => ok
+      #   x.foo ((42)), 43 do ; end # => parse error!
       def need_parentheses?
         true unless
           arguments.empty? || # No issue when no arguments
-          receiver || # No ambiguity if there is a receiver
+          loc_hash[:selector_end] || # No issue with foo[bar]= and such
+          loc_hash[:operator] || # No issue with foo.bar=
           loc_hash[:begin] # Ok if has parentheses
       end
     end

data/lib/deep_cover/problem_with_diagnostic.rb

@@ -0,0 +1,61 @@
+module DeepCover
+  class ProblemWithDiagnostic < StandardError
+    attr_reader :covered_code, :line_range, :original_exception
+
+    def initialize(covered_code, line_range, original_exception=nil)
+      @covered_code = covered_code
+      if line_range.is_a?(Parser::Source::Range)
+        @line_range = line_range.line..line_range.last_line
+      else
+        @line_range = line_range
+      end
+      @original_exception = original_exception
+    end
+
+    def message
+      msg = []
+      msg << "You found a problem with DeepCover!"
+      msg << "Please open an issue at https://github.com/deep-cover/deep-cover/issues"
+      msg << "and include the following diagnostic information:"
+      extra = begin
+        diagnostic_information_lines.map{|line| "| #{line}"}
+      rescue ProblemWithDiagnostic
+        ["Oh no! We're in deep trouble!!!"]
+      rescue Exception => e
+        ["Oh no! Even diagnostics are failing: #{e}\n#{e.backtrace}"]
+      end
+      msg.concat(extra)
+      msg.join("\n")
+    end
+
+    def diagnostic_information_lines
+      lines = []
+      lines << "Source file: #{covered_code.path}"
+      lines << "Line numbers: #{line_range}"
+      lines << "Source lines around location:"
+      lines.concat source_lines.map{|line| "   #{line}" }
+      if original_exception
+        lines << "Original exception:"
+        lines << "  #{original_exception.class.name}: #{original_exception.message}"
+        backtrace = Tools.truncate_backtrace(original_exception)
+        lines.concat backtrace.map{|line| "    #{line}"}
+      end
+      lines
+    end
+
+    def source_lines(nb_context_line: 7)
+      first_index = line_range.begin - nb_context_line - buffer.first_line
+      first_index = 0 if first_index < 0
+      last_index = line_range.end + nb_context_line - buffer.first_line
+      last_index = 0 if last_index < 0
+
+      lines = buffer.source_lines[first_index..last_index]
+
+      Tools.number_lines(lines, lineno: buffer.first_line, bad_linenos: line_range.to_a)
+    end
+
+    def buffer
+      covered_code.buffer
+    end
+  end
+end

data/lib/deep_cover/tools/number_lines.rb

@@ -7,8 +7,10 @@ module DeepCover
         cur_lineno = lineno + i
         cur_lineno_s = cur_lineno.to_s.rjust(nb_lineno_digits)
         if bad_linenos.include?(cur_lineno)
+          cur_lineno_s = "*#{cur_lineno_s}" unless bad_linenos.empty?
           prefix = Term::ANSIColor.red("#{cur_lineno_s} | ")
         else
+          cur_lineno_s = " #{cur_lineno_s}" unless bad_linenos.empty?
           prefix = Term::ANSIColor.white("#{cur_lineno_s} | ")
         end
         "#{prefix}#{line}"

data/lib/deep_cover/tools/our_coverage.rb

@@ -3,7 +3,7 @@ module DeepCover
     def our_coverage(source, fn, lineno, **options)
       covered_code = CoveredCode.new(source:source, path: fn, lineno: lineno)
       Tools.execute_sample(covered_code)
-      covered_code.line_coverage(options)
+      covered_code.line_coverage(options)[(lineno-1)..-1]
     end
   end
 end

data/lib/deep_cover/tools/truncate_backtrace.rb

@@ -0,0 +1,30 @@
+module DeepCover
+  module Tools::TruncateBacktrace
+    def truncate_backtrace(backtrace, extra_context: 10)
+      backtrace = backtrace.backtrace if backtrace.is_a?(Exception)
+      trace_lines = backtrace.uniq
+
+      keep_from_begin = 0
+      keep_from_end = backtrace.size - 1
+
+      trace_lines.each do |line|
+        from_begin = backtrace.index(line)
+        from_end = backtrace.rindex(line)
+        if from_begin <= backtrace.size - 1 - from_end
+          keep_from_begin = [keep_from_begin, from_begin].max
+        else
+          keep_from_end = [keep_from_end, from_end].min
+        end
+      end
+
+      keep_from_begin += extra_context
+      keep_from_end -= extra_context
+
+      return backtrace if keep_from_begin + 5 >= keep_from_end
+
+      result = backtrace[0..keep_from_begin]
+      result << "... #{keep_from_end - keep_from_begin - 1} levels..."
+      result.concat backtrace[keep_from_end..-1]
+    end
+  end
+end

data/lib/deep_cover/version.rb

@@ -1,3 +1,3 @@
 module DeepCover
-  VERSION = "0.1.13"
+  VERSION = "0.1.14"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: deep-cover
 version: !ruby/object:Gem::Version
-  version: 0.1.13
+  version: 0.1.14
 platform: ruby
 authors:
 - Marc-André Lafortune
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-05 00:00:00.000000000 Z
+date: 2017-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -288,6 +288,7 @@ files:
 - lib/deep_cover/node/splat.rb
 - lib/deep_cover/node/variables.rb
 - lib/deep_cover/parser_ext/range.rb
+- lib/deep_cover/problem_with_diagnostic.rb
 - lib/deep_cover/reporter.rb
 - lib/deep_cover/reporter/istanbul.rb
 - lib/deep_cover/tools.rb
@@ -304,6 +305,7 @@ files:
 - lib/deep_cover/tools/require_relative_dir.rb
 - lib/deep_cover/tools/silence_warnings.rb
 - lib/deep_cover/tools/slice.rb
+- lib/deep_cover/tools/truncate_backtrace.rb
 - lib/deep_cover/version.rb
 homepage: http://github.com
 licenses:
@@ -325,7 +327,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Write a short summary, because Rubygems requires one.