From 75be0ca4d08de6d00b1fe17ae1aee20f80c25ade Mon Sep 17 00:00:00 2001
From: Jonathan Chang <me@jonathanchang.org>
Date: Fri, 27 Nov 2020 18:40:08 +1100
Subject: [PATCH] git_repository: add type signatures and comments
---
Library/Homebrew/extend/git_repository.rb | 22 +++++++++++++++++++++-
Library/Homebrew/extend/git_repository.rbi | 8 ++++++++
Library/Homebrew/utils/git.rb | 1 +
3 files changed, 30 insertions(+), 1 deletion(-)
create mode 100644 Library/Homebrew/extend/git_repository.rbi
diff --git a/Library/Homebrew/extend/git_repository.rb b/Library/Homebrew/extend/git_repository.rb
index 56a8ced860..067f518bbf 100644
--- a/Library/Homebrew/extend/git_repository.rb
+++ b/Library/Homebrew/extend/git_repository.rb
@@ -1,50 +1,70 @@
-# typed: false
+# typed: strict
# frozen_string_literal: true
require "utils/git"
require "utils/popen"
+# Extensions to {Pathname} for querying Git repository information.
+# @see Utils::Git
+# @api private
module GitRepositoryExtension
+ extend T::Sig
+
+ sig { returns(T::Boolean) }
def git?
join(".git").exist?
end
+ # Gets the URL of the Git origin remote.
+ sig { returns(T.nilable(String)) }
def git_origin
return unless git? && Utils::Git.available?
Utils.popen_read("git", "config", "--get", "remote.origin.url", chdir: self).chomp.presence
end
+ # Sets the URL of the Git origin remote.
+ sig { params(origin: String).returns(T.nilable(T::Boolean)) }
def git_origin=(origin)
return unless git? && Utils::Git.available?
safe_system "git", "remote", "set-url", "origin", origin, chdir: self
end
+ # Gets the full commit hash of the HEAD commit.
+ sig { returns(T.nilable(String)) }
def git_head
return unless git? && Utils::Git.available?
Utils.popen_read("git", "rev-parse", "--verify", "-q", "HEAD", chdir: self).chomp.presence
end
+ # Gets a short commit hash of the HEAD commit.
+ sig { returns(T.nilable(String)) }
def git_short_head
return unless git? && Utils::Git.available?
Utils.popen_read("git", "rev-parse", "--short=4", "--verify", "-q", "HEAD", chdir: self).chomp.presence
end
+ # Gets the relative date of the last commit, e.g. "1 hour ago"
+ sig { returns(T.nilable(String)) }
def git_last_commit
return unless git? && Utils::Git.available?
Utils.popen_read("git", "show", "-s", "--format=%cr", "HEAD", chdir: self).chomp.presence
end
+ # Gets the name of the currently checked-out branch, or HEAD if the repository is in a detached HEAD state.
+ sig { returns(T.nilable(String)) }
def git_branch
return unless git? && Utils::Git.available?
Utils.popen_read("git", "rev-parse", "--abbrev-ref", "HEAD", chdir: self).chomp.presence
end
+ # Returns the date of the last commit, in YYYY-MM-DD format.
+ sig { returns(T.nilable(String)) }
def git_last_commit_date
return unless git? && Utils::Git.available?
diff --git a/Library/Homebrew/extend/git_repository.rbi b/Library/Homebrew/extend/git_repository.rbi
new file mode 100644
index 0000000000..534b936b96
--- /dev/null
+++ b/Library/Homebrew/extend/git_repository.rbi
@@ -0,0 +1,8 @@
+# typed: strict
+
+module GitRepositoryExtension
+ include Kernel
+
+ sig { params(args: T.any(String, Pathname)).returns(Pathname) }
+ def join(*args); end
+end
diff --git a/Library/Homebrew/utils/git.rb b/Library/Homebrew/utils/git.rb
index 59025a3064..0b9039dfcf 100644
--- a/Library/Homebrew/utils/git.rb
+++ b/Library/Homebrew/utils/git.rb
@@ -4,6 +4,7 @@
module Utils
# Helper functions for querying Git information.
#
+ # @see GitRepositoryExtension
# @api private
module Git
module_function
--
GitLab