covered 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4e02c3c03842ced3f0f2b325fbdc6cd6a56b1ca88341bf53108f760f319b9ea
-  data.tar.gz: 21cb38f3723b640c0b059f5672509830c4e864456bac07fc1d16bb81ad636cd7
+  metadata.gz: 427269046d977cdbbf273f6b037306b94b767bac227611c4bb088284ba386a3d
+  data.tar.gz: 60562f99f72cb13819d75f53ee9d4d24397d3391656e005def4b085ef48b607f
 SHA512:
-  metadata.gz: a2f58e90824ad8b42075984a06f187d96b2e166affc7a8882383612cca9627c79fdafd2d0bdc55459347bfee5bc46d5ab10749271b2e7667cefa47381190f12e
-  data.tar.gz: 319a678ee8bd7a6660a7d6f9908b80810e4a67b19e3f79ae3a17d35e45e0c00c619c5cf0bbd1e726789e2319a6ed9c7d54d26e4f78a20282ae5208e48d29ff8d
+  metadata.gz: 5957818e2d53357da2fd7874d1040a36dd032d1ba287047724684f1702b2d866a66910c3b1254b4ee2788751e0016de6eb26fa17392c6758e524f9a69e3c5125
+  data.tar.gz: 749be10e7c7a56a8f93b34c347abab188aafde3ee0af70806e2d4e991a7a9c4ed6dd5a1eb05ea1ce46907fe4e5463460a48b3e1006b7a67f4cb40a03781a1a8b

data/.editorconfig

@@ -0,0 +1,6 @@
+root = true
+
+[*]
+indent_style = tab
+indent_size = 2
+

data/README.md

@@ -1,36 +1,66 @@
 # Covered [![Build Status](https://travis-ci.com/ioquatix/covered.svg)](https://travis-ci.com/ioquatix/covered)
 
-Covered uses modern Ruby features to generate comprehensive coverage, including support for templates which are compiled into Ruby. **This only works with Ruby 2.6 and its experimental support for RubyVM::AbstractSyntaxTree**
+Covered uses modern Ruby features to generate comprehensive coverage, including support for templates which are compiled into Ruby.
 
 ![Screenshot](media/example.png)
 
 ## 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. With Ruby 2.6, `RubyVM::AST.parse(source)` came into existence, which gives us a fine grained tool for computing initial source coverage (i.e. what lines are executable), and thus making it possible to compute coverage for "templates".
+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] 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.
 
+[parser]: https://github.com/whitequark/parser
+
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this line to your application's `Gemfile`:
 
-	gem 'covered'
+```ruby
+group :test do
+	gem 'covered', require: 'covered/rspec'
+end
+```
 
-And then execute:
+In your `spec/spec_helper.rb` add the following before loading any other code:
 
-	$ bundle
+```ruby
+require 'bundler/setup'
+Bundler.require(:test)
+```
 
-Or install it yourself as:
+Ensure that you have a `.rspec` file with `--require spec_helper`:
 
-	$ gem install covered
+```
+--require spec_helper
+--format documentation
+--warnings
+```
 
 ## Usage
 
-For `rspec`, simply include the following from your `spec_helper.rb`
+When running `rspec`, you can specify the kind of coverage analysis you would like:
+
+```
+COVERAGE=Summary rspec
+```
+
+### Partial Summary
+
+```
+COVERAGE=PartialSummary rspec
+```
+
+This report only shows snippets of source code with incomplete coverage.
+
+### Brief Summary
+
 
-```ruby
-require 'covered/rspec'
 ```
+COVERAGE=BriefSummary rspec
+```
+
+This report lists several files in order of least coverage.
 
 ## Contributing
 

data/covered.gemspec

@@ -17,11 +17,11 @@ Gem::Specification.new do |spec|
 
 	spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
 	spec.require_paths = ["lib"]
-
-	spec.required_ruby_version = '~> 2.6.0'
-
+	
 	spec.add_dependency "rainbow"
 	
+	spec.add_dependency "parser"
+	
 	spec.add_development_dependency "trenni", "~> 3.6"
 	
 	spec.add_development_dependency "bundler"

data/lib/covered/policy.rb

@@ -74,8 +74,12 @@ module Covered
 			@output = Root.new(@output, *args)
 		end
 		
+		def cache!
+			@output = Cache.new(@output)
+		end
+		
 		def capture
-			@capture ||= Capture.new(Cache.new(@output))
+			@capture ||= Capture.new(@output)
 		end
 		
 		def enable

data/lib/covered/policy/default.rb

@@ -0,0 +1,38 @@
+# 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.
+
+$covered = Covered.policy do
+	cache!
+	
+	# Only files in the root would be tracked:
+	root Dir.pwd
+	
+	# We will ignore any files in the spec directory:
+	skip /spec/
+	
+	# 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
+end

data/lib/covered/rspec.rb

@@ -18,27 +18,10 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require_relative '../covered'
-require 'rspec/core/formatters'
+require_relative 'policy'
+require_relative 'policy/default'
 
-$covered = Covered.policy do
-	# Only files in the root would be tracked:
-	root Dir.pwd
-	
-	# We will ignore any files in the spec directory:
-	skip /spec/
-	
-	# 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)
-	else
-		self.summary_class = Covered::BriefSummary
-	end
-end
+require 'rspec/core/formatters'
 
 module Covered
 	module RSpec
@@ -72,12 +55,14 @@ module Covered
 	end
 end
 
-RSpec::Core::Configuration.prepend(Covered::RSpec::Policy)
+if ENV['COVERAGE']
+	RSpec::Core::Configuration.prepend(Covered::RSpec::Policy)
 
-RSpec.configure do |config|
-	config.add_formatter(Covered::RSpec::Formatter)
-	
-	config.after(:suite) do
-		$covered.disable
+	RSpec.configure do |config|
+		config.add_formatter(Covered::RSpec::Formatter)
+		
+		config.after(:suite) do
+			$covered.disable
+		end
 	end
 end

data/lib/covered/source.rb

@@ -23,6 +23,8 @@ require_relative 'wrapper'
 
 require 'thread'
 
+require 'parser/current'
+
 module Covered
 	# The source map, loads the source file, parses the AST to generate which lines contain executable code.
 	class Source < Wrapper
@@ -70,22 +72,21 @@ module Covered
 		end
 		
 		def executable?(node)
-			node.type.to_s =~ @executable
+			node.type == :send
 		end
 		
 		def ignore?(node)
-			# NODE_ARGS Ruby doesn't report execution of arguments in :line tracepoint.
-			node.nil? or node.type.to_s =~ @ignore
+			node.nil? or node.type == :arg
 		end
 		
 		def expand(node, coverage, level = 0)
-			if node.is_a? RubyVM::AbstractSyntaxTree::Node
+			if node.is_a? Parser::AST::Node
 				if ignore?(node)
-					coverage.annotate(node.first_lineno, "ignoring #{node.type}")
+					coverage.annotate(node.location.line, "ignoring #{node.type}")
 				else
 					if executable?(node)
 						# coverage.annotate(node.first_lineno, "executable #{node.type}")
-						coverage.counts[node.first_lineno] ||= 0
+						coverage.counts[node.location.line] ||= 0
 					else
 						# coverage.annotate(node.first_lineno, "not executable #{node.type}")
 					end
@@ -103,9 +104,9 @@ module Covered
 		
 		def parse(path)
 			if source = @paths[path]
-				RubyVM::AbstractSyntaxTree.parse(source)
+				Parser::CurrentRuby.parse(source)
 			elsif File.exist?(path)
-				RubyVM::AbstractSyntaxTree.parse_file(path)
+				Parser::CurrentRuby.parse_file(path)
 			else
 				warn "Couldn't parse #{path}, file doesn't exist?"
 			end

data/lib/covered/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: covered
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-27 00:00:00.000000000 Z
+date: 2019-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rainbow
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: parser
+  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
@@ -87,6 +101,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".editorconfig"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -100,6 +115,7 @@ files:
 - lib/covered/eval.rb
 - lib/covered/files.rb
 - lib/covered/policy.rb
+- lib/covered/policy/default.rb
 - lib/covered/rspec.rb
 - lib/covered/source.rb
 - lib/covered/statistics.rb
@@ -116,16 +132,16 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: A modern approach to code coverage.