gcov2x 0.2.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 86e9963bfe5c1d5e50a80853ce8e9772123efd9f
+  data.tar.gz: 7c201f588c22f3f5c2296e3e45874518cf084ad8
+SHA512:
+  metadata.gz: c2551f66a91913ef11c5a54e877bb7801a7ced9b320e1349a51505deaa09d226c09402aa9d4131f7735031b62f62257184d4102cfc5bff8400357fe7b5d054d4
+  data.tar.gz: 57b0e1c8d95ccc1ae41eb0859abbe792306da800f953a6c42139e33e9868d8c33576bc82dd153ebeae2d2c2dc63b310058d8fbad34652772a6dfb40928861332

data/.gitignore

@@ -0,0 +1,37 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+## Emacs
+*~

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.0

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+ruby "2.1.0"
+
+gem "rspec"
+gem "terminal-table"
+gem "term-ansicolor"
+gem "mixlib-cli"
+gem 'gyoku', '~> 1.0'
+gem 'rake'
+gem 'rubygems-tasks'

data/Gemfile.lock

@@ -0,0 +1,38 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    builder (3.2.2)
+    diff-lcs (1.2.5)
+    gyoku (1.2.2)
+      builder (>= 2.1.2)
+    mixlib-cli (1.5.0)
+    rake (10.3.2)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.7)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
+    rubygems-tasks (0.2.4)
+    term-ansicolor (1.3.0)
+      tins (~> 1.0)
+    terminal-table (1.4.5)
+    tins (1.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  gyoku (~> 1.0)
+  mixlib-cli
+  rake
+  rspec
+  rubygems-tasks
+  term-ansicolor
+  terminal-table

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Mattias Bergbom
+
+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.md

@@ -0,0 +1,25 @@
+gcov2x
+======
+
+![Travis CI Status](https://travis-ci.org/mattiasbergbom/gcov2x.svg)
+
+**gcov2x** takes coverage data emitted from [llvm-cov](http://llvm.org/docs/CommandGuide/llvm-cov.html) and aggregates it into various formats, some more easily interpreted by humans, some better suited for machines.
+
+Quick Start
+-----------
+
+First, unless you haven't already done so, compile your project using ```clang --coverage``` and digest the output using ```llvm-cov``` (see the `src` dir for examples). You should end up with one or more ```.gcov``` files.
+
+Next, install the gem:
+
+```gem install gcov2x```
+
+This should furnish you with a ```gcov2x``` executable in your path.
+
+Finally, execute ```gcov2x``` in one of multiple possible ways. For instance, generate a HTML coverage report:
+
+```gcov2x --format html *.gcov > coverage.html```
+
+Disclaimer
+----------
+This is a work in progress.

data/Rakefile

@@ -0,0 +1,2 @@
+Dir['tasks/**/*.rake'].sort.each { |lib| load lib }
+

data/bin/gcov2x

@@ -0,0 +1,101 @@
+#!/usr/bin/env ruby
+
+require 'mixlib/cli'
+
+require_relative '../lib/gcov2x'
+require_relative '../lib/ansii_formatter'
+require_relative '../lib/xml_formatter'
+require_relative '../lib/html_formatter'
+
+class Util
+  def Util.opt_wrap(s, width=61)
+    s.gsub(/(.{1,#{width}})(\s+|\Z)/, "\\1\n                                     ")
+  end
+end
+
+class CGOV_CLI
+  include Mixlib::CLI
+  
+  option :filter,
+  :long => "--filter FILTER",
+  :description => Util.opt_wrap("A regex filter which specifies which files not to include in the conversion. Will filter on the actual filename (replacing any mangling done by llvm-cov using #'s) as well as the 'Source' meta attribute in the GCOV data. Available presets:
+xcode - Xcode system headers
+linux - Linux system headers
+"),
+  :proc => Proc.new { |f| (f.size > 0 and f[0] == ":" ? f[1..-1].to_sym : f ) }
+
+  option :format,
+  :short => "-f FORMAT",
+  :long => "--format FORMAT",
+  :description => Util.opt_wrap("The output format (ascii, html, xml, json)"),
+  :proc => Proc.new { |f| f.to_sym }
+  
+  option :css,
+  :short => "-c CSS",
+  :long => "--css CSS",
+  :description => Util.opt_wrap("CSS file to reference in HTML output.")
+
+  option :xsl,
+  :short => "-x XSL",
+  :long => "--xsl XSL",
+  :description => Util.opt_wrap("XSL file to reference in XML output.")
+
+  option :recursive,
+  :short => "-r",
+  :long => "--recursive",
+  :description => Util.opt_wrap("Recursively load all .gcov files in the given directory"),
+  :on => :tail,
+  :boolean => true
+  
+  option :help,
+  :short => "-h",
+  :long => "--help",
+  :description => Util.opt_wrap("Show this message"),
+  :on => :tail,
+  :boolean => true,
+  :show_options => true,
+  :exit => 0
+  
+end
+
+cli = CGOV_CLI.new
+filenames = cli.parse_options
+
+fail "Got no filename" unless filenames.is_a? Array and filenames.count > 0
+
+STDERR.puts "filter: #{cli.config[:filter]}"
+
+proj = GCOV::Project.new
+
+filter = case cli.config[:filter]
+         when :xcode then /Developer\/Toolchains\/.*\/usr\/include\//
+         when :linux then /\/usr\/include\//
+         else /#{cli.config[:filter]}/
+         end
+  
+STDERR.puts "filter regex: #{filter}"
+
+filenames.each do |filename|
+  if File.directory? filename
+    proj.add_dir filename, :recursive => cli.config[:recursive], :filter => filter
+  elsif File.file? filename
+    proj.add_file filename, :filter => filter
+  end
+end
+
+case cli.config[:format]
+when :ascii then
+  formatter = GCOV::ANSIIFormatter.new proj
+  formatter.print
+when :html then
+  formatter = GCOV::HTMLFormatter.new( proj, :css => cli.config[:css] )
+  formatter.print
+when :xml then
+  formatter = GCOV::XMLFormatter.new( proj, :xsl => cli.config[:xsl] )
+  formatter.print
+when :json then
+  fail "json export not implemented yet"
+else
+  fail "Invalid format"
+end
+

data/gcov2x.gemspec

@@ -0,0 +1,15 @@
+require File.expand_path('../lib/version.rb', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name        = 'gcov2x'
+  gem.version     = GCOV::VERSION
+  gem.date        = '2014-12-09'
+  gem.summary     = "gcov parser and formatter"
+  gem.description = "gcov2x digests .gcov files generated by llvm-cov and translates them into various common formats"
+  gem.authors     = ["Mattias Bergbom"]
+  gem.email       = 'mattias.bergbom@gmail.com'
+  gem.files       = `git ls-files`.split($\)
+  gem.executables = ["gcov2x"]
+  gem.homepage    = 'http://rubygems.org/gems/gcov2x'
+  gem.license     = 'MIT'
+end

data/lib/ansii_formatter.rb

@@ -0,0 +1,34 @@
+require 'term/ansicolor'
+include Term::ANSIColor
+
+require_relative './project'
+require_relative './file'
+require_relative './line'
+
+module GCOV
+  
+  class ANSIIFormatter
+    
+    def initialize project
+      @project = project
+    end
+    
+    def print
+      
+      @project.files.each do |file|
+        puts "#{white}#{bold}=== #{file.meta['Source']} ===#{reset}"
+        file.lines.select{|line| line.number > 0}.each do |line|
+          col = case line.count
+                when :none then dark+white
+                when :missed then black+on_red
+                else green
+                end
+          puts col + line.text + reset
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/file.rb

@@ -0,0 +1,84 @@
+require_relative './line'
+
+class TrueClass
+  def to_i
+    return 1
+  end
+end
+
+class FalseClass
+  def to_i
+    return 0
+  end
+end
+
+module GCOV
+
+  class File
+
+    attr_reader :name, :lines, :meta, :stats
+
+    def initialize name
+      fail "name required" unless name and name.is_a? String
+      @name = name
+      @lines = []
+      @meta = {}
+      @stats = {}
+    end
+
+    def add_lines &block
+      fail "add_lines requires a block" unless block_given?
+      @adding = true
+      yield
+      @adding = false
+      _update_stats
+    end
+
+    def _update_stats
+      @stats = { 
+        :missed_lines => 0,
+        :exec_lines => 0,
+        :empty_lines => 0,
+        :total_exec => 0,
+        :total_lines => 0,
+        :lines => 0,
+        :coverage => 0.0 
+      }
+
+      @lines.each do |line|
+        @stats[:missed_lines] += (line.state == :missed).to_i
+        @stats[:exec_lines] += (line.state == :exec).to_i
+        @stats[:total_exec] += (line.count.is_a?(Integer) ? line.count : 0 )
+        @stats[:empty_lines] += (line.state == :none).to_i
+      end
+      
+      @stats[:lines] = @stats[:exec_lines] + @stats[:missed_lines]
+      @stats[:total_lines] = @stats[:lines] + @stats[:empty_lines]
+      @stats[:coverage] = @stats[:exec_lines].to_f / @stats[:lines].to_f
+      @stats[:coverage_s] = sprintf("%0.01f%",100.0*@stats[:coverage])
+    end
+
+    def <<(line)
+      fail "need to be in add_lines block" unless @adding
+      if line.number == 0
+        key,val = /([^:]+):(.*)$/.match(line.text).to_a[1..2]
+        @meta[key] = val
+      else
+        @lines << line
+      end
+    end
+
+    def self.load filename
+      file = GCOV::File.new filename
+      ::File.open(filename, "r") do |file_handle|
+        file.add_lines do
+          file_handle.each_line do |line|
+            file << GCOV::Line.parse(line)
+          end
+        end
+      end
+      file
+    end
+  end
+
+end

data/lib/gcov2x.rb

@@ -0,0 +1,4 @@
+require_relative './line'
+require_relative './file'
+require_relative './project'
+require_relative './version'

data/lib/html_formatter.rb

@@ -0,0 +1,68 @@
+
+require_relative './project'
+require_relative './file'
+require_relative './line'
+
+require 'erb'
+require 'cgi'
+
+module GCOV
+  
+  class HTMLFormatter
+    
+    def get_binding # this is only a helper method to access the objects binding method
+      binding
+    end
+    
+    def initialize project, va={}
+      @project = project
+      @css = va[:css]
+
+      if !@css
+        @csslink = <<EOF
+      <style>
+
+      </style>
+EOF
+      else
+        @csslink = "<link rel=\"stylesheet\" href=\"#{@css}\" />"
+      end
+      
+      @template = ::File.read(::File.join(::File.dirname(__FILE__),"html_view.html.erb"))
+    end # initialize
+    
+    def class_of line
+      case line.count
+      when :none then "moot"
+      when :missed then "missed"
+      else "ok"
+      end
+    end
+
+    def class_of_stat value, &block
+      fail "class_of_stat needs a block" unless block_given?
+      return ( (yield value) ? "value" : "value_bad" )
+    end
+
+    def class_of_file file
+      case file.stats[:missed_lines]
+      when 0 then "header good"
+      else "header bad"
+      end
+    end
+
+    def encode text
+      CGI.escapeHTML( text )
+    end
+
+    def print
+      
+      renderer = ERB.new( @template )
+      
+      puts renderer.result(self.get_binding)
+      
+    end # HTMLFormatter#print
+
+  end # HTMLFormatter
+
+end # GCOV