Get all directory entries at the given SHA #65
Conversation
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 commit adds Gollum-formatted entries that represent the directory
tree of the repository at the given SHA. For example, using the Gollum
`lotr.git` test wiki, we get the following array back:
@repo.lstree_all_directories(sha)
=>
[{:sha=>"6e48abfc56565574859e081ee58eae655d48cf71",
:mode=>16384,
:type=>"tree",
:name=>"Gondor",
:path=>"Gondor"},
{:sha=>"760982a3b84987919b99748d87c7890bb54afd07",
:mode=>16384,
:type=>"tree",
:name=>"Mordor",
:path=>"Mordor"},
{:sha=>"a13e77aca82edd8e6bd4096e351627859f74ffec",
:mode=>16384,
:type=>"tree",
:name=>"Rivendell",
:path=>"Rivendell"}]
In subsequent commits to `gollum` and `gollum-lib`, using this method
can help us make Gollum's "Overview" page more performant for large
wikis.
Currently, Gollum has no mechanism for getting the directory tree of
the git repository, meaning we have to reverse-engineer the directory
tree by using the paths of files checked into the repository.
The test suite for the adapters is in a separate repository so that all the adapters share the same tests. |
|
Right, and the test suite gives at least some sort of documentation of the API, which is a bit lacking at the moment. :) |
dometto
reviewed
May 6, 2024
| @@ -659,6 +659,12 @@ def lstree(sha, options = {}) | |||
| results | |||
| end | |||
|
|
|||
| def lstree_all_directories(sha) | |||
There was a problem hiding this comment.
Maybe lstree_all_trees to stay consistent with git terminology?
There was a problem hiding this comment.
That makes sense. I will change this.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
It looks like this gem has no test suite, so I've included the output from
@repo.lstree_all_directories(sha)below as evidence that this works--until this can be tested at thegollum-libandgollumlayers.This commit adds Gollum-formatted entries that represent the directory tree of the repository at the given SHA. For example, using the Gollum
lotr.gittest wiki, we get the following array back:In subsequent commits to
gollumandgollum-lib, using this method can help us make Gollum's "Overview" page more performant for large wikis.Currently, Gollum has no mechanism for getting the directory tree of the git repository, meaning we have to reverse-engineer the directory tree by using the paths of files checked into the repository.