module Codecov

Codecov module for executing codecov coverage for any platform independently

Constants

CODECOV_DESTINATION
NAME: Gem information
SCRIPT_ENDPOINT
VERSION

Attributes

CODECOV_DESTINATION[RW]

SCRIPT_ENDPOINT[RW]

Public Class Methods

as_flags(params) click to toggle source

Transforms the params into flags @param params nonnull map of <k,v>

# File lib/global-codecov.rb, line 89
def self.as_flags(params)
        return '' if params.nil?

        return params.map { |k,v|
                case
                        when v.nil?
                                "-#{k.to_s.shellescape}"
                        when v.is_a?(String)
                                "-#{k.to_s.shellescape} #{v.to_s.shellescape}"
                        when v.is_a?(Array)
                                v.flat_map { |iv| [ "-#{k.to_s.shellescape}", iv.to_s.shellescape ] }[0..-1].join(' ')
                        else 
                                raise "Cant understand '#{k}' => '#{v}'"
                end
        }.join(' ')
end

download_script() click to toggle source

PRIVATE. This method is for the api, avoid using it

Downloads the SCRIPT_ENDPOINT into the CODECOV_DESTINATION This method doesnt have behavior if the CODECOV_DESTINATION already exists

# File lib/global-codecov.rb, line 113
def self.download_script()
        unless File.file? self.CODECOV_DESTINATION
                download = open(self.SCRIPT_ENDPOINT)
                IO.copy_stream(download, self.CODECOV_DESTINATION)
        end
end

run(params = nil) click to toggle source

PUBLIC

Runs codecov

@params map with parameters for codecov @returns command ran Eg. params = {

'c' => nil,
'empty' => '',
'X' => [ 'gcov', 'coveragepy', 'fix' ],
'R' => 'root_dir',
't' => 'MY_ACCESS_TOKEN'

}

Translates to: bash <(codecov.io/bash) -c -empty '' -X gcov -X coveragepy

-X fix -R root_dir -t MY_ACCESS_TOKEN

Notes: This will shellescape ALL, since this is still a shell so using $MY_VAR wont work. If you want to pass a variable use ENV and pass that in the map.

For information about all the params codecov supports, refer to the bash script -h function :)

# File lib/global-codecov.rb, line 73
def self.run(params = nil)
        download_script unless File.file? self.CODECOV_DESTINATION

        flags = ''
        flags << as_flags(params) unless params.nil?

        command = "bash #{self.CODECOV_DESTINATION} #{flags}"

        system command
        return command
end

set_script_destination(dest) click to toggle source

PUBLIC

Set the script destination path. We will download the bash script in this path

@param dest String with the absolute file path, used as destination for the bash script

Defaults to “codecov_script.sh”

# File lib/global-codecov.rb, line 42
def self.set_script_destination(dest)
        self.CODECOV_DESTINATION = dest.to_s.shellescape
end