rspec-cover_it 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 528de4fe406f539d93d8632624714721d8cded1463a35776c16423d387c13c30
-  data.tar.gz: 57fc958451fb2dfeafb94aaaed56aba38befd938a4ea24d2f82d0ac09a46ee4e
+  metadata.gz: 66c4b3e0c88dffe53a1d435d40d4e1bdb52038661d8abb89ccc29ef6974398e2
+  data.tar.gz: 563d49e4e8656ea8da53defeb9e2d5f7ed9a91d36e5de0df126213f35dee6813
 SHA512:
-  metadata.gz: 6c636b00bd14fd976d53f9f97cbd2d53334ecb5677ad480ef00e737b51144da2f0ae76fffc1f6d1fb0366381961311e8aec93dfe6453cc2942c10dc652d87a88
-  data.tar.gz: 93c2432a8ce2725b2ca3ff9f1c8115a38154dc7c4426f7aa5667d12ed9546b9890d83885bcbe727064ea78972e58ab4e721b6dcef82d93c004d95f8a8ae6609f
+  metadata.gz: e17ac79db233e4a1f9571f98d025c37cf2e3c304155838fc221507ef5ac6a24aecb47be2f0a6678423009254a0bb5eac442ce775f4ad8bb3f9a66554e9f09fd6
+  data.tar.gz: 0c9afcc6b5f019c185365e5c40925a3b96b4108133d1dcc6150edb182780c35e2a946693106fdf9299e507007a1adfb1dc33cbc341b95f729cea1faf202bbab2

data/README.md

@@ -78,7 +78,30 @@ We use `Object.const_source_location` to find the file that defines the
 means that, if you are reopening the class somewhere else, that coverage won't
 be checked; if you are including 15 Concerns, and don't intend to write separate
 specs for them, be sure to list them as `covers:` metadata on the test. Also,
-shame!.
+shame!
+
+## Output
+
+When there's missing coverage on the class under test, you'll currently see
+output like this:
+
+```
+❯ rspec
+
+Randomized with seed 29392
+...............................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................
+An error occurred in an `after(:context)` hook.
+Failure/Error: fail(MissingCoverage, message)
+  Missing coverage in /Users/emueller/src/quiet_quality/lib/quiet_quality/message.rb on line 7
+# /Users/emueller/src/rspec-cover_it/lib/rspec/cover_it/context_coverage.rb:40:in `enforce!'
+# /Users/emueller/src/rspec-cover_it/lib/rspec/cover_it/coverage_state.rb:37:in `block in finish_tracking_for'
+# /Users/emueller/src/rspec-cover_it/lib/rspec/cover_it/coverage_state.rb:35:in `finish_tracking_for'
+# /Users/emueller/src/rspec-cover_it/lib/rspec/cover_it.rb:26:in `block (2 levels) in setup'
+.....................................................................................................................................................................................................................................................................................................
+
+Finished in 1.06 seconds (files took 0.28925 seconds to load)
+852 examples, 0 failures, 1 error occurred outside of examples
+```
 
 ## Drawbacks and Shortcomings
 
@@ -103,3 +126,13 @@ 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,12 +1,12 @@
 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?)
       end
 
       def target_path
@@ -25,6 +25,10 @@ module RSpec
 
       attr_reader :scope, :rspec_context
 
+      def autoenforce?
+        @autoenforce
+      end
+
       def metadata
         scope.metadata
       end

data/lib/rspec/cover_it/context_coverage.rb

@@ -8,6 +8,10 @@ module RSpec
 
       attr_accessor :precontext_coverage, :postcontext_coverage
 
+      def pretest_coverage
+        @_pretest_coverage ||= pretest_results[target_path]
+      end
+
       def local_coverage
         return nil unless precontext_coverage && postcontext_coverage
         @_local_coverage ||= pretest_coverage
@@ -20,18 +24,30 @@ 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
+        lines = local_coverage.each_with_index.select { |v, _i| v&.zero? }.map(&:last)
+
+        summary =
+          if lines.length == 1
+            "on line #{lines.first}"
+          elsif lines.length <= 10
+            "on lines #{lines.map(&:to_s).join(", ")}"
+          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
 
-      attr_reader :context, :pretest_results, :precontext_coverage, :postcontext_coverage
+      attr_reader :context, :pretest_results
 
       def target_path
         @_target_path ||= context.target_path
       end
 
-      def pretest_coverage
-        @_pretest_coverage ||= pretest_results[target_path]
-      end
-
       # Really, we shouldn't see nil for any of these values unless they are all
       # nil. We want the coverage we'd expect to have seen if we ran _just_ this
       # groups of examples, which ought boe the pretest coverage, plus the

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)
+        @filter, @autoenforce = filter, autoenforce
         @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]
-          fail("missing coverage!") if context_coverage.local_coverage_rate < 1.0
+          context_coverage.enforce!
         end
       end
 
@@ -42,6 +42,14 @@ module RSpec
 
       attr_reader :pretest_results
 
+      def autoenforce?
+        @autoenforce
+      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/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.2"
+    VERSION = "0.0.4"
   end
 end

data/lib/rspec/cover_it.rb

@@ -16,8 +16,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.2
+  version: 0.0.4
 platform: ruby
 authors:
 - Eric Mueller