covered 0.14.2 → 0.15.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6ce67ae80be9650cde586f9bb8e0496dfebcd2ad7b8176714657cad29cd1eac
-  data.tar.gz: fa0475934c2c8b95e383ce494c69264f74fb29d7a31f33c2218459e71e7b747d
+  metadata.gz: 112c85633150c4f05435b29a2867a51a711a9f216fdbe850c0356b0371ab4e49
+  data.tar.gz: 2efa0d7a7d07ca3125237c55b4e1d34fd4835e5f9d963344f1c7b4b9405d37eb
 SHA512:
-  metadata.gz: 5cecc1f2ab8fc64c0003734a7e98acba98ad25310ae28be596b21f4230dbf856922b4f495428587353ace8bf568edae6d82ae1051f2a5150ee415b3f6b9107fe
-  data.tar.gz: 13cffc32f6884dda4911caba487d583b95bcf3f5830b5322674749ba308b839d8ad72b52a1c75dfe42fda533b0c02c55ab15638d11065386a89aed0a70d0327e
+  metadata.gz: 054c6dca966431d180da1ff4e98afadea19400ec2ea28a2f7b4a3096ae6affdcc0082f939bb612cc3440861b4e1bd55e1b88dc03b7a93205ec19d2e3935fb5fd
+  data.tar.gz: f9ea6aacbb0993749c4e808f09c8b6bcccfa5d7f6c640fcdf83a79a7432fffd893008ccb6aed9314801f1c79446dcb82bdfc919e55c1564ca5691920a6371073

checksums.yaml.gz.sig

@@ -1,3 +1,3 @@
-̅ݒl4
-h
-����M�ё3���I")8*�R����G<
+q�dq������y��7�'��e�&ep)0��b�?[��WØjK%�-� a�I�GS�`��fK�|C���5�[��/�^i
��V�#r���I��}���y����
+�L���{�.�}���{��.0R���+�p�?
+$��Y��g��:��4�����%G�k��Ћ�%�2��a�B��2

data/bake/covered/validate.rb

@@ -0,0 +1,26 @@
+
+def initialize(context)
+	super
+	
+	require_relative '../../lib/covered/policy/default'
+end
+
+# Validate the coverage of multiple test runs.
+# @parameter paths [Array(String)] The coverage database paths.
+# @parameter minumum [Float] The minimum required coverage in order to pass.
+def validate(paths: nil, minimum: 1.0)
+	paths&.each do |path|
+		# It would be nice to have a better algorithm here than just ignoring mtime - perhaps using checksums?
+		Covered::Persist.new($covered.output, path).load!(ignore_mtime: true)
+	end
+	
+	$covered.flush
+	
+	statistics = Covered::Statistics.new
+	
+	$covered.each do |coverage|
+		statistics << coverage
+	end
+	
+	statistics.validate!(minimum)
+end

data/lib/covered/cache.rb

@@ -0,0 +1,65 @@
+# Copyright, 2018, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require_relative 'wrapper'
+
+require 'coverage'
+
+module Covered
+	class Cache < Wrapper
+		def initialize(output)
+			super(output)
+			
+			@marks = nil
+		end
+		
+		def mark(path, lineno, count = 1)
+			if @marks
+				@marks << path << lineno << count
+			else
+				super
+			end
+		end
+		
+		def enable
+			@marks = []
+			
+			super
+		end
+		
+		def flush
+			if @marks
+				@marks.each_slice(3) do |path, lineno, count|
+					@output.mark(path, lineno, count)
+				end
+				
+				@marks = nil
+			end
+			
+			super
+		end
+		
+		def disable
+			super
+			
+			flush
+		end
+	end
+end

data/lib/covered/capture.rb

@@ -59,35 +59,6 @@ module Covered
 		end
 	end
 	
-	class Cache < Wrapper
-		def initialize(output)
-			super(output)
-			@marks = []
-		end
-		
-		def mark(path, lineno, count = 1)
-			@marks << path << lineno << count
-		end
-		
-		def enable
-			super
-		end
-		
-		def flush
-			@marks.each_slice(3) do |path, lineno, count|
-				@output.mark(path, lineno, count)
-			end
-			
-			@marks.clear
-		end
-		
-		def disable
-			super
-			
-			flush
-		end
-	end
-	
 	# class Capture < Wrapper
 	# 	def enable
 	# 		super

data/lib/covered/persist.rb

@@ -23,6 +23,7 @@ require_relative 'wrapper'
 require 'msgpack'
 require 'time'
 require 'set'
+require 'console'
 
 module Covered
 	class Persist < Wrapper
@@ -32,18 +33,27 @@ module Covered
 			super(output)
 			
 			@path = path
-			
 			@touched = Set.new
 		end
 		
-		def apply(record)
+		def apply(record, ignore_mtime: false)
 			# The file must still exist:
 			return unless path = expand_path(record[:path])
-			return unless File.exist? path
+			
+			unless File.exist?(path)
+				Console.logger.debug(self) {"Ignoring coverage, path #{path} does not exist!"}
+				return
+			end
 			
 			# If the file has been modified since... we can't use the coverage.
 			return unless mtime = record[:mtime]
-			return if File.mtime(path).to_f > record[:mtime]
+			
+			unless ignore_mtime
+				if File.mtime(path).to_f > record[:mtime]
+					Console.logger.debug(self) {"Ignoring coverage, path #{path} has been updated: #{File.mtime(path).to_f} > #{record[:mtime]}!"}
+					return
+				end
+			end
 			
 			record[:coverage].each_with_index do |count, index|
 				@output.mark(path, index, count) if count
@@ -59,22 +69,28 @@ module Covered
 			}
 		end
 		
-		def load!(path = @path)
+		def load!(**options)
 			return unless File.exist?(@path)
 			
 			# Load existing coverage information and mark all files:
 			File.open(@path, "rb") do |file|
 				file.flock(File::LOCK_SH)
 				
-				make_unpacker(file).each(&self.method(:apply))
+				Console.logger.debug(self) {"Loading from #{@path} with #{options}..."}
+				
+				make_unpacker(file).each do |record|
+					self.apply(record, **options)
+				end
 			end
 		end
 		
-		def save!(path = @path)
+		def save!
 			# Dump all coverage:
 			File.open(@path, "wb") do |file|
 				file.flock(File::LOCK_EX)
 				
+				Console.logger.debug(self) {"Saving to #{@path}..."}
+				
 				packer = make_packer(file)
 				
 				self.each do |coverage|
@@ -87,7 +103,7 @@ module Covered
 		
 		def mark(file, line, count)
 			@touched << file
-		
+			
 			super
 		end
 		
@@ -97,6 +113,12 @@ module Covered
 			load!
 		end
 		
+		def flush
+			load!
+			
+			super
+		end
+		
 		def disable
 			super
 			

data/lib/covered/policy/default.rb

@@ -20,21 +20,25 @@
 
 require_relative '../policy'
 
-$covered = Covered.policy do
-	cache!
-	
-	# Only files in the root would be tracked:
-	root(Dir.pwd)
-	
-	# We will ignore any files in the test or spec directory:
-	skip(/^.*\/(test|spec|vendor)\//)
-	
-	# We will include all files under lib, even if they aren't loaded:
-	include("lib/**/*.rb")
-	
-	persist!
-	
-	source
-	
-	reports!
+if File.exist?("config/coverage.rb")
+	load("config/coverage.rb")
+else
+	$covered = Covered.policy do
+		cache!
+		
+		# Only files in the root would be tracked:
+		root(Dir.pwd)
+		
+		# We will ignore any files in the test or spec directory:
+		skip(/^.*\/(test|spec|vendor)\//)
+		
+		# We will include all files under lib, even if they aren't loaded:
+		include("lib/**/*.rb")
+		
+		persist!
+		
+		source
+		
+		reports!
+	end
 end

data/lib/covered/policy.rb

@@ -22,6 +22,7 @@ require_relative "summary"
 require_relative "files"
 require_relative "source"
 require_relative "capture"
+require_relative "cache"
 require_relative "persist"
 
 module Covered
@@ -42,6 +43,8 @@ module Covered
 			@reports = []
 		end
 		
+		attr :output
+		
 		def freeze
 			return self if frozen?
 			
@@ -91,6 +94,10 @@ module Covered
 			capture.disable
 		end
 		
+		def flush
+			@output.flush
+		end
+		
 		attr :reports
 		
 		class Autoload

data/lib/covered/statistics.rb

@@ -22,6 +22,9 @@ require_relative 'wrapper'
 require_relative 'coverage'
 
 module Covered
+	class CoverageError < StandardError
+	end
+	
 	class Statistics < Wrapper
 		def initialize
 			@count = 0
@@ -51,5 +54,11 @@ module Covered
 			
 			# Could output funny message here, especially for 100% coverage.
 		end
+		
+		def validate!(minimum = 1.0)
+			if self.ratio < minimum
+				raise CoverageError, "Coverage of #{self.percentage.to_f.round(2)}% is less than required minimum of #{(minimum * 100.0).round(2)}%!"
+			end
+		end
 	end
 end

data/lib/covered/version.rb

@@ -19,5 +19,5 @@
 # THE SOFTWARE.
 
 module Covered
-	VERSION = "0.14.2"
+	VERSION = "0.15.2"
 end

data/lib/covered/wrapper.rb

@@ -26,6 +26,9 @@ module Covered
 		def disable
 		end
 		
+		def flush
+		end
+		
 		def accept?(path)
 			true
 		end
@@ -60,6 +63,10 @@ module Covered
 			@output.disable
 		end
 		
+		def flush
+			@output.flush
+		end
+		
 		def accept?(path)
 			@output.accept?(path)
 		end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: covered
 version: !ruby/object:Gem::Version
-  version: 0.14.2
+  version: 0.15.2
 platform: ruby
 authors:
 - Samuel Williams
@@ -39,7 +39,7 @@ cert_chain:
   RAOsIl+HOBTb252nx1kIRN5hqQx272AJCbCjKx8egcUQKffFVVCI0nye09v5CK+a
   HiLJ8VOFx6w=
   -----END CERTIFICATE-----
-date: 2022-06-11 00:00:00.000000000 Z
+date: 2022-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-rest
@@ -159,16 +159,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/development.yml"
-- ".github/workflows/documentation.yml"
-- examples/coverage/covered.rb
-- examples/coverage/erb/coverage.rb
-- examples/coverage/erb/template.erb
-- examples/coverage/parser.rb
-- examples/coverage/simplecov.rb
-- examples/coverage/test.rb
-- examples/coverage/tracepoint.rb
+- bake/covered/validate.rb
 - lib/covered.rb
+- lib/covered/cache.rb
 - lib/covered/capture.rb
 - lib/covered/coverage.rb
 - lib/covered/coveralls.rb
@@ -184,7 +177,6 @@ files:
 - lib/covered/summary.rb
 - lib/covered/version.rb
 - lib/covered/wrapper.rb
-- media/example.png
 homepage: https://github.com/ioquatix/covered
 licenses:
 - MIT

data/.github/workflows/development.yml

@@ -1,45 +0,0 @@
-name: Development
-
-on: [push, pull_request]
-
-jobs:
-  test:
-    name: ${{matrix.ruby}} on ${{matrix.os}}
-    runs-on: ${{matrix.os}}-latest
-    continue-on-error: ${{matrix.experimental}}
-    
-    strategy:
-      matrix:
-        os:
-          - ubuntu
-          - macos
-        
-        ruby:
-          - "2.6"
-          - "2.7"
-          - "3.0"
-        
-        experimental: [false]
-        env: [""]
-        
-        include:
-          - os: ubuntu
-            ruby: truffleruby
-            experimental: true
-          - os: ubuntu
-            ruby: jruby
-            experimental: true
-          - os: ubuntu
-            ruby: head
-            experimental: true
-    
-    steps:
-    - uses: actions/checkout@v2
-    - uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{matrix.ruby}}
-        bundler-cache: true
-    
-    - name: Run tests
-      timeout-minutes: 5
-      run: ${{matrix.env}} bundle exec rspec

data/.github/workflows/documentation.yml

@@ -1,34 +0,0 @@
-name: Documentation
-
-on:
-  push:
-    branches:
-      - main
-
-env:
-  BUNDLE_WITH: maintenance
-
-jobs:
-  deploy:
-    runs-on: ubuntu-latest
-    
-    steps:
-    - uses: actions/checkout@v3
-
-    - uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: 3.1
-        bundler-cache: true
-    
-    - name: Installing packages
-      run: sudo apt-get install wget
-    
-    - name: Prepare GitHub Pages
-      run: bundle exec bake github:pages:prepare --directory docs
-    
-    - name: Generate documentation
-      timeout-minutes: 5
-      run: bundle exec bake utopia:project:static --force no
-    
-    - name: Deploy GitHub Pages
-      run: bundle exec bake github:pages:commit --directory docs

data/examples/coverage/covered.rb

@@ -1,11 +0,0 @@
-
-ENV['COVERAGE'] ||= 'PartialSummary'
-require 'covered/policy/default'
-
-$covered.enable
-
-require_relative 'test'
-
-$covered.disable
-
-$covered.call($stdout)

data/examples/coverage/erb/coverage.rb

@@ -1,21 +0,0 @@
-
-require 'erb'
-$LOAD_PATH.unshift File.expand_path('../../../lib', __dir__)
-
-template_path = File.expand_path("template.erb", __dir__)
-
-ENV['COVERAGE'] ||= 'PartialSummary'
-require 'covered/policy/default'
-
-$covered.enable
-
-template = ERB.new(File.read(template_path)).tap do |template|
-	template.filename = template_path
-end
-
-@items = ["Cats", "Dogs", "Chickens"]
-puts template.result(binding)
-
-$covered.disable
-
-$covered.call($stdout)

data/examples/coverage/erb/template.erb

@@ -1,7 +0,0 @@
-<% for @item in @items %>
-	<%= @item %>
-<% end %>
-
-<% if 1 == 2 %>
-	Math is broken.
-<% end %>

data/examples/coverage/parser.rb

@@ -1,23 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'pry'
-require 'parser/current'
-
-ast = Parser::CurrentRuby.parse_file('test.rb')
-# ast.location.expression.source
-
-def print_methods(ast)
-	if ast.is_a? Parser::AST::Node
-		if ast.type == :send
-			puts "Calling #{ast.children[1]} on #{ast.location.line}"
-		end
-		
-		ast.children.each do |child|
-			print_methods(child)
-		end
-	end
-end
-
-print_methods(ast)
-
-binding.pry

data/examples/coverage/simplecov.rb

@@ -1,7 +0,0 @@
-
-require 'simplecov'
-
-SimpleCov.command_name 'Example'
-SimpleCov.start
-
-require_relative 'test'

data/examples/coverage/test.rb

@@ -1,16 +0,0 @@
-trace_point = TracePoint.new(:call, :return, :line, :c_call, :c_return, :b_call, :b_return) do |trace|
-	puts [trace.path, trace.lineno].join(":")
-end
-
-trace_point.enable
-
-values = {foo: 10}
-
-def shell_escape(x)
-	x
-end
-
-values.map{|key, value| [
-	key.to_s.upcase,
-	shell_escape(value) # TracePoint is never triggered for this line.
-]}

data/examples/coverage/tracepoint.rb

@@ -1,8 +0,0 @@
-
-trace_point = TracePoint.new(:call, :return, :line, :c_call, :c_return, :b_call, :b_return) do |trace|
-	puts [trace.path, trace.lineno].join(":")
-end
-
-trace_point.enable
-
-require_relative 'test'