git_helpers 0.1.0 → 0.2

data/lib/git_helpers/extra_helpers.rb

@@ -1,209 +1,22 @@
-require 'shellwords'
-require 'dr/sh'
-require 'dr/base/encoding'
+# require 'dr/base/encoding'
 # require 'git_helpers' #if we are required directly
 
 module GitHelpers
-	DefaultLogOptions=["-M", "-C", "--no-color"].shelljoin
-	
-	module GitStats
-		#Note: stats-authors give the same result, should be faster, and handle mailcap
-		#inspired by git-mainline//git-rank-contributors
-		def stats_diff(logopts=nil)
-			lines = {}
-
-			with_dir do
-				author = nil
-				state = :pre_author
-				DR::Encoding.fix_utf8(`git log #{DefaultLogOptions} -p #{logopts}`).each_line do |l|
-					case
-					when (state == :pre_author || state == :post_author) && m=l[/Author: (.*)$/,1]
-						#TODO: using directly author=l[]... seems to only affect a block scoped author variable
-						author=m
-						state = :post_author
-						lines[author] ||= {added: 0, deleted: 0, all: 0}
-					when state == :post_author && l =~ /^\+\+\+\s/
-						state = :in_diff
-					when state == :in_diff && l =~ /^[\+\-]/
-						unless l=~ /^(\+\+\+|\-\-\-)\s/
-							lines[author][:all] += 1 
-							lines[author][:added] += 1	if l[0]=="+"
-							lines[author][:deleted] += 1 if l[0]=="-"
-						end
-					when state == :in_diff && l =~ /^commit /
-						state = :pre_author
-					end
-				end
-			end
-			lines
-		end
-
-		def output_stats_diff(logopts=nil)
-			lines=stats_diff(logopts)
-			lines.sort_by { |a, c| -c[:all] }.each do |a, c|
-				puts "#{a}: #{c[:all]} lines of diff (+#{c[:added]}/-#{c[:deleted]})"
-			end
-		end
-
-		# inspired by visionmedia//git-line-summary
-		def stats_lines(file)
-			#p file
-			with_dir do
-				out,_suc=SH.run_simple("git", "blame", "--line-porcelain", file, quiet: true)
-			end
-			r={}
-			begin
-			out.each_line do |l|
-					l.match(/^author (.*)/) do |m|
-						r[m[1]]||=0
-						r[m[1]]+=1
-					end
-				end
-			rescue => e
-				warn "Warning: #{e} on #{file}"
-			end
-			r
-		end
-
-		def stats_lines_all
-			r={}
-			all_files.select {|f| SH::Pathname.new(f).text? rescue false}.each do |f|
-				stats_lines(f).each do |k,v|
-					r[k]||=0
-					r[k]+=v
-				end
-			end
-			r
-		end
-
-		def output_stats_lines
-			stats=stats_lines_all
-			total=stats.values.sum
-			stats.sort_by{|k,v| -v}.each do |k,v|
-				puts "- #{k}: #{v} (#{"%2.1f%%" % (100*v/total.to_f)})"
-			end
-			puts "Total lines: #{total}"
-		end
-
-		#Inspired by https://github.com/esc/git-stats/blob/master/git-stats.sh
-		def stats_authors(logopts=nil, more: false)
-			require 'set'
-			#Exemple: --after=..., --before=...,
-			#  -w #word diff
-			#  -C --find-copies-harder; -M
-			authors={}
-			with_dir do
-				%x/git shortlog -sn #{logopts}/.each_line do |l|
-					commits, author=l.chomp.split(' ', 2)
-					authors[author]={commits: commits.to_i}
-				end
-
-				if more
-					authors.each_key do |a|
-						tot_a=0; tot_r=0; tot_rename=0; files=Set.new
-						%x/git log #{DefaultLogOptions} #{logopts} --numstat --format="%n" --author='#{a}'/.each_line do |l|
-							added, deleted, file=l.chomp.split(' ',3)
-							#puts "#{l} => #{added}, #{deleted}, #{rest}"
-							tot_a+=added.to_i; tot_r+=deleted.to_i
-							next if file.nil?
-							if file.include?(' => ')
-								tot_rename+=1
-							else
-								files.add(file) unless file.empty?
-							end
-						end
-						#rev-list should be faster, but I would need to use 
-						# `git rev-parse --revs-only --default HEAD #{logopts.shelljoin}`
-						# to be sure we default to HEAD, and 
-						# `git rev-parse --flags #{logopts.shelljoin}` to get the log flags...
-						#tot_merges=%x/git rev-list #{logopts} --merges --author='#{a}'/.each_line.count
-						tot_merges=%x/git log --pretty=oneline #{logopts} --merges --author='#{a}'/.each_line.count
-						authors[a].merge!({added: tot_a, deleted: tot_r, files: files.size, renames: tot_rename, merges: tot_merges})
-					end
-				end
-			end
-			authors
-		end
-
-		def output_stats_authors(logopts=nil)
-			authors=stats_authors(logopts, more: true)
-			authors.each do |a,v|
-				puts "- #{a}: #{v[:commits]} commits (+#{v[:added]}/-#{v[:deleted]}), #{v[:files]} files modified, #{v[:renames]} renames, #{v[:merges]} merges"
-			end
-		end
-
-		#inspired by visionmedia//git-infos
-		def infos
-			with_dir do
-				puts "## Remote URLs:"
-				puts
-				system("git --no-pager remote -v")
-				puts
-				
-				puts "## Remote Branches:"
-				puts
-				system("git --no-pager  branch -r")
-				puts
-				
-				puts "## Local Branches:"
-				puts
-				system("git --no-pager  branch")
-				puts
-				
-				puts "## Most Recent Commit:"
-				puts
-				system("git --no-pager log --max-count=1 --pretty=short")
-				puts
-			end
-		end
-
-		#inspired by visionmedia//git-summary
-		def summary(logopts=nil)
-			with_dir do
-				project=Pathname.new(%x/git rev-parse --show-toplevel/).basename
-				authors=stats_authors(logopts)
-				commits=authors.map {|a,v| v[:commits]}.sum
-				file_count=%x/git ls-files/.each_line.count
-				active_days=%x/git log --date=short --pretty='format: %ad' #{logopts}/.each_line.uniq.count
-				#This only give the rep age of the current branch; and is not
-				#efficient since we generate the first log
-				#A better way would be to get all the roots commits via
-				#    git rev-list --max-parents=0 HEAD
-				#and then look at their ages
-				repository_age=%x/git log --reverse --pretty=oneline --format="%ar" #{logopts}/.each_line.first.sub!('ago','')
-				#total= %x/git rev-list #{logopts}/.each_line.count
-				total=%x/git rev-list --count #{logopts.empty? ? "HEAD" : logopts.shelljoin}/.to_i
-
-				puts " project  : #{project}"
-				puts " repo age : #{repository_age}"
-				puts " active   : #{active_days} days"
-				puts " commits  : #{commits}"
-				puts " files    : #{file_count}"
-				puts " authors  : #{authors.keys.join(", ")} (Total: #{total})"
-				authors.each do |a,v|
-					puts " - #{a}: #{v[:commits]} (#{"%2.1f" % (100*v[:commits]/commits.to_f)}%)"
-				end
-			end
-		end
-	end
-
 	# various helpers
 	module GitExtraInfos
 		# Inspired by http://chneukirchen.org/dotfiles/bin/git-attic
 		def removed_files(logopts=nil)
 			removed={}
-			with_dir do
-				commit=nil; date=nil
-				%x/git log #{DefaultLogOptions} --raw --date=short --format="%h %cd" #{logopts}/.each_line do |l|
-					l.chomp!
-					case l
-					when /^[0-9a-f]/
-						commit, date=l.split(' ',2)
-					when /^:/
-						_old_mode, _new_mode, _old_hash, _new_hash, state, filename=l.split(' ',6)
-						#keep earliest removal
-						removed[filename]||={date: date, commit: commit} if state=="D"
-					end
+			commit=nil; date=nil
+			run_simple(%Q/git log #{DefaultLogOptions} --raw --date=short --format="%h %cd" #{logopts}/, chomp: :lines).each do |l|
+				l.chomp!
+				case l
+				when /^[0-9a-f]/
+					commit, date=l.split(' ',2)
+				when /^:/
+					_old_mode, _new_mode, _old_hash, _new_hash, state, filename=l.split(' ',6)
+					#keep earliest removal
+					removed[filename]||={date: date, commit: commit} if state=="D"
 				end
 			end
 			removed
@@ -218,16 +31,14 @@ module GitHelpers
 		#Inspired by https://gist.github.com/7590246.git
 		def commit_children(*commits)
 			r={}
-			with_dir do
-				commits.each do |commit|
-					commit_id=%x/git rev-parse "#{commit}^0"/.chomp #dereference tags
-					%x/git rev-list --all --not #{commit_id}^@ --children/.each_line do |l|
-						if l=~/^#{commit_id}/
-							_commit, *children=l.chomp.split
-							described=children.map {|c| %x/git describe --always #{c}/.chomp}
-							r[commit]||=[]
-							r[commit]+=described
-						end
+			commits.each do |commit|
+				commit_id=run_simple %Q/git rev-parse "#{commit}^0"/, chomp: true #dereference tags
+				run_simple(%Q/git rev-list --all --not #{commit_id}^@ --children/, chomp: :lines).each do |l|
+					if l=~/^#{commit_id}/
+						_commit, *children=l.split
+						described=children.map {|c| run_simple("git describe --always #{c}", chomp: true)}
+						r[commit]||=[]
+						r[commit]+=described
 					end
 				end
 			end
@@ -243,12 +54,10 @@ module GitHelpers
 		#Inspired by the script git-churn, written by Corey Haines # Scriptified by Gary Bernhardt
 		def log_commits_by_files(logopts=nil)
 			r={}
-			with_dir do
-				files=%x/git log #{DefaultLogOptions} --name-only --format="" #{logopts}/.each_line.map {|l| l.chomp!}
-				uniq=files.uniq
-				uniq.each do |file|
-					r[file]=files.count(file)
-				end
+			files=run_simple("git log #{DefaultLogOptions} --name-only --format="" #{logopts}", chomp: :lines)
+			uniq=files.uniq
+			uniq.each do |file|
+				r[file]=files.count(file)
 			end
 			r
 		end
@@ -346,14 +155,9 @@ module GitHelpers
 				merges=trails(commit, **opts)
 				merges.delete(hash) #todo: only delete if we are the only tip
 				merges.delete(:disjoint)
-				system("git --no-pager -c color.ui=always log --pretty=summary #{log_opts} #{merges.keys.map {|mb| "^#{mb}"}.join(" ")} #{commit}")
+				system("git --no-pager -c color.ui=always log --pretty=suminfo #{log_opts} #{merges.keys.map {|mb| "^#{mb}"}.join(" ")} #{commit}")
 				puts
 			end
 		end
 	end
-
-	class GitDir
-		include GitStats
-		include GitExtraInfos
-	end
 end

data/lib/git_helpers/git_dir.rb

@@ -0,0 +1,176 @@
+require 'git_helpers/stats'
+require 'git_helpers/extra_helpers'
+require 'git_helpers/branch_infos'
+require 'git_helpers/status'
+require 'git_helpers/submodules'
+
+module GitHelpers
+	class GitDir
+		include GitStats
+		include GitExtraInfos
+		include GitBranchInfos
+		include GitStatus
+		include GitSubmodules
+
+		attr_reader :dir, :reldir
+		attr_writer :infos
+		def initialize(dir=".")
+			self.dir=dir
+		end
+
+		def dir=(dir)
+			@reldir=Pathname.new(dir.to_s)
+			@dir=begin @reldir.realpath rescue @reldir end
+		end
+
+		def to_s
+			@dir.to_s
+		end
+		#we could also use 'git -C #{@dir}' for each git invocation
+		def with_dir
+			Dir.chdir(@dir) { yield self }
+		end
+
+		#reset all caches
+		def reset!
+			@infos=nil
+			@head=nil
+		end
+
+		def infos(*args)
+			return @infos if @infos
+			@infos=infos!(*args)
+		end
+
+		def run(*args, run_command: :run, **opts, &b)
+			SH.logger.debug("run #{args} (#{opts})")
+			with_dir do
+				return SH.public_send(run_command, *args, **opts, &b)
+			end
+		end
+		def run_simple(*args,**opts, &b)
+			run(*args, run_command: :run_simple,**opts, &b)
+		end
+		def run_success(*args,**opts, &b)
+			run(*args, run_command: :run_success, **opts, &b)
+		end
+
+		# infos without cache
+		def infos!(quiet: true)
+			infos={}
+			status, out, _err=run("git rev-parse --is-inside-git-dir --is-inside-work-tree --is-bare-repository --show-prefix --show-toplevel --show-cdup --git-dir", chomp: :lines, quiet: quiet)
+			infos[:git]=status.success?
+			infos[:in_gitdir]=DR::Bool.to_bool out[0]
+			infos[:in_worktree]=DR::Bool.to_bool out[1]
+			infos[:is_bare]=DR::Bool.to_bool out[2]
+			infos[:prefix]=out[3]
+			infos[:toplevel]=out[4]
+			infos[:cdup]=out[5]
+			infos[:gitdir]=out[6]
+			infos
+		end
+
+		#are we a git repo?
+		def git?
+			infos[:git]
+		end
+		#are we in .git/?
+		def gitdir?
+			infos[:in_gitdir]
+		end
+		#are we in the worktree?
+		def worktree?
+			infos[:in_worktree]
+		end
+		#are we in a bare repo?
+		def bare?
+			infos[:is_bare]
+		end
+		#relative path from toplevel to @dir
+		def prefix
+			d=infos[:prefix] and ShellHelpers::Pathname.new(d)
+		end
+		#return the absolute path of the toplevel
+		def toplevel
+			d=infos[:toplevel] and ShellHelpers::Pathname.new(d)
+		end
+		#return the relative path from @dir to the toplevel
+		def relative_toplevel
+			d=infos[:cdup] and ShellHelpers::Pathname.new(d)
+		end
+		#get path to .git directory (can be relative or absolute)
+		def gitdir
+			d=infos[:gitdir] and ShellHelpers::Pathname.new(d)
+		end
+
+		def all_files
+			run_simple("git ls-files -z").split("\0")
+		end
+
+		def with_toplevel(&b)
+			with_dir do
+				dir=relative_toplevel
+				if !dir.to_s.empty?
+					Dir.chdir(dir,&b)
+				else
+					warn "No toplevel found, executing inside dir #{@dir}"
+					with_dir(&b)
+				end
+			end
+		end
+
+		#return a list of submodules
+		def submodules
+			run_simple("git submodule status").each_line.map { |l| l.split[1] }
+		end
+
+		def get_config(*args)
+			run_simple("git config #{args.shelljoin}", chomp: true)
+		end
+
+		# deprecated
+		# run head.name instead
+		def current_branch(always: true)
+			branchname= run_simple("git symbolic-ref -q --short HEAD", chomp: true)
+			branchname= run_simple("git rev-parse --short --verify HEAD", chomp: true) if always and branchname.empty?
+			return branch(branchname)
+		end
+
+		def head
+			@head || @head=branch('HEAD')
+		end
+
+		## #return all branches that have an upstream
+		## #if branches=:all look through all branches
+		## def all_upstream_branches(branches)
+		## 	#TODO (or use branch_infos)
+		## 	upstreams=%x!git for-each-ref --format='%(upstream:short)' refs/heads/branch/!
+		## end
+
+		def push_default
+			run_simple("git config --get remote.pushDefault", chomp: true) || "origin"
+		end
+
+		def get_topic_branches(*branches, complete: :local)
+			if branches.length >= 2
+				return branch(branches[0]), branch(branches[1])
+			elsif branches.length == 1
+				b=branch(branches[0])
+				if complete == :local
+					return current_branch, b
+				elsif complete == :remote
+					return b, b.upstream
+				else
+					fail "complete keyword should be :local or :remote"
+				end
+			else
+				c=current_branch
+				return c, c.upstream
+			end
+		end
+
+		def branch(branch="HEAD")
+			GitBranch.new(branch, dir: self)
+		end
+	end
+end