simplecov 0.3.0

data/lib/simplecov/filter.rb

@@ -0,0 +1,35 @@
+module SimpleCov
+  #
+  # Base filter class. Inherit from this to create custom filters,
+  # and overwrite the passes?(source_file) instance method
+  # 
+  # # A sample class that rejects all source files.
+  # class StupidFilter < SimpleCov::Filter
+  #   def passes?(source_file)
+  #     false
+  #   end
+  # end
+  #
+  class Filter
+    attr_reader :filter_argument
+    def initialize(filter_argument)
+      @filter_argument = filter_argument
+    end
+    
+    def passes?(source_file)
+      raise "The base filter class is not intended for direct use"
+    end
+  end
+  
+  class StringFilter < SimpleCov::Filter
+    def passes?(source_file)
+      !(source_file.filename =~ /#{filter_argument}/)
+    end
+  end
+  
+  class BlockFilter < SimpleCov::Filter
+    def passes?(source_file)
+      !filter_argument.call(source_file)
+    end
+  end
+end

data/lib/simplecov/formatter.rb

@@ -0,0 +1,7 @@
+module SimpleCov
+  module Formatter
+    
+  end
+end
+
+require 'simplecov/formatter/simple_formatter'

data/lib/simplecov/formatter/simple_formatter.rb

@@ -0,0 +1,15 @@
+class SimpleCov::Formatter::SimpleFormatter
+  def format(result)
+    output = ""
+    result.groups.each do |name, files|
+      output << "Group: #{name}\n"
+      output << "="*40
+      output << "\n"
+      files.each do |file|
+        output << "#{file.filename} (coverage: #{file.covered_percent.round(2)}%)\n"
+      end
+      output << "\n"
+    end
+    output
+  end
+end

data/lib/simplecov/merge_helpers.rb

@@ -0,0 +1,37 @@
+module SimpleCov::ArrayMergeHelper
+  def merge_resultset(array)
+    new_array = []
+    
+    self.each_with_index do |element, i|
+      new_array[i] = element
+    end
+    
+    array.each_with_index do |element, i|
+      if element.nil? and new_array[i].nil?
+        new_array[i] = nil
+      else
+        local_value = element || 0
+        other_value = new_array[i] || 0
+        new_array[i] = local_value + other_value
+      end
+    end
+    new_array
+  end
+end
+
+module SimpleCov::HashMergeHelper
+  def merge_resultset(hash)
+    new_resultset = {}
+    (self.keys + hash.keys).each do |filename|
+      new_resultset[filename] = []
+    end
+    
+    new_resultset.each do |filename, data|
+      new_resultset[filename] = (self[filename] || []).merge_resultset(hash[filename] || [])
+    end
+    new_resultset
+  end
+end
+
+Array.send :include, SimpleCov::ArrayMergeHelper
+Hash.send :include, SimpleCov::HashMergeHelper

data/lib/simplecov/result.rb

@@ -0,0 +1,73 @@
+require 'digest/sha1'
+require 'yaml'
+
+module SimpleCov
+  class Result    
+    attr_reader :original_result, :files
+    attr_writer :created_at, :command_name
+    alias_method :source_files, :files
+
+    def initialize(original_result)
+      @original_result = original_result.freeze
+      @files = original_result.map {|filename, coverage| SimpleCov::SourceFile.new(filename, coverage)}.sort_by(&:filename)
+      filter!
+    end
+  
+    def filenames
+      files.map(&:filename)
+    end
+    
+    def groups
+      @groups ||= SimpleCov.grouped(files)
+    end
+    
+    def covered_percent
+      files.map(&:covered_percent).inject(:+) / files.count.to_f
+    end
+    
+    def format!
+      SimpleCov.formatter.new.format(self)
+    end
+    
+    # Defines when this result has been created
+    def created_at
+      @created_at ||= Time.now
+    end
+    
+    # The command name that launched this result. 
+    # Retrieved from SimpleCov.command_name
+    def command_name
+      @command_name ||= SimpleCov.command_name
+    end
+    
+    # Returns a hash representation of this Result
+    def to_hash
+      {command_name => {:original_result => original_result.reject {|filename, result| !filenames.include?(filename) }, :created_at => created_at}}
+    end
+    
+    # Returns a yaml dump of this result, which then can be reloaded using SimpleCov::Result.from_yaml
+    def to_yaml
+      to_hash.to_yaml
+    end
+    
+    # Loads a SimpleCov::Result#to_hash dump
+    def self.from_hash(hash)
+      command_name, data = hash.first
+      result = SimpleCov::Result.new(data[:original_result])
+      result.command_name = command_name
+      result.created_at = data[:created_at]
+      result
+    end
+    
+    # Loads a SimpleCov::Result#to_yaml dump
+    def self.from_yaml(yaml)
+      from_hash(YAML.load(yaml))
+    end
+    
+    private
+  
+    def filter!
+      @files = SimpleCov.filtered(files)
+    end
+  end
+end

data/lib/simplecov/result_merger.rb

@@ -0,0 +1,46 @@
+require 'yaml'
+module SimpleCov::ResultMerger
+  class << self
+    def resultset_path
+      File.join(SimpleCov.coverage_path, 'resultset.yml')
+    end
+    
+    def resultset
+      return {} unless File.exist?(resultset_path)
+      YAML.load(File.read(resultset_path))
+    end
+    
+    def results
+      results = []
+      resultset.each do |command_name, data| 
+        result = SimpleCov::Result.from_hash(command_name => data)
+        # Only add result if the timeout is above the configured threshold
+        if (Time.now - result.created_at) < SimpleCov.merge_timeout
+          results << result
+        end
+      end
+      results
+    end
+    
+    def merged_result
+      merged = {}
+      results.each do |result|
+        merged = result.original_result.merge_resultset(merged)
+      end
+      result = SimpleCov::Result.new(merged)
+      # Specify the command name
+      result.command_name = results.map(&:command_name).join(", ")
+      result
+    end
+    
+    def store_result(result)
+      new_set = resultset
+      command_name, data = result.to_hash.first
+      new_set[command_name] = data
+      File.open(resultset_path, "w+") do |f|
+        f.puts new_set.to_yaml
+      end
+      true
+    end
+  end
+end

data/lib/simplecov/source_file.rb

@@ -0,0 +1,68 @@
+module SimpleCov
+  class SourceFile
+    # Representation of a single line in a source file including
+    # this specific line's source code, line_number and code coverage,
+    # with the coverage being either nil (coverage not applicable, e.g. comment
+    # line), 0 (line not covered) or >1 (the amount of times the line was 
+    # executed)
+    class Line
+      attr_reader :src, :line_number, :coverage
+      # Lets grab some fancy aliases, shall we?
+      alias_method :source, :src
+      alias_method :line, :line_number
+      alias_method :number, :line_number
+    
+      def initialize(src, line_number, coverage)
+        raise ArgumentError, "Only String accepted for source" unless src.kind_of?(String)
+        raise ArgumentError, "Only Fixnum accepted for line_number" unless line_number.kind_of?(Fixnum)
+        raise ArgumentError, "Only Fixnum and nil accepted for coverage" unless coverage.kind_of?(Fixnum) or coverage.nil?
+        @src, @line_number, @coverage = src, line_number, coverage
+      end
+    
+      def missed?
+        not never? and coverage == 0
+      end
+    
+      def covered?
+        not never? and coverage > 0
+      end
+    
+      def never?
+        coverage.nil?
+      end
+    end
+  
+    attr_reader :filename, :coverage, :src, :lines
+    alias_method :source, :src
+    alias_method :source_lines, :lines
+  
+    def initialize(filename, coverage)
+      @filename, @coverage, @src = filename, coverage, File.readlines(filename)
+      @lines = []
+      coverage.each_with_index do |coverage, i|
+        @lines << SimpleCov::SourceFile::Line.new(src[i], i+1, coverage)
+      end
+    end
+    
+    def line(number)
+      lines[number-1]
+    end
+  
+    def covered_percent
+      return 100.0 if lines.length == 0 or lines.length == never_lines.count
+      (covered_lines.count) * 100 / (lines.count-never_lines.count).to_f
+    end
+  
+    def covered_lines
+      @covered_lines ||= lines.select {|c| c.covered? }
+    end
+  
+    def missed_lines
+      @missed_lines ||= lines.select {|c| c.missed? }
+    end
+  
+    def never_lines
+      @never_lines ||= lines.select {|c| c.never? }
+    end
+  end
+end

data/simple_cov.gemspec

@@ -0,0 +1,81 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{simple_cov}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Christoph Olszowka"]
+  s.date = %q{2010-08-20}
+  s.description = %q{Makes ruby 1.9's code coverage library's results more accessible in an object-oriented manner and adds some sugar on top}
+  s.email = %q{christoph at olszowka.de}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/simple_cov.rb",
+     "lib/simple_cov/adapters.rb",
+     "lib/simple_cov/configuration.rb",
+     "lib/simple_cov/filter.rb",
+     "lib/simple_cov/formatter.rb",
+     "lib/simple_cov/formatter/simple_formatter.rb",
+     "lib/simple_cov/merge_helpers.rb",
+     "lib/simple_cov/result.rb",
+     "lib/simple_cov/result_merger.rb",
+     "lib/simple_cov/source_file.rb",
+     "simple_cov.gemspec",
+     "test/fixtures/app/controllers/sample_controller.rb",
+     "test/fixtures/app/models/user.rb",
+     "test/fixtures/resultset1.rb",
+     "test/fixtures/resultset2.rb",
+     "test/fixtures/sample.rb",
+     "test/helper.rb",
+     "test/test_filters.rb",
+     "test/test_merge_helpers.rb",
+     "test/test_result.rb",
+     "test/test_source_file.rb",
+     "test/test_source_file_line.rb"
+  ]
+  s.homepage = %q{http://github.com/colszowka/simple_cov}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Makes ruby 1.9's code coverage library's results more accessible in an object-oriented manner and adds some sugar on top}
+  s.test_files = [
+    "test/fixtures/app/controllers/sample_controller.rb",
+     "test/fixtures/app/models/user.rb",
+     "test/fixtures/resultset1.rb",
+     "test/fixtures/resultset2.rb",
+     "test/fixtures/sample.rb",
+     "test/helper.rb",
+     "test/test_filters.rb",
+     "test/test_merge_helpers.rb",
+     "test/test_result.rb",
+     "test/test_source_file.rb",
+     "test/test_source_file_line.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, ["= 2.10.3"])
+    else
+      s.add_dependency(%q<shoulda>, ["= 2.10.3"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, ["= 2.10.3"])
+  end
+end
+

data/simplecov.gemspec

@@ -0,0 +1,82 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{simplecov}
+  s.version = "0.3.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Christoph Olszowka"]
+  s.date = %q{2010-08-22}
+  s.description = %q{Code coverage for Ruby 1.9}
+  s.email = %q{christoph at olszowka.de}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/simplecov.rb",
+     "lib/simplecov/adapters.rb",
+     "lib/simplecov/configuration.rb",
+     "lib/simplecov/filter.rb",
+     "lib/simplecov/formatter.rb",
+     "lib/simplecov/formatter/simple_formatter.rb",
+     "lib/simplecov/merge_helpers.rb",
+     "lib/simplecov/result.rb",
+     "lib/simplecov/result_merger.rb",
+     "lib/simplecov/source_file.rb",
+     "simple_cov.gemspec",
+     "simplecov.gemspec",
+     "test/fixtures/app/controllers/sample_controller.rb",
+     "test/fixtures/app/models/user.rb",
+     "test/fixtures/resultset1.rb",
+     "test/fixtures/resultset2.rb",
+     "test/fixtures/sample.rb",
+     "test/helper.rb",
+     "test/test_filters.rb",
+     "test/test_merge_helpers.rb",
+     "test/test_result.rb",
+     "test/test_source_file.rb",
+     "test/test_source_file_line.rb"
+  ]
+  s.homepage = %q{http://github.com/colszowka/simplecov}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Code coverage for Ruby 1.9}
+  s.test_files = [
+    "test/fixtures/app/controllers/sample_controller.rb",
+     "test/fixtures/app/models/user.rb",
+     "test/fixtures/resultset1.rb",
+     "test/fixtures/resultset2.rb",
+     "test/fixtures/sample.rb",
+     "test/helper.rb",
+     "test/test_filters.rb",
+     "test/test_merge_helpers.rb",
+     "test/test_result.rb",
+     "test/test_source_file.rb",
+     "test/test_source_file_line.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, ["= 2.10.3"])
+    else
+      s.add_dependency(%q<shoulda>, ["= 2.10.3"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, ["= 2.10.3"])
+  end
+end
+