simplecov-reports 0.0.4.ooyala

data/lib/simplecov/reports/file_report.rb

@@ -0,0 +1,97 @@
+#
+# FileReport gives statistics of different types of elements based on analyzing the code in files.
+# Stats are generated per file, but also summarized for the element of interest.
+# The elements are for example, 'api' calls. 'class'es and 'method's.
+#
+require "simplecov"
+
+module SimpleCov
+  class FileReport < Report
+    BLOCK_END_REGEX = /^(?<indent>\s*)end\s*$/
+
+    attr_reader :report_type, :title, :options
+
+    def initialize(options)
+      @options = options
+      @report_type = options[:report_type]
+      case @report_type
+        when :api
+          @block_start_regex = /^(?<indent>\s*)(get|put|post|delete|patch|options|before) \"/
+          @title = "API methods missing coverage"
+        when :class
+          @block_start_regex = /^(?<indent>\s*)(class|module) /
+          @title = "Classes missing coverage"
+        when :method
+          @block_start_regex = /^(?<indent>\s*)(def) /
+          @title = "Methods missing coverage"
+        when :configure
+          @block_start_regex = /^(?<indent>\s*)(configure) /
+          @title = "Configure methods missing coverage"
+      end
+    end
+
+    def generate(files)
+      @report = {
+        :type => {
+          :main => :file_report,
+          :subtype => @report_type
+        },
+        :title => @title,
+        :items => ItemMap.new
+      }
+
+      files.each do |file|
+        @report[:items][file] = SimpleCov::SourceFile::LineList.new
+
+        file.lines.each_with_index do |line, line_number|
+          line = file.lines[line_number]
+          method_started = @block_start_regex.match(line.source)
+          if method_started && line.missed?
+            @report[:items][file] << line
+            next
+          end
+
+          next_line = file.lines[line_number + 1]
+          missed_next_line = method_started && next_line.missed?
+          if method_started && missed_next_line
+            @report[:items][file] << line
+            next
+          end
+
+          method_ends_on_same_line = /\bend\s*$/.match(line.source)
+          if method_started && method_ends_on_same_line
+            # line.source += " *"
+            next
+          end
+
+          next_line = file.lines[line_number + 1]
+          next_line_excluded = method_started && next_line.never?
+          if method_started && next_line_excluded
+            method_start_line = line
+            begin
+              line_number += 1
+              line = file.lines[line_number]
+              method_ended = BLOCK_END_REGEX.match(line.source)
+              method_ended = method_ended && method_started["indent"].length >= method_ended["indent"].length
+              next_line_included = !line.never?
+            end until method_ended || next_line_included
+
+            missed_next_line = line.missed?
+            if missed_next_line
+              # line.source += " **"
+              @report[:items][file] << method_start_line
+            end
+          end
+        end # file.lines.each
+
+        @report[:items].delete(file) if @report[:items][file].empty?
+      end # result.files.each
+
+      @report
+    end # generate(files)
+
+  end # class FileReport
+
+end # module SimpleCov
+
+SimpleCov::Report.register(:file_report, SimpleCov::FileReport)

data/lib/simplecov/reports/version.rb

@@ -0,0 +1,5 @@
+module Simplecov
+  module Reports
+    VERSION = "0.0.4.ooyala"
+  end
+end

data/lib/simplecov/source_file.rb

@@ -0,0 +1,39 @@
+require "ooyala-grit"
+require "simplecov"
+
+module SimpleCov
+  class SourceFile
+    class Line
+      # Author of the line
+      attr_accessor :author
+      # Authored date
+      attr_accessor :date
+    end
+  end
+
+  SimpleCov::SourceFile.add_line_enhancer(lambda do |lines, filename|
+      author_info = []
+      root_dir = Grit::Git.new(Dir.pwd).native(:rev_parse, {:base => false}, "--show-toplevel").chomp
+      repo = Grit::Repo.new(root_dir)
+      begin
+        blame = repo.blame(File.realdirpath(filename), nil, {:base => false})
+        blame.lines.each_with_index do |blame_line, line_number|
+          author_info << { :author => blame_line.commit.author.name, :date => blame_line.commit.date }
+        end
+      rescue Exception => e
+        puts "`git blame` on \'#{filename}\' encountered exception: #{e.message}. Skipping adding author info."
+      end
+
+      # Initialize lines
+      lines.each_with_index do |line, i|
+        line_author_info = i < author_info.length ? author_info[i] : nil
+        if !line_author_info.nil?
+          line.author = line_author_info[:author]
+          line.date = line_author_info[:date]
+        end
+      end
+    end
+  )
+
+end
+

data/simplecov-reports.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simplecov/reports/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "simplecov-reports"
+  spec.version       = Simplecov::Reports::VERSION
+  spec.authors       = ["Rajesh Konda"]
+  spec.email         = ["rkonda@ooyala.com"]
+  spec.description   = "Contains code that enhances simplecov, and simplecov-html gems with FileReport and AuthorReport"
+  spec.summary       = "Reports added to simplecov and simplecov-html: FileReport and AuthorReport"
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "pry-nav"
+  spec.add_development_dependency "shoulda"
+
+  spec.add_dependency "ooyala-grit"
+  spec.add_dependency "simplecov", "0.9.3.ooyala"
+  spec.add_dependency "simplecov-html", "0.7.6.ooyala"
+end

data/test/fixtures/author_report/author_stats_file1.rb

@@ -0,0 +1,23 @@
+# author=="AuthorTesterOne"
+# (3/10) 30% coverage
+if COVERAGE == "cover"
+  line = "Author-1 1"
+  line = "Author-1 2"
+else
+  line = "Author-1 3"
+  line = "Author-1 4"
+  line = "Author-1 5"
+  line = "Author-1 6"
+  line = "Author-1 7"
+  line = "Author-1 8"
+  line = "Author-1 9"
+end
+
+# author=="AuthorTesterTwo"
+# (1/4) 25% coverage
+if COVERAGE == "cover"
+else
+  line = "Author-2 1"
+  line = "Author-2 2"
+  line = "Author-2 3"
+end

data/test/fixtures/author_report/author_stats_file2.rb

@@ -0,0 +1,26 @@
+# author=="AuthorTesterOne"
+# (1/10) 10% coverage
+if COVERAGE == "cover"
+else
+  line = "Author-1 1"
+  line = "Author-1 2"
+  line = "Author-1 3"
+  line = "Author-1 4"
+  line = "Author-1 5"
+  line = "Author-1 6"
+  line = "Author-1 7"
+  line = "Author-1 8"
+  line = "Author-1 9"
+end
+
+# author=="AuthorTesterThree"
+# (4/4) 100% coverage
+if COVERAGE == "cover"
+  line = "Author-3 1"
+  line = "Author-3 2"
+  line = "Author-3 3"
+else
+end
+
+# author=="AuthorTesterFour"
+# (0/0) coverage is NA

data/test/fixtures/author_report/best_author_tolerance.rb

@@ -0,0 +1,264 @@
+# author=="Rajesh Konda"
+# (10/100) 10% coverage
+if COVERAGE == "cover"
+  line = "Rajesh 1"
+  line = "Rajesh 2"
+  line = "Rajesh 3"
+  line = "Rajesh 4"
+  line = "Rajesh 5"
+  line = "Rajesh 6"
+  line = "Rajesh 7"
+  line = "Rajesh 8"
+  line = "Rajesh 9"
+else
+  line = "Rajesh 10"
+  line = "Rajesh 11"
+  line = "Rajesh 12"
+  line = "Rajesh 13"
+  line = "Rajesh 14"
+  line = "Rajesh 15"
+  line = "Rajesh 16"
+  line = "Rajesh 17"
+  line = "Rajesh 18"
+  line = "Rajesh 19"
+  line = "Rajesh 20"
+  line = "Rajesh 21"
+  line = "Rajesh 22"
+  line = "Rajesh 23"
+  line = "Rajesh 24"
+  line = "Rajesh 25"
+  line = "Rajesh 26"
+  line = "Rajesh 27"
+  line = "Rajesh 28"
+  line = "Rajesh 29"
+  line = "Rajesh 30"
+  line = "Rajesh 31"
+  line = "Rajesh 32"
+  line = "Rajesh 33"
+  line = "Rajesh 34"
+  line = "Rajesh 35"
+  line = "Rajesh 36"
+  line = "Rajesh 37"
+  line = "Rajesh 38"
+  line = "Rajesh 39"
+  line = "Rajesh 40"
+  line = "Rajesh 41"
+  line = "Rajesh 42"
+  line = "Rajesh 43"
+  line = "Rajesh 44"
+  line = "Rajesh 45"
+  line = "Rajesh 46"
+  line = "Rajesh 47"
+  line = "Rajesh 48"
+  line = "Rajesh 49"
+  line = "Rajesh 50"
+  line = "Rajesh 51"
+  line = "Rajesh 52"
+  line = "Rajesh 53"
+  line = "Rajesh 54"
+  line = "Rajesh 55"
+  line = "Rajesh 56"
+  line = "Rajesh 57"
+  line = "Rajesh 58"
+  line = "Rajesh 59"
+  line = "Rajesh 60"
+  line = "Rajesh 61"
+  line = "Rajesh 62"
+  line = "Rajesh 63"
+  line = "Rajesh 64"
+  line = "Rajesh 65"
+  line = "Rajesh 66"
+  line = "Rajesh 67"
+  line = "Rajesh 68"
+  line = "Rajesh 69"
+  line = "Rajesh 70"
+  line = "Rajesh 71"
+  line = "Rajesh 72"
+  line = "Rajesh 73"
+  line = "Rajesh 74"
+  line = "Rajesh 75"
+  line = "Rajesh 76"
+  line = "Rajesh 77"
+  line = "Rajesh 78"
+  line = "Rajesh 79"
+  line = "Rajesh 80"
+  line = "Rajesh 81"
+  line = "Rajesh 82"
+  line = "Rajesh 83"
+  line = "Rajesh 84"
+  line = "Rajesh 85"
+  line = "Rajesh 86"
+  line = "Rajesh 87"
+  line = "Rajesh 88"
+  line = "Rajesh 89"
+  line = "Rajesh 90"
+  line = "Rajesh 91"
+  line = "Rajesh 92"
+  line = "Rajesh 93"
+  line = "Rajesh 94"
+  line = "Rajesh 95"
+  line = "Rajesh 96"
+  line = "Rajesh 97"
+  line = "Rajesh 98"
+  line = "Rajesh 99"
+end
+
+# author=="AuthorTesterOne"
+# (14/70) 20% coverage
+if COVERAGE == "cover"
+  line = "Author-1 101"
+  line = "Author-1 102"
+  line = "Author-1 103"
+  line = "Author-1 104"
+  line = "Author-1 105"
+  line = "Author-1 106"
+  line = "Author-1 107"
+  line = "Author-1 108"
+  line = "Author-1 109"
+  line = "Author-1 110"
+  line = "Author-1 111"
+  line = "Author-1 112"
+  line = "Author-1 113"
+else
+  line = "Author-1 114"
+  line = "Author-1 115"
+  line = "Author-1 116"
+  line = "Author-1 117"
+  line = "Author-1 118"
+  line = "Author-1 119"
+  line = "Author-1 120"
+  line = "Author-1 121"
+  line = "Author-1 122"
+  line = "Author-1 123"
+  line = "Author-1 124"
+  line = "Author-1 125"
+  line = "Author-1 126"
+  line = "Author-1 127"
+  line = "Author-1 128"
+  line = "Author-1 129"
+  line = "Author-1 130"
+  line = "Author-1 131"
+  line = "Author-1 132"
+  line = "Author-1 133"
+  line = "Author-1 134"
+  line = "Author-1 135"
+  line = "Author-1 136"
+  line = "Author-1 137"
+  line = "Author-1 138"
+  line = "Author-1 139"
+  line = "Author-1 140"
+  line = "Author-1 141"
+  line = "Author-1 142"
+  line = "Author-1 143"
+  line = "Author-1 144"
+  line = "Author-1 145"
+  line = "Author-1 146"
+  line = "Author-1 147"
+  line = "Author-1 148"
+  line = "Author-1 149"
+  line = "Author-1 150"
+  line = "Author-1 151"
+  line = "Author-1 152"
+  line = "Author-1 153"
+  line = "Author-1 154"
+  line = "Author-1 155"
+  line = "Author-1 156"
+  line = "Author-1 157"
+  line = "Author-1 158"
+  line = "Author-1 159"
+  line = "Author-1 160"
+  line = "Author-1 161"
+  line = "Author-1 162"
+  line = "Author-1 163"
+  line = "Author-1 164"
+  line = "Author-1 165"
+  line = "Author-1 166"
+  line = "Author-1 167"
+  line = "Author-1 168"
+  line = "Author-1 169"
+end
+
+# author=="AuthorTesterTwo"
+# (9/30) 30% coverage
+if COVERAGE == "cover"
+  line = "Author-2 201"
+  line = "Author-2 202"
+  line = "Author-2 203"
+  line = "Author-2 204"
+  line = "Author-2 205"
+  line = "Author-2 206"
+  line = "Author-2 207"
+  line = "Author-2 208"
+else
+  line = "Author-2 209"
+  line = "Author-2 210"
+  line = "Author-2 211"
+  line = "Author-2 212"
+  line = "Author-2 213"
+  line = "Author-2 214"
+  line = "Author-2 215"
+  line = "Author-2 216"
+  line = "Author-2 217"
+  line = "Author-2 218"
+  line = "Author-2 219"
+  line = "Author-2 220"
+  line = "Author-2 221"
+  line = "Author-2 222"
+  line = "Author-2 223"
+  line = "Author-2 224"
+  line = "Author-2 225"
+  line = "Author-2 226"
+  line = "Author-2 227"
+  line = "Author-2 228"
+  line = "Author-2 229"
+end
+
+# author=="AuthorTesterThree"
+# (12/30) 40% coverage
+if COVERAGE == "cover"
+  line = "Author-3 301"
+  line = "Author-3 302"
+  line = "Author-3 303"
+  line = "Author-3 304"
+  line = "Author-3 305"
+  line = "Author-3 306"
+  line = "Author-3 307"
+  line = "Author-3 308"
+  line = "Author-3 309"
+  line = "Author-3 310"
+  line = "Author-3 311"
+else
+  line = "Author-3 312"
+  line = "Author-3 313"
+  line = "Author-3 314"
+  line = "Author-3 315"
+  line = "Author-3 316"
+  line = "Author-3 317"
+  line = "Author-3 318"
+  line = "Author-3 319"
+  line = "Author-3 320"
+  line = "Author-3 321"
+  line = "Author-3 322"
+  line = "Author-3 323"
+  line = "Author-3 324"
+  line = "Author-3 325"
+  line = "Author-3 326"
+  line = "Author-3 327"
+  line = "Author-3 328"
+  line = "Author-3 329"
+end
+
+# author=="AuthorTesterFour"
+# (5/10) 50% coverage
+if COVERAGE == "cover"
+  line = "Author-4 401"
+  line = "Author-4 402"
+  line = "Author-4 403"
+  line = "Author-4 404"
+else
+  line = "Author-4 405"
+  line = "Author-4 406"
+  line = "Author-4 407"
+  line = "Author-4 408"
+  line = "Author-4 409"
+end