relevance-rcov 0.8.4.1 → 0.8.5

data/Rakefile

@@ -1,7 +1,3 @@
-# This Rakefile serves as an example of how to use Rcov::RcovTask.
-# Take a look at the RDoc documentation (or readme_for_rake) for further
-# information.
-
 $:.unshift "lib" if File.directory? "lib"
 require 'rcov/rcovtask'
 require 'rcov/version'
@@ -10,9 +6,6 @@ require 'rake/rdoctask'
 require 'rake/gempackagetask'
 require 'rake/clean'
 
-puts "************\n#{ENV["PATH"]}\n************\n"
-puts "************\n#{RUBY_VERSION}\n************"
-
 # Use the specified rcov executable instead of the one in $PATH
 # (this way we get a sort of informal functional test).
 # This could also be specified from the command like, e.g.

data/bin/rcov

@@ -36,6 +36,7 @@ options.spec_only = false
 options.sort = :name
 options.sort_reverse = false
 options.output_threshold = 101
+options.failure_threshold = nil
 options.replace_prog_name = false
 options.callsites = false
 options.crossrefs = false
@@ -76,216 +77,221 @@ opts = OptionParser.new do |opts|
 rcov #{Rcov::VERSION} #{Rcov::RELEASE_DATE}
 Usage: rcov [options] <script1.rb> [script2.rb] [-- --extra-options]
 EOF
-    opts.separator ""
-    opts.separator "Options:"
+  opts.separator ""
+  opts.separator "Options:"
 
-    opts.on("-o", "--output PATH", "Destination directory.") do |dir|
-      options.destdir = dir
-    end
-    
-    opts.on("-I", "--include PATHS", "Prepend PATHS to $: (colon separated list)") do |paths|
-      options.loadpaths = paths.split(/:/)
-    end
-    
-    opts.on("--[no-]comments", "Mark all comments by default.", "(default: --no-comments)") do |comments_run_p|
-      options.comments_run_by_default = comments_run_p
-    end
-
-    opts.on("--test-unit-only", "Only trace code executed inside TestCases.") do
-      deprecated("--test-unit-only")
-    end
-
-    opts.on("--spec-only", "Only trace code executed inside RSpec specs.") do
-      deprecated("--spec-only")
-    end
-
-    opts.on("-n", "--no-color", "Create colorblind-safe output.") do
-      options.color = false
+  opts.on("-o", "--output PATH", "Destination directory.") do |dir|
+    options.destdir = dir
+  end
+  
+  opts.on("-I", "--include PATHS", "Prepend PATHS to $: (colon separated list)") do |paths|
+    options.loadpaths = paths.split(/:/)
+  end
+  
+  opts.on("--[no-]comments", "Mark all comments by default.", "(default: --no-comments)") do |comments_run_p|
+    options.comments_run_by_default = comments_run_p
+  end
+  
+  opts.on("--test-unit-only", "Only trace code executed inside TestCases.") do
+    deprecated("--test-unit-only")
+  end
+  
+  opts.on("--spec-only", "Only trace code executed inside RSpec specs.") do
+    deprecated("--spec-only")
+  end
+  
+  opts.on("-n", "--no-color", "Create colorblind-safe output.") do
+    options.color = false
+  end
+  
+  opts.on("-i", "--include-file PATTERNS", 
+          "Generate info for files matching a",
+          "pattern (comma-separated regexp list)") do |list|
+    begin
+      regexps = list.split(/,/).map{|x| Regexp.new(x) }
+      options.include += regexps
+    rescue RegexpError => e
+      raise OptionParser::InvalidArgument, e.message
     end
-
-    opts.on("-i", "--include-file PATTERNS", 
-            "Generate info for files matching a",
-            "pattern (comma-separated regexp list)") do |list|
-                begin
-                    regexps = list.split(/,/).map{|x| Regexp.new(x) }
-                    options.include += regexps
-                rescue RegexpError => e
-                    raise OptionParser::InvalidArgument, e.message
-                end
-            end
-            
-    opts.on("-x", "--exclude PATTERNS", "Don't generate info for files matching a","pattern (comma-separated regexp list)") do |list|
-      begin
-        regexps = list.split(/,/).map{|x| Regexp.new x}
+  end
+  
+  opts.on("-x", "--exclude PATTERNS", "Don't generate info for files matching a","pattern (comma-separated regexp list)") do |list|
+    begin
+      regexps = list.split(/,/).map{|x| Regexp.new x}
         options.skip += regexps
-      rescue RegexpError => e
+    rescue RegexpError => e
         raise OptionParser::InvalidArgument, e.message
-      end
-    end
-            
-    opts.on("--exclude-only PATTERNS", "Skip info only for files matching the", "given patterns.") do |list|
-      begin
-        options.skip = list.split(/,/).map{|x| Regexp.new(x) }
-      rescue RegexpError => e
-        raise OptionParser::InvalidArgument, e.message
-      end
-    end
-            
-    opts.on("--rails", "Skip config/, environment/ and vendor/.") do 
-      options.skip.concat [%r{\bvendor/},%r{\bconfig/},%r{\benvironment/}]
-    end
-
-    opts.on("--[no-]callsites", "Show callsites in generated XHTML report.", "(somewhat slower; disabled by default)") do |val|
-      options.callsites = val
-    end
-
-    opts.on("--[no-]xrefs", "Generate fully cross-referenced report.", "(includes --callsites)") do |val|
-      options.crossrefs = val
-      options.callsites ||= val
     end
-
-    opts.on("-p", "--profile", "Generate bogo-profiling info.") do
-      options.profiling = true
-      options.destdir ||= "profiling"
+  end
+  
+  opts.on("--exclude-only PATTERNS", "Skip info only for files matching the", "given patterns.") do |list|
+    begin
+      options.skip = list.split(/,/).map{|x| Regexp.new(x) }
+    rescue RegexpError => e
+      raise OptionParser::InvalidArgument, e.message
     end
-
-    opts.on("-r", "--range RANGE", Float, "Color scale range for profiling info (dB).") do |val|
+  end
+  
+  opts.on("--rails", "Skip config/, environment/ and vendor/.") do 
+    options.skip.concat [%r{\bvendor/},%r{\bconfig/},%r{\benvironment/}]
+  end
+  
+  opts.on("--[no-]callsites", "Show callsites in generated XHTML report.", "(somewhat slower; disabled by default)") do |val|
+    options.callsites = val
+  end
+  
+  opts.on("--[no-]xrefs", "Generate fully cross-referenced report.", "(includes --callsites)") do |val|
+    options.crossrefs = val
+    options.callsites ||= val
+  end
+  
+  opts.on("-p", "--profile", "Generate bogo-profiling info.") do
+    options.profiling = true
+    options.destdir ||= "profiling"
+  end
+  
+  opts.on("-r", "--range RANGE", Float, "Color scale range for profiling info (dB).") do |val|
       options.range = val
-    end
-    
-    opts.on("-a", "--annotate", "Generate annotated source code.") do
-      options.html = false
-      options.textmode = :annotate
-      options.crossrefs = true
-      options.callsites = true
-      options.skip = [ %r!/test/unit/! ]
-    end
-
-    opts.on("-T", "--text-report", "Dump detailed plain-text report to stdout.", "(filename, LoC, total lines, coverage)") do
-      options.textmode = :report
-    end
-
-    opts.on("-t", "--text-summary", "Dump plain-text summary to stdout.") do
-      options.textmode = :summary
-    end
-
-    opts.on("--text-counts", "Dump execution counts in plaintext.") do
-      options.textmode = :counts
-    end
-
-    opts.on("--text-coverage", "Dump coverage info to stdout, using", "ANSI color sequences unless -n.") do
-      options.textmode = :coverage
-    end
-
-    opts.on("--gcc", "Dump uncovered line in GCC error format.") do
-      options.gcc_output = true
-    end
-    
-    opts.on("--aggregate FILE", "Aggregate data from previous runs",
-                                "in FILE. Overwrites FILE with the",
-                                "merged data. FILE is created if",
-                                "necessary.") do |file|
-      options.aggregate_file = file
-    end
-    
-    opts.on("-D [FILE]", "--text-coverage-diff [FILE]",
-            "Compare code coverage with saved state",
-            "in FILE, defaults to coverage.info.",
-            "Implies --comments.") do |file|
-        options.textmode = :coverage_diff
-        options.comments_run_by_default = true
-        if options.coverage_diff_save
-            raise "You shouldn't use --save and --text-coverage-diff at a time."
-        end
-        options.coverage_diff_mode = :compare
-        options.coverage_diff_file = file if file && !file.empty?
-    end
-    
-    opts.on("--save [FILE]", "Save coverage data to FILE,", "for later use with rcov -D.", "(default: coverage.info)") do |file|
-      options.coverage_diff_save = true
-      options.coverage_diff_mode = :record
-      if options.textmode == :coverage_diff
-        raise "You shouldn't use --save and --text-coverage-diff at a time."
-      end
-      options.coverage_diff_file = file if file && !file.empty?
-    end
-    
-    opts.on("--[no-]html", "Generate HTML output.", "(default: --html)") do |val|
-      options.html = val
-    end
-    
-    opts.on("--sort CRITERION", [:name, :loc, :coverage], "Sort files in the output by the specified", "field (name, loc, coverage)") do |criterion|
-      options.sort = criterion
-    end
-    
-    opts.on("--sort-reverse", "Reverse files in the output.") do
-      options.sort_reverse = true
-    end
-    
-    opts.on("--threshold INT", "Only list files with coverage < INT %.", "(default: 101)") do |threshold|
-      begin
-        threshold = Integer(threshold)
-        raise if threshold <= 0 || threshold > 101
-      rescue Exception
-        raise OptionParser::InvalidArgument, threshold
-      end
-      options.output_threshold = threshold
-    end
-
-    opts.on("--charset CHARSET", "Charset used in Content-Type declaration of HTML reports.") do |c|
-        options.charset = c
-    end
+  end
+  
+  opts.on("-a", "--annotate", "Generate annotated source code.") do
+    options.html = false
+    options.textmode = :annotate
+    options.crossrefs = true
+    options.callsites = true
+    options.skip = [ %r!/test/unit/! ]
+  end
+  
+  opts.on("-T", "--text-report", "Dump detailed plain-text report to stdout.", "(filename, LoC, total lines, coverage)") do
+    options.textmode = :report
+  end
+  
+  opts.on("-t", "--text-summary", "Dump plain-text summary to stdout.") do
+    options.textmode = :summary
+  end
+  
+  opts.on("--text-counts", "Dump execution counts in plaintext.") do
+    options.textmode = :counts
+  end
+  
+  opts.on("--text-coverage", "Dump coverage info to stdout, using", "ANSI color sequences unless -n.") do
+    options.textmode = :coverage
+  end
+  
+  opts.on("--gcc", "Dump uncovered line in GCC error format.") do
+    options.gcc_output = true
+  end
+  
+  opts.on("--aggregate FILE", "Aggregate data from previous runs",
+          "in FILE. Overwrites FILE with the",
+          "merged data. FILE is created if",
+          "necessary.") do |file|
+    options.aggregate_file = file
+  end
+  
+  opts.on("-D [FILE]", "--text-coverage-diff [FILE]",
+          "Compare code coverage with saved state",
+          "in FILE, defaults to coverage.info.",
+          "Implies --comments.") do |file|
+    options.textmode = :coverage_diff
+    options.comments_run_by_default = true
+    if options.coverage_diff_save
+      raise "You shouldn't use --save and --text-coverage-diff at a time."
+    end
+    options.coverage_diff_mode = :compare
+    options.coverage_diff_file = file if file && !file.empty?
+  end
+  
+  opts.on("--save [FILE]", "Save coverage data to FILE,", "for later use with rcov -D.", "(default: coverage.info)") do |file|
+    options.coverage_diff_save = true
+    options.coverage_diff_mode = :record
+    if options.textmode == :coverage_diff
+      raise "You shouldn't use --save and --text-coverage-diff at a time."
+    end
+    options.coverage_diff_file = file if file && !file.empty?
+  end
+  
+  opts.on("--[no-]html", "Generate HTML output.", "(default: --html)") do |val|
+    options.html = val
+  end
+  
+  opts.on("--sort CRITERION", [:name, :loc, :coverage], "Sort files in the output by the specified", "field (name, loc, coverage)") do |criterion|
+    options.sort = criterion
+  end
+  
+  opts.on("--sort-reverse", "Reverse files in the output.") do
+    options.sort_reverse = true
+  end
+  
+  opts.on("--threshold INT", "Only list files with coverage < INT %.", "(default: 101)") do |threshold|
+    begin
+      threshold = Integer(threshold)
+      raise if threshold <= 0 || threshold > 101
+    rescue Exception
+      raise OptionParser::InvalidArgument, threshold
+    end
+    options.output_threshold = threshold
+  end
+  
+  opts.on("--failure-threshold [INT]", "Fail if the coverage is below the threshold", "(default: 100)") do |threshold|
+    options.failure_threshold = (threshold || 100).to_i
+    options.textmode = :failure_report
+  end
 
-    opts.on("--only-uncovered", "Same as --threshold 100") do
-        options.output_threshold = 100
-    end
-    
-    opts.on("--replace-progname", "Replace $0 when loading the .rb files.") do
-        options.replace_prog_name = true
-    end
-    
-    opts.on("-w", "Turn warnings on (like ruby).") do
-        $VERBOSE = true
-    end
-    
-    opts.on("--no-rcovrt", "Do not use the optimized C runtime.", "(will run 30-300 times slower)") do 
-        $rcov_do_not_use_rcovrt = true
-    end
-    
-    opts.on("--diff-cmd PROGNAME", "Use PROGNAME for --text-coverage-diff.",
-            "(default: diff)") do |cmd|
-        options.diff_cmd = cmd
-    end
-    
-    opts.separator ""
-    
-    opts.on_tail("-h", "--help", "Show extended help message") do
-      require 'pp'
-      puts opts
-        puts <<EOF
+  opts.on("--charset CHARSET", "Charset used in Content-Type declaration of HTML reports.") do |c|
+    options.charset = c
+  end
+  
+  opts.on("--only-uncovered", "Same as --threshold 100") do
+    options.output_threshold = 100
+  end
+  
+  opts.on("--replace-progname", "Replace $0 when loading the .rb files.") do
+    options.replace_prog_name = true
+  end
+  
+  opts.on("-w", "Turn warnings on (like ruby).") do
+    $VERBOSE = true
+  end
+  
+  opts.on("--no-rcovrt", "Do not use the optimized C runtime.", "(will run 30-300 times slower)") do 
+    $rcov_do_not_use_rcovrt = true
+  end
+  
+  opts.on("--diff-cmd PROGNAME", "Use PROGNAME for --text-coverage-diff.",
+          "(default: diff)") do |cmd|
+    options.diff_cmd = cmd
+  end
+  
+  opts.separator ""
+  
+  opts.on_tail("-h", "--help", "Show extended help message") do
+    require 'pp'
+    puts opts
+    puts <<EOF
 
 Files matching any of the following regexps will be omitted in the report(s):
 #{PP.pp(options.skip, "").chomp}
 EOF
-      puts EXTRA_HELP
-      exit
-    end
-    
-    opts.on_tail("--report-cov-bug SELECTOR", "Report coverage analysis bug for the",
-                 "method specified by SELECTOR", "(format: Foo::Bar#method, A::B.method)") do |selector|
-        case selector
-        when /([^.]+)(#|\.)(.*)/ then options.report_cov_bug_for = selector
-        else
-            raise OptionParser::InvalidArgument, selector
-        end
-        options.textmode = nil
-        options.html = false
-        options.callsites = true
-    end
-    opts.on_tail("--version", "Show version") do
-        puts "rcov " + Rcov::VERSION + " " + Rcov::RELEASE_DATE
-        exit
-    end
+    puts EXTRA_HELP
+    exit
+  end
+  
+  opts.on_tail("--report-cov-bug SELECTOR", "Report coverage analysis bug for the",
+               "method specified by SELECTOR", "(format: Foo::Bar#method, A::B.method)") do |selector|
+    case selector
+    when /([^.]+)(#|\.)(.*)/ then options.report_cov_bug_for = selector
+    else
+      raise OptionParser::InvalidArgument, selector
+    end
+    options.textmode = nil
+    options.html = false
+    options.callsites = true
+  end
+  opts.on_tail("--version", "Show version") do
+    puts "rcov " + Rcov::VERSION + " " + Rcov::RELEASE_DATE
+    exit
+  end
 end
 
 $ORIGINAL_ARGV = ARGV.clone
@@ -370,7 +376,8 @@ make_formatter = lambda do |klass|
               :diff_cmd => options.diff_cmd,
               :comments_run_by_default => options.comments_run_by_default,
               :gcc_output => options.gcc_output,
-              :charset => options.charset
+              :charset => options.charset,
+              :failure_threshold => options.failure_threshold
              )
 end
 
@@ -385,7 +392,7 @@ end
 textual_formatters = { :counts => Rcov::FullTextReport, :coverage => Rcov::FullTextReport,
                       :gcc => Rcov::FullTextReport, :annotate => Rcov::RubyAnnotation,
                       :summary => Rcov::TextSummary, :report => Rcov::TextReport,
-                      :coverage_diff => Rcov::TextCoverageDiff }
+                      :coverage_diff => Rcov::TextCoverageDiff, :failure_report => Rcov::FailureReport }
 
 if textual_formatters[options.textmode]
   formatters << make_formatter[textual_formatters[options.textmode]]

data/lib/rcov/formatters/base_formatter.rb

@@ -10,6 +10,7 @@ module Rcov
 
     def initialize(opts = {})
       options = DEFAULT_OPTS.clone.update(opts)
+      @failure_threshold = options[:failure_threshold]
       @files = {}
       @ignore_files = options[:ignore]
       @dont_ignore_files = options[:dont_ignore]

data/lib/rcov/formatters/failure_report.rb

@@ -0,0 +1,12 @@
+module Rcov
+  class FailureReport < TextSummary # :nodoc:
+    def execute
+      puts summary
+      coverage = code_coverage * 100
+      if coverage < @failure_threshold
+        puts "You failed to satisfy the coverage theshold of #{@failure_threshold}%"
+        exit(1)
+      end
+    end
+  end
+end

data/lib/rcov/formatters/text_summary.rb

@@ -1,7 +1,5 @@
 module Rcov
-
   class TextSummary < BaseFormatter # :nodoc:
-
     def execute
       puts summary
     end
@@ -9,7 +7,5 @@ module Rcov
     def summary
       "%.1f%%   %d file(s)   %d Lines   %d LOC" % [code_coverage * 100, @files.size, num_lines, num_code_lines]
     end
-
   end
-
-end
+end

data/lib/rcov/formatters.rb

@@ -5,11 +5,9 @@ require 'rcov/formatters/text_report'
 require 'rcov/formatters/text_coverage_diff'
 require 'rcov/formatters/full_text_report'
 require 'rcov/formatters/html_coverage'
+require 'rcov/formatters/failure_report'
 
 module Rcov
-  
   module Formatters
-    
   end
-  
-end
+end

data/lib/rcov/version.rb

@@ -3,8 +3,8 @@
 # See LEGAL and LICENSE for licensing information.
 
 module Rcov
-  VERSION = "0.8.4.1"
-  RELEASE_DATE = "2009-07-31"
+  VERSION = "0.8.5"
+  RELEASE_DATE = "2009-08-07"
   RCOVRT_ABI = [2,0,0]
   UPSTREAM_URL = "http://github.com/relevance/rcov"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: relevance-rcov
 version: !ruby/object:Gem::Version 
-  version: 0.8.4.1
+  version: 0.8.5
 platform: ruby
 authors: 
 - Relevance
@@ -37,6 +37,7 @@ files:
 - lib/rcov/formatters/text_coverage_diff.rb
 - lib/rcov/formatters/text_report.rb
 - lib/rcov/formatters/text_summary.rb
+- lib/rcov/formatters/failure_report.rb
 - lib/rcov/templates/index.html.erb
 - lib/rcov/templates/detail.html.erb
 - lib/rcov/templates/screen.css