simplecov 0.14.1 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: bda7293a0b718da578a1e9b6897393d21d955fbf
-  data.tar.gz: d81ac2993a335e716a47a19dd648fe635cc4a635
+SHA256:
+  metadata.gz: 316080f1732d39e050a8c0310aa1527717c2216ac5ab7b570dca4076e358a041
+  data.tar.gz: 1417f8a0e41fab72d8b2d86b583dec9c5b47adde77f26dce84ee3646985b0a43
 SHA512:
-  metadata.gz: 6e25b2151aec02177f9a6dd1f14366d44ad1ab2158d8502c65bbf2db4e2672a1926eaba1107580f4a642ad99d79f57d421d54759bed341099ec4a1a4cb9a3a04
-  data.tar.gz: 34fe7bc261f7e105b230652e5b8ceed4e4b179bf7f36e5424c51cf7767e14ae91173a01b9da2e89707bd147ab212f85367e28791cfa1bbfcac3d055660e2ca43
+  metadata.gz: 3d58eee98ca6d7da2412747c6972560cdb835f110d37041a84816d44b8d433deb9d2b0bf20ce29012f90d2f2978afed2ae1bfdde3540b4d078a69adb2a64623e
+  data.tar.gz: cbbf89810a47ffec5328846f0135e98fac7fc0827d5cda4db59c8b761ce7c307e73f8cdc4e15e8db8e192e28b5c0eed8c15399f52bedacca4517cc76ef0556e5

data/.rubocop.yml

@@ -3,6 +3,7 @@ AllCops:
     - 'spec/fixtures/iso-8859.rb'
     - 'tmp/**/*'
     - 'vendor/bundle/**/*'
+  TargetRubyVersion: 1.9
 
 Bundler/OrderedGems:
   Enabled: false
@@ -35,7 +36,7 @@ Metrics/ParameterLists:
   Max: 4
   CountKeywordArgs: true
 
-Style/AccessModifierIndentation:
+Layout/AccessModifierIndentation:
   EnforcedStyle: outdent
 
 Style/CollectionMethods:
@@ -54,10 +55,13 @@ Style/DoubleNegation:
 Style/HashSyntax:
   EnforcedStyle: hash_rockets
 
+Layout/IndentHeredoc:
+  Enabled: false
+
 Style/RegexpLiteral:
   Enabled: false
 
-Style/SpaceInsideHashLiteralBraces:
+Layout/SpaceInsideHashLiteralBraces:
   EnforcedStyle: no_space
 
 Style/SpecialGlobalVars:

data/.travis.yml

@@ -15,12 +15,12 @@ rvm:
   - 1.9.3
   - 2.0.0
   - 2.1.10
-  - 2.2.6
-  - 2.3.3
-  - 2.4.0
+  - 2.2.7
+  - 2.3.4
+  - 2.4.1
+  - jruby-9.1.12.0
   - ruby-head
   - jruby-head
-  - jruby-9.1.8.0
 
 matrix:
   allow_failures:

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+0.15.0 (2017-08-14) ([changes](https://github.com/colszowka/simplecov/compare/v0.14.1...v0.15.0))
+=======
+
+## Enhancements
+
+* Ability to use regex filters for removing files from the output. See [#589](https://github.com/colszowka/simplecov/pull/589) (thanks @jsteel)
+
+## Bugfixes
+
+* Fix merging race condition when running tests in parallel and merging them. See [#570](https://github.com/colszowka/simplecov/pull/570) (thanks @jenseng)
+* Fix relevant lines for unloaded files - comments, skipped code etc. are correctly classigied as irrelevant. See [#605](https://github.com/colszowka/simplecov/pull/605) (thanks @odlp)
+* Allow using simplecov with frozen-string-literals enabled. See [#590](https://github.com/colszowka/simplecov/pull/590) (thanks @pat)
+* Make sure Array Filter can use all other filter types. See [#589](https://github.com/colszowka/simplecov/pull/589) (thanks @jsteel)
+* Make sure file names use `Simplecov.root` as base avoiding using full absolute project paths. See [#589](https://github.com/colszowka/simplecov/pull/589) (thanks @jsteel)
+
 0.14.1 2017-03-18 ([changes](https://github.com/colszowka/simplecov/compare/v0.14.0...v0.14.1))
 ========
 

data/Gemfile

@@ -23,13 +23,13 @@ group :test do
     gem "rack", "~> 1.6"
   end
   platforms :jruby, :ruby_19, :ruby_20, :ruby_21, :ruby_22, :ruby_23, :ruby_24, :ruby_25 do
-    gem "aruba", "~> 0.7.4"
+    gem "aruba", "~> 0.14"
     gem "capybara"
     gem "nokogiri", RUBY_VERSION < "2.1" ? "~> 1.6.0" : ">= 1.7"
     gem "cucumber"
     gem "phantomjs", "~> 2.1"
     gem "poltergeist"
-    gem "rubocop" unless RUBY_VERSION.start_with?("1.")
+    gem "rubocop", "0.49.1" unless RUBY_VERSION.start_with?("1.")
     gem "test-unit"
   end
   gem "json", RUBY_VERSION.start_with?("1.") ? "~> 1.8" : "~> 2.0"

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010-2015 Christoph Olszowka
+Copyright (c) 2010-2017 Christoph Olszowka
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -40,7 +40,7 @@ automatically when you launch SimpleCov. If you're curious, you can find it [on
 
 *Questions, Problems, Suggestions, etc.*
 
-* [Mailing List]: https://groups.google.com/forum/#!forum/simplecov "Open mailing list for discussion and announcements on Google Groups"
+* [Mailing List](https://groups.google.com/forum/#!forum/simplecov) "Open mailing list for discussion and announcements on Google Groups"
 
 Getting started
 ---------------
@@ -133,6 +133,17 @@ to use SimpleCov with them. Here's an overview of the known ones:
 
 <table>
   <tr><th>Framework</th><th>Notes</th><th>Issue</th></tr>
+  <tr>
+    <th>
+      bootsnap
+    </th>
+    <td>
+      <a href="#want-to-use-bootsnap-with-simplecov">See section below.</a>
+    </td>
+    <td>
+      <a href="https://github.com/Shopify/bootsnap/issues/35">Shopify/bootsnap#35</a>
+    </td>
+  </tr>
   <tr>
     <th>
       parallel_tests
@@ -262,7 +273,7 @@ report.
 
 ### Defining custom filters
 
-You can currently define a filter using either a String (that will then be Regexp-matched against each source file's path),
+You can currently define a filter using either a String or Regexp (that will then be Regexp-matched against each source file's path),
 a block or by passing in your own Filter class.
 
 #### String filter
@@ -275,6 +286,16 @@ end
 
 This simple string filter will remove all files that match "/test/" in their path.
 
+#### Regex filter
+
+```ruby
+SimpleCov.start do
+  add_filter %r{^/test/}
+end
+```
+
+This simple regex filter will remove all files that start with /test/ in their path.
+
 #### Block filter
 
 ```ruby
@@ -305,6 +326,17 @@ Defining your own filters is pretty easy: Just inherit from SimpleCov::Filter an
 the filter, a true return value from this method will result in the removal of the given source_file. The filter_argument method
 is being set in the SimpleCov::Filter initialize method and thus is set to 5 in this example.
 
+#### Array filter
+
+```ruby
+SimpleCov.start do
+  proc = Proc.new { |source_file| false }
+  add_filter ["string", /regex/, proc, LineFilter.new(5)]
+end
+```
+
+You can pass in an array containing any of the other filter types.
+
 #### Ignoring/skipping code
 
 You can exclude code from the coverage report by wrapping it in `# :nocov:`.
@@ -570,10 +602,10 @@ being an instance of SimpleCov::Result. Do whatever your wish with that!
 As of SimpleCov 0.9, you can specify multiple result formats:
 
 ```ruby
-SimpleCov.formatters = [
+SimpleCov.formatters = SimpleCov::Formatter::MultiFormatter.new([
   SimpleCov::Formatter::HTMLFormatter,
   SimpleCov::Formatter::CSVFormatter,
-]
+])
 ```
 
 ## Available formatters, editor integrations and hosted services
@@ -624,6 +656,20 @@ If you're using [Spring](https://github.com/rails/spring) to speed up test suite
     ```
 3. Run `spring rspec <path>` as normal. Remember to run `spring stop` after
    making important changes to your app or its specs!
+   
+## Want to use bootsnap with SimpleCov?
+
+As mentioned in [this issue](https://github.com/Shopify/bootsnap/issues/35) iseq
+loading/dumping doesn't work with coverage. Hence you need to deactivate it when
+you run coverage so for instance when you use the environment `COVERAGE=true` to
+decide that you want to gather coverage you can do:
+
+```ruby
+Bootsnap.setup(
+  compile_cache_iseq:   !ENV["COVERAGE"], # Compile Ruby code into ISeq cache, breaks coverage reporting.
+  # all those other options
+)
+```
 
 ## Contributing
 
@@ -635,4 +681,4 @@ Thanks to Aaron Patterson for the original idea for this!
 
 ## Copyright
 
-Copyright (c) 2010-2015 Christoph Olszowka. See MIT-LICENSE for details.
+Copyright (c) 2010-2017 Christoph Olszowka. See MIT-LICENSE for details.

data/doc/editor-integration.md

@@ -7,7 +7,12 @@ Some editors have a graphical integration for the simplecov gem.
 
 Adds an overview of your current test coverage to Atom.
 
+#### [Sublime Editor: Simple​Cov](https://packagecontrol.io/packages/SimpleCov)
+*by sentience*
+
+Adds in editor live coverage highlighting, status bar coverage information, and summary coverage information.
+
 #### [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.
+Includes a formatter for Simplecov that emits a Vim script to mark up code files with coverage information.

data/features/config_tracked_files.feature

@@ -16,7 +16,7 @@ Feature:
     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     |
+      | All Files | 77.94%   | 7     |
 
     And I should see the source files:
       | name                                    | coverage |

data/features/config_tracked_files_relevant_lines.feature

@@ -0,0 +1,31 @@
+@rspec
+Feature:
+
+  Using the setting `tracked_files` should classify whether lines
+  are relevant or not (such as whitespace or comments).
+
+  Scenario:
+    Given SimpleCov for RSpec is configured with:
+      """
+      require 'simplecov'
+      SimpleCov.start do
+        track_files "lib/**/*.rb"
+      end
+      """
+    Given a file named "lib/not_loaded.rb" with:
+    """
+    # A comment line. Plus a whitespace line below:
+
+    # :nocov:
+    def ignore_me
+    end
+    # :nocov:
+
+    def this_is_relevant
+      puts "still relevant"
+    end
+    """
+
+    When I open the coverage report generated with `bundle exec rspec spec`
+    Then I follow "lib/not_loaded.rb"
+    Then I should see "3 relevant lines" within ".highlighted"

data/features/step_definitions/transformers.rb

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

data/features/support/aruba_freedom_patch.rb

@@ -0,0 +1,53 @@
+# Freedom patch because of not working absolute directories, see: https://github.com/cucumber/aruba/issues/478
+# code taken directly from aruba 0.14.2 - roughly here: https://github.com/cucumber/aruba/blob/master/lib/aruba/api/core.rb#L122-L159
+# rubocop:disable all
+module Aruba
+  module Api
+    module Core
+      def expand_path(file_name, dir_string = nil)
+        # only line added, don't ask why but I couldn't get alias_method to work...
+        return file_name if absolute?(file_name)
+        check_for_deprecated_variables if Aruba::VERSION < '1'
+
+        message = %(Filename "#{file_name}" needs to be a string. It cannot be nil or empty either.  Please use `expand_path('.')` if you want the current directory to be expanded.)
+
+        fail ArgumentError, message unless file_name.is_a?(String) && !file_name.empty?
+
+        aruba.logger.warn %(`aruba`'s working directory does not exist. Maybe you forgot to run `setup_aruba` before using it's API. This warning will be an error from 1.0.0) unless Aruba.platform.directory? File.join(aruba.config.root_directory, aruba.config.working_directory)
+
+        if RUBY_VERSION < '1.9'
+          prefix = file_name.chars.to_a[0].to_s
+          rest = if file_name.chars.to_a[2..-1].nil?
+                   nil
+                 else
+                   file_name.chars.to_a[2..-1].join
+                 end
+        else
+          prefix = file_name[0]
+          rest = file_name[2..-1]
+        end
+
+        if aruba.config.fixtures_path_prefix == prefix
+          path = File.join(*[aruba.fixtures_directory, rest].compact)
+
+          fail ArgumentError, %(Fixture "#{rest}" does not exist in fixtures directory "#{aruba.fixtures_directory}". This was the one we found first on your system from all possible candidates: #{aruba.config.fixtures_directories.map { |p| format('"%s"', p) }.join(', ')}.) unless Aruba.platform.exist? path
+
+          path
+        elsif '~' == prefix
+          path = with_environment do
+            ArubaPath.new(File.expand_path(file_name))
+          end
+
+          fail ArgumentError, 'Expanding "~/" to "/" is not allowed' if path.to_s == '/'
+          fail ArgumentError, %(Expanding "~/" to a relative path "#{path}" is not allowed) unless path.absolute?
+
+          path.to_s
+        else
+          directory = File.join(aruba.root_directory, aruba.current_directory)
+          ArubaPath.new(File.join(*[directory, dir_string, file_name].compact)).expand_path.to_s
+        end
+      end
+    end
+  end
+end
+# rubocop:enable all

data/features/support/env.rb

@@ -6,7 +6,8 @@ end
 require "bundler"
 Bundler.setup
 require "aruba/cucumber"
-require "aruba/jruby" if RUBY_ENGINE == "jruby"
+require "aruba/config/jruby" if RUBY_ENGINE == "jruby"
+require_relative "aruba_freedom_patch"
 require "capybara/cucumber"
 require "phantomjs/poltergeist"
 
@@ -34,7 +35,7 @@ Before do
   this_dir = File.dirname(__FILE__)
 
   # Clean up and create blank state for fake project
-  in_current_directory do
+  cd(".") do
     FileUtils.rm_rf "project"
     FileUtils.cp_r File.join(this_dir, "../../spec/faked_project/"), "project"
   end
@@ -44,7 +45,6 @@ end
 
 # Workaround for https://github.com/cucumber/aruba/pull/125
 Aruba.configure do |config|
-  config.before_cmd do
-    set_env("JRUBY_OPTS", "--dev --debug")
-  end
+  config.exit_timeout = RUBY_ENGINE == "jruby" ? 60 : 20
+  config.command_runtime_environment = {"JRUBY_OPTS" => "--dev --debug"}
 end

data/lib/simplecov.rb

@@ -55,7 +55,7 @@ module SimpleCov
 
     #
     # Finds files that were to be tracked but were not loaded and initializes
-    # their coverage to zero.
+    # the line-by-line coverage to zero (if relevant) or nil (comments / whitespace etc).
     #
     def add_not_loaded_files(result)
       if tracked_files
@@ -63,7 +63,7 @@ module SimpleCov
         Dir[tracked_files].each do |file|
           absolute = File.expand_path(file)
 
-          result[absolute] ||= [0] * File.foreach(absolute).count
+          result[absolute] ||= LinesClassifier.new.classify(File.foreach(absolute))
         end
       end
 
@@ -75,23 +75,21 @@ module SimpleCov
     # from cache using SimpleCov::ResultMerger if use_merging is activated (default)
     #
     def result
-      # Ensure the variable is defined to avoid ruby warnings
-      @result = nil unless defined?(@result)
+      return @result if result?
 
       # Collect our coverage result
-      if running && !result?
+      if running
         @result = SimpleCov::Result.new add_not_loaded_files(Coverage.result)
       end
 
       # If we're using merging of results, store the current result
-      # first, then merge the results and return those
+      # first (if there is one), then merge the results and return those
       if use_merging
         SimpleCov::ResultMerger.store_result(@result) if result?
-
-        SimpleCov::ResultMerger.merged_result
-      else
-        @result
+        @result = SimpleCov::ResultMerger.merged_result
       end
+
+      @result
     ensure
       self.running = false
     end
@@ -158,6 +156,13 @@ module SimpleCov
         false
       end
     end
+
+    #
+    # Clear out the previously cached .result. Primarily useful in testing
+    #
+    def clear_result
+      @result = nil
+    end
   end
 end
 
@@ -172,6 +177,7 @@ require "simplecov/result"
 require "simplecov/filter"
 require "simplecov/formatter"
 require "simplecov/last_run"
+require "simplecov/lines_classifier"
 require "simplecov/raw_coverage"
 require "simplecov/result_merger"
 require "simplecov/command_guesser"

data/lib/simplecov/configuration.rb

@@ -291,16 +291,12 @@ module SimpleCov
     # The actual filter processor. Not meant for direct use
     #
     def parse_filter(filter_argument = nil, &filter_proc)
-      if filter_argument.is_a?(SimpleCov::Filter)
-        filter_argument
-      elsif filter_argument.is_a?(String)
-        SimpleCov::StringFilter.new(filter_argument)
-      elsif filter_proc
-        SimpleCov::BlockFilter.new(filter_proc)
-      elsif filter_argument.is_a?(Array)
-        SimpleCov::ArrayFilter.new(filter_argument)
+      filter = filter_argument || filter_proc
+
+      if filter
+        SimpleCov::Filter.build_filter(filter)
       else
-        raise ArgumentError, "Please specify either a string or a block to filter with"
+        raise ArgumentError, "Please specify either a filter or a block to filter with"
       end
     end
   end