simplecov 0.6.2 → 0.7.0

data/lib/simplecov/configuration.rb

@@ -14,7 +14,7 @@ module SimpleCov::Configuration
   # Configure with SimpleCov.root('/my/project/path')
   #
   def root(root=nil)
-    return @root if @root and root.nil?
+    return @root if defined? @root and root.nil?
     @root = File.expand_path(root || Dir.getwd)
   end
 
@@ -24,7 +24,7 @@ module SimpleCov::Configuration
   # Configure with SimpleCov.coverage_dir('cov')
   #
   def coverage_dir(dir=nil)
-    return @coverage_dir if @coverage_dir and dir.nil?
+    return @coverage_dir if defined? @coverage_dir and dir.nil?
     @coverage_dir = (dir || 'coverage')
   end
 
@@ -60,14 +60,14 @@ module SimpleCov::Configuration
     @name ||= SimpleCov::CommandGuesser.guess
     @name
   end
-  
+
   #
   # Gets or sets the configured formatter.
   #
   # Configure with: SimpleCov.formatter(SimpleCov::Formatter::SimpleFormatter)
   #
   def formatter(formatter=nil)
-    return @formatter if @formatter and formatter.nil?
+    return @formatter if defined? @formatter and formatter.nil?
     @formatter = formatter
     raise "No formatter configured. Please specify a formatter using SimpleCov.formatter = SimpleCov::Formatter::SimpleFormatter" unless @formatter
     @formatter
@@ -81,7 +81,7 @@ module SimpleCov::Configuration
   # Configure with SimpleCov.nocov_token('skip') or it's alias SimpleCov.skip_token('skip')
   #
   def nocov_token(nocov_token=nil)
-    return @nocov_token if @nocov_token and nocov_token.nil?
+    return @nocov_token if defined? @nocov_token and nocov_token.nil?
     @nocov_token = (nocov_token || 'nocov')
   end
   alias_method :skip_token, :nocov_token
@@ -108,7 +108,7 @@ module SimpleCov::Configuration
   #   add_filter 'foobar'
   # end
   #
-  # This is equivalent to SimpleCov.add_filter 'foobar' and thus makes it easier to set a buchn of configure
+  # This is equivalent to SimpleCov.add_filter 'foobar' and thus makes it easier to set a bunch of configure
   # options at once.
   #
   def configure(&block)
@@ -138,7 +138,7 @@ module SimpleCov::Configuration
   # the SimpleCov.root is this.
   #
   def project_name(new_name=nil)
-    return @project_name if @project_name and new_name.nil?
+    return @project_name if defined? @project_name and @project_name and new_name.nil?
     @project_name = new_name if new_name.kind_of?(String)
     @project_name ||= File.basename(root.split('/').last).capitalize.gsub('_', ' ')
   end
@@ -148,8 +148,8 @@ module SimpleCov::Configuration
   # are joined and combined into a single coverage report
   #
   def use_merging(use=nil)
-    @use_merging = use unless use.nil? # Set if param given
-    @use_merging = true if @use_merging != false
+    @use_merging = use unless use.nil?
+    @use_merging = true unless defined? @use_merging and @use_merging == false
   end
 
   #
@@ -165,10 +165,38 @@ module SimpleCov::Configuration
   # Configure with SimpleCov.merge_timeout(3600) # 1hr
   #
   def merge_timeout(seconds=nil)
-    @merge_timeout = seconds if !seconds.nil? and seconds.kind_of?(Fixnum)
+    @merge_timeout = seconds if seconds.kind_of?(Fixnum)
     @merge_timeout ||= 600
   end
 
+  #
+  # Defines the minimum overall coverage required for the testsuite to pass.
+  # SimpleCov will return non-zero if the current coverage is below this threshold.
+  #
+  # Default is 0% (disabled)
+  #
+  def minimum_coverage(coverage=nil)
+    @minimum_coverage ||= (coverage || 0).to_f.round(2)
+  end
+
+  #
+  # Defines the maximum coverage drop at once allowed for the testsuite to pass.
+  # SimpleCov will return non-zero if the coverage decreases by more than this threshold.
+  #
+  # Default is 100% (disabled)
+  #
+  def maximum_coverage_drop(coverage_drop=nil)
+    @maximum_coverage_drop ||= (coverage_drop || 100).to_f.round(2)
+  end
+
+  #
+  # Refuses any coverage drop. That is, coverage is only allowed to increase.
+  # SimpleCov will return non-zero if the coverage decreases.
+  #
+  def refuse_coverage_drop
+    maximum_coverage_drop 0
+  end
+
   #
   # Add a filter to the processing chain.
   # There are three ways to define a filter:
@@ -195,7 +223,7 @@ module SimpleCov::Configuration
   def add_group(group_name, filter_argument=nil, &filter_proc)
     groups[group_name] = parse_filter(filter_argument, &filter_proc)
   end
-  
+
   private
 
   #

data/lib/simplecov/defaults.rb

@@ -46,9 +46,38 @@ at_exit do
     #if it was a SystemExit, use the accompanying status
     #otherwise set a non-zero status representing termination by some other exception
     #(see github issue 41)
-    @exit_status = $!.is_a?(SystemExit) ? $!.status : 1
+    @exit_status = $!.is_a?(SystemExit) ? $!.status : SimpleCov::ExitCodes::EXCEPTION
   end
+
   SimpleCov.at_exit.call
+
+  if SimpleCov.result? # Result has been computed
+    covered_percent = SimpleCov.result.covered_percent.round(2)
+
+    if @exit_status.to_i == 0 # No other errors
+      @exit_status = if covered_percent < SimpleCov.minimum_coverage
+        $stderr.puts "Coverage (%.2f%%) is below the expected minimum coverage (%.2f%%)." % \
+                     [covered_percent, SimpleCov.minimum_coverage]
+
+        SimpleCov::ExitCodes::MINIMUM_COVERAGE
+
+      elsif (last_run = SimpleCov::LastRun.read)
+        diff = last_run['result']['covered_percent'] - covered_percent
+        if diff > SimpleCov.maximum_coverage_drop
+          $stderr.puts "Coverage has dropped by %.2f%% since the last time (maximum allowed: %.2f%%)." % \
+                       [diff, SimpleCov.maximum_coverage_drop]
+
+          SimpleCov::ExitCodes::MAXIMUM_COVERAGE_DROP
+        end
+      end
+    end
+
+    metrics = {
+      :result => { :covered_percent => covered_percent }
+    }
+    SimpleCov::LastRun.write(metrics)
+  end
+
   exit @exit_status if @exit_status # Force exit with stored status (see github issue #5)
 end
 

data/lib/simplecov/exit_codes.rb

@@ -0,0 +1,5 @@
+module SimpleCov::ExitCodes
+  EXCEPTION = 1
+  MINIMUM_COVERAGE = 2
+  MAXIMUM_COVERAGE_DROP = 3
+end

data/lib/simplecov/formatter/multi_formatter.rb

@@ -0,0 +1,25 @@
+class SimpleCov::Formatter::MultiFormatter
+  def self.[](*args)
+    Class.new(self) do
+      define_method :formatters do
+        @formatters ||= args
+      end
+    end
+  end
+
+  def format(result)
+    formatters.map do |formatter|
+      begin
+        formatter.new.format(result)
+      rescue => e
+        STDERR.puts("Formatter #{formatter} failed with #{e.class}: #{e.message} (#{e.backtrace.first})")
+        nil
+      end
+    end
+  end
+
+  def formatters
+    @formatters ||= []
+  end
+
+end

data/lib/simplecov/formatter.rb

@@ -5,3 +5,4 @@ module SimpleCov
 end
 
 require 'simplecov/formatter/simple_formatter'
+require 'simplecov/formatter/multi_formatter'

data/lib/simplecov/json.rb

@@ -0,0 +1,27 @@
+require 'multi_json'
+
+module SimpleCov::JSON
+  class << self
+    def parse(json)
+      # Detect and use available MultiJson API - it changed in v1.3
+      if MultiJson.respond_to?(:adapter)
+        MultiJson.load(json)
+      else
+        MultiJson.decode(json)
+      end
+    end
+
+    def dump(string)
+      if defined? ::JSON
+        ::JSON.pretty_generate(string)
+      else
+        # Detect and use available MultiJson API - it changed in v1.3
+        if MultiJson.respond_to?(:adapter)
+          MultiJson.dump(string)
+        else
+          MultiJson.encode(string)
+        end
+      end
+    end
+  end
+end

data/lib/simplecov/last_run.rb

@@ -0,0 +1,20 @@
+module SimpleCov::LastRun
+  class << self
+    def last_run_path
+      File.join(SimpleCov.coverage_path, '.last_run.json')
+    end
+
+    def read
+      return nil unless File.exist?(last_run_path)
+
+      SimpleCov::JSON.parse(File.read(last_run_path))
+    end
+
+    def write(json)
+      File.open(last_run_path, "w+") do |f|
+        f.puts SimpleCov::JSON.dump(json)
+      end
+    end
+  end
+end
+

data/lib/simplecov/result.rb

@@ -44,6 +44,7 @@ module SimpleCov
 
     # The multiple of coverage for this result
     def covered_strength
+      return 0 if total_lines.zero?
       return @covered_strength if @covered_strength
       m = 0
       @files.each do |file|
@@ -58,7 +59,7 @@ module SimpleCov
 
     # Returns the count of lines that are covered
     def covered_lines
-      return @covered_lines if @covered_lines
+      return @covered_lines if defined? @covered_lines
       @covered_lines = 0
       @files.each do |file|
         original_result[file.filename].each do |line_result|
@@ -70,7 +71,7 @@ module SimpleCov
 
     # Returns the count of missed lines
     def missed_lines
-      return @missed_lines if @missed_lines
+      return @missed_lines if defined? @missed_lines
       @missed_lines = 0
       @files.each do |file|
         original_result[file.filename].each do |line_result|

data/lib/simplecov/result_merger.rb

@@ -1,5 +1,3 @@
-require 'multi_json'
-
 #
 # Singleton that is responsible for caching, loading and merging
 # SimpleCov::Results into a single result for coverage analysis based
@@ -7,7 +5,7 @@ require 'multi_json'
 #
 module SimpleCov::ResultMerger
   class << self
-    # The path to the resultset.yml cache file
+    # The path to the .resultset.json cache file
     def resultset_path
       File.join(SimpleCov.coverage_path, '.resultset.json')
     end
@@ -15,7 +13,7 @@ module SimpleCov::ResultMerger
     # Loads the cached resultset from YAML and returns it as a Hash
     def resultset
       if stored_data
-        MultiJson.load(stored_data)
+        SimpleCov::JSON.parse(stored_data)
       else
         {}
       end
@@ -68,11 +66,7 @@ module SimpleCov::ResultMerger
       command_name, data = result.to_hash.first
       new_set[command_name] = data
       File.open(resultset_path, "w+") do |f|
-        if defined? ::JSON
-          f.puts JSON.pretty_generate(new_set)
-        else
-          f.puts MultiJson.dump(new_set)
-        end
+        f.puts SimpleCov::JSON.dump(new_set)
       end
       true
     end

data/lib/simplecov/source_file.rb

@@ -30,6 +30,7 @@ module SimpleCov
         raise ArgumentError, "Only Fixnum and nil accepted for coverage" unless coverage.kind_of?(Fixnum) or coverage.nil?
         @src, @line_number, @coverage = src, line_number, coverage
         @skipped = false
+        @src.encode!('UTF-8', 'UTF-8', :invalid => :replace) if @src.respond_to?(:encode!)
       end
 
       # Returns true if this is a line that should have been covered, but was not
@@ -84,7 +85,7 @@ module SimpleCov
     # Returns all source lines for this file as instances of SimpleCov::SourceFile::Line,
     # and thus including coverage data. Aliased as :source_lines
     def lines
-      return @lines unless @lines.nil?
+      return @lines if defined? @lines
 
       # Warning to identify condition from Issue #56
       if coverage.size > src.size
@@ -109,18 +110,30 @@ module SimpleCov
     # The coverage for this file in percent. 0 if the file has no relevant lines
     def covered_percent
       return 100.0 if lines.length == 0 or lines.length == never_lines.count
-      (covered_lines.count) * 100 / (lines.count - never_lines.count - skipped_lines.count).to_f
+      relevant_lines = lines.count - never_lines.count - skipped_lines.count
+      if relevant_lines == 0
+        0
+      else
+        (covered_lines.count) * 100 / relevant_lines.to_f
+      end
     end
 
     def covered_strength
       return 0 if lines.length == 0 or lines.length == never_lines.count
+
       lines_strength = 0
       lines.each do |c|
         lines_strength += c.coverage if c.coverage
       end
+
       effective_lines_count = (lines.count - never_lines.count - skipped_lines.count).to_f
-      strength = lines_strength / effective_lines_count
-      round_float(strength, 1)
+
+      if effective_lines_count == 0
+        0
+      else
+        strength = lines_strength / effective_lines_count
+        round_float(strength, 1)
+      end
     end
 
     # Returns all covered lines as SimpleCov::SourceFile::Line
@@ -172,3 +185,4 @@ module SimpleCov
     end
   end
 end
+

data/lib/simplecov/version.rb

@@ -1,3 +1,3 @@
 module SimpleCov
-  VERSION = "0.6.2"
+  VERSION = "0.7.0"
 end

data/lib/simplecov.rb

@@ -48,12 +48,20 @@ module SimpleCov
         SimpleCov::ResultMerger.store_result(@result) if @result
         return SimpleCov::ResultMerger.merged_result
       else
-        return @result
+        return @result if defined? @result
       end
     ensure
       self.running = false
     end
 
+    #
+    # Returns nil if the result has not been computed
+    # Otherwise, returns the result
+    #
+    def result?
+      defined? @result and @result
+    end
+
     #
     # Applies the configured filters to the given array of SimpleCov::SourceFile items
     #
@@ -105,12 +113,15 @@ end
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__)))
 require 'simplecov/configuration'
 SimpleCov.send :extend, SimpleCov::Configuration
+require 'simplecov/exit_codes'
+require 'simplecov/json'
 require 'simplecov/adapters'
 require 'simplecov/source_file'
 require 'simplecov/file_list'
 require 'simplecov/result'
 require 'simplecov/filter'
 require 'simplecov/formatter'
+require 'simplecov/last_run'
 require 'simplecov/merge_helpers'
 require 'simplecov/result_merger'
 require 'simplecov/command_guesser'

data/simplecov.gemspec

@@ -12,10 +12,11 @@ Gem::Specification.new do |gem|
   gem.description = %Q{Code coverage for Ruby 1.9 with a powerful configuration library and automatic merging of coverage across test suites}
   gem.summary     = gem.description
 
-  gem.add_dependency 'multi_json', '~> 1.3'
-  gem.add_dependency 'simplecov-html', '~> 0.5.3'
+  gem.add_dependency 'multi_json', '~> 1.0'
+  gem.add_dependency 'simplecov-html', '~> 0.7.0'
   gem.add_development_dependency 'aruba'
   gem.add_development_dependency 'capybara'
+  gem.add_development_dependency 'appraisal'
   gem.add_development_dependency 'cucumber', '>= 1.1.4'
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec'

data/test/fixtures/iso-8859.rb

@@ -0,0 +1,3 @@
+
+# localized to Espa�ol thus:
+

data/test/fixtures/sample.rb

@@ -10,7 +10,7 @@ class Foo
 
   #:nocov:
   def skipped
-	@foo * 2
+    @foo * 2
   end
   #:nocov:
 end

data/test/test_result.rb

@@ -21,7 +21,7 @@ class TestResult < Test::Unit::TestCase
 
         should "have 3 source files" do
           assert_equal 3, @result.source_files.count
-          assert @result.source_files.all? {|s| s.instance_of?(SimpleCov::SourceFile)}, "Not alL instances are of SimpleCov::SourceFile type"
+          assert @result.source_files.all? {|s| s.instance_of?(SimpleCov::SourceFile)}, "Not all instances are of SimpleCov::SourceFile type"
         end
 
         should "return an instance of SimpleCov::FileList for source_files and files" do
@@ -111,6 +111,21 @@ class TestResult < Test::Unit::TestCase
             assert_equal String, @result.format!.class
           end
         end
+
+        context "and multi formatter being used" do
+          setup do
+            SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+              SimpleCov::Formatter::SimpleFormatter,
+              SimpleCov::Formatter::SimpleFormatter,
+            ]
+          end
+
+          should "return an array containing formatted string with result.format!" do
+            formated = @result.format!
+            assert_equal 2, formated.count
+            assert_equal String, formated.first.class
+          end
+        end
       end
 
       context "with groups set up that do not match all files" do

data/test/test_source_file.rb

@@ -68,7 +68,7 @@ class TestSourceFile < Test::Unit::TestCase
           @source_file.lines
         end
 
-        assert_match /^Warning: coverage data provided/, captured_output
+        assert_match(/^Warning: coverage data provided/, captured_output)
       end
     end
 
@@ -80,7 +80,16 @@ class TestSourceFile < Test::Unit::TestCase
           source_file.process_skipped_lines!
         end
       end
+
+      should "handle iso-8859 encoded source files" do
+        source_file = SimpleCov::SourceFile.new(source_fixture('iso-8859.rb'), [nil, nil, 1])
+
+        assert_nothing_raised do
+          source_file.process_skipped_lines!
+        end
+      end
     end
 
   end
 end
+