coco 0.4.1

data/NEWS

@@ -0,0 +1,34 @@
+v0.4.1  (2011-02-27)
+
+  * Quick fix, add forgotten images for html menu
+
+
+v0.4  (2011-02-26)
+
+  * add colors to console output (*nix only)
+  
+  * it can exclude unwanted files from the report
+
+
+v0.3  (2011-02-25)
+
+  * Report sources not covered at all
+  
+  * Configurable via a simple yaml file
+    + threeshold
+    + source directories
+  
+  * UTF-8 compliant
+  
+  * Misc
+    + sort index.html and console output by percentage
+    + display coco's version in index.html
+
+
+v0.2  (2011-02-24)
+
+  * Use coco from rspec with a simple require 'coco'
+  
+  * Display filenames covered < 90% on console
+  
+  * Build simple html report only for files covered < 90%

data/README.rdoc

@@ -0,0 +1,48 @@
+= coco
+
+Another COde COverage for ruby 1.9 (from the famous post of Aaron Patterson).
+This one suits my needs.
+
+== Features
+* Use it from rspec with a simple <code>require 'coco'</code>
+* Display filenames covered < 90% on console
+* Build <em>simple</em> html report <em>only</em> for files covered < 90%
+* Report sources that have no tests
+* UTF-8 compliant
+* Configuration could be done via a simple yaml file
+* Colorized console output (*nix only)
+
+<em>Note: I have tested coco only on debian linux. I have not tested it with the test/unit
+framework.</em>
+
+== Documentation
+
+ require 'coco'
+ 
+at the beginning of your tests, usually in a \*helper\*.rb file.
+
+See {the wiki}[https://github.com/lkdjiin/coco/wiki] for more information on using coco.
+
+To generate the developper's documentation in YARD format:
+ rake doc
+
+== Dependencies
+
+ruby >= 1.9.2
+
+To contribute:
+
+* reek
+* rspec
+
+== Installing coco
+Download and
+ rake install
+
+== License
+GPLv3, see COPYING.
+
+== Questions and/or Comments
+
+Feel free to email {Xavier Nayrac}[mailto:xavier.nayrac@gmail.com]
+with any questions.

data/Rakefile

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+
+require 'rake'
+require 'rspec/core/rake_task'
+
+desc 'Test coco'
+task :default => :spec
+
+desc 'Test coco'
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = ['--color']
+end
+
+desc 'Check for code smells'
+task :reek do
+  puts 'Checking for code smells...'
+  files = Dir.glob 'lib/**/*.rb'
+  args = files.join(' ')
+  sh "reek --quiet #{args} | ./reek.sed"
+end
+
+desc 'Build the gem & install it'
+task :install do
+  sh "gem build coco.gemspec"
+	f = FileList['coco*gem'].to_a
+	sh "gem install #{f.first} --no-rdoc --no-ri"
+end
+
+desc 'Generate yard documentation for developpers'
+task :doc do 
+	exec 'yardoc --title "Coco Documentation" - NEWS COPYING VERSION'
+end

data/TODO

@@ -0,0 +1,3 @@
+
+* rubygem
+* quick web site (on GitHub ?)

data/VERSION

@@ -0,0 +1 @@
+0.4.1

data/lib/coco.rb

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+
+$LOAD_PATH.unshift File.dirname(__FILE__)
+$COCO_PATH = File.expand_path(File.expand_path(File.dirname(__FILE__)) + '/..')
+require 'coco/formatter'
+require 'coco/cover'
+require 'coco/writer'
+require 'coco/helpers'
+require 'coco/configuration'
+require 'coco/lister'
+require 'coverage'
+
+module Coco
+end
+
+Coverage.start
+
+at_exit do
+  config = Coco::Configuration.new
+  result = Coco::CoverageResult.new(config, Coverage.result)
+  covered = result.covered_from_domain
+  
+  sources = Coco::SourceLister.new(config).list
+  uncovered = Coco::UncoveredLister.new(sources, result.all_from_domain).list
+  
+  puts Coco::ConsoleFormatter.new(covered, uncovered).format
+  
+  html_files = Coco::HtmlFormatter.new(covered).format
+  Coco::HtmlFilesWriter.new(html_files).write
+  
+  index = Coco::HtmlIndexFormatter.new(covered, uncovered).format
+  Coco::HtmlIndexWriter.new(index).write
+end

data/lib/coco/configuration.rb

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+
+require 'yaml'
+
+module Coco
+
+  # I know the configuration of coco.
+  #
+  # @example read the threeshold value
+  #   config = Configuration.new
+  #   config[:threeshold]
+  #   => 90
+  #
+  # You can override the default configuration by putting a '.coco' file 
+  # in YAML format in the project root directory.
+  # @example to override the threeshold put this line in a '.coco' file:
+  #   :threeshold: 70
+  #
+  # @note You can set the threeshold above 100% (to be sure to see all files) but you
+  #   cannot set it under 0.
+  class Configuration < Hash
+  
+    def initialize
+      self[:threeshold] = 90
+      self[:directories] = ['lib']
+      self[:excludes] = []
+      if File.exist?('.coco')
+        conf = YAML.load_file '.coco'
+        self.merge!(conf)
+      end
+    end
+    
+  end
+  
+end

data/lib/coco/cover.rb

@@ -0,0 +1,4 @@
+# -*- encoding: utf-8 -*-
+
+require 'coco/cover/coverage_stat'
+require 'coco/cover/coverage_result'

data/lib/coco/cover/coverage_result.rb

@@ -0,0 +1,48 @@
+# -*- encoding: utf-8 -*-
+
+module Coco
+
+  # Compute results of interest from the big results information (from Coverage.result)
+  class CoverageResult
+    # @return [Hash] Coverage for all the sources that live in the root project folder.
+    attr_reader :all_from_domain
+    # @return [Hash] Coverage for sources that are not sufficiently covered.
+    #   More technically, the sources that live in the root project folder and for
+    #   which the coverage percentage is under the threeshold. 
+    attr_reader :covered_from_domain
+  
+    # @param [Hash] config
+    # @param [Hash] raw_results Results obtained from Coverage.result
+    def initialize config, raw_results
+      @exclude_files = config[:excludes]
+      @threeshold = config[:threeshold]
+      raise ArgumentError if @threeshold < 0
+      @result = raw_results
+      exclude_external_sources
+      exclude_files_user_dont_want
+      exclude_sources_above_threeshold
+    end
+    
+    private
+    
+    def exclude_external_sources
+      here = Dir.pwd
+      @all_from_domain = @result.select {|key, value| key.start_with? here}
+    end
+    
+    def exclude_files_user_dont_want
+      return if @exclude_files.nil?
+      @exclude_files.each do |filename|
+        @all_from_domain.delete(File.expand_path(filename))
+      end
+    end
+    
+    def exclude_sources_above_threeshold 
+      @covered_from_domain = @all_from_domain.select {|key, value| 
+        CoverageStat.coverage_percent(value) < @threeshold
+      }
+    end
+    
+  end
+  
+end

data/lib/coco/cover/coverage_stat.rb

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+
+module Coco
+
+  # Give statistics about an array of lines hit.
+  #
+  # An "array of lines hit" is an array of integers, possibly nil.
+  # Such array is obtain from Coverage.result.
+  #
+  # Each integer represent the state of a source line:
+  # * nil: source line will never be reached (like comments)
+  # * 0: source line could be reached, but was not
+  # * 1 and above: number of time the source line has been reached
+  class CoverageStat
+    
+    def CoverageStat.remove_nil_from hits
+      hits.select {|elem| not elem.nil?}
+    end
+    
+    def CoverageStat.number_of_covered_lines hits
+      hits.select {|elem| elem > 0}.size
+    end
+    
+    def CoverageStat.coverage_percent hits
+      hits = CoverageStat.remove_nil_from hits
+      return 0 if hits.empty?
+      one_percent = 100.0 / hits.size
+      (CoverageStat.number_of_covered_lines(hits) * one_percent).to_i
+    end
+    
+  end
+  
+end

data/lib/coco/formatter.rb

@@ -0,0 +1,9 @@
+require 'coco/formatter/formatter'
+
+require 'coco/formatter/console_formatter'
+require 'coco/formatter/context'
+
+require 'coco/formatter/html_formatter'
+require 'coco/formatter/html_index_formatter'
+require 'coco/formatter/template'
+require 'coco/formatter/colored_string'

data/lib/coco/formatter/colored_string.rb

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+
+module Coco
+
+  # Extend String with ANSI colorization.
+  # Do nothing on Windows.
+  class ColoredString < String
+    
+    def initialize(str="")
+      super(str)
+    end
+    
+    def red
+      colorize "\033[31m"
+    end
+    
+    def yellow
+      colorize "\033[33m"
+    end
+    
+    private
+    
+    def colorize color_code
+      if RUBY_PLATFORM =~ /win32/
+        self
+      else
+        "#{color_code}#{self}\033[0m"
+      end
+    end
+    
+  end
+  
+end

data/lib/coco/formatter/console_formatter.rb

@@ -0,0 +1,46 @@
+# -*- encoding: utf-8 -*-
+
+module Coco
+
+  # I format coverages information for console output
+  class ConsoleFormatter < Formatter
+    
+    # return [string] percent covered and associated filenames 
+    def format 
+      @formatted_output.join("\n")
+    end
+    
+    # @param [Hash] covered
+    # @param [Array] uncovered
+    def initialize covered, uncovered
+      super(covered, uncovered)
+      @formatted_output = []
+      compute_percentage
+      add_percentage_to_uncovered
+      @formatted_output.sort!
+      @formatted_output.map! do |percentage, filename| 
+        text = ColoredString.new "#{percentage}% #{filename}"
+        if percentage <= 50
+          text.red
+        else
+          text.yellow
+        end
+      end
+    end
+  
+    private
+    
+    def compute_percentage
+      @raw_coverages.each do |filename, coverage| 
+        percentage = CoverageStat.coverage_percent(coverage)
+        @formatted_output << [percentage, filename]
+      end
+    end
+    
+    def add_percentage_to_uncovered
+      @uncovered.each do |filename| @formatted_output << [0, filename] end
+    end
+    
+  end
+
+end

data/lib/coco/formatter/context.rb

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+
+module Coco
+  
+  # Contextual information for ERB template, representing each covered files.
+  class Context
+  
+    # @param [String] filename Name of the source file
+    # @param [Array] lines 
+		def initialize filename, lines
+			@filename = filename
+      @lines = lines
+		end
+		
+		def get_binding
+			binding
+		end
+	end
+  
+  # Contextual information for ERB template, representing index.html.
+  class IndexContext
+  
+    # @todo doc, inheritance (with Context)
+		def initialize title, covered, uncovered
+			@title = title
+      @covered = covered
+      @uncovered = uncovered
+		end
+		
+		def get_binding
+			binding
+		end
+	end
+
+end

data/lib/coco/formatter/formatter.rb

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+
+module Coco
+  
+  # My childs will format coverages information.
+  # @abstract
+  class Formatter
+  
+    # @param [Hash] raw_coverages The hash from Coverage.result
+    # @param [Array] uncovered List on uncovered files
+    # @todo I think covered is a better name than raw_coverages
+    def initialize raw_coverages, uncovered
+      @raw_coverages = raw_coverages
+      @uncovered = uncovered
+    end
+    
+    def format
+      "Implement me in child"
+    end
+  end
+
+end

data/lib/coco/formatter/html_formatter.rb

@@ -0,0 +1,39 @@
+# -*- encoding: utf-8 -*-
+
+require 'erb'
+
+module Coco
+  
+  # I format coverages information into html files.
+  # @todo document and change name to HtmlFilesFormatter
+  class HtmlFormatter < Formatter
+    
+    def initialize raw_coverages
+      super(raw_coverages, [])
+      @formatted_output_files = {}
+      @context = nil
+      @template = Template.open File.join($COCO_PATH,'template/file.erb')
+    end
+    
+    def format
+      @raw_coverages.each do |filename, coverage|
+        build_html filename, coverage
+      end
+      @formatted_output_files
+    end
+    
+    private
+    
+    def build_html filename, coverage
+      source = File.readlines filename
+      lines = []
+      source.each_with_index do |line, index|
+        lines << [index+1, line.chomp, coverage[index]]
+      end
+      @context = Context.new filename, lines
+      @formatted_output_files[filename] = @template.result(@context.get_binding)
+    end
+    
+  end
+
+end