git_ownership_insights 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b4e4cc30ba7171927e4abab4be4b0193352393d3690f0f687c4ac87518bc72c
-  data.tar.gz: 55ea9d63840f6d95bb5d4f071f712ca76f79b666d50f21b162a05b97a9adb47a
+  metadata.gz: 6d884a43cd70caba8943ba59a6ce05d46631cb6927ed0eefa74a1dccbc2d66f8
+  data.tar.gz: 180007096b00a2978d8e6d6440c9214b1f8d59e41c841e665392db2c955fecd8
 SHA512:
-  metadata.gz: 220d887e9bda7878504ad5f8ae78247a0e8ad445b9bdfbd277334d7fb6505c9ff228232db65cd0009546789c11ea793b39aad53e64d6c6e6eed1980831485bc3
-  data.tar.gz: 11fc632f24d489cce44c3bf224fc787ef0ddfba4527c4017ec1553535571743ae071d901e153a0da870b9215b1b3db2de6bb48be04507bec5ea88a65d3e52ca2
+  metadata.gz: 27a2bc913215ffb0cee443be41b1a91128edc31998d0f3841ad0ac02fd03393529f41825c55645cfc007f0a0d478a439834568334e2bf81c89929d3eeb396f37
+  data.tar.gz: e8d564d1734b023321027464ff86aea38463085681ef579297b69fc8f4bfd034b558d064e754bc0b142bf1a18171f4e959dd9c1af0d2a2ac34a375f01f5cbb88

data/Gemfile.lock

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

data/bin/git_ownership_insights

@@ -33,7 +33,7 @@ OptionParser.new do |opts|
   end
 
   opts.on('--excluded-files STRING',
-          'Comma-delimited list of excluded files [example: ViewController,AppDelegate.swift]') do |excluded_files|
+          'Comma-delimited list of excluded keywords [example: ViewController,AppDelegate.swift]') do |excluded_files|
     options[:excluded_files] = excluded_files
   end
 
@@ -79,7 +79,7 @@ OptionParser.new do |opts|
   end
 
   opts.on('--code-extensions STRING',
-          'The file extensions that consider to be code [default: ".kt, .swift"]') do |code_extension|
+          'The file extensions that consider to be code [default: ".kt,.swift"]') do |code_extension|
     options[:code_extension] = code_extension
   end
 
@@ -110,7 +110,7 @@ CI = options[:ci] || false
 DEFAULT_BRANCH = options[:default_branch] || 'master'
 CODEOWNERS = options[:codeowners] || false
 HOTSPOT = options[:hotspot_files] || false
-CODE_EXTENSIONS = options[:code_extension] ? options[:code_extension].split : ['.swift', '.kt']
+CODE_EXTENSIONS = options[:code_extension] ? options[:code_extension].split(',') : ['.swift', '.kt']
 EXCLUDED_FILES = options[:excluded_files]
 
 unless CI
@@ -121,7 +121,7 @@ unless CI
   puts "Code extensions: #{CODE_EXTENSIONS}"
   puts "Regex to detect the teams identifiers: #{TEAM_REGEX}"
   puts "Excluded contributors: #{EXCLUSIONS}\n" if EXCLUSIONS
-  puts "Excluded file patterns: #{EXCLUDED_FILES.split(',')}\n" if EXCLUDED_FILES
+  puts "Excluded file keywords: #{EXCLUDED_FILES.split(',')}\n" if EXCLUDED_FILES
   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"

data/git_ownership_insights.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.summary = 'This gem prints git ownership insights'
   spec.homepage = 'https://rubygems.org'
   spec.license = 'MIT'
-  spec.required_ruby_version = '>= 2.6.0'
+  spec.required_ruby_version = '>= 3.2'
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = 'https://rubygems.org'

data/lib/git_ownership_insights/git_ownership_insight.rb

@@ -62,7 +62,7 @@ module GitOwnershipInsights
       count += 1 if lines_count > size
     end
 
-    puts "     *Total number of code files longer than #{size} lines:* #{count}"
+    puts "     *Current(*) total number of code files longer than #{size} lines:* #{count}"
   end
 
   def self.count_hotspot_lines(files)
@@ -83,14 +83,28 @@ module GitOwnershipInsights
     puts "     *Total lines of hotspot code:* #{count}"
   end
 
-  def self.filter_code_files(files)
+  def self.filter_existing_code_files(files)
     files.select do |f|
+      next unless File.exist?(f)
+
       extension = File.extname(f)
       valid_extensions = CODE_EXTENSIONS
       valid_extensions.include?(extension)
     end
   end
 
+  def self.git_files(directory_path:)
+    `git ls-tree -r --name-only $(git rev-list -1 HEAD) -- "#{directory_path}"`
+  end
+
+  def self.files_with_changes(directory_path:, start_date:, end_date:)
+    `git log --name-only --pretty=format:"" --since="#{start_date}" --until="#{end_date}" "#{directory_path}"`
+  end
+
+  def self.git_commit_count(file:, start_date:, end_date:)
+    `git log --since="#{start_date}" --until="#{end_date}" --follow -- "#{file}" | grep -c '^commit'`
+  end
+
   def self.contribution_message(directory_path:, duration_in_days:, begin_time:, debug: nil, steps: nil)
     duration_in_days = duration_in_days.to_i
     all_teams = []
@@ -98,27 +112,25 @@ module GitOwnershipInsights
     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
-    end_date = begin_time.to_time.to_i
-    file_count = `git ls-tree -r --name-only $(git rev-list -1 --since="#{start_date}" --until="#{end_date}" HEAD) -- "#{directory_path}" | wc -l`.to_i
-    all_files_with_changes = `git log --name-only --pretty=format:"" --since="#{start_date}" --until="#{end_date}" "#{directory_path}"`.split.sort
-    excluded_patterns = EXCLUDED_FILES.split(',') if EXCLUDED_FILES
-
-    code_files_with_changes = filter_code_files(all_files_with_changes)
+    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:)
+    file_count = filter_existing_code_files(git_ls.split).count
+    all_files_with_changes = files_with_changes(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
 
     if EXCLUDED_FILES
-      code_files_with_changes = code_files_with_changes.reject do |file|
+      excluded_patterns = EXCLUDED_FILES.split(',')
+      uniq_code_files_with_changes = uniq_code_files_with_changes.reject do |file|
         excluded_patterns.any? { |pattern| file.include?(pattern) }
       end
     end
 
-    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)
-      commit_count = `git log --since="#{start_date}" --until="#{end_date}" --follow -- "#{file}" | grep -c '^commit'`.to_i
-      # Get the log of the file in the given duration
+      commit_count = git_commit_count(file:, start_date:, end_date:).to_i
       git_log = `git log --pretty=format:"%s" --since="#{start_date}" --until="#{end_date}" --follow -- "#{file}"`.split("\n")
       teams = git_log.map do |team|
         team.match(/#{TEAM_REGEX}/)[0].upcase
@@ -131,9 +143,9 @@ module GitOwnershipInsights
       if teams.count > 1
         files_changed_by_many_teams += 1
         file_team_map.merge!(file.to_s => [teams, commit_count])
-        cross_teams_count += teams.count if File.exist?(file)
+        cross_teams_count += teams.count
       else
-        single_ownership_teams_count += 1 if File.exist?(file)
+        single_ownership_teams_count += 1
       end
 
       puts "\n#{filename} [#{commit_count}]:#{teams}\n" if debug
@@ -156,20 +168,26 @@ module GitOwnershipInsights
 
     filtered_top_touched_files = filtered_files.sort_by { |element, count| [-count.last, element] }
 
-    puts ""
+    puts ''
     puts "*Timeframe:* #{(begin_time - duration_in_days).strftime('%Y-%m-%d')} to #{begin_time.strftime('%Y-%m-%d')}"
-    puts "     *Hotspot Code Changes:* #{churn_count} (#{hotspot_changes_percentage.round(2)}%)"
-    puts "     *Cross-Squad Dependency:*"
+    puts "     *Code files with a single contributor:* #{(100 - ((files_changed_by_many_teams.to_f / file_count) * 100)).round(2)}%"
+    puts "        *Existing files changed by many teams:* #{files_changed_by_many_teams}"
+    puts "        *Current existing #{CODE_EXTENSIONS} files:* #{file_count}"
+    puts '     *Cross-Squad Dependency:*'
     puts "        *Contributions by multiple squads to the same files:* #{cross_teams_count}"
     puts "        *Contributions by single squads contributing to single files:* #{single_ownership_teams_count}"
-    puts "     *Files exceeding #{BIG_FILE_SIZE} lines with multiple contributors:* #{filtered_top_touched_files.count}"
+    puts "     *Hotspot Code Changes:* #{hotspot_changes_percentage.round(2)}%"
+    puts "        *Churn count(commits to files by multiple teams):* #{churn_count}"
+    puts "        *Total amount of commits:* #{total_changes}"
     count_hotspot_lines(filtered_files.keys)
+    puts "     *#{CODE_EXTENSIONS} files with multiple contributors:* #{file_team_map.count}"
+    puts "     *#{CODE_EXTENSIONS} files exceeding #{BIG_FILE_SIZE} lines with multiple contributors:* #{filtered_top_touched_files.count}"
+    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 "     *Code files with a single contributor:* #{(100 - ((files_changed_by_many_teams.to_f / code_files_with_changes.count) * 100)).round(2)}%"
-    puts "     *Total amount of code changes:* #{total_changes}"
-    puts "     *Total files changed:* #{code_files_with_changes.count}"
-    puts "     *Total 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"
@@ -196,7 +214,7 @@ module GitOwnershipInsights
           owners_data[owner][:churn_count] += count.last
 
           dir_path = File.dirname(file)
-          owners_data[owner][:directories][dir_path][:files] << { name: File.basename(file), count: count }
+          owners_data[owner][:directories][dir_path][:files] << { name: File.basename(file), count: }
         end
       end
 
@@ -228,7 +246,7 @@ module GitOwnershipInsights
 
     system("git checkout `git rev-list -1 --before='#{(begin_time - duration_in_days).strftime('%B %d %Y')}' HEAD`",
            %i[out err] => File::NULL)
-    contribution_message(duration_in_days: duration_in_days, directory_path: directory_path,
-                         begin_time: begin_time - duration_in_days, steps: steps, debug: debug)
+    contribution_message(duration_in_days:, directory_path:,
+                         begin_time: begin_time - duration_in_days, steps:, debug:)
   end
 end

data/lib/git_ownership_insights/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GitOwnershipInsights
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: git_ownership_insights
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Serghei Moret
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-29 00:00:00.000000000 Z
+date: 2024-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: date
@@ -81,7 +81,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="