rcov_stats 2.0.1 → 2.1.0

data/CHANGELOG

@@ -0,0 +1,8 @@
+2.1.0 (September 2010)
+  replaced ReXML with Hpricot
+  made it working only with bundler > 0.9
+  made it working with rcov 0.9.9
+2.0.1 (May 2010)
+  fixed bug for merb with wrong bracket use
+2.0.0 (April 2010)
+  refactor

data/README

@@ -1,52 +1,36 @@
-RcovStats
-=========
-
-RcovStats provides rcov extension, so you can select test files and test covered files for unit and functional tests.
-
-How to install :
-
-1) As a Rails plugin:
-  ./script/plugin install git://github.com/bartes/rcov_stats.git
-2) As a gem for Rails:
-  gem install rcov_stats
-  cd your_application
-  rake gems:unpack GEM=rcov_stats
-  #add in RakeFile.rb
-  Dir[File.dirname(__FILE__) + "/vendor/gems/**/rcov_stats*/tasks/*.rake"].each do |f|
-    import f
-  end
-3) As a gem for Merb:
-  gem install rcov_stats #from gemcutter
-  ## puts this dependency inside your config/init.rb file ##
-  dependency "rcov_stats"
-5) for bundler
-  ## puts this into Gemfile file ##
-  gem "rcov_stats"
-  #add in RakeFile.rb
-  Dir[File.dirname(__FILE__) + "/vendor/bundler_gems/**/rcov_stats*/tasks/*.rake"].each do |f|
-    import f
-  end
-
-How to configure
-
-After installation (initialization) you can see rcov_stats.yml in /config directory.
-You can specify there :
-  - files or directories to be covered by unit tests to cover (units_files_to_cover)
-  - files or directories to be covered by functional tests to cover (functionals_files_to_cover)
-  - test files or directories with test files which will be used for unit testing (units_files_to_test)
-  - test files or directories with test files which will be used for functional testing (functionals_files_to_test)
-  - action which will be used before running test suite (before_rcov -> by default db:test:prepare)
-
-
-You can run:
-- rake rcov:stats (includes rcov:units and rcov:functionals)
-- rake rcov:units
-- rake rcov:functionals
-- rake rcov:general (includes rcov:units and rcov:functionals, but counts one general coverage and puts all results in one output directory)
-
-
-You can grab rcov gem with :
-  gem install rcov
-
-
-Copyright (c) 2010 [bartes], released under the MIT license
+RcovStats
+=========
+
+RcovStats provides rcov extension, so you can select test files and test covered files for unit and functional tests.
+
+How to install :
+
+** for Merb:
+  gem install rcov_stats #from gemcutter
+  ## puts this dependency inside your config/init.rb file ##
+  dependency "rcov_stats"
+** for Rails
+  ## puts this into Gemfile file ##
+  gem "rcov_stats"
+
+
+How to configure
+
+After installation (initialization) you can see rcov_stats.yml in /config directory.
+You can specify there :
+  - files or directories to be covered by unit tests to cover (units_files_to_cover)
+  - files or directories to be covered by functional tests to cover (functionals_files_to_cover)
+  - test files or directories with test files which will be used for unit testing (units_files_to_test)
+  - test files or directories with test files which will be used for functional testing (functionals_files_to_test)
+  - action which will be used before running test suite (before_rcov -> by default db:test:prepare)
+
+
+You can run:
+- rake rcov:stats (includes rcov:units and rcov:functionals)
+- rake rcov:units
+- rake rcov:functionals
+- rake rcov:general (includes rcov:units and rcov:functionals, but counts one general coverage and puts all results in one output directory)
+
+
+
+Copyright (c) 2010 [bartes], released under the MIT license

data/config/rcov_rspec.yml

@@ -1,13 +1,13 @@
-units_files_to_cover:
-  - app/models
-functionals_files_to_cover:
-  - app/controllers
-  - app/helpers
-units_files_to_test:
-  - models
-functionals_files_to_test:
-  - controllers
-  - helpers
-before_rcov: db:test:prepare
-
+units_files_to_cover:
+  - app/models
+functionals_files_to_cover:
+  - app/controllers
+  - app/helpers
+units_files_to_test:
+  - models
+functionals_files_to_test:
+  - controllers
+  - helpers
+before_rcov: db:test:prepare
+
 #you can select files also this way app/*/*.rb

data/config/rcov_standard.yml

@@ -1,13 +1,13 @@
-units_files_to_cover:
-  - app/models
-functionals_files_to_cover:
-  - app/controllers
-  - app/helpers
-units_files_to_test:
-  - unit
-functionals_files_to_test:
-  - functional
-  - integration
-before_rcov: db:test:prepare
-
-#you can select files also this way app/*/*.rb
+units_files_to_cover:
+  - app/models
+functionals_files_to_cover:
+  - app/controllers
+  - app/helpers
+units_files_to_test:
+  - unit
+functionals_files_to_test:
+  - functional
+  - integration
+before_rcov: db:test:prepare
+
+#you can select files also this way app/*/*.rb

data/lib/rcov_stats.rb

@@ -1,147 +1,166 @@
-require 'fileutils'
-require "rexml/document"
-
-class RcovStats
-
-  TYPES = ["units", "functionals"]
-
-  def self.cattr_accessor_with_default(name, value = nil)
-    cattr_accessor name
-    self.send("#{name}=", value) if value
-  end
-
-  cattr_accessor_with_default :is_rails, Object.const_defined?('Rails')
-  cattr_accessor_with_default :is_merb, Object.const_defined?('Merb')
-  cattr_accessor_with_default :root, ((@@is_rails && Rails.root) or (@@is_merb && Merb.root) or nil)
-  cattr_accessor_with_default :rcov_stats_dir, File.dirname(__FILE__)
-  cattr_accessor_with_default :rcov_stats_config_file, File.join(@@root, 'config', 'rcov_stats.yml')
-  cattr_accessor_with_default :use_rspec, File.exists?(File.join(@@root, 'spec'))
-  cattr_accessor_with_default :test_name, @@use_rspec ? "spec" : "test"
-  cattr_accessor_with_default :test_file_indicator, "*_#{@@test_name}.rb"
-  cattr_accessor_with_default :cover_file_indicator, "*.rb"
-
-  attr_accessor :name, :sections
-
-  def initialize(name_, sections_ = nil)
-    self.name = name_
-    self.sections = sections_.blank? ? [name_] : sections_
-  end
-
-  def self.get_config(option)
-    YAML::load(File.open(File.join(@@root, 'config', 'rcov_stats.yml')))[option]
-  end
-
-  def self.before_rcov
-    (pre_rcov = get_config("before_rcov")).blank? ? nil : pre_rcov
-  end
-
-  def get_array_data(type)
-    @sections.map do |section|
-      (self.class.get_config("#{section}_#{type}") || []).reject { |d| d.blank? }
-    end.flatten.uniq
-  end
-
-  def files_to_cover
-    get_array_data "files_to_cover"
-  end
-
-  def files_to_test
-    get_array_data "files_to_test"
-  end
-
-  def parse_file_to_test(list)
-    result = []
-    list.each do |f|
-      file_list = File.directory?(File.join(@@root, @@test_name, f)) ? File.join(@@test_name, f, "**", @@test_file_indicator) : File.join(@@test_name, f)
-      unless (list_of_read_files = Dir[file_list]).empty?
-        result += list_of_read_files
-      end
-    end
-    result.uniq
-  end
-
-  def parse_file_to_cover(list)
-    result = []
-    list.each do |f|
-      file_list = File.directory?(File.join(@@root, f)) ? File.join(f, "**", @@cover_file_indicator) : File.join(f)
-      unless (list_of_read_files = Dir[file_list]).empty?
-        result += list_of_read_files
-      end
-    end
-    result.uniq
-  end
-
-  def invoke_rcov_task
-    require 'rake/win32'
-    files_to_cover_parsed = parse_file_to_cover(files_to_cover).map { |f| "(#{f})".gsub("/", "\/") }.join("|")
-    rcov_settings = "--sort coverage --text-summary -x \"^(?!(#{files_to_cover_parsed}))\" "
-    rcov_settings +="--output=#{File.join(@@root, "coverage", @name)} "
-    rcov_tests = parse_file_to_test(files_to_test)
-    return false if rcov_tests.empty?
-    rcov_settings += rcov_tests.join(' ')
-    cmd = "rcov #{rcov_settings}"
-    Rake::Win32.windows? ? Rake::Win32.rake_system(cmd) : system(cmd)
-  end
-
-  def invoke_rcov_spec_task
-    require 'spec/rake/spectask'
-    rcov_tests = parse_file_to_test(files_to_test)
-    return false if rcov_tests.empty?
-    Spec::Rake::SpecTask.new(@name) do |t|
-      spec_opts = File.join(@@root, @@test_name, 'spec.opts')
-      t.spec_opts = ['--options', "\"#{spec_opts}\""] if File.exists?(spec_opts)
-      t.spec_files = rcov_tests
-      t.rcov = true
-      t.rcov_dir =  File.join(@@root, "coverage", @name)
-      files_to_cover_parsed = parse_file_to_cover(files_to_cover).map { |f| "(#{f})".gsub("/", "\/") }.join("|")
-      t.rcov_opts = ["--text-summary", "--sort", "coverage", "-x", "\"^(?!(#{files_to_cover_parsed}))\""]
-    end
-  end
-
-  def invoke
-    @@use_rspec ? invoke_rcov_spec_task : invoke_rcov_task
-  end
-
-  def generate_index
-    Dir[File.join(@@rcov_stats_dir, '..', 'templates/*')].each do |i|
-      FileUtils.cp(i, File.join(@@root, 'coverage', i.split("/").last))
-    end
-    @sections.each do |i|
-      coverage_index = File.join(@@root, 'coverage', i, "index.html")
-      next unless File.exists?(coverage_index)
-      isource = IO.read(coverage_index)
-      idoc = REXML::Document.new(isource.gsub(/\&/, ""))
-      footer_tts = idoc.get_elements("//tfoot/tr/td//tt")
-      footer_div_covered = idoc.get_elements("//tfoot/tr/td//div[@class='covered']")
-      footer_div_uncovered = idoc.get_elements("//tfoot/tr/td//div[@class='uncovered']")
-      curr_source = IO.read(File.join(@@root, 'coverage', "index.html"))
-      curr_source.gsub!("#{i}_total_lines", footer_tts[0].text)
-      curr_source.gsub!("#{i}_code_lines", footer_tts[1].text)
-      curr_source.gsub!("#{i}_total_result", footer_tts[2].text)
-      curr_source.gsub!("#{i}_code_result", footer_tts[3].text)
-      curr_source.gsub!("#{i}_total_rpx", footer_div_covered[0].attribute("style").value)
-      curr_source.gsub!("#{i}_total_cpx", footer_div_covered[1].attribute("style").value)
-      curr_source.gsub!("#{i}_total_lrpx", footer_div_uncovered[0].attribute("style").value)
-      curr_source.gsub!("#{i}_total_lcpx", footer_div_uncovered[1].attribute("style").value)
-      curr_source.gsub!(/\<p\>*\<\/p\>/, "Generated on #{Time.now}")
-      File.open(File.join(@@root, 'coverage', "index.html"), "w+") do |f|
-        f.write(curr_source)
-      end
-    end
-  end
-
-  def self.setup
-    if @@is_merb
-      Merb::Plugins.add_rakefiles(File.join(@@rcov_stats_dir, "rcov_stats_tasks"))
-    end
-    unless File.exists?(@@rcov_stats_config_file)
-      which_conf_use = (@@use_rspec ? 'rcov_rspec' : 'rcov_standard') + '.yml'
-      FileUtils.cp(File.join(@@rcov_stats_dir, '..', 'config', which_conf_use), @@rcov_stats_config_file)
-    end
-  end
-end
-
-RcovStats.setup
-
-
-
+require "fileutils"
+require "erb"
+
+class RcovStatsForErb
+
+  def initialize( options )
+    options.each_pair do |key, value|
+      instance_variable_set(:"@#{key}",value)
+    end
+  end
+
+  def get_binding
+    binding
+  end
+
+end
+
+
+class RcovStats
+
+  TYPES = ["units", "functionals"]
+
+  def self.cattr_accessor_with_default(name, value = nil)
+    cattr_accessor name
+    self.send("#{name}=", value) if value
+  end
+
+  cattr_accessor_with_default :is_rails, Object.const_defined?('Rails')
+  cattr_accessor_with_default :is_merb, Object.const_defined?('Merb')
+  cattr_accessor_with_default :root, ((@@is_rails && Rails.root) or (@@is_merb && Merb.root) or nil)
+  cattr_accessor_with_default :rcov_stats_dir, File.dirname(__FILE__)
+  cattr_accessor_with_default :rcov_stats_config_file, File.join(@@root, 'config', 'rcov_stats.yml')
+  cattr_accessor_with_default :use_rspec, File.exists?(File.join(@@root, 'spec'))
+  cattr_accessor_with_default :test_name, @@use_rspec ? "spec" : "test"
+  cattr_accessor_with_default :test_file_indicator, "*_#{@@test_name}.rb"
+  cattr_accessor_with_default :cover_file_indicator, "*.rb"
+
+  attr_accessor :name, :sections
+
+  def initialize(name_, sections_ = nil)
+    self.name = name_
+    self.sections = sections_.blank? ? [name_] : sections_
+  end
+
+  def self.get_config(option)
+    YAML::load(File.open(File.join(@@root, 'config', 'rcov_stats.yml')))[option]
+  end
+
+  def self.before_rcov
+    (pre_rcov = get_config("before_rcov")).blank? ? nil : pre_rcov
+  end
+
+  def get_array_data(type)
+    @sections.map do |section|
+      (self.class.get_config("#{section}_#{type}") || []).reject { |d| d.blank? }
+    end.flatten.uniq
+  end
+
+  def files_to_cover
+    get_array_data "files_to_cover"
+  end
+
+  def files_to_test
+    get_array_data "files_to_test"
+  end
+
+  def parse_file_to_test(list)
+    result = []
+    list.each do |f|
+      file_list = File.directory?(File.join(@@root, @@test_name, f)) ? File.join(@@test_name, f, "**", @@test_file_indicator) : File.join(@@test_name, f)
+      unless (list_of_read_files = Dir[file_list]).empty?
+        result += list_of_read_files
+      end
+    end
+    result.uniq
+  end
+
+  def parse_file_to_cover(list)
+    result = []
+    list.each do |f|
+      file_list = File.directory?(File.join(@@root, f)) ? File.join(f, "**", @@cover_file_indicator) : File.join(f)
+      unless (list_of_read_files = Dir[file_list]).empty?
+        result += list_of_read_files
+      end
+    end
+    result.uniq
+  end
+
+  def invoke_rcov_task
+    require 'rake/win32'
+    files_to_cover_parsed = parse_file_to_cover(files_to_cover).map { |f| "(#{f})".gsub("/", "\/") }.join("|")
+    rcov_settings = "--sort coverage --text-summary -x \"^(?!(#{files_to_cover_parsed}))\" "
+    rcov_settings +="--output=#{File.join(@@root, "coverage", @name)} "
+    rcov_tests = parse_file_to_test(files_to_test)
+    return false if rcov_tests.empty?
+    rcov_settings += rcov_tests.join(' ')
+    cmd = "bundle exec rcov #{rcov_settings}"
+    Rake::Win32.windows? ? Rake::Win32.rake_system(cmd) : system(cmd)
+  end
+
+  def invoke_rcov_spec_task
+    require 'spec/rake/spectask'
+    rcov_tests = parse_file_to_test(files_to_test)
+    return false if rcov_tests.empty?
+    Spec::Rake::SpecTask.new(@name) do |t|
+      spec_opts = File.join(@@root, @@test_name, 'spec.opts')
+      t.spec_opts = ['--options', "\"#{spec_opts}\""] if File.exists?(spec_opts)
+      t.spec_files = rcov_tests
+      t.rcov = true
+      t.rcov_dir =  File.join(@@root, "coverage", @name)
+      files_to_cover_parsed = parse_file_to_cover(files_to_cover).map { |f| "(#{f})".gsub("/", "\/") }.join("|")
+      t.rcov_opts = ["--text-summary", "--sort", "coverage", "-x", "\"^(?!(#{files_to_cover_parsed}))\""]
+    end
+  end
+
+  def invoke
+    @@use_rspec ? invoke_rcov_spec_task : invoke_rcov_task
+  end
+
+  def generate_index
+    Dir[File.join(@@rcov_stats_dir, '..', 'templates/*')].each do |i|
+      FileUtils.cp(i, File.join(@@root, 'coverage', i.split("/").last))
+    end
+
+
+
+    @sections.each do |i|
+      coverage_index = File.join(@@root, 'coverage', i, "index.html")
+      next unless File.exists?(coverage_index)
+      doc = open(coverage_index) { |f| Hpricot(f) }
+      footer_tts = doc.search("//tfoot/tr/td//tt")
+      footer_div_covered = doc.search("//tfoot/tr/td//div[@class='covered']")
+      footer_div_uncovered = doc.search("//tfoot/tr/td//div[@class='uncovered']")
+
+      template_object = {}
+      template_object["#{i}_total_lines"] = footer_tts[0].inner_text
+      template_object["#{i}_code_lines"] =  footer_tts[1].inner_text
+      template_object["#{i}_total_result"] = footer_tts[2].inner_text
+      template_object["#{i}_code_result"] =  footer_tts[3].inner_text
+      template_object["#{i}_total_rpx"] =  footer_div_covered[0].get_attribute("style")
+      template_object["#{i}_total_cpx"] =  footer_div_covered[1].get_attribute("style")
+      template_object["#{i}_total_lrpx"] = footer_div_uncovered[0].get_attribute("style")
+      template_object["#{i}_total_lcpx"] =  footer_div_uncovered[1].get_attribute("style")
+      template_object["generated_on"] = "Generated on #{Time.now}"
+
+
+      template_source = ERB.new(IO.read(File.join(@@root, 'coverage', "index.html")))
+
+      File.open(File.join(@@root, 'coverage', "index.html"), "w+") do |f|
+        f.write( template_source.result(RcovStatsForErb.new(template_object).get_binding))
+      end
+    end
+  end
+
+  def self.setup
+    if @@is_merb
+      Merb::Plugins.add_rakefiles(File.join(@@rcov_stats_dir, "rcov_stats_tasks"))
+    end
+    unless File.exists?(@@rcov_stats_config_file)
+      which_conf_use = (@@use_rspec ? 'rcov_rspec' : 'rcov_standard') + '.yml'
+      FileUtils.cp(File.join(@@rcov_stats_dir, '..', 'config', which_conf_use), @@rcov_stats_config_file)
+    end
+  end
+end
+
+RcovStats.setup

data/lib/rcov_stats_tasks.rb

@@ -1,34 +1,34 @@
-namespace :rcov do
-  require File.join(File.dirname(__FILE__), "rcov_stats.rb")
-  desc "run rcov for units tests"
-  task(RcovStats.before_rcov ? ({:units => RcovStats.before_rcov}) : :units) do
-    puts '** rcov:units **'
-    RcovStats.new('units').invoke
-  end
-
-  desc "run rcov for functionals tests"
-  task(RcovStats.before_rcov ? ({:functionals => RcovStats.before_rcov}) : :functionals) do
-    puts '** rcov:functionals **'
-    RcovStats.new('functionals').invoke
-  end
-
-  desc "run rcov for functionals and units tests"
-  task(RcovStats.before_rcov ? ({:stats => RcovStats.before_rcov}) : :stats) do
-    puts '** rcov:stats **'
-    Rake::Task['rcov:units'].invoke
-    Rake::Task['rcov:functionals'].invoke
-    Rake::Task['rcov:generate_index'].invoke
-  end
-
-  desc "run general rcov tests"
-  task(RcovStats.before_rcov ? ({:general => RcovStats.before_rcov}) : :general) do
-    puts '** rcov:general **'
-    RcovStats.new('general',["units", "functionals"]).invoke
-  end
-
-  desc "generate index for all suites"
-  task :generate_index do
-    puts '** rcov:generate_index **'
-    RcovStats.new('general',["units", "functionals"]).generate_index
-  end
-end
+namespace :rcov do
+  require File.join(File.dirname(__FILE__), "rcov_stats.rb")
+  desc "run rcov for units tests"
+  task(RcovStats.before_rcov ? ({:units => RcovStats.before_rcov}) : :units) do
+    puts '** rcov:units **'
+    RcovStats.new('units').invoke
+  end
+
+  desc "run rcov for functionals tests"
+  task(RcovStats.before_rcov ? ({:functionals => RcovStats.before_rcov}) : :functionals) do
+    puts '** rcov:functionals **'
+    RcovStats.new('functionals').invoke
+  end
+
+  desc "run rcov for functionals and units tests"
+  task(RcovStats.before_rcov ? ({:stats => RcovStats.before_rcov}) : :stats) do
+    puts '** rcov:stats **'
+    Rake::Task['rcov:units'].invoke
+    Rake::Task['rcov:functionals'].invoke
+    Rake::Task['rcov:generate_index'].invoke
+  end
+
+  desc "run general rcov tests"
+  task(RcovStats.before_rcov ? ({:general => RcovStats.before_rcov}) : :general) do
+    puts '** rcov:general **'
+    RcovStats.new('general',["units", "functionals"]).invoke
+  end
+
+  desc "generate index for all suites"
+  task :generate_index do
+    puts '** rcov:generate_index **'
+    RcovStats.new('general',["units", "functionals"]).generate_index
+  end
+end