Class: RCov::VerifyTask

Inherits:
Rake::TaskLib
  • Object
show all
Defined in:
lib/vendor/plugins/rspec/lib/spec/rake/verify_rcov.rb

Overview

A task that can verify that the RCov coverage doesn’t drop below a certain threshold. It should be run after running Spec::Rake::SpecTask.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name = :verify_rcov) {|_self| ... } ⇒ VerifyTask

Returns a new instance of VerifyTask.

Yields:

  • (_self)

Yield Parameters:



25
26
27
28
29
30
31
32
33
 
# File 'lib/vendor/plugins/rspec/lib/spec/rake/verify_rcov.rb', line 25

def initialize(name=:verify_rcov)
  @name = name
  @index_html = 'coverage/index.html'
  @verbose = true
  @require_exact_threshold = true
  yield self if block_given?
  raise "Threshold must be set" if @threshold.nil?
  define
end

Instance Attribute Details

#index_html ⇒ Object

Path to the index.html file generated by RCov, which is the file containing the total coverage. Defaults to ‘coverage/index.html’



12
13
14
 
# File 'lib/vendor/plugins/rspec/lib/spec/rake/verify_rcov.rb', line 12

def index_html
  @index_html
end

#name ⇒ Object

Name of the task. Defaults to :verify_rcov



7
8
9
 
# File 'lib/vendor/plugins/rspec/lib/spec/rake/verify_rcov.rb', line 7

def name
  @name
end

#require_exact_threshold ⇒ Object

Require the threshold value be met exactly. This is the default.



23
24
25
 
# File 'lib/vendor/plugins/rspec/lib/spec/rake/verify_rcov.rb', line 23

def require_exact_threshold
  @require_exact_threshold
end

#threshold ⇒ Object

The threshold value (in percent) for coverage. If the actual coverage is not equal to this value, the task will raise an exception.



20
21
22
 
# File 'lib/vendor/plugins/rspec/lib/spec/rake/verify_rcov.rb', line 20

def threshold
  @threshold
end

#verbose ⇒ Object

Whether or not to output details. Defaults to true.



15
16
17
 
# File 'lib/vendor/plugins/rspec/lib/spec/rake/verify_rcov.rb', line 15

def verbose
  @verbose
end

Instance Method Details

#define ⇒ Object 



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/vendor/plugins/rspec/lib/spec/rake/verify_rcov.rb', line 35

def define
  desc "Verify that rcov coverage is at least #{threshold}%"
  task @name do
    total_coverage = 0

    File.open(index_html).each_line do |line|
      if line =~ /<tt class='coverage_total'>\s*(\d+\.\d+)%\s*<\/tt>/
        total_coverage = $1.to_f
        break
      end
    end
    puts "Coverage: #{total_coverage}% (threshold: #{threshold}%)" if verbose
    raise "Coverage must be at least #{threshold}% but was #{total_coverage}%" if total_coverage < threshold
    raise "Coverage has increased above the threshold of #{threshold}% to #{total_coverage}%. You should update your threshold value." if (total_coverage > threshold) and require_exact_threshold
  end
end