Add git-config include. #345

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.

Sign up for GitHub

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

Jump to bottom

Merged

Byron merged 16 commits into GitoxideLabs:main from svetli-n:git_include

Mar 28, 2022

Contributor

svetli-n commented Mar 5, 2022 •

edited

Loading

Contributor Author

svetli-n commented Mar 5, 2022

@Byron plz take a look when taking a break from multithreading :-)

Member

Byron commented Mar 6, 2022

Thanks for taking a shot at this.

There seems to be an issue with the way commits/pushes are done - this is how it looks to me:

Byron reviewed

View reviewed changes

Member

Byron left a comment

I took a look mostly at the tests this time, with a few general comments.

git-config/src/file/git_config.rs Outdated Show resolved Hide resolved

git-config/src/file/git_config.rs Show resolved Hide resolved

git-config/src/file/git_config.rs Outdated Show resolved Hide resolved

svetli-n force-pushed the git_include branch from 6decab4 to e0fdad2 Compare

March 8, 2022 12:51

svetli-n commented

View reviewed changes

git-config/src/file/git_config.rs Outdated Show resolved Hide resolved

svetli-n commented

View reviewed changes

git-config/src/file/git_config.rs Outdated Show resolved Hide resolved

svetli-n marked this pull request as ready for review

March 8, 2022 23:35

svetli-n changed the title ~~Add git-config include for absolute paths.~~ Add git-config include.

Byron reviewed

View reviewed changes

Member

Byron left a comment

Thanks a lot!

I think the biggest change still needed is to pass in context so interpolate(…) has something to work with.

git-config/Cargo.toml Outdated Show resolved Hide resolved

git-config/src/file/git_config.rs Outdated Show resolved Hide resolved

git-config/src/file/git_config.rs Outdated Show resolved Hide resolved

git-config/src/file/git_config.rs Outdated Show resolved Hide resolved

git-config/src/file/git_config.rs Outdated Show resolved Hide resolved

svetli-n force-pushed the git_include branch from eb64d92 to 963a4f7 Compare

March 12, 2022 23:40

Byron reviewed

View reviewed changes

Member

Byron left a comment

I really like seeing how this PR is developing, and includeIf is probably in reach now, too.

git-config/src/file/git_config.rs Outdated Show resolved Hide resolved

git-config/src/file/git_config.rs Outdated Show resolved Hide resolved

git-config/src/file/git_config.rs Outdated Show resolved Hide resolved

Byron reviewed

View reviewed changes

Member

Byron left a comment •

edited

Loading

Thanks for the fixes!
Some more ideas came up, I think they may help prepare the code for includeIf as well.
My plan is to merge this one next time.

git-config/src/file/git_config.rs Outdated Show resolved Hide resolved

git-config/src/file/git_config.rs Outdated Show resolved Hide resolved

git-config/src/file/git_config.rs Outdated Show resolved Hide resolved

svetli-n force-pushed the git_include branch from ac2af27 to 58c774c Compare

March 16, 2022 20:20

Byron reviewed

View reviewed changes

Member

Byron left a comment

I was about to prepare this PR for merging when I noticed one last thing that I couldn't fix in the little time that remained.

Once it is addressed I'd love to merge. Thanks.

git-config/src/file/git_config.rs Outdated Show resolved Hide resolved

svetli-n commented

View reviewed changes

git-config/src/file/git_config.rs Show resolved Hide resolved

Byron reviewed

View reviewed changes

git-config/src/file/git_config.rs Outdated Show resolved Hide resolved

Member

Byron commented Mar 19, 2022

So close :)!

When refactoring and looking at the code I noticed that it would by its very nature loose the include sections themselves. Maybe I am wrong about this, but could you add a test to assure that doesn't happen?

I double-checked with git config --get-all --includes include.path and could indeed query all values underneath the include sections themselves.

Thank you.

Member

Byron commented Mar 19, 2022

As discussed, two more small items on the list of the ever expanding scope.

allow to emulate something like '--no-include'
check if GIT_CONFIG_VALUES may contain include.path and have them followed, and if so, we'd need that too.

Byron mentioned this pull request

git-config towards 1.0 #331

Closed

24 tasks

svetli-n force-pushed the git_include branch from 74335bf to 11fe422 Compare

March 26, 2022 22:00

Contributor Author

svetli-n commented Mar 26, 2022

Ready may be? :-)

svetli-n and others added 9 commits

March 27, 2022 10:01


          implement include.path support (GitoxideLabs#331)

a392988

- Add git-config include for absolute paths.
- Temp disable criterion due to cargo-deny (advisories).
- Pass git_install_dir when creating config. Canonicalize include paths.
- Use `from_paths::Error`.
- Fix clippy warnings.


          add from_paths::Options::default(); minor refactor (GitoxideLabs#331)

bcd038c


          Return error when max allowed nested includes depth is passed.


          refactor (GitoxideLabs#331)

85be984


          Add path include to from_env. Follow duplicate include paths until …

2295dc5

…max include depth is exceeded.


          Replace GitConfigFromEnvError with from_env::Error.

e1f8b52


          Refactor and add skip bom when reading config.

2d5768d


          use the same BOM bytes as in git-attributes (GitoxideLabs#331)

That way, it's more easily discoverable should people search for it.


          add TODO to not forget reworking the 'fs' module (GitoxideLabs#331)

0b032e4

Byron added 3 commits

March 27, 2022 10:41


          remove unnecessary doc comments; remove unused field in Options (Gito…

e94ded4

…xideLabs#331)


          assure from_env() include paths only use paths of the correct key (G…

0d84ce8

…itoxideLabs#331)


          Ignore subsections when resolving include.path keys (GitoxideLabs#331)

baa300f

Byron force-pushed the git_include branch from 11fe422 to baa300f Compare

March 27, 2022 03:29

Byron and others added 4 commits

March 27, 2022 17:36


          refactor include path recursion logic (GitoxideLabs#331)

2862a07

It was born in the `from_paths()` method which eventually showed
that it wasn't possible to easily resolve paths in an existing
config file, as is the case in the `from_env()` constructor.

There still is a TODO asking how to resolve relative include paths
if there was no path on disk.


          refactor (GitoxideLabs#331)

845fe37


          Relative include path from env is error.

e303466


          Move tests out of git_config.

7fd8369

Member

Byron commented Mar 28, 2022

Thanks a lot for your contribution, it's merged!

Please note also about the comment in 3cbe072, I think it would be valuable to split tests into integration tests without affecting the API, and factor the unit tests out into their own module files (without being integration tests). Even though this refactoring could be done at any time, I recommend doing it before proceeding with includeIf support.

Byron merged commit 7fd8369 into GitoxideLabs:main

Contributor Author

svetli-n commented Mar 28, 2022

Awesome & thanks for the valuable guidance while working on it!

Yes, I was unsure about the tests and will act on the comment in 3cbe072

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet