edgecase-ocov 1.0

data/README.rdoc

@@ -0,0 +1,3 @@
+ocov is a wrapper around gcov for producing rcov-like C0 reports for Objective C projects.
+
+ocov is developed at EdgeCase.

data/Rakefile

@@ -0,0 +1,68 @@
+# Rakefile for ocov -*- ruby -*-
+begin
+  require 'rubygems'
+  require 'rake/gempackagetask'
+  require 'rake/testtask'
+  require 'rake/rdoctask'
+rescue Exception
+  nil
+end
+
+if `ruby -Ilib -rocov -e "print OCov.version"` =~ /([0-9.]+)$/
+  CURRENT_VERSION = $1
+else
+  CURRENT_VERSION = '0.0.0'
+end
+
+PKG_FILES = FileList['[A-Z]*',
+                     'README.rdoc',
+                     'bin/*',
+                     'lib/**/*.rb',
+                     'lib/ocov/templates/*.erb',
+                     'doc/**/*'
+                    ]
+
+desc 'Generate documentation for magic bus'
+rd = Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'html'
+  rdoc.template = 'doc/jamis.rb'
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = 'ocov'
+  rdoc.options << '--line-numbers' << '--inline-source' << '--main' << 'README.rdoc' << '--title' << 'Magic Bus'
+  rdoc.rdoc_files.include('README.rdoc', 'lib/**/*.rb', 'doc/**/*.rdoc')
+end
+
+if !defined?(Gem)
+  puts "Package target requires RubyGEMs"
+else
+  spec = Gem::Specification.new do |s|
+    s.name = 'ocov'
+    s.version = CURRENT_VERSION
+    s.summary = 'C0 coverage report tool for Objective-C'
+    s.executables = ['ocov']
+    s.files = PKG_FILES.to_a
+    s.require_path = 'lib'
+    s.has_rdoc = true
+    s.extra_rdoc_files = rd.rdoc_files.reject {|fn| fn =~ /\.rb$/}.to_a
+    s.rdoc_options = rd.options
+
+    s.author = "EdgeCase, LLC"
+    s.email = "scott@edgecase.com"
+    s.homepage = "http://github.com/edgecase/ocov/tree/master"
+  end
+
+  package_task = Rake::GemPackageTask.new(spec) do |pkg|
+    pkg.need_zip = true
+    pkg.need_tar = true
+  end
+end
+
+desc "Run all tests"
+task :default => [:test]
+
+Rake::TestTask.new(:test) do |t|
+  t.test_files = FileList['test/test*.rb']
+  t.warning = true
+  t.verbose = false
+end
+  

data/bin/ocov

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# -*- ruby -*-
+
+require 'ocov'
+
+project = OCov::Project.new(Dir.pwd)
+project.analyze_and_report

data/lib/ocov.rb

@@ -0,0 +1,12 @@
+require File.join(File.dirname(__FILE__), 'ocov', 'project')
+require File.join(File.dirname(__FILE__), 'ocov', 'gcov')
+require File.join(File.dirname(__FILE__), 'ocov', 'source_line')
+require File.join(File.dirname(__FILE__), 'ocov', 'target')
+
+require 'fileutils'
+
+module OCov
+  def self.version
+    "1.0"
+  end
+end

data/lib/ocov/gcov.rb

@@ -0,0 +1,49 @@
+module OCov
+  class GCov
+    attr_reader :name
+    attr_reader :lines
+    attr_reader :lines_of_code
+    attr_reader :coverage
+    
+    def initialize(build_path, class_file)
+      @class_file = class_file
+      @build_path = build_path
+      @name       = File.basename(class_file)
+      @lines      = []
+      @coverage   = 100.00
+      @lines_of_code = 0
+    end
+
+    def run
+      run_gcov
+      parse_gcov_output
+      cleanup
+    end
+
+    def total_lines
+      lines.size
+    end
+
+    private
+    def run_gcov
+      results = `gcov -o "#{@build_path}" "#{@class_file}"`
+      if results =~ /Lines executed:(\d+\.\d+)% of (\d+)/
+        @lines_of_code = $2.to_i
+        @coverage = $1.to_f
+      end
+    end
+
+    def parse_gcov_output
+      gcov_file = File.open("#{File.basename(@class_file)}.gcov")
+      gcov_file.readlines.each do |line|
+        if OCov::SourceLine.parsable?(line)
+          @lines << OCov::SourceLine.new(line)
+        end
+      end
+    end
+
+    def cleanup
+      FileUtils.rm_f("#{File.basename(@class_file)}.gcov")
+    end
+  end
+end

data/lib/ocov/project.rb

@@ -0,0 +1,95 @@
+require 'erb'
+
+module OCov
+  class Project
+    attr_reader :name
+    attr_reader :files
+    
+    def initialize(project_path)
+      @project_path = project_path
+      @files        = []
+      
+      determine_name_from_xcode_file
+    end
+
+    def analyze_and_report
+      analyze
+      
+      FileUtils.rm_rf('coverage')
+      FileUtils.mkdir('coverage')
+
+      template = ERB.new(open(File.join(File.dirname(__FILE__), 'templates', 'index.html.erb')).read)
+      f = open('coverage/index.html', 'w')
+      f.write(template.result(binding))
+      f.close
+      
+      files.each do |file|
+        template = ERB.new(open(File.join(File.dirname(__FILE__), 'templates', 'file.html.erb')).read)
+        f = open("coverage/#{file.name.gsub('.', '_')}.html", 'w')
+        f.write(template.result(file.send(:binding)))
+        f.close
+      end
+    end
+
+    def analyze
+      class_files.each do |file|
+        gcov = OCov::GCov.new(build_path, file)
+        gcov.run
+        @files << gcov
+      end
+      @files.sort! { |a, b| b.coverage <=> a.coverage }
+    end
+
+    def total_coverage
+      (total_lines_covered.to_f / total_lines_of_code) * 100
+    end
+
+    def total_lines_covered
+      files.inject(0) { |sum, file| sum + ((file.coverage / 100.0) * file.lines_of_code).to_i }
+    end
+
+    def total_lines
+      files.inject(0) { |sum, file| sum + file.total_lines }
+    end
+
+    def total_lines_of_code
+      files.inject(0) { |sum, file| sum + file.lines_of_code }
+    end
+
+    def classes_path
+      File.join(@project_path, 'Classes')
+    end
+
+    def build_path
+      File.join(@project_path, 'build', "#{@name}.build", 'Debug-iphonesimulator', "#{OCov::Target.name}.build", 'Objects-normal', 'i386')
+    end
+    
+    def class_files
+      Dir.glob(File.join(classes_path, '*.m')).inject([]) do |arr, file|
+        arr << file if File.basename(file) !~ /(AppDelegate|ViewController)\.m$/
+        arr
+      end
+    end
+
+    def gcda_files
+      Dir.glob(File.join(build_path, '*.gcda')).inject([]) do |arr, file|
+        arr << file if File.basename(file) !~ /^(GTM|Test)/
+        arr
+      end
+    end
+
+
+
+
+    
+    private
+    def determine_name_from_xcode_file
+      xcode_file = Dir.glob(File.join(@project_path, '*.xcodeproj')).first
+      if xcode_file
+        @name = File.basename(xcode_file, '.xcodeproj')
+      else
+        raise "Unable to determine project name"
+      end
+    end
+  end
+end

data/lib/ocov/source_line.rb

@@ -0,0 +1,23 @@
+module OCov
+  class SourceLine
+    def self.parsable?(line)
+      !(line =~ /        -:    0:/)
+    end
+    
+    def initialize(line)
+      @line = line
+    end
+
+    def covered?
+      !(@line =~ /^    #####:/)
+    end
+
+    def source_line
+      @line.strip.split(':')[2..-1].join(':')
+    end
+
+    def line_number
+      @line.split(':')[1].to_i
+    end
+  end
+end

data/lib/ocov/target.rb

@@ -0,0 +1,7 @@
+module OCov
+  class Target
+    def self.name
+      'Unit Test'
+    end
+  end
+end

data/lib/ocov/templates/file.html.erb

@@ -0,0 +1,24 @@
+<html>
+  <head>
+    <title><%= file.name %> - C0 code coverage</title>
+    <style type="text/css">
+      span { width: 100%; display: block;}
+      
+      span.covered {
+        background-color: rgb(185, 210, 200);
+      }
+      
+      span.uncovered {
+        background-color: rgb(225, 110, 110);
+      }
+    </style>
+  </head>
+  <body>
+    <h1>C0 code coverage information for <%= name %></h1>
+    <p>Generated on <%= Time.now %> with <a href="http://github.com/edgecase/ocov/tree/master">ocov <%= OCov.version %></a></p>
+    <hr />
+    <pre>
+      <% file.lines.each do |line| %><span class="<%= line.covered? ? 'covered' : 'uncovered' %>"><%= '% 3d' % line.line_number %>:    <%= line.source_line %></span><% end %>
+    </pre>
+  </body>
+</html>

data/lib/ocov/templates/index.html.erb

@@ -0,0 +1,72 @@
+<html>
+  <head>
+    <title><%= name %> C0 code coverage</title>
+    <style type="text/css">
+.graph_outer {
+  height: 12px;
+  background: red;
+  width: 100px;
+  border: 1px solid #808080;
+  float:right;
+}
+.graph_inner {
+  height: 12px;
+  background: #00F000;
+}
+      table.report {  border-collapse: collapse; width: 100%; }
+      th {
+        background: #dcecff;
+border: #d0d0d0 1px solid;
+font-weight: bold;
+text-align: center;
+      }
+table.report td {  border: #d0d0d0 1px solid; }
+      td.value { text-align: right; }
+      th.filename { width: 55%; }
+    </style>
+  </head>
+  <body>
+    <h1>C0 code coverage information for <%= name %></h1>
+    <p>Generated on <%= Time.now %> with <a href="http://github.com/edgecase/ocov/tree/master">ocov <%= OCov.version %></a></p>
+    <hr />
+    <table class="report">
+      <thead>
+	<th class="filename">Name</th>
+	<th>Total Lines</th>
+	<th>Lines of Code</th>
+	<th>Coverage</th>
+      </thead>
+      <tbody>
+	<tr>
+	  <td>TOTAL</td>
+	  <td class="value"><%= total_lines %></td>
+	  <td class="value"><%= total_lines_of_code %></td>
+	  <td>
+	    <table>
+	      <tr>
+		<td class="value" style="border: 0px; width: 50px;"><%= '%.1f' % total_coverage %>%</td>
+		<td style="border: 0px;"><div class="graph_outer"><div class="graph_inner" style="width: <%= '%d' % total_coverage %>%;"></div></div></td>
+	      </tr>
+	    </table>
+	  </td>
+	</tr>
+	
+	<% files.each do |file| %>
+	  <tr>
+	    <td><a href="<%= file.name.gsub('.', '_') %>.html"><%= file.name %></a></td>
+	    <td class="value"><%= file.total_lines %></td>
+	    <td class="value"><%= file.lines_of_code %></td>
+	    <td>
+	      <table>
+		<tr>
+		  <td class="value" style="border: 0px; width: 50px;"><%= '%.1f' % file.coverage %>%</td>
+		  <td style="border: 0px;"><div class="graph_outer"><div class="graph_inner" style="width: <%= '%d' % file.coverage %>%;"></div></div></td>
+		</tr>
+	      </table>
+	    </td>
+	  </tr>
+	<% end %>
+      </tbody>
+    </table>
+  </body>
+</html>

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification 
+name: edgecase-ocov
+version: !ruby/object:Gem::Version 
+  version: "1.0"
+platform: ruby
+authors: 
+- EdgeCase, LLC
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-11 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: 
+email: scott@edgecase.com
+executables: 
+- ocov
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- Rakefile
+- README.rdoc
+- bin/ocov
+- lib/ocov/gcov.rb
+- lib/ocov/project.rb
+- lib/ocov/source_line.rb
+- lib/ocov/target.rb
+- lib/ocov.rb
+- lib/ocov/templates/file.html.erb
+- lib/ocov/templates/index.html.erb
+has_rdoc: true
+homepage: http://github.com/edgecase/ocov/tree/master
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --main
+- README.rdoc
+- --title
+- Magic Bus
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: C0 coverage report tool for Objective-C
+test_files: []
+