simplecov 0.4.2 → 0.5.2

data/lib/simplecov.rb

@@ -1,15 +1,13 @@
-require 'rubygems'
-
 #
 # Code coverage for ruby 1.9. Please check out README for a full introduction.
 #
 module SimpleCov
   # Indicates invalid coverage data
   class CoverageDataError < StandardError; end;
-  
+
   class << self
     attr_accessor :running#, :result # TODO: Remove result?
-    
+
     #
     # Sets up SimpleCov to run against your project.
     # You can optionally specify an adapter to use as well as configuration with a block:
@@ -29,7 +27,7 @@ module SimpleCov
     #
     def start(adapter=nil, &block)
       return false unless SimpleCov.usable?
-      
+
       require 'coverage'
       load_adapter(adapter) unless adapter.nil?
       Coverage.start
@@ -37,7 +35,7 @@ module SimpleCov
       @result = nil
       self.running = true
     end
-    
+
     #
     # Returns the result for the current coverage run, merging it across test suites
     # from cache using SimpleCov::ResultMerger if use_merging is activated (default)
@@ -55,7 +53,7 @@ module SimpleCov
     ensure
       self.running = false
     end
-    
+
     #
     # Applies the configured filters to the given array of SimpleCov::SourceFile items
     #
@@ -64,9 +62,9 @@ module SimpleCov
       filters.each do |filter|
         result = result.select {|source_file| filter.passes?(source_file) }
       end
-      result
+      SimpleCov::FileList.new result
     end
-    
+
     #
     # Applies the configured groups to the given array of SimpleCov::SourceFile items
     #
@@ -74,22 +72,22 @@ module SimpleCov
       grouped = {}
       grouped_files = []
       groups.each do |name, filter|
-        grouped[name] = files.select {|source_file| !filter.passes?(source_file)}
+        grouped[name] = SimpleCov::FileList.new(files.select {|source_file| !filter.passes?(source_file)})
         grouped_files += grouped[name]
       end
       if groups.length > 0 and (other_files = files.reject {|source_file| grouped_files.include?(source_file)}).length > 0
-        grouped["Ungrouped"] = other_files
+        grouped["Ungrouped"] = SimpleCov::FileList.new(other_files)
       end
       grouped
     end
-    
-    # 
+
+    #
     # Applies the adapter of given name on SimpleCov configuration
     #
     def load_adapter(name)
       adapters.load(name)
     end
-    
+
     #
     # Checks whether we're on a proper version of ruby (1.9+) and returns false if this is not the case,
     # also printing an appropriate warning
@@ -110,6 +108,7 @@ require 'simplecov/configuration'
 SimpleCov.send :extend, SimpleCov::Configuration
 require 'simplecov/adapters'
 require 'simplecov/source_file'
+require 'simplecov/file_list'
 require 'simplecov/result'
 require 'simplecov/filter'
 require 'simplecov/formatter'
@@ -118,19 +117,5 @@ require 'simplecov/result_merger'
 require 'simplecov/command_guesser'
 require 'simplecov/version'
 
-# Load formatter gem
-require 'simplecov-html'
-
-# Default configuration
-SimpleCov.configure do
-  formatter SimpleCov::Formatter::HTMLFormatter
-  # Exclude files outside of SimpleCov.root
-  load_adapter 'root_filter'
-end
-
-at_exit do
-  # Store the exit status of the test run since it goes away after calling the at_exit proc...
-  @exit_status = $!.status if $!.is_a?(SystemExit)
-  SimpleCov.at_exit.call
-  exit @exit_status if @exit_status # Force exit with stored status (see github issue #5)
-end
+# Load default config
+require 'simplecov/defaults'

data/lib/simplecov/adapters.rb

@@ -1,12 +1,12 @@
 #
-# Adaptars are glorified SimpleCov configuration procs that can be easily 
+# Adapters are glorified SimpleCov configuration procs that can be easily
 # loaded using SimpleCov.start :rails and defined using
 #   SimpleCov.adapters.define :foo do
 #     # SimpleCov configuration here, same as in  SimpleCov.configure
 #   end
 #
 class SimpleCov::Adapters < Hash
-  # 
+  #
   # Define a SimpleCov adapter:
   #   SimpleCov.adapters.define 'rails' do
   #     # Same as SimpleCov.configure do .. here
@@ -17,7 +17,7 @@ class SimpleCov::Adapters < Hash
     raise "SimpleCov Adapter '#{name}' is already defined" unless self[name].nil?
     self[name] = blk
   end
-  
+
   #
   # Applies the adapter of given name on SimpleCov.configure
   #
@@ -27,26 +27,3 @@ class SimpleCov::Adapters < Hash
     SimpleCov.configure(&self[name])
   end
 end
-
-SimpleCov.adapters.define 'root_filter' do
-  # Exclude all files outside of simplecov root
-  add_filter do |src|
-    !(src.filename =~ /^#{SimpleCov.root}/)
-  end
-end
-
-SimpleCov.adapters.define 'rails' do
-  add_filter '/test/'
-  add_filter '/features/'
-  add_filter '/spec/'
-  add_filter '/config/'
-  add_filter '/db/'
-  add_filter '/autotest/'
-  add_filter '/vendor/bundle/'
-  
-  add_group 'Controllers', 'app/controllers'
-  add_group 'Models', 'app/models'
-  add_group 'Helpers', 'app/helpers'
-  add_group 'Libraries', 'lib'
-  add_group 'Plugins', 'vendor/plugins'
-end

data/lib/simplecov/command_guesser.rb

@@ -12,10 +12,10 @@ module SimpleCov::CommandGuesser
         "Unit Tests"
       when /cucumber/, /features/
         "Cucumber Features"
-      when /#{'spec/'}/
+      when /spec/
         "RSpec"
       else
         return command
     end
   end
-end
+end

data/lib/simplecov/configuration.rb

@@ -6,7 +6,7 @@ require 'fileutils'
 #
 module SimpleCov::Configuration
   attr_writer :filters, :groups, :formatter
-  
+
   #
   # The root for the project. This defaults to the
   # current working directory.
@@ -17,7 +17,7 @@ module SimpleCov::Configuration
     return @root if @root and root.nil?
     @root = File.expand_path(root || Dir.getwd)
   end
-  
+
   #
   # The name of the output and cache directory. Defaults to 'coverage'
   #
@@ -27,7 +27,7 @@ module SimpleCov::Configuration
     return @coverage_dir if @coverage_dir and dir.nil?
     @coverage_dir = (dir || 'coverage')
   end
-  
+
   #
   # Returns the full path to the output directory using SimpleCov.root
   # and SimpleCov.coverage_dir, so you can adjust this by configuring those
@@ -38,14 +38,14 @@ module SimpleCov::Configuration
     FileUtils.mkdir_p coverage_path
     coverage_path
   end
-  
-  # 
+
+  #
   # Returns the list of configured filters. Add filters using SimpleCov.add_filter.
   #
   def filters
     @filters ||= []
   end
-  
+
   # The name of the command (a.k.a. Test Suite) currently running. Used for result
   # merging and caching. It first tries to make a guess based upon the command line
   # arguments the current test suite is running on and should automatically detect
@@ -60,7 +60,7 @@ module SimpleCov::Configuration
     @name ||= SimpleCov::CommandGuesser.guess("#{$0} #{ARGV.join(" ")}")
     @name
   end
-  
+
   #
   # Gets or sets the configured formatter.
   #
@@ -72,21 +72,21 @@ module SimpleCov::Configuration
     raise "No formatter configured. Please specify a formatter using SimpleCov.formatter = SimpleCov::Formatter::SimpleFormatter" unless @formatter
     @formatter
   end
-  
+
   #
   # Returns the configured groups. Add groups using SimpleCov.add_group
   #
   def groups
     @groups ||= {}
   end
-  
+
   #
   # Returns the hash of available adapters
   #
   def adapters
     @adapters ||= SimpleCov::Adapters.new
   end
-  
+
   #
   # Allows you to configure simplecov in a block instead of prepending SimpleCov to all config methods
   # you're calling.
@@ -102,7 +102,7 @@ module SimpleCov::Configuration
     return false unless SimpleCov.usable?
     instance_exec(&block)
   end
-  
+
   #
   # Gets or sets the behavior to process coverage results.
   #
@@ -119,7 +119,7 @@ module SimpleCov::Configuration
     @at_exit = block if block_given?
     @at_exit ||= Proc.new { SimpleCov.result.format! }
   end
-  
+
   #
   # Returns the project name - currently assuming the last dirname in
   # the SimpleCov.root is this.
@@ -129,7 +129,7 @@ module SimpleCov::Configuration
     @project_name = new_name if new_name.kind_of?(String)
     @project_name ||= File.basename(root.split('/').last).capitalize.gsub('_', ' ')
   end
-  
+
   #
   # Defines whether to use result merging so all your test suites (test:units, test:functionals, cucumber, ...)
   # are joined and combined into a single coverage report
@@ -138,10 +138,10 @@ module SimpleCov::Configuration
     @use_merging = use unless use.nil? # Set if param given
     @use_merging = true if @use_merging != false
   end
-  
+
   #
   # Defines them maximum age (in seconds) of a resultset to still be included in merged results.
-  # i.e. If you run cucumber features, then later rake test, if the stored cucumber resultset is 
+  # i.e. If you run cucumber features, then later rake test, if the stored cucumber resultset is
   # more seconds ago than specified here, it won't be taken into account when merging (and is also
   # purged from the resultset cache)
   #
@@ -155,11 +155,11 @@ module SimpleCov::Configuration
     @merge_timeout = seconds if !seconds.nil? and seconds.kind_of?(Fixnum)
     @merge_timeout ||= 600
   end
-  
+
   #
   # Add a filter to the processing chain.
   # There are three ways to define a filter:
-  # 
+  #
   # * as a String that will then be matched against all source files' file paths,
   #   SimpleCov.add_filter 'app/models' # will reject all your models
   # * as a block which will be passed the source file in question and should either
@@ -173,7 +173,7 @@ module SimpleCov::Configuration
   def add_filter(filter_argument=nil, &filter_proc)
     filters << parse_filter(filter_argument, &filter_proc)
   end
-  
+
   #
   # Define a group for files. Works similar to add_filter, only that the first
   # argument is the desired group name and files PASSING the filter end up in the group
@@ -182,7 +182,7 @@ module SimpleCov::Configuration
   def add_group(group_name, filter_argument=nil, &filter_proc)
     groups[group_name] = parse_filter(filter_argument, &filter_proc)
   end
-  
+
   #
   # The actal filter processor. Not meant for direct use
   #
@@ -195,6 +195,6 @@ module SimpleCov::Configuration
       SimpleCov::BlockFilter.new(filter_proc)
     else
       raise ArgumentError, "Please specify either a string or a block to filter with"
-    end      
+    end
   end
-end
+end

data/lib/simplecov/defaults.rb

@@ -0,0 +1,48 @@
+# Load default formatter gem
+require 'simplecov-html'
+
+SimpleCov.adapters.define 'root_filter' do
+  # Exclude all files outside of simplecov root
+  add_filter do |src|
+    !(src.filename =~ /^#{SimpleCov.root}/)
+  end
+end
+
+SimpleCov.adapters.define 'test_frameworks' do
+  add_filter '/test/'
+  add_filter '/features/'
+  add_filter '/spec/'
+  add_filter '/autotest/'
+end
+
+SimpleCov.adapters.define 'rails' do
+  load_adapter 'test_frameworks'
+
+  add_filter '/config/'
+  add_filter '/db/'
+  add_filter '/vendor/bundle/'
+
+  add_group 'Controllers', 'app/controllers'
+  add_group 'Models', 'app/models'
+  add_group 'Helpers', 'app/helpers'
+  add_group 'Libraries', 'lib'
+  add_group 'Plugins', 'vendor/plugins'
+end
+
+# Default configuration
+SimpleCov.configure do
+  formatter SimpleCov::Formatter::HTMLFormatter
+  # Exclude files outside of SimpleCov.root
+  load_adapter 'root_filter'
+end
+
+at_exit do
+  # Store the exit status of the test run since it goes away after calling the at_exit proc...
+  @exit_status = $!.status if $!.is_a?(SystemExit)
+  SimpleCov.at_exit.call
+  exit @exit_status if @exit_status # Force exit with stored status (see github issue #5)
+end
+
+# Autoload config from .simplecov if present
+config_path = File.join(SimpleCov.root, '.simplecov')
+load config_path if File.exist?(config_path)

data/lib/simplecov/file_list.rb

@@ -0,0 +1,44 @@
+# An array of SimpleCov SourceFile instances with additional collection helper
+# methods for calculating coverage across them etc.
+class SimpleCov::FileList < Array
+  # Returns the count of lines that have coverage
+  def covered_lines
+    return 0.0 if empty?
+    map {|f| f.covered_lines.count }.inject(&:+)
+  end
+
+  # Returns the count of lines that have been missed
+  def missed_lines
+    return 0.0 if empty?
+    map {|f| f.missed_lines.count }.inject(&:+)
+  end
+
+  # Returns the count of lines that are not relevant for coverage
+  def never_lines
+    return 0.0 if empty?
+    map {|f| f.never_lines.count }.inject(&:+)
+  end
+
+  # Returns the count of skipped lines
+  def skipped_lines
+    return 0.0 if empty?
+    map {|f| f.skipped_lines.count }.inject(&:+)
+  end
+
+  # Returns the overall amount of relevant lines of code across all files in this list
+  def lines_of_code
+    covered_lines + missed_lines
+  end
+
+  # Computes the coverage based upon lines covered and lines missed
+  def covered_percent
+    return 100.0 if empty? or lines_of_code == 0
+    covered_lines * 100.0 / lines_of_code
+  end
+
+  # Computes the strength (hits / line) based upon lines covered and lines missed
+  def covered_strength
+    return 0 if empty? or lines_of_code == 0
+    map {|f| f.covered_strength }.inject(&:+) / size
+  end
+end

data/lib/simplecov/filter.rb

@@ -2,7 +2,7 @@ module SimpleCov
   #
   # Base filter class. Inherit from this to create custom filters,
   # and overwrite the passes?(source_file) instance method
-  # 
+  #
   # # A sample class that rejects all source files.
   # class StupidFilter < SimpleCov::Filter
   #   def passes?(source_file)
@@ -15,12 +15,12 @@ module SimpleCov
     def initialize(filter_argument)
       @filter_argument = filter_argument
     end
-    
+
     def passes?(source_file)
       raise "The base filter class is not intended for direct use"
     end
   end
-  
+
   class StringFilter < SimpleCov::Filter
     # Returns true when the given source file's filename matches the
     # string configured when initializing this Filter with StringFilter.new('somestring)
@@ -28,7 +28,7 @@ module SimpleCov
       !(source_file.filename =~ /#{filter_argument}/)
     end
   end
-  
+
   class BlockFilter < SimpleCov::Filter
     # Returns true if the block given when initializing this filter with BlockFilter.new {|src_file| ... }
     # returns true for the given source file.
@@ -36,4 +36,4 @@ module SimpleCov
       !filter_argument.call(source_file)
     end
   end
-end
+end