rspec-cover_it 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7646cf84b3b24df43ca171de7628e65347bbdc8270dd4ff1de2c3bdc6d44596f
-  data.tar.gz: 47e86f853552fadfa9f64a478871fad62db530e4840d8887a6513593a6505032
+  metadata.gz: b3efab53f0b9f05be2f5a8ae7f170e4a3a8e886439a751e025926c61bf9ac8f1
+  data.tar.gz: 569fbdcc5f328d5d0656eb3fe20265c9cd164455cfbf290c7764b92d15454fbf
 SHA512:
-  metadata.gz: 114cb6e33e6867b1c4e4dadc43690e67feeb01cbcdab39bcd24d3d563e65323e43eb09dd2d78f8c5056f1b27faad3ba0f9383a31b5fb216674c92998dc718258
-  data.tar.gz: d89f76882f68ffbf6978407fa6f588e29fa87cf66f6cd64bc985af9510232168204d81925975f739e9cf2961e345b871a45c7ac8894e75f0ea0db6855a2d60d1
+  metadata.gz: e9d198749c87a093cf8cbf5d2e5a4f20bfdb1a4c312579a541d8335fa4ccab88781fdbee073195cf8d5c682d921019c9fb86ede9fe951e57f83df24722934c59
+  data.tar.gz: 604d4808f4a3d8afacf52cfe0651d4bbae46ee510ca95e123cd14304b071cbf1c726bf37741002efdd0d9dc636625b47d149f0a17226c26f42cdad0ba531be7f

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,14 +122,16 @@ 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
+its version in `lib/foo/version.rb` (as an example), in a separate file from
+lib/foo.rb, the _path_ for `Foo` may end up being the former. Which is.. not
+going to have much coverable code, of course. This is an edge case, but one
+that is likely to occur fairly regularly. I haven't thought of a _good_ solution
+yet. Perhaps if the `covers` array includes a string, we should treat it as a
+relative path?

data/lib/rspec/cover_it/context.rb

@@ -1,16 +1,23 @@
 module RSpec
   module CoverIt
     class Context
-      def initialize(scope:, rspec_context:)
-        @scope, @rspec_context = scope, rspec_context
+      def initialize(scope:, rspec_context:, autoenforce:)
+        @scope, @rspec_context, @autoenforce = scope, rspec_context, autoenforce
       end
 
       def cover_it?
-        target_class && metadata.fetch(:cover_it, nil)
+        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,13 +28,35 @@ module RSpec
         target_class.name
       end
 
+      def scope_name
+        scope.file_path
+      end
+
       private
 
       attr_reader :scope, :rspec_context
 
+      def autoenforce?
+        @autoenforce
+      end
+
       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_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 =
@@ -40,8 +61,6 @@ module RSpec
         fail(MissingCoverage, message)
       end
 
-      private
-
       attr_reader :context, :pretest_results
 
       def target_path
@@ -65,6 +84,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:)
-        @filter = filter
+      def initialize(filter: nil, autoenforce: false, default_threshold: 100.0)
+        @filter, @autoenforce, @default_threshold = filter, autoenforce, default_threshold
         @pretest_results = nil
         @context_coverages = {}
       end
@@ -20,7 +20,7 @@ module RSpec
       end
 
       def start_tracking_for(scope, rspec_context)
-        context = Context.new(scope: scope, rspec_context: rspec_context)
+        context = context_for(scope, rspec_context)
         return unless context.cover_it?
 
         context_coverage_for(context).tap do |context_coverage|
@@ -29,12 +29,12 @@ module RSpec
       end
 
       def finish_tracking_for(scope, rspec_context)
-        context = Context.new(scope: scope, rspec_context: rspec_context)
+        context = context_for(scope, rspec_context)
         return unless context.cover_it?
 
         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
 
@@ -42,6 +42,18 @@ module RSpec
 
       attr_reader :pretest_results
 
+      def autoenforce?
+        @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
+
       def context_coverage_for(context)
         @context_coverages[context.target_class] ||= ContextCoverage.new(
           context: context,

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/pretest_coverage.rb

@@ -4,7 +4,7 @@ module RSpec
       def initialize(filter:, results:)
         @filter = filter
         @results = results
-          .select { |k, _v| k.start_with?(filter) }
+          .select { |k, _v| filter.nil? || k.start_with?(filter) }
           .map { |k, v| [k, v.dup] }
           .to_h
       end

data/lib/rspec/cover_it/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module CoverIt
-    VERSION = "0.0.3"
+    VERSION = "0.0.5"
   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
@@ -16,8 +17,8 @@ module RSpec
       attr_accessor :state
     end
 
-    def self.setup(filter:)
-      RSpec::CoverIt.state = CoverageState.new(filter: filter)
+    def self.setup(filter: nil, autoenforce: false)
+      RSpec::CoverIt.state = CoverageState.new(filter: filter, autoenforce: autoenforce)
       RSpec::CoverIt.state.start_tracking
 
       RSpec.configure do |config|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-cover_it
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
 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