Attempt conversion of SPDX license expressions to Homebrew DSL #1345
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
mistydemeo
reviewed
Aug 19, 2024
mistydemeo
reviewed
Aug 20, 2024
added `spdx` dependency for parsing license expression. added to_homebrew_license_format utility function with tests. modified add_homebrew_installer to attempt conversion updated snapshots
cxreiff
force-pushed
the
homebrew-multiple-license
branch
from
507f9e7 to
b9ceed3
Compare
mistydemeo
added a commit
that referenced
this pull request
Aug 21, 2024
These two tests produce different results in Homebrew's SPDX parser, but that appears to be a bug in Homebrew's parser rather than this one. Added notes to both tests so that we expect the results to be different from what Homebrew returns. refs #1345 (comment).
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.
Resolves #820.
Problem
Currently, when publishing to a Homebrew tap, whatever string is in the crate's Cargo.toml license field (usually a SPDX license expression) gets passed into
licensein the Homebrew formula. However, rather than using SPDX syntax, Homebrew has its own ruby syntax for specifying licenses. So, when passed an SPDX expression, Homebrew:brew audit/brew test-bot.Solution
spdxcrate to parse the SPDX license expression.licensecommand, falling back to the original license string if there are issues parsing.Scope
spdxcrate has not yet implemented v3 of the spec. This means that the WITH operator is not yet covered, and neither are lower-case versions of the operators.spdxissue for implementing spec v3 is here.Testing
I added tests for the conversion utility function, tested the output in a Homebrew formula, and I inspected and updated the test snapshots. This PR could certainly use some additional testing from someone with deeper familiarity with the project.