coco 0.13.0 → 0.14.0

data/lib/coco/deprecated_message.rb

@@ -0,0 +1,31 @@
+module Coco
+
+  # Group all messages for deprecated things in this module.
+  #
+  module DeprecatedMessage
+
+    def self.for_excludes
+      "Please change `excludes` to `exclude`.\n" \
+      'Support for `excludes` configuration key will ' \
+      'be removed in future Coco versions.'
+    end
+
+    def self.for_directories
+      "Please change `directories` to `include`.\n" \
+      'Support for `directories` configuration key will ' \
+      'be removed in future Coco versions.'
+    end
+
+    def self.for_threeshold
+      "Please change `threeshold` to `threshold`.\n" \
+      'Support for the misspelt `threeshold` configuration key will ' \
+      'be removed in future Coco versions.'
+    end
+
+    def self.for_legacy_config_file
+      "Please use `.coco.yml` instead of `.coco`.\n" \
+      'Support for `.coco` will be removed in future versions.'
+    end
+
+  end
+end

data/lib/coco/formatter.rb

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

data/lib/coco/formatter/colored_string.rb

@@ -7,7 +7,7 @@ module Coco
     # Public: Initialize a new ColoredString object.
     #
     # str - A String.
-    def initialize(str="")
+    def initialize(str = '')
       super(str)
     end
 

data/lib/coco/formatter/console_formatter.rb

@@ -1,24 +1,25 @@
 module Coco
 
   # I format coverages data for console output.
-  class ConsoleFormatter < Formatter
+  #
+  class ConsoleFormatter
 
     # Public: Get a colored report, formatted for console output.
     #
-    # single_line_report - Boolean
-    #
     # Returns percent covered and associated filenames as a multilines
-    # String
-    def format(single_line_report = false)
-      single_line_report ? single_line_message : @formatted_output.join("\n")
+    # or a single line String.
+    #
+    def format
+      @config[:single_line_report] ? single_line_message : multilines_message
     end
 
     # Get the link for the report's index file.
     #
     # Returns String.
+    #
     def link
       unless @formatted_output.empty?
-        "See file://" +
+        'See file://' +
           File.expand_path(File.join(Coco::HtmlDirectory.new.coverage_dir,
                                      'index.html'))
       end
@@ -26,11 +27,15 @@ module Coco
 
     # Public: Creates a new ConsoleFormatter.
     #
-    # covered   - See base class Formatter.
-    # uncovered - See base class Formatter.
+    # uncovered - An Array list of uncovered files.
     # threshold - The Fixnum percentage threshold.
-    def initialize(covered, uncovered, threshold)
-      super(covered, uncovered)
+    # result    - A CoverageResult.
+    # config    - A Configuration.
+    #
+    def initialize(uncovered, threshold, result, config)
+      @uncovered = uncovered
+      @result = result
+
       @formatted_output = []
       compute_percentage
       add_percentage_to_uncovered
@@ -45,29 +50,29 @@ module Coco
           text.yellow
         end
       end
+      @summary = Summary.new(result, uncovered)
+      @config = config
     end
 
     private
 
     def compute_percentage
-      @raw_coverages.each do |filename, coverage|
+      @result.not_covered_enough.each do |filename, coverage|
         percentage = CoverageStat.coverage_percent(coverage)
         @formatted_output << [percentage, filename]
       end
     end
 
     def add_percentage_to_uncovered
-      @uncovered.each {|filename| @formatted_output << [0, filename] }
+      @uncovered.each { |filename| @formatted_output << [0, filename] }
     end
 
     def single_line_message
-      if @uncovered.empty?
-        ""
-      else
-        ColoredString.new("Some files are uncovered").yellow
-      end
+      ColoredString.new(@summary.to_s).yellow
     end
 
+    def multilines_message
+      @formatted_output.join("\n") + "\n" + @summary.to_s + "\n"
+    end
   end
-
 end

data/lib/coco/formatter/context.rb

@@ -1,6 +1,7 @@
 module Coco
 
   # Contextual information for ERB template, representing each covered files.
+  #
   class Context
 
     # Public: Initialize a Context for a covered file shown in the HTML
@@ -8,48 +9,18 @@ module Coco
     #
     # filename - A String name of the source file.
     # lines    - An Array of lines.
-		def initialize(filename, lines)
-			@filename = filename
-      @lines = lines
-		end
-		
-    # Public: Get the object's binding.
     #
-    # Returns Binding.
-		def get_binding
-			binding
-		end
-	end
-
-  # Contextual information for ERB template, representing index.html.
-  class IndexContext
+    def initialize(filename, lines)
+      @filename = filename
+      @lines = lines
+    end
 
-    # Public: Initialize an IndexContext for the index file in the HTML
-    # report.
-    #
-    # title     - The String title for the report.
-    # covered   - Array of subarrays. Each subarray is:
-    #             [
-    #               Fixnum coverage percentage,
-    #               String formatted filename (HTML ready),
-    #               String real filename
-    #             ]
-    #             FIXME Need a class to handle subarrays.
-    # uncovered - Array of String filenames. The filenames are already
-    #             formatted, ready to be display in an HTML file.
-    #
-		def initialize(title, covered, uncovered)
-			@title = title
-      @covered = covered
-      @uncovered = uncovered
-		end
-		
     # Public: Get the object's binding.
     #
     # Returns Binding.
-		def get_binding
-			binding
-		end
-	end
-
+    #
+    def variables
+      binding
+    end
+  end
 end

data/lib/coco/formatter/html_formatter.rb

@@ -3,12 +3,12 @@ require 'erb'
 
 module Coco
 
-  # I format coverages information into html files.
-  # @todo document and change name to HtmlFilesFormatter
-  class HtmlFormatter < Formatter
+  # I format coverage's data into html files.
+  #
+  class HtmlFormatter
 
     def initialize(raw_coverages)
-      super(raw_coverages, [])
+      @raw_coverages = raw_coverages
       @formatted_output_files = {}
       @context = nil
       @template = Template.open(File.join(Coco::ROOT, 'template/file.erb'))
@@ -25,17 +25,11 @@ module Coco
 
     def build_html(filename, coverage)
       lines = []
-      source(filename).each_with_index do |line, index|
-        lines << [index+1, CGI.escapeHTML(line.chomp), coverage[index]]
+      File.readlines(filename).each_with_index do |line, index|
+        lines << [index + 1, CGI.escapeHTML(line.chomp), coverage[index]]
       end
       @context = Context.new(Helpers.name_for_html(filename), lines)
-      @formatted_output_files[filename] = @template.result(@context.get_binding)
+      @formatted_output_files[filename] = @template.result(@context.variables)
     end
-
-    def source(filename)
-      File.readlines(filename)
-    end
-
   end
-
 end

data/lib/coco/formatter/html_index_formatter.rb

@@ -3,10 +3,18 @@ require 'erb'
 module Coco
 
   # I format the index.html
-  class HtmlIndexFormatter < Formatter
-
-    def initialize(raw_coverages, uncovered)
-      super
+  #
+  class HtmlIndexFormatter
+
+    # uncovered - An Array list of uncovered files.
+    # result    - CoverageResult.
+    # threshold - Fixnum.
+    #
+    def initialize(uncovered, result, threshold = 100)
+      @uncovered = uncovered
+      @result = result
+      @threshold = threshold
+      @summary = Summary.new(result, uncovered)
       @context = nil
       @template = Template.open(File.join(Coco::ROOT, 'template/index.erb'))
       @lines = []
@@ -14,26 +22,22 @@ module Coco
     end
 
     def format
-      @context = IndexContext.new(
-        Helpers.index_title,
-        @lines,
-        @uncovered.map {|filename| Helpers.name_for_html(filename) })
-      @template.result(@context.get_binding)
+      @context = IndexContext.new(Helpers.index_title, @lines, uncovered_files,
+                                  @summary, @threshold)
+      @template.result(@context.variables)
     end
 
     private
 
     def build_lines_for_context
-      @raw_coverages.each do |filename, coverage|
-        @lines << [
-          CoverageStat.coverage_percent(coverage),
-          Helpers.name_for_html(filename),
-          Helpers.rb2html(filename)
-        ]
+      @result.coverable_files.to_a.each do |filename, coverage|
+        @lines << IndexLine.build(filename, coverage)
       end
       @lines.sort!
     end
 
+    def uncovered_files
+      @uncovered.map { |filename| Helpers.name_for_html(filename) }
+    end
   end
-
 end

data/lib/coco/formatter/index_context.rb

@@ -0,0 +1,37 @@
+module Coco
+
+  # Contextual information for ERB template, representing index.html.
+  #
+  class IndexContext
+
+    # Public: Initialize an IndexContext for the index file in the HTML
+    # report.
+    #
+    # title     - The String title for the report.
+    # all       - Array of subarrays. Each subarray is:
+    #             [
+    #               Fixnum coverage percentage,
+    #               String formatted filename (HTML ready),
+    #               String real filename
+    #             ]
+    # uncovered - Array of String filenames. The filenames are already
+    #             formatted, ready to be display in an HTML file.
+    # summary   - A Summary object.
+    # threshold - Fixnum.
+    #
+    def initialize(title, all, uncovered, summary, threshold)
+      @title = title
+      @covered, @greens = all.partition { |file| file.first < threshold }
+      @uncovered = uncovered
+      @summary = summary
+    end
+
+    # Public: Get the object's binding.
+    #
+    # Returns Binding.
+    #
+    def variables
+      binding
+    end
+  end
+end

data/lib/coco/formatter/index_line.rb

@@ -0,0 +1,21 @@
+module Coco
+
+  # Assembles data required to represent a line on the index HTML
+  # report.
+  #
+  module IndexLine
+
+    # filename - The absolute String filename.
+    # coverage - An Array of hit.
+    #
+    # Returns an Array.
+    #
+    def self.build(filename, coverage)
+      [
+        CoverageStat.coverage_percent(coverage),
+        Helpers.name_for_html(filename),
+        Helpers.rb2html(filename),
+      ]
+    end
+  end
+end

data/lib/coco/formatter/template.rb

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

data/lib/coco/helpers.rb

@@ -2,81 +2,101 @@ module Coco
 
   # Public: Collection of application's helpers methods.
   #
-  # TODO The app is full of `Dir.pwd`. This is the root project
-  # directory and must be in Configuration class (or Coco module ?).
   module Helpers
-    class << self
 
-      # Public: Get a String (ruby) source filename ready to be
-      # displayed in the index file.
-      #
-      # name - String full path filename (normaly full path but, who
-      #        knows? may be relative path).
-      #
-      # Examples
-      #
-      #   name = '/home/user/my_project/lib/source.rb'
-      #   Helpers.name_for_html(name)
-      #   #=> 'lib/<b>source.rb</b>'
-      #
-      # Returns the formatted String.
-      def name_for_html(name)
-        name = File.expand_path(name)
-        name = name.sub(Dir.pwd, '')
-        name = name.sub(/^\//, '')
-        base = File.basename(name)
-        name.sub(base, "<b>#{base}</b>")
-      end
+    # Public: Get a String (ruby) source filename ready to be
+    # displayed in the index file.
+    #
+    # name - String full path filename (normaly full path but, who
+    #        knows? may be relative path).
+    #
+    # Examples
+    #
+    #   name = '/home/user/my_project/lib/source.rb'
+    #   Helpers.name_for_html(name)
+    #   #=> 'lib/<b>source.rb</b>'
+    #
+    # Returns the formatted String.
+    #
+    def self.name_for_html(name)
+      name = File.expand_path(name)
+      name = name.sub(Dir.pwd, '')
+      name = name.sub(%r{^/}, '')
+      base = File.basename(name)
+      name.sub(base, "<b>#{base}</b>")
+    end
 
-      # Public: Get html filename (from a ruby filename) suitable for
-      # the coverage directory.
-      #
-      # name - String full path filename.
-      #
-      # Examples
-      #
-      #   ruby = '/home/user/my_project/lib/source.rb'
-      #   html = Helpers.rb2html(ruby)
-      #   #=> '_lib_source.rb.html'
-      #
-      # Returns String HTML filename.
-      def rb2html(name)
-        name = name.sub(Dir.pwd, '')
-        name = name.sub(/^\//, '')
-        name = name.tr('/\\', '_')
-        name + '.html'
-      end
+    # Public: Get html filename (from a ruby filename) suitable for
+    # the coverage directory.
+    #
+    # name - String full path filename.
+    #
+    # Examples
+    #
+    #   ruby = '/home/user/my_project/lib/source.rb'
+    #   html = Helpers.rb2html(ruby)
+    #   #=> '_lib_source.rb.html'
+    #
+    # Returns String HTML filename.
+    #
+    def self.rb2html(name)
+      name = name.sub(Dir.pwd, '')
+      name = name.sub(%r{^/}, '')
+      name = name.tr('/\\', '_')
+      name + '.html'
+    end
 
-      # Public: Get page title for the index.html file.
-      #
-      # Returns String.
-      def index_title
-        project_name = File.basename(Dir.pwd)
-        version = File.read(File.join(Coco::ROOT, 'VERSION')).strip
-        "#{project_name} - Code coverage (coco #{version})"
-      end
+    # Public: Get page title for the index.html file.
+    #
+    # Returns String.
+    #
+    def self.index_title
+      project_name = File.basename(Dir.pwd)
+      version = File.read(File.join(Coco::ROOT, 'VERSION')).strip
+      "#{project_name} - Code coverage (coco #{version})"
+    end
 
-      # Public: Expands a bulk of filenames into full path filenames.
-      #
-      # files - List of filenames as an Array of String.
-      #
-      # Returns an Array of String.
-      def expand(files)
-        files.map {|file| File.expand_path(file) }
-      end
+    # Public: Expands a bulk of filenames into full path filenames.
+    #
+    # files - List of filenames as an Array of String.
+    #
+    # Returns an Array of String.
+    #
+    def self.expand(files)
+      files.map { |file| File.expand_path(file) }
+    end
 
-      # Public: Get all ruby files from a directory, including
-      # sub-directories.
-      #
-      # directory - String directory to look into.
-      #
-      # Returns an Array of String.
-      def rb_files_from(directory)
-        rb_files = File.join(directory, "**", "*.rb")
-        Dir.glob(rb_files)
-      end
+    # Public: Get all ruby files from a directory, including
+    # sub-directories.
+    #
+    # directory - String directory to look into.
+    #
+    # Returns an Array of String.
+    #
+    def self.rb_files_from(directory)
+      rb_files = File.join(directory, '**', '*.rb')
+      Dir.glob(rb_files)
     end
 
+    # Public: Get the CSS class given a percentage. To use in the
+    # index file.
+    #
+    # percentage - A Fixnum.
+    #
+    # Examples
+    #
+    #   Helpers.level_class(100)
+    #   #=> 'green'
+    #
+    # Returns the String CSS class name.
+    #
+    def self.level_class(percentage)
+      case percentage
+      when 100 then 'green'
+      when 80..99 then 'yellow'
+      else
+        'red'
+      end
+    end
   end
-
 end