coco 0.4.1

data/lib/coco/formatter/html_index_formatter.rb

@@ -0,0 +1,37 @@
+# -*- encoding: utf-8 -*-
+
+require 'erb'
+
+module Coco
+  
+  # I format the index.html
+  # @todo document
+  class HtmlIndexFormatter < Formatter
+    
+    def initialize raw_coverages, uncovered
+      super(raw_coverages, uncovered)
+      @context = nil
+      @template = Template.open File.join($COCO_PATH,'template/index.erb')
+      @lines = []
+      build_lines_for_context
+    end
+    
+    def format
+      @context = IndexContext.new Helpers.index_title, @lines, @uncovered
+      @template.result(@context.get_binding)
+    end
+    
+    private
+    
+    def build_lines_for_context
+      @raw_coverages.each do |filename, coverage| 
+        filename = File.expand_path(filename)
+        percentage = CoverageStat.coverage_percent(coverage)
+        @lines << [percentage, filename, Helpers.rb2html(filename)]
+      end
+      @lines.sort!
+    end
+    
+  end
+
+end

data/lib/coco/formatter/template.rb

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+
+require 'erb'
+
+module Coco
+  
+  # From me, you can obtain ERB templates.
+  class Template
+    # @param [String] filename An ERB template
+    # @return [ERB]
+    def self.open filename
+      io = IO.readlines(filename, nil)
+			ERB.new(io[0], nil, '><')
+    end
+  end
+
+end

data/lib/coco/helpers.rb

@@ -0,0 +1,36 @@
+# -*- encoding: utf-8 -*-
+
+module Coco
+
+  # @todo The app is full of <tt>Dir.pwd</tt>. This is the root project directory
+  #   and must be in Configuration class (or Coco module ?).
+  module Helpers
+  
+    # Get html filename (from a ruby filename) suitable for the coverage
+    # directory.
+    #
+    # @example
+    #   ruby = '/home/user/my_project/lib/source.rb'
+    #   html = Helpers.rb2html(ruby)
+    #   => '_lib_source.rb.html'
+    #
+    # @param [String] name Ruby filename
+    # @return [String] Html filename
+    def Helpers.rb2html name
+      name.sub(Dir.pwd, '').tr('/\\', '_') + '.html'
+    end
+    
+    # @return [String] The title of the index.html file
+    def Helpers.index_title
+      "Coco #{File.read(File.join($COCO_PATH, 'VERSION')).strip}, code coverage for #{File.basename(Dir.pwd)}"
+    end
+    
+    # @param [Array<String>] files List of filenames
+    # @return [Array<String>]
+    def Helpers.expand files
+      files.map {|file| File.expand_path file}
+    end
+    
+  end
+  
+end

data/lib/coco/lister.rb

@@ -0,0 +1,4 @@
+# -*- encoding: utf-8 -*-
+
+require 'coco/lister/source_lister'
+require 'coco/lister/uncovered_lister'

data/lib/coco/lister/source_lister.rb

@@ -0,0 +1,47 @@
+# -*- encoding: utf-8 -*-
+
+module Coco
+
+  # I retrieve the .rb files from a list of directories.
+  class SourceLister
+  
+    # @param [Hash] config
+    def initialize config
+      @exclude_files = config[:excludes]
+      dirs = config[:directories]
+      unless dirs.is_a? Array
+        @folders = [dirs]
+      else
+        @folders = dirs
+      end
+      @folders.each {|folder| raise ArgumentError unless File.directory?(folder)}
+      @list = []
+    end
+    
+    # @return [Array<String>] A list of all .rb files from the directories found in configuration
+    def list
+      look_for_sources
+      @list.map! {|file| File.expand_path(file)}
+      exclude_files_user_dont_want
+      @list
+    end
+    
+    private
+    
+    def look_for_sources
+      @folders.each do |folder|
+        rb_files = File.join(folder, "**", "*.rb")
+        @list += Dir.glob(rb_files)
+      end
+    end
+    
+    def exclude_files_user_dont_want
+      return if  @exclude_files.nil?
+      @exclude_files.each do |filename|
+        @list.delete File.expand_path(filename)
+      end
+    end
+    
+  end
+
+end

data/lib/coco/lister/uncovered_lister.rb

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+
+module Coco
+
+  # I retrieve the list of uncovered (0%) .rb files.
+  class UncoveredLister
+    
+    # @param [Array<String>] sources List of filenames
+    # @param [Hash] covered Raw coverage from the domain
+    def initialize sources, covered
+      @source_files = Helpers.expand(sources)
+      @covered_files = Helpers.expand(covered.keys)
+    end
+    
+    # @return [Array<String>] List of uncovered filenames
+    def list
+      list = []
+      @source_files.each do |elem|
+        list << elem unless @covered_files.include?(elem)
+      end
+      list
+    end
+    
+  end
+  
+end

data/lib/coco/writer.rb

@@ -0,0 +1,6 @@
+# -*- encoding: utf-8 -*-
+
+require 'coco/writer/file_writer'
+require 'coco/writer/html_directory'
+require 'coco/writer/html_files_writer'
+require 'coco/writer/html_index_writer'

data/lib/coco/writer/file_writer.rb

@@ -0,0 +1,14 @@
+# -*- encoding: utf-8 -*-
+
+module Coco
+  
+  # I write one file.
+  class FileWriter
+    def FileWriter.write filename, content
+      file = File.new(filename, "w")
+      file.write content
+      file.close
+    end
+  end
+
+end

data/lib/coco/writer/html_directory.rb

@@ -0,0 +1,39 @@
+# -*- encoding: utf-8 -*-
+
+module Coco
+
+  # I prepare the coverage/ directory for html files.
+  class HtmlDirectory
+    attr_reader :coverage_dir
+    
+    def initialize
+      @coverage_dir = 'coverage'
+      @css_dir = 'coverage/css'
+      @img_dir = 'coverage/img'
+      css = File.join($COCO_PATH, 'template/css')
+      @css_files = Dir.glob(css + '/*')
+      img = File.join($COCO_PATH, 'template/img')
+      @img_files = Dir.glob(img + '/*')
+    end
+    
+    # Delete the coverage/ directory
+    def clean
+      FileUtils.remove_dir @coverage_dir if File.exist? @coverage_dir
+    end
+    
+    def setup
+      FileUtils.makedirs @css_dir
+      FileUtils.makedirs @img_dir
+      FileUtils.cp @css_files, @css_dir
+      FileUtils.cp @img_files, @img_dir
+    end
+    
+    # I list the html files from the coverage directory
+    def list
+      files = Dir.glob("#{@coverage_dir}/*.html")
+      files.map {|file| File.basename(file)}
+    end
+    
+  end
+
+end

data/lib/coco/writer/html_files_writer.rb

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+
+module Coco
+  
+  # I populate the coverage/ directory with files, if any.
+  class HtmlFilesWriter
+  
+    # @param [Hash] html_files Key is filename, value is html content
+    def initialize html_files
+      @html_files = html_files
+      @html_dir = HtmlDirectory.new
+    end
+    
+    def write
+      @html_dir.clean
+      if @html_files.size > 0
+        @html_dir.setup
+        write_each_file
+      end
+    end
+    
+    private
+    
+    def write_each_file
+      @html_files.each do |filename, html|
+        FileWriter.write File.join('coverage', Helpers.rb2html(filename)), html
+      end
+    end
+    
+  end
+
+end

data/lib/coco/writer/html_index_writer.rb

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+
+module Coco
+  
+  # I write the index.html
+  class HtmlIndexWriter
+  
+    def initialize index
+      @index = index
+      @dir = HtmlDirectory.new.coverage_dir
+    end
+    
+    def write
+      if File.exist?(@dir)
+        FileWriter.write File.join(@dir, 'index.html'), @index
+      end
+    end
+    
+  end
+  
+end

data/template/css/LICENCE

@@ -0,0 +1,5 @@
+base-min.css, fonts-min.css and reset-min.css: BSD licence.
+Copyright (c) 2010, Yahoo! Inc. All rights reserved.
+Code licensed under the BSD License:
+http://developer.yahoo.com/yui/license.html
+version: 2.8.2r1

data/template/css/base-min.css

@@ -0,0 +1 @@
+body{margin:10px;}h1{font-size:138.5%;}h2{font-size:123.1%;}h3{font-size:108%;}h1,h2,h3{margin:1em 0;}h1,h2,h3,h4,h5,h6,strong,dt{font-weight:bold;}optgroup{font-weight:normal;}abbr,acronym{border-bottom:1px dotted #000;cursor:help;}em{font-style:italic;}del{text-decoration:line-through;}blockquote,ul,ol,dl{margin:1em;}ol,ul,dl{margin-left:2em;}ol li{list-style:decimal outside;}ul li{list-style:disc outside;}dl dd{margin-left:1em;}th,td{border:1px solid #000;padding:.5em;}th{font-weight:bold;text-align:center;}caption{margin-bottom:.5em;text-align:center;}sup{vertical-align:super;}sub{vertical-align:sub;}p,fieldset,table,pre{margin-bottom:1em;}button,input[type="checkbox"],input[type="radio"],input[type="reset"],input[type="submit"]{padding:1px;}

data/template/css/coco.css

@@ -0,0 +1,96 @@
+@charset "UTF-8";
+@import url("reset-min.css");
+@import url("base-min.css");
+@import url("font-min.css");
+@import url("ext.css");
+
+html
+{
+  background-color: #fcfcff;
+}
+
+h2
+{
+  padding: 10px;
+  background-color: #668;
+  color: #fcfcff;
+}
+
+a
+{ 
+	color:#446;
+  text-decoration: none;
+}
+
+p.menu a
+{
+  font-weight: bold;
+}
+
+p.license
+{
+  color: #888;
+  margin-top: 20px;
+  padding-top: 5px;
+  border-top: 1px solid #888;
+  font-size: 80%;
+}
+
+p.date
+{
+  font-size: 80%;
+}
+
+table td
+{
+  border-width: 0;
+}
+
+table.source td
+{
+  padding: 0;
+}
+
+tr.never
+{
+  background-color: #eee;
+}
+
+tr.hit
+{
+  background-color: #efe;
+}
+
+tr.miss
+{
+   background-color: #fbb;
+}
+
+td.yellow
+{
+  background-color: #fffead;
+}
+
+td.orange
+{
+  background-color: #ffcd84;
+}
+
+td.pink
+{
+  background-color: #ffcd84;
+}
+
+td.red
+{
+  background-color: #ff4747;
+  color: #fff;
+  font-weight: bold;
+}
+
+td.black
+{
+  background-color: #002;
+  color: #fff;
+  font-weight: bold;
+}

data/template/css/ext.css

@@ -0,0 +1,5 @@
+td, h2
+{
+	-moz-border-radius: 10px 0;
+	border-radius: 10px 0;
+}

data/template/css/fonts-min.css

@@ -0,0 +1 @@
+body{font:13px/1.231 arial,helvetica,clean,sans-serif;*font-size:small;*font:x-small;}select,input,button,textarea,button{font:99% arial,helvetica,clean,sans-serif;}table{font-size:inherit;font:100%;}pre,code,kbd,samp,tt{font-family:monospace;*font-size:108%;line-height:100%;}

data/template/css/reset-min.css

@@ -0,0 +1 @@
+html{color:#000;background:#FFF;}body,div,dl,dt,dd,ul,ol,li,h1,h2,h3,h4,h5,h6,pre,code,form,fieldset,legend,input,button,textarea,p,blockquote,th,td{margin:0;padding:0;}table{border-collapse:collapse;border-spacing:0;}fieldset,img{border:0;}address,caption,cite,code,dfn,em,strong,th,var,optgroup{font-style:inherit;font-weight:inherit;}del,ins{text-decoration:none;}li{list-style:none;}caption,th{text-align:left;}h1,h2,h3,h4,h5,h6{font-size:100%;font-weight:normal;}q:before,q:after{content:'';}abbr,acronym{border:0;font-variant:normal;}sup{vertical-align:baseline;}sub{vertical-align:baseline;}legend{color:#000;}input,button,textarea,select,optgroup,option{font-family:inherit;font-size:inherit;font-style:inherit;font-weight:inherit;}input,button,textarea,select{*font-size:100%;}

data/template/file.erb

@@ -0,0 +1,35 @@
+<html>
+  <head>
+    <meta charset='utf-8'>
+    <title><%= @filename %></title>
+    <link rel="stylesheet" href="css/coco.css" type="text/css" />
+  </head>
+  <body>
+    <p class="menu">
+      <a href="index.html">Index</a> <img src="img/coconut16.png" width="16" height="16" />
+      <a href="https://github.com/lkdjiin/coco/wiki">Wiki</a> <img src="img/coconut16.png" width="16" height="16" />
+      <a href="https://github.com/lkdjiin/coco">Source</a> <img src="img/coconut16.png" width="16" height="16" />
+      <a href="#">Web site</a>
+    </p>
+    <h2><%= @filename %></h2>
+    <p class="date"><%= "#{Time.now}" %></p>
+    
+    <table class="source">
+      
+      <% @lines.each do |num, text, hit|%>
+      <%   if hit.nil? %>
+        <tr class="never">
+      <%   elsif hit.zero? %>
+        <tr class="miss">
+      <%   elsif hit > 0 %>
+        <tr class="hit" %>
+      <%   end %>
+
+      <%= "<td><pre>#{num} </pre></td><td><pre>#{text}</pre></td>" %>
+
+        </tr>
+      <% end%>
+      
+    </table>
+  </body>
+</html>