git_ownership_insights 1.1.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a07de43c9627bdeceeedc7e06d1028645a3b374f26203063e1bc23ed3024611
-  data.tar.gz: b7ea15dc22b92a8742278ff835612f180125240af9531e2ec764c7b19a80e5c9
+  metadata.gz: e323781f21d5b045b9fe23e6790f53739fe6bd99e917a9ad2b88c544a9aa3428
+  data.tar.gz: 0c23bd13ad86a4edc00f38a77e5219d18ebd81af84dc8e76764762611780fb1e
 SHA512:
-  metadata.gz: f828c59098fb64d0017ac93a0fe15894ea8c92a08a5f6a2145d84ff7e88f38c089311cb5d177257169a9d88e8d0948c592f85c12f8a1209135e4442c223b0795
-  data.tar.gz: eb8302ef0f5a93679411c77c243dfece43e0d902a129325d4319d739f103fbf5c2ed29f225d9c3c705466525aaef7238964fd557176fbb87036e97355119967e
+  metadata.gz: 7302774074f86ca8f5ebd3288f47150a7cc9adf642b2dfe3bc60f0f0ff087a38f9645789b256e923fc578b5d445293be72dcc143d07906a86c6a678e8742a1c4
+  data.tar.gz: 97f58091878d741eac46b1c0a0eb8263cbe7cc7abdba5f8db2c70bf2d12fe4dc0f089496a8e8b7b87531c9bfa4bdb4577820b75afa50576eec9e30184bbdd723

data/.github/CODEOWNERS

@@ -0,0 +1,2 @@
+spec/fixtures/file1.swift @FIOS
+spec/fixtures/file2.kt @FAND

data/.rubocop.yml

@@ -0,0 +1,14 @@
+inherit_from: .rubocop_todo.yml
+
+# The behavior of RuboCop can be controlled via the .rubocop.yml
+# configuration file. It makes it possible to enable/disable
+# certain cops (checks) and to alter their behavior if they accept
+# any parameters. The file can be placed either in your home
+# directory or in some project directory.
+#
+# RuboCop will start looking for the configuration file in the directory
+# where the inspected file is and continue its way up to the root directory.
+#
+# See https://docs.rubocop.org/rubocop/configuration
+AllCops:
+  TargetRubyVersion: 3.2.1

data/.rubocop_todo.yml

@@ -0,0 +1,58 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2024-01-30 07:43:06 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
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 4
+# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
+Metrics/AbcSize:
+  Max: 187
+
+# Offense count: 1
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+# AllowedMethods: refine
+Metrics/BlockLength:
+  Max: 69
+
+# Offense count: 1
+# Configuration parameters: AllowedMethods, AllowedPatterns.
+Metrics/CyclomaticComplexity:
+  Max: 31
+
+# Offense count: 4
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+Metrics/MethodLength:
+  Max: 115
+
+# Offense count: 1
+# Configuration parameters: CountComments, CountAsOne.
+Metrics/ModuleLength:
+  Max: 192
+
+# Offense count: 1
+# Configuration parameters: AllowedMethods, AllowedPatterns.
+Metrics/PerceivedComplexity:
+  Max: 32
+
+# Offense count: 1
+# Configuration parameters: AllowedConstants.
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/git_ownership_insights/git_ownership_insight.rb'
+
+# Offense count: 1
+Style/MultilineBlockChain:
+  Exclude:
+    - 'lib/git_ownership_insights/git_ownership_insight.rb'
+
+# Offense count: 7
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns.
+# URISchemes: http, https
+Layout/LineLength:
+  Max: 150

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    git_ownership_insights (1.0.6)
+    git_ownership_insights (2.0.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
 
@@ -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"
@@ -134,5 +134,5 @@ end
 system("git checkout #{DEFAULT_BRANCH}", [:out] => File::NULL)
 system('git pull', %i[out err] => File::NULL)
 
-GitOwnershipInsights.contribution_message(duration_in_days: options[:duration_in_days] || 30, directory_path: REPO_PATH,
-                                          begin_time: DateTime.now, steps: options[:steps].to_i, debug: options[:debug])
+GitOwnershipInsights.new(duration_in_days: options[:duration_in_days] || 30, directory_path: REPO_PATH,
+                         begin_time: DateTime.now, steps: options[:steps].to_i, debug: options[:debug]).contribution_message

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

@@ -1,11 +1,22 @@
 # frozen_string_literal: true
 
-module GitOwnershipInsights
-  def self.true?(obj)
+require 'pry'
+require 'date'
+
+class GitOwnershipInsights
+  def initialize(directory_path:, duration_in_days:, begin_time:, debug: nil, steps: 1)
+    @directory_path = directory_path
+    @duration_in_days = duration_in_days
+    @begin_time = begin_time
+    @debug = debug
+    @steps = steps
+  end
+
+  def true?(obj)
     obj.to_s.downcase == 'true'
   end
 
-  def self.read_codeowners_file
+  def read_codeowners_file
     raise "CODEOWNERS file does not exist under #{CODEOWNERS_PATH}" unless File.exist?(CODEOWNERS_PATH)
 
     codeowners = {}
@@ -20,7 +31,7 @@ module GitOwnershipInsights
     codeowners
   end
 
-  def self.find_owners(file_path, codeowners)
+  def find_owners(file_path, codeowners)
     matching_patterns = codeowners.keys.select do |pattern|
       pattern_regex = Regexp.new("^#{Regexp.escape(pattern.sub(%r{^/+}, '').chomp('/')).gsub('\*', '.*').gsub('**',
                                                                                                               '.*?')}")
@@ -42,7 +53,7 @@ module GitOwnershipInsights
     codeowners[best_match].split(' ')
   end
 
-  def self.count_big_files(directory_path, size: BIG_FILE_SIZE)
+  def count_big_files(directory_path, size: BIG_FILE_SIZE)
     size = size.to_i
     # Get a list of all files in the specified directory
     files = Dir.glob(File.join(directory_path, '**', '*')).select { |file| File.file?(file) }
@@ -62,10 +73,10 @@ 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)
+  def count_hotspot_lines(files)
     code_files = files.select do |f|
       extension = File.extname(f)
       valid_extensions = CODE_EXTENSIONS
@@ -83,43 +94,57 @@ module GitOwnershipInsights
     puts "     *Total lines of hotspot code:* #{count}"
   end
 
-  def self.filter_code_files(files)
+  def filter_existing_code_files(files)
     files.select do |f|
+      next unless File.exist?(f)
+
+      if EXCLUDED_FILES
+        excluded_patterns = EXCLUDED_FILES.split(',')
+        next if excluded_patterns.any? { |pattern| f.include?(pattern) }
+      end
+
       extension = File.extname(f)
       valid_extensions = CODE_EXTENSIONS
       valid_extensions.include?(extension)
     end
   end
 
-  def self.contribution_message(directory_path:, duration_in_days:, begin_time:, debug: nil, steps: nil)
-    duration_in_days = duration_in_days.to_i
+  def git_files(directory_path:)
+    `git ls-tree -r --name-only $(git rev-list -1 HEAD) -- "#{directory_path}"`
+  end
+
+  def 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 git_commit_count(file:, start_date:, end_date:)
+    `git log --since="#{start_date}" --until="#{end_date}" --follow -- "#{file}" | grep -c '^commit'`
+  end
+
+  def git_commit_info(file:, start_date:, end_date:)
+    `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
     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
-    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)
-
-    if EXCLUDED_FILES
-      code_files_with_changes = code_files_with_changes.reject do |file|
-        excluded_patterns.any? { |pattern| file.include?(pattern) }
-      end
-    end
-
+    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)
-      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
-      git_log = `git log --pretty=format:"%s" --since="#{start_date}" --until="#{end_date}" --follow -- "#{file}"`.split("\n")
+      commit_count = git_commit_count(file:, start_date:, end_date:).to_i
+      git_log = git_commit_info(file:, start_date:, end_date:).split("\n")
       teams = git_log.map do |team|
         team.match(/#{TEAM_REGEX}/)[0].upcase
       end.reject { |e| EXCLUSIONS&.include?(e) }
@@ -131,12 +156,12 @@ 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
+      puts "\n#{filename} [#{commit_count}]:#{teams}\n" if @debug
     end
 
     occurrences = all_teams.flatten.compact.tally
@@ -156,26 +181,32 @@ module GitOwnershipInsights
 
     filtered_top_touched_files = filtered_files.sort_by { |element, count| [-count.last, element] }
 
-    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 ''
+    puts "*Timeframe:* #{(@begin_time - duration_in_days).strftime('%Y-%m-%d')} to #{@begin_time.strftime('%Y-%m-%d')}"
+    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)
-    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 "     *#{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 "     *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}"
+        puts "     #{line.first.gsub(@directory_path, '')} Contributors: #{line.last.first} Commits: #{line.last.last}"
       end
     end
 
@@ -196,7 +227,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
 
@@ -222,13 +253,13 @@ module GitOwnershipInsights
         end
       end
     end
-    steps -= 1
+    @steps -= 1
 
-    return unless steps.positive?
+    return unless @steps.positive?
 
-    system("git checkout `git rev-list -1 --before='#{(begin_time - duration_in_days).strftime('%B %d %Y')}' HEAD`",
+    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)
+    @begin_time -= duration_in_days
+    contribution_message
   end
 end

data/lib/git_ownership_insights/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-module GitOwnershipInsights
-  VERSION = '1.1.1'
+class GitOwnershipInsights
+  VERSION = '2.0.0'
 end

data/lib/git_ownership_insights.rb

@@ -2,7 +2,7 @@
 
 require_relative 'git_ownership_insights/version'
 
-module GitOwnershipInsights
+class GitOwnershipInsights
   class Error < StandardError; end
   # Your code goes here...
 end

data/sig/git_ownership_insights.rbs

@@ -1,4 +1,4 @@
-module GitOwnershipInsights
+class GitOwnershipInsights
   VERSION: String
   # See the writing guide of rbs: https://github.com/ruby/rbs#guides
 end