covered 0.25.1 → 0.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 374bfc6095d15b4908cd4faa5d3027742446cd4cb42e40c39a613d181c3d8e14
-  data.tar.gz: 53a805a6c2a9df4d2a869054a43389935213e757eaa0308b0c967f0fa88fd34e
+  metadata.gz: 0b3b51e8cda089a57c22c3ef8e75f7f0da473883048f2526c343eeaff2b96578
+  data.tar.gz: a4ae054e1b15e1c4a0398c2bd2aaa4ee2291fab2d4f3315eaf8e0772b6e5921c
 SHA512:
-  metadata.gz: 88832afe00019b3e76230e13a4eeb933b3f891e1bdc81f8c164783eae2bec7cb2fec8badffdecc61cebf2a9da8de019bb10c1a67c21ff423200deaf666e3f9dd
-  data.tar.gz: bf5c8da4e3fc34ca72915e1e5e2ca157deb329f3ebe498280ad2c70e73343997df29b1a04b22df22bdc08c1d11716221bbbe9f9dd27938d0170ef51eb58b3742
+  metadata.gz: 1e841ed5b73e93b103adae84f250f43e204b75d8acb3de82ef4ec0dc6ef10a2db8c7c28cf00cad3a094678480bf07f7a4425e0f6284ea481f0e70c1ed68f7baa
+  data.tar.gz: 6e9b2dab1f92cf567126d20ea2ec77dfd7c8959ac397b1f73cfd3793d91fc7672408452ef4cf345962e55425ea13014de79a9b16f0978fbc2156a43ac2a0746d

data/bake/covered/debug.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2022-2023, by Samuel Williams.
+# Copyright, 2022-2024, by Samuel Williams.
 
 def initialize(context)
 	super
@@ -15,7 +15,6 @@ end
 # @parameter execute [Boolean] Whether to execute the code.
 def parse(paths: [], execute: false)
 	files = output = Covered::Files.new
-	output = Covered::Source.new(output)
 	
 	paths.each do |path|
 		output.mark(path, 0, 0)

data/bake/covered/policy.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2023, by Samuel Williams.
+# Copyright, 2023-2024, by Samuel Williams.
+# Copyright, 2023, by Michael Adams.
 
 def initialize(context)
 	super
@@ -12,7 +13,7 @@ end
 # Load the current coverage policy.
 # Defaults to the default coverage path if no paths are specified.
 # @parameter paths [Array(String)] The coverage database paths.
-def current(paths: nil)
+def current(paths: nil, reports: Covered::Config.reports)
 	policy = Covered::Policy.new
 	
 	# Load the default path if no paths are specified:
@@ -29,6 +30,10 @@ def current(paths: nil)
 		Covered::Persist.new(policy.output, path).load!(ignore_mtime: true)
 	end
 	
+	if reports
+		policy.reports!(reports)
+	end
+	
 	return policy
 end
 

data/bake/covered/validate.rb

@@ -26,6 +26,8 @@ def validate(paths: nil, minimum: 1.0, input:)
 	# Print statistics:
 	statistics.print($stderr)
 	
+	policy.call(STDOUT)
+	
 	# Validate statistics and raise an error if they are not met:
 	statistics.validate!(minimum)
 end

data/lib/covered/config.rb

@@ -21,11 +21,11 @@ module Covered
 			end
 		end
 		
-		def self.coverage
+		def self.reports
 			ENV['COVERAGE']
 		end
 		
-		def self.load(root: self.root, coverage: self.coverage)
+		def self.load(root: self.root, reports: self.reports)
 			derived = Class.new(self)
 			
 			if path = self.path(root)
@@ -34,19 +34,19 @@ module Covered
 				derived.prepend(config)
 			end
 			
-			return derived.new(root, coverage)
+			return derived.new(root, reports)
 		end
 		
-		def initialize(root, coverage)
+		def initialize(root, reports)
 			@root = root
-			@coverage = coverage
+			@reports = reports
 			@policy = nil
 			
 			@environment = nil
 		end
 		
 		def report?
-			!!@coverage
+			!!@reports
 		end
 		
 		alias :record? :report?
@@ -61,6 +61,7 @@ module Covered
 			policy.output
 		end
 		
+		# Start coverage tracking.
 		def start
 			# Save and setup the environment:
 			@environment = ENV.to_h
@@ -70,6 +71,7 @@ module Covered
 			policy.start
 		end
 		
+		# Finish coverage tracking.
 		def finish
 			# Finish coverage tracking:
 			policy.finish
@@ -79,6 +81,8 @@ module Covered
 			@environment = nil
 		end
 		
+		# Generate coverage reports to the given output.
+		# @param output [IO] The output stream to write the coverage report to.
 		def call(output)
 			policy.call(output)
 		end
@@ -87,10 +91,18 @@ module Covered
 			policy.each(&block)
 		end
 		
+		# Which paths to ignore when computing coverage for a given project.
+		# @returns [Array(String)] An array of relative paths to ignore.
 		def ignore_paths
 			['test/', 'fixtures/', 'spec/', 'vendor/', 'config/']
 		end
 		
+		# Which paths to include when computing coverage for a given project.
+		# @returns [Array(String)] An array of relative patterns to include, e.g. `"lib/**/*.rb"`.
+		def include_patterns
+			["lib/**/*.rb"]
+		end
+		
 		# Override this method to implement your own policy.
 		def make_policy(policy)
 			# Only files in the root would be tracked:
@@ -104,11 +116,13 @@ module Covered
 			policy.skip(Regexp.union(patterns))
 			
 			# We will include all files under lib, even if they aren't loaded:
-			policy.include("lib/**/*.rb")
+			include_patterns.each do |pattern|
+				policy.include(pattern)
+			end
 			
 			policy.persist!
 			
-			policy.reports!(@coverage)
+			policy.reports!(@reports)
 		end
 		
 		protected

data/lib/covered/policy.rb

@@ -101,9 +101,9 @@ module Covered
 			end
 		end
 		
-		def reports!(coverage)
-			if coverage.is_a?(String)
-				names = coverage.split(',')
+		def reports!(reports)
+			if reports.is_a?(String)
+				names = reports.split(',')
 				
 				names.each do |name|
 					begin
@@ -113,8 +113,14 @@ module Covered
 						@reports << Autoload.new(name)
 					end
 				end
-			elsif coverage
+			elsif reports == true
 				@reports << Covered::BriefSummary.new
+			elsif reports == false
+				@reports.clear
+			elsif reports.is_a?(Array)
+				@reports.concat(reports)
+			else
+				@reports << reports
 			end
 		end
 		

data/lib/covered/version.rb

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

data/license.md

@@ -1,11 +1,12 @@
 # MIT License
 
-Copyright, 2018-2023, by Samuel Williams.  
+Copyright, 2018-2024, by Samuel Williams.  
 Copyright, 2018, by Shannon Skipper.  
 Copyright, 2019, by Cyril Roelandt.  
 Copyright, 2022, by Adam Daniels.  
 Copyright, 2022, by Felix Yan.  
 Copyright, 2023, by Stephen Ierodiaconou.  
+Copyright, 2023, by Michael Adams.  
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/readme.md

@@ -11,8 +11,7 @@ into Ruby.
     platforms.
   - Supports coverage of views - templates compiled to Ruby code can be tracked for coverage reporting.
 
-[![Development
-Status](https://github.com/ioquatix/covered/workflows/Test/badge.svg)](https://github.com/ioquatix/covered/actions?workflow=Test)
+[![Development Status](https://github.com/ioquatix/covered/workflows/Test/badge.svg)](https://github.com/ioquatix/covered/actions?workflow=Test)
 
 ## Motivation
 
@@ -25,10 +24,11 @@ After this concept prooved useful, [it was integrated directly into Ruby](https:
 
 ## Usage
 
-Please see the [project documentation](https://github.com/ioquatix/covered) for more details.
+Please see the [project documentation](https://ioquatix.github.io/covered/) for more details.
 
-  - [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.
+  - [Getting Started](https://ioquatix.github.io/covered/guides/getting-started/index) - This guide explains how to get started with `covered` and integrate it with your test suite.
+
+  - [Configuration](https://ioquatix.github.io/covered/guides/configuration/index) - This guide will help you to configure covered for your project's specific requirements.
 
 ## See Also
 
@@ -48,10 +48,8 @@ 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 the [Contributor Covenant](https://www.contributor-covenant.org/). All contributors and participants agree to abide by its terms.

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: covered
 version: !ruby/object:Gem::Version
-  version: 0.25.1
+  version: 0.26.0
 platform: ruby
 authors:
 - Samuel Williams
 - Adam Daniels
 - Cyril Roelandt
 - Felix Yan
+- Michael Adams
 - Shannon Skipper
 - Stephen Ierodiaconou
 autorequire:
@@ -42,7 +43,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2023-10-29 00:00:00.000000000 Z
+date: 2024-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: console
@@ -105,7 +106,9 @@ homepage: https://github.com/ioquatix/covered
 licenses:
 - MIT
 metadata:
+  documentation_uri: https://ioquatix.github.io/covered/
   funding_uri: https://github.com/sponsors/ioquatix/
+  source_code_uri: https://github.com/ioquatix/covered.git
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -114,14 +117,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: A modern approach to code coverage.