simplecov-reports 0.0.4.ooyala

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YmU1NzU3NjE3NmZjNGExMTE4MWM2ZWJhOGJhMmNkMjY2Nzk5ZDA3Nw==
+  data.tar.gz: !binary |-
+    ZWY3ODQ0MjE2MTk2MjBmMzI0NmMzODU3MzFjMjZiZjY0OWE4ZDcyNg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NTQ3ZjdlOTVkNWVlYTc2ZWJiYTRiNzAwMDE2NWIwNzY1NmZjMWJkNmJjOWIz
+    ZmEzOWNlNzI1ZjE5OWMyYjFhYTA4YTQwYzgzMWY5MDFmNWMzODNlNDgwM2Nk
+    ZWQzYjEwZGU3ZDA1Mjk4MmJiZmQ1ZjY4ODYyMzE4ZWExNzc3ODM=
+  data.tar.gz: !binary |-
+    MzRjODIwZDFmNTMwMzZhYTIzYjQwNDA3NTNlYTg1Y2QzYzRmZjEwMzM3NjZm
+    OGJkNjJhOWQ5ZDg3OTgzMzhlYmFkZTAzMWMxN2Y5ZjcwZTM2NDgzNGFjMGI1
+    YmQ1NzQwZmM3M2E4YjhiZDAyY2Q0OGZhYWNmODBmMTM1N2ZjYmI=

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea/

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in simplecov-reports.gemspec
+gemspec
+
+# gem "simplecov", :path => "/Users/rkonda/repos/qa/tools/simplecov"
+# gem "simplecov-html", :path => "/Users/rkonda/repos/qa/tools/simplecov-html"

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Rajesh Konda
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,66 @@
+# Simplecov::Reports
+
+This gem provides author and file analysis based reports to be generated when simplecov generates code
+coverage reports.
+
+Author reports include 'best author' and 'author stats'. File analysis based reports include 'api', 'class',
+'method' and 'configure' coverage reports.
+
+'api' coverage report gives statistics about the api methods (as specified using Sinatra) that are missing
+coverage. 'class' coverage report gives statistics about the classes that are missing coverage. 'method'
+coverage report gives statistics about all the methods/functions that are missing coverage. 'configure'
+coverage report gives statistics about all the 'configure' blocks (as specified using Sinatra) that are
+missing coverage.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'simplecov-reports'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simplecov-reports
+
+## Usage
+
+* require the gem in your .simplecov file
+  
+    `require "simplecov/reports"`
+
+* specify reports you would like to generate, eg.,
+
+```ruby
+    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 => 4)
+```
+
+### Author reports configuration
+
+The following options can be passed to the Author report as seen in the example above.
+
+* `:best-authors-count` :   The minimum number of authors to show in the best authors list as long as their coverage satisfies `best-author-cutoff` (default: 3).
+* `:best-author-tolerance` :   Percentage value that limits how authors are selected to show in best authors list. Given m, the most number of lines written by any author, this value v, is the percentage of m, that is a normal cutoff for choosing the best authors. All the authors that have written `v/100 * m` or more lines of code are selected (default: 50.0)  
+* `:best-author-cutoff` :   Percentage value that limits how authors are selected to show in best authors list. Given m, the most number of lines written by any author, this value v, is the percentage of m, that is the absolute cutoff for choosing the best authors. All the authors that have written `v/100 * m` or more lines of code are selected, unless the 'best_author_count' is reached (default: 15.0)  
+* `:author-report-from` :   Starting date from which authoring is considered, for author stats reports. Format: YYYY-MM-DD HH:MM:SS (-/+)HHMM (default: 1900-12-31 00:00:00 -0000)  
+* `:author-report-to` :   Ending date to which authoring is considered, for author stats reports. Format: YYYY-MM-DD HH:MM:SS (-/+)HHMM (default: 2025-12-31 00:00:00 -0000)  
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,73 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+
+task :test => [
+  "test_all_reports",
+  "test_best_author",
+  "test_file_reports",
+  "test_html_reports",
+  "test_line_enhancer"
+]
+
+Rake::TestTask.new(:test_all_reports) do |test|
+  test.libs << 'lib' << 'test'
+  test.test_files = FileList['test/test_all_reports.rb']
+  test.verbose = true
+end
+
+task :test_best_author => [
+  "test_best_author_stage1",
+  "test_best_author_stage2",
+  "test_best_author_stage3",
+  "test_best_author_stage4",
+  "test_best_author_stage5",
+]
+
+Rake::TestTask.new(:test_best_author_stage1) do |test|
+  test.libs << 'lib' << 'test'
+  test.test_files = FileList['test/test_best_author_stage1.rb']
+  test.verbose = true
+end
+
+Rake::TestTask.new(:test_best_author_stage2) do |test|
+  test.libs << 'lib' << 'test'
+  test.test_files = FileList['test/test_best_author_stage2.rb']
+  test.verbose = true
+end
+
+Rake::TestTask.new(:test_best_author_stage3) do |test|
+  test.libs << 'lib' << 'test'
+  test.test_files = FileList['test/test_best_author_stage3.rb']
+  test.verbose = true
+end
+
+Rake::TestTask.new(:test_best_author_stage4) do |test|
+  test.libs << 'lib' << 'test'
+  test.test_files = FileList['test/test_best_author_stage4.rb']
+  test.verbose = true
+end
+
+Rake::TestTask.new(:test_best_author_stage5) do |test|
+  test.libs << 'lib' << 'test'
+  test.test_files = FileList['test/test_best_author_stage5.rb']
+  test.verbose = true
+end
+
+Rake::TestTask.new(:test_file_reports) do |test|
+  test.libs << 'lib' << 'test'
+  test.test_files = FileList['test/test_file_reports.rb']
+  test.verbose = true
+end
+
+Rake::TestTask.new(:test_html_reports) do |test|
+  test.libs << 'lib' << 'test'
+  test.test_files = FileList['test/test_html_reports.rb']
+  test.verbose = true
+end
+
+Rake::TestTask.new(:test_line_enhancer) do |test|
+  test.libs << 'lib' << 'test'
+  test.test_files = FileList['test/test_line_enhancer.rb']
+  test.verbose = true
+end

data/lib/simplecov-html-extended.rb

@@ -0,0 +1,50 @@
+require "simplecov-html"
+
+
+module SimpleCov
+  module Formatter
+    class HTMLFormatter
+      def formatted_file_report(report)
+        case report[:type][:subtype]
+          when :api
+          when :class
+          when :method
+          when :configure
+        end
+        title = "#{report[:type]} #{report[:type][:subtype]}"
+        title_id = title.gsub(/^[^a-zA-Z]+/, '').gsub(/[^a-zA-Z0-9\-\_]/, '')
+        template('file_report').result(binding)
+      end
+
+      def formatted_author_report(report)
+        generated_source = ""
+        report[:sub_reports].each do |sub_report|
+          case sub_report[:type]
+            when :best_authors
+            when :author_stats
+          end
+          title = "#{report[:type]} #{sub_report[:type]}"
+          title_id = title.gsub(/^[^a-zA-Z]+/, '').gsub(/[^a-zA-Z0-9\-\_]/, '')
+          generated_source += template('author_report').result(binding)
+        end
+        generated_source
+      end
+    end
+
+    # Add report formatters
+    formatters = {
+      :file_report => :formatted_file_report,
+      :author_report => :formatted_author_report
+    }
+
+    HTMLFormatter.add_report_formatters(formatters)
+
+    # Author report would like to add author information to the source file view
+    HTMLFormatter::Views::SourceFile.add_line_attribute "author", lambda { |line| line.author }
+    HTMLFormatter::Views::SourceFile.add_line_attribute "authored_date", lambda { |line| line.date }
+
+    # Add the "views" directory in this gem as a path to finding erb files
+    gem_root = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+    HTMLFormatter.erb_files.append_path(File.join(gem_root, "views"))
+  end
+end

data/lib/simplecov/configuration.rb

@@ -0,0 +1,98 @@
+#
+# Enhancements to SimpleCov::Configuration for generating reports
+#
+require "simplecov"
+
+module SimpleCov::Configuration
+
+  module ReportTypes
+    module ItemsMissingCoverage
+      module Api
+        def self.get_specification(options)
+          { :type => :file_report,
+            :options => {
+              :report_type => :api
+            }
+          }
+        end
+      end
+
+      module Class
+        def self.get_specification(options)
+          { :type => :file_report,
+            :options => {
+              :report_type => :class
+            }
+          }
+        end
+      end
+
+      module Method
+        def self.get_specification(options)
+          { :type => :file_report,
+            :options => {
+              :report_type => :method
+            }
+          }
+        end
+      end
+
+      module Configure
+        def self.get_specification(options)
+          { :type => :file_report,
+            :options => {
+              :report_type => :configure
+            }
+          }
+        end
+      end
+    end # module ItemsMissingCoverage
+
+    module Author
+      def self.get_specification(options)
+        specification =
+        { :type => :author_report,
+          :options => {
+            :report_types => {},
+            :best_authors_count =>
+              options.has_key?(:best_authors_count) ? options[:best_authors_count] : 3,
+
+            :best_author_tolerance =>
+              options.has_key?(:best_author_tolerance) ? options[:best_author_tolerance] : 50.00,
+
+            :best_author_cutoff =>
+              options.has_key?(:best_author_cutoff) ? options[:best_author_cutoff] : 15.00,
+
+            :author_report_from =>
+              options.has_key?(:author_report_from) ? options[:author_report_from] : "1900-12-31 00:00:00 -0000",
+
+            :author_report_to =>
+              options.has_key?(:author_report_to) ? options[:author_report_to] : "2025-12-31 00:00:00 -0000"
+          }
+        }
+
+        options[:sub_types].each do |author_type|
+          specification = author_type.get_specification(options, specification)
+        end
+        specification
+      end
+
+      module BestAuthor
+        def self.get_specification(options, specification)
+          specification[:options][:report_types][:best_authors] = true
+          specification
+        end
+      end
+
+      module AuthorStats
+        def self.get_specification(options, specification)
+          specification[:options][:report_types][:author_stats] = true
+          specification
+        end
+      end
+    end # module Author
+
+  end # module ReportTypes
+
+end # module SimpleCov::Configuration
+

data/lib/simplecov/reports.rb

@@ -0,0 +1,5 @@
+require_relative "reports/author_report"
+require_relative "reports/file_report"
+require_relative "reports/version"
+require_relative "configuration"
+require_relative "../simplecov-html-extended"

data/lib/simplecov/reports/author_report.rb

@@ -0,0 +1,180 @@
+#
+# AuthorReport gives statistics on coverage mapped to the authors of the code.
+#
+
+require "algorithms"
+require "simplecov"
+require_relative "../source_file"
+
+module SimpleCov
+  class AuthorReport < Report
+    attr_reader :author_stats_mapping, :best_author_stats_mapping
+
+    def initialize(options)
+      @options = options
+      @report_types = options[:report_types]
+
+      # For each author, there is a mapping to a file/linesOfCode map
+      # 'file/linesOfCode map': mapping from file name to the stats about coverage for code
+      @author_stats_mapping = {}
+      @best_author_stats_mapping = {}
+    end
+
+    def generate(files)
+      compute_author_stats_mapping(files)
+      if @report_types[:best_authors]
+        compute_best_authors
+      end
+
+      @report = {
+        :type => {
+          :main => :author_report,
+        },
+        :sub_reports => []
+      }
+
+      if @report_types[:best_authors]
+        @report[:sub_reports] <<
+          {
+            :type => :best_authors,
+            :title => "Best Authors",
+            :items => @best_author_stats_mapping
+          }
+      end
+
+      if @report_types[:author_stats]
+        @report[:sub_reports] <<
+          {
+            :type => :author_stats,
+            :title => "Author Stats",
+            :items => @author_stats_mapping
+          }
+      end
+
+      @report
+    end
+
+    private
+    def compute_author_stats_mapping(files)
+      files.each do |file|
+        file.lines.each do |line|
+          next if line.author.nil? || line.date.nil?
+          next if(line.date < Time.parse(@options[:author_report_from]) ||
+            line.date > Time.parse(@options[:author_report_to]))
+
+          @author_stats_mapping[line.author] = @author_stats_mapping[line.author] || {}
+          files_stats = @author_stats_mapping[line.author][:files] =
+            @author_stats_mapping[line.author][:files] || ItemMap.new
+          files_stats[file] =
+            files_stats[file] || {}
+
+          if line.missed?
+            files_stats[file][:missed] =
+              files_stats[file][:missed] || 0
+            files_stats[file][:missed] += 1
+          elsif line.covered?
+            files_stats[file][:covered] =
+              files_stats[file][:covered] || 0
+            files_stats[file][:covered] += 1
+          end
+        end
+
+        @author_stats_mapping.keys.each do |author_name|
+          files_stats = @author_stats_mapping[author_name][:files]
+          next if files_stats[file].nil?
+          files_stats[file][:covered] =
+            files_stats[file][:covered] || 0
+          files_stats[file][:missed] =
+            files_stats[file][:missed] || 0
+
+          if files_stats[file][:covered] == 0 &&
+            files_stats[file][:missed] == 0
+            files_stats.delete(file)
+            next
+          end
+
+          files_stats[file][:total] =
+            files_stats[file][:covered] +
+              files_stats[file][:missed]
+          files_stats[file][:coverage] =
+            compute_coverage(files_stats[file])
+        end
+      end
+
+      @author_stats_mapping.keys.each do |author_name|
+        total_lines = 0
+        total_covered_lines = 0
+
+        author_stats = @author_stats_mapping[author_name]
+        author_stats[:files].keys.each do |file|
+          total_lines += author_stats[:files][file][:missed] +
+            author_stats[:files][file][:covered]
+          total_covered_lines += author_stats[:files][file][:covered]
+        end
+        author_stats[:total_coverage] = {}
+        author_stats[:total_coverage][:missed] = total_lines - total_covered_lines
+        author_stats[:total_coverage][:covered] = total_covered_lines
+        author_stats[:total_coverage][:total] =
+          author_stats[:total_coverage][:missed] +
+            author_stats[:total_coverage][:covered]
+        author_stats[:total_coverage][:coverage] =
+          compute_coverage(author_stats[:total_coverage])
+      end
+
+      @author_stats_mapping
+    end # compute_author_stats_mapping
+
+    def compute_coverage(file_stats)
+      return 0 if file_stats[:total] == 0
+      100 * file_stats[:covered].to_f / file_stats[:total]
+    end
+
+    def compute_best_authors
+      all_authors_queue = Containers::PriorityQueue.new
+      significant_authors_queue = Containers::PriorityQueue.new
+
+      @author_stats_mapping.keys.each do |author_name|
+        author_stats = @author_stats_mapping[author_name]
+        all_authors_queue.push(author_name, author_stats[:total_coverage][:total])
+      end
+
+      most_total_author = all_authors_queue.pop
+      return if most_total_author.nil?
+      significant_authors_queue.push(most_total_author,
+                                     @author_stats_mapping[most_total_author][:total_coverage][:coverage])
+      author_count = 1
+      while(author_name = all_authors_queue.pop) != nil &&
+        (
+          comparable( @author_stats_mapping[most_total_author][:total_coverage][:total],
+                    @author_stats_mapping[author_name][:total_coverage][:total]) ||
+          (
+            comparable_cutoff( @author_stats_mapping[most_total_author][:total_coverage][:total],
+                             @author_stats_mapping[author_name][:total_coverage][:total]) &&
+            author_count < @options[:best_authors_count]
+          )
+        )
+        significant_authors_queue.push(author_name,
+                                       @author_stats_mapping[author_name][:total_coverage][:coverage])
+        author_count += 1
+      end
+
+      author_count = 0
+      while (author_name = significant_authors_queue.pop) != nil
+        @best_author_stats_mapping[author_name] = @author_stats_mapping[author_name]
+        author_count += 1
+      end
+    end # compute_best_authors
+
+    def comparable(baseline, candidate)
+      candidate.to_f / baseline * 100 >= @options[:best_author_tolerance]
+    end
+
+    def comparable_cutoff(baseline, candidate)
+      candidate.to_f / baseline * 100 >= @options[:best_author_cutoff]
+    end
+
+  end # class AuthorReport
+
+end # module SimpleCov
+
+SimpleCov::Report.register(:author_report, SimpleCov::AuthorReport)