-
-
Notifications
You must be signed in to change notification settings - Fork 9.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
utils: add git_repository
#10245
Merged
SeekingMeaning
merged 3 commits into
Homebrew:master
from
SeekingMeaning:git-repository-head
Jan 8, 2021
Merged
utils: add git_repository
#10245
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
# typed: false | ||
# frozen_string_literal: true | ||
|
||
require "utils/git_repository" | ||
|
||
describe Utils do | ||
before do | ||
HOMEBREW_CACHE.cd do | ||
system "git", "init" | ||
Pathname("README.md").write("README") | ||
system "git", "add", "README.md" | ||
system "git", "commit", "-m", "File added" | ||
end | ||
end | ||
|
||
let(:head_revision) { HOMEBREW_CACHE.cd { `git rev-parse HEAD`.chomp } } | ||
let(:short_head_revision) { HOMEBREW_CACHE.cd { `git rev-parse --short HEAD`.chomp } } | ||
|
||
describe ".git_head" do | ||
it "returns the revision at HEAD" do | ||
expect(described_class.git_head(HOMEBREW_CACHE)).to eq(head_revision) | ||
expect(described_class.git_head(HOMEBREW_CACHE, length: 5)).to eq(head_revision[0...5]) | ||
end | ||
end | ||
|
||
describe ".git_short_head" do | ||
it "returns the short revision at HEAD" do | ||
expect(described_class.git_short_head(HOMEBREW_CACHE)).to eq(short_head_revision) | ||
expect(described_class.git_short_head(HOMEBREW_CACHE, length: 5)).to eq(head_revision[0...5]) | ||
end | ||
end | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
# typed: strict | ||
# frozen_string_literal: true | ||
|
||
module Utils | ||
extend T::Sig | ||
|
||
sig { params(repo: T.any(String, Pathname), length: T.nilable(Integer)).returns(T.nilable(String)) } | ||
def self.git_head(repo, length: nil) | ||
return git_short_head(repo, length: length) if length.present? | ||
|
||
repo = Pathname(repo).extend(GitRepositoryExtension) | ||
repo.git_head | ||
end | ||
|
||
sig { params(repo: T.any(String, Pathname), length: T.nilable(Integer)).returns(T.nilable(String)) } | ||
def self.git_short_head(repo, length: nil) | ||
repo = Pathname(repo).extend(GitRepositoryExtension) | ||
repo.git_short_head(length: length) | ||
end | ||
end |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can docs be added (as these are public methods) instead of this being added to
todo
?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How do I fix this style error?
What about
utils/popen
andutils/fork
(which both extendUtils
)? Would adding top-level documentation comments cause conflicts?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah, yes, I see. Would need to perhaps define that module in
utils.rb
and document it? I think it's fine to punt on that, then.