coco 0.13.0 → 0.14.0

data/lib/coco/lister/source_lister.rb

@@ -2,16 +2,12 @@ module Coco
 
   # I retrieve the .rb files from a list of directories.
   class SourceLister
-  
+
     # config - Hash.
     def initialize(config)
-      @exclude_files = config[:excludes]
-      dirs = config[:directories]
-      unless dirs.is_a? Array
-        @folders = [dirs]
-      else
-        @folders = dirs
-      end
+      @exclude_files = config[:exclude]
+      dirs = config[:include]
+      @folders = [*dirs]
       @folders.each do |folder|
         unless File.directory?(folder)
           raise ArgumentError, "Not a folder: #{folder}"
@@ -19,41 +15,42 @@ module Coco
       end
       @list = []
     end
-    
+
     # Returns Array of String, that is 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.map! { |file| File.expand_path(file) }
+      exclude_files_user_dont_want if @exclude_files
       @list
     end
-    
+
     private
-    
+
     def look_for_sources
-      @folders.each {|folder| @list += Helpers.rb_files_from folder }
+      @folders.each do |folder|
+        @list += Helpers.rb_files_from folder
+      end
     end
-    
+
     def exclude_files_user_dont_want
-      return if @exclude_files.nil?
-      
       @exclude_files.each do |filename|
-        full_path = File.expand_path(filename)
-        if File.file?(full_path)
-          @list.delete full_path 
-        elsif File.directory?(full_path)
-          exclude_all_from_dir full_path
-        end
+        exclude_path(File.expand_path(filename))
       end
     end
-    
+
+    def exclude_path(full_path)
+      if File.file?(full_path)
+        @list.delete full_path
+      elsif File.directory?(full_path)
+        exclude_all_from_dir full_path
+      end
+    end
+
     def exclude_all_from_dir(full_path)
       Helpers.rb_files_from(full_path).each do |file|
         @list.delete File.expand_path(file)
       end
     end
-    
   end
-
 end

data/lib/coco/lister/uncovered_lister.rb

@@ -1,24 +1,21 @@
 module Coco
 
   # I retrieve the list of uncovered (0%) .rb files.
+  #
   class UncoveredLister
-    
+
     # sources - Array of String list of filenames.
     # covered - Hash raw coverage from the domain.
+    #
     def initialize(sources, covered)
       @source_files = Helpers.expand(sources)
       @covered_files = Helpers.expand(covered.keys)
     end
-    
+
     # Returns Array of String list of uncovered filenames.
+    #
     def list
-      list = []
-      @source_files.each do |elem|
-        list << elem unless @covered_files.include?(elem)
-      end
-      list
+      @source_files.select { |elem| !@covered_files.include?(elem) }
     end
-    
   end
-  
 end

data/lib/coco/project.rb

@@ -0,0 +1,65 @@
+module Coco
+
+  # A project reports statistics about the code coverage.
+  #
+  class Project
+
+    # raw_result - The hash obtain by the call to `Coverage.result`.
+    # out        - The output where results will be displayed, by
+    #              default this is stdout.
+    #
+    def self.run(raw_result, out = STDOUT)
+      new(raw_result, out).run
+    end
+
+    def initialize(raw_result, out)
+      @raw_result = raw_result
+      @out = out
+      @config = Configuration.new
+    end
+
+    def run
+      return unless @config.run_this_time?
+
+      report_on_console
+      report_in_html
+    end
+
+    private
+
+    def report_on_console
+      formatter = ConsoleFormatter.new(uncovered, @config[:threshold],
+                                       result, @config)
+      @out.puts formatter.format
+      @out.puts formatter.link if @config[:show_link_in_terminal]
+    end
+
+    def report_in_html
+      report_code_files
+      report_index
+    end
+
+    def report_code_files
+      files = HtmlFormatter.new(result.coverable_files).format
+      HtmlFilesWriter.new(files, @config[:theme]).write
+    end
+
+    def report_index
+      index = HtmlIndexFormatter.new(uncovered, result,
+                                     @config[:threshold]).format
+      HtmlIndexWriter.new(index).write
+    end
+
+    def result
+      @result ||= CoverageResult.new(@config, @raw_result)
+    end
+
+    def uncovered
+      @uncovered ||= UncoveredLister.new(sources, result.coverable_files).list
+    end
+
+    def sources
+      SourceLister.new(@config).list
+    end
+  end
+end

data/lib/coco/theme.rb

@@ -0,0 +1,15 @@
+module Coco
+
+  # A CSS theme for the report.
+  #
+  class Theme
+
+    def initialize(name)
+      @name = "#{name}.css"
+    end
+
+    def filename
+      File.join(Coco::ROOT, 'template/css', @name)
+    end
+  end
+end

data/lib/coco/writer/file_writer.rb

@@ -1,8 +1,8 @@
 module Coco
-  
+
   # Public: I write a single file.
+  #
   module FileWriter
-    extend self
 
     # Public: Write a file.
     #
@@ -10,9 +10,9 @@ module Coco
     # content  - String content to put in the file.
     #
     # Returns nothing.
-    def write(filename, content)
-      File.open(filename, 'w') {|file| file.write(content) }
+    #
+    def self.write(filename, content)
+      File.open(filename, 'w') { |file| file.write(content) }
     end
   end
-
 end

data/lib/coco/writer/html_directory.rb

@@ -1,13 +1,17 @@
 module Coco
 
   # Public: I prepare the coverage/ directory for html files.
+  #
   class HtmlDirectory
-    COVERAGE_DIR = 'coverage'
+    COVERAGE_DIR = 'coverage'.freeze
 
     # Public: Initialize a new HtmlDirectory object.
-    def initialize
-      css = File.join(Coco::ROOT, 'template/css')
-      @css_files = Dir.glob(css + '/*')
+    #
+    # theme - The String name of the theme. There is 2 builtin themes :
+    #         light & dark. The default one is light.
+    #
+    def initialize(theme = 'light')
+      @theme = Theme.new(theme)
       img = File.join(Coco::ROOT, 'template/img')
       @img_files = Dir.glob(img + '/*')
     end
@@ -32,10 +36,10 @@ module Coco
     #
     # Returns nothing.
     def setup
-      FileUtils.makedirs(css_dir)
-      FileUtils.makedirs(image_dir)
-      FileUtils.cp(@css_files, css_dir)
+      FileUtils.makedirs([css_dir, image_dir, js_dir])
+      FileUtils.cp(@theme.filename, File.join(css_dir, 'coco.css'))
       FileUtils.cp(@img_files, image_dir)
+      FileUtils.cp(File.join(Coco::ROOT, 'template/js/coco.js'), js_dir)
     end
 
     # Public: I list the html files from the directory where the HTML
@@ -44,7 +48,7 @@ module Coco
     # Returns nothing.
     def list
       files = Dir.glob("#{coverage_dir}/*.html")
-      files.map {|file| File.basename(file) }
+      files.map { |file| File.basename(file) }
     end
 
     private
@@ -56,5 +60,9 @@ module Coco
     def image_dir
       "#{COVERAGE_DIR}/img"
     end
+
+    def js_dir
+      "#{COVERAGE_DIR}/js"
+    end
   end
 end

data/lib/coco/writer/html_files_writer.rb

@@ -6,20 +6,23 @@ module Coco
     # Public: Initialize a new HtmlFilesWriter.
     #
     # html_files - Hash, key is filename, value is html content.
-    def initialize(html_files)
+    # theme      - The String name of the theme. Default is light.
+    #
+    def initialize(html_files, theme = 'light')
       @html_files = html_files
-      @html_dir = HtmlDirectory.new
+      @html_dir = HtmlDirectory.new(theme)
     end
 
     # Public: Write HTML files in the right place.
     #
     # Returns nothing.
+    #
     def write
       @html_dir.clean
-      if @html_files.size > 0
-        @html_dir.setup
-        write_each_file
-      end
+      return if @html_files.empty?
+
+      @html_dir.setup
+      write_each_file
     end
 
     private

data/lib/coco/writer/html_index_writer.rb

@@ -1,19 +1,22 @@
 module Coco
-  
+
   # Public: I write the index.html
+  #
   class HtmlIndexWriter
-  
+
     # Public: Initialize a new HtmlIndexWriter object.
     #
     # index - A String HTML document.
+    #
     def initialize(index)
       @index = index
       @dir = HtmlDirectory.new.coverage_dir
     end
-    
+
     # Public: Write the index file in the right place.
     #
     # Returns nothing.
+    #
     def write
       if File.exist?(@dir)
         FileWriter.write File.join(@dir, 'index.html'), @index

data/template/css/dark.css

@@ -0,0 +1,178 @@
+@charset "UTF-8";
+
+/*
+ * Dark theme for Coco.
+ */
+
+table.source {
+  border-collapse:collapse;
+  border-spacing: 0;
+}
+
+table.index tr {
+  height: 1.8em;
+}
+
+table.index td {
+  padding-left: 0.5em;
+}
+
+html {
+  background-color: #505050;
+  color: #F5F5F5;
+}
+
+body {
+  margin: 0;
+}
+
+h2 {
+  padding: 10px;
+  background-color: #6A9FB5;
+  color: #F5F5F5;
+  font-size: 1.1em;
+}
+
+a {
+  color: #F5F5F5;
+  text-decoration: none;
+}
+
+p {
+  margin: 1em;
+}
+
+p.menu a {
+  font-weight: bold;
+}
+
+p.date {
+  font-size: 80%;
+}
+
+table {
+  width: 100%;
+}
+
+table td {
+  border-width: 0;
+}
+
+table.source td {
+  padding-top: 0;
+  padding-bottom: 0;
+  padding-left: 0;
+}
+
+thead {
+  font-weight: bold;
+  background-color: #404040;
+  text-align: center;
+}
+
+td,
+td a {
+  color: #B0B0B0;
+}
+
+td b,
+td a b {
+  color: #F5F5F5;
+}
+
+tr.never {
+  background-color: #505050;
+}
+
+tr.hit {
+  background-color: #506939;
+}
+
+tr.hit:hover {
+  background-color: #90A959;
+}
+
+tr.miss {
+   background-color: #AC4142;
+}
+
+tr.miss:hover {
+  background-color: #E65758;
+}
+
+td.yellow, td.red, td.black, td.green {
+  width: 45px;
+}
+
+td.yellow {
+  background-color: #F4BF75;
+  color: #202020;
+}
+
+td.red {
+  background-color: #AC4142;
+  color: #F5F5F5;
+}
+
+td.black {
+  background-color: #404040;
+  color: #F5F5F5;
+}
+
+td.green {
+  background-color: #90A959;
+  color: #F5F5F5;
+}
+
+td.percentage {
+  text-align: right;
+  padding-right: 20px;
+}
+
+td.line-num,
+td.line-hits,
+td.line-source {
+  color: #F5F5F5;
+}
+
+td.line-num,
+td.line-hits {
+  width: 10%;
+  text-align: right;
+}
+
+td.line-source {
+  padding-right: 0;
+}
+
+td.line-num {
+  padding-right: 5px;
+}
+
+td.line-hits {
+  padding-right: 20px;
+}
+
+th {
+  padding-bottom: 5px;
+  padding-top: 5px;
+}
+
+pre {
+  margin: 6px 0;
+}
+
+.summary {
+  font-size: 150%;
+  color: #F5F5F5;
+}
+
+.summary-rate, .summary-uncovered, .summary-files {
+  background-color: #6A9FB5;
+  padding: 5px 10px;
+  margin-right: 20px;
+}
+
+#bis {
+  display: none;
+}