undercover 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1eb3fb245f9d09808a19a1605fb6c70aac3c77cc8f52b8cc07b756ba33542ac3
-  data.tar.gz: d8895855e6e3e3c98446c43ce59e489ba5e2e79c5da6a2e091a195284462bff9
+  metadata.gz: 0d1c42774adbdc9699ebdd44b4ec5d20b3a00aa5ac8da172c61fd4742932ecc8
+  data.tar.gz: 914cd5575c028904029e9958e6cab614937a1fc654cc59077994870b1ef687dd
 SHA512:
-  metadata.gz: b57b782e8e9258729c94d9455bf9c410cc51761ce97082550e7ed1eb78f38bb5fa8ccc6ed4678c64cb6f662ddf36f3d961d6856371026fe5d2fb5a57fce51fa4
-  data.tar.gz: 2748d7c27b2636323c15e08bbb27d7cf9d2ae58992f34e33afd79214d11adae7ba2180e383d26814271d2058c6bf16fb03d8ed552b6ef0376b497b10111532f1
+  metadata.gz: 2957a4d20fe41d13835985e23213e1ddaf19786d09d451faecf269074f9e21f7d1120f2d7aec8d4f17e59c63dde430100e799fa2915648f5d549cc305f7b3e49
+  data.tar.gz: 4a1e0805e0b9cf51d4eb9ebd0f962637f04b523584568cab7196a9875cf48f7457b01d7f01f0281bbc466d21043c5b145a8b88308306dbbe31a38f767141b43b

data/.overcommit.yml

@@ -0,0 +1,25 @@
+# Use this file to configure the Overcommit hooks you wish to use. This will
+# extend the default configuration defined in:
+# https://github.com/brigade/overcommit/blob/master/config/default.yml
+#
+# At the topmost level of this YAML file is a key representing type of hook
+# being run (e.g. pre-commit, commit-msg, etc.). Within each type you can
+# customize each hook, such as whether to only run it on certain files (via
+# `include`), whether to only display output if it fails (via `quiet`), etc.
+#
+# For a complete list of hooks, see:
+# https://github.com/brigade/overcommit/tree/master/lib/overcommit/hook
+#
+# For a complete list of options that you can use to customize hooks, see:
+# https://github.com/brigade/overcommit#configuration
+#
+# Uncomment the following lines to make the configuration take effect.
+
+CommitMsg:
+  CapitalizedSubject:
+    enabled: false
+PrePush:
+  Undercover:
+    enabled: true
+    required: true
+    command: ['undercover', '--compare', 'origin/master']

data/.travis.yml

@@ -1,8 +1,8 @@
 language: ruby
 rvm:
-  - 2.5.1
-  - 2.4.4
-  - 2.3.4
+  - 2.5.3
+  - 2.4.5
+  - 2.3.8
 before_install:
   - gem install bundler undercover
   - gem update --system

data/CHANGELOG.md

@@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [0.2.2] - 2018-12-16
+### Fixed
+- Change stale_coverage error into a warning
+
 ## [0.2.1] - 2018-09-26
 ### Fixed
 - Bug in mapping changed lines to coverage results
@@ -54,7 +58,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ### Added
 - First release of `undercover` 🎉
 
-[Unreleased]: https://github.com/grodowski/undercover/compare/v0.2.1...HEAD
+[Unreleased]: https://github.com/grodowski/undercover/compare/v0.2.2...HEAD
+[0.2.2]: https://github.com/grodowski/undercover/compare/v0.2.1...v0.2.2
 [0.2.1]: https://github.com/grodowski/undercover/compare/v0.2.0...v0.2.1
 [0.2.0]: https://github.com/grodowski/undercover/compare/v0.1.7...v0.2.0
 [0.1.7]: https://github.com/grodowski/undercover/compare/v0.1.6...v0.1.7

data/README.md

@@ -4,30 +4,13 @@
 
 **Inspects files in a git diff and warns on methods, classes and blocks which need test coverage.** Use it locally or as part of an automated build to shorten your code coverage feedback loop!
 
-## Why?
-
-I wanted to create a tool to help others and myself ensure that tests are written for all the recent code changes. This should be useful for any ruby project, but especially those large or legacy codebases that lack testing (and we can't or don't want to invest in full test coverage).
-
-The goal was to provide automated warnings, that are:
-- relevant, so scoped to the actual code changes
-- timely, so we don't end up writing tests long after the implementation
-- actionable, so we can fix them before the code is committed or reaches production
-
-For more background, please [read the blog post](https://medium.com/futuredev/stop-shipping-untested-ruby-code-with-undercover-1edc963be4a6).
-
-## How?
-
-Technically, `undercover` combines data from git, coverage reports and code structure graphs.
-
 A sample output of `undercover` ran before a commit may look like this:
 
-![screenshot warning](screenshot_warnings.png)
+![screenshot warning](docs/screenshot_warnings.png)
 
 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).
+![screenshot success](docs/screenshot_success.png)
 
 [![Build Status](https://travis-ci.org/grodowski/undercover.svg?branch=master)](https://travis-ci.org/grodowski/undercover)
 [![Maintainability](https://api.codeclimate.com/v1/badges/b403feed68a18c072ec5/maintainability)](https://codeclimate.com/github/grodowski/undercover/maintainability)
@@ -67,7 +50,6 @@ SimpleCov::Formatter::LcovFormatter.config.report_with_single_file = true
 SimpleCov.formatter = SimpleCov::Formatter::LcovFormatter
 SimpleCov.start do
   add_filter(/^\/spec\//) # For RSpec
-  
   add_filter(/^\/test\//) # For Minitest
 end
 
@@ -80,22 +62,25 @@ Then run your test suite once through to generate the initial `coverage/lcov/*.l
 
 ## Usage
 
-### Compare method and class coverage with latest commit
+Invoked with no arguments, Undercover will flag all untested methods and classes from the current diff:
 
 ```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.
+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
+undercover --compare origin/master
 ```
 
+Check out `docs/` for CI configuration examples:
+- [Travis CI](docs/travis.yml)
+- [CircleCI - simple](docs/circleci_config.yml)
+- [CircleCI - advanced](docs/circleci_advanced.yml)
+- [Semaphore](docs/semaphore.yml)
+- [Codeship](docs/codeship.md)
+
 ### Options
 
 ```sh
@@ -109,7 +94,18 @@ Usage: undercover [options]
         --version                    Show version
 ```
 
-The defaults assume that the program is run from the top level of the project directory.
+Default options assume that the program is run from the top level of the project directory.
+
+## Why?
+
+I wanted to create a tool to help others and myself ensure that tests are written for all the recent code changes. This should be useful for any ruby project, but especially those large or legacy codebases that lack testing (and we can't or don't want to invest in full test coverage).
+
+The goal was to provide automated warnings, that are:
+- relevant, so scoped to the actual code changes
+- timely, so we don't end up writing tests long after the implementation
+- actionable, so we can fix them before the code is committed or reaches production
+
+For more background, please [read the blog post](https://medium.com/futuredev/stop-shipping-untested-ruby-code-with-undercover-1edc963be4a6).
 
 ## Development
 

data/docs/circleci_advanced.yml

@@ -0,0 +1,55 @@
+# Advanced CircleCI workflow config with file sharing
+# and separate jobs for tests and running coverage checks.
+
+version: 2
+jobs:
+  test:
+    docker:
+      - image: circleci/ruby:2.5-browsers
+    steps:
+      - checkout
+      - run:
+          name: Install dependencies
+          command: |
+            sudo apt-get install cmake
+            bundle install
+      - run:
+          name: Run RSpec
+          command: |
+            mkdir -p /tmp/coverage
+            bundle exec rspec
+      - run:
+          name: Store coverage report
+          command: mv coverage/lcov/project.lcov /tmp/coverage/
+      - persist_to_workspace:
+          root: /tmp/coverage
+          paths: .
+      - store_artifacts:
+          path: /tmp/coverage
+          destination: coverage
+  analyse_coverage:
+    docker:
+      - image: circleci/ruby:2.5-browsers
+    steps:
+      - checkout
+      - attach_workspace:
+          at: /tmp/coverage # gives access to project's LCOV report
+      - run:
+          name: Check coverage
+          command: |
+            sudo apt-get install cmake
+            gem install undercover
+            undercover --lcov /tmp/coverage/project.lcov \
+                       --compare origin/master
+
+workflows:
+  version: 2
+  build_and_test:
+    jobs:
+      - test
+      - analyse_coverage:
+          requires:
+            - test
+          filters:
+            branches:
+              ignore: master

data/docs/circleci_config.yml

@@ -0,0 +1,24 @@
+# Simple CircleCI config.yml example.
+# See workflow_config.yml for a more advanced example,
+# that includes sharing data between containers.
+
+version: 2
+jobs:
+  build:
+    docker:
+      - image: circleci/ruby:2.5-browsers
+    steps:
+      - checkout
+      - run:
+          name: Install dependencies
+          command: |
+            sudo apt-get install cmake
+            bundle install
+      - run:
+          name: Run RSpec
+          command: bundle exec rspec
+      - run:
+          name: Check coverage
+          command: |
+            gem install undercover
+            undercover --compare origin/master

data/docs/codeship.md

@@ -0,0 +1,19 @@
+Sample configuration to run `undercover` in Codeship CI. Edit these fields in **Project Settings**.
+
+**Setup commands**
+
+```
+rvm use 2.5.3 --install
+bundle install
+gem install undercover
+```
+
+**Test pipeline**
+
+```
+bundle exec rspec --format documentation --color
+# pull origin/master to have a ref to compare against
+git remote set-branches --add origin master
+git fetch
+undercover -c origin/master
+```

data/docs/semaphore.yml

@@ -0,0 +1,18 @@
+version: v1.0
+name: RSpec + Undercover
+agent:
+  machine:
+    type: e1-standard-2
+    os_image: ubuntu1804
+
+blocks:
+  - name: "RSpec"
+    task:
+      jobs:
+      - name: Run Specs and Coverage
+        commands:
+          - checkout
+          - bundle install
+          - bundle exec rspec
+          - gem install undercover
+          - undercover --compare origin/master

data/docs/travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+  - 2.5.1
+  - 2.4.4
+  - 2.3.4
+before_install:
+  - gem install bundler undercover
+  - gem update --system
+script:
+  - bundle exec rake
+  - git pull origin master:master
+  - undercover --compare master

data/lib/undercover/cli.rb

@@ -9,13 +9,12 @@ module Undercover
     # traversing the whole project at first!
 
     WARNINGS_TO_S = {
-      stale_coverage: Rainbow('♻️  Coverage data is older than your ' \
-        'latest changes. Re-run tests to update').yellow,
+      stale_coverage: Rainbow('🚨 WARNING: Coverage data is older than your ' \
+        'latest changes and results might be incomplete. ' \
+        'Re-run tests to update').yellow,
       no_changes: Rainbow('✅ No reportable changes').green
     }.freeze
 
-    WARNINGS_TO_EXITCODE = {stale_coverage: 1, no_changes: 0}.freeze
-
     # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
     def self.run(args)
       opts = Undercover::Options.new.parse(args)
@@ -25,7 +24,7 @@ module Undercover
       error = report.validate(opts.lcov)
       if error
         puts(WARNINGS_TO_S[error])
-        return WARNINGS_TO_EXITCODE[error]
+        return 0 if error == :no_changes
       end
 
       warnings = report.build_warnings

data/lib/undercover/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Undercover
-  VERSION = '0.2.1'
+  VERSION = '0.2.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: undercover
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Jan Grodowski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-26 00:00:00.000000000 Z
+date: 2018-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: imagen
@@ -188,6 +188,7 @@ extra_rdoc_files: []
 files:
 - ".codebeatsettings"
 - ".gitignore"
+- ".overcommit.yml"
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
@@ -197,6 +198,13 @@ files:
 - README.md
 - Rakefile
 - bin/undercover
+- docs/circleci_advanced.yml
+- docs/circleci_config.yml
+- docs/codeship.md
+- docs/screenshot_success.png
+- docs/screenshot_warnings.png
+- docs/semaphore.yml
+- docs/travis.yml
 - lib/undercover.rb
 - lib/undercover/changeset.rb
 - lib/undercover/cli.rb
@@ -205,8 +213,6 @@ 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: