cxxproject_gcov 0.0.1

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Christian Köstlin
+
+MIT License
+
+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,29 @@
+# CxxprojectStats
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cxxproject_stats'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cxxproject_stats
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/lib/cxxproject_gcov/gcov.css

@@ -0,0 +1,28 @@
+body {
+    color: #000000;
+    background-color: #fff;
+}
+
+.source {
+    font-family: monospaced;
+    background-color: #fff;
+}
+
+.dead_code {
+    background-color: #FF6230;
+}
+
+.ignored_code {
+}
+
+.used_code {
+    background-color: #CAD7FE;;
+}
+
+
+.not_covered {
+    background-color: #FF6230;
+}
+
+.covered {
+}

data/lib/cxxproject_gcov/gcov.rb

@@ -0,0 +1,167 @@
+require 'ostruct'
+
+module Gcov
+  @@excludes = []
+  class << self
+    def excludes
+      @excludes = [] unless @excludes
+      return @excludes
+    end
+    def excludes=(e)
+      @excludes = e
+    end
+  end
+
+  class FileStatistics
+    attr_reader :total_lines_of_code
+    def initialize(lines)
+      @total_lines_of_code = lines.select{|i|i.hit_count.counts?}.size
+      @dead_lines_of_code = lines.select{|i|i.hit_count.count == :DEAD_CODE}.size
+      @ignored_lines_of_code = lines.select{|i|i.hit_count.count == :IGNORED}.size
+    end
+    def covered_lines
+      return @total_lines_of_code - @dead_lines_of_code
+    end
+    def coverage
+      covered = covered_lines()
+      result = (100 * (covered.to_f / @total_lines_of_code)).to_i
+      if covered < @total_lines_of_code
+        if result == 100
+          result = 99
+        end
+      end
+      return result
+    end
+  end
+
+  class Hitcount
+    attr_reader :count
+    def counts?
+      if @count == :DEAD_CODE
+        return true
+      elsif @count == :IGNORED
+        return false
+      else
+        return true
+      end
+    end
+
+    def initialize(s)
+      if s.match('#+')
+        @count = :DEAD_CODE
+      elsif s == '-'
+        @count = :IGNORED
+      else
+        @count = s.to_i
+      end
+    end
+    def join(other)
+      if @count == :DEAD_CODE
+        if other.count == :DEAD_CODE
+        elsif other.count == :IGNORED
+        else
+          @count = other.count
+        end
+      elsif @count == :IGNORED
+        if other.count == :DEAD_CODE
+          @count = :DEAD_CODE
+        elsif other.count == :IGNORED
+        else
+          @count = other.count
+        end
+      else
+        if other.count == :DEAD_CODE
+        elsif other.count == :IGNORED
+        else
+          @count += other.count
+        end
+      end
+      self
+    end
+  end
+  
+  def self.match_to_line(match)
+=begin
+lines look like this:
+    4:   30:    }
+    -:   31:
+#####:   32:    void Timestamp::unused() {
+=end
+    hit_count = Hitcount.new(match[1].strip)
+    line_number = match[2].strip.to_i
+    code = match[3]
+    OpenStruct.new({:hit_count => hit_count, :line_number => line_number, :code => code})
+  end
+
+  def self.parse_gcov_string(str)
+    line_regexp = Regexp.new('(.*?):(.*?):(.*)')
+    matches = str.each_line.map{|i|i.match(line_regexp)}
+    return matches.map{|match|match_to_line(match)}.delete_if{|line|line.line_number == 0}
+  end
+  
+  def self.simplify_path(p)
+    path_elements = p.split('/')
+    path_elements = path_elements.delete_if{|i|i == '.'}
+    new_elements = []
+    path_elements.each do |i|
+      if i == '..'
+        if new_elements.size > 0
+          new_elements.pop
+        else
+          new_elements << i
+        end
+      else
+        new_elements << i
+      end
+    end
+    return new_elements.join('/')
+  end
+
+  def self.replace_hash_with_slash(f)
+    f.gsub('#', '/')
+  end
+
+  def self.get_source_file(file)
+    res = ''
+    if not file.index('#')
+      # no #
+      res = file
+    elsif file.index('##')
+      # two or more ##
+      res = replace_hash_with_slash(file[0...file.index('##')])
+    else
+      # one #
+      res = replace_hash_with_slash(file)
+    end
+    return simplify_path(res.gsub('.gcov', ''))
+  end
+
+  def self.get_other_file(file)
+    res = ''
+    if not file.index('#')
+      # no #
+      return nil
+    elsif file.index('##')
+      # 2 or 3 ###
+      res = simplify_path(replace_hash_with_slash(file[file.index('##')+2..-1]).gsub('.gcov', ''))
+    else
+      return nil
+    end
+  end
+
+  def self.calc_source_and_visited(s)
+    return [get_source_file(s), get_other_file(s)]
+  end
+
+  # gcovs is array of gov-files
+  # gcov-files are arrays of lines
+  # lines are [Hitcount, linenr, content]
+  def self.merge_gcovs(gcovs)
+    gcovs.inject do |one,other|
+      one.zip(other).map do |a,b|
+        OpenStruct.new({:hit_count => a.hit_count.join(b.hit_count), :line_number => a.line_number, :code => a.code})
+      end
+    end
+  end
+
+end

data/lib/cxxproject_gcov/html_export.rb

@@ -0,0 +1,91 @@
+require 'cgi'
+require 'cxxproject_gcov/gcov'
+class HtmlExport
+
+  def initialize(out_dir, gcov_for_files, base_dir)
+    @out_dir = out_dir
+    @gcov_for_files = gcov_for_files
+    @base_dir = base_dir
+    export_css()
+    export_toc()
+    export_sources()
+  end
+  def export_css()
+    open_for_write(File.join(@out_dir, 'gcov.css')) do |out|
+      data = File.read(File.join(File.dirname(__FILE__), 'gcov.css'))
+      out.puts(data)
+    end
+  end
+  def export_toc
+    output_file_name = File.join(@out_dir, 'index.html')
+    open_for_write(output_file_name) do |out|
+      out.puts("<html><head><link rel=\"stylesheet\" type=\"text/css\" href=\"gcov.css\"></head><body>")
+      
+      out.puts("<table><tr><th>Sourcefile</th><th>Loc</th><th>Coverage in %</th></tr>")
+      total_lines = 0
+      total_covered_lines = 0
+      @gcov_for_files.each do |file, coverage|
+        puts "working on #{file}"
+        relative_file = file.gsub(@base_dir, '')
+        stats = Gcov::FileStatistics.new(coverage)
+        total_lines += stats.total_lines_of_code
+        total_covered_lines += stats.covered_lines
+        coverage = stats.coverage
+        covered_style = coverage == 100 ? 'covered' : 'not_covered'
+        out.puts("<tr class=\"#{covered_style}\"><td><a href=\"#{relative_file}.html\">#{relative_file}</a></td><td>#{stats.total_lines_of_code}</td><td>#{coverage}</td></tr>")
+      end
+      covered = (100 * (total_covered_lines.to_f / total_lines)).to_i
+      out.puts("<tr><td>TOTAL</td><td>#{total_lines}</td><td>#{covered}</td></tr>")
+      out.puts("</table>")
+      out.puts("</body></html>")
+    end
+  end
+
+  def export_sources
+    @gcov_for_files.each do |file, coverage|
+      relative_file = file.gsub(@base_dir, '')
+      output_file_name = File.join(@out_dir, relative_file + '.html')
+      path_to_stylesheet = calc_path_to_stylesheet(output_file_name, @out_dir)
+      if path_to_stylesheet.size > 0
+        path_to_stylesheet = File.join(path_to_stylesheet, 'gcov.css')
+      else
+        path_to_stylesheet = 'gcov.css'
+      end
+      open_for_write(output_file_name) do |out|
+        out.puts("<html><head><link rel=\"stylesheet\" type=\"text/css\" href=\"#{path_to_stylesheet}\"></head><body><pre>")
+        coverage.each do |line|
+          line_number = sprintf("%5d:", line.line_number)
+          count_state = count_state_to_css_class(line.hit_count)
+          out.puts("<span class=\"#{count_state} linenumber\">#{line_number}</span><span class=\"#{count_state}\">#{CGI.escape_html(line.code)}</span>")
+        end
+        out.puts("</pre></body></html>")
+      end
+    end
+  end
+
+  def ensure_dir_for_file(output_file_name)
+    FileUtils.mkdir_p(File.dirname(output_file_name))
+  end
+
+  def open_for_write(output_file_name)
+    ensure_dir_for_file(output_file_name)
+    File.open(output_file_name, 'w') do |out|
+      yield out
+    end
+  end
+
+  def count_state_to_css_class(hit_count)
+    mapping = {:DEAD_CODE => 'dead_code', :IGNORED => 'ignored_code'}
+    if mapping.has_key?(hit_count.count)
+      return mapping[hit_count.count]
+    else
+      return 'used_code'
+    end
+  end
+
+  def calc_path_to_stylesheet(output, base)
+    count = output.split('/').size - base.split('/').size - 1
+    return ('../' * count)[0...-1]
+  end
+
+end

data/lib/cxxproject_gcov/plugin.rb

@@ -0,0 +1,93 @@
+require 'cxxproject_gcov/gcov'
+require 'cxxproject_gcov/html_export'
+
+cxx_plugin do |ruby_dsl, building_blocks, log|
+
+  def handle_has_sources(building_block)
+    if building_block.kind_of?(Cxxproject::HasSources)
+      building_block.collect_sources_and_toolchains.each do | source, toolchain |
+        cd(building_block.project_dir, :verbose => false) do
+          sh "gcov -l -p -o \"#{File.join(building_block.project_dir, building_block.get_object_file(source))}\" \"#{source}\""
+        end
+      end
+    end
+  end
+
+  def find_absolute_files(gcov_files)
+    return gcov_files.select{|f|f.index('###')}.map{|f|'/' + f.match(/.*###(.*)/)[1].gsub('#', '/').gsub('.gcov', '')}
+  end
+
+  def is_absolute?(file)
+    return file[0] == '/'
+  end
+
+  def find_building_block_for_source(building_blocks, to_find)
+    building_blocks.each do |building_block|
+      building_block.collect_sources_and_toolchains.each do |source, toolchain|
+        h = File.join(building_block.project_dir, source)
+        if h === to_find
+          return building_block
+        end
+      end
+    end
+    return nil
+  end
+
+  def find_file(file, building_blocks)
+    with_sources = building_blocks.select {|bb|bb.kind_of?(Cxxproject::HasSources)}
+    source, visited = Gcov.calc_source_and_visited(file)
+    if not visited
+      bb = find_building_block_for_source(with_sources, source)
+      return [source, bb]
+    else
+      if is_absolute?(visited)
+        return [visited, nil]
+      else
+        bb = find_building_block_for_source(with_sources, source)
+        if bb
+          return [Gcov.simplify_path(File.join(bb.project_dir, visited)), bb]
+        else
+          raise "could not find building block for #{source}"
+        end
+      end
+    end
+  end
+
+  directory ruby_dsl.build_dir
+
+  desc 'run gcov'
+  task :gcov => ruby_dsl.build_dir do
+    excludes = Gcov.excludes
+    sh 'find . -name "*.gcov" -delete'
+    Cxxproject::sorted_building_blocks.each do |building_block|
+      handle_has_sources(building_block)
+    end
+
+    gcovs_for_files = {}
+    bb_for_files = {}
+    gcov_files = Dir.glob('**/*.gcov')
+    gcov_files.each do |f|
+      f = File.join(Dir.pwd, f)
+      file, bb = find_file(f, Cxxproject::sorted_building_blocks)
+      raise "could not find file for #{f}" unless file
+
+      bb_for_files[file] = bb
+      gcovs_for_files[file] = [] unless gcovs_for_files.has_key?(file)
+      gcovs_for_files[file] << f
+    end
+    
+    gcovs_for_files = gcovs_for_files.delete_if do | key, value |
+      excludes.any? do | i |
+        key.match(i)
+      end
+    end
+
+    gcovs_for_files.each do | file, gcovs |
+      gcovs_for_files[file] = Gcov.merge_gcovs(gcovs.map{|i|Gcov.parse_gcov_string(File.read(i))})
+    end
+
+
+    HtmlExport.new('out/gcov/html', gcovs_for_files, Dir.pwd + '/')
+  end
+
+end

data/lib/cxxproject_gcov/version.rb

@@ -0,0 +1,3 @@
+module CxxprojectGcov
+  VERSION = "0.0.1"
+end

data/lib/cxxproject_gcov.rb

@@ -0,0 +1,5 @@
+require "cxxproject_gcov/version"
+
+module CxxprojectGcov
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: cxxproject_gcov
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Christian Köstlin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cxx
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: create gcvo files after a run
+email:
+- christian.koestlin@esrlabs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/cxxproject_gcov.rb
+- lib/cxxproject_gcov/gcov.css
+- lib/cxxproject_gcov/gcov.rb
+- lib/cxxproject_gcov/plugin.rb
+- lib/cxxproject_gcov/version.rb
+- lib/cxxproject_gcov/html_export.rb
+- LICENSE
+- README.md
+homepage: http://github.com
+licenses:
+- MIT
+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'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: ! '...'
+test_files: []