covered 0.22.1 → 0.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c83b08be821b20f583a8e9f7c0c5eff4ded0852016e73e93d3a29f63ed33d79b
-  data.tar.gz: 8a8cf40418633108d9b5bbb491eaf0c06dc7be5f53a11f2bbc3fac4abfca5cd3
+  metadata.gz: 0a79659c74af1e795823f64d18c4829240e5be7cdcf03b3f719680b9d29f9522
+  data.tar.gz: f0d8ad9bb7330adf479b0a028bc7a03e73ff35f091d79c4308f461f984f65f77
 SHA512:
-  metadata.gz: 25f75fb59e078f2d89ca296a583a70d3b93817a4bb3e7863dbecc40a0bc13c21d0a0a66a536960c967483f27a036e25063960d40d52c20dde94fe320b34cb634
-  data.tar.gz: 7e594df30c68df8df4cf71f0b8063f69dc0e3885d962cc176bbf0a2bf1c2408d6ab6fe2df31f524bcfc5d6162954a7e6f598084d76c851266fad317e0fbb65f0
+  metadata.gz: d205944455af6959144bc22e7456ed165d308fde5989b5e6b781458aead3ded563fc7efcea3fa3ede628e85d0b678dcad82f0caa4ce851c3fa02ebd2f3432a08
+  data.tar.gz: 5f1d51e92917387f004e38e4e7ad0754ff1063ea348a7a4a36d52b27703fc1bb66ecd8dbc8a5815aeeaeaf71663e49c6faf072e7e7fec984c5c7c368d0035719

data/bake/covered/policy.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2023, by Samuel Williams.
+
+def initialize(context)
+	super
+	
+	require_relative '../../lib/covered/config'
+end
+
+# Load the current coverage policy.
+def current(paths: nil)
+	policy = Covered::Policy.new
+	
+	# Load the default path if no paths are specified:
+	paths ||= Dir.glob(Covered::Persist::DEFAULT_PATH, base: context.root)
+	
+	# If no paths are specified, raise an error:
+	if paths.empty?
+		raise ArgumentError, "No coverage paths specified!"
+	end
+	
+	# Load all coverage information:
+	paths.each do |path|
+		# It would be nice to have a better algorithm here than just ignoring mtime - perhaps using checksums?
+		Covered::Persist.new(policy.output, path).load!(ignore_mtime: true)
+	end
+	
+	return policy
+end

data/bake/covered/validate.rb

@@ -12,22 +12,9 @@ end
 # Validate the coverage of multiple test runs.
 # @parameter paths [Array(String)] The coverage database paths.
 # @parameter minimum [Float] The minimum required coverage in order to pass.
-def validate(paths: nil, minimum: 1.0)
-	policy = Covered::Policy.new
-	
-	# Load the default path if no paths are specified:
-	paths ||= Dir.glob(Covered::Persist::DEFAULT_PATH, base: context.root)
-	
-	# If no paths are specified, raise an error:
-	if paths.empty?
-		raise ArgumentError, "No coverage paths specified!"
-	end
-	
-	# Load all coverage information:
-	paths.each do |path|
-		# It would be nice to have a better algorithm here than just ignoring mtime - perhaps using checksums?
-		Covered::Persist.new(policy.output, path).load!(ignore_mtime: true)
-	end
+# @parameter input [Covered::Policy] The input policy to validate.
+def validate(paths: nil, minimum: 1.0, input:)
+	policy ||= context.lookup("covered:policy:current").call(paths: paths)
 	
 	# Calculate statistics:
 	statistics = Covered::Statistics.new

data/lib/covered/coverage.rb

@@ -3,6 +3,8 @@
 # Released under the MIT License.
 # Copyright, 2018-2023, by Samuel Williams.
 
+require_relative 'source'
+
 module Covered
 	module Ratio
 		def ratio
@@ -20,66 +22,11 @@ module Covered
 		end
 	end
 	
-	class Source
-		def self.for(path, code, line_offset)
-			self.new(path, code: code, line_offset: line_offset)
-		end
-		
-		def initialize(path, code: nil, line_offset: 1, modified_time: nil)
-			@path = path
-			@code = code
-			@line_offset = line_offset
-			@modified_time = modified_time
-		end
-		
-		attr_accessor :path
-		attr :code
-		attr :line_offset
-		attr :modified_time
-		
-		def to_s
-			"\#<#{self.class} path=#{path}>"
-		end
-		
-		def read(&block)
-			if block_given?
-				File.open(self.path, "r", &block)
-			else
-				File.read(self.path)
-			end
-		end
-		
-		# The actual code which is being covered. If a template generates the source, this is the generated code, while the path refers to the template itself.
-		def code!
-			self.code || self.read
-		end
-		
-		def code?
-			!!self.code
-		end
-		
-		def serialize(packer)
-			packer.write(self.path)
-			packer.write(self.code)
-			packer.write(self.line_offset)
-			packer.write(self.modified_time)
-		end
-		
-		def self.deserialize(unpacker)
-			path = unpacker.read
-			code = unpacker.read
-			line_offset = unpacker.read
-			modified_time = unpacker.read
-			
-			self.new(path, code: code, line_offset: line_offset, modified_time: modified_time)
-		end
-	end
-	
 	class Coverage
 		include Ratio
 		
 		def self.for(path, **options)
-			self.new(Source.new(path, **options))
+			self.new(Source.for(path, **options))
 		end
 		
 		def initialize(source, counts = [], annotations = {}, total = nil)
@@ -94,6 +41,12 @@ module Covered
 			@executed_lines = nil
 		end
 		
+		# Construct a new coverage object for the given line numbers. Only the given line numbers will be considered for the purposes of computing coverage.
+		# @parameter line_numbers [Array(Integer)] The line numbers to include in the new coverage object.
+		def for_lines(line_numbers)
+			self.class.new(@source, @counts.values_at(*line_numbers), @annotations)
+		end
+		
 		def path
 			@source.path
 		end
@@ -104,8 +57,8 @@ module Covered
 		
 		def fresh?
 			if @source.modified_time.nil?
-				# We don't know when the file was last modified, so we assume it is fresh:
-				return true
+				# We don't know when the file was last modified, so we assume it is stale:
+				return false
 			end
 			
 			unless File.exist?(@source.path)

data/lib/covered/files.rb

@@ -12,7 +12,7 @@ module Covered
 	class Files < Base
 		class State
 			def self.for(path, **options)
-				self.new(Source.new(path, **options))
+				self.new(Source.for(path, **options))
 			end
 			
 			def initialize(source)

data/lib/covered/minitest.rb

@@ -21,9 +21,7 @@ module Covered
 end
 
 if $covered.record?
-	class << Minitest
-		prepend Covered::Minitest
-	end
+	Minitest.singleton_class.prepend(Covered::Minitest)
 	
 	Minitest.after_run do
 		$covered.finish

data/lib/covered/persist.rb

@@ -26,8 +26,13 @@ module Covered
 					coverage.path = path
 				end
 				
-				add(coverage)
+				if ignore_mtime || coverage.fresh?
+					add(coverage)
+					return true
+				end
 			end
+			
+			return false
 		end
 		
 		def serialize(coverage)

data/lib/covered/source.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2018-2023, by Samuel Williams.
+
+module Covered
+	class Source
+		def self.for(path, **options)
+			if File.exist?(path)
+				options[:code] ||= File.read(path)
+				options[:modified_time] ||= File.mtime(path)
+			end
+			
+			self.new(path, **options)
+		end
+		
+		def initialize(path, code: nil, line_offset: 1, modified_time: nil)
+			@path = path
+			@code = code
+			@line_offset = line_offset
+			@modified_time = modified_time
+		end
+		
+		attr_accessor :path
+		attr :code
+		attr :line_offset
+		attr :modified_time
+		
+		def to_s
+			"\#<#{self.class} path=#{path}>"
+		end
+		
+		def read(&block)
+			if block_given?
+				File.open(self.path, "r", &block)
+			else
+				File.read(self.path)
+			end
+		end
+		
+		# The actual code which is being covered. If a template generates the source, this is the generated code, while the path refers to the template itself.
+		def code!
+			self.code || self.read
+		end
+		
+		def code?
+			!!self.code
+		end
+		
+		def serialize(packer)
+			packer.write(self.path)
+			packer.write(self.code)
+			packer.write(self.line_offset)
+			packer.write(self.modified_time)
+		end
+		
+		def self.deserialize(unpacker)
+			path = unpacker.read
+			code = unpacker.read
+			line_offset = unpacker.read
+			modified_time = unpacker.read
+			
+			self.new(path, code: code, line_offset: line_offset, modified_time: modified_time)
+		end
+	end
+end

data/lib/covered/statistics.rb

@@ -11,6 +11,12 @@ module Covered
 	end
 	
 	class Statistics < Wrapper
+		def self.for(coverage)
+			self.new.tap do |statistics|
+				statistics << coverage
+			end
+		end
+		
 		def initialize
 			@count = 0
 			@executable_count = 0
@@ -26,6 +32,19 @@ module Covered
 		# The number of lines that were executed.
 		attr :executed_count
 		
+		def as_json
+			{
+				count: count,
+				executable_count: executable_count,
+				executed_count: executed_count,
+				percentage: percentage.to_f.round(2),
+			}
+		end
+		
+		def to_json(options)
+			as_json.to_json(options)
+		end
+		
 		def << coverage
 			@count += 1
 			

data/lib/covered/version.rb

@@ -4,5 +4,5 @@
 # Copyright, 2018-2023, by Samuel Williams.
 
 module Covered
-	VERSION = "0.22.1"
+	VERSION = "0.23.0"
 end

data/readme.md

@@ -1,86 +1,40 @@
 # Covered
 
-[![Development Status](https://github.com/ioquatix/covered/workflows/Test/badge.svg)](https://github.com/ioquatix/covered/actions?workflow=Test)
+![Screenshot](media/example.png)
 
-Covered uses modern Ruby features to generate comprehensive coverage, including support for templates which are compiled into Ruby.
+Covered uses modern Ruby features to generate comprehensive coverage, including support for templates which are compiled
+into Ruby.
 
-  - Incremental coverage - if you run your full test suite, and the run a subset, it will still report the correct coverage - so you can incrementally work on improving coverage.
-  - Integration with RSpec, Minitest, Travis & Coveralls - no need to configure anything - out of the box support for these platforms.
+  - Incremental coverage - if you run your full test suite, and the run a subset, it will still report the correct
+    coverage - so you can incrementally work on improving coverage.
+  - Integration with Sus, Git, RSpec and Minitest- no need to configure anything - out of the box support for these
+    platforms.
   - Supports coverage of views - templates compiled to Ruby code can be tracked for coverage reporting.
 
-![Screenshot](media/example.png)
+[![Development
+Status](https://github.com/ioquatix/covered/workflows/Test/badge.svg)](https://github.com/ioquatix/covered/actions?workflow=Test)
 
 ## Motivation
 
-Existing Ruby coverage tools are unable to handle `eval`ed code. This is because the `coverage` module built into Ruby doesn't expose the necessary hooks to capture it. Using the [parser](https://github.com/whitequark/parser) gem allows us to do our own source code analysis to compute executable lines, thus making it possible to compute coverage for "templates".
-
-It's still tricky to do it correctly, but it is feasible now to compute coverage of web application "views" by using this technique. This gem is an exploration to see what is possible.
-
-## Installation
-
-Add this line to your application's `Gemfile`:
-
-``` ruby
-gem 'covered'
-```
-
-### RSpec Integration
-
-In your `spec/spec_helper.rb` add the following before loading any other code:
-
-``` ruby
-require 'covered/rspec'
-```
-
-Ensure that you have a `.rspec` file with `--require spec_helper`:
-
-    --require spec_helper
-    --format documentation
-    --warnings
-
-### Minitest Integration
+Originally, Ruby coverage tools were unable to handle `eval`ed code. This is because the `coverage` module built into
+Ruby doesn't expose the necessary hooks to capture it. Using the [parser](https://github.com/whitequark/parser) gem and
+trace points allows us to do our own source code analysis to compute executable lines, thus making it possible to
+compute coverage for "templates".
 
-In your `test/test_helper.rb` add the following before loading any other code:
-
-``` ruby
-require 'covered/minitest'
-require 'minitest/autorun'
-```
-
-In your test files, e.g. `test/dummy_test.rb` add the following at the top:
-
-``` ruby
-require_relative 'test_helper'
-```
+After this concept prooved useful, [it was integrated directly into Ruby](https://bugs.ruby-lang.org/issues/19008).
 
 ## Usage
 
-When running `rspec`, you can specify the kind of coverage analysis you would like:
-
-    COVERAGE=Summary rspec
-
-If no `COVERAGE` is specified, coverage tracking will be finishd.
-
-### Template Coverage
-
-Covered supports coverage of templates which are compiled into Ruby code. This is only supported on Ruby 3.2+ due to enhancements in the coverage interface.
-
-### Partial Summary
-
-    COVERAGE=PartialSummary rspec
-
-This report only shows snippets of source code with incomplete coverage.
-
-### Brief Summary
-
-    COVERAGE=BriefSummary rspec
+Please see the [project documentation](https://github.com/ioquatix/covered) for more details.
 
-This report lists several files in order of least coverage.l
+  - [Getting Started](https://github.com/ioquatix/coveredguides/getting-started/index) - This guide explains how to get
+    started with `covered` and integrate it with your test suite.
 
 ## See Also
 
-  - [coveralls-ruby](https://github.com/lemurheavy/coveralls-ruby) – the official Coveralls implementation for Ruby.
-  - [simplecov](https://github.com/colszowka/simplecov) – one of the original coverage implementations for Ruby, uses the built-in `coverage` library.
+  - [simplecov](https://github.com/colszowka/simplecov) – one of the original coverage implementations for Ruby, uses
+    the built-in `coverage` library.
+  - [sus](https://github.com/ioquatix/sus) - a test framework which uses `covered` to generate coverage reports.
 
 ## Contributing
 
@@ -94,8 +48,10 @@ We welcome contributions to this project.
 
 ### Developer Certificate of Origin
 
-This project uses the [Developer Certificate of Origin](https://developercertificate.org/). All contributors to this project must agree to this document to have their contributions accepted.
+This project uses the [Developer Certificate of Origin](https://developercertificate.org/). All contributors to this
+project must agree to this document to have their contributions accepted.
 
 ### Contributor Covenant
 
-This project is governed by [Contributor Covenant](https://www.contributor-covenant.org/). All contributors and participants agree to abide by its terms.
+This project is governed by [Contributor Covenant](https://www.contributor-covenant.org/). All contributors and
+participants agree to abide by its terms.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: covered
 version: !ruby/object:Gem::Version
-  version: 0.22.1
+  version: 0.23.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -42,7 +42,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2023-07-17 00:00:00.000000000 Z
+date: 2023-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: console
@@ -79,6 +79,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - bake/covered/debug.rb
+- bake/covered/policy.rb
 - bake/covered/validate.rb
 - lib/covered.rb
 - lib/covered/autostart.rb
@@ -92,6 +93,7 @@ files:
 - lib/covered/persist.rb
 - lib/covered/policy.rb
 - lib/covered/rspec.rb
+- lib/covered/source.rb
 - lib/covered/statistics.rb
 - lib/covered/summary.rb
 - lib/covered/sus.rb