rspec-coverage 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 29b8b2178b66f9dff2b994cfb90628783a4a349e
+  data.tar.gz: a50fb4c922b77a988dd0ff25fbb64e997384ebdc
+SHA512:
+  metadata.gz: 8fd71b289d0990e744e01f053069a40e96558423eaf196d04282ba3781aa78ad63630c67b3a6a1152abc63a0d0b228f98907b62f24d97c772b3356c061ca2d1f
+  data.tar.gz: 021e9850d4c48f1a667b1004133bf2499cb39cddeecc862b84b7f9c08e037757878d939aa5487730c180d7fbeaaa87d5b52e78028781338e0e356e0e20af0501

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at jamesdabbs@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rspec-coverage.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 James Dabbs
+
+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.

data/README.md

@@ -0,0 +1,48 @@
+# Rspec::Coverage
+
+_Inspired by Ryan Davis' RubyConf 2016 talk._
+
+SimpleCov-backed coverage-tracking tools for RSpec. Coverage is only recorded in a `describe` block for the class being `describe`d, which prevents incidental coverage of unverified lines in collaborators and encourages better test design.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rspec-coverage'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rspec-coverage
+
+## Usage
+
+As early as possible in your code (before your classes load), add
+
+```ruby
+require 'rspec/coverage'
+# Takes the same optional args as SimpleCov.start
+RSpec::Coverage.start
+```
+
+and use `rspec` as normal. Any `describe` block will automatically filter coverage to the class under test. You can also add a `covers:` annotation to control filtering.
+
+```ruby
+RSpec.describe "User with collaborators", covers: [User, Collaborator] do
+  ...
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jamesdabbs/rspec-coverage. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rspec/coverage"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rspec/coverage/class_map.rb

@@ -0,0 +1,57 @@
+require "set"
+
+module RSpec::Coverage
+  class ClassMap
+    attr_reader :root
+
+    def initialize root=""
+      @root = root
+      @files, @masks, @klasses = {}, {}, {}
+    end
+
+    def mask *klasses
+      return @masks[klasses] if @masks[klasses]
+
+      masks = klasses.map { |klass| class_mask klass }
+      @masks[klasses] = Result.traverse(*masks) do |_file, *entries|
+        entries.include?(ACTIVE) ? ACTIVE : INACTIVE
+      end
+    end
+
+    def start_class name:, path:, line:
+      return unless path.start_with? @root
+
+      @files[path] ||= {}
+      @files[path][line] = name
+
+      @klasses[name] ||= {}
+      @klasses[name][path] = true
+    end
+
+    private
+
+    def class_mask klass_or_name
+      klass = klass_or_name.respond_to?(:name) ? klass_or_name.name : klass_or_name
+      return @masks[klass] if @masks.include?(klass)
+
+      active_files  = (@klasses[klass] || {}).keys
+      @masks[klass] = active_files.each_with_object({}) do |file, h|
+        h[file] = file_mask file, klass
+      end
+    end
+
+    def file_mask file, klass
+      @files[file].freeze # can't add class defs to a file after computing the map
+
+      fm = @files[file]
+
+      active = INACTIVE
+      1.upto(fm.keys.last).map do |i|
+        if current = fm[i]
+          active = (current == klass) ? ACTIVE : INACTIVE
+        end
+        active
+      end
+    end
+  end
+end

data/lib/rspec/coverage/class_map_builder.rb

@@ -0,0 +1,16 @@
+module RSpec::Coverage
+  class ClassMapBuilder
+    def initialize map=nil
+      @map   = map
+      @trace = TracePoint.new(:class) { |t| handle t }
+    end
+
+    def handle trace
+      @map.start_class name: trace.self.name, path: trace.path, line: trace.lineno
+    end
+
+    def enable
+      @trace.enable
+    end
+  end
+end

data/lib/rspec/coverage/configuration.rb

@@ -0,0 +1,30 @@
+module RSpec
+  module Coverage
+    class Configuration
+      attr_reader :root, :builder, :runner
+
+      def initialize root
+        @root    = root
+        map      = ClassMap.new root
+        @builder = ClassMapBuilder.new map
+        @runner  = Runner.new map
+      end
+
+      def start *args
+        @builder.enable
+
+        SimpleCov.start(*args)
+        SimpleCov.at_exit do
+          SimpleCov.formatter.new.format SimpleCov::Result.new runner.result
+        end
+
+        _self = self
+        RSpec.configure do |c|
+          c.around :each do |example|
+            _self.runner.call example
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rspec/coverage/excludes.rb

@@ -0,0 +1,31 @@
+module RSpec::Coverage
+  class Excludes
+    attr_reader :root
+
+    def initialize root
+      @root, @overs = root, RSpec::Coverage::Result.new(root)
+    end
+
+    def record before:, after:, mask:
+      @overs.traverse! before, after, mask do |file,o,b,a,m|
+        o ||= 0
+        b ||= 0
+        a ||= 0
+        m ||= mask[file] ? mask[file].last : INACTIVE
+
+        if m == INACTIVE
+          o + a - b
+        else
+          o
+        end
+      end
+    end
+
+    def deduct coverage
+      @overs.traverse coverage do |file, over, cover|
+        next unless cover
+        cover - (over || 0)
+      end
+    end
+  end
+end

data/lib/rspec/coverage/result.rb

@@ -0,0 +1,40 @@
+module RSpec::Coverage
+  class Result
+    attr_reader :root
+
+    extend Forwardable
+    def_delegators :@coverage, :[], :keys
+
+    def self.traverse *results, &block
+      new("", results.shift).traverse(*results, &block).to_h
+    end
+
+    def traverse *results, &block
+      RSpec::Coverage::Result.new(root, @coverage.dup).traverse!(*results, &block)
+    end
+
+    def traverse! *results
+      results.unshift self
+      files = results.map(&:keys).flatten.uniq
+      files.each do |file|
+        next unless file.start_with? root
+
+        lines = results.map{ |r| r[file] || [] }
+        len   = lines.map(&:length).max
+
+        @coverage[file] = len.times.map do |i|
+          yield file, *lines.map { |ls| ls[i] }
+        end
+      end
+      self
+    end
+
+    def initialize root, coverage={}
+      @root, @coverage = root, coverage
+    end
+
+    def to_h
+      @coverage.dup
+    end
+  end
+end

data/lib/rspec/coverage/runner.rb

@@ -0,0 +1,33 @@
+module RSpec::Coverage
+  class Runner
+    def initialize map, coverage: ::Coverage.method(:peek_result)
+      @map, @coverage = map, coverage
+      @exclusions = Excludes.new map.root
+    end
+
+    def call ex
+      if klasses = ex.metadata[:covers]
+        run_filtered klasses, ex
+      elsif klass = ex.metadata[:described_class]
+        run_filtered [klass], ex
+      else
+        ex.call
+      end
+    end
+
+    def result
+      @exclusions.deduct(@coverage.call).to_h
+    end
+
+    private
+
+    def run_filtered klasses, example
+      before = @coverage.call
+      example.call
+      @exclusions.record \
+        before: before,
+        after:  @coverage.call,
+        mask:   @map.mask(*klasses)
+    end
+  end
+end

data/lib/rspec/coverage/version.rb

@@ -0,0 +1,5 @@
+module RSpec
+  module Coverage
+    VERSION = "0.1.1"
+  end
+end

data/lib/rspec/coverage.rb

@@ -0,0 +1,30 @@
+require "rspec/coverage/version"
+
+require "rspec/coverage/class_map"
+require "rspec/coverage/class_map_builder"
+require "rspec/coverage/configuration"
+require "rspec/coverage/excludes"
+require "rspec/coverage/result"
+require "rspec/coverage/runner"
+
+require "simplecov"
+require "pry"
+
+module RSpec
+  module Coverage
+    INACTIVE = 0
+    ACTIVE   = 1
+
+    def self.root
+      Dir.pwd
+    end
+
+    def self.config
+      @config ||= Configuration.new root
+    end
+
+    def self.start *args
+      config.start(*args)
+    end
+  end
+end

data/rspec-coverage.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rspec/coverage/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rspec-coverage"
+  spec.version       = RSpec::Coverage::VERSION
+  spec.authors       = ["James Dabbs"]
+  spec.email         = ["jamesdabbs@gmail.com"]
+
+  spec.summary       = %q{Filter test results to include only the system under test}
+  spec.description   = %q{Filter test results to include only the system under test. A port of minitest-coverage}
+  spec.homepage      = "https://github.com/jamesdabbs/rspec-coverage"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rspec"
+  spec.add_dependency "simplecov"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: rspec-coverage
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- James Dabbs
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: simplecov
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Filter test results to include only the system under test. A port of
+  minitest-coverage
+email:
+- jamesdabbs@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rspec/coverage.rb
+- lib/rspec/coverage/class_map.rb
+- lib/rspec/coverage/class_map_builder.rb
+- lib/rspec/coverage/configuration.rb
+- lib/rspec/coverage/excludes.rb
+- lib/rspec/coverage/result.rb
+- lib/rspec/coverage/runner.rb
+- lib/rspec/coverage/version.rb
+- rspec-coverage.gemspec
+homepage: https://github.com/jamesdabbs/rspec-coverage
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Filter test results to include only the system under test
+test_files: []