Class: Git::Report

Inherits:
Object
  • Object
show all
Defined in:
lib/version.rb,
lib/git/report.rb

Overview

Report class - generates statistics about git repository contributors Analyzes commits, lines of code, and file changes per author

Constant Summary collapse

VERSION_FILE = 
File.expand_path('../VERSION', __dir__)
VERSION = 
File.exist?(VERSION_FILE) ? File.read(VERSION_FILE).strip : 'unknown'
NAME = 
/\A[^(]*\((.*)\s*\d{4}-\d\d-\d\d \d\d:\d\d:\d\d [+-]\d{4}\s+\d+\)/
COMMITS_NAME_EMAIL = 
/\A\s*(\d*)\t(.*) <(.*)>/
HEADER = 
{
  name:    'Name',
  loc:     'LOC',
  commits: 'Commits',
  files:   'files',
  loc_add: '+LOC',
  loc_del: '-LOC'
}.freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Report

Returns a new instance of Report.



21
22
23
 
# File 'lib/git/report.rb', line 21

def initialize
  @authors = []
end

Instance Attribute Details

#authors ⇒ Object (readonly)

Returns the value of attribute authors.



8
9
10
 
# File 'lib/git/report.rb', line 8

def authors
  @authors
end

Instance Method Details

#add(line, opts = {}) ⇒ Object 



81
82
83
84
85
86
 
# File 'lib/git/report.rb', line 81

def add(line, opts = {})
  shortlog_line = format_shortlog_line(*line.scan(COMMITS_NAME_EMAIL)[0])
  shortlog_line[:commits] = opts[:commits] if opts[:commits]
  candidate = Author.new(**shortlog_line)
  @authors << candidate unless add_author candidate
end

#add_author(candidate) ⇒ Object 



88
89
90
91
92
93
94
95
96
97
 
# File 'lib/git/report.rb', line 88

def add_author(candidate)
  merged = false
  @authors.each do |author|
    if author.mergable?(candidate)
      author.merge(candidate)
      merged = true
    end
  end
  merged
end

#find_author(name) ⇒ Object 



99
100
101
 
# File 'lib/git/report.rb', line 99

def find_author(name)
  @authors.find { |author| author.name == name }
end

#parse_blame ⇒ Object 



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/git/report.rb', line 51

def parse_blame
  ls_files        = `git ls-files`.split(/\n/)
  ignore_files    = `git status --porcelain`.split(/\n/)
  ignore_files.map! { |file| file[3..-1] }
  ls_files -= ignore_files

  file_lists      = ls_files.each_slice((ls_files.count**0.5).ceil).to_a
  names_loc_count = Hash.new(0)
  names_files     = {}

  Git::Parallel.peach(file_lists) do |files|
    files.each do |file|
      escaped_file = Shellwords.escape(file)
      blame = `git blame -w #{escaped_file} 2> /dev/null`
      next if blame.empty?
      blame.unpack('C*').pack('C*').split(/\n/).map do |line|
        name = line.match(NAME)[1].strip.force_encoding('UTF-8')
        names_loc_count[name] += 1
        names_files[name] ||= Set.new
        names_files[name] << file
      end
    end
  end
  # find_author can be nil for lines git attributes to someone outside the
  # shortlog history (e.g. "Not Committed Yet" for staged-but-uncommitted
  # changes), so skip those rather than crash.
  names_loc_count.each { |name, loc| find_author(name)&.loc = loc }
  names_files.each { |name, files| find_author(name)&.files = files.size }
end

#parse_shortlog ⇒ Object 



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/git/report.rb', line 34

def parse_shortlog
  # First pass: get all authors (including those with only merges).
  # HEAD is required: without an explicit revision and with a non-tty
  # stdin (as when run via the `git report` alias) git shortlog reads the
  # commit list from stdin and would otherwise return nothing.
  `git shortlog -se HEAD`.split(/\n/).map do |shortlog_line|
    add shortlog_line, commits: 0
  end

  # Second pass: get actual commit counts (excluding merges)
  `git shortlog -se --no-merges HEAD`.split(/\n/).map do |shortlog_line|
    add shortlog_line
  end

  Git::Parallel.peach(authors, &:retrieve_loc_stats)
end

#retrieve_stats ⇒ Object 



25
26
27
28
29
30
 
# File 'lib/git/report.rb', line 25

def retrieve_stats
  verify_git_repository
  parse_shortlog
  parse_blame
  self
end

#stats ⇒ Object 



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/git/report.rb', line 103

def stats
  authors.sort! { |this, other| other.name  <=> this.name }
  authors.sort! { |this, other| other.files <=> this.files }
  authors.sort! { |this, other| other.loc   <=> this.loc }

  name_length =    authors.map { |auth| auth.name.length }.max
  loc_length =     authors.map { |auth| auth.loc.to_s.length }.max
  commits_length = authors.map { |auth| auth.commits.to_s.length }.max
  files_length =   authors.map { |auth| auth.files.to_s.length }.max
  loc_add_length = authors.map { |auth| auth.loc_added.to_s.length }.max
  loc_del_length = authors.map { |auth| auth.loc_deleted.to_s.length }.max

  name_length =    [name_length, HEADER[:name].length].max
  loc_length =     [loc_length, HEADER[:loc].length].max
  commits_length = [commits_length, HEADER[:commits].length].max
  files_length =   [files_length, HEADER[:files].length].max
  loc_add_length = [loc_add_length, HEADER[:loc_add].length].max
  loc_del_length = [loc_del_length, HEADER[:loc_del].length].max

  lines = []
  hr = '+' + ('-' * name_length) + '--'
  hr += '+' + ('-' * loc_length) + '--'
  hr += '+' + ('-' * commits_length) + '--'
  hr += '+' + ('-' * files_length) + '--'
  hr += '+' + ('-' * loc_add_length) + '--'
  hr += '+' + ('-' * loc_del_length) + '--+'

  head =  "| #{HEADER[:name].ljust(name_length)} "
  head += "| #{HEADER[:loc].rjust(loc_length)} "
  head += "| #{HEADER[:commits].rjust(commits_length)} "
  head += "| #{HEADER[:files].rjust(files_length)} "
  head += "| #{HEADER[:loc_add].rjust(loc_add_length)} "
  head += "| #{HEADER[:loc_del].to_s.rjust(loc_del_length)} |"

  lines << hr
  lines << head
  lines << hr
  authors.each do |author|
    # Skip authors with no contributions
    next if [author.loc, author.commits, author.files, author.loc_added,
             author.loc_deleted].all?(&:zero?)
             
    line =  "| #{author.name.unicode_normalize.ljust(name_length)} "
    line += "| #{author.loc.to_s.rjust(loc_length)} "
    line += "| #{author.commits.to_s.rjust(commits_length)} "
    line += "| #{author.files.to_s.rjust(files_length)} "
    line += "| #{author.loc_added.to_s.rjust(loc_add_length)} "
    line += "| #{author.loc_deleted.to_s.rjust(loc_del_length)} |"
    lines << line
  end
  lines << hr
  lines
end