rspec-cover_it 0.0.4 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66c4b3e0c88dffe53a1d435d40d4e1bdb52038661d8abb89ccc29ef6974398e2
-  data.tar.gz: 563d49e4e8656ea8da53defeb9e2d5f7ed9a91d36e5de0df126213f35dee6813
+  metadata.gz: 5989ad87b5dccfd49f0e4074fde2aa5ee796af31c93d7a8c3b081fd5283db3aa
+  data.tar.gz: ef49e7f6d941accf93973aaf56da57a6ae60db7232042b9d06edad5d1845dc5e
 SHA512:
-  metadata.gz: e17ac79db233e4a1f9571f98d025c37cf2e3c304155838fc221507ef5ac6a24aecb47be2f0a6678423009254a0bb5eac442ce775f4ad8bb3f9a66554e9f09fd6
-  data.tar.gz: 0c9afcc6b5f019c185365e5c40925a3b96b4108133d1dcc6150edb182780c35e2a946693106fdf9299e507007a1adfb1dc33cbc341b95f729cea1faf202bbab2
+  metadata.gz: 0d64ad3f4a25abd3a5af67ab7e6ff3f548e7c43004c25c6c7dba5da4de81d5217a2160ae7c725c50af9fb9caecad57105c4d0f18cafb5b12a4968c63de849993
+  data.tar.gz: e0dee5c4480e921645112dcd5bfcbe303f144a90564d03542fe6b84b11159566807555b06c45382eb5a0302faba6470b786bcd38c4e5ba16563184a0bad52259

data/README.md

@@ -58,13 +58,20 @@ In example groups, you can use metadata to control the behavior of
   this ExampleGroup. If numeric, it's enabling, and specifying the coverage
   threshold at the same time (as a percentage - `cover_it: 95` requires 95%
   coverage of the target class by this example group).
+* `covers_path`: The path (relative to the spec file!) of the code the spec is
+  intending to cover. Later, this can be an array of paths, for the multi-spec
+  case `covers` is intended for as well. This is an annoying work-around for
+  the fact that we can't perfectly infer the location of the source code in
+  some cases - in particular, `lib/foo/version.rb` tends to cause a problem
+  for specs on `foo.rb`, since the version file is invariably loaded first.
 * `covers`: An array of classes and modules that this example groups _thinks
   it is completely testing_. Ideally, you'd have a separate test file for each,
   but sometimes that's hard to do - you can let one spec claim responsibility
   for multiple classes and modules (such as Concerns) using this. Be default
   it is just `[described_class]`. Additionally, if your top-level example
   group _does not describe a Class or Module_, you may use `covers` to let it
-  invoke `rspec-cover_it` anyway.
+  invoke `rspec-cover_it` anyway - some people `describe "a descriptive string"`
+  instead of `describe AClass`, and .. fine.
 
 ## Implementation
 
@@ -115,18 +122,10 @@ That's not the goal here, and I'm not going to worry about it.
 As initially implemented, it fails your tests if you don't run the entire test
 file. `rspec spec/foo_spec.rb:32` will error, because .. running only one of
 your tests _doesn't cover the class_. I have a solution for this, but it uses
-some non-public bits of RSpec, so I'm trying to find a better answer first.
+some non-public bits of RSpec, so I'm trying to find a better answer still.
 (Conversation started in their
 [issue tracker](https://github.com/rspec/rspec-core/issues/3037))
 
-So far, I haven't found a _great_ way to report that there's a problem. The
-output from having insufficient coverage is _raising an exception from an
-`after(:context)` hook_, which RSpec rescues and formats for itself, and there
-aren't a lot of controls - it works, but it's a bit ugly and doesn't really
-give the right immediate impression. I'm contemplating using an `after(:suite)`
-hook and aggregating them myself, but at the end of the day RSpec is in control
-of the output stream, and we don't entirely fit its metaphor.
-
 We're using `Object.const_source_location` to find the path of the source file
 defining a given constant. That _mostly_ works, but it actually gives the path
 of the _first_ source file that defined that constant. So if your gem defines

data/lib/rspec/cover_it/context.rb

@@ -6,11 +6,18 @@ module RSpec
       end
 
       def cover_it?
-        target_class && metadata.fetch(:cover_it, autoenforce?)
+        target_class &&
+          metadata.fetch(:cover_it, autoenforce?) &&
+          completeness_checker.running_all_examples?
+      end
+
+      def specific_threshold
+        meta_value = metadata.fetch(:cover_it, nil)
+        meta_value.is_a?(Numeric) ? meta_value / 100.0 : nil
       end
 
       def target_path
-        Object.const_source_location(target_class_name).first
+        metadata.key?(:covers_path) ? metadata_path : inferred_path
       end
 
       def target_class
@@ -21,6 +28,10 @@ module RSpec
         target_class.name
       end
 
+      def scope_name
+        scope.file_path
+      end
+
       private
 
       attr_reader :scope, :rspec_context
@@ -32,6 +43,20 @@ module RSpec
       def metadata
         scope.metadata
       end
+
+      def completeness_checker
+        @_completeness_checker ||= ExampleGroupCompletenessChecker.new(scope)
+      end
+
+      def metadata_path
+        supplied_path = metadata.fetch(:covers_path)
+        spec_directory = File.dirname(scope.file_path)
+        File.expand_path(supplied_path, spec_directory)
+      end
+
+      def inferred_path
+        Object.const_source_location(target_class_name).first
+      end
     end
   end
 end

data/lib/rspec/cover_it/context_coverage.rb

@@ -24,8 +24,29 @@ module RSpec
         covered_line_count.to_f / coverable_line_count.to_f
       end
 
-      def enforce!
-        return if local_coverage.nil? || local_coverage_rate >= 1.0
+      def enforce!(default_threshold:)
+        if precovered?
+          fail_with_missing_code!
+        elsif local_coverage_rate < (context.specific_threshold || default_threshold)
+          fail_with_missing_coverage!
+        end
+      end
+
+      private
+
+      def fail_with_missing_code!
+        fail(MissingCode, <<~MESSAGE.tr("\n", " "))
+          Example group `#{context.scope_name}` is attempting to cover the code for class
+          `#{context.target_class}`, but it was located at `#{context.target_path}`,
+          and does not appear to have any code to cover (or it was all executed before the
+          tests started). If this is not the correct path for the code under test, please
+          specify the correct path using the `covers:` spec metadata - sometimes the
+          rspec-cover_it gem isn't properly able to infer the correct source path for a
+          class.
+        MESSAGE
+      end
+
+      def fail_with_missing_coverage!
         lines = local_coverage.each_with_index.select { |v, _i| v&.zero? }.map(&:last)
 
         summary =
@@ -36,11 +57,12 @@ module RSpec
           else
             "on #{lines.length} lines, including #{lines.first(10).map(&:to_s).join(", ")}"
           end
-        message = "Missing coverage in #{context.target_path} #{summary}"
-        fail(MissingCoverage, message)
-      end
 
-      private
+        fail(MissingCoverage, <<~MESSAGE.tr("\n", " "))
+          Example group `#{context.scope_name}` is missing coverage on
+          `#{context.target_class}` in `#{context.target_path}` #{summary}
+        MESSAGE
+      end
 
       attr_reader :context, :pretest_results
 
@@ -65,6 +87,11 @@ module RSpec
         return nil unless local_coverage
         local_coverage.count { |executions| executions && executions > 0 }
       end
+
+      def precovered?
+        return @_precovered if defined?(@_precovered)
+        @_precovered = pretest_coverage.nil? || pretest_coverage.none? { |n| n&.zero? }
+      end
     end
   end
 end

data/lib/rspec/cover_it/coverage_state.rb

@@ -3,8 +3,8 @@ module RSpec
     class CoverageState
       attr_reader :filter
 
-      def initialize(filter: nil, autoenforce: false)
-        @filter, @autoenforce = filter, autoenforce
+      def initialize(filter: nil, autoenforce: false, default_threshold: 100.0)
+        @filter, @autoenforce, @default_threshold = filter, autoenforce, default_threshold
         @pretest_results = nil
         @context_coverages = {}
       end
@@ -34,7 +34,7 @@ module RSpec
 
         context_coverage_for(context).tap do |context_coverage|
           context_coverage.postcontext_coverage = Coverage.peek_result[context.target_path]
-          context_coverage.enforce!
+          context_coverage.enforce!(default_threshold: default_threshold_rate)
         end
       end
 
@@ -46,6 +46,10 @@ module RSpec
         @autoenforce
       end
 
+      def default_threshold_rate
+        @default_threshold / 100.0
+      end
+
       def context_for(scope, rspec_context)
         Context.new(scope: scope, rspec_context: rspec_context, autoenforce: autoenforce?)
       end

data/lib/rspec/cover_it/example_group_completeness_checker.rb

@@ -0,0 +1,34 @@
+require "set"
+
+module RSpec
+  module CoverIt
+    class ExampleGroupCompletenessChecker
+      # This class uses some bits of the RSpec::Core::ExampleGroup api that are
+      # not documented, and are marked `@private` using YARD notation. But I
+      # found no other reasonable way to answer this question, so I've isolated
+      # my intrusion into this class - hopefully, there will be a more
+      # appropriate way to determine this information in the future; I've begun
+      # that conversation here: https://github.com/rspec/rspec-core/issues/3037
+
+      def initialize(example_group)
+        @example_group = example_group
+      end
+
+      def running_all_examples?
+        all_examples == filtered_examples
+      end
+
+      private
+
+      attr_reader :example_group
+
+      def all_examples
+        @_all_examples ||= example_group.descendants.flat_map(&:examples).to_set
+      end
+
+      def filtered_examples
+        @_filtered_examples ||= example_group.descendant_filtered_examples.to_set
+      end
+    end
+  end
+end

data/lib/rspec/cover_it/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module CoverIt
-    VERSION = "0.0.4"
+    VERSION = "0.0.6"
   end
 end

data/lib/rspec/cover_it.rb

@@ -3,6 +3,7 @@ require "coverage"
 module RSpec
   module CoverIt
     Error = Class.new(StandardError)
+    MissingCode = Class.new(Error)
     MissingCoverage = Class.new(Error)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-cover_it
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.6
 platform: ruby
 authors:
 - Eric Mueller
@@ -99,6 +99,7 @@ files:
 - lib/rspec/cover_it/context.rb
 - lib/rspec/cover_it/context_coverage.rb
 - lib/rspec/cover_it/coverage_state.rb
+- lib/rspec/cover_it/example_group_completeness_checker.rb
 - lib/rspec/cover_it/pretest_coverage.rb
 - lib/rspec/cover_it/version.rb
 - rspec-cover_it.gemspec