simplecov-reports 0.0.4.ooyala

data/test/fixtures/file_report/classes_covered.rb

@@ -0,0 +1,80 @@
+# Classes Covered
+
+# Classes with no significant lines of code
+
+class CoveredClass_Empty_None
+end
+
+class CoveredClass_Empty_BlankLine
+
+end
+
+class CoveredClass_Empty_Comments
+  # first comment
+end
+
+
+# Classes with code in them
+
+class CoveredClass_Code
+  def coveredClass_Code_method
+  end
+end
+
+class CoveredClass_Comment_Code
+  # first comment
+
+  def coveredClass_Comment_Code_method
+  end
+end
+
+class CoveredClass_BlankLine_Code
+
+  def coveredClass_BlankLine_Code_method
+  end
+end
+
+
+# Classes Covered although not actually used
+
+# Classes with no significant lines of code
+
+class CoveredClass_Unused_Empty_None
+end
+
+class CoveredClass_Unused_Empty_BlankLine
+
+end
+
+class CoveredClass_Unused_Empty_Comments
+  # first comment
+end
+
+
+# Classes with code in them
+
+class CoveredClass_Unused_Code
+  def coveredClass_Unused_Code_method
+  end
+end
+
+class CoveredClass_Unused_Comment_Code
+  # first comment
+
+  def coveredClass_Unused_Comment_Code_method
+  end
+end
+
+class CoveredClass_Unused_BlankLine_Code
+
+  def coveredClass_Unused_BlankLine_Code_method
+  end
+end
+
+# Class that's not covered
+if false
+  class NonCoveredClass
+    def non_covered_method
+    end
+  end
+end

data/test/fixtures/file_report/classes_not_covered.rb

@@ -0,0 +1,37 @@
+if false
+  # Classes Not Covered
+
+  # Classes with no significant lines of code
+
+  class NonCoveredClass_Empty_None
+  end
+
+  class NonCoveredClass_Empty_BlankLine
+
+  end
+
+  class NonCoveredClass_Empty_Comments
+    # first comment
+  end
+
+
+  # Classes with code in them
+
+  class NonCoveredClass_Code
+    def nonCoveredClass_Code_method
+    end
+  end
+
+  class NonCoveredClass_Comment_Code
+    # first comment
+
+    def nonCoveredClass_Comment_Code_method
+    end
+  end
+
+  class NonCoveredClass_BlankLine_Code
+
+    def nonCoveredClass_BlankLine_Code_method
+    end
+  end
+end

data/test/fixtures/file_report/classes_partially_covered.rb

@@ -0,0 +1,11 @@
+# Classes Partially Covered
+
+class PartiallyCoveredClass
+  def covered_method
+  end
+
+  if false
+    def non_covered_method
+    end
+  end
+end

data/test/fixtures/file_report/methods_covered.rb

@@ -0,0 +1,38 @@
+# Methods Covered
+
+
+class CoveredMethod
+  # Methods with no significant lines of code. These methods are excepted from reported not covered.
+  def emptyMethod
+  end
+
+  def emptyMethod_BlankLine
+
+  end
+
+  def emptyMethod_Comments
+    # first comment
+  end
+
+# Methods with code in them
+  def method_Code
+    method = "method_Code"
+  end
+
+  def method_Comment_Code
+    # first comment
+
+    method = "method_Comment_Code"
+  end
+
+  def method_BlankLine_Code
+
+    method = "method_BlankLine_Code"
+  end
+
+# Methods that are not covered, just for sakes
+  def non_covered_method
+    method = "I am not covered"
+  end
+end
+

data/test/fixtures/file_report/methods_not_covered.rb

@@ -0,0 +1,39 @@
+# Methods Covered
+
+
+class NonCoveredMethod
+  if false
+    def emptyMethod
+    end
+
+    def emptyMethod_BlankLine
+
+    end
+
+    def emptyMethod_Comments
+      # first comment
+    end
+  end
+
+  # Methods with code in them
+  def method_Code
+    method = "method_Code"
+  end
+
+  def method_Comment_Code
+    # first comment
+
+    method = "method_Comment_Code"
+  end
+
+  def method_BlankLine_Code
+
+    method = "method_BlankLine_Code"
+  end
+
+  # Methods that are covered, just for sakes
+  def covered_method
+    method = "I am covered"
+  end
+end
+

data/test/fixtures/file_report/methods_partially_covered.rb

@@ -0,0 +1,13 @@
+# Methods Partially Covered
+
+
+class PartiallyCoveredMethod
+  def partially_covered_method(flag)
+    if flag
+      method = "yes"
+    else
+      method = "no"
+    end
+  end
+end
+

data/test/fixtures/line enhancer/line_enhancer_fixture.rb

@@ -0,0 +1 @@
+line = "dummy"

data/test/helper.rb

@@ -0,0 +1,19 @@
+require 'bundler/setup'
+require 'test/unit'
+require 'shoulda'
+require 'simplecov'
+require "simplecov/reports"
+require 'simplecov-html-extended'
+
+SimpleCov.coverage_dir('tmp/coverage')
+
+class SimpleCov::Formatter::MergedFormatter
+  def format(result)
+    SimpleCov::Formatter::HTMLFormatter.new.format(result)
+  end
+end
+
+SimpleCov.formatter = SimpleCov::Formatter::MergedFormatter
+
+
+

data/test/test_all_reports.rb

@@ -0,0 +1,35 @@
+require_relative 'helper'
+
+SimpleCov.start do
+  use_merging true
+  merge_timeout 3600
+
+  add_report :type => SimpleCov::Configuration::ReportTypes::ItemsMissingCoverage::Api
+  add_report :type => SimpleCov::Configuration::ReportTypes::ItemsMissingCoverage::Class
+  add_report :type => SimpleCov::Configuration::ReportTypes::ItemsMissingCoverage::Method
+  add_report :type => SimpleCov::Configuration::ReportTypes::ItemsMissingCoverage::Configure
+  add_report(:type => SimpleCov::Configuration::ReportTypes::Author,
+             :sub_types => [
+               SimpleCov::Configuration::ReportTypes::Author::BestAuthor,
+               SimpleCov::Configuration::ReportTypes::Author::AuthorStats
+             ],
+             :best_authors_count => 3)
+end
+
+# Tests the scenario where all possible reports are configured
+# Tests whether all the reports are generated
+#TODO (rkonda, 06/27/2013): Add more tests
+class TestAllReports < Test::Unit::TestCase
+  context "tests: " do
+    setup do
+      @result = SimpleCov.result.format!
+    end
+
+    context "reports" do
+      should "be of the expected number" do
+        assert_equal 5, @result.reports.count, "There should be 5 reports"
+      end
+    end
+  end # context "tests: " do
+
+end

data/test/test_author_stats.rb

@@ -0,0 +1,89 @@
+require_relative 'helper'
+
+SimpleCov.start do
+  use_merging true
+  merge_timeout 3600
+
+  add_report(:type => SimpleCov::Configuration::ReportTypes::Author,
+             :sub_types => [
+               SimpleCov::Configuration::ReportTypes::Author::AuthorStats
+             ]
+  )
+end
+
+# Execute code to get coverage
+COVERAGE = "cover"
+require_relative "fixtures/author_report/author_stats_file1"
+require_relative "fixtures/author_report/author_stats_file2"
+
+
+class TestAuthorStatsReport < Test::Unit::TestCase
+  context "author report" do
+    context "/author stats report" do
+      setup do
+        @result = SimpleCov.result.format!
+        @author_reports = @result.reports[0][:sub_reports]
+      end
+
+      should "exist" do
+        assert_equal 1, @author_reports.count, "best author report should be the only report"
+      end
+
+      should "have all authors" do
+        authors = @author_reports[0][:items].keys
+        expected_authors = ["AuthorTesterOne", "AuthorTesterTwo", "AuthorTesterThree", "AuthorTesterFour"]
+        assert_equal expected_authors.sort, authors.sort, "Authors should be the expected ones"
+      end
+
+      should "match files reported per author" do
+        files = @author_reports[0][:items]["AuthorTesterOne"][:files].keys.map(&:filename).
+          collect{ |item| item.slice(/simplecov-reports(.*)/, 1) }
+        expected_files = ["/test/fixtures/author_report/author_stats_file1.rb",
+                          "/test/fixtures/author_report/author_stats_file2.rb"]
+
+        assert_equal expected_files, files,
+                     "AuthorTesterOne's authored files don't match"
+
+        files = @author_reports[0][:items]["AuthorTesterTwo"][:files].keys.map(&:filename).
+          collect{ |item| item.slice(/simplecov-reports(.*)/, 1) }
+        expected_files = ["/test/fixtures/author_report/author_stats_file1.rb"]
+
+        assert_equal expected_files, files,
+                     "AuthorTesterTwo's authored files don't match"
+
+        files = @author_reports[0][:items]["AuthorTesterThree"][:files].keys.map(&:filename).
+          collect{ |item| item.slice(/simplecov-reports(.*)/, 1) }
+        expected_files = ["/test/fixtures/author_report/author_stats_file2.rb"]
+
+        assert_equal expected_files, files,
+                     "AuthorTesterThree's authored files don't match"
+
+        files = @author_reports[0][:items]["AuthorTesterFour"][:files].keys.map(&:filename).
+          collect{ |item| item.slice(/simplecov-reports(.*)/, 1) }
+        expected_files = []
+
+        assert_equal expected_files, files,
+                     "AuthorTesterFour's authored files don't match"
+      end
+
+      should "match the coverage report per author per file" do
+        author_report = @author_reports[0][:items]["AuthorTesterOne"][:files].values
+        expected_author_report = [{:covered=>3, :missed=>7, :total=>10, :coverage=>30.0},
+                                  {:covered=>1, :missed=>9, :total=>10, :coverage=>10.0}]
+        assert_equal expected_author_report, author_report, "AuthorTesterOne's author report should match"
+
+        author_report = @author_reports[0][:items]["AuthorTesterTwo"][:files].values
+        expected_author_report = [{:covered=>1, :missed=>3, :total=>4, :coverage=>25.0}]
+        assert_equal expected_author_report, author_report, "AuthorTesterTwo's author report should match"
+
+        author_report = @author_reports[0][:items]["AuthorTesterThree"][:files].values
+        expected_author_report = [{:covered=>4, :missed=>0, :total=>4, :coverage=>100.0}]
+        assert_equal expected_author_report, author_report, "AuthorTesterThree's author report should match"
+
+        author_report = @author_reports[0][:items]["AuthorTesterFour"][:files].values
+        expected_author_report = []
+        assert_equal expected_author_report, author_report, "AuthorTesterFour's author report should match"
+      end
+    end
+  end # context "author report" do
+end # class TestAuthorReports

data/test/test_best_author_stage1.rb

@@ -0,0 +1,75 @@
+require_relative 'helper'
+
+SimpleCov.start do
+  use_merging true
+  merge_timeout 3600
+
+  add_report(:type => SimpleCov::Configuration::ReportTypes::Author,
+             :sub_types => [
+               SimpleCov::Configuration::ReportTypes::Author::BestAuthor
+             ],
+             :best_authors_count => 1)
+end
+
+# Execute code to get coverage
+COVERAGE = "cover"
+require_relative "fixtures/author_report/best_author_tolerance"
+
+# best_author_tolerance is 50%
+# best_author_cutoff is 15%
+# best_author_count is 3
+# Author: Rajesh Konda has 10% coverage with 100 lines of code
+# Author: AuthorTesterOne has 20% coverage with 70 lines of code
+# Author: AuthorTesterTwo has 30% coverage with 30 lines of code
+# Author: AuthorTesterThree has 40% coverage with 30 lines of code
+# Author: AuthorTesterFour has 50% coverage with 10 lines of code
+
+
+class TestBestAuthorReport < Test::Unit::TestCase
+  context "author report" do
+    context "/best author report" do
+      setup do
+        @result = SimpleCov.result.format!
+        @author_reports = @result.reports[0][:sub_reports]
+      end
+
+      context " when :best_authors_count=1" do
+        should "exist" do
+          assert_equal 1, @author_reports.count, "best author report should be the only report"
+        end
+
+        should "have authors in right order" do
+          authors = @author_reports[0][:items].keys
+          expected_authors = ["AuthorTesterOne", "Rajesh Konda"]
+          assert_equal expected_authors, authors, "Authors should be the expected ones"
+        end
+
+        should "match files reported per author" do
+          files = @author_reports[0][:items]["Rajesh Konda"][:files].keys.map(&:filename).
+                    collect{ |item| item.slice(/simplecov-reports(.*)/, 1) }
+          expected_files = ["/test/fixtures/author_report/best_author_tolerance.rb"]
+
+          assert_equal expected_files, files,
+                       "Rajesh Konda's authored files don't match"
+
+          files = @author_reports[0][:items]["AuthorTesterOne"][:files].keys.map(&:filename).
+            collect{ |item| item.slice(/simplecov-reports(.*)/, 1) }
+          expected_files = ["/test/fixtures/author_report/best_author_tolerance.rb"]
+
+          assert_equal expected_files, files,
+                       "AuthorTesterOne's authored files don't match"
+        end
+
+        should "match the coverage report per author per file" do
+          author_report = @author_reports[0][:items]["Rajesh Konda"][:files].values
+          expected_author_report = [{:covered=>10, :missed=>90, :total=>100, :coverage=>10.0}]
+          assert_equal expected_author_report, author_report, "Rajesh Konda's author report should match"
+
+          author_report = @author_reports[0][:items]["AuthorTesterOne"][:files].values
+          expected_author_report = [{:covered=>14, :missed=>56, :total=>70, :coverage=>20.0}]
+          assert_equal expected_author_report, author_report, "AuthorTesterOne's author report should match"
+        end
+      end
+    end # context "/best author report" do
+  end # context "author report" do
+end # class TestAuthorReports