covered 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 832fa815563de02d41b8036c455e30e77d2af630f3a40b7bedff85c538f60227
-  data.tar.gz: 71b0144166e1a7285eb9e9db91ebd9904ec567646eb80a9f7d31dcaa7600c562
+  metadata.gz: 9ee9ff727d34b2454f900ea9f0b41e3b37801f0351da7b67e1def1925dd2e4e8
+  data.tar.gz: 7c9b15d856eab2589bfae31bddb1adf153b013038ff4cc13c4e407533da6b5f2
 SHA512:
-  metadata.gz: aa48464fc936d9b2e30079c0fcd3bb8cd338f958f8e49a45bdfe063de94f2d6819970f36d13958c48d3c93d854274d6723574db8c4eaf88509d3cb0b2cf37db8
-  data.tar.gz: 18cb7e0b47dddde9a80bfddc54762082ca55cea95215a14331c7ca8ae45325162063336f2b6ee2bb4106f506f612bc432d3f9275a21d404dca6ac4c94e08f0f9
+  metadata.gz: 1e93e9bb129a5960c85e958e8a4dcc7e1639e83269c6618eeffadd057aae6227d7e939707c51540893a2760002f152a3311e16d5022bc63893ab3b6d991e58eb
+  data.tar.gz: 8db25730358dbe19ecd5591780dd9e1c3d2a07193f31f300346673eea59b0986243d5735bca22c89f98e28ce0220336e2e190ed6a23e8176676a383e8c3ce3e0

data/.travis.yml

@@ -1,7 +1,11 @@
-sudo: false
 language: ruby
+dist: xenial
+cache: bundler
 
-rvm:
-  - 2.6
-
-before_install: gem install bundler -v 1.16.2
+matrix:
+  include:
+    - rvm: 2.3
+    - rvm: 2.4
+    - rvm: 2.5
+    - rvm: 2.6
+      env: COVERAGE=BriefSummary,Coveralls

data/README.md

@@ -59,6 +59,8 @@ When running `rspec`, you can specify the kind of coverage analysis you would li
 COVERAGE=Summary rspec
 ```
 
+If no `COVERAGE` is specified, coverage tracking will be disabled.
+
 ### Partial Summary
 
 ```
@@ -69,12 +71,23 @@ This report only shows snippets of source code with incomplete coverage.
 
 ### Brief Summary
 
-
 ```
 COVERAGE=BriefSummary rspec
 ```
 
-This report lists several files in order of least coverage.
+This report lists several files in order of least coverage.l
+
+### Coveralls/Travis Integration
+
+You can send coverage information to [Coveralls](https://coveralls.io).
+
+```
+COVERAGE=BriefSummary,Coveralls rspec
+```
+
+This will print out a brief report and then upload the coverage data. This integrates transparently with Travis.
+
+### 
 
 ## Contributing
 

data/covered.gemspec

@@ -19,9 +19,10 @@ Gem::Specification.new do |spec|
 	spec.require_paths = ["lib"]
 	
 	spec.add_dependency "rainbow"
-	
 	spec.add_dependency "parser"
 	
+	spec.add_dependency "async-rest"
+	
 	spec.add_development_dependency "trenni", "~> 3.6"
 	
 	spec.add_development_dependency "bundler"

data/lib/covered.rb

@@ -19,5 +19,4 @@
 # THE SOFTWARE.
 
 require_relative "covered/version"
-
 require_relative "covered/policy"

data/lib/covered/coverage.rb

@@ -53,8 +53,16 @@ module Covered
 		
 		attr :annotations
 		
+		def read(&block)
+			if block_given?
+				File.open(@path, "r", &block)
+			else
+				File.read(@path)
+			end
+		end
+		
 		def freeze
-			return if frozen?
+			return self if frozen?
 			
 			@counts.freeze
 			@annotations.freeze
@@ -65,6 +73,10 @@ module Covered
 			super
 		end
 		
+		def to_a
+			@counts
+		end
+		
 		def zero?
 			@total.zero?
 		end
@@ -110,8 +122,12 @@ module Covered
 		
 		include Ratio
 		
-		def print_summary(output)
+		def print(output)
 			output.puts "** #{executed_count}/#{executable_count} lines executed; #{percentage.to_f.round(2)}% covered."
 		end
+		
+		def to_s
+			"\#<#{self.class} path=#{@path} #{percentage.to_f.round(2)}% covered>"
+		end
 	end
 end

data/lib/covered/coveralls.rb

@@ -0,0 +1,104 @@
+# Copyright, 2019, 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 'async'
+require 'async/rest/representation'
+
+require 'securerandom'
+
+module Covered
+	class Coveralls
+		class Wrapper < Async::REST::Wrapper::JSON
+			def prepare_request(payload, headers)
+				headers['accept'] ||= @content_type
+				boundary = SecureRandom.hex(32)
+				
+				# This is a pretty messed up API. Don't change anything below. It's fragile.
+				if payload
+					headers['content-type'] = "multipart/form-data, boundary=#{boundary}"
+					
+					Async::HTTP::Body::Buffered.new([
+						"--#{boundary}\r\n",
+						"Content-Disposition: form-data; name=\"json_file\"; filename=\"body.json\"\r\n",
+						"Content-Type: text/plain\r\n\r\n",
+						::JSON.dump(payload),
+						"\r\n--#{boundary}--\r\n",
+					])
+				end
+			end
+		end
+		
+		URL = "https://coveralls.io/api/v1/jobs"
+		
+		def initialize(token: nil, service: nil, job_id: nil)
+			@token = token
+		end
+		
+		def detect_service
+			if token = ENV.fetch('COVERALLS_REPO_TOKEN', @token)
+				return {"repo_token" => token}
+			elsif @service && @job_id
+				return {"service_name" => @service, "service_job_id" => @job_id}
+			elsif job_id = ENV['TRAVIS_JOB_ID']
+				return {"service_name" => "travis-ci", "service_job_id" => job_id}
+			else
+				warn "#{self.class} can't detect service! Please specify COVERALLS_REPO_TOKEN."
+			end
+			
+			return nil
+		end
+		
+		def call(wrapper, output = $stderr)
+			if body = detect_service
+				output.puts "Submitting data using #{body.inspect}..."
+				
+				source_files = []
+				
+				wrapper.each do |coverage|
+					path = wrapper.relative_path(coverage.path)
+					
+					source_files << {
+						name: path,
+						source_digest: Digest::MD5.hexdigest(coverage.read),
+						coverage: coverage.to_a,
+					}
+				end
+				
+				body[:source_files] = source_files
+				
+				Async do
+					representation = Async::REST::Representation.new(
+						Async::REST::Resource.for(URL),
+						wrapper: Wrapper.new
+					)
+					
+					begin
+						response = representation.post(body)
+						
+						output.puts "Got response: #{response.read}"
+						
+					ensure
+						representation.close
+					end
+				end
+			end
+		end
+	end
+end

data/lib/covered/files.rb

@@ -44,28 +44,27 @@ module Covered
 			return coverage
 		end
 		
-		def each
-			return to_enum unless block_given?
-			
-			@paths.each do |path, coverage|
-				yield coverage
-			end
+		def each(&block)
+			@paths.each_value(&block)
 		end
 	end
 	
 	class Include < Wrapper
-		def initialize(output, pattern)
+		def initialize(output, pattern, base = "")
 			super(output)
 			
 			@pattern = pattern
+			@base = base
 		end
 		
 		attr :pattern
 		
 		def glob
 			paths = Set.new
+			root = self.expand_path(@base)
+			pattern = File.expand_path(@pattern, root)
 			
-			Dir.glob(@pattern) do |path|
+			Dir.glob(pattern) do |path|
 				unless File.directory?(path)
 					paths << File.realpath(path)
 				end
@@ -100,21 +99,30 @@ module Covered
 		
 		def each(&block)
 			super do |coverage|
-				yield coverage if accept?(coverage.path)
+				if accept?(coverage.path)
+					yield coverage
+				else
+					puts "Skipping #{coverage.path} #{self.class}"
+				end
 			end
 		end
 	end
 	
 	class Skip < Filter
-		def initialize(output, pattern)
+		def initialize(output, pattern, base = "")
 			super(output)
 			
 			@pattern = pattern
+			@base = self.expand_path(base)
 		end
 		
 		attr :pattern
 		
 		def accept? path
+			if @base
+				path = relative_path(path)
+			end
+			
 			!(@pattern === path)
 		end
 	end
@@ -142,6 +150,18 @@ module Covered
 		
 		attr :path
 		
+		def expand_path(path)
+			File.expand_path(super, @path)
+		end
+		
+		def relative_path(path)
+			if path.start_with?(@path)
+				path[@path.size+1..-1]
+			else
+				super
+			end
+		end
+		
 		def accept?(path)
 			path.start_with?(@path)
 		end

data/lib/covered/minitest.rb

@@ -40,6 +40,6 @@ if ENV['COVERAGE']
 	
 	Minitest.after_run do
 		$covered.disable
-		$covered.print_summary($stderr)
+		$covered.call($stderr)
 	end
 end

data/lib/covered/policy.rb

@@ -23,6 +23,8 @@ require_relative "files"
 require_relative "source"
 require_relative "capture"
 
+require_relative 'coveralls'
+
 module Covered
 	def self.policy(&block)
 		policy = Policy.new
@@ -38,18 +40,14 @@ module Covered
 		def initialize
 			super(Files.new)
 			
-			@threshold = 1.0
-			@summary_class = PartialSummary
+			@reports = []
 		end
 		
-		attr_accessor :summary_class
-		attr_accessor :threshold
-		
 		def freeze
-			return if frozen?
+			return self if frozen?
 			
 			capture
-			summary(threshold: @threshold)
+			@reports.freeze
 			
 			super
 		end
@@ -90,12 +88,28 @@ module Covered
 			capture.disable
 		end
 		
-		def summary(*args)
-			@summary ||= @summary_class.new(@output, *args)
+		attr :reports
+		
+		def reports!(coverage = ENV['COVERAGE'])
+			if coverage
+				names = coverage.split(',')
+				
+				names.each do |name|
+					if klass = Covered.const_get(name)
+						@reports << klass.new
+					else
+						warn "Could not find #{name} call Ignoring."
+					end
+				end
+			else
+				@reports << Covered::BriefSummary.new
+			end
 		end
 		
-		def print_summary(*args)
-			summary.print_summary(*args)
+		def call(*args)
+			@reports.each do |report|
+				report.call(self, *args)
+			end
 		end
 	end
 end

data/lib/covered/policy/default.rb

@@ -25,14 +25,12 @@ $covered = Covered.policy do
 	root Dir.pwd
 	
 	# We will ignore any files in the test or spec directory:
-	skip /test|spec/
+	skip /^(test|spec|vendor)/
 	
 	# We will include all files under lib, even if they aren't loaded:
 	include "lib/**/*.rb"
 	
 	source
 	
-	if coverage = ENV['COVERAGE']
-		self.summary_class = Covered.const_get(coverage) || Covered::BriefSummary
-	end
+	reports!
 end

data/lib/covered/rspec.rb

@@ -26,6 +26,7 @@ require 'rspec/core/formatters'
 module Covered
 	module RSpec
 		class Formatter
+			# The name `dump_summary` of this method is significant:
 			::RSpec::Core::Formatters.register self, :dump_summary
 			
 			def initialize(output)
@@ -33,7 +34,7 @@ module Covered
 			end
 			
 			def dump_summary notification
-				$covered.print_summary(@output)
+				$covered.call(@output)
 			end
 		end
 		

data/lib/covered/source.rb

@@ -110,11 +110,12 @@ module Covered
 			else
 				warn "Couldn't parse #{path}, file doesn't exist?"
 			end
+		rescue
+			warn "Couldn't parse #{path}: #{$!}"
 		end
 		
 		def each(&block)
 			@output.each do |coverage|
-				# This is a little bit inefficient, perhaps add a cache layer?
 				if top = parse(coverage.path)
 					self.expand(top, coverage)
 				end

data/lib/covered/statistics.rb

@@ -46,7 +46,7 @@ module Covered
 		
 		include Ratio
 		
-		def print_summary(output)
+		def print(output)
 			output.puts "* #{count} files checked; #{executed_count}/#{executable_count} lines executed; #{percentage.to_f.round(2)}% covered."
 		end
 	end

data/lib/covered/summary.rb

@@ -24,17 +24,15 @@ require_relative 'wrapper'
 require 'rainbow'
 
 module Covered
-	class Summary < Wrapper
-		def initialize(output, threshold: 1.0)
-			super(output)
-			
+	class Summary
+		def initialize(threshold: 1.0)
 			@threshold = threshold
 		end
 		
-		def each
+		def each(wrapper)
 			statistics = Statistics.new
 			
-			super do |coverage|
+			wrapper.each do |coverage|
 				statistics << coverage
 				
 				if @threshold.nil? or coverage.ratio < @threshold
@@ -58,14 +56,16 @@ module Covered
 		end
 		
 		# A coverage array gives, for each line, the number of line execution by the interpreter. A nil value means coverage is disabled for this line (lines like else and end).
-		def print_summary(output = $stdout)
-			statistics = self.each do |coverage|
+		def call(wrapper, output = $stdout)
+			statistics = self.each(wrapper) do |coverage|
 				line_offset = 1
-				output.puts "", Rainbow(coverage.path).bold.underline
+				
+				path = wrapper.relative_path(coverage.path)
+				output.puts "", Rainbow(path).bold.underline
 				
 				counts = coverage.counts
 				
-				File.open(coverage.path, "r") do |file|
+				coverage.read do |file|
 					file.each_line do |line|
 						count = counts[line_offset]
 						
@@ -91,30 +91,32 @@ module Covered
 					end
 				end
 				
-				coverage.print_summary(output)
+				coverage.print(output)
 			end
 			
-			statistics.print_summary(output)
+			statistics.print(output)
 		end
 	end
 	
 	class BriefSummary < Summary
-		def print_summary(output = $stdout, before: 4, after: 4)
+		def call(wrapper, output = $stdout, before: 4, after: 4)
 			ordered = []
 			
-			statistics = self.each do |coverage|
+			statistics = self.each(wrapper) do |coverage|
 				ordered << coverage unless coverage.complete?
 			end
 			
 			output.puts
-			statistics.print_summary(output)
+			statistics.print(output)
 			
 			if ordered.any?
 				output.puts "", "Least Coverage:"
 				ordered.sort_by!(&:missing_count).reverse!
 				
 				ordered.first(5).each do |coverage|
-					output.write Rainbow(coverage.path).orange
+					path = wrapper.relative_path(coverage.path)
+					
+					output.write Rainbow(path).orange
 					output.puts ": #{coverage.missing_count} lines not executed!"
 				end
 			end
@@ -122,16 +124,18 @@ module Covered
 	end
 	
 	class PartialSummary < Summary
-		def print_summary(output = $stdout, before: 4, after: 4)
-			statistics = self.each do |coverage|
+		def call(wrapper, output = $stdout, before: 4, after: 4)
+			statistics = self.each(wrapper) do |coverage|
 				line_offset = 1
-				output.puts "", Rainbow(coverage.path).bold.underline
+				
+				path = wrapper.relative_path(coverage.path)
+				output.puts "", Rainbow(path).bold.underline
 				
 				counts = coverage.counts
 				last_line = nil
 				
 				unless coverage.zero?
-					File.open(coverage.path, "r") do |file|
+					coverage.read do |file|
 						file.each_line do |line|
 							range = Range.new([line_offset - before, 0].max, line_offset+after)
 							
@@ -170,11 +174,11 @@ module Covered
 					end
 				end
 				
-				coverage.print_summary(output)
+				coverage.print(output)
 			end
 			
 			output.puts
-			statistics.print_summary(output)
+			statistics.print(output)
 		end
 	end
 end

data/lib/covered/version.rb

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

data/lib/covered/wrapper.rb

@@ -42,7 +42,23 @@ module Covered
 		
 		# @yield [Coverage] the path to the file, and the execution counts.
 		def each(&block)
-			@output.each(&block)
+			@output.each(&block) if @output
+		end
+		
+		def relative_path(path)
+			if @output
+				@output.relative_path(path)
+			else
+				path
+			end
+		end
+		
+		def expand_path(path)
+			if @output
+				@output.expand_path(path)
+			else
+				path
+			end
 		end
 		
 		def to_h

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: covered
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-31 00:00:00.000000000 Z
+date: 2019-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rainbow
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: async-rest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: trenni
   requirement: !ruby/object:Gem::Requirement
@@ -126,6 +140,7 @@ files:
 - lib/covered.rb
 - lib/covered/capture.rb
 - lib/covered/coverage.rb
+- lib/covered/coveralls.rb
 - lib/covered/eval.rb
 - lib/covered/files.rb
 - lib/covered/minitest.rb
@@ -156,7 +171,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: A modern approach to code coverage.