git_ownership_insights 2.0.5 → 2.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b90e3d2355601c1711367b299fe90656b7f51e1996bff55167a58fb03281fb17
-  data.tar.gz: bb5e35f34321125a6c1d81e8c83da66c57baa9788e2e5fc4dfe5922c6b69e563
+  metadata.gz: b2f6a04d3018e987e2762a5037c474904cf6602fded2e27f08df2789f0dc99c3
+  data.tar.gz: 8ae4f2dc116cf482b4ff0f7a10225e1d6aeefa4a1f7219a7909eca541a4a51f1
 SHA512:
-  metadata.gz: 107ce0fca4900d0ffb548d261d9537d5c43bdeb67ac66803a99f431049613ce86025593d575b718ce7ff2ba77f169c32ab55e7aa94434dd114804ba7f2ad8a59
-  data.tar.gz: becb170bb5ebf8adba77ce1fda76cca504288fffb1e13c86e94c6e8e2db0db9ad6a9ca8f264faf60b65c4f6f9beb680b50701d6cb75847bca8bdf2d948501bc1
+  metadata.gz: ef5dc57fa25ac45c1732177686c947bd30f373fce422a1208993da14e52a104f15ceab0902005c48b789428c2fcd6edac2e851303457ab21aaa7664ffde0a853
+  data.tar.gz: 0ee6b4f127938b0d4daa4e3f6b1e35491e79698af297bec7f96321313180fd4a2cf2a553727c5da3559879bbc152e2be175deac9ada09ebd210ce9d4c03a1b65

data/Gemfile.lock

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

data/bin/git_ownership_insights

@@ -54,16 +54,6 @@ OptionParser.new do |opts|
     options[:team_regex] = team_regex
   end
 
-  opts.on('--top-contributing-team STRING',
-          'Limit of top contributed to the directory teams in codeownership data [default: 5]') do |top_contributing_team|
-    options[:top_contributing_team] = top_contributing_team
-  end
-
-  opts.on('--top-touched-files STRING',
-          'Limit of top touched files by individual contributors in codeownership data [default: 5]') do |top_touched_files|
-    options[:top_touched_files] = top_touched_files
-  end
-
   opts.on('--codeowners-path STRING', 'Path to CODEOWNERS file [default: .github/CODEOWNERS]') do |codeowners_path|
     options[:codeowners_path] = codeowners_path
   end
@@ -83,6 +73,11 @@ OptionParser.new do |opts|
     options[:code_extension] = code_extension
   end
 
+  opts.on('--output-to-files',
+          'Puts the output for hotspot and codeowners into files instead of the STDOUT (useful for CI and big amount of data) [default:false]') do
+    options[:file_output] = true
+  end
+
   opts.on('-v', '--version', 'Display the version of the gem') do
     puts "git_ownership_insights version #{GitOwnershipInsights::VERSION}"
     exit
@@ -102,14 +97,13 @@ end.parse!
 EXCLUSIONS = options[:exclusions]&.split(',')
 REPO_PATH = options[:path] || '.'
 TEAM_REGEX = options[:team_regex] || '[A-Za-z]+'
-TOP_TOUCHED_FILES = options[:top_touched_files] || 5
-TOP_CONTRIBUTED_TEAMS = options[:top_contributing_team] || 5
 CODEOWNERS_PATH = options[:codeowners_path] || '.github/CODEOWNERS'
 BIG_FILE_SIZE = options[:big_file_size] || 250
 CI = options[:ci] || false
 DEFAULT_BRANCH = options[:default_branch] || 'master'
 CODEOWNERS = options[:codeowners] || false
 HOTSPOT = options[:hotspot_files] || false
+FILE_OUTPUT = options[:file_output] || false
 CODE_EXTENSIONS = options[:code_extension] ? options[:code_extension].split(',') : ['.swift', '.kt']
 EXCLUDED_FILES = options[:excluded_files]
 
@@ -125,8 +119,7 @@ unless CI
   puts "Lines of code limit (big files) for the hotspot calculation: #{BIG_FILE_SIZE}"
   puts "Hotspot detailed output is: #{options[:hotspot_files] ? 'on' : 'off'}\n"
   puts "CODEOWNERS output is: #{options[:codeowners] ? 'on' : 'off'}\n"
-  puts "Limit of the teams shown in codeownership data: #{TOP_CONTRIBUTED_TEAMS}"
-  puts "Limit of the files shown in codeownership data: #{TOP_TOUCHED_FILES}"
+  puts "Output to file mode is: #{options[:file_output] ? 'on' : 'off'}\n"
   puts "CI mode is: #{options[:ci] ? 'on' : 'off'}\n"
   puts "Debug mode is: #{options[:debug] ? 'on' : 'off'}\n\n"
 end

data/lib/git_ownership_insights/git_ownership_insight.rb

@@ -54,8 +54,7 @@ class GitOwnershipInsights
   end
 
   def handle_codeowners(file_team_map:)
-    puts "\n"
-    puts '*Code ownership data:*'
+    output = "\n   *Code ownership data:*\n"
     codeowners = read_codeowners_file
 
     owners_data = Hash.new do |hash, key|
@@ -76,25 +75,28 @@ class GitOwnershipInsights
 
     # 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]}"
+    sorted_owners_data.each do |owner, data|
+      output += "\n      #{owner.split('/').last}:\n         Total Count: #{data[:churn_count]}\n"
       data[:directories].each do |dir, dir_data|
-        puts "            Directory: #{dir}\n               Top files:"
+        output += "            Directory: #{dir}\n               Top files:\n"
         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}}"
+          output += "                  #{File.basename(file_data[:name])} - #{file_data[:count].last} #{contributors}}"
         end
       end
     end
+
+    if FILE_OUTPUT
+      File.open('codeowners.txt', 'w') do |f|
+        f.puts output
+      end
+    else
+      puts output
+    end
   end
 
   def find_owner(file:)
@@ -255,14 +257,22 @@ class GitOwnershipInsights
     puts "     *Contributors:* #{contributors}"
 
     if HOTSPOT
-      puts "\n"
-      puts '   *Hotspot changes:*'
+      hotspot_output = "\n   *Hotspot files(#{filtered_top_touched_files.count}):*\n"
+
       filtered_top_touched_files.each do |line|
-        puts "\n"
+        hotspot_output += "\n"
         file = line.first
         contributors = line.last.first
         commits = line.last.last
-        puts "     #{file.gsub(@directory_path, '')} Contributors: #{contributors} Commits: #{commits} Owner: #{find_owner(file:)}"
+        hotspot_output += "     #{file.gsub(@directory_path, '')} Contributors: #{contributors} Commits: #{commits} Owner: #{find_owner(file:)}"
+      end
+
+      if FILE_OUTPUT
+        File.open('hotspot.txt', 'w') do |f|
+          f.puts hotspot_output
+        end
+      else
+        puts hotspot_output
       end
     end
 

data/lib/git_ownership_insights/version.rb

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

data/spec/git_ownership_insights_spec.rb

@@ -5,8 +5,6 @@ require_relative '../lib/git_ownership_insights/git_ownership_insight'
 RSpec.describe GitOwnershipInsights do
   EXCLUSIONS = %w[exclusion1 exclusion2].freeze
   TEAM_REGEX = '[A-Za-z]+'
-  TOP_TOUCHED_FILES = 5
-  TOP_CONTRIBUTED_TEAMS = 5
   CODEOWNERS_PATH = '.github/CODEOWNERS'
   BIG_FILE_SIZE = 250
   CI = false
@@ -15,6 +13,7 @@ RSpec.describe GitOwnershipInsights do
   HOTSPOT = true
   CODE_EXTENSIONS = ['.swift', '.kt'].freeze
   EXCLUDED_FILES = 'ignore'
+  FILE_OUTPUT = false
 
   let(:dummy_directory_path) { 'spec/fixtures' }
   let(:duration_in_days) { 7 }
@@ -56,11 +55,12 @@ RSpec.describe GitOwnershipInsights do
              *Current total of [".swift", ".kt"] files in the folder:* 4
              *Contributors:* {"FIOS"=>5, "FAND"=>2}
 
-           *Hotspot changes:*
-             /file1.swift Contributors: ["FIOS", "FAND"] Commits: 3
+           *Hotspot files(1):*
+
+             /file1.swift Contributors: ["FIOS", "FAND"] Commits: 3 Owner: ["FIOS"]
+
+           *Code ownership data:*
 
-        *Code ownership data:*
-           Codeownership data:
               FIOS:
                  Total Count: 3
                     Directory: spec/fixtures

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: git_ownership_insights
 version: !ruby/object:Gem::Version
-  version: 2.0.5
+  version: 2.0.7
 platform: ruby
 authors:
 - Serghei Moret
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-30 00:00:00.000000000 Z
+date: 2024-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: date