simplecov 0.9.2 → 0.10.0

data/Rakefile

@@ -1,7 +1,7 @@
 #!/usr/bin/env rake
 
-require 'rubygems'
-require 'bundler/setup'
+require "rubygems"
+require "bundler/setup"
 Bundler::GemHelper.install_tasks
 
 # See https://github.com/colszowka/simplecov/issues/171
@@ -12,19 +12,28 @@ end
 # Enforce proper permissions on each build
 Rake::Task[:build].prerequisites.unshift :fix_permissions
 
-require 'rake/testtask'
+require "rake/testtask"
 Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.test_files = FileList['test/test_*.rb']
+  test.libs << "lib" << "test"
+  test.test_files = FileList["test/test_*.rb"]
   test.verbose = true
   test.warning = true
 end
 
+begin
+  require "rubocop/rake_task"
+  RuboCop::RakeTask.new
+rescue LoadError
+  task :rubocop do
+    $stderr.puts "Rubocop is disabled"
+  end
+end
+
 # Cucumber integration test suite is for impls that work with simplecov only - a.k.a. 1.9+
 if RUBY_VERSION >= "1.9"
-  require 'cucumber/rake/task'
+  require "cucumber/rake/task"
   Cucumber::Rake::Task.new
-  task :default => [:test, :cucumber]
+  task :default => [:test, :cucumber, :rubocop]
 else
   task :default => [:test]
 end

data/doc/alternate-formatters.md

@@ -0,0 +1,36 @@
+## Alternate coverage report formatters
+
+The community around simplecov provides a whole bunch of alternate formatters beyond the official
+[simplecov-html](https://github.com/colszowka/simplecov-html) gem.
+
+If you have built or found one that is missing here, please send a Pull Request for this document!
+
+#### [simplecov-badge](https://github.com/matthew342/simplecov-badge)
+*by Matt Hale*
+
+A formatter that generates a coverage badge for use in your project's readme using ImageMagick.
+
+#### [simplecov-cobertura](https://github.com/dashingrocket/simplecov-cobertura)
+*by Jesse Bowes*
+
+A formatter that generates Cobertura XML.
+
+#### [simplecov-csv](https://github.com/fguillen/simplecov-csv)
+*by Fernando Guillen*
+
+CSV formatter for SimpleCov
+
+#### [simplecov-json](https://github.com/vicentllongo/simplecov-json)
+*by Vicent Llongo*
+
+JSON formatter for SimpleCov
+
+#### [simplecov-rcov](https://github.com/fguillen/simplecov-rcov)
+*by Fernando Guillen*
+
+"The target of this formatter is to cheat on Hudson so I can use the Ruby metrics plugin with SimpleCov."
+
+#### [simplecov-single_file_reporter](https://github.com/grosser/simplecov-single_file_reporter)
+*by [Michael Grosser](http://grosser.it)*
+
+A formatter that prints the coverage of the file under test when you run a single test file.

data/doc/commercial-services.md

@@ -0,0 +1,20 @@
+## Commercial Services with SimpleCov integration
+
+There is a bunch of services that offer integration with your existing CI pipeline and SimpleCov coverage
+reports. Please note these are not associated with the SimpleCov project itself, so please report problems with
+these integrations with their respective owners.
+
+#### [codeclimate](https://github.com/codeclimate/ruby-test-reporter)
+*by [Code Climate](https://codeclimate.com/)*
+
+Upload coverage reports to [codeclimate.com](https://codeclimate.com/), a hosted software quality analysis and that also includes coverage reporting.
+
+#### [codecov](https://github.com/codecov/codecov-ruby)
+*by [Codecov](https://codecov.io/)*
+
+Upload coverage reports to [codecov.io](https://codecov.io/), a hosted coverage reporting solution.
+
+#### [coveralls](https://github.com/lemurheavy/coveralls-ruby)
+*by [Coveralls](https://coveralls.io/)*
+
+Upload coverage reports to [coveralls.io](https://coveralls.io/), a hosted coverage reporting solution.

data/doc/editor-integration.md

@@ -0,0 +1,13 @@
+## Editor integration
+
+Some editors have a graphical integration for the simplecov gem.
+
+#### [Atom Editor: coverage](https://atom.io/packages/coverage)
+*by Philip Giuliani*
+
+Adds an overview of your current test coverage to Atom.
+
+#### [cadre](https://github.com/nyarly/cadre)
+*by Judson Lester*
+
+Includes a formatter for Simplecov that emits a Vim script to mark up code files with coverage information.

data/features/rspec_basic.feature

@@ -14,14 +14,15 @@ Feature:
     When I open the coverage report generated with `bundle exec rspec spec`
     Then I should see the groups:
       | name      | coverage | files |
-      | All Files | 91.23%   | 6     |
+      | All Files | 91.8%   | 7     |
 
     And I should see the source files:
       | name                                    | coverage |
       | lib/faked_project.rb                    | 100.0 %  |
-      | lib/faked_project/some_class.rb         | 80.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 %  |
+      | spec/forking_spec.rb                    | 100.0 %  |
       | spec/meta_magic_spec.rb                 | 100.0 %  |
       | spec/some_class_spec.rb                 | 100.0 %  |
 

data/features/rspec_groups_and_filters_complex.feature

@@ -15,6 +15,7 @@ Feature: Sophisticated grouping and filtering on RSpec
           src_file.filename =~ /MaGiC/i
         end
         add_group 'By string', 'project/meta_magic'
+        add_group 'By array', ['project/meta_magic']
 
         add_filter 'faked_project.rb'
         # Remove all files that include "describe" in their source
@@ -29,6 +30,7 @@ Feature: Sophisticated grouping and filtering on RSpec
       | All Files | 100.0%   | 1     |
       | By block  | 100.0%   | 1     |
       | By string | 100.0%   | 1     |
+      | By array  | 100.0%   | 1     |
 
     And I should see the source files:
       | name                            | coverage |

data/features/rspec_groups_using_filter_class.feature

@@ -24,10 +24,10 @@ Feature: Grouping on RSpec using a custom filter class
     When I open the coverage report generated with `bundle exec rspec spec`
     Then I should see the groups:
       | name             | coverage | files |
-      | All Files        | 91.23%   | 6     |
+      | All Files        | 91.8%    | 7     |
       | By filter class  | 78.26%   | 2     |
       | By string        | 100.0%   | 1     |
-      | Ungrouped        | 100.0%   | 3     |
+      | Ungrouped        | 100.0%   | 4     |
 
     And I should see the source files:
       | name                                    | coverage |
@@ -35,6 +35,7 @@ Feature: Grouping on RSpec using a custom filter class
       | lib/faked_project/some_class.rb         | 80.0 %   |
       | lib/faked_project.rb                    | 100.0 %  |
       | lib/faked_project/meta_magic.rb         | 100.0 %  |
+      | spec/forking_spec.rb                    | 100.0 %  |
       | spec/meta_magic_spec.rb                 | 100.0 %  |
       | spec/some_class_spec.rb                 | 100.0 %  |
 

data/features/step_definitions/html_steps.rb

@@ -1,15 +1,14 @@
 module GroupHelpers
   def available_groups
-    all('#content .file_list_container')
+    all("#content .file_list_container")
   end
 
   def available_source_files
-    all('.source_files .source_table')
+    all(".source_files .source_table")
   end
 end
 World(GroupHelpers)
 
-
 Then /^I should see the groups:$/ do |table|
   expected_groups = table.hashes
   # Given group names should be the same number than those rendered in report
@@ -18,8 +17,8 @@ Then /^I should see the groups:$/ do |table|
   # Verify each of the expected groups has a file list container and corresponding title and coverage number
   # as well as the correct number of links to files.
   expected_groups.each do |group|
-    with_scope "#content ##{group["name"].gsub(/[^a-z]/i, '')}.file_list_container" do
-      file_count_in_group = page.all('a.src_link').count
+    with_scope "#content ##{group['name'].gsub(/[^a-z]/i, '')}.file_list_container" do
+      file_count_in_group = page.all("a.src_link").count
       expect(file_count_in_group).to eq(group["files"].to_i)
 
       with_scope "h2" do
@@ -35,9 +34,9 @@ Then /^I should see the source files:$/ do |table|
   expect(expected_files.length).to eq(available_source_files.count)
 
   # Find all filenames and their coverage present in coverage report
-  files = available_source_files.map {|f| {"name" => f.find('h3').text, "coverage" => f.find('h4 > span').text} }
+  files = available_source_files.map { |f| {"name" => f.find("h3").text, "coverage" => f.find("h4 > span").text} }
 
-  expect(files.sort_by {|hsh| hsh["name"] }).to eq(expected_files.sort_by {|hsh| hsh["name"] })
+  expect(files.sort_by { |hsh| hsh["name"] }).to eq(expected_files.sort_by { |hsh| hsh["name"] })
 end
 
 Then /^there should be (\d+) skipped lines in the source files$/ do |expected_count|

data/features/step_definitions/simplecov_steps.rb

@@ -2,7 +2,8 @@
 # The test project is using separate config files to avoid specifying all of
 # test/spec_helper in the features every time.
 Given /^SimpleCov for (.*) is configured with:$/ do |framework, config_body|
-  framework_dir = case framework
+  framework_dir = begin
+    case framework
     when /RSpec/i
       "spec"
     when /Test\/Unit/i
@@ -10,53 +11,54 @@ Given /^SimpleCov for (.*) is configured with:$/ do |framework, config_body|
     when /Cucumber/i
       "features/support"
     else
-      raise ArgumentError, "Could not identify test framework #{framework}!"
+      fail ArgumentError, "Could not identify test framework #{framework}!"
+    end
   end
 
-  steps %Q{
+  steps %(
     Given a file named "#{framework_dir}/simplecov_config.rb" with:
       """
       #{config_body}
       """
-  }
+    )
 end
 
 When /^I open the coverage report generated with `([^`]+)`$/ do |command|
-  steps %Q{
+  steps %(
     When I successfully run `#{command}`
     Then a coverage report should have been generated
     When I open the coverage report
-  }
+    )
 end
 
 Then /^a coverage report should have been generated(?: in "([^"]*)")?$/ do |coverage_dir|
-  coverage_dir ||= 'coverage'
-  steps %Q{
+  coverage_dir ||= "coverage"
+  steps %(
     Then the output should contain "Coverage report generated"
     And a directory named "#{coverage_dir}" should exist
     And the following files should exist:
       | #{coverage_dir}/index.html      |
       | #{coverage_dir}/.resultset.json |
-  }
+    )
 end
 
 Then /^no coverage report should have been generated(?: in "([^"]*)")?$/ do |coverage_dir|
-  coverage_dir ||= 'coverage'
-  steps %Q{
+  coverage_dir ||= "coverage"
+  steps %(
     Then the output should not contain "Coverage report generated"
     And a directory named "#{coverage_dir}" should not exist
     And the following files should not exist:
       | #{coverage_dir}/index.html      |
       | #{coverage_dir}/.resultset.json |
-  }
+    )
 end
 
 Then /^the report should be based upon:$/ do |table|
   frameworks = table.raw.flatten
-  steps %Q{
-    Then the output should contain "Coverage report generated for #{frameworks.join(", ")}"
-    And I should see "using #{frameworks.join(", ")}" within "#footer"
-  }
+  steps %(
+    Then the output should contain "Coverage report generated for #{frameworks.join(', ')}"
+    And I should see "using #{frameworks.join(', ')}" within "#footer"
+    )
 end
 
 # This is neccessary to ensure timing-dependant tests like the merge timeout

data/features/step_definitions/transformers.rb

@@ -6,8 +6,8 @@
 # This is due to the fact that coverage will not include the first loaded spec/test file.
 # To get predictable coverage results, we need to know which one that is...
 #
-Transform "bundle exec rspec spec" do |t|
+Transform "bundle exec rspec spec" do |_|
   files = nil # Avoid shadowing
-  in_current_dir { files = Dir['spec/**/*_spec.rb'] }
+  in_current_dir { files = Dir["spec/**/*_spec.rb"] }
   "bundle exec rspec #{files.sort.join(' ')}"
 end

data/features/step_definitions/web_steps.rb

@@ -6,7 +6,7 @@ end
 World(WithinHelpers)
 
 When /^I open the coverage report$/ do
-  visit '/'
+  visit "/"
 end
 
 Given /^(?:|I )am on (.+)$/ do |path|
@@ -38,7 +38,7 @@ end
 Then /^(?:|I )should see \/([^\/]*)\/(?: within "([^"]*)")?$/ do |regexp, selector|
   regexp = Regexp.new(regexp)
   with_scope(selector) do
-    expect(page).to have_xpath('//*', :text => regexp)
+    expect(page).to have_xpath("//*", :text => regexp)
   end
 end
 
@@ -51,12 +51,12 @@ end
 Then /^(?:|I )should not see \/([^\/]*)\/(?: within "([^"]*)")?$/ do |regexp, selector|
   regexp = Regexp.new(regexp)
   with_scope(selector) do
-    expect(page).to have_no_xpath('//*', :text => regexp)
+    expect(page).to have_no_xpath("//*", :text => regexp)
   end
 end
 
 Then /^show me the page$/ do
-  save_and_open_page
+  save_and_open_page # rubocop:disable Lint/Debugger
 end
 
 Then /^print the page$/ do

data/features/support/env.rb

@@ -3,35 +3,37 @@ if RUBY_VERSION < "1.9"
   exit 0
 end
 
-require 'bundler'
+require "bundler"
 Bundler.setup
-require 'aruba/cucumber'
-require 'aruba/jruby' if RUBY_ENGINE == 'jruby'
-require 'capybara/cucumber'
-require 'minitest/autorun'
-require 'phantomjs/poltergeist'
+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
 Capybara.app = lambda { |env|
-  request_path = env['REQUEST_PATH'] || '/'
-  request_path = '/index.html' if request_path == '/'
-
-  [200, {'Content-Type' => 'text/html'},
-    [File.read(File.join(File.dirname(__FILE__), '../../tmp/aruba/project/coverage', request_path))]]
+  request_path = env["REQUEST_PATH"] || "/"
+  request_path = "/index.html" if request_path == "/"
+  [
+    200,
+    {"Content-Type" => "text/html"},
+    [File.read(File.join(File.dirname(__FILE__), "../../tmp/aruba/project/coverage", request_path))],
+  ]
 }
 
 Capybara.default_driver = Capybara.javascript_driver = :poltergeist
 
 Before do
   # JRuby takes it's time... See https://github.com/cucumber/aruba/issues/134
-  @aruba_timeout_seconds = RUBY_ENGINE == 'jruby' ? 60 : 20
+  @aruba_timeout_seconds = RUBY_ENGINE == "jruby" ? 60 : 20
 
   this_dir = File.dirname(__FILE__)
 
   # Clean up and create blank state for fake project
   in_current_dir do
-    FileUtils.rm_rf 'project'
-    FileUtils.cp_r File.join(this_dir, '../../test/faked_project/'), 'project'
+    FileUtils.rm_rf "project"
+    FileUtils.cp_r File.join(this_dir, "../../test/faked_project/"), "project"
   end
 
   step 'I cd to "project"'
@@ -40,6 +42,6 @@ end
 # Workaround for https://github.com/cucumber/aruba/pull/125
 Aruba.configure do |config|
   config.before_cmd do
-    set_env('JRUBY_OPTS', '-X-C --1.9')
+    set_env("JRUBY_OPTS", "-X-C --1.9")
   end
 end

data/lib/simplecov.rb

@@ -1,9 +1,20 @@
 #
 # Code coverage for ruby 1.9. Please check out README for a full introduction.
 #
+# Coverage may be inaccurate under JRUBY.
+if defined?(JRUBY_VERSION)
+  if ENV["JRUBY_OPTS"].to_s !~ /-Xcli.debug=true/
+    warn "Coverage may be inaccurate; Try setting JRUBY_OPTS=\"-Xcli.debug=true --debug\""
+    # see https://github.com/metricfu/metric_fu/pull/226
+    #     https://github.com/jruby/jruby/issues/1196
+    #     https://jira.codehaus.org/browse/JRUBY-6106
+    #     https://github.com/colszowka/simplecov/issues/86
+  end
+end
 module SimpleCov
   class << self
     attr_accessor :running
+    attr_accessor :pid
 
     #
     # Sets up SimpleCov to run against your project.
@@ -22,12 +33,13 @@ module SimpleCov
     #
     # Please check out the RDoc for SimpleCov::Configuration to find about available config options
     #
-    def start(profile=nil, &block)
+    def start(profile = nil, &block)
       if SimpleCov.usable?
         load_profile(profile) if profile
         configure(&block) if block_given?
         @result = nil
         self.running = true
+        self.pid = Process.pid
         Coverage.start
       else
         warn "WARNING: SimpleCov is activated, but you're not running Ruby 1.9+ - no coverage analysis will happen"
@@ -59,7 +71,7 @@ module SimpleCov
     # Otherwise, returns the result
     #
     def result?
-      defined? @result and @result
+      defined?(@result) && @result
     end
 
     #
@@ -68,7 +80,7 @@ module SimpleCov
     def filtered(files)
       result = files.clone
       filters.each do |filter|
-        result = result.reject {|source_file| filter.matches?(source_file) }
+        result = result.reject { |source_file| filter.matches?(source_file) }
       end
       SimpleCov::FileList.new result
     end
@@ -80,10 +92,10 @@ module SimpleCov
       grouped = {}
       grouped_files = []
       groups.each do |name, filter|
-        grouped[name] = SimpleCov::FileList.new(files.select {|source_file| filter.matches?(source_file)})
+        grouped[name] = SimpleCov::FileList.new(files.select { |source_file| filter.matches?(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
+      if groups.length > 0 && (other_files = files.reject { |source_file| grouped_files.include?(source_file) }).length > 0
         grouped["Ungrouped"] = SimpleCov::FileList.new(other_files)
       end
       grouped
@@ -106,11 +118,11 @@ module SimpleCov
     # provides coverage support
     #
     def usable?
-      return @usable if defined? @usable and !@usable.nil?
+      return @usable if defined?(@usable) && !@usable.nil?
 
       @usable = begin
-        require 'coverage'
-        require 'simplecov/jruby_fix'
+        require "coverage"
+        require "simplecov/jruby_fix"
         true
       rescue LoadError
         false
@@ -120,24 +132,23 @@ module SimpleCov
 end
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__)))
-require 'simplecov/configuration'
+require "simplecov/configuration"
 SimpleCov.send :extend, SimpleCov::Configuration
-require 'simplecov/exit_codes'
-require 'simplecov/json'
-require 'simplecov/profiles'
-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'
-require 'simplecov/version'
+require "simplecov/exit_codes"
+require "simplecov/profiles"
+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"
+require "simplecov/version"
 
 # Load default config
-require 'simplecov/defaults' unless ENV['SIMPLECOV_NO_DEFAULTS']
+require "simplecov/defaults" unless ENV["SIMPLECOV_NO_DEFAULTS"]
 
 # Load Rails integration (only for Rails 3, see #113)
-require 'simplecov/railtie' if defined? Rails::Railtie
+require "simplecov/railtie" if defined? Rails::Railtie