Clean code in guess_github_metadata.R #216
Conversation
- This version (using "ceiling = 0") is never used as the version in utils.R seems to take precedence (because "utils" comes after "guess_github_metadata" in alphabetical order?) - What is the desired behaviour, ceiling = 0 or the default (ceiling = NULL), or should ceiling be an argument to uses_git()?
- Return early with NULL if git is not used - Consequently use the pipe operator. It makes the code look clean but is there maybe any reason not to do so?
- I think that there is no need to call git2r::repository() since it is already called within guess_github() - Return early - Use paste(..., sep = "/") instead of paste0()
- Use the pipe operator to avoid repetition of variable name "github" - Use getElment(1) instead of "[[1]]" to make this step a bit more obvious - no need for intermediate variables "owner" and "repo" since they are used only once in the call to gh::gh(). There, their meaning gets clear because the arguments are set by name. - Set silent = TRUE first in call to gh::gh(). This allows for a cleaner indentation.
|
Thank you! Can the slight changes in behaviour be described in tests, potentially with mocking? |
|
@hsonne could you answer the question above, or write a summary of the changes in behavior? Thank you! |
|
@hsonne Happy New Year! Any feedback on the above? Thank you! |
|
Hi @maelle and happy New Year to you, too. Sorry for not having replied so far. |
|
@cboettig do you remember the reason for the use of |
|
I believe it is used to guess the repository URL (if it's not given in the DESCRIPTION), see: codemetar/R/guess_github_metadata.R Lines 13 to 23 in 210a4b0 |
|
@maelle Just wanted check in and see where we are on this? is this good to merge now? |
|
It depends on your decision on #216 (comment) IIRC |
## Deprecation * The use_git_hook argument of write_codemeta() has been deprecated. Solutions for keeping DESCRIPTION and codemeta.json in sync are available in the docs. ## Enhancements * Docs were improved to make a better case for codemetar. * Changes in the way codeRepository is guessed. codemetar can now recognize an URL from GitHub, GitLab, Bitbucket, R-Forge among several URLs in DESCRIPTION, to assign it to codeRepository. If no URL in DESCRIPTION is from any of these providers, `guess_github()` is called. * Adds documentation of internet needs and verbosity to steps downloading information from the web (#270, @Bisaloo) * New argument `write_minimeta` for `write_codemeta()` indicating whether to also create the file schemaorg.json that corresponds to the metadata Google would validate, to be inserted to a webpage for SEO. It is saved as "schemaorg.json" alongside `path` (by default, "codemeta.json"). This functionality requires the `jsonld` package (listed under `Suggests`). ## Bug fixes * Fix for detecting rOpenSci review badge (@sckott, #236) * Fix extraction of ORCID when composite comment (@billy34, #231) * Fix bug in crosswalking (#243) * Bug fix: the codeRepository is updated if there's any URL in DESCRIPTION. * Bug fix: the README information is now updated by codemeta_readme(). Previously if e.g. a developmentStatus had been set previously, it was never updated. ## Internals * Code cleaning following the book Martin, Robert C. Clean code: a handbook of agile software craftsmanship. Pearson Education, 2009. (@hsonne, #201, #202, #204, #205, #206, #207, #209, #210, #211, #212, #216, #218, #219, #220, #221). * Use of re-usable Rmd pieces for the README, intro vignette and man pages to reduce copy-pasting.
Please consider my attempt to clean the code in guess_github_metadata.R. See my commit messages for details. Please review carefully since the behaviour changed slightly, but hopefully improved.
Thanks for consideration, Hauke