git_ownership_insights 2.0.2 → 2.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd5244ef2598407471bd2b55728b3c86cd48dfce9d4e6e2956b8b0ba2b0cf7ef
-  data.tar.gz: 9e21ea07a0455fa4792687ee4b0180c8d3dfee0889801f4846ccec8dec04f33c
+  metadata.gz: eb151470ef24ed0e040026ced3fb187e7cc02012ba0564dd062be4611b8219a8
+  data.tar.gz: 64b844eebef335350f0fa9fa939c0d338910b5a711652a8c9ba926a7caec3456
 SHA512:
-  metadata.gz: e07e63cba3b86fdedb333cf5063f559ac36d545fd04482f5339e3f939b4e207d8d99cbeb59e75832132c9501d74b73f251c5de343f76258ef1cbeadc8b06a2f5
-  data.tar.gz: 9abb98a4c09c8ad308b8fdd2bd591bbd8a291da716090047b26836c9d801780949fde3389348b17739ecd5fe436726bb6efcaab271bf67edf014def7b0c2b992
+  metadata.gz: f3ab9fa17feabb5b7774f61911ae34dd36605b412a365d3192fb76ec8585569635aa74121b31fb5fbbe67c77fe1b8e77f3983724839a4ff4261b0212f79ccf4d
+  data.tar.gz: 4a176d6a400141e7fda5697d53f54ad4f7d599ab1ec85178798ad70c0188a7145aa49a688be37ad3d7c0e33c20a77ae478211dd6a08718625e87de6f4d33455d

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2024-01-30 15:39:52 UTC using RuboCop version 1.60.0.
+# on 2024-01-30 16:41:47 UTC using RuboCop version 1.60.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -13,36 +13,36 @@ Lint/ConstantDefinitionInBlock:
   Exclude:
     - 'spec/git_ownership_insights_spec.rb'
 
-# Offense count: 4
+# Offense count: 6
 # Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
 Metrics/AbcSize:
-  Max: 181
+  Max: 92
 
 # Offense count: 4
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 # AllowedMethods: refine
 Metrics/BlockLength:
-  Max: 76
+  Max: 75
 
 # Offense count: 1
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ClassLength:
-  Max: 200
+  Max: 207
 
-# Offense count: 1
+# Offense count: 2
 # Configuration parameters: AllowedMethods, AllowedPatterns.
 Metrics/CyclomaticComplexity:
-  Max: 28
+  Max: 12
 
-# Offense count: 4
+# Offense count: 6
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 Metrics/MethodLength:
-  Max: 109
+  Max: 49
 
 # Offense count: 1
 # Configuration parameters: AllowedMethods, AllowedPatterns.
 Metrics/PerceivedComplexity:
-  Max: 29
+  Max: 12
 
 # Offense count: 1
 # Configuration parameters: AllowedConstants.
@@ -57,7 +57,7 @@ Style/MultilineBlockChain:
   Exclude:
     - 'lib/git_ownership_insights/git_ownership_insight.rb'
 
-# Offense count: 11
+# Offense count: 12
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns.
 # URISchemes: http, https

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    git_ownership_insights (2.0.2)
+    git_ownership_insights (2.0.4)
       date
       pry
 

data/lib/git_ownership_insights/git_ownership_insight.rb

@@ -53,6 +53,55 @@ class GitOwnershipInsights
     codeowners[best_match].split(' ')
   end
 
+  def handle_codeowners(file_team_map:)
+    puts "\n"
+    puts '*Code ownership data:*'
+    codeowners = read_codeowners_file
+
+    owners_data = Hash.new do |hash, key|
+      hash[key] = { directories: Hash.new do |h, k|
+        h[k] = { files: [] }
+      end, churn_count: 0 }
+    end
+
+    file_team_map.each do |file, count|
+      owners = find_owners(file, codeowners)
+      owners.each do |owner|
+        owners_data[owner][:churn_count] += count.last
+
+        dir_path = File.dirname(file)
+        owners_data[owner][:directories][dir_path][:files] << { name: File.basename(file), count: }
+      end
+    end
+
+    # Sort owners_data by total count in descending order
+    sorted_owners_data = owners_data.sort_by { |_, data| -data[:churn_count] }
+
+    # Take the last 5 elements
+    top_owners_data = sorted_owners_data.last(TOP_CONTRIBUTED_TEAMS.to_i)
+
+    converted_team_map = file_team_map.transform_keys { |key| File.basename(key) }
+
+    puts '   Codeownership data:'
+    top_owners_data.each do |owner, data|
+      puts "      #{owner.split('/').last}:\n         Total Count: #{data[:churn_count]}"
+      data[:directories].each do |dir, dir_data|
+        puts "            Directory: #{dir}\n               Top files:"
+        dir_data[:files].each do |file_data|
+          next if converted_team_map[File.basename(file_data[:name])].nil?
+
+          contributors = converted_team_map[file_data[:name]]&.first&.empty? ? ['Excluded contributor'] : converted_team_map[file_data[:name]].first
+          puts "                  #{File.basename(file_data[:name])} - #{file_data[:count].last} #{contributors}}"
+        end
+      end
+    end
+  end
+
+  def find_owner(file:)
+    codeowners = read_codeowners_file
+    find_owners(file, codeowners)
+  end
+
   def count_big_files(directory_path, size: BIG_FILE_SIZE)
     size = size.to_i
     # Get a list of all files in the specified directory
@@ -73,7 +122,7 @@ class GitOwnershipInsights
       count += 1 if lines_count > size
     end
 
-    puts "     *Current(\\*) total number of code files longer than #{size} lines:* #{count}"
+    puts "     *Current total number of code files longer than #{size} lines:* #{count}"
   end
 
   def count_hotspot_lines(files)
@@ -125,21 +174,12 @@ class GitOwnershipInsights
     `git log --pretty=format:"%s" --since="#{start_date}" --until="#{end_date}" --follow -- "#{file}"`
   end
 
-  def contribution_message
-    duration_in_days = @duration_in_days.to_i
+  def analyze_changed_files(uniq_code_files_with_changes:, start_date:, end_date:)
     all_teams = []
     cross_teams_count = 0
     single_ownership_teams_count = 0
     files_changed_by_many_teams = 0
     total_changes = 0
-    start_date = @begin_time.to_time.to_i - duration_in_days * 86_400 - 30 * 86_400
-    end_date = @begin_time.to_time.to_i - 30 * 86_400
-    git_ls = git_files(directory_path: @directory_path)
-    file_count = filter_existing_code_files(git_ls.split).count
-    all_files_with_changes = files_with_changes(directory_path: @directory_path, start_date:, end_date:).split.sort
-    code_files_with_changes = filter_existing_code_files(all_files_with_changes)
-    uniq_code_files_with_changes = code_files_with_changes.uniq
-
     file_team_map = {}
     uniq_code_files_with_changes.each do |file|
       filename = File.basename(file)
@@ -163,22 +203,35 @@ class GitOwnershipInsights
 
       puts "\n#{filename} [#{commit_count}]:#{teams}\n" if @debug
     end
+    [all_teams, cross_teams_count, single_ownership_teams_count, files_changed_by_many_teams, total_changes, file_team_map]
+  end
 
-    occurrences = all_teams.flatten.compact.tally
-    sorted_occurrences = occurrences.sort_by { |element, count| [-count, element] }
-    contributors = Hash[sorted_occurrences]
-
-    churn_count = file_team_map.values.map { |value| value[1] }.sum
-    hotspot_changes_percentage = (churn_count.to_f / total_changes) * 100
-
-    # Filter files based on extension and size
-    filtered_files = file_team_map.select do |file_path|
+  def filter_files(file_team_map:)
+    file_team_map.select do |file_path|
       next unless File.exist?(file_path)
 
       # Check if the file size is more than BIG_FILE_SIZE lines (excluding empty and commented lines)
       File.foreach(file_path).reject { |line| line.match(%r{^\s*(//|/\*.*\*/|\s*$)}) }.count > BIG_FILE_SIZE.to_i
     end
+  end
 
+  def contribution_message
+    duration_in_days = @duration_in_days.to_i
+    start_date = @begin_time.to_time.to_i - duration_in_days * 86_400 - 30 * 86_400
+    end_date = @begin_time.to_time.to_i - 30 * 86_400
+    git_ls = git_files(directory_path: @directory_path)
+    file_count = filter_existing_code_files(git_ls.split).count
+    all_files_with_changes = files_with_changes(directory_path: @directory_path, start_date:, end_date:).split.sort
+    code_files_with_changes = filter_existing_code_files(all_files_with_changes)
+    uniq_code_files_with_changes = code_files_with_changes.uniq
+    all_teams, cross_teams_count, single_ownership_teams_count, files_changed_by_many_teams, total_changes, file_team_map = analyze_changed_files(uniq_code_files_with_changes:, start_date:, end_date:)
+    occurrences = all_teams.flatten.compact.tally
+    sorted_occurrences = occurrences.sort_by { |element, count| [-count, element] }
+    contributors = Hash[sorted_occurrences]
+    churn_count = file_team_map.values.map { |value| value[1] }.sum
+    hotspot_changes_percentage = (churn_count.to_f / total_changes) * 100
+    # Filter files based on extension, existence and size
+    filtered_files = filter_files(file_team_map:)
     filtered_top_touched_files = filtered_files.sort_by { |element, count| [-count.last, element] }
 
     puts ''
@@ -198,61 +251,22 @@ class GitOwnershipInsights
     puts "     *Total amount of commits to #{CODE_EXTENSIONS} files:* #{total_changes}"
     puts "     *Total #{CODE_EXTENSIONS} files changed:* #{uniq_code_files_with_changes.count}"
     count_big_files(@directory_path)
-    puts "     *Current(\\*) total of #{CODE_EXTENSIONS} files in the folder:* #{file_count}"
+    puts "     *Current total of #{CODE_EXTENSIONS} files in the folder:* #{file_count}"
     puts "     *Contributors:* #{contributors}"
-    puts "* means that it the current(instant) repository value, all the other metrics are done over #{duration_in_days} days period"
 
     if HOTSPOT
       puts "\n"
       puts '   *Hotspot changes:*'
       filtered_top_touched_files.each do |line|
-        puts "     #{line.first.gsub(@directory_path, '')} Contributors: #{line.last.first} Commits: #{line.last.last}"
+        file = line.first
+        contributors = line.last.first
+        commits = line.last.last
+        puts "     #{file.gsub(@directory_path, '')} Contributors: #{contributors} Commits: #{commits} Owner: #{find_owner(file:)}"
       end
     end
 
-    if CODEOWNERS
-      puts "\n"
-      puts '*Code ownership data:*'
-      codeowners = read_codeowners_file
-
-      owners_data = Hash.new do |hash, key|
-        hash[key] = { directories: Hash.new do |h, k|
-          h[k] = { files: [] }
-        end, churn_count: 0 }
-      end
-
-      file_team_map.each do |file, count|
-        owners = find_owners(file, codeowners)
-        owners.each do |owner|
-          owners_data[owner][:churn_count] += count.last
-
-          dir_path = File.dirname(file)
-          owners_data[owner][:directories][dir_path][:files] << { name: File.basename(file), count: }
-        end
-      end
-
-      # Sort owners_data by total count in descending order
-      sorted_owners_data = owners_data.sort_by { |_, data| -data[:churn_count] }
-
-      # Take the last 5 elements
-      top_owners_data = sorted_owners_data.last(TOP_CONTRIBUTED_TEAMS.to_i)
-
-      converted_team_map = file_team_map.transform_keys { |key| File.basename(key) }
+    handle_codeowners(file_team_map:) if CODEOWNERS
 
-      puts '   Codeownership data:'
-      top_owners_data.each do |owner, data|
-        puts "      #{owner.split('/').last}:\n         Total Count: #{data[:churn_count]}"
-        data[:directories].each do |dir, dir_data|
-          puts "            Directory: #{dir}\n               Top files:"
-          dir_data[:files].each do |file_data|
-            next if converted_team_map[File.basename(file_data[:name])].nil?
-
-            contributors = converted_team_map[file_data[:name]]&.first&.empty? ? ['Excluded contributor'] : converted_team_map[file_data[:name]].first
-            puts "                  #{File.basename(file_data[:name])} - #{file_data[:count].last} #{contributors}}"
-          end
-        end
-      end
-    end
     @steps -= 1
 
     return unless @steps.positive?

data/lib/git_ownership_insights/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class GitOwnershipInsights
-  VERSION = '2.0.2'
+  VERSION = '2.0.4'
 end

data/spec/git_ownership_insights_spec.rb

@@ -52,15 +52,14 @@ RSpec.describe GitOwnershipInsights do
              *[".swift", ".kt"] files exceeding 250 lines with multiple contributors:* 1
              *Total amount of commits to [".swift", ".kt"] files:* 7
              *Total [".swift", ".kt"] files changed:* 3
-             *Current(\\*) total number of code files longer than 250 lines:* 2
-             *Current(\\*) total of [".swift", ".kt"] files in the folder:* 4
+             *Current total number of code files longer than 250 lines:* 2
+             *Current total of [".swift", ".kt"] files in the folder:* 4
              *Contributors:* {"FIOS"=>5, "FAND"=>2}
-        * means that it the current(instant) repository value, all the other metrics are done over 7 days period
 
-           Hotspot changes:
+           *Hotspot changes:*
              /file1.swift Contributors: ["FIOS", "FAND"] Commits: 3
 
-        Code ownership data:
+        *Code ownership data:*
            Codeownership data:
               FIOS:
                  Total Count: 3

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: git_ownership_insights
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.0.4
 platform: ruby
 authors:
 - Serghei Moret