Proposal: Test coverage report for the project

[esparta]

Currently the project has no test coverage report, this can be a nice to have to maintain and improve the CSV gem.

Pros:

• We can actively monitor what needs to be done on the current tests and be prepared also for the new contributions.
• Analyze new areas of improvements (on test and the code)

Cons:

• None. Not technical at least.

Plan (if accepted):

• Add SimpleCov gem as development dependency and configure the unit test according.
• Optionally, setup a service to have the info visible(as CodeClimate)

[esparta]

I did the first step of the plan. According to SimpleCov the project has 98.86% of coverage:

Some missing coverage is related to exceptions, and some other like Table#push has apparently no test at all:

This is the patch needed:

diff --git a/csv.gemspec b/csv.gemspec
index 6a3435f..5fc79e7 100644
--- a/csv.gemspec
+++ b/csv.gemspec
@@ -25,4 +25,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "benchmark-ips"
+  spec.add_development_dependency "simplecov"
 end
diff --git a/test/lib/test/unit.rb b/test/lib/test/unit.rb
index b83b56a..e600b38 100644
--- a/test/lib/test/unit.rb
+++ b/test/lib/test/unit.rb
@@ -9,6 +9,9 @@ require_relative '../envutil'
 require 'test/unit/testcase'
 require 'optparse'

+require 'simplecov'
+SimpleCov.start
+

Obviously would need bundle & rake in order to have your report.

On the optional part I also setup the CodeClimate for my fork (https://codeclimate.com/github/esparta/csv), and currently looks like this:

[kou]

OK.

[kou]

@hsbt Can you enable this repository on Code Climate or Codecov? (I don't have any opinion for code coverage report service.)

[hsbt]

I enabled codeclimate with ruby/csv.

@esparta What should I do next step?

[esparta]

The next step should be just a simple PR with all the changes, we can use Github's suggestions to change the CodeClimate Test ID and the URL for the Badge.