deep-cover 0.1.1

data/lib/deep_cover/tools.rb

@@ -0,0 +1,18 @@
+module DeepCover
+  Tools = Module.new
+
+  require_relative 'tools/require_relative_dir'
+  extend Tools::RequireRelativeDir
+  require_relative_dir 'tools'
+  extend Tools::SilenceWarnings
+
+  # The functions defined in the submodules of Tools can be accessed
+  # either by extending the desired module, or all of them by extending
+  # Tools, or by calling them directly Tool.my_function.
+  module Tools
+    constants.each do |module_name|
+      include const_get(module_name)
+    end
+    extend self
+  end
+end

data/lib/deep_cover/tools/builtin_coverage.rb

@@ -0,0 +1,50 @@
+module DeepCover
+  module Tools::BuiltinCoverage
+    require 'coverage'
+
+    def builtin_coverage(source, fn, lineno)
+      fn = File.absolute_path(File.expand_path(fn))
+      ::Coverage.start
+      Tools.silence_warnings do
+        execute_sample ->{ run_with_line_coverage(source, fn, lineno)}
+      end
+      unshift_coverage(::Coverage.result.fetch(fn), lineno)
+    end
+
+    if defined?(RUBY_ENGINE) && RUBY_ENGINE == 'jruby'
+      # Executes the source as if it was in the specified file while
+      # builtin coverage information is still captured
+      def run_with_line_coverage(source, fn=nil, lineno=1)
+        source = shift_source(source, lineno)
+        Object.to_java.getRuntime.executeScript(source, fn)
+      end
+    else
+      # In ruby 2.0 and 2.1, using 2, 3 or 4 as lineno with RubyVM::InstructionSequence.compile
+      # will cause the coverage result to be truncated.
+      # 1: [1,2,nil,1]
+      # 2: [nil,1,2,nil]
+      # 3: [nil,nil,1,2]
+      # 4: [nil,nil,nil,1]
+      # 5: [nil,nil,nil,nil,1,2,nil,1]
+      # Using 1 and 5 or more do not seem to show this issue.
+      # The workaround is to create the fake lines manually and always use the default lineno
+
+      # Executes the source as if it was in the specified file while
+      # builtin coverage information is still captured
+      def run_with_line_coverage(source, fn=nil, lineno=1)
+        source = shift_source(source, lineno)
+        RubyVM::InstructionSequence.compile(source, fn).eval
+      end
+    end
+
+    private
+
+    def shift_source(source, lineno)
+      "\n" * (lineno - 1) + source
+    end
+
+    def unshift_coverage(coverage, lineno)
+      coverage[(lineno-1)..-1]
+    end
+  end
+end

data/lib/deep_cover/tools/camelize.rb

@@ -0,0 +1,8 @@
+module DeepCover
+  module Tools::Camelize
+    # Poor man's camelize. 'an_example' => 'AnExample'
+    def camelize(string)
+      string.to_s.gsub(/([a-z\d]*)[_?!]?/){ $1.capitalize }
+    end
+  end
+end

data/lib/deep_cover/tools/dump_covered_code.rb

@@ -0,0 +1,32 @@
+require 'with_progress'
+
+module DeepCover
+  module Tools::DumpCoveredCode
+    def dump_covered_code(source_path, dest_path = Dir.mktmpdir)
+      coverage = Coverage.new(tracker_global: '$_sc')
+      source_path = File.join(File.expand_path(source_path), '')
+      dest_path = File.join(File.expand_path(dest_path), '')
+      skipped = []
+      Dir.glob("#{source_path}**/*.rb").each.with_progress(title: 'Rewriting') do |path|
+        begin
+          covered_code = coverage.covered_code(path)
+        rescue Parser::SyntaxError
+          skipped << path
+          next
+        end
+        new_path = Pathname(path.gsub(source_path, dest_path))
+        new_path.dirname.mkpath
+        new_path.write(covered_code.covered_source)
+      end
+      unless skipped.empty?
+        warn [
+          "#{skipped.size} files could not be instrumented because of syntax errors:",
+          *skipped.first(3),
+          ('...' if skipped.size > 3),
+        ].compact.join("\n")
+      end
+      coverage.save(dest_path)
+      dest_path
+    end
+  end
+end

data/lib/deep_cover/tools/execute_sample.rb

@@ -0,0 +1,23 @@
+module DeepCover
+  module Tools::ExecuteSample
+    # Returns true if the code would have continued, false if the rescue was triggered.
+    def execute_sample(to_execute)
+      # Disable some annoying warning by ruby. We are testing edge cases, so warnings are to be expected.
+      begin
+        Tools.silence_warnings do
+          if to_execute.is_a?(CoveredCode)
+            to_execute.execute_code
+          else
+            to_execute.call
+          end
+        end
+        true
+      rescue RuntimeError => e
+         # In our samples, a simple `raise` doesn't need to be rescued
+         # Other exceptions are not rescued
+        raise unless e.message.empty?
+        false
+      end
+    end
+  end
+end

data/lib/deep_cover/tools/format.rb

@@ -0,0 +1,16 @@
+module DeepCover
+  module Tools::Format
+    CONVERT = Hash.new('  ')
+    CONVERT[0] = 'x '
+    CONVERT[nil] = '- '
+
+    def format(*results, filename: nil, source: nil)
+      source ||= File.read(filename)
+      results.map!{|counts| counts.map{|c| CONVERT[c]}}
+      [*results, source.lines].transpose.map do |parts|
+        *line_results, line = parts
+        Term::ANSIColor.white(line_results.join) + line.to_s
+      end
+    end
+  end
+end

data/lib/deep_cover/tools/format_char_cover.rb

@@ -0,0 +1,18 @@
+module DeepCover
+  module Tools::FormatCharCover
+    COLOR = {'x' => :red, ' ' => :green, '-' => :faint}
+    WHITESPACE_MAP = Hash.new{|_, v| v}.merge!(' ' => '·', "\t" => '→ ')
+    def format_char_cover(covered_code, show_whitespace: false)
+      bc = covered_code.char_cover
+
+      covered_code.buffer.source_lines.map.with_index do |line, line_index|
+        next line if line.strip =~ /^#[ >]/
+        line.chars.map.with_index do |c, c_index|
+          color = COLOR[bc[line_index][c_index]]
+          c = WHITESPACE_MAP[c] if show_whitespace
+          Term::ANSIColor.send(color, c)
+        end.join
+      end
+    end
+  end
+end

data/lib/deep_cover/tools/format_generated_code.rb

@@ -0,0 +1,25 @@
+module DeepCover
+  module Tools::FormatGeneratedCode
+    def format_generated_code(covered_code)
+      inserts = []
+      generated_code = covered_code.instrument_source do |inserted, _node, expr_limit|
+        inserts << [expr_limit, inserted.size]
+        Term::ANSIColor.yellow(inserted)
+      end
+
+      inserts = inserts.sort_by{|exp, _| [exp.line, exp.column]}.reverse
+      generated_lines = generated_code.split("\n")
+
+      inserts.each do |exp_limit, size|
+        # Line index starts at 1, so array index returns the next line
+        comment_line = generated_lines[exp_limit.line]
+        next unless comment_line.present?
+        next unless comment_line.start_with?('#>')
+        next if comment_line.start_with?('#>X')
+        next unless comment_line.size >= exp_limit.column
+        comment_line.insert(exp_limit.column, ' ' * size)
+      end
+      generated_lines.join("\n")
+    end
+  end
+end

data/lib/deep_cover/tools/number_lines.rb

@@ -0,0 +1,18 @@
+module DeepCover
+  module Tools::NumberLines
+    def number_lines(lines, lineno: 1, bad_linenos: [])
+      max_lineno = lineno + lines.size - 1
+      nb_lineno_digits = max_lineno.to_s.size
+      lines.map.with_index do |line, i|
+        cur_lineno = lineno + i
+        cur_lineno_s = cur_lineno.to_s.rjust(nb_lineno_digits)
+        if bad_linenos.include?(cur_lineno)
+          prefix = Term::ANSIColor.red("#{cur_lineno_s} | ")
+        else
+          prefix = Term::ANSIColor.white("#{cur_lineno_s} | ")
+        end
+        "#{prefix}#{line}"
+      end
+    end
+  end
+end

data/lib/deep_cover/tools/our_coverage.rb

@@ -0,0 +1,9 @@
+module DeepCover
+  module Tools::OutCoverage
+    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)
+    end
+  end
+end

data/lib/deep_cover/tools/require_relative_dir.rb

@@ -0,0 +1,10 @@
+module DeepCover
+  module Tools::RequireRelativeDir
+    def require_relative_dir(dir_name, except: [])
+      dir = File.dirname(caller.first.partition(/\.rb:\d/).first)
+      Dir["#{dir}/#{dir_name}/*.rb"].sort.each do |file|
+        require file unless except.include? File.basename(file, '.rb')
+      end
+    end
+  end
+end

data/lib/deep_cover/tools/silence_warnings.rb

@@ -0,0 +1,15 @@
+module DeepCover
+  module Tools::SilenceWarnings
+    # copied from: activesupport/lib/active_support/core_ext/kernel/reporting.rb
+    def silence_warnings
+      with_warnings(nil) { yield }
+    end
+
+    def with_warnings(flag)
+      old_verbose, $VERBOSE = $VERBOSE, flag
+      yield
+    ensure
+      $VERBOSE = old_verbose
+    end
+  end
+end

data/lib/deep_cover/version.rb

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

metadata

@@ -0,0 +1,326 @@
+--- !ruby/object:Gem::Specification
+name: deep-cover
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Marc-André Lafortune
+- Maxime Lapointe
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: parser
+  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
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.10.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.10.1
+- !ruby/object:Gem::Dependency
+  name: binding_of_caller
+  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: term-ansicolor
+  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: highline
+  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: ruby-progressbar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+- !ruby/object:Gem::Dependency
+  name: with_progress
+  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: slop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: Write a longer description or delete this line.
+email:
+- github@marc-andre.ca
+- hunter_spawn@hotmail.com
+executables:
+- deep-cover
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/cov
+- bin/gemcov
+- bin/selfcov
+- bin/setup
+- bin/testall
+- deep_cover.gemspec
+- exe/deep-cover
+- future_read_me.md
+- lib/deep-cover.rb
+- lib/deep_cover.rb
+- lib/deep_cover/analyser.rb
+- lib/deep_cover/analyser/base.rb
+- lib/deep_cover/analyser/branch.rb
+- lib/deep_cover/analyser/covered_code_source.rb
+- lib/deep_cover/analyser/function.rb
+- lib/deep_cover/analyser/ignore_uncovered.rb
+- lib/deep_cover/analyser/node.rb
+- lib/deep_cover/analyser/per_char.rb
+- lib/deep_cover/analyser/per_line.rb
+- lib/deep_cover/analyser/statement.rb
+- lib/deep_cover/analyser/subset.rb
+- lib/deep_cover/auto_run.rb
+- lib/deep_cover/autoload_tracker.rb
+- lib/deep_cover/backports.rb
+- lib/deep_cover/base.rb
+- lib/deep_cover/builtin_takeover.rb
+- lib/deep_cover/cli/debugger.rb
+- lib/deep_cover/cli/deep_cover.rb
+- lib/deep_cover/cli/instrumented_clone_reporter.rb
+- lib/deep_cover/config.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
+- lib/deep_cover/core_ext/require_overrides.rb
+- lib/deep_cover/coverage.rb
+- lib/deep_cover/covered_code.rb
+- lib/deep_cover/custom_requirer.rb
+- lib/deep_cover/node.rb
+- lib/deep_cover/node/arguments.rb
+- lib/deep_cover/node/assignments.rb
+- lib/deep_cover/node/base.rb
+- lib/deep_cover/node/begin.rb
+- lib/deep_cover/node/block.rb
+- lib/deep_cover/node/boolean.rb
+- lib/deep_cover/node/branch.rb
+- lib/deep_cover/node/case.rb
+- lib/deep_cover/node/collections.rb
+- lib/deep_cover/node/const.rb
+- lib/deep_cover/node/def.rb
+- lib/deep_cover/node/empty_body.rb
+- lib/deep_cover/node/exceptions.rb
+- lib/deep_cover/node/if.rb
+- lib/deep_cover/node/keywords.rb
+- lib/deep_cover/node/literals.rb
+- lib/deep_cover/node/loops.rb
+- lib/deep_cover/node/mixin/can_augment_children.rb
+- lib/deep_cover/node/mixin/check_completion.rb
+- 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/flow_accounting.rb
+- lib/deep_cover/node/mixin/has_child.rb
+- lib/deep_cover/node/mixin/has_child_handler.rb
+- lib/deep_cover/node/mixin/has_tracker.rb
+- lib/deep_cover/node/mixin/is_statement.rb
+- lib/deep_cover/node/mixin/rewriting.rb
+- lib/deep_cover/node/mixin/wrapper.rb
+- lib/deep_cover/node/module.rb
+- lib/deep_cover/node/root.rb
+- lib/deep_cover/node/send.rb
+- lib/deep_cover/node/splat.rb
+- lib/deep_cover/node/variables.rb
+- lib/deep_cover/parser_ext/range.rb
+- lib/deep_cover/reporter.rb
+- lib/deep_cover/reporter/istanbul.rb
+- lib/deep_cover/tools.rb
+- lib/deep_cover/tools/builtin_coverage.rb
+- lib/deep_cover/tools/camelize.rb
+- lib/deep_cover/tools/dump_covered_code.rb
+- lib/deep_cover/tools/execute_sample.rb
+- lib/deep_cover/tools/format.rb
+- lib/deep_cover/tools/format_char_cover.rb
+- lib/deep_cover/tools/format_generated_code.rb
+- lib/deep_cover/tools/number_lines.rb
+- lib/deep_cover/tools/our_coverage.rb
+- lib/deep_cover/tools/require_relative_dir.rb
+- lib/deep_cover/tools/silence_warnings.rb
+- lib/deep_cover/version.rb
+homepage: http://github.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Write a short summary, because Rubygems requires one.
+test_files: []