Sha256: e8681330f0fdda74074b95cd6edba1cbc91fc935e120c126d31b260238dc10f4

Contents?: true

Size: 1.81 KB

Versions: 3

Compression:

Stored size: 1.81 KB

Contents

module RCov
  # 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.
  class VerifyTask < Rake::TaskLib
    # Name of the task. Defaults to :verify_rcov
    attr_accessor :name

    # Path to the index.html file generated by RCov, which
    # is the file containing the total coverage.
    # Defaults to 'coverage/index.html'
    attr_accessor :index_html

    # Whether or not to output details. Defaults to true.
    attr_accessor :verbose

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

    # Require the threshold value be met exactly.  This is the default.
    attr_accessor :require_exact_threshold

    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

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

        File.open(index_html).each_line do |line|
          if line =~ /<tt class='coverage_total'>(\d+\.\d+)%<\/tt>/
            total_coverage = eval($1)
            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
  end
end

Version data entries

3 entries across 3 versions & 1 rubygems

Version Path
picolena-0.1.6 rails_plugins/rspec/lib/spec/rake/verify_rcov.rb
picolena-0.1.7 rails_plugins/rspec/lib/spec/rake/verify_rcov.rb
picolena-0.1.8 rails_plugins/rspec/lib/spec/rake/verify_rcov.rb