git_ownership_insights 2.0.5 → 2.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b90e3d2355601c1711367b299fe90656b7f51e1996bff55167a58fb03281fb17
-  data.tar.gz: bb5e35f34321125a6c1d81e8c83da66c57baa9788e2e5fc4dfe5922c6b69e563
+  metadata.gz: 9e95410a234ad6fdf3d9684a28da2dcd3515cb77c3f949fa0c2e97723cb6e76f
+  data.tar.gz: e212afe069ae204cd8f2eb8b07a49774dd64de590945940da812e6c4048ab111
 SHA512:
-  metadata.gz: 107ce0fca4900d0ffb548d261d9537d5c43bdeb67ac66803a99f431049613ce86025593d575b718ce7ff2ba77f169c32ab55e7aa94434dd114804ba7f2ad8a59
-  data.tar.gz: becb170bb5ebf8adba77ce1fda76cca504288fffb1e13c86e94c6e8e2db0db9ad6a9ca8f264faf60b65c4f6f9beb680b50701d6cb75847bca8bdf2d948501bc1
+  metadata.gz: 3b9ea8b6441df0167ff471a2118a293c5e250dbecc817a330985a29ab950d12b59d8de1c24cb2b2b275fbfc842500174deeb906d792e6d51338adc905c62d919
+  data.tar.gz: d08540070983653aa3216aab3a3e7b01d46e36e35666cc7ca0e7d4307e7d7995742628b781704397a8dcfa633cfce82cd8d34d2f78f33eb13bed559aaa7d810a

data/Gemfile.lock

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

data/bin/git_ownership_insights

@@ -83,6 +83,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
@@ -110,6 +115,7 @@ 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]
 
@@ -127,6 +133,7 @@ unless CI
   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|
@@ -82,19 +81,26 @@ class GitOwnershipInsights
 
     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]}"
+      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 +261,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.6'
 end

data/spec/git_ownership_insights_spec.rb

@@ -15,6 +15,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 +57,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.6
 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