undercover 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 83b2a35bc1bcadd4892ed21804bf9fd7bd2b3a7a
-  data.tar.gz: 91ed40ea4c090ce57d05532ed4ab986fe12fd873
+  metadata.gz: 95823e9c99d27f235ecf164326d14dfaba5ab716
+  data.tar.gz: 6626a7f1d7a6f01a3639f1f682064a30e2fee79c
 SHA512:
-  metadata.gz: adeff5d8fe3e1a31b17427f0f53db3d62afaa50802aa52ac15b02a9adfcce82170147b6e327a6fcf59fbf4a9aa64828f7ad830b8aac2aa0ffd388af83643c4bb
-  data.tar.gz: ef8f9f142bdcf0369a978fd765cbede85d39807cf79f3c5fb7ed89115c88725d4e8e1e3391cf01477e507391884aea7ce54dde04dd2520167fdd4c042a5b41e7
+  metadata.gz: 909e534984be8f7db602d5863ee31f1e986acaab8be58b84fd870e51f74ffe744a7625501eccca3f8cda2aec5a7a9dd0a6001cc6b1ca98472a0169e943557918
+  data.tar.gz: 6525467a27c472d0b24aa17cec6a986252ab649c8dfe514585dc405f8775803beac8d1aa7840ffc21af362a4bbb804bb890f41c1aca90ca9eeb56ba2b467247b

data/.rubocop.yml

@@ -8,6 +8,10 @@ Style/RegexpLiteral:
 Style/Documentation:
   Enabled: false
 
+Style/SpaceInsideHashLiteralBraces:
+  Enabled: true
+  EnforcedStyle: no_space
+
 Metrics/BlockLength:
   Enabled: true
   Exclude:

data/.travis.yml

@@ -4,5 +4,9 @@ rvm:
   - 2.4.4
   - 2.3.4
 before_install:
-  - gem install bundler
+  - gem install bundler undercover
   - gem update --system
+script:
+  - bundle exec rake
+  - git pull origin master:master
+  - undercover --compare master

data/Gemfile

@@ -1,6 +1,5 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+source 'https://rubygems.org'
 
-# Specify your gem's dependencies in undercover.gemspec
 gemspec

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    undercover (0.1.0)
-      imagen (~> 0.1.0)
+    undercover (0.1.1)
+      imagen (~> 0.1.1)
       rainbow (~> 3.0.0)
       rugged (~> 0.27.0)
 
@@ -13,12 +13,14 @@ GEM
     coderay (1.1.2)
     diff-lcs (1.3)
     docile (1.3.0)
-    imagen (0.1.0)
+    imagen (0.1.1)
       parser
     json (2.1.0)
     method_source (0.9.0)
+    parallel (1.12.1)
     parser (2.5.1.0)
       ast (~> 2.4.0)
+    powerpack (0.1.1)
     pry (0.11.3)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
@@ -37,6 +39,14 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.7.0)
     rspec-support (3.7.1)
+    rubocop (0.55.0)
+      parallel (~> 1.10)
+      parser (>= 2.5)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
     rugged (0.27.0)
     simplecov (0.16.1)
       docile (~> 1.1)
@@ -44,17 +54,22 @@ GEM
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
     simplecov-lcov (0.7.0)
+    timecop (0.9.1)
+    unicode-display_width (1.3.2)
 
 PLATFORMS
   ruby
+  x86_64-darwin-17
 
 DEPENDENCIES
   bundler (~> 1.16)
   pry
   rake (~> 10.0)
   rspec (~> 3.0)
+  rubocop (~> 0.55.0)
   simplecov
   simplecov-lcov
+  timecop
   undercover!
 
 BUNDLED WITH

data/README.md

@@ -1,11 +1,21 @@
-# Undercover
+# undercover 👮‍♂️
 
-[![Build Status](https://travis-ci.org/grodowski/undercover.svg?branch=master)](https://travis-ci.org/grodowski/undercover)
-[![codebeat badge](https://codebeat.co/badges/be548247-2421-4448-bdab-896d13eb02e9)](https://codebeat.co/projects/github-com-grodowski-undercover-master)
+**RuboCop for code coverage**
+
+Meaningful warnings for methods and classes which lack testing, using data from coverage reports, git metadata and a parsed structure of your Ruby codebase. `undercover` automates the coverage feedback loop and makes sure no code review passes without tests.
+
+A sample output of `undercover` ran before a commit may look like this:
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/undercover`. To experiment with that code, run `bin/console` for an interactive prompt.
+![screenshot warning](screenshot_warnings.png)
 
-TODO: Delete this and the text above, and describe your gem
+And like this, given that specs were added:
+
+![screenshot success](screenshot_success.png)
+
+The project is in an early phase, so please expect the unexpected and [report any problems or feedback as issues](https://github.com/grodowski/undercover/issues).
+
+[![Build Status](https://travis-ci.org/grodowski/undercover.svg?branch=master)](https://travis-ci.org/grodowski/undercover)
+[![codebeat badge](https://codebeat.co/badges/be548247-2421-4448-bdab-896d13eb02e9)](https://codebeat.co/projects/github-com-grodowski-undercover-master)
 
 ## Installation
 
@@ -23,9 +33,65 @@ Or install it yourself as:
 
     $ gem install undercover
 
+## Setting up required LCOV reporting
+
+Undercover depends on a git diff, code structure generated by [`imagen`](https://github.com/grodowski/imagen_rb) and a coverage report in LCOV format.
+
+To make your specs compatible with `undercover` by providing an LCOV report, please add `simplecov` and `simplecov-lcov` to your test setup. Example for rspec:
+
+```ruby
+# Gemfile
+group :test do
+  gem 'simplecov'
+  gem 'simplecov-lcov'
+end
+
+# the very top of spec_helper.rb
+require 'simplecov'
+require 'simplecov-lcov'
+SimpleCov::Formatter::LcovFormatter.config.report_with_single_file = true
+SimpleCov.formatter = SimpleCov::Formatter::LcovFormatter
+SimpleCov.start do
+  add_filter(/^\/spec\//)
+end
+
+require 'undercover'
+
+# ...
+```
+
 ## Usage
 
-TODO: Write usage instructions here
+### Compare method and class coverage with latest commit
+
+```sh
+undercover
+```
+
+### Compare with branch/ref
+
+Undercover will list all methods and classes that haven't been covered in specs and have been added since a given git `ref`. Use the `-c --compare ref` flag to specify a git ref (commit hash, branch name, tag) to compare against.
+
+**This is a recommended usage for CI/CD build environments**, as `undercover` will `exit 1` if there are any warnings.
+
+```sh
+undercover --compare master
+```
+
+### Options
+
+```sh
+undercover -h
+Usage: undercover [options]
+    -l, --lcov path                  LCOV report file path
+    -p, --path path                  Project directory
+    -g, --git-dir dir                Override `.git` with a custom directory
+    -c, --compare ref                Generate coverage warnings for all changes after `ref`
+    -h, --help                       Prints this help
+        --version                    Show version
+```
+
+The defaults assume that the program is run from the top level of the project directory.
 
 ## Development
 
@@ -35,7 +101,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/undercover.
+Bug reports and pull requests are welcome on GitHub at https://github.com/grodowski/undercover.
 
 ## License
 

data/Rakefile

@@ -1,6 +1,13 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
 
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+desc 'Run RuboCop'
+RuboCop::RakeTask.new(:rubocop)
+
+desc 'Run Tests'
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: %i[rubocop spec]

data/bin/undercover

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-$LOAD_PATH.unshift("#{__dir__}/../../lib")
+$LOAD_PATH.unshift("#{__dir__}/../lib")
 
 require 'undercover'
 require 'benchmark'

data/lib/undercover.rb

@@ -19,7 +19,6 @@ module Undercover
     def_delegators :changeset, :validate
 
     attr_reader :changeset,
-                :code_structure,
                 :lcov,
                 :results
 
@@ -27,8 +26,6 @@ module Undercover
     # add dependecy on "options" for all opts (dirs, git_dir, etc)
     def initialize(lcov_report_path, code_dir, git_dir: '.git', compare: nil)
       @lcov = LcovParser.parse(File.open(lcov_report_path))
-      # TODO: optimise by building changeset structure only!
-      @code_structure = Imagen.from_local(code_dir)
       @changeset = Changeset.new(File.join(code_dir, git_dir), compare).update
       @results = Hash.new { |hsh, key| hsh[key] = [] }
     end
@@ -71,13 +68,16 @@ module Undercover
 
     private
 
+    # TODO: some of this could be moved to the imagen gem
+    # TODO: should that start from changeset.file_paths?
+    # this way we could report things that weren't even loaded in any spec,
+    # so is this still good idea? (Rakefile, .gemspec etc)
     def each_result_arg
-      matches_path = lambda do |path|
-        ->(node) { node.file_path.end_with?(path) }
-      end
-
+      match_all = ->(_) { true }
       lcov.source_files.each do |filename, coverage|
-        code_structure.find_all(matches_path[filename]).each do |node|
+        ast = Imagen::Node::Root.new
+        Imagen::Visitor.traverse(Parser::CurrentRuby.parse_file(filename), ast)
+        ast.children[0].find_all(match_all).each do |node|
           yield(filename, coverage, node)
         end
       end

data/lib/undercover/changeset.rb

@@ -35,13 +35,18 @@ module Undercover
     end
 
     def last_modified
-      mod = files.keys.map do |f|
-        next T_ZERO unless File.exists?(f)
-        File.mtime(File.join(repo.workdir, f))
+      mod = file_paths.map do |f|
+        path = File.join(repo.workdir, f)
+        next T_ZERO unless File.exist?(path)
+        File.mtime(path)
       end.max
       mod || T_ZERO
     end
 
+    def file_paths
+      files.keys.sort
+    end
+
     def each_changed_line
       files.each do |filepath, line_numbers|
         line_numbers.each { |ln| yield filepath, ln }

data/lib/undercover/cli.rb

@@ -14,6 +14,8 @@ module Undercover
       no_changes: Rainbow('✅ No reportable changes').green
     }.freeze
 
+    WARNINGS_TO_EXITCODE = {stale_coverage: 1, no_changes: 0}.freeze
+
     # TODO: add executable in ./bin later
     # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
     def self.run(args)
@@ -28,7 +30,7 @@ module Undercover
       error = report.validate(opts.lcov)
       if error
         puts(WARNINGS_TO_S[error])
-        return 1
+        return WARNINGS_TO_EXITCODE[error]
       end
 
       warnings = report.build_warnings

data/lib/undercover/formatter.rb

@@ -15,7 +15,7 @@ module Undercover
 
     def formatted_warnings
       @results.map.with_index(1) do |res, idx|
-        "🚨 #{idx}) node `#{res.node.name}` type: #{res.node.class},\n" +
+        "🚨 #{idx}) node `#{res.node.name}` type: #{res.node.human_name},\n" +
           (' ' * pad_size) + "loc: #{res.file_path_with_lines}," \
           " coverage: #{res.coverage_f * 100}%\n" +
           res.pretty_print

data/lib/undercover/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Undercover
-  VERSION = "0.1.0"
+  VERSION = '0.1.1'
 end

data/undercover.gemspec

@@ -1,33 +1,37 @@
+# frozen_string_literal: true
 
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "undercover/version"
+require 'undercover/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "undercover"
+  spec.name          = 'undercover'
   spec.version       = Undercover::VERSION
-  spec.authors       = ["Jan Grodowski"]
-  spec.email         = ["jgrodowski@gmail.com"]
+  spec.authors       = ['Jan Grodowski']
+  spec.email         = ['jgrodowski@gmail.com']
 
-  spec.summary       = %q{Actionable code coverage - detects untested code blocks in recent changes}
-  spec.homepage      = "https://github.com/grodowski/undercover"
-  spec.license       = "MIT"
+  spec.summary       = 'Actionable code coverage - detects untested' \
+                       ' code blocks in recent changes'
+  spec.homepage      = 'https://github.com/grodowski/undercover'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
+    f.match(/^(test|spec|features)\//)
   end
-  spec.bindir        = "bin"
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
 
-  spec.add_dependency 'imagen', '~> 0.1.0'
+  spec.add_dependency 'imagen', '~> 0.1.1'
   spec.add_dependency 'rainbow', '~> 3.0.0'
   spec.add_dependency 'rugged', '~> 0.27.0'
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'bundler', '~> 1.16'
   spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.55.0'
   spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'simplecov-lcov'
+  spec.add_development_dependency 'timecop'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: undercover
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Jan Grodowski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-10 00:00:00.000000000 Z
+date: 2018-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: imagen
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.1.1
 - !ruby/object:Gem::Dependency
   name: rainbow
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -95,7 +109,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.55.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.55.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +137,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: simplecov-lcov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -123,7 +151,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov-lcov
+  name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -140,8 +168,6 @@ description:
 email:
 - jgrodowski@gmail.com
 executables:
-- console
-- setup
 - undercover
 extensions: []
 extra_rdoc_files: []
@@ -155,8 +181,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
 - bin/undercover
 - lib/undercover.rb
 - lib/undercover/changeset.rb
@@ -166,6 +190,8 @@ files:
 - lib/undercover/options.rb
 - lib/undercover/result.rb
 - lib/undercover/version.rb
+- screenshot_success.png
+- screenshot_warnings.png
 - undercover.gemspec
 homepage: https://github.com/grodowski/undercover
 licenses:

data/bin/console

@@ -1,7 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "undercover"
-require "pry"
-
-Pry.start

data/bin/setup

@@ -1,8 +0,0 @@
-#!/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