lcoveralls 0.2.0 → 0.2.1.pre.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c462ce13fc850020fa683a07e8f892f39b30e380
+  data.tar.gz: 52368ddb0c15c2feb97bdf9ef8987d56e85538fc
+SHA512:
+  metadata.gz: ebd18da325d78de34ed8ff45ce56b6f39c747ede904dca6c3457d04cc917e095996d3ebd732577106d2c0595e2fe1b60de03588c8aa0eee40f3929d4026c96cb
+  data.tar.gz: b9939492b8235f1766a4e570b9eed6f08f2c86efc5d28912fd67721d955914a17bca514a9c31b7e7273aa344a19da0918b5ed5421d97cdc3fc83f9f56e1f8d6e

data/lib/lcoveralls/color_formatter.rb

@@ -18,8 +18,10 @@ require 'logger'
 
 module Lcoveralls
 
+  # Adds some color to loggers.
   class ColorFormatter < Logger::Formatter
 
+    # Maps log severities to color codes.
     COLOR_CODES = {
       'Warning' => '35',
       'Error'   => '31',
@@ -27,10 +29,19 @@ module Lcoveralls
       'Unknown' => '31;1'
     }
 
+    # Initializes a new ColorFormatter.
+    #
+    # @param color [Boolean] Whether to enable color output.
     def initialize(color)
       @color = color
     end
 
+    # Invoked by Logger objects to format a log message.
+    #
+    # @param severity [String] Severity of the message to format.
+    # @param datetime [Time] Timestamp for the message to format.
+    # @param progname [String] Name of the program that generated the message.
+    # @param msg [String] The message to format.
     def call(severity, datetime, progname, msg)
       severity.capitalize!
       if severity == 'Warn' then severity = 'Warning' end

data/lib/lcoveralls/coveralls_request.rb

@@ -19,11 +19,17 @@ require 'net/http'
 
 module Lcoveralls
 
+  # Encapsulates a Coveralls (coverall.io) HTTP POST request.
   class CoverallsRequest < Net::HTTP::Post
 
+    # Initializes a new CoverallsRequest instance.
+    #
+    # @param job [Hash] The fields of a Coveralls API request. Can be any type
+    #        that can be passed to +JSON#generate+.
+    # @param path Optional HTTP request path.
     def initialize(job, path='/api/v1/jobs')
       super path
-      @boundary = (1...70).map { self.class.boundary_chr(rand(62)) }.join
+      @boundary = (1..70).map { self.class.boundary_chr(rand(62)) }.join
       set_content_type "multipart/form-data, boundary=#{@boundary}"
       @body =
         "--#{@boundary}\r\n" +
@@ -32,7 +38,15 @@ module Lcoveralls
         JSON::generate(job) + "\r\n--#{@boundary}--\r\n"
     end
 
-    # Note, 0-73 is valid for MIME, but only 0-61 is valid for HTTP headers.
+    # Returns one of the 74 valid MIME boundary characters.
+    #
+    # @param index [Integer] Index of the boundary character to fetch. Must be
+    #        between 0 and 73. *Note*, although indices between 0 and 73 are
+    #        valid according to the MIME standard, only indices between 0 and
+    #        61 are valid for HTTP headers. If index is outside the range 0 to
+    #        73, this method will raise a RuntimeError.
+    #
+    # @return [String] a valid MIME boundary character.
     def self.boundary_chr(index)
       case index
       when 0..9
@@ -44,7 +58,7 @@ module Lcoveralls
       when 62..73
         "'()+_,-./:=?"[index - 62]
       else
-        abort "Invalid boundary index #{index}"
+        raise "Invalid boundary index #{index}"
       end
     end
 

data/lib/lcoveralls/logger.rb

@@ -16,12 +16,21 @@
 
 require 'logger'
 
+# Adds {TRACE} severity logging to Ruby's Logger class.
 class Logger
 
+  # {TRACE} severity is one less than +::Logger::DEBUG+.
   TRACE = DEBUG - 1
 
+  # Log a {TRACE} message.
+  #
+  # See +::Logger::info+ for more information.
   def trace(progname = nil, &block)
     add(TRACE, nil, progname, &block)
   end
 
+  # Returns +true+ if the current severity level allows for the printing of
+  # {TRACE} messages.
+  def trace?; @level <= TRACE; end
+
 end

data/lib/lcoveralls/option_parser.rb

@@ -19,8 +19,14 @@ require 'optparse'
 
 module Lcoveralls
 
+  # Parses CLI options for the Lcoveralls application.
   class OptionParser
 
+    # Destructively parse the command line arguments.
+    #
+    # @params args [Array] Arguments to parse.
+    #
+    # @return [Hash] parsed options.
     def parse!(args)
       options =  {
         :color          => $stderr.isatty,
@@ -90,7 +96,7 @@ module Lcoveralls
       rescue ::OptionParser::InvalidOption => e
         $stderr.puts parser
         $stderr.puts e
-        exit!
+        exit(false)
       end
     end
 

data/lib/lcoveralls/runner.rb

@@ -1,4 +1,3 @@
-#!/usr/bin/ruby -w
 #
 # Copyright 2014 Paul Colby
 #
@@ -16,10 +15,14 @@
 #
 
 require 'find'
+require 'openssl'
 
 module Lcoveralls
+
+  # Runs the Lcoveralls application.
   class Runner
 
+    # Initializes a new Locveralls::Runner instance.
     def initialize
       # Parse the command line options.
       parser = Lcoveralls::OptionParser.new
@@ -32,6 +35,21 @@ module Lcoveralls
       @log.debug { "Options: #{@options}" }
     end
 
+    # Attempts to auto-detect the git repository root.
+    #
+    # This method looks throuhgh all source files covered by the supplied
+    # tracefiles, and for each, check if they are part of a git repository.
+    # The method then returns git repository's root directory.
+    #
+    # If more than one git repository are found to be covered by the tracefiles
+    # then a warning will be logged, and the root of the repository with the
+    # largest number of source files covered will be returned.
+    #
+    # If no git repository roots could be found, then +nil+ is returned.
+    #
+    # @param info_files [Array] A list of LCOV tracefiles (aka *.info files).
+    #
+    # @return [String, nil] A git repository root, if found, otherwise +nil+.
     def find_root(info_files)
       # Try source file(s) covered by the lcov tracefile(s).
       root_dirs = Hash.new(0)
@@ -57,6 +75,21 @@ module Lcoveralls
       end
     end
 
+    # Format a percentage string.
+    #
+    # This method formats the number of lines hit, as a percentage of the total
+    # number of lines, including prepended spaces, and color codes where
+    # appropriate.
+    #
+    # If the percentage cannot be calculated (for example, either parameter is
+    # +nil+, NaN, +/- ininity, etc), then this function will return a 'blank'
+    # string - one with enough spaces to match the width of other valid
+    # percentage strings returned by this function.
+    #
+    # @param lines_hit [Integer, nil] Number of lines hit by unit tests.
+    # @param lines_found [Integer, nil] Number of executable lines.
+    #
+    # @return [String] Percentage of lines overered.
     def get_percentage(lines_hit, lines_found, bold=false)
       perc = lines_hit.to_f / lines_found.to_f * 100.0
       color = case when perc >= 90; 32 when perc >= 75; 33 else 31 end
@@ -66,6 +99,16 @@ module Lcoveralls
       perc
     end
 
+    # Builds a hash of source files matching the Coveralls API.
+    #
+    # This method will build a Hash containing all source files covered by the
+    # supplies LCOV tracefiles, that reside within the specified repository
+    # root directory.
+    #
+    # @param info_file [Array] LCOV tracefiles containing source files to load.
+    # @param root_dir [String] Repository root directory.
+    #
+    # @return [Hash] Source files in Coveralls API structure.
     def get_source_files(info_files, root_dir)
       sources = {}
       total_lines_found = 0
@@ -132,6 +175,11 @@ module Lcoveralls
       sources.values
     end
 
+    # Get git repository information in the Coveralla API structure.
+    #
+    # @param root_dir Git repository root directory.
+    #
+    # @return [Hash] Git repository information.
     def get_git_info(root_dir)
       Dir.chdir(root_dir) do
         info = {
@@ -159,7 +207,19 @@ module Lcoveralls
       end if Dir.exist?(root_dir)
     end
 
-    def should_retry
+    # Should we retry a failed Coveralls API request?
+    #
+    # This method is called by {#run} on internal and server errors to check if
+    # the API request should be retried. Specifically, this function checks the
+    # :retry_count option, and if greater than zero decrements it before
+    # returning +true+.
+    #
+    # Additionally, if retrying is appropriate, and the :retry_interval option
+    # is greater than zero, this function will also sleep for that interval.
+    #
+    # @return [Boolean] +true+ if the caller should retry the API request, or
+    #         +false+ if no more retries should be attempted.
+    def should_retry?
       return false unless @options[:retry_count] > 0
       @options[:retry_count] = @options[:retry_count] - 1;
 
@@ -174,6 +234,10 @@ module Lcoveralls
       true
     end
 
+    # Runs the Lcoveralls application.
+    #
+    # This method does the real work of building up the Coveralls API request
+    # according to the parsed options, and submitting the request to Coveralls.
     def run
       # Find *.info tracefiles if none specified on the command line.
       Find.find('.') do |path|
@@ -225,15 +289,15 @@ module Lcoveralls
           @log.debug { "HTTP response status: #{response.code} #{response.message}" }
           raise response.code unless response.is_a? Net::HTTPSuccess
           puts response.body
-        rescue RuntimeError => e
+        rescue RuntimeError
           raise unless response
           @log.error { "Received non-OK response: #{response.code} #{response.message}" }
           puts response.body
-          retry if should_retry unless response.is_a? Net::HTTPClientError
+          retry if should_retry? unless response.is_a? Net::HTTPClientError
           exit!
         rescue SocketError => error
           @log.error { error }
-          retry if should_retry
+          retry if should_retry?
           exit!
         end
       end

data/lib/lcoveralls/version.rb

@@ -15,5 +15,6 @@
 #
 
 module Lcoveralls
-  VERSION = [ 0, 2, 0 ]
+  # Lcoveralls version.
+  VERSION = [ 0, 2, 1, :pre, 1 ]
 end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lcoveralls
 version: !ruby/object:Gem::Version
-  version: 0.2.0
-  prerelease: 
+  version: 0.2.1.pre.1
 platform: ruby
 authors:
 - Paul Colby
@@ -19,37 +18,36 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- bin/lcoveralls
 - lib/lcoveralls.rb
 - lib/lcoveralls/color_formatter.rb
-- lib/lcoveralls/option_parser.rb
-- lib/lcoveralls/version.rb
+- lib/lcoveralls/coveralls_request.rb
 - lib/lcoveralls/logger.rb
+- lib/lcoveralls/option_parser.rb
 - lib/lcoveralls/runner.rb
-- lib/lcoveralls/coveralls_request.rb
-- bin/lcoveralls
+- lib/lcoveralls/version.rb
 homepage: https://github.com/pcolby/lcoveralls
 licenses:
 - Apache-2.0
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.4.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Report Gcov / LCOV (ie C, C++, Go, etc) code coverage to coveralls.io
 test_files: []