coco 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3030feb597e938253dfae399455180d66a35f093
-  data.tar.gz: a0a298d7731658d6aff3c0493304bc7111caa4a8
+  metadata.gz: d2ad77928953cdcb188c1a23fd0e3305876a3d63
+  data.tar.gz: 6575f5fea0141f3824172835eb1f701485d694cf
 SHA512:
-  metadata.gz: 44de807fa160bf1e72e5e48dfa78464faf3f5d6bea1298f4b0afa2ccb28c0e22e5d31408c30c195655cbabb212bd5f60b9533bfc9a0f50b92f93c1a1f2153d20
-  data.tar.gz: 3a1b568bb6d43580078b59d23abe583da54d06972b8f9aa81c69ed8f30232db811633b69e00145e223904463254a74baf2257cb5fd8daf102c33384e187d29dc
+  metadata.gz: acb60b91e3097ea477f510a3cb235cc02b120e29399b5228f0f7c519855152fd458757f6242b5dffd95dfdd2479b5d97b21a5f8c3985abaade3398c7aff883ee
+  data.tar.gz: fd645a95bbc252eb7face09d94cf7b0e305eeedda922431a51c9d5597b271b224eb8fef4b77c4e8d9b44634c5c7598510ab9d5b46c1ac1dc4bf0780b6d64e77f

data/CONTRIBUTORS

@@ -0,0 +1,9 @@
+[sunaku (Suraj N. Kurapati)](https://github.com/sunaku)
+
+[Daniel Rice](https://github.com/BigNerdRanchDan)
+
+[Gioele](https://github.com/gioele)
+
+[TiteiKo](https://github.com/TiteiKo)
+
+[Nicolas Cavigneaux](https://github.com/Bounga)

data/Changelog.markdown

@@ -1,3 +1,45 @@
+Next version (Unreleased)
+=================================================
+
+
+v0.14.0 (2016-04-16)
+=================================================
+
+## Added
+
+* Add a summary (rate of coverage, number of uncovered files and total number of
+  files) in the HTML report and on the console.
+* You can now view all files in the HTML report, even those equal to or above
+  the threshold. This feature allow you to view the line's hit for every files.
+* Add support for Ruby 2.3.
+* Now you can choose between a dark theme and the (old) light one, for the HTML
+  report. The choice is made with a new configuration key : `:theme`. The
+  default theme is the light one.
+* Add acceptance testing with Cucumber.
+* [Experimental] Add support for head of MRI Ruby.
+* [Experimental] Add support for Rubinius 2.x.
+* [Experimental] Add support for (latest version of) JRuby.
+* [Experimental] Add support for OSX.
+
+## Changed
+
+* The single line report (on the console) is now the default behavior.
+* The license is now MIT.
+* Move contributors list in a file.
+
+## Removed
+
+* Removed the license's mention in the reports's index.
+* Removed the gems reek and flay from the development dependencies.
+
+## Deprecated
+
+* The configuration key `directories` will be removed in a future version, the
+  new key to use is `include`.
+* The configuration key `excludes` will be removed in a future version, the
+  new key to use is `exclude`.
+
+
 v0.13.0  (2015-07-03)
 =================================================
 

data/Gemfile.lock

@@ -1,70 +1,51 @@
 PATH
   remote: .
   specs:
-    coco (0.13.0)
+    coco (0.14.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    abstract_type (0.0.7)
-    adamantium (0.2.0)
-      ice_nine (~> 0.11.0)
-      memoizable (~> 0.4.0)
-    ast (2.0.0)
-    concord (0.1.5)
-      adamantium (~> 0.2.0)
-      equalizer (~> 0.0.9)
+    builder (3.2.2)
+    cucumber (2.3.3)
+      builder (>= 2.1.2)
+      cucumber-core (~> 1.4.0)
+      cucumber-wire (~> 0.0.1)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 3.2.0)
+      multi_json (>= 1.7.5, < 2.0)
+      multi_test (>= 0.1.2)
+    cucumber-core (1.4.0)
+      gherkin (~> 3.2.0)
+    cucumber-wire (0.0.1)
     diff-lcs (1.2.5)
-    equalizer (0.0.11)
-    flay (2.6.1)
-      ruby_parser (~> 3.0)
-      sexp_processor (~> 4.0)
-    ice_nine (0.11.1)
-    memoizable (0.4.2)
-      thread_safe (~> 0.3, >= 0.3.1)
-    parser (2.2.2.6)
-      ast (>= 1.1, < 3.0)
-    procto (0.0.2)
-    rainbow (2.0.0)
+    gherkin (3.2.0)
+    multi_json (1.11.2)
+    multi_test (0.1.2)
     rake (10.4.2)
-    reek (3.0.0)
-      parser (~> 2.2.2.5)
-      rainbow (~> 2.0)
-      unparser (~> 0.2.2)
-    rspec (2.99.0)
-      rspec-core (~> 2.99.0)
-      rspec-expectations (~> 2.99.0)
-      rspec-mocks (~> 2.99.0)
-    rspec-core (2.99.2)
-    rspec-expectations (2.99.2)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.99.4)
-    ruby_parser (3.7.0)
-      sexp_processor (~> 4.1)
-    sexp_processor (4.6.0)
-    thread_safe (0.3.5)
-    tomparse (0.4.2)
-    unparser (0.2.4)
-      abstract_type (~> 0.0.7)
-      adamantium (~> 0.2.0)
-      concord (~> 0.1.5)
-      diff-lcs (~> 1.2.5)
-      equalizer (~> 0.0.9)
-      parser (~> 2.2.2)
-      procto (~> 0.0.2)
-    yard (0.8.7.6)
-    yard-tomdoc (0.7.1)
-      tomparse (>= 0.4.0)
-      yard
+    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)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.3)
+  bundler (~> 1.11)
   coco!
-  flay (~> 2.4)
-  rake (~> 10.1)
-  reek (~> 3.0)
-  rspec (~> 2.14)
-  yard-tomdoc (~> 0.7)
+  cucumber
+  rake
+  rspec (~> 3.4)
+
+BUNDLED WITH
+   1.11.2

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2016 Xavier Nayrac
+
+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.markdown

@@ -3,27 +3,15 @@ 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 and 2.2.
+Code coverage tool for ruby 2.0, 2.1, 2.2 and 2.3.
 =======
 
-Features
---------------------------------
-
-* Use it from rspec or test/unit with a simple `require 'coco'`
-* Works with Rails
-* Display names of uncovered files on console
-* _Simple_ html report _only_ for uncovered files
-* Report sources that have no tests
-* Configurable via a simple yaml file
-* Colorized console output (nix only)
-
-
 Install
 --------------------------------
 
 In your Gemfile:
 
-    gem coco
+    gem 'coco'
 
 Or directly:
 
@@ -31,6 +19,10 @@ Or directly:
 
 *NOTE: If you're using a Gemfile, don't `:require => false`*
 
+And in case you want to test the latest development:
+
+    gem 'coco', github: 'lkdjiin/coco', branch: 'development'
+
 Usage
 --------------------------------
 Require the coco library at the beginning of your tests:
@@ -40,87 +32,147 @@ Require the coco library at the beginning of your tests:
 Usually you do this only once, by putting this line in an spec_helper.rb,
 or test_helper.rb (or whatever you named it).
 
-###View report
+### View report
 
-After your tests, coco will display a short report in the console window, like this one:
+After your tests, coco will display a **very** short report in the console
+window, like this one:
 
     $ rake test
     [...]
     26 examples, 0 failures
-    0% /home/xavier/project/lib/iprune.rb
-    0% /home/xavier/project/lib/iprune/iprune.rb
-    46% /home/xavier/project/lib/parser/prunille.rb
-    $
 
-If there is some files reported in the console, coco will create a `coverage/`
-folder at the root of the project. Browse the `coverage/index.html` to access
-a line by line report.
+    Rate 82% | Uncovered 0 | Files 7
+    $
 
-**Be careful!** Any `coverage` folder at the root of your project will be
-deleted without warning!
+coco will also create a `coverage/` folder at the root of the project. Browse
+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._
 
-Configuration
+Basic Configuration
 ----------------------------------
 
 Configuration is done via a YAML file. You can configure:
 
+* __theme__: Choose between a light and a dark theme for the HTML report
 * __threshold__: the percentage threshold
-* __directories__: the directories from where coco will search for untested source files
-* __excludes__: a list of files to exclude from the report
-* __single_line_report__: the report's style
+* __include__: the directories from where coco will search for untested source files
+* __exclude__: a list of files and/or directories to exclude from the report, if any
+* __single_line_report__: style of the report in the console
+
+By default, threshold is set to 100, the list of directories is set to `['lib']`,
+no files are excluded and the console report is a single line one.
+
+To change this default configuration, put a `.coco.yml` file at the root of your project.
+
+### Theme
+
+You can choose between a light and a dark theme. The light theme is the
+default one. For a dark theme, add this line in the configuration file:
+
+    :theme: dark
+
+**Light theme**
+
+![light](theme-light.png)
+
+**Dark theme**
+
+![dark](theme-dark.png)
+
+### Threshold
+
+Add the following line to your .coco.yml file to set the threshold to 80%.
+
+    :threshold: 80
+
+Only files under 80% of coverage will be directly reported in the report.
+I strongly advice to use the default threshold (100%).
+
+### Directories Included
 
-By default, threshold is set to 100 and directories is set to 'lib'.
+Add the following lines to your .coco.yml file to set the directories to both
+'lib' and “ext':
 
-To change the default coco configuration, put a `.coco.yml` file at the root of your project.
+    :include: 
+    - lib
+    - ext
+
+### Files and Directories Excludes
+
+Add the following lines to your .coco.yml file to exclude a file from the
+report:
+
+    :exclude:
+    - lib/project/file1.rb
+
+Add the following lines to your .coco.yml file to exclude a whole folder's
+content from the report:
+
+    :exclude:
+    - config/initializers
+
+Of course you can mix files and folders:
+
+    :exclude:
+    - path/to/file1
+    - path/to/file2
+    - folder1
+    - path/to/folder2
+
+### Single line report
+
+By default, the console's reports a brief, one line, summary. If instead, you
+want to display the coverage of all files under the threeshold, put this line
+in your .coco.yml file:
 
+    :single_line_report: false
 
-###Sample config for a Rails project
+Advice: Don't do this!
 
-    :directories: 
+## Sample config for a Rails project
+
+    :include: 
     - app
+    - custom_dir
     - lib
-    :excludes:
-    - spec
+    :exclude:
     - config/initializers
-    :single_line_report: true
 
 _Note: YAML is very punctilious with the syntax. In particular, paid attention
 to not put any leading spaces or tab at all._
 
-See [more examples](https://github.com/lkdjiin/coco/wiki) on the wiki.
 
 Advanced configuration
 ---------------------------------
 
 ### See coverage of all files in the console
 
-By default, 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.
+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:
+So, to display in green the covered files, put this in your `.coco.yml`
+configuration file:
 
     :exclude_above_threshold: false
 
 ### When to start coco, and when not to start it
-For projects whose complete test suite runs in a matter of seconds,
-running code coverage with every test is fine.
-But when the test suite takes longer to complete, we typically start to
-run a single test more often than the complete suite. In such cases,
-the behavior of **coco** could be really annoying: you run a single
-test and **coco** reports a infinite list of uncovered files. The
-problem here is this is a lie. To avoid this behavior, I recommend to
-run code coverage only from time to time, and with the entire test
-suite. To do so, **coco** provide the following configuration key:
-
-__always_run__: If true, **coco** will run every time you start a test.
-If false, **coco** will run only when you explicitly set an
+
+For projects whose complete test suite runs in a matter of seconds, running
+code coverage with every test is fine.  But when the test suite takes longer to
+complete, we typically start to run a single test more often than the complete
+suite. In such cases, the behavior of Coco could be really annoying: you
+run a single test and Coco reports a infinite list of uncovered files. The
+problem here is this is a lie. To avoid this behavior, I recommend to run code
+coverage only from time to time, and with the entire test suite. To do so,
+Coco provide the following configuration key:
+
+__always_run__: If true, Coco will run every time you start a test.
+If false, Coco will run only when you explicitly set an
 environement variable named `COCO` with something other than `false`,
 `0` or the empty string.
 
@@ -132,12 +184,12 @@ Put this in your `.coco.yml` configuration file:
 
 Now, when you run:
 
-    rspec spec/
+    rspec
 
-**coco** will no start. To start it, you have to set the
+…Coco will no start. To start it, you have to set the
 environement variable `COCO`, like this:
 
-    COCO=1 rspec spec/
+    COCO=1 rspec
 
 ### Index page URI in your terminal
 
@@ -161,10 +213,20 @@ Now, when running tests, you will see something like the following:
     See file:///path/to/your/coverage/index.html
 
 
-Dependencies
+How is this different than [SimpleCov](https://github.com/colszowka/simplecov) ?
 --------------------------------
 
-ruby >= 2.0
+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.
+
+It's easier. Add a single line of code at the start of your spec helper and
+you are good to go.
+
+It's faster. Because Coco has no dependencies and less features, analyzing and
+reporting are so fast you don't even notice them.
+
+To synthesize, if you have big needs, give SimpleCov a try ; if you have small
+needs, give Coco a try.
 
 
 Contributing
@@ -182,7 +244,7 @@ Contributing
 
 License
 --------------------------------
-GPLv3, see COPYING.
+MIT, see LICENSE.
 
 
 Questions and/or Comments
@@ -191,14 +253,3 @@ 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).
 
-Contributors
---------------------------------
-
-[sunaku (Suraj N. Kurapati)](https://github.com/sunaku)
-
-[Daniel Rice](https://github.com/BigNerdRanchDan)
-
-[Gioele](https://github.com/gioele)
-
-[TiteiKo](https://github.com/TiteiKo)
-