coveralls-multi 1.1.2 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61f4cc6605887257e4da0207b424bc45bd28686c6245a907eb82294a0d03d382
-  data.tar.gz: a392c2e6084fa880f6ca306d947e9ee47e4ed8a9e63b9b23b7fbb0952e4f4795
+  metadata.gz: 8441c1e4d66a1cf7607a2c4c95319a14a39fbe1fdeb3bc1ac8e5f7d206a65cf1
+  data.tar.gz: 46c4e9918d6276588cd239871721ccdcb75ddc6b4659e08309b95db5439db387
 SHA512:
-  metadata.gz: 6a8de4206e8d13208a8c8e37ab29200cc299e59f55e3a7e778ffc334fe4beee18537d1db2ed46628aceb144288dbc7d7c1f8d686f8421ba0b229ddadbf8044aa
-  data.tar.gz: 8b59b47d986a7e76930430a7f08d035a05aa743428e7f0d61af04a6495a3e9eab8d5e513b9c1ad1b2b67de2eac21156d7a61d55b8fcf9ee9a551bcba79976dfe
+  metadata.gz: a302753703820c50e5ae3bbfa601fd31e54a2b76b20c0186a897d900cf960166ce4c121af7edbc97208ccfb3cfd9a53f13f0c46affbe97bd9156f8d5d099d334
+  data.tar.gz: 10b9add91ea9b65a8cc7ea503e417cd8265dda9512374e7e7dbd99f4356548ada13bb82b3f5ca74a59a266ac10c8c48483bda47f6093bfc6c2d178320afc6110

data/.travis.yml

@@ -1,5 +1,15 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.5.1
+- 2.5.1
 before_install: gem install bundler -v 1.16.1
+script: bundle exec rspec
+deploy:
+  provider: rubygems
+  api_key:
+    secure: UpgSvvPDay6lbcxVUtlChzR56u1bLTX+DXrCLxxQpKBQ8rdj+PoKUXwGzCjks1n0lGSPd6t95YJ0l9yOyrPRWj19x//aQAj5FckhldBcacR6bPBwruK0WrFMUdrUMafldxHjeYl4wWy8degThCgie1oMB2IT2l6lLJ7RyjydXNE6CqU5Fq6SYn0/bi9E7jnzAXN6wnY8PvLeOOKqK8fKSq6xtMROWN0gNM0y9q986eRjkeWWZF1eG2ZICwAQVp5ybXPYH3Riqn2Pp9J8W2uu9npp7E/V73Y7PWHeW4oXw1X5NOwgLf3A/yoAkfplGk/CDx3zLXVmEMjMf9VYTCgmW5/Unh7VQj5JfMMQQXCEXrFmaTg7A7v1PrabOMQ6GUSriic+shygpEjPk5WJfqA20Kr7H6Q9FRGCAvq1kRB85E+2y4oDrBG+YixlfjPhXcIDQPnaTAaDP886eLjQUNtU0AuSmzKeBhCbVj30G4TOGflo8wY/idyYsLbmFaxJC0UZFlkxulpvBQZVG51OIOmjqwcdZHwJ6qpIJKl8E4rG03Kpzf0jk5TWyUmj72/tkXpKQLCkNm5+9k6XXGUrhiNkII9MqIlqXcG0rYWGI37szwDwNPe7oyjHbFPx6ZgoieybUR0lKJ+Tx/DVCd0QaX0iSpmBnnpyKnXF4kmJE4Rnq/c=
+  gem: coveralls-multi
+  on:
+    tags: true
+    repo: radditude/coveralls-multi
+    branch: master

data/README.md

@@ -1,18 +1,28 @@
+
+
+[![coveralls-multi](https://img.shields.io/gem/v/coveralls-multi.svg)](https://rubygems.org/gems/coveralls-multi) [![Travis](https://img.shields.io/travis/radditude/coveralls-multi/master.svg)](https://travis-ci.org/radditude/coveralls-multi) [![Coverage Status](https://coveralls.io/repos/github/radditude/coveralls-multi/badge.svg)](https://coveralls.io/github/radditude/coveralls-multi)
+
 # CoverallsMulti
 
-CoverallsMulti is a Coveralls client with support for multi-language repos. Specify the paths to your coverage output files in `.coveralls.yml`, and CoverallsMulti will handle formatting them, merging them into one big superfile, and posting the result to Coveralls.io.
+CoverallsMulti is a Coveralls client with support for multi-language repos. Once you've set up coverage tools for all the languages in your repo, specify the paths to your coverage output files in `.coveralls.yml` and let CoverallsMulti handle formatting them, merging them into one big superfile, and posting the result to Coveralls.io.
 
 ### Currently supported:
 
+#### Languages & Output Formats
+
+| *Language* | *Coverage tool* | *Config key* |
+|----------- | --------------- | ------------ |
+| Elixir | [ExCoveralls](https://github.com/parroty/excoveralls) (JSON output) | `excoveralls` |
+| JavaScript | [nyc](https://github.com/istanbuljs/nyc), or any tool that can output an lcov file | `lcov` |
+| Ruby | [SimpleCov](https://github.com/colszowka/simplecov) | `simplecov` |
+
 #### CI Providers
-- TravisCI
 
-#### Languages/Output Formats
-- Ruby (SimpleCov)
-- JavaScript (lcov)
+- TravisCI
 
 #### Coming Soon
-- Elixir
+
+Have another language, tool, or CI provider you'd like to see supported? [Let me know](https://github.com/radditude/coveralls-multi/issues/new).
 
 ## Installation
 
@@ -32,9 +42,9 @@ Or install it yourself as:
 
 ## Usage
 
-Set up coverage measurement for each of the languages in your repo (TODO: add links to setup instructions for supported languages).
+0. Set up coverage measurement for each language. Coveralls-multi is only concerned with formatting & posting the output files, so choice of tooling is up to you.
 
-Once you know where the output files will go, add the output type and path to `.coveralls.yml`. Example:
+1. Once you know where the output files will go, set up your `.coveralls.yml` with the appropriate keys and paths like so (see supported languages above for more details on the supported config keys):
 
 ```
 service_name: travis-ci
@@ -42,9 +52,20 @@ repo_token: [REPO_TOKEN]
 multi:
   simplecov: coverage/.resultset.json
   lcov: coverage/lcov.info
+  excoveralls: cover/excoveralls.json
 ```
 
-Then run `coveralls-multi` to merge the output files and send them to Coveralls. In a CI environment, run `coveralls-multi` after you run your test commands.
+2. Run `coveralls-multi` to merge the output files and send them to Coveralls. In a CI environment, you can run `coveralls-multi` as an final step after you run your test commands.
+
+_Note for ExCoveralls:_ Currently, formatting will break if the ExCoveralls output directory is called something other than the default `cover`. You don't need to worry about this unless you've changed the default `output_dir` in your ExCoveralls config.
+
+## Troubleshooting
+
+Debug mode will save and output the merged file so you can take a closer look. To enable debug mode, add the following line to `.coveralls.yml`:
+
+```
+debug_mode: true
+```
 
 ## Development
 
@@ -52,7 +73,7 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
-TODO: more detailed instructions for adding a new formatter
+TODO: add better contributing instructions (especially for adding a new formatter)
 
 ## Contributing
 

data/lib/coveralls-multi/formatters/excoveralls.rb

@@ -1,4 +1,5 @@
 require 'json'
+require 'pathname'
 
 module CoverallsMulti
   class Formatter
@@ -7,7 +8,18 @@ module CoverallsMulti
     class Excoveralls
       def run(file_path)
         file = CoverallsMulti::Formatter.parse_json(file_path)
-        file['source_files']
+        # ExCoveralls uses paths relative to the elixir app root, which breaks things
+        # if the elixir app is in a subdirectory of the repo as a whole.
+        # So, for a somewhat hacky solution, we grab the subdirectory if it exists
+        # based on the path of the coverage file...
+        subdirectory = file_path.split('cover')[0]
+        source_files = file['source_files'].map do |source_file|
+          path = source_file['name']
+          # ...and prepend it to the file path before sending things off to Coveralls.
+          source_file['name'] = subdirectory + path
+          source_file
+        end
+        source_files
       rescue StandardError => e
         raise e, "There was a problem converting the excoveralls file at #{file_path}"
       end

data/lib/coveralls-multi/version.rb

@@ -1,3 +1,3 @@
 module CoverallsMulti
-  VERSION = '1.1.2'.freeze
+  VERSION = '1.2.2'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: coveralls-multi
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.2
 platform: ruby
 authors:
 - CJ Horton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-06 00:00:00.000000000 Z
+date: 2018-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coveralls
@@ -160,7 +160,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Coveralls client for multi-language repos.