simplecov 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
---- 
-SHA512: 
-  metadata.gz: 48711e9d1476719d339f0086b8f35b64be59364bbbf5c0d3c767c56a7857dd1afa576b05278a1c74aa8a346d97817676eef1d48f3f10ec1e8b4e452fc4445f56
-  data.tar.gz: 88dad87cce15389b66baa7d2bb73f675fe168e2dd4168fef863310b053cf989a10a1fdced39b2d10616e8187c48d342236da8e0e17e915d34b4588da949737a2
-SHA1: 
-  metadata.gz: ce56b638173500ad25afd14ce524ff192753fc7e
-  data.tar.gz: 5279e97dae54994a96c976917ce820c5af60cbcb
+---
+SHA1:
+  metadata.gz: bcd3fcd0c8e30121cc9f50e81b8b756f1153e8a3
+  data.tar.gz: 58d53aacce8c59039020aa58c651c6c66b04c414
+SHA512:
+  metadata.gz: 8edc40314d68f3964d6cdba4d99a9afb07f15e7bafdc5ecccdeda85ce2d662ff5016ccc0b5e78edf5668ca40c92bf168d2f3b031ca08b541a18f15d717354f69
+  data.tar.gz: 60b3f714f8701072f44186639a4915aae3b8fdd8341e31ad41b2bde07961917052c012106fccad8b2a54ced75be9f84f7f1f743b3ef64a7b7bd0671c906eea83

data/.rspec

@@ -1 +1,3 @@
---require rspec/legacy_formatters
+--color
+--order random
+--warning

data/.rubocop.yml

@@ -1,13 +1,13 @@
 AllCops:
   Exclude:
-    - 'test/fixtures/iso-8859.rb'
+    - 'spec/fixtures/iso-8859.rb'
     - 'tmp/**/*'
     - 'vendor/bundle/**/*'
 
 Lint/AmbiguousRegexpLiteral:
   Exclude:
     - 'features/**/*_steps.rb'
-    - 'test/**/*_steps.rb'
+    - 'spec/**/*_steps.rb'
     - 'tmp/**/*_steps.rb'
 
 Metrics/AbcSize:
@@ -55,15 +55,16 @@ Style/SpaceInsideHashLiteralBraces:
 
 Style/SpecialGlobalVars:
   Exclude:
-    - 'test/test_deleted_source.rb'
-    - 'test/test_return_codes.rb'
+    - 'spec/deleted_source_spec.rb'
+    - 'spec/return_codes_spec.rb'
+    - 'lib/simplecov/defaults.rb'
 
 Style/StringLiterals:
   EnforcedStyle: double_quotes
 
 Style/FileName:
   Exclude:
-    - 'test/fixtures/utf-8.rb'
+    - 'spec/fixtures/utf-8.rb'
 
 Style/TrailingComma:
   EnforcedStyleForMultiline: 'comma'

data/CHANGELOG.md

@@ -1,11 +1,25 @@
-Unreleased ([changes](https://github.com/colszowka/simplecov/compare/v0.10.0...master))
+Unreleased ([changes](https://github.com/colszowka/simplecov/compare/v0.11.0...master))
 =================
 
 ## Enhancements
 
 ## Bugfixes
 
-0.10.0 2015-04-18 ([changes](https://github.com/colszowka/simplecov/compare/v0.9.2...0.10.0))
+0.11.0 2015-11-29 ([changes](https://github.com/colszowka/simplecov/compare/v0.10.0...v0.10.11))
+=================
+
+## Enhancements
+
+* Added `SimpleCov.minimum_coverage_by_file` for per-file coverage thresholds. See [#392](https://github.com/colszowka/simplecov/pull/392) (thanks @ptashman)
+* Added `track_files` configuration option to specify a glob to always include in coverage results, whether or not those files are required. See [#422](https://github.com/colszowka/simplecov/pull/422) (thanks @hugopeixoto)
+* Speed up `root_filter` by an order of magnitude. See [#396](https://github.com/colszowka/simplecov/pull/396) (thanks @raszi)
+
+## Bugfixes
+
+* Fix warning about global variable `$ERROR_INFO`. See [#400](https://github.com/colszowka/simplecov/pull/400) (thanks @amatsuda)
+* Actually recurse upward looking for `.simplecov`, as claimed by the documentation, rather than only the working directory. See [#423](https://github.com/colszowka/simplecov/pull/423) (thanks @alexdowad)
+
+0.10.0 2015-04-18 ([changes](https://github.com/colszowka/simplecov/compare/v0.9.2...v0.10.0))
 =================
 
 ## Enhancements

data/Gemfile

@@ -9,26 +9,26 @@ source "https://rubygems.org"
 gem "rake", ">= 10.3"
 
 group :test do
+  gem "rspec", ">= 3.2"
   # Older versions of some gems required for Ruby 1.8.7 support
   platform :ruby_18 do
     gem "activesupport", "~> 3.2.21"
-    gem "shoulda-matchers", "~> 2.0.0"
     gem "i18n", "~> 0.6.11"
   end
-  gem "rubocop", ">= 0.30", :platforms => [:ruby_19, :ruby_20, :ruby_21, :ruby_22]
-  gem "minitest", ">= 5.5"
-  gem "rspec", ">= 3.0"
-  gem "rspec-legacy_formatters", ">= 1.0"
-  gem "shoulda", ">= 3.5"
-end
+  platform :jruby, :ruby_19, :ruby_20, :ruby_21, :ruby_22 do
+    gem "aruba", "~> 0.7.4"
+    gem "capybara", "~> 2.4"
+
+    # Hack until Capybara fixes its gemspec. 3.0 removed 1.9 support.
+    # See https://github.com/jnicklas/capybara/issues/1615
+    gem "mime-types", "~> 2.0.0"
 
-platform :jruby, :ruby_19, :ruby_20, :ruby_21, :ruby_22 do
-  gem "aruba", "~> 0.6"
-  gem "capybara", "~> 2.0.0"
-  gem "cucumber", "~> 2.0"
-  gem "phantomjs", "~> 1.9"
-  gem "poltergeist", "~> 1.1"
-  gem "test-unit", "~> 3.0"
+    gem "cucumber", "~> 2.0"
+    gem "phantomjs", "~> 1.9"
+    gem "poltergeist", "~> 1.1"
+    gem "rubocop", ">= 0.30"
+    gem "test-unit", "~> 3.0"
+  end
 end
 
 gemspec

data/README.md

@@ -145,8 +145,8 @@ to use SimpleCov with them. Here's an overview of the known ones:
     <td>
       As of 0.8.0, SimpleCov should correctly recognize parallel_tests and
       supplement your test suite names with their corresponding test env
-      numbers. Locking of the resultset cache should ensure no race conditions
-      occur when results are merged.
+      numbers. SimpleCov locks the resultset cache while merging, ensuring no
+      race conditions occur when results are merged.
     </td>
     <td>
       <a href="https://github.com/colszowka/simplecov/issues/64">#64</a> &amp;
@@ -391,17 +391,17 @@ There are two things to note here though:
 
 ### Test suite names
 
-SimpleCov tries to guess the name of the currently running test suite based upon the shell command the tests are running
-on. This should work fine for Unit Tests, RSpec, and Cucumber. If it fails, it will use the shell command
-that invoked the test suite as a command name.
+SimpleCov tries to guess the name of the currently running test suite based upon the shell command the tests
+are running on. This should work fine for Unit Tests, RSpec, and Cucumber. If it fails, it will use the shell
+command that invoked the test suite as a command name.
 
-If you have some non-standard setup and still want nicely labeled test suites, you have to give Simplecov a cue as to what the
-name of the currently running test suite is. You can do so by specifying `SimpleCov.command_name` in one test file that is
-part of your specific suite.
+If you have some non-standard setup and still want nicely labeled test suites, you have to give Simplecov a
+cue as to what the name of the currently running test suite is. You can do so by specifying
+`SimpleCov.command_name` in one test file that is part of your specific suite.
 
 To customize the suite names on a Rails app (yeah, sorry for being Rails-biased, but everyone knows what
-the structure of those projects is. You can apply this accordingly to the RSpecs in your Outlook-WebDAV-Calendar-Sync gem),
-you could do something like this:
+the structure of those projects is. You can apply this accordingly to the RSpecs in your
+Outlook-WebDAV-Calendar-Sync gem), you could do something like this:
 
 ```ruby
 # test/unit/some_test.rb
@@ -417,8 +417,8 @@ SimpleCov.command_name "test:integration"
 SimpleCov.command_name "features"
 ```
 
-Note that this only has to be invoked ONCE PER TEST SUITE, so even if you have 200 unit test files, specifying it in
-some_test.rb is enough.
+Note that this only has to be invoked ONCE PER TEST SUITE, so even if you have 200 unit test files,
+specifying it in `some_test.rb` is enough.
 
 Last but not least **if multiple suites resolve to the same `command_name`** be aware that the coverage results **will
 clobber each other instead of being merged**.  SimpleCov is smart enough to detect unique names for the most common
@@ -431,6 +431,14 @@ If you are relying on the default `command_name` then SimpleCov will attempt to
 parallel test runner does not set one or both of these then *you must* set a `command_name` and ensure that it is unique
 per process (eg. `command_name "Unit Tests PID #{$$}"`).
 
+If you are using parallel_tests, you must incorporate `TEST_ENV_NUMBER` into the command name yourself, in
+order for SimpleCov to merge the results correctly. For example:
+
+```ruby
+# spec/spec_helper.rb
+SimpleCov.command_name "features" + (ENV['TEST_ENV_NUMBER'] || '')
+```
+
 [simplecov-html] prints the used test suites in the footer of the generated coverage report.
 
 ### Timeout for merge
@@ -539,6 +547,14 @@ You can define the minimum coverage percentage expected. SimpleCov will return n
 SimpleCov.minimum_coverage 90
 ```
 
+### Minimum coverage by file
+
+You can define the minimum coverage by file percentage expected. SimpleCov will return non-zero if unmet. This is useful to help ensure coverage is relatively consistent, rather than being skewed by particularly good or bad areas of the code.
+
+```ruby
+SimpleCov.minimum_coverage_by_file 80
+```
+
 ### Maximum coverage drop
 
 You can define the maximum coverage drop percentage at once. SimpleCov will return non-zero if exceeded.

data/Rakefile

@@ -12,12 +12,9 @@ end
 # Enforce proper permissions on each build
 Rake::Task[:build].prerequisites.unshift :fix_permissions
 
-require "rake/testtask"
-Rake::TestTask.new(:test) do |test|
-  test.libs << "lib" << "test"
-  test.test_files = FileList["test/test_*.rb"]
-  test.verbose = true
-  test.warning = true
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList["spec/*_spec.rb"]
 end
 
 begin
@@ -33,7 +30,7 @@ end
 if RUBY_VERSION >= "1.9"
   require "cucumber/rake/task"
   Cucumber::Rake::Task.new
-  task :default => [:test, :cucumber, :rubocop]
+  task :default => [:spec, :cucumber, :rubocop]
 else
-  task :default => [:test]
+  task :default => [:spec]
 end

data/features/config_formatters.feature

@@ -30,7 +30,7 @@ Feature:
     Given SimpleCov for Test/Unit is configured with:
       """
       require 'simplecov'
-      SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+      SimpleCov.formatters = [
         SimpleCov::Formatter::SimpleFormatter,
         Class.new do
           def format(result)

data/features/config_tracked_files.feature

@@ -0,0 +1,29 @@
+@test_unit
+Feature:
+
+  Using the setting `tracked_files` should add files that were not
+  required to the report.
+
+  Scenario:
+    Given SimpleCov for Test/Unit is configured with:
+      """
+      require 'simplecov'
+      SimpleCov.start do
+        track_files "lib/**/*.rb"
+      end
+      """
+
+    When I open the coverage report generated with `bundle exec rake test`
+    Then I should see the groups:
+      | name      | coverage | files |
+      | All Files | 76.81%   | 7     |
+
+    And I should see the source files:
+      | name                                    | coverage |
+      | lib/faked_project.rb                    | 100.0 %  |
+      | lib/faked_project/untested_class.rb     | 0.0 %    |
+      | lib/faked_project/some_class.rb         | 80.0 %   |
+      | lib/faked_project/framework_specific.rb | 75.0 %   |
+      | lib/faked_project/meta_magic.rb         | 100.0 %  |
+      | test/meta_magic_test.rb                 | 100.0 %  |
+      | test/some_class_test.rb                 | 100.0 %  |

data/features/step_definitions/transformers.rb

@@ -8,6 +8,6 @@
 #
 Transform "bundle exec rspec spec" do |_|
   files = nil # Avoid shadowing
-  in_current_dir { files = Dir["spec/**/*_spec.rb"] }
+  in_current_directory { files = Dir["spec/**/*_spec.rb"] }
   "bundle exec rspec #{files.sort.join(' ')}"
 end

data/features/support/env.rb

@@ -8,7 +8,6 @@ Bundler.setup
 require "aruba/cucumber"
 require "aruba/jruby" if RUBY_ENGINE == "jruby"
 require "capybara/cucumber"
-require "minitest/autorun"
 require "phantomjs/poltergeist"
 
 # Fake rack app for capybara that just returns the latest coverage report from aruba temp project dir
@@ -24,6 +23,10 @@ Capybara.app = lambda { |env|
 
 Capybara.default_driver = Capybara.javascript_driver = :poltergeist
 
+Capybara.configure do |config|
+  config.ignore_hidden_elements = false
+end
+
 Before do
   # JRuby takes it's time... See https://github.com/cucumber/aruba/issues/134
   @aruba_timeout_seconds = RUBY_ENGINE == "jruby" ? 60 : 20
@@ -31,9 +34,9 @@ Before do
   this_dir = File.dirname(__FILE__)
 
   # Clean up and create blank state for fake project
-  in_current_dir do
+  in_current_directory do
     FileUtils.rm_rf "project"
-    FileUtils.cp_r File.join(this_dir, "../../test/faked_project/"), "project"
+    FileUtils.cp_r File.join(this_dir, "../../spec/faked_project/"), "project"
   end
 
   step 'I cd to "project"'

data/lib/simplecov.rb

@@ -48,12 +48,29 @@ module SimpleCov
       end
     end
 
+    #
+    # Finds files that were to be tracked but were not loaded and initializes
+    # their coverage to zero.
+    #
+    def add_not_loaded_files(result)
+      if @track_files_glob
+        result = result.dup
+        Dir[@track_files_glob].each do |file|
+          absolute = File.expand_path(file)
+
+          result[absolute] ||= [0] * File.foreach(absolute).count
+        end
+      end
+
+      result
+    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)
     #
     def result
-      @result ||= SimpleCov::Result.new(Coverage.result) if running
+      @result ||= SimpleCov::Result.new(add_not_loaded_files(Coverage.result)) if running
       # If we're using merging of results, store the current result
       # first, then merge the results and return those
       if use_merging
@@ -109,7 +126,7 @@ module SimpleCov
     end
 
     def load_adapter(name)
-      warn "method load_adapter is deprecated. use load_profile instead"
+      warn "#{Kernel.caller.first}: [DEPRECATION] #load_adapter is deprecated. Use #load_profile instead."
       load_profile(name)
     end
 

data/lib/simplecov/configuration.rb

@@ -7,7 +7,7 @@ require "simplecov/formatter/multi_formatter"
 # SimpleCov documentation for further info.
 #
 module SimpleCov
-  module Configuration
+  module Configuration # rubocop:disable ModuleLength
     attr_writer :filters, :groups, :formatter
 
     #
@@ -42,6 +42,15 @@ module SimpleCov
       coverage_path
     end
 
+    #
+    # Coverage results will always include files matched by this glob, whether
+    # or not they were explicitly required. Without this, un-required files
+    # will not be present in the final report.
+    #
+    def track_files(glob)
+      @track_files_glob = glob
+    end
+
     #
     # Returns the list of configured filters. Add filters using SimpleCov.add_filter.
     #
@@ -80,7 +89,7 @@ module SimpleCov
     # Sets the configured formatters.
     #
     def formatters=(formatters)
-      @formatter = SimpleCov::Formatter::MultiFormatter[*formatters]
+      @formatter = SimpleCov::Formatter::MultiFormatter.new(formatters)
     end
 
     #
@@ -122,7 +131,7 @@ module SimpleCov
     end
 
     def adapters
-      warn "method adapters is deprecated. use profiles instead"
+      warn "#{Kernel.caller.first}: [DEPRECATION] #adapters is deprecated. Use #profiles instead."
       profiles
     end
 
@@ -166,7 +175,7 @@ module SimpleCov
     def project_name(new_name = nil)
       return @project_name if defined?(@project_name) && @project_name && new_name.nil?
       @project_name = new_name if new_name.is_a?(String)
-      @project_name ||= File.basename(root.split("/").last).capitalize.gsub("_", " ")
+      @project_name ||= File.basename(root.split("/").last).capitalize.tr("_", " ")
     end
 
     #
@@ -215,6 +224,17 @@ module SimpleCov
       @maximum_coverage_drop ||= (coverage_drop || 100).to_f.round(2)
     end
 
+    #
+    # Defines the minimum coverage per file required for the testsuite to pass.
+    # SimpleCov will return non-zero if the current coverage of the least covered file
+    # is below this threshold.
+    #
+    # Default is 0% (disabled)
+    #
+    def minimum_coverage_by_file(coverage = nil)
+      @minimum_coverage_by_file ||= (coverage || 0).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.

data/lib/simplecov/defaults.rb

@@ -1,10 +1,12 @@
 # Load default formatter gem
 require "simplecov-html"
+require "pathname"
 
 SimpleCov.profiles.define "root_filter" do
   # Exclude all files outside of simplecov root
+  root_filter = /\A#{Regexp.escape(SimpleCov.root)}/io
   add_filter do |src|
-    !(src.filename =~ /^#{Regexp.escape(SimpleCov.root)}/i)
+    !(src.filename =~ root_filter)
   end
 end
 
@@ -30,6 +32,8 @@ SimpleCov.profiles.define "rails" do
   add_group "Mailers", "app/mailers"
   add_group "Helpers", "app/helpers"
   add_group "Libraries", "lib"
+
+  track_files "{app,lib}/**/*.rb"
 end
 
 # Default configuration
@@ -47,11 +51,11 @@ at_exit do
   # If we are in a different process than called start, don't interfere.
   next if SimpleCov.pid != Process.pid
 
-  if $ERROR_INFO # was an exception thrown?
+  if $! # was an exception thrown?
     # 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 = $ERROR_INFO.is_a?(SystemExit) ? $ERROR_INFO.status : SimpleCov::ExitCodes::EXCEPTION
+    @exit_status = $!.is_a?(SystemExit) ? $!.status : SimpleCov::ExitCodes::EXCEPTION
   else
     # Store the exit status of the test run since it goes away after calling the at_exit proc...
     @exit_status = SimpleCov::ExitCodes::SUCCESS
@@ -61,11 +65,15 @@ at_exit do
 
   if SimpleCov.result? # Result has been computed
     covered_percent = SimpleCov.result.covered_percent.round(2)
+    covered_percentages = SimpleCov.result.covered_percentages.map { |p| p.round(2) }
 
     if @exit_status == SimpleCov::ExitCodes::SUCCESS # No other errors
       if covered_percent < SimpleCov.minimum_coverage # rubocop:disable Metrics/BlockNesting
         $stderr.printf("Coverage (%.2f%%) is below the expected minimum coverage (%.2f%%).\n", covered_percent, SimpleCov.minimum_coverage)
         @exit_status = SimpleCov::ExitCodes::MINIMUM_COVERAGE
+      elsif covered_percentages.any? { |p| p < SimpleCov.minimum_coverage_by_file } # rubocop:disable Metrics/BlockNesting
+        $stderr.printf("File (%s) is only (%.2f%%) covered. This is below the expected minimum coverage per file of (%.2f%%).\n", SimpleCov.result.least_covered_file, covered_percentages.min, SimpleCov.minimum_coverage_by_file)
+        @exit_status = SimpleCov::ExitCodes::MINIMUM_COVERAGE
       elsif (last_run = SimpleCov::LastRun.read) # rubocop:disable Metrics/BlockNesting
         diff = last_run["result"]["covered_percent"] - covered_percent
         if diff > SimpleCov.maximum_coverage_drop # rubocop:disable Metrics/BlockNesting
@@ -92,5 +100,20 @@ if home_dir
 end
 
 # Autoload config from .simplecov if present
-config_path = File.join(SimpleCov.root, ".simplecov")
-load config_path if File.exist?(config_path)
+# Recurse upwards until we find .simplecov or reach the root directory
+
+config_path = Pathname.new(SimpleCov.root)
+loop do
+  filename = config_path.join(".simplecov")
+  if filename.exist?
+    begin
+      load filename
+    rescue LoadError, StandardError
+      $stderr.puts "Warning: Error occurred while trying to load #{filename}. " \
+        "Error message: #{$!.message}"
+    end
+    break
+  end
+  config_path, = config_path.split
+  break if config_path.root?
+end