single_cov 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fc4bd21262f4b962189d8bb21f2032e5f32c6b42
+  data.tar.gz: 96832f5c76759152715afc37a7250037e054e7ae
+SHA512:
+  metadata.gz: 949aa6f89ff4d1cfe868fdee4b778f686971b1bca13092b5c099abdf6b282fa7465bb97a00f56daba40082a62348d48c693be3fed117b4ce582991228421b252
+  data.tar.gz: 6971f210c32e0e54e13bf8e3adc9980056d66ef3368cec0b1894620691197f32834681094a46b557615f5cb71327e77604ce20882dbef647d24ae1bff7dece5c

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (C) 2013 Michael Grosser <michael@grosser.it>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/single_cov/version.rb

@@ -0,0 +1,3 @@
+module SingleCov
+  VERSION = "0.1.0"
+end

data/lib/single_cov.rb

@@ -0,0 +1,212 @@
+module SingleCov
+  COVERAGES = []
+  MAX_OUTPUT = 40
+
+  class << self
+    def not_covered!
+    end
+
+    def covered!(file: nil, uncovered: 0)
+      file = guess_and_check_covered_file(file)
+      COVERAGES << [file, uncovered]
+    end
+
+    def all_covered?(result)
+      errors = COVERAGES.map do |file, expected_uncovered|
+        if coverage = result[File.expand_path(file)]
+          uncovered_lines = coverage.each_with_index.map { |c, i| "#{file}:#{i+1}" if c == 0 }.compact
+          next if uncovered_lines.size == expected_uncovered
+          warn_about_bad_coverage(file, expected_uncovered, uncovered_lines)
+        else
+          warn_about_no_coverage(file)
+        end
+      end.compact
+
+      return true if errors.empty?
+
+      errors = errors.join("\n").split("\n") # unify arrays with multiline strings
+      errors[MAX_OUTPUT..-1] = "... coverage output truncated" if errors.size >= MAX_OUTPUT
+      warn errors
+
+      errors.all? { |l| l.end_with?('?') } # ok if we just have warnings
+    end
+
+    def assert_used(tests: default_tests)
+      bad = tests.select do |file|
+        File.read(file) !~ /SingleCov.(not_)?covered\!/
+      end
+      unless bad.empty?
+        raise bad.map { |f| "#{f}: needs to use SingleCov.covered!" }.join("\n")
+      end
+    end
+
+    def assert_tested(files: Dir['{app,lib}/**/*.rb'], tests: default_tests, untested: [])
+      missing = files - tests.map { |t| file_under_test(t) }
+      fixed = untested - missing
+      missing -= untested
+
+      if fixed.any?
+        raise "Remove #{fixed.inspect} from untested!"
+      elsif missing.any?
+        raise missing.map { |f| "missing test for #{f}" }.join("\n")
+      end
+    end
+
+    def setup(framework)
+      if defined?(SimpleCov)
+        raise "Load SimpleCov after SingleCov"
+      end
+
+      case framework
+      when :minitest
+        minitest_should_not_be_running!
+        return if minitest_running_subset_of_tests?
+        start_coverage_recording
+
+        override_at_exit do |status, _exception|
+          exit 1 if status == 0 && !SingleCov.all_covered?(coverage_results)
+        end
+      else
+        raise "Unsupported framework #{framework.inspect}"
+      end
+    end
+
+    private
+
+    def default_tests
+      Dir["{test,spec}/**/*_{test,spec}.rb"]
+    end
+
+    # do not ask for coverage when SimpleCov already does or it conflicts
+    def coverage_results
+      if defined?(SimpleCov)
+        SimpleCov.instance_variable_get(:@result).original_result
+      else
+        Coverage.result
+      end
+    end
+
+    # start recording before classes are loaded or nothing can be recorded
+    # SimpleCov might start coverage again, but that does not hurt ...
+    def start_coverage_recording
+      require 'coverage'
+      Coverage.start
+    end
+
+    # not running rake or a whole folder
+    # TODO make this better ...
+    def running_single_file?
+      !defined?(Rake)
+    end
+
+    # we cannot insert our hooks when minitest is already running
+    def minitest_should_not_be_running!
+      if defined?(Minitest) && Minitest.class_variable_get(:@@installed_at_exit)
+        raise "Load minitest after setting up SingleCov"
+      end
+    end
+
+    # do not record or verify when only running selected tests since it would be missing data
+    def minitest_running_subset_of_tests?
+      (ARGV & ['-n', '--name', '-l', '--line']).any?
+    end
+
+    # code stolen from SimpleCov
+    def override_at_exit
+      at_exit do
+        exit_status = 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)
+          $!.is_a?(SystemExit) ? $!.status : 1
+        else
+          # Store the exit status of the test run since it goes away
+          # after calling the at_exit proc...
+          0
+        end
+
+        yield exit_status, $!
+
+        # Force exit with stored status (see github issue #5)
+        # unless it's nil or 0 (see github issue #281)
+        Kernel.exit exit_status if exit_status && exit_status > 0
+      end
+    end
+
+    def guess_and_check_covered_file(file)
+      if file && file.start_with?("/")
+        raise "Use paths relative to rails root."
+      end
+
+      if file
+        raise "#{file} does not exist and cannot be covered." unless File.exist?(file)
+      else
+        file = file_under_test(caller[1])
+        unless File.exist?(file)
+          raise "Tried to guess covered file as #{file}, but it does not exist.\nUse `SingleCov.covered file: 'target_file.rb'` to set covered file location."
+        end
+      end
+
+      file
+    end
+
+    def warn_about_bad_coverage(file, expected_uncovered, uncovered_lines)
+      details = "(#{uncovered_lines.size} current vs #{expected_uncovered} configured)"
+      if expected_uncovered > uncovered_lines.size
+        if running_single_file?
+          "#{file} has less uncovered lines #{details}, decrement configured uncovered?"
+        end
+      else
+        [
+          "#{file} new uncovered lines introduced #{details}",
+          "Lines missing coverage:",
+          *uncovered_lines
+        ].join("\n")
+      end
+    end
+
+    def warn_about_no_coverage(file)
+      if $LOADED_FEATURES.include?(File.expand_path(file))
+        # we cannot enforce $LOADED_FEATURES during covered! since it would fail when multiple files are loaded
+        "#{file} was expected to be covered, but already loaded before tests started."
+      else
+        "#{file} was expected to be covered, but never loaded."
+      end
+    end
+
+    def file_under_test(file)
+      file = file.dup
+
+      # remove project root
+      file.sub!("#{Bundler.root}/", '')
+
+      # remove caller junk to get nice error messages when something fails
+      file.sub!(/\.rb\b.*/, '.rb')
+
+      # preserve subfolders like foobar/test/xxx_test.rb -> foobar/lib/xxx_test.rb
+      subfolder, file_part = file.split(%r{(?:^|/)(?:test|spec)/}, 2)
+      unless file_part
+        raise "#{file} includes neither 'test' nor 'spec' folder ... unable to resolve"
+      end
+
+      # rails things live in app
+      file_part[0...0] = if file_part =~ /^(?:models|serializers|helpers|controllers|mailers|views)\//
+        "app/"
+      elsif file_part.start_with?("lib/") # don't add lib twice
+        ""
+      else # everything else lives in lib
+        "lib/"
+      end
+
+      # remove test extension
+      unless file_part.sub!(/_(?:test|spec)\.rb\b.*/, '.rb')
+        raise "Unable to remove test extension from #{file} ... _test.rb and _spec.rb are supported"
+      end
+
+      # put back the subfolder
+      file_part[0...0] = "#{subfolder}/" unless subfolder.empty?
+
+      file_part
+    end
+  end
+end

metadata

@@ -0,0 +1,46 @@
+--- !ruby/object:Gem::Specification
+name: single_cov
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael Grosser
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-17 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: michael@grosser.it
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- lib/single_cov.rb
+- lib/single_cov/version.rb
+homepage: https://github.com/grosser/single_cov
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Actionable code coverage.
+test_files: []