coco 0.14.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d2ad77928953cdcb188c1a23fd0e3305876a3d63
-  data.tar.gz: 6575f5fea0141f3824172835eb1f701485d694cf
+  metadata.gz: 43c9f3652fdd1a0d076a55cc16ff8f479c6e243a
+  data.tar.gz: 922a59fa96f022356bbd639b94f02299a44d209f
 SHA512:
-  metadata.gz: acb60b91e3097ea477f510a3cb235cc02b120e29399b5228f0f7c519855152fd458757f6242b5dffd95dfdd2479b5d97b21a5f8c3985abaade3398c7aff883ee
-  data.tar.gz: fd645a95bbc252eb7face09d94cf7b0e305eeedda922431a51c9d5597b271b224eb8fef4b77c4e8d9b44634c5c7598510ab9d5b46c1ac1dc4bf0780b6d64e77f
+  metadata.gz: 466b4ece64b0ba67bc5537094ec57f2b2289e7b8d043c163bf889e361fc48c45145404837924e492cf74b43b0df6bf1ccb3260eea80efc8ec8963f0ed0063bea
+  data.tar.gz: 39f8c68fc9edb94231328c5aae8b37ff0c311fdea2c904e28c4d76d58f8bb987d208783ab80b7558b6a8a393d1ad565e8a5dfd47367a769c9badae21bb9f5f5f

data/Changelog.markdown

@@ -2,6 +2,23 @@ Next version (Unreleased)
 =================================================
 
 
+v0.15.0 (2017-02-27)
+=================================================
+
+## Added
+
+* It's now possible to exit (with code status 2) from coco when the coverage
+  is less than a particular threshold. This feature allow the build to fail in
+  continuous integration. This behavior is controlled by the option
+  `:exit_if_coverage_below` and is to 0 by default (that is it's not active).
+
+## Changed
+
+* The coverage rate is now displayed in decimal format. So it's 12.34% instead
+  of 12%. This change affect the console summary as well as the index page of
+  the HTML report.
+
+
 v0.14.0 (2016-04-16)
 =================================================
 

data/Gemfile.lock

@@ -1,41 +1,41 @@
 PATH
   remote: .
   specs:
-    coco (0.14.0)
+    coco (0.15.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    builder (3.2.2)
-    cucumber (2.3.3)
+    builder (3.2.3)
+    cucumber (2.4.0)
       builder (>= 2.1.2)
-      cucumber-core (~> 1.4.0)
+      cucumber-core (~> 1.5.0)
       cucumber-wire (~> 0.0.1)
       diff-lcs (>= 1.1.3)
-      gherkin (~> 3.2.0)
+      gherkin (~> 4.0)
       multi_json (>= 1.7.5, < 2.0)
       multi_test (>= 0.1.2)
-    cucumber-core (1.4.0)
-      gherkin (~> 3.2.0)
+    cucumber-core (1.5.0)
+      gherkin (~> 4.0)
     cucumber-wire (0.0.1)
-    diff-lcs (1.2.5)
-    gherkin (3.2.0)
-    multi_json (1.11.2)
+    diff-lcs (1.3)
+    gherkin (4.0.0)
+    multi_json (1.12.1)
     multi_test (0.1.2)
-    rake (10.4.2)
-    rspec (3.4.0)
-      rspec-core (~> 3.4.0)
-      rspec-expectations (~> 3.4.0)
-      rspec-mocks (~> 3.4.0)
-    rspec-core (3.4.4)
-      rspec-support (~> 3.4.0)
-    rspec-expectations (3.4.0)
+    rake (12.0.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-mocks (3.4.1)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-support (3.4.1)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
 
 PLATFORMS
   ruby
@@ -48,4 +48,4 @@ DEPENDENCIES
   rspec (~> 3.4)
 
 BUNDLED WITH
-   1.11.2
+   1.13.7

data/README.markdown

@@ -3,11 +3,9 @@ coco [![Build Status](https://travis-ci.org/lkdjiin/coco.png)](https://travis-ci
 
 — *«If it's well-covered it doesn't mean it's well-tested!»* —
 
-Code coverage tool for ruby 2.0, 2.1, 2.2 and 2.3.
-=======
+# Code coverage tool for ruby 2.x
 
-Install
---------------------------------
+## Install
 
 In your Gemfile:
 
@@ -23,8 +21,7 @@ And in case you want to test the latest development:
 
     gem 'coco', github: 'lkdjiin/coco', branch: 'development'
 
-Usage
---------------------------------
+## Usage
 Require the coco library at the beginning of your tests:
 
     require 'coco'
@@ -50,8 +47,7 @@ the `coverage/index.html` to access a line by line report.
 _Note: files with a coverage of 0% are only listed in index.html ; there
 is no line by line report for such files._
 
-Basic Configuration
-----------------------------------
+## Basic Configuration
 
 Configuration is done via a YAML file. You can configure:
 
@@ -144,21 +140,7 @@ _Note: YAML is very punctilious with the syntax. In particular, paid attention
 to not put any leading spaces or tab at all._
 
 
-Advanced configuration
----------------------------------
-
-### See coverage of all files in the console
-
-By default, with a multilines report style on the console, Coco will display
-only the files with a coverage above the threshold. And as the threshold is
-100% by default, nothing will be displayed if your test suite is 100% covered.
-This could be annoying for some people, or worst, you could even feel like Coco
-doing something the wrong way.
-
-So, to display in green the covered files, put this in your `.coco.yml`
-configuration file:
-
-    :exclude_above_threshold: false
+## Advanced configuration
 
 ### When to start coco, and when not to start it
 
@@ -191,6 +173,34 @@ environement variable `COCO`, like this:
 
     COCO=1 rspec
 
+### Premature exit if coverage is under a particular threshold
+
+If you're using some kind of continuous integration, there is some chance you
+would like the build to fail if the coverage is under a particular threshold.
+In such case you want to set the `exit_if_coverage_below` option.
+
+#### Example
+
+Put this in your `.coco.yml` configuration file:
+
+    :exit_if_coverage_below: 95
+
+This will make coco fail if the coverage percentage is below 95%.
+
+
+### See coverage of all files in the console
+
+By default, with a multilines report style on the console, Coco will display
+only the files with a coverage above the threshold. And as the threshold is
+100% by default, nothing will be displayed if your test suite is 100% covered.
+This could be annoying for some people, or worst, you could even feel like Coco
+doing something the wrong way.
+
+So, to display in green the covered files, put this in your `.coco.yml`
+configuration file:
+
+    :exclude_above_threshold: false
+
 ### Index page URI in your terminal
 
 If your terminal supports opening an URI with a double-clic (or any
@@ -213,8 +223,7 @@ Now, when running tests, you will see something like the following:
     See file:///path/to/your/coverage/index.html
 
 
-How is this different than [SimpleCov](https://github.com/colszowka/simplecov) ?
---------------------------------
+## How is this different than [SimpleCov](https://github.com/colszowka/simplecov) ?
 
 I designed Coco from the start to have only the features I need. And I don't
 need much: 95% of the time, all I want is a tiny one line summary in my console.
@@ -229,26 +238,22 @@ To synthesize, if you have big needs, give SimpleCov a try ; if you have small
 needs, give Coco a try.
 
 
-Contributing
---------------------------------
+## Contributing
 
 1. Fork it.
-2. Create your feature branch **from the development branch**:
-   - `git checkout development`
-   - `git pull origin development`
+2. Create your feature branch
+   - `git pull origin master`
    - `git checkout -b my-new-feature`
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a Pull Request.
 
 
-License
---------------------------------
+## License
 MIT, see LICENSE.
 
 
-Questions and/or Comments
---------------------------------
+## Questions and/or Comments
 
 Feel free to email [Xavier Nayrac](mailto:xavier.nayrac@gmail.com)
 with any questions, or contact me on [twitter](https://twitter.com/lkdjiin).

data/TODO.md

@@ -0,0 +1,3 @@
+twitter
+blog / exemple avec travis et/ou circle
+

data/VERSION

@@ -1 +1 @@
-0.14.0
+0.15.0

data/lib/coco.rb

@@ -11,7 +11,7 @@ require 'coco/deprecated_message'
 require 'coverage'
 
 # Public: Main namespace of Coco, a code coverage utilily for
-# Ruby from 2.0 to 2.3.
+# Ruby 2.x.
 #
 module Coco
   ROOT = File.expand_path(File.dirname(__FILE__) + '/..').freeze

data/lib/coco/configuration.rb

@@ -30,6 +30,7 @@ module Coco
       show_link_in_terminal: false,
       exclude_above_threshold: true,
       theme: 'light',
+      exit_if_coverage_below: 0,
     }.freeze
 
     # Public: Initialize a Configuration.

data/lib/coco/cover/summary.rb

@@ -12,7 +12,7 @@ module Coco
     end
 
     def to_s
-      "Cover #{average}% | #{uncovered_count} uncovered | #{count} files"
+      "Cover #{'%.2f' % average}% | #{uncovered_count} uncovered | #{count} files"
     end
 
     # Public: Computes the average coverage rate.
@@ -25,10 +25,10 @@ module Coco
     # In words: Take the sum of the coverage's percentage of all files
     # and divide this sum by the number of files.
     #
-    # Returns the Fixnum rounded average rate of coverage.
+    # Returns the Float average rate of coverage.
     #
     def average
-      files_present? ? (sum / count).round : 0
+      files_present? ? sum / count : 0
     end
 
     private

data/lib/coco/project.rb

@@ -3,6 +3,7 @@ module Coco
   # A project reports statistics about the code coverage.
   #
   class Project
+    EXIT_ON_LOW_COVERAGE_CODE = 2
 
     # raw_result - The hash obtain by the call to `Coverage.result`.
     # out        - The output where results will be displayed, by
@@ -23,10 +24,26 @@ module Coco
 
       report_on_console
       report_in_html
+
+      maybe_exit_if_low_coverage
     end
 
     private
 
+    def maybe_exit_if_low_coverage
+      return if coverage_is_satisfying?
+
+      message = "Sadly, the code coverage is below the required value of " +
+                "#{@config[:exit_if_coverage_below]}%"
+      @out.puts ColoredString.new(message).red
+
+      exit(EXIT_ON_LOW_COVERAGE_CODE)
+    end
+
+    def coverage_is_satisfying?
+      Summary.new(result, uncovered).average >= @config[:exit_if_coverage_below]
+    end
+
     def report_on_console
       formatter = ConsoleFormatter.new(uncovered, @config[:threshold],
                                        result, @config)

data/template/index.erb

@@ -19,7 +19,7 @@
 
     <section class="summary">
       <p>
-      <span class="summary-rate">Rate <%= @summary.average %>%</span>
+      <span class="summary-rate">Rate <%= '%.2f' % @summary.average %>%</span>
       <span class="summary-uncovered">Uncovered <%= @summary.uncovered_count %></span>
       <span class="summary-files">Files <%= @summary.count %></span>
       </p>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: coco
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Xavier Nayrac
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-16 00:00:00.000000000 Z
+date: 2017-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -84,6 +84,7 @@ files:
 - LICENSE
 - README.markdown
 - Rakefile
+- TODO.md
 - VERSION
 - lib/coco.rb
 - lib/coco/configuration.rb
@@ -137,7 +138,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Code coverage tool for ruby 2.x