Feature/review coverage (#603) (#604)

* Add review coverage model

* Fix review coverage tests

* Add review coverage to the dashboard

* Adjust review coverage creation and error handling

Author: gonzaM

app/controllers/development_metrics_controller.rb

@@ -52,6 +52,7 @@ def build_overall_calculations(entity_name)
     @merge_time_success_rate = merge_time[:success_rate]
     @merge_time_avg = merge_time[:avg]
     @pull_request_size_avg = @pull_request_size[key].first[:avg]
+    @review_coverage_avg = @review_coverage[key].first[:avg] if @review_coverage.present?
   end
 
   def build_metrics(entity_id, entity_name)
@@ -60,6 +61,7 @@ def build_metrics(entity_id, entity_name)
                                                      .call(entity_id, @from, @to)
     @merge_time = metrics[:merge_time]
     @pull_request_size = metrics[:pull_request_size]
+    @review_coverage = metrics[:review_coverage]
   end
 
   def build_product_metrics(entity_id, entity_name)
@@ -84,6 +86,7 @@ def build_metrics_definitions
     @review_turnaround_definition = MetricDefinition.find_by(code: :review_turnaround)
     @merge_time_definition = MetricDefinition.find_by(code: :merge_time)
     @pull_request_size_definition = MetricDefinition.find_by(code: :pull_request_size)
+    @review_coverage_definition = MetricDefinition.find_by(code: :review_coverage)
   end
 
   def set_metrics_to_show

app/controllers/pull_requests/review_coverage_prs_repository_controller.rb

@@ -0,0 +1,7 @@
+module PullRequests
+  class ReviewCoveragePrsRepositoryController < PullRequestsController
+    def repository
+      Builders::Distribution::PullRequests::ReviewCoverageRepository
+    end
+  end
+end

app/helpers/modal_see_detail_helper.rb

@@ -14,6 +14,10 @@ def build_bar_chart_modal(repository_name, from, to)
       'pull-request-size': {
         url: repository_pull_request_size_prs_repository_index_path(repository_name, metrics),
         metric: 'lines'
+      },
+      'review-coverage': {
+        url: repository_review_coverage_prs_repository_index_path(repository_name, metrics),
+        metric: '%'
       }
     }
 

app/models/events/pull_request.rb

@@ -52,6 +52,7 @@ class PullRequest < ApplicationRecord
                                      dependent: :destroy, inverse_of: :pull_request
     has_many :events, as: :handleable, dependent: :destroy
     has_one :merge_time, dependent: :destroy
+    has_one :review_coverage, dependent: :destroy
 
     validates :state, inclusion: { in: states.keys }
     validates :github_id,
@@ -65,13 +66,5 @@ class PullRequest < ApplicationRecord
               :locked,
               inclusion: { in: [true, false] }
     validates :github_id, uniqueness: true, strict: PullRequests::GithubUniquenessError
-
-    after_validation :build_merge_time, on: :update, if: :merged_at_changed?
-
-    private
-
-    def build_merge_time
-      Builders::MergeTime.call(self)
-    end
   end
 end

app/models/metric_definition.rb

@@ -19,7 +19,8 @@ class MetricDefinition < ApplicationRecord
                defect_escape_rate: 'defect_escape_rate',
                pull_request_size: 'pull_request_size',
                development_cycle: 'development_cycle',
-               planned_to_done: 'planned_to_done' }
+               planned_to_done: 'planned_to_done',
+               review_coverage: 'review_coverage' }
 
   validates :code, uniqueness: true
   validates :name, presence: true, uniqueness: true

app/models/review_coverage.rb

@@ -0,0 +1,32 @@
+# == Schema Information
+#
+# Table name: review_coverages
+#
+#  id                        :bigint           not null, primary key
+#  coverage_percentage       :decimal(, )      not null
+#  deleted_at                :datetime
+#  files_with_comments_count :integer          not null
+#  total_files_changed       :integer          not null
+#  created_at                :datetime         not null
+#  updated_at                :datetime         not null
+#  pull_request_id           :bigint           not null
+#
+# Indexes
+#
+#  index_review_coverages_on_pull_request_id  (pull_request_id)
+#
+# Foreign Keys
+#
+#  fk_rails_...  (pull_request_id => events_pull_requests.id)
+#
+
+class ReviewCoverage < ApplicationRecord
+  acts_as_paranoid
+
+  belongs_to :pull_request, class_name: 'Events::PullRequest'
+
+  validates :total_files_changed, :files_with_comments_count, presence: true
+  validates :pull_request_id, uniqueness: true
+  validates :total_files_changed, :files_with_comments_count,
+            numericality: { greater_than_or_equal_to: 0 }
+end

app/services/action_handlers/pull_request.rb

@@ -16,7 +16,11 @@ def open
     end
 
     def merged
-      @entity.update!(merged_at: Time.current)
+      ActiveRecord::Base.transaction do
+        @entity.update!(merged_at: Time.current)
+        Builders::MergeTime.call(@entity)
+        Builders::ReviewCoverage.call(@entity)
+      end
     end
 
     def closed

app/services/builders/chartkick/development_metrics.rb

@@ -71,7 +71,8 @@ def entities_by_metric
           metrics = {
             review_turnaround: %w[repository users_repository repository_distribution],
             merge_time: %w[repository users_repository repository_distribution],
-            pull_request_size: %w[repository_distribution]
+            pull_request_size: %w[repository_distribution],
+            review_coverage: %w[repository repository_distribution]
           }
           metrics
         end

app/services/builders/chartkick/repository_distribution_data_metrics/review_coverage.rb

@@ -0,0 +1,23 @@
+module Builders
+  module Chartkick
+    module RepositoryDistributionDataMetrics
+      class ReviewCoverage
+        def retrieve_records(entity_id:, time_range:)
+          ::ReviewCoverage
+            .joins(pull_request: :repository)
+            .where(repositories: { id: entity_id })
+            .where(events_pull_requests: { merged_at: time_range })
+            .where.not(events_pull_requests: { owner: User.ignored_users })
+        end
+
+        def resolve_interval(entity)
+          Metrics::IntervalResolver::Percentage.call(entity.coverage_percentage * 100)
+        end
+
+        def value_for_average(entity)
+          entity.coverage_percentage * 100
+        end
+      end
+    end
+  end
+end

app/services/builders/distribution/pull_requests/pull_request_size_repository.rb

@@ -26,6 +26,7 @@ def pr_sizes
                                              .where.not(
                                                events_pull_requests: { html_url: nil }
                                              )
+                                             .where.not(owner: User.ignored_users)
                                              .where.not(size: nil)
                                              .order(:size)
         end